#include <ScalingFFAMagnet.h>

Inheritance diagram for ScalingFFAMagnet:

Collaboration diagram for ScalingFFAMagnet:

Public Member Functions
	ScalingFFAMagnet (const std::string &name)
	~ScalingFFAMagnet ()
ScalingFFAMagnet *	clone () const override
bool	apply (const size_t &i, const double &t, Vector_t &E, Vector_t &B) override
bool	apply (const Vector_t &R, const Vector_t &P, const double &t, Vector_t &E, Vector_t &B) override
bool	getFieldValue (const Vector_t &R, Vector_t &B) const
bool	getFieldValueCylindrical (const Vector_t &R, Vector_t &B) const
void	initialise (PartBunchBase< double, 3 > *bunch, double &startField, double &endField) override
void	initialise ()
void	finalise () override
bool	bends () const override
void	getDimensions (double &, double &) const override
BGeometryBase &	getGeometry () override
const BGeometryBase &	getGeometry () const override
EMField &	getField () override
const EMField &	getField () const override
void	accept (BeamlineVisitor &visitor) const override
double	getTanDelta () const
void	setTanDelta (double tanDelta)
double	getFieldIndex () const
void	setFieldIndex (double k)
double	getDipoleConstant () const
void	setDipoleConstant (double Bz)
double	getR0 () const
void	setR0 (double r0)
Vector_t	getCentre () const
void	setCentre (Vector_t centre)
endfieldmodel::EndFieldModel *	getEndField () const
void	setEndField (endfieldmodel::EndFieldModel *endField)
size_t	getMaxOrder () const
void	setMaxOrder (size_t maxOrder)
double	getPhiStart () const
void	setPhiStart (double phiStart)
double	getPhiEnd () const
void	setPhiEnd (double phiEnd)
double	getRMin () const
void	setRMin (double rMin)
double	getRMax () const
void	setRMax (double rMax)
double	getAzimuthalExtent () const
void	setAzimuthalExtent (double azimuthalExtent)
double	getVerticalExtent () const
void	setVerticalExtent (double verticalExtent)
std::vector< std::vector< double > >	getDfCoefficients ()
void	setupEndField ()
void	setEndFieldName (std::string name)
std::string	getEndFieldName () 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	setElementLength (double length)
	Set 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
bool	isInsideTransverse (const Vector_t &r) const

Protected Attributes
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 Member Functions
void	calculateDfCoefficients ()
	ScalingFFAMagnet (const ScalingFFAMagnet &right)
ScalingFFAMagnet &	operator= (const ScalingFFAMagnet &rhs)

Private Attributes
PlanarArcGeometry	planarArcGeometry_m
BMultipoleField	dummy
size_t	maxOrder_m = 0
double	tanDelta_m = 0.
double	k_m = 0.
double	Bz_m = 0.
double	r0_m = 0.
double	rMin_m = 0.
double	rMax_m = 0.
double	phiStart_m = 0.
double	phiEnd_m = 0.
double	azimuthalExtent_m = 0.
double	verticalExtent_m = 0.
double	r0Sign_m = 0.0
Vector_t	centre_m
endfieldmodel::EndFieldModel *	endField_m = nullptr
std::string	endFieldName_m = ""
const double	fp_tolerance = 1e-18
std::vector< std::vector< double > >	dfCoefficients_m
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

Sector bending magnet with an FFA-style field index and spiral end shape

Note about placement and end field; in order to get a user-defined end field shape, we do a lookup from user defined end fields, which is pulled from the EndFieldModel object and done by setupEndField(). Because end fields tie into the geometry, this has to be done before placements; but it also needs to be done after parsing has finished. setupEndField() is called by e.g. ParallelCyclotronTracker just before the object is handed to OpalRing for placement.

Definition at line 41 of file ScalingFFAMagnet.h.

Constructor & Destructor Documentation

◆ ScalingFFAMagnet() [1/2]

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

explicit

Construct a new ScalingFFAMagnet

Parameters

name	User-defined name of the ScalingFFAMagnet

Definition at line 23 of file ScalingFFAMagnet.cpp.

References Component::Component(), dummy, endField_m, name, and planarArcGeometry_m.

Referenced by clone(), operator=(), and ScalingFFAMagnet().

Here is the call graph for this function:

