Inheritance diagram for TestMultipoleTStraight:

Collaboration diagram for TestMultipoleTStraight:

Classes
class	TestableFieldSolverCmd

Public Member Functions
	TestMultipoleTStraight ()

void	grabTransverseDataLine (std::vector< double > &line, const double s, const double width, const Vector_t< double, 3 > &elementEntry, const double elementLength)

void	grabVerticalDataLine (std::vector< double > &line, const double s, const double height, const Vector_t< double, 3 > &elementEntry, const double elementLength)

void	grabLongitudinalDivCurlLine (std::vector< double > &fieldLine, std::vector< double > &divLine, std::vector< Vector_t< double, 3 > > &curlLine, const double x, const double length, const Vector_t< double, 3 > &elementEntry, const double elementLength, const double dr)

std::shared_ptr< PartBunch_t >	makeBunch (const size_t numParticles)

ElementBase *	clone () const override

void	accept (BeamlineVisitor &visitor) const override

BGeometryBase &	getGeometry () override

const BGeometryBase &	getGeometry () const override

EMField &	getField () override

const EMField &	getField () const override

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

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

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

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

void	finalise () override

bool	bends () const override

size_t	getMaxFOrder () const

size_t	getMaxXOrder () const

void	setMaxOrder (size_t orderZ, size_t orderX)

std::size_t	getTransMaxOrder () const

void	setTransProfile (const std::vector< double > &profile)

const Kokkos::Array< double, MultipoleTConfig::NumPoles > &	getTransProfile () const

void	setFringeField (const double &s0, const double &lambda_left, const double &lambda_right)

std::tuple< double, double, double >	getFringeField () const

void	setEntranceAngle (double entranceAngle)

void	setEntryOffset (double offset)

double	getEntryOffset () const

bool	getVariableRadius () const

void	setBendAngle (double angle, bool variableRadius)

double	getBendAngle () const

double	getEntranceAngle () const

void	setElementLength (double length) override

double	getLength () const

void	setAperture (const double &vertAp, const double &horizAp)

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

std::tuple< double, double >	getAperture ()

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

void	setRotation (double rot)

double	getRotation () const

double	getBoundingBoxLength () const

void	setBoundingBoxLength (double boundingBoxLength)

void	getFieldExtend (double &zBegin, double &zEnd) const override

void	setScalingName (const std::string &name)

std::string	getScalingName () const

void	initialiseTimeDependencies () const

MultipoleTConfig &	getConfig ()

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	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)
	Apply to reference particle with position R and momemtum P.

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

virtual bool	Online ()

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

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

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

static void	TearDownTestSuite ()

static Vector_t< double, 3 >	curvilinearToGlobal (const Vector_t< double, 3 > &local, const Vector_t< double, 3 > &elementEntry, const double elementLength)

static std::string	getTypeString (ElementType type)

Public Attributes
std::shared_ptr< FieldSolverCmd >	fsCmdBase_m

std::shared_ptr< DataSink >	dataSink_m

Protected Member Functions
void	chooseImplementation ()

double	getScaling (double t) const

void	validateConfiguration () const

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

Protected Attributes
MultipoleTConfig	config_m

BMultipoleField	dummy

std::string	scalingName_m

std::shared_ptr< AbstractTimeDependence >	scalingTD_m

std::unique_ptr< MultipoleTBase >	implementation_ {}

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

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

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 25 of file TestMultipoleTStraight.cpp.

Constructor & Destructor Documentation

◆ TestMultipoleTStraight()

TestMultipoleTStraight::TestMultipoleTStraight ( )

inline

Definition at line 27 of file TestMultipoleTStraight.cpp.

Member Function Documentation

◆ accept()

void MultipoleT::accept ( BeamlineVisitor & visitor ) const

overridevirtualinherited

Accept a beamline visitor

Implements ElementBase.

Definition at line 36 of file MultipoleT.cpp.

References MultipoleT::initialiseTimeDependencies(), and BeamlineVisitor::visitMultipoleT().

Here is the call graph for this function:

◆ apply() [1/3]

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

overridevirtualinherited

Calculate the field at the position of the ith particle

Parameters

i	-> Index of the particle event; field is calculated at this position This overload is single-container only. In multi-container tracking, use apply(const std::shared_ptr<ParticleContainer_t>& pc). If particle is outside field map true is returned, otherwise false is returned
t	-> Time at which the field is to be calculated
E	-> Calculated electric field - always 0 (no E-field)
B	-> Calculated magnetic field

Reimplemented from Component.

Definition at line 64 of file MultipoleT.cpp.

References MultipoleT::getScaling(), MultipoleT::implementation_, Component::RefPartBunch_m, and MultipoleT::validateConfiguration().

Here is the call graph for this function:

◆ apply() [2/3]

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

overridevirtualinherited

Calculate the field for all particles

Reimplemented from Component.

Definition at line 49 of file MultipoleT.cpp.

References MultipoleT::getScaling(), PartBunch< T, Dim >::getT(), MultipoleT::implementation_, Component::RefPartBunch_m, and MultipoleT::validateConfiguration().

Referenced by TestMultipoleT::fieldAtT(), TestMultipoleTCurvedConstRadius::grabLongitudinalDivCurlLine(), grabLongitudinalDivCurlLine(), grabTransverseDataLine(), TestMultipoleTCurvedConstRadius::grabTransverseDataLine(), grabVerticalDataLine(), and TestMultipoleTCurvedConstRadius::grabVerticalDataLine().

Here is the call graph for this function:

◆ apply() [3/3]

bool MultipoleT::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

Calculate the field at some arbitrary position
If particle is outside field map true is returned, otherwise false is returned

Parameters

R	-> Position in the lab coordinate system of the multipole
P	-> Not used
t	-> Time at which the field is to be calculated
E	-> Calculated electric field - always 0 (no E-field)
B	-> Calculated magnetic field

Reimplemented from Component.

Definition at line 57 of file MultipoleT.cpp.

References MultipoleT::getScaling(), MultipoleT::implementation_, and MultipoleT::validateConfiguration().

Here is the call graph for this function:

◆ applyToReferenceParticle()

bool Component::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
	)

virtualinherited

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 in BendBase, ConstantEFieldCavity, Monitor, Multipole, PluginElement, RFCavity, Solenoid, TravelingWave, and VariableRFCavity.

Definition at line 114 of file Component.cpp.

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

Here is the call graph for this function:

◆ bends()

bool MultipoleT::bends ( ) const

overridevirtualinherited

Return true if dipole component not zero

Implements Component.

Definition at line 165 of file MultipoleT.cpp.

References MultipoleTConfig::bendAngle_m, and MultipoleT::config_m.

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

◆ chooseImplementation()

void MultipoleT::chooseImplementation ( )

protectedinherited

Definition at line 117 of file MultipoleT.cpp.

References MultipoleTConfig::bendAngle_m, MultipoleT::config_m, and MultipoleT::implementation_.

Referenced by MultipoleT::MultipoleT(), MultipoleT::MultipoleT(), and MultipoleT::setBendAngle().

◆ clone()

ElementBase * MultipoleT::clone ( ) const

overridevirtualinherited

Inheritable copy constructor

Implements ElementBase.

Definition at line 34 of file MultipoleT.cpp.

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

◆ curvilinearToGlobal()

static Vector_t< double, 3 > TestMultipoleTStraight::curvilinearToGlobal	(	const Vector_t< double, 3 > &	local,
		const Vector_t< double, 3 > &	elementEntry,
		const double	elementLength
	)

inlinestatic

Definition at line 49 of file TestMultipoleTStraight.cpp.

Referenced by grabLongitudinalDivCurlLine(), grabTransverseDataLine(), and grabVerticalDataLine().

◆ 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 MultipoleT::finalise ( )

overridevirtualinherited

Finalise the MultipoleT - sets bunch to nullptr

Implements Component.

Definition at line 100 of file MultipoleT.cpp.

References Component::RefPartBunch_m.

◆ 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() [1/2]

std::tuple< double, double > MultipoleT::getAperture ( )

inlineinherited

Get the aperture dimensions

Returns: {verticalApert, horizontalApert}

Definition at line 197 of file MultipoleT.h.

