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

Information recorded for a step leaving a volume. More...

#include <BDSHitEnergyDepositionGlobal.hh>

Inheritance diagram for BDSHitEnergyDepositionGlobal:
Inheritance graph
Collaboration diagram for BDSHitEnergyDepositionGlobal:
Collaboration graph

Public Member Functions

 BDSHitEnergyDepositionGlobal (G4double totalEnergyIn, G4double preStepKineticEnergyIn, G4double postStepKineticEnergyIn, G4double stepLengthIn, G4double XIn, G4double YIn, G4double ZIn, G4double TIn, G4int pdgIDIn, G4int trackIDIn, G4int parentIDIn, G4double weightIn, G4int turnsTakenIn)
 
virtual ~BDSHitEnergyDepositionGlobal ()
 Note this should not be inline when we use a G4Allocator. More...
 
G4double TotalEnergyWeighted () const
 
G4double KineticEnergyWeighted () const
 

Data Fields

G4double totalEnergy
 
G4double preStepKineticEnergy
 
G4double postStepKineticEnergy
 
G4double stepLength
 
G4int pdgID
 
G4int trackID
 
G4int parentID
 
G4double weight
 
G4int turnsTaken
 
G4double X
 Global coordinate. More...
 
G4double Y
 Global coordinate. More...
 
G4double Z
 Global coordinate. More...
 
G4double T
 Global coordinate. More...
 

Private Member Functions

 BDSHitEnergyDepositionGlobal ()=delete
 Private default constructor (not implemented) as the constructor.
 

Detailed Description

Information recorded for a step leaving a volume.

Author
Laurie Nevay

Definition at line 32 of file BDSHitEnergyDepositionGlobal.hh.

Constructor & Destructor Documentation

◆ BDSHitEnergyDepositionGlobal()

BDSHitEnergyDepositionGlobal::BDSHitEnergyDepositionGlobal ( G4double  totalEnergyIn,
G4double  preStepKineticEnergyIn,
G4double  postStepKineticEnergyIn,
G4double  stepLengthIn,
G4double  XIn,
G4double  YIn,
G4double  ZIn,
G4double  TIn,
G4int  pdgIDIn,
G4int  trackIDIn,
G4int  parentIDIn,
G4double  weightIn,
G4int  turnsTakenIn 
)

Default (in effect) constructor for energy deposition hit. The intention (by a lack of setter methods is that all information should be provided as instantiation time for an instance of this class.

Definition at line 23 of file BDSHitEnergyDepositionGlobal.cc.

◆ ~BDSHitEnergyDepositionGlobal()

BDSHitEnergyDepositionGlobal::~BDSHitEnergyDepositionGlobal ( )
virtual

Note this should not be inline when we use a G4Allocator.

Definition at line 51 of file BDSHitEnergyDepositionGlobal.cc.

Member Function Documentation

◆ KineticEnergyWeighted()

G4double BDSHitEnergyDepositionGlobal::KineticEnergyWeighted ( ) const
inline

Definition at line 56 of file BDSHitEnergyDepositionGlobal.hh.

◆ TotalEnergyWeighted()

G4double BDSHitEnergyDepositionGlobal::TotalEnergyWeighted ( ) const
inline

Definition at line 55 of file BDSHitEnergyDepositionGlobal.hh.

Field Documentation

◆ parentID

G4int BDSHitEnergyDepositionGlobal::parentID

Definition at line 76 of file BDSHitEnergyDepositionGlobal.hh.

◆ pdgID

G4int BDSHitEnergyDepositionGlobal::pdgID

Definition at line 74 of file BDSHitEnergyDepositionGlobal.hh.

◆ postStepKineticEnergy

G4double BDSHitEnergyDepositionGlobal::postStepKineticEnergy

Unlike kinetic energy recorded elsewhere, this is from the post-step point rather than the pre-step point because we want the kinetic energy leaving the volume.

Definition at line 64 of file BDSHitEnergyDepositionGlobal.hh.

◆ preStepKineticEnergy

G4double BDSHitEnergyDepositionGlobal::preStepKineticEnergy

Definition at line 59 of file BDSHitEnergyDepositionGlobal.hh.

◆ stepLength

G4double BDSHitEnergyDepositionGlobal::stepLength

Definition at line 65 of file BDSHitEnergyDepositionGlobal.hh.

◆ T

G4double BDSHitEnergyDepositionGlobal::T

Global coordinate.

Definition at line 71 of file BDSHitEnergyDepositionGlobal.hh.

◆ totalEnergy

G4double BDSHitEnergyDepositionGlobal::totalEnergy

Definition at line 58 of file BDSHitEnergyDepositionGlobal.hh.

◆ trackID

G4int BDSHitEnergyDepositionGlobal::trackID

Definition at line 75 of file BDSHitEnergyDepositionGlobal.hh.

◆ turnsTaken

G4int BDSHitEnergyDepositionGlobal::turnsTaken

Definition at line 78 of file BDSHitEnergyDepositionGlobal.hh.

◆ weight

G4double BDSHitEnergyDepositionGlobal::weight

Definition at line 77 of file BDSHitEnergyDepositionGlobal.hh.

◆ X

G4double BDSHitEnergyDepositionGlobal::X

Global coordinate.

Definition at line 68 of file BDSHitEnergyDepositionGlobal.hh.

◆ Y

G4double BDSHitEnergyDepositionGlobal::Y

Global coordinate.

Definition at line 69 of file BDSHitEnergyDepositionGlobal.hh.

◆ Z

G4double BDSHitEnergyDepositionGlobal::Z

Global coordinate.

Definition at line 70 of file BDSHitEnergyDepositionGlobal.hh.


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