BDSIM
BDSIM is a Geant4 extension toolkit for simulation of particle transport in accelerator beamlines.
Data Structures | Public Member Functions | Data Fields
BDSOutputROOTParticleData Class Reference

Geant4 particle data for particles used in simulation. More...

#include <BDSOutputROOTParticleData.hh>

Inheritance diagram for BDSOutputROOTParticleData:
Inheritance graph
Collaboration diagram for BDSOutputROOTParticleData:
Collaboration graph

Data Structures

struct  IonInfo
 Simple particle information to be stored per ion specifically. More...
 
struct  ParticleInfo
 Simple particle information to be stored per particle. More...
 

Public Member Functions

virtual void Flush ()
 Clear maps. More...
 
const ParticleInfo GetParticleInfo (const int &pdgID) const
 
const IonInfo GetIonInfo (const int &pdgID) const
 
int Charge (const int &pdgID) const
 
double Mass (const int &pdgID) const
 
double Rigidity (const int &pdgID, const double &totalEnergy) const
 Calculate rigidity of particle given PDG ID and total energy in GeV. More...
 
double KineticEnergy (const int &pdgID, const double &totalEnergy) const
 Calculate kinetic energy of particle given PDG ID and total energy in GeV. More...
 
std::string Name (const int &pdgID) const
 
int IonA (const int &pdgID) const
 
int IonZ (const int &pdgID) const
 
bool IsIon (const int &pdgID) const
 This doesn't count a proton (even with electrons) as an ion. More...
 
void Fill (G4bool fillIons)
 Fill maps of particle information from Geant4. More...
 
 ClassDef (BDSOutputROOTParticleData, 1)
 

Data Fields

std::map< int, ParticleInfoparticles
 
std::map< int, IonInfoions
 

Detailed Description

Geant4 particle data for particles used in simulation.

Author
Laurie Nevay

Definition at line 40 of file BDSOutputROOTParticleData.hh.

Constructor & Destructor Documentation

◆ ~BDSOutputROOTParticleData()

virtual BDSOutputROOTParticleData::~BDSOutputROOTParticleData ( )
inlinevirtual

Definition at line 111 of file BDSOutputROOTParticleData.hh.

Member Function Documentation

◆ Charge()

int BDSOutputROOTParticleData::Charge ( const int &  pdgID) const

Definition at line 63 of file BDSOutputROOTParticleData.cc.

◆ Fill()

void BDSOutputROOTParticleData::Fill ( G4bool  fillIons)

Fill maps of particle information from Geant4.

Definition at line 198 of file BDSOutputROOTParticleData.cc.

Referenced by BDSOutputROOTEventSampler< U >::Fill(), and BDSOutput::FillParticleData().

Here is the caller graph for this function:

◆ Flush()

void BDSOutputROOTParticleData::Flush ( )
virtual

Clear maps.

Definition at line 39 of file BDSOutputROOTParticleData.cc.

Referenced by BDSOutputStructures::ClearStructuresParticleData(), and BDSOutput::FillParticleData().

Here is the caller graph for this function:

◆ GetIonInfo()

const BDSOutputROOTParticleData::IonInfo BDSOutputROOTParticleData::GetIonInfo ( const int &  pdgID) const

Definition at line 54 of file BDSOutputROOTParticleData.cc.

◆ GetParticleInfo()

const BDSOutputROOTParticleData::ParticleInfo BDSOutputROOTParticleData::GetParticleInfo ( const int &  pdgID) const

Definition at line 45 of file BDSOutputROOTParticleData.cc.

◆ IonA()

int BDSOutputROOTParticleData::IonA ( const int &  pdgID) const

Definition at line 165 of file BDSOutputROOTParticleData.cc.

◆ IonZ()

int BDSOutputROOTParticleData::IonZ ( const int &  pdgID) const

Definition at line 181 of file BDSOutputROOTParticleData.cc.

◆ IsIon()

bool BDSOutputROOTParticleData::IsIon ( const int &  pdgID) const
inline

This doesn't count a proton (even with electrons) as an ion.

Definition at line 134 of file BDSOutputROOTParticleData.hh.

Referenced by BDSOutputROOTEventSamplerC::getIsIon(), BDSOutputROOTEventSamplerS::getIsIon(), KineticEnergy(), and Rigidity().

Here is the caller graph for this function:

◆ KineticEnergy()

double BDSOutputROOTParticleData::KineticEnergy ( const int &  pdgID,
const double &  totalEnergy 
) const

Calculate kinetic energy of particle given PDG ID and total energy in GeV.

Definition at line 124 of file BDSOutputROOTParticleData.cc.

References IsIon().

Referenced by BDSOutputROOTEventSamplerC::getKineticEnergy(), and BDSOutputROOTEventSamplerS::getKineticEnergy().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Mass()

double BDSOutputROOTParticleData::Mass ( const int &  pdgID) const

Definition at line 83 of file BDSOutputROOTParticleData.cc.

◆ Name()

std::string BDSOutputROOTParticleData::Name ( const int &  pdgID) const

Definition at line 145 of file BDSOutputROOTParticleData.cc.

◆ Rigidity()

double BDSOutputROOTParticleData::Rigidity ( const int &  pdgID,
const double &  totalEnergy 
) const

Calculate rigidity of particle given PDG ID and total energy in GeV.

Definition at line 103 of file BDSOutputROOTParticleData.cc.

References IsIon().

Referenced by BDSOutputROOTEventSamplerC::getRigidity(), and BDSOutputROOTEventSamplerS::getRigidity().

Here is the call graph for this function:
Here is the caller graph for this function:

Field Documentation

◆ ions

std::map<int, IonInfo> BDSOutputROOTParticleData::ions

Definition at line 142 of file BDSOutputROOTParticleData.hh.

◆ particles

std::map<int, ParticleInfo> BDSOutputROOTParticleData::particles

Definition at line 141 of file BDSOutputROOTParticleData.hh.


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