|
OPAL (Object Oriented Parallel Accelerator Library) 2022.1
OPAL
|
#include <PluginElement.h>


Public Member Functions | |
| PluginElement (const std::string &name) | |
| Constructor with given name. More... | |
| PluginElement () | |
| PluginElement (const PluginElement &) | |
| void | operator= (const PluginElement &)=delete |
| virtual | ~PluginElement () |
| void | setDimensions (double xstart, double xend, double ystart, double yend) |
| Set dimensions and consistency checks. More... | |
| bool | check (PartBunchBase< double, 3 > *bunch, const int turnnumber, const double t, const double tstep) |
| int | checkPoint (const double &x, const double &y) const |
| Checks if coordinate is within element. More... | |
| void | save () |
| Save output. More... | |
| virtual void | initialise (PartBunchBase< double, 3 > *bunch, double &startField, double &endField) override |
| Pure virtual implementation of Component. More... | |
| void | initialise (PartBunchBase< double, 3 > *bunch) |
| virtual void | finalise () final |
| virtual void | goOffline () final |
| virtual bool | bends () const override |
| virtual void | getDimensions (double &zBegin, double &zEnd) const override |
| virtual bool | apply (const size_t &i, const double &t, Vector_t &E, Vector_t &B) override |
| virtual bool | applyToReferenceParticle (const Vector_t &R, const Vector_t &P, const double &t, Vector_t &E, Vector_t &B) override |
| double | getXStart () const |
| Member variable access. More... | |
| double | getXEnd () const |
| double | getYStart () const |
| double | getYEnd () const |
Public Member Functions inherited from Component | |
| Component (const std::string &name) | |
| Constructor with given name. More... | |
| Component () | |
| Component (const Component &right) | |
| virtual | ~Component () |
| virtual EMField & | getField ()=0 |
| Return field. More... | |
| virtual const EMField & | getField () const =0 |
| Return field. More... | |
| 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 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 | applyToReferenceParticle (const Vector_t &R, const Vector_t &P, const double &t, Vector_t &E, Vector_t &B) |
| virtual bool | getPotential (const Vector_t &, const double &, Vector_t &, double &) |
| virtual double | getDesignEnergy () const |
| virtual void | setDesignEnergy (const double &energy, bool changeable=true) |
| virtual void | initialise (PartBunchBase< double, 3 > *bunch, double &startField, double &endField)=0 |
| virtual void | finalise ()=0 |
| virtual bool | bends () const =0 |
| virtual void | goOnline (const double &kineticEnergy) |
| virtual void | goOffline () |
| virtual bool | Online () |
| virtual void | getDimensions (double &zBegin, double &zEnd) const =0 |
| virtual ElementType | getType () const |
| Get element type std::string. More... | |
| 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... | |
| virtual ElementType | getType () const =0 |
| Get element type std::string. More... | |
| std::string | getTypeString () const |
| virtual BGeometryBase & | getGeometry ()=0 |
| Get geometry. More... | |
| virtual const BGeometryBase & | getGeometry () 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 Channel * | getChannel (const std::string &aKey, bool create=false) |
| Construct a read/write channel. More... | |
| virtual const ConstChannel * | getConstChannel (const std::string &aKey) const |
| Construct a read-only channel. More... | |
| virtual void | accept (BeamlineVisitor &visitor) const =0 |
| Apply visitor. More... | |
| virtual ElementBase * | clone () const =0 |
| Return clone. 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... | |
| 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 |
| 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< ApertureType, std::vector< double > > | getAperture () const |
| virtual bool | isInside (const Vector_t &r) const |
| 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 |
| virtual BoundingBox | getBoundingBoxInLabCoords () const |
| virtual int | getRequiredNumberOfTimeSteps () const |
| void | setOutputFN (std::string fn) |
| Set output filename. More... | |
| std::string | getOutputFN () const |
| Get output filename. More... | |
| void | setFlagDeleteOnTransverseExit (bool=true) |
| bool | getFlagDeleteOnTransverseExit () 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... | |
Protected Member Functions | |
| void | setGeom (const double dist) |
| Sets geometry geom_m with element width dist. More... | |
| void | changeWidth (PartBunchBase< double, 3 > *bunch, int i, const double tstep, const double tangle) |
| Change probe width depending on step size and angle of particle. More... | |
| double | calculateIncidentAngle (double xp, double yp) const |
| Calculate angle of particle/bunch wrt to element. More... | |
Protected Member Functions inherited from ElementBase | |
| bool | isInsideTransverse (const Vector_t &r) 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 | |
| double | rmin_m |
| radius closest to the origin More... | |
| Point | geom_m [5] |
| actual geometry positions with adaptive width such that each particle hits element once per turn More... | |
| double | A_m |
| double | B_m |
| double | R_m |
| double | C_m |
| Geometric lengths used in calculations. More... | |
| std::unique_ptr< LossDataSink > | lossDs_m |
| Pointer to Loss instance. More... | |
| int | numPassages_m = 0 |
| Number of turns (number of times save() method is called) More... | |
| double | xstart_m |
| input geometry positions More... | |
| double | xend_m |
| double | ystart_m |
| double | yend_m |
| double | rstart_m |
| double | rend_m |
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 |
Private Member Functions | |
| bool | preCheck (PartBunchBase< double, 3 > *bunch) |
| Check if bunch is close to element. More... | |
| bool | finaliseCheck (PartBunchBase< double, 3 > *bunch, bool flagNeedUpdate) |
| Finalise call after check. More... | |
| virtual void | doInitialise (PartBunchBase< double, 3 > *) |
| Pure virtual hook for initialise. More... | |
| virtual bool | doCheck (PartBunchBase< double, 3 > *bunch, const int turnnumber, const double t, const double tstep)=0 |
| Pure virtual hook for check. More... | |
| virtual void | doSetGeom () |
| Virtual hook for setGeom. More... | |
| virtual bool | doPreCheck (PartBunchBase< double, 3 > *) |
| Virtual hook for preCheck. More... | |
| virtual bool | doFinaliseCheck (PartBunchBase< double, 3 > *, bool flagNeedUpdate) |
| Virtual hook for finaliseCheck. More... | |
| virtual void | doFinalise () |
| Virtual hook for finalise. More... | |
| virtual void | doGoOffline () |
| Virtual hook for goOffline. More... | |
Additional Inherited Members | |
Static Public Member Functions inherited from ElementBase | |
| static std::string | getTypeString (ElementType type) |
Static Protected Attributes inherited from Component | |
| static const std::vector< double > | defaultAperture_m |
Definition at line 30 of file PluginElement.h.
|
explicit |
Constructor with given name.
Definition at line 33 of file PluginElement.cpp.
References setDimensions().

| PluginElement::PluginElement | ( | ) |
Definition at line 30 of file PluginElement.cpp.
| PluginElement::PluginElement | ( | const PluginElement & | right | ) |
Definition at line 38 of file PluginElement.cpp.
References setDimensions(), xend_m, xstart_m, yend_m, and ystart_m.

|
virtual |
Definition at line 43 of file PluginElement.cpp.
|
overridevirtual |
Virtual implementation of Component
Reimplemented from Component.
Definition at line 78 of file PluginElement.cpp.
|
overridevirtual |
Reimplemented from Component.
Definition at line 82 of file PluginElement.cpp.
|
overridevirtual |
Implements Component.
Definition at line 74 of file PluginElement.cpp.
|
protected |
Calculate angle of particle/bunch wrt to element.
Definition at line 153 of file PluginElement.cpp.
References A_m, abs(), and B_m.
Referenced by Probe::doCheck(), and Stripper::doCheck().

|
protected |
Change probe width depending on step size and angle of particle.
Definition at line 145 of file PluginElement.cpp.
References Physics::c, euclidean_norm(), Util::getGamma(), PartBunchBase< T, Dim >::P, Units::s2ns, setGeom(), and sqrt().
Referenced by Probe::doCheck(), and Stripper::doCheck().

| bool PluginElement::check | ( | PartBunchBase< double, 3 > * | bunch, |
| const int | turnnumber, | ||
| const double | t, | ||
| const double | tstep | ||
| ) |
Check if bunch particles are lost
Definition at line 194 of file PluginElement.cpp.
References doCheck(), finaliseCheck(), and preCheck().

| int PluginElement::checkPoint | ( | const double & | x, |
| const double & | y | ||
| ) | const |
Checks if coordinate is within element.
Definition at line 213 of file PluginElement.cpp.
References geom_m, and Point::y.
Referenced by CCollimator::doCheck(), Probe::doCheck(), and Stripper::doCheck().
|
privatepure virtual |
Pure virtual hook for check.
Implemented in CCollimator, Probe, Septum, and Stripper.
Referenced by check().
|
inlineprivatevirtual |
Virtual hook for finalise.
Reimplemented in CCollimator, and Stripper.
Definition at line 102 of file PluginElement.h.
Referenced by finalise().
|
inlineprivatevirtual |
Virtual hook for finaliseCheck.
Reimplemented in CCollimator, and Stripper.
Definition at line 100 of file PluginElement.h.
Referenced by finaliseCheck().
|
inlineprivatevirtual |
Virtual hook for goOffline.
Reimplemented in Probe.
Definition at line 104 of file PluginElement.h.
Referenced by goOffline().
|
inlineprivatevirtual |
Pure virtual hook for initialise.
Reimplemented in CCollimator, Probe, and Septum.
Definition at line 92 of file PluginElement.h.
Referenced by initialise().
|
inlineprivatevirtual |
Virtual hook for preCheck.
Reimplemented in CCollimator, Probe, Septum, and Stripper.
Definition at line 98 of file PluginElement.h.
Referenced by preCheck().
|
inlineprivatevirtual |
Virtual hook for setGeom.
Reimplemented in CCollimator.
Definition at line 96 of file PluginElement.h.
Referenced by setGeom().
|
finalvirtual |
Implements Component.
Definition at line 60 of file PluginElement.cpp.
References doFinalise(), and Component::online_m.

|
inlineprivate |
Finalise call after check.
Definition at line 90 of file PluginElement.h.
References doFinaliseCheck().
Referenced by check().

|
overridevirtual |
Implements Component.
Reimplemented in CCollimator.
Definition at line 208 of file PluginElement.cpp.
| double PluginElement::getXEnd | ( | ) | const |
Definition at line 182 of file PluginElement.cpp.
References xend_m.
Referenced by ParallelCyclotronTracker::visitCCollimator(), ParallelCyclotronTracker::visitProbe(), ParallelCyclotronTracker::visitSeptum(), and ParallelCyclotronTracker::visitStripper().
| double PluginElement::getXStart | ( | ) | const |
Member variable access.
Definition at line 178 of file PluginElement.cpp.
References xstart_m.
Referenced by ParallelCyclotronTracker::visitCCollimator(), ParallelCyclotronTracker::visitProbe(), ParallelCyclotronTracker::visitSeptum(), and ParallelCyclotronTracker::visitStripper().
| double PluginElement::getYEnd | ( | ) | const |
Definition at line 190 of file PluginElement.cpp.
References yend_m.
Referenced by ParallelCyclotronTracker::visitCCollimator(), ParallelCyclotronTracker::visitProbe(), ParallelCyclotronTracker::visitSeptum(), and ParallelCyclotronTracker::visitStripper().
| double PluginElement::getYStart | ( | ) | const |
Definition at line 186 of file PluginElement.cpp.
References ystart_m.
Referenced by ParallelCyclotronTracker::visitCCollimator(), ParallelCyclotronTracker::visitProbe(), ParallelCyclotronTracker::visitSeptum(), and ParallelCyclotronTracker::visitStripper().
|
finalvirtual |
Reimplemented from Component.
Definition at line 66 of file PluginElement.cpp.
References doGoOffline(), lossDs_m, and Component::online_m.
Referenced by Septum::initialise().

| void PluginElement::initialise | ( | PartBunchBase< double, 3 > * | bunch | ) |
Definition at line 52 of file PluginElement.cpp.
References Options::asciidump, doInitialise(), ElementBase::getOutputFN(), Component::goOnline(), lossDs_m, and Component::RefPartBunch_m.

