Generates a field like Ey = E0*a(t)*y^{2n+1} g_n(z) sin{f(t)*t-q(t)} Ez = E0*a(t)*y^{2n} f_n(z) sin{f(t)*t-q(t)} Bx = B0*a(t)*y^{2n+1} h_n(z) cos{f(t)*t-q(t)} where E0, is a user-defined field and B0 is the corresponding magnetic field magnitude; f_n is a user-defined axial field dependence and g_n, h_n are the corresponding off-axis field dependencies. More...

#include <VariableRFCavityFringeField.h>

Inheritance diagram for VariableRFCavityFringeField:

Collaboration diagram for VariableRFCavityFringeField:

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

	VariableRFCavityFringeField (const VariableRFCavityFringeField &)
	Copy Constructor; performs deepcopy on time-dependence models. More...

	VariableRFCavityFringeField ()
	Default constructor. More...

VariableRFCavityFringeField &	operator= (const VariableRFCavityFringeField &)
	Assignment operator; performs deepcopy on time-dependence models. More...

virtual	~VariableRFCavityFringeField ()
	Destructor does nothing. More...

virtual void	accept (BeamlineVisitor &) const override
	Apply visitor to RFCavity. More...

void	initialise () const
	Lookup the time dependencies and update. More...

virtual ElementBase *	clone () const override
	Inheritable deepcopy method. More...

virtual bool	apply (const size_t &i, const double &t, Vector_t &E, Vector_t &B) override
	Calculate the field at the position of the i^th particle. More...

virtual bool	apply (const Vector_t &R, const Vector_t &P, const double &t, Vector_t &E, Vector_t &B) override
	Calculate the field at a given position. More...

virtual bool	applyToReferenceParticle (const Vector_t &R, const Vector_t &P, const double &t, Vector_t &E, Vector_t &B) override
	Calculate the field at a given position. More...

virtual void	setEndField (std::shared_ptr< endfieldmodel::EndFieldModel > endField)
	Set the endFieldModel. More...

virtual std::shared_ptr< endfieldmodel::EndFieldModel >	getEndField () const
	Get the endFieldModel. More...

virtual void	initialise (PartBunchBase< double, 3 > *bunch, double &startField, double &endField) override
	Initialise ready for tracking. More...

virtual void	setCavityCentre (double zCentre)
	Get the offset of centre of the cavity field from the element start in metres. More...

virtual double	getCavityCentre () const
	Set the offset of centre of the cavity field from the element start in metres. More...

virtual void	setMaxOrder (size_t maxOrder)
	Set the maximum y power. More...

virtual size_t	getMaxOrder () const
	Get the maximum y power that will be used in field calculations. More...

void	initialiseCoefficients ()
	Set the coefficients for calculating the field expansion. More...

void	printCoefficients (std::ostream &out) const
	Print the coefficients to ostream out. More...

std::vector< std::vector< double > >	getEzCoefficients () const
	Get the coefficients for Ez. More...

std::vector< std::vector< double > >	getEyCoefficients () const
	Get the coefficients for Ey. More...

std::vector< std::vector< double > >	getBxCoefficients () const
	Get the coefficients for Bx. More...

virtual void	finalise () override
	Finalise following tracking. More...

virtual bool	bends () const override

virtual void	getDimensions (double &, double &) const override
	Not used (does nothing) More...

virtual double	getAmplitude (double time) const
	Get the amplitude at a given time. More...

virtual double	getFrequency (double time) const
	Get the frequency at a given time. More...

virtual double	getPhase (double time) const
	Get the phase at a given time. More...

virtual double	getHeight () const

virtual double	getWidth () const

virtual double	getLength () const

virtual void	setHeight (double fullHeight)
	Set the full height of the cavity. More...

virtual void	setWidth (double fullWidth)
	Set the full width of the cavity. More...

virtual void	setLength (double length)
	Set the length of the cavity. More...

virtual std::shared_ptr< AbstractTimeDependence >	getAmplitudeModel () const

virtual std::shared_ptr< AbstractTimeDependence >	getPhaseModel () const

virtual std::shared_ptr< AbstractTimeDependence >	getFrequencyModel () const

virtual void	setAmplitudeModel (std::shared_ptr< AbstractTimeDependence > time_dep)
	Set the amplitude (field gradient) time dependence. More...

virtual void	setPhaseModel (std::shared_ptr< AbstractTimeDependence > time_dep)
	Set the phase time dependence. More...

virtual void	setFrequencyModel (std::shared_ptr< AbstractTimeDependence > time_dep)
	Set the frequency time dependence. More...

virtual void	setAmplitudeName (const std::string &amplitude)
	Set the amplitude time dependence name. More...

virtual void	setPhaseName (const std::string &phase)
	Set the phase time dependence name. More...

virtual void	setFrequencyName (const std::string &frequency)
	Set the frequency time dependence name. More...

virtual StraightGeometry &	getGeometry () override
	Set the cavity geometry. More...

virtual const StraightGeometry &	getGeometry () const override

virtual EMField &	getField () override
	Not implemented. More...

virtual const EMField &	getField () const override
	Not implemented. More...

EVector	Efield (const Point3D &P) const
	Return the field in a point. More...

EVector	Efield (const Point3D &P, double t) const
	Return the field in a point. More...

BVector	Bfield (const Point3D &P) const
	Return the field in a point. More...

BVector	Bfield (const Point3D &P, double t) const
	Return the field in a point. More...

EBVectors	EBfield (const Point3D &P) const
	Return the field in a point. More...

EBVectors	EBfield (const Point3D &P, double t) const
	Return the field in a point. More...

virtual bool	getPotential (const Vector_t &, const double &, Vector_t &, double &)
	Calculate the four-potential at some position relative to the component. More...

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

virtual const ElementBase &	getDesign () const
	Return design element. More...

virtual void	trackBunch (PartBunchBase< double, 3 > *bunch, const PartData &, bool revBeam, bool revTrack) const
	Track particle bunch. More...

virtual void	trackMap (FVps< double, 6 > &map, const PartData &, bool revBeam, bool revTrack) const
	Track a map. More...

void	setExitFaceSlope (const double &)

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

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

std::string	getTypeString () const

virtual double	getArcLength () const
	Get arc length. More...

virtual double	getElementLength () const
	Get design length. More...

virtual void	setElementLength (double length)
	Set design length. More...

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

virtual double	getOrigin () const
	Get origin position. More...

virtual double	getEntrance () const
	Get entrance position. More...

virtual double	getExit () const
	Get exit position. More...

virtual Euclid3D	getTransform (double fromS, double toS) const
	Get transform. More...

virtual Euclid3D	getTransform (double s) const
	Get transform. More...

virtual Euclid3D	getTotalTransform () const
	Get transform. More...

virtual Euclid3D	getEntranceFrame () const
	Get transform. More...

virtual Euclid3D	getExitFrame () const
	Get transform. More...

virtual Euclid3D	getEntrancePatch () const
	Get patch. More...

virtual Euclid3D	getExitPatch () const
	Get patch. More...

virtual double	getAttribute (const std::string &aKey) const
	Get attribute value. More...

virtual bool	hasAttribute (const std::string &aKey) const
	Test for existence of an attribute. More...

virtual void	removeAttribute (const std::string &aKey)
	Remove an existing attribute. More...

virtual void	setAttribute (const std::string &aKey, double val)
	Set value of an attribute. More...

virtual Channel *	getChannel (const std::string &aKey, bool create=false)
	Construct a read/write channel. More...

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

virtual ElementBase *	copyStructure ()
	Make a structural copy. More...

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

virtual void	makeSharable ()
	Set sharable flag. More...

bool	update (const AttributeSet &)
	Update element. More...

virtual void	setBoundaryGeometry (BoundaryGeometry *geo)
	attach a boundary geometry field to the element More...

virtual BoundaryGeometry *	getBoundaryGeometry () const
	return the attached boundary geometrt object if there is any More...

virtual bool	hasBoundaryGeometry () const

virtual void	setWake (WakeFunction *wf)
	attach a wake field to the element More...

virtual WakeFunction *	getWake () const
	return the attached wake object if there is any More...

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

double	getRotationAboutZ () const

virtual BoundingBox	getBoundingBoxInLabCoords () const

virtual int	getRequiredNumberOfTimeSteps () const

void	setOutputFN (std::string fn)
	Set output filename. More...

std::string	getOutputFN () const
	Get output filename. More...

void	setFlagDeleteOnTransverseExit (bool=true)

bool	getFlagDeleteOnTransverseExit () const

int	addReference () const
	Increment reference count. More...

int	removeReference () const
	Decrement the reference count. More...

bool	isShared () const
	Test for sharing. More...


void	setElementPosition (double elemedge)
	Access to ELEMEDGE attribute. More...

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	zCentre_m

size_t	maxOrder_m

std::shared_ptr< endfieldmodel::EndFieldModel >	endField_m

std::vector< std::vector< double > >	f_m

std::vector< std::vector< double > >	g_m

std::vector< std::vector< double > >	h_m

std::shared_ptr< AbstractTimeDependence >	phaseTD_m

std::shared_ptr< AbstractTimeDependence >	amplitudeTD_m

std::shared_ptr< AbstractTimeDependence >	frequencyTD_m

std::string	phaseName_m

std::string	amplitudeName_m

std::string	frequencyName_m

double	halfWidth_m

double	halfHeight_m

double	length_m

TimeDependenceCache	frequencyCache_m

StraightGeometry	geometry
	The cavity's geometry. More...

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

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
	The name of the outputfile. More...

bool	deleteOnTransverseExit_m = true

int	refCount


double	elementPosition_m
	ELEMEDGE attribute. More...

bool	elemedgeSet_m

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

Detailed Description

Generates a field like Ey = E0*a(t)*y^{2n+1} g_n(z) sin{f(t)*t-q(t)} Ez = E0*a(t)*y^{2n} f_n(z) sin{f(t)*t-q(t)} Bx = B0*a(t)*y^{2n+1} h_n(z) cos{f(t)*t-q(t)} where E0, is a user-defined field and B0 is the corresponding magnetic field magnitude; f_n is a user-defined axial field dependence and g_n, h_n are the corresponding off-axis field dependencies.

a(t), f(t), q(t) are time dependent amplitude, frequency, phase respectively; it is assumed that these quantities vary sufficiently slowly that Maxwell is satisfied.

Inherits from VariableRFCavity; inheritance is used here to share code from VariableRFCavity.

Set/get methods use metres

Field units are kG and GV/mm

Definition at line 50 of file VariableRFCavityFringeField.h.

Constructor & Destructor Documentation

◆ VariableRFCavityFringeField() [1/3]

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

explicit

Constructor with given name.

Definition at line 29 of file VariableRFCavityFringeField.cpp.

References initNull().

Here is the call graph for this function:

◆ VariableRFCavityFringeField() [2/3]

VariableRFCavityFringeField::VariableRFCavityFringeField ( const VariableRFCavityFringeField & var )

Copy Constructor; performs deepcopy on time-dependence models.

Definition at line 37 of file VariableRFCavityFringeField.cpp.

References initNull().

Here is the call graph for this function:

◆ VariableRFCavityFringeField() [3/3]

VariableRFCavityFringeField::VariableRFCavityFringeField ( )

Default constructor.

Definition at line 33 of file VariableRFCavityFringeField.cpp.

References initNull().

Referenced by clone().

Here is the call graph for this function:

◆ ~VariableRFCavityFringeField()

VariableRFCavityFringeField::~VariableRFCavityFringeField ( )

virtual

Destructor does nothing.

The shared_ptrs will self-destruct when reference count goes to 0

Definition at line 55 of file VariableRFCavityFringeField.cpp.

Member Function Documentation

◆ accept()

void VariableRFCavityFringeField::accept ( BeamlineVisitor & visitor ) const

overridevirtual

Apply visitor to RFCavity.

The RF cavity finds the "time dependence" models by doing a string lookup against a list held by AbstractTimeDependence at accept time.

Reimplemented from VariableRFCavity.

Definition at line 69 of file VariableRFCavityFringeField.cpp.

References initialise(), initialiseCoefficients(), and BeamlineVisitor::visitVariableRFCavity().

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 RCObject::refCount.

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

◆ apply() [1/2]

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

overridevirtual

Calculate the field at the position of the i^th particle.

Parameters

i	indexes the particle whose field we need
t	the time at which the field is calculated
E	return value with electric field strength
B	return value with magnetic field strength

Returns: True if particle is outside the boundaries; else False

Reimplemented from VariableRFCavity.

Definition at line 139 of file VariableRFCavityFringeField.cpp.

References apply(), PartBunchBase< T, Dim >::P, PartBunchBase< T, Dim >::R, and Component::RefPartBunch_m.

Referenced by apply(), and applyToReferenceParticle().

Here is the call graph for this function:

◆ apply() [2/2]

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

overridevirtual

Calculate the field at a given position.

Parameters

R	the position at which the field is calculated
P	the momentum (not used)
t	the time at which the field is calculated
E	return value; filled with electric field strength
B	return value; filled with magnetic field strength

Returns: True if particle is outside the boundaries; else False

Reimplemented from VariableRFCavity.

Definition at line 77 of file VariableRFCavityFringeField.cpp.

References abs(), VariableRFCavity::amplitudeTD_m, cos(), endField_m, f_m, VariableRFCavity::frequencyTD_m, g_m, h_m, VariableRFCavity::halfHeight_m, VariableRFCavity::halfWidth_m, Units::Hz2GHz, VariableRFCavity::length_m, maxOrder_m, Units::MHz2Hz, Hypervolume::n, VariableRFCavity::phaseTD_m, Attrib::Distribution::R, sin(), Units::T2kG, Physics::two_pi, and zCentre_m.

Here is the call graph for this function:

◆ applyToReferenceParticle()

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

overridevirtual

Calculate the field at a given position.

This is identical to "apply".

Parameters

R	the position at which the field is calculated
P	the momentum (not used)
t	the time at which the field is calculated
E	return value; filled with electric field strength
B	return value; filled with magnetic field strength

Returns: True if particle is outside the boundaries; else False

Reimplemented from VariableRFCavity.

Definition at line 144 of file VariableRFCavityFringeField.cpp.

References apply(), and Attrib::Distribution::R.

Here is the call graph for this function:

◆ bends()

virtual bool VariableRFCavity::bends ( ) const

inlineoverridevirtualinherited

Returns: false (cavity does not bend the trajectory)

Implements Component.

Definition at line 119 of file VariableRFCavity.h.

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

Here is the call graph for this function:

◆ Bfield() [2/2]

