#include <VariableRFCavityFringeField.h>

Inheritance diagram for VariableRFCavityFringeField:

Collaboration diagram for VariableRFCavityFringeField:

Public Member Functions
	VariableRFCavityFringeField (const std::string &name)
	Constructor with given name.
	VariableRFCavityFringeField (const VariableRFCavityFringeField &)
	VariableRFCavityFringeField ()
VariableRFCavityFringeField &	operator= (const VariableRFCavityFringeField &)
virtual	~VariableRFCavityFringeField ()
virtual void	accept (BeamlineVisitor &) const override
void	initialise () const
virtual ElementBase *	clone () const override
virtual bool	apply (const size_t &i, const double &t, Vector_t &E, Vector_t &B) override
virtual bool	apply (const Vector_t &R, const Vector_t &P, const double &t, Vector_t &E, Vector_t &B) override
virtual bool	applyToReferenceParticle (const Vector_t &R, const Vector_t &P, const double &t, Vector_t &E, Vector_t &B) override
virtual void	setEndField (std::shared_ptr< endfieldmodel::EndFieldModel > endField)
virtual std::shared_ptr< endfieldmodel::EndFieldModel >	getEndField () const
virtual void	initialise (PartBunchBase< double, 3 > *bunch, double &startField, double &endField) override
virtual void	setCavityCentre (double zCentre)
virtual double	getCavityCentre () const
virtual void	setMaxOrder (size_t maxOrder)
virtual size_t	getMaxOrder () const
void	initialiseCoefficients ()
void	printCoefficients (std::ostream &out) const
std::vector< std::vector< double > >	getEzCoefficients () const
std::vector< std::vector< double > >	getEyCoefficients () const
std::vector< std::vector< double > >	getBxCoefficients () const
virtual void	finalise () override
virtual bool	bends () const override
virtual void	getDimensions (double &, double &) const override
virtual double	getAmplitude (double time) const
virtual double	getFrequency (double time) const
virtual double	getPhase (double time) const
virtual double	getHeight () const
virtual double	getWidth () const
virtual double	getLength () const
virtual void	setHeight (double fullHeight)
virtual void	setWidth (double fullWidth)
virtual void	setLength (double length)
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)
virtual void	setPhaseModel (std::shared_ptr< AbstractTimeDependence > time_dep)
virtual void	setFrequencyModel (std::shared_ptr< AbstractTimeDependence > time_dep)
virtual void	setAmplitudeName (const std::string &amplitude)
virtual void	setPhaseName (const std::string &phase)
virtual void	setFrequencyName (const std::string &frequency)
virtual StraightGeometry &	getGeometry () override
virtual const StraightGeometry &	getGeometry () const override
virtual EMField &	getField () override
	Not implemented.
virtual const EMField &	getField () const override
	Not implemented.
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	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	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
StraightGeometry	geometry
	The cavity's geometry.
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
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

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(), name, and VariableRFCavity::VariableRFCavity().

Referenced by accept(), operator=(), and VariableRFCavityFringeField().

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(), VariableRFCavity::VariableRFCavity(), and VariableRFCavityFringeField().

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(), and VariableRFCavity::VariableRFCavity().

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(), VariableRFCavityFringeField(), 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 refCount.

Referenced by Pointer< Object >::operator=(), 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(), 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 VariableRFCavity::amplitudeTD_m, 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, VariableRFCavity::phaseTD_m, Units::T2kG, Physics::two_pi, and zCentre_m.

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

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

◆ clone()

ElementBase * VariableRFCavityFringeField::clone ( ) const

overridevirtual

Inheritable deepcopy method

Reimplemented from VariableRFCavity.

Definition at line 58 of file VariableRFCavityFringeField.cpp.

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

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

overridevirtualinherited

Finalise following tracking

Just sets RefPartBunch_m to nullptr

Implements Component.

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

◆ 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 227 of file VariableRFCavity.h.

References amplitudeTD_m.

◆ getAmplitudeModel()

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

virtualinherited

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

Definition at line 82 of file VariableRFCavity.cpp.

References amplitudeTD_m.

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

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

◆ 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 >, SingleMultipole< -2 >, SingleMultipole< -3 >, SingleMultipole< -4 >, SingleMultipole< 2 >, SingleMultipole< 3 >, SingleMultipole< 4 >, SolenoidRep, SourceRep, StripperRep, TravelingWaveRep, UndulatorRep, VacuumRep, XCorrectorRep, and YCorrectorRep.

Definition at line 228 of file ElementBase.cpp.

References userAttribs.

◆ getConstChannel()

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

virtualinherited

Construct a read-only channel.

Definition at line 233 of file ElementBase.cpp.

References ElementBase(), and getChannel().

Referenced by getAttribute(), and hasAttribute().

Here is the call graph for this function:

◆ getCSTrafoGlobal2Local()

CoordinateSystemTrafo ElementBase::getCSTrafoGlobal2Local ( ) const

inlineinherited

Definition at line 498 of file ElementBase.h.

References csTrafoGlobal2Local_m.

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

◆ getDesign()

const ElementBase & Component::getDesign ( ) const

virtualinherited

Return design element.

Definition at line 67 of file Component.cpp.

References ElementBase::ElementBase().

Here is the call graph for this function:

◆ getDesignEnergy()

double Component::getDesignEnergy ( ) const

inlinevirtualinherited

Reimplemented in BendBase, and RFCavity.

Definition at line 231 of file Component.h.

◆ getDimensions()

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

inlineoverridevirtualinherited

Not used (does nothing)

Implements Component.

Definition at line 121 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 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()

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

◆ 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 119 of file VariableRFCavity.cpp.

◆ getField() [2/2]

EMField & VariableRFCavity::getField ( )

overridevirtualinherited

Not implemented.

Implements Component.

Definition at line 114 of file VariableRFCavity.cpp.

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

◆ 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 235 of file VariableRFCavity.h.

References frequencyTD_m.

◆ getFrequencyModel()

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

virtualinherited

Returns: shared_ptr to the frequency

Definition at line 90 of file VariableRFCavity.cpp.

References frequencyTD_m.

◆ getGeometry() [1/2]

const StraightGeometry & VariableRFCavity::getGeometry ( ) const

overridevirtualinherited

Returns: the cavity geometry

Implements ElementBase.

Definition at line 110 of file VariableRFCavity.cpp.

References geometry.

◆ getGeometry() [2/2]

StraightGeometry & VariableRFCavity::getGeometry ( )

overridevirtualinherited

Set the cavity geometry

Implements ElementBase.

Definition at line 106 of file VariableRFCavity.cpp.

References geometry.

◆ getHeight()

double VariableRFCavity::getHeight ( ) const

inlinevirtualinherited

Returns: the full height of the cavity

Definition at line 239 of file VariableRFCavity.h.

References halfHeight_m.

◆ getLength()

double VariableRFCavity::getLength ( ) const

inlinevirtualinherited

Returns: the length of the cavity

Definition at line 247 of file VariableRFCavity.h.

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

◆ 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 231 of file VariableRFCavity.h.

References phaseTD_m.

◆ getPhaseModel()

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

virtualinherited

Returns: shared_ptr to the phase time dependence

Definition at line 86 of file VariableRFCavity.cpp.

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

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

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

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

◆ getWidth()

double VariableRFCavity::getWidth ( ) const

inlinevirtualinherited

Returns: the full width of the cavity

Definition at line 243 of file VariableRFCavity.h.

References halfWidth_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 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, 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(), VariableRFCavityFringeField(), and VariableRFCavityFringeField().

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

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

◆ setAmplitudeModel()

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

virtualinherited

Set the amplitude (field gradient) time dependence

Definition at line 94 of file VariableRFCavity.cpp.

References amplitudeTD_m.

Referenced by initialise(), and 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 178 of file VariableRFCavity.h.

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

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

◆ 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 csTrafoGlobal2Local_m, and positionIsFixed.

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

◆ setCurrentSCoordinate()

void ElementBase::setCurrentSCoordinate ( double s )

inherited

Definition at line 278 of file ElementBase.cpp.

◆ setDesignEnergy()

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

inlinevirtualinherited

Reimplemented in BendBase, Corrector, and RFCavity.

Definition at line 228 of file Component.h.

◆ setElementLength()

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

◆ setFlagDeleteOnTransverseExit()

void ElementBase::setFlagDeleteOnTransverseExit ( bool flag = true )

inlineinherited

Definition at line 608 of file ElementBase.h.

References deleteOnTransverseExit_m.

Referenced by OpalElement::update().

◆ setFrequencyModel()

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

virtualinherited

Set the frequency time dependence

Definition at line 102 of file VariableRFCavity.cpp.

References frequencyTD_m.

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

◆ 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 190 of file VariableRFCavity.h.

References 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 251 of file VariableRFCavity.h.

References 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 190 of file VariableRFCavity.cpp.

References geometry, and length_m.

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

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

◆ setPhaseModel()

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

virtualinherited

Set the phase time dependence

Definition at line 98 of file VariableRFCavity.cpp.

References phaseTD_m.

Referenced by initialise(), and 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 184 of file VariableRFCavity.h.

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

Referenced by OpalCavity::update(), OpalDrift::update(), OpalProbe::update(), OpalRBend3D::update(), OpalRBend::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 255 of file VariableRFCavity.h.

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

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

◆ amplitudeName_m

std::string VariableRFCavity::amplitudeName_m

protectedinherited

Definition at line 215 of file VariableRFCavity.h.

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

◆ amplitudeTD_m

std::shared_ptr<AbstractTimeDependence> VariableRFCavity::amplitudeTD_m

protectedinherited

Definition at line 212 of file VariableRFCavity.h.

Referenced by apply(), VariableRFCavityFringeField::apply(), getAmplitude(), getAmplitudeModel(), operator=(), and 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(), Bend2D::getOutline(), Bend2D::getSurfaceMesh(), Bend2D::inMagnetCentralRegion(), Bend2D::inMagnetEntranceRegion(), Bend2D::inMagnetExitRegion(), isInsideTransverse(), 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(), getBoundaryGeometry(), hasBoundaryGeometry(), and setBoundaryGeometry().

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

◆ 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

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(), Component(), and 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().

◆ frequencyName_m

std::string VariableRFCavity::frequencyName_m

protectedinherited

Definition at line 216 of file VariableRFCavity.h.

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

◆ frequencyTD_m

std::shared_ptr<AbstractTimeDependence> VariableRFCavity::frequencyTD_m

protectedinherited

Definition at line 213 of file VariableRFCavity.h.

Referenced by apply(), VariableRFCavityFringeField::apply(), getFrequency(), getFrequencyModel(), operator=(), and 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 222 of file VariableRFCavity.h.

Referenced by getGeometry(), getGeometry(), and 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 218 of file VariableRFCavity.h.

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

◆ halfWidth_m

double VariableRFCavity::halfWidth_m

protectedinherited

Definition at line 217 of file VariableRFCavity.h.

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

◆ length_m

double VariableRFCavity::length_m

protectedinherited

Definition at line 219 of file VariableRFCavity.h.

Referenced by apply(), VariableRFCavityFringeField::apply(), getLength(), initNull(), operator=(), and 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 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().

◆ phaseName_m

std::string VariableRFCavity::phaseName_m

protectedinherited

Definition at line 214 of file VariableRFCavity.h.

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

◆ phaseTD_m

std::shared_ptr<AbstractTimeDependence> VariableRFCavity::phaseTD_m

protectedinherited

Definition at line 211 of file VariableRFCavity.h.

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

◆ positionIsFixed

bool ElementBase::positionIsFixed

privateinherited

Definition at line 394 of file ElementBase.h.

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

◆ refCount

int RCObject::refCount

mutableprivateinherited

Definition at line 76 of file RCObject.h.

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

◆ RefPartBunch_m

PartBunchBase<double, 3>* Component::RefPartBunch_m

protectedinherited

Definition at line 191 of file Component.h.

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

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

◆ userAttribs

AttributeSet ElementBase::userAttribs

privateinherited

Definition at line 386 of file ElementBase.h.

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

◆ wake_m

WakeFunction* ElementBase::wake_m

privateinherited

Definition at line 388 of file ElementBase.h.

Referenced by ElementBase(), getWake(), hasWake(), and 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()