SBendRep Class Reference

Representation for a sector bend magnet. More...

#include <SBendRep.h>

Inheritance diagram for SBendRep:

Collaboration diagram for SBendRep:

Public Member Functions
	SBendRep (const std::string &name)
	Constructor with given name. More...
	SBendRep ()
	SBendRep (const SBendRep &)
virtual	~SBendRep ()
virtual ElementBase *	clone () const
	Return clone. More...
virtual Channel *	getChannel (const std::string &aKey, bool=false)
	Construct a read/write channel. More...
virtual BMultipoleField &	getField ()
	Get field. More...
virtual const BMultipoleField &	getField () const
	Get field. More...
virtual PlanarArcGeometry &	getGeometry ()
	Get geometry. More...
virtual const PlanarArcGeometry &	getGeometry () const
	Get geometry. More...
virtual ElementImage *	getImage () const
	Construct an image. 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 ElementBase *	makeFieldWrapper ()
	Allow field errors. 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...
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 void	addKR (int, double, Vector_t &) override
virtual void	addKT (int, double, Vector_t &) override
virtual ElementBase::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 bool	apply (const size_t &i, const double &t, Vector_t &E, Vector_t &B)
	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)
	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)
virtual void	goOnline (const double &kineticEnergy)
virtual void	finalise ()
virtual void	getDimensions (double &sBegin, double &sEnd) const
virtual void	initialise (PartBunchBase< double, 3 > *bunch, double &startField, double &endField)
double	getBendRadius () const
double	getEffectiveCenter () const
double	getEffectiveLength () const
double	getStartElement () const
void	setK1 (double k1)
	Set quadrupole field component. More...
void	setExitAngle (double exitAngle)
virtual double	getExitAngle () const
double	getMapLength () const
std::vector< Vector_t >	getOutline () const
MeshData	getSurfaceMesh () const
virtual CoordinateSystemTrafo	getEdgeToEnd () const
CoordinateSystemTrafo	getBeginToEnd_local () const
virtual bool	isInside (const Vector_t &r) const
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...
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...
void	setLength (double length)
double	getLength () const
double	getChordLength () const
virtual void	setBendAngle (double angle)
double	getBendAngle () const
virtual void	setEntranceAngle (double entranceAngle)
double	getEntranceAngle () const
void	setFullGap (double)
double	getFullGap () const
virtual void	setDesignEnergy (const double &energy, bool changeable=true)
double	getDesignEnergy () const
std::vector< Vector_t >	getDesignPath () const
void	setFieldAmplitude (double k0, double k0s)
double	getFieldAmplitude () const
void	setFieldMapFN (std::string fileName)
std::string	getFieldMapFN () const
Public Member Functions inherited from Component
	Component (const std::string &name)
	Constructor with given name. More...
	Component ()
	Component (const Component &right)
virtual	~Component ()
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	getPotential (const Vector_t &R, const double &t, Vector_t &A, double &phi)
virtual void	goOffline ()
virtual bool	Online ()
virtual void	setComponentType (std::string)
virtual std::string	getComponentType () const
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...
std::string	getTypeString () const
virtual double	getArcLength () const
	Get arc length. More...
virtual double	getElementLength () const
	Get design length. More...
virtual void	setElementLength (double length)
	Set design length. More...
virtual void	getElementDimensions (double &begin, double &end) const
virtual double	getOrigin () const
	Get origin position. More...
virtual double	getEntrance () const
	Get entrance position. More...
virtual double	getExit () const
	Get exit position. More...
virtual Euclid3D	getTransform (double fromS, double toS) const
	Get transform. More...
virtual Euclid3D	getTransform (double s) const
	Get transform. More...
virtual Euclid3D	getTotalTransform () const
	Get transform. More...
virtual Euclid3D	getEntranceFrame () const
	Get transform. More...
virtual Euclid3D	getExitFrame () const
	Get transform. More...
virtual Euclid3D	getEntrancePatch () const
	Get patch. More...
virtual Euclid3D	getExitPatch () const
	Get patch. More...
virtual double	getAttribute (const std::string &aKey) const
	Get attribute value. More...
virtual bool	hasAttribute (const std::string &aKey) const
	Test for existence of an attribute. More...
virtual void	removeAttribute (const std::string &aKey)
	Remove an existing attribute. More...
virtual void	setAttribute (const std::string &aKey, double val)
	Set value of an attribute. More...
virtual const ConstChannel *	getConstChannel (const std::string &aKey) const
	Construct a read-only channel. More...
virtual ElementBase *	copyStructure ()
	Make a structural copy. More...
bool	isSharable () const
	Test if the element can be shared. More...
virtual void	makeSharable ()
	Set sharable flag. More...
virtual ElementBase *	makeAlignWrapper ()
	Allow misalignment. More...