BVector Component::Bfield	(	const Point3D &	P,
		double	t
	)		const

inlineinherited

Return the field in a point.

Definition at line 208 of file Component.h.

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

Here is the call graph for this function:

◆ clone()

ElementBase * VariableRFCavityFringeField::clone ( ) const

overridevirtual

Inheritable deepcopy method.

Reimplemented from VariableRFCavity.

Definition at line 58 of file VariableRFCavityFringeField.cpp.

References VariableRFCavityFringeField().

Here is the call graph for this function:

◆ copyStructure()

ElementBase * ElementBase::copyStructure ( )

virtualinherited

Make a structural copy.

Reimplemented in TBeamline< T >.

Definition at line 244 of file ElementBase.cpp.

References ElementBase::clone(), and ElementBase::isSharable().

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

Here is the call graph for this function:

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

Here is the call graph for this function:

◆ EBfield() [2/2]

EBVectors Component::EBfield	(	const Point3D &	P,
		double	t
	)		const

inlineinherited

Return the field in a point.

Definition at line 214 of file Component.h.

References EMField::EBfield(), and Component::getField().

Here is the call graph for this function:

◆ Efield() [1/2]

EVector Component::Efield ( const Point3D & P ) const

inlineinherited

Return the field in a point.

Definition at line 199 of file Component.h.

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

Here is the call graph for this function:

◆ Efield() [2/2]

EVector Component::Efield	(	const Point3D &	P,
		double	t
	)		const

inlineinherited

Return the field in a point.

Definition at line 205 of file Component.h.

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

Here is the call graph for this function:

◆ finalise()

void VariableRFCavity::finalise ( )

overridevirtualinherited

Finalise following tracking.

Just sets RefPartBunch_m to nullptr

Implements Component.

Definition at line 163 of file VariableRFCavity.cpp.

References Component::RefPartBunch_m.

◆ fixPosition()

void ElementBase::fixPosition ( )

inlineinherited

Definition at line 551 of file ElementBase.h.

References ElementBase::positionIsFixed.

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

◆ getAmplitude()

double VariableRFCavity::getAmplitude ( double time ) const

inlinevirtualinherited

Get the amplitude at a given time.

Parameters

time	the time at which the amplitude is calculated

Returns: the RF field gradient.

Definition at line 229 of file VariableRFCavity.h.

References VariableRFCavity::amplitudeTD_m.

◆ getAmplitudeModel()

std::shared_ptr< AbstractTimeDependence > VariableRFCavity::getAmplitudeModel ( ) const

virtualinherited

Returns: shared_ptr to the amplitude (field gradient) time dependence

Definition at line 83 of file VariableRFCavity.cpp.

References VariableRFCavity::amplitudeTD_m.

◆ getAperture()

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

inlineinherited

Definition at line 525 of file ElementBase.h.

References ElementBase::aperture_m.

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

◆ getArcLength()

double ElementBase::getArcLength ( ) const

inlinevirtualinherited

Get arc length.

Reimplemented in MarkerRep, and TBeamline< T >.

Definition at line 411 of file ElementBase.h.

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

Referenced by BeamlineGeometry::getArcLength(), and TBeamline< T >::getTransform().

Here is the call graph for this function:

◆ getAttribute()

double ElementBase::getAttribute ( const std::string & aKey ) const

virtualinherited

Get attribute value.

Definition at line 187 of file ElementBase.cpp.

References ElementBase::getConstChannel().

Here is the call graph for this function:

◆ 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 ElementBase::bgeometry_m.

◆ getBoundingBoxInLabCoords()

BoundingBox ElementBase::getBoundingBoxInLabCoords ( ) const

virtualinherited

Reimplemented in Bend2D.

Definition at line 313 of file ElementBase.cpp.

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

Here is the call graph for this function:

◆ getBxCoefficients()

std::vector< std::vector< double > > VariableRFCavityFringeField::getBxCoefficients ( ) const

inline

Get the coefficients for Bx.

Definition at line 209 of file VariableRFCavityFringeField.h.

References h_m.

◆ getCavityCentre()

double VariableRFCavityFringeField::getCavityCentre ( ) const

inlinevirtual

Set the offset of centre of the cavity field from the element start in metres.

Definition at line 180 of file VariableRFCavityFringeField.h.

References zCentre_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 >, SolenoidRep, SourceRep, StripperRep, TravelingWaveRep, UndulatorRep, VacuumRep, XCorrectorRep, and YCorrectorRep.

Definition at line 228 of file ElementBase.cpp.

References AttributeSet::getChannel(), and ElementBase::userAttribs.

Here is the call graph for this function:

◆ getConstChannel()

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

virtualinherited

Construct a read-only channel.

Definition at line 233 of file ElementBase.cpp.

References ElementBase::getChannel().

Referenced by ElementBase::getAttribute(), and ElementBase::hasAttribute().

Here is the call graph for this function:

◆ getCSTrafoGlobal2Local()

CoordinateSystemTrafo ElementBase::getCSTrafoGlobal2Local ( ) const

inlineinherited

Definition at line 498 of file ElementBase.h.

References ElementBase::csTrafoGlobal2Local_m.

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

◆ getDesign()

const ElementBase & Component::getDesign ( ) const

virtualinherited

Return design element.

Definition at line 67 of file Component.cpp.

◆ getDesignEnergy()

double Component::getDesignEnergy ( ) const

inlinevirtualinherited

Reimplemented in BendBase, and RFCavity.

Definition at line 231 of file Component.h.

◆ getDimensions()

virtual void VariableRFCavity::getDimensions	(	double &	,
		double &
	)		const

inlineoverridevirtualinherited

Not used (does nothing)

Implements Component.

Definition at line 122 of file VariableRFCavity.h.

◆ getEdgeToBegin()

CoordinateSystemTrafo ElementBase::getEdgeToBegin ( ) const

inlinevirtualinherited

Reimplemented in RFCavity, Solenoid, and TravelingWave.

Definition at line 503 of file ElementBase.h.

Referenced by ElementBase::getBoundingBoxInLabCoords(), Bend2D::getBoundingBoxInLabCoords(), and ElementBase::isInsideTransverse().

◆ getEdgeToEnd()

CoordinateSystemTrafo ElementBase::getEdgeToEnd ( ) const

inlinevirtualinherited

Reimplemented in Bend2D, RFCavity, Solenoid, and TravelingWave.

Definition at line 511 of file ElementBase.h.

References ElementBase::getElementLength().

Referenced by ElementBase::getBoundingBoxInLabCoords().

Here is the call graph for this function:

◆ getElementDimensions()

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

inlinevirtualinherited

Reimplemented in RFCavity, TravelingWave, and Solenoid.

Definition at line 174 of file ElementBase.h.

References begin(), end(), and ElementBase::getElementLength().

Referenced by MeshGenerator::add().

Here is the call graph for this function:

◆ getElementLength()

double ElementBase::getElementLength ( ) const

inlinevirtualinherited

Get design length.

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

Definition at line 415 of file ElementBase.h.

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

