#include <ElementBase.h>

Inheritance diagram for ElementBase:

Collaboration diagram for ElementBase:

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

	ElementBase ()

	ElementBase (const ElementBase &)

virtual	~ElementBase ()

virtual const std::string &	getName () const
	Get element name.

virtual void	setName (const std::string &name)
	Set element name.

virtual ElementType	getType () const =0
	Get element type std::string.

std::string	getTypeString () const

virtual BGeometryBase &	getGeometry ()=0
	Get geometry.

virtual const BGeometryBase &	getGeometry () const =0
	Get geometry.

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 Channel *	getChannel (const std::string &aKey, bool create=false)
	Construct a read/write channel.

virtual const ConstChannel *	getConstChannel (const std::string &aKey) const
	Construct a read-only channel.

virtual void	accept (BeamlineVisitor &visitor) const =0
	Apply visitor.

virtual ElementBase *	clone () const =0
	Return clone.

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


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
bool	isInsideTransverse (const Vector_t< double, 3 > &r) const

Protected Attributes
bool	shareFlag

CoordinateSystemTrafo	csTrafoGlobal2Local_m

CoordinateSystemTrafo	misalignment_m

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

double	elementEdge_m

double	rotationZAxis_m

Private Member Functions
void	operator= (const ElementBase &)

Private Attributes
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 123 of file ElementBase.h.

Constructor & Destructor Documentation

◆ ElementBase() [1/3]

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

explicit

Constructor with given name.

Definition at line 114 of file ElementBase.cpp.

◆ ElementBase() [2/3]

ElementBase::ElementBase ( )

Definition at line 93 of file ElementBase.cpp.

◆ ElementBase() [3/3]

ElementBase::ElementBase ( const ElementBase & right )

Definition at line 95 of file ElementBase.cpp.

◆ ~ElementBase()

ElementBase::~ElementBase ( )

virtual

Definition at line 130 of file ElementBase.cpp.

Member Function Documentation

◆ accept()

virtual void ElementBase::accept ( BeamlineVisitor & visitor ) const

pure virtual

Apply visitor.

Implemented in Corrector, TBeamline< T >, Drift, Laser, Marker, Monitor, Multipole, Probe, RFCavity, Solenoid, TravelingWave, VariableRFCavity, VerticalFFAMagnet, ConstantEFieldCavity, MultipoleT, RBend, Ring, SBend, ScalingFFAMagnet, and DummyBeamline.

Referenced by DefaultVisitor::execute(), ParallelTracker::prepareSections(), SpecificElementVisitor< ELEM >::visitFlaggedElmPtr(), and DefaultVisitor::visitFlaggedElmPtr().

◆ clone()

virtual ElementBase * ElementBase::clone ( ) const

pure virtual

Return clone.

Implemented in VerticalFFAMagnet, DriftRep, MarkerRep, MonitorRep, MultipoleRep, ProbeRep, RFCavityRep, SolenoidRep, TravelingWaveRep, TBeamline< T >, MultipoleT, Ring, ScalingFFAMagnet, VariableRFCavity, ConstantEFieldCavityRep, LaserRep, RBendRep, SBendRep, TestMonitor, TestRFCavity, DummyBeamline, and TestTravelingWave.

Referenced by Ring::appendElement(), Sequence::copy(), copyStructure(), and RingSection::operator=().

◆ copyStructure()

ElementBase * ElementBase::copyStructure ( )

virtual

Make a structural copy.

Reimplemented in TBeamline< T >.

Definition at line 194 of file ElementBase.cpp.

References clone(), and isSharable().

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

Here is the call graph for this function:

◆ fixPosition()

void ElementBase::fixPosition ( )

inline

Definition at line 597 of file ElementBase.h.

References positionIsFixed.

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

◆ getAperture()

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

inline

Definition at line 582 of file ElementBase.h.

References aperture_m.

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

◆ getArcLength()

double ElementBase::getArcLength ( ) const

inlinevirtual

Get arc length.

Reimplemented in MarkerRep, and TBeamline< T >.

Definition at line 479 of file ElementBase.h.

References BGeometryBase::getArcLength(), and 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

virtual

Get attribute value.

Definition at line 147 of file ElementBase.cpp.

References getConstChannel().

Here is the call graph for this function:

◆ getBodyPort()

Port ElementBase::getBodyPort ( ) const

