#include <SingleMultipole.h>
Inheritance diagram for SingleMultipole< order >:
Collaboration diagram for SingleMultipole< order >:
Classes | |
| struct | Entry |
Public Member Functions | |
| SingleMultipole (const std::string &name) | |
| Constructor with given name. More... | |
| SingleMultipole () | |
| SingleMultipole (const SingleMultipole &) | |
| virtual | ~SingleMultipole () |
| virtual BMultipoleField & | getField () |
| Get field. More... | |
| virtual const BMultipoleField & | getField () const |
| Get field. More... | |
| virtual StraightGeometry & | getGeometry () |
| Get geometry. More... | |
| virtual const StraightGeometry & | getGeometry () const |
| Get geometry. More... | |
| virtual double | getComponent () const |
| Get component. More... | |
| virtual void | setComponent (double Bn) |
| Set component. More... | |
| virtual ElementBase * | clone () const |
| Return clone. More... | |
| virtual Channel * | getChannel (const std::string &aKey, bool=false) |
| Construct a read/write channel. More... | |
 Public Member Functions inherited from Multipole | |
| Multipole (const std::string &name) | |
| Constructor with given name. More... | |
| Multipole () | |
| Multipole (const Multipole &) | |
| virtual | ~Multipole () |
| virtual void | accept (BeamlineVisitor &) const override |
| Apply visitor to Multipole. More... | |
| double | getNormalComponent (int n) const |
| Get normal component. More... | |
| double | getSkewComponent (int n) const |
| Get skew component. More... | |
| void | setNormalComponent (int, double) |
| Set normal component. More... | |
| void | setNormalComponent (int, double, double) |
| Set normal component. More... | |
| void | setSkewComponent (int, double) |
| Set skew component. More... | |
| void | setSkewComponent (int, double, double) |
| Set skew component. More... | |
| size_t | getMaxNormalComponentIndex () const |
| size_t | getMaxSkewComponentIndex () const |
| void | setNSlices (const std::size_t &nSlices) |
| std::size_t | getNSlices () const |
| bool | isFocusing (unsigned int component) const |
| virtual bool | apply (const size_t &i, const double &t, Vector_t &E, Vector_t &B) override |
| virtual bool | apply (const Vector_t &R, const Vector_t &P, const double &t, Vector_t &E, Vector_t &B) override |
| virtual bool | applyToReferenceParticle (const Vector_t &R, const Vector_t &P, const double &t, Vector_t &E, Vector_t &B) override |
| virtual void | initialise (PartBunchBase< double, 3 > *bunch, double &startField, double &endField) override |
| virtual void | finalise () override |
| virtual bool | bends () const override |
| virtual ElementType | getType () const override |
| Get element type std::string. More... | |
| virtual void | getDimensions (double &zBegin, double &zEnd) const override |
| virtual bool | isInside (const Vector_t &r) const override |
| 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 double | getDesignEnergy () const |
| virtual void | setDesignEnergy (const double &energy, bool changeable=true) |
| virtual void | goOnline (const double &kineticEnergy) |
| 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 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... | |
| 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 |
| 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 SingleMultipole &) |
| template<> | |
| const std::string | type ("Octupole") |
| template<> | |
| const SingleMultipole< 4 >::Entry | entries [] |
| template<> | |
| const std::string | type ("Quadrupole") |
| template<> | |
| const SingleMultipole< 2 >::Entry | entries [] |
| template<> | |
| const std::string | type ("Sextupole") |
| template<> | |
| const SingleMultipole< 3 >::Entry | entries [] |
| template<> | |
| const std::string | type ("SkewOctupole") |
| template<> | |
| const SingleMultipole< -4 >::Entry | entries [] |
| template<> | |
| const std::string | type ("SkewQuadrupole") |
| template<> | |
| const SingleMultipole< -2 >::Entry | entries [] |
| template<> | |
| const std::string | type ("SkewSextupole") |
| template<> | |
| const SingleMultipole< -3 >::Entry | entries [] |
Private Attributes | |
| BMultipoleField | tempField |
| StraightGeometry | geometry |
| Multipole geometry. More... | |
| BSingleMultipoleField< order > | field |
| The single multipole component. More... | |
Static Private Attributes | |
| static const std::string | type |
| static const Entry | entries [] |
Additional Inherited Members | |
| Static Public Member Functions inherited from ElementBase | |
| static std::string | getTypeString (ElementType type) |
| 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 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
template<int order>
class SingleMultipole< order >
Definition at line 47 of file SingleMultipole.h.
Constructor & Destructor Documentation
template<int order>
|
explicit |
Constructor with given name.
Definition at line 142 of file SingleMultipole.h.
template<int order>
| SingleMultipole< order >::SingleMultipole | ( | ) |
Definition at line 125 of file SingleMultipole.h.
template<int order>
| SingleMultipole< order >::SingleMultipole | ( | const SingleMultipole< order > & | multipole | ) |
Definition at line 134 of file SingleMultipole.h.
template<int order>
|
virtual |
Definition at line 150 of file SingleMultipole.h.
Member Function Documentation
template<int order>
|
inlinevirtual |
template<>
|
private |
Definition at line 33 of file Octupole.cpp.
template<>
|
private |
Definition at line 33 of file SkewOctupole.cpp.
template<>
|
private |
Definition at line 33 of file SkewQuadrupole.cpp.
template<>
|
private |
Definition at line 33 of file SkewSextupole.cpp.
template<>
|
private |
Definition at line 33 of file Quadrupole.cpp.
template<>
|
private |
Definition at line 33 of file Sextupole.cpp.
template<int order>
|
inlinevirtual |
Construct a read/write channel.
Reimplemented from ElementBase.
Definition at line 197 of file SingleMultipole.h.
References ElementBase::getChannel(), and SingleMultipole< order >::Entry::name.
Here is the call graph for this function:
template<int order>
|
inlinevirtual |
Get component.
Definition at line 155 of file SingleMultipole.h.
template<int order>
|
virtual |
template<int order>
|
virtual |
template<int order>
|
inlinevirtual |
template<int order>
|
inlinevirtual |
template<int order>
|
private |
template<int order>
|
inlinevirtual |
Set component.
Definition at line 160 of file SingleMultipole.h.
template<>
|
private |
template<>
|
private |
template<>
|
private |
template<>
|
private |
template<>
|
private |
template<>
|
private |
Member Data Documentation
template<int order>
|
staticprivate |
Definition at line 117 of file SingleMultipole.h.
template<int order>
|
private |
The single multipole component.
Definition at line 104 of file SingleMultipole.h.
template<int order>
|
private |
Multipole geometry.
Definition at line 101 of file SingleMultipole.h.
template<int order>
|
mutableprivate |
Definition at line 98 of file SingleMultipole.h.
template<int order>
|
staticprivate |
Definition at line 107 of file SingleMultipole.h.
The documentation for this class was generated from the following file:
- src/Classic/BeamlineCore/SingleMultipole.h