◆ ~ScalingFFAMagnet()

ScalingFFAMagnet::~ScalingFFAMagnet ( )

Destructor - deletes map

Definition at line 48 of file ScalingFFAMagnet.cpp.

References endField_m.

◆ ScalingFFAMagnet() [2/2]

ScalingFFAMagnet::ScalingFFAMagnet ( const ScalingFFAMagnet & right )

private

Copy constructor

Definition at line 30 of file ScalingFFAMagnet.cpp.

References azimuthalExtent_m, Bz_m, centre_m, endfieldmodel::EndFieldModel::clone(), Component::Component(), dfCoefficients_m, dummy, endField_m, endFieldName_m, k_m, maxOrder_m, phiEnd_m, phiStart_m, planarArcGeometry_m, r0_m, r0Sign_m, Component::RefPartBunch_m, rMax_m, rMin_m, ScalingFFAMagnet(), tanDelta_m, and verticalExtent_m.

Here is the call graph for this function:

Member Function Documentation

◆ accept()

void ScalingFFAMagnet::accept ( BeamlineVisitor & visitor ) const

overridevirtual

Accept a beamline visitor

Implements ElementBase.

Definition at line 91 of file ScalingFFAMagnet.cpp.

References BeamlineVisitor::visitScalingFFAMagnet().

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 ScalingFFAMagnet::apply	(	const size_t &	i,
		const double &	t,
		Vector_t &	E,
		Vector_t &	B )

inlineoverridevirtual

Calculate the field at the position of the ith particle

Parameters

i	index of the particle event override; field is calculated at this position
t	time at which the field is to be calculated
E	calculated electric field - always 0 (no E-field)
B	calculated magnetic field

Returns: true if particle is outside the field map

Reimplemented from Component.

Definition at line 300 of file ScalingFFAMagnet.h.

References apply(), and Component::RefPartBunch_m.

Referenced by apply().

Here is the call graph for this function:

◆ apply() [2/2]

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

inlineoverridevirtual

Calculate the field at some arbitrary position

Parameters

R	position in the local coordinate system of the bend
P	not used
t	not used
E	not used
B	calculated magnetic field

Returns: true if particle is outside the field map, else false

Reimplemented from Component.

Definition at line 295 of file ScalingFFAMagnet.h.

References getFieldValue().

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 ScalingFFAMagnet::bends ( ) const

inlineoverridevirtual

Return true - ScalingFFAMagnet always bends the reference particle

Implements Component.

Definition at line 79 of file ScalingFFAMagnet.cpp.

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

◆ calculateDfCoefficients()

void ScalingFFAMagnet::calculateDfCoefficients ( )

private

Calculate the df coefficients, ready for field generation

Must be called following any update to the the field parameters, in order for correct field to be calculated.

Definition at line 160 of file ScalingFFAMagnet.cpp.

References dfCoefficients_m, k_m, maxOrder_m, and tanDelta_m.

Referenced by initialise().

◆ clone()

ScalingFFAMagnet * ScalingFFAMagnet::clone ( ) const

overridevirtual

Inheritable copy constructor

Implements ElementBase.

Definition at line 52 of file ScalingFFAMagnet.cpp.

References initialise(), and ScalingFFAMagnet().

Referenced by ParallelCyclotronTracker::visitScalingFFAMagnet().

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

overridevirtual

Finalise the ScalingFFAMagnet - sets bunch to nullptr

Implements Component.

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

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

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

◆ getAzimuthalExtent()

double ScalingFFAMagnet::getAzimuthalExtent ( ) const

inline

Get the maximum azimuthal displacement from \psi=0

Definition at line 223 of file ScalingFFAMagnet.h.

References azimuthalExtent_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:

◆ getCentre()

Vector_t ScalingFFAMagnet::getCentre ( ) const

inline

Get the centre of the sector

Definition at line 162 of file ScalingFFAMagnet.h.

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

◆ getDfCoefficients()

std::vector< std::vector< double > > ScalingFFAMagnet::getDfCoefficients ( )

inline

Return the calculated df coefficients

Definition at line 238 of file ScalingFFAMagnet.h.

References dfCoefficients_m.

◆ getDimensions()

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

inlineoverridevirtual

Not implemented

Implements Component.

Definition at line 120 of file ScalingFFAMagnet.h.

◆ getDipoleConstant()

double ScalingFFAMagnet::getDipoleConstant ( ) const

inline

Get the dipole constant B_0

Definition at line 150 of file ScalingFFAMagnet.h.

References Bz_m.

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

◆ getEndField()

endfieldmodel::EndFieldModel * ScalingFFAMagnet::getEndField ( ) const

inline

Get the fringe field

Returns the fringe field model; ScalingFFAMagnet retains ownership of the returned memory.

Definition at line 172 of file ScalingFFAMagnet.h.

References endField_m.

Referenced by OpalScalingFFAMagnet::update().

◆ getEndFieldName()

std::string ScalingFFAMagnet::getEndFieldName ( ) const

inline

Return the end field name.

Definition at line 258 of file ScalingFFAMagnet.h.

References endFieldName_m.

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

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

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

const EMField & ScalingFFAMagnet::getField ( ) const

overridevirtual

Return a dummy (0.) field value (what is this for?)

Implements Component.

Definition at line 62 of file ScalingFFAMagnet.cpp.

References dummy.

◆ getField() [2/2]

EMField & ScalingFFAMagnet::getField ( )

overridevirtual

Return a dummy (0.) field value (what is this for?)

Implements Component.

Definition at line 58 of file ScalingFFAMagnet.cpp.

References dummy.

◆ getFieldIndex()

double ScalingFFAMagnet::getFieldIndex ( ) const

inline

Get the field index k

Definition at line 144 of file ScalingFFAMagnet.h.

References k_m.

◆ getFieldValue()

bool ScalingFFAMagnet::getFieldValue	(	const Vector_t &	R,
		Vector_t &	B ) const

Calculate the field at some arbitrary position in cartesian coordinates

Parameters

R	position in the local coordinate system of the bend, in cartesian coordinates defined like (x, y, z)
B	calculated magnetic field defined like (Bx, By, Bz)

Returns: true if particle is outside the field map, else false

Definition at line 95 of file ScalingFFAMagnet.cpp.

References getFieldValueCylindrical(), r0_m, and r0Sign_m.

Referenced by apply().

Here is the call graph for this function:

◆ getFieldValueCylindrical()

bool ScalingFFAMagnet::getFieldValueCylindrical	(	const Vector_t &	R,
		Vector_t &	B ) const

Calculate the field at some arbitrary position in cylindrical coordinates

Parameters

R	position in the local coordinate system of the bend, in cylindrical polar coordinates defined like (r, z, phi)
B	calculated magnetic field defined like (Br, By, Bphi)

Returns: true if particle is outside the field map, else false

Definition at line 111 of file ScalingFFAMagnet.cpp.

References azimuthalExtent_m, Bz_m, dfCoefficients_m, endField_m, k_m, maxOrder_m, phiStart_m, r0_m, r0Sign_m, rMax_m, tanDelta_m, and verticalExtent_m.

Referenced by getFieldValue().

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

◆ getGeometry() [1/2]

const BGeometryBase & ScalingFFAMagnet::getGeometry ( ) const

overridevirtual

Return the cell geometry

Implements ElementBase.

Definition at line 87 of file ScalingFFAMagnet.cpp.

References planarArcGeometry_m.

◆ getGeometry() [2/2]

BGeometryBase & ScalingFFAMagnet::getGeometry ( )

overridevirtual

Return the cell geometry

Implements ElementBase.

Definition at line 83 of file ScalingFFAMagnet.cpp.

References planarArcGeometry_m.

◆ getMaxOrder()

size_t ScalingFFAMagnet::getMaxOrder ( ) const

inline

Get the maximum power of y modelled in the off-midplane expansion;

Definition at line 183 of file ScalingFFAMagnet.h.

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

◆ getPhiEnd()

double ScalingFFAMagnet::getPhiEnd ( ) const

inline

Get the offset of the magnet end from the start

Definition at line 199 of file ScalingFFAMagnet.h.

References phiEnd_m.

◆ getPhiStart()

double ScalingFFAMagnet::getPhiStart ( ) const

inline

Get the offset of the magnet centre from the start

Definition at line 191 of file ScalingFFAMagnet.h.

References phiStart_m.

Referenced by setupEndField().

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

◆ getR0()

double ScalingFFAMagnet::getR0 ( ) const

inline

