#include <TBeamline.h>

Inheritance diagram for TBeamline< T >:

Collaboration diagram for TBeamline< T >:

Public Member Functions
	TBeamline ()
	Default constructor.

	TBeamline (const std::string &name)
	Constructor with given name.

	TBeamline (const TBeamline< T > &right)

virtual	~TBeamline ()

virtual void	accept (BeamlineVisitor &) const
	Apply BeamlineVisitor to this line.

virtual void	iterate (BeamlineVisitor &, bool r2l) const
	Apply visitor to all elements of the line.

virtual TBeamline< T > *	clone () const
	Make clone.

virtual TBeamline< T > *	copyStructure ()
	Make structure copy.

virtual void	makeSharable ()
	Set sharable flag.

virtual BeamlineGeometry &	getGeometry ()
	Get geometry.

virtual const BeamlineGeometry &	getGeometry () const
	Get geometry.

virtual double	getArcLength () const
	Get arc length.

virtual double	getElementLength () const
	Get design length.

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 ElementType	getType () const
	Get beamline type.

virtual void	append (const T &)
	Append a T object.

virtual void	prepend (const T &)
	Prepend a T object.

void	setOrigin3D (const Vector_t< double, 3 > &ori)

Vector_t< double, 3 >	getOrigin3D () const

void	setInitialDirection (const Quaternion &rot)

Quaternion	getInitialDirection () const

void	setRelativeFlag (bool flag)

bool	getRelativeFlag () const

size_t	size () const
	Get the number of elements in the TBeamline.

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

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

std::string	getTypeString () const

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 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.

bool	isSharable () const
	Test if the element can be shared.

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)

Public Attributes
T	elements
	STL member.

Protected Member Functions
bool	isInsideTransverse (const Vector_t< double, 3 > &r) const

Protected Attributes
BeamlineGeometry	itsGeometry
	The beamline geometry.

Vector_t< double, 3 >	itsOrigin_m

Quaternion	itsCoordTrafoTo_m

bool	relativePositions_m

bool	shareFlag

CoordinateSystemTrafo	csTrafoGlobal2Local_m

CoordinateSystemTrafo	misalignment_m

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

double	elementEdge_m

double	rotationZAxis_m

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

template<class T>
class TBeamline< T >

Definition at line 33 of file TBeamline.h.

Constructor & Destructor Documentation

◆ TBeamline() [1/3]

template<class T >

TBeamline< T >::TBeamline ( )

Default constructor.

Definition at line 158 of file TBeamline.h.

◆ TBeamline() [2/3]

template<class T >

TBeamline< T >::TBeamline ( const std::string & name )

explicit

Constructor with given name.

Definition at line 167 of file TBeamline.h.

◆ TBeamline() [3/3]

template<class T >

TBeamline< T >::TBeamline ( const TBeamline< T > & right )

Definition at line 176 of file TBeamline.h.

◆ ~TBeamline()

template<class T >

TBeamline< T >::~TBeamline ( )

virtual

Definition at line 185 of file TBeamline.h.

Member Function Documentation

◆ accept()

template<class T >

void TBeamline< T >::accept ( BeamlineVisitor & visitor ) const

virtual

Apply BeamlineVisitor to this line.

Implements ElementBase.

Definition at line 188 of file TBeamline.h.

References BeamlineVisitor::visitBeamline().

Here is the call graph for this function:

◆ append()

template<class T >

void TBeamline< T >::append ( const T & obj )

inlinevirtual

Append a T object.

Definition at line 384 of file TBeamline.h.

Referenced by TBeamline< T >::clone(), and TBeamline< T >::copyStructure().

◆ clone()

template<class T >

TBeamline< T > * TBeamline< T >::clone ( ) const

virtual

Make clone.

Implements ElementBase.

Definition at line 207 of file TBeamline.h.

References TBeamline< T >::append(), TBeamline< T >::itsCoordTrafoTo_m, TBeamline< T >::itsOrigin_m, and TBeamline< T >::relativePositions_m.

Here is the call graph for this function:

◆ copyStructure()

template<class T >

TBeamline< T > * TBeamline< T >::copyStructure ( )

virtual

Make structure copy.

Reimplemented from ElementBase.

Definition at line 226 of file TBeamline.h.

References TBeamline< T >::append(), TBeamline< T >::itsCoordTrafoTo_m, TBeamline< T >::itsOrigin_m, and TBeamline< T >::relativePositions_m.

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

template<class T >

double TBeamline< T >::getArcLength ( ) const

virtual

Get arc length.

Reimplemented from ElementBase.

Definition at line 269 of file TBeamline.h.

References BeamlineGeometry::getArcLength().

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 * ElementBase::getChannel	(	const std::string &	aKey,
		bool	create = `false`
	)

virtualinherited

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 ElementBase::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(), ElementBase::getConstChannel(), and ElementBase::setAttribute().

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

◆ 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()

template<class T >

double TBeamline< T >::getElementLength ( ) const

virtual

Get design length.

Reimplemented from ElementBase.

Definition at line 280 of file TBeamline.h.

◆ 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()

template<class T >

double TBeamline< T >::getEntrance ( ) const

virtual

Get entrance position.

Reimplemented from ElementBase.

Definition at line 296 of file TBeamline.h.

◆ getEntranceFrame()

template<class T >

Euclid3D TBeamline< T >::getEntranceFrame ( ) const

virtual

Get transform.

Reimplemented from ElementBase.

Definition at line 369 of file TBeamline.h.

◆ 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()

template<class T >

double TBeamline< T >::getExit ( ) const

virtual

Get exit position.

Reimplemented from ElementBase.

Definition at line 301 of file TBeamline.h.

◆ getExitFrame()

template<class T >

Euclid3D TBeamline< T >::getExitFrame ( ) const

virtual

Get transform.

Reimplemented from ElementBase.

Definition at line 374 of file TBeamline.h.

◆ 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:

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

template<class T >

BeamlineGeometry & TBeamline< T >::getGeometry ( )

inlinevirtual

Get geometry.

Implements ElementBase.

Definition at line 259 of file TBeamline.h.

◆ getGeometry() [2/2]

template<class T >

const BeamlineGeometry & TBeamline< T >::getGeometry ( ) const

inlinevirtual

Get geometry.

Implements ElementBase.

Definition at line 264 of file TBeamline.h.

◆ getInitialDirection()

template<class T >

Quaternion TBeamline< T >::getInitialDirection ( ) const

inlinevirtual

Reimplemented from Beamline.

Definition at line 409 of file TBeamline.h.

◆ 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

◆ getOrigin()

template<class T >

double TBeamline< T >::getOrigin ( ) const

virtual

Get origin position.

Reimplemented from ElementBase.

Definition at line 291 of file TBeamline.h.

◆ getOrigin3D()

template<class T >

Vector_t< double, 3 > TBeamline< T >::getOrigin3D ( ) const

inlinevirtual

Reimplemented from Beamline.

Definition at line 399 of file TBeamline.h.

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

◆ getRelativeFlag()

template<class T >

bool TBeamline< T >::getRelativeFlag ( ) const

inlinevirtual

Reimplemented from Beamline.

Definition at line 419 of file TBeamline.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().

◆ getTotalTransform()

template<class T >

Euclid3D TBeamline< T >::getTotalTransform ( ) const

virtual

Get transform.

Reimplemented from ElementBase.

Definition at line 353 of file TBeamline.h.

References Euclid3D::dotBy().

Here is the call graph for this function:

◆ getTransform() [1/2]

template<class T >

Euclid3D TBeamline< T >::getTransform	(	double	fromS,
		double	toS
	)		const

virtual

Get transform.

Reimplemented from ElementBase.

Definition at line 306 of file TBeamline.h.

References ElementBase::getArcLength(), and ElementBase::getTransform().

Here is the call graph for this function:

◆ getTransform() [2/2]

template<class T >

Euclid3D TBeamline< T >::getTransform ( double s ) const

virtual

Get transform.

Reimplemented from ElementBase.

Definition at line 364 of file TBeamline.h.

◆ getType()

template<class T >

ElementType TBeamline< T >::getType ( ) const

inlinevirtual

Get beamline type.

Implements ElementBase.

Definition at line 379 of file TBeamline.h.

References BEAMLINE.

◆ 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.

◆ 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.

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

◆ iterate()

template<class T >

void TBeamline< T >::iterate	(	BeamlineVisitor &	visitor,
		bool	r2l
	)		const

virtual

Apply visitor to all elements of the line.

Implements Beamline.

Definition at line 193 of file TBeamline.h.

Referenced by ParallelTracker::visitBeamline().

◆ makeSharable()

template<class T >

void TBeamline< T >::makeSharable ( )

inlinevirtual

Set sharable flag.

Reimplemented from ElementBase.

Definition at line 250 of file TBeamline.h.

References TBeamline< T >::makeSharable().

Referenced by TBeamline< T >::makeSharable().

Here is the call graph for this function:

◆ prepend()

template<class T >

void TBeamline< T >::prepend ( const T & obj )

inlinevirtual

Prepend a T object.

Definition at line 389 of file TBeamline.h.

◆ 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:

◆ 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.

◆ 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.

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

◆ setFlagDeleteOnTransverseExit()

void ElementBase::setFlagDeleteOnTransverseExit ( bool flag = true )

inlineinherited

Definition at line 630 of file ElementBase.h.

References ElementBase::deleteOnTransverseExit_m.

Referenced by OpalElement::update().

◆ setInitialDirection()

template<class T >

void TBeamline< T >::setInitialDirection ( const Quaternion & rot )

inline

Definition at line 404 of file TBeamline.h.

Referenced by Line::parse().

◆ 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=().

◆ setOrigin3D()

template<class T >

void TBeamline< T >::setOrigin3D ( const Vector_t< double, 3 > & ori )

inline

Definition at line 394 of file TBeamline.h.

Referenced by Line::parse().

◆ 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:

◆ setRelativeFlag()

template<class T >

void TBeamline< T >::setRelativeFlag ( bool flag )

inline

Definition at line 414 of file TBeamline.h.

Referenced by Line::parse().

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

◆ 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.

◆ size()

template<class T >

size_t TBeamline< T >::size ( ) const

Get the number of elements in the TBeamline.

Definition at line 424 of file TBeamline.h.

◆ 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

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

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

◆ bgeometry_m

BoundaryGeometry* ElementBase::bgeometry_m

privateinherited

Definition at line 460 of file ElementBase.h.

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

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

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

◆ elements

T std::list< T >::elements

inherited

STL member.

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

◆ itsCoordTrafoTo_m

template<class T >

Quaternion TBeamline< T >::itsCoordTrafoTo_m

protected

Definition at line 150 of file TBeamline.h.

Referenced by TBeamline< T >::clone(), and TBeamline< T >::copyStructure().

◆ itsGeometry

template<class T >

BeamlineGeometry TBeamline< T >::itsGeometry

protected

The beamline geometry.

Definition at line 147 of file TBeamline.h.

◆ itsOrigin_m

template<class T >

Vector_t<double, 3> TBeamline< T >::itsOrigin_m

protected

Definition at line 149 of file TBeamline.h.

Referenced by TBeamline< T >::clone(), and TBeamline< T >::copyStructure().

◆ misalignment_m

CoordinateSystemTrafo ElementBase::misalignment_m

protectedinherited

Definition at line 438 of file ElementBase.h.

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

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

◆ positionIsFixed

bool ElementBase::positionIsFixed

privateinherited

Definition at line 464 of file ElementBase.h.

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

◆ relativePositions_m

template<class T >

bool TBeamline< T >::relativePositions_m

protected

Definition at line 151 of file TBeamline.h.

Referenced by TBeamline< T >::clone(), and TBeamline< T >::copyStructure().

◆ rotationZAxis_m

double ElementBase::rotationZAxis_m

protectedinherited

Definition at line 444 of file ElementBase.h.

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

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

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

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

TBeamline.h

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TBeamline() [1/3]

◆ TBeamline() [2/3]

◆ TBeamline() [3/3]

◆ ~TBeamline()

Member Function Documentation

◆ accept()

◆ append()

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

◆ getInitialDirection()

◆ getMisalignment() [1/2]

◆ getMisalignment() [2/2]

◆ getName()

◆ getOrigin()

◆ getOrigin3D()

◆ getOutputFN()

◆ getParticleMatterInteraction()

◆ getPlacedElement()

◆ getPlacementGeometry()

◆ getPlacementMisalignment()

◆ getPlacementPose()

◆ getPlacementSupport()

◆ getRelativeFlag()

◆ 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()

◆ iterate()

◆ makeSharable()

◆ prepend()

◆ releasePosition()