References MultipoleT::config_m, MultipoleTConfig::horizontalAperture_m, and MultipoleTConfig::verticalAperture_m.

◆ getAperture() [2/2]

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:

◆ getBendAngle()

double MultipoleT::getBendAngle ( ) const

inlineinherited

Get the bending angle of the magnet

Definition at line 178 of file MultipoleT.h.

References MultipoleTConfig::bendAngle_m, and MultipoleT::config_m.

Referenced by MultipoleTCurvedConstRadius::initialise().

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

◆ getBoundingBoxLength()

double MultipoleT::getBoundingBoxLength ( ) const

inlineinherited

Get the bounding box size

Definition at line 209 of file MultipoleT.h.

References MultipoleTConfig::boundingBoxLength_m, and MultipoleT::config_m.

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

◆ getConfig()

MultipoleTConfig & MultipoleT::getConfig ( )

inlineinherited

Definition at line 229 of file MultipoleT.h.

References MultipoleT::config_m.

Referenced by MultipoleTCurvedConstRadius::getField(), and MultipoleTStraight::getField().

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

◆ getEntranceAngle()

double MultipoleT::getEntranceAngle ( ) const

inlineinherited

Get the entrance angle

Definition at line 180 of file MultipoleT.h.

References MultipoleT::config_m, and MultipoleTConfig::entranceAngle_m.

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

◆ getEntryOffset()

double MultipoleT::getEntryOffset ( ) const

inlineinherited

Get the offset of the entry point from the standard position

Definition at line 172 of file MultipoleT.h.

References MultipoleT::config_m, and MultipoleTConfig::entryOffset_m.

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

const EMField & MultipoleT::getField ( ) const

inlineoverridevirtualinherited

Return a dummy field value

Implements Component.

Definition at line 93 of file MultipoleT.h.

References MultipoleT::dummy.

◆ getField() [2/2]

EMField & MultipoleT::getField ( )

inlineoverridevirtualinherited

Return a dummy field value

Implements Component.

Definition at line 91 of file MultipoleT.h.

References MultipoleT::dummy.

Referenced by TEST_F().

◆ getFieldExtend()

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

inlineoverridevirtualinherited

Return the longitudinal field-support extent.

For the current MultipoleT implementation the field support is defined on the full local body interval latexmath:[z \in [0, L)].

Implements Component.

Definition at line 220 of file MultipoleT.h.

References ElementBase::getElementLength().

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

◆ getFringeField()

std::tuple< double, double, double > MultipoleT::getFringeField ( ) const

inherited

Get the fringe field model

Returns: {s0, leftFringe, rightFringe}

Definition at line 96 of file MultipoleT.cpp.

References MultipoleT::config_m, MultipoleTConfig::fringeLambdaLeft_m, MultipoleTConfig::fringeLambdaRight_m, and MultipoleTConfig::fringeS0_m.

◆ getGeometry() [1/2]

const BGeometryBase & MultipoleT::getGeometry ( ) const

overridevirtualinherited

Return the cell geometry

Implements ElementBase.

Definition at line 189 of file MultipoleT.cpp.

References MultipoleT::implementation_.

◆ getGeometry() [2/2]

BGeometryBase & MultipoleT::getGeometry ( )

overridevirtualinherited

Return the cell geometry

Implements ElementBase.

Definition at line 187 of file MultipoleT.cpp.

References MultipoleT::implementation_.

Referenced by TEST_F(), and TEST_F().

◆ getLength()

double MultipoleT::getLength ( ) const

inlineinherited

Get the length of the magnet

Definition at line 187 of file MultipoleT.h.

References MultipoleT::config_m, and MultipoleTConfig::length_m.

Referenced by MultipoleTCurvedConstRadius::initialise(), and MultipoleTStraight::initialise().

◆ getMaxFOrder()

size_t MultipoleT::getMaxFOrder ( ) const

inlineinherited

Get the number of terms used in calculation of field components

Definition at line 132 of file MultipoleT.h.

References MultipoleT::config_m, and MultipoleTConfig::maxFOrder_m.

Referenced by MultipoleTCurvedConstRadius::initialise(), and MultipoleTStraight::initialise().

◆ getMaxXOrder()

size_t MultipoleT::getMaxXOrder ( ) const

inlineinherited

Definition at line 133 of file MultipoleT.h.

References MultipoleT::config_m, and MultipoleTConfig::maxXOrder_m.

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

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.

◆ getRotation()

double MultipoleT::getRotation ( ) const

inlineinherited

Get the angle of rotation of the magnet around its axis

Definition at line 207 of file MultipoleT.h.

References MultipoleT::config_m, and MultipoleTConfig::rotation_m.

◆ getRotationAboutZ()

double ElementBase::getRotationAboutZ ( ) const

inlineinherited

Definition at line 609 of file ElementBase.h.

References ElementBase::rotationZAxis_m.

Referenced by OpalBeamline::compileCompatibilityPlacement().

◆ getScaling()

double MultipoleT::getScaling ( double t ) const

protectedinherited

Definition at line 41 of file MultipoleT.cpp.

References MultipoleT::scalingTD_m.

Referenced by MultipoleT::apply(), MultipoleT::apply(), and MultipoleT::apply().

◆ getScalingName()

std::string MultipoleT::getScalingName ( ) const

inlineinherited

Definition at line 226 of file MultipoleT.h.

References MultipoleT::scalingName_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:

◆ getTransMaxOrder()

std::size_t MultipoleT::getTransMaxOrder ( ) const

inlineinherited

Get the maximum order in the given transverse profile

Definition at line 140 of file MultipoleT.h.

References MultipoleT::config_m, and MultipoleTConfig::transverseProfileMaxOrder_m.

◆ getTransProfile()

const Kokkos::Array< double, MultipoleTConfig::NumPoles > & MultipoleT::getTransProfile ( ) const

inlineinherited

Get all terms of transverse profile

Definition at line 146 of file MultipoleT.h.

References MultipoleT::config_m, and MultipoleTConfig::transverseProfile_m.

◆ getType()

ElementType Component::getType ( ) const

virtualinherited

Get element type std::string.

Implements ElementBase.

Reimplemented in Corrector, ConstantEFieldCavity, Drift, Laser, Marker, Monitor, Multipole, Probe, RBend, RFCavity, SBend, Solenoid, and TravelingWave.

Definition at line 49 of file Component.cpp.

References ANY.

Referenced by ParallelTracker::visitComponent().

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

◆ getVariableRadius()

bool MultipoleT::getVariableRadius ( ) const

inlineinherited

Get the variable radius of the magnet

Definition at line 174 of file MultipoleT.h.

References MultipoleT::config_m, and MultipoleTConfig::variableRadius_m.

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

◆ goOffline()

void Component::goOffline ( )

virtualinherited

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

Definition at line 45 of file Component.cpp.

References Component::online_m.

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

◆ grabLongitudinalDivCurlLine()

void TestMultipoleTStraight::grabLongitudinalDivCurlLine	(	std::vector< double > &	fieldLine,
		std::vector< double > &	divLine,
		std::vector< Vector_t< double, 3 > > &	curlLine,
		const double	x,
		const double	length,
		const Vector_t< double, 3 > &	elementEntry,
		const double	elementLength,
		const double	dr
	)

inline

Definition at line 134 of file TestMultipoleTStraight.cpp.

References MultipoleT::apply(), and curvilinearToGlobal().

Here is the call graph for this function:

◆ grabTransverseDataLine()

void TestMultipoleTStraight::grabTransverseDataLine	(	std::vector< double > &	line,
		const double	s,
		const double	width,
		const Vector_t< double, 3 > &	elementEntry,
		const double	elementLength
	)

inline

Definition at line 58 of file TestMultipoleTStraight.cpp.

References MultipoleT::apply(), curvilinearToGlobal(), MultipoleT::initialise(), and makeBunch().

Here is the call graph for this function:

◆ grabVerticalDataLine()

void TestMultipoleTStraight::grabVerticalDataLine	(	std::vector< double > &	line,
		const double	s,
		const double	height,
		const Vector_t< double, 3 > &	elementEntry,
		const double	elementLength
	)

inline

Definition at line 96 of file TestMultipoleTStraight.cpp.

