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

Representation for a beam stripping. More...

#include <BeamStrippingRep.h>

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

Public Member Functions

 BeamStrippingRep (const std::string &name)
 Constructor with given name. More...
 
 BeamStrippingRep ()
 
 BeamStrippingRep (const BeamStrippingRep &)
 
virtual ~BeamStrippingRep ()
 
virtual ElementBase * clone () const
 Return clone. More...
 
virtual Channel * getChannel (const std::string &aKey, bool=false)
 Construct a read/write channel. More...
 
virtual NullField & getField ()
 Get field. More...
 
virtual const NullField & getField () const
 Get field. More...
 
virtual PlanarArcGeometry & getGeometry ()
 Get geometry. More...
 
virtual const PlanarArcGeometry & getGeometry () const
 Get geometry. More...
 
virtual ElementImage * getImage () const
 Construct an image. More...
 
- Public Member Functions inherited from BeamStripping
 BeamStripping (const std::string &name)
 Constructor with given name. More...
 
 BeamStripping ()
 
 BeamStripping (const BeamStripping &rhs)
 
virtual ~BeamStripping ()
 
virtual void accept (BeamlineVisitor &) const
 Apply visitor to BeamStripping. More...
 
virtual bool apply (const size_t &i, const double &t, Vector_t &E, Vector_t &B)
 
virtual bool apply (const Vector_t &R, const Vector_t &P, const double &t, Vector_t &E, Vector_t &B)
 
virtual bool checkBeamStripping (PartBunchBase< double, 3 > *bunch, Cyclotron *cycl, const int turnnumber, const double t, const double tstep)
 
virtual bool checkBeamStripping (Vector_t r, Vector_t rmin, Vector_t rmax)
 
virtual void initialise (PartBunchBase< double, 3 > *bunch, double &startField, double &endField)
 
virtual void initialise (PartBunchBase< double, 3 > *bunch, const double &scaleFactor)
 
virtual void finalise ()
 
virtual bool bends () const
 
virtual void goOnline (const double &kineticEnergy)
 
virtual void goOffline ()
 
virtual ElementBase::ElementType getType () const
 Get element type std::string. More...
 
virtual void getDimensions (double &zBegin, double &zEnd) const
 
std::string getBeamStrippingShape ()
 
int checkPoint (const double &x, const double &y, const double &z)
 
double checkPressure (const double &x, const double &y)
 
void setPressure (double pressure)
 
double getPressure () const
 
void setTemperature (double temperature)
 
double getTemperature () const
 
void setPressureMapFN (std::string pmapfn)
 
virtual std::string getPressureMapFN () const
 
void setPScale (double ps)
 
virtual double getPScale () const
 
void setResidualGas (std::string gas)
 
virtual std::string getResidualGas () const
 
void setStop (bool stopflag)
 
virtual bool getStop () const
 
- Public Member Functions inherited from Component
 Component (const std::string &name)
 Constructor with given name. More...
 
 Component ()
 
 Component (const Component &right)
 
virtual ~Component ()
 
EVector Efield (const Point3D &P) const
 Return the field in a point. More...
 
BVector Bfield (const Point3D &P) const
 Return the field in a point. More...
 
EVector Efield (const Point3D &P, double t) const
 Return the field in a point. More...
 
BVector Bfield (const Point3D &P, double t) const
 Return the field in a point. More...
 
EBVectors EBfield (const Point3D &P) const
 Return the field in a point. More...
 
EBVectors EBfield (const Point3D &P, double t) const
 Return the field in a point. More...
 
virtual void addKR (int i, double t, Vector_t &K)
 
virtual void addKT (int i, double t, Vector_t &K)
 
virtual bool applyToReferenceParticle (const Vector_t &R, const Vector_t &P, const double &t, Vector_t &E, Vector_t &B)
 
virtual bool getPotential (const Vector_t &R, const double &t, Vector_t &A, double &phi)
 
virtual double getDesignEnergy () const
 
virtual void setDesignEnergy (const double &energy, bool changeable)
 
virtual bool Online ()
 
virtual void setComponentType (std::string)
 
virtual std::string getComponentType () const
 
virtual const ElementBase & getDesign () const
 Return design element. More...
 
virtual void trackBunch (PartBunchBase< double, 3 > *bunch, const PartData &, bool revBeam, bool revTrack) const
 Track particle bunch. More...
 
virtual void trackMap (FVps< double, 6 > &map, const PartData &, bool revBeam, bool revTrack) const
 Track a map. More...
 
void setExitFaceSlope (const double &)
 
- 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 const ConstChannel * getConstChannel (const std::string &aKey) const
 Construct a read-only channel. More...
 
virtual ElementBase * copyStructure ()
 Make a structural copy. More...
 
bool isSharable () const
 Test if the element can be shared. More...
 
virtual void makeSharable ()
 Set sharable flag. More...
 
virtual ElementBase * makeAlignWrapper ()
 Allow misalignment. More...
 
virtual ElementBase * makeFieldWrapper ()
 Allow field errors. More...
 
virtual ElementBase * makeWrappers ()
 Allow errors. More...
 
virtual ElementBase * removeAlignWrapper ()
 Remove align wrapper. More...
 
virtual const ElementBase * removeAlignWrapper () const
 Remove align wrapper. More...
 
virtual ElementBase * removeFieldWrapper ()
 Remove field wrapper. More...
 
virtual const ElementBase * removeFieldWrapper () const
 Remove field wrapper. More...
 
virtual ElementBase * removeWrappers ()
 Return the design element. More...
 
virtual const ElementBase * removeWrappers () const
 Return the design element. More...
 
bool update (const AttributeSet &)
 Update element. More...
 
virtual void setBoundaryGeometry (BoundaryGeometry *geo)
 
virtual BoundaryGeometry * getBoundaryGeometry () 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 WakeFunction * getWake () 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

void operator= (const BeamStrippingRep &)
 

Private Attributes

NullField field
 
PlanarArcGeometry geometry
 

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 BeamStripping
void initR (double rmin, double dr, int nrad)
 
void getPressureFromFile (const double &scaleFactor)
 
int idx (int irad, int ktet)
 
- 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
 
RCObject & operator= (const RCObject &right)
 
- Protected Attributes inherited from BeamStripping
PFieldData PField
 
PPositions PP
 
- Protected Attributes inherited from Component
double exit_face_slope_m
 
PartBunchBase< double, 3 > * RefPartBunch_m
 
bool online_m
 
- 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
 
- Static Protected Attributes inherited from Component
static const std::vector< double > defaultAperture_m
 

Detailed Description

Representation for a beam stripping.

Definition at line 30 of file BeamStrippingRep.h.

Constructor & Destructor Documentation

BeamStrippingRep::BeamStrippingRep ( const std::string &  name)
explicit

Constructor with given name.

Definition at line 56 of file BeamStrippingRep.cpp.

BeamStrippingRep::BeamStrippingRep ( )

Definition at line 46 of file BeamStrippingRep.cpp.

Referenced by clone().

BeamStrippingRep::BeamStrippingRep ( const BeamStrippingRep &  right)

Definition at line 51 of file BeamStrippingRep.cpp.

BeamStrippingRep::~BeamStrippingRep ( )
virtual

Definition at line 61 of file BeamStrippingRep.cpp.

Member Function Documentation

ElementBase * BeamStrippingRep::clone ( ) const
virtual

Return clone.

Implements ElementBase.

Definition at line 65 of file BeamStrippingRep.cpp.

References BeamStrippingRep().

Here is the call graph for this function:

Channel * BeamStrippingRep::getChannel ( const std::string &  aKey,
bool  create = false 
)
virtual

Construct a read/write channel.

Reimplemented from ElementBase.

Definition at line 70 of file BeamStrippingRep.cpp.

References ElementBase::getChannel().

Here is the call graph for this function:

NullField & BeamStrippingRep::getField ( )
virtual

Get field.

Implements Component.

Definition at line 80 of file BeamStrippingRep.cpp.

References field.

const NullField & BeamStrippingRep::getField ( ) const
virtual

Get field.

Implements Component.

Definition at line 84 of file BeamStrippingRep.cpp.

References field.

PlanarArcGeometry & BeamStrippingRep::getGeometry ( )
virtual

Get geometry.

Implements ElementBase.

Definition at line 89 of file BeamStrippingRep.cpp.

References geometry.

const PlanarArcGeometry & BeamStrippingRep::getGeometry ( ) const
virtual

Get geometry.

Implements ElementBase.

Definition at line 93 of file BeamStrippingRep.cpp.

References geometry.

ElementImage * BeamStrippingRep::getImage ( ) const
virtual

Construct an image.

Reimplemented from ElementBase.

Definition at line 98 of file BeamStrippingRep.cpp.

References ElementBase::getImage(), and AttributeSet::setAttribute().

Here is the call graph for this function:

void BeamStrippingRep::operator= ( const BeamStrippingRep &  )
private

Member Data Documentation

NullField BeamStrippingRep::field
private

Definition at line 82 of file BeamStrippingRep.h.

Referenced by getField().

PlanarArcGeometry BeamStrippingRep::geometry
private

Definition at line 85 of file BeamStrippingRep.h.

Referenced by getGeometry().

The documentation for this class was generated from the following files:
Generated on Sat Jan 4 2020 14:49:49 for OPAL (Object Oriented Parallel Accelerator Library) by   doxygen 1.8.5