#include <VerticalFFAMagnet.h>

Inheritance diagram for VerticalFFAMagnet:

Collaboration diagram for VerticalFFAMagnet:

Public Member Functions
	VerticalFFAMagnet (const std::string &name)
	~VerticalFFAMagnet ()
ElementBase *	clone () const
bool	apply (const size_t &i, const double &t, Vector_t< double, 3 > &E, Vector_t< double, 3 > &B)
bool	apply (const Vector_t< double, 3 > &R, const Vector_t< double, 3 > &P, const double &t, Vector_t< double, 3 > &E, Vector_t< double, 3 > &B)
bool	getFieldValue (const Vector_t< double, 3 > &R, Vector_t< double, 3 > &B) const
void	initialise (PartBunch_t *bunch, double &startField, double &endField)
void	initialise ()
void	finalise ()
bool	bends () const
void	getDimensions (double &, double &) const
BGeometryBase &	getGeometry ()
const BGeometryBase &	getGeometry () const
EMField &	getField ()
const EMField &	getField () const
void	accept (BeamlineVisitor &visitor) const
endfieldmodel::EndFieldModel *	getEndField () const
void	setEndField (endfieldmodel::EndFieldModel *endField)
size_t	getMaxOrder () const
void	setMaxOrder (size_t maxOrder)
double	getB0 () const
void	setB0 (double Bz)
double	getFieldIndex () const
void	setFieldIndex (double index)
double	getNegativeVerticalExtent () const
void	setNegativeVerticalExtent (double negativeExtent)
double	getPositiveVerticalExtent () const
void	setPositiveVerticalExtent (double positiveExtent)
double	getBBLength () const
void	setBBLength (double bbLength)
double	getWidth () const
void	setWidth (double width)
std::vector< std::vector< double > >	getDfCoefficients () const
EVector	Efield (const Point3D &P) const
	Return the field in a point.
EVector	Efield (const Point3D &P, double t) const
	Return the field in a point.
BVector	Bfield (const Point3D &P) const
	Return the field in a point.
BVector	Bfield (const Point3D &P, double t) const
	Return the field in a point.
EBVectors	EBfield (const Point3D &P) const
	Return the field in a point.
EBVectors	EBfield (const Point3D &P, double t) const
	Return the field in a point.
virtual bool	applyToReferenceParticle (const Vector_t< double, 3 > &R, const Vector_t< double, 3 > &P, const double &t, Vector_t< double, 3 > &E, Vector_t< double, 3 > &B)
virtual bool	getPotential (const Vector_t< double, 3 > &, const double &, Vector_t< double, 3 > &, 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
	Get element type std::string.
virtual const ElementBase &	getDesign () const
	Return design element.
virtual void	trackBunch (PartBunch_t *bunch, const PartData &, bool revBeam, bool revTrack) const
	Track 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< double, 3 > &r) const
void	setMisalignment (const CoordinateSystemTrafo &cst)
void	getMisalignment (double &x, double &y, double &s) const
CoordinateSystemTrafo	getMisalignment () const
void	setActionRange (const std::queue< std::pair< double, double > > &range)
void	setCurrentSCoordinate (double s)
void	setRotationAboutZ (double rotation)
	Set rotation about z axis in bend frame.
double	getRotationAboutZ () const
virtual BoundingBox	getBoundingBoxInLabCoords () const
virtual int	getRequiredNumberOfTimeSteps () const
void	setOutputFN (std::string fn)
	Set output filename.
std::string	getOutputFN () const
	Get output filename.
void	setFlagDeleteOnTransverseExit (bool=true)
bool	getFlagDeleteOnTransverseExit () const
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< double, 3 > &r) const

Protected Attributes
double	exit_face_slope_m
PartBunch_t *	RefPartBunch_m
bool	online_m
bool	shareFlag
CoordinateSystemTrafo	csTrafoGlobal2Local_m
CoordinateSystemTrafo	misalignment_m
std::pair< ApertureType, std::vector< double > >	aperture_m
double	elementEdge_m
double	rotationZAxis_m

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

Private Member Functions
void	calculateDfCoefficients ()
	VerticalFFAMagnet (const VerticalFFAMagnet &right)
VerticalFFAMagnet &	operator= (const VerticalFFAMagnet &rhs)

Private Attributes
StraightGeometry	straightGeometry_m
BMultipoleField	dummy
size_t	maxOrder_m = 0
double	k_m = 0.
double	Bz_m = 0.
double	zNegExtent_m = 0.
double	zPosExtent_m = 0.
double	halfWidth_m = 0.
double	bbLength_m = 0.
std::unique_ptr< endfieldmodel::EndFieldModel >	endField_m
std::vector< std::vector< double > >	dfCoefficients_m
const double	mm = 1000.
const double	Tesla = 10.
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

Bending magnet with an exponential dependence on field in the vertical plane

VerticalFFAMagnet makes a rectangular bending magnet with a dipole field that has a dependence like B0 exp(mz)

Definition at line 28 of file VerticalFFAMagnet.h.

Constructor & Destructor Documentation

◆ VerticalFFAMagnet() [1/2]

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

explicit

Construct a new VerticalFFAMagnet

Parameters

name	User-defined name of the VerticalFFAMagnet

Definition at line 17 of file VerticalFFAMagnet.cpp.

References Component::Component(), and straightGeometry_m.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ~VerticalFFAMagnet()

VerticalFFAMagnet::~VerticalFFAMagnet ( )

Destructor - deletes the field

Definition at line 38 of file VerticalFFAMagnet.cpp.

◆ VerticalFFAMagnet() [2/2]

