Ring describes a ring type geometry for tracking. More...

#include <Ring.h>

Inheritance diagram for Ring:

Collaboration diagram for Ring:

Public Member Functions
	Ring (std::string ring)
	Ring (const Ring &ring)
virtual	~Ring ()
virtual bool	apply (const size_t &id, const double &t, Vector_t< double, 3 > &E, Vector_t< double, 3 > &B) override
virtual 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) override
virtual void	initialise (PartBunch_t *bunch, double &startField, double &endField) override
virtual void	initialise (PartBunch_t *bunch)
virtual void	finalise () override
virtual bool	bends () const override
virtual void	accept (BeamlineVisitor &visitor) const override
virtual void	getDimensions (double &zBegin, double &zEnd) const override
virtual ElementBase *	clone () const override
void	appendElement (const Component &element)
virtual EMField &	getField () override
virtual const EMField &	getField () const override
virtual PlanarArcGeometry &	getGeometry () override
virtual const PlanarArcGeometry &	getGeometry () const override
void	setLossDataSink (LossDataSink *sink)
PartBunch_t *	getLossDataSink () const
void	setRefPartBunch (PartBunch_t *bunch)
PartBunch_t *	getRefPartBunch () const
void	setHarmonicNumber (double cyclHarm)
double	getHarmonicNumber ()
void	setRFFreq (double rfFreq)
double	getRFFreq () const
void	setBeamRInit (double rInit)
double	getBeamRInit () const
void	setBeamPhiInit (double phiInit)
double	getBeamPhiInit () const
void	setBeamPRInit (double pRInit)
double	getBeamPRInit () const
void	setLatticeRInit (double rInit)
double	getLatticeRInit () const
void	setLatticePhiInit (double phiInit)
double	getLatticePhiInit () const
Vector_t< double, 3 >	getNextPosition () const
Vector_t< double, 3 >	getNextNormal () const
void	setLatticeThetaInit (double thetaInit)
double	getLatticeThetaInit () const
void	setSymmetry (double symmetry)
void	setScale (double scale)
double	getSymmetry () const
void	setIsClosed (bool isClosed)
double	getIsClosed () const
void	setRingAperture (double minR, double maxR)
double	getRingMinR () const
double	getRingMaxR () const
void	lockRing ()
RingSection *	getLastSectionPlaced () const
std::vector< RingSection * >	getSectionsAt (const Vector_t< double, 3 > &pos)
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 Vector_t< double, 3 >	convert (const Vector3D &vec)
static Vector3D	convert (const Vector_t< double, 3 > &vec)
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	resetAzimuths ()
void	checkAndClose ()
void	buildRingSections ()
void	rotateToCyclCoordinates (Euclid3D &euclid3d) const
	Ring ()
Ring &	operator= (const Ring &ring)
void	checkMidplane (Euclid3D delta) const
Rotation3D	getRotationStartToEnd (Euclid3D delta) const

Static Private Member Functions
static bool	sectionCompare (RingSection const const sec1, RingSection const const sec2)

Private Attributes
PlanarArcGeometry	planarArcGeometry_m
PartBunch_t *	refPartBunch_m
LossDataSink *	lossDS_m
double	beamRInit_m
double	beamPRInit_m
double	beamPhiInit_m
double	latticeRInit_m
double	latticePhiInit_m
double	latticeThetaInit_m
bool	willDoAperture_m = false
double	minR2_m
double	maxR2_m
bool	isLocked_m
bool	isClosed_m
int	symmetry_m
double	scale_m = 1.
double	cyclHarm_m
double	rfFreq_m
double	phiStep_m
std::vector< RingSectionList >	ringSections_m
RingSectionList	section_list_m
std::string	elementID
AttributeSet	userAttribs
WakeFunction *	wake_m
BoundaryGeometry *	bgeometry_m
ParticleMatterInteractionHandler *	parmatint_m
bool	positionIsFixed
std::queue< std::pair< double, double > >	actionRange_m
std::string	outputfn_m
bool	deleteOnTransverseExit_m = true
int	refCount

