OPAL (Object Oriented Parallel Accelerator Library) 2024.2
OPAL
Classes | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
Cyclotron Class Referenceabstract

#include <Cyclotron.h>

Inheritance diagram for Cyclotron:
Inheritance graph
[legend]
Collaboration diagram for Cyclotron:
Collaboration graph
[legend]

Classes

struct  RFPhaseCache
 

Public Types

enum class  BFieldType : unsigned short {
  NONE , PSIBF , CARBONBF , ANSYSBF ,
  AVFEQBF , FFABF , BANDRF , SYNCHRO
}
 

Public Member Functions

 Cyclotron (const std::string &name)
 Constructor with given name.
 
 Cyclotron ()
 
 Cyclotron (const Cyclotron &)
 
virtual ~Cyclotron ()
 
virtual void accept (BeamlineVisitor &) const
 Apply visitor to Cyclotron.
 
virtual double getSlices () const =0
 Get number of slices.
 
virtual double getStepsize () const =0
 Get stepsize.
 
void setFieldMapFN (const std::string &fmapfn)
 
virtual std::string getFieldMapFN () const
 
void setRfFieldMapFN (std::vector< std::string > rffmapfn)
 
void setRFFCoeffFN (std::vector< std::string > rff_coeff_fn)
 
void setRFVCoeffFN (std::vector< std::string > rfv_coeff_fn)
 
void setCyclotronType (const std::string &type)
 
const std::string & getCyclotronType () const
 
void setBFieldType ()
 
BFieldType getBFieldType () const
 
virtual ElementType getType () const
 Get element type std::string.
 
virtual void getDimensions (double &zBegin, double &zEnd) const
 
unsigned int getNumberOfTrimcoils () const
 
void setCyclHarm (double h)
 
virtual double getCyclHarm () const
 
void setRfPhi (std::vector< double > f)
 
virtual std::vector< double > getRfPhi () const
 
void setRfFrequ (std::vector< double > f)
 
virtual std::vector< double > getRfFrequ () const
 
void setSymmetry (double symmetry)
 
virtual double getSymmetry () const
 
void setRinit (double rinit)
 
virtual double getRinit () const
 
void setPRinit (double prinit)
 
virtual double getPRinit () const
 
void setPHIinit (double phiinit)
 
virtual double getPHIinit () const
 
void setZinit (double zinit)
 
virtual double getZinit () const
 
void setPZinit (double zinit)
 
virtual double getPZinit () const
 
void setBScale (double bs)
 
virtual double getBScale () const
 
void setEScale (std::vector< double > bs)
 
virtual std::vector< double > getEScale () const
 
void setTrimCoils (const std::vector< TrimCoil * > &trimcoils)
 
void setSuperpose (std::vector< bool > flag)
 
virtual std::vector< bool > getSuperpose () const
 
void setMinR (double r)
 
virtual double getMinR () const
 
void setMaxR (double r)
 
virtual double getMaxR () const
 
void setMinZ (double z)
 
virtual double getMinZ () const
 
void setMaxZ (double z)
 
virtual double getMaxZ () const
 
void setFMLowE (double e)
 
virtual double getFMLowE () const
 
void setFMHighE (double e)
 
virtual double getFMHighE () const
 
void setTrimCoilThreshold (double)
 
virtual double getTrimCoilThreshold () const
 
void setSpiralFlag (bool spiral_flag)
 
virtual bool getSpiralFlag () const
 
void setTurnNumber (int turn)
 Turn number written into the loss records of apply(); the tracker sets it every step.
 
virtual bool apply (const size_t &id, 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 void apply (const double &rad, const double &z, const double &tet_rad, double &br, double &bt, double &bz)
 
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 double getRmax () const
 
virtual double getRmin () const
 
bool interpolate (const double &rad, const double &tet_rad, double &br, double &bt, double &bz)
 
void read (const double &scaleFactor)
 
void writeOutputFieldFiles ()
 
void checkInitialReferenceParticle (double refR, double refTheta, double refZ)
 
- Public Member Functions inherited from Component
 Component (const std::string &name)
 Constructor with given name.
 
 Component ()
 
 Component (const Component &right)
 
virtual ~Component ()
 
virtual EMField & getField ()=0
 Return field.
 
virtual const EMField & getField () const =0
 Return field.
 
EVector Efield (const Point3D &P) const
 Return the field in a point.
 
BVector Bfield (const Point3D &P) const
 Return the field in a point.
 
EVector Efield (const Point3D &P, double t) const
 Return the field in a point.
 
BVector Bfield (const Point3D &P, double t) const
 Return the field in a point.
 
EBVectors EBfield (const Point3D &P) const
 Return the field in a point.
 
EBVectors EBfield (const Point3D &P, double t) const
 Return the field in a point.
 
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 goOnline (const double &kineticEnergy)
 
virtual void goOffline ()
 
virtual bool Online ()
 
virtual const ElementBase & getDesign () const
 Return design element.
 
virtual void trackBunch (PartBunchBase< double, 3 > *bunch, const PartData &, bool revBeam, bool revTrack) const
 Track particle bunch.
 
virtual void trackMap (FVps< double, 6 > &map, const PartData &, bool revBeam, bool revTrack) const
 Track a map.
 
void setExitFaceSlope (const double &)
 
- Public Member Functions inherited from ElementBase
 ElementBase (const std::string &name)
 Constructor with given name.
 
 ElementBase ()
 
 ElementBase (const ElementBase &)
 
virtual ~ElementBase ()
 
virtual const std::string & getName () const
 Get element name.
 
virtual void setName (const std::string &name)
 Set element name.
 
std::string getTypeString () const
 
virtual BGeometryBase & getGeometry ()=0
 Get geometry.
 
virtual const BGeometryBase & getGeometry () const =0
 Get geometry.
 
virtual double getArcLength () const
 Get arc length.
 
virtual double getElementLength () const
 Get design length.
 
virtual void setElementLength (double length)
 Set design length.
 
virtual void getElementDimensions (double &begin, double &end) const
 
virtual double getOrigin () const
 Get origin position.
 
virtual double getEntrance () const
 Get entrance position.
 
virtual double getExit () const
 Get exit position.
 
virtual Euclid3D getTransform (double fromS, double toS) const
 Get transform.
 
virtual Euclid3D getTransform (double s) const
 Get transform.
 
virtual Euclid3D getTotalTransform () const
 Get transform.
 
virtual Euclid3D getEntranceFrame () const
 Get transform.
 
virtual Euclid3D getExitFrame () const
 Get transform.
 
virtual Euclid3D getEntrancePatch () const
 Get patch.
 
virtual Euclid3D getExitPatch () const
 Get patch.
 
virtual double getAttribute (const std::string &aKey) const
 Get attribute value.
 
virtual bool hasAttribute (const std::string &aKey) const
 Test for existence of an attribute.
 
virtual void removeAttribute (const std::string &aKey)
 Remove an existing attribute.
 
virtual void setAttribute (const std::string &aKey, double val)
 Set value of an attribute.
 
virtual Channel * getChannel (const std::string &aKey, bool create=false)
 Construct a read/write channel.
 
virtual const ConstChannel * getConstChannel (const std::string &aKey) const
 Construct a read-only channel.
 
virtual ElementBase * clone () const =0
 Return clone.
 
virtual ElementBase * copyStructure ()
 Make a structural copy.
 
bool isSharable () const
 Test if the element can be shared.
 
virtual void makeSharable ()
 Set sharable flag.
 
bool update (const AttributeSet &)
 Update element.
 
virtual void setBoundaryGeometry (BoundaryGeometry *geo)
 
virtual BoundaryGeometry * getBoundaryGeometry () const
 return the attached boundary geometrt object if there is any
 
virtual bool hasBoundaryGeometry () const
 
virtual void setWake (WakeFunction *wf)
 attach a wake field to the element
 
virtual WakeFunction * getWake () const
 return the attached wake object if there is any
 
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.
 
double getRotationAboutZ () const
 
virtual BoundingBox getBoundingBoxInLabCoords () const
 
virtual int getRequiredNumberOfTimeSteps () const
 
void setOutputFN (std::string fn)
 Set output filename.
 
std::string getOutputFN () const
 Get output filename.
 
void setFlagDeleteOnTransverseExit (bool=true)
 
bool getFlagDeleteOnTransverseExit () const
 
void setElementPosition (double elemedge)
 Access to ELEMEDGE attribute.
 
double getElementPosition () const
 
bool isElementPositionSet () const
 
- Public Member Functions inherited from RCObject
int addReference () const
 Increment reference count.
 
int removeReference () const
 Decrement the reference count.
 
bool isShared () const
 Test for sharing.
 

Protected Member Functions

void getdiffs ()
 
double gutdf5d (double *f, double dx, const int kor, const int krl, const int lpr)
 
void initR (double rmin, double dr, int nrad)
 
void getFieldFromFile_Ring (const double &scaleFactor)
 
void getFieldFromFile_Carbon (const double &scaleFactor)
 
void getFieldFromFile_CYCIAE (const double &scaleFactor)
 
void getFieldFromFile_AVFEQ (const double &scaleFactor)
 
void getFieldFromFile_FFA (const double &scaleFactor)
 
void getFieldFromFile_BandRF (const double &scaleFactor)
 
void getFieldFromFile_Synchrocyclotron (const double &scaleFactor)
 
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.
 
 RCObject (const RCObject &)
 Copy constructor.
 
virtual ~RCObject ()=0
 
RCObject & operator= (const RCObject &right)
 

Protected Attributes

BfieldData Bfield_m
 
BPositions BP_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 applyTrimCoil (const double r, const double z, const double tet_rad, double &br, double &bz)
 Apply trim coils (calculate field contributions) with smooth field transition.
 
void applyTrimCoil_m (const double r, const double z, const double tet_rad, double *br, double *bz)
 Apply trim coils (calculate field contributions)
 
void operator= (const Cyclotron &)=delete
 
bool midplaneMapInterior (const Vector_t &R) const
 
void rfPhase (std::size_t map, double t, double frequency, double phi, double &cosPhase, double &sinPhase)
 

Private Attributes

BFieldType fieldType_m
 
std::string fmapfn_m
 
std::vector< double > rffrequ_m
 
std::vector< std::vector< double > > rffc_m
 
std::vector< double > rfvrequ_m
 
std::vector< std::vector< double > > rfvc_m
 
std::vector< double > rfphi_m
 
std::vector< double > escale_m
 
std::vector< bool > superpose_m
 
double symmetry_m
 
double rinit_m
 
double prinit_m
 
double phiinit_m
 
double zinit_m
 
double pzinit_m
 
bool spiralFlag_m
 
double trimCoilThreshold_m
 
std::string typeName_m
 
double harm_m
 
double bscale_m
 
std::vector< TrimCoil * > trimcoils_m
 
double minr_m
 
double maxr_m
 
double minz_m
 
double maxz_m
 
double fmLowE_m
 
double fmHighE_m
 
std::vector< Fieldmap > RFfields_m
 
std::vector< std::string > RFfilename_m
 
std::vector< std::string > RFFCoeff_fn_m
 
std::vector< std::string > RFVCoeff_fn_m
 
std::unique_ptr< LossDataSink > lossDs_m
 
int turnNumber_m = 0
 
int waitingGap_m = 1
 
bool midplaneMapIsZero_m = false
 
std::vector< RFPhaseCache > rfPhaseCache_m
 

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
 

Detailed Description

Definition at line 84 of file Cyclotron.h.

Member Enumeration Documentation

◆ BFieldType

enum class Cyclotron::BFieldType : unsigned short
strong
Enumerator
NONE 
PSIBF 
CARBONBF 
ANSYSBF 
AVFEQBF 
FFABF 
BANDRF 
SYNCHRO 

Definition at line 87 of file Cyclotron.h.

Constructor & Destructor Documentation

◆ Cyclotron() [1/3]

Cyclotron::Cyclotron ( const std::string &  name)
explicit

Constructor with given name.

Definition at line 91 of file Cyclotron.cpp.

◆ Cyclotron() [2/3]

Cyclotron::Cyclotron ( )

Definition at line 56 of file Cyclotron.cpp.

◆ Cyclotron() [3/3]

Cyclotron::Cyclotron ( const Cyclotron &  right)

Definition at line 60 of file Cyclotron.cpp.

◆ ~Cyclotron()

Cyclotron::~Cyclotron ( )
virtual

Definition at line 95 of file Cyclotron.cpp.

Member Function Documentation

◆ accept()

void Cyclotron::accept ( BeamlineVisitor &  visitor) const
virtual

Apply visitor to Cyclotron.

Implements ElementBase.

Definition at line 163 of file Cyclotron.cpp.

References BeamlineVisitor::visitCyclotron().

Here is the call graph for this function:

◆ apply() [1/3]

void Cyclotron::apply ( const double &  rad,
const double &  z,
const double &  tet_rad,
double &  br,
double &  bt,
double &  bz 
)
virtual

Definition at line 650 of file Cyclotron.cpp.

References applyTrimCoil(), and interpolate().

Here is the call graph for this function:

◆ apply() [2/3]

bool Cyclotron::apply ( const size_t &  id,
const double &  t,
Vector_t &  E,
Vector_t &  B 
)
virtual

◆ apply() [3/3]

bool Cyclotron::apply ( const Vector_t &  R,
const Vector_t &  P,
const double &  t,
Vector_t &  E,
Vector_t &  B 
)
virtual

◆ applyTrimCoil()

void Cyclotron::applyTrimCoil ( const double  r,
const double  z,
const double  tet_rad,
double &  br,
double &  bz 
)
private

Apply trim coils (calculate field contributions) with smooth field transition.

Definition at line 107 of file Cyclotron.cpp.

References applyTrimCoil_m(), and trimCoilThreshold_m.

Referenced by apply(), and apply().

Here is the call graph for this function:

◆ applyTrimCoil_m()

void Cyclotron::applyTrimCoil_m ( const double  r,
const double  z,
const double  tet_rad,
double *  br,
double *  bz 
)
private

Apply trim coils (calculate field contributions)

Definition at line 99 of file Cyclotron.cpp.

References trimcoils_m.

Referenced by applyTrimCoil().

◆ bends()

bool Cyclotron::bends ( ) const
virtual

Implements Component.

Definition at line 663 of file Cyclotron.cpp.

◆ checkInitialReferenceParticle()

void Cyclotron::checkInitialReferenceParticle ( double  refR,
double  refTheta,
double  refZ 
)

Definition at line 445 of file Cyclotron.cpp.

References Util::angleBetweenAngles(), maxr_m, maxz_m, and Physics::pi.

Referenced by ParallelCyclotronTracker::visitCyclotron().

Here is the call graph for this function:

◆ finalise()

void Cyclotron::finalise ( )
virtual

Implements Component.

Definition at line 657 of file Cyclotron.cpp.

References endl(), ElementBase::getName(), gmsg, lossDs_m, and Component::online_m.

Here is the call graph for this function:

◆ getBFieldType()

Cyclotron::BFieldType Cyclotron::getBFieldType ( ) const

Definition at line 441 of file Cyclotron.cpp.

References fieldType_m.

Referenced by ParallelCyclotronTracker::visitCyclotron().

◆ getBScale()

double Cyclotron::getBScale ( ) const
virtual

◆ getCyclHarm()

double Cyclotron::getCyclHarm ( ) const
virtual

◆ getCyclotronType()

const std::string & Cyclotron::getCyclotronType ( ) const

Definition at line 311 of file Cyclotron.cpp.

References typeName_m.

Referenced by ParallelCyclotronTracker::visitCyclotron().

◆ getdiffs()

void Cyclotron::getdiffs ( )
protected

◆ getDimensions()

void Cyclotron::getDimensions ( double &  zBegin,
double &  zEnd 
) const
virtual

Implements Component.

Definition at line 1611 of file Cyclotron.cpp.

◆ getEScale()

std::vector< double > Cyclotron::getEScale ( ) const
virtual

Definition at line 335 of file Cyclotron.cpp.

References escale_m.

Referenced by ParallelCyclotronTracker::visitCyclotron().

◆ getFieldFromFile_AVFEQ()

void Cyclotron::getFieldFromFile_AVFEQ ( const double &  scaleFactor)
protected

◆ getFieldFromFile_BandRF()

void Cyclotron::getFieldFromFile_BandRF ( const double &  scaleFactor)
protected

Definition at line 1522 of file Cyclotron.cpp.

References endl(), getFieldFromFile_Carbon(), _Fieldmap::getFieldmap(), gmsg, RFfields_m, and RFfilename_m.

Referenced by read().

Here is the call graph for this function:

◆ getFieldFromFile_Carbon()

void Cyclotron::getFieldFromFile_Carbon ( const double &  scaleFactor)
protected

◆ getFieldFromFile_CYCIAE()

void Cyclotron::getFieldFromFile_CYCIAE ( const double &  scaleFactor)
protected

◆ getFieldFromFile_FFA()

void Cyclotron::getFieldFromFile_FFA ( const double &  scaleFactor)
protected

◆ getFieldFromFile_Ring()

void Cyclotron::getFieldFromFile_Ring ( const double &  scaleFactor)
protected

◆ getFieldFromFile_Synchrocyclotron()

void Cyclotron::getFieldFromFile_Synchrocyclotron ( const double &  scaleFactor)
protected

Definition at line 1536 of file Cyclotron.cpp.

References CHECK_CYC_FSCANF_EOF, endl(), getFieldFromFile_Carbon(), _Fieldmap::getFieldmap(), gmsg, rffc_m, RFFCoeff_fn_m, RFfields_m, RFfilename_m, rfvc_m, and RFVCoeff_fn_m.

Referenced by read().

Here is the call graph for this function:

◆ getFieldMapFN()

std::string Cyclotron::getFieldMapFN ( ) const
virtual

◆ getFMHighE()

double Cyclotron::getFMHighE ( ) const
virtual

◆ getFMLowE()

double Cyclotron::getFMLowE ( ) const
virtual

◆ getMaxR()

double Cyclotron::getMaxR ( ) const
virtual

Definition at line 377 of file Cyclotron.cpp.

References maxr_m, and minr_m.

Referenced by Vacuum::checkVacuum(), and ParallelCyclotronTracker::visitCyclotron().

◆ getMaxZ()

double Cyclotron::getMaxZ ( ) const
virtual

Definition at line 398 of file Cyclotron.cpp.

References maxz_m, and minz_m.

Referenced by Vacuum::checkVacuum(), and ParallelCyclotronTracker::visitCyclotron().

◆ getMinR()

double Cyclotron::getMinR ( ) const
virtual

Definition at line 368 of file Cyclotron.cpp.

References minr_m.

Referenced by Vacuum::checkVacuum(), and ParallelCyclotronTracker::visitCyclotron().

◆ getMinZ()

double Cyclotron::getMinZ ( ) const
virtual

Definition at line 390 of file Cyclotron.cpp.

References minz_m.

Referenced by Vacuum::checkVacuum(), and ParallelCyclotronTracker::visitCyclotron().

◆ getNumberOfTrimcoils()

unsigned int Cyclotron::getNumberOfTrimcoils ( ) const

Definition at line 344 of file Cyclotron.cpp.

References trimcoils_m.

Referenced by ParallelCyclotronTracker::visitCyclotron().

◆ getPHIinit()

double Cyclotron::getPHIinit ( ) const
virtual

◆ getPRinit()

double Cyclotron::getPRinit ( ) const
virtual

Definition at line 179 of file Cyclotron.cpp.

References prinit_m.

Referenced by ParallelCyclotronTracker::visitCyclotron().

◆ getPZinit()

double Cyclotron::getPZinit ( ) const
virtual

Definition at line 203 of file Cyclotron.cpp.

References pzinit_m.

Referenced by ParallelCyclotronTracker::visitCyclotron().

◆ getRfFrequ()

std::vector< double > Cyclotron::getRfFrequ ( ) const
virtual

Definition at line 274 of file Cyclotron.cpp.

References rffrequ_m.

Referenced by ParallelCyclotronTracker::visitCyclotron().

◆ getRfPhi()

std::vector< double > Cyclotron::getRfPhi ( ) const
virtual

Definition at line 261 of file Cyclotron.cpp.

References rfphi_m.

Referenced by ParallelCyclotronTracker::visitCyclotron().

◆ getRinit()

double Cyclotron::getRinit ( ) const
virtual

Definition at line 171 of file Cyclotron.cpp.

References rinit_m.

Referenced by ParallelCyclotronTracker::visitCyclotron().

◆ getRmax()

double Cyclotron::getRmax ( ) const
virtual

◆ getRmin()

double Cyclotron::getRmin ( ) const
virtual

Definition at line 352 of file Cyclotron.cpp.

References BP_m, and BPositions::rmin_m.

Referenced by ParallelCyclotronTracker::visitCyclotron().

◆ getSlices()

virtual double Cyclotron::getSlices ( ) const
pure virtual

Get number of slices.

Implemented in CyclotronRep.

◆ getSpiralFlag()

bool Cyclotron::getSpiralFlag ( ) const
virtual

Definition at line 219 of file Cyclotron.cpp.

References spiralFlag_m.

Referenced by ParallelCyclotronTracker::visitCyclotron().

◆ getStepsize()

virtual double Cyclotron::getStepsize ( ) const
pure virtual

Get stepsize.

Implemented in CyclotronRep.

◆ getSuperpose()

std::vector< bool > Cyclotron::getSuperpose ( ) const
virtual

Definition at line 287 of file Cyclotron.cpp.

References superpose_m.

Referenced by ParallelCyclotronTracker::visitCyclotron().

◆ getSymmetry()

double Cyclotron::getSymmetry ( ) const
virtual

◆ getTrimCoilThreshold()

double Cyclotron::getTrimCoilThreshold ( ) const
virtual

Definition at line 211 of file Cyclotron.cpp.

References trimCoilThreshold_m.

◆ getType()

ElementType Cyclotron::getType ( ) const
virtual

Get element type std::string.

Reimplemented from Component.

Definition at line 315 of file Cyclotron.cpp.

References CYCLOTRON.

◆ getZinit()

double Cyclotron::getZinit ( ) const
virtual

Definition at line 195 of file Cyclotron.cpp.

References zinit_m.

Referenced by ParallelCyclotronTracker::visitCyclotron().

◆ gutdf5d()

double Cyclotron::gutdf5d ( double *  f,
double  dx,
const int  kor,
const int  krl,
const int  lpr 
)
protected

Definition at line 668 of file Cyclotron.cpp.

Referenced by getdiffs().

◆ idx()

int Cyclotron::idx ( int  irad,
int  ktet 
)
inlineprotected

◆ initialise() [1/2]

void Cyclotron::initialise ( PartBunchBase< double, 3 > *  bunch,
const double &  scaleFactor 
)
virtual

Definition at line 1066 of file Cyclotron.cpp.

References Options::asciidump, ElementBase::getOutputFN(), lossDs_m, read(), and Component::RefPartBunch_m.

Here is the call graph for this function:

◆ initialise() [2/2]

void Cyclotron::initialise ( PartBunchBase< double, 3 > *  bunch,
double &  startField,
double &  endField 
)
virtual

Implements Component.

Definition at line 1061 of file Cyclotron.cpp.

References Component::online_m, and Component::RefPartBunch_m.

Referenced by ParallelCyclotronTracker::visitCyclotron().

◆ initR()

void Cyclotron::initR ( double  rmin,
double  dr,
int  nrad 
)
protected

Definition at line 1053 of file Cyclotron.cpp.

References BP_m, BPositions::delr_m, and BPositions::rarr_m.

Referenced by read().

◆ interpolate()

bool Cyclotron::interpolate ( const double &  rad,
const double &  tet_rad,
double &  br,
double &  bt,
double &  bz 
)

◆ midplaneMapInterior()

bool Cyclotron::midplaneMapInterior ( const Vector_t &  R) const
private

True if the midplane map is known to give a zero field at R: R lies strictly inside its radial range, where interpolate() is guaranteed to succeed, off the axis, with a finite z.

Definition at line 150 of file Cyclotron.cpp.

References Bfield_m, BP_m, BPositions::delr_m, midplaneMapIsZero_m, BfieldData::nrad_m, BPositions::rmin_m, and trimcoils_m.

Referenced by apply().

◆ operator=()

void Cyclotron::operator= ( const Cyclotron &  )
privatedelete

◆ read()

void Cyclotron::read ( const double &  scaleFactor)

◆ rfPhase()

void Cyclotron::rfPhase ( std::size_t  map,
double  t,
double  frequency,
double  phi,
double &  cosPhase,
double &  sinPhase 
)
private

◆ setBFieldType()

void Cyclotron::setBFieldType ( )

Definition at line 427 of file Cyclotron.cpp.

References ANSYSBF, AVFEQBF, BANDRF, CARBONBF, FFABF, fieldType_m, PSIBF, SYNCHRO, and typeName_m.

Referenced by setCyclotronType().

◆ setBScale()

void Cyclotron::setBScale ( double  bs)

Definition at line 323 of file Cyclotron.cpp.

References bscale_m.

Referenced by OpalCyclotron::update().

◆ setCyclHarm()

void Cyclotron::setCyclHarm ( double  h)

Definition at line 319 of file Cyclotron.cpp.

References harm_m.

Referenced by OpalCyclotron::update().

◆ setCyclotronType()

void Cyclotron::setCyclotronType ( const std::string &  type)

Definition at line 304 of file Cyclotron.cpp.

References setBFieldType(), and typeName_m.

Referenced by OpalCyclotron::update().

Here is the call graph for this function:

◆ setEScale()

void Cyclotron::setEScale ( std::vector< double >  bs)

Definition at line 331 of file Cyclotron.cpp.

References escale_m.

Referenced by OpalCyclotron::update().

◆ setFieldMapFN()

void Cyclotron::setFieldMapFN ( const std::string &  fmapfn)

Definition at line 227 of file Cyclotron.cpp.

References fmapfn_m.

Referenced by OpalCyclotron::update().

◆ setFMHighE()

void Cyclotron::setFMHighE ( double  e)

Definition at line 419 of file Cyclotron.cpp.

References fmHighE_m.

Referenced by OpalCyclotron::update().

◆ setFMLowE()

void Cyclotron::setFMLowE ( double  e)

Definition at line 411 of file Cyclotron.cpp.

References fmLowE_m.

Referenced by OpalCyclotron::update().

◆ setMaxR()

void Cyclotron::setMaxR ( double  r)

Definition at line 364 of file Cyclotron.cpp.

References maxr_m.

Referenced by OpalCyclotron::update().

◆ setMaxZ()

void Cyclotron::setMaxZ ( double  z)

Definition at line 394 of file Cyclotron.cpp.

References maxz_m.

Referenced by OpalCyclotron::update().

◆ setMinR()

void Cyclotron::setMinR ( double  r)

Definition at line 360 of file Cyclotron.cpp.

References minr_m.

Referenced by OpalCyclotron::update().

◆ setMinZ()

void Cyclotron::setMinZ ( double  z)

Definition at line 386 of file Cyclotron.cpp.

References minz_m.

Referenced by OpalCyclotron::update().

◆ setPHIinit()

void Cyclotron::setPHIinit ( double  phiinit)

Definition at line 183 of file Cyclotron.cpp.

References phiinit_m.

Referenced by OpalCyclotron::update().

◆ setPRinit()

void Cyclotron::setPRinit ( double  prinit)

Definition at line 175 of file Cyclotron.cpp.

References prinit_m.

Referenced by Distribution::createMatchedGaussDistribution(), and OpalCyclotron::update().

◆ setPZinit()

void Cyclotron::setPZinit ( double  zinit)

Definition at line 199 of file Cyclotron.cpp.

References pzinit_m.

Referenced by OpalCyclotron::update().

◆ setRFFCoeffFN()

void Cyclotron::setRFFCoeffFN ( std::vector< std::string >  rff_coeff_fn)

Definition at line 249 of file Cyclotron.cpp.

References RFFCoeff_fn_m.

Referenced by OpalCyclotron::update().

◆ setRfFieldMapFN()

void Cyclotron::setRfFieldMapFN ( std::vector< std::string >  rffmapfn)

Definition at line 245 of file Cyclotron.cpp.

References RFfilename_m.

Referenced by OpalCyclotron::update().

◆ setRfFrequ()

void Cyclotron::setRfFrequ ( std::vector< double >  f)

Definition at line 270 of file Cyclotron.cpp.

References rffrequ_m.

Referenced by OpalCyclotron::update().

◆ setRfPhi()

void Cyclotron::setRfPhi ( std::vector< double >  f)

Definition at line 257 of file Cyclotron.cpp.

References rfphi_m.

Referenced by OpalCyclotron::update().

◆ setRFVCoeffFN()

void Cyclotron::setRFVCoeffFN ( std::vector< std::string >  rfv_coeff_fn)

Definition at line 253 of file Cyclotron.cpp.

References RFVCoeff_fn_m.

Referenced by OpalCyclotron::update().

◆ setRinit()

void Cyclotron::setRinit ( double  rinit)

Definition at line 167 of file Cyclotron.cpp.

References rinit_m.

Referenced by Distribution::createMatchedGaussDistribution(), and OpalCyclotron::update().

◆ setSpiralFlag()

void Cyclotron::setSpiralFlag ( bool  spiral_flag)

Definition at line 215 of file Cyclotron.cpp.

References spiralFlag_m.

Referenced by OpalCyclotron::update().

◆ setSuperpose()

void Cyclotron::setSuperpose ( std::vector< bool >  flag)

Definition at line 283 of file Cyclotron.cpp.

References superpose_m.

Referenced by OpalCyclotron::update().

◆ setSymmetry()

void Cyclotron::setSymmetry ( double  symmetry)

Definition at line 296 of file Cyclotron.cpp.

References symmetry_m.

Referenced by OpalCyclotron::update().

◆ setTrimCoils()

void Cyclotron::setTrimCoils ( const std::vector< TrimCoil * > &  trimcoils)

Definition at line 407 of file Cyclotron.cpp.

References trimcoils_m.

Referenced by OpalCyclotron::update().

◆ setTrimCoilThreshold()

void Cyclotron::setTrimCoilThreshold ( double  trimCoilThreshold)

Definition at line 207 of file Cyclotron.cpp.

References trimCoilThreshold_m.

Referenced by OpalCyclotron::update().

◆ setTurnNumber()

void Cyclotron::setTurnNumber ( int  turn)

Turn number written into the loss records of apply(); the tracker sets it every step.

Definition at line 223 of file Cyclotron.cpp.

References turnNumber_m.

Referenced by ParallelCyclotronTracker::GenericTracker(), and ParallelCyclotronTracker::MtsTracker().

◆ setZinit()

void Cyclotron::setZinit ( double  zinit)

Definition at line 191 of file Cyclotron.cpp.

References zinit_m.

Referenced by OpalCyclotron::update().

◆ writeOutputFieldFiles()

void Cyclotron::writeOutputFieldFiles ( )

Member Data Documentation

◆ Bfield_m

BfieldData Cyclotron::Bfield_m
protected

◆ BP_m

BPositions Cyclotron::BP_m
protected

◆ bscale_m

double Cyclotron::bscale_m
private

A scale factor for the B-field

Definition at line 280 of file Cyclotron.h.

Referenced by getBScale(), and setBScale().

◆ escale_m

std::vector<double> Cyclotron::escale_m
private

A scale factor for the E-field

Definition at line 262 of file Cyclotron.h.

Referenced by apply(), getEScale(), and setEScale().

◆ fieldType_m

BFieldType Cyclotron::fieldType_m
private

◆ fmapfn_m

std::string Cyclotron::fmapfn_m
private

◆ fmHighE_m

double Cyclotron::fmHighE_m
private

Definition at line 290 of file Cyclotron.h.

Referenced by getFMHighE(), and setFMHighE().

◆ fmLowE_m

double Cyclotron::fmLowE_m
private

Definition at line 289 of file Cyclotron.h.

Referenced by getFMLowE(), and setFMLowE().

◆ harm_m

double Cyclotron::harm_m
private

Definition at line 278 of file Cyclotron.h.

Referenced by getCyclHarm(), and setCyclHarm().

◆ lossDs_m

std::unique_ptr<LossDataSink> Cyclotron::lossDs_m
private

Handling for store the particle out of region

Definition at line 302 of file Cyclotron.h.

Referenced by apply(), finalise(), and initialise().

◆ maxr_m

double Cyclotron::maxr_m
private

Definition at line 285 of file Cyclotron.h.

Referenced by apply(), checkInitialReferenceParticle(), getMaxR(), and setMaxR().

◆ maxz_m

double Cyclotron::maxz_m
private

Definition at line 287 of file Cyclotron.h.

Referenced by apply(), checkInitialReferenceParticle(), getMaxZ(), and setMaxZ().

◆ midplaneMapIsZero_m

bool Cyclotron::midplaneMapIsZero_m = false
private

BANDRF only: the midplane map is zero everywhere and there are no trim coils, so in the interior of the map it contributes nothing and only its radial extent matters (see midplaneMapInterior()).

Definition at line 312 of file Cyclotron.h.

Referenced by midplaneMapInterior(), and read().

◆ minr_m

double Cyclotron::minr_m
private

Definition at line 284 of file Cyclotron.h.

Referenced by apply(), getMaxR(), getMinR(), and setMinR().

◆ minz_m

double Cyclotron::minz_m
private

Definition at line 286 of file Cyclotron.h.

Referenced by getMaxZ(), getMinZ(), and setMinZ().

◆ phiinit_m

double Cyclotron::phiinit_m
private

Definition at line 269 of file Cyclotron.h.

Referenced by getPHIinit(), and setPHIinit().

◆ prinit_m

double Cyclotron::prinit_m
private

Definition at line 268 of file Cyclotron.h.

Referenced by getPRinit(), and setPRinit().

◆ pzinit_m

double Cyclotron::pzinit_m
private

Definition at line 271 of file Cyclotron.h.

Referenced by getPZinit(), and setPZinit().

◆ rffc_m

std::vector< std::vector<double> > Cyclotron::rffc_m
private

Definition at line 258 of file Cyclotron.h.

Referenced by apply(), and getFieldFromFile_Synchrocyclotron().

◆ RFFCoeff_fn_m

std::vector<std::string> Cyclotron::RFFCoeff_fn_m
private

Definition at line 299 of file Cyclotron.h.

Referenced by getFieldFromFile_Synchrocyclotron(), and setRFFCoeffFN().

◆ RFfields_m

std::vector<Fieldmap> Cyclotron::RFfields_m
private

◆ RFfilename_m

std::vector<std::string> Cyclotron::RFfilename_m
private

◆ rffrequ_m

std::vector<double> Cyclotron::rffrequ_m
private

Definition at line 257 of file Cyclotron.h.

Referenced by apply(), getRfFrequ(), and setRfFrequ().

◆ rfPhaseCache_m

std::vector<RFPhaseCache> Cyclotron::rfPhaseCache_m
private

Definition at line 331 of file Cyclotron.h.

Referenced by apply(), read(), and rfPhase().

◆ rfphi_m

std::vector<double> Cyclotron::rfphi_m
private

Definition at line 261 of file Cyclotron.h.

Referenced by apply(), getRfPhi(), and setRfPhi().

◆ rfvc_m

std::vector< std::vector<double> > Cyclotron::rfvc_m
private

Definition at line 260 of file Cyclotron.h.

Referenced by apply(), and getFieldFromFile_Synchrocyclotron().

◆ RFVCoeff_fn_m

std::vector<std::string> Cyclotron::RFVCoeff_fn_m
private

Definition at line 300 of file Cyclotron.h.

Referenced by getFieldFromFile_Synchrocyclotron(), and setRFVCoeffFN().

◆ rfvrequ_m

std::vector<double> Cyclotron::rfvrequ_m
private

Definition at line 259 of file Cyclotron.h.

◆ rinit_m

double Cyclotron::rinit_m
private

Definition at line 267 of file Cyclotron.h.

Referenced by getRinit(), and setRinit().

◆ spiralFlag_m

bool Cyclotron::spiralFlag_m
private

Definition at line 273 of file Cyclotron.h.

Referenced by getSpiralFlag(), and setSpiralFlag().

◆ superpose_m

std::vector<bool> Cyclotron::superpose_m
private

A flag for superpose electric fields

Definition at line 263 of file Cyclotron.h.

Referenced by apply(), getSuperpose(), and setSuperpose().

◆ symmetry_m

double Cyclotron::symmetry_m
private

Definition at line 265 of file Cyclotron.h.

Referenced by getSymmetry(), interpolate(), read(), and setSymmetry().

◆ trimcoils_m

std::vector<TrimCoil*> Cyclotron::trimcoils_m
private

Trim coils

Definition at line 282 of file Cyclotron.h.

Referenced by applyTrimCoil_m(), getNumberOfTrimcoils(), midplaneMapInterior(), read(), and setTrimCoils().

◆ trimCoilThreshold_m

double Cyclotron::trimCoilThreshold_m
private

B-field threshold for applying trim coil

Definition at line 274 of file Cyclotron.h.

Referenced by applyTrimCoil(), getTrimCoilThreshold(), and setTrimCoilThreshold().

◆ turnNumber_m

int Cyclotron::turnNumber_m = 0
private

Turn number for the loss records, see setTurnNumber()

Definition at line 304 of file Cyclotron.h.

Referenced by apply(), and setTurnNumber().

◆ typeName_m

std::string Cyclotron::typeName_m
private

Name of the TYPE parameter in cyclotron

Definition at line 276 of file Cyclotron.h.

Referenced by getCyclotronType(), read(), setBFieldType(), and setCyclotronType().

◆ waitingGap_m

int Cyclotron::waitingGap_m = 1
private

Definition at line 307 of file Cyclotron.h.

Referenced by apply().

◆ zinit_m

double Cyclotron::zinit_m
private

Definition at line 270 of file Cyclotron.h.

Referenced by getZinit(), and setZinit().


The documentation for this class was generated from the following files: