SBend Class Reference

#include <SBend.h>

Inheritance diagram for SBend:

Collaboration diagram for SBend:

Public Member Functions
	SBend (const std::string &name)
	Constructor with given name.
	SBend ()
	SBend (const SBend &)
virtual	~SBend ()
virtual void	accept (BeamlineVisitor &) const override
	Apply visitor to SBend.
virtual double	getB () const =0
	Get dipole field of SBend.
virtual PlanarArcGeometry &	getGeometry () override=0
	Get SBend geometry.
virtual const PlanarArcGeometry &	getGeometry () const override=0
	Get SBend geometry.
virtual BMultipoleField &	getField () override=0
	Get multipole expansion of field.
virtual const BMultipoleField &	getField () const override=0
	Get multipole expansion of field.
double	getNormalComponent (int) const
	Get normal component.
double	getSkewComponent (int) const
	Get skew component.
void	setNormalComponent (int, double)
	Set normal component.
void	setSkewComponent (int, double)
	Set skew component.
virtual double	getEntryFaceRotation () const =0
	Get pole entry face rotation.
virtual double	getExitFaceRotation () const =0
	Get exit pole face rotation.
virtual double	getEntryFaceCurvature () const =0
	Get entry pole face curvature.
virtual double	getExitFaceCurvature () const =0
	Get exit pole face curvature.
virtual double	getSlices () const =0
	Get number of slices.
virtual double	getStepsize () const =0
	Get stepsize.
virtual ElementType	getType () const override
	Get element type std::string.
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.
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.
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.
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.
std::array< double, 2 >	getExitFringeFieldLength () const
	Get exit fringe field length.
BoundingBox	getBoundingBoxInLabCoords () const override
virtual bool	bends () const
	Indicates that element bends the beam.
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.
EVector	Efield (const Point3D &P, double t) const
	Return the field in a point.
BVector	Bfield (const Point3D &P) const
	Return the field in a point.
BVector	Bfield (const Point3D &P, double t) const
	Return the field in a point.
EBVectors	EBfield (const Point3D &P) const
	Return the field in a point.
EBVectors	EBfield (const Point3D &P, double t) const
	Return the field in a point.
virtual bool	getPotential (const Vector_t &, const double &, Vector_t &, double &)
virtual void	goOffline ()
virtual bool	Online ()
virtual const ElementBase &	getDesign () const
	Return design element.
virtual void	trackBunch (PartBunchBase< double, 3 > *bunch, const PartData &, bool revBeam, bool revTrack) const
	Track particle bunch.
virtual void	trackMap (FVps< double, 6 > &map, const PartData &, bool revBeam, bool revTrack) const
	Track a map.
void	setExitFaceSlope (const double &)
virtual const std::string &	getName () const
	Get element name.
virtual void	setName (const std::string &name)
	Set element name.
std::string	getTypeString () const
virtual double	getArcLength () const
	Get arc length.
virtual double	getElementLength () const
	Get design length.
virtual void	setElementLength (double length)
	Set design length.
virtual void	getElementDimensions (double &begin, double &end) const
virtual double	getOrigin () const
	Get origin position.
virtual double	getEntrance () const
	Get entrance position.
virtual double	getExit () const
	Get exit position.
virtual Euclid3D	getTransform (double fromS, double toS) const
	Get transform.
virtual Euclid3D	getTransform (double s) const
	Get transform.
virtual Euclid3D	getTotalTransform () const
	Get transform.
virtual Euclid3D	getEntranceFrame () const
	Get transform.
virtual Euclid3D	getExitFrame () const
	Get transform.
virtual Euclid3D	getEntrancePatch () const
	Get patch.
virtual Euclid3D	getExitPatch () const
	Get patch.
virtual double	getAttribute (const std::string &aKey) const
	Get attribute value.
virtual bool	hasAttribute (const std::string &aKey) const
	Test for existence of an attribute.
virtual void	removeAttribute (const std::string &aKey)
	Remove an existing attribute.
virtual void	setAttribute (const std::string &aKey, double val)
	Set value of an attribute.
virtual Channel *	getChannel (const std::string &aKey, bool create=false)
	Construct a read/write channel.
virtual const ConstChannel *	getConstChannel (const std::string &aKey) const
	Construct a read-only channel.
virtual ElementBase *	clone () const =0
	Return clone.
virtual ElementBase *	copyStructure ()
	Make a structural copy.
bool	isSharable () const
	Test if the element can be shared.
virtual void	makeSharable ()
	Set sharable flag.
bool	update (const AttributeSet &)
	Update element.
virtual void	setBoundaryGeometry (BoundaryGeometry *geo)
virtual BoundaryGeometry *	getBoundaryGeometry () const
	return the attached boundary geometrt object if there is any
virtual bool	hasBoundaryGeometry () const
virtual void	setWake (WakeFunction *wf)
	attach a wake field to the element
virtual WakeFunction *	getWake () const
	return the attached wake object if there is any
virtual bool	hasWake () const
virtual void	setParticleMatterInteraction (ParticleMatterInteractionHandler *spys)
virtual ParticleMatterInteractionHandler *	getParticleMatterInteraction () const
virtual bool	hasParticleMatterInteraction () const
void	setCSTrafoGlobal2Local (const CoordinateSystemTrafo &ori)
CoordinateSystemTrafo	getCSTrafoGlobal2Local () const
void	releasePosition ()
void	fixPosition ()
bool	isPositioned () const
virtual CoordinateSystemTrafo	getEdgeToBegin () const
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.
double	getRotationAboutZ () const
virtual int	getRequiredNumberOfTimeSteps () const
void	setOutputFN (std::string fn)
	Set output filename.
std::string	getOutputFN () const
	Get output filename.
void	setFlagDeleteOnTransverseExit (bool=true)
bool	getFlagDeleteOnTransverseExit () const
int	addReference () const
	Increment reference count.
int	removeReference () const
	Decrement the reference count.
bool	isShared () const
	Test for sharing.
void	setElementPosition (double elemedge)
	Access to ELEMEDGE attribute.
double	getElementPosition () const
bool	isElementPositionSet () const

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

Protected Member Functions
void	setMessageHeader (const std::string &header)
double	getStartField () const
double	calcDesignRadius (double fieldAmplitude) const
	Calculate design radius from design energy and field amplitude.
double	calcDesignRadius (double chordLength, double angle) const
	Calculate design radius from chord length and bend angle.
double	calcFieldAmplitude (double radius) const
	Calculate field amplitude from design energy and radius.
double	calcBendAngle (double chordLength, double radius) const
	Calculate bend angle from chord length and design radius.
double	calcGamma () const
	Calculate gamma from design energy.
double	calcBetaGamma () const
	Calculate beta*gamma from design energy.
bool	isInsideTransverse (const Vector_t &r) const

Protected Attributes
double	chordLength_m
double	angle_m
	Bend angle.
double	entranceAngle_m
Fieldmap	fieldmap_m
	Magnet field map.
const bool	fast_m = false
	Flag to turn on fast field calculation.
double	gap_m
	Full vertical gap of the magnets.
double	designEnergy_m
	Bend design energy (eV).