Get the radius constant R_0

Definition at line 156 of file ScalingFFAMagnet.h.

References r0_m.

◆ getRequiredNumberOfTimeSteps()

int ElementBase::getRequiredNumberOfTimeSteps ( ) const

inlinevirtualinherited

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

Definition at line 603 of file ElementBase.h.

◆ getRMax()

double ScalingFFAMagnet::getRMax ( ) const

inline

Get the maximum radius

Definition at line 215 of file ScalingFFAMagnet.h.

References rMax_m.

◆ getRMin()

double ScalingFFAMagnet::getRMin ( ) const

inline

Get the maximum radius

Definition at line 207 of file ScalingFFAMagnet.h.

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

◆ getTanDelta()

double ScalingFFAMagnet::getTanDelta ( ) const

inline

Get tan delta - delta is the spiral angle

Definition at line 138 of file ScalingFFAMagnet.h.

References tanDelta_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:

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

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

◆ getVerticalExtent()

double ScalingFFAMagnet::getVerticalExtent ( ) const

inline

Get the maximum vertical displacement from the midplane

Definition at line 231 of file ScalingFFAMagnet.h.

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

void ScalingFFAMagnet::initialise ( )

Initialise the ScalingFFAMagnet

Sets up the field expansion and the geometry; call after changing any field parameters

Definition at line 66 of file ScalingFFAMagnet.cpp.

References calculateDfCoefficients().

Referenced by initialise().

Here is the call graph for this function:

◆ initialise() [2/2]

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

overridevirtual

Initialise the ScalingFFAMagnet

Parameters

bunch	the global bunch object
startField	not used
endField	not used

Implements Component.

Definition at line 70 of file ScalingFFAMagnet.cpp.

References initialise(), and Component::RefPartBunch_m.

Referenced by clone(), and OpalScalingFFAMagnet::update().

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.

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

◆ operator=()

ScalingFFAMagnet & ScalingFFAMagnet::operator= ( const ScalingFFAMagnet & rhs )

private

References ScalingFFAMagnet().

Here is the call graph for this function:

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

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

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

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

◆ setAzimuthalExtent()

void ScalingFFAMagnet::setAzimuthalExtent ( double azimuthalExtent )

inline

Set the maximum azimuthal displacement from \psi=0

Definition at line 227 of file ScalingFFAMagnet.h.

References azimuthalExtent_m.

Referenced by setupEndField(), and OpalScalingFFAMagnet::update().

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

◆ setCentre()

void ScalingFFAMagnet::setCentre ( Vector_t centre )

inline

Set the centre of the sector

Definition at line 165 of file ScalingFFAMagnet.h.

References centre_m.

Referenced by OpalScalingFFAMagnet::update().

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

◆ setDipoleConstant()

void ScalingFFAMagnet::setDipoleConstant ( double Bz )

inline

Set the dipole constant B_0

Definition at line 153 of file ScalingFFAMagnet.h.

References Bz_m.

Referenced by OpalScalingFFAMagnet::update().

◆ setElementLength()

void ElementBase::setElementLength ( double length )

inlinevirtualinherited

Set design length.

Reimplemented in MultipoleT.

Definition at line 419 of file ElementBase.h.

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

Referenced by Bend2D::initialise(), RBend3D::initialise(), RFCavity::initialise(), Solenoid::initialise(), TravelingWave::initialise(), MultipoleT::setElementLength(), SequenceMember::setLength(), OpalCavity::update(), OpalCCollimator::update(), OpalDrift::update(), OpalECollimator::update(), OpalFlexibleCollimator::update(), OpalHKicker::update(), OpalKicker::update(), OpalMonitor::update(), OpalMultipole::update(), OpalOctupole::update(), OpalPepperPot::update(), OpalProbe::update(), OpalQuadrupole::update(), OpalRBend3D::update(), OpalRCollimator::update(), OpalSeptum::update(), OpalSextupole::update(), OpalSlit::update(), OpalSolenoid::update(), OpalSource::update(), OpalStripper::update(), OpalTravelingWave::update(), OpalUndulator::update(), OpalVacuum::update(), and OpalVKicker::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().

◆ setEndField()

void ScalingFFAMagnet::setEndField ( endfieldmodel::EndFieldModel * endField )

Set the fringe field

