OPAL (Object Oriented Parallel Accelerator Library)  2.2.0
OPAL
Public Member Functions | Private Member Functions | Private Attributes | List of all members
MPSplitIntegrator Class Reference

Integrator replacing each multipole by a set of thin lenses. More...

#include <MPSplitIntegrator.h>

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

Public Member Functions

 MPSplitIntegrator (Multipole *, int slices)
 Constructor. More...
 
 MPSplitIntegrator (const MPSplitIntegrator &)
 
virtual ~MPSplitIntegrator ()
 
virtual MPSplitIntegratorclone () const
 Make clone. More...
 
virtual BGeometryBasegetGeometry ()
 Get geometry. More...
 
virtual const BGeometryBasegetGeometry () const
 Get geometry. More...
 
virtual ElementBase::ElementType getType () const
 Get element type string. More...
 
virtual void getMap (FVps< double, 6 > &map, const PartData &data, bool revBeam, bool revTrack) const
 Get map from MPSplitIntegrator. More...
 
virtual void trackMap (FVps< double, 6 > &map, const PartData &data, bool revBeam, bool revTrack) const
 Track map through MPSplitIntegrator. More...
 
virtual void trackParticle (OpalParticle &part, const PartData &data, bool revBeam, bool revTrack) const
 Track particle through MPSplitIntegrator. More...
 
virtual void trackBunch (PartBunchBase< double, 3 > *bunch, const PartData &data, bool revBeam, bool revTrack) const
 Track particle bunch through MPSplitIntegrator. More...
 
void getSlices (std::vector< double > &v) const
 Return slice positions. More...
 
- Public Member Functions inherited from MapIntegrator
 MapIntegrator (ElementBase *)
 
 MapIntegrator (const MapIntegrator &right)
 
virtual ~MapIntegrator ()
 
virtual void accept (BeamlineVisitor &visitor) const
 Apply visitor. 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...
 
std::string getTypeString () const
 
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

 MPSplitIntegrator ()
 
void operator= (const MPSplitIntegrator &)
 
void applyDrift (FVps< double, 6 > &map, double, const PartData &) const
 
void applyMultipole (FVps< double, 6 > &map, const BMultipoleField &field, double factor) const
 
void applyDrift (OpalParticle &, double, const PartData &) const
 
void applyMultipole (OpalParticle &, const BMultipoleField &field, double factor) const
 

Private Attributes

MultipoleitsMultipole
 
int itsSlices
 

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

Integrator replacing each multipole by a set of thin lenses.

Definition at line 67 of file MPSplitIntegrator.h.

Constructor & Destructor Documentation

MPSplitIntegrator::MPSplitIntegrator ( Multipole mult,
int  slices 
)

Constructor.

Definition at line 38 of file MPSplitIntegrator.cpp.

MPSplitIntegrator::MPSplitIntegrator ( const MPSplitIntegrator rhs)

Definition at line 43 of file MPSplitIntegrator.cpp.

MPSplitIntegrator::~MPSplitIntegrator ( )
virtual

Definition at line 48 of file MPSplitIntegrator.cpp.

MPSplitIntegrator::MPSplitIntegrator ( )
private

Referenced by clone().

Member Function Documentation

void MPSplitIntegrator::applyDrift ( FVps< double, 6 > &  map,
double  length,
const PartData reference 
) const
private

Definition at line 179 of file MPSplitIntegrator.cpp.

References PartData::getM(), PartData::getP(), and Hypervolume::ref.

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

Here is the call graph for this function:

void MPSplitIntegrator::applyDrift ( OpalParticle part,
double  length,
const PartData reference 
) const
private
void MPSplitIntegrator::applyMultipole ( FVps< double, 6 > &  map,
const BMultipoleField field,
double  factor 
) const
private

Definition at line 207 of file MPSplitIntegrator.cpp.

References BMultipoleField::normal(), BMultipoleField::order(), and BMultipoleField::skew().

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

Here is the call graph for this function:

void MPSplitIntegrator::applyMultipole ( OpalParticle part,
const BMultipoleField field,
double  factor 
) const
private
MPSplitIntegrator * MPSplitIntegrator::clone ( ) const
virtual

Make clone.

Implements MapIntegrator.

Definition at line 52 of file MPSplitIntegrator.cpp.

References MPSplitIntegrator().

Here is the call graph for this function:

BGeometryBase & MPSplitIntegrator::getGeometry ( )
virtual

Get geometry.

Implements ElementBase.

Definition at line 57 of file MPSplitIntegrator.cpp.

References ElementBase::getGeometry(), and Integrator::itsElement.

Here is the call graph for this function:

const BGeometryBase & MPSplitIntegrator::getGeometry ( ) const
virtual

Get geometry.

Implements ElementBase.

Definition at line 62 of file MPSplitIntegrator.cpp.

References ElementBase::getGeometry(), and Integrator::itsElement.

Here is the call graph for this function:

void MPSplitIntegrator::getMap ( FVps< double, 6 > &  map,
const PartData data,
bool  revBeam,
bool  revTrack 
) const
virtual

Get map from MPSplitIntegrator.

Implements MapIntegrator.

Definition at line 72 of file MPSplitIntegrator.cpp.

References trackMap().

Here is the call graph for this function:

void MPSplitIntegrator::getSlices ( std::vector< double > &  v) const

Return slice positions.

Definition at line 255 of file MPSplitIntegrator.cpp.

References itsSlices.

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

ElementBase::ElementType MPSplitIntegrator::getType ( ) const
virtual

Get element type string.

Implements ElementBase.

Definition at line 67 of file MPSplitIntegrator.cpp.

References ElementBase::MPSPLITINTEGRATOR.

void MPSplitIntegrator::operator= ( const MPSplitIntegrator )
private
void MPSplitIntegrator::trackBunch ( PartBunchBase< double, 3 > *  bunch,
const PartData data,
bool  revBeam,
bool  revTrack 
) const
virtual
void MPSplitIntegrator::trackMap ( FVps< double, 6 > &  map,
const PartData data,
bool  revBeam,
bool  revTrack 
) const
virtual

Track map through MPSplitIntegrator.

Reimplemented from MapIntegrator.

Definition at line 79 of file MPSplitIntegrator.cpp.

References applyDrift(), applyMultipole(), Physics::c, ElementBase::getElementLength(), Multipole::getField(), PartData::getP(), PartData::getQ(), getSlices(), itsMultipole, and itsSlices.

Referenced by getMap().

Here is the call graph for this function:

void MPSplitIntegrator::trackParticle ( OpalParticle part,
const PartData data,
bool  revBeam,
bool  revTrack 
) const
virtual

Track particle through MPSplitIntegrator.

Reimplemented from MapIntegrator.

Definition at line 110 of file MPSplitIntegrator.cpp.

References applyDrift(), applyMultipole(), Physics::c, ElementBase::getElementLength(), Multipole::getField(), PartData::getP(), PartData::getQ(), getSlices(), itsMultipole, and itsSlices.

Here is the call graph for this function:

Member Data Documentation

Multipole* MPSplitIntegrator::itsMultipole
private

Definition at line 141 of file MPSplitIntegrator.h.

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

int MPSplitIntegrator::itsSlices
private

Definition at line 144 of file MPSplitIntegrator.h.

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


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