SBend Class Reference

Abstract sector bend with planar-arc body geometry. More...

#include <SBend.h>

Inheritance diagram for SBend:

Collaboration diagram for SBend:

Public Member Functions
	SBend ()
	SBend (const std::string &name)
	SBend (const SBend &)
	~SBend () override
void	accept (BeamlineVisitor &visitor) const override
	Apply visitor.
ElementType	getType () const override
	Get element type std::string.
PlanarArcGeometry &	getGeometry () override=0
	Get geometry.
const PlanarArcGeometry &	getGeometry () const override=0
	Get geometry.
void	setExitAngle (double exitAngle) override
double	getExitAngle () const override
bool	bends () const override
void	initialise (PartBunch_t *bunch, double &startField, double &endField) override
void	finalise () override
bool	apply (const std::shared_ptr< ParticleContainer_t > &pc) override
	Apply to all particles. Kernel launch moved inside the function.
bool	apply (const size_t &i, const double &t, Vector_t< double, 3 > &E, Vector_t< double, 3 > &B) override
	Apply to particle i.
bool	apply (const Vector_t< double, 3 > &R, const Vector_t< double, 3 > &P, const double &t, Vector_t< double, 3 > &E, Vector_t< double, 3 > &B) override
	Apply to particle with position R and momentum P.
bool	applyToReferenceParticle (const Vector_t< double, 3 > &R, const Vector_t< double, 3 > &P, const double &t, Vector_t< double, 3 > &E, Vector_t< double, 3 > &B) override
	Apply to reference particle with position R and momemtum P.
void	getFieldExtend (double &zBegin, double &zEnd) const override
	Return the field-support extent of the component.
bool	isInside (const Vector_t< double, 3 > &r) const override
CoordinateSystemTrafo	getEdgeToBegin () const override
CoordinateSystemTrafo	getEdgeToEnd () const override
void	setLength (double length)
	Set the nominal body length.
double	getLength () const
double	getChordLength () const
	Return the geometric chord between entrance and exit frames.
virtual void	setBendAngle (double angle)
double	getBendAngle () const
virtual void	setEntranceAngle (double entranceAngle)
double	getEntranceAngle () const
void	setFullGap (double gap)
double	getFullGap () const
void	setDesignEnergy (const double &energy, bool changeable=true) override
double	getDesignEnergy () const override
std::vector< Vector_t< double, 3 > >	getDesignPath (std::size_t minSamples=32) const
	Sample the local curved reference path of the bend body.
void	setFieldAmplitude (double k0, double k0s)
	Store the dipole design amplitudes used by the analytic field.
double	getFieldAmplitude () const
void	setFieldMapFN (std::string fileName)
std::string	getFieldMapFN () const
double	getB () const
void	setB (double B)
void	setEntryFaceRotation (double rotation)
double	getEntryFaceRotation () const
void	setExitFaceRotation (double rotation)
double	getExitFaceRotation () const
void	setEntryFaceCurvature (double curvature)
double	getEntryFaceCurvature () const
void	setExitFaceCurvature (double curvature)
double	getExitFaceCurvature () const
void	setSlices (double slices)
double	getSlices () const
void	setStepsize (double stepSize)
double	getStepsize () const
void	setNSlices (const std::size_t &nSlices)
std::size_t	getNSlices () const
void	setK1 (double k1)
double	getK1 () const
int	getRequiredNumberOfTimeSteps () const override
virtual BMultipoleField &	getField () override=0
	Return field.
virtual const BMultipoleField &	getField () const override=0
	Return field.
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< double, 3 > &, const double &, Vector_t< double, 3 > &, double &)
	Calculate the four-potential at some position relative to the component.
virtual void	goOnline (const double &kineticEnergy)
virtual void	goOffline ()
virtual bool	Online ()
virtual const ElementBase &	getDesign () const
	Return design element.
virtual void	trackBunch (PartBunch_t &bunch, const PartData &, bool revBeam, bool revTrack) const
	Track a borrowed particle bunch through a non-standard component.
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
	Return the nominal body extent of the element.
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 Port	getEntryPort () const
	Return the entrance port of the canonical local chart.
virtual Port	getBodyPort () const
	Return the body port of the canonical local chart.
virtual Port	getExitPort () const
	Return the exit port of the canonical local chart.
PlacementPose	getPlacementPose () const
	Return the nominal rigid placement transform of the element.
void	setPlacementPose (const PlacementPose &pose)
	Set the nominal rigid placement transform of the element.
Misalignment	getPlacementMisalignment () const
	Return the local nominal-to-actual correction stored for the element.
ElementGeometry	getPlacementGeometry () const
	Return the bridge geometry ports assembled from legacy edge state.
SupportPlacement	getPlacementSupport () const
	Return the support-frame bridge object. The default is the body frame.
PlacedElement	getPlacedElement () const
	Return a placed-element view assembled from the current bridge objects.
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 BoundingBox	getBoundingBoxInLabCoords () const
void	setOutputFN (std::string fn)
	Set output filename.
std::string	getOutputFN () const
	Get output filename.
void	setFlagDeleteOnTransverseExit (bool=true)
bool	getFlagDeleteOnTransverseExit () const
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
double	calcDesignRadius (double fieldAmplitude) const
double	calcDesignRadius (double chordLength, double angle) const
double	calcFieldAmplitude (double radius) const
double	calcBendAngle (double chordLength, double radius) const
double	calcGamma () const
double	calcBetaGamma () const
double	getStoredExitAngle () const
bool	isInsideTransverse (const Vector_t< double, 3 > &r) const

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

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

Static Private Member Functions
static void	computeFieldHost (const Vector_t< double, 3 > &R, const BMultipoleField &field, Vector_t< double, 3 > &B)

Private Attributes
double	startField_m
double	endField_m
double	angle_m
double	entranceAngle_m
double	exitAngle_m
double	gap_m
double	designEnergy_m
bool	designEnergyChangeable_m
double	fieldAmplitudeX_m
double	fieldAmplitudeY_m
double	fieldAmplitude_m
std::string	fileName_m
double	entryFaceRotation_m
double	exitFaceRotation_m
double	entryFaceCurvature_m
double	exitFaceCurvature_m
double	slices_m
double	stepSize_m
std::size_t	nSlices_m
double	k1_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
double	elementPosition_m
	ELEMEDGE attribute.
bool	elemedgeSet_m

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

Detailed Description

Abstract sector bend with planar-arc body geometry.

A sector bend is represented by a planar circular arc in the local x-z plane. The entrance and exit faces may have independent edge angles, so the canonical body geometry and the edge-face optics data are kept separately.

Definition at line 15 of file SBend.h.

Constructor & Destructor Documentation

SBend() [1/3]

SBend::SBend

(

)

Definition at line 5 of file SBend.cpp.

SBend() [2/3]

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

explicit

Definition at line 9 of file SBend.cpp.

SBend() [3/3]

SBend::SBend

(

const SBend &

right

)

Definition at line 7 of file SBend.cpp.

~SBend()

SBend::~SBend ( )

overridedefault

Member Function Documentation

accept()

void SBend::accept ( BeamlineVisitor &  visitor ) const

overridevirtual

Apply visitor.

Implements ElementBase.

Definition at line 13 of file SBend.cpp.

References BeamlineVisitor::visitSBend().

Referenced by TEST().

Here is the call graph for this function:

apply() [1/3]

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

overridevirtualinherited

Apply to particle i.

Parameters

i	Particle index
t	Time
E	Electric Field
B	Magnetic Field

Returns

true if particle is out-of-bounds (lost), false otherwise

Reimplemented from Component.

Definition at line 147 of file BendBase.cpp.

References BendBase::computeFieldHost(), BendBase::getField(), ElementBase::getFlagDeleteOnTransverseExit(), BendBase::isInside(), ElementBase::isInsideTransverse(), PartBunch< T, Dim >::R(), and Component::RefPartBunch_m.

Here is the call graph for this function:

apply() [2/3]

bool BendBase::apply ( const std::shared_ptr< ParticleContainer_t > &  pc )

overridevirtualinherited

Apply to all particles. Kernel launch moved inside the function.

Apply functions apply the components electromagnetic field to the particles. They are called inside ParalleTracker::computeExternalFields()

Returns

true if particle is out-of-bounds (lost), false otherwise

true if particle is out-of-bounds (lost), false otherwise

Reimplemented from Component.

Definition at line 92 of file BendBase.cpp.

References ElementBase::getElementLength(), BendBase::getField(), BMultipoleField::getNormalComponent(), BMultipoleField::getSkewComponent(), and BMultipoleField::order().

Here is the call graph for this function:

apply() [3/3]

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

overridevirtualinherited

Apply to particle with position R and momentum P.

Parameters

R	Position
P	Momentum
t	Time
E	Electric Field
B	Magnetic Field

Returns

true if particle is out-of-bounds (lost), false otherwise

Reimplemented from Component.

Definition at line 164 of file BendBase.cpp.

References BendBase::computeFieldHost(), BendBase::getField(), ElementBase::getFlagDeleteOnTransverseExit(), BendBase::isInside(), and ElementBase::isInsideTransverse().

Here is the call graph for this function:

applyToReferenceParticle()

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

overridevirtualinherited

Apply to reference particle with position R and momemtum P.

Parameters

R	Position
P	Momentum
t	Time
E	Electric Field
B	Magnetic Field

Returns

true if particle is out-of-bounds (lost), false otherwise

Reimplemented from Component.

Definition at line 179 of file BendBase.cpp.

References BendBase::computeFieldHost(), BendBase::getField(), BendBase::isInside(), and ElementBase::isInsideTransverse().

Here is the call graph for this function:

bends()

bool BendBase::bends ( ) const

inlineoverridevirtualinherited

Implements Component.

Definition at line 184 of file BendBase.h.

Bfield() [1/2]

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

inlineinherited

Return the field in a point.

Definition at line 234 of file Component.h.

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

Here is the call graph for this function:

Bfield() [2/2]

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

inlineinherited

Return the field in a point.

Definition at line 240 of file Component.h.

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

Here is the call graph for this function:

calcBendAngle()

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

protectedinherited

Definition at line 256 of file BendBase.cpp.

calcBetaGamma()

double BendBase::calcBetaGamma ( ) const

protectedinherited

Definition at line 270 of file BendBase.cpp.

References BendBase::calcGamma().

Referenced by BendBase::calcDesignRadius(), and BendBase::calcFieldAmplitude().

Here is the call graph for this function:

calcDesignRadius() [1/2]

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

protectedinherited

Definition at line 260 of file BendBase.cpp.

calcDesignRadius() [2/2]

double BendBase::calcDesignRadius ( double  fieldAmplitude ) const

protectedinherited

Definition at line 240 of file BendBase.cpp.

References Physics::c, BendBase::calcBetaGamma(), PartData::getM(), PartBunch< T, Dim >::getReference(), and Component::RefPartBunch_m.

Here is the call graph for this function:

calcFieldAmplitude()

double BendBase::calcFieldAmplitude ( double  radius ) const

protectedinherited

Definition at line 248 of file BendBase.cpp.

References Physics::c, BendBase::calcBetaGamma(), PartData::getM(), PartBunch< T, Dim >::getReference(), and Component::RefPartBunch_m.

Here is the call graph for this function:

calcGamma()

double BendBase::calcGamma ( ) const

protectedinherited

Definition at line 264 of file BendBase.cpp.

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

Referenced by BendBase::calcBetaGamma().

Here is the call graph for this function:

clone()

virtual ElementBase * ElementBase::clone ( ) const

pure virtualinherited

Return clone.

Implemented in VerticalFFAMagnet, DriftRep, MarkerRep, MonitorRep, MultipoleRep, ProbeRep, RFCavityRep, SolenoidRep, TravelingWaveRep, TBeamline< T >, MultipoleT, Ring, ScalingFFAMagnet, VariableRFCavity, ConstantEFieldCavityRep, LaserRep, RBendRep, SBendRep, TestMonitor, TestRFCavity, DummyBeamline, and TestTravelingWave.

Referenced by Ring::appendElement(), Sequence::copy(), ElementBase::copyStructure(), and RingSection::operator=().

computeFieldHost()

void BendBase::computeFieldHost ( const Vector_t< double, 3 > &  R, const BMultipoleField &  field, Vector_t< double, 3 > &  B  )

staticprivateinherited

Definition at line 275 of file BendBase.cpp.

References BMultipoleField::getNormalComponent(), BMultipoleField::getSkewComponent(), and BMultipoleField::order().

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

Here is the call graph for this function:

copyStructure()

ElementBase * ElementBase::copyStructure ( )

virtualinherited

Make a structural copy.

Reimplemented in TBeamline< T >.

Definition at line 194 of file ElementBase.cpp.

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

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

Here is the call graph for this function:

EBfield() [1/2]

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

inlineinherited

Return the field in a point.

Definition at line 244 of file Component.h.

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

Here is the call graph for this function:

EBfield() [2/2]

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

inlineinherited

Return the field in a point.

Definition at line 246 of file Component.h.

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

Here is the call graph for this function:

Efield() [1/2]

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

inlineinherited

Return the field in a point.

Definition at line 232 of file Component.h.

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

Here is the call graph for this function:

Efield() [2/2]

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

inlineinherited

Return the field in a point.

Definition at line 236 of file Component.h.

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

Here is the call graph for this function:

finalise()

void BendBase::finalise ( )

overridevirtualinherited

Implements Component.

Definition at line 90 of file BendBase.cpp.

References Component::online_m.

fixPosition()

void ElementBase::fixPosition ( )

inlineinherited

Definition at line 597 of file ElementBase.h.

References ElementBase::positionIsFixed.

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

getAperture()

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

inlineinherited

Definition at line 582 of file ElementBase.h.

References ElementBase::aperture_m.

Referenced by MeshGenerator::add(), Solenoid::getSupportEnvelope(), and MeshGenerator::getTransverseSupport().

getArcLength()

double ElementBase::getArcLength ( ) const

inlinevirtualinherited

Get arc length.

Reimplemented in MarkerRep, and TBeamline< T >.

Definition at line 479 of file ElementBase.h.

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

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

Here is the call graph for this function:

getAttribute()

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

virtualinherited

Get attribute value.

Definition at line 147 of file ElementBase.cpp.

References ElementBase::getConstChannel().

Here is the call graph for this function:

getB()

double BendBase::getB ( ) const

inlineinherited

Definition at line 225 of file BendBase.h.

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

Here is the call graph for this function:

getBendAngle()

double BendBase::getBendAngle ( ) const

inlineinherited

Definition at line 192 of file BendBase.h.

References BendBase::angle_m.

Referenced by OpalBeamline::compileCompatibilityPlacement(), RBend::getExitAngle(), and OpalBeamline::save3DLattice().

getBodyPort()

Port ElementBase::getBodyPort ( ) const

inlinevirtualinherited

Return the body port of the canonical local chart.

The body port \(p_{i,\mathrm{body}}\) is the identity port of the element's canonical local chart. Its rigid transform is therefore the identity element of \(SE(3)\) in the first redesign stage.

Definition at line 547 of file ElementBase.h.

Referenced by ElementBase::getPlacementGeometry(), and TEST_F().

getBoundaryGeometry()

BoundaryGeometry * ElementBase::getBoundaryGeometry ( ) const

inlinevirtualinherited

return the attached boundary geometrt object if there is any

Definition at line 513 of file ElementBase.h.

References ElementBase::bgeometry_m.

getBoundingBoxInLabCoords()

BoundingBox ElementBase::getBoundingBoxInLabCoords ( ) const

virtualinherited

Definition at line 264 of file ElementBase.cpp.

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

Here is the call graph for this function:

getChannel()

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

virtualinherited

Construct a read/write channel.

Reimplemented in LaserRep, RBendRep, SBendRep, DriftRep, MonitorRep, MultipoleRep, ProbeRep, RFCavityRep, SolenoidRep, TravelingWaveRep, and ConstantEFieldCavityRep.

Definition at line 182 of file ElementBase.cpp.

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

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

Here is the call graph for this function:

getChordLength()

double BendBase::getChordLength ( ) const

inherited

Return the geometric chord between entrance and exit frames.

For sector bends this is shorter than the arc length, while for rectangular bends it equals the straight body length.

Definition at line 211 of file BendBase.cpp.

References ElementBase::getEntranceFrame(), ElementBase::getExitFrame(), Euclid3D::getVector(), Vector3D::getX(), Vector3D::getY(), and Vector3D::getZ().

Referenced by OpalBeamline::compileCompatibilityPlacement().

Here is the call graph for this function:

getConstChannel()

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

virtualinherited

Construct a read-only channel.

Definition at line 186 of file ElementBase.cpp.

References ElementBase::getChannel().

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

Here is the call graph for this function:

getCSTrafoGlobal2Local()

CoordinateSystemTrafo ElementBase::getCSTrafoGlobal2Local ( ) const

inlineinherited

Definition at line 529 of file ElementBase.h.

References ElementBase::csTrafoGlobal2Local_m.

Referenced by Monitor::driftToCorrectPositionAndSave(), ElementBase::getPlacementPose(), OpalRBend::update(), and OpalSBend::update().

getDesign()

const ElementBase & Component::getDesign ( ) const

virtualinherited

Return design element.

Definition at line 33 of file Component.cpp.

getDesignEnergy()

double BendBase::getDesignEnergy ( ) const

inlineoverridevirtualinherited

Reimplemented from Component.

Definition at line 211 of file BendBase.h.

References BendBase::designEnergy_m.

getDesignPath()

std::vector< Vector_t< double, 3 > > BendBase::getDesignPath ( std::size_t  minSamples = 32 ) const

inherited

Sample the local curved reference path of the bend body.

The returned points lie in the canonical local chart and can be mapped to lab space via the placed body transform. The sampling is uniform in the body parameter \(s\) between the entrance and exit frames.

Definition at line 220 of file BendBase.cpp.

References ElementBase::getEntrance(), ElementBase::getExit(), and ElementBase::getTransform().

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

Here is the call graph for this function:

getEdgeToBegin()

CoordinateSystemTrafo BendBase::getEdgeToBegin ( ) const

overridevirtualinherited

Reimplemented from ElementBase.

Definition at line 203 of file BendBase.cpp.

References ElementBase::getEntranceFrame().

Here is the call graph for this function:

getEdgeToEnd()

CoordinateSystemTrafo BendBase::getEdgeToEnd ( ) const

overridevirtualinherited

Reimplemented from ElementBase.

Definition at line 207 of file BendBase.cpp.

References ElementBase::getExitFrame().

Here is the call graph for this function:

getElementDimensions()

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

inlinevirtualinherited

Return the nominal body extent of the element.

The first placement redesign stage distinguishes between the nominal body extent and the field-support extent. The body extent is the canonical longitudinal interval of the placed hardware, \([z_\mathrm{body}^{\mathrm{begin}}, z_\mathrm{body}^{\mathrm{end}}]\), and therefore drives ports, placement, and visualization. By default it coincides with the geometry length \([0, L]\) in the local chart.

Reimplemented in RFCavity, TravelingWave, and Solenoid.

Definition at line 178 of file ElementBase.h.

References ElementBase::getElementLength().

Referenced by MeshGenerator::add().

Here is the call graph for this function:

getElementLength()

double ElementBase::getElementLength ( ) const

inlinevirtualinherited

Get design length.

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

Definition at line 481 of file ElementBase.h.

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

Referenced by MeshGenerator::add(), ConstantEFieldCavity::apply(), Multipole::apply(), VariableRFCavity::apply(), BendBase::apply(), ConstantEFieldCavity::apply(), Multipole::apply(), VariableRFCavity::apply(), Component::apply(), Corrector::apply(), ConstantEFieldCavity::apply(), Multipole::apply(), VariableRFCavity::apply(), Component::applyToReferenceParticle(), ConstantEFieldCavity::applyToReferenceParticle(), Multipole::applyToReferenceParticle(), ElementBase::getEdgeToEnd(), Solenoid::getEdgeToEnd(), ElementBase::getElementDimensions(), Solenoid::getElementDimensions(), BeamlineGeometry::getElementLength(), RFCavity::getElementLength(), Corrector::getFieldExtend(), BendBase::getFieldExtend(), ConstantEFieldCavity::getFieldExtend(), Drift::getFieldExtend(), Laser::getFieldExtend(), Multipole::getFieldExtend(), MultipoleT::getFieldExtend(), VariableRFCavity::getFieldExtend(), BendBase::getLength(), Corrector::initialise(), BendBase::initialise(), ConstantEFieldCavity::initialise(), Drift::initialise(), Laser::initialise(), Multipole::initialise(), ElementBase::isInside(), BendBase::isInside(), Monitor::isInside(), Multipole::isInside(), ElementBase::isInsideTransverse(), and TEST_F().

Here is the call graph for this function:

getElementPosition()

double ElementBase::getElementPosition ( ) const

inlineinherited

Definition at line 618 of file ElementBase.h.

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

Here is the call graph for this function:

getEntrance()

double ElementBase::getEntrance ( ) const

inlinevirtualinherited

Get entrance position.

Reimplemented in TBeamline< T >.

Definition at line 487 of file ElementBase.h.

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

Referenced by BendBase::getDesignPath(), and BeamlineGeometry::getEntrance().

Here is the call graph for this function:

getEntranceAngle()

double BendBase::getEntranceAngle ( ) const

inlineinherited

Definition at line 196 of file BendBase.h.

References BendBase::entranceAngle_m.

Referenced by OpalBeamline::compileCompatibilityPlacement(), and RBend::getExitAngle().

getEntranceFrame()

Euclid3D ElementBase::getEntranceFrame ( ) const

inlinevirtualinherited

Get transform.

Reimplemented in TBeamline< T >.

Definition at line 499 of file ElementBase.h.

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

Referenced by BendBase::getChordLength(), BendBase::getEdgeToBegin(), and BeamlineGeometry::getEntranceFrame().

Here is the call graph for this function:

getEntrancePatch()

Euclid3D ElementBase::getEntrancePatch ( ) const

inlinevirtualinherited

Get patch.

Definition at line 503 of file ElementBase.h.

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

Here is the call graph for this function:

getEntryFaceCurvature()

double BendBase::getEntryFaceCurvature ( ) const

inlineinherited

Definition at line 239 of file BendBase.h.

References BendBase::entryFaceCurvature_m.

getEntryFaceRotation()

double BendBase::getEntryFaceRotation ( ) const

inlineinherited

Definition at line 231 of file BendBase.h.

References BendBase::entryFaceRotation_m.

getEntryPort()

Port ElementBase::getEntryPort ( ) const

inlinevirtualinherited

Return the entrance port of the canonical local chart.

In the placement-note language, this is the marked entrance port \(p_{i,\mathrm{entry}}\) of element \(i\). For straight elements in the bridge stage, the body-to-entry transform is taken from the legacy getEdgeToBegin() result.

Definition at line 545 of file ElementBase.h.

References ElementBase::getEdgeToBegin().

Referenced by ElementBase::getPlacementGeometry(), and TEST_F().

Here is the call graph for this function:

getExit()

double ElementBase::getExit ( ) const

inlinevirtualinherited

Get exit position.

Reimplemented in TBeamline< T >.

Definition at line 489 of file ElementBase.h.

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

Referenced by BendBase::getDesignPath(), and BeamlineGeometry::getExit().

Here is the call graph for this function:

getExitAngle()

double SBend::getExitAngle ( ) const

overridevirtual

Implements BendBase.

Definition at line 19 of file SBend.cpp.

References BendBase::getStoredExitAngle().

Here is the call graph for this function:

getExitFaceCurvature()

double BendBase::getExitFaceCurvature ( ) const

inlineinherited

Definition at line 243 of file BendBase.h.

References BendBase::exitFaceCurvature_m.

getExitFaceRotation()

double BendBase::getExitFaceRotation ( ) const

inlineinherited

Definition at line 235 of file BendBase.h.

References BendBase::exitFaceRotation_m.

getExitFrame()

Euclid3D ElementBase::getExitFrame ( ) const

inlinevirtualinherited

Get transform.

Reimplemented in TBeamline< T >.

Definition at line 501 of file ElementBase.h.

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

Referenced by BendBase::getChordLength(), BendBase::getEdgeToEnd(), and BeamlineGeometry::getExitFrame().

Here is the call graph for this function:

getExitPatch()

Euclid3D ElementBase::getExitPatch ( ) const

inlinevirtualinherited

Get patch.

Definition at line 505 of file ElementBase.h.

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

Here is the call graph for this function:

getExitPort()

Port ElementBase::getExitPort ( ) const

inlinevirtualinherited

Return the exit port of the canonical local chart.

In the placement-note language, this is the marked exit port \(p_{i,\mathrm{exit}}\). For straight elements in the bridge stage, the body-to-exit transform is taken from the legacy getEdgeToEnd() result.

Definition at line 549 of file ElementBase.h.

References ElementBase::getEdgeToEnd().

Referenced by ElementBase::getPlacementGeometry(), and TEST_F().

Here is the call graph for this function:

getField() [1/2]

virtual const BMultipoleField & BendBase::getField ( ) const

overridepure virtualinherited

Return field.

Implements Component.

Implemented in RBendRep, and SBendRep.

getField() [2/2]

virtual BMultipoleField & BendBase::getField ( )

overridepure virtualinherited

Return field.

Implements Component.

Implemented in RBendRep, and SBendRep.

Referenced by BendBase::apply(), BendBase::apply(), BendBase::apply(), BendBase::applyToReferenceParticle(), BendBase::getB(), and BendBase::setB().

getFieldAmplitude()

double BendBase::getFieldAmplitude ( ) const

inlineinherited

Definition at line 219 of file BendBase.h.

References BendBase::fieldAmplitude_m.

getFieldExtend()

void BendBase::getFieldExtend ( double &  zBegin, double &  zEnd  ) const

overridevirtualinherited

Return the field-support extent of the component.

This is the longitudinal interval \([z_\mathrm{field}^{\mathrm{begin}}, z_\mathrm{field}^{\mathrm{end}}]\) on which the external field model is evaluated in the element-local chart. In the first extent model this may differ from the nominal body extent returned by getElementDimensions(), for example when fringe fields extend beyond the hardware body or when a field map occupies only part of the body.

Implements Component.

Definition at line 194 of file BendBase.cpp.

References ElementBase::getElementLength().

Here is the call graph for this function:

getFieldMapFN()

std::string BendBase::getFieldMapFN ( ) const

inlineinherited

Definition at line 223 of file BendBase.h.

References BendBase::fileName_m.

getFlagDeleteOnTransverseExit()

bool ElementBase::getFlagDeleteOnTransverseExit ( ) const

inlineinherited

Definition at line 634 of file ElementBase.h.

References ElementBase::deleteOnTransverseExit_m.

Referenced by BendBase::apply(), ConstantEFieldCavity::apply(), Multipole::apply(), Corrector::apply(), BendBase::apply(), ConstantEFieldCavity::apply(), Multipole::apply(), RFCavity::apply(), Solenoid::apply(), and TravelingWave::apply().

getFullGap()

double BendBase::getFullGap ( ) const

inlineinherited

Definition at line 202 of file BendBase.h.

References BendBase::gap_m.

getGeometry() [1/2]

const PlanarArcGeometry & SBend::getGeometry ( ) const

overridepure virtual

Get geometry.

Implements ElementBase.

Implemented in SBendRep.

getGeometry() [2/2]

PlanarArcGeometry & SBend::getGeometry ( )

overridepure virtual

Get geometry.

Implements ElementBase.

Implemented in SBendRep.

getK1()

double BendBase::getK1 ( ) const

inlineinherited

Definition at line 259 of file BendBase.h.

References BendBase::k1_m.

getLength()

double BendBase::getLength ( ) const

inlineinherited

Definition at line 188 of file BendBase.h.

References ElementBase::getElementLength().

Here is the call graph for this function:

getMisalignment() [1/2]

CoordinateSystemTrafo ElementBase::getMisalignment ( ) const

inlineinherited

Definition at line 593 of file ElementBase.h.

References ElementBase::misalignment_m.

Referenced by ElementBase::getPlacementMisalignment().

getMisalignment() [2/2]

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

inherited

getName()

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

virtualinherited

Get element name.

Definition at line 132 of file ElementBase.cpp.

References ElementBase::elementID.

Referenced by Ring::appendElement(), Probe::doGoOffline(), PlaceRep::enter(), ElementBase::getElementPosition(), RFCavity::getMomentaKick(), ElementBase::getOutputFN(), CavityAutophaser::getPhaseAtMaxEnergy(), Selector::handleElement(), Ring::initialise(), RFCavity::initialise(), Solenoid::initialise(), PlaceRep::leave(), VariableRFCavity::operator=(), Sequence::print(), TEST_F(), Component::trackBunch(), Component::trackMap(), OpalRBend::update(), OpalSBend::update(), Sequence::updateList(), ParallelTracker::updateRFElement(), and Replacer::visitFlaggedElmPtr().

getNSlices()

std::size_t BendBase::getNSlices ( ) const

inlineinherited

Definition at line 255 of file BendBase.h.

References BendBase::nSlices_m.

getOrigin()

double ElementBase::getOrigin ( ) const

inlinevirtualinherited

Get origin position.

Reimplemented in TBeamline< T >.

Definition at line 485 of file ElementBase.h.

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

Referenced by BeamlineGeometry::getOrigin().

Here is the call graph for this function:

getOutputFN()

std::string ElementBase::getOutputFN ( ) const

inherited

Get output filename.

Definition at line 138 of file ElementBase.cpp.

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

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

Here is the call graph for this function:

getParticleMatterInteraction()

ParticleMatterInteractionHandler * ElementBase::getParticleMatterInteraction ( ) const

inlinevirtualinherited

Definition at line 517 of file ElementBase.h.

References ElementBase::parmatint_m.

getPlacedElement()

PlacedElement ElementBase::getPlacedElement ( ) const

inlineinherited

Return a placed-element view assembled from the current bridge objects.

Definition at line 571 of file ElementBase.h.

References ElementBase::getPlacementGeometry(), ElementBase::getPlacementMisalignment(), ElementBase::getPlacementPose(), and ElementBase::getPlacementSupport().

Referenced by MeshGenerator::add(), and TEST_F().

Here is the call graph for this function:

getPlacementGeometry()

ElementGeometry ElementBase::getPlacementGeometry ( ) const

inlineinherited

Return the bridge geometry ports assembled from legacy edge state.

The first redesign stage defines a minimal explicit port contract with three named body-relative ports: \(p_{i,\mathrm{entry}}\), \(p_{i,\mathrm{body}}\), \(p_{i,\mathrm{exit}}\). The default bridge preserves current OPALX behavior by deriving those ports from getEntryPort(), getBodyPort(), and getExitPort(), whose straight-element implementations are backed by the legacy getEdgeToBegin() and getEdgeToEnd() methods.

Definition at line 563 of file ElementBase.h.

References ElementBase::getBodyPort(), ElementBase::getEntryPort(), and ElementBase::getExitPort().

Referenced by ElementBase::getPlacedElement().

Here is the call graph for this function:

getPlacementMisalignment()

Misalignment ElementBase::getPlacementMisalignment ( ) const

inlineinherited

Return the local nominal-to-actual correction stored for the element.

Definition at line 559 of file ElementBase.h.

References ElementBase::getMisalignment().

Referenced by ElementBase::getPlacedElement().

Here is the call graph for this function:

getPlacementPose()

PlacementPose ElementBase::getPlacementPose ( ) const

inlineinherited

Return the nominal rigid placement transform of the element.

This is the bridge from the legacy stored CoordinateSystemTrafo to the new placement vocabulary. It preserves current nominal placement semantics and does not apply misalignment.

Definition at line 551 of file ElementBase.h.

References ElementBase::getCSTrafoGlobal2Local().

Referenced by ElementBase::getPlacedElement().

Here is the call graph for this function:

getPlacementSupport()

SupportPlacement ElementBase::getPlacementSupport ( ) const

inlineinherited

Return the support-frame bridge object. The default is the body frame.

Definition at line 567 of file ElementBase.h.

Referenced by ElementBase::getPlacedElement().

getPotential()

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

inlinevirtualinherited

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

Parameters

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

Returns

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

Definition at line 155 of file Component.h.

getRequiredNumberOfTimeSteps()

int BendBase::getRequiredNumberOfTimeSteps ( ) const

inlineoverridevirtualinherited

Reimplemented from ElementBase.

Definition at line 261 of file BendBase.h.

getRotationAboutZ()

double ElementBase::getRotationAboutZ ( ) const

inlineinherited

Definition at line 609 of file ElementBase.h.

References ElementBase::rotationZAxis_m.

Referenced by OpalBeamline::compileCompatibilityPlacement().

getSlices()

double BendBase::getSlices ( ) const

inlineinherited

Definition at line 247 of file BendBase.h.

References BendBase::slices_m.

getStepsize()

double BendBase::getStepsize ( ) const

inlineinherited

Definition at line 251 of file BendBase.h.

References BendBase::stepSize_m.

getStoredExitAngle()

double BendBase::getStoredExitAngle ( ) const

inlineprotectedinherited

Definition at line 263 of file BendBase.h.

References BendBase::exitAngle_m.

Referenced by getExitAngle().

getTotalTransform()

Euclid3D ElementBase::getTotalTransform ( ) const

inlinevirtualinherited

Get transform.

Reimplemented in TBeamline< T >.

Definition at line 495 of file ElementBase.h.

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

Referenced by BeamlineGeometry::getTotalTransform().

Here is the call graph for this function:

getTransform() [1/2]

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

inlinevirtualinherited

Get transform.

Reimplemented in TBeamline< T >.

Definition at line 491 of file ElementBase.h.

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

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

Here is the call graph for this function:

getTransform() [2/2]

Euclid3D ElementBase::getTransform ( double  s ) const

inlinevirtualinherited

Get transform.

Reimplemented in TBeamline< T >.

Definition at line 497 of file ElementBase.h.

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

Here is the call graph for this function:

getType()

ElementType SBend::getType ( ) const

overridevirtual

Get element type std::string.

Reimplemented from Component.

Definition at line 15 of file SBend.cpp.

References SBEND.

getTypeString() [1/2]

std::string ElementBase::getTypeString ( ) const

inlineinherited

Definition at line 611 of file ElementBase.h.

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

Referenced by ElementBase::getTypeString().

Here is the call graph for this function:

getTypeString() [2/2]

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

staticinherited

Definition at line 192 of file ElementBase.cpp.

References ElementBase::elementTypeToString_s.

getWake()

WakeFunction * ElementBase::getWake ( ) const

inlinevirtualinherited

return the attached wake object if there is any

Definition at line 509 of file ElementBase.h.

References ElementBase::wake_m.

goOffline()

void Component::goOffline ( )

virtualinherited

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

Definition at line 45 of file Component.cpp.

References Component::online_m.

goOnline()

void Component::goOnline ( const double &  kineticEnergy )

virtualinherited

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

Definition at line 43 of file Component.cpp.

References Component::online_m.

Referenced by PluginElement::initialise().

hasAttribute()

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

virtualinherited

Test for existence of an attribute.

Definition at line 159 of file ElementBase.cpp.

References ElementBase::getConstChannel().

Here is the call graph for this function:

hasBoundaryGeometry()

bool ElementBase::hasBoundaryGeometry ( ) const

inlinevirtualinherited

Definition at line 515 of file ElementBase.h.

References ElementBase::bgeometry_m.

hasParticleMatterInteraction()

bool ElementBase::hasParticleMatterInteraction ( ) const

inlinevirtualinherited

Definition at line 521 of file ElementBase.h.

References ElementBase::parmatint_m.

hasWake()

bool ElementBase::hasWake ( ) const

inlinevirtualinherited

Definition at line 511 of file ElementBase.h.

References ElementBase::wake_m.

initialise()

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

overridevirtualinherited

Implements Component.

Definition at line 82 of file BendBase.cpp.

References BendBase::endField_m, ElementBase::getElementLength(), Component::online_m, Component::RefPartBunch_m, and BendBase::startField_m.

Here is the call graph for this function:

isElementPositionSet()

bool ElementBase::isElementPositionSet ( ) const

inlineinherited

Definition at line 626 of file ElementBase.h.

References ElementBase::elemedgeSet_m.

isInside()

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

overridevirtualinherited

Reimplemented from ElementBase.

Definition at line 199 of file BendBase.cpp.

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

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

Here is the call graph for this function:

isInsideTransverse()

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

protectedinherited

Definition at line 233 of file ElementBase.cpp.

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

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

Here is the call graph for this function:

isPositioned()

bool ElementBase::isPositioned ( ) const

inlineinherited

Definition at line 599 of file ElementBase.h.

References ElementBase::positionIsFixed.

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

isSharable()

bool ElementBase::isSharable ( ) const

inlineinherited

Test if the element can be shared.

Definition at line 507 of file ElementBase.h.

References ElementBase::shareFlag.

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

makeSharable()

void ElementBase::makeSharable ( )

virtualinherited

Set sharable flag.

Reimplemented in TBeamline< T >.

Definition at line 202 of file ElementBase.cpp.

References ElementBase::shareFlag.

Referenced by OpalMarker::OpalMarker().

Online()

bool Component::Online ( )

virtualinherited

Definition at line 47 of file Component.cpp.

References Component::online_m.

releasePosition()

void ElementBase::releasePosition ( )

inlineinherited

Definition at line 595 of file ElementBase.h.

References ElementBase::positionIsFixed.

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

removeAttribute()

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

virtualinherited

Remove an existing attribute.

Definition at line 170 of file ElementBase.cpp.

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

Here is the call graph for this function:

setActionRange()

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

inlineinherited

Definition at line 601 of file ElementBase.h.

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

setAperture()

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

inlineinherited

Definition at line 577 of file ElementBase.h.

References ElementBase::aperture_m.

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

setAttribute()

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

virtualinherited

Set value of an attribute.

Definition at line 172 of file ElementBase.cpp.

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

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

Here is the call graph for this function:

setB()

void BendBase::setB ( double  B )

inlineinherited

Definition at line 227 of file BendBase.h.

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

Here is the call graph for this function:

setBendAngle()

void BendBase::setBendAngle ( double  angle )

inlinevirtualinherited

Definition at line 190 of file BendBase.h.

References BendBase::angle_m.

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

setBoundaryGeometry()

void ElementBase::setBoundaryGeometry ( BoundaryGeometry *  geo )

virtualinherited

attach a boundary geometry field to the element

Definition at line 216 of file ElementBase.cpp.

References ElementBase::bgeometry_m.

setCSTrafoGlobal2Local()

void ElementBase::setCSTrafoGlobal2Local ( const CoordinateSystemTrafo &  ori )

inlineinherited

Definition at line 523 of file ElementBase.h.

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

Referenced by ElementBase::setPlacementPose(), TEST_F(), OpalElement::update(), OpalRBend::update(), and OpalSBend::update().

setCurrentSCoordinate()

void ElementBase::setCurrentSCoordinate ( double  s )

inherited

Definition at line 224 of file ElementBase.cpp.

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

setDesignEnergy()

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

inlineoverridevirtualinherited

Reimplemented from Component.

Definition at line 204 of file BendBase.h.

References BendBase::designEnergy_m, and BendBase::designEnergyChangeable_m.

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

setElementLength()

void ElementBase::setElementLength ( double  length )

inlinevirtualinherited

Set design length.

Reimplemented in MultipoleT, and ConstantEFieldCavityRep.

Definition at line 483 of file ElementBase.h.

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

Referenced by MultipoleT::setElementLength(), SequenceMember::setLength(), BendBase::setLength(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), OpalCavity::update(), OpalMonitor::update(), OpalMultipole::update(), OpalProbe::update(), OpalQuadrupole::update(), OpalSolenoid::update(), and OpalTravelingWave::update().

Here is the call graph for this function:

setElementPosition()

void ElementBase::setElementPosition ( double  elemedge )

inlineinherited

Access to ELEMEDGE attribute.

Definition at line 613 of file ElementBase.h.

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

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

setEntranceAngle()

void BendBase::setEntranceAngle ( double  entranceAngle )

inlinevirtualinherited

Definition at line 194 of file BendBase.h.

References BendBase::entranceAngle_m.

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

setEntryFaceCurvature()

void BendBase::setEntryFaceCurvature ( double  curvature )

inlineinherited

Definition at line 237 of file BendBase.h.

References BendBase::entryFaceCurvature_m.

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

setEntryFaceRotation()

void BendBase::setEntryFaceRotation ( double  rotation )

inlineinherited

Definition at line 229 of file BendBase.h.

References BendBase::entryFaceRotation_m.

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

setExitAngle()

void SBend::setExitAngle ( double  exitAngle )

overridevirtual

Reimplemented from BendBase.

Definition at line 17 of file SBend.cpp.

References BendBase::setExitAngle().

Referenced by OpalSBend::update().

Here is the call graph for this function:

setExitFaceCurvature()

void BendBase::setExitFaceCurvature ( double  curvature )

inlineinherited

Definition at line 241 of file BendBase.h.

References BendBase::exitFaceCurvature_m.

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

setExitFaceRotation()

void BendBase::setExitFaceRotation ( double  rotation )

inlineinherited

Definition at line 233 of file BendBase.h.

References BendBase::exitFaceRotation_m.

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

setExitFaceSlope()

void Component::setExitFaceSlope ( const double &  m )

inlineinherited

Definition at line 250 of file Component.h.

References Component::exit_face_slope_m.

setFieldAmplitude()

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

inlineinherited

Store the dipole design amplitudes used by the analytic field.

The normal and skew dipole strengths are the leading coefficients of the local multipole expansion

\[ B_y + i B_x = \sum_{n=0}^{N} (B_n + i A_n) (x + i y)^n . \]

Definition at line 213 of file BendBase.h.

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

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

setFieldMapFN()

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

inlineinherited

Definition at line 221 of file BendBase.h.

References BendBase::fileName_m.

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

setFlagDeleteOnTransverseExit()

void ElementBase::setFlagDeleteOnTransverseExit ( bool  flag = true )

inlineinherited

Definition at line 630 of file ElementBase.h.

References ElementBase::deleteOnTransverseExit_m.

Referenced by OpalElement::update().

setFullGap()

void BendBase::setFullGap ( double  gap )

inlineinherited

Definition at line 200 of file BendBase.h.

References BendBase::gap_m.

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

setK1()

void BendBase::setK1 ( double  k1 )

inlineinherited

Definition at line 257 of file BendBase.h.

References BendBase::k1_m.

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

setLength()

void BendBase::setLength ( double  length )

inlineinherited

Set the nominal body length.

The bend body length is the placed hardware length and therefore drives ports and visualization. The geometry itself remains the source of truth for the placed body extent.

Definition at line 186 of file BendBase.h.

References ElementBase::setElementLength().

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

Here is the call graph for this function:

setMisalignment()

void ElementBase::setMisalignment ( const CoordinateSystemTrafo &  cst )

inlineinherited

Definition at line 591 of file ElementBase.h.

References ElementBase::misalignment_m.

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

setName()

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

virtualinherited

Set element name.

Definition at line 134 of file ElementBase.cpp.

References ElementBase::elementID.

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

setNSlices()

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

inlineinherited

Definition at line 253 of file BendBase.h.

References BendBase::nSlices_m.

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

setOutputFN()

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

inherited

Set output filename.

Definition at line 136 of file ElementBase.cpp.

References ElementBase::outputfn_m.

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

setParticleMatterInteraction()

void ElementBase::setParticleMatterInteraction ( ParticleMatterInteractionHandler *  spys )

virtualinherited

Definition at line 220 of file ElementBase.cpp.

References ElementBase::parmatint_m.

setPlacementPose()

void ElementBase::setPlacementPose ( const PlacementPose &  pose )

inlineinherited

Set the nominal rigid placement transform of the element.

This bridge setter preserves the existing storage model by delegating to setCSTrafoGlobal2Local().

Definition at line 555 of file ElementBase.h.

References PlacementPose::getParentToNominal(), and ElementBase::setCSTrafoGlobal2Local().

Here is the call graph for this function:

setRotationAboutZ()

void ElementBase::setRotationAboutZ ( double  rotation )

inlineinherited

Set rotation about z axis in bend frame.

Definition at line 607 of file ElementBase.h.

References ElementBase::rotationZAxis_m.

Referenced by OpalElement::update().

setSlices()

void BendBase::setSlices ( double  slices )

inlineinherited

Definition at line 245 of file BendBase.h.

References BendBase::slices_m.

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

setStepsize()

void BendBase::setStepsize ( double  stepSize )

inlineinherited

Definition at line 249 of file BendBase.h.

References BendBase::stepSize_m.

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

setWake()

void ElementBase::setWake ( WakeFunction *  wf )

virtualinherited

attach a wake field to the element

Definition at line 212 of file ElementBase.cpp.

References ElementBase::wake_m.

trackBunch()

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

virtualinherited

Track a borrowed particle bunch through a non-standard component.

The default implementation throws a LogicalError.

Parameters

bunch

Particle bunch to track. The component does not take ownership.

Definition at line 35 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 39 of file Component.cpp.

References ElementBase::getName().

Here is the call graph for this function:

update()

bool ElementBase::update ( const AttributeSet &  set )

inherited

Update element.

Definition at line 204 of file ElementBase.cpp.

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

Referenced by Monitor::driftToCorrectPositionAndSave().

Here is the call graph for this function:

Member Data Documentation

actionRange_m

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

privateinherited

Definition at line 469 of file ElementBase.h.

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

angle_m

double BendBase::angle_m

privateinherited

Definition at line 164 of file BendBase.h.

Referenced by BendBase::getBendAngle(), and BendBase::setBendAngle().

aperture_m

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

protectedinherited

Definition at line 440 of file ElementBase.h.

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

bgeometry_m

BoundaryGeometry* ElementBase::bgeometry_m

privateinherited

Definition at line 460 of file ElementBase.h.

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

csTrafoGlobal2Local_m

CoordinateSystemTrafo ElementBase::csTrafoGlobal2Local_m

protectedinherited

Definition at line 437 of file ElementBase.h.

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

defaultAperture_m

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

staticprotectedinherited

Definition at line 221 of file Component.h.

Referenced by Component::Component().

deleteOnTransverseExit_m

bool ElementBase::deleteOnTransverseExit_m = true

privateinherited

Definition at line 473 of file ElementBase.h.

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

designEnergy_m

double BendBase::designEnergy_m

privateinherited

Definition at line 168 of file BendBase.h.

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

designEnergyChangeable_m

bool BendBase::designEnergyChangeable_m

privateinherited

Definition at line 169 of file BendBase.h.

Referenced by BendBase::setDesignEnergy().

elemedgeSet_m

bool ElementBase::elemedgeSet_m

privateinherited

Definition at line 467 of file ElementBase.h.

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

elementEdge_m

double ElementBase::elementEdge_m

protectedinherited

Definition at line 442 of file ElementBase.h.

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

elementID

std::string ElementBase::elementID

privateinherited

Definition at line 451 of file ElementBase.h.

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

elementPosition_m

double ElementBase::elementPosition_m

privateinherited

ELEMEDGE attribute.

Definition at line 466 of file ElementBase.h.

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

elementTypeToString_s

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

staticprivateinherited

Initial value:

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

Definition at line 73 of file ElementBase.h.

Referenced by ElementBase::getTypeString().

endField_m

double BendBase::endField_m

privateinherited

Definition at line 163 of file BendBase.h.

Referenced by BendBase::initialise().

entranceAngle_m

double BendBase::entranceAngle_m

privateinherited

Definition at line 165 of file BendBase.h.

Referenced by BendBase::getEntranceAngle(), and BendBase::setEntranceAngle().

entryFaceCurvature_m

double BendBase::entryFaceCurvature_m

privateinherited

Definition at line 176 of file BendBase.h.

Referenced by BendBase::getEntryFaceCurvature(), and BendBase::setEntryFaceCurvature().

entryFaceRotation_m

double BendBase::entryFaceRotation_m

privateinherited

Definition at line 174 of file BendBase.h.

Referenced by BendBase::getEntryFaceRotation(), and BendBase::setEntryFaceRotation().

exit_face_slope_m

double Component::exit_face_slope_m

protectedinherited

Definition at line 222 of file Component.h.

Referenced by Component::setExitFaceSlope().

exitAngle_m

double BendBase::exitAngle_m

privateinherited

Definition at line 166 of file BendBase.h.

Referenced by BendBase::getStoredExitAngle(), and BendBase::setExitAngle().

exitFaceCurvature_m

double BendBase::exitFaceCurvature_m

privateinherited

Definition at line 177 of file BendBase.h.

Referenced by BendBase::getExitFaceCurvature(), and BendBase::setExitFaceCurvature().

exitFaceRotation_m

double BendBase::exitFaceRotation_m

privateinherited

Definition at line 175 of file BendBase.h.

Referenced by BendBase::getExitFaceRotation(), and BendBase::setExitFaceRotation().

fieldAmplitude_m

double BendBase::fieldAmplitude_m

privateinherited

Definition at line 172 of file BendBase.h.

Referenced by BendBase::getFieldAmplitude(), and BendBase::setFieldAmplitude().

fieldAmplitudeX_m

double BendBase::fieldAmplitudeX_m

privateinherited

Definition at line 170 of file BendBase.h.

Referenced by BendBase::setFieldAmplitude().

fieldAmplitudeY_m

double BendBase::fieldAmplitudeY_m

privateinherited

Definition at line 171 of file BendBase.h.

Referenced by BendBase::setFieldAmplitude().

fileName_m

std::string BendBase::fileName_m

privateinherited

Definition at line 173 of file BendBase.h.

Referenced by BendBase::getFieldMapFN(), and BendBase::setFieldMapFN().

gap_m

double BendBase::gap_m

privateinherited

Definition at line 167 of file BendBase.h.

Referenced by BendBase::getFullGap(), and BendBase::setFullGap().

k1_m

double BendBase::k1_m

privateinherited

Definition at line 181 of file BendBase.h.

Referenced by BendBase::getK1(), and BendBase::setK1().

misalignment_m

CoordinateSystemTrafo ElementBase::misalignment_m

protectedinherited

Definition at line 438 of file ElementBase.h.

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

nSlices_m

std::size_t BendBase::nSlices_m

privateinherited

Definition at line 180 of file BendBase.h.

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

online_m

bool Component::online_m

protectedinherited

Definition at line 226 of file Component.h.

Referenced by Monitor::apply(), Monitor::apply(), Monitor::applyToReferenceParticle(), Probe::doGoOffline(), PluginElement::finalise(), BendBase::finalise(), Multipole::finalise(), Ring::finalise(), Component::goOffline(), PluginElement::goOffline(), RFCavity::goOffline(), Solenoid::goOffline(), Component::goOnline(), Corrector::goOnline(), Monitor::goOnline(), RFCavity::goOnline(), Solenoid::goOnline(), TravelingWave::goOnline(), Ring::initialise(), BendBase::initialise(), Multipole::initialise(), Component::Online(), and PluginElement::~PluginElement().

outputfn_m

std::string ElementBase::outputfn_m

privateinherited

The name of the outputfile

Definition at line 471 of file ElementBase.h.

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

parmatint_m

ParticleMatterInteractionHandler* ElementBase::parmatint_m

privateinherited

Definition at line 462 of file ElementBase.h.

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

positionIsFixed

bool ElementBase::positionIsFixed

privateinherited

Definition at line 464 of file ElementBase.h.

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

RefPartBunch_m

PartBunch_t* Component::RefPartBunch_m

protectedinherited

Definition at line 225 of file Component.h.

Referenced by Corrector::apply(), VerticalFFAMagnet::apply(), BendBase::apply(), ConstantEFieldCavity::apply(), Monitor::apply(), Multipole::apply(), MultipoleT::apply(), RFCavity::apply(), ScalingFFAMagnet::apply(), Solenoid::apply(), TravelingWave::apply(), VariableRFCavity::apply(), Ring::apply(), Monitor::apply(), MultipoleT::apply(), RFCavity::apply(), TravelingWave::apply(), VariableRFCavity::apply(), Corrector::apply(), Monitor::applyToReferenceParticle(), BendBase::calcDesignRadius(), BendBase::calcFieldAmplitude(), BendBase::calcGamma(), Monitor::driftToCorrectPositionAndSave(), VerticalFFAMagnet::finalise(), MultipoleT::finalise(), ScalingFFAMagnet::finalise(), VariableRFCavity::finalise(), Corrector::goOnline(), PluginElement::initialise(), Corrector::initialise(), VerticalFFAMagnet::initialise(), BendBase::initialise(), ConstantEFieldCavity::initialise(), Drift::initialise(), Laser::initialise(), Marker::initialise(), Monitor::initialise(), Multipole::initialise(), MultipoleT::initialise(), RFCavity::initialise(), ScalingFFAMagnet::initialise(), Solenoid::initialise(), TravelingWave::initialise(), VariableRFCavity::initialise(), RFCavity::initialise(), VariableRFCavity::initNull(), Multipole::isFocusing(), MultipoleT::MultipoleT(), ScalingFFAMagnet::ScalingFFAMagnet(), Corrector::setDesignEnergy(), Ring::setRefPartBunch(), RFCavity::trackOnAxisParticle(), and VerticalFFAMagnet::VerticalFFAMagnet().

rotationZAxis_m

double ElementBase::rotationZAxis_m

protectedinherited

Definition at line 444 of file ElementBase.h.

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

shareFlag

bool ElementBase::shareFlag

mutableprotectedinherited

Definition at line 435 of file ElementBase.h.

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

slices_m

double BendBase::slices_m

privateinherited

Definition at line 178 of file BendBase.h.

Referenced by BendBase::getSlices(), and BendBase::setSlices().

startField_m

double BendBase::startField_m

privateinherited

Definition at line 162 of file BendBase.h.

Referenced by BendBase::initialise().

stepSize_m

double BendBase::stepSize_m

privateinherited

Definition at line 179 of file BendBase.h.

Referenced by BendBase::getStepsize(), and BendBase::setStepsize().

userAttribs

AttributeSet ElementBase::userAttribs

privateinherited

Definition at line 456 of file ElementBase.h.

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

wake_m

WakeFunction* ElementBase::wake_m

privateinherited

Definition at line 458 of file ElementBase.h.

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

---

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

• SBend.h
• SBend.cpp