References MultipoleT::apply(), curvilinearToGlobal(), MultipoleT::initialise(), and makeBunch().

Here is the call graph for this function:

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

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

overridevirtualinherited

Initialise the MultipoleT

Parameters

bunch	-> Bunch the global bunch object
startField	-> Not used
endField	-> Not used

Implements Component.

Definition at line 167 of file MultipoleT.cpp.

References MultipoleT::implementation_, and Component::RefPartBunch_m.

Referenced by grabTransverseDataLine(), TestMultipoleTCurvedConstRadius::grabTransverseDataLine(), grabVerticalDataLine(), and TestMultipoleTCurvedConstRadius::grabVerticalDataLine().

◆ initialiseTimeDependencies()

void MultipoleT::initialiseTimeDependencies ( ) const

inherited

Definition at line 180 of file MultipoleT.cpp.

References AbstractTimeDependence::getTimeDependence(), MultipoleT::scalingName_m, and MultipoleT::scalingTD_m.

Referenced by MultipoleT::accept().

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

◆ makeBunch()

std::shared_ptr< PartBunch_t > TestMultipoleTStraight::makeBunch ( const size_t numParticles )

inline

Definition at line 191 of file TestMultipoleTStraight.cpp.

References dataSink_m, Beam::find(), and fsCmdBase_m.

Referenced by grabTransverseDataLine(), and grabVerticalDataLine().

Here is the call graph for this function:

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

◆ 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() [1/2]

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

◆ setAperture() [2/2]

void MultipoleT::setAperture	(	const double &	vertAp,
		const double &	horizAp
	)

inherited

Set the aperture dimensions
This element only supports a rectangular aperture

Parameters

vertAp	-> Vertical aperture length
horizAp	-> Horisontal aperture length

Definition at line 129 of file MultipoleT.cpp.

References MultipoleT::config_m, MultipoleTConfig::horizontalAperture_m, and MultipoleTConfig::verticalAperture_m.

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

◆ setBendAngle()

void MultipoleT::setBendAngle	(	double	angle,
		bool	variableRadius
	)

inherited

Set the bending angle of the magnet

Definition at line 110 of file MultipoleT.cpp.

References MultipoleTConfig::bendAngle_m, MultipoleT::chooseImplementation(), MultipoleT::config_m, and MultipoleTConfig::variableRadius_m.

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.

◆ setBoundingBoxLength()

void MultipoleT::setBoundingBoxLength ( double boundingBoxLength )

inherited

Set the bounding box size. This controls the region for

Parameters

boundingBoxLength -> Distance between centre and entrance

Definition at line 134 of file MultipoleT.cpp.

References MultipoleTConfig::boundingBoxLength_m, and MultipoleT::config_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.

◆ setElementLength()

void MultipoleT::setElementLength ( double length )

overridevirtualinherited

Set the length of the magnet If straight-> Actual length If curved -> Arc length

Reimplemented from ElementBase.

Definition at line 102 of file MultipoleT.cpp.

References MultipoleT::config_m, MultipoleT::implementation_, MultipoleTConfig::length_m, and ElementBase::setElementLength().

Referenced by OpalMultipoleT::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().

◆ setEntranceAngle()

void MultipoleT::setEntranceAngle ( double entranceAngle )

inherited

Set the entrance angle

Parameters

entranceAngle -> Entrance angle

Definition at line 159 of file MultipoleT.cpp.

References MultipoleT::config_m, and MultipoleTConfig::entranceAngle_m.

◆ setEntryOffset()

void MultipoleT::setEntryOffset ( double offset )

inherited

Set the offset of the entry point from the standard position

Parameters

offset positive for further away from the center

Definition at line 163 of file MultipoleT.cpp.

References MultipoleT::config_m, and MultipoleTConfig::entryOffset_m.

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

◆ setFringeField()

void MultipoleT::setFringeField	(	const double &	s0,
		const double &	lambda_left,
		const double &	lambda_right
	)

inherited

Set fringe field model
Tanh model used here

\[ 1/2 * \left [tanh \left( \frac{s + s_0}{\lambda_{left}} \right) - tanh \left( \frac{s - s_0}{\lambda_{right}} \right) \right] \]

Parameters

s0	-> Centre field length and
lambda_left	-> Left end field length
lambda_right	-> Right end field length

Definition at line 88 of file MultipoleT.cpp.

References MultipoleT::config_m, MultipoleTConfig::fringeLambdaLeft_m, MultipoleTConfig::fringeLambdaRight_m, MultipoleTConfig::fringeS0_m, and MultipoleT::implementation_.

◆ setMaxOrder()

void MultipoleT::setMaxOrder	(	size_t	orderZ,
		size_t	orderX
	)

inherited

Set the number of terms used in calculation of field components

Parameters

orderZ	-> Number of terms in expansion in z
orderX	-> Number of terms in expansion in x

Definition at line 151 of file MultipoleT.cpp.

References MultipoleT::config_m, MultipoleT::implementation_, MultipoleTConfig::maxFOrder_m, and MultipoleTConfig::maxXOrder_m.

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

◆ setRotation()

void MultipoleT::setRotation ( double rot )

inherited

Set the angle of rotation of the magnet around its axis
To make skew components

Parameters

rot	-> Angle of rotation

Definition at line 157 of file MultipoleT.cpp.

References MultipoleT::config_m, and MultipoleTConfig::rotation_m.

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

◆ setScalingName()

void MultipoleT::setScalingName ( const std::string & name )

inherited

Definition at line 172 of file MultipoleT.cpp.

References MultipoleT::scalingName_m.

◆ setTransProfile()

void MultipoleT::setTransProfile ( const std::vector< double > & profile )

inherited

Set the the transverse profile

Parameters

profile -> Multipole field profile

Definition at line 138 of file MultipoleT.cpp.

References MultipoleT::config_m, MultipoleTConfig::NumPoles, MultipoleTConfig::transverseProfile_m, and MultipoleTConfig::transverseProfileMaxOrder_m.

◆ SetUpTestSuite()

static void TestMultipoleTStraight::SetUpTestSuite ( )

inlinestatic

Definition at line 29 of file TestMultipoleTStraight.cpp.

References Options::enableHDF5, OpalData::getInstance(), gmsg, and OpalData::storeInputFn().

Here is the call graph for this function:

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

◆ TearDownTestSuite()

static void TestMultipoleTStraight::TearDownTestSuite ( )

inlinestatic

Definition at line 42 of file TestMultipoleTStraight.cpp.

References gmsg.

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

◆ validateConfiguration()

void MultipoleT::validateConfiguration ( ) const

protectedinherited

Definition at line 191 of file MultipoleT.cpp.

References MultipoleT::config_m, MultipoleTBase::MaxDerivatives, and MultipoleTConfig::maxFOrder_m.

Referenced by MultipoleT::apply(), MultipoleT::apply(), and MultipoleT::apply().

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

◆ config_m

MultipoleTConfig MultipoleT::config_m

protectedinherited

The magnet configuration

Definition at line 233 of file MultipoleT.h.

Referenced by MultipoleT::bends(), MultipoleT::chooseImplementation(), MultipoleT::getAperture(), MultipoleT::getBendAngle(), MultipoleT::getBoundingBoxLength(), MultipoleT::getConfig(), MultipoleT::getEntranceAngle(), MultipoleT::getEntryOffset(), MultipoleT::getFringeField(), MultipoleT::getLength(), MultipoleT::getMaxFOrder(), MultipoleT::getMaxXOrder(), MultipoleT::getRotation(), MultipoleT::getTransMaxOrder(), MultipoleT::getTransProfile(), MultipoleT::getVariableRadius(), MultipoleT::setAperture(), MultipoleT::setBendAngle(), MultipoleT::setBoundingBoxLength(), MultipoleT::setElementLength(), MultipoleT::setEntranceAngle(), MultipoleT::setEntryOffset(), MultipoleT::setFringeField(), MultipoleT::setMaxOrder(), MultipoleT::setRotation(), MultipoleT::setTransProfile(), and MultipoleT::validateConfiguration().

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

◆ dataSink_m

std::shared_ptr<DataSink> TestMultipoleTStraight::dataSink_m

Definition at line 189 of file TestMultipoleTStraight.cpp.

Referenced by makeBunch().

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

◆ dummy

BMultipoleField MultipoleT::dummy

protectedinherited

Not implemented

Definition at line 240 of file MultipoleT.h.

Referenced by MultipoleT::getField(), and MultipoleT::getField().

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

◆ fsCmdBase_m

std::shared_ptr<FieldSolverCmd> TestMultipoleTStraight::fsCmdBase_m

Definition at line 188 of file TestMultipoleTStraight.cpp.

Referenced by makeBunch().

◆ implementation_

std::unique_ptr<MultipoleTBase> MultipoleT::implementation_ {}

protectedinherited

Definition at line 247 of file MultipoleT.h.

Referenced by MultipoleT::apply(), MultipoleT::apply(), MultipoleT::apply(), MultipoleT::chooseImplementation(), MultipoleT::getGeometry(), MultipoleT::getGeometry(), MultipoleT::initialise(), MultipoleT::setElementLength(), MultipoleT::setFringeField(), and MultipoleT::setMaxOrder().

◆ misalignment_m

CoordinateSystemTrafo ElementBase::misalignment_m

protectedinherited

Definition at line 438 of file ElementBase.h.

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

◆ online_m

bool Component::online_m

protectedinherited

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

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

◆ rotationZAxis_m

double ElementBase::rotationZAxis_m

protectedinherited

Definition at line 444 of file ElementBase.h.

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

◆ scalingName_m

std::string MultipoleT::scalingName_m

protectedinherited

Definition at line 243 of file MultipoleT.h.

Referenced by MultipoleT::getScalingName(), MultipoleT::initialiseTimeDependencies(), and MultipoleT::setScalingName().

◆ scalingTD_m

std::shared_ptr<AbstractTimeDependence> MultipoleT::scalingTD_m

mutableprotectedinherited

Definition at line 244 of file MultipoleT.h.

Referenced by MultipoleT::getScaling(), and MultipoleT::initialiseTimeDependencies().

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

TestMultipoleTStraight.cpp

Classes

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TestMultipoleTStraight()

Member Function Documentation

◆ accept()

◆ apply() [1/3]

◆ apply() [2/3]

◆ apply() [3/3]

◆ applyToReferenceParticle()

◆ bends()

◆ Bfield() [1/2]

◆ Bfield() [2/2]

◆ chooseImplementation()

◆ clone()

◆ copyStructure()

◆ curvilinearToGlobal()

◆ EBfield() [1/2]

◆ EBfield() [2/2]

◆ Efield() [1/2]

◆ Efield() [2/2]

◆ finalise()

◆ fixPosition()

◆ getAperture() [1/2]

◆ getAperture() [2/2]

◆ getArcLength()

◆ getAttribute()

◆ getBendAngle()

◆ getBodyPort()

◆ getBoundaryGeometry()

◆ getBoundingBoxInLabCoords()

◆ getBoundingBoxLength()

◆ getChannel()

◆ getConfig()

◆ getConstChannel()

◆ getCSTrafoGlobal2Local()

◆ getDesign()

◆ getDesignEnergy()

◆ getEdgeToBegin()

◆ getEdgeToEnd()

◆ getElementDimensions()

◆ getElementLength()

◆ getElementPosition()

◆ getEntrance()

◆ getEntranceAngle()

◆ getEntranceFrame()

◆ getEntrancePatch()

◆ getEntryOffset()

◆ getEntryPort()

◆ getExit()

◆ getExitFrame()

◆ getExitPatch()

◆ getExitPort()

◆ getField() [1/2]

◆ getField() [2/2]

◆ getFieldExtend()

◆ getFlagDeleteOnTransverseExit()

◆ getFringeField()

◆ getGeometry() [1/2]

◆ getGeometry() [2/2]

◆ getLength()

◆ getMaxFOrder()

◆ getMaxXOrder()

◆ getMisalignment() [1/2]

◆ getMisalignment() [2/2]

◆ getName()

◆ getOrigin()

◆ getOutputFN()

◆ getParticleMatterInteraction()

◆ getPlacedElement()

◆ getPlacementGeometry()

◆ getPlacementMisalignment()