#include <SBendRep.h>

Inheritance diagram for SBendRep:

[legend]

Collaboration diagram for SBendRep:

[legend]

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

	SBendRep ()

	SBendRep (const SBendRep &)

virtual	~SBendRep ()

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	SBend ()

	SBend (const SBend &)

virtual	~SBend ()

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

virtual double	getB () const =0
	Get dipole field of SBend. More...

virtual PlanarArcGeometry &	getGeometry () override=0
	Get SBend geometry. More...

virtual const PlanarArcGeometry &	getGeometry () const override=0
	Get SBend geometry. More...

virtual BMultipoleField &	getField () override=0
	Get multipole expansion of field. More...

virtual const BMultipoleField &	getField () const override=0
	Get multipole expansion of field. More...

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

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

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

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

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

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

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

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

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

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

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

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

	Bend2D ()

	Bend2D (const Bend2D &)

virtual	~Bend2D ()

virtual void	accept (BeamlineVisitor &) const override=0
	Apply visitor to Bend2D. More...

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

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

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

virtual void	goOnline (const double &kineticEnergy) override

virtual void	finalise () override

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

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

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

double	getBendRadius () const

double	getEffectiveCenter () const

double	getEffectiveLength () const

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

virtual void	setEntranceAngle (double entranceAngle) override

void	setExitAngle (double exitAngle)

virtual double	getExitAngle () const override

std::vector< Vector_t >	getOutline () const

MeshData	getSurfaceMesh () const

virtual CoordinateSystemTrafo	getEdgeToEnd () const override

CoordinateSystemTrafo	getBeginToEnd_local () const

virtual bool	isInside (const Vector_t &r) const override

void	setNSlices (const std::size_t &nSlices)

std::size_t	getNSlices () const

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

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

BoundingBox	getBoundingBoxInLabCoords () const override

Public Member Functions inherited from BendBase
	BendBase ()

	BendBase (const BendBase &)

	BendBase (const std::string &)

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

double	getChordLength () const

virtual void	setBendAngle (double angle)

double	getBendAngle () const

virtual void	setEntranceAngle (double entranceAngle)

double	getEntranceAngle () const

virtual double	getExitAngle () const =0

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

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

	Component ()

	Component (const Component &right)

virtual	~Component ()

virtual EMField &	getField ()=0
	Return field. More...

virtual const EMField &	getField () const =0
	Return field. More...

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

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

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

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

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

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

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

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

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

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

virtual double	getDesignEnergy () const

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

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

virtual void	finalise ()=0

virtual bool	bends () const =0

virtual void	goOnline (const double &kineticEnergy)

virtual void	goOffline ()

virtual bool	Online ()

virtual void	getDimensions (double &zBegin, double &zEnd) const =0

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

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

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

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

void	setExitFaceSlope (const double &)

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

	ElementBase ()

	ElementBase (const ElementBase &)

virtual	~ElementBase ()

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

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

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

std::string	getTypeString () const

virtual BGeometryBase &	getGeometry ()=0
	Get geometry. More...

virtual const BGeometryBase &	getGeometry () const =0
	Get geometry. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual void	accept (BeamlineVisitor &visitor) const =0
	Apply visitor. More...

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

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

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

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

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

virtual void	setBoundaryGeometry (BoundaryGeometry *geo)

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

virtual bool	hasBoundaryGeometry () const

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

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

virtual bool	hasWake () const

virtual void	setParticleMatterInteraction (ParticleMatterInteractionHandler *spys)

virtual ParticleMatterInteractionHandler *	getParticleMatterInteraction () const

virtual bool	hasParticleMatterInteraction () const

void	setCSTrafoGlobal2Local (const CoordinateSystemTrafo &ori)

CoordinateSystemTrafo	getCSTrafoGlobal2Local () const

void	releasePosition ()

void	fixPosition ()

bool	isPositioned () const

virtual CoordinateSystemTrafo	getEdgeToBegin () const

virtual CoordinateSystemTrafo	getEdgeToEnd () const

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

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

virtual bool	isInside (const Vector_t &r) const

void	setMisalignment (const CoordinateSystemTrafo &cst)

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

CoordinateSystemTrafo	getMisalignment () const

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

void	setCurrentSCoordinate (double s)

void	setRotationAboutZ (double rotation)
	Set rotation about z axis in bend frame. More...

double	getRotationAboutZ () const

virtual BoundingBox	getBoundingBoxInLabCoords () const

virtual int	getRequiredNumberOfTimeSteps () const

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

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

void	setFlagDeleteOnTransverseExit (bool=true)

bool	getFlagDeleteOnTransverseExit () const

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

double	getElementPosition () const

bool	isElementPositionSet () const

Public Member Functions inherited from RCObject
int	addReference () const
	Increment reference count. More...

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

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

Private Member Functions
void	operator= (const SBendRep &)

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

BMultipoleField	field
	The multipole expansion. More...

double	rEntry

double	rExit

double	hEntry

double	hExit

double	slices

double	stepsize

Additional Inherited Members
Static Public Member Functions inherited from ElementBase
static std::string	getTypeString (ElementType type)

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

double	getStartField () const

Protected Member Functions inherited from BendBase
double	calcDesignRadius (double fieldAmplitude) const
	Calculate design radius from design energy and field amplitude. More...

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

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

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

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

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

Protected Member Functions inherited from ElementBase
bool	isInsideTransverse (const Vector_t &r) const

Protected Member Functions inherited from RCObject
	RCObject ()
	Default constructor. More...

	RCObject (const RCObject &)
	Copy constructor. More...

virtual	~RCObject ()=0

RCObject &	operator= (const RCObject &right)

Protected Attributes inherited from BendBase
double	chordLength_m

double	angle_m
	Bend angle. More...

double	entranceAngle_m

Fieldmap *	fieldmap_m
	Magnet field map. More...

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

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

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

bool	designEnergyChangeable_m

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

double	fieldAmplitudeX_m

double	fieldAmplitudeY_m

double	fieldAmplitude_m
	Field amplitude. More...

std::string	fileName_m

Protected Attributes inherited from Component
double	exit_face_slope_m

PartBunchBase< double, 3 > *	RefPartBunch_m

bool	online_m

Protected Attributes inherited from ElementBase
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 inherited from Component
static const std::vector< double >	defaultAperture_m

Detailed Description

Definition at line 28 of file SBendRep.h.

Constructor & Destructor Documentation

◆ SBendRep() [1/3]

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

explicit

Constructor with given name.

Definition at line 87 of file SBendRep.cpp.

References hEntry, hExit, rEntry, and rExit.

◆ SBendRep() [2/3]

SBendRep::SBendRep ( )

Definition at line 68 of file SBendRep.cpp.

References hEntry, hExit, rEntry, and rExit.

Referenced by clone().

◆ SBendRep() [3/3]

SBendRep::SBendRep ( const SBendRep & rhs )

Definition at line 76 of file SBendRep.cpp.

References hEntry, hExit, rEntry, and rExit.

◆ ~SBendRep()

SBendRep::~SBendRep ( )

virtual

Definition at line 95 of file SBendRep.cpp.

Member Function Documentation

◆ clone()

ElementBase * SBendRep::clone ( ) const

virtual

Return clone.

Implements ElementBase.

Definition at line 99 of file SBendRep.cpp.

References SBendRep().

Here is the call graph for this function:

◆ getB()

double SBendRep::getB ( ) const

virtual

Get field.

Implements SBend.

Definition at line 155 of file SBendRep.cpp.

References field, and BMultipoleField::getNormalComponent().

Here is the call graph for this function:

◆ getChannel()

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

virtual

Construct a read/write channel.

Reimplemented from ElementBase.

Definition at line 104 of file SBendRep.cpp.

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

Here is the call graph for this function:

◆ getEntryFaceCurvature()

double SBendRep::getEntryFaceCurvature ( ) const

virtual

Get entry pole face curvature.

Implements SBend.

Definition at line 181 of file SBendRep.cpp.

References hEntry.

◆ getEntryFaceRotation()

double SBendRep::getEntryFaceRotation ( ) const

virtual

Get pole entry face rotation.

Implements SBend.

Definition at line 164 of file SBendRep.cpp.

References rEntry.

◆ getExitFaceCurvature()

double SBendRep::getExitFaceCurvature ( ) const

virtual

Get exit pole face curvature.

Implements SBend.

Definition at line 185 of file SBendRep.cpp.

References hExit.

◆ getExitFaceRotation()

double SBendRep::getExitFaceRotation ( ) const

virtual

Get exit pole face rotation.

Implements SBend.

Definition at line 169 of file SBendRep.cpp.

References rExit.

◆ getField() [1/2]

BMultipoleField & SBendRep::getField ( )

virtual

Get field.

Implements SBend.

Definition at line 137 of file SBendRep.cpp.

References field.

◆ getField() [2/2]

const BMultipoleField & SBendRep::getField ( ) const

virtual

Get field.

Implements SBend.

Definition at line 141 of file SBendRep.cpp.

References field.

◆ getGeometry() [1/2]

PlanarArcGeometry & SBendRep::getGeometry ( )

virtual

Get geometry.

Implements SBend.

Definition at line 146 of file SBendRep.cpp.

References geometry.

Referenced by OpalSBend::update().

◆ getGeometry() [2/2]

const PlanarArcGeometry & SBendRep::getGeometry ( ) const

virtual

Get geometry.

Implements SBend.

Definition at line 150 of file SBendRep.cpp.

References geometry.

◆ getSlices()

double SBendRep::getSlices ( ) const

virtual

Get number of slices.

Implements SBend.

Definition at line 198 of file SBendRep.cpp.

References slices.

◆ getStepsize()

double SBendRep::getStepsize ( ) const

virtual

Get stepsize.

Implements SBend.

Definition at line 202 of file SBendRep.cpp.

References stepsize.

◆ operator=()

void SBendRep::operator= ( const SBendRep & )

private

◆ setB()

void SBendRep::setB ( double By )

virtual

Set vertical component.

Definition at line 159 of file SBendRep.cpp.

References field, and BMultipoleField::setNormalComponent().

Here is the call graph for this function:

◆ setEntryFaceCurvature()

void SBendRep::setEntryFaceCurvature ( double h1 )

virtual

Set entry pole face curvature.

Definition at line 189 of file SBendRep.cpp.

References hEntry.

Referenced by OpalSBend::update().

◆ setEntryFaceRotation()

void SBendRep::setEntryFaceRotation ( double e1 )

virtual

Set pole entry face rotation.

Definition at line 173 of file SBendRep.cpp.

References rEntry.

Referenced by OpalSBend::update().

◆ setExitFaceCurvature()

void SBendRep::setExitFaceCurvature ( double h2 )

virtual

Set exit pole face curvature.

Definition at line 193 of file SBendRep.cpp.

References hExit.

Referenced by OpalSBend::update().

◆ setExitFaceRotation()

void SBendRep::setExitFaceRotation ( double e2 )

virtual

Set exit pole face rotation.

Definition at line 177 of file SBendRep.cpp.

References rExit.

Referenced by OpalSBend::update().

◆ setField()

void SBendRep::setField ( const BMultipoleField & field )

virtual

Set field.

Definition at line 215 of file SBendRep.cpp.

References field.

Referenced by OpalSBend::update().

◆ setSlices()

void SBendRep::setSlices ( double sl )

virtual

Set number of slices.

Definition at line 206 of file SBendRep.cpp.

References slices.

Referenced by OpalSBend::update().

◆ setStepsize()

void SBendRep::setStepsize ( double ds )

virtual

Set stepsize.

Definition at line 210 of file SBendRep.cpp.

References stepsize.

Referenced by OpalSBend::update().

Member Data Documentation

◆ field

BMultipoleField SBendRep::field

private

The multipole expansion.

Definition at line 142 of file SBendRep.h.

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

◆ geometry

PlanarArcGeometry SBendRep::geometry

private

The bend geometry.

Definition at line 139 of file SBendRep.h.

Referenced by getGeometry().

◆ hEntry

double SBendRep::hEntry

private

Definition at line 147 of file SBendRep.h.

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

◆ hExit

double SBendRep::hExit

private

Definition at line 148 of file SBendRep.h.

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

◆ rEntry

double SBendRep::rEntry

private

Definition at line 145 of file SBendRep.h.

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

◆ rExit

double SBendRep::rExit

private

Definition at line 146 of file SBendRep.h.

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

◆ slices

double SBendRep::slices

private

Definition at line 151 of file SBendRep.h.

Referenced by getSlices(), and setSlices().

◆ stepsize

double SBendRep::stepsize

private

Definition at line 152 of file SBendRep.h.

Referenced by getStepsize(), and setStepsize().

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

/Users/gsell/src/OPAL/src/src/Classic/BeamlineCore/SBendRep.h
/Users/gsell/src/OPAL/src/src/Classic/BeamlineCore/SBendRep.cpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SBendRep() [1/3]

◆ SBendRep() [2/3]

◆ SBendRep() [3/3]

◆ ~SBendRep()

Member Function Documentation

◆ clone()

◆ getB()

◆ getChannel()

◆ getEntryFaceCurvature()

◆ getEntryFaceRotation()

◆ getExitFaceCurvature()

◆ getExitFaceRotation()

◆ getField() [1/2]

◆ getField() [2/2]

◆ getGeometry() [1/2]

◆ getGeometry() [2/2]

◆ getSlices()

◆ getStepsize()

◆ operator=()

◆ setB()

◆ setEntryFaceCurvature()

◆ setEntryFaceRotation()

◆ setExitFaceCurvature()

◆ setExitFaceRotation()

◆ setField()

◆ setSlices()

◆ setStepsize()

Member Data Documentation

◆ field

◆ geometry

◆ hEntry

◆ hExit

◆ rEntry

◆ rExit

◆ slices

◆ stepsize