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

Snapshot of information for particle passing through a collimator. More...

#include <BDSHitCollimator.hh>

Inheritance diagram for BDSHitCollimator:
Inheritance graph
Collaboration diagram for BDSHitCollimator:
Collaboration graph

Public Member Functions

 BDSHitCollimator (const BDSBeamline *beamlineIn, G4int collimatorIndexIn, const G4ThreeVector &preStepPositionIn, const G4ThreeVector &preStepMomentumIn, G4double totalEnergyIn, G4double globalTimeIn, G4double weightIn, G4int partIDIn, G4int parentIDIn, G4int turnsTakenIn, BDSHitEnergyDeposition *energyDepositionHitIn)
 
virtual ~BDSHitCollimator ()
 Note this should not be inline when we use a G4Allocator.
 
void * operator new (size_t)
 
void operator delete (void *aHit)
 

Data Fields

const BDSBeamline * beamline
 Which beam line the collimator is in.
 
G4int collimatorIndex
 Index of collimator the hit is in.
 
G4ThreeVector preStepPosition
 Local pre step point (z from centre of object).
 
G4ThreeVector preStepMomentum
 Local pre step point momentum.
 
G4double totalEnergy
 Total energy of particle.
 
G4double globalTime
 Pre step point global time.
 
G4double weight
 Statistical weight of the track.
 
G4int partID
 PDG ID of the particle.
 
G4int parentID
 Track ID of the parent of the particle.
 
G4int turnsTaken
 Turn number of the hit.
 
BDSHitEnergyDeposition * energyDepositionHit
 

Detailed Description

Snapshot of information for particle passing through a collimator.

Everything public for simplicity of the class.

Author
Laurie Nevay

Definition at line 38 of file BDSHitCollimator.hh.

Constructor & Destructor Documentation

◆ BDSHitCollimator()

BDSHitCollimator::BDSHitCollimator ( const BDSBeamline *  beamlineIn,
G4int  collimatorIndexIn,
const G4ThreeVector &  preStepPositionIn,
const G4ThreeVector &  preStepMomentumIn,
G4double  totalEnergyIn,
G4double  globalTimeIn,
G4double  weightIn,
G4int  partIDIn,
G4int  parentIDIn,
G4int  turnsTakenIn,
BDSHitEnergyDeposition *  energyDepositionHitIn 
)

Definition at line 24 of file BDSHitCollimator.cc.

◆ ~BDSHitCollimator()

BDSHitCollimator::~BDSHitCollimator ( )
virtual

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

Definition at line 48 of file BDSHitCollimator.cc.

Member Function Documentation

◆ operator delete()

void BDSHitCollimator::operator delete ( void *  aHit)
inline

Definition at line 87 of file BDSHitCollimator.hh.

◆ operator new()

void * BDSHitCollimator::operator new ( size_t  )
inline

Definition at line 80 of file BDSHitCollimator.hh.

Field Documentation

◆ beamline

const BDSBeamline* BDSHitCollimator::beamline

Which beam line the collimator is in.

Definition at line 60 of file BDSHitCollimator.hh.

◆ collimatorIndex

G4int BDSHitCollimator::collimatorIndex

Index of collimator the hit is in.

Definition at line 61 of file BDSHitCollimator.hh.

Referenced by BDSOutput::FillCollimatorHits().

◆ energyDepositionHit

BDSHitEnergyDeposition* BDSHitCollimator::energyDepositionHit

Pointer to the externally created energy deposition hit for the step in the collimator this hit will correspond to. Can be nullptr if there was no energy deposition hit for the step, in which case the information above is used.

Definition at line 74 of file BDSHitCollimator.hh.

◆ globalTime

G4double BDSHitCollimator::globalTime

Pre step point global time.

Definition at line 65 of file BDSHitCollimator.hh.

◆ parentID

G4int BDSHitCollimator::parentID

Track ID of the parent of the particle.

Definition at line 68 of file BDSHitCollimator.hh.

◆ partID

G4int BDSHitCollimator::partID

PDG ID of the particle.

Definition at line 67 of file BDSHitCollimator.hh.

◆ preStepMomentum

G4ThreeVector BDSHitCollimator::preStepMomentum

Local pre step point momentum.

Definition at line 63 of file BDSHitCollimator.hh.

◆ preStepPosition

G4ThreeVector BDSHitCollimator::preStepPosition

Local pre step point (z from centre of object).

Definition at line 62 of file BDSHitCollimator.hh.

◆ totalEnergy

G4double BDSHitCollimator::totalEnergy

Total energy of particle.

Definition at line 64 of file BDSHitCollimator.hh.

◆ turnsTaken

G4int BDSHitCollimator::turnsTaken

Turn number of the hit.

Definition at line 69 of file BDSHitCollimator.hh.

◆ weight

G4double BDSHitCollimator::weight

Statistical weight of the track.

Definition at line 66 of file BDSHitCollimator.hh.


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