|
OPAL (Object Oriented Parallel Accelerator Library)
2024.1
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 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) 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 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 |
| 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 &, const double &, Vector_t &, double &) |
| virtual void | goOffline () |
| virtual bool | Online () |
| 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 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 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 |
| 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. More... | |
| double | getRotationAboutZ () 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 SBend &) |
| virtual bool | findChordLength (double &chordLength) override |
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 |
|
explicit |
Constructor with given name.
Definition at line 42 of file SBend.cpp.
References Bend2D::setMessageHeader().

| SBend::SBend | ( | const SBend & | right | ) |
Definition at line 36 of file SBend.cpp.
References Bend2D::setMessageHeader().

|
overridevirtual |
Apply visitor to SBend.
Implements Bend2D.
Definition at line 51 of file SBend.cpp.
References BeamlineVisitor::visitSBend().

|
overrideprivatevirtual |
Implements Bend2D.
Definition at line 91 of file SBend.cpp.
References ElementBase::getElementLength().

|
pure virtual |
|
pure virtual |
Get entry pole face curvature.
Implemented in SBendRep.
|
pure virtual |
Get pole entry face rotation.
Implemented in SBendRep.
|
pure virtual |
Get exit pole face curvature.
Implemented in SBendRep.
|
pure virtual |
Get exit pole face rotation.
Implemented in SBendRep.
|
overridepure virtual |
Get multipole expansion of field.
Implements Component.
Implemented in SBendRep.
Referenced by getNormalComponent(), getSkewComponent(), setNormalComponent(), and setSkewComponent().
|
overridepure virtual |
|
overridepure virtual |
|
overridepure virtual |
| double SBend::getNormalComponent | ( | int | n | ) | const |
Get normal component.
Definition at line 59 of file SBend.cpp.
References getField(), and BMultipoleField::getNormalComponent().
Referenced by SBendRep::getChannel().

| double SBend::getSkewComponent | ( | int | n | ) | const |
Get skew component.
Definition at line 63 of file SBend.cpp.
References getField(), and BMultipoleField::getSkewComponent().
Referenced by SBendRep::getChannel().

|
pure virtual |
Get number of slices.
Implemented in SBendRep.
|
pure virtual |
Get stepsize.
Implemented in SBendRep.
|
overridevirtual |
| void SBend::setNormalComponent | ( | int | n, |
| double | v | ||
| ) |
Set normal component.
Definition at line 67 of file SBend.cpp.
References getField(), and BMultipoleField::setNormalComponent().
Referenced by SBendRep::getChannel().

| void SBend::setSkewComponent | ( | int | n, |
| double | v | ||
| ) |
Set skew component.
Definition at line 71 of file SBend.cpp.
References getField(), and BMultipoleField::setSkewComponent().
Referenced by SBendRep::getChannel().

1.8.5