bool	designEnergyChangeable_m
std::vector< Vector_t >	refTrajMap_m
	Map of reference particle trajectory.
double	fieldAmplitudeX_m
double	fieldAmplitudeY_m
double	fieldAmplitude_m
	Field amplitude.
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 SBend &)
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
std::string	messageHeader_m
BorisPusher	pusher_m
double	designRadius_m
	through the bend.
double	exitAngle_m
	Bend design radius (m).
double	fieldIndex_m
	and the exit face of the magnet (radians).
double	startField_m
	Dipole field index.
double	endField_m
	Start of magnet field map in s coordinates (m).
double	widthEntranceFringe_m
	End of magnet field map in s coordinates (m).
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.
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
	function origin where Enge function starts.
int	polyOrderEntry_m
	function origin that Enge function ends.
double	deltaBeginExit_m
	Enge function order for entry region.
double	deltaEndExit_m
	function origin that Enge function starts.
int	polyOrderExit_m
	function origin that Enge function ends.
double	cosEntranceAngle_m
	Enge function order for entry region.
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
bool	deleteOnTransverseExit_m = true
int	refCount
double	elementPosition_m
	ELEMEDGE attribute.
bool	elemedgeSet_m

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

Detailed Description

Definition at line 68 of file SBend.h.

Constructor & Destructor Documentation

SBend() [1/3]

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

explicit

Constructor with given name.

Definition at line 42 of file SBend.cpp.

References Bend2D::Bend2D(), name, and Bend2D::setMessageHeader().

Referenced by operator=(), SBend(), SBend(), SBendRep::SBendRep(), SBendRep::SBendRep(), and SBendRep::SBendRep().

Here is the call graph for this function:

SBend() [2/3]

SBend::SBend

(

)

Definition at line 32 of file SBend.cpp.

References SBend().

Here is the call graph for this function:

SBend() [3/3]

SBend::SBend

(

const SBend &

right

)

Definition at line 36 of file SBend.cpp.

References Bend2D::Bend2D(), SBend(), and Bend2D::setMessageHeader().

Here is the call graph for this function:

~SBend()

SBend::~SBend ( )

virtual

Definition at line 48 of file SBend.cpp.

Member Function Documentation

accept()

void SBend::accept ( BeamlineVisitor & visitor ) const

overridevirtual

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

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

adjustFringeFields()

void Bend2D::adjustFringeFields ( double ratio )

privateinherited

Definition at line 234 of file Bend2D.cpp.

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

Referenced by 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 apply(), and Component::RefPartBunch_m.

Referenced by apply(), and 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 calculateMapField(), designRadius_m, BendBase::fieldAmplitude_m, ElementBase::getFlagDeleteOnTransverseExit(), 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 apply().

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

Referenced by OutputPlane::getFieldsAtPoint().

Here is the call graph for this function:

Bfield() [2/2]

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

inlineinherited

Return the field in a point.

Definition at line 208 of file Component.h.

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

Here is the call graph for this function:

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.

Referenced by Bend2D::findIdealBendParameters().

calcBetaGamma()

double BendBase::calcBetaGamma ( ) const

protectedinherited

Calculate beta*gamma from design energy.

Definition at line 95 of file BendBase.cpp.

References calcGamma().

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

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 Physics::c, calcBetaGamma(), 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 BendBase::gap_m.

Referenced by readFieldMap().

calcEntranceFringeField()

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

privateinherited

Definition at line 374 of file Bend2D.cpp.

References entranceParameter1_m, entranceParameter2_m, entranceParameter3_m, entryFieldAccel_m, entryFieldValues_m, CoordinateSystemTrafo::rotateFrom(), and CoordinateSystemTrafo::transformTo().

Referenced by 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 exitFieldAccel_m, exitFieldValues_m, exitParameter1_m, exitParameter2_m, exitParameter3_m, getBeginToEnd_local(), CoordinateSystemTrafo::rotateFrom(), and CoordinateSystemTrafo::transformTo().

Referenced by 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, calcBetaGamma(), 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 designEnergy_m, and Component::RefPartBunch_m.

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

calculateBendAngle()

double Bend2D::calculateBendAngle ( )

privateinherited

Definition at line 252 of file Bend2D.cpp.

References Physics::c, BendBase::calcBetaGamma(), calculateMapField(), cosEntranceAngle_m, deltaBeginEntry_m, endField_m, BendBase::entranceAngle_m, euclidean_norm(), BendBase::fieldAmplitude_m, pusher_m, Component::RefPartBunch_m, sinEntranceAngle_m, startField_m, tanEntranceAngle_m, and X.

Referenced by findBendEffectiveLength(), findBendStrength(), and 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 calcCentralField(), calcEntranceFringeField(), calcExitFringeField(), cosEntranceAngle_m, designRadius_m, BendBase::gap_m, getBeginToEnd_local(), inMagnetCentralRegion(), inMagnetEntranceRegion(), inMagnetExitRegion(), isPositionInEntranceField(), isPositionInExitField(), sinEntranceAngle_m, CoordinateSystemTrafo::transformTo(), transformToEntranceRegion(), and transformToExitRegion().

Referenced by apply(), calculateBendAngle(), and 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 Physics::c, BendBase::calcBetaGamma(), BendBase::calcGamma(), calculateMapField(), Util::combineFilePath(), cosEntranceAngle_m, deltaBeginEntry_m, endField_m, BendBase::entranceAngle_m, BendBase::fieldAmplitude_m, OpalData::getAuxiliaryOutputDirectory(), OpalData::getInputBasename(), OpalData::getInstance(), ElementBase::getName(), IpplInfo::myNode(), pusher_m, Component::RefPartBunch_m, BendBase::refTrajMap_m, sinEntranceAngle_m, startField_m, tanEntranceAngle_m, Options::writeBendTrajectories, and X.

Referenced by initialise().

Here is the call graph for this function:

clone()

virtual ElementBase * ElementBase::clone ( ) const

pure virtualinherited

Return clone.

Implemented in CCollimatorRep, CorrectorRep, CyclotronRep, DegraderRep, DriftRep, FlexibleCollimatorRep, MarkerRep, MonitorRep, MultipoleRep, MultipoleT, Offset, OutputPlane, ProbeRep, RBend3D, RBendRep, RFCavityRep, Ring, SBend3D, SBendRep, ScalingFFAMagnet, SeptumRep, SingleMultipole< order >, SingleMultipole< -2 >, SingleMultipole< -3 >, SingleMultipole< -4 >, SingleMultipole< 2 >, SingleMultipole< 3 >, SingleMultipole< 4 >, SolenoidRep, SourceRep, StripperRep, TBeamline< T >, TBeamline< FlaggedElmPtr >, TBeamline< SequenceMember >, TravelingWaveRep, UndulatorRep, VacuumRep, VariableRFCavity, VariableRFCavityFringeField, VerticalFFAMagnet, XCorrectorRep, and YCorrectorRep.

References ElementBase().

Referenced by Ring::appendElement(), Sequence::copy(), RingSection::operator=(), ParallelCyclotronTracker::ParallelCyclotronTracker(), OpalBeamline::visit(), ParallelCyclotronTracker::visitCCollimator(), ParallelCyclotronTracker::visitCorrector(), ParallelCyclotronTracker::visitCyclotron(), ParallelCyclotronTracker::visitDrift(), ParallelCyclotronTracker::visitMarker(), ParallelCyclotronTracker::visitMonitor(), ParallelCyclotronTracker::visitMultipole(), ParallelCyclotronTracker::visitProbe(), ParallelCyclotronTracker::visitRBend(), ParallelCyclotronTracker::visitRFCavity(), ParallelCyclotronTracker::visitSBend(), ParallelCyclotronTracker::visitSeptum(), ParallelCyclotronTracker::visitSolenoid(), ParallelCyclotronTracker::visitStripper(), and ParallelCyclotronTracker::visitVacuum().

Here is the call graph for this function:

copyStructure()

ElementBase * ElementBase::copyStructure ( )

virtualinherited

Make a structural copy.

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

Definition at line 244 of file ElementBase.cpp.

References ElementBase(), and isSharable().

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

Here is the call graph for this function:

EBfield() [1/2]

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

inlineinherited

Return the field in a point.

Definition at line 211 of file Component.h.

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

Here is the call graph for this function:

EBfield() [2/2]

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

inlineinherited

Return the field in a point.

Definition at line 214 of file Component.h.

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

Here is the call graph for this function:

Efield() [1/2]

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

inlineinherited

Return the field in a point.

Definition at line 199 of file Component.h.

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

Referenced by OutputPlane::getFieldsAtPoint().

Here is the call graph for this function:

Efield() [2/2]

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

inlineinherited

Return the field in a point.

Definition at line 205 of file Component.h.

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

Here is the call graph for this function:

estimateFieldAdjustmentStep()

double Bend2D::estimateFieldAdjustmentStep ( double actualBendAngle )

privateinherited

Definition at line 577 of file Bend2D.cpp.

References BendBase::angle_m, BendBase::calcFieldAmplitude(), designRadius_m, and BendBase::fieldAmplitude_m.

Referenced by 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 BendBase::angle_m, calculateBendAngle(), BendBase::gap_m, setEngeOriginDelta(), setFieldBoundaries(), and setFieldCalcParam().

Referenced by setBendEffectiveLength().

Here is the call graph for this function:

findBendStrength()

void Bend2D::findBendStrength ( )

privateinherited

Definition at line 683 of file Bend2D.cpp.

References BendBase::angle_m, calculateBendAngle(), estimateFieldAdjustmentStep(), BendBase::fieldAmplitude_m, and Units::rad2deg.

Referenced by setBendStrength().

Here is the call graph for this function:

findChordLength()

bool SBend::findChordLength ( double & chordLength )

overrideprivatevirtual

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 BendBase::angle_m, BendBase::calcBendAngle(), BendBase::calcDesignRadius(), BendBase::calcFieldAmplitude(), designRadius_m, BendBase::entranceAngle_m, exitAngle_m, BendBase::fieldAmplitude_m, BendBase::fieldAmplitudeX_m, BendBase::fieldAmplitudeY_m, Physics::pi, Component::RefPartBunch_m, ElementBase::rotationZAxis_m, setEntranceAngle(), and setExitAngle().

Referenced by setupBendGeometry().

Here is the call graph for this function:

fixPosition()

void ElementBase::fixPosition ( )

inlineinherited

Definition at line 551 of file ElementBase.h.

References positionIsFixed.

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

getAperture()

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

inlineinherited

Definition at line 525 of file ElementBase.h.

References aperture_m.

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

getArcLength()

double ElementBase::getArcLength ( ) const

inlinevirtualinherited

Get arc length.

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

Definition at line 411 of file ElementBase.h.

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

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

Here is the call graph for this function:

getAttribute()

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

virtualinherited

Get attribute value.

Definition at line 187 of file ElementBase.cpp.

References getConstChannel().

Here is the call graph for this function:

getB()

virtual double SBend::getB ( ) const

pure virtual

Get dipole field of SBend.

Implemented in SBendRep.

Referenced by ThickTracker::visitSBend().

getBeginToEnd_local()

CoordinateSystemTrafo Bend2D::getBeginToEnd_local ( ) const

inlineinherited

Definition at line 354 of file Bend2D.h.

References beginToEnd_lcs_m.

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

getBendAngle()

double BendBase::getBendAngle ( ) const

inlineinherited

Definition at line 92 of file BendBase.h.

References 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 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 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(), getEdgeToEnd(), BendBase::getFullGap(), and getOutline().

Here is the call graph for this function:

getChannel()

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

virtualinherited

Construct a read/write channel.

Reimplemented in CCollimatorRep, CorrectorRep, CyclotronRep, DegraderRep, DriftRep, FlexibleCollimatorRep, MonitorRep, MultipoleRep, ProbeRep, RBendRep, RFCavityRep, SBendRep, SeptumRep, SingleMultipole< order >, SingleMultipole< -2 >, SingleMultipole< -3 >, SingleMultipole< -4 >, SingleMultipole< 2 >, SingleMultipole< 3 >, SingleMultipole< 4 >, SolenoidRep, SourceRep, StripperRep, TravelingWaveRep, UndulatorRep, VacuumRep, XCorrectorRep, and YCorrectorRep.

Definition at line 228 of file ElementBase.cpp.

References userAttribs.

Referenced by CCollimatorRep::getChannel(), CorrectorRep::getChannel(), CyclotronRep::getChannel(), DegraderRep::getChannel(), DriftRep::getChannel(), FlexibleCollimatorRep::getChannel(), MonitorRep::getChannel(), MultipoleRep::getChannel(), ProbeRep::getChannel(), RBendRep::getChannel(), RFCavityRep::getChannel(), SBendRep::getChannel(), SeptumRep::getChannel(), SingleMultipole< order >::getChannel(), SolenoidRep::getChannel(), SourceRep::getChannel(), StripperRep::getChannel(), TravelingWaveRep::getChannel(), UndulatorRep::getChannel(), VacuumRep::getChannel(), XCorrectorRep::getChannel(), YCorrectorRep::getChannel(), getConstChannel(), and setAttribute().

getChordLength()

double BendBase::getChordLength ( ) const

inlineinherited

Definition at line 82 of file BendBase.h.

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

Referenced by getAttribute(), and hasAttribute().

Here is the call graph for this function:

getCSTrafoGlobal2Local()

CoordinateSystemTrafo ElementBase::getCSTrafoGlobal2Local ( ) const

inlineinherited

Definition at line 498 of file ElementBase.h.

References csTrafoGlobal2Local_m.

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

getDesign()

const ElementBase & Component::getDesign ( ) const

virtualinherited

Return design element.

Definition at line 67 of file Component.cpp.

References ElementBase::ElementBase().

Here is the call graph for this function:

getDesignEnergy()

double BendBase::getDesignEnergy ( ) const

inlinevirtualinherited

Reimplemented from Component.

Definition at line 126 of file BendBase.h.

References 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 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 endField_m, and 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 Bend2D::getBoundingBoxInLabCoords(), getBoundingBoxInLabCoords(), and SingleMultipole< 4 >::update().

getEdgeToEnd()

CoordinateSystemTrafo Bend2D::getEdgeToEnd ( ) const

inlineoverridevirtualinherited

Reimplemented from ElementBase.

Definition at line 348 of file Bend2D.h.

References beginToEnd_m.

Referenced by getBoundingBoxInLabCoords().

getEffectiveCenter()

double Bend2D::getEffectiveCenter ( ) const

inlineinherited

Definition at line 295 of file Bend2D.h.

References BendBase::angle_m, 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 designRadius_m.

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

getElementDimensions()

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

inlinevirtualinherited

Reimplemented in RFCavity, Solenoid, and TravelingWave.

Definition at line 174 of file ElementBase.h.

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

Referenced by MeshGenerator::add().

Here is the call graph for this function:

getElementLength()

double ElementBase::getElementLength ( ) const

inlinevirtualinherited

Get design length.

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

Definition at line 415 of file ElementBase.h.

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

Referenced by Component::apply(), Corrector::apply(), Multipole::apply(), Multipole::apply(), Solenoid::apply(), Undulator::apply(), Component::applyToReferenceParticle(), Multipole::applyToReferenceParticle(), Solenoid::applyToReferenceParticle(), Vacuum::checkPoint(), RBend::findChordLength(), SBend::findChordLength(), CCollimator::getDimensions(), Corrector::getDimensions(), Degrader::getDimensions(), Drift::getDimensions(), FlexibleCollimator::getDimensions(), Multipole::getDimensions(), RBend3D::getDimensions(), Solenoid::getDimensions(), Vacuum::getDimensions(), getEdgeToEnd(), Solenoid::getEdgeToEnd(), getElementDimensions(), Solenoid::getElementDimensions(), RFCavity::getElementLength(), Corrector::initialise(), Degrader::initialise(), Drift::initialise(), FlexibleCollimator::initialise(), Multipole::initialise(), RBend3D::initialise(), Solenoid::initialise(), Source::initialise(), Vacuum::initialise(), Degrader::isInside(), isInside(), Monitor::isInside(), Multipole::isInside(), FlexibleCollimator::isStopped(), Bend2D::setupDefaultFieldMap(), SingleMultipole< 4 >::update(), ParallelCyclotronTracker::visitCorrector(), ParallelCyclotronTracker::visitDrift(), ThickTracker::visitDrift(), ParallelCyclotronTracker::visitMultipole(), ThickTracker::visitMultipole(), ParallelCyclotronTracker::visitRBend(), ParallelCyclotronTracker::visitSBend(), and ThickTracker::visitSBend().

Here is the call graph for this function:

getElementPosition()

double ElementBase::getElementPosition ( ) const

inlineinherited

Definition at line 589 of file ElementBase.h.

References elemedgeSet_m, elementPosition_m, and getName().

Here is the call graph for this function:

getEntrance()

double ElementBase::getEntrance ( ) const

inlinevirtualinherited

Get entrance position.

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

Definition at line 427 of file ElementBase.h.

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

Here is the call graph for this function:

getEntranceAngle()

double BendBase::getEntranceAngle ( ) const

inlineinherited

Definition at line 103 of file BendBase.h.

References 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 >, TBeamline< FlaggedElmPtr >, and TBeamline< SequenceMember >.

Definition at line 447 of file ElementBase.h.

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

Here is the call graph for this function:

getEntranceFringeFieldLength()

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

inherited

Get entrance fringe field length.

Definition at line 1655 of file Bend2D.cpp.

References entranceParameter1_m, entranceParameter2_m, 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 getGeometry().

Here is the call graph for this function:

getEntryFaceCurvature()

virtual double SBend::getEntryFaceCurvature ( ) const

pure virtual

Get entry pole face curvature.

Implemented in SBendRep.

getEntryFaceRotation()

virtual double SBend::getEntryFaceRotation ( ) const

pure virtual

Get pole entry face rotation.

Implemented in SBendRep.

getExit()

double ElementBase::getExit ( ) const

inlinevirtualinherited

Get exit position.

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

Definition at line 431 of file ElementBase.h.

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

Here is the call graph for this function:

getExitAngle()

double Bend2D::getExitAngle ( ) const

inlineoverridevirtualinherited

Implements BendBase.

Definition at line 326 of file Bend2D.h.

References exitAngle_m.

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

getExitFaceCurvature()

virtual double SBend::getExitFaceCurvature ( ) const

pure virtual

Get exit pole face curvature.

Implemented in SBendRep.

getExitFaceRotation()

virtual double SBend::getExitFaceRotation ( ) const

pure virtual

Get exit pole face rotation.

Implemented in SBendRep.

getExitFrame()

Euclid3D ElementBase::getExitFrame ( ) const

inlinevirtualinherited

Get transform.

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

Definition at line 451 of file ElementBase.h.

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

Here is the call graph for this function:

getExitFringeFieldLength()

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

inherited

Get exit fringe field length.

Definition at line 1675 of file Bend2D.cpp.

References exitParameter1_m, exitParameter2_m, 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 getGeometry().

Here is the call graph for this function:

getField() [1/2]

virtual const BMultipoleField & SBend::getField ( ) const

overridepure virtual

Get multipole expansion of field.

Implements Component.

Implemented in SBendRep.

getField() [2/2]

virtual BMultipoleField & SBend::getField ( )

overridepure virtual

Get multipole expansion of field.

Implements Component.

Implemented in SBendRep.

Referenced by getNormalComponent(), getSkewComponent(), setNormalComponent(), and setSkewComponent().

getFieldAmplitude()

double BendBase::getFieldAmplitude ( ) const

inlineinherited

Definition at line 131 of file BendBase.h.

References fieldAmplitude_m.

getFieldMapFN()

std::string BendBase::getFieldMapFN ( ) const

inlineinherited

Definition at line 142 of file BendBase.h.

References fileName_m.

getFlagDeleteOnTransverseExit()

bool ElementBase::getFlagDeleteOnTransverseExit ( ) const

inlineinherited

Definition at line 614 of file ElementBase.h.

References deleteOnTransverseExit_m.

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

getFullGap()

double BendBase::getFullGap ( ) const

inlineinherited

Definition at line 113 of file BendBase.h.

References gap_m.

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

getGeometry() [1/2]

virtual const PlanarArcGeometry & SBend::getGeometry ( ) const

overridepure virtual

Get SBend geometry.

Implements ElementBase.

Implemented in SBendRep.

getGeometry() [2/2]

virtual PlanarArcGeometry & SBend::getGeometry ( )

overridepure virtual

Get SBend geometry.

Implements ElementBase.

Implemented in SBendRep.

getMisalignment() [1/2]

CoordinateSystemTrafo ElementBase::getMisalignment ( ) const

inlineinherited

Definition at line 541 of file ElementBase.h.

References misalignment_m.

getMisalignment() [2/2]

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

inherited

Referenced by ParallelTTracker::computeParticleMatterInteraction().

getName()

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

virtualinherited

Get element name.

Definition at line 162 of file ElementBase.cpp.

References elementID.

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

getNormalComponent()

double SBend::getNormalComponent

(

int

n

)

const

Get normal component.

Definition at line 59 of file SBend.cpp.

References getField(), and BMultipoleField::getNormalComponent().

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

Referenced by ThickTracker::visitSBend().

getOrigin()

double ElementBase::getOrigin ( ) const

inlinevirtualinherited

Get origin position.

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

Definition at line 423 of file ElementBase.h.

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

Here is the call graph for this function:

getOutline()

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

inherited

Definition at line 1281 of file Bend2D.cpp.

References a, ElementBase::aperture_m, Util::combineFilePath(), cosEntranceAngle_m, Units::deg2rad, designRadius_m, dot(), entranceParameter1_m, exitParameter3_m, OpalData::getAuxiliaryOutputDirectory(), getBeginToEnd_local(), OpalData::getInputBasename(), OpalData::getInstance(), ElementBase::getName(), getQuaternion(), IpplInfo::myNode(), Quaternion::rotate(), sinEntranceAngle_m, tanEntranceAngle_m, tanExitAngle_m, CoordinateSystemTrafo::transformFrom(), CoordinateSystemTrafo::transformTo(), Physics::two_pi, widthEntranceFringe_m, widthExitFringe_m, and Options::writeBendTrajectories.

Referenced by getBoundingBoxInLabCoords(), and 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 getName(), and outputfn_m.

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

Here is the call graph for this function:

getParticleMatterInteraction()

ParticleMatterInteractionHandler * ElementBase::getParticleMatterInteraction ( ) const

inlinevirtualinherited

Definition at line 483 of file ElementBase.h.

References parmatint_m.

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

getPotential()

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

inlinevirtualinherited

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

Parameters

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

Returns

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

Definition at line 130 of file Component.h.

getRequiredNumberOfTimeSteps()

int ElementBase::getRequiredNumberOfTimeSteps ( ) const

inlinevirtualinherited

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

Definition at line 603 of file ElementBase.h.

getRotationAboutZ()

double ElementBase::getRotationAboutZ ( ) const

inlineinherited

Definition at line 574 of file ElementBase.h.

References rotationZAxis_m.

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

getSkewComponent()

double SBend::getSkewComponent

(

int

n

)

const

Get skew component.

Definition at line 63 of file SBend.cpp.

References getField(), and BMultipoleField::getSkewComponent().

Referenced by SBendRep::getChannel().

Here is the call graph for this function:

getSlices()

virtual double SBend::getSlices ( ) const

pure virtual

Get number of slices.

Implemented in SBendRep.

getStartField()

double Bend2D::getStartField ( ) const

inlineprotectedinherited

Definition at line 320 of file Bend2D.h.

References startField_m.

getStepsize()

virtual double SBend::getStepsize ( ) const

pure virtual

Get stepsize.

Implemented in SBendRep.

getSurfaceMesh()

MeshData Bend2D::getSurfaceMesh ( ) const

inherited

Definition at line 1388 of file Bend2D.cpp.

References BendBase::angle_m, ElementBase::aperture_m, cosEntranceAngle_m, cross(), MeshData::decorations_m, designRadius_m, det(), dot(), BendBase::entranceAngle_m, entranceParameter1_m, entranceParameter3_m, euclidean_norm(), exitAngle_m, exitParameter1_m, exitParameter3_m, getBeginToEnd_local(), BendBase::getFullGap(), getOutline(), getType(), RBEND, Quaternion::rotate(), sinEntranceAngle_m, tanEntranceAngle_m, tanExitAngle_m, toEntranceRegion_m, 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 >, TBeamline< FlaggedElmPtr >, and TBeamline< SequenceMember >.

Definition at line 439 of file ElementBase.h.

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

Here is the call graph for this function:

getTransform() [1/2]

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

inlinevirtualinherited

Get transform.

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

Definition at line 435 of file ElementBase.h.

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

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

Here is the call graph for this function:

getTransform() [2/2]

Euclid3D ElementBase::getTransform ( double s ) const

inlinevirtualinherited

Get transform.

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

Definition at line 443 of file ElementBase.h.

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

Here is the call graph for this function:

getType()

ElementType SBend::getType ( ) const

overridevirtual

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

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

Here is the call graph for this function:

getTypeString() [2/2]

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

staticinherited

Definition at line 240 of file ElementBase.cpp.

References elementTypeToString_s.

getWake()

WakeFunction * ElementBase::getWake ( ) const

inlinevirtualinherited

return the attached wake object if there is any

Definition at line 467 of file ElementBase.h.

References wake_m.

goOffline()

void Component::goOffline ( )

virtualinherited

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

Definition at line 87 of file Component.cpp.

References online_m.

goOnline()

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

Referenced by ParallelCyclotronTracker::visitSolenoid().

Here is the call graph for this function:

hasBoundaryGeometry()

bool ElementBase::hasBoundaryGeometry ( ) const

inlinevirtualinherited

Definition at line 479 of file ElementBase.h.

References bgeometry_m.

hasParticleMatterInteraction()

bool ElementBase::hasParticleMatterInteraction ( ) const

inlinevirtualinherited

Definition at line 487 of file ElementBase.h.

References parmatint_m.

hasWake()

bool ElementBase::hasWake ( ) const

inlinevirtualinherited

Definition at line 471 of file ElementBase.h.

References wake_m.

initialise()

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

overridevirtualinherited

Implements Component.

Definition at line 192 of file Bend2D.cpp.

References calculateRefTrajectory(), ElementBase::elementEdge_m, endField_m, endl(), ERRORMSG, BendBase::fileName_m, ElementBase::getName(), gmsg, initializeFieldMap(), level2(), messageHeader_m, name, print(), readFieldMap(), ElementBase::setElementLength(), setupBendGeometry(), setupFringeWidths(), setupPusher(), 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 setupDefaultFieldMap().

Referenced by 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 ElementBase::aperture_m, computeAngleTrafo_m, cosEntranceAngle_m, designRadius_m, euclidean_norm(), getBeginToEnd_local(), maxAngle_m, sinEntranceAngle_m, CoordinateSystemTrafo::transformTo(), and Physics::two_pi.

Referenced by calculateMapField(), and 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 ElementBase::aperture_m, and entranceParameter1_m.

Referenced by calculateMapField(), and isInside().

inMagnetExitRegion()

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

privateinherited

Definition at line 823 of file Bend2D.cpp.

References ElementBase::aperture_m, exitParameter3_m, getBeginToEnd_local(), and CoordinateSystemTrafo::transformTo().

Referenced by calculateMapField(), and isInside().

Here is the call graph for this function:

isElementPositionSet()

bool ElementBase::isElementPositionSet ( ) const

inlineinherited

Definition at line 598 of file ElementBase.h.

References elemedgeSet_m.

isFieldZero()

bool Bend2D::isFieldZero ( )

privateinherited

Definition at line 1249 of file Bend2D.cpp.

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

Referenced by 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 BendBase::gap_m, inMagnetCentralRegion(), inMagnetEntranceRegion(), and inMagnetExitRegion().

Here is the call graph for this function:

isInsideTransverse()

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

protectedinherited

Definition at line 287 of file ElementBase.cpp.

References aperture_m.

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

isPositioned()

bool ElementBase::isPositioned ( ) const

inlineinherited

Definition at line 556 of file ElementBase.h.

References positionIsFixed.

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

isPositionInEntranceField()

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

privateinherited

Definition at line 832 of file Bend2D.cpp.

References entranceParameter1_m, entranceParameter3_m, and polyOrderEntry_m.

Referenced by calculateMapField().

isPositionInExitField()

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

privateinherited

Definition at line 839 of file Bend2D.cpp.

References exitParameter1_m, exitParameter3_m, getBeginToEnd_local(), polyOrderExit_m, and CoordinateSystemTrafo::transformTo().

Referenced by 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 shareFlag.

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

isShared()

bool RCObject::isShared ( ) const

inlineinherited

Test for sharing.

Definition at line 93 of file RCObject.h.

References refCount.

makeSharable()

void ElementBase::makeSharable ( )

virtualinherited

Set sharable flag.

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

Definition at line 253 of file ElementBase.cpp.

References shareFlag.

Referenced by OpalMarker::OpalMarker().

Online()

bool Component::Online ( )

virtualinherited

Definition at line 91 of file Component.cpp.

References online_m.

operator=()

void SBend::operator= ( const SBend & )

private

References SBend().

Here is the call graph for this function:

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, designRadius_m, ElementBase::elementEdge_m, endField_m, endl(), engeCoeffsEntry_m, engeCoeffsExit_m, BendBase::entranceAngle_m, entranceParameter1_m, entranceParameter2_m, entranceParameter3_m, exitAngle_m, exitParameter1_m, exitParameter2_m, exitParameter3_m, BendBase::fieldAmplitude_m, fieldIndex_m, BendBase::fileName_m, BendBase::gap_m, level2(), polyOrderEntry_m, polyOrderExit_m, Units::rad2deg, ElementBase::rotationZAxis_m, and startField_m.

Referenced by 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 Physics::c, calcEngeFunction(), engeCoeffsEntry_m, engeCoeffsExit_m, entranceParameter1_m, entranceParameter2_m, entranceParameter3_m, entryFieldAccel_m, entryFieldValues_m, exitFieldAccel_m, exitFieldValues_m, exitParameter1_m, exitParameter2_m, exitParameter3_m, BendBase::fieldmap_m, BendBase::fileName_m, BendBase::gap_m, ElementBase::getName(), level2(), polyOrderEntry_m, polyOrderExit_m, Units::ps2s, _Fieldmap::readMap(), and setGapFromFieldMap().

Referenced by initialise().

Here is the call graph for this function:

releasePosition()

void ElementBase::releasePosition ( )

inlineinherited

Definition at line 546 of file ElementBase.h.

References positionIsFixed.

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

removeAttribute()

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

virtualinherited

Remove an existing attribute.

Definition at line 212 of file ElementBase.cpp.

References userAttribs.

removeReference()

int RCObject::removeReference ( ) const

inlineinherited

Decrement the reference count.

Definition at line 88 of file RCObject.h.

References refCount.

setActionRange()

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

inlineinherited

Definition at line 561 of file ElementBase.h.

References actionRange_m, and elementEdge_m.

setAperture()

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

inlineinherited

Definition at line 519 of file ElementBase.h.

References aperture_m.

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

setAttribute()

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

virtualinherited

Set value of an attribute.

Definition at line 217 of file ElementBase.cpp.

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

Referenced by TBeamline< FlaggedElmPtr >::getChannel(), and OpalElement::updateUnknown().

Here is the call graph for this function:

setBendAngle()

void BendBase::setBendAngle ( double angle )

inlinevirtualinherited

Reimplemented in RBend.

Definition at line 87 of file BendBase.h.

References 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 BendBase::angle_m, calculateBendAngle(), and findBendEffectiveLength().

Referenced by 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(), designRadius_m, BendBase::fieldAmplitude_m, and findBendStrength().

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

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

setCSTrafoToEntranceRegion()

void Bend2D::setCSTrafoToEntranceRegion ( const CoordinateSystemTrafo & trafo )

inlineprivateinherited

Definition at line 360 of file Bend2D.h.

References toEntranceRegion_m.

setCSTrafoToExitRegion()

void Bend2D::setCSTrafoToExitRegion ( const CoordinateSystemTrafo & trafo )

inlineprivateinherited

Definition at line 365 of file Bend2D.h.

References toExitRegion_m.

setCurrentSCoordinate()

void ElementBase::setCurrentSCoordinate ( double s )

inherited

Definition at line 278 of file ElementBase.cpp.

setDesignEnergy()

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

inlinevirtualinherited

Reimplemented from Component.

Definition at line 118 of file BendBase.h.

References designEnergy_m, and designEnergyChangeable_m.

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

setElementLength()

void ElementBase::setElementLength ( double length )

inlinevirtualinherited

Set design length.

Reimplemented in MultipoleT.

Definition at line 419 of file ElementBase.h.

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

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

Here is the call graph for this function:

setElementPosition()

void ElementBase::setElementPosition ( double elemedge )

inlineinherited

Access to ELEMEDGE attribute.

Definition at line 583 of file ElementBase.h.

References elemedgeSet_m, and elementPosition_m.

Referenced by OpalElement::update().

setEngeOriginDelta()

void Bend2D::setEngeOriginDelta ( double delta )

privateinherited

Definition at line 1048 of file Bend2D.cpp.

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

Referenced by 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 cosEntranceAngle_m, BendBase::entranceAngle_m, BendBase::setEntranceAngle(), sinEntranceAngle_m, and tanEntranceAngle_m.

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

Here is the call graph for this function:

setExitAngle()

void Bend2D::setExitAngle ( double exitAngle )

inlineinherited

Definition at line 341 of file Bend2D.h.

References exitAngle_m, and tanExitAngle_m.

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

setExitFaceSlope()

void Component::setExitFaceSlope ( const double & m )

inlineinherited

Definition at line 225 of file Component.h.

References exit_face_slope_m.

setFieldAmplitude()

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

inherited

Definition at line 56 of file BendBase.cpp.

References fieldAmplitudeX_m, and fieldAmplitudeY_m.

Referenced by OpalRBend3D::update(), OpalRBend::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, deltaBeginEntry_m, deltaEndExit_m, designRadius_m, endField_m, BendBase::entranceAngle_m, exitAngle_m, and startField_m.

Referenced by findBendEffectiveLength(), and setupBendGeometry().

setFieldCalcParam()

void Bend2D::setFieldCalcParam ( )

privateinherited

Definition at line 1070 of file Bend2D.cpp.

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

Referenced by findBendEffectiveLength(), and 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 fileName_m.

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

setFlagDeleteOnTransverseExit()

void ElementBase::setFlagDeleteOnTransverseExit ( bool flag = true )

inlineinherited

Definition at line 608 of file ElementBase.h.

References deleteOnTransverseExit_m.

Referenced by OpalElement::update().

setFullGap()

void BendBase::setFullGap ( double gap )

inlineinherited

Definition at line 108 of file BendBase.h.

References gap_m.

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

setGapFromFieldMap()

void Bend2D::setGapFromFieldMap ( )

privateinherited

Definition at line 1158 of file Bend2D.cpp.

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

Referenced by 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 fieldIndex_m.

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

setMessageHeader()

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

inlineprotectedinherited

Definition at line 314 of file Bend2D.h.

References messageHeader_m.

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

setMisalignment()

void ElementBase::setMisalignment ( const CoordinateSystemTrafo & cst )

inlineinherited

Definition at line 536 of file ElementBase.h.

References misalignment_m.

Referenced by OpalElement::update().

setName()

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

virtualinherited

Set element name.

Definition at line 167 of file ElementBase.cpp.

References elementID, and name.

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

setNormalComponent()

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

Set normal component.

Definition at line 67 of file SBend.cpp.

References getField(), and BMultipoleField::setNormalComponent().

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

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

setParticleMatterInteraction()

void ElementBase::setParticleMatterInteraction ( ParticleMatterInteractionHandler * spys )

virtualinherited

Definition at line 274 of file ElementBase.cpp.

References parmatint_m.

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

setRotationAboutZ()

void ElementBase::setRotationAboutZ ( double rotation )

inlineinherited

Set rotation about z axis in bend frame.

Definition at line 569 of file ElementBase.h.

References rotationZAxis_m.

Referenced by OpalElement::update().

setSkewComponent()

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

Set skew component.

Definition at line 71 of file SBend.cpp.

References getField(), and BMultipoleField::setSkewComponent().

Referenced by SBendRep::getChannel().

Here is the call graph for this function:

setupBendGeometry()

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

privateinherited

Definition at line 1167 of file Bend2D.cpp.

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

Referenced by 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 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, entranceParameter1_m, entranceParameter3_m, exitParameter1_m, exitParameter3_m, widthEntranceFringe_m, and widthExitFringe_m.

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

setupPusher()

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

privateinherited

Definition at line 1242 of file Bend2D.cpp.

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

Referenced by 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 wake_m.

Referenced by OpalCavity::update(), OpalDrift::update(), OpalProbe::update(), OpalRBend3D::update(), OpalRBend::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 toEntranceRegion_m.

Referenced by calculateMapField().

transformToExitRegion()

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

inlineprivateinherited

Definition at line 375 of file Bend2D.h.

References toExitRegion_m.

Referenced by calculateMapField().

update()

bool ElementBase::update ( const AttributeSet & set )

inherited

Update element.

Definition at line 258 of file ElementBase.cpp.

Referenced by Monitor::driftToCorrectPositionAndSave().

Member Data Documentation

actionRange_m

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

privateinherited

Definition at line 399 of file ElementBase.h.

Referenced by setActionRange().

angle_m

double BendBase::angle_m

protectedinherited

Bend angle.

Definition at line 53 of file BendBase.h.

Referenced by BendBase(), BendBase(), Bend2D::estimateFieldAdjustmentStep(), Bend2D::findBendEffectiveLength(), Bend2D::findBendStrength(), Bend2D::findIdealBendParameters(), getBendAngle(), Bend2D::getEffectiveCenter(), Bend2D::getEffectiveLength(), Bend2D::getSurfaceMesh(), RBend3D::initialise(), Bend2D::isFieldZero(), Bend2D::print(), 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(), Bend2D::getOutline(), Bend2D::getSurfaceMesh(), Bend2D::inMagnetCentralRegion(), Bend2D::inMagnetEntranceRegion(), Bend2D::inMagnetExitRegion(), isInsideTransverse(), 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 setFieldCalcParam().

beginToEnd_m

CoordinateSystemTrafo Bend2D::beginToEnd_m

privateinherited

Definition at line 266 of file Bend2D.h.

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

bgeometry_m

BoundaryGeometry* ElementBase::bgeometry_m

privateinherited

Definition at line 390 of file ElementBase.h.

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

chordLength_m

double BendBase::chordLength_m

protectedinherited

Definition at line 52 of file BendBase.h.

Referenced by Bend2D::adjustFringeFields(), BendBase(), 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 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(), Bend2D(), calculateBendAngle(), calculateMapField(), calculateRefTrajectory(), getOutline(), getSurfaceMesh(), inMagnetCentralRegion(), setEntranceAngle(), and setFieldCalcParam().

csTrafoGlobal2Local_m

CoordinateSystemTrafo ElementBase::csTrafoGlobal2Local_m

protectedinherited

Definition at line 366 of file ElementBase.h.

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

defaultAperture_m

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

staticprotectedinherited

Initial value:

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

Definition at line 187 of file Component.h.

Referenced by Component().

deleteOnTransverseExit_m

bool ElementBase::deleteOnTransverseExit_m = true

privateinherited

Definition at line 403 of file ElementBase.h.

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

deltaBeginEntry_m

double Bend2D::deltaBeginEntry_m

privateinherited

Definition at line 249 of file Bend2D.h.

Referenced by Bend2D(), Bend2D(), calculateBendAngle(), calculateRefTrajectory(), setFieldBoundaries(), and 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(), Bend2D(), and setFieldCalcParam().

deltaEndEntry_m

double Bend2D::deltaEndEntry_m

privateinherited

function origin where Enge function starts.

Perpendicular distance from entrance Enge

Definition at line 251 of file Bend2D.h.

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

deltaEndExit_m

double Bend2D::deltaEndExit_m

privateinherited

function origin that Enge function starts.

Perpendicular distance from exit Enge

Definition at line 257 of file Bend2D.h.

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

designEnergy_m

double BendBase::designEnergy_m

protectedinherited

Bend design energy (eV).

Definition at line 61 of file BendBase.h.

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

designEnergyChangeable_m

bool BendBase::designEnergyChangeable_m

protectedinherited

Definition at line 62 of file BendBase.h.

Referenced by BendBase(), BendBase(), and setDesignEnergy().

designRadius_m

double Bend2D::designRadius_m

privateinherited

through the bend.

Pusher used to integrate reference particle

Definition at line 199 of file Bend2D.h.

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

elemedgeSet_m

bool ElementBase::elemedgeSet_m

privateinherited

Definition at line 397 of file ElementBase.h.

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

elementEdge_m

double ElementBase::elementEdge_m

protectedinherited

Definition at line 371 of file ElementBase.h.

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

elementID

std::string ElementBase::elementID

privateinherited

Definition at line 381 of file ElementBase.h.

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

elementPosition_m

double ElementBase::elementPosition_m

privateinherited

ELEMEDGE attribute.

Definition at line 396 of file ElementBase.h.

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

elementTypeToString_s

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

staticprivateinherited

Definition at line 71 of file ElementBase.h.

Referenced by getTypeString().

endField_m

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(), Bend2D(), calculateBendAngle(), calculateRefTrajectory(), getDimensions(), initialise(), print(), setFieldBoundaries(), and 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 readFieldMap().

engeCoeffsExit_m

std::vector<double> Bend2D::engeCoeffsExit_m

privateinherited

Definition at line 238 of file Bend2D.h.

Referenced by Bend2D(), print(), and 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 BendBase(), BendBase(), Bend2D::calculateBendAngle(), Bend2D::calculateRefTrajectory(), Bend2D::findIdealBendParameters(), getEntranceAngle(), Bend2D::getSurfaceMesh(), RBend3D::initialise(), Bend2D::print(), Bend2D::setEntranceAngle(), setEntranceAngle(), Bend2D::setFieldBoundaries(), and RBend3D::trackRefParticleThrough().

entranceParameter1_m

double Bend2D::entranceParameter1_m

privateinherited

Definition at line 229 of file Bend2D.h.

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

entranceParameter2_m

double Bend2D::entranceParameter2_m

privateinherited

Definition at line 230 of file Bend2D.h.

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

entranceParameter3_m

double Bend2D::entranceParameter3_m

privateinherited

Definition at line 231 of file Bend2D.h.

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

entryFieldAccel_m

gsl_interp_accel* Bend2D::entryFieldAccel_m

privateinherited

Definition at line 242 of file Bend2D.h.

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

entryFieldValues_m

gsl_spline** Bend2D::entryFieldValues_m

privateinherited

Definition at line 240 of file Bend2D.h.

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

exit_face_slope_m

double Component::exit_face_slope_m

protectedinherited

Definition at line 189 of file Component.h.

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

exitAngle_m

double Bend2D::exitAngle_m

privateinherited

Bend design radius (m).

Definition at line 201 of file Bend2D.h.

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

exitFieldAccel_m

gsl_interp_accel* Bend2D::exitFieldAccel_m

privateinherited

Definition at line 243 of file Bend2D.h.

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

exitFieldValues_m

gsl_spline** Bend2D::exitFieldValues_m

privateinherited

Definition at line 241 of file Bend2D.h.

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

exitParameter1_m

double Bend2D::exitParameter1_m

privateinherited

Definition at line 232 of file Bend2D.h.

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

exitParameter2_m

double Bend2D::exitParameter2_m

privateinherited

Definition at line 233 of file Bend2D.h.

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

exitParameter3_m

double Bend2D::exitParameter3_m

privateinherited

Definition at line 234 of file Bend2D.h.

Referenced by adjustFringeFields(), Bend2D(), Bend2D(), calcExitFringeField(), getExitFringeFieldLength(), getOutline(), getSurfaceMesh(), inMagnetExitRegion(), isPositionInExitField(), print(), readFieldMap(), setEngeOriginDelta(), setFieldCalcParam(), and 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().

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(), BendBase(), BendBase(), Bend2D::calculateBendAngle(), Bend2D::calculateRefTrajectory(), Bend2D::estimateFieldAdjustmentStep(), Bend2D::findBendStrength(), Bend2D::findIdealBendParameters(), 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 BendBase(), BendBase(), RBend::findChordLength(), Bend2D::findIdealBendParameters(), RBend3D::initialise(), Bend2D::isFieldZero(), and 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 BendBase(), BendBase(), RBend::findChordLength(), Bend2D::findIdealBendParameters(), RBend3D::initialise(), Bend2D::isFieldZero(), and setFieldAmplitude().

fieldIndex_m

double Bend2D::fieldIndex_m

privateinherited

and the exit face of the magnet (radians).

Angle between outgoing reference trajectory

Definition at line 203 of file Bend2D.h.

Referenced by Bend2D(), Bend2D(), print(), and 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(), BendBase(), BendBase(), 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(), BendBase(), getFieldMapFN(), RBend3D::goOffline(), RBend3D::goOnline(), Bend2D::initialise(), RBend3D::initialise(), Bend2D::initializeFieldMap(), Bend2D::print(), Bend2D::readFieldMap(), 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 BendBase(), BendBase(), Bend2D::calcEngeFunction(), Bend2D::calculateMapField(), Bend2D::findBendEffectiveLength(), getFullGap(), Bend2D::isInside(), Bend2D::print(), Bend2D::readFieldMap(), setFullGap(), and Bend2D::setGapFromFieldMap().

maxAngle_m

double Bend2D::maxAngle_m

privateinherited

Definition at line 272 of file Bend2D.h.

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

messageHeader_m

std::string Bend2D::messageHeader_m

privateinherited

Definition at line 194 of file Bend2D.h.

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

misalignment_m

CoordinateSystemTrafo ElementBase::misalignment_m

protectedinherited

Definition at line 367 of file ElementBase.h.

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

nSlices_m

std::size_t Bend2D::nSlices_m

privateinherited

Definition at line 274 of file Bend2D.h.

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

online_m

bool Component::online_m

protectedinherited

Definition at line 192 of file Component.h.

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

outputfn_m

std::string ElementBase::outputfn_m

privateinherited

The name of the outputfile

Definition at line 401 of file ElementBase.h.

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

parmatint_m

ParticleMatterInteractionHandler* ElementBase::parmatint_m

privateinherited

Definition at line 392 of file ElementBase.h.

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

polyOrderEntry_m

int Bend2D::polyOrderEntry_m

privateinherited

function origin that Enge function ends.

Perpendicular distance from entrance Enge

Definition at line 253 of file Bend2D.h.

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

polyOrderExit_m

int Bend2D::polyOrderExit_m

privateinherited

function origin that Enge function ends.

Perpendicular distance from exit Enge

Definition at line 259 of file Bend2D.h.

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

positionIsFixed

bool ElementBase::positionIsFixed

privateinherited

Definition at line 394 of file ElementBase.h.

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

pusher_m

BorisPusher Bend2D::pusher_m

privateinherited

Definition at line 196 of file Bend2D.h.

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

refCount

int RCObject::refCount

mutableprivateinherited

Definition at line 76 of file RCObject.h.

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

RefPartBunch_m

PartBunchBase<double, 3>* Component::RefPartBunch_m

protectedinherited

Definition at line 191 of file Component.h.

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

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 BendBase(), Bend2D::calculateRefTrajectory(), and getDesignPath().

reinitialize_m

bool Bend2D::reinitialize_m

privateinherited

Definition at line 216 of file Bend2D.h.

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

rotationZAxis_m

double ElementBase::rotationZAxis_m

protectedinherited

Definition at line 373 of file ElementBase.h.

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

shareFlag

bool ElementBase::shareFlag

mutableprotectedinherited

Definition at line 364 of file ElementBase.h.

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

sinEntranceAngle_m

double Bend2D::sinEntranceAngle_m

privateinherited

Definition at line 262 of file Bend2D.h.

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

startField_m

double Bend2D::startField_m

privateinherited

Dipole field index.

Definition at line 204 of file Bend2D.h.

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

tanEntranceAngle_m

double Bend2D::tanEntranceAngle_m

privateinherited

Definition at line 263 of file Bend2D.h.

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

tanExitAngle_m

double Bend2D::tanExitAngle_m

privateinherited

Definition at line 264 of file Bend2D.h.

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

toEntranceRegion_m

CoordinateSystemTrafo Bend2D::toEntranceRegion_m

privateinherited

Definition at line 268 of file Bend2D.h.

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

toExitRegion_m

CoordinateSystemTrafo Bend2D::toExitRegion_m

privateinherited

Definition at line 269 of file Bend2D.h.

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

userAttribs

AttributeSet ElementBase::userAttribs

privateinherited

Definition at line 386 of file ElementBase.h.

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

wake_m

WakeFunction* ElementBase::wake_m

privateinherited

Definition at line 388 of file ElementBase.h.

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

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(), Bend2D(), getOutline(), and setupFringeWidths().

widthExitFringe_m

double Bend2D::widthExitFringe_m

privateinherited

Definition at line 208 of file Bend2D.h.

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

---

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

• SBend.h
• SBend.cpp