OPAL (Object Oriented Parallel Accelerator Library)  2.2.0
OPAL
Public Member Functions | Private Member Functions | List of all members
MapIntegrator Class Referenceabstract

Integrate a map. More...

#include <MapIntegrator.h>

Inheritance diagram for MapIntegrator:
Inheritance graph
[legend]
Collaboration diagram for MapIntegrator:
Collaboration graph
[legend]

Public Member Functions

 MapIntegrator (ElementBase *)
 
 MapIntegrator (const MapIntegrator &right)
 
virtual ~MapIntegrator ()
 
virtual void accept (BeamlineVisitor &visitor) const
 Apply visitor. More...
 
virtual MapIntegratorclone () const =0
 Make a clone. More...
 
virtual void trackParticle (OpalParticle &part, const PartData &, bool revBeam, bool revTrack) const
 Track a particle. More...
 
virtual void trackBunch (PartBunchBase< double, 3 > *, const PartData &, bool revBeam, bool revTrack) const
 Track a particle bunch. More...
 
virtual void trackMap (FVps< double, 6 > &, const PartData &, bool revBeam, bool revTrack) const
 Track a map. More...
 
- Public Member Functions inherited from TrackIntegrator
 TrackIntegrator (ElementBase *)
 
 TrackIntegrator (const TrackIntegrator &)
 
virtual ~TrackIntegrator ()
 
- Public Member Functions inherited from Integrator
 Integrator (ElementBase *)
 
 Integrator (const Integrator &rhs)
 
virtual ~Integrator ()
 
ElementBasegetElement () const
 Return the embedded element. More...
 
virtual void makeSharable ()
 Set sharable flag. More...
 
- Public Member Functions inherited from ElementBase
 ElementBase (const std::string &name)
 Constructor with given name. More...
 
 ElementBase ()
 
 ElementBase (const ElementBase &)
 
virtual ~ElementBase ()
 
virtual const std::string & getName () const
 Get element name. More...
 
virtual void setName (const std::string &name)
 Set element name. More...
 
virtual ElementType getType () const =0
 Get element type std::string. More...
 
std::string getTypeString () const
 
virtual BGeometryBasegetGeometry ()=0
 Get geometry. More...
 
virtual const BGeometryBasegetGeometry () const =0
 Get geometry. More...
 
virtual double getArcLength () const
 Get arc length. More...
 
virtual double getElementLength () const
 Get design length. More...
 
virtual void setElementLength (double length)
 Set design length. More...
 
virtual void getElementDimensions (double &begin, double &end) const
 
virtual double getOrigin () const
 Get origin position. More...
 
virtual double getEntrance () const
 Get entrance position. More...
 
virtual double getExit () const
 Get exit position. More...
 
virtual Euclid3D getTransform (double fromS, double toS) const
 Get transform. More...
 
virtual Euclid3D getTransform (double s) const
 Get transform. More...
 
virtual Euclid3D getTotalTransform () const
 Get transform. More...
 
virtual Euclid3D getEntranceFrame () const
 Get transform. More...
 
virtual Euclid3D getExitFrame () const
 Get transform. More...
 
virtual Euclid3D getEntrancePatch () const
 Get patch. More...
 
virtual Euclid3D getExitPatch () const
 Get patch. More...
 
virtual double getAttribute (const std::string &aKey) const
 Get attribute value. More...
 
virtual bool hasAttribute (const std::string &aKey) const
 Test for existence of an attribute. More...
 
virtual void removeAttribute (const std::string &aKey)
 Remove an existing attribute. More...
 
virtual void setAttribute (const std::string &aKey, double val)
 Set value of an attribute. More...
 
virtual ChannelgetChannel (const std::string &aKey, bool create=false)
 Construct a read/write channel. More...
 
virtual const ConstChannelgetConstChannel (const std::string &aKey) const
 Construct a read-only channel. More...
 
virtual ElementImagegetImage () const
 Construct an image. More...
 
virtual ElementBasecopyStructure ()
 Make a structural copy. More...
 
bool isSharable () const
 Test if the element can be shared. More...
 
virtual ElementBasemakeAlignWrapper ()
 Allow misalignment. More...
 
virtual ElementBasemakeFieldWrapper ()
 Allow field errors. More...
 
virtual ElementBasemakeWrappers ()
 Allow errors. More...
 
virtual ElementBaseremoveAlignWrapper ()
 Remove align wrapper. More...
 
virtual const ElementBaseremoveAlignWrapper () const
 Remove align wrapper. More...
 
virtual ElementBaseremoveFieldWrapper ()
 Remove field wrapper. More...
 
virtual const ElementBaseremoveFieldWrapper () const
 Remove field wrapper. More...
 
virtual ElementBaseremoveWrappers ()
 Return the design element. More...
 
virtual const ElementBaseremoveWrappers () const
 Return the design element. More...
 
bool update (const AttributeSet &)
 Update element. More...
 
virtual void setBoundaryGeometry (BoundaryGeometry *geo)
 
virtual BoundaryGeometrygetBoundaryGeometry () const
 return the attached boundary geometrt object if there is any More...
 
virtual bool hasBoundaryGeometry () const
 
virtual void setWake (WakeFunction *wf)
 attach a wake field to the element More...
 
virtual WakeFunctiongetWake () const
 return the attached wake object if there is any More...
 
virtual bool hasWake () const
 
virtual void setParticleMatterInteraction (ParticleMatterInteractionHandler *spys)
 
virtual
ParticleMatterInteractionHandler
getParticleMatterInteraction () const
 
virtual bool hasParticleMatterInteraction () const
 
ElemType getElType () const
 returns element type as enumeration needed in the envelope tracker More...
 
void setElType (ElemType elt)
 set the element type as enumeration needed in the envelope tracker More...
 
void setCSTrafoGlobal2Local (const CoordinateSystemTrafo &ori)
 
CoordinateSystemTrafo getCSTrafoGlobal2Local () const
 
void releasePosition ()
 
void fixPosition ()
 
bool isPositioned () const
 
virtual CoordinateSystemTrafo getEdgeToBegin () const
 
virtual CoordinateSystemTrafo getEdgeToEnd () const
 
void setAperture (const ApertureType &type, const std::vector< double > &args)
 
std::pair
< ElementBase::ApertureType,
std::vector< double > > 
getAperture () const
 
virtual bool isInside (const Vector_t &r) const
 
void setMisalignment (double x, double y, double s)
 
void setMisalignment (const CoordinateSystemTrafo &cst)
 
void getMisalignment (double &x, double &y, double &s) const
 
CoordinateSystemTrafo getMisalignment () const
 
void setActionRange (const std::queue< std::pair< double, double > > &range)
 
void setCurrentSCoordinate (double s)
 
void setRotationAboutZ (double rotation)
 Set rotation about z axis in bend frame. More...
 
double getRotationAboutZ () const
 
void setElementPosition (double elemedge)
 Access to ELEMEDGE attribute. More...
 
double getElementPosition () const
 
bool isElementPositionSet () const
 
- Public Member Functions inherited from RCObject
int addReference () const
 Increment reference count. More...
 
int removeReference () const
 Decrement the reference count. More...
 
bool isShared () const
 Test for sharing. More...
 

Private Member Functions

 MapIntegrator ()
 
void operator= (const MapIntegrator &)
 
virtual void getMap (FVps< double, 6 > &, const PartData &, bool revBeam, bool revTrack) const =0
 

Additional Inherited Members

- Public Types inherited from ElementBase
enum  ApertureType { RECTANGULAR, ELLIPTICAL, CONIC_RECTANGULAR, CONIC_ELLIPTICAL }
 
enum  ElementType {
  ALIGNWRAPPER, BEAMBEAM, BEAMBEAM3D, BEAMLINE,
  BEAMSTRIPPING, CCOLLIMATOR, CORRECTOR, CORRECTORWRAPPER,
  CYCLOTRON, CYCLOTRONWRAPPER, CYCLOTRONVALLEY, DEGRADER,
  DIAGNOSTIC, DRIFT, FLEXIBLECOLLIMATOR, INTEGRATOR,
  LAMBERTSON, MARKER, MONITOR, MPSPLITINTEGRATOR,
  MULTIPOLE, MULTIPOLET, MULTIPOLEWRAPPER, OFFSET,
  PARALLELPLATE, PATCH, PROBE, RBEND,
  RBEND3D, RBENDWRAPPER, RFCAVITY, RFQUADRUPOLE,
  RING, SBEND3D, SBEND, SBENDWRAPPER,
  SEPARATOR, SEPTUM, SOLENOID, SOURCE,
  STRIPPER, TRAVELINGWAVE, VARIABLERFCAVITY, ANY
}
 
- Static Public Member Functions inherited from ElementBase
static std::string getTypeString (ElementType type)
 
- Protected Member Functions inherited from ElementBase
bool isInsideTransverse (const Vector_t &r, double f=1) const
 
- Protected Member Functions inherited from RCObject
 RCObject ()
 Default constructor. More...
 
 RCObject (const RCObject &)
 Copy constructor. More...
 
virtual ~RCObject ()=0
 
RCObjectoperator= (const RCObject &right)
 
- Protected Attributes inherited from Integrator
Pointer< ElementBaseitsElement
 Pointer to the replaced element. More...
 
- Protected Attributes inherited from ElementBase
bool shareFlag
 
CoordinateSystemTrafo csTrafoGlobal2Local_m
 
CoordinateSystemTrafo misalignment_m
 
std::pair< ApertureType,
std::vector< double > > 
aperture_m
 
double elementEdge_m
 
double rotationZAxis_m
 

Detailed Description

Integrate a map.

Definition at line 41 of file MapIntegrator.h.

Constructor & Destructor Documentation

MapIntegrator::MapIntegrator ( ElementBase elem)
explicit

Definition at line 34 of file MapIntegrator.cpp.

MapIntegrator::MapIntegrator ( const MapIntegrator right)

Definition at line 39 of file MapIntegrator.cpp.

MapIntegrator::~MapIntegrator ( )
virtual

Definition at line 44 of file MapIntegrator.cpp.

MapIntegrator::MapIntegrator ( )
private

Member Function Documentation

void MapIntegrator::accept ( BeamlineVisitor visitor) const
virtual

Apply visitor.

Reimplemented from TrackIntegrator.

Definition at line 48 of file MapIntegrator.cpp.

References BeamlineVisitor::visitMapIntegrator().

Here is the call graph for this function:

virtual MapIntegrator* MapIntegrator::clone ( ) const
pure virtual

Make a clone.

Implements TrackIntegrator.

Implemented in MPSplitIntegrator.

virtual void MapIntegrator::getMap ( FVps< double, 6 > &  ,
const PartData ,
bool  revBeam,
bool  revTrack 
) const
privatepure virtual

Implemented in MPSplitIntegrator.

Referenced by trackBunch(), trackMap(), and trackParticle().

void MapIntegrator::operator= ( const MapIntegrator )
private
void MapIntegrator::trackBunch ( PartBunchBase< double, 3 > *  bunch,
const PartData ref,
bool  revBeam,
bool  revTrack 
) const
virtual

Track a particle bunch.

Implements Integrator.

Reimplemented in MPSplitIntegrator.

Definition at line 75 of file MapIntegrator.cpp.

References FVps< T, N >::constantTerm(), PartBunchBase< T, Dim >::get_part(), PartBunchBase< T, Dim >::getLocalNum(), getMap(), and PartBunchBase< T, Dim >::set_part().

Referenced by Tracker::visitMapIntegrator().

Here is the call graph for this function:

void MapIntegrator::trackMap ( FVps< double, 6 > &  map,
const PartData ref,
bool  revBeam,
bool  revTrack 
) const
virtual

Track a map.

Reimplemented from TrackIntegrator.

Reimplemented in MPSplitIntegrator.

Definition at line 98 of file MapIntegrator.cpp.

References getMap(), and FVps< T, N >::substitute().

Referenced by Mapper::visitMapIntegrator(), LinearMapper::visitMapIntegrator(), and TransportMapper::visitMapIntegrator().

Here is the call graph for this function:

void MapIntegrator::trackParticle ( OpalParticle part,
const PartData ref,
bool  revBeam,
bool  revTrack 
) const
virtual

Track a particle.

Implements Integrator.

Reimplemented in MPSplitIntegrator.

Definition at line 53 of file MapIntegrator.cpp.

References FVps< T, N >::constantTerm(), getMap(), OpalParticle::pt(), OpalParticle::px(), OpalParticle::py(), OpalParticle::x(), and OpalParticle::y().

Here is the call graph for this function:


The documentation for this class was generated from the following files: