OPAL (Object Oriented Parallel Accelerator Library)
2.2.0
OPAL
|
Interface for RF cavity. More...
#include <ParallelPlate.h>
Public Member Functions | |
ParallelPlate (const std::string &name) | |
Constructor with given name. More... | |
ParallelPlate () | |
ParallelPlate (const ParallelPlate &) | |
virtual | ~ParallelPlate () |
virtual void | accept (BeamlineVisitor &) const override |
Apply visitor to ParallelPlate. More... | |
void | getDimensions (double &zBegin, double &zEnd) const override |
ElementBase::ElementType | getType () const override |
Get element type std::string. More... | |
std::string | getFieldMapFN () const |
void | setAmplitude (double vPeak) |
double | getAmplitude () const |
void | setFrequency (double freq) |
double | getFrequency () const |
void | setPhase (double phase) |
double | getPhase () 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 | initialise (PartBunchBase< double, 3 > *bunch) |
virtual void | finalise () override |
virtual bool | bends () const override |
![]() | |
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 | getPotential (const Vector_t &R, const double &t, Vector_t &A, double &phi) |
virtual double | getDesignEnergy () const |
virtual void | setDesignEnergy (const double &energy, bool changeable) |
virtual void | goOnline (const double &kineticEnergy) |
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 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 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 |
![]() | |
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 ParallelPlate &) |
Private Attributes | |
std::string | filename_m |
double | scale_m |
double | phase_m |
double | frequency_m |
double | length_m |
double | ptime_m |
Interface for RF cavity.
Definition at line 36 of file ParallelPlate.h.
|
explicit |
Constructor with given name.
Definition at line 52 of file ParallelPlate.cpp.
References isRF, and ElementBase::setElType().
ParallelPlate::ParallelPlate | ( | ) |
Definition at line 35 of file ParallelPlate.cpp.
ParallelPlate::ParallelPlate | ( | const ParallelPlate & | right | ) |
Definition at line 40 of file ParallelPlate.cpp.
References isRF, and ElementBase::setElType().
|
virtual |
Definition at line 64 of file ParallelPlate.cpp.
|
overridevirtual |
Apply visitor to ParallelPlate.
Implements ElementBase.
Definition at line 70 of file ParallelPlate.cpp.
References BeamlineVisitor::visitParallelPlate().
|
overridevirtual |
Reimplemented from Component.
Definition at line 112 of file ParallelPlate.cpp.
References applyToReferenceParticle(), PartBunchBase< T, Dim >::P, PartBunchBase< T, Dim >::R, and Component::RefPartBunch_m.
|
overridevirtual |
Reimplemented from Component.
Definition at line 116 of file ParallelPlate.cpp.
References applyToReferenceParticle().
|
overridevirtual |
Reimplemented from Component.
Definition at line 120 of file ParallelPlate.cpp.
References frequency_m, length_m, phase_m, ptime_m, Attrib::Distribution::R, scale_m, and sin().
Referenced by apply().
|
overridevirtual |
Implements Component.
Definition at line 162 of file ParallelPlate.cpp.
|
overridevirtual |
Implements Component.
Definition at line 159 of file ParallelPlate.cpp.
double ParallelPlate::getAmplitude | ( | ) | const |
Definition at line 83 of file ParallelPlate.cpp.
References scale_m.
Referenced by OpalParallelPlate::fillRegisteredAttributes().
|
overridevirtual |
std::string ParallelPlate::getFieldMapFN | ( | ) | const |
Definition at line 75 of file ParallelPlate.cpp.
double ParallelPlate::getFrequency | ( | ) | const |
Definition at line 91 of file ParallelPlate.cpp.
References frequency_m.
Referenced by OpalParallelPlate::fillRegisteredAttributes().
double ParallelPlate::getPhase | ( | ) | const |
Definition at line 99 of file ParallelPlate.cpp.
References phase_m.
Referenced by OpalParallelPlate::fillRegisteredAttributes().
|
overridevirtual |
Get element type std::string.
Reimplemented from Component.
Definition at line 172 of file ParallelPlate.cpp.
References ElementBase::PARALLELPLATE.
|
overridevirtual |
Implements Component.
Definition at line 135 of file ParallelPlate.cpp.
References ElementBase::getElementLength(), length_m, and Component::RefPartBunch_m.
|
virtual |
Definition at line 146 of file ParallelPlate.cpp.
References endl(), Physics::pi, and Component::RefPartBunch_m.
|
private |
void ParallelPlate::setAmplitude | ( | double | vPeak | ) |
Definition at line 79 of file ParallelPlate.cpp.
References scale_m.
Referenced by OpalParallelPlate::update().
void ParallelPlate::setFrequency | ( | double | freq | ) |
Definition at line 87 of file ParallelPlate.cpp.
References frequency_m.
Referenced by OpalParallelPlate::update().
void ParallelPlate::setPhase | ( | double | phase | ) |
Definition at line 95 of file ParallelPlate.cpp.
References phase_m.
Referenced by OpalParallelPlate::update().
|
private |
The name of the inputfile
Definition at line 87 of file ParallelPlate.h.
|
private |
Read in frequency of time varying field(MHz)
Definition at line 91 of file ParallelPlate.h.
Referenced by applyToReferenceParticle(), getFrequency(), and setFrequency().
|
private |
Read in distance/length of Parallel Plate
Definition at line 92 of file ParallelPlate.h.
Referenced by applyToReferenceParticle(), getDimensions(), and initialise().
|
private |
phase shift of time varying field(degrees)
Definition at line 90 of file ParallelPlate.h.
Referenced by applyToReferenceParticle(), getPhase(), and setPhase().
|
private |
Definition at line 93 of file ParallelPlate.h.
Referenced by applyToReferenceParticle().
|
private |
scale multiplier
Definition at line 89 of file ParallelPlate.h.
Referenced by applyToReferenceParticle(), getAmplitude(), and setAmplitude().