OPAL (Object Oriented Parallel Accelerator Library)
2.2.0
OPAL
|
Interface for beam position monitors. More...
#include <Monitor.h>
Public Types | |
enum | Plane { OFF, X, Y, XY } |
Plane selection. More... | |
enum | Type { TEMPORAL, SPATIAL } |
![]() | |
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 } |
Public Member Functions | |
Monitor (const std::string &name) | |
Constructor with given name. More... | |
Monitor () | |
Monitor (const Monitor &) | |
virtual | ~Monitor () |
virtual void | accept (BeamlineVisitor &) const override |
Apply visitor to Monitor. More... | |
virtual StraightGeometry & | getGeometry () override=0 |
Get geometry. More... | |
virtual const StraightGeometry & | getGeometry () const override=0 |
Get geometry. Version for const object. More... | |
virtual Plane | getPlane () const =0 |
Get plane on which monitor observes. More... | |
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 |
virtual void | initialise (PartBunchBase< double, 3 > *bunch, double &startField, double &endField) override |
virtual void | finalise () override |
virtual bool | bends () const override |
virtual void | goOnline (const double &kineticEnergy) override |
virtual void | goOffline () override |
virtual ElementBase::ElementType | getType () const override |
Get element type std::string. More... | |
virtual void | getDimensions (double &zBegin, double &zEnd) const override |
void | setOutputFN (std::string fn) |
void | setType (Type type) |
![]() | |
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 void | addKR (int i, double t, Vector_t &K) |
virtual void | addKT (int i, double t, Vector_t &K) |
virtual bool | apply (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 &) |
![]() | |
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 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 ElementImage * | getImage () const |
Construct an image. 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... | |
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 |
![]() | |
int | addReference () const |
Increment reference count. More... | |
int | removeReference () const |
Decrement the reference count. More... | |
bool | isShared () const |
Test for sharing. More... | |
Static Public Member Functions | |
static void | writeStatistics () |
![]() | |
static std::string | getTypeString (ElementType type) |
Private Member Functions | |
void | operator= (const Monitor &) |
Private Attributes | |
std::string | filename_m |
Plane | plane_m |
Type | type_m |
unsigned int | numPassages_m |
std::unique_ptr< LossDataSink > | lossDs_m |
Static Private Attributes | |
static std::map< double, SetStatistics > | statFileEntries_sm |
static const double | halfLength_s = 0.005 |
Additional Inherited Members | |
![]() | |
bool | isInsideTransverse (const Vector_t &r, double f=1) const |
![]() | |
RCObject () | |
Default constructor. More... | |
RCObject (const RCObject &) | |
Copy constructor. More... | |
virtual | ~RCObject ()=0 |
RCObject & | operator= (const RCObject &right) |
![]() | |
double | exit_face_slope_m |
PartBunchBase< double, 3 > * | RefPartBunch_m |
bool | online_m |
![]() | |
bool | shareFlag |
CoordinateSystemTrafo | csTrafoGlobal2Local_m |
CoordinateSystemTrafo | misalignment_m |
std::pair< ApertureType, std::vector< double > > | aperture_m |
double | elementEdge_m |
double | rotationZAxis_m |
![]() | |
static const std::vector< double > | defaultAperture_m |
enum Monitor::Plane |
enum Monitor::Type |
|
explicit |
Constructor with given name.
Definition at line 57 of file Monitor.cpp.
Monitor::Monitor | ( | ) |
Definition at line 43 of file Monitor.cpp.
Monitor::Monitor | ( | const Monitor & | right | ) |
Definition at line 48 of file Monitor.cpp.
|
virtual |
Definition at line 66 of file Monitor.cpp.
|
overridevirtual |
Apply visitor to Monitor.
Implements ElementBase.
Definition at line 70 of file Monitor.cpp.
References BeamlineVisitor::visitMonitor().
|
overridevirtual |
Reimplemented from Component.
Definition at line 74 of file Monitor.cpp.
References Physics::c, PartBunchBase< T, Dim >::dt, ElementBase::getElementLength(), Util::getGamma(), PartBunchBase< T, Dim >::ID, lossDs_m, Component::online_m, PartBunchBase< T, Dim >::P, Attrib::Distribution::R, PartBunchBase< T, Dim >::R, Component::RefPartBunch_m, SPATIAL, and type_m.
|
overridevirtual |
Reimplemented from Component.
Definition at line 93 of file Monitor.cpp.
References OpalData::APPEND, Physics::c, ElementBase::csTrafoGlobal2Local_m, euclidean_norm(), PartBunchBase< T, Dim >::get_sPos(), PartBunchBase< T, Dim >::getdT(), ElementBase::getElementLength(), Util::getGamma(), PartBunchBase< T, Dim >::getGlobalTrackStep(), OpalData::getInstance(), PartBunchBase< T, Dim >::getLocalNum(), OpalData::getOpenMode(), halfLength_s, PartBunchBase< T, Dim >::ID, lossDs_m, numPassages_m, PartBunchBase< T, Dim >::P, Attrib::Distribution::R, PartBunchBase< T, Dim >::R, Component::RefPartBunch_m, CoordinateSystemTrafo::rotateFrom(), TEMPORAL, CoordinateSystemTrafo::transformFrom(), and type_m.
|
overridevirtual |
Implements Component.
Definition at line 191 of file Monitor.cpp.
|
overridevirtual |
Implements Component.
Definition at line 172 of file Monitor.cpp.
|
overridevirtual |
|
overridepure virtual |
|
overridepure virtual |
|
pure virtual |
Get plane on which monitor observes.
Implemented in MonitorRep, XMonitorRep, and YMonitorRep.
|
overridevirtual |
Get element type std::string.
Reimplemented from Component.
Definition at line 205 of file Monitor.cpp.
References ElementBase::MONITOR.
Referenced by initialise().
|
overridevirtual |
Reimplemented from Component.
Definition at line 180 of file Monitor.cpp.
References lossDs_m, numPassages_m, statFileEntries_sm, TEMPORAL, and type_m.
|
overridevirtual |
Reimplemented from Component.
Definition at line 176 of file Monitor.cpp.
References Component::online_m.
|
overridevirtual |
Implements Component.
Definition at line 139 of file Monitor.cpp.
References Options::asciidump, Communicate::barrier(), IpplInfo::Comm, filename_m, Hypervolume::fs, PartBunchBase< T, Dim >::get_sPos(), OpalData::getInstance(), ElementBase::getName(), PartBunchBase< T, Dim >::getTotalNum(), getType(), halfLength_s, lossDs_m, IpplInfo::myNode(), Component::RefPartBunch_m, and OpalData::WRITE.
|
private |
void Monitor::setOutputFN | ( | std::string | fn | ) |
Definition at line 195 of file Monitor.cpp.
References filename_m.
Referenced by OpalMonitor::update().
|
inline |
|
static |
Definition at line 209 of file Monitor.cpp.
References MonitorStatisticsWriter::addRow(), OpalData::getInputBasename(), OpalData::getInstance(), Util::rewindLinesSDDS(), and statFileEntries_sm.
Referenced by ParallelTTracker::execute().
|
private |
The name of the outputfile
Definition at line 112 of file Monitor.h.
Referenced by initialise(), and setOutputFN().
|
staticprivate |
Definition at line 120 of file Monitor.h.
Referenced by applyToReferenceParticle(), getDimensions(), and initialise().
|
private |
Definition at line 117 of file Monitor.h.
Referenced by apply(), applyToReferenceParticle(), goOffline(), and initialise().
|
private |
Definition at line 115 of file Monitor.h.
Referenced by applyToReferenceParticle(), and goOffline().
|
staticprivate |
Definition at line 119 of file Monitor.h.
Referenced by goOffline(), and writeStatistics().
|
private |
Definition at line 114 of file Monitor.h.
Referenced by apply(), applyToReferenceParticle(), goOffline(), and setType().