Monitor Class Reference

#include <Monitor.h>

Inheritance diagram for Monitor:

Collaboration diagram for Monitor:

Public Types
enum	Plane { OFF, X, Y, XY }
	Plane selection. More...

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 ElementType	getType () const override
	Get element type std::string. More...
virtual void	getDimensions (double &zBegin, double &zEnd) const override
void	setCollectionType (CollectionType type)
virtual int	getRequiredNumberOfTimeSteps () const override
virtual bool	isInside (const Vector_t &r) const override
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 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 bool	Online ()
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 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 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
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
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...

Static Public Member Functions
static void	writeStatistics ()
Static Public Member Functions inherited from ElementBase
static std::string	getTypeString (ElementType type)

Private Member Functions
void	driftToCorrectPositionAndSave (const Vector_t &R, const Vector_t &P)
void	operator= (const Monitor &)

Private Attributes
std::string	filename_m
Plane	plane_m
CollectionType	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
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 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

Definition at line 32 of file Monitor.h.

Member Enumeration Documentation

enum Monitor::Plane

Plane selection.

Enumerator
OFF	Monitor is off (inactive).
X	Monitor acts on x-plane.
Y	Monitor acts on y-plane.
XY	Monitor acts on both planes.

Definition at line 37 of file Monitor.h.

Constructor & Destructor Documentation

Monitor::Monitor ( const std::string &  name )

explicit

Constructor with given name.

Definition at line 51 of file Monitor.cpp.

References SPATIAL.

Monitor::Monitor

(

)

Definition at line 37 of file Monitor.cpp.

Monitor::Monitor

(

const Monitor &

right

)

Definition at line 42 of file Monitor.cpp.

Monitor::~Monitor ( )

virtual

Definition at line 60 of file Monitor.cpp.

Member Function Documentation

void Monitor::accept ( BeamlineVisitor &  visitor ) const

overridevirtual

Apply visitor to Monitor.

Implements ElementBase.

Definition at line 64 of file Monitor.cpp.

References BeamlineVisitor::visitMonitor().

Here is the call graph for this function:

bool Monitor::apply ( const size_t &  i, const double &  t, Vector_t &  E, Vector_t &  B  )

overridevirtual

Reimplemented from Component.

Definition at line 68 of file Monitor.cpp.

References Physics::c, PartBunchBase< T, Dim >::dt, Util::getBeta(), PartBunchBase< T, Dim >::ID, lossDs_m, PartBunchBase< T, Dim >::M, Component::online_m, PartBunchBase< T, Dim >::P, PartBunchBase< T, Dim >::Q, Attrib::Distribution::R, PartBunchBase< T, Dim >::R, Component::RefPartBunch_m, SPATIAL, and type_m.

Here is the call graph for this function:

bool Monitor::applyToReferenceParticle ( const Vector_t &  R, const Vector_t &  P, const double &  t, Vector_t &  E, Vector_t &  B  )

overridevirtual

Reimplemented from Component.

Definition at line 106 of file Monitor.cpp.

References OpalData::APPEND, Physics::c, ElementBase::csTrafoGlobal2Local_m, driftToCorrectPositionAndSave(), euclidean_norm(), PartBunchBase< T, Dim >::get_sPos(), Util::getBeta(), PartBunchBase< T, Dim >::getdT(), PartBunchBase< T, Dim >::getGlobalTrackStep(), OpalData::getInstance(), OpalData::getOpenMode(), lossDs_m, numPassages_m, Attrib::Distribution::R, Component::RefPartBunch_m, CoordinateSystemTrafo::rotateFrom(), statFileEntries_sm, TEMPORAL, CoordinateSystemTrafo::transformFrom(), and type_m.

Here is the call graph for this function:

bool Monitor::bends ( ) const

overridevirtual

Implements Component.

Definition at line 199 of file Monitor.cpp.

void Monitor::driftToCorrectPositionAndSave ( const Vector_t &  R, const Vector_t &  P  )

private

Definition at line 91 of file Monitor.cpp.

References Physics::c, Util::getBeta(), ElementBase::getCSTrafoGlobal2Local(), PartBunchBase< T, Dim >::getdT(), getQuaternion(), lossDs_m, Component::RefPartBunch_m, CoordinateSystemTrafo::rotateTo(), PartBunchBase< T, Dim >::toLabTrafo_m, CoordinateSystemTrafo::transformTo(), and ElementBase::update().

Referenced by applyToReferenceParticle().

Here is the call graph for this function:

void Monitor::finalise ( )

overridevirtual

Implements Component.

Definition at line 180 of file Monitor.cpp.

void Monitor::getDimensions ( double &  zBegin, double &  zEnd  ) const

overridevirtual

Implements Component.

Definition at line 203 of file Monitor.cpp.

References halfLength_s.

virtual StraightGeometry& Monitor::getGeometry ( )

overridepure virtual

Get geometry.

Implements ElementBase.

Implemented in MonitorRep.

virtual const StraightGeometry& Monitor::getGeometry ( ) const

overridepure virtual

Get geometry. Version for const object.

Implements ElementBase.

Implemented in MonitorRep.

virtual Plane Monitor::getPlane ( ) const

pure virtual

Get plane on which monitor observes.

Implemented in MonitorRep.

int Monitor::getRequiredNumberOfTimeSteps ( ) const

inlineoverridevirtual

Reimplemented from ElementBase.

Definition at line 119 of file Monitor.h.

ElementType Monitor::getType ( ) const

overridevirtual

Get element type std::string.

Reimplemented from Component.

Definition at line 209 of file Monitor.cpp.

References MONITOR.

void Monitor::goOffline ( )

overridevirtual

Reimplemented from Component.

Definition at line 188 of file Monitor.cpp.

References lossDs_m, numPassages_m, statFileEntries_sm, TEMPORAL, and type_m.

void Monitor::goOnline ( const double &  kineticEnergy )

overridevirtual

Reimplemented from Component.

Definition at line 184 of file Monitor.cpp.

References Component::online_m.

void Monitor::initialise ( PartBunchBase< double, 3 > *  bunch, double &  startField, double &  endField  )

overridevirtual

Implements Component.

Definition at line 149 of file Monitor.cpp.

References Options::asciidump, Communicate::barrier(), IpplInfo::Comm, filename_m, Hypervolume::fs, PartBunchBase< T, Dim >::get_sPos(), OpalData::getInstance(), ElementBase::getOutputFN(), PartBunchBase< T, Dim >::getTotalNum(), halfLength_s, lossDs_m, IpplInfo::myNode(), Component::RefPartBunch_m, type_m, and OpalData::WRITE.

Here is the call graph for this function:

bool Monitor::isInside ( const Vector_t &  r ) const

inlineoverridevirtual

Reimplemented from ElementBase.

Definition at line 125 of file Monitor.h.

References abs(), ElementBase::getElementLength(), and ElementBase::isInsideTransverse().

Here is the call graph for this function:

void Monitor::operator= ( const Monitor &  )

private

void Monitor::setCollectionType ( CollectionType  type )

inline

Definition at line 114 of file Monitor.h.

References type, and type_m.

Referenced by OpalMonitor::update().

void Monitor::writeStatistics ( )

static

Definition at line 213 of file Monitor.cpp.

References MonitorStatisticsWriter::addRow(), OpalData::getInputBasename(), OpalData::getInstance(), it, Util::rewindLinesSDDS(), and statFileEntries_sm.

Referenced by ParallelTTracker::execute().

Here is the call graph for this function:

Member Data Documentation

std::string Monitor::filename_m

private

The name of the outputfile

Definition at line 102 of file Monitor.h.

Referenced by initialise().

const double Monitor::halfLength_s = 0.005

staticprivate

Definition at line 110 of file Monitor.h.

Referenced by getDimensions(), and initialise().

std::unique_ptr<LossDataSink> Monitor::lossDs_m

private

Definition at line 107 of file Monitor.h.

Referenced by apply(), applyToReferenceParticle(), driftToCorrectPositionAndSave(), goOffline(), and initialise().

unsigned int Monitor::numPassages_m

private

Definition at line 105 of file Monitor.h.

Referenced by applyToReferenceParticle(), and goOffline().

Plane Monitor::plane_m

private

Definition at line 103 of file Monitor.h.

std::map< double, SetStatistics > Monitor::statFileEntries_sm

staticprivate

Definition at line 109 of file Monitor.h.

Referenced by applyToReferenceParticle(), goOffline(), and writeStatistics().

CollectionType Monitor::type_m

private

Definition at line 104 of file Monitor.h.

Referenced by apply(), applyToReferenceParticle(), goOffline(), initialise(), and setCollectionType().

---

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

• src/Classic/AbsBeamline/Monitor.h
• src/Classic/AbsBeamline/Monitor.cpp