#include <Offset.h>

Inheritance diagram for Offset:

Collaboration diagram for Offset:

Public Member Functions
	Offset (const std::string &name)
	Constructor sets everything to 0., makes a default geometry with everything set to 0. More...

	Offset ()
	Default constructor sets everything to 0., makes a default geometry with everything set to 0. More...

	Offset (std::string name, const Offset &)
	Copy constructor; deep copies geometry_m; all other stuff is copied as well. More...

	Offset (const Offset &)
	Copy constructor; deep copies geometry_m; all other stuff is copied as well. More...

Offset &	operator= (const Offset &)
	Assignment operator deep copies geometry and wrappedGeometry; all other stuff is copied as well. More...

	~Offset ()
	deletes geometry and wrappedGeometry More...

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

ElementBase *	clone () const override
	Just calls the copy constructor on *this. More...

bool	bends () const override
	Returns true if either input angle or output angle are greater than float_tolerance. More...

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

void	finalise () override

void	getDimensions (double &, double &) const override

void	setEndPosition (Vector_t< double, 3 > position)

Vector_t< double, 3 >	getEndPosition () const

void	setEndDirection (Vector_t< double, 3 > direction)

Vector_t< double, 3 >	getEndDirection () const

void	setIsLocal (bool isLocal)
	Set to true if stored coordinates are in the local coordinate system of the last placed object. More...

bool	getIsLocal () const
	Returns true if stored coordinates are in the local coordinate system of the last placed object. More...

Euclid3DGeometry &	getGeometry () override
	Get geometry. More...

const Euclid3DGeometry &	getGeometry () const override
	Get geometry. More...

void	updateGeometry (Vector_t< double, 3 > startPosition, Vector_t< double, 3 > startDirection)

void	updateGeometry ()

bool	isGeometryAllocated () const

EMField &	getField () override
	Not implemented - throws GeneralClassicException. More...

const EMField &	getField () const override
	Not implemented - throws GeneralClassicException. More...

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

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

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

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

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

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

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

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)

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 &)
	Calculate the four-potential at some position relative to the component. More...

virtual double	getDesignEnergy () const

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

virtual void	goOnline (const double &kineticEnergy)

virtual void	goOffline ()

virtual bool	Online ()

virtual ElementType	getType () const
	Get element type std::string. More...

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

virtual void	trackBunch (PartBunch_t *bunch, const PartData &, bool revBeam, bool revTrack) const
	Track particle bunch. More...

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

void	setExitFaceSlope (const double &)

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

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

std::string	getTypeString () const

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual bool	hasBoundaryGeometry () const

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

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

virtual bool	hasWake () const

virtual void	setParticleMatterInteraction (ParticleMatterInteractionHandler *spys)

virtual ParticleMatterInteractionHandler *	getParticleMatterInteraction () const

virtual bool	hasParticleMatterInteraction () const

void	setCSTrafoGlobal2Local (const CoordinateSystemTrafo &ori)

CoordinateSystemTrafo	getCSTrafoGlobal2Local () const

void	releasePosition ()

void	fixPosition ()

bool	isPositioned () const

virtual CoordinateSystemTrafo	getEdgeToBegin () const

virtual CoordinateSystemTrafo	getEdgeToEnd () const

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

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

virtual bool	isInside (const Vector_t< 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. More...

double	getRotationAboutZ () const

virtual BoundingBox	getBoundingBoxInLabCoords () const

virtual int	getRequiredNumberOfTimeSteps () const

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

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

void	setFlagDeleteOnTransverseExit (bool=true)

bool	getFlagDeleteOnTransverseExit () const

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

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

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


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

double	getElementPosition () const

bool	isElementPositionSet () const

Static Public Member Functions
static Offset	localCylindricalOffset (std::string name, double theta_in, double theta_out, double displacement)
	Factory method to make an offset in Cylindrical coordinates local to the end of the previous element. More...

static Offset	globalCylindricalOffset (std::string name, double radius_out, double phi_out, double theta_out)
	Factory method to make an offset in global cylindrical polar coordinates. More...

static Offset	localCartesianOffset (std::string name, Vector_t< double, 3 > end_position, Vector_t< double, 3 > end_direction)
	Factory method to make an offset in cartesian coordinates local to the end of the previous element. More...

static Offset	globalCartesianOffset (std::string name, Vector_t< double, 3 > end_position, Vector_t< double, 3 > end_direction)
	Factory method to make an offset in global cartesian coordinates. More...

static double	getTheta (Vector_t< double, 3 > vec1, Vector_t< double, 3 > vec2)
	Calculate the angle between vectors on the midplane. More...

static Vector_t< double, 3 >	rotate (Vector_t< double, 3 > vec, double theta)
	Rotate vec anticlockwise by angle theta about z axis; return the rotated vector. More...

static std::string	getTypeString (ElementType type)

Static Public Attributes
static double	float_tolerance = 1e-12

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 Attributes
Vector_t< double, 3 >	_end_position

Vector_t< double, 3 >	_end_direction

bool	_is_local

Euclid3DGeometry *	geometry_m = nullptr

std::string	elementID

AttributeSet	userAttribs

WakeFunction *	wake_m

BoundaryGeometry *	bgeometry_m

ParticleMatterInteractionHandler *	parmatint_m

bool	positionIsFixed

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

std::string	outputfn_m
	The name of the outputfile. More...

bool	deleteOnTransverseExit_m = true

int	refCount


double	elementPosition_m
	ELEMEDGE attribute. More...

bool	elemedgeSet_m

Static Private Attributes
static const double	lengthUnits_m = 1e3

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

Detailed Description

@Class Offset

Enables user to define a placement, either in global coordinates or in the coordinate system of the previously placed object

Parameters

_end_position	final position of the offset
_end_direction	normal vector to entry face
_is_local	parameter is True if everything is in the coordinate system of the last placed object. It is expected that everything will be in a local coordinate system before tracking begins (this is expected by, for example, Ring). This is expected to be set by the visit function in e.g. ParallelCyclotronTracker.
geometry	the geometry that RingSection uses to do displacements This has to be a pointer because SRotatedGeometry does not have an defined assignment op. SRotatedGeometry does not have a assignment op because BGeometryBase does not have an assignment op... and there is no way (I think) to reassign a previously assigned variable in C++ without using =
wrappedGeometry	Something to do with the reference handling in SRotatedGeometry - looks like it doesn't make a copy but holds a reference, so unless I keep that alive in Offset I get memory errors (seg fault) @float_tolerance bends() and operator==(...) use float_tolerance when evaluating equality between doubles. @lengthUnits_m conversion factor from user interface to get to mm

WARNING: this object uses a default aperture that is large. It will screw up any calculation based on aperture (e.g. wakefields etc)

Definition at line 66 of file Offset.h.

Constructor & Destructor Documentation

◆ Offset() [1/4]

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

explicit

Constructor sets everything to 0., makes a default geometry with everything set to 0.

Definition at line 40 of file Offset.cpp.

References geometry_m.

◆ Offset() [2/4]

Offset::Offset ( )

Default constructor sets everything to 0., makes a default geometry with everything set to 0.

Definition at line 44 of file Offset.cpp.

Referenced by clone().

◆ Offset() [3/4]

Offset::Offset	(	std::string	name,
		const Offset &	rhs
	)

Copy constructor; deep copies geometry_m; all other stuff is copied as well.

Definition at line 47 of file Offset.cpp.

References ElementBase::setName().

Here is the call graph for this function:

◆ Offset() [4/4]

Offset::Offset ( const Offset & rhs )

Copy constructor; deep copies geometry_m; all other stuff is copied as well.

Definition at line 53 of file Offset.cpp.

◆ ~Offset()

Offset::~Offset ( )

deletes geometry and wrappedGeometry

Definition at line 58 of file Offset.cpp.

References geometry_m.

Member Function Documentation

◆ accept()

void Offset::accept ( BeamlineVisitor & visitor ) const

overridevirtual

Apply visitor to Offset.

Sets ring radius

Implements ElementBase.

Definition at line 82 of file Offset.cpp.

References BeamlineVisitor::visitOffset().

Here is the call graph for this function:

◆ addReference()

int RCObject::addReference ( ) const

inlineinherited

Increment reference count.

Definition at line 83 of file RCObject.h.

References RCObject::refCount.

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

◆ apply() [1/2]

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

virtualinherited

Reimplemented in Corrector, MultipoleTBase, VerticalFFAMagnet, Monitor, Multipole, MultipoleT, PluginElement, RFCavity, ScalingFFAMagnet, Solenoid, TravelingWave, and Ring.

Definition at line 80 of file Component.cpp.

Referenced by RingSection::getFieldValue(), DumpEMFields::writeFieldLine(), and DumpFields::writeFieldThis().

◆ apply() [2/2]

bool Component::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
	)

virtualinherited

Reimplemented in Corrector, MultipoleTBase, PluginElement, VerticalFFAMagnet, Monitor, Multipole, MultipoleT, RFCavity, Ring, ScalingFFAMagnet, Solenoid, and TravelingWave.

Definition at line 90 of file Component.cpp.

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

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

overridevirtual

Returns true if either input angle or output angle are greater than float_tolerance.

Implements Component.

Definition at line 227 of file Offset.cpp.

References float_tolerance, geometry_m, Rotation3D::getAxis(), Euclid3D::getRotation(), Euclid3DGeometry::getTotalTransform(), and Euclid3D::getVector().

Here is the call graph for this function:

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

Here is the call graph for this function:

◆ Bfield() [2/2]

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

inlineinherited

Return the field in a point.

Definition at line 204 of file Component.h.

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

Here is the call graph for this function:

◆ clone()

ElementBase * Offset::clone ( ) const

overridevirtual

Just calls the copy constructor on *this.

Implements ElementBase.

Definition at line 102 of file Offset.cpp.

References Offset().

Here is the call graph for this function:

◆ copyStructure()

ElementBase * ElementBase::copyStructure ( )

virtualinherited

Make a structural copy.

Reimplemented in TBeamline< T >.

Definition at line 204 of file ElementBase.cpp.

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

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

Here is the call graph for this function:

◆ EBfield() [1/2]

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

inlineinherited

Return the field in a point.

Definition at line 208 of file Component.h.

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

Here is the call graph for this function:

◆ EBfield() [2/2]

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

inlineinherited

Return the field in a point.

Definition at line 212 of file Component.h.

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

Here is the call graph for this function:

◆ Efield() [1/2]

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

inlineinherited

Return the field in a point.

Definition at line 192 of file Component.h.

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

Here is the call graph for this function:

◆ Efield() [2/2]

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

inlineinherited

Return the field in a point.

Definition at line 200 of file Component.h.

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

Here is the call graph for this function:

◆ finalise()

void Offset::finalise ( )

overridevirtual

Implements Component.

Definition at line 98 of file Offset.cpp.

References Component::RefPartBunch_m.

◆ fixPosition()

void ElementBase::fixPosition ( )

inlineinherited

Definition at line 521 of file ElementBase.h.

References ElementBase::positionIsFixed.

Referenced by OpalElement::update().

◆ getAperture()

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

inlineinherited

Definition at line 500 of file ElementBase.h.

References ElementBase::aperture_m.

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

◆ getArcLength()

double ElementBase::getArcLength ( ) const

inlinevirtualinherited

Get arc length.

Reimplemented in MarkerRep, and TBeamline< T >.

Definition at line 392 of file ElementBase.h.

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

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

Here is the call graph for this function:

◆ getAttribute()

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

virtualinherited

Get attribute value.

Definition at line 153 of file ElementBase.cpp.

References ElementBase::getConstChannel().

Here is the call graph for this function:

◆ getBoundaryGeometry()

BoundaryGeometry * ElementBase::getBoundaryGeometry ( ) const

inlinevirtualinherited

return the attached boundary geometrt object if there is any

Definition at line 456 of file ElementBase.h.

References ElementBase::bgeometry_m.

◆ getBoundingBoxInLabCoords()

BoundingBox ElementBase::getBoundingBoxInLabCoords ( ) const

virtualinherited

Definition at line 272 of file ElementBase.cpp.

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

Here is the call graph for this function:

◆ 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 AttributeSet::getChannel(), and ElementBase::userAttribs.

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

Here is the call graph for this function:

◆ getConstChannel()

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

virtualinherited

Construct a read-only channel.

Definition at line 194 of file ElementBase.cpp.

References ElementBase::getChannel().

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

Here is the call graph for this function:

◆ getCSTrafoGlobal2Local()

CoordinateSystemTrafo ElementBase::getCSTrafoGlobal2Local ( ) const

inlineinherited

Definition at line 479 of file ElementBase.h.

References ElementBase::csTrafoGlobal2Local_m.

Referenced by MeshGenerator::add().

◆ getDesign()

const ElementBase & Component::getDesign ( ) const

virtualinherited

Return design element.

Definition at line 52 of file Component.cpp.

◆ getDesignEnergy()

double Component::getDesignEnergy ( ) const

inlinevirtualinherited

Reimplemented in RFCavity.

Definition at line 231 of file Component.h.

◆ getDimensions()

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

inlineoverridevirtual

Implements Component.

Definition at line 163 of file Offset.h.

◆ getEdgeToBegin()

CoordinateSystemTrafo ElementBase::getEdgeToBegin ( ) const

inlinevirtualinherited

Reimplemented in RFCavity, Solenoid, and TravelingWave.

Definition at line 483 of file ElementBase.h.

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

◆ getEdgeToEnd()

CoordinateSystemTrafo ElementBase::getEdgeToEnd ( ) const

inlinevirtualinherited

Reimplemented in RFCavity, Solenoid, and TravelingWave.

Definition at line 488 of file ElementBase.h.

References ElementBase::getElementLength().

Referenced by ElementBase::getBoundingBoxInLabCoords().

Here is the call graph for this function:

◆ getElementDimensions()

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

inlinevirtualinherited

Reimplemented in RFCavity, TravelingWave, and Solenoid.

Definition at line 159 of file ElementBase.h.

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

Referenced by MeshGenerator::add().

Here is the call graph for this function:

◆ getElementLength()

double ElementBase::getElementLength ( ) const

inlinevirtualinherited

Get design length.

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

Definition at line 396 of file ElementBase.h.

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

Referenced by Multipole::apply(), Component::apply(), Corrector::apply(), Solenoid::apply(), Component::applyToReferenceParticle(), Multipole::applyToReferenceParticle(), Solenoid::applyToReferenceParticle(), Corrector::getDimensions(), Drift::getDimensions(), Multipole::getDimensions(), Solenoid::getDimensions(), ElementBase::getEdgeToEnd(), Solenoid::getEdgeToEnd(), ElementBase::getElementDimensions(), Solenoid::getElementDimensions(), BeamlineGeometry::getElementLength(), RFCavity::getElementLength(), Corrector::initialise(), Drift::initialise(), Multipole::initialise(), Solenoid::initialise(), ElementBase::isInside(), Monitor::isInside(), Multipole::isInside(), and ElementBase::isInsideTransverse().

Here is the call graph for this function:

◆ getElementPosition()

double ElementBase::getElementPosition ( ) const

inlineinherited

Definition at line 553 of file ElementBase.h.

References ElementBase::elemedgeSet_m, ElementBase::elementPosition_m, and ElementBase::getName().

Here is the call graph for this function:

◆ getEndDirection()

Vector_t< double, 3 > Offset::getEndDirection ( ) const

Definition at line 118 of file Offset.cpp.

References _end_direction.

Referenced by operator<<(), operator==(), and updateGeometry().

◆ getEndPosition()

Vector_t< double, 3 > Offset::getEndPosition ( ) const

Definition at line 110 of file Offset.cpp.

References _end_position.

Referenced by operator<<(), operator==(), and updateGeometry().

◆ getEntrance()

double ElementBase::getEntrance ( ) const

inlinevirtualinherited

Get entrance position.

Reimplemented in TBeamline< T >.

Definition at line 408 of file ElementBase.h.

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

Referenced by BeamlineGeometry::getEntrance().

Here is the call graph for this function:

◆ getEntranceFrame()

Euclid3D ElementBase::getEntranceFrame ( ) const

inlinevirtualinherited

Get transform.

Reimplemented in TBeamline< T >.

Definition at line 428 of file ElementBase.h.

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

Referenced by BeamlineGeometry::getEntranceFrame().

Here is the call graph for this function:

◆ getEntrancePatch()

Euclid3D ElementBase::getEntrancePatch ( ) const

inlinevirtualinherited

Get patch.

Definition at line 436 of file ElementBase.h.

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

Here is the call graph for this function:

◆ getExit()

double ElementBase::getExit ( ) const

inlinevirtualinherited

Get exit position.

Reimplemented in TBeamline< T >.

Definition at line 412 of file ElementBase.h.

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

Referenced by BeamlineGeometry::getExit().

Here is the call graph for this function:

◆ getExitFrame()

Euclid3D ElementBase::getExitFrame ( ) const

inlinevirtualinherited

Get transform.

Reimplemented in TBeamline< T >.

Definition at line 432 of file ElementBase.h.

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

Referenced by BeamlineGeometry::getExitFrame().

Here is the call graph for this function:

◆ getExitPatch()

Euclid3D ElementBase::getExitPatch ( ) const

inlinevirtualinherited

Get patch.

Definition at line 440 of file ElementBase.h.

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

Here is the call graph for this function:

◆ getField() [1/2]

const EMField & Offset::getField ( ) const

overridevirtual

Not implemented - throws GeneralClassicException.

Implements Component.

Definition at line 90 of file Offset.cpp.

◆ getField() [2/2]

EMField & Offset::getField ( )

overridevirtual

Not implemented - throws GeneralClassicException.

Implements Component.

Definition at line 86 of file Offset.cpp.

◆ getFlagDeleteOnTransverseExit()

bool ElementBase::getFlagDeleteOnTransverseExit ( ) const

inlineinherited

Definition at line 574 of file ElementBase.h.

References ElementBase::deleteOnTransverseExit_m.

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

◆ getGeometry() [1/2]

const Euclid3DGeometry & Offset::getGeometry ( ) const

overridevirtual

Get geometry.

Implements ElementBase.

Definition at line 134 of file Offset.cpp.

References geometry_m.

◆ getGeometry() [2/2]

Euclid3DGeometry & Offset::getGeometry ( )

overridevirtual

Get geometry.

Implements ElementBase.

Definition at line 130 of file Offset.cpp.

References geometry_m.

Referenced by operator==().

◆ getIsLocal()

bool Offset::getIsLocal ( ) const

Returns true if stored coordinates are in the local coordinate system of the last placed object.

Definition at line 126 of file Offset.cpp.

References _is_local.

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

◆ getMisalignment() [1/2]

CoordinateSystemTrafo ElementBase::getMisalignment ( ) const

inlineinherited

Definition at line 513 of file ElementBase.h.

References ElementBase::misalignment_m.

◆ getMisalignment() [2/2]

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

inherited

◆ getName()

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

virtualinherited

◆ getOrigin()

double ElementBase::getOrigin ( ) const

inlinevirtualinherited

Get origin position.

Reimplemented in TBeamline< T >.

Definition at line 404 of file ElementBase.h.

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

Referenced by BeamlineGeometry::getOrigin().

Here is the call graph for this function:

◆ getOutputFN()

std::string ElementBase::getOutputFN ( ) const

inherited

Get output filename.

Definition at line 144 of file ElementBase.cpp.

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

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

Here is the call graph for this function:

◆ getParticleMatterInteraction()

ParticleMatterInteractionHandler * ElementBase::getParticleMatterInteraction ( ) const

inlinevirtualinherited

Definition at line 464 of file ElementBase.h.

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

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

◆ getTheta()

double Offset::getTheta	(	Vector_t< double, 3 >	vec1,
		Vector_t< double, 3 >	vec2
	)

static

Calculate the angle between vectors on the midplane.

Returns theta in domain -pi, pi. A positive angle means a rotation anticlockwise from vec1 to vec2.

Throws an GeneralClassicException if vec1, vec2 are not in the midplane i.e. non-zero z.

Definition at line 143 of file Offset.cpp.

References Physics::e, and Physics::pi.

Referenced by updateGeometry().

◆ getTotalTransform()

Euclid3D ElementBase::getTotalTransform ( ) const

inlinevirtualinherited

Get transform.

Reimplemented in TBeamline< T >.

Definition at line 420 of file ElementBase.h.

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

Referenced by BeamlineGeometry::getTotalTransform().

Here is the call graph for this function:

◆ getTransform() [1/2]

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

inlinevirtualinherited

Get transform.

Reimplemented in TBeamline< T >.

Definition at line 416 of file ElementBase.h.

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

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

Here is the call graph for this function:

◆ getTransform() [2/2]

Euclid3D ElementBase::getTransform ( double s ) const

inlinevirtualinherited

Get transform.

Reimplemented in TBeamline< T >.

Definition at line 424 of file ElementBase.h.

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

Referenced by ElementBase::getTypeString().

Here is the call graph for this function:

◆ getTypeString() [2/2]

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

staticinherited

Definition at line 200 of file ElementBase.cpp.

References ElementBase::elementTypeToString_s.

◆ getWake()

WakeFunction * ElementBase::getWake ( ) const

inlinevirtualinherited

return the attached wake object if there is any

Definition at line 448 of file ElementBase.h.

References ElementBase::wake_m.

◆ globalCartesianOffset()

Offset Offset::globalCartesianOffset	(	std::string	name,
		Vector_t< double, 3 >	end_position,
		Vector_t< double, 3 >	end_direction
	)

static

Factory method to make an offset in global cartesian coordinates.

name name of the offset
end_position position of the end of the offset
end_direction direction of the end of the offset Call updateGeometry(Vector_t<double, 3>, Vector_t<double, 3>) using the end of the previous element before placement; Offset will convert to the local coordinate system.

Definition at line 280 of file Offset.cpp.

References lengthUnits_m, setEndDirection(), setEndPosition(), and setIsLocal().

Referenced by OpalOffset::OpalGlobalCartesianOffset::update().

Here is the call graph for this function:

◆ globalCylindricalOffset()

Offset Offset::globalCylindricalOffset	(	std::string	name,
		double	radius_out,
		double	phi_out,
		double	theta_out
	)

static

Factory method to make an offset in global cylindrical polar coordinates.

name name of the offset
radius_out radius of the end of the offset
phi_out azimuthal angle of the end of the offset
theta_out angle relative to the tangent of the end of the offset Call updateGeometry(Vector_t<double, 3>, Vector_t<double, 3>) using the end of the previous element before placement; Offset will convert to the local coordinate system.

Definition at line 257 of file Offset.cpp.

References lengthUnits_m, setEndDirection(), setEndPosition(), and setIsLocal().

Referenced by OpalOffset::OpalGlobalCylindricalOffset::update().

Here is the call graph for this function:

◆ goOffline()

void Component::goOffline ( )

virtualinherited

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

Definition at line 68 of file Component.cpp.

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

Referenced by PluginElement::initialise().

◆ hasAttribute()

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

virtualinherited

Test for existence of an attribute.

Definition at line 165 of file ElementBase.cpp.

References ElementBase::getConstChannel().

Here is the call graph for this function:

◆ hasBoundaryGeometry()

bool ElementBase::hasBoundaryGeometry ( ) const

inlinevirtualinherited

Definition at line 460 of file ElementBase.h.

References ElementBase::bgeometry_m.

◆ hasParticleMatterInteraction()

bool ElementBase::hasParticleMatterInteraction ( ) const

inlinevirtualinherited

Definition at line 468 of file ElementBase.h.

References ElementBase::parmatint_m.

◆ hasWake()

bool ElementBase::hasWake ( ) const

inlinevirtualinherited

Definition at line 452 of file ElementBase.h.

References ElementBase::wake_m.

◆ initialise()

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

overridevirtual

Implements Component.

Definition at line 94 of file Offset.cpp.

References Component::RefPartBunch_m.

◆ isElementPositionSet()

bool ElementBase::isElementPositionSet ( ) const

inlineinherited

Definition at line 562 of file ElementBase.h.

References ElementBase::elemedgeSet_m.

◆ isGeometryAllocated()

bool Offset::isGeometryAllocated ( ) const

Definition at line 189 of file Offset.cpp.

References geometry_m.

Referenced by operator==().

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

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

Here is the call graph for this function:

◆ isPositioned()

bool ElementBase::isPositioned ( ) const

inlineinherited

Definition at line 525 of file ElementBase.h.

References ElementBase::positionIsFixed.

◆ isSharable()

bool ElementBase::isSharable ( ) const

inlineinherited

Test if the element can be shared.

Definition at line 444 of file ElementBase.h.

References ElementBase::shareFlag.

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

◆ isShared()

bool RCObject::isShared ( ) const

inlineinherited

Test for sharing.

Definition at line 93 of file RCObject.h.

References RCObject::refCount.

◆ localCartesianOffset()

Offset Offset::localCartesianOffset	(	std::string	name,
		Vector_t< double, 3 >	end_position,
		Vector_t< double, 3 >	end_direction
	)

static

Factory method to make an offset in cartesian coordinates local to the end of the previous element.

name name of the offset
end_position position of the end of the offset
end_direction direction of the end of the offset

Definition at line 269 of file Offset.cpp.

References lengthUnits_m, setEndDirection(), setEndPosition(), setIsLocal(), and updateGeometry().

Referenced by OpalOffset::OpalLocalCartesianOffset::update().

Here is the call graph for this function:

◆ localCylindricalOffset()

Offset Offset::localCylindricalOffset	(	std::string	name,
		double	theta_in,
		double	theta_out,
		double	displacement
	)

static

Factory method to make an offset in Cylindrical coordinates local to the end of the previous element.

name name of the offset
theta_in angle between the previous element and the displacement vector
theta_out angle between the displacement vector and the next element
displacement length of the displacement vector in the theta_in direction

Definition at line 244 of file Offset.cpp.

References lengthUnits_m, setEndDirection(), setEndPosition(), setIsLocal(), and updateGeometry().

Referenced by OpalOffset::OpalLocalCylindricalOffset::update().

Here is the call graph for this function:

◆ makeSharable()

void ElementBase::makeSharable ( )

virtualinherited

Set sharable flag.

Reimplemented in TBeamline< T >.

Definition at line 212 of file ElementBase.cpp.

References ElementBase::shareFlag.

Referenced by OpalMarker::OpalMarker().

◆ Online()

bool Component::Online ( )

virtualinherited

Definition at line 72 of file Component.cpp.

References Component::online_m.

◆ operator=()

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

Assignment operator deep copies geometry and wrappedGeometry; all other stuff is copied as well.

Definition at line 62 of file Offset.cpp.

References _end_direction, _end_position, _is_local, geometry_m, ElementBase::getAperture(), ElementBase::getName(), Euclid3DGeometry::getTotalTransform(), ElementBase::setAperture(), and ElementBase::setName().

Here is the call graph for this function:

◆ releasePosition()

void ElementBase::releasePosition ( )

inlineinherited

Definition at line 517 of file ElementBase.h.

References ElementBase::positionIsFixed.

◆ removeAttribute()

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

virtualinherited

Remove an existing attribute.

Definition at line 176 of file ElementBase.cpp.

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

Here is the call graph for this function:

◆ removeReference()

int RCObject::removeReference ( ) const

inlineinherited

Decrement the reference count.

Definition at line 88 of file RCObject.h.

References RCObject::refCount.

◆ rotate()

Vector_t< double, 3 > Offset::rotate	(	Vector_t< double, 3 >	vec,
		double	theta
	)

static

Rotate vec anticlockwise by angle theta about z axis; return the rotated vector.

Definition at line 154 of file Offset.cpp.

References Physics::c.

Referenced by updateGeometry().

◆ setActionRange()

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

inlineinherited

Definition at line 529 of file ElementBase.h.

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

◆ setAperture()

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

inlineinherited

Definition at line 495 of file ElementBase.h.

References ElementBase::aperture_m.

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

◆ 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 endl(), ElementBase::getChannel(), and Channel::isSettable().

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

Here is the call graph for this function:

◆ setBoundaryGeometry()

void ElementBase::setBoundaryGeometry ( BoundaryGeometry * geo )

virtualinherited

attach a boundary geometry field to the element

Definition at line 228 of file ElementBase.cpp.

References ElementBase::bgeometry_m.

◆ setCSTrafoGlobal2Local()

void ElementBase::setCSTrafoGlobal2Local ( const CoordinateSystemTrafo & ori )

inlineinherited

Definition at line 472 of file ElementBase.h.

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

Referenced by OpalElement::update().

◆ setCurrentSCoordinate()

void ElementBase::setCurrentSCoordinate ( double s )

inherited

Definition at line 236 of file ElementBase.cpp.

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

◆ setDesignEnergy()

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

inlinevirtualinherited

Reimplemented in Corrector, 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 ElementBase::getGeometry(), and BGeometryBase::setElementLength().

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

Here is the call graph for this function:

◆ setElementPosition()

void ElementBase::setElementPosition ( double elemedge )

inlineinherited

Access to ELEMEDGE attribute.

Definition at line 548 of file ElementBase.h.

References ElementBase::elemedgeSet_m, and ElementBase::elementPosition_m.

Referenced by OpalElement::update().

◆ setEndDirection()

void Offset::setEndDirection ( Vector_t< double, 3 > direction )

Definition at line 114 of file Offset.cpp.

References _end_direction.

Referenced by globalCartesianOffset(), globalCylindricalOffset(), localCartesianOffset(), and localCylindricalOffset().

◆ setEndPosition()

void Offset::setEndPosition ( Vector_t< double, 3 > position )

Definition at line 106 of file Offset.cpp.

References _end_position.

Referenced by globalCartesianOffset(), globalCylindricalOffset(), localCartesianOffset(), and localCylindricalOffset().

◆ setExitFaceSlope()

void Component::setExitFaceSlope ( const double & m )

inlineinherited

Definition at line 224 of file Component.h.

References Component::exit_face_slope_m.

◆ setFlagDeleteOnTransverseExit()

void ElementBase::setFlagDeleteOnTransverseExit ( bool flag = true )

inlineinherited

Definition at line 570 of file ElementBase.h.

References ElementBase::deleteOnTransverseExit_m.

Referenced by OpalElement::update().

◆ setIsLocal()

void Offset::setIsLocal ( bool isLocal )

Set to true if stored coordinates are in the local coordinate system of the last placed object.

Definition at line 122 of file Offset.cpp.

References _is_local.

Referenced by globalCartesianOffset(), globalCylindricalOffset(), localCartesianOffset(), and localCylindricalOffset().

◆ setMisalignment()

void ElementBase::setMisalignment ( const CoordinateSystemTrafo & cst )

inlineinherited

Definition at line 509 of file ElementBase.h.

References ElementBase::misalignment_m.

Referenced by OpalElement::update().

◆ setName()

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

virtualinherited

Set element name.

Definition at line 136 of file ElementBase.cpp.

References ElementBase::elementID.

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

◆ setOutputFN()

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

inherited

Set output filename.

Definition at line 140 of file ElementBase.cpp.

References ElementBase::outputfn_m.

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

◆ setParticleMatterInteraction()

void ElementBase::setParticleMatterInteraction ( ParticleMatterInteractionHandler * spys )

virtualinherited

Definition at line 232 of file ElementBase.cpp.

References ElementBase::parmatint_m.

◆ setRotationAboutZ()

void ElementBase::setRotationAboutZ ( double rotation )

inlineinherited

Set rotation about z axis in bend frame.

Definition at line 536 of file ElementBase.h.

References ElementBase::rotationZAxis_m.

Referenced by OpalElement::update().

◆ setWake()

void ElementBase::setWake ( WakeFunction * wf )

virtualinherited

attach a wake field to the element

Definition at line 224 of file ElementBase.cpp.

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

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

Here is the call graph for this function:

◆ updateGeometry() [1/2]

void Offset::updateGeometry ( )

Definition at line 160 of file Offset.cpp.

References _is_local, geometry_m, getEndDirection(), getEndPosition(), and getTheta().

Referenced by updateGeometry().

Here is the call graph for this function:

◆ updateGeometry() [2/2]

void Offset::updateGeometry	(	Vector_t< double, 3 >	startPosition,
		Vector_t< double, 3 >	startDirection
	)

Definition at line 177 of file Offset.cpp.

References _end_direction, _end_position, _is_local, getTheta(), rotate(), and updateGeometry().

Referenced by localCartesianOffset(), localCylindricalOffset(), and ParallelTracker::visitOffset().

Here is the call graph for this function:

Member Data Documentation

◆ _end_direction

Vector_t<double, 3> Offset::_end_direction

private

Definition at line 209 of file Offset.h.

Referenced by getEndDirection(), operator=(), setEndDirection(), and updateGeometry().

◆ _end_position

Vector_t<double, 3> Offset::_end_position

private

Definition at line 208 of file Offset.h.

Referenced by getEndPosition(), operator=(), setEndPosition(), and updateGeometry().

◆ _is_local

bool Offset::_is_local

private

Definition at line 210 of file Offset.h.

Referenced by getIsLocal(), operator=(), setIsLocal(), and updateGeometry().

◆ actionRange_m

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

privateinherited

Definition at line 382 of file ElementBase.h.

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

◆ aperture_m

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

protectedinherited

Definition at line 353 of file ElementBase.h.

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

◆ bgeometry_m

BoundaryGeometry* ElementBase::bgeometry_m

privateinherited

Definition at line 373 of file ElementBase.h.

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

◆ csTrafoGlobal2Local_m

CoordinateSystemTrafo ElementBase::csTrafoGlobal2Local_m

protectedinherited

Definition at line 350 of file ElementBase.h.

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

◆ deleteOnTransverseExit_m

bool ElementBase::deleteOnTransverseExit_m = true

privateinherited

Definition at line 386 of file ElementBase.h.

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

◆ elemedgeSet_m

bool ElementBase::elemedgeSet_m

privateinherited

Definition at line 380 of file ElementBase.h.

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

◆ elementEdge_m

double ElementBase::elementEdge_m

protectedinherited

Definition at line 355 of file ElementBase.h.

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

◆ elementID

std::string ElementBase::elementID

privateinherited

Definition at line 364 of file ElementBase.h.

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

◆ elementPosition_m

double ElementBase::elementPosition_m

privateinherited

ELEMEDGE attribute.

Definition at line 379 of file ElementBase.h.

Referenced by ElementBase::getElementPosition(), and ElementBase::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 366 of file ElementBase.h.

Referenced by ElementBase::getTypeString().

◆ exit_face_slope_m

double Component::exit_face_slope_m

protectedinherited

Definition at line 183 of file Component.h.

Referenced by Component::setExitFaceSlope().

◆ float_tolerance

double Offset::float_tolerance = 1e-12

static

Definition at line 206 of file Offset.h.

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

◆ geometry_m

Euclid3DGeometry* Offset::geometry_m = nullptr

private

Definition at line 212 of file Offset.h.

Referenced by bends(), getGeometry(), isGeometryAllocated(), Offset(), operator=(), updateGeometry(), and ~Offset().

◆ lengthUnits_m

const double Offset::lengthUnits_m = 1e3

staticprivate

Definition at line 213 of file Offset.h.

Referenced by globalCartesianOffset(), globalCylindricalOffset(), localCartesianOffset(), and localCylindricalOffset().

◆ misalignment_m

CoordinateSystemTrafo ElementBase::misalignment_m

protectedinherited

Definition at line 351 of file ElementBase.h.

Referenced by ElementBase::getMisalignment(), and ElementBase::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 ElementBase::setOutputFN().

◆ parmatint_m

ParticleMatterInteractionHandler* ElementBase::parmatint_m

privateinherited

Definition at line 375 of file ElementBase.h.

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

◆ positionIsFixed

bool ElementBase::positionIsFixed

privateinherited

Definition at line 377 of file ElementBase.h.

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

◆ refCount

int RCObject::refCount

mutableprivateinherited

Definition at line 76 of file RCObject.h.

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

◆ RefPartBunch_m

PartBunch_t* Component::RefPartBunch_m

protectedinherited

Definition at line 185 of file Component.h.

Referenced by Corrector::apply(), MultipoleTBase::apply(), VerticalFFAMagnet::apply(), Multipole::apply(), MultipoleT::apply(), RFCavity::apply(), ScalingFFAMagnet::apply(), Solenoid::apply(), TravelingWave::apply(), Ring::apply(), MultipoleTBase::finalise(), VerticalFFAMagnet::finalise(), MultipoleT::finalise(), finalise(), ScalingFFAMagnet::finalise(), Corrector::goOnline(), PluginElement::initialise(), Corrector::initialise(), VerticalFFAMagnet::initialise(), Drift::initialise(), Marker::initialise(), Monitor::initialise(), Multipole::initialise(), MultipoleTCurvedConstRadius::initialise(), MultipoleTCurvedVarRadius::initialise(), MultipoleTStraight::initialise(), initialise(), RFCavity::initialise(), ScalingFFAMagnet::initialise(), Solenoid::initialise(), TravelingWave::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::getRotationAboutZ(), and ElementBase::setRotationAboutZ().

◆ shareFlag

bool ElementBase::shareFlag

mutableprotectedinherited

Definition at line 348 of file ElementBase.h.

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

◆ userAttribs

AttributeSet ElementBase::userAttribs

privateinherited

Definition at line 369 of file ElementBase.h.

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

◆ wake_m

WakeFunction* ElementBase::wake_m

privateinherited

Definition at line 371 of file ElementBase.h.

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

The documentation for this class was generated from the following files:

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Offset() [1/4]

◆ Offset() [2/4]

◆ Offset() [3/4]

◆ Offset() [4/4]

◆ ~Offset()

Member Function Documentation

◆ accept()

◆ addReference()

◆ apply() [1/2]

◆ apply() [2/2]

◆ applyToReferenceParticle()

◆ bends()

◆ Bfield() [1/2]

◆ Bfield() [2/2]

◆ clone()

◆ copyStructure()

◆ EBfield() [1/2]

◆ EBfield() [2/2]

◆ Efield() [1/2]

◆ Efield() [2/2]

◆ finalise()

◆ fixPosition()

◆ getAperture()

◆ getArcLength()

◆ getAttribute()

◆ getBoundaryGeometry()

◆ getBoundingBoxInLabCoords()

◆ getChannel()

◆ getConstChannel()

◆ getCSTrafoGlobal2Local()

◆ getDesign()

◆ getDesignEnergy()

◆ getDimensions()

◆ getEdgeToBegin()

◆ getEdgeToEnd()

◆ getElementDimensions()

◆ getElementLength()

◆ getElementPosition()

◆ getEndDirection()

◆ getEndPosition()

◆ getEntrance()

◆ getEntranceFrame()

◆ getEntrancePatch()

◆ getExit()

◆ getExitFrame()

◆ getExitPatch()

◆ getField() [1/2]

◆ getField() [2/2]

◆ getFlagDeleteOnTransverseExit()

◆ getGeometry() [1/2]

◆ getGeometry() [2/2]

◆ getIsLocal()

◆ getMisalignment() [1/2]

◆ getMisalignment() [2/2]

◆ getName()

◆ getOrigin()

◆ getOutputFN()

◆ getParticleMatterInteraction()

◆ getPotential()

◆ getRequiredNumberOfTimeSteps()

◆ getRotationAboutZ()

◆ getTheta()

◆ getTotalTransform()

◆ getTransform() [1/2]

◆ getTransform() [2/2]

◆ getType()

◆ getTypeString() [1/2]

◆ getTypeString() [2/2]

◆ getWake()

◆ globalCartesianOffset()