endField: the new fringe field; ScalingFFAMagnet takes ownership of the memory associated with endField.

Definition at line 183 of file ScalingFFAMagnet.cpp.

References endField_m.

Referenced by OpalScalingFFAMagnet::OpalScalingFFAMagnet(), OpalScalingFFAMagnet::OpalScalingFFAMagnet(), and setupEndField().

◆ setEndFieldName()

void ScalingFFAMagnet::setEndFieldName ( std::string name )

inline

Set the end field name.

Called during parsing of the input file; OPAL looks for the endFieldName when setupEndField() is called.

Definition at line 255 of file ScalingFFAMagnet.h.

References endFieldName_m, and name.

Referenced by OpalScalingFFAMagnet::setupDefaultEndField(), and OpalScalingFFAMagnet::setupNamedEndField().

◆ setExitFaceSlope()

void Component::setExitFaceSlope ( const double & m )

inlineinherited

Definition at line 225 of file Component.h.

References exit_face_slope_m.

◆ setFieldIndex()

void ScalingFFAMagnet::setFieldIndex ( double k )

inline

Set the field index k

Definition at line 147 of file ScalingFFAMagnet.h.

References k_m.

Referenced by OpalScalingFFAMagnet::update().

◆ setFlagDeleteOnTransverseExit()

void ElementBase::setFlagDeleteOnTransverseExit ( bool flag = true )

inlineinherited

Definition at line 608 of file ElementBase.h.

References deleteOnTransverseExit_m.

Referenced by OpalElement::update().

◆ setMaxOrder()

void ScalingFFAMagnet::setMaxOrder ( size_t maxOrder )

inline

Set the maximum power of y modelled in the off-midplane expansion;

Definition at line 187 of file ScalingFFAMagnet.h.

References maxOrder_m.

Referenced by OpalScalingFFAMagnet::update().

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

◆ setPhiEnd()

void ScalingFFAMagnet::setPhiEnd ( double phiEnd )

inline

Set the offset of the magnet end from the start

Definition at line 203 of file ScalingFFAMagnet.h.

References phiEnd_m.

Referenced by setupEndField(), and OpalScalingFFAMagnet::update().

◆ setPhiStart()

void ScalingFFAMagnet::setPhiStart ( double phiStart )

inline

Set the offset of the magnet centre from the start

Definition at line 195 of file ScalingFFAMagnet.h.

References phiStart_m.

Referenced by setupEndField(), and OpalScalingFFAMagnet::update().

◆ setR0()

void ScalingFFAMagnet::setR0 ( double r0 )

inline

Set the radius constant R_0

Definition at line 159 of file ScalingFFAMagnet.h.

References r0_m, and r0Sign_m.

Referenced by OpalScalingFFAMagnet::update().

◆ setRMax()

void ScalingFFAMagnet::setRMax ( double rMax )

inline

Set the maximum radius

Definition at line 219 of file ScalingFFAMagnet.h.

References rMax_m.

Referenced by OpalScalingFFAMagnet::update().

◆ setRMin()

void ScalingFFAMagnet::setRMin ( double rMin )

inline

Set the maximum radius

Definition at line 211 of file ScalingFFAMagnet.h.

References rMin_m.

Referenced by OpalScalingFFAMagnet::update().

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

◆ setTanDelta()

void ScalingFFAMagnet::setTanDelta ( double tanDelta )

inline

Set tan delta - delta is the spiral angle

Definition at line 141 of file ScalingFFAMagnet.h.

References tanDelta_m.

Referenced by OpalScalingFFAMagnet::update().

◆ setupEndField()

void ScalingFFAMagnet::setupEndField ( )

setupEndField does some end field and geometry set-up

This is normally called just before the magnet is placed; can only set up the end field after everything has been parsed from input (otherwise OPAL may not know about an end field model).

sets PhiStart, PhiEnd, AzimuthalExtent and the end field model itself.

Definition at line 191 of file ScalingFFAMagnet.cpp.

References azimuthalExtent_m, endFieldName_m, endfieldmodel::EndFieldModel::getCentreLength(), endfieldmodel::EndFieldModel::getEndFieldModel(), endfieldmodel::EndFieldModel::getEndLength(), getPhiStart(), maxOrder_m, phiEnd_m, phiStart_m, planarArcGeometry_m, r0_m, endfieldmodel::EndFieldModel::rescale(), setAzimuthalExtent(), setEndField(), endfieldmodel::EndFieldModel::setMaximumDerivative(), setPhiEnd(), and setPhiStart().

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

