OPAL (Object Oriented Parallel Accelerator Library)
2.2.0
OPAL
|
#include <SBend.h>
Public Member Functions | |
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 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... | |
![]() | |
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... | |
![]() | |
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 |
![]() | |
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 &) |
![]() | |
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 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 ElementImage * | getImage () const |
Construct an image. 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... | |
virtual ElementBase * | makeAlignWrapper () |
Allow misalignment. More... | |
virtual ElementBase * | makeFieldWrapper () |
Allow field errors. 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 |
![]() | |
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 SBend &) |
virtual bool | findChordLength (Inform &msg, double &chordLength) override |
|
explicit |
Constructor with given name.
Definition at line 45 of file SBend.cpp.
References Bend2D::setMessageHeader().
SBend::SBend | ( | const SBend & | right | ) |
Definition at line 39 of file SBend.cpp.
References Bend2D::setMessageHeader().
|
overridevirtual |
Apply visitor to SBend.
Implements Bend2D.
Reimplemented in SBendWrapper.
Definition at line 54 of file SBend.cpp.
References BeamlineVisitor::visitSBend().
|
inlineoverridevirtual |
|
inlineoverridevirtual |
|
overrideprivatevirtual |
Implements Bend2D.
Definition at line 94 of file SBend.cpp.
References BendBase::getLength().
|
pure virtual |
Get dipole field of SBend.
Implemented in SBendWrapper, and SBendRep.
Referenced by ThickTracker::visitSBend().
|
pure virtual |
Get entry pole face curvature.
Implemented in SBendRep, and SBendWrapper.
Referenced by SBendWrapper::getEntryFaceCurvature(), ThickMapper::visitSBend(), and LieMapper::visitSBend().
|
pure virtual |
Get pole entry face rotation.
Implemented in SBendRep, and SBendWrapper.
Referenced by SBendWrapper::getEntryFaceRotation(), MSplit::visitSBend(), OrbitTracker::visitSBend(), Aperture::visitSBend(), ThickMapper::visitSBend(), LieMapper::visitSBend(), LinearMapper::visitSBend(), and TransportMapper::visitSBend().
|
pure virtual |
Get exit pole face curvature.
Implemented in SBendRep, and SBendWrapper.
Referenced by SBendWrapper::getExitFaceCurvature(), ThickMapper::visitSBend(), and LieMapper::visitSBend().
|
pure virtual |
Get exit pole face rotation.
Implemented in SBendRep, and SBendWrapper.
Referenced by SBendWrapper::getExitFaceRotation(), MSplit::visitSBend(), OrbitTracker::visitSBend(), Aperture::visitSBend(), ThickMapper::visitSBend(), LieMapper::visitSBend(), LinearMapper::visitSBend(), and TransportMapper::visitSBend().
|
overridepure virtual |
Get multipole expansion of field.
Implements Component.
Implemented in SBendWrapper, SBendRep, and SectorFieldMapComponent.
Referenced by OpalSBend::fillRegisteredAttributes(), SBendWrapper::getField(), getNormalComponent(), getSkewComponent(), setNormalComponent(), setSkewComponent(), MSplit::visitSBend(), ThinMapper::visitSBend(), OrbitTracker::visitSBend(), ThinTracker::visitSBend(), Aperture::visitSBend(), ThickMapper::visitSBend(), LieMapper::visitSBend(), LinearMapper::visitSBend(), and TransportMapper::visitSBend().
|
overridepure virtual |
Get multipole expansion of field.
Implements Component.
Implemented in SBendWrapper, SBendRep, and SectorFieldMapComponent.
|
overridepure virtual |
Get SBend geometry.
Implements ElementBase.
Implemented in SBendWrapper, and SBendRep.
Referenced by SBendWrapper::getGeometry(), MSplit::visitSBend(), ThinMapper::visitSBend(), OrbitTracker::visitSBend(), ThinTracker::visitSBend(), Aperture::visitSBend(), ThickMapper::visitSBend(), LieMapper::visitSBend(), LinearMapper::visitSBend(), and TransportMapper::visitSBend().
|
overridepure virtual |
double SBend::getNormalComponent | ( | int | n | ) | const |
Get normal component.
Definition at line 62 of file SBend.cpp.
References getField(), and BMultipoleField::getNormalComponent().
Referenced by SBendRep::getChannel().
double SBend::getSkewComponent | ( | int | n | ) | const |
Get skew component.
Definition at line 66 of file SBend.cpp.
References getField(), and BMultipoleField::getSkewComponent().
Referenced by SBendRep::getChannel().
|
pure virtual |
Get number of slices.
Implemented in SBendRep, and SBendWrapper.
Referenced by SBendWrapper::getSlices(), and ThickMapper::visitSBend().
|
pure virtual |
Get stepsize.
Implemented in SBendRep, and SBendWrapper.
Referenced by SBendWrapper::getStepsize(), and ThickMapper::visitSBend().
|
overridevirtual |
Get element type std::string.
Implements Bend2D.
Reimplemented in SBendWrapper.
Definition at line 89 of file SBend.cpp.
References ElementBase::SBEND.
|
private |
void SBend::setNormalComponent | ( | int | n, |
double | v | ||
) |
Set normal component.
Definition at line 70 of file SBend.cpp.
References getField(), and BMultipoleField::setNormalComponent().
Referenced by SBendRep::getChannel().
void SBend::setSkewComponent | ( | int | n, |
double | v | ||
) |
Set skew component.
Definition at line 74 of file SBend.cpp.
References getField(), and BMultipoleField::setSkewComponent().
Referenced by SBendRep::getChannel().