#include <BeamStripping.h>
Public Member Functions | |
| BeamStripping (const std::string &name) | |
| Constructor with given name. More... | |
| BeamStripping () | |
| BeamStripping (const BeamStripping &rhs) | |
| virtual | ~BeamStripping () |
| virtual void | accept (BeamlineVisitor &) const |
| Apply visitor to BeamStripping. 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 | checkBeamStripping (PartBunchBase< double, 3 > *bunch, Cyclotron *cycl, const int turnnumber, const double t, const double tstep) |
| virtual bool | checkBeamStripping (Vector_t r, Vector_t rmin, Vector_t rmax) |
| virtual void | initialise (PartBunchBase< double, 3 > *bunch, double &startField, double &endField) |
| virtual void | initialise (PartBunchBase< double, 3 > *bunch, const double &scaleFactor) |
| virtual void | finalise () |
| virtual bool | bends () const |
| virtual void | goOnline (const double &kineticEnergy) |
| virtual void | goOffline () |
| virtual ElementBase::ElementType | getType () const |
| Get element type std::string. More... | |
| virtual void | getDimensions (double &zBegin, double &zEnd) const |
| std::string | getBeamStrippingShape () |
| int | checkPoint (const double &x, const double &y, const double &z) |
| double | checkPressure (const double &x, const double &y) |
| void | setPressure (double pressure) |
| double | getPressure () const |
| void | setTemperature (double temperature) |
| double | getTemperature () const |
| void | setPressureMapFN (std::string pmapfn) |
| virtual std::string | getPressureMapFN () const |
| void | setPScale (double ps) |
| virtual double | getPScale () const |
| void | setResidualGas (std::string gas) |
| virtual std::string | getResidualGas () const |
| void | setStop (bool stopflag) |
| virtual bool | getStop () 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 | 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 double | getDesignEnergy () const |
| virtual void | setDesignEnergy (const double &energy, bool changeable) |
| 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 &) |
| 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 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 Member Functions | |
| void | initR (double rmin, double dr, int nrad) |
| void | getPressureFromFile (const double &scaleFactor) |
| int | idx (int irad, int ktet) |
| Protected Member Functions inherited from ElementBase | |
| bool | isInsideTransverse (const Vector_t &r, double f=1) 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 | |
| PFieldData | PField |
| PPositions | PP |
| 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 |
Private Attributes | |
| ParticleMatterInteractionHandler * | parmatint_m |
| std::string | gas_m |
| parameters for BeamStripping More... | |
| double | pressure_m |
| std::string | pmapfn_m |
| mbar More... | |
| double | pscale_m |
| stores the filename of the pressure map More... | |
| double | temperature_m |
| a scale factor for the P-field More... | |
| double | stop_m |
| K. More... | |
| double | minr_m |
| size limits took from cyclotron More... | |
| double | maxr_m |
| mm More... | |
| double | minz_m |
| mm More... | |
| double | maxz_m |
| mm More... | |
Additional Inherited Members | |
| Public Types inherited from ElementBase | |
| enum | ApertureType { RECTANGULAR, ELLIPTICAL, CONIC_RECTANGULAR, CONIC_ELLIPTICAL } |
| enum | ElementType { ALIGNWRAPPER, BEAMBEAM, BEAMBEAM3D, BEAMLINE, BEAMSTRIPPING, CCOLLIMATOR, CORRECTOR, CORRECTORWRAPPER, CYCLOTRON, CYCLOTRONWRAPPER, CYCLOTRONVALLEY, DEGRADER, DIAGNOSTIC, DRIFT, FLEXIBLECOLLIMATOR, INTEGRATOR, LAMBERTSON, MARKER, MONITOR, MPSPLITINTEGRATOR, MULTIPOLE, MULTIPOLET, MULTIPOLEWRAPPER, OFFSET, PARALLELPLATE, PATCH, PROBE, RBEND, RBEND3D, RBENDWRAPPER, RFCAVITY, RFQUADRUPOLE, RING, SBEND3D, SBEND, SBENDWRAPPER, SEPARATOR, SEPTUM, SOLENOID, SOURCE, STRIPPER, TRAVELINGWAVE, VARIABLERFCAVITY, ANY } |
| Static Public Member Functions inherited from ElementBase | |
| static std::string | getTypeString (ElementType type) |
| Static Protected Attributes inherited from Component | |
| static const std::vector< double > | defaultAperture_m |
Detailed Description
Definition at line 59 of file BeamStripping.h.
Constructor & Destructor Documentation
|
explicit |
Constructor with given name.
Definition at line 76 of file BeamStripping.cpp.
| BeamStripping::BeamStripping | ( | ) |
Definition at line 56 of file BeamStripping.cpp.
| BeamStripping::BeamStripping | ( | const BeamStripping & | rhs | ) |
Definition at line 61 of file BeamStripping.cpp.
|
virtual |
Definition at line 92 of file BeamStripping.cpp.
References goOffline(), and Component::online_m.
Member Function Documentation
|
virtual |
Apply visitor to BeamStripping.
Implements ElementBase.
Definition at line 97 of file BeamStripping.cpp.
References BeamlineVisitor::visitBeamStripping().
|
virtual |
Reimplemented from Component.
Definition at line 164 of file BeamStripping.cpp.
|
virtual |
Reimplemented from Component.
Definition at line 168 of file BeamStripping.cpp.
|
virtual |
Implements Component.
Definition at line 253 of file BeamStripping.cpp.
|
virtual |
Definition at line 179 of file BeamStripping.cpp.
References ParticleMatterInteractionHandler::apply(), PartBunchBase< T, Dim >::Bin, checkPoint(), euclidean_norm(), PartBunchBase< T, Dim >::get_bounds(), PartBunchBase< T, Dim >::getLocalNum(), Cyclotron::getMaxR(), Cyclotron::getMaxZ(), Cyclotron::getMinR(), Cyclotron::getMinZ(), maxr_m, maxz_m, minr_m, minz_m, parmatint_m, PartBunchBase< T, Dim >::R, and reduce().
Referenced by ParallelCyclotronTracker::applyPluginElements().
Definition at line 173 of file BeamStripping.cpp.
References checkPoint().
| int BeamStripping::checkPoint | ( | const double & | x, |
| const double & | y, | ||
| const double & | z | ||
| ) |
Definition at line 268 of file BeamStripping.cpp.
References maxr_m, maxz_m, minr_m, and sqrt().
Referenced by checkBeamStripping().
| double BeamStripping::checkPressure | ( | const double & | x, |
| const double & | y | ||
| ) |
Definition at line 279 of file BeamStripping.cpp.
References atan(), PPositions::delr, PPositions::dtet, fmod(), getPressure(), idx(), PFieldData::nrad, PFieldData::ntetS, PField, PFieldData::pfld, pi, pmapfn_m, PP, matheval::detail::math::rad(), PPositions::rmin, and sqrt().
|
virtual |
Implements Component.
Definition at line 240 of file BeamStripping.cpp.
References endl(), goOffline(), and Component::online_m.
| std::string BeamStripping::getBeamStrippingShape | ( | ) |
Definition at line 263 of file BeamStripping.cpp.
|
virtual |
Implements Component.
Definition at line 257 of file BeamStripping.cpp.
| double BeamStripping::getPressure | ( | ) | const |
Definition at line 105 of file BeamStripping.cpp.
References pressure_m.
Referenced by checkPressure(), and ParallelCyclotronTracker::visitBeamStripping().
|
protected |
Definition at line 358 of file BeamStripping.cpp.
References CHECK_BSTP_FSCANF_EOF, PPositions::delr, PPositions::dtet, endl(), idx(), PFieldData::nrad, PFieldData::ntet, PFieldData::ntetS, PFieldData::ntot, PPositions::Pfact, PField, PFieldData::pfld, pmapfn_m, PP, PPositions::rmin, and PPositions::tetmin.
Referenced by initialise().
|
virtual |
Definition at line 131 of file BeamStripping.cpp.
References pmapfn_m.
Referenced by ParallelCyclotronTracker::visitBeamStripping().
|
virtual |
Definition at line 139 of file BeamStripping.cpp.
References pscale_m.
Referenced by ParallelCyclotronTracker::visitBeamStripping().
|
virtual |
Definition at line 147 of file BeamStripping.cpp.
References gas_m.
Referenced by BeamStrippingPhysics::BeamStrippingPhysics(), and ParallelCyclotronTracker::visitBeamStripping().
|
virtual |
Definition at line 160 of file BeamStripping.cpp.
References stop_m.
Referenced by BeamStrippingPhysics::doPhysics(), and ParallelCyclotronTracker::visitBeamStripping().
| double BeamStripping::getTemperature | ( | ) | const |
Definition at line 118 of file BeamStripping.cpp.
References temperature_m.
Referenced by BeamStrippingPhysics::crossSection(), and ParallelCyclotronTracker::visitBeamStripping().
|
virtual |
Get element type std::string.
Reimplemented from Component.
Definition at line 259 of file BeamStripping.cpp.
References ElementBase::BEAMSTRIPPING.
|
virtual |
Reimplemented from Component.
Definition at line 249 of file BeamStripping.cpp.
References Component::online_m.
Referenced by finalise(), and ~BeamStripping().
|
virtual |
Reimplemented from Component.
Definition at line 246 of file BeamStripping.cpp.
Referenced by initialise().
|
inlineprotected |
Definition at line 127 of file BeamStripping.h.
References PFieldData::ntetS, and PField.
Referenced by checkPressure(), and getPressureFromFile().
|
virtual |
Implements Component.
Definition at line 211 of file BeamStripping.cpp.
References ElementBase::getElementLength(), and pscale_m.
Referenced by ParallelCyclotronTracker::visitBeamStripping().
|
virtual |
Definition at line 216 of file BeamStripping.cpp.
References PartBunchBase< T, Dim >::Bin, PPositions::delr, PartBunchBase< T, Dim >::getLocalNum(), PartBunchBase< T, Dim >::getM(), ElementBase::getParticleMatterInteraction(), getPressureFromFile(), PartBunchBase< T, Dim >::getQ(), goOnline(), initR(), PartBunchBase< T, Dim >::M, PFieldData::nrad, parmatint_m, PField, pmapfn_m, PP, PartBunchBase< T, Dim >::Q, Physics::q_e, Component::RefPartBunch_m, PPositions::rmin, and PartBunchBase< T, Dim >::weHaveBins().
|
protected |
Definition at line 349 of file BeamStripping.cpp.
References PPositions::delr, PP, and PPositions::rarr.
Referenced by initialise().
| void BeamStripping::setPressure | ( | double | pressure | ) |
Definition at line 101 of file BeamStripping.cpp.
References pressure_m.
Referenced by OpalBeamStripping::update().
| void BeamStripping::setPressureMapFN | ( | std::string | pmapfn | ) |
Definition at line 127 of file BeamStripping.cpp.
References pmapfn_m.
Referenced by OpalBeamStripping::update().
| void BeamStripping::setPScale | ( | double | ps | ) |
Definition at line 135 of file BeamStripping.cpp.
References pscale_m.
Referenced by OpalBeamStripping::update().
| void BeamStripping::setResidualGas | ( | std::string | gas | ) |
Definition at line 143 of file BeamStripping.cpp.
References gas_m.
Referenced by OpalBeamStripping::update().
| void BeamStripping::setStop | ( | bool | stopflag | ) |
Definition at line 156 of file BeamStripping.cpp.
References stop_m.
Referenced by OpalBeamStripping::update().
| void BeamStripping::setTemperature | ( | double | temperature | ) |
Definition at line 114 of file BeamStripping.cpp.
References temperature_m.
Referenced by OpalBeamStripping::update().
Member Data Documentation
|
private |
parameters for BeamStripping
Definition at line 132 of file BeamStripping.h.
Referenced by getResidualGas(), and setResidualGas().
|
private |
mm
Definition at line 142 of file BeamStripping.h.
Referenced by checkBeamStripping(), and checkPoint().
|
private |
mm
Definition at line 144 of file BeamStripping.h.
Referenced by checkBeamStripping(), and checkPoint().
|
private |
size limits took from cyclotron
Definition at line 141 of file BeamStripping.h.
Referenced by checkBeamStripping(), and checkPoint().
|
private |
|
private |
mm
Definition at line 147 of file BeamStripping.h.
Referenced by checkBeamStripping(), and initialise().
|
protected |
Definition at line 151 of file BeamStripping.h.
Referenced by checkPressure(), getPressureFromFile(), idx(), and initialise().
|
private |
mbar
Definition at line 134 of file BeamStripping.h.
Referenced by checkPressure(), getPressureFromFile(), getPressureMapFN(), initialise(), and setPressureMapFN().
|
protected |
Definition at line 154 of file BeamStripping.h.
Referenced by checkPressure(), getPressureFromFile(), initialise(), and initR().
|
private |
Definition at line 133 of file BeamStripping.h.
Referenced by getPressure(), and setPressure().
|
private |
stores the filename of the pressure map
Definition at line 135 of file BeamStripping.h.
Referenced by getPScale(), initialise(), and setPScale().
|
private |
|
private |
a scale factor for the P-field
Definition at line 136 of file BeamStripping.h.
Referenced by getTemperature(), and setTemperature().
The documentation for this class was generated from the following files:
- src/Classic/AbsBeamline/BeamStripping.h
- src/Classic/AbsBeamline/BeamStripping.cpp