VerticalFFAMagnet::VerticalFFAMagnet ( const VerticalFFAMagnet & right )

private

Copy constructor

Definition at line 21 of file VerticalFFAMagnet.cpp.

References bbLength_m, Bz_m, clone(), Component::Component(), dfCoefficients_m, dummy, endField_m, halfWidth_m, k_m, maxOrder_m, Component::RefPartBunch_m, straightGeometry_m, VerticalFFAMagnet(), zNegExtent_m, and zPosExtent_m.

Here is the call graph for this function:

Member Function Documentation

◆ accept()

void VerticalFFAMagnet::accept ( BeamlineVisitor & visitor ) const

virtual

Accept a beamline visitor

Implements ElementBase.

Definition at line 77 of file VerticalFFAMagnet.cpp.

References BeamlineVisitor::visitVerticalFFAMagnet().

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

Here is the caller graph for this function:

◆ apply() [1/2]

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

inlinevirtual

Calculate the field at the position of the ith particle

Parameters

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

Returns: true if particle is outside the field map

Reimplemented from Component.

Definition at line 248 of file VerticalFFAMagnet.h.

References apply(), and Component::RefPartBunch_m.

Referenced by apply().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ apply() [2/2]

bool VerticalFFAMagnet::apply	(	const Vector_t< double, 3 > &	R,
		const Vector_t< double, 3 > &	P,
		const double &	t,
		Vector_t< double, 3 > &	E,
		Vector_t< double, 3 > &	B )

inlinevirtual

Calculate the field at some arbitrary position

Parameters

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

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

Reimplemented from Component.

Definition at line 258 of file VerticalFFAMagnet.h.

References getFieldValue().

Here is the call graph for this function:

◆ applyToReferenceParticle()

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

virtualinherited

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

Definition at line 100 of file Component.cpp.

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

Here is the call graph for this function:

◆ bends()

bool VerticalFFAMagnet::bends ( ) const

inlinevirtual

Return false - VerticalFFAMagnet is a straight magnet

Nb: the VerticalFFAMagnet geometry is straight even though trajectories are not

Implements Component.

Definition at line 99 of file VerticalFFAMagnet.h.

◆ Bfield() [1/2]

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

inlineinherited

Return the field in a point.

Definition at line 196 of file Component.h.

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

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

Here is the call graph for this function:

◆ calculateDfCoefficients()

void VerticalFFAMagnet::calculateDfCoefficients ( )

private

Definition at line 123 of file VerticalFFAMagnet.cpp.

References dfCoefficients_m, k_m, and maxOrder_m.

Referenced by initialise().

Here is the caller graph for this function:

◆ clone()

ElementBase * VerticalFFAMagnet::clone ( ) const

virtual

Inheritable copy constructor

Implements ElementBase.

Definition at line 41 of file VerticalFFAMagnet.cpp.

References ElementBase::ElementBase(), initialise(), and VerticalFFAMagnet().

Referenced by VerticalFFAMagnet().

Here is the call graph for this function:

Here is the caller 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 204 of file ElementBase.cpp.

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ EBfield() [1/2]

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

inlineinherited

Return the field in a point.

Definition at line 208 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 212 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 192 of file Component.h.

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

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

Here is the call graph for this function:

◆ finalise()

void VerticalFFAMagnet::finalise ( )

virtual

Finalise the VerticalFFAMagnet - sets bunch to nullptr

Implements Component.

Definition at line 65 of file VerticalFFAMagnet.cpp.

References Component::RefPartBunch_m.

◆ fixPosition()

void ElementBase::fixPosition ( )

inlineinherited

Definition at line 521 of file ElementBase.h.

References positionIsFixed.

Referenced by OpalElement::update().

Here is the caller graph for this function:

◆ getAperture()

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

inlineinherited

Definition at line 500 of file ElementBase.h.

References aperture_m.

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

Here is the caller graph for this function:

◆ getArcLength()

double ElementBase::getArcLength ( ) const

inlinevirtualinherited

Get arc length.

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

Definition at line 392 of file ElementBase.h.

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

Referenced by TBeamline< T >::getTransform().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAttribute()

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

virtualinherited

Get attribute value.

Definition at line 153 of file ElementBase.cpp.

References getConstChannel().

Here is the call graph for this function:

◆ getB0()

double VerticalFFAMagnet::getB0 ( ) const

inline

Get the centre field at z=0

Definition at line 149 of file VerticalFFAMagnet.h.

References Bz_m, and Tesla.

◆ getBBLength()

double VerticalFFAMagnet::getBBLength ( ) const

inline

Get the length of the bounding box (centred on magnet centre)

Definition at line 185 of file VerticalFFAMagnet.h.

References bbLength_m, and mm.

◆ getBoundaryGeometry()

BoundaryGeometry * ElementBase::getBoundaryGeometry ( ) const

inlinevirtualinherited

return the attached boundary geometrt object if there is any

Definition at line 456 of file ElementBase.h.

References bgeometry_m.

◆ getBoundingBoxInLabCoords()

BoundingBox ElementBase::getBoundingBoxInLabCoords ( ) const

virtualinherited

Definition at line 272 of file ElementBase.cpp.

References csTrafoGlobal2Local_m, getEdgeToBegin(), and getEdgeToEnd().

Here is the call graph for this function:

◆ getChannel()

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

virtualinherited

Construct a read/write channel.

Reimplemented in DriftRep, MonitorRep, MultipoleRep, ProbeRep, RFCavityRep, SolenoidRep, and TravelingWaveRep.

Definition at line 190 of file ElementBase.cpp.

References userAttribs.

Referenced by DriftRep::getChannel(), MonitorRep::getChannel(), MultipoleRep::getChannel(), ProbeRep::getChannel(), RFCavityRep::getChannel(), SolenoidRep::getChannel(), TravelingWaveRep::getChannel(), getConstChannel(), and setAttribute().

Here is the caller graph for this function:

◆ getConstChannel()

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

virtualinherited

Construct a read-only channel.

Definition at line 194 of file ElementBase.cpp.

References ElementBase(), and getChannel().

Referenced by getAttribute(), and hasAttribute().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCSTrafoGlobal2Local()

CoordinateSystemTrafo ElementBase::getCSTrafoGlobal2Local ( ) const

inlineinherited

Definition at line 479 of file ElementBase.h.

References csTrafoGlobal2Local_m.

Referenced by MeshGenerator::add().

Here is the caller graph for this function:

◆ getDesign()

const ElementBase & Component::getDesign ( ) const

virtualinherited

Return design element.

Definition at line 52 of file Component.cpp.

References ElementBase::ElementBase().

Here is the call graph for this function:

◆ getDesignEnergy()

double Component::getDesignEnergy ( ) const

inlinevirtualinherited

Reimplemented in RFCavity.

Definition at line 231 of file Component.h.

◆ getDfCoefficients()

std::vector< std::vector< double > > VerticalFFAMagnet::getDfCoefficients ( ) const

inline

Get the coefficients used for the field expansion

B_y is given by sum_n B_0 exp(ky) f_n x^n where f_n = sum_k c_{nk} partial_k f_0

Returns a vector of vectors, like c[n][k]. The expansion for the other field elements can be related back to c[n][k] (see elsewhere for details).

Definition at line 264 of file VerticalFFAMagnet.h.

References dfCoefficients_m.

◆ getDimensions()

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

inlinevirtual

Not implemented

Implements Component.

Definition at line 104 of file VerticalFFAMagnet.h.

◆ getEdgeToBegin()

CoordinateSystemTrafo ElementBase::getEdgeToBegin ( ) const

inlinevirtualinherited

Reimplemented in RFCavity, Solenoid, and TravelingWave.

Definition at line 483 of file ElementBase.h.

Referenced by getBoundingBoxInLabCoords(), and TBeamline< FlaggedElmPtr >::getConstChannel().

Here is the caller graph for this function:

◆ getEdgeToEnd()

CoordinateSystemTrafo ElementBase::getEdgeToEnd ( ) const

inlinevirtualinherited

Reimplemented in RFCavity, Solenoid, and TravelingWave.

Definition at line 488 of file ElementBase.h.

References getElementLength().

Referenced by getBoundingBoxInLabCoords().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getElementDimensions()

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

inlinevirtualinherited

Reimplemented in RFCavity, Solenoid, and TravelingWave.

Definition at line 159 of file ElementBase.h.

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

Referenced by MeshGenerator::add().

Here is the call graph for this function:

Here is the caller 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 396 of file ElementBase.h.

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

Referenced by Component::apply(), Corrector::apply(), Multipole::apply(), Multipole::apply(), Solenoid::apply(), Component::applyToReferenceParticle(), Multipole::applyToReferenceParticle(), Solenoid::applyToReferenceParticle(), TBeamline< FlaggedElmPtr >::getConstChannel(), Corrector::getDimensions(), Drift::getDimensions(), Multipole::getDimensions(), Solenoid::getDimensions(), getEdgeToEnd(), Solenoid::getEdgeToEnd(), getElementDimensions(), Solenoid::getElementDimensions(), RFCavity::getElementLength(), Corrector::initialise(), Drift::initialise(), Multipole::initialise(), Solenoid::initialise(), isInside(), Monitor::isInside(), and Multipole::isInside().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getElementPosition()

double ElementBase::getElementPosition ( ) const

inlineinherited

Definition at line 553 of file ElementBase.h.

References elemedgeSet_m, elementPosition_m, and getName().

Here is the call graph for this function:

◆ getEndField()

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

inline

Get the fringe field

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

Definition at line 127 of file VerticalFFAMagnet.h.

References endField_m.

Referenced by OpalVerticalFFAMagnet::update().

Here is the caller graph for this function:

◆ getEntrance()

double ElementBase::getEntrance ( ) const

inlinevirtualinherited

Get entrance position.

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

Definition at line 408 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 428 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 436 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 412 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 432 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 440 of file ElementBase.h.

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

Here is the call graph for this function:

◆ getField() [1/2]

EMField & VerticalFFAMagnet::getField ( )

virtual

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

Implements Component.

Definition at line 47 of file VerticalFFAMagnet.cpp.

References dummy.

◆ getField() [2/2]

const EMField & VerticalFFAMagnet::getField ( ) const

virtual

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

Implements Component.

Definition at line 51 of file VerticalFFAMagnet.cpp.

References dummy.

◆ getFieldIndex()

double VerticalFFAMagnet::getFieldIndex ( ) const

inline

Get the field index

Definition at line 159 of file VerticalFFAMagnet.h.

References k_m, and mm.

◆ getFieldValue()

bool VerticalFFAMagnet::getFieldValue	(	const Vector_t< double, 3 > &	R,
		Vector_t< double, 3 > &	B ) const

Calculate the field at some arbitrary position in cartesian coordinates

Parameters

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

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

Definition at line 82 of file VerticalFFAMagnet.cpp.

References bbLength_m, Bz_m, dfCoefficients_m, endField_m, halfWidth_m, k_m, maxOrder_m, zNegExtent_m, and zPosExtent_m.

Referenced by apply().

Here is the caller graph for this function:

◆ getFlagDeleteOnTransverseExit()

bool ElementBase::getFlagDeleteOnTransverseExit ( ) const

inlineinherited

Definition at line 574 of file ElementBase.h.

References deleteOnTransverseExit_m.

Referenced by Corrector::apply(), Multipole::apply(), Multipole::apply(), MultipoleT::apply(), MultipoleTBase::apply(), RFCavity::apply(), Solenoid::apply(), and TravelingWave::apply().

Here is the caller graph for this function:

◆ getGeometry() [1/2]

BGeometryBase & VerticalFFAMagnet::getGeometry ( )

virtual

Return the cell geometry

Implements ElementBase.

Definition at line 69 of file VerticalFFAMagnet.cpp.

References straightGeometry_m.

◆ getGeometry() [2/2]

const BGeometryBase & VerticalFFAMagnet::getGeometry ( ) const

virtual

Return the cell geometry

Implements ElementBase.

Definition at line 73 of file VerticalFFAMagnet.cpp.

References straightGeometry_m.

◆ getMaxOrder()

size_t VerticalFFAMagnet::getMaxOrder ( ) const

inline

Get the maximum power of x used in the off-midplane expansion;

Definition at line 140 of file VerticalFFAMagnet.h.

References maxOrder_m.

◆ getMisalignment() [1/2]

CoordinateSystemTrafo ElementBase::getMisalignment ( ) const

inlineinherited

Definition at line 513 of file ElementBase.h.

References misalignment_m.

◆ getMisalignment() [2/2]

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

inherited

◆ getName()

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

virtualinherited

Get element name.

Definition at line 132 of file ElementBase.cpp.

Referenced by Ring::appendElement(), Ring::apply(), TBeamline< T >::clone(), TBeamline< T >::copyStructure(), Probe::doGoOffline(), PlaceRep::enter(), getElementPosition(), RFCavity::getMomentaKick(), getOutputFN(), CavityAutophaser::getPhaseAtMaxEnergy(), Selector::handleElement(), RFCavity::initialise(), Ring::initialise(), Solenoid::initialise(), PlaceRep::leave(), Offset::Offset(), operator<<(), Offset::operator=(), operator==(), Sequence::print(), Ring::Ring(), ClassicField::SortAsc(), Component::trackBunch(), Component::trackMap(), Sequence::updateList(), ParallelTracker::updateRFElement(), and Replacer::visitFlaggedElmPtr().

Here is the caller graph for this function:

◆ getNegativeVerticalExtent()

double VerticalFFAMagnet::getNegativeVerticalExtent ( ) const

inline

Get the maximum extent below z = 0

Definition at line 169 of file VerticalFFAMagnet.h.

References mm, and zNegExtent_m.

◆ getOrigin()

double ElementBase::getOrigin ( ) const

inlinevirtualinherited

Get origin position.

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

Definition at line 404 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 144 of file ElementBase.cpp.

References getName(), and outputfn_m.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getParticleMatterInteraction()

ParticleMatterInteractionHandler * ElementBase::getParticleMatterInteraction ( ) const

inlinevirtualinherited

Definition at line 464 of file ElementBase.h.

References parmatint_m.

◆ getPositiveVerticalExtent()

double VerticalFFAMagnet::getPositiveVerticalExtent ( ) const

inline

Get the maximum extent above z = 0

Definition at line 177 of file VerticalFFAMagnet.h.

References mm, and zPosExtent_m.

◆ getPotential()

virtual bool Component::getPotential	(	const Vector_t< double, 3 > &	,
		const double &	,
		Vector_t< double, 3 > &	,
		double &	)

inlinevirtualinherited

Calculate the four-potential at some position relative to the component

Parameters

R	position in the local coordinate system of the component
t	time
A	filled with the calculated magnetic vector potential
phi	filled with the calculated electric potential Note that any existing values in A and phi may be overwritten by this method.

Returns: true if particle is outside the field map, else false Default for component is to return false and make no change to A and phi

Definition at line 122 of file Component.h.

◆ getRequiredNumberOfTimeSteps()

int ElementBase::getRequiredNumberOfTimeSteps ( ) const

inlinevirtualinherited

Reimplemented in Drift, Marker, and Monitor.

Definition at line 566 of file ElementBase.h.

◆ getRotationAboutZ()

double ElementBase::getRotationAboutZ ( ) const

inlineinherited

Definition at line 540 of file ElementBase.h.

References rotationZAxis_m.

◆ getTotalTransform()

Euclid3D ElementBase::getTotalTransform ( ) const

inlinevirtualinherited

Get transform.

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

Definition at line 420 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 416 of file ElementBase.h.

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

Referenced by TBeamline< T >::getTransform().

Here is the call graph for this function:

Here is the caller 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 424 of file ElementBase.h.

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

Here is the call graph for this function:

◆ getType()

ElementType Component::getType ( ) const

virtualinherited

Get element type std::string.

Implements ElementBase.

Reimplemented in Corrector, Drift, Marker, Monitor, Multipole, Probe, RFCavity, Solenoid, and TravelingWave.

Definition at line 76 of file Component.cpp.

References ANY.

◆ getTypeString() [1/2]

std::string ElementBase::getTypeString ( ) const

inlineinherited

Definition at line 544 of file ElementBase.h.

References getType(), and getTypeString().

Referenced by getTypeString().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTypeString() [2/2]

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

staticinherited

Definition at line 200 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 448 of file ElementBase.h.

References wake_m.

◆ getWidth()

double VerticalFFAMagnet::getWidth ( ) const

inline

Get the full width of the bounding box (centred on magnet centre)

Definition at line 195 of file VerticalFFAMagnet.h.

References halfWidth_m, and mm.

◆ goOffline()

void Component::goOffline ( )

virtualinherited

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

Definition at line 68 of file Component.cpp.

References online_m.

◆ goOnline()

void Component::goOnline ( const double & kineticEnergy )

virtualinherited

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

Definition at line 64 of file Component.cpp.

References online_m.

Referenced by PluginElement::initialise().

Here is the caller graph for this function:

◆ hasAttribute()

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

virtualinherited

Test for existence of an attribute.

Definition at line 165 of file ElementBase.cpp.

References getConstChannel().

Here is the call graph for this function:

◆ hasBoundaryGeometry()

bool ElementBase::hasBoundaryGeometry ( ) const

inlinevirtualinherited

Definition at line 460 of file ElementBase.h.

References bgeometry_m.

◆ hasParticleMatterInteraction()

bool ElementBase::hasParticleMatterInteraction ( ) const

inlinevirtualinherited

Definition at line 468 of file ElementBase.h.

References parmatint_m.

◆ hasWake()

bool ElementBase::hasWake ( ) const

inlinevirtualinherited

Definition at line 452 of file ElementBase.h.

References wake_m.

◆ initialise() [1/2]

void VerticalFFAMagnet::initialise ( )

Initialise the VerticalFFAMagnet

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

Definition at line 55 of file VerticalFFAMagnet.cpp.

References bbLength_m, calculateDfCoefficients(), and straightGeometry_m.

Referenced by initialise().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initialise() [2/2]

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

virtual

Initialise the VerticalFFAMagnet

Parameters

bunch	the global bunch object (but not used)
startField	not used
endField	not used

Implements Component.

Definition at line 60 of file VerticalFFAMagnet.cpp.

References initialise(), and Component::RefPartBunch_m.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isElementPositionSet()

bool ElementBase::isElementPositionSet ( ) const

inlineinherited

Definition at line 562 of file ElementBase.h.

References elemedgeSet_m.

◆ isInside()

bool ElementBase::isInside ( const Vector_t< double, 3 > & r ) const

inlinevirtualinherited

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

Definition at line 504 of file ElementBase.h.

References getElementLength(), and isInsideTransverse().

Here is the call graph for this function:

◆ isInsideTransverse()

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

protectedinherited

Definition at line 245 of file ElementBase.cpp.

References aperture_m.

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

Here is the caller graph for this function:

◆ isPositioned()

bool ElementBase::isPositioned ( ) const

inlineinherited

Definition at line 525 of file ElementBase.h.

References positionIsFixed.

◆ isSharable()

bool ElementBase::isSharable ( ) const

inlineinherited

Test if the element can be shared.

Definition at line 444 of file ElementBase.h.

References shareFlag.

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

Here is the caller graph for this function:

◆ 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 212 of file ElementBase.cpp.

References shareFlag.

Referenced by OpalMarker::OpalMarker().

Here is the caller graph for this function:

◆ Online()

bool Component::Online ( )

virtualinherited

Definition at line 72 of file Component.cpp.

References online_m.

◆ operator=()

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

private

References VerticalFFAMagnet().

Here is the call graph for this function:

◆ releasePosition()

void ElementBase::releasePosition ( )

inlineinherited

Definition at line 517 of file ElementBase.h.

References positionIsFixed.

◆ removeAttribute()

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

virtualinherited

Remove an existing attribute.

Definition at line 176 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 529 of file ElementBase.h.

References actionRange_m, and elementEdge_m.

◆ setAperture()

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

inlineinherited

Definition at line 495 of file ElementBase.h.

References aperture_m.

Referenced by Component::Component(), Offset::operator=(), and OpalElement::update().

Here is the caller graph for this function:

◆ setAttribute()

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

virtualinherited

Set value of an attribute.

Definition at line 180 of file ElementBase.cpp.

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setB0()

void VerticalFFAMagnet::setB0 ( double Bz )

inline

Set the centre field at z=0

Definition at line 154 of file VerticalFFAMagnet.h.

References Bz_m, and Tesla.

Referenced by OpalVerticalFFAMagnet::update().

Here is the caller graph for this function:

◆ setBBLength()

void VerticalFFAMagnet::setBBLength ( double bbLength )

inline

Set the length of the bounding box (centred on magnet centre)

Definition at line 190 of file VerticalFFAMagnet.h.

References bbLength_m, and mm.

Referenced by OpalVerticalFFAMagnet::update().

Here is the caller graph for this function:

◆ setBoundaryGeometry()

void ElementBase::setBoundaryGeometry ( BoundaryGeometry * geo )

virtualinherited

attach a boundary geometry field to the element

Definition at line 228 of file ElementBase.cpp.

References bgeometry_m.

◆ setCSTrafoGlobal2Local()

void ElementBase::setCSTrafoGlobal2Local ( const CoordinateSystemTrafo & ori )

inlineinherited

Definition at line 472 of file ElementBase.h.

References csTrafoGlobal2Local_m, and positionIsFixed.

Referenced by OpalElement::update().

Here is the caller graph for this function:

◆ setCurrentSCoordinate()

void ElementBase::setCurrentSCoordinate ( double s )

inherited

Definition at line 236 of file ElementBase.cpp.

◆ setDesignEnergy()

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

inlinevirtualinherited

Reimplemented in Corrector, and RFCavity.

Definition at line 228 of file Component.h.

◆ setElementLength()

void ElementBase::setElementLength ( double length )

inlinevirtualinherited

Set design length.

Definition at line 400 of file ElementBase.h.

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

Referenced by RFCavity::initialise(), Solenoid::initialise(), TravelingWave::initialise(), SequenceMember::setLength(), OpalCavity::update(), OpalMonitor::update(), OpalMultipole::update(), OpalMultipoleT::update(), OpalProbe::update(), OpalSolenoid::update(), and OpalTravelingWave::update().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setElementPosition()

void ElementBase::setElementPosition ( double elemedge )

inlineinherited

Access to ELEMEDGE attribute.

Definition at line 548 of file ElementBase.h.

References elemedgeSet_m, and elementPosition_m.

Referenced by OpalElement::update().

Here is the caller graph for this function:

◆ setEndField()

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

Set the fringe field

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

Definition at line 144 of file VerticalFFAMagnet.cpp.

References endField_m, and maxOrder_m.

Referenced by OpalVerticalFFAMagnet::OpalVerticalFFAMagnet(), and OpalVerticalFFAMagnet::OpalVerticalFFAMagnet().

Here is the caller graph for this function:

◆ setExitFaceSlope()

void Component::setExitFaceSlope ( const double & m )

inlineinherited

Definition at line 224 of file Component.h.

References exit_face_slope_m.

◆ setFieldIndex()

void VerticalFFAMagnet::setFieldIndex ( double index )

inline

Set the field index

Definition at line 164 of file VerticalFFAMagnet.h.

References k_m, and mm.

Referenced by OpalVerticalFFAMagnet::update().

Here is the caller graph for this function:

◆ setFlagDeleteOnTransverseExit()

void ElementBase::setFlagDeleteOnTransverseExit ( bool flag = true )

inlineinherited

Definition at line 570 of file ElementBase.h.

References deleteOnTransverseExit_m.

Referenced by OpalElement::update().

Here is the caller graph for this function:

◆ setMaxOrder()

void VerticalFFAMagnet::setMaxOrder ( size_t maxOrder )

Set the maximum power of x used in the off-midplane expansion;

Definition at line 149 of file VerticalFFAMagnet.cpp.

References endField_m, and maxOrder_m.

Referenced by OpalVerticalFFAMagnet::update().

Here is the caller graph for this function:

◆ setMisalignment()

void ElementBase::setMisalignment ( const CoordinateSystemTrafo & cst )

inlineinherited

Definition at line 509 of file ElementBase.h.

References misalignment_m.

Referenced by OpalElement::update().

Here is the caller graph for this function:

◆ setName()

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

virtualinherited

Set element name.

Definition at line 136 of file ElementBase.cpp.

References elementID.

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

Here is the caller graph for this function:

◆ setNegativeVerticalExtent()

void VerticalFFAMagnet::setNegativeVerticalExtent ( double negativeExtent )

inline

Set the maximum extent below z = 0

Definition at line 240 of file VerticalFFAMagnet.h.

References mm, and zNegExtent_m.

Referenced by OpalVerticalFFAMagnet::update().

Here is the caller graph for this function:

◆ setOutputFN()

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

inherited

Set output filename.

Definition at line 140 of file ElementBase.cpp.

References outputfn_m.

Referenced by OpalMonitor::update(), and OpalProbe::update().

Here is the caller graph for this function:

◆ setParticleMatterInteraction()

void ElementBase::setParticleMatterInteraction ( ParticleMatterInteractionHandler * spys )

virtualinherited

Definition at line 232 of file ElementBase.cpp.

◆ setPositiveVerticalExtent()

void VerticalFFAMagnet::setPositiveVerticalExtent ( double positiveExtent )

inline

set the maximum extent above z = 0

Definition at line 244 of file VerticalFFAMagnet.h.

References mm, and zPosExtent_m.

Referenced by OpalVerticalFFAMagnet::update().

Here is the caller graph for this function:

◆ setRotationAboutZ()

void ElementBase::setRotationAboutZ ( double rotation )

inlineinherited

Set rotation about z axis in bend frame.

Definition at line 536 of file ElementBase.h.

References rotationZAxis_m.

Referenced by OpalElement::update().

Here is the caller graph for this function:

◆ setWake()

void ElementBase::setWake ( WakeFunction * wf )

virtualinherited

attach a wake field to the element

Definition at line 224 of file ElementBase.cpp.

References wake_m.

◆ setWidth()

void VerticalFFAMagnet::setWidth ( double width )

inline

Set the full width of the bounding box (centred on magnet centre)

Definition at line 200 of file VerticalFFAMagnet.h.

References halfWidth_m, and mm.

Referenced by OpalVerticalFFAMagnet::update().

Here is the caller graph for this function:

◆ trackBunch()

void Component::trackBunch	(	PartBunch_t *	bunch,
		const PartData &	,
		bool	revBeam,
		bool	revTrack ) const

virtualinherited

Track particle bunch.

Definition at line 56 of file Component.cpp.

References ElementBase::getName().

Referenced by Tracker::visitComponent().

Here is the call graph for this function:

Here is the caller 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 60 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 216 of file ElementBase.cpp.

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

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 382 of file ElementBase.h.

Referenced by setActionRange().

◆ aperture_m

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

protectedinherited

Definition at line 353 of file ElementBase.h.

Referenced by ElementBase(), getAperture(), isInsideTransverse(), and setAperture().

◆ bbLength_m

double VerticalFFAMagnet::bbLength_m = 0.

private

Definition at line 232 of file VerticalFFAMagnet.h.

Referenced by getBBLength(), getFieldValue(), initialise(), setBBLength(), and VerticalFFAMagnet().

◆ bgeometry_m

BoundaryGeometry* ElementBase::bgeometry_m

privateinherited

Definition at line 373 of file ElementBase.h.

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

◆ Bz_m

double VerticalFFAMagnet::Bz_m = 0.

private

Definition at line 228 of file VerticalFFAMagnet.h.

Referenced by getB0(), getFieldValue(), setB0(), and VerticalFFAMagnet().

◆ csTrafoGlobal2Local_m

CoordinateSystemTrafo ElementBase::csTrafoGlobal2Local_m

protectedinherited

Definition at line 350 of file ElementBase.h.

Referenced by ElementBase(), ElementBase(), getBoundingBoxInLabCoords(), getCSTrafoGlobal2Local(), and setCSTrafoGlobal2Local().

◆ defaultAperture_m

const std::vector< double > Component::defaultAperture_m = std::vector<double>({1e6, 1e6, 1.0})

staticprotectedinherited

Definition at line 181 of file Component.h.

Referenced by Component().

◆ deleteOnTransverseExit_m

bool ElementBase::deleteOnTransverseExit_m = true

privateinherited

Definition at line 386 of file ElementBase.h.

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

◆ dfCoefficients_m

std::vector<std::vector<double> > VerticalFFAMagnet::dfCoefficients_m

private

Definition at line 234 of file VerticalFFAMagnet.h.

Referenced by calculateDfCoefficients(), getDfCoefficients(), getFieldValue(), and VerticalFFAMagnet().

◆ dummy

BMultipoleField VerticalFFAMagnet::dummy

private

Definition at line 224 of file VerticalFFAMagnet.h.

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

◆ elemedgeSet_m

bool ElementBase::elemedgeSet_m

privateinherited

Definition at line 380 of file ElementBase.h.

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

◆ elementEdge_m

double ElementBase::elementEdge_m

protectedinherited

Definition at line 355 of file ElementBase.h.

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

◆ elementID

std::string ElementBase::elementID

privateinherited

Definition at line 364 of file ElementBase.h.

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

◆ elementPosition_m

double ElementBase::elementPosition_m

privateinherited

ELEMEDGE attribute.

Definition at line 379 of file ElementBase.h.

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

◆ elementTypeToString_s

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

staticprivateinherited

Initial value:

= {
    {ElementType::ANY, "Any"},
    {ElementType::BEAMLINE, "Beamline"},
    {ElementType::DRIFT, "Drift"},
    {ElementType::MARKER, "Marker"},
    {ElementType::MULTIPOLE, "Multipole"},
    {ElementType::RFCAVITY, "RFCavity"},
    {ElementType::TRAVELINGWAVE, "TravelingWave"},
    {ElementType::SBEND, "SBEND"},
    {ElementType::RBEND, "RBEND"},
    {ElementType::RBEND3D, "RBEND3D"},
    {ElementType::RING, "Ring"},
    {ElementType::SOURCE, "SOURCE"},
    {ElementType::SOLENOID, "SOLENOID"},
    {ElementType::PROBE, "Probe"},
    {ElementType::VACUUM, "Vacuum"}}

Definition at line 69 of file ElementBase.h.

Referenced by getTypeString().

◆ endField_m

std::unique_ptr<endfieldmodel::EndFieldModel> VerticalFFAMagnet::endField_m

private

Definition at line 233 of file VerticalFFAMagnet.h.

Referenced by getEndField(), getFieldValue(), setEndField(), setMaxOrder(), and VerticalFFAMagnet().

◆ exit_face_slope_m

double Component::exit_face_slope_m

protectedinherited

Definition at line 183 of file Component.h.

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

◆ halfWidth_m

double VerticalFFAMagnet::halfWidth_m = 0.

private

Definition at line 231 of file VerticalFFAMagnet.h.

Referenced by getFieldValue(), getWidth(), setWidth(), and VerticalFFAMagnet().

◆ k_m

double VerticalFFAMagnet::k_m = 0.

private

Definition at line 227 of file VerticalFFAMagnet.h.

Referenced by calculateDfCoefficients(), getFieldIndex(), getFieldValue(), setFieldIndex(), and VerticalFFAMagnet().

◆ maxOrder_m

size_t VerticalFFAMagnet::maxOrder_m = 0

private

Definition at line 226 of file VerticalFFAMagnet.h.

Referenced by calculateDfCoefficients(), getFieldValue(), getMaxOrder(), setEndField(), setMaxOrder(), and VerticalFFAMagnet().

◆ misalignment_m

CoordinateSystemTrafo ElementBase::misalignment_m

protectedinherited

Definition at line 351 of file ElementBase.h.

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

◆ mm

const double VerticalFFAMagnet::mm = 1000.

private

Definition at line 236 of file VerticalFFAMagnet.h.

Referenced by getBBLength(), getFieldIndex(), getNegativeVerticalExtent(), getPositiveVerticalExtent(), getWidth(), setBBLength(), setFieldIndex(), setNegativeVerticalExtent(), setPositiveVerticalExtent(), and setWidth().

◆ online_m

bool Component::online_m

protectedinherited

◆ outputfn_m

std::string ElementBase::outputfn_m

privateinherited

The name of the outputfile

Definition at line 384 of file ElementBase.h.

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

◆ parmatint_m

ParticleMatterInteractionHandler* ElementBase::parmatint_m

privateinherited

Definition at line 375 of file ElementBase.h.

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

◆ positionIsFixed

bool ElementBase::positionIsFixed

privateinherited

Definition at line 377 of file ElementBase.h.

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

PartBunch_t* Component::RefPartBunch_m

protectedinherited

Definition at line 185 of file Component.h.

Referenced by Corrector::apply(), Corrector::apply(), Multipole::apply(), MultipoleT::apply(), MultipoleTBase::apply(), RFCavity::apply(), Ring::apply(), ScalingFFAMagnet::apply(), Solenoid::apply(), TravelingWave::apply(), VerticalFFAMagnet::apply(), Component(), MultipoleT::finalise(), MultipoleTBase::finalise(), Offset::finalise(), ScalingFFAMagnet::finalise(), VerticalFFAMagnet::finalise(), Corrector::goOnline(), Corrector::initialise(), Drift::initialise(), Marker::initialise(), Monitor::initialise(), Multipole::initialise(), MultipoleTCurvedConstRadius::initialise(), MultipoleTCurvedVarRadius::initialise(), MultipoleTStraight::initialise(), Offset::initialise(), PluginElement::initialise(), RFCavity::initialise(), RFCavity::initialise(), ScalingFFAMagnet::initialise(), Solenoid::initialise(), TravelingWave::initialise(), VerticalFFAMagnet::initialise(), Multipole::isFocusing(), MultipoleT::MultipoleT(), MultipoleTBase::MultipoleTBase(), MultipoleTCurvedConstRadius::MultipoleTCurvedConstRadius(), MultipoleTCurvedVarRadius::MultipoleTCurvedVarRadius(), MultipoleTStraight::MultipoleTStraight(), ScalingFFAMagnet::ScalingFFAMagnet(), Corrector::setDesignEnergy(), Ring::setRefPartBunch(), RFCavity::trackOnAxisParticle(), and VerticalFFAMagnet::VerticalFFAMagnet().

◆ rotationZAxis_m

double ElementBase::rotationZAxis_m

protectedinherited

Definition at line 357 of file ElementBase.h.

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

◆ shareFlag

bool ElementBase::shareFlag

mutableprotectedinherited

Definition at line 348 of file ElementBase.h.

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

◆ straightGeometry_m

StraightGeometry VerticalFFAMagnet::straightGeometry_m

private

Definition at line 223 of file VerticalFFAMagnet.h.

Referenced by getGeometry(), getGeometry(), initialise(), VerticalFFAMagnet(), and VerticalFFAMagnet().

◆ Tesla

const double VerticalFFAMagnet::Tesla = 10.

private

Definition at line 237 of file VerticalFFAMagnet.h.

Referenced by getB0(), and setB0().

◆ userAttribs

AttributeSet ElementBase::userAttribs

privateinherited

Definition at line 369 of file ElementBase.h.

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

◆ wake_m

WakeFunction* ElementBase::wake_m

privateinherited

Definition at line 371 of file ElementBase.h.

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

◆ zNegExtent_m

double VerticalFFAMagnet::zNegExtent_m = 0.

private

Definition at line 229 of file VerticalFFAMagnet.h.

Referenced by getFieldValue(), getNegativeVerticalExtent(), setNegativeVerticalExtent(), and VerticalFFAMagnet().

◆ zPosExtent_m

double VerticalFFAMagnet::zPosExtent_m = 0.

private

Definition at line 230 of file VerticalFFAMagnet.h.

Referenced by getFieldValue(), getPositiveVerticalExtent(), setPositiveVerticalExtent(), and VerticalFFAMagnet().

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

◆ VerticalFFAMagnet() [1/2]

◆ ~VerticalFFAMagnet()

◆ VerticalFFAMagnet() [2/2]

Member Function Documentation

◆ accept()

◆ addReference()

◆ apply() [1/2]

◆ apply() [2/2]

◆ applyToReferenceParticle()

◆ bends()

◆ Bfield() [1/2]

◆ Bfield() [2/2]

◆ calculateDfCoefficients()

◆ clone()

◆ copyStructure()

◆ EBfield() [1/2]

◆ EBfield() [2/2]

◆ Efield() [1/2]

◆ Efield() [2/2]

◆ finalise()

◆ fixPosition()

◆ getAperture()

◆ getArcLength()

◆ getAttribute()

◆ getB0()

◆ getBBLength()

◆ getBoundaryGeometry()

◆ getBoundingBoxInLabCoords()

◆ getChannel()

◆ getConstChannel()

◆ getCSTrafoGlobal2Local()

◆ getDesign()

◆ getDesignEnergy()

◆ getDfCoefficients()

◆ getDimensions()

◆ getEdgeToBegin()

◆ getEdgeToEnd()

◆ getElementDimensions()

◆ getElementLength()

◆ getElementPosition()

◆ getEndField()

◆ getEntrance()

◆ getEntranceFrame()

◆ getEntrancePatch()

◆ getExit()

◆ getExitFrame()

◆ getExitPatch()

◆ getField() [1/2]

◆ getField() [2/2]

◆ getFieldIndex()

◆ getFieldValue()

◆ getFlagDeleteOnTransverseExit()

◆ getGeometry() [1/2]

◆ getGeometry() [2/2]

◆ getMaxOrder()

◆ getMisalignment() [1/2]

◆ getMisalignment() [2/2]

◆ getName()

◆ getNegativeVerticalExtent()

◆ getOrigin()

◆ getOutputFN()

◆ getParticleMatterInteraction()

◆ getPositiveVerticalExtent()

◆ getPotential()

◆ getRequiredNumberOfTimeSteps()

◆ getRotationAboutZ()

◆ getTotalTransform()

◆ getTransform() [1/2]

◆ getTransform() [2/2]

◆ getType()