BDSIM
BDSIM is a Geant4 extension toolkit for simulation of particle transport in accelerator beamlines.
Loading...
Searching...
No Matches
Public Member Functions
BDSOutputROOTEventBeam Class Reference

Class to store all beam options for a BDSIM run. More...

#include <BDSOutputROOTEventBeam.hh>

Inheritance diagram for BDSOutputROOTEventBeam:
Inheritance graph
Collaboration diagram for BDSOutputROOTEventBeam:
Collaboration graph

Public Member Functions

 BDSOutputROOTEventBeam (const GMAD::BeamBase *ob)
 
void Fill ()
 
 ClassDef (BDSOutputROOTEventBeam, 6)
 

Additional Inherited Members

- Data Fields inherited from GMAD::BeamBase
int nlinesIgnore
 Ignore first lines in the input bunch file.
 
int nlinesSkip
 Number of event lines to skip after the ignore lines.
 
double tilt
 tilt of beam applied as rotation about unit local z
 
double sigmaT
 bunch length
 
double sigmaE
 for the gaussian, elliptic shell, ring distributions
 
double sigmaEk
 
double sigmaP
 
bool offsetSampleMean
 
std::vector< std::string > setKeys
 A list of all the keys that have been set in this instance.
 
std::string particle
 beam parameters
 
std::string beamParticleName
 beam parameters
 
double beamEnergy
 beam parameters
 
double beamKineticEnergy
 beam parameters
 
double beamMomentum
 beam parameters
 
std::string distrType
 beam parameters
 
std::string xDistrType
 beam parameters
 
std::string yDistrType
 beam parameters
 
std::string zDistrType
 beam parameters
 
std::string spaceDistrType
 beam parameters
 
std::string directionDistrType
 beam parameters
 
std::string energyDistrType
 beam parameters
 
std::string distrFile
 beam parameters
 
std::string distrFileFormat
 beam parameters
 
bool distrFileFromExecOptions
 Required to know how to build the absolute path properly.
 
bool distrFileMatchLength
 beam parameters
 
bool distrFileLoop
 beam parameters
 
int distrFileLoopNTimes
 beam parameters
 
bool removeUnstableWithoutDecay
 beam parameters
 
double bunchFrequency
 Bunch offsets in time.
 
double bunchPeriod
 Bunch offsets in time.
 
int eventsPerBunch
 Bunch offsets in time.
 
double X0
 initial beam centroid
 
double Y0
 initial beam centroid
 
double Z0
 initial beam centroid
 
double S0
 initial beam centroid
 
double Xp0
 initial beam centroid
 
double Yp0
 initial beam centroid
 
double Zp0
 initial beam centroid
 
double T0
 initial beam centroid
 
double E0
 initial beam centroid
 
double Ek0
 initial beam centroid
 
double P0
 initial beam centroid
 
double betx
 initial twiss parameters
 
double bety
 initial twiss parameters
 
double alfx
 initial twiss parameters
 
double alfy
 initial twiss parameters
 
double emitx
 initial twiss parameters
 
double emity
 initial twiss parameters
 
double dispx
 initial twiss parameters
 
double dispy
 initial twiss parameters
 
double dispxp
 initial twiss parameters
 
double dispyp
 initial twiss parameters
 
double emitNX
 initial twiss parameters
 
double emitNY
 initial twiss parameters
 
double sigmaX
 for the gaussian beam distribution
 
double sigmaXp
 for the gaussian beam distribution
 
double sigmaY
 for the gaussian beam distribution
 
double sigmaYp
 for the gaussian beam distribution
 
double envelopeX
 for the circle/square/box beam distribution
 
double envelopeXp
 for the circle/square/box beam distribution
 
double envelopeY
 for the circle/square/box beam distribution
 
double envelopeYp
 for the circle/square/box beam distribution
 
double envelopeZ
 for the circle/square/box beam distribution
 
double envelopeZp
 for the circle/square/box beam distribution
 
double envelopeT
 for the circle/square/box beam distribution
 
double envelopeE
 for the circle/square/box beam distribution
 
double envelopeR
 for the circle/square/box beam distribution
 
double envelopeRp
 for the circle/square/box beam distribution
 
bool zFromT
 for the circle/square/box beam distribution
 
double sigma11
 for the gaussian sigma matrix distribution
 
double sigma12
 for the gaussian sigma matrix distribution
 
double sigma13
 for the gaussian sigma matrix distribution
 
double sigma14
 for the gaussian sigma matrix distribution
 
double sigma15
 for the gaussian sigma matrix distribution
 
double sigma16
 for the gaussian sigma matrix distribution
 
double sigma22
 for the gaussian sigma matrix distribution
 
double sigma23
 for the gaussian sigma matrix distribution
 
double sigma24
 for the gaussian sigma matrix distribution
 
double sigma25
 for the gaussian sigma matrix distribution
 
double sigma26
 for the gaussian sigma matrix distribution
 
double sigma33
 for the gaussian sigma matrix distribution
 
double sigma34
 for the gaussian sigma matrix distribution
 
double sigma35
 for the gaussian sigma matrix distribution
 
double sigma36
 for the gaussian sigma matrix distribution
 
double sigma44
 for the gaussian sigma matrix distribution
 
double sigma45
 for the gaussian sigma matrix distribution
 
double sigma46
 for the gaussian sigma matrix distribution
 
double sigma55
 for the gaussian sigma matrix distribution
 
double sigma56
 for the gaussian sigma matrix distribution
 
double sigma66
 for the gaussian sigma matrix distribution
 
double shellX
 for the elliptic shell distribution
 
double shellXp
 for the elliptic shell distribution
 
double shellY
 for the elliptic shell distribution
 
double shellYp
 for the elliptic shell distribution
 
double shellXWidth
 for the elliptic shell distribution
 
double shellXpWidth
 for the elliptic shell distribution
 
double shellYWidth
 for the elliptic shell distribution
 
double shellYpWidth
 for the elliptic shell distribution
 
double Rmin
 for the ring beam distribution
 
double Rmax
 for the ring beam distribution
 
double haloNSigmaXInner
 for the halo distribution
 
double haloNSigmaXOuter
 for the halo distribution
 
double haloNSigmaYInner
 for the halo distribution
 
double haloNSigmaYOuter
 for the halo distribution
 
double haloXCutInner
 for the halo distribution
 
double haloYCutInner
 for the halo distribution
 
double haloXCutOuter
 for the halo distribution
 
double haloYCutOuter
 for the halo distribution
 
double haloXpCutInner
 for the halo distribution
 
double haloYpCutInner
 for the halo distribution
 
double haloXpCutOuter
 for the halo distribution
 
double haloYpCutOuter
 for the halo distribution
 
double haloPSWeightParameter
 for the halo distribution
 
std::string haloPSWeightFunction
 for the halo distribution
 
int eventGeneratorNEventsSkip
 Event generator file filter.
 
double eventGeneratorMinX
 Event generator file filter.
 
double eventGeneratorMaxX
 Event generator file filter.
 
double eventGeneratorMinY
 Event generator file filter.
 
double eventGeneratorMaxY
 Event generator file filter.
 
double eventGeneratorMinZ
 Event generator file filter.
 
double eventGeneratorMaxZ
 Event generator file filter.
 
double eventGeneratorMinXp
 Event generator file filter.
 
double eventGeneratorMaxXp
 Event generator file filter.
 
double eventGeneratorMinYp
 Event generator file filter.
 
double eventGeneratorMaxYp
 Event generator file filter.
 
double eventGeneratorMinZp
 Event generator file filter.
 
double eventGeneratorMaxZp
 Event generator file filter.
 
double eventGeneratorMinRp
 Event generator file filter.
 
double eventGeneratorMaxRp
 Event generator file filter.
 
double eventGeneratorMinT
 Event generator file filter.
 
double eventGeneratorMaxT
 Event generator file filter.
 
double eventGeneratorMinEK
 Event generator file filter.
 
double eventGeneratorMaxEK
 Event generator file filter.
 
std::string eventGeneratorParticles
 Event generator file filter.
 
bool eventGeneratorWarnSkippedParticles
 Event generator file filter.
 

Detailed Description

Class to store all beam options for a BDSIM run.

Author
Laurie Nevay

Definition at line 33 of file BDSOutputROOTEventBeam.hh.

Constructor & Destructor Documentation

◆ BDSOutputROOTEventBeam()

BDSOutputROOTEventBeam::BDSOutputROOTEventBeam ( const GMAD::BeamBase *  ob)
explicit

Definition at line 26 of file BDSOutputROOTEventBeam.cc.

◆ ~BDSOutputROOTEventBeam()

BDSOutputROOTEventBeam::~BDSOutputROOTEventBeam ( )
virtual

Definition at line 30 of file BDSOutputROOTEventBeam.cc.

Member Function Documentation

◆ Fill()

void BDSOutputROOTEventBeam::Fill ( )

Definition at line 34 of file BDSOutputROOTEventBeam.cc.

The documentation for this class was generated from the following files:
Generated on Mon Aug 14 2023 13:49:32 for BDSIM by doxygen 1.9.6