#include <MultipoleT.h>

Inheritance diagram for MultipoleT:

Collaboration diagram for MultipoleT:

Public Member Functions
	MultipoleT (const std::string &name)
	MultipoleT (const MultipoleT &right)
	~MultipoleT () override=default
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 Vector_t &R, const Vector_t &P, const double &t, Vector_t &E, Vector_t &B) override
bool	apply (const size_t &i, const double &t, Vector_t &E, Vector_t &B) override
void	initialise (PartBunchBase< double, 3 > *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 std::vector< double > &	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)
std::tuple< double, double >	getAperture ()
void	setRotation (double rot)
double	getRotation () const
double	getBoundingBoxLength () const
void	setBoundingBoxLength (double boundingBoxLength)
void	getDimensions (double &, double &) const override
double	getFringeDeriv (const std::size_t &n, const double &s)
double	getFnDerivX (const std::size_t &n, const double &x, const double &s)
double	getFnDerivS (const std::size_t &n, const double &x, const double &s)
double	getTransDeriv (const std::size_t &n, const double &x) const
Vector_t	toMagnetCoords (const Vector_t &R)
Vector_t	getField (const Vector_t &magnetCoords)
Vector_t	localCartesianToOpalCartesian (const Vector_t &r)
double	localCartesianRotation ()
void	setScalingName (const std::string &name)
void	setScalingModel (const std::shared_ptr< AbstractTimeDependence > &td)
std::string	getScalingName () const
void	initialiseTimeDepencencies () const
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 &R, const Vector_t &P, const double &t, Vector_t &E, Vector_t &B)
virtual bool	getPotential (const Vector_t &, const double &, Vector_t &, double &)
virtual double	getDesignEnergy () const
virtual void	setDesignEnergy (const double &energy, bool changeable=true)
virtual void	goOnline (const double &kineticEnergy)
virtual void	goOffline ()
virtual bool	Online ()
virtual ElementType	getType () const override
	Get element type std::string.
virtual const ElementBase &	getDesign () const
	Return design element.
virtual void	trackBunch (PartBunchBase< double, 3 > *bunch, const PartData &, bool revBeam, bool revTrack) const
	Track particle bunch.
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
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
void	setAperture (const ApertureType &type, const std::vector< double > &args)
std::pair< ApertureType, std::vector< double > >	getAperture () const
virtual bool	isInside (const Vector_t &r) const
void	setMisalignment (const CoordinateSystemTrafo &cst)
void	getMisalignment (double &x, double &y, double &s) const
CoordinateSystemTrafo	getMisalignment () const
void	setActionRange (const std::queue< std::pair< double, double > > &range)
void	setCurrentSCoordinate (double s)
void	setRotationAboutZ (double rotation)
	Set rotation about z axis in bend frame.
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
int	addReference () const
	Increment reference count.
int	removeReference () const
	Decrement the reference count.
bool	isShared () const
	Test for sharing.

void	setElementPosition (double elemedge)
	Access to ELEMEDGE attribute.
double	getElementPosition () const
bool	isElementPositionSet () const

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

Protected Member Functions
Vector_t	rotateFrame (const Vector_t &R) const
bool	insideAperture (const Vector_t &R) const
bool	insideBoundingBox (const Vector_t &R) const
void	chooseImplementation ()
bool	isInsideTransverse (const Vector_t &r) const

Protected Attributes
endfieldmodel::Tanh	fringeField_l {endfieldmodel::Tanh()}
endfieldmodel::Tanh	fringeField_r {endfieldmodel::Tanh()}
std::size_t	maxFOrder_m {3}
std::size_t	maxXOrder_m {20}
std::vector< double >	transProfile_m {0.0}
size_t	transMaxOrder_m {1}
double	length_m {1.0}
double	entranceAngle_m {0.0}
double	rotation_m {0.0}
double	bendAngle_m {0.0}
bool	variableRadius_m {false}
double	boundingBoxLength_m {0.0}
double	entryOffset_m {0.0}
double	verticalApert_m {0.5}
double	horizontalApert_m {0.5}
BMultipoleField	dummy
std::string	scalingName_m
std::shared_ptr< AbstractTimeDependence >	scalingTD_m
std::unique_ptr< MultipoleTBase >	implementation_ {}
double	exit_face_slope_m
PartBunchBase< double, 3 > *	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

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
int	refCount

double	elementPosition_m
	ELEMEDGE attribute.
bool	elemedgeSet_m

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

Detailed Description

MultipoleT implements a straight or curved combined
function magnet (up to arbitrary multipole component) with fringe fields.

Class category: AbsBeamline
$Author: Titus Dascalu, Martin Duy Tat, Chris Rogers

The field is obtained from the scalar potential

\[ V = f_0(x,s) z + f_1 (x,s) \frac{z^3}{3!} + f_2 (x,s) \frac{z^5}{5!} + ... \]

(x,z,s) -> Frenet-Serret local coordinates along the magnet
z -> vertical component
assume mid-plane symmetry
set field on mid-plane -> $ B_z = f_0(x,s) = T(x) \cdot S(s) $
T(x) -> transverse profile; this is a polynomial describing the field expansion on the mid-plane inside the magnet (not in the fringe field); 1st term is the dipole strength, 2nd term is the quadrupole gradient * x, etc.
-> when setting the magnet, one gives the multipole coefficients of this polynomial (i.e. dipole strength,
quadrupole gradient, etc.)

----------— example --------------------------------------------—
Setting a combined function magnet with dipole, quadrupole and sextupole components:
$ T(x) = B_0 + B_1 \cdot x + B_2 \cdot x^2 $
user gives $ B_0, B_1, B_2 $
----------— example end ----------------------------------------—

S(s) -> fringe field
recursion -> $ f_n (x,s) = (-1)^n \cdot \sum_{i=0}^{n} C_n^i \cdot T^{(2i)} \cdot S^{(2n-2i)} $
for curved magnets the above recursion is more complicated
$ C_n^i $ -> binomial coeff; $ T^{(n)} $ -> n-th derivative

Definition at line 88 of file MultipoleT.h.

Constructor & Destructor Documentation

◆ MultipoleT() [1/2]

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

explicit

Constructor

Parameters

name	-> User-defined name

Definition at line 42 of file MultipoleT.cpp.

References chooseImplementation(), Component::Component(), and name.

Referenced by clone(), and MultipoleT().

Here is the call graph for this function:

◆ MultipoleT() [2/2]

MultipoleT::MultipoleT ( const MultipoleT & right )

Copy constructor

Definition at line 47 of file MultipoleT.cpp.

References bendAngle_m, boundingBoxLength_m, chooseImplementation(), Component::Component(), entranceAngle_m, fringeField_l, fringeField_r, horizontalApert_m, length_m, maxFOrder_m, maxXOrder_m, MultipoleT(), Component::RefPartBunch_m, rotation_m, scalingName_m, scalingTD_m, transMaxOrder_m, transProfile_m, variableRadius_m, and verticalApert_m.

Here is the call graph for this function:

◆ ~MultipoleT()

MultipoleT::~MultipoleT ( )

overridedefault

Destructor

References ElementBase::ElementBase().

Here is the call graph for this function:

Member Function Documentation

◆ accept()

void MultipoleT::accept ( BeamlineVisitor & visitor ) const

overridevirtual

Accept a beamline visitor

Implements ElementBase.

Definition at line 73 of file MultipoleT.cpp.

References initialiseTimeDepencencies(), and BeamlineVisitor::visitMultipoleT().

Here is the call graph for this function:

◆ addReference()

