#include <Stripper.h>
Inheritance diagram for Stripper:
Collaboration diagram for Stripper:
Public Member Functions | |
| Stripper (const std::string &name) | |
| Constructor with given name. More... | |
| Stripper () | |
| Stripper (const Stripper &) | |
| void | operator= (const Stripper &)=delete |
| virtual | ~Stripper () |
| virtual void | accept (BeamlineVisitor &) const override |
| Apply visitor to Stripper. More... | |
| virtual ElementBase::ElementType | getType () const override |
| Override implementation of PluginElement. More... | |
| void | setOPCharge (double charge) |
| Member variable access. More... | |
| double | getOPCharge () const |
| void | setOPMass (double mass) |
| double | getOPMass () const |
| void | setOPYield (double yield) |
| double | getOPYield () const |
| void | setStop (bool stopflag) |
| bool | getStop () const |
 Public Member Functions inherited from PluginElement | |
| PluginElement (const std::string &name) | |
| Constructor with given name. More... | |
| PluginElement () | |
| PluginElement (const PluginElement &) | |
| void | operator= (const PluginElement &)=delete |
| virtual | ~PluginElement () |
| void | setOutputFN (std::string fn) |
| Set output filename. More... | |
| std::string | getOutputFN () const |
| Get output filename. More... | |
| void | setDimensions (double xstart, double xend, double ystart, double yend) |
| Set dimensions and consistency checks. More... | |
| bool | check (PartBunchBase< double, 3 > *bunch, const int turnnumber, const double t, const double tstep) |
| int | checkPoint (const double &x, const double &y) const |
| Checks if coordinate is within element. More... | |
| void | save () |
| Save output. More... | |
| virtual void | initialise (PartBunchBase< double, 3 > *bunch, double &startField, double &endField) override |
| Pure virtual implementation of Component. More... | |
| void | initialise (PartBunchBase< double, 3 > *bunch) |
| virtual void | finalise () final |
| virtual void | goOffline () final |
| virtual bool | bends () const override |
| virtual void | getDimensions (double &zBegin, double &zEnd) const override |
| virtual bool | apply (const size_t &i, 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 |
| double | getXStart () const |
| Member variable access. More... | |
| double | getXEnd () const |
| double | getYStart () const |
| double | getYEnd () 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 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 void | goOnline (const double &kineticEnergy) |
| 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... | |
Private Member Functions | |
| virtual bool | doCheck (PartBunchBase< double, 3 > *bunch, const int turnnumber, const double t, const double tstep) override |
| Record hits when bunch particles pass. More... | |
| virtual void | doFinalise () override |
| Virtual hook for finalise. More... | |
| virtual bool | doPreCheck (PartBunchBase< double, 3 > *) override |
| Virtual hook for preCheck. More... | |
| virtual bool | doFinaliseCheck (PartBunchBase< double, 3 > *bunch, bool flagNeedUpdate) override |
| Virtual hook for finaliseCheck. More... | |
Private Attributes | |
| double | opcharge_m |
| Charge number of the out-coming particle. More... | |
| double | opmass_m |
| Mass of the out-coming particle. More... | |
| double | opyield_m |
| Yield of the out-coming particle. More... | |
| bool | stop_m |
| Flag if particles should be stripped or stopped. 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) |
| Protected Member Functions inherited from PluginElement | |
| void | setGeom (const double dist) |
| Sets geometry geom_m with element width dist. More... | |
| void | changeWidth (PartBunchBase< double, 3 > *bunch, int i, const double tstep, const double tangle) |
| Change probe width depending on step size and angle of particle. More... | |
| double | calculateIncidentAngle (double xp, double yp) const |
| Calculate angle of particle/bunch wrt to element. More... | |
| 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 inherited from PluginElement | |
| std::string | filename_m |
| double | position_m |
| double | rmin_m |
| radius closest to the origin More... | |
| Point | geom_m [5] |
| actual geometry positions with adaptive width such that each particle hits element once per turn More... | |
| double | A_m |
| double | B_m |
| double | R_m |
| double | C_m |
| Geometric lengths used in calculations. More... | |
| std::unique_ptr< LossDataSink > | lossDs_m |
| Pointer to Loss instance. More... | |
| int | numPassages_m = 0 |
| Number of turns (number of times save() method is called) More... | |
| double | xstart_m |
| input geometry positions More... | |
| double | xend_m |
| double | ystart_m |
| double | yend_m |
| double | rstart_m |
| double | rend_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 10 of file Stripper.h.
Constructor & Destructor Documentation
|
explicit |
Constructor with given name.
Definition at line 13 of file Stripper.cpp.
| Stripper::Stripper | ( | ) |
Definition at line 10 of file Stripper.cpp.
| Stripper::Stripper | ( | const Stripper & | right | ) |
Definition at line 21 of file Stripper.cpp.
|
virtual |
Definition at line 29 of file Stripper.cpp.
Member Function Documentation
|
overridevirtual |
Apply visitor to Stripper.
Implements ElementBase.
Definition at line 31 of file Stripper.cpp.
References BeamlineVisitor::visitStripper().
Here is the call graph for this function:
|
overrideprivatevirtual |
Record hits when bunch particles pass.
Implements PluginElement.
Definition at line 86 of file Stripper.cpp.
References PluginElement::A_m, PluginElement::B_m, PartBunchBase< T, Dim >::Bin, PartBunchBase< T, Dim >::bunchNum, Physics::c, PluginElement::C_m, PluginElement::calculateIncidentAngle(), PluginElement::changeWidth(), PluginElement::checkPoint(), PartBunchBase< T, Dim >::create(), dot(), Physics::e, endl(), PartBunchBase< T, Dim >::getLocalNum(), ElementBase::getName(), PartBunchBase< T, Dim >::ID, INFORM_ALL_NODES, level4(), PluginElement::lossDs_m, PartBunchBase< T, Dim >::M, opcharge_m, opmass_m, opyield_m, PartBunchBase< T, Dim >::P, PartBunchBase< T, Dim >::PType, PartBunchBase< T, Dim >::Q, Physics::q_e, PartBunchBase< T, Dim >::R, PluginElement::R_m, ParticleType::REGULAR, PartBunchBase< T, Dim >::setPType(), sqrt(), stop_m, ParticleType::STRIPPED, and PartBunchBase< T, Dim >::weHaveBins().
Here is the call graph for this function:
|
overrideprivatevirtual |
Virtual hook for finalise.
Reimplemented from PluginElement.
Definition at line 35 of file Stripper.cpp.
References endl(), and ElementBase::getName().
Here is the call graph for this function:
|
overrideprivatevirtual |
Virtual hook for finaliseCheck.
Reimplemented from PluginElement.
Definition at line 150 of file Stripper.cpp.
References PartBunchBase< T, Dim >::getPType(), opcharge_m, opmass_m, reduce(), PartBunchBase< T, Dim >::resetM(), PartBunchBase< T, Dim >::resetQ(), stop_m, and ParticleType::STRIPPED.
Here is the call graph for this function:
|
overrideprivatevirtual |
Virtual hook for preCheck.
Reimplemented from PluginElement.
Definition at line 71 of file Stripper.cpp.
References abs(), PartBunchBase< T, Dim >::get_bounds(), max(), and PluginElement::rmin_m.
Here is the call graph for this function:
| double Stripper::getOPCharge | ( | ) | const |
Definition at line 55 of file Stripper.cpp.
References opcharge_m.
Referenced by ParallelCyclotronTracker::visitStripper().
| double Stripper::getOPMass | ( | ) | const |
Definition at line 59 of file Stripper.cpp.
References opmass_m.
Referenced by ParallelCyclotronTracker::visitStripper().
| double Stripper::getOPYield | ( | ) | const |
Definition at line 63 of file Stripper.cpp.
References opyield_m.
| bool Stripper::getStop | ( | ) | const |
Definition at line 67 of file Stripper.cpp.
References stop_m.
Referenced by ParallelCyclotronTracker::visitStripper().
|
overridevirtual |
Override implementation of PluginElement.
Reimplemented from Component.
Definition at line 164 of file Stripper.cpp.
References ElementBase::STRIPPER.
|
delete |
| void Stripper::setOPCharge | ( | double | charge | ) |
Member variable access.
Definition at line 39 of file Stripper.cpp.
References opcharge_m.
Referenced by OpalStripper::update().
| void Stripper::setOPMass | ( | double | mass | ) |
Definition at line 43 of file Stripper.cpp.
References opmass_m.
Referenced by OpalStripper::update().
| void Stripper::setOPYield | ( | double | yield | ) |
Definition at line 47 of file Stripper.cpp.
References opyield_m.
Referenced by OpalStripper::update().
| void Stripper::setStop | ( | bool | stopflag | ) |
Definition at line 51 of file Stripper.cpp.
References stop_m.
Referenced by OpalStripper::update().
Member Data Documentation
|
private |
Charge number of the out-coming particle.
Definition at line 48 of file Stripper.h.
Referenced by doCheck(), doFinaliseCheck(), getOPCharge(), and setOPCharge().
|
private |
Mass of the out-coming particle.
Definition at line 49 of file Stripper.h.
Referenced by doCheck(), doFinaliseCheck(), getOPMass(), and setOPMass().
|
private |
Yield of the out-coming particle.
Definition at line 50 of file Stripper.h.
Referenced by doCheck(), getOPYield(), and setOPYield().
|
private |
Flag if particles should be stripped or stopped.
Definition at line 51 of file Stripper.h.
Referenced by doCheck(), doFinaliseCheck(), getStop(), and setStop().
The documentation for this class was generated from the following files:
- src/Classic/AbsBeamline/Stripper.h
- src/Classic/AbsBeamline/Stripper.cpp
