ProbeRep Class Reference

#include <ProbeRep.h>

Inheritance diagram for ProbeRep:

Collaboration diagram for ProbeRep:

Public Member Functions
	ProbeRep (const std::string &name)
	Constructor with given name.
	ProbeRep ()
	ProbeRep (const ProbeRep &)
virtual	~ProbeRep ()
virtual ElementBase *	clone () const
	Return clone.
virtual Channel *	getChannel (const std::string &aKey, bool=false)
	Construct a read/write channel.
virtual NullField &	getField ()
	Get field.
virtual const NullField &	getField () const
	Get field.
virtual StraightGeometry &	getGeometry ()
	Get geometry.
virtual const StraightGeometry &	getGeometry () const
	Get geometry.
virtual void	setActive (bool=true)
	Set active flag.
virtual void	accept (BeamlineVisitor &) const override
	Apply visitor to Probe.
void	setStep (double step)
	Set probe histogram bin width.
virtual ElementType	getType () const override
	Get element type std::string.
void	setDimensions (double xstart, double xend, double ystart, double yend)
	Set dimensions and consistency checks.
bool	check (PartBunch_t *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.
void	save ()
	Save output.
EVector	Efield (const Point3D &P) const
	Return the field in a point.
EVector	Efield (const Point3D &P, double t) const
	Return the field in a point.
BVector	Bfield (const Point3D &P) const
	Return the field in a point.
BVector	Bfield (const Point3D &P, double t) const
	Return the field in a point.
EBVectors	EBfield (const Point3D &P) const
	Return the field in a point.
EBVectors	EBfield (const Point3D &P, double t) const
	Return the field in a point.
virtual bool	getPotential (const Vector_t< double, 3 > &, const double &, Vector_t< double, 3 > &, double &)
	Calculate the four-potential at some position relative to the component.
virtual double	getDesignEnergy () const
virtual void	setDesignEnergy (const double &energy, bool changeable=true)
virtual void	goOnline (const double &kineticEnergy)
virtual bool	Online ()
virtual const ElementBase &	getDesign () const
	Return design element.
virtual void	trackBunch (PartBunch_t &bunch, const PartData &, bool revBeam, bool revTrack) const
	Track a borrowed particle bunch through a non-standard component.
virtual void	trackMap (FVps< double, 6 > &map, const PartData &, bool revBeam, bool revTrack) const
	Track a map.
void	setExitFaceSlope (const double &)
virtual const std::string &	getName () const
	Get element name.
virtual void	setName (const std::string &name)
	Set element name.
std::string	getTypeString () const
virtual double	getArcLength () const
	Get arc length.
virtual double	getElementLength () const
	Get design length.
virtual void	setElementLength (double length)
	Set design length.
virtual void	getElementDimensions (double &begin, double &end) const
	Return the nominal body extent of the element.
virtual double	getOrigin () const
	Get origin position.
virtual double	getEntrance () const
	Get entrance position.
virtual double	getExit () const
	Get exit position.
virtual Euclid3D	getTransform (double fromS, double toS) const
	Get transform.
virtual Euclid3D	getTransform (double s) const
	Get transform.
virtual Euclid3D	getTotalTransform () const
	Get transform.
virtual Euclid3D	getEntranceFrame () const
	Get transform.
virtual Euclid3D	getExitFrame () const
	Get transform.
virtual Euclid3D	getEntrancePatch () const
	Get patch.
virtual Euclid3D	getExitPatch () const
	Get patch.
virtual double	getAttribute (const std::string &aKey) const
	Get attribute value.
virtual bool	hasAttribute (const std::string &aKey) const
	Test for existence of an attribute.
virtual void	removeAttribute (const std::string &aKey)
	Remove an existing attribute.
virtual void	setAttribute (const std::string &aKey, double val)
	Set value of an attribute.
virtual const ConstChannel *	getConstChannel (const std::string &aKey) const
	Construct a read-only channel.
virtual ElementBase *	copyStructure ()
	Make a structural copy.
bool	isSharable () const
	Test if the element can be shared.
virtual void	makeSharable ()
	Set sharable flag.
bool	update (const AttributeSet &)
	Update element.
virtual void	setBoundaryGeometry (BoundaryGeometry *geo)
virtual BoundaryGeometry *	getBoundaryGeometry () const
	return the attached boundary geometrt object if there is any
virtual bool	hasBoundaryGeometry () const
virtual void	setWake (WakeFunction *wf)
	attach a wake field to the element
virtual WakeFunction *	getWake () const
	return the attached wake object if there is any
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
virtual Port	getEntryPort () const
	Return the entrance port of the canonical local chart.
virtual Port	getBodyPort () const
	Return the body port of the canonical local chart.
virtual Port	getExitPort () const
	Return the exit port of the canonical local chart.
PlacementPose	getPlacementPose () const
	Return the nominal rigid placement transform of the element.
void	setPlacementPose (const PlacementPose &pose)
	Set the nominal rigid placement transform of the element.
Misalignment	getPlacementMisalignment () const
	Return the local nominal-to-actual correction stored for the element.
ElementGeometry	getPlacementGeometry () const
	Return the bridge geometry ports assembled from legacy edge state.
SupportPlacement	getPlacementSupport () const
	Return the support-frame bridge object. The default is the body frame.
PlacedElement	getPlacedElement () const
	Return a placed-element view assembled from the current bridge objects.
void	setAperture (const ApertureType &type, const std::vector< double > &args)
std::pair< ApertureType, std::vector< double > >	getAperture () const
virtual bool	isInside (const Vector_t< double, 3 > &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.
double	getRotationAboutZ () const
virtual BoundingBox	getBoundingBoxInLabCoords () const
virtual int	getRequiredNumberOfTimeSteps () const
void	setOutputFN (std::string fn)
	Set output filename.
std::string	getOutputFN () const
	Get output filename.
void	setFlagDeleteOnTransverseExit (bool=true)
bool	getFlagDeleteOnTransverseExit () const
virtual double	getStep () const
	Member variable access.
virtual void	initialise (PartBunch_t *bunch, double &startField, double &endField) override
	Pure virtual implementation of Component.
void	initialise (PartBunch_t *bunch)
virtual void	finalise () final
virtual void	goOffline () final
virtual bool	bends () const override
virtual void	getFieldExtend (double &zBegin, double &zEnd) const override
	Return the field-support extent of the component.
virtual bool	apply (const std::shared_ptr< ParticleContainer_t > &pc) override
virtual bool	apply (const size_t &i, const double &t, Vector_t< double, 3 > &E, Vector_t< double, 3 > &B) override
	Apply to particle i.
virtual bool	apply (const Vector_t< double, 3 > &R, const Vector_t< double, 3 > &P, const double &t, Vector_t< double, 3 > &E, Vector_t< double, 3 > &B) override
	Apply to particle with position R and momentum P.
virtual bool	applyToReferenceParticle (const Vector_t< double, 3 > &R, const Vector_t< double, 3 > &P, const double &t, Vector_t< double, 3 > &E, Vector_t< double, 3 > &B) override
	Apply to reference particle with position R and momemtum P.
double	getXStart () const
	Member variable access.
double	getXEnd () const
double	getYStart () const
double	getYEnd () const
void	setElementPosition (double elemedge)
	Access to ELEMEDGE attribute.
double	getElementPosition () const
bool	isElementPositionSet () const

Static Public Member Functions
static std::string	getTypeString (ElementType type)

Protected Member Functions
void	setGeom (const double dist)
	Sets geometry geom_m with element width dist.
void	changeWidth (PartBunch_t *bunch, int i, const double tstep, const double tangle)
	Change probe width depending on step size and angle of particle.
double	calculateIncidentAngle (double xp, double yp) const
	Calculate angle of particle/bunch wrt to element.
bool	isInsideTransverse (const Vector_t< double, 3 > &r) const

Protected Attributes
NullField	field
	The zero magnetic field.
StraightGeometry	geometry
	The probe's geometry.
bool	active
	The active/inactive flag.
double	rmin_m
	radius closest to the origin
Point	geom_m [5]
double	A_m
double	B_m
double	R_m
double	C_m
	Geometric lengths used in calculations.
std::unique_ptr< LossDataSink >	lossDs_m
	Pointer to Loss instance.
int	numPassages_m = 0
	Number of turns (number of times save() method is called)
double	exit_face_slope_m
PartBunch_t *	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
double	xstart_m
	input geometry positions
double	xend_m
double	ystart_m
double	yend_m
double	rstart_m
double	rend_m

Static Protected Attributes
static const std::vector< double >	defaultAperture_m = std::vector<double>({1e6, 1e6, 1.0})

Private Member Functions
void	operator= (const ProbeRep &)
virtual void	doInitialise (PartBunch_t *bunch) override
	Initialise peakfinder file.
virtual bool	doCheck (PartBunch_t *bunch, const int turnnumber, const double t, const double tstep) override
	Record probe hits when bunch particles pass.
virtual void	doGoOffline () override
	Hook for goOffline.
virtual bool	doPreCheck (PartBunch_t *) override
	Virtual hook for preCheck.
bool	preCheck (PartBunch_t *bunch)
	Check if bunch is close to element.
bool	finaliseCheck (PartBunch_t *bunch, bool flagNeedUpdate)
	Finalise call after check.
virtual void	doSetGeom ()
	Virtual hook for setGeom.
virtual bool	doFinaliseCheck (PartBunch_t *, bool flagNeedUpdate)
	Virtual hook for finaliseCheck.
virtual void	doFinalise ()
	Virtual hook for finalise.

Private Attributes
double	step_m
	Step size of the probe (bin width in histogram file)
std::unique_ptr< PeakFinder >	peakfinder_m
	Pointer to Peakfinder instance.
std::string	elementID
AttributeSet	userAttribs
WakeFunction *	wake_m
BoundaryGeometry *	bgeometry_m
ParticleMatterInteractionHandler *	parmatint_m
bool	positionIsFixed
std::queue< std::pair< double, double > >	actionRange_m
std::string	outputfn_m
bool	deleteOnTransverseExit_m = true
double	elementPosition_m
	ELEMEDGE attribute.
bool	elemedgeSet_m

Static Private Attributes
static const std::map< ElementType, std::string >	elementTypeToString_s

Detailed Description

Definition at line 25 of file ProbeRep.h.

Constructor & Destructor Documentation

ProbeRep() [1/3]

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

explicit

Constructor with given name.

Definition at line 37 of file ProbeRep.cpp.

ProbeRep() [2/3]

ProbeRep::ProbeRep

(

)

Definition at line 32 of file ProbeRep.cpp.

Referenced by clone().

ProbeRep() [3/3]

ProbeRep::ProbeRep

(

const ProbeRep &

right

)

Definition at line 34 of file ProbeRep.cpp.

~ProbeRep()

ProbeRep::~ProbeRep ( )

virtual

Definition at line 39 of file ProbeRep.cpp.

Member Function Documentation

accept()

void Probe::accept ( BeamlineVisitor &  visitor ) const

overridevirtualinherited

Apply visitor to Probe.

Implements ElementBase.

Definition at line 36 of file Probe.cpp.

References BeamlineVisitor::visitProbe().

Here is the call graph for this function:

apply() [1/3]

bool PluginElement::apply ( const size_t &  i, const double &  t, Vector_t< double, 3 > &  E, Vector_t< double, 3 > &  B  )

overridevirtualinherited

Apply to particle i.

Parameters

i	Particle index
t	Time
E	Electric Field
B	Magnetic Field

Returns

true if particle is out-of-bounds (lost), false otherwise

Reimplemented from Component.

Definition at line 69 of file PluginElement.cpp.

apply() [2/3]

bool PluginElement::apply ( const std::shared_ptr< ParticleContainer_t > &  pc )

overridevirtualinherited

Virtual implementation of Component

Reimplemented from Component.

Definition at line 67 of file PluginElement.cpp.

apply() [3/3]

bool PluginElement::apply ( const Vector_t< double, 3 > &  R, const Vector_t< double, 3 > &  P, const double &  t, Vector_t< double, 3 > &  E, Vector_t< double, 3 > &  B  )

overridevirtualinherited

Apply to particle with position R and momentum P.

Parameters

R	Position
P	Momentum
t	Time
E	Electric Field
B	Magnetic Field

Returns

true if particle is out-of-bounds (lost), false otherwise

Reimplemented from Component.

Definition at line 74 of file PluginElement.cpp.

References gmsg.

applyToReferenceParticle()

bool PluginElement::applyToReferenceParticle ( const Vector_t< double, 3 > &  R, const Vector_t< double, 3 > &  P, const double &  t, Vector_t< double, 3 > &  E, Vector_t< double, 3 > &  B  )

overridevirtualinherited

Apply to reference particle with position R and momemtum P.

Parameters

R	Position
P	Momentum
t	Time
E	Electric Field
B	Magnetic Field

Returns

true if particle is out-of-bounds (lost), false otherwise

Reimplemented from Component.

Definition at line 81 of file PluginElement.cpp.

bends()

bool PluginElement::bends ( ) const

overridevirtualinherited

Implements Component.

Definition at line 65 of file PluginElement.cpp.

Bfield() [1/2]

BVector Component::Bfield ( const Point3D &  P ) const

inlineinherited

Return the field in a point.

Definition at line 234 of file Component.h.

References EMField::Bfield(), and Component::getField().

Here is the call graph for this function:

Bfield() [2/2]

BVector Component::Bfield ( const Point3D &  P, double  t  ) const

inlineinherited

Return the field in a point.

Definition at line 240 of file Component.h.

References EMField::Bfield(), and Component::getField().

Here is the call graph for this function:

calculateIncidentAngle()

double PluginElement::calculateIncidentAngle ( double  xp, double  yp  ) const

protectedinherited

Calculate angle of particle/bunch wrt to element.

Definition at line 154 of file PluginElement.cpp.

References PluginElement::A_m, and PluginElement::B_m.

Referenced by Probe::doCheck().

changeWidth()

void PluginElement::changeWidth ( PartBunch_t *  bunch, int  i, const double  tstep, const double  tangle  )

protectedinherited

Change probe width depending on step size and angle of particle.

Definition at line 144 of file PluginElement.cpp.

References Physics::c, dot(), Util::getGamma(), PartBunch< T, Dim >::P(), Units::s2ns, and PluginElement::setGeom().

Referenced by Probe::doCheck().

Here is the call graph for this function:

check()

bool PluginElement::check ( PartBunch_t *  bunch, const int  turnnumber, const double  t, const double  tstep  )

inherited

Check if bunch particles are lost

Definition at line 187 of file PluginElement.cpp.

References PluginElement::doCheck(), PluginElement::finaliseCheck(), and PluginElement::preCheck().

Here is the call graph for this function:

checkPoint()

int PluginElement::checkPoint ( const double &  x, const double &  y  ) const

inherited

Checks if coordinate is within element.

Definition at line 207 of file PluginElement.cpp.

References PluginElement::geom_m, and Point::y.

Referenced by Probe::doCheck().

clone()

ElementBase * ProbeRep::clone ( ) const

virtual

Return clone.

Implements ElementBase.

Definition at line 41 of file ProbeRep.cpp.

References ProbeRep().

Here is the call graph for this function:

copyStructure()

ElementBase * ElementBase::copyStructure ( )

virtualinherited

Make a structural copy.

Reimplemented in TBeamline< T >.

Definition at line 194 of file ElementBase.cpp.

References ElementBase::clone(), and ElementBase::isSharable().

Referenced by Sequence::copy(), Line::parse(), SequenceParser::parseMember(), and Replacer::visitFlaggedElmPtr().

Here is the call graph for this function:

doCheck()

bool Probe::doCheck ( PartBunch_t *  bunch, const int  turnnumber, const double  t, const double  tstep  )

overrideprivatevirtualinherited

Record probe hits when bunch particles pass.

Implements PluginElement.

Definition at line 71 of file Probe.cpp.

References PluginElement::A_m, PluginElement::B_m, PluginElement::C_m, PluginElement::calculateIncidentAngle(), PluginElement::changeWidth(), PluginElement::checkPoint(), dot(), gmsg, Units::m2mm, PartBunch< T, Dim >::P(), Probe::peakfinder_m, PartBunch< T, Dim >::R(), and PluginElement::R_m.

Here is the call graph for this function:

doFinalise()

virtual void PluginElement::doFinalise ( )

inlineprivatevirtualinherited

Virtual hook for finalise.

Definition at line 105 of file PluginElement.h.

Referenced by PluginElement::finalise().

doFinaliseCheck()

virtual bool PluginElement::doFinaliseCheck ( PartBunch_t *  , bool  flagNeedUpdate  )

inlineprivatevirtualinherited

Virtual hook for finaliseCheck.

Definition at line 103 of file PluginElement.h.

Referenced by PluginElement::finaliseCheck().

doGoOffline()

void Probe::doGoOffline ( )

overrideprivatevirtualinherited

Hook for goOffline.

Reimplemented from PluginElement.

Definition at line 44 of file Probe.cpp.

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

Here is the call graph for this function:

doInitialise()

void Probe::doInitialise ( PartBunch_t *  bunch )

overrideprivatevirtualinherited

Initialise peakfinder file.

Reimplemented from PluginElement.

Definition at line 38 of file Probe.cpp.

References ElementBase::getOutputFN(), Probe::peakfinder_m, PluginElement::rend_m, PluginElement::rmin_m, and Probe::step_m.

Here is the call graph for this function:

doPreCheck()

bool Probe::doPreCheck ( PartBunch_t *  bunch )

overrideprivatevirtualinherited

Virtual hook for preCheck.

Reimplemented from PluginElement.

Definition at line 54 of file Probe.cpp.

References PartBunch< T, Dim >::get_bounds(), PluginElement::rend_m, and PluginElement::rmin_m.

Here is the call graph for this function:

doSetGeom()

virtual void PluginElement::doSetGeom ( )

inlineprivatevirtualinherited

Virtual hook for setGeom.

Definition at line 99 of file PluginElement.h.

Referenced by PluginElement::setGeom().

EBfield() [1/2]

EBVectors Component::EBfield ( const Point3D &  P ) const

inlineinherited

Return the field in a point.

Definition at line 244 of file Component.h.

References EMField::EBfield(), and Component::getField().

Here is the call graph for this function:

EBfield() [2/2]

EBVectors Component::EBfield ( const Point3D &  P, double  t  ) const

inlineinherited

Return the field in a point.

Definition at line 246 of file Component.h.

References EMField::EBfield(), and Component::getField().

Here is the call graph for this function:

Efield() [1/2]

EVector Component::Efield ( const Point3D &  P ) const

inlineinherited

Return the field in a point.

Definition at line 232 of file Component.h.

References EMField::Efield(), and Component::getField().

Here is the call graph for this function:

Efield() [2/2]

EVector Component::Efield ( const Point3D &  P, double  t  ) const

inlineinherited

Return the field in a point.

Definition at line 236 of file Component.h.

References EMField::Efield(), and Component::getField().

Here is the call graph for this function:

finalise()

void PluginElement::finalise ( )

finalvirtualinherited

Implements Component.

Definition at line 53 of file PluginElement.cpp.

References PluginElement::doFinalise(), PluginElement::goOffline(), and Component::online_m.

Here is the call graph for this function:

finaliseCheck()

bool PluginElement::finaliseCheck ( PartBunch_t *  bunch, bool  flagNeedUpdate  )

inlineprivateinherited

Finalise call after check.

Definition at line 90 of file PluginElement.h.

References PluginElement::doFinaliseCheck().

Referenced by PluginElement::check().

Here is the call graph for this function:

fixPosition()

void ElementBase::fixPosition ( )

inlineinherited

Definition at line 597 of file ElementBase.h.

References ElementBase::positionIsFixed.

Referenced by OpalElement::update(), OpalRBend::update(), and OpalSBend::update().

getAperture()

std::pair< ApertureType, std::vector< double > > ElementBase::getAperture ( ) const

inlineinherited

Definition at line 582 of file ElementBase.h.

References ElementBase::aperture_m.

Referenced by MeshGenerator::add(), Solenoid::getSupportEnvelope(), and MeshGenerator::getTransverseSupport().

getArcLength()

double ElementBase::getArcLength ( ) const

inlinevirtualinherited

Get arc length.

Reimplemented in MarkerRep, and TBeamline< T >.

Definition at line 479 of file ElementBase.h.

References BGeometryBase::getArcLength(), and ElementBase::getGeometry().

Referenced by BeamlineGeometry::getArcLength(), and TBeamline< T >::getTransform().

Here is the call graph for this function:

getAttribute()

double ElementBase::getAttribute ( const std::string &  aKey ) const

virtualinherited

Get attribute value.

Definition at line 147 of file ElementBase.cpp.

References ElementBase::getConstChannel().

Here is the call graph for this function:

getBodyPort()

Port ElementBase::getBodyPort ( ) const

inlinevirtualinherited

Return the body port of the canonical local chart.

The body port \(p_{i,\mathrm{body}}\) is the identity port of the element's canonical local chart. Its rigid transform is therefore the identity element of \(SE(3)\) in the first redesign stage.

Definition at line 547 of file ElementBase.h.

Referenced by ElementBase::getPlacementGeometry(), and TEST_F().

getBoundaryGeometry()

BoundaryGeometry * ElementBase::getBoundaryGeometry ( ) const

inlinevirtualinherited

return the attached boundary geometrt object if there is any

Definition at line 513 of file ElementBase.h.

References ElementBase::bgeometry_m.

getBoundingBoxInLabCoords()

BoundingBox ElementBase::getBoundingBoxInLabCoords ( ) const

virtualinherited

Definition at line 264 of file ElementBase.cpp.

References ElementBase::aperture_m, ElementBase::csTrafoGlobal2Local_m, BoundingBox::getBoundingBox(), ElementBase::getEdgeToBegin(), ElementBase::getEdgeToEnd(), and CoordinateSystemTrafo::transformFrom().

Here is the call graph for this function:

getChannel()

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

virtual

Construct a read/write channel.

Reimplemented from ElementBase.

Definition at line 43 of file ProbeRep.cpp.

References ElementBase::getChannel().

Here is the call graph for this function:

getConstChannel()

const ConstChannel * ElementBase::getConstChannel ( const std::string &  aKey ) const

virtualinherited

Construct a read-only channel.

Definition at line 186 of file ElementBase.cpp.

References ElementBase::getChannel().

Referenced by ElementBase::getAttribute(), and ElementBase::hasAttribute().

Here is the call graph for this function:

getCSTrafoGlobal2Local()

CoordinateSystemTrafo ElementBase::getCSTrafoGlobal2Local ( ) const

inlineinherited

Definition at line 529 of file ElementBase.h.

References ElementBase::csTrafoGlobal2Local_m.

Referenced by Monitor::driftToCorrectPositionAndSave(), ElementBase::getPlacementPose(), OpalRBend::update(), and OpalSBend::update().

getDesign()

const ElementBase & Component::getDesign ( ) const

virtualinherited

Return design element.

Definition at line 33 of file Component.cpp.

getDesignEnergy()

double Component::getDesignEnergy ( ) const

inlinevirtualinherited

Reimplemented in BendBase, and RFCavity.

Definition at line 254 of file Component.h.

getEdgeToBegin()

CoordinateSystemTrafo ElementBase::getEdgeToBegin ( ) const

inlinevirtualinherited

Reimplemented in BendBase, RFCavity, Solenoid, and TravelingWave.

Definition at line 533 of file ElementBase.h.

Referenced by ElementBase::getBoundingBoxInLabCoords(), ElementBase::getEntryPort(), and ElementBase::isInsideTransverse().

getEdgeToEnd()

CoordinateSystemTrafo ElementBase::getEdgeToEnd ( ) const

inlinevirtualinherited

Reimplemented in BendBase, RFCavity, Solenoid, and TravelingWave.

Definition at line 538 of file ElementBase.h.

References ElementBase::getElementLength().

Referenced by ElementBase::getBoundingBoxInLabCoords(), and ElementBase::getExitPort().

Here is the call graph for this function:

getElementDimensions()

virtual void ElementBase::getElementDimensions ( double &  begin, double &  end  ) const

inlinevirtualinherited

Return the nominal body extent of the element.

The first placement redesign stage distinguishes between the nominal body extent and the field-support extent. The body extent is the canonical longitudinal interval of the placed hardware, \([z_\mathrm{body}^{\mathrm{begin}}, z_\mathrm{body}^{\mathrm{end}}]\), and therefore drives ports, placement, and visualization. By default it coincides with the geometry length \([0, L]\) in the local chart.

Reimplemented in RFCavity, TravelingWave, and Solenoid.

Definition at line 178 of file ElementBase.h.

References ElementBase::getElementLength().

Referenced by MeshGenerator::add().

Here is the call graph for this function:

getElementLength()

double ElementBase::getElementLength ( ) const

inlinevirtualinherited

Get design length.

Reimplemented in MarkerRep, TBeamline< T >, and RFCavity.

Definition at line 481 of file ElementBase.h.

References BGeometryBase::getElementLength(), and ElementBase::getGeometry().

Referenced by MeshGenerator::add(), ConstantEFieldCavity::apply(), Multipole::apply(), VariableRFCavity::apply(), BendBase::apply(), ConstantEFieldCavity::apply(), Multipole::apply(), VariableRFCavity::apply(), Component::apply(), Corrector::apply(), ConstantEFieldCavity::apply(), Multipole::apply(), VariableRFCavity::apply(), Component::applyToReferenceParticle(), ConstantEFieldCavity::applyToReferenceParticle(), Multipole::applyToReferenceParticle(), ElementBase::getEdgeToEnd(), Solenoid::getEdgeToEnd(), ElementBase::getElementDimensions(), Solenoid::getElementDimensions(), BeamlineGeometry::getElementLength(), RFCavity::getElementLength(), Corrector::getFieldExtend(), BendBase::getFieldExtend(), ConstantEFieldCavity::getFieldExtend(), Drift::getFieldExtend(), Laser::getFieldExtend(), Multipole::getFieldExtend(), MultipoleT::getFieldExtend(), VariableRFCavity::getFieldExtend(), BendBase::getLength(), Corrector::initialise(), BendBase::initialise(), ConstantEFieldCavity::initialise(), Drift::initialise(), Laser::initialise(), Multipole::initialise(), ElementBase::isInside(), BendBase::isInside(), Monitor::isInside(), Multipole::isInside(), ElementBase::isInsideTransverse(), and TEST_F().

Here is the call graph for this function:

getElementPosition()

double ElementBase::getElementPosition ( ) const

inlineinherited

Definition at line 618 of file ElementBase.h.

References ElementBase::elemedgeSet_m, ElementBase::elementPosition_m, and ElementBase::getName().

Here is the call graph for this function:

getEntrance()

double ElementBase::getEntrance ( ) const

inlinevirtualinherited

Get entrance position.

Reimplemented in TBeamline< T >.

Definition at line 487 of file ElementBase.h.

References BGeometryBase::getEntrance(), and ElementBase::getGeometry().

Referenced by BendBase::getDesignPath(), and BeamlineGeometry::getEntrance().

Here is the call graph for this function:

getEntranceFrame()

Euclid3D ElementBase::getEntranceFrame ( ) const

inlinevirtualinherited

Get transform.

Reimplemented in TBeamline< T >.

Definition at line 499 of file ElementBase.h.

References BGeometryBase::getEntranceFrame(), and ElementBase::getGeometry().

Referenced by BendBase::getChordLength(), BendBase::getEdgeToBegin(), and BeamlineGeometry::getEntranceFrame().

Here is the call graph for this function:

getEntrancePatch()

Euclid3D ElementBase::getEntrancePatch ( ) const

inlinevirtualinherited

Get patch.

Definition at line 503 of file ElementBase.h.

References BGeometryBase::getEntrancePatch(), and ElementBase::getGeometry().

Here is the call graph for this function:

getEntryPort()

Port ElementBase::getEntryPort ( ) const

inlinevirtualinherited

Return the entrance port of the canonical local chart.

In the placement-note language, this is the marked entrance port \(p_{i,\mathrm{entry}}\) of element \(i\). For straight elements in the bridge stage, the body-to-entry transform is taken from the legacy getEdgeToBegin() result.

Definition at line 545 of file ElementBase.h.

References ElementBase::getEdgeToBegin().

Referenced by ElementBase::getPlacementGeometry(), and TEST_F().

Here is the call graph for this function:

getExit()

double ElementBase::getExit ( ) const

inlinevirtualinherited

Get exit position.

Reimplemented in TBeamline< T >.

Definition at line 489 of file ElementBase.h.

References BGeometryBase::getExit(), and ElementBase::getGeometry().

Referenced by BendBase::getDesignPath(), and BeamlineGeometry::getExit().

Here is the call graph for this function:

getExitFrame()

Euclid3D ElementBase::getExitFrame ( ) const

inlinevirtualinherited

Get transform.

Reimplemented in TBeamline< T >.

Definition at line 501 of file ElementBase.h.

References BGeometryBase::getExitFrame(), and ElementBase::getGeometry().

Referenced by BendBase::getChordLength(), BendBase::getEdgeToEnd(), and BeamlineGeometry::getExitFrame().

Here is the call graph for this function:

getExitPatch()

Euclid3D ElementBase::getExitPatch ( ) const

inlinevirtualinherited

Get patch.

Definition at line 505 of file ElementBase.h.

References BGeometryBase::getExitPatch(), and ElementBase::getGeometry().

Here is the call graph for this function:

getExitPort()

Port ElementBase::getExitPort ( ) const

inlinevirtualinherited

Return the exit port of the canonical local chart.

In the placement-note language, this is the marked exit port \(p_{i,\mathrm{exit}}\). For straight elements in the bridge stage, the body-to-exit transform is taken from the legacy getEdgeToEnd() result.

Definition at line 549 of file ElementBase.h.

References ElementBase::getEdgeToEnd().

Referenced by ElementBase::getPlacementGeometry(), and TEST_F().

Here is the call graph for this function:

getField() [1/2]

NullField & ProbeRep::getField ( )

virtual

Get field.

Implements Component.

Definition at line 53 of file ProbeRep.cpp.

References field.

getField() [2/2]

const NullField & ProbeRep::getField ( ) const

virtual

Get field.

Implements Component.

Definition at line 55 of file ProbeRep.cpp.

References field.

getFieldExtend()

void PluginElement::getFieldExtend ( double &  zBegin, double &  zEnd  ) const

overridevirtualinherited

Return the field-support extent of the component.

This is the longitudinal interval \([z_\mathrm{field}^{\mathrm{begin}}, z_\mathrm{field}^{\mathrm{end}}]\) on which the external field model is evaluated in the element-local chart. In the first extent model this may differ from the nominal body extent returned by getElementDimensions(), for example when fringe fields extend beyond the hardware body or when a field map occupies only part of the body.

Implements Component.

Definition at line 202 of file PluginElement.cpp.

getFlagDeleteOnTransverseExit()

bool ElementBase::getFlagDeleteOnTransverseExit ( ) const

inlineinherited

Definition at line 634 of file ElementBase.h.

References ElementBase::deleteOnTransverseExit_m.

Referenced by BendBase::apply(), ConstantEFieldCavity::apply(), Multipole::apply(), Corrector::apply(), BendBase::apply(), ConstantEFieldCavity::apply(), Multipole::apply(), RFCavity::apply(), Solenoid::apply(), and TravelingWave::apply().

getGeometry() [1/2]

StraightGeometry & ProbeRep::getGeometry ( )

virtual

Get geometry.

Get geometry.

Implements ElementBase.

Definition at line 57 of file ProbeRep.cpp.

References geometry.

getGeometry() [2/2]

const StraightGeometry & ProbeRep::getGeometry ( ) const

virtual

Get geometry.

Implements ElementBase.

Definition at line 59 of file ProbeRep.cpp.

References geometry.

getMisalignment() [1/2]

CoordinateSystemTrafo ElementBase::getMisalignment ( ) const

inlineinherited

Definition at line 593 of file ElementBase.h.

References ElementBase::misalignment_m.

Referenced by ElementBase::getPlacementMisalignment().

getMisalignment() [2/2]

void ElementBase::getMisalignment ( double &  x, double &  y, double &  s  ) const

inherited

getName()

const std::string & ElementBase::getName ( ) const

virtualinherited

Get element name.

Definition at line 132 of file ElementBase.cpp.

References ElementBase::elementID.

Referenced by Ring::appendElement(), Probe::doGoOffline(), PlaceRep::enter(), ElementBase::getElementPosition(), RFCavity::getMomentaKick(), ElementBase::getOutputFN(), CavityAutophaser::getPhaseAtMaxEnergy(), Selector::handleElement(), Ring::initialise(), RFCavity::initialise(), Solenoid::initialise(), PlaceRep::leave(), VariableRFCavity::operator=(), Sequence::print(), TEST_F(), Component::trackBunch(), Component::trackMap(), OpalRBend::update(), OpalSBend::update(), Sequence::updateList(), ParallelTracker::updateRFElement(), and Replacer::visitFlaggedElmPtr().

getOrigin()

double ElementBase::getOrigin ( ) const

inlinevirtualinherited

Get origin position.

Reimplemented in TBeamline< T >.

Definition at line 485 of file ElementBase.h.

References ElementBase::getGeometry(), and BGeometryBase::getOrigin().

Referenced by BeamlineGeometry::getOrigin().

Here is the call graph for this function:

getOutputFN()

std::string ElementBase::getOutputFN ( ) const

inherited

Get output filename.

Definition at line 138 of file ElementBase.cpp.

References ElementBase::getName(), and ElementBase::outputfn_m.

Referenced by Probe::doInitialise(), PluginElement::initialise(), and Monitor::initialise().

Here is the call graph for this function:

getParticleMatterInteraction()

ParticleMatterInteractionHandler * ElementBase::getParticleMatterInteraction ( ) const

inlinevirtualinherited

Definition at line 517 of file ElementBase.h.

References ElementBase::parmatint_m.

getPlacedElement()

PlacedElement ElementBase::getPlacedElement ( ) const

inlineinherited

Return a placed-element view assembled from the current bridge objects.

Definition at line 571 of file ElementBase.h.

References ElementBase::getPlacementGeometry(), ElementBase::getPlacementMisalignment(), ElementBase::getPlacementPose(), and ElementBase::getPlacementSupport().

Referenced by MeshGenerator::add(), and TEST_F().

Here is the call graph for this function:

getPlacementGeometry()

ElementGeometry ElementBase::getPlacementGeometry ( ) const

inlineinherited

Return the bridge geometry ports assembled from legacy edge state.

The first redesign stage defines a minimal explicit port contract with three named body-relative ports: \(p_{i,\mathrm{entry}}\), \(p_{i,\mathrm{body}}\), \(p_{i,\mathrm{exit}}\). The default bridge preserves current OPALX behavior by deriving those ports from getEntryPort(), getBodyPort(), and getExitPort(), whose straight-element implementations are backed by the legacy getEdgeToBegin() and getEdgeToEnd() methods.

Definition at line 563 of file ElementBase.h.

References ElementBase::getBodyPort(), ElementBase::getEntryPort(), and ElementBase::getExitPort().

Referenced by ElementBase::getPlacedElement().

Here is the call graph for this function:

getPlacementMisalignment()

Misalignment ElementBase::getPlacementMisalignment ( ) const

inlineinherited

Return the local nominal-to-actual correction stored for the element.

Definition at line 559 of file ElementBase.h.

References ElementBase::getMisalignment().

Referenced by ElementBase::getPlacedElement().

Here is the call graph for this function:

getPlacementPose()

PlacementPose ElementBase::getPlacementPose ( ) const

inlineinherited

Return the nominal rigid placement transform of the element.

This is the bridge from the legacy stored CoordinateSystemTrafo to the new placement vocabulary. It preserves current nominal placement semantics and does not apply misalignment.

Definition at line 551 of file ElementBase.h.

References ElementBase::getCSTrafoGlobal2Local().

Referenced by ElementBase::getPlacedElement().

Here is the call graph for this function:

getPlacementSupport()

SupportPlacement ElementBase::getPlacementSupport ( ) const

inlineinherited

Return the support-frame bridge object. The default is the body frame.

Definition at line 567 of file ElementBase.h.

Referenced by ElementBase::getPlacedElement().

getPotential()

virtual bool Component::getPotential ( const Vector_t< double, 3 > &  , const double &  , Vector_t< double, 3 > &  , double &    )

inlinevirtualinherited

Calculate the four-potential at some position relative to the component.

Parameters

R	position in the local coordinate system of the component
t	time
A	filled with the calculated magnetic vector potential
phi	filled with the calculated electric potential Note that any existing values in A and phi may be overwritten by this method.

Returns

true if particle is outside the field map, else false Default for component is to return false and make no change to A and phi

Definition at line 155 of file Component.h.

getRequiredNumberOfTimeSteps()

int ElementBase::getRequiredNumberOfTimeSteps ( ) const

inlinevirtualinherited

Reimplemented in BendBase, Drift, Laser, Marker, and Monitor.

Definition at line 628 of file ElementBase.h.

getRotationAboutZ()

double ElementBase::getRotationAboutZ ( ) const

inlineinherited

Definition at line 609 of file ElementBase.h.

References ElementBase::rotationZAxis_m.

Referenced by OpalBeamline::compileCompatibilityPlacement().

getStep()

double Probe::getStep ( ) const

virtualinherited

Member variable access.

Definition at line 52 of file Probe.cpp.

References Probe::step_m.

getTotalTransform()

Euclid3D ElementBase::getTotalTransform ( ) const

inlinevirtualinherited

Get transform.

Reimplemented in TBeamline< T >.

Definition at line 495 of file ElementBase.h.

References ElementBase::getGeometry(), and BGeometryBase::getTotalTransform().

Referenced by BeamlineGeometry::getTotalTransform().

Here is the call graph for this function:

getTransform() [1/2]

Euclid3D ElementBase::getTransform ( double  fromS, double  toS  ) const

inlinevirtualinherited

Get transform.

Reimplemented in TBeamline< T >.

Definition at line 491 of file ElementBase.h.

References ElementBase::getGeometry(), and BGeometryBase::getTransform().

Referenced by BendBase::getDesignPath(), BeamlineGeometry::getTransform(), TBeamline< T >::getTransform(), and BeamlineGeometry::getTransform().

Here is the call graph for this function:

getTransform() [2/2]

Euclid3D ElementBase::getTransform ( double  s ) const

inlinevirtualinherited

Get transform.

Reimplemented in TBeamline< T >.

Definition at line 497 of file ElementBase.h.

References ElementBase::getGeometry(), and BGeometryBase::getTransform().

Here is the call graph for this function:

getType()

ElementType Probe::getType ( ) const

overridevirtualinherited

Get element type std::string.

Reimplemented from Component.

Definition at line 114 of file Probe.cpp.

References PROBE.

getTypeString() [1/2]

std::string ElementBase::getTypeString ( ) const

inlineinherited

Definition at line 611 of file ElementBase.h.

References ElementBase::getType(), and ElementBase::getTypeString().

Referenced by ElementBase::getTypeString().

Here is the call graph for this function:

getTypeString() [2/2]

std::string ElementBase::getTypeString ( ElementType  type )

staticinherited

Definition at line 192 of file ElementBase.cpp.

References ElementBase::elementTypeToString_s.

getWake()

WakeFunction * ElementBase::getWake ( ) const

inlinevirtualinherited

return the attached wake object if there is any

Definition at line 509 of file ElementBase.h.

References ElementBase::wake_m.

getXEnd()

double PluginElement::getXEnd ( ) const

inherited

Definition at line 181 of file PluginElement.cpp.

References PluginElement::xend_m.

getXStart()

double PluginElement::getXStart ( ) const

inherited

Member variable access.

Definition at line 179 of file PluginElement.cpp.

References PluginElement::xstart_m.

getYEnd()

double PluginElement::getYEnd ( ) const

inherited

Definition at line 185 of file PluginElement.cpp.

References PluginElement::yend_m.

getYStart()

double PluginElement::getYStart ( ) const

inherited

Definition at line 183 of file PluginElement.cpp.

References PluginElement::ystart_m.

goOffline()

void PluginElement::goOffline ( )

finalvirtualinherited

Reimplemented from Component.

Definition at line 58 of file PluginElement.cpp.

References PluginElement::doGoOffline(), PluginElement::lossDs_m, and Component::online_m.

Referenced by PluginElement::finalise(), and PluginElement::~PluginElement().

Here is the call graph for this function:

goOnline()

void Component::goOnline ( const double &  kineticEnergy )

virtualinherited

Reimplemented in Corrector, Monitor, RFCavity, Solenoid, and TravelingWave.

Definition at line 43 of file Component.cpp.

References Component::online_m.

Referenced by PluginElement::initialise().

hasAttribute()

bool ElementBase::hasAttribute ( const std::string &  aKey ) const

virtualinherited

Test for existence of an attribute.

Definition at line 159 of file ElementBase.cpp.

References ElementBase::getConstChannel().

Here is the call graph for this function:

hasBoundaryGeometry()

bool ElementBase::hasBoundaryGeometry ( ) const

inlinevirtualinherited

Definition at line 515 of file ElementBase.h.

References ElementBase::bgeometry_m.

hasParticleMatterInteraction()

bool ElementBase::hasParticleMatterInteraction ( ) const

inlinevirtualinherited

Definition at line 521 of file ElementBase.h.

References ElementBase::parmatint_m.

hasWake()

bool ElementBase::hasWake ( ) const

inlinevirtualinherited

Definition at line 511 of file ElementBase.h.

References ElementBase::wake_m.

initialise() [1/2]

void PluginElement::initialise ( PartBunch_t *  bunch )

inherited

Definition at line 45 of file PluginElement.cpp.

References Options::asciidump, PluginElement::doInitialise(), ElementBase::getOutputFN(), Component::goOnline(), PluginElement::lossDs_m, and Component::RefPartBunch_m.

Here is the call graph for this function:

initialise() [2/2]

void PluginElement::initialise ( PartBunch_t *  bunch, double &  startField, double &  endField  )

overridevirtualinherited

Pure virtual implementation of Component.

Implements Component.

Definition at line 43 of file PluginElement.cpp.

References PluginElement::initialise().

Referenced by PluginElement::initialise().

Here is the call graph for this function:

isElementPositionSet()

bool ElementBase::isElementPositionSet ( ) const

inlineinherited

Definition at line 626 of file ElementBase.h.

References ElementBase::elemedgeSet_m.

isInside()

bool ElementBase::isInside ( const Vector_t< double, 3 > &  r ) const

inlinevirtualinherited

Reimplemented in BendBase, Monitor, Multipole, RFCavity, Solenoid, and TravelingWave.

Definition at line 586 of file ElementBase.h.

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

Referenced by TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), and TEST_F().

Here is the call graph for this function:

isInsideTransverse()

bool ElementBase::isInsideTransverse ( const Vector_t< double, 3 > &  r ) const

protectedinherited

Definition at line 233 of file ElementBase.cpp.

References ElementBase::aperture_m, CONIC_ELLIPTICAL, CONIC_RECTANGULAR, ELLIPTICAL, ElementBase::getEdgeToBegin(), ElementBase::getElementLength(), RECTANGULAR, and CoordinateSystemTrafo::transformTo().

Referenced by BendBase::apply(), ConstantEFieldCavity::apply(), Multipole::apply(), Component::apply(), Corrector::apply(), BendBase::apply(), ConstantEFieldCavity::apply(), Multipole::apply(), Component::applyToReferenceParticle(), BendBase::applyToReferenceParticle(), ConstantEFieldCavity::applyToReferenceParticle(), Multipole::applyToReferenceParticle(), ElementBase::isInside(), BendBase::isInside(), Monitor::isInside(), Multipole::isInside(), RFCavity::isInside(), Solenoid::isInside(), and TravelingWave::isInside().

Here is the call graph for this function:

isPositioned()

bool ElementBase::isPositioned ( ) const

inlineinherited

Definition at line 599 of file ElementBase.h.

References ElementBase::positionIsFixed.

Referenced by OpalRBend::update(), and OpalSBend::update().

isSharable()

bool ElementBase::isSharable ( ) const

inlineinherited

Test if the element can be shared.

Definition at line 507 of file ElementBase.h.

References ElementBase::shareFlag.

Referenced by ElementBase::copyStructure(), and Sequence::updateList().

makeSharable()

void ElementBase::makeSharable ( )

virtualinherited

Set sharable flag.

Reimplemented in TBeamline< T >.

Definition at line 202 of file ElementBase.cpp.

References ElementBase::shareFlag.

Referenced by OpalMarker::OpalMarker().

Online()

bool Component::Online ( )

virtualinherited

Definition at line 47 of file Component.cpp.

References Component::online_m.

operator=()

void ProbeRep::operator= ( const ProbeRep &  )

private

preCheck()

bool PluginElement::preCheck ( PartBunch_t *  bunch )

inlineprivateinherited

Check if bunch is close to element.

Definition at line 88 of file PluginElement.h.

References PluginElement::doPreCheck().

Referenced by PluginElement::check().

Here is the call graph for this function:

releasePosition()

void ElementBase::releasePosition ( )

inlineinherited

Definition at line 595 of file ElementBase.h.

References ElementBase::positionIsFixed.

Referenced by OpalRBend::update(), and OpalSBend::update().

removeAttribute()

void ElementBase::removeAttribute ( const std::string &  aKey )

virtualinherited

Remove an existing attribute.

Definition at line 170 of file ElementBase.cpp.

References AttributeSet::removeAttribute(), and ElementBase::userAttribs.

Here is the call graph for this function:

save()

void PluginElement::save ( )

inherited

Save output.

Definition at line 219 of file PluginElement.cpp.

References OpalData::APPEND, OpalData::getInstance(), OpalData::getOpenMode(), PluginElement::lossDs_m, and PluginElement::numPassages_m.

Here is the call graph for this function:

setActionRange()

void ElementBase::setActionRange ( const std::queue< std::pair< double, double > > &  range )

inlineinherited

Definition at line 601 of file ElementBase.h.

References ElementBase::actionRange_m, and ElementBase::elementEdge_m.

setActive()

void ProbeRep::setActive ( bool  flag = true )

virtual

Set active flag.

Definition at line 61 of file ProbeRep.cpp.

References active.

setAperture()

void ElementBase::setAperture ( const ApertureType &  type, const std::vector< double > &  args  )

inlineinherited

Definition at line 577 of file ElementBase.h.

References ElementBase::aperture_m.

Referenced by Component::Component(), TEST_F(), TEST_F(), TEST_F(), OpalElement::update(), OpalRBend::update(), and OpalSBend::update().

setAttribute()

void ElementBase::setAttribute ( const std::string &  aKey, double  val  )

virtualinherited

Set value of an attribute.

Definition at line 172 of file ElementBase.cpp.

References ElementBase::getChannel(), and Channel::isSettable().

Referenced by ElementBase::update(), and OpalElement::updateUnknown().

Here is the call graph for this function:

setBoundaryGeometry()

void ElementBase::setBoundaryGeometry ( BoundaryGeometry *  geo )

virtualinherited

attach a boundary geometry field to the element

Definition at line 216 of file ElementBase.cpp.

References ElementBase::bgeometry_m.

setCSTrafoGlobal2Local()

void ElementBase::setCSTrafoGlobal2Local ( const CoordinateSystemTrafo &  ori )

inlineinherited

Definition at line 523 of file ElementBase.h.

References ElementBase::csTrafoGlobal2Local_m, and ElementBase::positionIsFixed.

Referenced by ElementBase::setPlacementPose(), TEST_F(), OpalElement::update(), OpalRBend::update(), and OpalSBend::update().

setCurrentSCoordinate()

void ElementBase::setCurrentSCoordinate ( double  s )

inherited

Definition at line 224 of file ElementBase.cpp.

References ElementBase::actionRange_m, and ElementBase::elementEdge_m.

setDesignEnergy()

void Component::setDesignEnergy ( const double &  energy, bool  changeable = true  )

inlinevirtualinherited

Reimplemented in Corrector, RFCavity, and BendBase.

Definition at line 252 of file Component.h.

setDimensions()

void PluginElement::setDimensions ( double  xstart, double  xend, double  ystart, double  yend  )

inherited

Set dimensions and consistency checks.

Definition at line 87 of file PluginElement.cpp.

References PluginElement::A_m, PluginElement::B_m, PluginElement::C_m, PluginElement::R_m, PluginElement::rend_m, PluginElement::rmin_m, PluginElement::rstart_m, PluginElement::xend_m, PluginElement::xstart_m, PluginElement::yend_m, and PluginElement::ystart_m.

Referenced by PluginElement::PluginElement(), PluginElement::PluginElement(), and OpalProbe::update().

setElementLength()

void ElementBase::setElementLength ( double  length )

inlinevirtualinherited

Set design length.

Reimplemented in MultipoleT, and ConstantEFieldCavityRep.

Definition at line 483 of file ElementBase.h.

References ElementBase::getGeometry(), and BGeometryBase::setElementLength().

Referenced by MultipoleT::setElementLength(), SequenceMember::setLength(), BendBase::setLength(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), OpalCavity::update(), OpalMonitor::update(), OpalMultipole::update(), OpalProbe::update(), OpalQuadrupole::update(), OpalSolenoid::update(), and OpalTravelingWave::update().

Here is the call graph for this function:

setElementPosition()

void ElementBase::setElementPosition ( double  elemedge )

inlineinherited

Access to ELEMEDGE attribute.

Definition at line 613 of file ElementBase.h.

References ElementBase::elemedgeSet_m, and ElementBase::elementPosition_m.

Referenced by TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), and OpalElement::update().

setExitFaceSlope()

void Component::setExitFaceSlope ( const double &  m )

inlineinherited

Definition at line 250 of file Component.h.

References Component::exit_face_slope_m.

setFlagDeleteOnTransverseExit()

void ElementBase::setFlagDeleteOnTransverseExit ( bool  flag = true )

inlineinherited

Definition at line 630 of file ElementBase.h.

References ElementBase::deleteOnTransverseExit_m.

Referenced by OpalElement::update().

setGeom()

void PluginElement::setGeom ( const double  dist )

protectedinherited

Sets geometry geom_m with element width dist.

Definition at line 116 of file PluginElement.cpp.

References PluginElement::doSetGeom(), PluginElement::geom_m, Point::x, PluginElement::xend_m, PluginElement::xstart_m, Point::y, PluginElement::yend_m, and PluginElement::ystart_m.

Referenced by PluginElement::changeWidth().

Here is the call graph for this function:

setMisalignment()

void ElementBase::setMisalignment ( const CoordinateSystemTrafo &  cst )

inlineinherited

Definition at line 591 of file ElementBase.h.

References ElementBase::misalignment_m.

Referenced by TEST_F(), and OpalElement::update().

setName()

void ElementBase::setName ( const std::string &  name )

virtualinherited

Set element name.

