|
OPAL (Object Oriented Parallel Accelerator Library)
2.2.0
OPAL
|
#include <BendBase.h>


Public Member Functions | |
| 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 |
| 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 void | addKR (int i, double t, Vector_t &K) |
| virtual void | addKT (int i, double t, Vector_t &K) |
| 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 &R, const double &t, Vector_t &A, double &phi) |
| virtual void | initialise (PartBunchBase< double, 3 > *bunch, double &startField, double &endField)=0 |
| virtual void | finalise ()=0 |
| virtual void | goOnline (const double &kineticEnergy) |
| virtual void | goOffline () |
| virtual bool | Online () |
| virtual void | getDimensions (double &zBegin, double &zEnd) const =0 |
| virtual ElementBase::ElementType | getType () const |
| Get element type std::string. More... | |
| 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 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 ElementImage * | getImage () const |
| Construct an image. 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... | |
| 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 |
| virtual CoordinateSystemTrafo | getEdgeToEnd () const |
| void | setAperture (const ApertureType &type, const std::vector< double > &args) |
| std::pair < ElementBase::ApertureType, std::vector< double > > | getAperture () const |
| virtual bool | isInside (const Vector_t &r) 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... | |
Protected Attributes | |
| 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 |
Definition at line 9 of file BendBase.h.
| BendBase::BendBase | ( | ) |
Definition at line 3 of file BendBase.cpp.
| BendBase::BendBase | ( | const BendBase & | right | ) |
Definition at line 7 of file BendBase.cpp.
References isDipole, and ElementBase::setElType().

| BendBase::BendBase | ( | const std::string & | name | ) |
Definition at line 25 of file BendBase.cpp.
References isDipole, and ElementBase::setElType().

|
inlinevirtual |
Indicates that element bends the beam.
Implements Component.
Reimplemented in RBend3D, and SectorFieldMapComponent.
Definition at line 60 of file BendBase.h.
|
inline |
Definition at line 86 of file BendBase.h.
References angle_m.
Referenced by OpalBeamline::compute3DLattice(), OrbitThreader::computeMaximalImplicitDrift(), RBend::findChordLength(), RBend3D::getExitAngle(), CSRWakeFunction::initialize(), CSRIGFWakeFunction::initialize(), OpalBeamline::save3DInput(), OpalBeamline::save3DLattice(), RBend::setEntranceAngle(), and Bend2D::setFieldCalcParam().
|
inline |
Definition at line 76 of file BendBase.h.
References chordLength_m.
Referenced by OpalBeamline::compute3DLattice(), and Bend2D::setFieldCalcParam().
|
inlinevirtual |
Reimplemented from Component.
Definition at line 120 of file BendBase.h.
References designEnergy_m.
Referenced by OpalBeamline::activateElements(), and ThickTracker::visitSBend().
| std::vector< Vector_t > BendBase::getDesignPath | ( | ) | const |
Definition at line 43 of file BendBase.cpp.
References refTrajMap_m.
Referenced by OpalBeamline::compute3DLattice(), and OpalBeamline::save3DLattice().
|
inline |
Definition at line 97 of file BendBase.h.
References entranceAngle_m.
Referenced by OpalBeamline::compute3DLattice(), OrbitThreader::computeMaximalImplicitDrift(), RBend::findChordLength(), RBend3D::getExitAngle(), OpalBeamline::save3DInput(), RBend::setBendAngle(), Bend2D::setFieldCalcParam(), Bend2D::setupBendGeometry(), and ThickTracker::visitSBend().
|
inline |
Definition at line 131 of file BendBase.h.
References fieldAmplitude_m.
Referenced by RBend::addKR(), and RBend::addKT().
|
inline |
Definition at line 142 of file BendBase.h.
References fileName_m.
|
inline |
Definition at line 107 of file BendBase.h.
References gap_m.
Referenced by Bend2D::getSurfaceMesh().
|
inline |
Definition at line 70 of file BendBase.h.
References length_m.
Referenced by SBend::findChordLength(), and RBend::findChordLength().
|
inlinevirtual |
Reimplemented in RBend.
Definition at line 81 of file BendBase.h.
References angle_m.
Referenced by RBend::setBendAngle(), OpalSBend::update(), and OpalRBend3D::update().
|
inlinevirtual |
Reimplemented from Component.
Definition at line 112 of file BendBase.h.
References abs(), designEnergy_m, and designEnergyChangeable_m.
Referenced by OpalSBend::update(), OpalRBend::update(), and OpalRBend3D::update().

|
inlinevirtual |
Reimplemented in RBend.
Definition at line 91 of file BendBase.h.
References entranceAngle_m.
Referenced by RBend::setEntranceAngle(), Bend2D::setupBendGeometry(), OpalSBend::update(), and OpalRBend3D::update().
|
inline |
Definition at line 125 of file BendBase.h.
Referenced by OpalSBend::update(), OpalRBend::update(), and OpalRBend3D::update().
|
inline |
Definition at line 137 of file BendBase.h.
References fileName_m.
Referenced by OpalSBend::update(), and OpalRBend::update().
|
inline |
Definition at line 102 of file BendBase.h.
Referenced by OpalSBend::update(), OpalRBend::update(), and OpalRBend3D::update().

|
inline |
Definition at line 65 of file BendBase.h.
References abs(), and length_m.
Referenced by OpalSBend::update(), OpalRBend::update(), and OpalRBend3D::update().

|
protected |
Definition at line 42 of file BendBase.h.
Referenced by Bend2D::estimateFieldAdjustmentStep(), Bend2D::findBendEffectiveLength(), Bend2D::findBendStrength(), Bend2D::findIdealBendParameters(), getBendAngle(), Bend2D::getEffectiveCenter(), Bend2D::getEffectiveLength(), Bend2D::getSurfaceMesh(), RBend3D::initialise(), Bend2D::print(), setBendAngle(), Bend2D::setBendEffectiveLength(), Bend2D::setFieldBoundaries(), and Bend2D::treatAsDrift().
|
protected |
Definition at line 52 of file BendBase.h.
Referenced by RBend::findChordLength(), Bend2D::findIdealBendParameters(), RBend3D::initialise(), setFieldAmplitude(), and Bend2D::treatAsDrift().
|
protected |
Definition at line 53 of file BendBase.h.
Referenced by RBend::findChordLength(), Bend2D::findIdealBendParameters(), RBend3D::initialise(), setFieldAmplitude(), and Bend2D::treatAsDrift().
|
protected |
Definition at line 41 of file BendBase.h.
Referenced by Bend2D::adjustFringeFields(), getChordLength(), RBend3D::initialise(), Bend2D::setEngeOriginDelta(), and Bend2D::setupBendGeometry().
|
protected |
Definition at line 47 of file BendBase.h.
Referenced by Bend2D::calculateBendAngle(), Bend2D::calculateRefTrajectory(), RBend::findChordLength(), Bend2D::findIdealBendParameters(), getDesignEnergy(), RBend3D::initialise(), Bend2D::print(), Bend2D::setBendStrength(), setDesignEnergy(), RBend3D::trackRefParticleThrough(), and Bend2D::treatAsDrift().
|
protected |
|
protected |
Definition at line 43 of file BendBase.h.
Referenced by Bend2D::calculateBendAngle(), Bend2D::calculateRefTrajectory(), Bend2D::findIdealBendParameters(), getEntranceAngle(), Bend2D::getSurfaceMesh(), RBend3D::initialise(), Bend2D::print(), setEntranceAngle(), Bend2D::setFieldBoundaries(), Bend2D::setFieldCalcParam(), and RBend3D::trackRefParticleThrough().
|
protected |
Definition at line 54 of file BendBase.h.
Referenced by RBend3D::apply(), Bend2D::apply(), RBend3D::applyToReferenceParticle(), Bend2D::calculateBendAngle(), Bend2D::calculateRefTrajectory(), Bend2D::estimateFieldAdjustmentStep(), Bend2D::findBendStrength(), Bend2D::findIdealBendParameters(), getFieldAmplitude(), RBend3D::initialise(), Bend2D::print(), Bend2D::setBendStrength(), and Bend2D::treatAsDrift().
|
protected |
Definition at line 56 of file BendBase.h.
Referenced by getFieldMapFN(), RBend3D::goOffline(), RBend3D::goOnline(), RBend3D::initialise(), Bend2D::initialise(), Bend2D::initializeFieldMap(), Bend2D::print(), Bend2D::readFieldMap(), setFieldMapFN(), RBend3D::setFieldMapFN(), and Bend2D::setupBendGeometry().
|
protected |
Angle between incoming reference trajectory.
Definition at line 45 of file BendBase.h.
Referenced by Bend2D::calcEngeFunction(), Bend2D::calculateMapField(), Bend2D::findBendEffectiveLength(), getFullGap(), Bend2D::isInside(), Bend2D::print(), Bend2D::readFieldMap(), setFullGap(), and Bend2D::setGapFromFieldMap().
|
protected |
Definition at line 40 of file BendBase.h.
Referenced by RBend3D::getDimensions(), getLength(), RBend3D::initialise(), setLength(), and Bend2D::setupDefaultFieldMap().
|
protected |
Map of reference particle trajectory.
Definition at line 50 of file BendBase.h.
Referenced by Bend2D::calculateRefTrajectory(), and getDesignPath().
1.8.5