inlinevirtual

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 getPlacementGeometry(), and TEST_F().

◆ getBoundaryGeometry()

BoundaryGeometry * ElementBase::getBoundaryGeometry ( ) const

inlinevirtual

return the attached boundary geometrt object if there is any

Definition at line 513 of file ElementBase.h.

References bgeometry_m.

◆ getBoundingBoxInLabCoords()

BoundingBox ElementBase::getBoundingBoxInLabCoords ( ) const

virtual

Definition at line 264 of file ElementBase.cpp.

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

Here is the call graph for this function:

◆ getChannel()

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

virtual

Construct a read/write channel.

Reimplemented in LaserRep, RBendRep, SBendRep, DriftRep, MonitorRep, MultipoleRep, ProbeRep, RFCavityRep, SolenoidRep, TravelingWaveRep, and ConstantEFieldCavityRep.

Definition at line 182 of file ElementBase.cpp.

References AttributeSet::getChannel(), and userAttribs.

Referenced by LaserRep::getChannel(), RBendRep::getChannel(), SBendRep::getChannel(), DriftRep::getChannel(), MonitorRep::getChannel(), MultipoleRep::getChannel(), ProbeRep::getChannel(), RFCavityRep::getChannel(), SolenoidRep::getChannel(), TravelingWaveRep::getChannel(), ConstantEFieldCavityRep::getChannel(), getConstChannel(), and setAttribute().

Here is the call graph for this function:

◆ getConstChannel()

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

virtual

Construct a read-only channel.

Definition at line 186 of file ElementBase.cpp.

References getChannel().

Referenced by getAttribute(), and hasAttribute().

Here is the call graph for this function:

◆ getCSTrafoGlobal2Local()

CoordinateSystemTrafo ElementBase::getCSTrafoGlobal2Local ( ) const

inline

Definition at line 529 of file ElementBase.h.

References csTrafoGlobal2Local_m.

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

◆ getEdgeToBegin()

CoordinateSystemTrafo ElementBase::getEdgeToBegin ( ) const

inlinevirtual

Reimplemented in BendBase, RFCavity, Solenoid, and TravelingWave.

Definition at line 533 of file ElementBase.h.

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

◆ getEdgeToEnd()

CoordinateSystemTrafo ElementBase::getEdgeToEnd ( ) const

inlinevirtual

Reimplemented in BendBase, RFCavity, Solenoid, and TravelingWave.

Definition at line 538 of file ElementBase.h.

References getElementLength().

Referenced by getBoundingBoxInLabCoords(), and getExitPort().

Here is the call graph for this function:

◆ getElementDimensions()

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

inlinevirtual

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 getElementLength().

Referenced by MeshGenerator::add().

Here is the call graph for this function:

◆ getElementLength()

double ElementBase::getElementLength ( ) const

inlinevirtual

Get design length.

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

Definition at line 481 of file ElementBase.h.

References BGeometryBase::getElementLength(), and 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(), getEdgeToEnd(), Solenoid::getEdgeToEnd(), 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(), isInside(), BendBase::isInside(), Monitor::isInside(), Multipole::isInside(), isInsideTransverse(), and TEST_F().

Here is the call graph for this function:

◆ getElementPosition()

double ElementBase::getElementPosition ( ) const

inline

Definition at line 618 of file ElementBase.h.

References elemedgeSet_m, elementPosition_m, and getName().

Here is the call graph for this function:

◆ getEntrance()

double ElementBase::getEntrance ( ) const

inlinevirtual

Get entrance position.

Reimplemented in TBeamline< T >.

Definition at line 487 of file ElementBase.h.

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

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

Here is the call graph for this function:

◆ getEntranceFrame()

Euclid3D ElementBase::getEntranceFrame ( ) const

inlinevirtual

Get transform.

Reimplemented in TBeamline< T >.

Definition at line 499 of file ElementBase.h.

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

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

Here is the call graph for this function:

◆ getEntrancePatch()

Euclid3D ElementBase::getEntrancePatch ( ) const

inlinevirtual

Get patch.

Definition at line 503 of file ElementBase.h.

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

Here is the call graph for this function:

◆ getEntryPort()

Port ElementBase::getEntryPort ( ) const

inlinevirtual

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 getEdgeToBegin().

Referenced by getPlacementGeometry(), and TEST_F().

Here is the call graph for this function:

◆ getExit()

double ElementBase::getExit ( ) const

inlinevirtual

Get exit position.

Reimplemented in TBeamline< T >.

Definition at line 489 of file ElementBase.h.

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

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

Here is the call graph for this function:

◆ getExitFrame()

Euclid3D ElementBase::getExitFrame ( ) const

inlinevirtual

Get transform.

Reimplemented in TBeamline< T >.

Definition at line 501 of file ElementBase.h.

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

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

Here is the call graph for this function:

◆ getExitPatch()

Euclid3D ElementBase::getExitPatch ( ) const

inlinevirtual

Get patch.

Definition at line 505 of file ElementBase.h.

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

Here is the call graph for this function:

◆ getExitPort()

Port ElementBase::getExitPort ( ) const

inlinevirtual

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 getEdgeToEnd().

Referenced by getPlacementGeometry(), and TEST_F().

Here is the call graph for this function:

◆ getFlagDeleteOnTransverseExit()

bool ElementBase::getFlagDeleteOnTransverseExit ( ) const

inline

Definition at line 634 of file ElementBase.h.

References 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]

virtual const BGeometryBase & ElementBase::getGeometry ( ) const

pure virtual

Get geometry.

Implemented in VerticalFFAMagnet, DriftRep, MarkerRep, MonitorRep, MultipoleRep, ProbeRep, RFCavityRep, SolenoidRep, TravelingWaveRep, TBeamline< T >, Corrector, MultipoleT, Ring, ScalingFFAMagnet, VariableRFCavity, ConstantEFieldCavityRep, LaserRep, RBendRep, SBendRep, TestMonitor, TestRFCavity, DummyBeamline, TestTravelingWave, Monitor, Multipole, RBend, and SBend.

◆ getGeometry() [2/2]

virtual BGeometryBase & ElementBase::getGeometry ( )

pure virtual

Get geometry.

Implemented in VerticalFFAMagnet, DriftRep, MarkerRep, MonitorRep, MultipoleRep, ProbeRep, RFCavityRep, SolenoidRep, TravelingWaveRep, TBeamline< T >, MultipoleT, Ring, ScalingFFAMagnet, VariableRFCavity, ConstantEFieldCavityRep, LaserRep, RBendRep, SBendRep, TestMonitor, TestRFCavity, DummyBeamline, TestTravelingWave, Monitor, Multipole, RBend, SBend, and Corrector.

Referenced by Ring::appendElement(), getArcLength(), getElementLength(), getEntrance(), getEntranceFrame(), getEntrancePatch(), getExit(), getExitFrame(), getExitPatch(), getOrigin(), getTotalTransform(), getTransform(), getTransform(), and setElementLength().

◆ getMisalignment() [1/2]

CoordinateSystemTrafo ElementBase::getMisalignment ( ) const

inline

Definition at line 593 of file ElementBase.h.

References misalignment_m.

Referenced by getPlacementMisalignment().

◆ getMisalignment() [2/2]

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

◆ getName()

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

virtual

◆ getOrigin()

double ElementBase::getOrigin ( ) const

inlinevirtual

Get origin position.

Reimplemented in TBeamline< T >.

Definition at line 485 of file ElementBase.h.

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

Referenced by BeamlineGeometry::getOrigin().

Here is the call graph for this function:

◆ getOutputFN()

std::string ElementBase::getOutputFN ( ) const

Get output filename.

Definition at line 138 of file ElementBase.cpp.

References getName(), and outputfn_m.

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

Here is the call graph for this function:

◆ getParticleMatterInteraction()

ParticleMatterInteractionHandler * ElementBase::getParticleMatterInteraction ( ) const

inlinevirtual

Definition at line 517 of file ElementBase.h.

References parmatint_m.

◆ getPlacedElement()

PlacedElement ElementBase::getPlacedElement ( ) const

inline

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

Definition at line 571 of file ElementBase.h.

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

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

Here is the call graph for this function:

◆ getPlacementGeometry()

ElementGeometry ElementBase::getPlacementGeometry ( ) const

inline

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 getBodyPort(), getEntryPort(), and getExitPort().

Referenced by getPlacedElement().

Here is the call graph for this function:

◆ getPlacementMisalignment()

Misalignment ElementBase::getPlacementMisalignment ( ) const

inline

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

Definition at line 559 of file ElementBase.h.

References getMisalignment().

Referenced by getPlacedElement().

Here is the call graph for this function:

◆ getPlacementPose()

PlacementPose ElementBase::getPlacementPose ( ) const

inline

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 getCSTrafoGlobal2Local().

Referenced by getPlacedElement().

Here is the call graph for this function:

◆ getPlacementSupport()

SupportPlacement ElementBase::getPlacementSupport ( ) const

inline

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

Definition at line 567 of file ElementBase.h.

Referenced by getPlacedElement().

◆ getRequiredNumberOfTimeSteps()

int ElementBase::getRequiredNumberOfTimeSteps ( ) const

inlinevirtual

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

Definition at line 628 of file ElementBase.h.

◆ getRotationAboutZ()

double ElementBase::getRotationAboutZ ( ) const

inline

Definition at line 609 of file ElementBase.h.

References rotationZAxis_m.

Referenced by OpalBeamline::compileCompatibilityPlacement().

◆ getTotalTransform()

Euclid3D ElementBase::getTotalTransform ( ) const

inlinevirtual

Get transform.

Reimplemented in TBeamline< T >.

Definition at line 495 of file ElementBase.h.

References 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

inlinevirtual

Get transform.

Reimplemented in TBeamline< T >.

Definition at line 491 of file ElementBase.h.

References 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

inlinevirtual

Get transform.

Reimplemented in TBeamline< T >.

Definition at line 497 of file ElementBase.h.

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

Here is the call graph for this function:

◆ getType()

virtual ElementType ElementBase::getType ( ) const

pure virtual

Get element type std::string.

Implemented in Component, Corrector, TBeamline< T >, ConstantEFieldCavity, Drift, Laser, Marker, Monitor, Multipole, Probe, RBend, RFCavity, SBend, Solenoid, TravelingWave, and DummyBeamline.

Referenced by MeshGenerator::add(), MeshGenerator::getTransverseSupport(), and getTypeString().

◆ getTypeString() [1/2]

std::string ElementBase::getTypeString ( ) const

inline

Definition at line 611 of file ElementBase.h.

References getType(), and getTypeString().

Referenced by getTypeString().

Here is the call graph for this function:

◆ getTypeString() [2/2]

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

static

Definition at line 192 of file ElementBase.cpp.

References elementTypeToString_s.

◆ getWake()

WakeFunction * ElementBase::getWake ( ) const

inlinevirtual

return the attached wake object if there is any

Definition at line 509 of file ElementBase.h.

References wake_m.

◆ hasAttribute()

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

virtual

Test for existence of an attribute.

Definition at line 159 of file ElementBase.cpp.

References getConstChannel().

Here is the call graph for this function:

◆ hasBoundaryGeometry()

bool ElementBase::hasBoundaryGeometry ( ) const

inlinevirtual

Definition at line 515 of file ElementBase.h.

References bgeometry_m.

◆ hasParticleMatterInteraction()

bool ElementBase::hasParticleMatterInteraction ( ) const

inlinevirtual

Definition at line 521 of file ElementBase.h.

References parmatint_m.

◆ hasWake()

bool ElementBase::hasWake ( ) const

inlinevirtual

Definition at line 511 of file ElementBase.h.

References wake_m.

◆ isElementPositionSet()

bool ElementBase::isElementPositionSet ( ) const

inline

Definition at line 626 of file ElementBase.h.

References elemedgeSet_m.

◆ isInside()

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

inlinevirtual

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

Definition at line 586 of file ElementBase.h.

References getElementLength(), and 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

protected

Definition at line 233 of file ElementBase.cpp.

References aperture_m, CONIC_ELLIPTICAL, CONIC_RECTANGULAR, ELLIPTICAL, getEdgeToBegin(), 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(), 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

inline

Definition at line 599 of file ElementBase.h.

References positionIsFixed.

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

◆ isSharable()

bool ElementBase::isSharable ( ) const

inline

Test if the element can be shared.

Definition at line 507 of file ElementBase.h.

References shareFlag.

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

◆ makeSharable()

void ElementBase::makeSharable ( )

virtual

Set sharable flag.

Reimplemented in TBeamline< T >.

Definition at line 202 of file ElementBase.cpp.

References shareFlag.

Referenced by OpalMarker::OpalMarker().

◆ operator=()

void ElementBase::operator= ( const ElementBase & )

private

◆ releasePosition()