int RCObject::addReference ( ) const

inlineinherited

Increment reference count.

Definition at line 83 of file RCObject.h.

References refCount.

Referenced by Pointer< Object >::operator=(), Pointer< Object >::operator=(), and Pointer< Object >::unique().

◆ apply() [1/2]

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

overridevirtual

Calculate the field at the position of the ith particle

Parameters

i	-> Index of the particle event; field is calculated at this position 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 228 of file MultipoleT.cpp.

References apply(), and Component::RefPartBunch_m.

Here is the call graph for this function:

◆ apply() [2/2]

bool MultipoleT::apply	(	const Vector_t &	R,
		const Vector_t &	P,
		const double &	t,
		Vector_t &	E,
		Vector_t &	B )

overridevirtual

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 129 of file MultipoleT.cpp.

References getField(), ElementBase::getFlagDeleteOnTransverseExit(), insideAperture(), insideBoundingBox(), scalingTD_m, and toMagnetCoords().

Referenced by apply().

Here is the call graph for this function:

◆ applyToReferenceParticle()

bool Component::applyToReferenceParticle	(	const Vector_t &	R,
		const Vector_t &	P,
		const double &	t,
		Vector_t &	E,
		Vector_t &	B )

virtualinherited

Reimplemented in Bend2D, Degrader, FlexibleCollimator, Monitor, Multipole, PluginElement, RBend3D, RFCavity, Solenoid, TravelingWave, Vacuum, VariableRFCavity, and VariableRFCavityFringeField.

Definition at line 121 of file Component.cpp.

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

Here is the call graph for this function:

◆ bends()

bool MultipoleT::bends ( ) const

overridevirtual

Return true if dipole component not zero

Implements Component.

Definition at line 293 of file MultipoleT.cpp.

References bendAngle_m, and transProfile_m.

◆ Bfield() [1/2]

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

inlineinherited

Return the field in a point.

Definition at line 202 of file Component.h.

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

Referenced by OutputPlane::getFieldsAtPoint().

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 208 of file Component.h.

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

Here is the call graph for this function:

◆ chooseImplementation()

void MultipoleT::chooseImplementation ( )

protected

Definition at line 247 of file MultipoleT.cpp.

References bendAngle_m, implementation_, and variableRadius_m.

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

◆ clone()

ElementBase * MultipoleT::clone ( ) const

overridevirtual

Inheritable copy constructor

Implements ElementBase.

Definition at line 69 of file MultipoleT.cpp.

References ElementBase::ElementBase(), and MultipoleT().

Referenced by ParallelCyclotronTracker::visitMultipoleT().

Here is the call graph for this function:

◆ copyStructure()

ElementBase * ElementBase::copyStructure ( )

virtualinherited

Make a structural copy.

Reimplemented in TBeamline< T >, TBeamline< FlaggedElmPtr >, and TBeamline< SequenceMember >.

Definition at line 244 of file ElementBase.cpp.

References ElementBase(), and isSharable().

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

Here is the call graph for this function:

◆ EBfield() [1/2]

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

inlineinherited

Return the field in a point.

Definition at line 211 of file Component.h.

References EMField::EBfield(), and 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 214 of file Component.h.

References EMField::EBfield(), and 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 199 of file Component.h.

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

Referenced by OutputPlane::getFieldsAtPoint().

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 205 of file Component.h.

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

Here is the call graph for this function:

◆ finalise()

void MultipoleT::finalise ( )

overridevirtual

Finalise the MultipoleT - sets bunch to nullptr

Implements Component.

Definition at line 224 of file MultipoleT.cpp.

References Component::RefPartBunch_m.

◆ fixPosition()

void ElementBase::fixPosition ( )

inlineinherited

Definition at line 551 of file ElementBase.h.

References positionIsFixed.

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

◆ getAperture() [1/2]

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

inlineinherited

Definition at line 525 of file ElementBase.h.

References aperture_m.

Referenced by MeshGenerator::add(), and Offset::operator=().

◆ getAperture() [2/2]

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

inline

Get the aperture dimensions

Returns: {verticalApert, horizontalApert}

Definition at line 206 of file MultipoleT.h.

References horizontalApert_m, and verticalApert_m.

◆ getArcLength()

double ElementBase::getArcLength ( ) const

inlinevirtualinherited

Get arc length.

Reimplemented in MarkerRep, TBeamline< T >, TBeamline< FlaggedElmPtr >, and TBeamline< SequenceMember >.

Definition at line 411 of file ElementBase.h.

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

Referenced by 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 187 of file ElementBase.cpp.

References getConstChannel().

Here is the call graph for this function:

◆ getBendAngle()

double MultipoleT::getBendAngle ( ) const

inline

Get the bending angle of the magnet

Definition at line 187 of file MultipoleT.h.

References bendAngle_m.

◆ getBoundaryGeometry()

BoundaryGeometry * ElementBase::getBoundaryGeometry ( ) const

inlinevirtualinherited

return the attached boundary geometrt object if there is any

Definition at line 475 of file ElementBase.h.

References bgeometry_m.

◆ getBoundingBoxInLabCoords()

BoundingBox ElementBase::getBoundingBoxInLabCoords ( ) const

virtualinherited

Reimplemented in Bend2D.

Definition at line 313 of file ElementBase.cpp.

References csTrafoGlobal2Local_m, and getEdgeToBegin().

Here is the call graph for this function:

◆ getBoundingBoxLength()

double MultipoleT::getBoundingBoxLength ( ) const

inline

Get the bounding box size

Definition at line 215 of file MultipoleT.h.

References boundingBoxLength_m.

◆ getChannel()

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

virtualinherited

Construct a read/write channel.

Reimplemented in CCollimatorRep, CorrectorRep, CyclotronRep, DegraderRep, DriftRep, FlexibleCollimatorRep, MonitorRep, MultipoleRep, ProbeRep, RBendRep, RFCavityRep, SBendRep, SeptumRep, SingleMultipole< order >, SingleMultipole< -2 >, SingleMultipole< -3 >, SingleMultipole< -4 >, SingleMultipole< 2 >, SingleMultipole< 3 >, SingleMultipole< 4 >, SolenoidRep, SourceRep, StripperRep, TravelingWaveRep, UndulatorRep, VacuumRep, XCorrectorRep, and YCorrectorRep.

Definition at line 228 of file ElementBase.cpp.

References userAttribs.

◆ getConstChannel()

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

virtualinherited

Construct a read-only channel.

Definition at line 233 of file ElementBase.cpp.

References ElementBase(), and getChannel().

Referenced by getAttribute(), and hasAttribute().

Here is the call graph for this function:

◆ getCSTrafoGlobal2Local()

CoordinateSystemTrafo ElementBase::getCSTrafoGlobal2Local ( ) const

inlineinherited

Definition at line 498 of file ElementBase.h.

References csTrafoGlobal2Local_m.

Referenced by MeshGenerator::add(), ParallelTTracker::computeParticleMatterInteraction(), Monitor::driftToCorrectPositionAndSave(), OpalRBend3D::update(), OpalRBend::update(), and OpalSBend::update().

◆ getDesign()

const ElementBase & Component::getDesign ( ) const

virtualinherited

Return design element.

Definition at line 67 of file Component.cpp.

References ElementBase::ElementBase().

Here is the call graph for this function:

◆ getDesignEnergy()

double Component::getDesignEnergy ( ) const

inlinevirtualinherited

Reimplemented in BendBase, and RFCavity.

Definition at line 231 of file Component.h.

◆ getDimensions()

void MultipoleT::getDimensions	(	double &	,
		double &	) const

inlineoverridevirtual

Not implemented

Implements Component.

Definition at line 221 of file MultipoleT.h.

◆ getEdgeToBegin()

CoordinateSystemTrafo ElementBase::getEdgeToBegin ( ) const

inlinevirtualinherited

Reimplemented in RFCavity, Solenoid, and TravelingWave.

Definition at line 503 of file ElementBase.h.

Referenced by Bend2D::getBoundingBoxInLabCoords(), getBoundingBoxInLabCoords(), and SingleMultipole< 4 >::update().

◆ getEdgeToEnd()

CoordinateSystemTrafo ElementBase::getEdgeToEnd ( ) const

inlinevirtualinherited

Reimplemented in Bend2D, RFCavity, Solenoid, and TravelingWave.

Definition at line 511 of file ElementBase.h.

References getElementLength().

Here is the call graph for this function:

◆ getElementDimensions()

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

inlinevirtualinherited

Reimplemented in RFCavity, Solenoid, and TravelingWave.

Definition at line 174 of file ElementBase.h.

References begin(), end(), and 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, RFCavity, TBeamline< T >, TBeamline< FlaggedElmPtr >, and TBeamline< SequenceMember >.

Definition at line 415 of file ElementBase.h.

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

Referenced by Component::apply(), Corrector::apply(), Multipole::apply(), Multipole::apply(), Solenoid::apply(), Undulator::apply(), Component::applyToReferenceParticle(), Multipole::applyToReferenceParticle(), Solenoid::applyToReferenceParticle(), Vacuum::checkPoint(), RBend::findChordLength(), SBend::findChordLength(), CCollimator::getDimensions(), Corrector::getDimensions(), Degrader::getDimensions(), Drift::getDimensions(), FlexibleCollimator::getDimensions(), Multipole::getDimensions(), RBend3D::getDimensions(), Solenoid::getDimensions(), Vacuum::getDimensions(), getEdgeToEnd(), Solenoid::getEdgeToEnd(), getElementDimensions(), Solenoid::getElementDimensions(), RFCavity::getElementLength(), Corrector::initialise(), Degrader::initialise(), Drift::initialise(), FlexibleCollimator::initialise(), Multipole::initialise(), RBend3D::initialise(), Solenoid::initialise(), Source::initialise(), Vacuum::initialise(), Degrader::isInside(), isInside(), Monitor::isInside(), Multipole::isInside(), FlexibleCollimator::isStopped(), Bend2D::setupDefaultFieldMap(), SingleMultipole< 4 >::update(), ParallelCyclotronTracker::visitCorrector(), ParallelCyclotronTracker::visitDrift(), ThickTracker::visitDrift(), ParallelCyclotronTracker::visitMultipole(), ThickTracker::visitMultipole(), ParallelCyclotronTracker::visitRBend(), ParallelCyclotronTracker::visitSBend(), and ThickTracker::visitSBend().

Here is the call graph for this function:

◆ getElementPosition()

double ElementBase::getElementPosition ( ) const

inlineinherited

Definition at line 589 of file ElementBase.h.

References elemedgeSet_m, elementPosition_m, and getName().

Here is the call graph for this function:

◆ getEntrance()

double ElementBase::getEntrance ( ) const

inlinevirtualinherited

Get entrance position.

Reimplemented in TBeamline< T >, TBeamline< FlaggedElmPtr >, and TBeamline< SequenceMember >.

Definition at line 427 of file ElementBase.h.

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

Here is the call graph for this function:

◆ getEntranceAngle()

double MultipoleT::getEntranceAngle ( ) const

inline

Get the entrance angle

Definition at line 189 of file MultipoleT.h.

References entranceAngle_m.

◆ getEntranceFrame()

Euclid3D ElementBase::getEntranceFrame ( ) const

inlinevirtualinherited

Get transform.

Reimplemented in TBeamline< T >, TBeamline< FlaggedElmPtr >, and TBeamline< SequenceMember >.

Definition at line 447 of file ElementBase.h.

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

Here is the call graph for this function:

◆ getEntrancePatch()

Euclid3D ElementBase::getEntrancePatch ( ) const

inlinevirtualinherited

Get patch.

Definition at line 455 of file ElementBase.h.

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

Here is the call graph for this function:

◆ getEntryOffset()

double MultipoleT::getEntryOffset ( ) const

inline

Get the offset of the entry point from the standard position

Definition at line 181 of file MultipoleT.h.

References entryOffset_m.

◆ getExit()

double ElementBase::getExit ( ) const

inlinevirtualinherited

Get exit position.

Reimplemented in TBeamline< T >, TBeamline< FlaggedElmPtr >, and TBeamline< SequenceMember >.

Definition at line 431 of file ElementBase.h.

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

Here is the call graph for this function:

◆ getExitFrame()

Euclid3D ElementBase::getExitFrame ( ) const

inlinevirtualinherited

Get transform.

Reimplemented in TBeamline< T >, TBeamline< FlaggedElmPtr >, and TBeamline< SequenceMember >.

Definition at line 451 of file ElementBase.h.

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

Here is the call graph for this function:

◆ getExitPatch()

Euclid3D ElementBase::getExitPatch ( ) const

inlinevirtualinherited

Get patch.

Definition at line 459 of file ElementBase.h.

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

Here is the call graph for this function:

◆ getField() [1/3]

const EMField & MultipoleT::getField ( ) const

inlineoverridevirtual

Return a dummy field value

Implements Component.

Definition at line 109 of file MultipoleT.h.

References dummy.

◆ getField() [2/3]

EMField & MultipoleT::getField ( )

inlineoverridevirtual

Return a dummy field value

Implements Component.

Definition at line 107 of file MultipoleT.h.

References dummy.

Referenced by apply().

◆ getField() [3/3]

Vector_t MultipoleT::getField ( const Vector_t & magnetCoords )

Calculate B-field in the local Frenet-Serret frame

Transform B-field from local to lab coordinates

Definition at line 117 of file MultipoleT.cpp.

References implementation_.

◆ getFlagDeleteOnTransverseExit()

bool ElementBase::getFlagDeleteOnTransverseExit ( ) const

inlineinherited

Definition at line 614 of file ElementBase.h.

References deleteOnTransverseExit_m.

Referenced by Bend2D::apply(), Corrector::apply(), Multipole::apply(), Multipole::apply(), MultipoleT::apply(), RFCavity::apply(), Solenoid::apply(), TravelingWave::apply(), and FlexibleCollimator::isStopped().

◆ getFnDerivS()

double MultipoleT::getFnDerivS	(	const std::size_t &	n,
		const double &	x,
		const double &	s )

Calculate partial derivative of fn wrt s using a 5-point finite difference formula Error of order stepSize^4

Parameters

n	-> nth derivative
x	-> Coordinate x
s	-> Coordinate s

Definition at line 210 of file MultipoleT.cpp.

References getFringeDeriv(), getTransDeriv(), and implementation_.

Here is the call graph for this function:

◆ getFnDerivX()

double MultipoleT::getFnDerivX	(	const std::size_t &	n,
		const double &	x,
		const double &	s )

Calculate partial derivative of fn wrt x using a 5-point finite difference formula Error of order stepSize^4

Parameters

n	-> nth derivative
x	-> Coordinate x
s	-> Coordinate s

Definition at line 196 of file MultipoleT.cpp.

References getFringeDeriv(), getTransDeriv(), and implementation_.

Here is the call graph for this function:

◆ getFringeDeriv()

double MultipoleT::getFringeDeriv	(	const std::size_t &	n,
		const double &	s )

Returns the value of the fringe field n-th derivative at s

Parameters

n	-> nth derivative
s	-> Coordinate s

Definition at line 159 of file MultipoleT.cpp.

References fringeField_l, fringeField_r, and tanhderiv::integrate().

Referenced by getFnDerivS(), and getFnDerivX().

Here is the call graph for this function:

◆ getFringeField()

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

Get the fringe field model

Returns: {s0, leftFringe, rightFringe}

Definition at line 155 of file MultipoleT.cpp.

References fringeField_l, and fringeField_r.

◆ getGeometry() [1/2]

const BGeometryBase & MultipoleT::getGeometry ( ) const

overridevirtual

Return the cell geometry

Implements ElementBase.

Definition at line 319 of file MultipoleT.cpp.

References implementation_.

◆ getGeometry() [2/2]

BGeometryBase & MultipoleT::getGeometry ( )

overridevirtual

Return the cell geometry

Implements ElementBase.

Definition at line 315 of file MultipoleT.cpp.

References implementation_.

◆ getLength()

double MultipoleT::getLength ( ) const

inline

Get the length of the magnet

Definition at line 196 of file MultipoleT.h.

References length_m.

◆ getMaxFOrder()

size_t MultipoleT::getMaxFOrder ( ) const

inline

Get the number of terms used in calculation of field components

Definition at line 143 of file MultipoleT.h.

References maxFOrder_m.

◆ getMaxXOrder()

size_t MultipoleT::getMaxXOrder ( ) const

inline

Definition at line 144 of file MultipoleT.h.

References maxXOrder_m.

◆ getMisalignment() [1/2]

CoordinateSystemTrafo ElementBase::getMisalignment ( ) const

inlineinherited

Definition at line 541 of file ElementBase.h.

References misalignment_m.

◆ getMisalignment() [2/2]

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

inherited

Referenced by ParallelTTracker::computeParticleMatterInteraction().

◆ getName()

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

virtualinherited

Get element name.

Definition at line 162 of file ElementBase.cpp.

References elementID.

Referenced by Ring::appendElement(), Cyclotron::apply(), Ring::apply(), Bend2D::calculateRefTrajectory(), OutputPlane::checkOne(), Vacuum::checkPressure(), TBeamline< T >::clone(), TBeamline< T >::copyStructure(), Stripper::doCheck(), CCollimator::doFinalise(), Stripper::doFinalise(), OutputPlane::doGoOffline(), Probe::doGoOffline(), PlaceRep::enter(), Cyclotron::finalise(), Degrader::finalise(), FlexibleCollimator::finalise(), Vacuum::finalise(), PyOpal::Field::getElementName(), getElementPosition(), RFCavity::getMomentaKick(), Bend2D::getOutline(), getOutputFN(), CavityAutophaser::getPhaseAtMaxEnergy(), Selector::handleElement(), Bend2D::initialise(), RBend3D::initialise(), RFCavity::initialise(), Ring::initialise(), Solenoid::initialise(), CSRIGFWakeFunction::initialize(), CSRWakeFunction::initialize(), OpalWake::initWakefunction(), PlaceRep::leave(), Offset::Offset(), operator<<(), Offset::operator=(), VariableRFCavity::operator=(), operator==(), Line::parse(), Sequence::print(), Vacuum::print(), Bend2D::readFieldMap(), PyOpal::PyLine_< TBeamline< FlaggedElmPtr > >::registerObject(), Ring::Ring(), ClassicField::SortAsc(), Component::trackBunch(), Component::trackMap(), RBend3D::trackRefParticleThrough(), OpalRBend3D::update(), OpalRBend::update(), OpalSBend::update(), Sequence::updateList(), ParallelTTracker::updateRFElement(), ParallelCyclotronTracker::visitCCollimator(), Replacer::visitFlaggedElmPtr(), ParallelCyclotronTracker::visitProbe(), ParallelCyclotronTracker::visitRFCavity(), ParallelCyclotronTracker::visitSeptum(), ParallelCyclotronTracker::visitStripper(), and ParallelTTracker::writePhaseSpace().

◆ getOrigin()

double ElementBase::getOrigin ( ) const

inlinevirtualinherited

Get origin position.

Reimplemented in TBeamline< T >, TBeamline< FlaggedElmPtr >, and TBeamline< SequenceMember >.

Definition at line 423 of file ElementBase.h.

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

Here is the call graph for this function:

◆ getOutputFN()

std::string ElementBase::getOutputFN ( ) const

inherited

Get output filename.

Definition at line 177 of file ElementBase.cpp.

References getName(), and outputfn_m.

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

Here is the call graph for this function:

◆ getParticleMatterInteraction()

ParticleMatterInteractionHandler * ElementBase::getParticleMatterInteraction ( ) const

inlinevirtualinherited

Definition at line 483 of file ElementBase.h.

References parmatint_m.

Referenced by Degrader::applyToReferenceParticle(), CCollimator::doInitialise(), FlexibleCollimator::initialise(), FlexibleCollimator::initialise(), and Vacuum::initialise().

◆ getPotential()

virtual bool Component::getPotential	(	const Vector_t &	,
		const double &	,
		Vector_t &	,
		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 130 of file Component.h.

◆ getRequiredNumberOfTimeSteps()

int ElementBase::getRequiredNumberOfTimeSteps ( ) const

inlinevirtualinherited

Reimplemented in Drift, Marker, Monitor, Source, and Stripper.

Definition at line 603 of file ElementBase.h.

◆ getRotation()

double MultipoleT::getRotation ( ) const

inline

Get the angle of rotation of the magnet around its axis

Definition at line 213 of file MultipoleT.h.

References rotation_m.

◆ getRotationAboutZ()

double ElementBase::getRotationAboutZ ( ) const

inlineinherited

Definition at line 574 of file ElementBase.h.

References rotationZAxis_m.

Referenced by OpalBeamline::compute3DLattice(), and Bend2D::setFieldCalcParam().

◆ getScalingName()

std::string MultipoleT::getScalingName ( ) const

inline

Definition at line 262 of file MultipoleT.h.

References scalingName_m.

◆ getTotalTransform()

Euclid3D ElementBase::getTotalTransform ( ) const

inlinevirtualinherited

Get transform.

Reimplemented in TBeamline< T >, TBeamline< FlaggedElmPtr >, and TBeamline< SequenceMember >.

Definition at line 439 of file ElementBase.h.

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

Here is the call graph for this function:

◆ getTransDeriv()

double MultipoleT::getTransDeriv	(	const std::size_t &	n,
		const double &	x ) const

Returns the value of the transverse field n-th derivative at x
Transverse field is a polynomial in x, differentiation follows usual polynomial rules of differentiation

Parameters

n	-> nth derivative
x	-> Coordinate x

Definition at line 172 of file MultipoleT.cpp.

References getTransMaxOrder(), getTransProfile(), and transMaxOrder_m.

Referenced by getFnDerivS(), and getFnDerivX().

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 >, TBeamline< FlaggedElmPtr >, and TBeamline< SequenceMember >.

Definition at line 435 of file ElementBase.h.

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

Referenced by TBeamline< T >::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 >, TBeamline< FlaggedElmPtr >, and TBeamline< SequenceMember >.

Definition at line 443 of file ElementBase.h.

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

Here is the call graph for this function:

◆ getTransMaxOrder()

std::size_t MultipoleT::getTransMaxOrder ( ) const

inline

Get the maximum order in the given transverse profile

Definition at line 151 of file MultipoleT.h.

References transMaxOrder_m.

Referenced by getTransDeriv().

◆ getTransProfile()

const std::vector< double > & MultipoleT::getTransProfile ( ) const

inline

Get all terms of transverse profile

Definition at line 157 of file MultipoleT.h.

References transProfile_m.

Referenced by getTransDeriv().

◆ getType()

ElementType Component::getType ( ) const

overridevirtualinherited

Get element type std::string.

Implements ElementBase.

Reimplemented in Bend2D, CCollimator, Corrector, Cyclotron, Degrader, Drift, FlexibleCollimator, Marker, Monitor, Multipole, OutputPlane, Probe, RBend3D, RBend, RFCavity, SBend, Septum, Solenoid, Source, Stripper, TravelingWave, Undulator, and Vacuum.

Definition at line 95 of file Component.cpp.

References ANY.

◆ getTypeString() [1/2]

std::string ElementBase::getTypeString ( ) const

inlineinherited

Definition at line 579 of file ElementBase.h.

References getType(), and getTypeString().

Referenced by ParallelCyclotronTracker::execute(), getTypeString(), and OpalBeamline::visit().

Here is the call graph for this function:

◆ getTypeString() [2/2]

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

staticinherited

Definition at line 240 of file ElementBase.cpp.

References elementTypeToString_s.

◆ getVariableRadius()

bool MultipoleT::getVariableRadius ( ) const

inline

Get the variable radius of the magnet

Definition at line 183 of file MultipoleT.h.

References variableRadius_m.

◆ getWake()

WakeFunction * ElementBase::getWake ( ) const

inlinevirtualinherited

return the attached wake object if there is any

Definition at line 467 of file ElementBase.h.

References wake_m.

◆ goOffline()

void Component::goOffline ( )

virtualinherited

Reimplemented in Degrader, FlexibleCollimator, Monitor, PluginElement, RBend3D, RFCavity, Solenoid, Source, TravelingWave, and Vacuum.

Definition at line 87 of file Component.cpp.

References online_m.

◆ goOnline()

void Component::goOnline ( const double & kineticEnergy )

virtualinherited

Reimplemented in Bend2D, CCollimator, Corrector, Degrader, FlexibleCollimator, Monitor, RBend3D, RFCavity, Solenoid, Source, TravelingWave, and Vacuum.

Definition at line 83 of file Component.cpp.

References online_m.

Referenced by PluginElement::initialise().

◆ hasAttribute()

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

virtualinherited

Test for existence of an attribute.

Definition at line 200 of file ElementBase.cpp.

References getConstChannel().

Referenced by ParallelCyclotronTracker::visitSolenoid().

Here is the call graph for this function:

◆ hasBoundaryGeometry()

bool ElementBase::hasBoundaryGeometry ( ) const

inlinevirtualinherited

Definition at line 479 of file ElementBase.h.

References bgeometry_m.

◆ hasParticleMatterInteraction()

bool ElementBase::hasParticleMatterInteraction ( ) const

inlinevirtualinherited

Definition at line 487 of file ElementBase.h.

References parmatint_m.

◆ hasWake()

bool ElementBase::hasWake ( ) const

inlinevirtualinherited

Definition at line 471 of file ElementBase.h.

References wake_m.

◆ initialise()

void MultipoleT::initialise	(	PartBunchBase< double, 3 > *	bunch,
		double &	startField,
		double &	endField )

overridevirtual

Initialise the MultipoleT

Parameters

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

Implements Component.

Definition at line 297 of file MultipoleT.cpp.

References implementation_, and Component::RefPartBunch_m.

◆ initialiseTimeDepencencies()

void MultipoleT::initialiseTimeDepencencies ( ) const

Definition at line 308 of file MultipoleT.cpp.

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

Referenced by accept(), and PyOpal::PyOpalObjectNS::PyOpalObject< C >::doSetup().

Here is the call graph for this function:

◆ insideAperture()

bool MultipoleT::insideAperture ( const Vector_t & R ) const

protected

Definition at line 98 of file MultipoleT.cpp.

References horizontalApert_m, and verticalApert_m.

Referenced by apply().

◆ insideBoundingBox()

bool MultipoleT::insideBoundingBox ( const Vector_t & R ) const

protected

Definition at line 103 of file MultipoleT.cpp.

References boundingBoxLength_m, and fabs().

Referenced by apply().

Here is the call graph for this function:

◆ isElementPositionSet()

bool ElementBase::isElementPositionSet ( ) const

inlineinherited

Definition at line 598 of file ElementBase.h.

References elemedgeSet_m.

◆ isInside()

bool ElementBase::isInside ( const Vector_t & r ) const

inlinevirtualinherited

Reimplemented in Bend2D, Degrader, Monitor, Multipole, RBend3D, RFCavity, Solenoid, and TravelingWave.

Definition at line 530 of file ElementBase.h.

References getElementLength(), and isInsideTransverse().

Here is the call graph for this function:

◆ isInsideTransverse()

bool ElementBase::isInsideTransverse ( const Vector_t & r ) const

protectedinherited

Definition at line 287 of file ElementBase.cpp.

References aperture_m.

Referenced by Component::apply(), Corrector::apply(), Multipole::apply(), Multipole::apply(), Undulator::apply(), Component::applyToReferenceParticle(), Multipole::applyToReferenceParticle(), isInside(), Monitor::isInside(), Multipole::isInside(), RFCavity::isInside(), Solenoid::isInside(), TravelingWave::isInside(), and FlexibleCollimator::isStopped().

◆ isPositioned()

bool ElementBase::isPositioned ( ) const

inlineinherited

Definition at line 556 of file ElementBase.h.

References positionIsFixed.

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

◆ isSharable()

bool ElementBase::isSharable ( ) const

inlineinherited

Test if the element can be shared.

Definition at line 463 of file ElementBase.h.

References shareFlag.

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

◆ isShared()

bool RCObject::isShared ( ) const

inlineinherited

Test for sharing.

Definition at line 93 of file RCObject.h.

References refCount.

◆ localCartesianRotation()

double MultipoleT::localCartesianRotation ( )

Definition at line 327 of file MultipoleT.cpp.

References implementation_.

◆ localCartesianToOpalCartesian()

Vector_t MultipoleT::localCartesianToOpalCartesian ( const Vector_t & r )

Definition at line 323 of file MultipoleT.cpp.

References implementation_.

◆ makeSharable()

void ElementBase::makeSharable ( )

virtualinherited

Set sharable flag.

Reimplemented in TBeamline< T >, TBeamline< FlaggedElmPtr >, and TBeamline< SequenceMember >.

Definition at line 253 of file ElementBase.cpp.

References shareFlag.

Referenced by OpalMarker::OpalMarker().

◆ Online()

bool Component::Online ( )

virtualinherited

Definition at line 91 of file Component.cpp.

References online_m.

◆ releasePosition()

void ElementBase::releasePosition ( )

inlineinherited

Definition at line 546 of file ElementBase.h.

References positionIsFixed.

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

◆ removeAttribute()

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

virtualinherited

Remove an existing attribute.

Definition at line 212 of file ElementBase.cpp.

References userAttribs.

◆ removeReference()

int RCObject::removeReference ( ) const

inlineinherited

Decrement the reference count.

Definition at line 88 of file RCObject.h.

References refCount.

◆ rotateFrame()

Vector_t MultipoleT::rotateFrame ( const Vector_t & R ) const

protected

Rotate the frame to account for the rotation and entry angles.

Parameters

R	-> coordinate to rotate

Returns: -> rotated coordinate

Apply two 2D rotation matrices to coordinate vector Rotate around central axis => skew fields Rotate azimuthally => entrance angle

Definition at line 78 of file MultipoleT.cpp.

References entranceAngle_m, and rotation_m.

Referenced by toMagnetCoords().

◆ setActionRange()

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

inlineinherited

Definition at line 561 of file ElementBase.h.

References actionRange_m, and elementEdge_m.

◆ setAperture() [1/2]

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

inlineinherited

Definition at line 519 of file ElementBase.h.

References aperture_m.

Referenced by Component::Component(), Offset::operator=(), OpalElement::update(), OpalRBend3D::update(), OpalRBend::update(), OpalSBend::update(), and OpalSlit::update().

◆ setAperture() [2/2]

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

Set the aperture dimensions
This element only supports a rectangular aperture

Parameters

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

Definition at line 258 of file MultipoleT.cpp.

References horizontalApert_m, and verticalApert_m.

◆ setAttribute()

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

virtualinherited

Set value of an attribute.

Definition at line 217 of file ElementBase.cpp.

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

Referenced by TBeamline< FlaggedElmPtr >::getChannel(), and OpalElement::updateUnknown().

Here is the call graph for this function:

◆ setBendAngle()

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

Set the bending angle of the magnet

Definition at line 240 of file MultipoleT.cpp.

References bendAngle_m, chooseImplementation(), and 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 270 of file ElementBase.cpp.

References bgeometry_m.

Referenced by OpalCavity::update(), OpalCyclotron::update(), and OpalDrift::update().

◆ setBoundingBoxLength()

void MultipoleT::setBoundingBoxLength ( double boundingBoxLength )

Set the bounding box size. This controls the region for

Parameters

boundingBoxLength -> Distance between centre and entrance

Definition at line 263 of file MultipoleT.cpp.

References boundingBoxLength_m.

◆ setCSTrafoGlobal2Local()

void ElementBase::setCSTrafoGlobal2Local ( const CoordinateSystemTrafo & ori )

inlineinherited

Definition at line 491 of file ElementBase.h.

References csTrafoGlobal2Local_m, and positionIsFixed.

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

◆ setCurrentSCoordinate()

void ElementBase::setCurrentSCoordinate ( double s )

inherited

Definition at line 278 of file ElementBase.cpp.

◆ setDesignEnergy()

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

inlinevirtualinherited

Reimplemented in BendBase, Corrector, and RFCavity.

Definition at line 228 of file Component.h.

◆ setElementLength()

void MultipoleT::setElementLength ( double length )

overridevirtual

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

Reimplemented from ElementBase.

Definition at line 232 of file MultipoleT.cpp.

References implementation_, 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 583 of file ElementBase.h.

References elemedgeSet_m, and elementPosition_m.

Referenced by OpalElement::update().

◆ setEntranceAngle()

void MultipoleT::setEntranceAngle ( double entranceAngle )

Set the entrance angle

Parameters

entranceAngle -> Entrance angle

Definition at line 285 of file MultipoleT.cpp.

References entranceAngle_m.

◆ setEntryOffset()

void MultipoleT::setEntryOffset ( double offset )

Set the offset of the entry point from the standard position

Parameters

offset positive for further away from the center

Definition at line 289 of file MultipoleT.cpp.

References entryOffset_m.

◆ setExitFaceSlope()

void Component::setExitFaceSlope ( const double & m )

inlineinherited

Definition at line 225 of file Component.h.

References exit_face_slope_m.

◆ setFlagDeleteOnTransverseExit()

void ElementBase::setFlagDeleteOnTransverseExit ( bool flag = true )

inlineinherited

Definition at line 608 of file ElementBase.h.

References deleteOnTransverseExit_m.

Referenced by OpalElement::update().

◆ setFringeField()

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

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 146 of file MultipoleT.cpp.

References fringeField_l, fringeField_r, implementation_, maxFOrder_m, and endfieldmodel::Tanh::setTanhDiffIndices().

Here is the call graph for this function:

◆ setMaxOrder()

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

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 275 of file MultipoleT.cpp.

References implementation_, maxFOrder_m, and maxXOrder_m.

◆ setMisalignment()

void ElementBase::setMisalignment ( const CoordinateSystemTrafo & cst )

inlineinherited

Definition at line 536 of file ElementBase.h.

References misalignment_m.

Referenced by OpalElement::update().

◆ setName()

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

virtualinherited

Set element name.

Definition at line 167 of file ElementBase.cpp.

References elementID, and name.

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

◆ setOutputFN()

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

inherited

Set output filename.

Definition at line 172 of file ElementBase.cpp.

References outputfn_m.

Referenced by OpalCCollimator::update(), OpalCyclotron::update(), OpalECollimator::update(), OpalFlexibleCollimator::update(), OpalMonitor::update(), OpalOutputPlane::update(), OpalPepperPot::update(), OpalProbe::update(), OpalRCollimator::update(), OpalSeptum::update(), OpalSlit::update(), OpalSource::update(), and OpalStripper::update().

◆ setParticleMatterInteraction()

void ElementBase::setParticleMatterInteraction ( ParticleMatterInteractionHandler * spys )

virtualinherited

Definition at line 274 of file ElementBase.cpp.

References parmatint_m.

Referenced by OpalCCollimator::update(), OpalDrift::update(), OpalECollimator::update(), OpalFlexibleCollimator::update(), OpalPepperPot::update(), OpalQuadrupole::update(), OpalRBend3D::update(), OpalRBend::update(), OpalRCollimator::update(), OpalSBend::update(), OpalSlit::update(), and OpalVacuum::update().

◆ setRotation()

void MultipoleT::setRotation ( double rot )

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

Parameters

rot	-> Angle of rotation

Definition at line 281 of file MultipoleT.cpp.

References rotation_m.

◆ setRotationAboutZ()

void ElementBase::setRotationAboutZ ( double rotation )

inlineinherited

Set rotation about z axis in bend frame.

Definition at line 569 of file ElementBase.h.

References rotationZAxis_m.

Referenced by OpalElement::update().

◆ setScalingModel()

void MultipoleT::setScalingModel ( const std::shared_ptr< AbstractTimeDependence > & td )

inline

Definition at line 261 of file MultipoleT.h.

References scalingTD_m.

◆ setScalingName()

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

Definition at line 303 of file MultipoleT.cpp.

References name, and scalingName_m.

◆ setTransProfile()

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

Set the the transverse profile

Parameters

profile -> Multipole field profile

Definition at line 267 of file MultipoleT.cpp.

References transMaxOrder_m, and transProfile_m.

◆ setWake()

void ElementBase::setWake ( WakeFunction * wf )

virtualinherited

attach a wake field to the element

Definition at line 266 of file ElementBase.cpp.

References wake_m.

Referenced by OpalCavity::update(), OpalDrift::update(), OpalProbe::update(), OpalRBend3D::update(), OpalRBend::update(), OpalSBend::update(), OpalSeptum::update(), and OpalTravelingWave::update().

◆ toMagnetCoords()

Vector_t MultipoleT::toMagnetCoords ( const Vector_t & R )

Rotate coordinates around the central axis of the magnet

Go to local Frenet-Serret coordinates

Definition at line 107 of file MultipoleT.cpp.

References implementation_, and rotateFrame().

Referenced by apply().

Here is the call graph for this function:

◆ trackBunch()

void Component::trackBunch	(	PartBunchBase< double, 3 > *	bunch,
		const PartData &	,
		bool	revBeam,
		bool	revTrack ) const

virtualinherited

Track particle bunch.

Definition at line 71 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 77 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 258 of file ElementBase.cpp.

Referenced by Monitor::driftToCorrectPositionAndSave().

Member Data Documentation

◆ actionRange_m

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

privateinherited

Definition at line 399 of file ElementBase.h.

Referenced by setActionRange().

◆ aperture_m

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

protectedinherited

Definition at line 369 of file ElementBase.h.

Referenced by ElementBase(), getAperture(), Bend2D::getOutline(), Bend2D::getSurfaceMesh(), Bend2D::inMagnetCentralRegion(), Bend2D::inMagnetEntranceRegion(), Bend2D::inMagnetExitRegion(), isInsideTransverse(), setAperture(), Bend2D::setFieldCalcParam(), Bend2D::setupBendGeometry(), and Bend2D::setupFringeWidths().

◆ bendAngle_m

double MultipoleT::bendAngle_m {0.0}

protected

Definition at line 289 of file MultipoleT.h.

Referenced by bends(), chooseImplementation(), getBendAngle(), MultipoleT(), and setBendAngle().

◆ bgeometry_m

BoundaryGeometry* ElementBase::bgeometry_m

privateinherited

Definition at line 390 of file ElementBase.h.

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

◆ boundingBoxLength_m

double MultipoleT::boundingBoxLength_m {0.0}

protected

Definition at line 291 of file MultipoleT.h.

Referenced by getBoundingBoxLength(), insideBoundingBox(), MultipoleT(), and setBoundingBoxLength().

◆ csTrafoGlobal2Local_m

CoordinateSystemTrafo ElementBase::csTrafoGlobal2Local_m

protectedinherited

Definition at line 366 of file ElementBase.h.

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

◆ defaultAperture_m

const std::vector< double > Component::defaultAperture_m

staticprotectedinherited

Initial value:

=

std::vector<double>({1e6, 1e6, 1.0})

Definition at line 187 of file Component.h.

Referenced by Component().

◆ deleteOnTransverseExit_m

bool ElementBase::deleteOnTransverseExit_m = true

privateinherited

Definition at line 403 of file ElementBase.h.

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

◆ dummy

BMultipoleField MultipoleT::dummy

protected

Not implemented

Definition at line 297 of file MultipoleT.h.

Referenced by getField(), and getField().

◆ elemedgeSet_m

bool ElementBase::elemedgeSet_m

privateinherited

Definition at line 397 of file ElementBase.h.

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

◆ elementEdge_m

double ElementBase::elementEdge_m

protectedinherited

Definition at line 371 of file ElementBase.h.

Referenced by ElementBase(), Bend2D::getEffectiveCenter(), Bend2D::initialise(), Bend2D::print(), setActionRange(), and Bend2D::setupBendGeometry().

◆ elementID

std::string ElementBase::elementID

privateinherited

Definition at line 381 of file ElementBase.h.

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

◆ elementPosition_m

double ElementBase::elementPosition_m

privateinherited

ELEMEDGE attribute.

Definition at line 396 of file ElementBase.h.

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

◆ elementTypeToString_s

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

staticprivateinherited

Definition at line 71 of file ElementBase.h.

Referenced by getTypeString().

◆ entranceAngle_m

double MultipoleT::entranceAngle_m {0.0}

protected

Definition at line 287 of file MultipoleT.h.

Referenced by getEntranceAngle(), MultipoleT(), rotateFrame(), and setEntranceAngle().

◆ entryOffset_m

double MultipoleT::entryOffset_m {0.0}

protected

Definition at line 292 of file MultipoleT.h.

Referenced by getEntryOffset(), and setEntryOffset().

◆ exit_face_slope_m

double Component::exit_face_slope_m

protectedinherited

Definition at line 189 of file Component.h.

Referenced by Component(), Component(), and setExitFaceSlope().

◆ fringeField_l

endfieldmodel::Tanh MultipoleT::fringeField_l {endfieldmodel::Tanh()}

protected

Definition at line 276 of file MultipoleT.h.

Referenced by getFringeDeriv(), getFringeField(), MultipoleT(), and setFringeField().

◆ fringeField_r

endfieldmodel::Tanh MultipoleT::fringeField_r {endfieldmodel::Tanh()}

protected

Definition at line 277 of file MultipoleT.h.

Referenced by getFringeDeriv(), getFringeField(), MultipoleT(), and setFringeField().

◆ horizontalApert_m

double MultipoleT::horizontalApert_m {0.5}

protected

Definition at line 295 of file MultipoleT.h.

Referenced by getAperture(), insideAperture(), MultipoleT(), and setAperture().

◆ implementation_

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

protected

Definition at line 302 of file MultipoleT.h.

Referenced by chooseImplementation(), getField(), getFnDerivS(), getFnDerivX(), getGeometry(), getGeometry(), initialise(), localCartesianRotation(), localCartesianToOpalCartesian(), setElementLength(), setFringeField(), setMaxOrder(), and toMagnetCoords().

◆ length_m

double MultipoleT::length_m {1.0}

protected

Magnet parameters

Definition at line 286 of file MultipoleT.h.

Referenced by getLength(), MultipoleT(), and setElementLength().

◆ maxFOrder_m

std::size_t MultipoleT::maxFOrder_m {3}

protected

Number of terms in z expansion used in calculating field components

Definition at line 279 of file MultipoleT.h.

Referenced by getMaxFOrder(), MultipoleT(), setFringeField(), and setMaxOrder().

◆ maxXOrder_m

std::size_t MultipoleT::maxXOrder_m {20}

protected

Highest order of polynomial expansions in x

Definition at line 281 of file MultipoleT.h.

Referenced by getMaxXOrder(), MultipoleT(), and setMaxOrder().

◆ misalignment_m

CoordinateSystemTrafo ElementBase::misalignment_m

protectedinherited

Definition at line 367 of file ElementBase.h.

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

◆ online_m

bool Component::online_m

protectedinherited

Definition at line 192 of file Component.h.

Referenced by Monitor::apply(), Source::apply(), Component(), Component(), Probe::doGoOffline(), Bend2D::finalise(), Cyclotron::finalise(), FlexibleCollimator::finalise(), Multipole::finalise(), PluginElement::finalise(), Ring::finalise(), Vacuum::finalise(), goOffline(), Degrader::goOffline(), FlexibleCollimator::goOffline(), PluginElement::goOffline(), RBend3D::goOffline(), RFCavity::goOffline(), Solenoid::goOffline(), Source::goOffline(), Vacuum::goOffline(), Bend2D::goOnline(), CCollimator::goOnline(), goOnline(), Corrector::goOnline(), Degrader::goOnline(), FlexibleCollimator::goOnline(), Monitor::goOnline(), RBend3D::goOnline(), RFCavity::goOnline(), Solenoid::goOnline(), Source::goOnline(), TravelingWave::goOnline(), Vacuum::goOnline(), Cyclotron::initialise(), Multipole::initialise(), Ring::initialise(), Septum::initialise(), Online(), Degrader::~Degrader(), FlexibleCollimator::~FlexibleCollimator(), and Vacuum::~Vacuum().

◆ outputfn_m

std::string ElementBase::outputfn_m

privateinherited

The name of the outputfile

Definition at line 401 of file ElementBase.h.

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

◆ parmatint_m

ParticleMatterInteractionHandler* ElementBase::parmatint_m

privateinherited

Definition at line 392 of file ElementBase.h.

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

◆ positionIsFixed

bool ElementBase::positionIsFixed

privateinherited

Definition at line 394 of file ElementBase.h.

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

◆ refCount

int RCObject::refCount

mutableprivateinherited

Definition at line 76 of file RCObject.h.

Referenced by addReference(), isShared(), RCObject(), RCObject(), and removeReference().

◆ RefPartBunch_m

PartBunchBase<double, 3>* Component::RefPartBunch_m

protectedinherited

Definition at line 191 of file Component.h.

Referenced by Bend2D::apply(), Corrector::apply(), Corrector::apply(), Cyclotron::apply(), Degrader::apply(), FlexibleCollimator::apply(), Monitor::apply(), Multipole::apply(), MultipoleT::apply(), RBend3D::apply(), RFCavity::apply(), SBend3D::apply(), ScalingFFAMagnet::apply(), Solenoid::apply(), Source::apply(), TravelingWave::apply(), Undulator::apply(), VariableRFCavity::apply(), VariableRFCavityFringeField::apply(), VerticalFFAMagnet::apply(), Degrader::applyToReferenceParticle(), Monitor::applyToReferenceParticle(), BendBase::calcDesignRadius(), BendBase::calcFieldAmplitude(), BendBase::calcGamma(), Bend2D::calculateBendAngle(), Bend2D::calculateRefTrajectory(), Component(), Component(), Monitor::driftToCorrectPositionAndSave(), MultipoleT::finalise(), Offset::finalise(), SBend3D::finalise(), ScalingFFAMagnet::finalise(), VariableRFCavity::finalise(), VerticalFFAMagnet::finalise(), RBend::findChordLength(), Bend2D::findIdealBendParameters(), Corrector::goOnline(), Degrader::goOnline(), Corrector::initialise(), Cyclotron::initialise(), Cyclotron::initialise(), Degrader::initialise(), Drift::initialise(), FlexibleCollimator::initialise(), FlexibleCollimator::initialise(), Marker::initialise(), Monitor::initialise(), Multipole::initialise(), MultipoleT::initialise(), Offset::initialise(), PluginElement::initialise(), RBend3D::initialise(), RFCavity::initialise(), RFCavity::initialise(), SBend3D::initialise(), ScalingFFAMagnet::initialise(), Solenoid::initialise(), Source::initialise(), TravelingWave::initialise(), Undulator::initialise(), Vacuum::initialise(), VariableRFCavity::initialise(), VerticalFFAMagnet::initialise(), VariableRFCavity::initNull(), Multipole::isFocusing(), MultipoleT::MultipoleT(), CCollimator::print(), FlexibleCollimator::print(), SBend3D::SBend3D(), ScalingFFAMagnet::ScalingFFAMagnet(), Corrector::setDesignEnergy(), Ring::setRefPartBunch(), Bend2D::setupPusher(), RFCavity::trackOnAxisParticle(), RBend3D::trackRefParticleThrough(), Vacuum::updateParticleAttributes(), and VerticalFFAMagnet::VerticalFFAMagnet().

◆ rotation_m

double MultipoleT::rotation_m {0.0}

protected

Definition at line 288 of file MultipoleT.h.

Referenced by getRotation(), MultipoleT(), rotateFrame(), and setRotation().

◆ rotationZAxis_m

double ElementBase::rotationZAxis_m

protectedinherited

Definition at line 373 of file ElementBase.h.

Referenced by ElementBase(), Bend2D::findIdealBendParameters(), getRotationAboutZ(), RBend3D::initialise(), Bend2D::print(), and setRotationAboutZ().

◆ scalingName_m

std::string MultipoleT::scalingName_m

protected

Definition at line 299 of file MultipoleT.h.

Referenced by getScalingName(), initialiseTimeDepencencies(), MultipoleT(), and setScalingName().

◆ scalingTD_m

std::shared_ptr<AbstractTimeDependence> MultipoleT::scalingTD_m

mutableprotected

Definition at line 300 of file MultipoleT.h.

Referenced by apply(), initialiseTimeDepencencies(), MultipoleT(), and setScalingModel().

◆ shareFlag

bool ElementBase::shareFlag

mutableprotectedinherited

Definition at line 364 of file ElementBase.h.

Referenced by Beamline::Beamline(), Beamline::Beamline(), Beamline::Beamline(), ElementBase(), isSharable(), makeSharable(), and TBeamline< T >::makeSharable().

◆ transMaxOrder_m

size_t MultipoleT::transMaxOrder_m {1}

protected

Definition at line 284 of file MultipoleT.h.

Referenced by getTransDeriv(), getTransMaxOrder(), MultipoleT(), and setTransProfile().

◆ transProfile_m

std::vector<double> MultipoleT::transProfile_m {0.0}

protected

List of transverse profile coefficients

Definition at line 283 of file MultipoleT.h.

Referenced by bends(), getTransProfile(), MultipoleT(), and setTransProfile().

◆ userAttribs

AttributeSet ElementBase::userAttribs

privateinherited

Definition at line 386 of file ElementBase.h.

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

◆ variableRadius_m

bool MultipoleT::variableRadius_m {false}

protected

Definition at line 290 of file MultipoleT.h.

Referenced by chooseImplementation(), getVariableRadius(), MultipoleT(), and setBendAngle().

◆ verticalApert_m

double MultipoleT::verticalApert_m {0.5}

protected

Assume rectangular aperture with these dimensions

Definition at line 294 of file MultipoleT.h.

Referenced by getAperture(), insideAperture(), MultipoleT(), and setAperture().

◆ wake_m

WakeFunction* ElementBase::wake_m

privateinherited

Definition at line 388 of file ElementBase.h.

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MultipoleT() [1/2]

◆ MultipoleT() [2/2]

◆ ~MultipoleT()

Member Function Documentation

◆ accept()

◆ addReference()

◆ apply() [1/2]

◆ apply() [2/2]

◆ applyToReferenceParticle()

◆ bends()

◆ Bfield() [1/2]

◆ Bfield() [2/2]

◆ chooseImplementation()

◆ clone()

◆ copyStructure()

◆ EBfield() [1/2]

◆ EBfield() [2/2]

◆ Efield() [1/2]

◆ Efield() [2/2]

◆ finalise()

◆ fixPosition()

◆ getAperture() [1/2]

◆ getAperture() [2/2]

◆ getArcLength()

◆ getAttribute()

◆ getBendAngle()

◆ getBoundaryGeometry()

◆ getBoundingBoxInLabCoords()

◆ getBoundingBoxLength()

◆ getChannel()

◆ getConstChannel()

◆ getCSTrafoGlobal2Local()

◆ getDesign()

◆ getDesignEnergy()

◆ getDimensions()

◆ getEdgeToBegin()

◆ getEdgeToEnd()

◆ getElementDimensions()

◆ getElementLength()

◆ getElementPosition()

◆ getEntrance()

◆ getEntranceAngle()

◆ getEntranceFrame()

◆ getEntrancePatch()

◆ getEntryOffset()

◆ getExit()

◆ getExitFrame()

◆ getExitPatch()

◆ getField() [1/3]

◆ getField() [2/3]

◆ getField() [3/3]

◆ getFlagDeleteOnTransverseExit()

◆ getFnDerivS()

◆ getFnDerivX()

◆ getFringeDeriv()

◆ getFringeField()

◆ getGeometry() [1/2]

◆ getGeometry() [2/2]

◆ getLength()

◆ getMaxFOrder()

◆ getMaxXOrder()

◆ getMisalignment() [1/2]

◆ getMisalignment() [2/2]

◆ getName()

◆ getOrigin()

◆ getOutputFN()

◆ getParticleMatterInteraction()

◆ getPotential()

◆ getRequiredNumberOfTimeSteps()

◆ getRotation()

◆ getRotationAboutZ()