ParticleMatterInteraction.h

Go to the documentation of this file.

#ifndef OPAL_PARTICLEMATTERINTERACTION_HH
#define OPAL_PARTICLEMATTERINTERACTION_HH

// ------------------------------------------------------------------------
// $RCSfile: Wake.h,v $
// ------------------------------------------------------------------------
// $Revision: 1.1.1.1 $
// ------------------------------------------------------------------------
// Copyright: see Copyright.readme
// ------------------------------------------------------------------------
//
// Class: Wake
//
// ------------------------------------------------------------------------
//
// $Date: 2000/03/27 09:33:44 $
// $Author: Andreas Adelmann $
//
// ------------------------------------------------------------------------

#include "AbstractObjects/Definition.h"
#include "Algorithms/PartData.h"
#include "Solvers/ParticleMatterInteractionHandler.hh"

class ElementBase;
class Inform;

// Class Wake
// ------------------------------------------------------------------------
//  A WAKE definition is used by most physics commands to define the
//  particle charge and the reference momentum, together with some other
//  data.

class ParticleMatterInteraction: public Definition {

public:

    ParticleMatterInteraction();

    virtual ~ParticleMatterInteraction();

    //  Can replace only by another WAKE.
    virtual bool canReplaceBy(Object *object);

    virtual ParticleMatterInteraction *clone(const std::string &name);

    virtual void execute();

    static ParticleMatterInteraction *find(const std::string &name);

    virtual void update();

    void print(std::ostream &os) const;

    void initParticleMatterInteractionHandler(ElementBase &element);

    void updateElement(ElementBase *element);

    ParticleMatterInteractionHandler *handler_m;

private:

    // Not implemented.
    ParticleMatterInteraction(const ParticleMatterInteraction &);
    void operator=(const ParticleMatterInteraction &);

    // Clone constructor.
    ParticleMatterInteraction(const std::string &name, ParticleMatterInteraction *parent);
};

inline std::ostream &operator<<(std::ostream &os, const ParticleMatterInteraction &b) {
    b.print(os);
    return os;
}

#endif // OPAL_PARTICLEMATTERINTERACTION_HH