Referenced by ScatteringPhysics::addBackToBunch(), Undulator::apply(), Multipole::apply(), Component::apply(), Corrector::apply(), Solenoid::apply(), Component::applyToReferenceParticle(), Multipole::applyToReferenceParticle(), Solenoid::applyToReferenceParticle(), Vacuum::checkPoint(), ScatteringPhysics::copyFromBunch(), RBend::findChordLength(), SBend::findChordLength(), Corrector::getDimensions(), CCollimator::getDimensions(), Degrader::getDimensions(), Drift::getDimensions(), FlexibleCollimator::getDimensions(), Multipole::getDimensions(), RBend3D::getDimensions(), Solenoid::getDimensions(), Vacuum::getDimensions(), ElementBase::getEdgeToEnd(), Solenoid::getEdgeToEnd(), ElementBase::getElementDimensions(), Solenoid::getElementDimensions(), BeamlineGeometry::getElementLength(), RFCavity::getElementLength(), Corrector::initialise(), Degrader::initialise(), Drift::initialise(), FlexibleCollimator::initialise(), Multipole::initialise(), RBend3D::initialise(), Solenoid::initialise(), Source::initialise(), Vacuum::initialise(), ElementBase::isInside(), Degrader::isInside(), Monitor::isInside(), Multipole::isInside(), ElementBase::isInsideTransverse(), FlexibleCollimator::isStopped(), ScatteringPhysics::setTimeStepForLeavingParticles(), Bend2D::setupDefaultFieldMap(), 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 ElementBase::elemedgeSet_m, ElementBase::elementPosition_m, and ElementBase::getName().

Here is the call graph for this function:

◆ getEndField()

std::shared_ptr< endfieldmodel::EndFieldModel > VariableRFCavityFringeField::getEndField ( ) const

inlinevirtual

Get the endFieldModel.

Returns: the endFieldModel; VariableRFCavityFringe retains ownership of the memory allocated to the endFieldModel.

Definition at line 197 of file VariableRFCavityFringeField.h.

References endField_m.

◆ getEntrance()

double ElementBase::getEntrance ( ) const

inlinevirtualinherited

Get entrance position.

Reimplemented in TBeamline< T >.

Definition at line 427 of file ElementBase.h.

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

Referenced by BeamlineGeometry::getEntrance().

Here is the call graph for this function:

◆ getEntranceFrame()

Euclid3D ElementBase::getEntranceFrame ( ) const

inlinevirtualinherited

Get transform.

Reimplemented in TBeamline< T >.

Definition at line 447 of file ElementBase.h.

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

Referenced by BeamlineGeometry::getEntranceFrame().

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 ElementBase::getGeometry().

Here is the call graph for this function:

◆ getExit()

double ElementBase::getExit ( ) const

inlinevirtualinherited

Get exit position.

Reimplemented in TBeamline< T >.

Definition at line 431 of file ElementBase.h.

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

Referenced by BeamlineGeometry::getExit().

Here is the call graph for this function:

◆ getExitFrame()

Euclid3D ElementBase::getExitFrame ( ) const

inlinevirtualinherited

Get transform.

Reimplemented in TBeamline< T >.

Definition at line 451 of file ElementBase.h.

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

Referenced by BeamlineGeometry::getExitFrame().

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 ElementBase::getGeometry().

Here is the call graph for this function:

◆ getEyCoefficients()

std::vector< std::vector< double > > VariableRFCavityFringeField::getEyCoefficients ( ) const

inline

Get the coefficients for Ey.

Definition at line 205 of file VariableRFCavityFringeField.h.

References g_m.

◆ getEzCoefficients()

std::vector< std::vector< double > > VariableRFCavityFringeField::getEzCoefficients ( ) const

inline

Get the coefficients for Ez.

Definition at line 201 of file VariableRFCavityFringeField.h.

References f_m.

◆ getField() [1/2]

const EMField & VariableRFCavity::getField ( ) const

overridevirtualinherited

Not implemented.

Implements Component.

Definition at line 121 of file VariableRFCavity.cpp.

◆ getField() [2/2]

EMField & VariableRFCavity::getField ( )

overridevirtualinherited

Not implemented.

Implements Component.

Definition at line 116 of file VariableRFCavity.cpp.

◆ getFlagDeleteOnTransverseExit()

bool ElementBase::getFlagDeleteOnTransverseExit ( ) const

inlineinherited

Definition at line 614 of file ElementBase.h.

References ElementBase::deleteOnTransverseExit_m.

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

◆ getFrequency()

double VariableRFCavity::getFrequency ( double time ) const

inlinevirtualinherited

Get the frequency at a given time.

Parameters

time	the time at which the frequency is calculated

Returns: the RF cavity frequency.

Definition at line 237 of file VariableRFCavity.h.

References VariableRFCavity::frequencyTD_m.

◆ getFrequencyModel()

std::shared_ptr< AbstractTimeDependence > VariableRFCavity::getFrequencyModel ( ) const

virtualinherited

Returns: shared_ptr to the frequency

Definition at line 91 of file VariableRFCavity.cpp.

References VariableRFCavity::frequencyTD_m.

◆ getGeometry() [1/2]

const StraightGeometry & VariableRFCavity::getGeometry ( ) const

overridevirtualinherited

Returns: the cavity geometry

Implements ElementBase.

Definition at line 112 of file VariableRFCavity.cpp.

References VariableRFCavity::geometry.

◆ getGeometry() [2/2]

StraightGeometry & VariableRFCavity::getGeometry ( )

overridevirtualinherited

Set the cavity geometry.

Implements ElementBase.

Definition at line 108 of file VariableRFCavity.cpp.

References VariableRFCavity::geometry.

◆ getHeight()

double VariableRFCavity::getHeight ( ) const

inlinevirtualinherited

Returns: the full height of the cavity

Definition at line 241 of file VariableRFCavity.h.

References VariableRFCavity::halfHeight_m.

◆ getLength()

double VariableRFCavity::getLength ( ) const

inlinevirtualinherited

Returns: the length of the cavity

Definition at line 249 of file VariableRFCavity.h.

References VariableRFCavity::length_m.

◆ getMaxOrder()

size_t VariableRFCavityFringeField::getMaxOrder ( ) const

inlinevirtual

Get the maximum y power that will be used in field calculations.

Definition at line 193 of file VariableRFCavityFringeField.h.

References maxOrder_m.

◆ getMisalignment() [1/2]

CoordinateSystemTrafo ElementBase::getMisalignment ( ) const

inlineinherited

Definition at line 541 of file ElementBase.h.

References ElementBase::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 ElementBase::elementID.

Referenced by Ring::appendElement(), Cyclotron::apply(), Ring::apply(), Bend2D::calculateRefTrajectory(), OutputPlane::checkOne(), Vacuum::checkPressure(), Stripper::doCheck(), CCollimator::doFinalise(), Stripper::doFinalise(), OutputPlane::doGoOffline(), Probe::doGoOffline(), OutputPlane::doInitialise(), PlaceRep::enter(), Cyclotron::finalise(), Degrader::finalise(), FlexibleCollimator::finalise(), Vacuum::finalise(), PyOpal::Field::getElementName(), ElementBase::getElementPosition(), RFCavity::getMomentaKick(), BeamStrippingPhysics::getName(), ScatteringPhysics::getName(), Bend2D::getOutline(), ElementBase::getOutputFN(), CavityAutophaser::getPhaseAtMaxEnergy(), Selector::handleElement(), Ring::initialise(), Bend2D::initialise(), RBend3D::initialise(), RFCavity::initialise(), Solenoid::initialise(), CSRIGFWakeFunction::initialize(), CSRWakeFunction::initialize(), OpalWake::initWakefunction(), PlaceRep::leave(), operator<<(), Offset::operator=(), VariableRFCavity::operator=(), operator==(), Line::parse(), Vacuum::print(), BeamStrippingPhysics::print(), ScatteringPhysics::print(), Sequence::print(), ParticleMatterInteraction::print(), Bend2D::readFieldMap(), PyOpal::PyLine_< C >::registerObject(), Component::trackBunch(), Component::trackMap(), RBend3D::trackRefParticleThrough(), OpalRBend::update(), OpalRBend3D::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 >.

Definition at line 423 of file ElementBase.h.

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

Referenced by BeamlineGeometry::getOrigin().

Here is the call graph for this function:

◆ getOutputFN()

std::string ElementBase::getOutputFN ( ) const

inherited

Get output filename.

Definition at line 177 of file ElementBase.cpp.

References ElementBase::getName(), and ElementBase::outputfn_m.

Referenced by Probe::doInitialise(), PluginElement::initialise(), Cyclotron::initialise(), FlexibleCollimator::initialise(), Monitor::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 ElementBase::parmatint_m.

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

◆ getPhase()

double VariableRFCavity::getPhase ( double time ) const

inlinevirtualinherited

Get the phase at a given time.

Parameters

phase the time at which the phase is calculated

Returns: the RF cavity phase.

Definition at line 233 of file VariableRFCavity.h.

References VariableRFCavity::phaseTD_m.

◆ getPhaseModel()

std::shared_ptr< AbstractTimeDependence > VariableRFCavity::getPhaseModel ( ) const

virtualinherited

Returns: shared_ptr to the phase time dependence

Definition at line 87 of file VariableRFCavity.cpp.

References VariableRFCavity::phaseTD_m.

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

◆ getRotationAboutZ()

double ElementBase::getRotationAboutZ ( ) const

inlineinherited

Definition at line 574 of file ElementBase.h.

References ElementBase::rotationZAxis_m.

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

◆ getTotalTransform()

Euclid3D ElementBase::getTotalTransform ( ) const

inlinevirtualinherited

Get transform.

Reimplemented in TBeamline< T >.

Definition at line 439 of file ElementBase.h.

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

Referenced by BeamlineGeometry::getTotalTransform().

Here is the call graph for this function:

◆ getTransform() [1/2]

Euclid3D ElementBase::getTransform	(	double	fromS,
		double	toS
	)		const

inlinevirtualinherited

Get transform.

Reimplemented in TBeamline< T >.

Definition at line 435 of file ElementBase.h.

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

Referenced by BeamlineGeometry::getTransform(), and 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 >.

Definition at line 443 of file ElementBase.h.

References ElementBase::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 Corrector, Cyclotron, Undulator, CCollimator, Degrader, Drift, FlexibleCollimator, Marker, Monitor, Multipole, OutputPlane, Probe, RBend, RBend3D, RFCavity, SBend, Septum, Solenoid, Source, Stripper, TravelingWave, Vacuum, and Bend2D.

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 ElementBase::getType(), and ElementBase::getTypeString().

Referenced by ParallelCyclotronTracker::execute(), ElementBase::getTypeString(), Vacuum::print(), 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 ElementBase::elementTypeToString_s.

◆ getWake()

WakeFunction * ElementBase::getWake ( ) const

inlinevirtualinherited

return the attached wake object if there is any

Definition at line 467 of file ElementBase.h.

References ElementBase::wake_m.

◆ getWidth()

double VariableRFCavity::getWidth ( ) const

inlinevirtualinherited

Returns: the full width of the cavity

Definition at line 245 of file VariableRFCavity.h.

References VariableRFCavity::halfWidth_m.

◆ goOffline()

void Component::goOffline ( )

virtualinherited

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

Definition at line 87 of file Component.cpp.

References Component::online_m.

◆ goOnline()

void Component::goOnline ( const double & kineticEnergy )

virtualinherited

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

Definition at line 83 of file Component.cpp.

References Component::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 ElementBase::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 ElementBase::bgeometry_m.

◆ hasParticleMatterInteraction()

bool ElementBase::hasParticleMatterInteraction ( ) const

inlinevirtualinherited

Definition at line 487 of file ElementBase.h.

References ElementBase::parmatint_m.

◆ hasWake()

bool ElementBase::hasWake ( ) const

inlinevirtualinherited

Definition at line 471 of file ElementBase.h.

References ElementBase::wake_m.

◆ initialise() [1/2]

void VariableRFCavityFringeField::initialise ( ) const

inline

Lookup the time dependencies and update.

Throws if the named time dependencies can't be found. Also throws if the width or height is < 1 nm

Definition at line 189 of file VariableRFCavityFringeField.h.

References VariableRFCavity::initialise().

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

Here is the call graph for this function:

◆ initialise() [2/2]

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

overridevirtual

Initialise ready for tracking.

Does any setup on VirtualRFCavity and sets field expansion coefficients

Reimplemented from VariableRFCavity.

Definition at line 152 of file VariableRFCavityFringeField.cpp.

References VariableRFCavity::initialise(), and initialiseCoefficients().

Here is the call graph for this function:

◆ initialiseCoefficients()

void VariableRFCavityFringeField::initialiseCoefficients ( )

Set the coefficients for calculating the field expansion.

Definition at line 169 of file VariableRFCavityFringeField.cpp.

References Physics::c, f_m, g_m, h_m, Units::m2mm, maxOrder_m, Hypervolume::n, and Units::s2ns.

Referenced by accept(), initialise(), and setMaxOrder().

◆ initNull()

void VariableRFCavityFringeField::initNull ( )

private

Definition at line 62 of file VariableRFCavityFringeField.cpp.

References endField_m, VariableRFCavity::initNull(), maxOrder_m, and zCentre_m.

Referenced by VariableRFCavityFringeField().

Here is the call graph for this function:

◆ isElementPositionSet()

bool ElementBase::isElementPositionSet ( ) const

inlineinherited

Definition at line 598 of file ElementBase.h.

References ElementBase::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 ElementBase::getElementLength(), and ElementBase::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 abs(), ElementBase::aperture_m, CONIC_ELLIPTICAL, CONIC_RECTANGULAR, ELLIPTICAL, ElementBase::getEdgeToBegin(), ElementBase::getElementLength(), pow(), RECTANGULAR, and CoordinateSystemTrafo::transformTo().

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

Here is the call graph for this function:

◆ isPositioned()

bool ElementBase::isPositioned ( ) const

inlineinherited

Definition at line 556 of file ElementBase.h.

References ElementBase::positionIsFixed.

Referenced by OpalRBend::update(), OpalRBend3D::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 ElementBase::shareFlag.

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

◆ isShared()

bool RCObject::isShared ( ) const

inlineinherited

Test for sharing.

Definition at line 93 of file RCObject.h.

References RCObject::refCount.

◆ makeSharable()

void ElementBase::makeSharable ( )

virtualinherited

Set sharable flag.

Reimplemented in TBeamline< T >.

Definition at line 253 of file ElementBase.cpp.

References ElementBase::shareFlag.

Referenced by OpalMarker::OpalMarker(), and Element::setShared().

◆ Online()

bool Component::Online ( )

virtualinherited

Definition at line 91 of file Component.cpp.

References Component::online_m.

◆ operator=()

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

Assignment operator; performs deepcopy on time-dependence models.

Definition at line 42 of file VariableRFCavityFringeField.cpp.

References endField_m, f_m, g_m, h_m, VariableRFCavity::operator=(), setEndField(), and zCentre_m.

Here is the call graph for this function:

◆ printCoefficients()

void VariableRFCavityFringeField::printCoefficients ( std::ostream & out ) const

Print the coefficients to ostream out.

Definition at line 209 of file VariableRFCavityFringeField.cpp.

References endl(), f_m, g_m, h_m, and printVector().

Here is the call graph for this function:

◆ releasePosition()

void ElementBase::releasePosition ( )

inlineinherited

Definition at line 546 of file ElementBase.h.

References ElementBase::positionIsFixed.

Referenced by OpalRBend::update(), OpalRBend3D::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 AttributeSet::removeAttribute(), and ElementBase::userAttribs.

Here is the call graph for this function:

◆ removeReference()

int RCObject::removeReference ( ) const

inlineinherited

Decrement the reference count.

Definition at line 88 of file RCObject.h.

References RCObject::refCount.

◆ setActionRange()

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

inlineinherited

Definition at line 561 of file ElementBase.h.

References ElementBase::actionRange_m, and ElementBase::elementEdge_m.

◆ setAmplitudeModel()

void VariableRFCavity::setAmplitudeModel ( std::shared_ptr< AbstractTimeDependence > time_dep )

virtualinherited

Set the amplitude (field gradient) time dependence.

Definition at line 95 of file VariableRFCavity.cpp.

References VariableRFCavity::amplitudeTD_m.

Referenced by VariableRFCavity::initialise(), and VariableRFCavity::operator=().

◆ setAmplitudeName()

virtual void VariableRFCavity::setAmplitudeName ( const std::string & amplitude )

inlinevirtualinherited

Set the amplitude time dependence name.

The name is used to find the amplitude model at accept time

Definition at line 179 of file VariableRFCavity.h.

References VariableRFCavity::amplitudeName_m.

Referenced by OpalVariableRFCavity::update(), and OpalVariableRFCavityFringeField::update().

◆ setAperture()

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

inlineinherited

Definition at line 519 of file ElementBase.h.

References ElementBase::aperture_m.

Referenced by Component::Component(), Offset::operator=(), OpalElement::update(), OpalRBend::update(), OpalRBend3D::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 endl(), ElementBase::getChannel(), and Channel::isSettable().

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

Here is the call graph for this function:

◆ setBoundaryGeometry()

void ElementBase::setBoundaryGeometry ( BoundaryGeometry * geo )

virtualinherited

attach a boundary geometry field to the element

Definition at line 270 of file ElementBase.cpp.

References ElementBase::bgeometry_m.

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

◆ setCavityCentre()

void VariableRFCavityFringeField::setCavityCentre ( double zCentre )

inlinevirtual

Get the offset of centre of the cavity field from the element start in metres.

Definition at line 176 of file VariableRFCavityFringeField.h.

References zCentre_m.

Referenced by OpalVariableRFCavityFringeField::update().

◆ setCSTrafoGlobal2Local()

void ElementBase::setCSTrafoGlobal2Local ( const CoordinateSystemTrafo & ori )

inlineinherited

Definition at line 491 of file ElementBase.h.

References ElementBase::csTrafoGlobal2Local_m, and ElementBase::positionIsFixed.

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

◆ setCurrentSCoordinate()

void ElementBase::setCurrentSCoordinate ( double s )

inherited

Definition at line 278 of file ElementBase.cpp.

References ElementBase::actionRange_m, and ElementBase::elementEdge_m.

◆ setDesignEnergy()

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

inlinevirtualinherited

Reimplemented in Corrector, RFCavity, and BendBase.

Definition at line 228 of file Component.h.

◆ setElementLength()

void ElementBase::setElementLength ( double length )

inlinevirtualinherited

Set design length.

Reimplemented in MultipoleT.

Definition at line 419 of file ElementBase.h.

References ElementBase::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 ElementBase::elemedgeSet_m, and ElementBase::elementPosition_m.

Referenced by OpalElement::update().

◆ setEndField()

void VariableRFCavityFringeField::setEndField ( std::shared_ptr< endfieldmodel::EndFieldModel > endField )

virtual

Set the endFieldModel.

Parameters

endField the new endFieldModel. VariableRFCavityFringe takes ownership of the memory allocated to endField.

Definition at line 219 of file VariableRFCavityFringeField.cpp.

References end(), and endField_m.

Referenced by operator=(), and OpalVariableRFCavityFringeField::update().

Here is the call graph for this function:

◆ setExitFaceSlope()

void Component::setExitFaceSlope ( const double & m )

inlineinherited

Definition at line 225 of file Component.h.

References Component::exit_face_slope_m.

◆ setFlagDeleteOnTransverseExit()

void ElementBase::setFlagDeleteOnTransverseExit ( bool flag = true )

inlineinherited

Definition at line 608 of file ElementBase.h.

References ElementBase::deleteOnTransverseExit_m.

Referenced by OpalElement::update().

◆ setFrequencyModel()

void VariableRFCavity::setFrequencyModel ( std::shared_ptr< AbstractTimeDependence > time_dep )

virtualinherited

Set the frequency time dependence.

Definition at line 103 of file VariableRFCavity.cpp.

References VariableRFCavity::frequencyCache_m, VariableRFCavity::frequencyTD_m, and TimeDependenceCache::setTimeDependence().

Referenced by VariableRFCavity::initialise(), and VariableRFCavity::operator=().

Here is the call graph for this function:

◆ setFrequencyName()

virtual void VariableRFCavity::setFrequencyName ( const std::string & frequency )

inlinevirtualinherited

Set the frequency time dependence name.

The name is used to find the frequency model at accept time

Definition at line 191 of file VariableRFCavity.h.

References VariableRFCavity::frequencyName_m.

Referenced by OpalVariableRFCavity::update(), and OpalVariableRFCavityFringeField::update().

◆ setHeight()

void VariableRFCavity::setHeight ( double fullHeight )

inlinevirtualinherited

Set the full height of the cavity.

Definition at line 253 of file VariableRFCavity.h.

References VariableRFCavity::halfHeight_m.

Referenced by OpalVariableRFCavity::update(), and OpalVariableRFCavityFringeField::update().

◆ setLength()

void VariableRFCavity::setLength ( double length )

virtualinherited

Set the length of the cavity.

Definition at line 193 of file VariableRFCavity.cpp.

References VariableRFCavity::geometry, VariableRFCavity::length_m, and StraightGeometry::setElementLength().

Referenced by VariableRFCavity::operator=(), OpalVariableRFCavity::update(), and OpalVariableRFCavityFringeField::update().

Here is the call graph for this function:

◆ setMaxOrder()

void VariableRFCavityFringeField::setMaxOrder ( size_t maxOrder )

inlinevirtual

Set the maximum y power.

Definition at line 184 of file VariableRFCavityFringeField.h.

References initialiseCoefficients(), and maxOrder_m.

Referenced by OpalVariableRFCavityFringeField::update().

Here is the call graph for this function:

◆ setMisalignment()

void ElementBase::setMisalignment ( const CoordinateSystemTrafo & cst )

inlineinherited

Definition at line 536 of file ElementBase.h.

References ElementBase::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 ElementBase::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 ElementBase::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 ElementBase::parmatint_m.

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

◆ setPhaseModel()

void VariableRFCavity::setPhaseModel ( std::shared_ptr< AbstractTimeDependence > time_dep )

virtualinherited

Set the phase time dependence.

Definition at line 99 of file VariableRFCavity.cpp.

References VariableRFCavity::phaseTD_m.

Referenced by VariableRFCavity::initialise(), and VariableRFCavity::operator=().

◆ setPhaseName()

virtual void VariableRFCavity::setPhaseName ( const std::string & phase )

inlinevirtualinherited

Set the phase time dependence name.

The name is used to find the phase model at accept time

Definition at line 185 of file VariableRFCavity.h.

References VariableRFCavity::phaseName_m.

Referenced by OpalVariableRFCavity::update(), and OpalVariableRFCavityFringeField::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 ElementBase::rotationZAxis_m.

Referenced by OpalElement::update().

◆ setWake()

void ElementBase::setWake ( WakeFunction * wf )

virtualinherited

attach a wake field to the element

Definition at line 266 of file ElementBase.cpp.

References ElementBase::wake_m.

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

◆ setWidth()

void VariableRFCavity::setWidth ( double fullWidth )

inlinevirtualinherited

Set the full width of the cavity.

Definition at line 257 of file VariableRFCavity.h.

References VariableRFCavity::halfWidth_m.

Referenced by OpalVariableRFCavity::update(), and OpalVariableRFCavityFringeField::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.

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

Referenced by Monitor::driftToCorrectPositionAndSave().

Here is the call graph for this function:

Member Data Documentation

◆ actionRange_m

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

privateinherited

Definition at line 399 of file ElementBase.h.

Referenced by ElementBase::setActionRange(), and ElementBase::setCurrentSCoordinate().

◆ amplitudeName_m

std::string VariableRFCavity::amplitudeName_m

protectedinherited

Definition at line 216 of file VariableRFCavity.h.

Referenced by VariableRFCavity::initialise(), VariableRFCavity::initNull(), VariableRFCavity::operator=(), and VariableRFCavity::setAmplitudeName().

◆ amplitudeTD_m

std::shared_ptr<AbstractTimeDependence> VariableRFCavity::amplitudeTD_m

protectedinherited

Definition at line 213 of file VariableRFCavity.h.

Referenced by VariableRFCavity::apply(), apply(), VariableRFCavity::getAmplitude(), VariableRFCavity::getAmplitudeModel(), VariableRFCavity::operator=(), and VariableRFCavity::setAmplitudeModel().

◆ aperture_m

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

protectedinherited

Definition at line 369 of file ElementBase.h.

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

◆ bgeometry_m

BoundaryGeometry* ElementBase::bgeometry_m

privateinherited

Definition at line 390 of file ElementBase.h.

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

◆ csTrafoGlobal2Local_m

CoordinateSystemTrafo ElementBase::csTrafoGlobal2Local_m

protectedinherited

Definition at line 366 of file ElementBase.h.

Referenced by Monitor::applyToReferenceParticle(), ElementBase::getBoundingBoxInLabCoords(), Bend2D::getBoundingBoxInLabCoords(), ElementBase::getCSTrafoGlobal2Local(), and ElementBase::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::Component().

◆ deleteOnTransverseExit_m

bool ElementBase::deleteOnTransverseExit_m = true

privateinherited

Definition at line 403 of file ElementBase.h.

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

◆ elemedgeSet_m

bool ElementBase::elemedgeSet_m

privateinherited

Definition at line 397 of file ElementBase.h.

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

◆ elementEdge_m

double ElementBase::elementEdge_m

protectedinherited

Definition at line 371 of file ElementBase.h.

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

◆ elementID

std::string ElementBase::elementID

privateinherited

Definition at line 381 of file ElementBase.h.

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

◆ elementPosition_m

double ElementBase::elementPosition_m

privateinherited

ELEMEDGE attribute.

Definition at line 396 of file ElementBase.h.

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

◆ elementTypeToString_s

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

staticprivateinherited

Definition at line 383 of file ElementBase.h.

Referenced by ElementBase::getTypeString().

◆ endField_m

std::shared_ptr<endfieldmodel::EndFieldModel> VariableRFCavityFringeField::endField_m

protected

Definition at line 167 of file VariableRFCavityFringeField.h.

Referenced by apply(), getEndField(), initNull(), operator=(), and setEndField().

◆ exit_face_slope_m

double Component::exit_face_slope_m

protectedinherited

Definition at line 189 of file Component.h.

Referenced by Component::setExitFaceSlope().

◆ f_m

std::vector<std::vector<double> > VariableRFCavityFringeField::f_m

protected

Definition at line 168 of file VariableRFCavityFringeField.h.

Referenced by apply(), getEzCoefficients(), initialiseCoefficients(), operator=(), and printCoefficients().

◆ frequencyCache_m

TimeDependenceCache VariableRFCavity::frequencyCache_m

protectedinherited

Definition at line 221 of file VariableRFCavity.h.

Referenced by VariableRFCavity::apply(), and VariableRFCavity::setFrequencyModel().

◆ frequencyName_m

std::string VariableRFCavity::frequencyName_m

protectedinherited

Definition at line 217 of file VariableRFCavity.h.

Referenced by VariableRFCavity::initialise(), VariableRFCavity::initNull(), VariableRFCavity::operator=(), and VariableRFCavity::setFrequencyName().

◆ frequencyTD_m

std::shared_ptr<AbstractTimeDependence> VariableRFCavity::frequencyTD_m

protectedinherited

Definition at line 214 of file VariableRFCavity.h.

Referenced by apply(), VariableRFCavity::getFrequency(), VariableRFCavity::getFrequencyModel(), VariableRFCavity::operator=(), and VariableRFCavity::setFrequencyModel().

◆ g_m

std::vector<std::vector<double> > VariableRFCavityFringeField::g_m

protected

Definition at line 169 of file VariableRFCavityFringeField.h.

Referenced by apply(), getEyCoefficients(), initialiseCoefficients(), operator=(), and printCoefficients().

◆ geometry

StraightGeometry VariableRFCavity::geometry

protectedinherited

The cavity's geometry.

Definition at line 224 of file VariableRFCavity.h.

Referenced by VariableRFCavity::getGeometry(), and VariableRFCavity::setLength().

◆ h_m

std::vector<std::vector<double> > VariableRFCavityFringeField::h_m

protected

Definition at line 170 of file VariableRFCavityFringeField.h.

Referenced by apply(), getBxCoefficients(), initialiseCoefficients(), operator=(), and printCoefficients().

◆ halfHeight_m

double VariableRFCavity::halfHeight_m

protectedinherited

Definition at line 219 of file VariableRFCavity.h.

Referenced by VariableRFCavity::apply(), apply(), VariableRFCavity::getHeight(), VariableRFCavity::initialise(), VariableRFCavity::initNull(), VariableRFCavity::operator=(), and VariableRFCavity::setHeight().

◆ halfWidth_m

double VariableRFCavity::halfWidth_m

protectedinherited

Definition at line 218 of file VariableRFCavity.h.

Referenced by VariableRFCavity::apply(), apply(), VariableRFCavity::getWidth(), VariableRFCavity::initialise(), VariableRFCavity::initNull(), VariableRFCavity::operator=(), and VariableRFCavity::setWidth().

◆ length_m

double VariableRFCavity::length_m

protectedinherited

Definition at line 220 of file VariableRFCavity.h.

Referenced by VariableRFCavity::apply(), apply(), VariableRFCavity::getLength(), VariableRFCavity::initNull(), VariableRFCavity::operator=(), and VariableRFCavity::setLength().

◆ maxOrder_m

size_t VariableRFCavityFringeField::maxOrder_m

protected

Definition at line 166 of file VariableRFCavityFringeField.h.

Referenced by apply(), getMaxOrder(), initialiseCoefficients(), initNull(), and setMaxOrder().

◆ misalignment_m

CoordinateSystemTrafo ElementBase::misalignment_m

protectedinherited

Definition at line 367 of file ElementBase.h.

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

◆ online_m

bool Component::online_m

protectedinherited

Definition at line 192 of file Component.h.

Referenced by Monitor::apply(), Source::apply(), Probe::doGoOffline(), Cyclotron::finalise(), PluginElement::finalise(), Bend2D::finalise(), FlexibleCollimator::finalise(), Multipole::finalise(), Ring::finalise(), Vacuum::finalise(), Component::goOffline(), PluginElement::goOffline(), Degrader::goOffline(), FlexibleCollimator::goOffline(), RBend3D::goOffline(), RFCavity::goOffline(), Solenoid::goOffline(), Source::goOffline(), Vacuum::goOffline(), Component::goOnline(), Corrector::goOnline(), Bend2D::goOnline(), CCollimator::goOnline(), Degrader::goOnline(), FlexibleCollimator::goOnline(), Monitor::goOnline(), RBend3D::goOnline(), RFCavity::goOnline(), Solenoid::goOnline(), Source::goOnline(), TravelingWave::goOnline(), Vacuum::goOnline(), Ring::initialise(), Septum::initialise(), Cyclotron::initialise(), Multipole::initialise(), Component::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 ElementBase::setOutputFN().

◆ parmatint_m

ParticleMatterInteractionHandler* ElementBase::parmatint_m

privateinherited

Definition at line 392 of file ElementBase.h.

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

◆ phaseName_m

std::string VariableRFCavity::phaseName_m

protectedinherited

Definition at line 215 of file VariableRFCavity.h.

Referenced by VariableRFCavity::initialise(), VariableRFCavity::initNull(), VariableRFCavity::operator=(), and VariableRFCavity::setPhaseName().

◆ phaseTD_m

std::shared_ptr<AbstractTimeDependence> VariableRFCavity::phaseTD_m

protectedinherited

Definition at line 212 of file VariableRFCavity.h.

Referenced by VariableRFCavity::apply(), apply(), VariableRFCavity::getPhase(), VariableRFCavity::getPhaseModel(), VariableRFCavity::operator=(), and VariableRFCavity::setPhaseModel().

◆ positionIsFixed

bool ElementBase::positionIsFixed

privateinherited

Definition at line 394 of file ElementBase.h.

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

◆ refCount

int RCObject::refCount

mutableprivateinherited

Definition at line 76 of file RCObject.h.

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

◆ RefPartBunch_m

PartBunchBase<double, 3>* Component::RefPartBunch_m

protectedinherited

Definition at line 191 of file Component.h.

Referenced by Corrector::apply(), Undulator::apply(), VerticalFFAMagnet::apply(), Bend2D::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(), VariableRFCavity::apply(), apply(), Cyclotron::apply(), Degrader::applyToReferenceParticle(), Monitor::applyToReferenceParticle(), BendBase::calcDesignRadius(), BendBase::calcFieldAmplitude(), BendBase::calcGamma(), Bend2D::calculateBendAngle(), Bend2D::calculateRefTrajectory(), Monitor::driftToCorrectPositionAndSave(), VerticalFFAMagnet::finalise(), MultipoleT::finalise(), Offset::finalise(), SBend3D::finalise(), ScalingFFAMagnet::finalise(), VariableRFCavity::finalise(), RBend::findChordLength(), Bend2D::findIdealBendParameters(), Corrector::goOnline(), Degrader::goOnline(), Degrader::initialise(), PluginElement::initialise(), Vacuum::initialise(), Corrector::initialise(), Cyclotron::initialise(), Undulator::initialise(), VerticalFFAMagnet::initialise(), Drift::initialise(), FlexibleCollimator::initialise(), Marker::initialise(), Monitor::initialise(), Multipole::initialise(), MultipoleT::initialise(), Offset::initialise(), RBend3D::initialise(), RFCavity::initialise(), SBend3D::initialise(), ScalingFFAMagnet::initialise(), Solenoid::initialise(), Source::initialise(), TravelingWave::initialise(), VariableRFCavity::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().

◆ rotationZAxis_m

double ElementBase::rotationZAxis_m

protectedinherited

Definition at line 373 of file ElementBase.h.

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

◆ shareFlag

bool ElementBase::shareFlag

mutableprotectedinherited

Definition at line 364 of file ElementBase.h.

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

◆ userAttribs

AttributeSet ElementBase::userAttribs

privateinherited

Definition at line 386 of file ElementBase.h.

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

◆ wake_m

WakeFunction* ElementBase::wake_m

privateinherited

Definition at line 388 of file ElementBase.h.

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

◆ zCentre_m

double VariableRFCavityFringeField::zCentre_m

protected

Definition at line 165 of file VariableRFCavityFringeField.h.

Referenced by apply(), getCavityCentre(), initNull(), operator=(), and setCavityCentre().

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

◆ VariableRFCavityFringeField() [1/3]

◆ VariableRFCavityFringeField() [2/3]

◆ VariableRFCavityFringeField() [3/3]

◆ ~VariableRFCavityFringeField()

Member Function Documentation

◆ accept()

◆ addReference()

◆ apply() [1/2]

◆ apply() [2/2]

◆ applyToReferenceParticle()

◆ bends()

◆ Bfield() [1/2]

◆ Bfield() [2/2]

◆ clone()

◆ copyStructure()

◆ EBfield() [1/2]

◆ EBfield() [2/2]

◆ Efield() [1/2]

◆ Efield() [2/2]

◆ finalise()

◆ fixPosition()

◆ getAmplitude()

◆ getAmplitudeModel()

◆ getAperture()

◆ getArcLength()

◆ getAttribute()

◆ getBoundaryGeometry()

◆ getBoundingBoxInLabCoords()

◆ getBxCoefficients()

◆ getCavityCentre()

◆ getChannel()

◆ getConstChannel()

◆ getCSTrafoGlobal2Local()

◆ getDesign()

◆ getDesignEnergy()

◆ getDimensions()

◆ getEdgeToBegin()

◆ getEdgeToEnd()

◆ getElementDimensions()

◆ getElementLength()

◆ getElementPosition()

◆ getEndField()

◆ getEntrance()

◆ getEntranceFrame()

◆ getEntrancePatch()

◆ getExit()

◆ getExitFrame()

◆ getExitPatch()

◆ getEyCoefficients()

◆ getEzCoefficients()

◆ getField() [1/2]

◆ getField() [2/2]

◆ getFlagDeleteOnTransverseExit()

◆ getFrequency()

◆ getFrequencyModel()

◆ getGeometry() [1/2]

◆ getGeometry() [2/2]

◆ getHeight()

◆ getLength()

◆ getMaxOrder()

◆ getMisalignment() [1/2]

◆ getMisalignment() [2/2]

◆ getName()

◆ getOrigin()

◆ getOutputFN()

◆ getParticleMatterInteraction()

◆ getPhase()

◆ getPhaseModel()

◆ getPotential()

◆ getRequiredNumberOfTimeSteps()