void ElementBase::releasePosition ( )

inline

Definition at line 595 of file ElementBase.h.

References positionIsFixed.

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

◆ removeAttribute()

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

virtual

Remove an existing attribute.

Definition at line 170 of file ElementBase.cpp.

References AttributeSet::removeAttribute(), and userAttribs.

Here is the call graph for this function:

◆ setActionRange()

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

inline

Definition at line 601 of file ElementBase.h.

References actionRange_m, and elementEdge_m.

◆ setAperture()

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

inline

Definition at line 577 of file ElementBase.h.

References 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
	)

virtual

Set value of an attribute.

Definition at line 172 of file ElementBase.cpp.

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

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

Here is the call graph for this function:

◆ setBoundaryGeometry()

void ElementBase::setBoundaryGeometry ( BoundaryGeometry * geo )

virtual

attach a boundary geometry field to the element

Definition at line 216 of file ElementBase.cpp.

References bgeometry_m.

◆ setCSTrafoGlobal2Local()

void ElementBase::setCSTrafoGlobal2Local ( const CoordinateSystemTrafo & ori )

inline

Definition at line 523 of file ElementBase.h.

References csTrafoGlobal2Local_m, and positionIsFixed.

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

◆ setCurrentSCoordinate()

void ElementBase::setCurrentSCoordinate ( double s )

Definition at line 224 of file ElementBase.cpp.

References actionRange_m, and elementEdge_m.

◆ setElementLength()

void ElementBase::setElementLength ( double length )

inlinevirtual

Set design length.

Reimplemented in MultipoleT, and ConstantEFieldCavityRep.

Definition at line 483 of file ElementBase.h.

References 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 )

inline

Access to ELEMEDGE attribute.

Definition at line 613 of file ElementBase.h.

References elemedgeSet_m, and elementPosition_m.

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

◆ setFlagDeleteOnTransverseExit()

void ElementBase::setFlagDeleteOnTransverseExit ( bool flag = true )

inline

Definition at line 630 of file ElementBase.h.

References deleteOnTransverseExit_m.

Referenced by OpalElement::update().

◆ setMisalignment()

void ElementBase::setMisalignment ( const CoordinateSystemTrafo & cst )

inline

Definition at line 591 of file ElementBase.h.

References misalignment_m.

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

◆ setName()

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

virtual

Set element name.

Definition at line 134 of file ElementBase.cpp.

References elementID.

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

◆ setOutputFN()

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

Set output filename.

Definition at line 136 of file ElementBase.cpp.

References outputfn_m.

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

◆ setParticleMatterInteraction()

void ElementBase::setParticleMatterInteraction ( ParticleMatterInteractionHandler * spys )

virtual

Definition at line 220 of file ElementBase.cpp.

References parmatint_m.

◆ setPlacementPose()

void ElementBase::setPlacementPose ( const PlacementPose & pose )

inline

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 setCSTrafoGlobal2Local().

Here is the call graph for this function:

◆ setRotationAboutZ()

void ElementBase::setRotationAboutZ ( double rotation )

inline

Set rotation about z axis in bend frame.

Definition at line 607 of file ElementBase.h.

References rotationZAxis_m.

Referenced by OpalElement::update().

◆ setWake()

void ElementBase::setWake ( WakeFunction * wf )

virtual

attach a wake field to the element

Definition at line 212 of file ElementBase.cpp.

References wake_m.

◆ update()

bool ElementBase::update ( const AttributeSet & set )

Update element.

Definition at line 204 of file ElementBase.cpp.

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

Referenced by Monitor::driftToCorrectPositionAndSave().

Here is the call graph for this function:

Member Data Documentation

◆ actionRange_m

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

private

Definition at line 469 of file ElementBase.h.

Referenced by setActionRange(), and setCurrentSCoordinate().

◆ aperture_m

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

protected

Definition at line 440 of file ElementBase.h.

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

◆ bgeometry_m

BoundaryGeometry* ElementBase::bgeometry_m

private

Definition at line 460 of file ElementBase.h.

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

◆ csTrafoGlobal2Local_m

CoordinateSystemTrafo ElementBase::csTrafoGlobal2Local_m

protected

Definition at line 437 of file ElementBase.h.

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

◆ deleteOnTransverseExit_m

bool ElementBase::deleteOnTransverseExit_m = true

private

