#include <RFCavityRep.h>
Inheritance diagram for RFCavityRep:
Collaboration diagram for RFCavityRep:
Public Member Functions | |
| RFCavityRep (const std::string &name) | |
| Constructor with given name. More... | |
| RFCavityRep () | |
| RFCavityRep (const RFCavityRep &) | |
| virtual | ~RFCavityRep () |
| virtual ElementBase * | clone () const |
| Return clone. More... | |
| virtual Channel * | getChannel (const std::string &aKey, bool=false) |
| Construct a read/write channel. More... | |
| virtual AcceleratingField & | getField () |
| Get field. More... | |
| virtual const AcceleratingField & | getField () const |
| Get field. More... | |
| virtual StraightGeometry & | getGeometry () |
| Get geometry. More... | |
| virtual const StraightGeometry & | getGeometry () const |
| Get geometry. More... | |
| virtual double | getAmplitude () const |
| Get amplitude. More... | |
| virtual double | getFrequency () const |
| Get frequency. More... | |
| virtual double | getPhase () const |
| Get phase. More... | |
| virtual void | setAmplitude (double V) |
| Set amplitude. More... | |
| virtual void | setFrequency (double f) |
| Set frequency. More... | |
| virtual void | setPhase (double phi) |
| Set phase. More... | |
 Public Member Functions inherited from RFCavity | |
| RFCavity (const std::string &name) | |
| Constructor with given name. More... | |
| RFCavity () | |
| RFCavity (const RFCavity &) | |
| virtual | ~RFCavity () |
| virtual void | accept (BeamlineVisitor &) const override |
| Apply visitor to RFCavity. More... | |
| virtual double | getAmplitude () const =0 |
| Get RF amplitude. More... | |
| virtual double | getFrequency () const =0 |
| Get RF frequency. More... | |
| void | setFrequency (double freq) |
| virtual double | getPhase () const =0 |
| Get RF phase. More... | |
| void | dropFieldmaps () |
| virtual void | setFieldMapFN (const std::string &fmapfn) |
| Set the name of the field map. More... | |
| virtual std::string | getFieldMapFN () const |
| virtual void | setAmplitudem (double vPeak) |
| virtual double | getAmplitudem () const |
| virtual void | setAmplitudeError (double vPeakError) |
| virtual double | getAmplitudeError () const |
| virtual void | setFrequencym (double freq) |
| virtual double | getFrequencym () const |
| virtual void | setPhasem (double phase) |
| virtual double | getPhasem () const |
| double | getPhasem (double t) const |
| virtual void | setPhaseError (double phaseError) |
| virtual double | getPhaseError () const |
| void | setCavityType (const std::string &type) |
| CavityType | getCavityType () const |
| std::string | getCavityTypeString () const |
| virtual void | setFast (bool fast) |
| virtual bool | getFast () const |
| virtual void | setAutophaseVeto (bool veto=true) |
| virtual bool | getAutophaseVeto () const |
| virtual double | getAutoPhaseEstimate (const double &E0, const double &t0, const double &q, const double &m) |
| virtual double | getAutoPhaseEstimateFallback (double E0, double t0, double q, double m) |
| virtual std::pair< double, double > | trackOnAxisParticle (const double &p0, const double &t0, const double &dt, const double &q, const double &mass, std::ofstream *out=nullptr) |
| 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 | initialise (PartBunchBase< double, 3 > *bunch, std::shared_ptr< AbstractTimeDependence > freq_atd, std::shared_ptr< AbstractTimeDependence > ampl_atd, std::shared_ptr< AbstractTimeDependence > phase_atd) |
| virtual void | finalise () override |
| virtual bool | bends () const override |
| virtual void | goOnline (const double &kineticEnergy) override |
| virtual void | goOffline () override |
| virtual void | setDesignEnergy (const double &ekin, bool changeable=true) override |
| virtual double | getDesignEnergy () const override |
| void | setRmin (double rmin) |
| virtual double | getRmin () const |
| void | setRmax (double rmax) |
| virtual double | getRmax () const |
| void | setAzimuth (double angle) |
| virtual double | getAzimuth () const |
| void | setPerpenDistance (double pdis) |
| virtual double | getPerpenDistance () const |
| void | setGapWidth (double gapwidth) |
| virtual double | getGapWidth () const |
| void | setPhi0 (double phi0) |
| virtual double | getPhi0 () const |
| virtual double | getCosAzimuth () const |
| virtual double | getSinAzimuth () const |
| virtual double | getCycFrequency () const |
| void | getMomentaKick (const double normalRadius, double momentum[], const double t, const double dtCorrt, const int PID, const double restMass, const int chargenumber) |
| used in OPAL-cycl More... | |
| double | spline (double z, double *za) |
| 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 |
| void | setAmplitudeModel (std::shared_ptr< AbstractTimeDependence > time_dep) |
| void | setAmplitudeModelName (std::string name) |
| std::string | getAmplitudeModelName () |
| void | setPhaseModel (std::shared_ptr< AbstractTimeDependence > time_dep) |
| void | setPhaseModelName (std::string name) |
| std::string | getPhaseModelName () |
| void | setFrequencyModel (std::shared_ptr< AbstractTimeDependence > time_dep) |
| void | setFrequencyModelName (std::string name) |
| std::string | getFrequencyModelName () |
| virtual double | getElementLength () const override |
| Get design length. More... | |
| virtual void | getElementDimensions (double &begin, double &end) const override |
| virtual CoordinateSystemTrafo | getEdgeToBegin () const override |
| virtual CoordinateSystemTrafo | getEdgeToEnd () 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 () |
| 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 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 &, const double &, Vector_t &, double &) |
| virtual double | getDesignEnergy () const |
| virtual void | setDesignEnergy (const double &energy, bool changeable=true) |
| virtual void | initialise (PartBunchBase< double, 3 > *bunch, double &startField, double &endField)=0 |
| virtual void | finalise ()=0 |
| virtual bool | bends () const =0 |
| virtual void | goOnline (const double &kineticEnergy) |
| virtual void | goOffline () |
| virtual bool | Online () |
| virtual void | getDimensions (double &zBegin, double &zEnd) const =0 |
| virtual ElementType | getType () const |
| Get element type std::string. More... | |
| 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... | |
| virtual ElementType | getType () const =0 |
| Get element type std::string. 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 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... | |
| 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 |
| virtual bool | isInside (const Vector_t &r) 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... | |
Static Public Member Functions | |
| static void | setIgnore (bool ignore=false) |
| Set ignore switch. More... | |
| Static Public Member Functions inherited from ElementBase | |
| static std::string | getTypeString (ElementType type) |
Private Member Functions | |
| void | operator= (const RFCavityRep &) |
Private Attributes | |
| StraightGeometry | geometry |
| The cavity's geometry. More... | |
| AcceleratingField | field |
| The cavity's field. More... | |
Static Private Attributes | |
| static bool | ignoreCavities = false |
| Cavities are ignored (amplitude = 0) when this switch is set. More... | |
Additional Inherited Members | |
| 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 RFCavity | |
| std::shared_ptr< AbstractTimeDependence > | phaseTD_m |
| std::string | phaseName_m |
| std::shared_ptr< AbstractTimeDependence > | amplitudeTD_m |
| std::string | amplitudeName_m |
| std::shared_ptr< AbstractTimeDependence > | frequencyTD_m |
| std::string | frequencyName_m |
| std::string | filename_m |
| double | scale_m |
| double | scaleError_m |
| double | phase_m |
| double | phaseError_m |
| double | frequency_m |
| bool | fast_m |
| bool | autophaseVeto_m |
| double | designEnergy_m |
| Fieldmap * | fieldmap_m |
| double | startField_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
Definition at line 26 of file RFCavityRep.h.
Constructor & Destructor Documentation
◆ RFCavityRep() [1/3]
|
explicit |
Constructor with given name.
Definition at line 68 of file RFCavityRep.cpp.
◆ RFCavityRep() [2/3]
| RFCavityRep::RFCavityRep | ( | ) |
Definition at line 57 of file RFCavityRep.cpp.
Referenced by clone().
◆ RFCavityRep() [3/3]
| RFCavityRep::RFCavityRep | ( | const RFCavityRep & | right | ) |
Definition at line 62 of file RFCavityRep.cpp.
◆ ~RFCavityRep()
|
virtual |
Definition at line 73 of file RFCavityRep.cpp.
Member Function Documentation
◆ clone()
|
virtual |
Return clone.
Implements ElementBase.
Definition at line 77 of file RFCavityRep.cpp.
References RFCavityRep().
Here is the call graph for this function:
◆ getAmplitude()
|
virtual |
Get amplitude.
Implements RFCavity.
Definition at line 111 of file RFCavityRep.cpp.
References field, ConstEzField::getEz(), and ignoreCavities.
Here is the call graph for this function:
◆ getChannel()
|
virtual |
Construct a read/write channel.
Reimplemented from ElementBase.
Definition at line 82 of file RFCavityRep.cpp.
References ElementBase::getChannel().
Here is the call graph for this function:
◆ getField() [1/2]
|
virtual |
◆ getField() [2/2]
|
virtual |
◆ getFrequency()
|
virtual |
Get frequency.
Implements RFCavity.
Definition at line 116 of file RFCavityRep.cpp.
References field, and OscillatingField< Field >::getFrequency().
Here is the call graph for this function:
◆ getGeometry() [1/2]
|
virtual |
Get geometry.
Implements ElementBase.
Definition at line 102 of file RFCavityRep.cpp.
References geometry.
◆ getGeometry() [2/2]
|
virtual |
Get geometry.
Implements ElementBase.
Definition at line 106 of file RFCavityRep.cpp.
References geometry.
◆ getPhase()
|
virtual |
Get phase.
Implements RFCavity.
Definition at line 121 of file RFCavityRep.cpp.
References field, and OscillatingField< Field >::getPhase().
Here is the call graph for this function:
◆ operator=()
|
private |
◆ setAmplitude()
|
virtual |
Set amplitude.
Definition at line 126 of file RFCavityRep.cpp.
References field, and ConstEzField::setEz().
Referenced by OpalCavity::update().
Here is the call graph for this function:
◆ setFrequency()
|
virtual |
Set frequency.
Definition at line 131 of file RFCavityRep.cpp.
References field, and OscillatingField< Field >::setFrequency().
Referenced by OpalCavity::update().
Here is the call graph for this function:
◆ setIgnore()
|
static |
◆ setPhase()
|
virtual |
Set phase.
Definition at line 136 of file RFCavityRep.cpp.
References field, and OscillatingField< Field >::setPhase().
Referenced by OpalCavity::update().
Here is the call graph for this function:
Member Data Documentation
◆ field
|
private |
The cavity's field.
Definition at line 102 of file RFCavityRep.h.
Referenced by getAmplitude(), getField(), getFrequency(), getPhase(), setAmplitude(), setFrequency(), and setPhase().
◆ geometry
|
private |
◆ ignoreCavities
|
staticprivate |
Cavities are ignored (amplitude = 0) when this switch is set.
Definition at line 105 of file RFCavityRep.h.
Referenced by getAmplitude(), and setIgnore().
The documentation for this class was generated from the following files:
- /Users/gsell/src/OPAL/src/src/Classic/BeamlineCore/RFCavityRep.h
- /Users/gsell/src/OPAL/src/src/Classic/BeamlineCore/RFCavityRep.cpp