Here is the call graph for this function:

◆ setVerticalExtent()

void ScalingFFAMagnet::setVerticalExtent ( double verticalExtent )

inline

Set the maximum vertical displacement from the midplane

Definition at line 235 of file ScalingFFAMagnet.h.

References verticalExtent_m.

Referenced by OpalScalingFFAMagnet::update().

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

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

◆ azimuthalExtent_m

double ScalingFFAMagnet::azimuthalExtent_m = 0.

private

Definition at line 285 of file ScalingFFAMagnet.h.

Referenced by getAzimuthalExtent(), getFieldValueCylindrical(), ScalingFFAMagnet(), setAzimuthalExtent(), and setupEndField().

◆ bgeometry_m

BoundaryGeometry* ElementBase::bgeometry_m

privateinherited

Definition at line 390 of file ElementBase.h.

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

◆ Bz_m

double ScalingFFAMagnet::Bz_m = 0.

private

Definition at line 279 of file ScalingFFAMagnet.h.

Referenced by getDipoleConstant(), getFieldValueCylindrical(), ScalingFFAMagnet(), and setDipoleConstant().

◆ centre_m

Vector_t ScalingFFAMagnet::centre_m

private

Definition at line 288 of file ScalingFFAMagnet.h.

Referenced by getCentre(), ScalingFFAMagnet(), and setCentre().

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

◆ dfCoefficients_m

std::vector<std::vector<double> > ScalingFFAMagnet::dfCoefficients_m

private

Definition at line 292 of file ScalingFFAMagnet.h.

Referenced by calculateDfCoefficients(), getDfCoefficients(), getFieldValueCylindrical(), and ScalingFFAMagnet().

◆ dummy

BMultipoleField ScalingFFAMagnet::dummy

private

Definition at line 274 of file ScalingFFAMagnet.h.

Referenced by getField(), getField(), ScalingFFAMagnet(), and ScalingFFAMagnet().

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

◆ endField_m

endfieldmodel::EndFieldModel* ScalingFFAMagnet::endField_m = nullptr

private

Definition at line 289 of file ScalingFFAMagnet.h.

Referenced by getEndField(), getFieldValueCylindrical(), ScalingFFAMagnet(), ScalingFFAMagnet(), setEndField(), and ~ScalingFFAMagnet().

◆ endFieldName_m

std::string ScalingFFAMagnet::endFieldName_m = ""

private

Definition at line 290 of file ScalingFFAMagnet.h.

Referenced by getEndFieldName(), ScalingFFAMagnet(), setEndFieldName(), and setupEndField().

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

◆ fp_tolerance

const double ScalingFFAMagnet::fp_tolerance = 1e-18

private

Definition at line 291 of file ScalingFFAMagnet.h.

◆ k_m

double ScalingFFAMagnet::k_m = 0.

private

Definition at line 278 of file ScalingFFAMagnet.h.

Referenced by calculateDfCoefficients(), getFieldIndex(), getFieldValueCylindrical(), ScalingFFAMagnet(), and setFieldIndex().

◆ maxOrder_m

size_t ScalingFFAMagnet::maxOrder_m = 0

private

Definition at line 276 of file ScalingFFAMagnet.h.

Referenced by calculateDfCoefficients(), getFieldValueCylindrical(), getMaxOrder(), ScalingFFAMagnet(), setMaxOrder(), and setupEndField().

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

◆ phiEnd_m

double ScalingFFAMagnet::phiEnd_m = 0.

private

Definition at line 284 of file ScalingFFAMagnet.h.

Referenced by getPhiEnd(), ScalingFFAMagnet(), setPhiEnd(), and setupEndField().

◆ phiStart_m

double ScalingFFAMagnet::phiStart_m = 0.

private

Definition at line 283 of file ScalingFFAMagnet.h.

Referenced by getFieldValueCylindrical(), getPhiStart(), ScalingFFAMagnet(), setPhiStart(), and setupEndField().

◆ planarArcGeometry_m

PlanarArcGeometry ScalingFFAMagnet::planarArcGeometry_m

private

Definition at line 273 of file ScalingFFAMagnet.h.