Definition at line 134 of file ElementBase.cpp.

References ElementBase::elementID.

Referenced by Sequence::insertDrifts(), and VariableRFCavity::operator=().

setOutputFN()

void ElementBase::setOutputFN ( std::string  fn )

inherited

Set output filename.

Definition at line 136 of file ElementBase.cpp.

References ElementBase::outputfn_m.

Referenced by OpalMonitor::update(), and OpalProbe::update().

setParticleMatterInteraction()

void ElementBase::setParticleMatterInteraction ( ParticleMatterInteractionHandler *  spys )

virtualinherited

Definition at line 220 of file ElementBase.cpp.

References ElementBase::parmatint_m.

setPlacementPose()

void ElementBase::setPlacementPose ( const PlacementPose &  pose )

inlineinherited

Set the nominal rigid placement transform of the element.

This bridge setter preserves the existing storage model by delegating to setCSTrafoGlobal2Local().

Definition at line 555 of file ElementBase.h.

References PlacementPose::getParentToNominal(), and ElementBase::setCSTrafoGlobal2Local().

Here is the call graph for this function:

setRotationAboutZ()

void ElementBase::setRotationAboutZ ( double  rotation )

inlineinherited

Set rotation about z axis in bend frame.

Definition at line 607 of file ElementBase.h.

References ElementBase::rotationZAxis_m.

Referenced by OpalElement::update().

setStep()

void Probe::setStep ( double  step )

inherited

Set probe histogram bin width.

Definition at line 50 of file Probe.cpp.

References Probe::step_m.

Referenced by OpalProbe::update().

setWake()

void ElementBase::setWake ( WakeFunction *  wf )

virtualinherited

attach a wake field to the element

Definition at line 212 of file ElementBase.cpp.

References ElementBase::wake_m.

trackBunch()

void Component::trackBunch ( PartBunch_t &  bunch, const PartData &  , bool  revBeam, bool  revTrack  ) const

virtualinherited

Track a borrowed particle bunch through a non-standard component.

The default implementation throws a LogicalError.

Parameters

bunch

Particle bunch to track. The component does not take ownership.

Definition at line 35 of file Component.cpp.

References ElementBase::getName().

Referenced by Tracker::visitComponent().

Here is the call graph for this function:

trackMap()

void Component::trackMap ( FVps< double, 6 > &  map, const PartData &  , bool  revBeam, bool  revTrack  ) const

virtualinherited

Track a map.

Definition at line 39 of file Component.cpp.

References ElementBase::getName().

Here is the call graph for this function:

update()

bool ElementBase::update ( const AttributeSet &  set )

