#include <Probe.h>

Inheritance diagram for Probe:

[legend]

Collaboration diagram for Probe:

[legend]

Public Member Functions
	Probe (const std::string &name)
	Constructor with given name. More...

	Probe ()

	Probe (const Probe &)

void	operator= (const Probe &)=delete

virtual	~Probe ()

virtual void	accept (BeamlineVisitor &) const override
	Apply visitor to Probe. More...

void	setStep (double step)
	Set probe histogram bin width. More...

virtual ElementType	getType () const override
	Get element type std::string. More...


virtual double	getStep () const
	Member variable access. More...

Public Member Functions inherited from PluginElement
	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...

Private Member Functions
virtual void	doInitialise (PartBunchBase< double, 3 > *bunch) override
	Initialise peakfinder file. More...

virtual bool	doCheck (PartBunchBase< double, 3 > *bunch, const int turnnumber, const double t, const double tstep) override
	Record probe hits when bunch particles pass. More...

virtual void	doGoOffline () override
	Hook for goOffline. More...

virtual bool	doPreCheck (PartBunchBase< double, 3 > *) override
	Virtual hook for preCheck. More...

Private Attributes
double	step_m
	Step size of the probe (bin width in histogram file) More...

std::unique_ptr< PeakFinder >	peakfinder_m
	Pointer to Peakfinder instance. More...

Additional Inherited Members
Static Public Member Functions inherited from ElementBase
static std::string	getTypeString (ElementType type)

Protected Member Functions inherited from PluginElement
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 inherited from PluginElement
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

Static Protected Attributes inherited from Component
static const std::vector< double >	defaultAperture_m

Detailed Description

Definition at line 28 of file Probe.h.

Constructor & Destructor Documentation

◆ Probe() [1/3]

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

explicit

Constructor with given name.

Definition at line 32 of file Probe.cpp.

◆ Probe() [2/3]

Probe::Probe ( )

Definition at line 29 of file Probe.cpp.

◆ Probe() [3/3]

Probe::Probe ( const Probe & right )

Definition at line 37 of file Probe.cpp.

◆ ~Probe()

Probe::~Probe ( )

virtual

Definition at line 42 of file Probe.cpp.

Member Function Documentation

◆ accept()

void Probe::accept ( BeamlineVisitor & visitor ) const

overridevirtual

Apply visitor to Probe.

Implements ElementBase.

Definition at line 44 of file Probe.cpp.

References BeamlineVisitor::visitProbe().

Here is the call graph for this function:

◆ doCheck()

bool Probe::doCheck	(	PartBunchBase< double, 3 > *	bunch,
		const int	turnnumber,
		const double	t,
		const double	tstep
	)

overrideprivatevirtual

Record probe hits when bunch particles pass.

Implements PluginElement.

Definition at line 85 of file Probe.cpp.

References PluginElement::A_m, PluginElement::B_m, PartBunchBase< T, Dim >::bunchNum, Physics::c, PluginElement::C_m, PluginElement::calculateIncidentAngle(), PluginElement::changeWidth(), PluginElement::checkPoint(), dot(), euclidean_norm(), PartBunchBase< T, Dim >::getLocalNum(), PartBunchBase< T, Dim >::ID, PluginElement::lossDs_m, PartBunchBase< T, Dim >::M, Units::m2mm, PartBunchBase< T, Dim >::P, peakfinder_m, PartBunchBase< T, Dim >::Q, PartBunchBase< T, Dim >::R, PluginElement::R_m, and sqrt().

Here is the call graph for this function:

◆ doGoOffline()

void Probe::doGoOffline ( )

overrideprivatevirtual

Hook for goOffline.

Reimplemented from PluginElement.

Definition at line 53 of file Probe.cpp.

References endl(), ElementBase::getName(), gmsg, Component::online_m, and peakfinder_m.

Here is the call graph for this function:

◆ doInitialise()

void Probe::doInitialise ( PartBunchBase< double, 3 > * bunch )

overrideprivatevirtual

Initialise peakfinder file.

Reimplemented from PluginElement.

Definition at line 48 of file Probe.cpp.

References ElementBase::getOutputFN(), PartBunchBase< T, Dim >::getTotalNum(), peakfinder_m, PluginElement::rend_m, PluginElement::rmin_m, and step_m.

Here is the call graph for this function:

◆ doPreCheck()

bool Probe::doPreCheck ( PartBunchBase< double, 3 > * bunch )

overrideprivatevirtual

Virtual hook for preCheck.

Reimplemented from PluginElement.

Definition at line 68 of file Probe.cpp.

References abs(), PartBunchBase< T, Dim >::get_bounds(), max(), min(), PluginElement::rend_m, and PluginElement::rmin_m.

Here is the call graph for this function:

◆ getStep()

double Probe::getStep ( ) const

virtual

Member variable access.

Definition at line 64 of file Probe.cpp.

References step_m.

◆ getType()

ElementType Probe::getType ( ) const

overridevirtual

Get element type std::string.

Reimplemented from Component.

Definition at line 122 of file Probe.cpp.

References PROBE.

◆ operator=()

void Probe::operator= ( const Probe & )

delete

◆ setStep()

void Probe::setStep ( double step )

Set probe histogram bin width.

Definition at line 60 of file Probe.cpp.

References step_m.

Referenced by OpalProbe::update().

Member Data Documentation

◆ peakfinder_m

std::unique_ptr<PeakFinder> Probe::peakfinder_m

private

Pointer to Peakfinder instance.

Definition at line 60 of file Probe.h.

Referenced by doCheck(), doGoOffline(), and doInitialise().

◆ step_m

double Probe::step_m

private

Step size of the probe (bin width in histogram file)

Definition at line 59 of file Probe.h.

Referenced by doInitialise(), getStep(), and setStep().

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

/Users/gsell/src/OPAL/src/src/Classic/AbsBeamline/Probe.h
/Users/gsell/src/OPAL/src/src/Classic/AbsBeamline/Probe.cpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Probe() [1/3]

◆ Probe() [2/3]

◆ Probe() [3/3]

◆ ~Probe()

Member Function Documentation

◆ accept()

◆ doCheck()

◆ doGoOffline()

◆ doInitialise()

◆ doPreCheck()

◆ getStep()

◆ getType()

◆ operator=()

◆ setStep()

Member Data Documentation

◆ peakfinder_m

◆ step_m