OPAL (Object Oriented Parallel Accelerator Library) 2022.1
OPAL
|
#include <Vacuum.h>
Public Member Functions | |
Vacuum (const std::string &name) | |
Constructor with given name. More... | |
Vacuum () | |
Vacuum (const Vacuum &rhs) | |
virtual | ~Vacuum () |
virtual void | accept (BeamlineVisitor &) const override |
Apply visitor to Vacuum. More... | |
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 |
virtual bool | checkVacuum (PartBunchBase< double, 3 > *bunch, Cyclotron *cycl) |
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 |
virtual void | goOnline (const double &kineticEnergy) override |
virtual void | goOffline () override |
virtual ElementType | getType () const override |
Get element type std::string. More... | |
virtual void | getDimensions (double &zBegin, double &zEnd) const override |
bool | checkPoint (const Vector_t &R) |
double | checkPressure (const Vector_t &R) |
void | setResidualGas (std::string gas) |
ResidualGas | getResidualGas () const |
std::string | getResidualGasName () |
void | setPressure (double pressure) |
double | getPressure () const |
void | setPressureMapFN (std::string pmapfn) |
std::string | getPressureMapFN () const |
void | setPScale (double ps) |
double | getPScale () const |
void | setTemperature (double temperature) |
double | getTemperature () const |
void | setStop (bool stopflag) |
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 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... | |
Protected Member Functions | |
void | initR (double rmin, double dr, int nrad) |
void | getPressureFromFile () |
int | idx (int irad, int ktet) |
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 | |
PFieldData | PField_m |
PPositions | PP_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 |
Private Member Functions | |
void | operator= (const Vacuum &) |
void | updateParticleAttributes () |
void | print () |
Private Attributes | |
ParticleMatterInteractionHandler * | parmatint_m |
mm More... | |
ResidualGas | gas_m |
parameters for Vacuum More... | |
double | pressure_m |
Type of gas for residual vacuum. More... | |
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... | |
bool | stop_m |
K. More... | |
double | minr_m |
Flag if particles should be stripped or stopped. More... | |
double | maxr_m |
mm More... | |
double | minz_m |
mm More... | |
double | maxz_m |
mm More... | |
Static Private Attributes | |
static const boost::bimap< ResidualGas, std::string > | bmResidualGasString_s |
Additional Inherited Members | |
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 |
|
explicit |
Vacuum::Vacuum | ( | ) |
Definition at line 55 of file Vacuum.cpp.
Vacuum::Vacuum | ( | const Vacuum & | rhs | ) |
Definition at line 60 of file Vacuum.cpp.
|
virtual |
Definition at line 92 of file Vacuum.cpp.
References goOffline(), and Component::online_m.
|
overridevirtual |
Apply visitor to Vacuum.
Implements ElementBase.
Definition at line 98 of file Vacuum.cpp.
References BeamlineVisitor::visitVacuum().
|
overridevirtual |
Reimplemented from Component.
Definition at line 192 of file Vacuum.cpp.
|
overridevirtual |
Reimplemented from Component.
Definition at line 196 of file Vacuum.cpp.
|
inlineoverridevirtual |
bool Vacuum::checkPoint | ( | const Vector_t & | R | ) |
Definition at line 179 of file Vacuum.cpp.
References ElementBase::getElementLength(), OpalData::getInstance(), maxz_m, minr_m, minz_m, Attrib::Distribution::R, and sqrt().
Referenced by checkVacuum().
double Vacuum::checkPressure | ( | const Vector_t & | R | ) |
Definition at line 298 of file Vacuum.cpp.
References atan(), PPositions::delr_m, PPositions::dtet_m, endl(), ElementBase::getName(), getPressure(), gmsg, idx(), level4(), PFieldData::nrad_m, PFieldData::ntetS_m, PField_m, PFieldData::pfld_m, Physics::pi, pmapfn_m, PP_m, Attrib::Distribution::R, matheval::detail::math::rad(), Units::rad2deg, PPositions::rmin_m, sqrt(), and Physics::two_pi.
Referenced by BeamStrippingPhysics::doPhysics().
|
virtual |
Definition at line 201 of file Vacuum.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(), gmsg, maxr_m, maxz_m, minr_m, minz_m, parmatint_m, ParticleMatterInteractionHandler::print(), PartBunchBase< T, Dim >::R, and reduce().
Referenced by ParallelCyclotronTracker::applyPluginElements().
|
overridevirtual |
Implements Component.
Definition at line 266 of file Vacuum.cpp.
References endl(), ElementBase::getName(), gmsg, goOffline(), and Component::online_m.
|
overridevirtual |
Implements Component.
Definition at line 289 of file Vacuum.cpp.
References ElementBase::getElementLength().
double Vacuum::getPressure | ( | ) | const |
Definition at line 128 of file Vacuum.cpp.
References pressure_m.
Referenced by checkPressure(), and ParallelCyclotronTracker::visitVacuum().
|
protected |
Definition at line 381 of file Vacuum.cpp.
References CHECK_VAC_FSCANF_EOF, PPositions::delr_m, PPositions::dtet_m, endl(), gmsg, idx(), Units::mm2m, PFieldData::nrad_m, PFieldData::ntet_m, PFieldData::ntetS_m, PFieldData::ntot_m, PPositions::Pfact_m, PField_m, PFieldData::pfld_m, pmapfn_m, PP_m, pscale_m, PPositions::rmin_m, and PPositions::tetmin_m.
Referenced by initialise().
std::string Vacuum::getPressureMapFN | ( | ) | const |
Definition at line 141 of file Vacuum.cpp.
References pmapfn_m.
Referenced by ParallelCyclotronTracker::visitVacuum().
double Vacuum::getPScale | ( | ) | const |
Definition at line 149 of file Vacuum.cpp.
References pscale_m.
Referenced by ParallelCyclotronTracker::visitVacuum().
ResidualGas Vacuum::getResidualGas | ( | ) | const |
Definition at line 111 of file Vacuum.cpp.
References gas_m.
Referenced by BeamStrippingPhysics::computeCrossSection(), and BeamStrippingPhysics::getSecondaryParticles().
std::string Vacuum::getResidualGasName | ( | ) |
Definition at line 115 of file Vacuum.cpp.
References bmResidualGasString_s, gas_m, and NOGAS.
Referenced by print(), BeamStrippingPhysics::print(), and ParallelCyclotronTracker::visitVacuum().
bool Vacuum::getStop | ( | ) | const |
Definition at line 175 of file Vacuum.cpp.
References stop_m.
Referenced by BeamStrippingPhysics::doPhysics(), and ParallelCyclotronTracker::visitVacuum().
double Vacuum::getTemperature | ( | ) | const |
Definition at line 162 of file Vacuum.cpp.
References temperature_m.
Referenced by BeamStrippingPhysics::doPhysics(), and ParallelCyclotronTracker::visitVacuum().
|
overridevirtual |
Get element type std::string.
Reimplemented from Component.
Definition at line 294 of file Vacuum.cpp.
References VACUUM.
|
overridevirtual |
Reimplemented from Component.
Definition at line 285 of file Vacuum.cpp.
References Component::online_m.
Referenced by finalise(), and ~Vacuum().
|
overridevirtual |
Reimplemented from Component.
Definition at line 272 of file Vacuum.cpp.
References Component::online_m.
Referenced by initialise().
|
inlineprotected |
Definition at line 127 of file Vacuum.h.
References PFieldData::ntetS_m, and PField_m.
Referenced by checkPressure(), and getPressureFromFile().
|
virtual |
Definition at line 242 of file Vacuum.cpp.
References PPositions::delr_m, ElementBase::getParticleMatterInteraction(), getPressureFromFile(), goOnline(), initR(), PFieldData::nrad_m, parmatint_m, PField_m, pmapfn_m, PP_m, Component::RefPartBunch_m, PPositions::rmin_m, and updateParticleAttributes().
|
overridevirtual |
Implements Component.
Definition at line 233 of file Vacuum.cpp.
References ElementBase::getElementLength(), initialise(), and print().
Referenced by initialise(), and ParallelCyclotronTracker::visitVacuum().
|
protected |
Definition at line 372 of file Vacuum.cpp.
References PPositions::delr_m, PP_m, and PPositions::rarr_m.
Referenced by initialise().
|
private |
|
private |
Definition at line 276 of file Vacuum.cpp.
References endl(), ParticleMatterInteractionHandler::getElement(), ElementBase::getName(), getResidualGasName(), ElementBase::getTypeString(), gmsg, level2(), parmatint_m, and pressure_m.
Referenced by initialise().
void Vacuum::setPressure | ( | double | pressure | ) |
Definition at line 124 of file Vacuum.cpp.
References pressure_m.
Referenced by OpalVacuum::update().
void Vacuum::setPressureMapFN | ( | std::string | pmapfn | ) |
void Vacuum::setPScale | ( | double | ps | ) |
void Vacuum::setResidualGas | ( | std::string | gas | ) |
Definition at line 102 of file Vacuum.cpp.
References bmResidualGasString_s, gas_m, and NOGAS.
Referenced by OpalVacuum::update().
void Vacuum::setStop | ( | bool | stopflag | ) |
void Vacuum::setTemperature | ( | double | temperature | ) |
Definition at line 158 of file Vacuum.cpp.
References temperature_m.
Referenced by OpalVacuum::update().
|
private |
Definition at line 259 of file Vacuum.cpp.
References Units::eV2GeV, PartBunchBase< T, Dim >::getLocalNum(), PartBunchBase< T, Dim >::getM(), PartBunchBase< T, Dim >::getQ(), PartBunchBase< T, Dim >::M, PartBunchBase< T, Dim >::Q, Physics::q_e, and Component::RefPartBunch_m.
Referenced by initialise().
|
staticprivate |
Definition at line 156 of file Vacuum.h.
Referenced by getResidualGasName(), and setResidualGas().
|
private |
parameters for Vacuum
Definition at line 139 of file Vacuum.h.
Referenced by getResidualGas(), getResidualGasName(), and setResidualGas().
|
private |
|
private |
|
private |
Flag if particles should be stripped or stopped.
size limits took from cyclotron
Definition at line 148 of file Vacuum.h.
Referenced by checkPoint(), and checkVacuum().
|
private |
|
private |
|
protected |
Definition at line 161 of file Vacuum.h.
Referenced by checkPressure(), getPressureFromFile(), idx(), and initialise().
|
private |
mbar
Definition at line 141 of file Vacuum.h.
Referenced by checkPressure(), getPressureFromFile(), getPressureMapFN(), initialise(), and setPressureMapFN().
|
protected |
Definition at line 164 of file Vacuum.h.
Referenced by checkPressure(), getPressureFromFile(), initialise(), and initR().
|
private |
Type of gas for residual vacuum.
Definition at line 140 of file Vacuum.h.
Referenced by getPressure(), print(), and setPressure().
|
private |
stores the filename of the pressure map
Definition at line 142 of file Vacuum.h.
Referenced by getPressureFromFile(), getPScale(), and setPScale().
|
private |
|
private |
a scale factor for the P-field
Definition at line 143 of file Vacuum.h.
Referenced by getTemperature(), and setTemperature().