|
overridevirtual |
Pure virtual implementation of Component.
Implements Component.
Reimplemented in Septum, and Septum.
Definition at line 48 of file PluginElement.cpp.
References initialise().
Referenced by initialise(), ParallelCyclotronTracker::visitCCollimator(), ParallelCyclotronTracker::visitProbe(), and ParallelCyclotronTracker::visitStripper().

|
delete |
|
inlineprivate |
Check if bunch is close to element.
Definition at line 88 of file PluginElement.h.
References doPreCheck().
Referenced by check().

| void PluginElement::save | ( | ) |
Save output.
Definition at line 227 of file PluginElement.cpp.
References OpalData::APPEND, OpalData::getInstance(), OpalData::getOpenMode(), lossDs_m, and numPassages_m.

| void PluginElement::setDimensions | ( | double | xstart, |
| double | xend, | ||
| double | ystart, | ||
| double | yend | ||
| ) |
Set dimensions and consistency checks.
Definition at line 86 of file PluginElement.cpp.
References A_m, abs(), B_m, C_m, max(), min(), R_m, rend_m, rmin_m, rstart_m, sqrt(), xend_m, xstart_m, yend_m, and ystart_m.
Referenced by PluginElement(), OpalProbe::update(), OpalSeptum::update(), and OpalStripper::update().

|
protected |
Sets geometry geom_m with element width dist.
Definition at line 116 of file PluginElement.cpp.
References doSetGeom(), geom_m, sqrt(), Point::x, xend_m, xstart_m, Point::y, yend_m, and ystart_m.
Referenced by CCollimator::CCollimator(), changeWidth(), Septum::Septum(), CCollimator::setDimensions(), and Septum::setWidth().

|
protected |
Definition at line 118 of file PluginElement.h.
Referenced by calculateIncidentAngle(), Probe::doCheck(), Stripper::doCheck(), and setDimensions().
|
protected |
Definition at line 118 of file PluginElement.h.
Referenced by calculateIncidentAngle(), Probe::doCheck(), Stripper::doCheck(), and setDimensions().
|
protected |
Geometric lengths used in calculations.
Definition at line 118 of file PluginElement.h.
Referenced by Probe::doCheck(), Stripper::doCheck(), and setDimensions().
|
protected |
actual geometry positions with adaptive width such that each particle hits element once per turn
Definition at line 117 of file PluginElement.h.
Referenced by checkPoint(), CCollimator::doSetGeom(), and setGeom().
|
protected |
Pointer to Loss instance.
Definition at line 120 of file PluginElement.h.
Referenced by CCollimator::doCheck(), Probe::doCheck(), Septum::doCheck(), Stripper::doCheck(), goOffline(), initialise(), and save().
|
protected |
Number of turns (number of times save() method is called)
Definition at line 121 of file PluginElement.h.
Referenced by save().
|
protected |
Definition at line 118 of file PluginElement.h.
Referenced by Probe::doCheck(), Stripper::doCheck(), and setDimensions().
|
protected |
Definition at line 114 of file PluginElement.h.
Referenced by Probe::doInitialise(), Probe::doPreCheck(), and setDimensions().
|
protected |
radius closest to the origin
Definition at line 116 of file PluginElement.h.
Referenced by Probe::doInitialise(), CCollimator::doPreCheck(), Probe::doPreCheck(), Stripper::doPreCheck(), and setDimensions().
|
protected |
Definition at line 113 of file PluginElement.h.
Referenced by Septum::doPreCheck(), and setDimensions().
|
protected |
Definition at line 110 of file PluginElement.h.
Referenced by CCollimator::CCollimator(), Septum::doCheck(), getXEnd(), PluginElement(), setDimensions(), and setGeom().
|
protected |
input geometry positions
Definition at line 109 of file PluginElement.h.
Referenced by CCollimator::CCollimator(), Septum::doCheck(), getXStart(), PluginElement(), setDimensions(), and setGeom().
|
protected |
Definition at line 112 of file PluginElement.h.
Referenced by CCollimator::CCollimator(), Septum::doCheck(), getYEnd(), PluginElement(), setDimensions(), and setGeom().
|
protected |
Definition at line 111 of file PluginElement.h.
Referenced by CCollimator::CCollimator(), Septum::doCheck(), getYStart(), PluginElement(), setDimensions(), and setGeom().