Referenced by getGeometry(), getGeometry(), ScalingFFAMagnet(), ScalingFFAMagnet(), and setupEndField().

◆ positionIsFixed

bool ElementBase::positionIsFixed

privateinherited

Definition at line 394 of file ElementBase.h.

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

◆ r0_m

double ScalingFFAMagnet::r0_m = 0.

private

Definition at line 280 of file ScalingFFAMagnet.h.

Referenced by getFieldValue(), getFieldValueCylindrical(), getR0(), ScalingFFAMagnet(), setR0(), and setupEndField().

◆ r0Sign_m

double ScalingFFAMagnet::r0Sign_m = 0.0

private

Definition at line 287 of file ScalingFFAMagnet.h.

Referenced by getFieldValue(), getFieldValueCylindrical(), ScalingFFAMagnet(), and setR0().

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

◆ rMax_m

double ScalingFFAMagnet::rMax_m = 0.

private

Definition at line 282 of file ScalingFFAMagnet.h.

Referenced by getFieldValueCylindrical(), getRMax(), ScalingFFAMagnet(), and setRMax().

◆ rMin_m

double ScalingFFAMagnet::rMin_m = 0.

private

Definition at line 281 of file ScalingFFAMagnet.h.

Referenced by getRMin(), ScalingFFAMagnet(), and setRMin().

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

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

◆ tanDelta_m

double ScalingFFAMagnet::tanDelta_m = 0.

private

Definition at line 277 of file ScalingFFAMagnet.h.

Referenced by calculateDfCoefficients(), getFieldValueCylindrical(), getTanDelta(), ScalingFFAMagnet(), and setTanDelta().

◆ userAttribs

AttributeSet ElementBase::userAttribs

privateinherited

Definition at line 386 of file ElementBase.h.

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

◆ verticalExtent_m

double ScalingFFAMagnet::verticalExtent_m = 0.

private

Definition at line 286 of file ScalingFFAMagnet.h.

Referenced by getFieldValueCylindrical(), getVerticalExtent(), ScalingFFAMagnet(), and setVerticalExtent().

◆ 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 Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ScalingFFAMagnet() [1/2]

◆ ~ScalingFFAMagnet()

◆ ScalingFFAMagnet() [2/2]

Member Function Documentation

◆ accept()

◆ addReference()

◆ apply() [1/2]

◆ apply() [2/2]

◆ applyToReferenceParticle()

◆ bends()

◆ Bfield() [1/2]

◆ Bfield() [2/2]

◆ calculateDfCoefficients()

◆ clone()

◆ copyStructure()

◆ EBfield() [1/2]

◆ EBfield() [2/2]

◆ Efield() [1/2]

◆ Efield() [2/2]

◆ finalise()

◆ fixPosition()

◆ getAperture()

◆ getArcLength()

◆ getAttribute()

◆ getAzimuthalExtent()

◆ getBoundaryGeometry()

◆ getBoundingBoxInLabCoords()

◆ getCentre()

◆ getChannel()

◆ getConstChannel()

◆ getCSTrafoGlobal2Local()

◆ getDesign()

◆ getDesignEnergy()

◆ getDfCoefficients()

◆ getDimensions()

◆ getDipoleConstant()

◆ getEdgeToBegin()

◆ getEdgeToEnd()

◆ getElementDimensions()

◆ getElementLength()

◆ getElementPosition()

◆ getEndField()

◆ getEndFieldName()

◆ getEntrance()

◆ getEntranceFrame()

◆ getEntrancePatch()

◆ getExit()

◆ getExitFrame()

◆ getExitPatch()

◆ getField() [1/2]

◆ getField() [2/2]

◆ getFieldIndex()

◆ getFieldValue()

◆ getFieldValueCylindrical()

◆ getFlagDeleteOnTransverseExit()

◆ getGeometry() [1/2]

◆ getGeometry() [2/2]

◆ getMaxOrder()

◆ getMisalignment() [1/2]

◆ getMisalignment() [2/2]

◆ getName()

◆ getOrigin()

◆ getOutputFN()

◆ getParticleMatterInteraction()

◆ getPhiEnd()

◆ getPhiStart()

◆ getPotential()

◆ getR0()

◆ getRequiredNumberOfTimeSteps()

◆ getRMax()