Definition at line 473 of file ElementBase.h.

Referenced by getFlagDeleteOnTransverseExit(), and setFlagDeleteOnTransverseExit().

◆ elemedgeSet_m

bool ElementBase::elemedgeSet_m

private

Definition at line 467 of file ElementBase.h.

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

◆ elementEdge_m

double ElementBase::elementEdge_m

protected

Definition at line 442 of file ElementBase.h.

Referenced by setActionRange(), and setCurrentSCoordinate().

◆ elementID

std::string ElementBase::elementID

private

Definition at line 451 of file ElementBase.h.

Referenced by getName(), and setName().

◆ elementPosition_m

double ElementBase::elementPosition_m

private

ELEMEDGE attribute.

Definition at line 466 of file ElementBase.h.

Referenced by getElementPosition(), and setElementPosition().

◆ elementTypeToString_s

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

staticprivate

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 getTypeString().

◆ misalignment_m

CoordinateSystemTrafo ElementBase::misalignment_m

protected

Definition at line 438 of file ElementBase.h.

Referenced by getMisalignment(), and setMisalignment().

◆ outputfn_m

std::string ElementBase::outputfn_m

private

The name of the outputfile

Definition at line 471 of file ElementBase.h.

Referenced by getOutputFN(), and setOutputFN().

◆ parmatint_m

ParticleMatterInteractionHandler* ElementBase::parmatint_m

private

Definition at line 462 of file ElementBase.h.

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

◆ positionIsFixed

bool ElementBase::positionIsFixed

private

Definition at line 464 of file ElementBase.h.

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

◆ rotationZAxis_m

double ElementBase::rotationZAxis_m

protected

Definition at line 444 of file ElementBase.h.

Referenced by getRotationAboutZ(), and setRotationAboutZ().

◆ shareFlag

bool ElementBase::shareFlag

mutableprotected

Definition at line 435 of file ElementBase.h.

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

◆ userAttribs

AttributeSet ElementBase::userAttribs

private

Definition at line 456 of file ElementBase.h.

Referenced by getChannel(), and removeAttribute().

◆ wake_m

WakeFunction* ElementBase::wake_m

private

Definition at line 458 of file ElementBase.h.

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ElementBase() [1/3]

◆ ElementBase() [2/3]

◆ ElementBase() [3/3]

◆ ~ElementBase()

Member Function Documentation

◆ accept()

◆ clone()

◆ copyStructure()

◆ fixPosition()

◆ getAperture()

◆ getArcLength()

◆ getAttribute()

◆ getBodyPort()

◆ getBoundaryGeometry()

◆ getBoundingBoxInLabCoords()

◆ getChannel()

◆ getConstChannel()

◆ getCSTrafoGlobal2Local()

◆ getEdgeToBegin()

◆ getEdgeToEnd()

◆ getElementDimensions()

◆ getElementLength()

◆ getElementPosition()

◆ getEntrance()

◆ getEntranceFrame()

◆ getEntrancePatch()

◆ getEntryPort()

◆ getExit()

◆ getExitFrame()

◆ getExitPatch()

◆ getExitPort()

◆ getFlagDeleteOnTransverseExit()

◆ getGeometry() [1/2]

◆ getGeometry() [2/2]

◆ getMisalignment() [1/2]

◆ getMisalignment() [2/2]

◆ getName()

◆ getOrigin()

◆ getOutputFN()

◆ getParticleMatterInteraction()

◆ getPlacedElement()

◆ getPlacementGeometry()

◆ getPlacementMisalignment()

◆ getPlacementPose()

◆ getPlacementSupport()

◆ getRequiredNumberOfTimeSteps()

◆ getRotationAboutZ()

◆ getTotalTransform()

◆ getTransform() [1/2]

◆ getTransform() [2/2]

◆ getType()

◆ getTypeString() [1/2]

◆ getTypeString() [2/2]

◆ getWake()

◆ hasAttribute()

◆ hasBoundaryGeometry()

◆ hasParticleMatterInteraction()

◆ hasWake()

◆ isElementPositionSet()

◆ isInside()

◆ isInsideTransverse()

◆ isPositioned()

◆ isSharable()

◆ makeSharable()

◆ operator=()

◆ releasePosition()

◆ removeAttribute()

◆ setActionRange()

◆ setAperture()

◆ setAttribute()

◆ setBoundaryGeometry()