virtual ElementBase *	makeWrappers ()
	Allow errors. More...
virtual ElementBase *	removeAlignWrapper ()
	Remove align wrapper. More...
virtual const ElementBase *	removeAlignWrapper () const
	Remove align wrapper. More...
virtual ElementBase *	removeFieldWrapper ()
	Remove field wrapper. More...
virtual const ElementBase *	removeFieldWrapper () const
	Remove field wrapper. More...
virtual ElementBase *	removeWrappers ()
	Return the design element. More...
virtual const ElementBase *	removeWrappers () const
	Return the design element. 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
ElemType	getElType () const
	returns element type as enumeration needed in the envelope tracker More...
void	setElType (ElemType elt)
	set the element type as enumeration needed in the envelope tracker More...
void	setCSTrafoGlobal2Local (const CoordinateSystemTrafo &ori)
CoordinateSystemTrafo	getCSTrafoGlobal2Local () const
void	releasePosition ()
void	fixPosition ()
bool	isPositioned () const
virtual CoordinateSystemTrafo	getEdgeToBegin () const
void	setAperture (const ApertureType &type, const std::vector< double > &args)
std::pair < ElementBase::ApertureType, std::vector< double > >	getAperture () const
void	setMisalignment (double x, double y, double s)
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
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
Public Types inherited from ElementBase
enum	ApertureType { RECTANGULAR, ELLIPTICAL, CONIC_RECTANGULAR, CONIC_ELLIPTICAL }
enum	ElementType {   ALIGNWRAPPER, BEAMBEAM, BEAMBEAM3D, BEAMLINE,   BEAMSTRIPPING, CCOLLIMATOR, CORRECTOR, CORRECTORWRAPPER,   CYCLOTRON, CYCLOTRONWRAPPER, CYCLOTRONVALLEY, DEGRADER,   DIAGNOSTIC, DRIFT, FLEXIBLECOLLIMATOR, INTEGRATOR,   LAMBERTSON, MARKER, MONITOR, MPSPLITINTEGRATOR,   MULTIPOLE, MULTIPOLET, MULTIPOLEWRAPPER, OFFSET,   PARALLELPLATE, PATCH, PROBE, RBEND,   RBEND3D, RBENDWRAPPER, RFCAVITY, RFQUADRUPOLE,   RING, SBEND3D, SBEND, SBENDWRAPPER,   SEPARATOR, SEPTUM, SOLENOID, SOURCE,   STRIPPER, TRAVELINGWAVE, VARIABLERFCAVITY, ANY }
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
Fieldmap *	getFieldmap ()
Protected Member Functions inherited from ElementBase
bool	isInsideTransverse (const Vector_t &r, double f=1) 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	length_m
double	chordLength_m
double	angle_m
double	entranceAngle_m
double	gap_m
	Angle between incoming reference trajectory. More...
double	designEnergy_m
bool	designEnergyChangeable_m
	Bend design energy (eV). More...
std::vector< Vector_t >	refTrajMap_m
	Map of reference particle trajectory. More...
double	bX_m
double	bY_m
double	fieldAmplitude_m
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

Representation for a sector bend magnet.

Definition at line 34 of file SBendRep.h.

Constructor & Destructor Documentation

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

explicit

Constructor with given name.

Definition at line 96 of file SBendRep.cpp.

References hEntry, hExit, rEntry, and rExit.

SBendRep::SBendRep

(

)

Definition at line 77 of file SBendRep.cpp.

References hEntry, hExit, rEntry, and rExit.

Referenced by clone().

SBendRep::SBendRep

(

const SBendRep &

rhs

)

Definition at line 85 of file SBendRep.cpp.

References hEntry, hExit, rEntry, and rExit.

SBendRep::~SBendRep ( )

virtual

Definition at line 104 of file SBendRep.cpp.

Member Function Documentation

ElementBase * SBendRep::clone ( ) const

virtual

Return clone.

Implements ElementBase.

Definition at line 108 of file SBendRep.cpp.

References SBendRep().

Here is the call graph for this function:

double SBendRep::getB ( ) const

virtual

Get field.

Implements SBend.

Definition at line 201 of file SBendRep.cpp.

References field, and BMultipoleField::getNormalComponent().

Here is the call graph for this function:

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

virtual

Construct a read/write channel.

Reimplemented from ElementBase.

Definition at line 113 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:

double SBendRep::getEntryFaceCurvature ( ) const

virtual

Get entry pole face curvature.

Implements SBend.

Definition at line 227 of file SBendRep.cpp.

References hEntry.

double SBendRep::getEntryFaceRotation ( ) const

virtual

Get pole entry face rotation.

Implements SBend.

Definition at line 210 of file SBendRep.cpp.

References rEntry.

double SBendRep::getExitFaceCurvature ( ) const

virtual

Get exit pole face curvature.

Implements SBend.

Definition at line 231 of file SBendRep.cpp.

References hExit.

double SBendRep::getExitFaceRotation ( ) const

virtual

Get exit pole face rotation.

Implements SBend.

Definition at line 215 of file SBendRep.cpp.

References rExit.

BMultipoleField & SBendRep::getField ( )

virtual

Get field.

Implements SBend.

Definition at line 146 of file SBendRep.cpp.

References field.

const BMultipoleField & SBendRep::getField ( ) const

virtual

Get field.

Implements SBend.

Definition at line 150 of file SBendRep.cpp.

References field.

PlanarArcGeometry & SBendRep::getGeometry ( )

virtual

Get geometry.

Implements SBend.

Definition at line 155 of file SBendRep.cpp.

References geometry.

Referenced by OpalSBend::update().

const PlanarArcGeometry & SBendRep::getGeometry ( ) const

virtual

Get geometry.

Implements SBend.

Definition at line 159 of file SBendRep.cpp.

References geometry.

ElementImage * SBendRep::getImage ( ) const

virtual

Construct an image.

Reimplemented from ElementBase.

Definition at line 164 of file SBendRep.cpp.

References field, ElementBase::getImage(), BMultipoleField::getNormalComponent(), BMultipoleField::getSkewComponent(), Hypervolume::n, name, BMultipoleField::order(), and AttributeSet::setAttribute().

Here is the call graph for this function:

double SBendRep::getSlices ( ) const

virtual

Get number of slices.

Implements SBend.

Definition at line 244 of file SBendRep.cpp.

References slices.

double SBendRep::getStepsize ( ) const

virtual

Get stepsize.

Implements SBend.

Definition at line 248 of file SBendRep.cpp.

References stepsize.

ElementBase * SBendRep::makeFieldWrapper ( )

virtual

Allow field errors.

Reimplemented from ElementBase.

Definition at line 266 of file SBendRep.cpp.

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

Here is the call graph for this function:

void SBendRep::operator= ( const SBendRep &  )

private

void SBendRep::setB ( double  By )

virtual

Set vertical component.

Definition at line 205 of file SBendRep.cpp.

References field, and BMultipoleField::setNormalComponent().

Here is the call graph for this function:

void SBendRep::setEntryFaceCurvature ( double  h1 )

virtual

Set entry pole face curvature.

Definition at line 235 of file SBendRep.cpp.

References hEntry.

Referenced by OpalSBend::update().

void SBendRep::setEntryFaceRotation ( double  e1 )

virtual

Set pole entry face rotation.

Definition at line 219 of file SBendRep.cpp.

References rEntry.

Referenced by OpalSBend::update().

void SBendRep::setExitFaceCurvature ( double  h2 )

virtual

Set exit pole face curvature.

Definition at line 239 of file SBendRep.cpp.

References hExit.

Referenced by OpalSBend::update().

void SBendRep::setExitFaceRotation ( double  e2 )

virtual

Set exit pole face rotation.

Definition at line 223 of file SBendRep.cpp.

References rExit.

Referenced by OpalSBend::update().

void SBendRep::setField ( const BMultipoleField &  field )

virtual

Set field.

Definition at line 261 of file SBendRep.cpp.

References field.

Referenced by OpalSBend::update().

void SBendRep::setSlices ( double  sl )

virtual

Set number of slices.

Definition at line 252 of file SBendRep.cpp.

References slices.

Referenced by OpalSBend::update().

void SBendRep::setStepsize ( double  ds )

virtual

Set stepsize.

Definition at line 256 of file SBendRep.cpp.

References stepsize.

Referenced by OpalSBend::update().

Member Data Documentation

BMultipoleField SBendRep::field

private

The multipole expansion.

Definition at line 158 of file SBendRep.h.

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

PlanarArcGeometry SBendRep::geometry

private

The bend geometry.

Definition at line 155 of file SBendRep.h.

Referenced by getGeometry().

double SBendRep::hEntry

private

Definition at line 163 of file SBendRep.h.

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

double SBendRep::hExit

private

Definition at line 164 of file SBendRep.h.

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

double SBendRep::rEntry

private

Definition at line 161 of file SBendRep.h.

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

double SBendRep::rExit

private

Definition at line 162 of file SBendRep.h.

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

double SBendRep::slices

private

Definition at line 167 of file SBendRep.h.

Referenced by getSlices(), and setSlices().

double SBendRep::stepsize

private

Definition at line 168 of file SBendRep.h.

Referenced by getStepsize(), and setStepsize().

---

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

• src/Classic/BeamlineCore/SBendRep.h
• src/Classic/BeamlineCore/SBendRep.cpp