#include <SBendRep.h>

Inheritance diagram for SBendRep:

Collaboration diagram for SBendRep:

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

	SBendRep ()

	SBendRep (const SBendRep &)

virtual	~SBendRep ()

virtual ElementBase *	clone () const
	Return clone. More...

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

virtual BMultipoleField &	getField ()
	Get field. More...

virtual const BMultipoleField &	getField () const
	Get field. More...

virtual PlanarArcGeometry &	getGeometry ()
	Get geometry. More...

virtual const PlanarArcGeometry &	getGeometry () const
	Get geometry. More...

virtual double	getB () const
	Get field. More...

virtual void	setB (double By)
	Set vertical component. More...

virtual void	setField (const BMultipoleField &field)
	Set field. More...

virtual double	getEntryFaceRotation () const
	Get pole entry face rotation. More...

virtual double	getExitFaceRotation () const
	Get exit pole face rotation. More...

virtual double	getEntryFaceCurvature () const
	Get entry pole face curvature. More...

virtual double	getExitFaceCurvature () const
	Get exit pole face curvature. More...

virtual void	setEntryFaceRotation (double e1)
	Set pole entry face rotation. More...

virtual void	setExitFaceRotation (double e2)
	Set exit pole face rotation. More...

virtual void	setEntryFaceCurvature (double h1)
	Set entry pole face curvature. More...

virtual void	setExitFaceCurvature (double h2)
	Set exit pole face curvature. More...

virtual double	getSlices () const
	Get number of slices. More...

virtual double	getStepsize () const
	Get stepsize. More...

virtual void	setSlices (double sl)
	Set number of slices. More...

virtual void	setStepsize (double ds)
	Set stepsize. More...

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

double	getNormalComponent (int) const
	Get normal component. More...

double	getSkewComponent (int) const
	Get skew component. More...

void	setNormalComponent (int, double)
	Set normal component. More...

void	setSkewComponent (int, double)
	Set skew component. More...

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

virtual bool	apply (const size_t &i, const double &t, Vector_t &E, Vector_t &B) override
	Apply field to particles with coordinates in magnet frame. More...

virtual bool	apply (const Vector_t &R, const Vector_t &P, const double &t, Vector_t &E, Vector_t &B) override
	Apply field to particles in beam frame. More...

virtual bool	applyToReferenceParticle (const Vector_t &R, const Vector_t &P, const double &t, Vector_t &E, Vector_t &B) override

virtual void	goOnline (const double &kineticEnergy) override

virtual void	finalise () override

virtual void	getDimensions (double &sBegin, double &sEnd) const override

virtual void	initialise (PartBunchBase< double, 3 > *bunch, double &startField, double &endField) override

double	getBendRadius () const

double	getEffectiveCenter () const

double	getEffectiveLength () const

void	setK1 (double k1)
	Set quadrupole field component. More...

virtual void	setEntranceAngle (double entranceAngle) override

void	setExitAngle (double exitAngle)

virtual double	getExitAngle () const override

std::vector< Vector_t >	getOutline () const

MeshData	getSurfaceMesh () const

virtual CoordinateSystemTrafo	getEdgeToEnd () const override

CoordinateSystemTrafo	getBeginToEnd_local () const

virtual bool	isInside (const Vector_t &r) const override

void	setNSlices (const std::size_t &nSlices)

std::size_t	getNSlices () const

std::array< double, 2 >	getEntranceFringeFieldLength () const
	Get entrance fringe field length. More...

std::array< double, 2 >	getExitFringeFieldLength () const
	Get exit fringe field length. More...

BoundingBox	getBoundingBoxInLabCoords () const override

virtual bool	bends () const
	Indicates that element bends the beam. More...

double	getChordLength () const

virtual void	setBendAngle (double angle)

double	getBendAngle () const

double	getEntranceAngle () const

void	setFullGap (double)

double	getFullGap () const

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

double	getDesignEnergy () const

std::vector< Vector_t >	getDesignPath () const

void	setFieldAmplitude (double k0, double k0s)

double	getFieldAmplitude () const

void	setFieldMapFN (std::string fileName)

std::string	getFieldMapFN () const

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

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

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

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

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

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

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

virtual void	goOffline ()

virtual bool	Online ()

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

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

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

void	setExitFaceSlope (const double &)

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

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

std::string	getTypeString () const

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual 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

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

std::pair< ApertureType, std::vector< double > >	getAperture () 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 int	getRequiredNumberOfTimeSteps () const

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

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

void	setFlagDeleteOnTransverseExit (bool=true)

bool	getFlagDeleteOnTransverseExit () const

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

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

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


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

double	getElementPosition () const

bool	isElementPositionSet () const

Static Public Member Functions
static std::string	getTypeString (ElementType type)

Protected Member Functions
void	setMessageHeader (const std::string &header)

double	getStartField () const

double	calcDesignRadius (double fieldAmplitude) const
	Calculate design radius from design energy and field amplitude. More...

double	calcDesignRadius (double chordLength, double angle) const
	Calculate design radius from chord length and bend angle. More...

double	calcFieldAmplitude (double radius) const
	Calculate field amplitude from design energy and radius. More...

double	calcBendAngle (double chordLength, double radius) const
	Calculate bend angle from chord length and design radius. More...

double	calcGamma () const
	Calculate gamma from design energy. More...

double	calcBetaGamma () const
	Calculate beta*gamma from design energy. More...

bool	isInsideTransverse (const Vector_t &r) const

Protected Attributes
double	chordLength_m

double	angle_m
	Bend angle. More...

double	entranceAngle_m
	Angle between incoming reference trajectory and the entrance face of the magnet (radians). More...

Fieldmap	fieldmap_m
	Magnet field map. More...

const bool	fast_m = false
	Flag to turn on fast field calculation. More...

double	gap_m
	Full vertical gap of the magnets. More...

double	designEnergy_m
	Bend design energy (eV). More...

bool	designEnergyChangeable_m

std::vector< Vector_t >	refTrajMap_m
	Map of reference particle trajectory. More...

double	fieldAmplitudeX_m
	Field amplitude in x direction. More...

double	fieldAmplitudeY_m
	Field amplitude in y direction. More...

double	fieldAmplitude_m
	Field amplitude. More...

std::string	fileName_m

double	exit_face_slope_m

PartBunchBase< double, 3 > *	RefPartBunch_m

bool	online_m

bool	shareFlag

CoordinateSystemTrafo	csTrafoGlobal2Local_m

CoordinateSystemTrafo	misalignment_m

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

double	elementEdge_m

double	rotationZAxis_m

Static Protected Attributes
static const std::vector< double >	defaultAperture_m

Private Member Functions
void	operator= (const SBendRep &)

virtual bool	findChordLength (double &chordLength) override

void	adjustFringeFields (double ratio)

double	calculateBendAngle ()

void	calcEngeFunction (double zNormalized, const std::vector< double > &engeCoeff, int polyOrder, double &engeFunc, double &engeFuncDeriv, double &engeFuncSecDerivNorm)

Vector_t	calcCentralField (const Vector_t &R, double deltaX)

Vector_t	calcEntranceFringeField (const Vector_t &R, double deltaX)

Vector_t	calcExitFringeField (const Vector_t &R, double deltaX)

void	setupFringeWidths ()

bool	calculateMapField (const Vector_t &R, Vector_t &B)

void	calculateRefTrajectory (double &angleX, double &angleY)

double	estimateFieldAdjustmentStep (double actualBendAngle)

void	findBendEffectiveLength (double startField, double endField)

void	findBendStrength ()

bool	findIdealBendParameters (double chordLength)

bool	initializeFieldMap ()

bool	inMagnetCentralRegion (const Vector_t &R) const

bool	inMagnetEntranceRegion (const Vector_t &R) const

bool	inMagnetExitRegion (const Vector_t &R) const

bool	isPositionInEntranceField (const Vector_t &R) const

bool	isPositionInExitField (const Vector_t &R) const

void	print (Inform &msg, double bendAngleX, double bendAngle)

void	readFieldMap (Inform &msg)

void	setBendEffectiveLength (double startField, double endField)

void	setBendStrength ()

void	setEngeOriginDelta (double delta)

void	setFieldCalcParam ()

void	setGapFromFieldMap ()

bool	setupBendGeometry (double &startField, double &endField)

bool	setupDefaultFieldMap ()

void	setFieldBoundaries (double startField, double endField)

void	setupPusher (PartBunchBase< double, 3 > *bunch)

bool	isFieldZero ()

void	setCSTrafoToEntranceRegion (const CoordinateSystemTrafo &trafo)

void	setCSTrafoToExitRegion (const CoordinateSystemTrafo &trafo)

Vector_t	transformToEntranceRegion (const Vector_t &R) const

Vector_t	transformToExitRegion (const Vector_t &R) const

Private Attributes
PlanarArcGeometry	geometry
	The bend geometry. More...

BMultipoleField	field
	The multipole expansion. More...

double	rEntry

double	rExit

double	hEntry

double	hExit

double	slices

double	stepsize

std::string	messageHeader_m

BorisPusher	pusher_m

double	designRadius_m
	Pusher used to integrate reference particle. More...

double	exitAngle_m
	Bend design radius (m). More...

double	fieldIndex_m
	Angle between outgoing reference trajectory. More...

double	startField_m
	Dipole field index. More...

double	endField_m
	Start of magnet field map in s coordinates (m). More...

double	widthEntranceFringe_m
	End of magnet field map in s coordinates (m). More...

double	widthExitFringe_m

bool	reinitialize_m

double	entranceParameter1_m

double	entranceParameter2_m

double	entranceParameter3_m

double	exitParameter1_m

double	exitParameter2_m

double	exitParameter3_m

std::vector< double >	engeCoeffsEntry_m
	Enge coefficients for map entry and exit regions. More...

std::vector< double >	engeCoeffsExit_m

gsl_spline **	entryFieldValues_m

gsl_spline **	exitFieldValues_m

gsl_interp_accel *	entryFieldAccel_m

gsl_interp_accel *	exitFieldAccel_m

double	deltaBeginEntry_m

double	deltaEndEntry_m
	Perpendicular distance from entrance Enge. More...

int	polyOrderEntry_m
	Perpendicular distance from entrance Enge. More...

double	deltaBeginExit_m
	Enge function order for entry region. More...

double	deltaEndExit_m
	Perpendicular distance from exit Enge. More...

int	polyOrderExit_m
	Perpendicular distance from exit Enge. More...

double	cosEntranceAngle_m
	Enge function order for entry region. More...

double	sinEntranceAngle_m

double	tanEntranceAngle_m

double	tanExitAngle_m

CoordinateSystemTrafo	beginToEnd_m

CoordinateSystemTrafo	beginToEnd_lcs_m

CoordinateSystemTrafo	toEntranceRegion_m

CoordinateSystemTrafo	toExitRegion_m

CoordinateSystemTrafo	computeAngleTrafo_m

double	maxAngle_m

std::size_t	nSlices_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
	The name of the outputfile. More...

bool	deleteOnTransverseExit_m = true

int	refCount


double	elementPosition_m
	ELEMEDGE attribute. More...

bool	elemedgeSet_m

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

Detailed Description

Definition at line 28 of file SBendRep.h.

Constructor & Destructor Documentation

◆ SBendRep() [1/3]

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

explicit

Constructor with given name.

Definition at line 87 of file SBendRep.cpp.

References hEntry, hExit, rEntry, and rExit.

◆ SBendRep() [2/3]

SBendRep::SBendRep ( )

Definition at line 68 of file SBendRep.cpp.

References hEntry, hExit, rEntry, and rExit.

Referenced by clone().

◆ SBendRep() [3/3]

SBendRep::SBendRep ( const SBendRep & rhs )

Definition at line 76 of file SBendRep.cpp.

References hEntry, hExit, rEntry, and rExit.

◆ ~SBendRep()

SBendRep::~SBendRep ( )

virtual

Definition at line 95 of file SBendRep.cpp.

Member Function Documentation

◆ accept()

void SBend::accept ( BeamlineVisitor & visitor ) const

overridevirtualinherited

Apply visitor to SBend.

Implements Bend2D.

Definition at line 51 of file SBend.cpp.

References BeamlineVisitor::visitSBend().

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

◆ adjustFringeFields()

void Bend2D::adjustFringeFields ( double ratio )

privateinherited

Definition at line 234 of file Bend2D.cpp.

References abs(), BendBase::chordLength_m, Bend2D::entranceParameter1_m, Bend2D::entranceParameter2_m, Bend2D::entranceParameter3_m, Bend2D::exitParameter1_m, Bend2D::exitParameter2_m, Bend2D::exitParameter3_m, Bend2D::findChordLength(), and Bend2D::setupFringeWidths().

Referenced by Bend2D::setGapFromFieldMap().

Here is the call graph for this function:

◆ apply() [1/2]

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

overridevirtualinherited

Apply field to particles with coordinates in magnet frame.

Reimplemented from Component.

Definition at line 149 of file Bend2D.cpp.

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

Referenced by Bend2D::apply(), and Bend2D::applyToReferenceParticle().

Here is the call graph for this function:

◆ apply() [2/2]

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

overridevirtualinherited

Apply field to particles in beam frame.

Reimplemented from Component.

Definition at line 157 of file Bend2D.cpp.

References Bend2D::calculateMapField(), Bend2D::designRadius_m, BendBase::fieldAmplitude_m, ElementBase::getFlagDeleteOnTransverseExit(), Attrib::Distribution::R, and X.

Here is the call graph for this function:

◆ applyToReferenceParticle()

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

overridevirtualinherited

Reimplemented from Component.

Definition at line 180 of file Bend2D.cpp.

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

Here is the call graph for this function:

◆ bends()

bool BendBase::bends ( ) const

inlinevirtualinherited

Indicates that element bends the beam.

Implements Component.

Definition at line 77 of file BendBase.h.

◆ Bfield() [1/2]

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

inlineinherited

Return the field in a point.

Definition at line 202 of file Component.h.

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

Here is the call graph for this function:

◆ Bfield() [2/2]

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

inlineinherited

Return the field in a point.

Definition at line 208 of file Component.h.

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

Here is the call graph for this function:

◆ calcBendAngle()

double BendBase::calcBendAngle	(	double	chordLength,
		double	radius
	)		const

protectedinherited

Calculate bend angle from chord length and design radius.

Definition at line 79 of file BendBase.cpp.

References asin().

Referenced by Bend2D::findIdealBendParameters().

Here is the call graph for this function:

◆ calcBetaGamma()

double BendBase::calcBetaGamma ( ) const

protectedinherited

Calculate beta*gamma from design energy.

Definition at line 95 of file BendBase.cpp.

References BendBase::calcGamma(), pow(), and sqrt().

Referenced by BendBase::calcDesignRadius(), BendBase::calcFieldAmplitude(), Bend2D::calculateBendAngle(), Bend2D::calculateRefTrajectory(), and RBend3D::trackRefParticleThrough().

Here is the call graph for this function:

◆ calcCentralField()

Vector_t Bend2D::calcCentralField	(	const Vector_t &	R,
		double	deltaX
	)

privateinherited

Definition at line 356 of file Bend2D.cpp.

Referenced by Bend2D::calculateMapField().

◆ calcDesignRadius() [1/2]

double BendBase::calcDesignRadius	(	double	chordLength,
		double	angle
	)		const

protectedinherited

Calculate design radius from chord length and bend angle.

Definition at line 84 of file BendBase.cpp.

References sin().

Here is the call graph for this function:

◆ calcDesignRadius() [2/2]

double BendBase::calcDesignRadius ( double fieldAmplitude ) const

protectedinherited

Calculate design radius from design energy and field amplitude.

Definition at line 61 of file BendBase.cpp.

References abs(), Physics::c, BendBase::calcBetaGamma(), PartBunchBase< T, Dim >::getM(), PartBunchBase< T, Dim >::getQ(), and Component::RefPartBunch_m.

Referenced by RBend::findChordLength(), Bend2D::findIdealBendParameters(), and Bend2D::isFieldZero().

Here is the call graph for this function:

◆ calcEngeFunction()

void Bend2D::calcEngeFunction	(	double	zNormalized,
		const std::vector< double > &	engeCoeff,
		int	polyOrder,
		double &	engeFunc,
		double &	engeFuncDeriv,
		double &	engeFuncSecDerivNorm
	)

privateinherited

Definition at line 291 of file Bend2D.cpp.

References exp(), BendBase::gap_m, matheval::detail::math::isinf(), matheval::detail::math::isnan(), and pow().

Referenced by Bend2D::readFieldMap().

Here is the call graph for this function:

◆ calcEntranceFringeField()

Vector_t Bend2D::calcEntranceFringeField	(	const Vector_t &	R,
		double	deltaX
	)

privateinherited

Definition at line 374 of file Bend2D.cpp.

References Bend2D::entranceParameter1_m, Bend2D::entranceParameter2_m, Bend2D::entranceParameter3_m, Bend2D::entryFieldAccel_m, Bend2D::entryFieldValues_m, pow(), Attrib::Distribution::R, CoordinateSystemTrafo::rotateFrom(), and CoordinateSystemTrafo::transformTo().

Referenced by Bend2D::calculateMapField().

Here is the call graph for this function:

◆ calcExitFringeField()

Vector_t Bend2D::calcExitFringeField	(	const Vector_t &	R,
		double	deltaX
	)

privateinherited

Definition at line 411 of file Bend2D.cpp.

References Bend2D::exitFieldAccel_m, Bend2D::exitFieldValues_m, Bend2D::exitParameter1_m, Bend2D::exitParameter2_m, Bend2D::exitParameter3_m, Bend2D::getBeginToEnd_local(), pow(), Attrib::Distribution::R, CoordinateSystemTrafo::rotateFrom(), and CoordinateSystemTrafo::transformTo().

Referenced by Bend2D::calculateMapField().

Here is the call graph for this function:

◆ calcFieldAmplitude()

double BendBase::calcFieldAmplitude ( double radius ) const

protectedinherited

Calculate field amplitude from design energy and radius.

Definition at line 70 of file BendBase.cpp.

References Physics::c, BendBase::calcBetaGamma(), PartBunchBase< T, Dim >::getM(), PartBunchBase< T, Dim >::getQ(), and Component::RefPartBunch_m.

Referenced by Bend2D::estimateFieldAdjustmentStep(), Bend2D::findIdealBendParameters(), RBend3D::initialise(), and Bend2D::setBendStrength().

Here is the call graph for this function:

◆ calcGamma()

double BendBase::calcGamma ( ) const

protectedinherited

Calculate gamma from design energy.

Definition at line 89 of file BendBase.cpp.

References BendBase::designEnergy_m, PartBunchBase< T, Dim >::getM(), and Component::RefPartBunch_m.

Referenced by BendBase::calcBetaGamma(), Bend2D::calculateRefTrajectory(), and RBend3D::trackRefParticleThrough().

Here is the call graph for this function:

◆ calculateBendAngle()

double Bend2D::calculateBendAngle ( )

privateinherited

Definition at line 252 of file Bend2D.cpp.

References atan2(), Physics::c, BendBase::calcBetaGamma(), Bend2D::calculateMapField(), Bend2D::cosEntranceAngle_m, Bend2D::deltaBeginEntry_m, Bend2D::endField_m, BendBase::entranceAngle_m, euclidean_norm(), BendBase::fieldAmplitude_m, PartBunchBase< T, Dim >::getdT(), BorisPusher::kick(), BorisPusher::push(), Bend2D::pusher_m, Component::RefPartBunch_m, Bend2D::sinEntranceAngle_m, Bend2D::startField_m, Bend2D::tanEntranceAngle_m, and X.

Referenced by Bend2D::findBendEffectiveLength(), Bend2D::findBendStrength(), and Bend2D::setBendEffectiveLength().

Here is the call graph for this function:

◆ calculateMapField()

bool Bend2D::calculateMapField	(	const Vector_t &	R,
		Vector_t &	B
	)

privateinherited

Definition at line 447 of file Bend2D.cpp.

References abs(), Bend2D::calcCentralField(), Bend2D::calcEntranceFringeField(), Bend2D::calcExitFringeField(), Bend2D::cosEntranceAngle_m, Bend2D::designRadius_m, BendBase::gap_m, Bend2D::getBeginToEnd_local(), Bend2D::inMagnetCentralRegion(), Bend2D::inMagnetEntranceRegion(), Bend2D::inMagnetExitRegion(), Bend2D::isPositionInEntranceField(), Bend2D::isPositionInExitField(), Attrib::Distribution::R, Bend2D::sinEntranceAngle_m, CoordinateSystemTrafo::transformTo(), Bend2D::transformToEntranceRegion(), and Bend2D::transformToExitRegion().

Referenced by Bend2D::apply(), Bend2D::calculateBendAngle(), and Bend2D::calculateRefTrajectory().

Here is the call graph for this function:

◆ calculateRefTrajectory()

void Bend2D::calculateRefTrajectory	(	double &	angleX,
		double &	angleY
	)

privateinherited

Definition at line 510 of file Bend2D.cpp.

References atan2(), Physics::c, BendBase::calcBetaGamma(), BendBase::calcGamma(), Bend2D::calculateMapField(), Util::combineFilePath(), Bend2D::cosEntranceAngle_m, Bend2D::deltaBeginEntry_m, Bend2D::endField_m, endl(), BendBase::entranceAngle_m, BendBase::fieldAmplitude_m, OpalData::getAuxiliaryOutputDirectory(), PartBunchBase< T, Dim >::getdT(), OpalData::getInputBasename(), OpalData::getInstance(), ElementBase::getName(), BorisPusher::kick(), IpplInfo::myNode(), BorisPusher::push(), Bend2D::pusher_m, Component::RefPartBunch_m, BendBase::refTrajMap_m, Bend2D::sinEntranceAngle_m, Bend2D::startField_m, Bend2D::tanEntranceAngle_m, Options::writeBendTrajectories, and X.

Referenced by Bend2D::initialise().

Here is the call graph for this function:

◆ clone()

ElementBase * SBendRep::clone ( ) const

virtual

Return clone.

Implements ElementBase.

Definition at line 99 of file SBendRep.cpp.

References SBendRep().

Here is the call graph for this function:

◆ copyStructure()

ElementBase * ElementBase::copyStructure ( )

virtualinherited

Make a structural copy.

Reimplemented in TBeamline< T >.

Definition at line 244 of file ElementBase.cpp.

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

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

Here is the call graph for this function:

◆ EBfield() [1/2]

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

inlineinherited

Return the field in a point.

Definition at line 211 of file Component.h.

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

Here is the call graph for this function:

◆ EBfield() [2/2]

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

inlineinherited

Return the field in a point.

Definition at line 214 of file Component.h.

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

Here is the call graph for this function:

◆ Efield() [1/2]

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

inlineinherited

Return the field in a point.

Definition at line 199 of file Component.h.

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

Here is the call graph for this function:

◆ Efield() [2/2]

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

inlineinherited

Return the field in a point.

Definition at line 205 of file Component.h.

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

Here is the call graph for this function:

◆ estimateFieldAdjustmentStep()

double Bend2D::estimateFieldAdjustmentStep ( double actualBendAngle )

privateinherited

Definition at line 577 of file Bend2D.cpp.

References abs(), BendBase::angle_m, BendBase::calcFieldAmplitude(), Bend2D::designRadius_m, BendBase::fieldAmplitude_m, pow(), and sqrt().

Referenced by Bend2D::findBendStrength().

Here is the call graph for this function:

◆ finalise()

void Bend2D::finalise ( )

inlineoverridevirtualinherited

Implements Component.

Definition at line 279 of file Bend2D.h.

References Component::online_m.

◆ findBendEffectiveLength()

void Bend2D::findBendEffectiveLength	(	double	startField,
		double	endField
	)

privateinherited

Definition at line 593 of file Bend2D.cpp.

References abs(), BendBase::angle_m, Bend2D::calculateBendAngle(), BendBase::gap_m, Bend2D::setEngeOriginDelta(), Bend2D::setFieldBoundaries(), and Bend2D::setFieldCalcParam().

Referenced by Bend2D::setBendEffectiveLength().

Here is the call graph for this function:

◆ findBendStrength()

void Bend2D::findBendStrength ( )

privateinherited

Definition at line 683 of file Bend2D.cpp.

References abs(), BendBase::angle_m, Bend2D::calculateBendAngle(), copysign(), Physics::e, Bend2D::estimateFieldAdjustmentStep(), BendBase::fieldAmplitude_m, and Units::rad2deg.

Referenced by Bend2D::setBendStrength().

Here is the call graph for this function:

◆ findChordLength()

bool SBend::findChordLength ( double & chordLength )

overrideprivatevirtualinherited

Implements Bend2D.

Definition at line 91 of file SBend.cpp.

References ElementBase::getElementLength().

Here is the call graph for this function:

◆ findIdealBendParameters()

bool Bend2D::findIdealBendParameters ( double chordLength )

privateinherited

Definition at line 751 of file Bend2D.cpp.

References abs(), BendBase::angle_m, atan2(), BendBase::calcBendAngle(), BendBase::calcDesignRadius(), BendBase::calcFieldAmplitude(), copysign(), Bend2D::designRadius_m, BendBase::entranceAngle_m, Bend2D::exitAngle_m, BendBase::fieldAmplitude_m, BendBase::fieldAmplitudeX_m, BendBase::fieldAmplitudeY_m, PartBunchBase< T, Dim >::getQ(), Physics::pi, Component::RefPartBunch_m, ElementBase::rotationZAxis_m, Bend2D::setEntranceAngle(), and Bend2D::setExitAngle().

Referenced by Bend2D::setupBendGeometry().

Here is the call graph for this function:

◆ fixPosition()

void ElementBase::fixPosition ( )

inlineinherited

Definition at line 551 of file ElementBase.h.

References ElementBase::positionIsFixed.

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

◆ getAperture()

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

inlineinherited

Definition at line 525 of file ElementBase.h.

References ElementBase::aperture_m.

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

◆ getArcLength()

double ElementBase::getArcLength ( ) const

inlinevirtualinherited

Get arc length.

Reimplemented in MarkerRep, and TBeamline< T >.

Definition at line 411 of file ElementBase.h.

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

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

Here is the call graph for this function:

◆ getAttribute()

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

virtualinherited

Get attribute value.

Definition at line 187 of file ElementBase.cpp.

References ElementBase::getConstChannel().

Here is the call graph for this function:

◆ getB()

double SBendRep::getB ( ) const

virtual

Get field.

Implements SBend.

Definition at line 155 of file SBendRep.cpp.

References field, and BMultipoleField::getNormalComponent().

Here is the call graph for this function:

◆ getBeginToEnd_local()

CoordinateSystemTrafo Bend2D::getBeginToEnd_local ( ) const

inlineinherited

Definition at line 354 of file Bend2D.h.

References Bend2D::beginToEnd_lcs_m.

Referenced by Bend2D::calcExitFringeField(), Bend2D::calculateMapField(), Bend2D::getOutline(), Bend2D::getSurfaceMesh(), Bend2D::inMagnetCentralRegion(), Bend2D::inMagnetExitRegion(), Bend2D::isPositionInExitField(), OpalBeamline::save3DLattice(), and Bend2D::setFieldCalcParam().

◆ getBendAngle()

double BendBase::getBendAngle ( ) const

inlineinherited

Definition at line 92 of file BendBase.h.

References BendBase::angle_m.

Referenced by OpalBeamline::compute3DLattice(), RBend::findChordLength(), RBend3D::getExitAngle(), CSRIGFWakeFunction::initialize(), CSRWakeFunction::initialize(), OpalBeamline::save3DInput(), OpalBeamline::save3DLattice(), RBend::setEntranceAngle(), and Bend2D::setFieldCalcParam().

◆ getBendRadius()

double Bend2D::getBendRadius ( ) const

inlineinherited

Definition at line 290 of file Bend2D.h.

References Bend2D::designRadius_m.

Referenced by CSRIGFWakeFunction::initialize(), and CSRWakeFunction::initialize().

◆ getBoundaryGeometry()

BoundaryGeometry * ElementBase::getBoundaryGeometry ( ) const

inlinevirtualinherited

return the attached boundary geometrt object if there is any

Definition at line 475 of file ElementBase.h.

References ElementBase::bgeometry_m.

◆ getBoundingBoxInLabCoords()

BoundingBox Bend2D::getBoundingBoxInLabCoords ( ) const

overridevirtualinherited

Reimplemented from ElementBase.

Definition at line 1693 of file Bend2D.cpp.

References ElementBase::csTrafoGlobal2Local_m, BoundingBox::enlargeToContainPosition(), ElementBase::getEdgeToBegin(), Bend2D::getEdgeToEnd(), BendBase::getFullGap(), Bend2D::getOutline(), and CoordinateSystemTrafo::transformFrom().

Here is the call graph for this function:

◆ getChannel()

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

virtual

Construct a read/write channel.

Reimplemented from ElementBase.

Definition at line 104 of file SBendRep.cpp.

References ElementBase::getChannel(), SBend::getNormalComponent(), SBend::getSkewComponent(), Hypervolume::n, SBend::setNormalComponent(), and SBend::setSkewComponent().

Here is the call graph for this function:

◆ getChordLength()

double BendBase::getChordLength ( ) const

inlineinherited

Definition at line 82 of file BendBase.h.

References BendBase::chordLength_m.

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

◆ getConstChannel()

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

virtualinherited

Construct a read-only channel.

Definition at line 233 of file ElementBase.cpp.

References ElementBase::getChannel().

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

Here is the call graph for this function:

◆ getCSTrafoGlobal2Local()

CoordinateSystemTrafo ElementBase::getCSTrafoGlobal2Local ( ) const

inlineinherited

Definition at line 498 of file ElementBase.h.

References ElementBase::csTrafoGlobal2Local_m.

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

◆ getDesign()

const ElementBase & Component::getDesign ( ) const

virtualinherited

Return design element.

Definition at line 67 of file Component.cpp.

◆ getDesignEnergy()

double BendBase::getDesignEnergy ( ) const

inlinevirtualinherited

Reimplemented from Component.

Definition at line 126 of file BendBase.h.

References BendBase::designEnergy_m.

Referenced by OpalBeamline::activateElements(), and ThickTracker::visitSBend().

◆ getDesignPath()

std::vector< Vector_t > BendBase::getDesignPath ( ) const

inherited

Definition at line 43 of file BendBase.cpp.

References BendBase::refTrajMap_m.

Referenced by OpalBeamline::compute3DLattice(), and OpalBeamline::save3DLattice().

◆ getDimensions()

void Bend2D::getDimensions	(	double &	sBegin,
		double &	sEnd
	)		const

inlineoverridevirtualinherited

Implements Component.

Definition at line 284 of file Bend2D.h.

References Bend2D::endField_m, and Bend2D::startField_m.

Referenced by CSRIGFWakeFunction::initialize(), and CSRWakeFunction::initialize().

◆ getEdgeToBegin()

CoordinateSystemTrafo ElementBase::getEdgeToBegin ( ) const

inlinevirtualinherited

Reimplemented in RFCavity, Solenoid, and TravelingWave.

Definition at line 503 of file ElementBase.h.

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

◆ getEdgeToEnd()

CoordinateSystemTrafo Bend2D::getEdgeToEnd ( ) const

inlineoverridevirtualinherited

Reimplemented from ElementBase.

Definition at line 348 of file Bend2D.h.

References Bend2D::beginToEnd_m.

Referenced by Bend2D::getBoundingBoxInLabCoords().

◆ getEffectiveCenter()

double Bend2D::getEffectiveCenter ( ) const

inlineinherited

Definition at line 295 of file Bend2D.h.

References BendBase::angle_m, Bend2D::designRadius_m, and ElementBase::elementEdge_m.

Referenced by CSRIGFWakeFunction::initialize(), and CSRWakeFunction::initialize().

◆ getEffectiveLength()

double Bend2D::getEffectiveLength ( ) const

inlineinherited

Definition at line 300 of file Bend2D.h.

References BendBase::angle_m, and Bend2D::designRadius_m.

Referenced by CSRIGFWakeFunction::initialize(), and CSRWakeFunction::initialize().

◆ getElementDimensions()

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

inlinevirtualinherited

Reimplemented in RFCavity, TravelingWave, and Solenoid.

Definition at line 174 of file ElementBase.h.

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

Referenced by MeshGenerator::add().

Here is the call graph for this function:

◆ getElementLength()

double ElementBase::getElementLength ( ) const

inlinevirtualinherited

Get design length.

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

Definition at line 415 of file ElementBase.h.

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

Referenced by ScatteringPhysics::addBackToBunch(), Undulator::apply(), Multipole::apply(), Component::apply(), Corrector::apply(), Solenoid::apply(), Component::applyToReferenceParticle(), Multipole::applyToReferenceParticle(), Solenoid::applyToReferenceParticle(), Vacuum::checkPoint(), ScatteringPhysics::copyFromBunch(), RBend::findChordLength(), SBend::findChordLength(), Corrector::getDimensions(), CCollimator::getDimensions(), Degrader::getDimensions(), Drift::getDimensions(), FlexibleCollimator::getDimensions(), Multipole::getDimensions(), RBend3D::getDimensions(), Solenoid::getDimensions(), Vacuum::getDimensions(), ElementBase::getEdgeToEnd(), Solenoid::getEdgeToEnd(), ElementBase::getElementDimensions(), Solenoid::getElementDimensions(), BeamlineGeometry::getElementLength(), RFCavity::getElementLength(), Corrector::initialise(), Degrader::initialise(), Drift::initialise(), FlexibleCollimator::initialise(), Multipole::initialise(), RBend3D::initialise(), Solenoid::initialise(), Source::initialise(), Vacuum::initialise(), ElementBase::isInside(), Degrader::isInside(), Monitor::isInside(), Multipole::isInside(), ElementBase::isInsideTransverse(), FlexibleCollimator::isStopped(), ScatteringPhysics::setTimeStepForLeavingParticles(), Bend2D::setupDefaultFieldMap(), ParallelCyclotronTracker::visitCorrector(), ParallelCyclotronTracker::visitDrift(), ThickTracker::visitDrift(), ParallelCyclotronTracker::visitMultipole(), ThickTracker::visitMultipole(), ParallelCyclotronTracker::visitRBend(), ParallelCyclotronTracker::visitSBend(), and ThickTracker::visitSBend().

Here is the call graph for this function:

◆ getElementPosition()

double ElementBase::getElementPosition ( ) const

inlineinherited

Definition at line 589 of file ElementBase.h.

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

Here is the call graph for this function:

◆ getEntrance()

double ElementBase::getEntrance ( ) const

inlinevirtualinherited

Get entrance position.

Reimplemented in TBeamline< T >.

Definition at line 427 of file ElementBase.h.

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

Referenced by BeamlineGeometry::getEntrance().

Here is the call graph for this function:

◆ getEntranceAngle()

double BendBase::getEntranceAngle ( ) const

inlineinherited

Definition at line 103 of file BendBase.h.

References BendBase::entranceAngle_m.

Referenced by OpalBeamline::compute3DLattice(), RBend::findChordLength(), RBend3D::getExitAngle(), OpalBeamline::save3DInput(), RBend::setBendAngle(), Bend2D::setFieldCalcParam(), Bend2D::setupBendGeometry(), and ThickTracker::visitSBend().

◆ getEntranceFrame()

Euclid3D ElementBase::getEntranceFrame ( ) const

inlinevirtualinherited

Get transform.

Reimplemented in TBeamline< T >.

Definition at line 447 of file ElementBase.h.

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

Referenced by BeamlineGeometry::getEntranceFrame().

Here is the call graph for this function:

◆ getEntranceFringeFieldLength()

std::array< double, 2 > Bend2D::getEntranceFringeFieldLength ( ) const

inherited

Get entrance fringe field length.

Definition at line 1655 of file Bend2D.cpp.

References Bend2D::entranceParameter1_m, Bend2D::entranceParameter2_m, Bend2D::entranceParameter3_m, and BendBase::fieldmap_m.

◆ getEntrancePatch()

Euclid3D ElementBase::getEntrancePatch ( ) const

inlinevirtualinherited

Get patch.

Definition at line 455 of file ElementBase.h.

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

Here is the call graph for this function:

◆ getEntryFaceCurvature()

double SBendRep::getEntryFaceCurvature ( ) const

virtual

Get entry pole face curvature.

Implements SBend.

Definition at line 181 of file SBendRep.cpp.

References hEntry.

◆ getEntryFaceRotation()

double SBendRep::getEntryFaceRotation ( ) const

virtual

Get pole entry face rotation.

Implements SBend.

Definition at line 164 of file SBendRep.cpp.

References rEntry.

◆ getExit()

double ElementBase::getExit ( ) const

inlinevirtualinherited

Get exit position.

Reimplemented in TBeamline< T >.

Definition at line 431 of file ElementBase.h.

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

Referenced by BeamlineGeometry::getExit().

Here is the call graph for this function:

◆ getExitAngle()

double Bend2D::getExitAngle ( ) const

inlineoverridevirtualinherited

Implements BendBase.

Definition at line 326 of file Bend2D.h.

References Bend2D::exitAngle_m.

Referenced by OpalBeamline::save3DInput(), and ThickTracker::visitSBend().

◆ getExitFaceCurvature()

double SBendRep::getExitFaceCurvature ( ) const

virtual

Get exit pole face curvature.

Implements SBend.

Definition at line 185 of file SBendRep.cpp.

References hExit.

◆ getExitFaceRotation()

double SBendRep::getExitFaceRotation ( ) const

virtual

Get exit pole face rotation.

Implements SBend.

Definition at line 169 of file SBendRep.cpp.

References rExit.

◆ getExitFrame()

Euclid3D ElementBase::getExitFrame ( ) const

inlinevirtualinherited

Get transform.

Reimplemented in TBeamline< T >.

Definition at line 451 of file ElementBase.h.

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

Referenced by BeamlineGeometry::getExitFrame().

Here is the call graph for this function:

◆ getExitFringeFieldLength()

std::array< double, 2 > Bend2D::getExitFringeFieldLength ( ) const

inherited

Get exit fringe field length.

Definition at line 1675 of file Bend2D.cpp.

References Bend2D::exitParameter1_m, Bend2D::exitParameter2_m, Bend2D::exitParameter3_m, and BendBase::fieldmap_m.

◆ getExitPatch()

Euclid3D ElementBase::getExitPatch ( ) const

inlinevirtualinherited

Get patch.

Definition at line 459 of file ElementBase.h.

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

Here is the call graph for this function:

◆ getField() [1/2]

BMultipoleField & SBendRep::getField ( )

virtual

Get field.

Implements SBend.

Definition at line 137 of file SBendRep.cpp.

References field.

◆ getField() [2/2]

const BMultipoleField & SBendRep::getField ( ) const

virtual

Get field.

Implements SBend.

Definition at line 141 of file SBendRep.cpp.

References field.

◆ getFieldAmplitude()

double BendBase::getFieldAmplitude ( ) const

inlineinherited

Definition at line 131 of file BendBase.h.

References BendBase::fieldAmplitude_m.

◆ getFieldMapFN()

std::string BendBase::getFieldMapFN ( ) const

inlineinherited

Definition at line 142 of file BendBase.h.

References BendBase::fileName_m.

◆ getFlagDeleteOnTransverseExit()

bool ElementBase::getFlagDeleteOnTransverseExit ( ) const

inlineinherited

Definition at line 614 of file ElementBase.h.

References ElementBase::deleteOnTransverseExit_m.

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

◆ getFullGap()

double BendBase::getFullGap ( ) const

inlineinherited

Definition at line 113 of file BendBase.h.

References BendBase::gap_m.

Referenced by Bend2D::getBoundingBoxInLabCoords(), and Bend2D::getSurfaceMesh().

◆ getGeometry() [1/2]

PlanarArcGeometry & SBendRep::getGeometry ( )

virtual

Get geometry.

Implements SBend.

Definition at line 146 of file SBendRep.cpp.

References geometry.

Referenced by OpalSBend::update().

◆ getGeometry() [2/2]

const PlanarArcGeometry & SBendRep::getGeometry ( ) const

virtual

Get geometry.

Implements SBend.

Definition at line 150 of file SBendRep.cpp.

References geometry.

◆ getMisalignment() [1/2]

CoordinateSystemTrafo ElementBase::getMisalignment ( ) const

inlineinherited

Definition at line 541 of file ElementBase.h.

References ElementBase::misalignment_m.

◆ getMisalignment() [2/2]

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

inherited

Referenced by ParallelTTracker::computeParticleMatterInteraction().

◆ getName()

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

virtualinherited

Get element name.

Definition at line 162 of file ElementBase.cpp.

References ElementBase::elementID.

Referenced by Ring::appendElement(), Cyclotron::apply(), Ring::apply(), Bend2D::calculateRefTrajectory(), OutputPlane::checkOne(), Vacuum::checkPressure(), Stripper::doCheck(), CCollimator::doFinalise(), Stripper::doFinalise(), OutputPlane::doGoOffline(), Probe::doGoOffline(), OutputPlane::doInitialise(), PlaceRep::enter(), Cyclotron::finalise(), Degrader::finalise(), FlexibleCollimator::finalise(), Vacuum::finalise(), PyOpal::Field::getElementName(), ElementBase::getElementPosition(), RFCavity::getMomentaKick(), BeamStrippingPhysics::getName(), ScatteringPhysics::getName(), Bend2D::getOutline(), ElementBase::getOutputFN(), CavityAutophaser::getPhaseAtMaxEnergy(), Selector::handleElement(), Ring::initialise(), Bend2D::initialise(), RBend3D::initialise(), RFCavity::initialise(), Solenoid::initialise(), CSRIGFWakeFunction::initialize(), CSRWakeFunction::initialize(), OpalWake::initWakefunction(), PlaceRep::leave(), operator<<(), Offset::operator=(), VariableRFCavity::operator=(), operator==(), Line::parse(), Vacuum::print(), BeamStrippingPhysics::print(), ScatteringPhysics::print(), Sequence::print(), ParticleMatterInteraction::print(), Bend2D::readFieldMap(), PyOpal::PyLine_< C >::registerObject(), Component::trackBunch(), Component::trackMap(), RBend3D::trackRefParticleThrough(), OpalRBend::update(), OpalRBend3D::update(), OpalSBend::update(), Sequence::updateList(), ParallelTTracker::updateRFElement(), ParallelCyclotronTracker::visitCCollimator(), Replacer::visitFlaggedElmPtr(), ParallelCyclotronTracker::visitProbe(), ParallelCyclotronTracker::visitRFCavity(), ParallelCyclotronTracker::visitSeptum(), ParallelCyclotronTracker::visitStripper(), and ParallelTTracker::writePhaseSpace().

◆ getNormalComponent()

double SBend::getNormalComponent ( int n ) const

inherited

Get normal component.

Definition at line 59 of file SBend.cpp.

References SBend::getField(), BMultipoleField::getNormalComponent(), and Hypervolume::n.

Referenced by getChannel().

Here is the call graph for this function:

◆ getNSlices()

std::size_t Bend2D::getNSlices ( ) const

inherited

Definition at line 1649 of file Bend2D.cpp.

References Bend2D::nSlices_m.

Referenced by ThickTracker::visitSBend().

◆ getOrigin()

double ElementBase::getOrigin ( ) const

inlinevirtualinherited

Get origin position.

Reimplemented in TBeamline< T >.

Definition at line 423 of file ElementBase.h.

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

Referenced by BeamlineGeometry::getOrigin().

Here is the call graph for this function:

◆ getOutline()

std::vector< Vector_t > Bend2D::getOutline ( ) const

inherited

Definition at line 1281 of file Bend2D.cpp.

References a, abs(), ElementBase::aperture_m, atan2(), ceil(), Util::combineFilePath(), cos(), Bend2D::cosEntranceAngle_m, Units::deg2rad, Bend2D::designRadius_m, dot(), endl(), Bend2D::entranceParameter1_m, Bend2D::exitParameter3_m, fmod(), OpalData::getAuxiliaryOutputDirectory(), Bend2D::getBeginToEnd_local(), OpalData::getInputBasename(), OpalData::getInstance(), ElementBase::getName(), getQuaternion(), max(), IpplInfo::myNode(), pow(), Attrib::Distribution::R, Quaternion::rotate(), sin(), Bend2D::sinEntranceAngle_m, Bend2D::tanEntranceAngle_m, Bend2D::tanExitAngle_m, CoordinateSystemTrafo::transformFrom(), CoordinateSystemTrafo::transformTo(), Physics::two_pi, Bend2D::widthEntranceFringe_m, Bend2D::widthExitFringe_m, and Options::writeBendTrajectories.

Referenced by Bend2D::getBoundingBoxInLabCoords(), and Bend2D::getSurfaceMesh().

Here is the call graph for this function:

◆ getOutputFN()

std::string ElementBase::getOutputFN ( ) const

inherited

Get output filename.

Definition at line 177 of file ElementBase.cpp.

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

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

Here is the call graph for this function:

◆ getParticleMatterInteraction()

ParticleMatterInteractionHandler * ElementBase::getParticleMatterInteraction ( ) const

inlinevirtualinherited

Definition at line 483 of file ElementBase.h.

References ElementBase::parmatint_m.

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

◆ getPotential()

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

inlinevirtualinherited

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

Parameters

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

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

Definition at line 130 of file Component.h.

◆ getRequiredNumberOfTimeSteps()

int ElementBase::getRequiredNumberOfTimeSteps ( ) const

inlinevirtualinherited

Reimplemented in Drift, Marker, Monitor, Source, and Stripper.

Definition at line 603 of file ElementBase.h.

◆ getRotationAboutZ()

double ElementBase::getRotationAboutZ ( ) const

inlineinherited

Definition at line 574 of file ElementBase.h.

References ElementBase::rotationZAxis_m.

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

◆ getSkewComponent()

double SBend::getSkewComponent ( int n ) const

inherited

Get skew component.

Definition at line 63 of file SBend.cpp.

References SBend::getField(), BMultipoleField::getSkewComponent(), and Hypervolume::n.

Referenced by getChannel().

Here is the call graph for this function:

◆ getSlices()

double SBendRep::getSlices ( ) const

virtual

Get number of slices.

Implements SBend.

Definition at line 198 of file SBendRep.cpp.

References slices.

◆ getStartField()

double Bend2D::getStartField ( ) const

inlineprotectedinherited

Definition at line 320 of file Bend2D.h.

References Bend2D::startField_m.

◆ getStepsize()

double SBendRep::getStepsize ( ) const

virtual

Get stepsize.

Implements SBend.

Definition at line 202 of file SBendRep.cpp.

References stepsize.

◆ getSurfaceMesh()

MeshData Bend2D::getSurfaceMesh ( ) const

inherited

Definition at line 1388 of file Bend2D.cpp.

References abs(), BendBase::angle_m, ElementBase::aperture_m, asin(), cos(), Bend2D::cosEntranceAngle_m, cross(), MeshData::decorations_m, Bend2D::designRadius_m, det(), dot(), Physics::e, BendBase::entranceAngle_m, Bend2D::entranceParameter1_m, Bend2D::entranceParameter3_m, euclidean_norm(), Bend2D::exitAngle_m, Bend2D::exitParameter1_m, Bend2D::exitParameter3_m, Bend2D::getBeginToEnd_local(), BendBase::getFullGap(), Bend2D::getOutline(), Bend2D::getType(), pow(), prod(), Attrib::Distribution::R, RBEND, Quaternion::rotate(), CoordinateSystemTrafo::rotateFrom(), sin(), Bend2D::sinEntranceAngle_m, Attrib::Legacy::Distribution::T, Bend2D::tanEntranceAngle_m, Bend2D::tanExitAngle_m, Bend2D::toEntranceRegion_m, Bend2D::toExitRegion_m, CoordinateSystemTrafo::transformFrom(), CoordinateSystemTrafo::transformTo(), MeshData::triangles_m, and MeshData::vertices_m.

Referenced by MeshGenerator::add().

Here is the call graph for this function:

◆ getTotalTransform()

Euclid3D ElementBase::getTotalTransform ( ) const

inlinevirtualinherited

Get transform.

Reimplemented in TBeamline< T >.

Definition at line 439 of file ElementBase.h.

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

Referenced by BeamlineGeometry::getTotalTransform().

Here is the call graph for this function:

◆ getTransform() [1/2]

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

inlinevirtualinherited

Get transform.

Reimplemented in TBeamline< T >.

Definition at line 435 of file ElementBase.h.

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

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

Here is the call graph for this function:

◆ getTransform() [2/2]

Euclid3D ElementBase::getTransform ( double s ) const

inlinevirtualinherited

Get transform.

Reimplemented in TBeamline< T >.

Definition at line 443 of file ElementBase.h.

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

Here is the call graph for this function:

◆ getType()

ElementType SBend::getType ( ) const

overridevirtualinherited

Get element type std::string.

Implements Bend2D.

Definition at line 86 of file SBend.cpp.

References SBEND.

◆ getTypeString() [1/2]

std::string ElementBase::getTypeString ( ) const

inlineinherited

Definition at line 579 of file ElementBase.h.

References ElementBase::getType(), and ElementBase::getTypeString().

Referenced by ParallelCyclotronTracker::execute(), ElementBase::getTypeString(), Vacuum::print(), and OpalBeamline::visit().

Here is the call graph for this function:

◆ getTypeString() [2/2]

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

staticinherited

Definition at line 240 of file ElementBase.cpp.

References ElementBase::elementTypeToString_s.

◆ getWake()

WakeFunction * ElementBase::getWake ( ) const

inlinevirtualinherited

return the attached wake object if there is any

Definition at line 467 of file ElementBase.h.

References ElementBase::wake_m.

◆ goOffline()

void Component::goOffline ( )

virtualinherited

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

Definition at line 87 of file Component.cpp.

References Component::online_m.

◆ goOnline()

void Bend2D::goOnline ( const double & kineticEnergy )

overridevirtualinherited

Reimplemented from Component.

Definition at line 188 of file Bend2D.cpp.

References Component::online_m.

◆ hasAttribute()

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

virtualinherited

Test for existence of an attribute.

Definition at line 200 of file ElementBase.cpp.

References ElementBase::getConstChannel().

Referenced by ParallelCyclotronTracker::visitSolenoid().

Here is the call graph for this function:

◆ hasBoundaryGeometry()

bool ElementBase::hasBoundaryGeometry ( ) const

inlinevirtualinherited

Definition at line 479 of file ElementBase.h.

References ElementBase::bgeometry_m.

◆ hasParticleMatterInteraction()

bool ElementBase::hasParticleMatterInteraction ( ) const

inlinevirtualinherited

Definition at line 487 of file ElementBase.h.

References ElementBase::parmatint_m.

◆ hasWake()

bool ElementBase::hasWake ( ) const

inlinevirtualinherited

Definition at line 471 of file ElementBase.h.

References ElementBase::wake_m.

◆ initialise()

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

overridevirtualinherited

Implements Component.

Definition at line 192 of file Bend2D.cpp.

References Bend2D::calculateRefTrajectory(), ElementBase::elementEdge_m, Bend2D::endField_m, endl(), ERRORMSG, BendBase::fileName_m, ElementBase::getName(), gmsg, Bend2D::initializeFieldMap(), level2(), Bend2D::messageHeader_m, name, Bend2D::print(), Bend2D::readFieldMap(), ElementBase::setElementLength(), Bend2D::setupBendGeometry(), Bend2D::setupFringeWidths(), Bend2D::setupPusher(), Bend2D::startField_m, and Util::toUpper().

Here is the call graph for this function:

◆ initializeFieldMap()

bool Bend2D::initializeFieldMap ( )

privateinherited

Definition at line 783 of file Bend2D.cpp.

References BendBase::fast_m, BendBase::fieldmap_m, BendBase::fileName_m, _Fieldmap::getFieldmap(), and Bend2D::setupDefaultFieldMap().

Referenced by Bend2D::initialise().

Here is the call graph for this function:

◆ inMagnetCentralRegion()

bool Bend2D::inMagnetCentralRegion ( const Vector_t & R ) const

privateinherited

Definition at line 798 of file Bend2D.cpp.

References abs(), ElementBase::aperture_m, atan2(), Bend2D::computeAngleTrafo_m, Bend2D::cosEntranceAngle_m, Bend2D::designRadius_m, euclidean_norm(), fmod(), Bend2D::getBeginToEnd_local(), Bend2D::maxAngle_m, Attrib::Distribution::R, Bend2D::sinEntranceAngle_m, CoordinateSystemTrafo::transformTo(), and Physics::two_pi.

Referenced by Bend2D::calculateMapField(), and Bend2D::isInside().

Here is the call graph for this function:

◆ inMagnetEntranceRegion()

bool Bend2D::inMagnetEntranceRegion ( const Vector_t & R ) const

privateinherited

Definition at line 816 of file Bend2D.cpp.

References abs(), ElementBase::aperture_m, Bend2D::entranceParameter1_m, and Attrib::Distribution::R.

Referenced by Bend2D::calculateMapField(), and Bend2D::isInside().

Here is the call graph for this function:

◆ inMagnetExitRegion()

bool Bend2D::inMagnetExitRegion ( const Vector_t & R ) const

privateinherited

Definition at line 823 of file Bend2D.cpp.

References abs(), ElementBase::aperture_m, Bend2D::exitParameter3_m, Bend2D::getBeginToEnd_local(), Attrib::Distribution::R, and CoordinateSystemTrafo::transformTo().

Referenced by Bend2D::calculateMapField(), and Bend2D::isInside().

Here is the call graph for this function:

◆ isElementPositionSet()

bool ElementBase::isElementPositionSet ( ) const

inlineinherited

Definition at line 598 of file ElementBase.h.

References ElementBase::elemedgeSet_m.

◆ isFieldZero()

bool Bend2D::isFieldZero ( )

privateinherited

Definition at line 1249 of file Bend2D.cpp.

References abs(), BendBase::angle_m, BendBase::calcDesignRadius(), BendBase::chordLength_m, BendBase::designEnergy_m, Bend2D::designRadius_m, endl(), BendBase::fieldAmplitude_m, BendBase::fieldAmplitudeX_m, BendBase::fieldAmplitudeY_m, pow(), and WARNMSG.

Referenced by Bend2D::setupBendGeometry().

Here is the call graph for this function:

◆ isInside()

bool Bend2D::isInside ( const Vector_t & r ) const

overridevirtualinherited

Reimplemented from ElementBase.

Definition at line 1623 of file Bend2D.cpp.

References abs(), BendBase::gap_m, Bend2D::inMagnetCentralRegion(), Bend2D::inMagnetEntranceRegion(), Bend2D::inMagnetExitRegion(), and Attrib::Distribution::R.

Here is the call graph for this function:

◆ isInsideTransverse()

bool ElementBase::isInsideTransverse ( const Vector_t & r ) const

protectedinherited

Definition at line 287 of file ElementBase.cpp.

References abs(), ElementBase::aperture_m, CONIC_ELLIPTICAL, CONIC_RECTANGULAR, ELLIPTICAL, ElementBase::getEdgeToBegin(), ElementBase::getElementLength(), pow(), RECTANGULAR, and CoordinateSystemTrafo::transformTo().

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

Here is the call graph for this function:

◆ isPositioned()

bool ElementBase::isPositioned ( ) const

inlineinherited

Definition at line 556 of file ElementBase.h.

References ElementBase::positionIsFixed.

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

◆ isPositionInEntranceField()

bool Bend2D::isPositionInEntranceField ( const Vector_t & R ) const

privateinherited

Definition at line 832 of file Bend2D.cpp.

References Bend2D::entranceParameter1_m, Bend2D::entranceParameter3_m, Bend2D::polyOrderEntry_m, and Attrib::Distribution::R.

Referenced by Bend2D::calculateMapField().

◆ isPositionInExitField()

bool Bend2D::isPositionInExitField ( const Vector_t & R ) const

privateinherited

Definition at line 839 of file Bend2D.cpp.

References Bend2D::exitParameter1_m, Bend2D::exitParameter3_m, Bend2D::getBeginToEnd_local(), Bend2D::polyOrderExit_m, Attrib::Distribution::R, and CoordinateSystemTrafo::transformTo().

Referenced by Bend2D::calculateMapField().

Here is the call graph for this function:

◆ isSharable()

bool ElementBase::isSharable ( ) const

inlineinherited

Test if the element can be shared.

Definition at line 463 of file ElementBase.h.

References ElementBase::shareFlag.

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

◆ isShared()

bool RCObject::isShared ( ) const

inlineinherited

Test for sharing.

Definition at line 93 of file RCObject.h.

References RCObject::refCount.

◆ makeSharable()

void ElementBase::makeSharable ( )

virtualinherited

Set sharable flag.

Reimplemented in TBeamline< T >.

Definition at line 253 of file ElementBase.cpp.

References ElementBase::shareFlag.

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

◆ Online()

bool Component::Online ( )

virtualinherited

Definition at line 91 of file Component.cpp.

References Component::online_m.

◆ operator=()

void SBendRep::operator= ( const SBendRep & )

private

◆ print()

void Bend2D::print	(	Inform &	msg,
		double	bendAngleX,
		double	bendAngle
	)

privateinherited

Definition at line 847 of file Bend2D.cpp.

References BendBase::angle_m, BendBase::designEnergy_m, Bend2D::designRadius_m, ElementBase::elementEdge_m, Bend2D::endField_m, endl(), Bend2D::engeCoeffsEntry_m, Bend2D::engeCoeffsExit_m, BendBase::entranceAngle_m, Bend2D::entranceParameter1_m, Bend2D::entranceParameter2_m, Bend2D::entranceParameter3_m, Bend2D::exitAngle_m, Bend2D::exitParameter1_m, Bend2D::exitParameter2_m, Bend2D::exitParameter3_m, BendBase::fieldAmplitude_m, Bend2D::fieldIndex_m, BendBase::fileName_m, BendBase::gap_m, level2(), Bend2D::polyOrderEntry_m, Bend2D::polyOrderExit_m, Units::rad2deg, ElementBase::rotationZAxis_m, and Bend2D::startField_m.

Referenced by Bend2D::initialise().

Here is the call graph for this function:

◆ readFieldMap()

void Bend2D::readFieldMap ( Inform & msg )

privateinherited

Definition at line 947 of file Bend2D.cpp.

References abs(), Physics::c, Bend2D::calcEngeFunction(), ceil(), Bend2D::engeCoeffsEntry_m, Bend2D::engeCoeffsExit_m, Bend2D::entranceParameter1_m, Bend2D::entranceParameter2_m, Bend2D::entranceParameter3_m, Bend2D::entryFieldAccel_m, Bend2D::entryFieldValues_m, Bend2D::exitFieldAccel_m, Bend2D::exitFieldValues_m, Bend2D::exitParameter1_m, Bend2D::exitParameter2_m, Bend2D::exitParameter3_m, BendBase::fieldmap_m, BendBase::fileName_m, BendBase::gap_m, ElementBase::getName(), level2(), Bend2D::polyOrderEntry_m, Bend2D::polyOrderExit_m, Units::ps2s, _Fieldmap::readMap(), and Bend2D::setGapFromFieldMap().

Referenced by Bend2D::initialise().

Here is the call graph for this function:

◆ releasePosition()

void ElementBase::releasePosition ( )

inlineinherited

Definition at line 546 of file ElementBase.h.

References ElementBase::positionIsFixed.

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

◆ removeAttribute()

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

virtualinherited

Remove an existing attribute.

Definition at line 212 of file ElementBase.cpp.

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

Here is the call graph for this function:

◆ removeReference()

int RCObject::removeReference ( ) const

inlineinherited

Decrement the reference count.

Definition at line 88 of file RCObject.h.

References RCObject::refCount.

◆ setActionRange()

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

inlineinherited

Definition at line 561 of file ElementBase.h.

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

◆ setAperture()

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

inlineinherited

Definition at line 519 of file ElementBase.h.

References ElementBase::aperture_m.

Referenced by Component::Component(), Offset::operator=(), OpalElement::update(), OpalRBend::update(), OpalRBend3D::update(), OpalSBend::update(), and OpalSlit::update().

◆ setAttribute()

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

virtualinherited

Set value of an attribute.

Definition at line 217 of file ElementBase.cpp.

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

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

Here is the call graph for this function:

◆ setB()

void SBendRep::setB ( double By )

virtual

Set vertical component.

Definition at line 159 of file SBendRep.cpp.

References field, and BMultipoleField::setNormalComponent().

Here is the call graph for this function:

◆ setBendAngle()

void BendBase::setBendAngle ( double angle )

inlinevirtualinherited

Reimplemented in RBend.

Definition at line 87 of file BendBase.h.

References BendBase::angle_m.

Referenced by RBend::setBendAngle(), OpalRBend3D::update(), and OpalSBend::update().

◆ setBendEffectiveLength()

void Bend2D::setBendEffectiveLength	(	double	startField,
		double	endField
	)

privateinherited

Definition at line 1027 of file Bend2D.cpp.

References abs(), BendBase::angle_m, Bend2D::calculateBendAngle(), and Bend2D::findBendEffectiveLength().

Referenced by Bend2D::setupBendGeometry().

Here is the call graph for this function:

◆ setBendStrength()

void Bend2D::setBendStrength ( )

privateinherited

Definition at line 1039 of file Bend2D.cpp.

References BendBase::calcFieldAmplitude(), Bend2D::designRadius_m, BendBase::fieldAmplitude_m, and Bend2D::findBendStrength().

Referenced by Bend2D::setupBendGeometry().

Here is the call graph for this function:

◆ setBoundaryGeometry()

void ElementBase::setBoundaryGeometry ( BoundaryGeometry * geo )

virtualinherited

attach a boundary geometry field to the element

Definition at line 270 of file ElementBase.cpp.

References ElementBase::bgeometry_m.

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

◆ setCSTrafoGlobal2Local()

void ElementBase::setCSTrafoGlobal2Local ( const CoordinateSystemTrafo & ori )

inlineinherited

Definition at line 491 of file ElementBase.h.

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

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

◆ setCSTrafoToEntranceRegion()

void Bend2D::setCSTrafoToEntranceRegion ( const CoordinateSystemTrafo & trafo )

inlineprivateinherited

Definition at line 360 of file Bend2D.h.

References Bend2D::toEntranceRegion_m.

◆ setCSTrafoToExitRegion()

void Bend2D::setCSTrafoToExitRegion ( const CoordinateSystemTrafo & trafo )

inlineprivateinherited

Definition at line 365 of file Bend2D.h.

References Bend2D::toExitRegion_m.

◆ setCurrentSCoordinate()

void ElementBase::setCurrentSCoordinate ( double s )

inherited

Definition at line 278 of file ElementBase.cpp.

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

◆ setDesignEnergy()

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

inlinevirtualinherited

Reimplemented from Component.

Definition at line 118 of file BendBase.h.

References abs(), BendBase::designEnergy_m, and BendBase::designEnergyChangeable_m.

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

Here is the call graph for this function:

◆ setElementLength()

void ElementBase::setElementLength ( double length )

inlinevirtualinherited

Set design length.

Reimplemented in MultipoleT.

Definition at line 419 of file ElementBase.h.

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

Referenced by Bend2D::initialise(), RBend3D::initialise(), RFCavity::initialise(), Solenoid::initialise(), TravelingWave::initialise(), MultipoleT::setElementLength(), SequenceMember::setLength(), OpalCavity::update(), OpalCCollimator::update(), OpalDrift::update(), OpalECollimator::update(), OpalFlexibleCollimator::update(), OpalHKicker::update(), OpalKicker::update(), OpalMonitor::update(), OpalMultipole::update(), OpalOctupole::update(), OpalPepperPot::update(), OpalProbe::update(), OpalQuadrupole::update(), OpalRBend3D::update(), OpalRCollimator::update(), OpalSeptum::update(), OpalSextupole::update(), OpalSlit::update(), OpalSolenoid::update(), OpalSource::update(), OpalStripper::update(), OpalTravelingWave::update(), OpalUndulator::update(), OpalVacuum::update(), and OpalVKicker::update().

Here is the call graph for this function:

◆ setElementPosition()

void ElementBase::setElementPosition ( double elemedge )

inlineinherited

Access to ELEMEDGE attribute.

Definition at line 583 of file ElementBase.h.

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

Referenced by OpalElement::update().

◆ setEngeOriginDelta()

void Bend2D::setEngeOriginDelta ( double delta )

privateinherited

Definition at line 1048 of file Bend2D.cpp.

References abs(), BendBase::chordLength_m, Bend2D::entranceParameter1_m, Bend2D::entranceParameter2_m, Bend2D::entranceParameter3_m, Bend2D::exitParameter1_m, Bend2D::exitParameter2_m, Bend2D::exitParameter3_m, Bend2D::findChordLength(), and Bend2D::setupFringeWidths().

Referenced by Bend2D::findBendEffectiveLength().

Here is the call graph for this function:

◆ setEntranceAngle()

void Bend2D::setEntranceAngle ( double entranceAngle )

inlineoverridevirtualinherited

Reimplemented from BendBase.

Reimplemented in RBend.

Definition at line 332 of file Bend2D.h.

References cos(), Bend2D::cosEntranceAngle_m, BendBase::entranceAngle_m, BendBase::setEntranceAngle(), sin(), Bend2D::sinEntranceAngle_m, tan(), and Bend2D::tanEntranceAngle_m.

Referenced by Bend2D::findIdealBendParameters(), RBend::setEntranceAngle(), Bend2D::setupBendGeometry(), and OpalSBend::update().

Here is the call graph for this function:

◆ setEntryFaceCurvature()

void SBendRep::setEntryFaceCurvature ( double h1 )

virtual

Set entry pole face curvature.

Definition at line 189 of file SBendRep.cpp.

References hEntry.

Referenced by OpalSBend::update().

◆ setEntryFaceRotation()

void SBendRep::setEntryFaceRotation ( double e1 )

virtual

Set pole entry face rotation.

Definition at line 173 of file SBendRep.cpp.

References rEntry.

Referenced by OpalSBend::update().

◆ setExitAngle()

void Bend2D::setExitAngle ( double exitAngle )

inlineinherited

Definition at line 341 of file Bend2D.h.

References Bend2D::exitAngle_m, tan(), and Bend2D::tanExitAngle_m.

Referenced by Bend2D::findIdealBendParameters(), RBend::setBendAngle(), RBend::setEntranceAngle(), and OpalSBend::update().

Here is the call graph for this function:

◆ setExitFaceCurvature()

void SBendRep::setExitFaceCurvature ( double h2 )

virtual

Set exit pole face curvature.

Definition at line 193 of file SBendRep.cpp.

References hExit.

Referenced by OpalSBend::update().

◆ setExitFaceRotation()

void SBendRep::setExitFaceRotation ( double e2 )

virtual

Set exit pole face rotation.

Definition at line 177 of file SBendRep.cpp.

References rExit.

Referenced by OpalSBend::update().

◆ setExitFaceSlope()

void Component::setExitFaceSlope ( const double & m )

inlineinherited

Definition at line 225 of file Component.h.

References Component::exit_face_slope_m.

◆ setField()

void SBendRep::setField ( const BMultipoleField & field )

virtual

Set field.

Definition at line 215 of file SBendRep.cpp.

References field.

Referenced by OpalSBend::update().

◆ setFieldAmplitude()

void BendBase::setFieldAmplitude	(	double	k0,
		double	k0s
	)

inherited

Definition at line 56 of file BendBase.cpp.

References BendBase::fieldAmplitudeX_m, and BendBase::fieldAmplitudeY_m.

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

◆ setFieldBoundaries()

void Bend2D::setFieldBoundaries	(	double	startField,
		double	endField
	)

privateinherited

Definition at line 1235 of file Bend2D.cpp.

References BendBase::angle_m, cos(), Bend2D::deltaBeginEntry_m, Bend2D::deltaEndExit_m, Bend2D::designRadius_m, Bend2D::endField_m, BendBase::entranceAngle_m, Bend2D::exitAngle_m, and Bend2D::startField_m.

Referenced by Bend2D::findBendEffectiveLength(), and Bend2D::setupBendGeometry().

Here is the call graph for this function:

◆ setFieldCalcParam()

void Bend2D::setFieldCalcParam ( )

privateinherited

Definition at line 1070 of file Bend2D.cpp.

References abs(), ElementBase::aperture_m, atan2(), Bend2D::beginToEnd_lcs_m, Bend2D::beginToEnd_m, Bend2D::computeAngleTrafo_m, Quaternion::conjugate(), cos(), Bend2D::cosEntranceAngle_m, Bend2D::deltaBeginEntry_m, Bend2D::deltaBeginExit_m, Bend2D::deltaEndEntry_m, Bend2D::deltaEndExit_m, Bend2D::designRadius_m, dot(), Bend2D::entranceParameter1_m, Bend2D::entranceParameter2_m, Bend2D::entranceParameter3_m, Bend2D::exitAngle_m, Bend2D::exitParameter1_m, Bend2D::exitParameter2_m, Bend2D::exitParameter3_m, fmod(), Bend2D::getBeginToEnd_local(), BendBase::getBendAngle(), BendBase::getChordLength(), BendBase::getEntranceAngle(), getQuaternion(), ElementBase::getRotationAboutZ(), Bend2D::maxAngle_m, pow(), Attrib::Distribution::R, Quaternion::rotate(), sin(), Bend2D::sinEntranceAngle_m, Bend2D::toEntranceRegion_m, Bend2D::toExitRegion_m, CoordinateSystemTrafo::transformFrom(), CoordinateSystemTrafo::transformTo(), and Physics::two_pi.

Referenced by Bend2D::findBendEffectiveLength(), and Bend2D::setupBendGeometry().

Here is the call graph for this function:

◆ setFieldMapFN()

void BendBase::setFieldMapFN ( std::string fileName )

inlineinherited

Definition at line 137 of file BendBase.h.

References BendBase::fileName_m.

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

◆ setFlagDeleteOnTransverseExit()

void ElementBase::setFlagDeleteOnTransverseExit ( bool flag = true )

inlineinherited

Definition at line 608 of file ElementBase.h.

References ElementBase::deleteOnTransverseExit_m.

Referenced by OpalElement::update().

◆ setFullGap()

void BendBase::setFullGap ( double gap )

inlineinherited

Definition at line 108 of file BendBase.h.

References abs(), and BendBase::gap_m.

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

Here is the call graph for this function:

◆ setGapFromFieldMap()

void Bend2D::setGapFromFieldMap ( )

privateinherited

Definition at line 1158 of file Bend2D.cpp.

References Bend2D::adjustFringeFields(), BendBase::fieldmap_m, and BendBase::gap_m.

Referenced by Bend2D::readFieldMap().

Here is the call graph for this function:

◆ setK1()

void Bend2D::setK1 ( double k1 )

inlineinherited

Set quadrupole field component.

Definition at line 305 of file Bend2D.h.

References abs(), and Bend2D::fieldIndex_m.

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

Here is the call graph for this function:

◆ setMessageHeader()

void Bend2D::setMessageHeader ( const std::string & header )

inlineprotectedinherited

Definition at line 314 of file Bend2D.h.

References Bend2D::messageHeader_m.

Referenced by RBend::RBend(), and SBend::SBend().

◆ setMisalignment()

void ElementBase::setMisalignment ( const CoordinateSystemTrafo & cst )

inlineinherited

Definition at line 536 of file ElementBase.h.

References ElementBase::misalignment_m.

Referenced by OpalElement::update().

◆ setName()

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

virtualinherited

Set element name.

Definition at line 167 of file ElementBase.cpp.

References ElementBase::elementID, and name.

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

◆ setNormalComponent()

void SBend::setNormalComponent	(	int	n,
		double	v
	)

inherited

Set normal component.

Definition at line 67 of file SBend.cpp.

References SBend::getField(), Hypervolume::n, and BMultipoleField::setNormalComponent().

Referenced by getChannel().

Here is the call graph for this function:

◆ setNSlices()

void Bend2D::setNSlices ( const std::size_t & nSlices )

inherited

Definition at line 1644 of file Bend2D.cpp.

References Bend2D::nSlices_m.

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

◆ setOutputFN()

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

inherited

Set output filename.

Definition at line 172 of file ElementBase.cpp.

References ElementBase::outputfn_m.

Referenced by OpalCCollimator::update(), OpalCyclotron::update(), OpalECollimator::update(), OpalFlexibleCollimator::update(), OpalMonitor::update(), OpalOutputPlane::update(), OpalPepperPot::update(), OpalProbe::update(), OpalRCollimator::update(), OpalSeptum::update(), OpalSlit::update(), OpalSource::update(), and OpalStripper::update().

◆ setParticleMatterInteraction()

void ElementBase::setParticleMatterInteraction ( ParticleMatterInteractionHandler * spys )

virtualinherited

Definition at line 274 of file ElementBase.cpp.

References ElementBase::parmatint_m.

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

◆ setRotationAboutZ()

void ElementBase::setRotationAboutZ ( double rotation )

inlineinherited

Set rotation about z axis in bend frame.

Definition at line 569 of file ElementBase.h.

References ElementBase::rotationZAxis_m.

Referenced by OpalElement::update().

◆ setSkewComponent()

void SBend::setSkewComponent	(	int	n,
		double	v
	)

inherited

Set skew component.

Definition at line 71 of file SBend.cpp.

References SBend::getField(), Hypervolume::n, and BMultipoleField::setSkewComponent().

Referenced by getChannel().

Here is the call graph for this function:

◆ setSlices()

void SBendRep::setSlices ( double sl )

virtual

Set number of slices.

Definition at line 206 of file SBendRep.cpp.

References slices.

Referenced by OpalSBend::update().

◆ setStepsize()

void SBendRep::setStepsize ( double ds )

virtual

Set stepsize.

Definition at line 210 of file SBendRep.cpp.

References stepsize.

Referenced by OpalSBend::update().

◆ setupBendGeometry()

bool Bend2D::setupBendGeometry	(	double &	startField,
		double &	endField
	)

privateinherited

Definition at line 1167 of file Bend2D.cpp.

References ElementBase::aperture_m, BendBase::chordLength_m, Bend2D::designRadius_m, ElementBase::elementEdge_m, Bend2D::endField_m, BendBase::fileName_m, Bend2D::findChordLength(), Bend2D::findIdealBendParameters(), BendBase::getEntranceAngle(), Bend2D::getType(), Bend2D::isFieldZero(), RBEND, Bend2D::reinitialize_m, Bend2D::setBendEffectiveLength(), Bend2D::setBendStrength(), Bend2D::setEntranceAngle(), Bend2D::setFieldBoundaries(), Bend2D::setFieldCalcParam(), and Bend2D::startField_m.

Referenced by Bend2D::initialise().

Here is the call graph for this function:

◆ setupDefaultFieldMap()

bool Bend2D::setupDefaultFieldMap ( )

privateinherited

Definition at line 1219 of file Bend2D.cpp.

References endl(), ERRORMSG, and ElementBase::getElementLength().

Referenced by Bend2D::initializeFieldMap().

Here is the call graph for this function:

◆ setupFringeWidths()

void Bend2D::setupFringeWidths ( )

privateinherited

Definition at line 1637 of file Bend2D.cpp.

References ElementBase::aperture_m, Bend2D::entranceParameter1_m, Bend2D::entranceParameter3_m, Bend2D::exitParameter1_m, Bend2D::exitParameter3_m, min(), Bend2D::widthEntranceFringe_m, and Bend2D::widthExitFringe_m.

Referenced by Bend2D::adjustFringeFields(), Bend2D::initialise(), and Bend2D::setEngeOriginDelta().

Here is the call graph for this function:

◆ setupPusher()

void Bend2D::setupPusher ( PartBunchBase< double, 3 > * bunch )

privateinherited

Definition at line 1242 of file Bend2D.cpp.

References PartBunchBase< T, Dim >::getReference(), BorisPusher::initialise(), Bend2D::pusher_m, and Component::RefPartBunch_m.

Referenced by Bend2D::initialise().

Here is the call graph for this function:

◆ setWake()

void ElementBase::setWake ( WakeFunction * wf )

virtualinherited

attach a wake field to the element

Definition at line 266 of file ElementBase.cpp.

References ElementBase::wake_m.

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

◆ trackBunch()

void Component::trackBunch	(	PartBunchBase< double, 3 > *	bunch,
		const PartData &	,
		bool	revBeam,
		bool	revTrack
	)		const

virtualinherited

Track particle bunch.

Definition at line 71 of file Component.cpp.

References ElementBase::getName().

Referenced by Tracker::visitComponent().

Here is the call graph for this function:

◆ trackMap()

void Component::trackMap	(	FVps< double, 6 > &	map,
		const PartData &	,
		bool	revBeam,
		bool	revTrack
	)		const

virtualinherited

Track a map.

Definition at line 77 of file Component.cpp.

References ElementBase::getName().

Here is the call graph for this function:

◆ transformToEntranceRegion()

Vector_t Bend2D::transformToEntranceRegion ( const Vector_t & R ) const

inlineprivateinherited

Definition at line 370 of file Bend2D.h.

References Attrib::Distribution::R, Bend2D::toEntranceRegion_m, and CoordinateSystemTrafo::transformTo().

Referenced by Bend2D::calculateMapField().

Here is the call graph for this function:

◆ transformToExitRegion()

Vector_t Bend2D::transformToExitRegion ( const Vector_t & R ) const

inlineprivateinherited

Definition at line 375 of file Bend2D.h.

References Attrib::Distribution::R, Bend2D::toExitRegion_m, and CoordinateSystemTrafo::transformTo().

Referenced by Bend2D::calculateMapField().

Here is the call graph for this function:

◆ update()

bool ElementBase::update ( const AttributeSet & set )

inherited

Update element.

Definition at line 258 of file ElementBase.cpp.

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

Referenced by Monitor::driftToCorrectPositionAndSave().

Here is the call graph for this function:

Member Data Documentation

◆ actionRange_m

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

privateinherited

Definition at line 399 of file ElementBase.h.

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

◆ angle_m

double BendBase::angle_m

protectedinherited

Bend angle.

Definition at line 53 of file BendBase.h.

Referenced by Bend2D::estimateFieldAdjustmentStep(), Bend2D::findBendEffectiveLength(), Bend2D::findBendStrength(), Bend2D::findIdealBendParameters(), BendBase::getBendAngle(), Bend2D::getEffectiveCenter(), Bend2D::getEffectiveLength(), Bend2D::getSurfaceMesh(), RBend3D::initialise(), Bend2D::isFieldZero(), Bend2D::print(), BendBase::setBendAngle(), Bend2D::setBendEffectiveLength(), and Bend2D::setFieldBoundaries().

◆ aperture_m

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

protectedinherited

Definition at line 369 of file ElementBase.h.

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

◆ beginToEnd_lcs_m

CoordinateSystemTrafo Bend2D::beginToEnd_lcs_m

privateinherited

Definition at line 267 of file Bend2D.h.

Referenced by Bend2D::getBeginToEnd_local(), and Bend2D::setFieldCalcParam().

◆ beginToEnd_m

CoordinateSystemTrafo Bend2D::beginToEnd_m

privateinherited

Definition at line 266 of file Bend2D.h.

Referenced by Bend2D::getEdgeToEnd(), and Bend2D::setFieldCalcParam().

◆ bgeometry_m

BoundaryGeometry* ElementBase::bgeometry_m

privateinherited

Definition at line 390 of file ElementBase.h.

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

◆ chordLength_m

double BendBase::chordLength_m

protectedinherited

Definition at line 52 of file BendBase.h.

Referenced by Bend2D::adjustFringeFields(), BendBase::getChordLength(), RBend3D::initialise(), Bend2D::isFieldZero(), Bend2D::setEngeOriginDelta(), and Bend2D::setupBendGeometry().

◆ computeAngleTrafo_m

CoordinateSystemTrafo Bend2D::computeAngleTrafo_m

privateinherited

Definition at line 271 of file Bend2D.h.

Referenced by Bend2D::inMagnetCentralRegion(), and Bend2D::setFieldCalcParam().

◆ cosEntranceAngle_m

double Bend2D::cosEntranceAngle_m

privateinherited

Enge function order for entry region.

Definition at line 261 of file Bend2D.h.

Referenced by Bend2D::calculateBendAngle(), Bend2D::calculateMapField(), Bend2D::calculateRefTrajectory(), Bend2D::getOutline(), Bend2D::getSurfaceMesh(), Bend2D::inMagnetCentralRegion(), Bend2D::setEntranceAngle(), and Bend2D::setFieldCalcParam().

◆ csTrafoGlobal2Local_m

CoordinateSystemTrafo ElementBase::csTrafoGlobal2Local_m

protectedinherited

Definition at line 366 of file ElementBase.h.

Referenced by Monitor::applyToReferenceParticle(), ElementBase::getBoundingBoxInLabCoords(), Bend2D::getBoundingBoxInLabCoords(), ElementBase::getCSTrafoGlobal2Local(), and ElementBase::setCSTrafoGlobal2Local().

◆ defaultAperture_m

const std::vector< double > Component::defaultAperture_m

staticprotectedinherited

Initial value:

=

std::vector<double>({1e6, 1e6, 1.0})

Definition at line 187 of file Component.h.

Referenced by Component::Component().

◆ deleteOnTransverseExit_m

bool ElementBase::deleteOnTransverseExit_m = true

privateinherited

Definition at line 403 of file ElementBase.h.

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

◆ deltaBeginEntry_m

double Bend2D::deltaBeginEntry_m

privateinherited

Definition at line 249 of file Bend2D.h.

Referenced by Bend2D::calculateBendAngle(), Bend2D::calculateRefTrajectory(), Bend2D::setFieldBoundaries(), and Bend2D::setFieldCalcParam().

◆ deltaBeginExit_m

double Bend2D::deltaBeginExit_m

privateinherited

Enge function order for entry region.

Definition at line 255 of file Bend2D.h.

Referenced by Bend2D::setFieldCalcParam().

◆ deltaEndEntry_m

double Bend2D::deltaEndEntry_m

privateinherited

Perpendicular distance from entrance Enge.

function origin where Enge function starts.

Definition at line 251 of file Bend2D.h.

Referenced by Bend2D::setFieldCalcParam().

◆ deltaEndExit_m

double Bend2D::deltaEndExit_m

privateinherited

Perpendicular distance from exit Enge.

function origin that Enge function starts.

Definition at line 257 of file Bend2D.h.

Referenced by Bend2D::setFieldBoundaries(), and Bend2D::setFieldCalcParam().

◆ designEnergy_m

double BendBase::designEnergy_m

protectedinherited

Bend design energy (eV).

Definition at line 61 of file BendBase.h.

Referenced by BendBase::calcGamma(), BendBase::getDesignEnergy(), Bend2D::isFieldZero(), Bend2D::print(), and BendBase::setDesignEnergy().

◆ designEnergyChangeable_m

bool BendBase::designEnergyChangeable_m

protectedinherited

Definition at line 62 of file BendBase.h.

Referenced by BendBase::setDesignEnergy().

◆ designRadius_m

double Bend2D::designRadius_m

privateinherited

Pusher used to integrate reference particle.

through the bend.

Definition at line 199 of file Bend2D.h.

Referenced by Bend2D::apply(), Bend2D::calculateMapField(), Bend2D::estimateFieldAdjustmentStep(), Bend2D::findIdealBendParameters(), Bend2D::getBendRadius(), Bend2D::getEffectiveCenter(), Bend2D::getEffectiveLength(), Bend2D::getOutline(), Bend2D::getSurfaceMesh(), Bend2D::inMagnetCentralRegion(), Bend2D::isFieldZero(), Bend2D::print(), Bend2D::setBendStrength(), Bend2D::setFieldBoundaries(), Bend2D::setFieldCalcParam(), and Bend2D::setupBendGeometry().

◆ elemedgeSet_m

bool ElementBase::elemedgeSet_m

privateinherited

Definition at line 397 of file ElementBase.h.

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

◆ elementEdge_m

double ElementBase::elementEdge_m

protectedinherited

Definition at line 371 of file ElementBase.h.

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

◆ elementID

std::string ElementBase::elementID

privateinherited

Definition at line 381 of file ElementBase.h.

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

◆ elementPosition_m

double ElementBase::elementPosition_m

privateinherited

ELEMEDGE attribute.

Definition at line 396 of file ElementBase.h.

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

◆ elementTypeToString_s

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

staticprivateinherited

Definition at line 383 of file ElementBase.h.

Referenced by ElementBase::getTypeString().

◆ endField_m

double Bend2D::endField_m

privateinherited

Start of magnet field map in s coordinates (m).

Definition at line 205 of file Bend2D.h.

Referenced by Bend2D::calculateBendAngle(), Bend2D::calculateRefTrajectory(), Bend2D::getDimensions(), Bend2D::initialise(), Bend2D::print(), Bend2D::setFieldBoundaries(), and Bend2D::setupBendGeometry().

◆ engeCoeffsEntry_m

std::vector<double> Bend2D::engeCoeffsEntry_m

privateinherited

Enge coefficients for map entry and exit regions.

Definition at line 237 of file Bend2D.h.

Referenced by Bend2D::print(), and Bend2D::readFieldMap().

◆ engeCoeffsExit_m

std::vector<double> Bend2D::engeCoeffsExit_m

privateinherited

Definition at line 238 of file Bend2D.h.

Referenced by Bend2D::print(), and Bend2D::readFieldMap().

◆ entranceAngle_m

double BendBase::entranceAngle_m

protectedinherited

Angle between incoming reference trajectory and the entrance face of the magnet (radians).

Definition at line 54 of file BendBase.h.

Referenced by Bend2D::calculateBendAngle(), Bend2D::calculateRefTrajectory(), Bend2D::findIdealBendParameters(), BendBase::getEntranceAngle(), Bend2D::getSurfaceMesh(), RBend3D::initialise(), Bend2D::print(), BendBase::setEntranceAngle(), Bend2D::setEntranceAngle(), Bend2D::setFieldBoundaries(), and RBend3D::trackRefParticleThrough().

◆ entranceParameter1_m

double Bend2D::entranceParameter1_m

privateinherited

Definition at line 229 of file Bend2D.h.

Referenced by Bend2D::adjustFringeFields(), Bend2D::calcEntranceFringeField(), Bend2D::getEntranceFringeFieldLength(), Bend2D::getOutline(), Bend2D::getSurfaceMesh(), Bend2D::inMagnetEntranceRegion(), Bend2D::isPositionInEntranceField(), Bend2D::print(), Bend2D::readFieldMap(), Bend2D::setEngeOriginDelta(), Bend2D::setFieldCalcParam(), and Bend2D::setupFringeWidths().

◆ entranceParameter2_m

double Bend2D::entranceParameter2_m

privateinherited

Definition at line 230 of file Bend2D.h.

Referenced by Bend2D::adjustFringeFields(), Bend2D::calcEntranceFringeField(), Bend2D::getEntranceFringeFieldLength(), Bend2D::print(), Bend2D::readFieldMap(), Bend2D::setEngeOriginDelta(), and Bend2D::setFieldCalcParam().

◆ entranceParameter3_m

double Bend2D::entranceParameter3_m

privateinherited

Definition at line 231 of file Bend2D.h.

Referenced by Bend2D::adjustFringeFields(), Bend2D::calcEntranceFringeField(), Bend2D::getEntranceFringeFieldLength(), Bend2D::getSurfaceMesh(), Bend2D::isPositionInEntranceField(), Bend2D::print(), Bend2D::readFieldMap(), Bend2D::setEngeOriginDelta(), Bend2D::setFieldCalcParam(), and Bend2D::setupFringeWidths().

◆ entryFieldAccel_m

gsl_interp_accel* Bend2D::entryFieldAccel_m

privateinherited

Definition at line 242 of file Bend2D.h.

Referenced by Bend2D::calcEntranceFringeField(), Bend2D::readFieldMap(), and Bend2D::~Bend2D().

◆ entryFieldValues_m

gsl_spline** Bend2D::entryFieldValues_m

privateinherited

Definition at line 240 of file Bend2D.h.

Referenced by Bend2D::calcEntranceFringeField(), Bend2D::readFieldMap(), and Bend2D::~Bend2D().

◆ exit_face_slope_m

double Component::exit_face_slope_m

protectedinherited

Definition at line 189 of file Component.h.

Referenced by Component::setExitFaceSlope().

◆ exitAngle_m

double Bend2D::exitAngle_m

privateinherited

Bend design radius (m).

Definition at line 201 of file Bend2D.h.

Referenced by Bend2D::findIdealBendParameters(), Bend2D::getExitAngle(), Bend2D::getSurfaceMesh(), Bend2D::print(), Bend2D::setExitAngle(), Bend2D::setFieldBoundaries(), and Bend2D::setFieldCalcParam().

◆ exitFieldAccel_m

gsl_interp_accel* Bend2D::exitFieldAccel_m

privateinherited

Definition at line 243 of file Bend2D.h.

Referenced by Bend2D::calcExitFringeField(), Bend2D::readFieldMap(), and Bend2D::~Bend2D().

◆ exitFieldValues_m

gsl_spline** Bend2D::exitFieldValues_m

privateinherited

Definition at line 241 of file Bend2D.h.

Referenced by Bend2D::calcExitFringeField(), Bend2D::readFieldMap(), and Bend2D::~Bend2D().

◆ exitParameter1_m

double Bend2D::exitParameter1_m

privateinherited

Definition at line 232 of file Bend2D.h.

Referenced by Bend2D::adjustFringeFields(), Bend2D::calcExitFringeField(), Bend2D::getExitFringeFieldLength(), Bend2D::getSurfaceMesh(), Bend2D::isPositionInExitField(), Bend2D::print(), Bend2D::readFieldMap(), Bend2D::setEngeOriginDelta(), Bend2D::setFieldCalcParam(), and Bend2D::setupFringeWidths().

◆ exitParameter2_m

double Bend2D::exitParameter2_m

privateinherited

Definition at line 233 of file Bend2D.h.

Referenced by Bend2D::adjustFringeFields(), Bend2D::calcExitFringeField(), Bend2D::getExitFringeFieldLength(), Bend2D::print(), Bend2D::readFieldMap(), Bend2D::setEngeOriginDelta(), and Bend2D::setFieldCalcParam().

◆ exitParameter3_m

double Bend2D::exitParameter3_m

privateinherited

Definition at line 234 of file Bend2D.h.

Referenced by Bend2D::adjustFringeFields(), Bend2D::calcExitFringeField(), Bend2D::getExitFringeFieldLength(), Bend2D::getOutline(), Bend2D::getSurfaceMesh(), Bend2D::inMagnetExitRegion(), Bend2D::isPositionInExitField(), Bend2D::print(), Bend2D::readFieldMap(), Bend2D::setEngeOriginDelta(), Bend2D::setFieldCalcParam(), and Bend2D::setupFringeWidths().

◆ fast_m

const bool BendBase::fast_m = false

protectedinherited

Flag to turn on fast field calculation.

Definition at line 57 of file BendBase.h.

Referenced by RBend3D::initialise(), and Bend2D::initializeFieldMap().

◆ field

BMultipoleField SBendRep::field

private

The multipole expansion.

Definition at line 142 of file SBendRep.h.

Referenced by getB(), getField(), setB(), and setField().

◆ fieldAmplitude_m

double BendBase::fieldAmplitude_m

protectedinherited

Field amplitude.

Definition at line 71 of file BendBase.h.

Referenced by Bend2D::apply(), RBend3D::apply(), RBend3D::applyToReferenceParticle(), Bend2D::calculateBendAngle(), Bend2D::calculateRefTrajectory(), Bend2D::estimateFieldAdjustmentStep(), Bend2D::findBendStrength(), Bend2D::findIdealBendParameters(), BendBase::getFieldAmplitude(), RBend3D::initialise(), Bend2D::isFieldZero(), Bend2D::print(), and Bend2D::setBendStrength().

◆ fieldAmplitudeX_m

double BendBase::fieldAmplitudeX_m

protectedinherited

Field amplitude in x direction.

Value not updated if user defines strength with angle

Definition at line 66 of file BendBase.h.

Referenced by RBend::findChordLength(), Bend2D::findIdealBendParameters(), RBend3D::initialise(), Bend2D::isFieldZero(), and BendBase::setFieldAmplitude().

◆ fieldAmplitudeY_m

double BendBase::fieldAmplitudeY_m

protectedinherited

Field amplitude in y direction.

Value not updated if user defines strength with angle

Definition at line 68 of file BendBase.h.

Referenced by RBend::findChordLength(), Bend2D::findIdealBendParameters(), RBend3D::initialise(), Bend2D::isFieldZero(), and BendBase::setFieldAmplitude().

◆ fieldIndex_m

double Bend2D::fieldIndex_m

privateinherited

Angle between outgoing reference trajectory.

and the exit face of the magnet (radians).

Definition at line 203 of file Bend2D.h.

Referenced by Bend2D::print(), and Bend2D::setK1().

◆ fieldmap_m

Fieldmap BendBase::fieldmap_m

protectedinherited

Magnet field map.

Definition at line 56 of file BendBase.h.

Referenced by RBend3D::apply(), RBend3D::applyToReferenceParticle(), Bend2D::getEntranceFringeFieldLength(), Bend2D::getExitFringeFieldLength(), RBend3D::getSurfaceMesh(), RBend3D::initialise(), Bend2D::initializeFieldMap(), RBend3D::isInside(), Bend2D::readFieldMap(), and Bend2D::setGapFromFieldMap().

◆ fileName_m

std::string BendBase::fileName_m

protectedinherited

Definition at line 73 of file BendBase.h.

Referenced by BendBase::getFieldMapFN(), RBend3D::goOffline(), RBend3D::goOnline(), Bend2D::initialise(), RBend3D::initialise(), Bend2D::initializeFieldMap(), Bend2D::print(), Bend2D::readFieldMap(), BendBase::setFieldMapFN(), and Bend2D::setupBendGeometry().

◆ gap_m

double BendBase::gap_m

protectedinherited

Full vertical gap of the magnets.

Definition at line 59 of file BendBase.h.

Referenced by Bend2D::calcEngeFunction(), Bend2D::calculateMapField(), Bend2D::findBendEffectiveLength(), BendBase::getFullGap(), Bend2D::isInside(), Bend2D::print(), Bend2D::readFieldMap(), BendBase::setFullGap(), and Bend2D::setGapFromFieldMap().

◆ geometry

PlanarArcGeometry SBendRep::geometry

private

The bend geometry.

Definition at line 139 of file SBendRep.h.

Referenced by getGeometry().

◆ hEntry

double SBendRep::hEntry

private

Definition at line 147 of file SBendRep.h.

Referenced by getEntryFaceCurvature(), SBendRep(), and setEntryFaceCurvature().

◆ hExit

double SBendRep::hExit

private

Definition at line 148 of file SBendRep.h.

Referenced by getExitFaceCurvature(), SBendRep(), and setExitFaceCurvature().

◆ maxAngle_m

double Bend2D::maxAngle_m

privateinherited

Definition at line 272 of file Bend2D.h.

Referenced by Bend2D::inMagnetCentralRegion(), and Bend2D::setFieldCalcParam().

◆ messageHeader_m

std::string Bend2D::messageHeader_m

privateinherited

Definition at line 194 of file Bend2D.h.

Referenced by Bend2D::initialise(), and Bend2D::setMessageHeader().

◆ misalignment_m

CoordinateSystemTrafo ElementBase::misalignment_m

protectedinherited

Definition at line 367 of file ElementBase.h.

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

◆ nSlices_m

std::size_t Bend2D::nSlices_m

privateinherited

Definition at line 274 of file Bend2D.h.

Referenced by Bend2D::getNSlices(), and Bend2D::setNSlices().

◆ online_m

bool Component::online_m

protectedinherited

Definition at line 192 of file Component.h.

Referenced by Monitor::apply(), Source::apply(), Probe::doGoOffline(), Cyclotron::finalise(), PluginElement::finalise(), Bend2D::finalise(), FlexibleCollimator::finalise(), Multipole::finalise(), Ring::finalise(), Vacuum::finalise(), Component::goOffline(), PluginElement::goOffline(), Degrader::goOffline(), FlexibleCollimator::goOffline(), RBend3D::goOffline(), RFCavity::goOffline(), Solenoid::goOffline(), Source::goOffline(), Vacuum::goOffline(), Component::goOnline(), Corrector::goOnline(), Bend2D::goOnline(), CCollimator::goOnline(), Degrader::goOnline(), FlexibleCollimator::goOnline(), Monitor::goOnline(), RBend3D::goOnline(), RFCavity::goOnline(), Solenoid::goOnline(), Source::goOnline(), TravelingWave::goOnline(), Vacuum::goOnline(), Ring::initialise(), Septum::initialise(), Cyclotron::initialise(), Multipole::initialise(), Component::Online(), Degrader::~Degrader(), FlexibleCollimator::~FlexibleCollimator(), and Vacuum::~Vacuum().

◆ outputfn_m

std::string ElementBase::outputfn_m

privateinherited

The name of the outputfile.

Definition at line 401 of file ElementBase.h.

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

◆ parmatint_m

ParticleMatterInteractionHandler* ElementBase::parmatint_m

privateinherited

Definition at line 392 of file ElementBase.h.

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

◆ polyOrderEntry_m

int Bend2D::polyOrderEntry_m

privateinherited

Perpendicular distance from entrance Enge.

function origin that Enge function ends.

Definition at line 253 of file Bend2D.h.

Referenced by Bend2D::isPositionInEntranceField(), Bend2D::print(), and Bend2D::readFieldMap().

◆ polyOrderExit_m

int Bend2D::polyOrderExit_m

privateinherited

Perpendicular distance from exit Enge.

function origin that Enge function ends.

Definition at line 259 of file Bend2D.h.

Referenced by Bend2D::isPositionInExitField(), Bend2D::print(), and Bend2D::readFieldMap().

◆ positionIsFixed

bool ElementBase::positionIsFixed

privateinherited

Definition at line 394 of file ElementBase.h.

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

◆ pusher_m

BorisPusher Bend2D::pusher_m

privateinherited

Definition at line 196 of file Bend2D.h.

Referenced by Bend2D::calculateBendAngle(), Bend2D::calculateRefTrajectory(), and Bend2D::setupPusher().

◆ refCount

int RCObject::refCount

mutableprivateinherited

Definition at line 76 of file RCObject.h.

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

◆ RefPartBunch_m

PartBunchBase<double, 3>* Component::RefPartBunch_m

protectedinherited

Definition at line 191 of file Component.h.

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

◆ refTrajMap_m

std::vector<Vector_t> BendBase::refTrajMap_m

protectedinherited

Map of reference particle trajectory.

Definition at line 64 of file BendBase.h.

Referenced by Bend2D::calculateRefTrajectory(), and BendBase::getDesignPath().

◆ reinitialize_m

bool Bend2D::reinitialize_m

privateinherited

Definition at line 216 of file Bend2D.h.

Referenced by Bend2D::setupBendGeometry().

◆ rEntry

double SBendRep::rEntry

private

Definition at line 145 of file SBendRep.h.

Referenced by getEntryFaceRotation(), SBendRep(), and setEntryFaceRotation().

◆ rExit

double SBendRep::rExit

private

Definition at line 146 of file SBendRep.h.

Referenced by getExitFaceRotation(), SBendRep(), and setExitFaceRotation().

◆ rotationZAxis_m

double ElementBase::rotationZAxis_m

protectedinherited

Definition at line 373 of file ElementBase.h.

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

◆ shareFlag

bool ElementBase::shareFlag

mutableprotectedinherited

Definition at line 364 of file ElementBase.h.

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

◆ sinEntranceAngle_m

double Bend2D::sinEntranceAngle_m

privateinherited

Definition at line 262 of file Bend2D.h.

Referenced by Bend2D::calculateBendAngle(), Bend2D::calculateMapField(), Bend2D::calculateRefTrajectory(), Bend2D::getOutline(), Bend2D::getSurfaceMesh(), Bend2D::inMagnetCentralRegion(), Bend2D::setEntranceAngle(), and Bend2D::setFieldCalcParam().

◆ slices

double SBendRep::slices

private

Definition at line 151 of file SBendRep.h.

Referenced by getSlices(), and setSlices().

◆ startField_m

double Bend2D::startField_m

privateinherited

Dipole field index.

Definition at line 204 of file Bend2D.h.

Referenced by Bend2D::calculateBendAngle(), Bend2D::calculateRefTrajectory(), Bend2D::getDimensions(), Bend2D::getStartField(), Bend2D::initialise(), Bend2D::print(), Bend2D::setFieldBoundaries(), and Bend2D::setupBendGeometry().

◆ stepsize

double SBendRep::stepsize

private

Definition at line 152 of file SBendRep.h.

Referenced by getStepsize(), and setStepsize().

◆ tanEntranceAngle_m

double Bend2D::tanEntranceAngle_m

privateinherited

Definition at line 263 of file Bend2D.h.

Referenced by Bend2D::calculateBendAngle(), Bend2D::calculateRefTrajectory(), Bend2D::getOutline(), Bend2D::getSurfaceMesh(), and Bend2D::setEntranceAngle().

◆ tanExitAngle_m

double Bend2D::tanExitAngle_m

privateinherited

Definition at line 264 of file Bend2D.h.

Referenced by Bend2D::getOutline(), Bend2D::getSurfaceMesh(), and Bend2D::setExitAngle().

◆ toEntranceRegion_m

CoordinateSystemTrafo Bend2D::toEntranceRegion_m

privateinherited

Definition at line 268 of file Bend2D.h.

Referenced by Bend2D::getSurfaceMesh(), Bend2D::setCSTrafoToEntranceRegion(), Bend2D::setFieldCalcParam(), and Bend2D::transformToEntranceRegion().

◆ toExitRegion_m

CoordinateSystemTrafo Bend2D::toExitRegion_m

privateinherited

Definition at line 269 of file Bend2D.h.

Referenced by Bend2D::getSurfaceMesh(), Bend2D::setCSTrafoToExitRegion(), Bend2D::setFieldCalcParam(), and Bend2D::transformToExitRegion().

◆ userAttribs

AttributeSet ElementBase::userAttribs

privateinherited

Definition at line 386 of file ElementBase.h.

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

◆ wake_m

WakeFunction* ElementBase::wake_m

privateinherited

Definition at line 388 of file ElementBase.h.

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

◆ widthEntranceFringe_m

double Bend2D::widthEntranceFringe_m

privateinherited

End of magnet field map in s coordinates (m).

Definition at line 207 of file Bend2D.h.

Referenced by Bend2D::getOutline(), and Bend2D::setupFringeWidths().

◆ widthExitFringe_m

double Bend2D::widthExitFringe_m

privateinherited

Definition at line 208 of file Bend2D.h.

Referenced by Bend2D::getOutline(), and Bend2D::setupFringeWidths().

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SBendRep() [1/3]

◆ SBendRep() [2/3]

◆ SBendRep() [3/3]

◆ ~SBendRep()

Member Function Documentation

◆ accept()

◆ addReference()

◆ adjustFringeFields()

◆ apply() [1/2]

◆ apply() [2/2]

◆ applyToReferenceParticle()

◆ bends()

◆ Bfield() [1/2]

◆ Bfield() [2/2]

◆ calcBendAngle()

◆ calcBetaGamma()

◆ calcCentralField()

◆ calcDesignRadius() [1/2]

◆ calcDesignRadius() [2/2]

◆ calcEngeFunction()

◆ calcEntranceFringeField()

◆ calcExitFringeField()

◆ calcFieldAmplitude()

◆ calcGamma()

◆ calculateBendAngle()

◆ calculateMapField()

◆ calculateRefTrajectory()

◆ clone()

◆ copyStructure()

◆ EBfield() [1/2]

◆ EBfield() [2/2]

◆ Efield() [1/2]

◆ Efield() [2/2]

◆ estimateFieldAdjustmentStep()

◆ finalise()

◆ findBendEffectiveLength()

◆ findBendStrength()

◆ findChordLength()

◆ findIdealBendParameters()

◆ fixPosition()

◆ getAperture()

◆ getArcLength()

◆ getAttribute()

◆ getB()

◆ getBeginToEnd_local()

◆ getBendAngle()

◆ getBendRadius()

◆ getBoundaryGeometry()

◆ getBoundingBoxInLabCoords()

◆ getChannel()

◆ getChordLength()

◆ getConstChannel()

◆ getCSTrafoGlobal2Local()

◆ getDesign()

◆ getDesignEnergy()

◆ getDesignPath()

◆ getDimensions()

◆ getEdgeToBegin()

◆ getEdgeToEnd()

◆ getEffectiveCenter()

◆ getEffectiveLength()

◆ getElementDimensions()

◆ getElementLength()

◆ getElementPosition()

◆ getEntrance()

◆ getEntranceAngle()

◆ getEntranceFrame()

◆ getEntranceFringeFieldLength()

◆ getEntrancePatch()

◆ getEntryFaceCurvature()