class Integrator : public ElementBase

(Return to index)

Base class for special integrators.

Integrator is a pure abstract class. It forms the base class for all special propagators through an element or a beam line. If present, it overrides a complete Component or Beamline object.

Type:	Abstract
Superclasses:	public ElementBase
Include file:	./AbsBeamline/Integrator.hh

Inheritance

Synopsis (including inherited members):

• Public members:
  • Integrator (ElementBase*) ;
  • Integrator (const Integrator&) ;
  • virtual ~Integrator () ;
  • inline ElementBase* getElement ()const ;
  • virtual void makeSharable () ;
  • virtual void trackParticle (Particle&,const PartData&,bool,bool)const = 0 ;
  • virtual void trackBunch (PartBunch&,const PartData&,bool,bool)const = 0 ;
  • virtual void trackMap (FVps<double,6>&,const PartData&,bool,bool)const = 0 ;
  • virtual const string& getName ()const ;
  • virtual void setName (const string&) ;
  • virtual const string& getType ()const = 0 ;
  • virtual Geometry& getGeometry () = 0 ;
  • virtual const Geometry& getGeometry ()const = 0 ;
  • virtual double getArcLength ()const ;
  • virtual double getElementLength ()const ;
  • virtual void setElementLength (double) ;
  • virtual double getOrigin ()const ;
  • virtual double getEntrance ()const ;
  • virtual double getExit ()const ;
  • virtual Euclid3D getTransform (double,double)const ;
  • virtual Euclid3D getTransform (double)const ;
  • virtual Euclid3D getTotalTransform ()const ;
  • virtual Euclid3D getEntranceFrame ()const ;
  • virtual Euclid3D getExitFrame ()const ;
  • virtual Euclid3D getEntrancePatch ()const ;
  • virtual Euclid3D getExitPatch ()const ;
  • virtual double getAttribute (const string&)const ;
  • virtual bool hasAttribute (const string&)const ;
  • virtual void removeAttribute (const string&) ;
  • virtual void setAttribute (const string&,double) ;
  • virtual Channel* getChannel (const string&) ;
  • virtual const ConstChannel* getConstChannel (const string&)const ;
  • virtual ElementImage* getImage ()const ;
  • virtual void accept (BeamlineVisitor&)const = 0 ;
  • virtual ElementBase* clone ()const = 0 ;
  • virtual ElementBase* copyStructure () ;
  • bool isSharable ()const ;
  • virtual ElementBase* makeAlignWrapper () ;
  • virtual ElementBase* makeFieldWrapper () ;
  • virtual ElementBase* makeWrappers () ;
  • virtual ElementBase* removeAlignWrapper () ;
  • virtual const ElementBase* removeAlignWrapper ()const ;
  • virtual ElementBase* removeFieldWrapper () ;
  • virtual const ElementBase* removeFieldWrapper ()const ;
  • virtual ElementBase* removeWrappers () ;
  • virtual const ElementBase* removeWrappers ()const ;
  • bool update (const AttributeSet&) ;
  • int addReference ()const ;
  • int removeReference ()const ;
  • bool isShared ()const ;
• Protected Members:
  • Pointer<ElementBase> itsElement ;
  • mutable bool shareFlag ;
  • RCObject& operator= (const RCObject&) ;

Documentation:

• Public members:

  inline ElementBase* getElement ()const ;

  Return the embedded element.

  virtual void makeSharable () ;

  Set sharable flag.
  The whole structure depending on this is marked as sharable. After this call a copyStructure() call reuses the element.

  virtual void trackBunch (PartBunch&,const PartData&,bool,bool)const = 0 ;

  Track a particle bunch.
  The first argument describes the particles in the bunch, the second argument describes the reference momentum and mass, revBeam true, means that the beam runs backwards, and revTrack true, means that we track against the beam.

  virtual void trackMap (FVps<double,6>&,const PartData&,bool,bool)const = 0 ;

  Track a map.
  The first argument describes the map to be tracked, the second argument describes the reference momentum and mass, revBeam true, means that the beam runs backwards, and revTrack true, means that we track against the beam.

  virtual void trackParticle (Particle&,const PartData&,bool,bool)const = 0 ;

  Track a particle.
  The first argument describes the particle's phase space position, the second argument describes the particle's momentum and mass, revBeam true, means that the beam runs backwards, and revTrack true, means that we track against the beam.

• Protected members:

  Pointer<ElementBase> itsElement ;

  Pointer to the replaced element.