double	elementPosition_m
	ELEMEDGE attribute.
bool	elemedgeSet_m

Static Private Attributes
static const double	lengthTolerance_m = 1e-2
static const double	angleTolerance_m = 1e-2
static const std::map< ElementType, std::string >	elementTypeToString_s

Detailed Description

Ring describes a ring type geometry for tracking.

Ring describes a ring type geometry for tracking. Ring provides the necessary interfaces for e.g. OPAL-CYCL to track through the ring geometry, while enabling the user to add arbitrary field elements in a closed geometry.

Ring uses similar routines to OPAL-T OpalBeamline class to set up geometry; note that as OPAL-CYCL places the beam in an x-y geometry we place in an x-y geometry for Ring (i.e. the axis of the ring is by default the z-axis). So far only placement of elements in the midplane is supported. It is not possible to give vertical displacements or rotations, or add elements that might create vertical displacements and rotations.

Also aim to maintain backwards compatibility with Cyclotron (i.e. use ParallelCyclotronTracker)

Definition at line 62 of file Ring.h.

Constructor & Destructor Documentation

◆ Ring() [1/3]

Ring::Ring ( std::string ring )

Constructor

Parameters

ring	Name of the ring as defined in the input file

Definition at line 47 of file Ring.cpp.

References beamPhiInit_m, beamPRInit_m, beamRInit_m, Component::Component(), cyclHarm_m, isClosed_m, isLocked_m, latticePhiInit_m, latticeRInit_m, latticeThetaInit_m, lossDS_m, phiStep_m, pi, planarArcGeometry_m, refPartBunch_m, rfFreq_m, ringSections_m, section_list_m, setRefPartBunch(), and symmetry_m.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Ring() [2/3]

Ring::Ring ( const Ring & ring )

Copy constructor

Can't copy LossDataSink so throw exception if this is set

Definition at line 73 of file Ring.cpp.

References beamPhiInit_m, beamPRInit_m, beamRInit_m, buildRingSections(), Component::Component(), cyclHarm_m, ElementBase::getName(), isClosed_m, isLocked_m, latticePhiInit_m, latticeRInit_m, latticeThetaInit_m, lossDS_m, maxR2_m, minR2_m, phiStep_m, planarArcGeometry_m, refPartBunch_m, Ring(), ringSections_m, section_list_m, setRefPartBunch(), symmetry_m, and willDoAperture_m.

Here is the call graph for this function:

◆ ~Ring()

Ring::~Ring ( )

virtual

Destructor - deletes lossDS_m if not nullptr

Definition at line 104 of file Ring.cpp.

References section_list_m.

◆ Ring() [3/3]

Ring::Ring ( )

private

Disabled

Referenced by clone().

Here is the caller graph for this function:

Member Function Documentation

◆ accept()

void Ring::accept ( BeamlineVisitor & visitor ) const

overridevirtual

Accept the BeamlineVisitor

Just calls visitRing function on the visitor. I guess the point of this function is that it enables us to store a pointer to the visitor object or something

Implements ElementBase.

Definition at line 69 of file Ring.cpp.

References BeamlineVisitor::visitRing().

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:

◆ appendElement()

void Ring::appendElement ( const Component & element )

Add element to the ring

Add element to the ring. Elements are assumed to occupy a region of space defined by a (flat) plane at the start and a plane at the end, both infinite in extent. The position and rotation of these planes are defined according to the Component geometry given by element.getGeometry().

Caller owns memory allocated to element - Ring makes a copy.

Throws an exception if the geometry would bend the element out of the midplane (elements out of midplane are not yet supported). Note that BeamlineGeometry considers midplane to be x-z, whereas Ring considers midplane to be x-y; we apply a rotation during set up.

The element is assumed to extend not beyond the element geometry; Ring applies a bounding box based on the element geometry, if there are field maps expanding outside this region they may get cut.

Definition at line 252 of file Ring.cpp.

References checkMidplane(), ElementBase::clone(), Component::Component(), Rotation3D::getAxis(), RingSection::getEndNormal(), RingSection::getEndPosition(), ElementBase::getGeometry(), ElementBase::getName(), getNextNormal(), getNextPosition(), Euclid3D::getRotation(), RingSection::getStartNormal(), RingSection::getStartPosition(), BGeometryBase::getTotalTransform(), Euclid3D::getVector(), isLocked_m, rotateToCyclCoordinates(), section_list_m, RingSection::setComponent(), RingSection::setComponentOrientation(), RingSection::setComponentPosition(), RingSection::setEndNormal(), RingSection::setEndPosition(), RingSection::setStartNormal(), and RingSection::setStartPosition().

Referenced by lockRing().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ apply() [1/2]

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

overridevirtual

Overwrite data in vector E and B with electric and magnetic field

Parameters

i	index of item in RefPartBunch_m - particle bunch
t	time
E	array where electric field vector is stored - any existing data is overwritten
B	array where magnetic field vector is stored - any existing data is overwritten

Returns: false if particle is outside of the field map apertures, else true. If particle is off the field maps, then set flag on the particle "Bin" data to -1 and store in LossDataSink

Reimplemented from Component.

Definition at line 109 of file Ring.cpp.

References apply(), ElementBase::getName(), lossDS_m, 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 Ring::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 )

overridevirtual

Overwrite data in vector E and B with electromagnetic field at point R

Parameters

R	3 vector position at which the field is found in Cartesian coordinates (i.e. x, y, z with z=vertical)
P	3 vector momentum
centroid	unknown, but not used - bunch mean maybe?
t	time
E	vector where electric field vector will be stored - any existing data is overwritten
B	vector where magnetic field vector will be stored - any existing data is overwritten

Returns: false if particle is outside of the ring aperture, else true. If particle is off the field maps, then set flag on the particle "Bin" data to -1

Reimplemented from Component.

Definition at line 140 of file Ring.cpp.

References getSectionsAt(), maxR2_m, refPartBunch_m, scale_m, and willDoAperture_m.

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

virtual bool Ring::bends ( ) const

inlineoverridevirtual

Returns true - Ring is assumed to bend particles, being a ring

Implements Component.

Definition at line 139 of file Ring.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:

◆ buildRingSections()

void Ring::buildRingSections ( )

private

Definition at line 365 of file Ring.cpp.

References phiStep_m, Physics::pi, ringSections_m, and section_list_m.

Referenced by lockRing(), and Ring().

Here is the caller graph for this function:

◆ checkAndClose()

void Ring::checkAndClose ( )

private

Definition at line 351 of file Ring.cpp.

References angleTolerance_m, lengthTolerance_m, and section_list_m.

Referenced by lockRing().

Here is the caller graph for this function:

◆ checkMidplane()

void Ring::checkMidplane ( Euclid3D delta ) const

private

Definition at line 216 of file Ring.cpp.

References angleTolerance_m, Rotation3D::getAxis(), Euclid3D::getRotation(), Euclid3D::getVector(), and lengthTolerance_m.

Referenced by appendElement().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clone()

virtual ElementBase * Ring::clone ( ) const

inlineoverridevirtual

Inherited copy constructor

Implements ElementBase.

Definition at line 155 of file Ring.h.

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

Referenced by ParallelTracker::visitRing().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ convert() [1/2]

Vector_t< double, 3 > Ring::convert ( const Vector3D & vec )

inlinestatic

Convert from a Vector3D to a Vector_t<double, 3>

Definition at line 467 of file Ring.h.

◆ convert() [2/2]

Vector3D Ring::convert ( const Vector_t< double, 3 > & vec )

inlinestatic

Convert from a Vector_t<double, 3> to a Vector3D

Definition at line 471 of file Ring.h.

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

overridevirtual

Clean up the Ring

Ring relinquishes RefPartBunch_t pointer and deletes LossDataSink

Implements Component.

Definition at line 190 of file Ring.cpp.

References lossDS_m, Component::online_m, and setLossDataSink().

Here is the call graph for this function:

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

◆ getBeamPhiInit()

double Ring::getBeamPhiInit ( ) const

inline

Get the initial beam azimuthal angle

Definition at line 265 of file Ring.h.

References beamPhiInit_m.

◆ getBeamPRInit()

double Ring::getBeamPRInit ( ) const

inline

Get the initial beam radial momentum

Definition at line 275 of file Ring.h.

References beamPRInit_m.

◆ getBeamRInit()

double Ring::getBeamRInit ( ) const

inline

Get the initial beam radius

Definition at line 255 of file Ring.h.

References beamRInit_m.

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

◆ getDimensions()

void Ring::getDimensions	(	double &	zBegin,
		double &	zEnd ) const

overridevirtual

Not implemented - always throws an exception

Implements Component.

Definition at line 176 of file Ring.cpp.

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

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

virtual const EMField & Ring::getField ( ) const

inlineoverridevirtual

Not implemented, throws an exception

Implements Component.

Definition at line 186 of file Ring.h.

◆ getField() [2/2]

virtual EMField & Ring::getField ( )

inlineoverridevirtual

Not implemented, throws an exception

Implements Component.

Definition at line 181 of file Ring.h.

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

virtual const PlanarArcGeometry & Ring::getGeometry ( ) const

inlineoverridevirtual

Not implemented

Implements ElementBase.

Definition at line 196 of file Ring.h.

References planarArcGeometry_m.

◆ getGeometry() [2/2]

virtual PlanarArcGeometry & Ring::getGeometry ( )

inlineoverridevirtual

Not implemented

Implements ElementBase.

Definition at line 191 of file Ring.h.

References planarArcGeometry_m.

◆ getHarmonicNumber()

double Ring::getHarmonicNumber ( )

inline

Get the harmonic number for RF (number of bunches in the ring)

Definition at line 234 of file Ring.h.

References cyclHarm_m.

◆ getIsClosed()

double Ring::getIsClosed ( ) const

inline

Get flag for closure checking

Definition at line 342 of file Ring.h.

References isClosed_m.

◆ getLastSectionPlaced()

RingSection * Ring::getLastSectionPlaced ( ) const

Get the last section placed or nullptr if no sections were placed yet

Definition at line 379 of file Ring.cpp.

References section_list_m.

◆ getLatticePhiInit()

double Ring::getLatticePhiInit ( ) const

inline

Get the initial element's azimuthal angle

Definition at line 295 of file Ring.h.

References latticePhiInit_m.

◆ getLatticeRInit()

double Ring::getLatticeRInit ( ) const

inline

Get the initial element's radius

Definition at line 285 of file Ring.h.

References latticeRInit_m.

◆ getLatticeThetaInit()

double Ring::getLatticeThetaInit ( ) const

inline

Get the first element's horizontal angle

Get the angle in the ring plane with respect to the tangent vector

Definition at line 317 of file Ring.h.

References latticeThetaInit_m.

◆ getLossDataSink()

PartBunch_t * Ring::getLossDataSink ( ) const

Get pointer to lossDataSink.

Ring still owns the memory to which lossDataSink points.

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

◆ getNextNormal()

Vector_t< double, 3 > Ring::getNextNormal ( ) const

Get the initial element's start normal in cartesian coordinates

Definition at line 243 of file Ring.cpp.

References latticePhiInit_m, latticeThetaInit_m, and section_list_m.

Referenced by appendElement().

Here is the caller graph for this function:

◆ getNextPosition()

Vector_t< double, 3 > Ring::getNextPosition ( ) const

Get the initial element's start position in cartesian coordinates

Definition at line 234 of file Ring.cpp.

References latticePhiInit_m, latticeRInit_m, and section_list_m.

Referenced by appendElement().

Here is the caller graph for this function:

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

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

◆ getRefPartBunch()

PartBunch_t * Ring::getRefPartBunch ( ) const

Get pointer to RefPartBunch_t from the bunch.

Ring does not own this memory (so neither does caller).

◆ getRequiredNumberOfTimeSteps()

int ElementBase::getRequiredNumberOfTimeSteps ( ) const

inlinevirtualinherited

Reimplemented in Drift, Marker, and Monitor.

Definition at line 566 of file ElementBase.h.

◆ getRFFreq()

double Ring::getRFFreq ( ) const

inline

Get the nominal RF frequency

Definition at line 245 of file Ring.h.

References rfFreq_m.

◆ getRingMaxR()

double Ring::getRingMaxR ( ) const

inline

Get the ring maximum

Definition at line 358 of file Ring.h.

References maxR2_m.

◆ getRingMinR()

double Ring::getRingMinR ( ) const

inline

Get the ring minimum

Definition at line 353 of file Ring.h.

References minR2_m.

◆ getRotationAboutZ()

double ElementBase::getRotationAboutZ ( ) const

inlineinherited

Definition at line 540 of file ElementBase.h.

References rotationZAxis_m.

◆ getRotationStartToEnd()

Rotation3D Ring::getRotationStartToEnd ( Euclid3D delta ) const

private

Definition at line 205 of file Ring.cpp.

References Euclid3D::getRotation(), and Rotation3D::ZRotation().

Here is the call graph for this function:

◆ getSectionsAt()

std::vector< RingSection * > Ring::getSectionsAt ( const Vector_t< double, 3 > & pos )

Get the list of sections at position pos

Definition at line 201 of file Ring.cpp.

References section_list_m.

Referenced by apply().

Here is the caller graph for this function:

◆ getSymmetry()

double Ring::getSymmetry ( ) const

inline

Get the rotational symmetry of the ring (number of cells)

Definition at line 332 of file Ring.h.

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

◆ 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 Ring::initialise ( PartBunch_t * bunch )

virtual

Initialise the Ring - set the bunch and allocate a new LossDataSink

Parameters

bunch the particle bunch. Ring borrows this pointer (caller owns memory)

Definition at line 180 of file Ring.cpp.

References ElementBase::getName(), Component::online_m, setLossDataSink(), and setRefPartBunch().

Here is the call graph for this function:

◆ initialise() [2/2]

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

overridevirtual

Initialise the Ring

Parameters

bunch	the particle bunch. Ring borrows this pointer (caller owns memory)
startField	- not used
endField	- not used
scaleFactor	- not used

Implements Component.

Definition at line 186 of file Ring.cpp.

References initialise().

Referenced by initialise().

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.

◆ lockRing()

void Ring::lockRing ( )

Lock the ring

Lock the ring; apply closure checks and symmetry properties as required. Impose rule that start must be before end and switch objects around if this is not the case. Sort by startPosition azimuthal angle.

Sets isLocked_m to true. New elements can no longer be added (as it may break the symmetry/bound checking)

Definition at line 306 of file Ring.cpp.

References appendElement(), buildRingSections(), checkAndClose(), isClosed_m, isLocked_m, section_list_m, and symmetry_m.

Here is the call graph for this function:

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

Ring & Ring::operator= ( const Ring & ring )

private

Disabled

References Ring().

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.

◆ resetAzimuths()

void Ring::resetAzimuths ( )

private

Definition at line 336 of file Ring.cpp.

References section_list_m.

◆ rotateToCyclCoordinates()

void Ring::rotateToCyclCoordinates ( Euclid3D & euclid3d ) const

private

Definition at line 226 of file Ring.cpp.

References Rotation3D::getAxis(), Euclid3D::getRotation(), and Euclid3D::getVector().

Referenced by appendElement().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sectionCompare()

bool Ring::sectionCompare	(	RingSection const *const	sec1,
		RingSection const *const	sec2 )

staticprivate

Definition at line 386 of file Ring.cpp.

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

◆ setBeamPhiInit()

void Ring::setBeamPhiInit ( double phiInit )

inline

Set the initial beam azimuthal angle

Definition at line 260 of file Ring.h.

References beamPhiInit_m.

Referenced by OpalRingDefinition::update().

Here is the caller graph for this function:

◆ setBeamPRInit()

void Ring::setBeamPRInit ( double pRInit )

inline

Set the initial beam radial momentum

Definition at line 270 of file Ring.h.

References beamPRInit_m.

Referenced by OpalRingDefinition::update().

Here is the caller graph for this function:

◆ setBeamRInit()

void Ring::setBeamRInit ( double rInit )

inline

Set the initial beam radius

Definition at line 250 of file Ring.h.

References beamRInit_m.

Referenced by OpalRingDefinition::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:

◆ setExitFaceSlope()

void Component::setExitFaceSlope ( const double & m )

inlineinherited

Definition at line 224 of file Component.h.

References exit_face_slope_m.

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

◆ setHarmonicNumber()

void Ring::setHarmonicNumber ( double cyclHarm )

inline

Set the harmonic number for RF (number of bunches in the ring)

Definition at line 229 of file Ring.h.

References cyclHarm_m.

Referenced by OpalRingDefinition::update().

Here is the caller graph for this function:

◆ setIsClosed()

void Ring::setIsClosed ( bool isClosed )

inline

Set flag for closure checking

Definition at line 337 of file Ring.h.

References isClosed_m.

Referenced by OpalRingDefinition::update().

Here is the caller graph for this function:

◆ setLatticePhiInit()

void Ring::setLatticePhiInit ( double phiInit )

inline

Set the initial element's azimuthal angle

Definition at line 290 of file Ring.h.

References latticePhiInit_m.

Referenced by OpalRingDefinition::update().

Here is the caller graph for this function:

◆ setLatticeRInit()

void Ring::setLatticeRInit ( double rInit )

inline

Set the initial element's radius

Definition at line 280 of file Ring.h.

References latticeRInit_m.

Referenced by OpalRingDefinition::update().

Here is the caller graph for this function:

◆ setLatticeThetaInit()

void Ring::setLatticeThetaInit ( double thetaInit )

inline

Set the first element's horizontal angle

Set the angle in the ring plane with respect to the tangent vector

Definition at line 309 of file Ring.h.

References latticeThetaInit_m.

Referenced by OpalRingDefinition::update().

Here is the caller graph for this function:

◆ setLossDataSink()

void Ring::setLossDataSink ( LossDataSink * sink )

Set LossDataSink to sink.

Parameters

sink	The LossDataSink. Ring takes ownership of memory allocated to sink

Definition at line 171 of file Ring.cpp.

References lossDS_m.

Referenced by finalise(), and initialise().

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:

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

◆ setRefPartBunch()

void Ring::setRefPartBunch ( PartBunch_t * bunch )

Set RefPartBunch_t to bunch.

Parameters

sink	The Bunch. Ring borrows memory allocated to bunch.

Note for compliance with style guide and compatibility with parent two pointer to RefPartBunch_t are stored; this keeps them aligned

Definition at line 196 of file Ring.cpp.

References Component::RefPartBunch_m, and refPartBunch_m.

Referenced by initialise(), Ring(), and Ring().

Here is the caller graph for this function:

◆ setRFFreq()

void Ring::setRFFreq ( double rfFreq )

inline

Set the nominal RF frequency

Definition at line 240 of file Ring.h.

References rfFreq_m.

Referenced by OpalRingDefinition::update().

Here is the caller graph for this function:

◆ setRingAperture()

void Ring::setRingAperture	(	double	minR,
		double	maxR )

Set the ring aperture limits

minR; the minimum radius allowed during tracking. Throws if minR < 0
maxR; the maximum radius allowed during tracking. Throws if maxR < 0 Sets willDoRingAperture_m to true.

Definition at line 390 of file Ring.cpp.

References maxR2_m, minR2_m, and willDoAperture_m.

Referenced by OpalRingDefinition::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:

◆ setScale()

void Ring::setScale ( double scale )

inline

Set the scaling factor for the fields

Definition at line 327 of file Ring.h.

References scale_m.

Referenced by OpalRingDefinition::update().

Here is the caller graph for this function:

◆ setSymmetry()

void Ring::setSymmetry ( double symmetry )

inline

Set the rotational symmetry of the ring (number of cells)

Definition at line 322 of file Ring.h.

References symmetry_m.

Referenced by OpalRingDefinition::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.

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

◆ angleTolerance_m

const double Ring::angleTolerance_m = 1e-2

staticprivate

Definition at line 464 of file Ring.h.

Referenced by checkAndClose(), and checkMidplane().

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

◆ beamPhiInit_m

double Ring::beamPhiInit_m

private

Definition at line 426 of file Ring.h.

Referenced by getBeamPhiInit(), Ring(), Ring(), and setBeamPhiInit().

◆ beamPRInit_m

double Ring::beamPRInit_m

private

Definition at line 425 of file Ring.h.

Referenced by getBeamPRInit(), Ring(), Ring(), and setBeamPRInit().

◆ beamRInit_m

double Ring::beamRInit_m

private

Definition at line 424 of file Ring.h.

Referenced by getBeamRInit(), Ring(), Ring(), and setBeamRInit().

◆ bgeometry_m

BoundaryGeometry* ElementBase::bgeometry_m

privateinherited

Definition at line 373 of file ElementBase.h.

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

◆ csTrafoGlobal2Local_m

CoordinateSystemTrafo ElementBase::csTrafoGlobal2Local_m

protectedinherited

Definition at line 350 of file ElementBase.h.

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

◆ cyclHarm_m

double Ring::cyclHarm_m

private

Definition at line 452 of file Ring.h.

Referenced by getHarmonicNumber(), Ring(), Ring(), and setHarmonicNumber().

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

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

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

◆ isClosed_m

bool Ring::isClosed_m

private

Definition at line 444 of file Ring.h.

Referenced by getIsClosed(), lockRing(), Ring(), Ring(), and setIsClosed().

◆ isLocked_m

bool Ring::isLocked_m

private

Definition at line 440 of file Ring.h.

Referenced by appendElement(), lockRing(), Ring(), and Ring().

◆ latticePhiInit_m

double Ring::latticePhiInit_m

private

Definition at line 430 of file Ring.h.

Referenced by getLatticePhiInit(), getNextNormal(), getNextPosition(), Ring(), Ring(), and setLatticePhiInit().

◆ latticeRInit_m

double Ring::latticeRInit_m

private

Definition at line 429 of file Ring.h.

Referenced by getLatticeRInit(), getNextPosition(), Ring(), Ring(), and setLatticeRInit().

◆ latticeThetaInit_m

double Ring::latticeThetaInit_m

private

Definition at line 431 of file Ring.h.

Referenced by getLatticeThetaInit(), getNextNormal(), Ring(), Ring(), and setLatticeThetaInit().

◆ lengthTolerance_m

const double Ring::lengthTolerance_m = 1e-2

staticprivate

Definition at line 463 of file Ring.h.

Referenced by checkAndClose(), and checkMidplane().

◆ lossDS_m

LossDataSink* Ring::lossDS_m

private

Definition at line 421 of file Ring.h.

Referenced by apply(), finalise(), Ring(), Ring(), and setLossDataSink().

◆ maxR2_m

double Ring::maxR2_m

private

Definition at line 437 of file Ring.h.

Referenced by apply(), getRingMaxR(), Ring(), and setRingAperture().

◆ minR2_m

double Ring::minR2_m

private

Definition at line 436 of file Ring.h.

Referenced by getRingMinR(), Ring(), and setRingAperture().

◆ misalignment_m

CoordinateSystemTrafo ElementBase::misalignment_m

protectedinherited

Definition at line 351 of file ElementBase.h.

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

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

◆ phiStep_m

double Ring::phiStep_m

private

Definition at line 458 of file Ring.h.

Referenced by buildRingSections(), Ring(), and Ring().

◆ planarArcGeometry_m

PlanarArcGeometry Ring::planarArcGeometry_m

private

Definition at line 410 of file Ring.h.

Referenced by getGeometry(), getGeometry(), Ring(), and Ring().

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

◆ refPartBunch_m

PartBunch_t* Ring::refPartBunch_m

private

Definition at line 416 of file Ring.h.

Referenced by apply(), Ring(), Ring(), and setRefPartBunch().

◆ rfFreq_m

double Ring::rfFreq_m

private

Definition at line 455 of file Ring.h.

Referenced by getRFFreq(), Ring(), and setRFFreq().

◆ ringSections_m

std::vector<RingSectionList> Ring::ringSections_m

private

Definition at line 459 of file Ring.h.

Referenced by buildRingSections(), Ring(), and Ring().

◆ rotationZAxis_m

double ElementBase::rotationZAxis_m

protectedinherited

Definition at line 357 of file ElementBase.h.

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

◆ scale_m

double Ring::scale_m = 1.

private

Definition at line 449 of file Ring.h.

Referenced by apply(), and setScale().

◆ section_list_m

RingSectionList Ring::section_list_m

private

Definition at line 460 of file Ring.h.

Referenced by appendElement(), buildRingSections(), checkAndClose(), getLastSectionPlaced(), getNextNormal(), getNextPosition(), getSectionsAt(), lockRing(), resetAzimuths(), Ring(), Ring(), and ~Ring().

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

◆ symmetry_m

int Ring::symmetry_m

private

Definition at line 447 of file Ring.h.

Referenced by getSymmetry(), lockRing(), Ring(), Ring(), and setSymmetry().

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

◆ willDoAperture_m

bool Ring::willDoAperture_m = false

private

Definition at line 435 of file Ring.h.

Referenced by apply(), Ring(), and setRingAperture().

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

Static Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Ring() [1/3]

◆ Ring() [2/3]

◆ ~Ring()

◆ Ring() [3/3]

Member Function Documentation

◆ accept()

◆ addReference()

◆ appendElement()

◆ apply() [1/2]

◆ apply() [2/2]

◆ applyToReferenceParticle()

◆ bends()

◆ Bfield() [1/2]

◆ Bfield() [2/2]

◆ buildRingSections()

◆ checkAndClose()

◆ checkMidplane()

◆ clone()

◆ convert() [1/2]

◆ convert() [2/2]

◆ copyStructure()

◆ EBfield() [1/2]

◆ EBfield() [2/2]

◆ Efield() [1/2]

◆ Efield() [2/2]

◆ finalise()

◆ fixPosition()

◆ getAperture()

◆ getArcLength()

◆ getAttribute()

◆ getBeamPhiInit()

◆ getBeamPRInit()

◆ getBeamRInit()

◆ getBoundaryGeometry()

◆ getBoundingBoxInLabCoords()

◆ getChannel()

◆ getConstChannel()

◆ getCSTrafoGlobal2Local()

◆ getDesign()

◆ getDesignEnergy()

◆ getDimensions()

◆ getEdgeToBegin()

◆ getEdgeToEnd()

◆ getElementDimensions()

◆ getElementLength()

◆ getElementPosition()

◆ getEntrance()

◆ getEntranceFrame()

◆ getEntrancePatch()

◆ getExit()

◆ getExitFrame()

◆ getExitPatch()

◆ getField() [1/2]

◆ getField() [2/2]

◆ getFlagDeleteOnTransverseExit()

◆ getGeometry() [1/2]

◆ getGeometry() [2/2]

◆ getHarmonicNumber()

◆ getIsClosed()

◆ getLastSectionPlaced()

◆ getLatticePhiInit()

◆ getLatticeRInit()

◆ getLatticeThetaInit()

◆ getLossDataSink()

◆ getMisalignment() [1/2]

◆ getMisalignment() [2/2]

◆ getName()

◆ getNextNormal()

◆ getNextPosition()