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

Information pertaining to an individual event. More...

#include <BDSOutputROOTEventInfo.hh>

Inheritance diagram for BDSOutputROOTEventInfo:
Inheritance graph
Collaboration diagram for BDSOutputROOTEventInfo:
Collaboration graph

Public Member Functions

void Flush ()
 
void Fill (const BDSOutputROOTEventInfo *other)
 Fill from another instance. More...
 
 ClassDef (BDSOutputROOTEventInfo, 6)
 

Data Fields

time_t startTime
 Time stamp at start of event. More...
 
time_t stopTime
 Time stamp at end of event. More...
 
float durationWall
 Number of seconds event took (wall time) to complete simulation (not writing out). More...
 
float durationCPU
 Number of seconds event took (CPU time). More...
 
std::string seedStateAtStart
 Seed state at the start of the event. More...
 
int index
 Number of this event or run. More...
 
bool aborted
 Whether the event was aborted or not. More...
 
bool primaryHitMachine
 Wether the primary particle hit the accelerator or not. More...
 
bool primaryAbsorbedInCollimator
 Whether the primary stopped in a collimator. More...
 
double memoryUsageMb
 Memory usage (rusage.ru_maxrss). More...
 
double energyDeposited
 Total energy deposited in machine (not world or tunnel). More...
 
double energyDepositedVacuum
 Total energy deposited in vacuum volumes. More...
 
double energyDepositedWorld
 Total energy deposited in the world for this event. More...
 
double energyDepositedWorldContents
 Total energy deposited in the world contents for this event. More...
 
double energyDepositedTunnel
 Total energy deposited in the tunnel for this event. More...
 
double energyWorldExit
 Total energy leaving the world. More...
 
double energyWorldExitKinetic
 Total kinetic energy leaving the world. More...
 
double energyImpactingAperture
 Total energy impacting the aperture. More...
 
double energyImpactingApertureKinetic
 Total kinetic energy impacting the aperture. More...
 
double energyKilled
 Total energy of killed particles that weren't in a sensitive volume. More...
 
double energyTotal
 Sum of above 5 variables that totals all energy. More...
 
int nCollimatorsInteracted
 Number of collimators primary interacted with. More...
 
long long int nTracks
 Number of tracks in the event. More...
 

Detailed Description

Information pertaining to an individual event.

Author
Stewart Boogert

Definition at line 34 of file BDSOutputROOTEventInfo.hh.

Constructor & Destructor Documentation

◆ ~BDSOutputROOTEventInfo()

BDSOutputROOTEventInfo::~BDSOutputROOTEventInfo ( )
virtual

Definition at line 51 of file BDSOutputROOTEventInfo.cc.

Member Function Documentation

◆ Fill()

void BDSOutputROOTEventInfo::Fill ( const BDSOutputROOTEventInfo other)

◆ Flush()

void BDSOutputROOTEventInfo::Flush ( )

Definition at line 54 of file BDSOutputROOTEventInfo.cc.

Field Documentation

◆ aborted

bool BDSOutputROOTEventInfo::aborted

Whether the event was aborted or not.

Definition at line 43 of file BDSOutputROOTEventInfo.hh.

Referenced by Fill(), and BDSEventInfo::SetAborted().

◆ durationCPU

float BDSOutputROOTEventInfo::durationCPU

Number of seconds event took (CPU time).

Definition at line 40 of file BDSOutputROOTEventInfo.hh.

Referenced by Fill(), and BDSEventInfo::SetDurationCPU().

◆ durationWall

float BDSOutputROOTEventInfo::durationWall

Number of seconds event took (wall time) to complete simulation (not writing out).

Definition at line 39 of file BDSOutputROOTEventInfo.hh.

Referenced by Fill(), and BDSEventInfo::SetDurationWall().

◆ energyDeposited

double BDSOutputROOTEventInfo::energyDeposited

Total energy deposited in machine (not world or tunnel).

Definition at line 47 of file BDSOutputROOTEventInfo.hh.

Referenced by Fill(), and BDSOutput::FillEventInfo().

◆ energyDepositedTunnel

double BDSOutputROOTEventInfo::energyDepositedTunnel

Total energy deposited in the tunnel for this event.

Definition at line 51 of file BDSOutputROOTEventInfo.hh.

Referenced by Fill(), and BDSOutput::FillEventInfo().

◆ energyDepositedVacuum

double BDSOutputROOTEventInfo::energyDepositedVacuum

Total energy deposited in vacuum volumes.

Definition at line 48 of file BDSOutputROOTEventInfo.hh.

Referenced by Fill(), and BDSOutput::FillEventInfo().

◆ energyDepositedWorld

double BDSOutputROOTEventInfo::energyDepositedWorld

Total energy deposited in the world for this event.

Definition at line 49 of file BDSOutputROOTEventInfo.hh.

Referenced by Fill(), and BDSOutput::FillEventInfo().

◆ energyDepositedWorldContents

double BDSOutputROOTEventInfo::energyDepositedWorldContents

Total energy deposited in the world contents for this event.

Definition at line 50 of file BDSOutputROOTEventInfo.hh.

Referenced by Fill(), and BDSOutput::FillEventInfo().

◆ energyImpactingAperture

double BDSOutputROOTEventInfo::energyImpactingAperture

Total energy impacting the aperture.

Definition at line 54 of file BDSOutputROOTEventInfo.hh.

Referenced by Fill(), and BDSOutput::FillEventInfo().

◆ energyImpactingApertureKinetic

double BDSOutputROOTEventInfo::energyImpactingApertureKinetic

Total kinetic energy impacting the aperture.

Definition at line 55 of file BDSOutputROOTEventInfo.hh.

Referenced by Fill(), and BDSOutput::FillEventInfo().

◆ energyKilled

double BDSOutputROOTEventInfo::energyKilled

Total energy of killed particles that weren't in a sensitive volume.

Definition at line 56 of file BDSOutputROOTEventInfo.hh.

Referenced by Fill(), and BDSOutput::FillEventInfo().

◆ energyTotal

double BDSOutputROOTEventInfo::energyTotal

Sum of above 5 variables that totals all energy.

Definition at line 57 of file BDSOutputROOTEventInfo.hh.

Referenced by Fill(), and BDSOutput::FillEventInfo().

◆ energyWorldExit

double BDSOutputROOTEventInfo::energyWorldExit

Total energy leaving the world.

Definition at line 52 of file BDSOutputROOTEventInfo.hh.

Referenced by Fill(), and BDSOutput::FillEventInfo().

◆ energyWorldExitKinetic

double BDSOutputROOTEventInfo::energyWorldExitKinetic

Total kinetic energy leaving the world.

Definition at line 53 of file BDSOutputROOTEventInfo.hh.

Referenced by Fill(), and BDSOutput::FillEventInfo().

◆ index

int BDSOutputROOTEventInfo::index

Number of this event or run.

Definition at line 42 of file BDSOutputROOTEventInfo.hh.

Referenced by Fill(), and BDSEventInfo::SetIndex().

◆ memoryUsageMb

double BDSOutputROOTEventInfo::memoryUsageMb

Memory usage (rusage.ru_maxrss).

Definition at line 46 of file BDSOutputROOTEventInfo.hh.

Referenced by Fill(), and BDSEventInfo::SetMemoryUsage().

◆ nCollimatorsInteracted

int BDSOutputROOTEventInfo::nCollimatorsInteracted

Number of collimators primary interacted with.

Definition at line 58 of file BDSOutputROOTEventInfo.hh.

Referenced by Fill(), and BDSOutput::FillEventInfo().

◆ nTracks

long long int BDSOutputROOTEventInfo::nTracks

Number of tracks in the event.

Definition at line 59 of file BDSOutputROOTEventInfo.hh.

Referenced by Fill(), and BDSEventInfo::SetNTracks().

◆ primaryAbsorbedInCollimator

bool BDSOutputROOTEventInfo::primaryAbsorbedInCollimator

Whether the primary stopped in a collimator.

Definition at line 45 of file BDSOutputROOTEventInfo.hh.

Referenced by Fill(), and BDSEventInfo::SetPrimaryAbsorbedInCollimator().

◆ primaryHitMachine

bool BDSOutputROOTEventInfo::primaryHitMachine

Wether the primary particle hit the accelerator or not.

Definition at line 44 of file BDSOutputROOTEventInfo.hh.

Referenced by Fill(), and BDSEventInfo::SetPrimaryHitMachine().

◆ seedStateAtStart

std::string BDSOutputROOTEventInfo::seedStateAtStart

Seed state at the start of the event.

Definition at line 41 of file BDSOutputROOTEventInfo.hh.

Referenced by Fill(), and BDSEventInfo::SetSeedStateAtStart().

◆ startTime

time_t BDSOutputROOTEventInfo::startTime

Time stamp at start of event.

Definition at line 37 of file BDSOutputROOTEventInfo.hh.

Referenced by Fill(), and BDSEventInfo::SetStartTime().

◆ stopTime

time_t BDSOutputROOTEventInfo::stopTime

Time stamp at end of event.

Definition at line 38 of file BDSOutputROOTEventInfo.hh.

Referenced by Fill(), and BDSEventInfo::SetStopTime().


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