inherited

Update element.

Definition at line 204 of file ElementBase.cpp.

References AttributeSet::begin(), AttributeSet::end(), and ElementBase::setAttribute().

Referenced by Monitor::driftToCorrectPositionAndSave().

Here is the call graph for this function:

Member Data Documentation

A_m

double PluginElement::A_m

protectedinherited

Definition at line 122 of file PluginElement.h.

Referenced by PluginElement::calculateIncidentAngle(), Probe::doCheck(), and PluginElement::setDimensions().

actionRange_m

std::queue<std::pair<double, double> > ElementBase::actionRange_m

privateinherited

Definition at line 469 of file ElementBase.h.

Referenced by ElementBase::setActionRange(), and ElementBase::setCurrentSCoordinate().

active

bool ProbeRep::active

protected

The active/inactive flag.

Definition at line 76 of file ProbeRep.h.

Referenced by setActive().

aperture_m

std::pair<ApertureType, std::vector<double> > ElementBase::aperture_m

protectedinherited

Definition at line 440 of file ElementBase.h.

Referenced by ElementBase::getAperture(), ElementBase::getBoundingBoxInLabCoords(), ElementBase::isInsideTransverse(), and ElementBase::setAperture().

B_m

double PluginElement::B_m

protectedinherited

Definition at line 122 of file PluginElement.h.

Referenced by PluginElement::calculateIncidentAngle(), Probe::doCheck(), and PluginElement::setDimensions().

bgeometry_m

BoundaryGeometry* ElementBase::bgeometry_m

privateinherited

Definition at line 460 of file ElementBase.h.

Referenced by ElementBase::getBoundaryGeometry(), ElementBase::hasBoundaryGeometry(), and ElementBase::setBoundaryGeometry().

C_m

double PluginElement::C_m

protectedinherited

Geometric lengths used in calculations.

Definition at line 122 of file PluginElement.h.

Referenced by Probe::doCheck(), and PluginElement::setDimensions().

csTrafoGlobal2Local_m

CoordinateSystemTrafo ElementBase::csTrafoGlobal2Local_m

protectedinherited

Definition at line 437 of file ElementBase.h.

Referenced by Monitor::applyToReferenceParticle(), ElementBase::getBoundingBoxInLabCoords(), ElementBase::getCSTrafoGlobal2Local(), and ElementBase::setCSTrafoGlobal2Local().

defaultAperture_m

const std::vector< double > Component::defaultAperture_m = std::vector<double>({1e6, 1e6, 1.0})

staticprotectedinherited

Definition at line 221 of file Component.h.

Referenced by Component::Component().

deleteOnTransverseExit_m

bool ElementBase::deleteOnTransverseExit_m = true

privateinherited

Definition at line 473 of file ElementBase.h.

Referenced by ElementBase::getFlagDeleteOnTransverseExit(), and ElementBase::setFlagDeleteOnTransverseExit().

elemedgeSet_m

bool ElementBase::elemedgeSet_m

privateinherited

Definition at line 467 of file ElementBase.h.

Referenced by ElementBase::getElementPosition(), ElementBase::isElementPositionSet(), and ElementBase::setElementPosition().

elementEdge_m

double ElementBase::elementEdge_m

protectedinherited

Definition at line 442 of file ElementBase.h.

Referenced by ElementBase::setActionRange(), and ElementBase::setCurrentSCoordinate().

elementID

std::string ElementBase::elementID

privateinherited

Definition at line 451 of file ElementBase.h.

Referenced by ElementBase::getName(), and ElementBase::setName().

elementPosition_m

double ElementBase::elementPosition_m

privateinherited

ELEMEDGE attribute.

Definition at line 466 of file ElementBase.h.

Referenced by ElementBase::getElementPosition(), and ElementBase::setElementPosition().

elementTypeToString_s

const std::map< ElementType, std::string > ElementBase::elementTypeToString_s

staticprivateinherited

Initial value:

= {
        {ElementType::ANY, "Any"},
        {ElementType::BEAMLINE, "Beamline"},
        {ElementType::DRIFT, "Drift"},
        {ElementType::LASER, "Laser"},
        {ElementType::MARKER, "Marker"},
        {ElementType::MONITOR, "Monitor"},
        {ElementType::MULTIPOLE, "Multipole"},
        {ElementType::RFCAVITY, "RFCavity"},
        {ElementType::TRAVELINGWAVE, "TravelingWave"},
        {ElementType::SBEND, "SBEND"},
        {ElementType::RBEND, "RBEND"},
        {ElementType::RBEND3D, "RBEND3D"},
        {ElementType::RING, "Ring"},
        {ElementType::SOURCE, "SOURCE"},
        {ElementType::SOLENOID, "SOLENOID"},
        {ElementType::PROBE, "Probe"},
        {ElementType::VACUUM, "Vacuum"},
        {ElementType::CONSTANTEFIELDCAVITY, "ConstantEFieldCavity"}}

Definition at line 73 of file ElementBase.h.

Referenced by ElementBase::getTypeString().

exit_face_slope_m

double Component::exit_face_slope_m

protectedinherited

Definition at line 222 of file Component.h.

Referenced by Component::setExitFaceSlope().

field

NullField ProbeRep::field

protected

The zero magnetic field.

Definition at line 70 of file ProbeRep.h.

Referenced by getField(), and getField().

geom_m

Point PluginElement::geom_m[5]

protectedinherited

actual geometry positions with adaptive width such that each particle hits element once per turn

Definition at line 120 of file PluginElement.h.

Referenced by PluginElement::checkPoint(), and PluginElement::setGeom().

geometry

StraightGeometry ProbeRep::geometry

protected

The probe's geometry.

Definition at line 73 of file ProbeRep.h.

Referenced by getGeometry(), and getGeometry().

lossDs_m

std::unique_ptr<LossDataSink> PluginElement::lossDs_m

protectedinherited

Pointer to Loss instance.

Definition at line 124 of file PluginElement.h.

Referenced by PluginElement::goOffline(), PluginElement::initialise(), and PluginElement::save().

misalignment_m

CoordinateSystemTrafo ElementBase::misalignment_m

protectedinherited

Definition at line 438 of file ElementBase.h.

Referenced by ElementBase::getMisalignment(), and ElementBase::setMisalignment().

numPassages_m

int PluginElement::numPassages_m = 0

protectedinherited

Number of turns (number of times save() method is called)

Definition at line 125 of file PluginElement.h.

Referenced by PluginElement::save().

online_m

bool Component::online_m

protectedinherited

Definition at line 226 of file Component.h.

Referenced by Monitor::apply(), Monitor::apply(), Monitor::applyToReferenceParticle(), Probe::doGoOffline(), PluginElement::finalise(), BendBase::finalise(), Multipole::finalise(), Ring::finalise(), Component::goOffline(), PluginElement::goOffline(), RFCavity::goOffline(), Solenoid::goOffline(), Component::goOnline(), Corrector::goOnline(), Monitor::goOnline(), RFCavity::goOnline(), Solenoid::goOnline(), TravelingWave::goOnline(), Ring::initialise(), BendBase::initialise(), Multipole::initialise(), Component::Online(), and PluginElement::~PluginElement().

outputfn_m

std::string ElementBase::outputfn_m

privateinherited

The name of the outputfile

Definition at line 471 of file ElementBase.h.

Referenced by ElementBase::getOutputFN(), and ElementBase::setOutputFN().

parmatint_m

ParticleMatterInteractionHandler* ElementBase::parmatint_m

privateinherited

Definition at line 462 of file ElementBase.h.

Referenced by ElementBase::getParticleMatterInteraction(), ElementBase::hasParticleMatterInteraction(), and ElementBase::setParticleMatterInteraction().

peakfinder_m

std::unique_ptr<PeakFinder> Probe::peakfinder_m

privateinherited

Pointer to Peakfinder instance.

Definition at line 60 of file Probe.h.

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

positionIsFixed

bool ElementBase::positionIsFixed

privateinherited

Definition at line 464 of file ElementBase.h.

Referenced by ElementBase::fixPosition(), ElementBase::isPositioned(), ElementBase::releasePosition(), and ElementBase::setCSTrafoGlobal2Local().

R_m

double PluginElement::R_m

protectedinherited

Definition at line 122 of file PluginElement.h.

Referenced by Probe::doCheck(), and PluginElement::setDimensions().

RefPartBunch_m

PartBunch_t* Component::RefPartBunch_m

protectedinherited

Definition at line 225 of file Component.h.

Referenced by Corrector::apply(), VerticalFFAMagnet::apply(), BendBase::apply(), ConstantEFieldCavity::apply(), Monitor::apply(), Multipole::apply(), MultipoleT::apply(), RFCavity::apply(), ScalingFFAMagnet::apply(), Solenoid::apply(), TravelingWave::apply(), VariableRFCavity::apply(), Ring::apply(), Monitor::apply(), MultipoleT::apply(), RFCavity::apply(), TravelingWave::apply(), VariableRFCavity::apply(), Corrector::apply(), Monitor::applyToReferenceParticle(), BendBase::calcDesignRadius(), BendBase::calcFieldAmplitude(), BendBase::calcGamma(), Monitor::driftToCorrectPositionAndSave(), VerticalFFAMagnet::finalise(), MultipoleT::finalise(), ScalingFFAMagnet::finalise(), VariableRFCavity::finalise(), Corrector::goOnline(), PluginElement::initialise(), Corrector::initialise(), VerticalFFAMagnet::initialise(), BendBase::initialise(), ConstantEFieldCavity::initialise(), Drift::initialise(), Laser::initialise(), Marker::initialise(), Monitor::initialise(), Multipole::initialise(), MultipoleT::initialise(), RFCavity::initialise(), ScalingFFAMagnet::initialise(), Solenoid::initialise(), TravelingWave::initialise(), VariableRFCavity::initialise(), RFCavity::initialise(), VariableRFCavity::initNull(), Multipole::isFocusing(), MultipoleT::MultipoleT(), ScalingFFAMagnet::ScalingFFAMagnet(), Corrector::setDesignEnergy(), Ring::setRefPartBunch(), RFCavity::trackOnAxisParticle(), and VerticalFFAMagnet::VerticalFFAMagnet().

rend_m

double PluginElement::rend_m

protectedinherited

Definition at line 117 of file PluginElement.h.

Referenced by Probe::doInitialise(), Probe::doPreCheck(), and PluginElement::setDimensions().

rmin_m

double PluginElement::rmin_m

protectedinherited

radius closest to the origin

Definition at line 119 of file PluginElement.h.

Referenced by Probe::doInitialise(), Probe::doPreCheck(), and PluginElement::setDimensions().

rotationZAxis_m

double ElementBase::rotationZAxis_m

protectedinherited

Definition at line 444 of file ElementBase.h.

Referenced by ElementBase::getRotationAboutZ(), and ElementBase::setRotationAboutZ().

rstart_m

double PluginElement::rstart_m

protectedinherited

Definition at line 116 of file PluginElement.h.

Referenced by PluginElement::setDimensions().

shareFlag

bool ElementBase::shareFlag

mutableprotectedinherited

Definition at line 435 of file ElementBase.h.

Referenced by Beamline::Beamline(), Beamline::Beamline(), Beamline::Beamline(), ElementBase::isSharable(), and ElementBase::makeSharable().

step_m

double Probe::step_m

privateinherited

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

Definition at line 59 of file Probe.h.

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

userAttribs

AttributeSet ElementBase::userAttribs

privateinherited

Definition at line 456 of file ElementBase.h.

Referenced by ElementBase::getChannel(), and ElementBase::removeAttribute().

wake_m

WakeFunction* ElementBase::wake_m

privateinherited

Definition at line 458 of file ElementBase.h.

Referenced by ElementBase::getWake(), ElementBase::hasWake(), and ElementBase::setWake().

xend_m

double PluginElement::xend_m

protectedinherited

Definition at line 113 of file PluginElement.h.

Referenced by PluginElement::getXEnd(), PluginElement::PluginElement(), PluginElement::setDimensions(), and PluginElement::setGeom().

xstart_m

double PluginElement::xstart_m

protectedinherited

input geometry positions

Definition at line 112 of file PluginElement.h.

Referenced by PluginElement::getXStart(), PluginElement::PluginElement(), PluginElement::setDimensions(), and PluginElement::setGeom().

yend_m

double PluginElement::yend_m

protectedinherited

Definition at line 115 of file PluginElement.h.

Referenced by PluginElement::getYEnd(), PluginElement::PluginElement(), PluginElement::setDimensions(), and PluginElement::setGeom().

ystart_m

double PluginElement::ystart_m

protectedinherited

Definition at line 114 of file PluginElement.h.

Referenced by PluginElement::getYStart(), PluginElement::PluginElement(), PluginElement::setDimensions(), and PluginElement::setGeom().

---

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

• ProbeRep.h
• ProbeRep.cpp