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

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: