Information recorded for a single piece of energy deposition. More...

#include <BDSHitEnergyDeposition.hh>

Inheritance diagram for BDSHitEnergyDeposition:

Collaboration diagram for BDSHitEnergyDeposition:

Public Member Functions
	BDSHitEnergyDeposition (G4double energyIn, G4double sHitIn, G4double weightIn, G4bool storeExtras, G4double preStepKineticEnergy=0, G4double XIn=0, G4double YIn=0, G4double ZIn=0, G4double xIn=0, G4double yIn=0, G4double zIn=0, G4double globalTimeIn=0, G4int partIDIn=0, G4int trackID=-1, G4int parentID=-1, G4int turnsTakenIn=1, G4double stepLengthIn=0, G4int beamlineIndexIn=-1, G4int postStepProcessType=-1, G4int postStepProcessSubType=-1)

virtual	~BDSHitEnergyDeposition ()
	Note this should not be inline when we use a G4Allocator.

void *	operator new (size_t)

void	operator delete (void *aHit)

G4double	GetEnergy () const

G4double	GetWeight () const

G4double	GetSHit () const

G4double	GetEnergyWeighted () const


G4double	GetPreStepKineticEnergy () const
	Accessor for extra piece of information.

G4double	GetX () const
	Accessor for extra piece of information.

G4double	GetY () const
	Accessor for extra piece of information.

G4double	GetZ () const
	Accessor for extra piece of information.

G4double	Getx () const
	Accessor for extra piece of information.

G4double	Gety () const
	Accessor for extra piece of information.

G4double	Getz () const
	Accessor for extra piece of information.

G4double	GetGlobalTime () const
	Accessor for extra piece of information.

G4int	GetPartID () const
	Accessor for extra piece of information.

G4int	GetTrackID () const
	Accessor for extra piece of information.

G4int	GetParentID () const
	Accessor for extra piece of information.

G4int	GetTurnsTaken () const
	Accessor for extra piece of information.

G4double	GetStepLength () const
	Accessor for extra piece of information.

G4int	GetBeamlineIndex () const
	Accessor for extra piece of information.

G4int	GetPostStepProcessType () const
	Accessor for extra piece of information.

G4int	GetPostStepProcessSubType () const
	Accessor for extra piece of information.

Private Member Functions
	BDSHitEnergyDeposition ()

Private Attributes
G4double	energy

G4double	sHit

G4double	weight

BDSHitEnergyDepositionExtra *	extra

Detailed Description

Information recorded for a single piece of energy deposition.

Definition at line 33 of file BDSHitEnergyDeposition.hh.

Constructor & Destructor Documentation

◆ BDSHitEnergyDeposition() [1/2]

BDSHitEnergyDeposition::BDSHitEnergyDeposition	(	G4double	energyIn,
		G4double	sHitIn,
		G4double	weightIn,
		G4bool	storeExtras,
		G4double	preStepKineticEnergy = `0`,
		G4double	XIn = `0`,
		G4double	YIn = `0`,
		G4double	ZIn = `0`,
		G4double	xIn = `0`,
		G4double	yIn = `0`,
		G4double	zIn = `0`,
		G4double	globalTimeIn = `0`,
		G4int	partIDIn = `0`,
		G4int	trackID = `-1`,
		G4int	parentID = `-1`,
		G4int	turnsTakenIn = `1`,
		G4double	stepLengthIn = `0`,
		G4int	beamlineIndexIn = `-1`,
		G4int	postStepProcessType = `-1`,
		G4int	postStepProcessSubType = `-1`
	)

Default (in effect) constructor for energy counter 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 27 of file BDSHitEnergyDeposition.cc.

◆ ~BDSHitEnergyDeposition()

BDSHitEnergyDeposition::~BDSHitEnergyDeposition ( )

virtual

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

Definition at line 62 of file BDSHitEnergyDeposition.cc.

◆ BDSHitEnergyDeposition() [2/2]

BDSHitEnergyDeposition::BDSHitEnergyDeposition ( )

private

Private default constructor (not implemented) as the constructor provided as defaults for everything which in effect provides a default constructor

Member Function Documentation

◆ GetBeamlineIndex()

G4int BDSHitEnergyDeposition::GetBeamlineIndex ( ) const

inline

Accessor for extra piece of information.

Definition at line 85 of file BDSHitEnergyDeposition.hh.

◆ GetEnergy()

G4double BDSHitEnergyDeposition::GetEnergy ( ) const

inline

Definition at line 66 of file BDSHitEnergyDeposition.hh.

◆ GetEnergyWeighted()

G4double BDSHitEnergyDeposition::GetEnergyWeighted ( ) const

inline

Definition at line 69 of file BDSHitEnergyDeposition.hh.

◆ GetGlobalTime()

G4double BDSHitEnergyDeposition::GetGlobalTime ( ) const

inline

Accessor for extra piece of information.

Definition at line 79 of file BDSHitEnergyDeposition.hh.

References BDSHitEnergyDepositionExtra::globalTime.

◆ GetParentID()

G4int BDSHitEnergyDeposition::GetParentID ( ) const

inline

Accessor for extra piece of information.

Definition at line 82 of file BDSHitEnergyDeposition.hh.

◆ GetPartID()

G4int BDSHitEnergyDeposition::GetPartID ( ) const

inline

Accessor for extra piece of information.

Definition at line 80 of file BDSHitEnergyDeposition.hh.

◆ GetPostStepProcessSubType()

G4int BDSHitEnergyDeposition::GetPostStepProcessSubType ( ) const

inline

Accessor for extra piece of information.

Definition at line 87 of file BDSHitEnergyDeposition.hh.

References BDSHitEnergyDepositionExtra::postStepProcessSubType.

◆ GetPostStepProcessType()

G4int BDSHitEnergyDeposition::GetPostStepProcessType ( ) const

inline

Accessor for extra piece of information.

Definition at line 86 of file BDSHitEnergyDeposition.hh.

References BDSHitEnergyDepositionExtra::postStepProcessType.

◆ GetPreStepKineticEnergy()

G4double BDSHitEnergyDeposition::GetPreStepKineticEnergy ( ) const

inline

Accessor for extra piece of information.

Definition at line 72 of file BDSHitEnergyDeposition.hh.

◆ GetSHit()

G4double BDSHitEnergyDeposition::GetSHit ( ) const

inline

Definition at line 68 of file BDSHitEnergyDeposition.hh.

◆ GetStepLength()

G4double BDSHitEnergyDeposition::GetStepLength ( ) const

inline

Accessor for extra piece of information.

Definition at line 84 of file BDSHitEnergyDeposition.hh.

◆ GetTrackID()

G4int BDSHitEnergyDeposition::GetTrackID ( ) const

inline

Accessor for extra piece of information.

Definition at line 81 of file BDSHitEnergyDeposition.hh.

Referenced by BDSEventAction::IdentifyTrajectoriesForStorage().

Here is the caller graph for this function:

◆ GetTurnsTaken()

G4int BDSHitEnergyDeposition::GetTurnsTaken ( ) const

inline

Accessor for extra piece of information.

Definition at line 83 of file BDSHitEnergyDeposition.hh.

◆ GetWeight()

G4double BDSHitEnergyDeposition::GetWeight ( ) const

inline

Definition at line 67 of file BDSHitEnergyDeposition.hh.

◆ GetX()

G4double BDSHitEnergyDeposition::GetX ( ) const

inline

Accessor for extra piece of information.

Definition at line 73 of file BDSHitEnergyDeposition.hh.

References BDSHitEnergyDepositionExtra::X.

◆ Getx()

G4double BDSHitEnergyDeposition::Getx ( ) const

inline

Accessor for extra piece of information.

Definition at line 76 of file BDSHitEnergyDeposition.hh.

References BDSHitEnergyDepositionExtra::x.

Referenced by BDSOutput::FillEnergyLoss().

Here is the caller graph for this function:

◆ GetY()

G4double BDSHitEnergyDeposition::GetY ( ) const

inline

Accessor for extra piece of information.

Definition at line 74 of file BDSHitEnergyDeposition.hh.

References BDSHitEnergyDepositionExtra::Y.

◆ Gety()

G4double BDSHitEnergyDeposition::Gety ( ) const

inline

Accessor for extra piece of information.

Definition at line 77 of file BDSHitEnergyDeposition.hh.

References BDSHitEnergyDepositionExtra::y.

Referenced by BDSOutput::FillEnergyLoss().

Here is the caller graph for this function:

◆ GetZ()

G4double BDSHitEnergyDeposition::GetZ ( ) const

inline

Accessor for extra piece of information.

Definition at line 75 of file BDSHitEnergyDeposition.hh.

References BDSHitEnergyDepositionExtra::Z.

◆ Getz()

G4double BDSHitEnergyDeposition::Getz ( ) const

inline

Accessor for extra piece of information.

Definition at line 78 of file BDSHitEnergyDeposition.hh.

References BDSHitEnergyDepositionExtra::z.

◆ operator delete()

void BDSHitEnergyDeposition::operator delete ( void * aHit )

inline

Definition at line 119 of file BDSHitEnergyDeposition.hh.

◆ operator new()

void * BDSHitEnergyDeposition::operator new ( size_t )

inline

Definition at line 112 of file BDSHitEnergyDeposition.hh.

Field Documentation

◆ energy

G4double BDSHitEnergyDeposition::energy

private

Definition at line 96 of file BDSHitEnergyDeposition.hh.

◆ extra

BDSHitEnergyDepositionExtra* BDSHitEnergyDeposition::extra

private

Definition at line 106 of file BDSHitEnergyDeposition.hh.

◆ sHit

G4double BDSHitEnergyDeposition::sHit

private

The position this energy deposition is assigned to. As we represent a Monte Carlo of discrete processes, this is randomly scattered along the length of the track this energy deposition corresponds to (uniform random distribution).

Definition at line 102 of file BDSHitEnergyDeposition.hh.

◆ weight

G4double BDSHitEnergyDeposition::weight

private

Definition at line 104 of file BDSHitEnergyDeposition.hh.

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

/Users/lnevay/physics/reps/bdsim/include/BDSHitEnergyDeposition.hh
/Users/lnevay/physics/reps/bdsim/src/BDSHitEnergyDeposition.cc

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ BDSHitEnergyDeposition() [1/2]

◆ ~BDSHitEnergyDeposition()

◆ BDSHitEnergyDeposition() [2/2]

Member Function Documentation

◆ GetBeamlineIndex()

◆ GetEnergy()

◆ GetEnergyWeighted()

◆ GetGlobalTime()

◆ GetParentID()

◆ GetPartID()

◆ GetPostStepProcessSubType()

◆ GetPostStepProcessType()

◆ GetPreStepKineticEnergy()

◆ GetSHit()

◆ GetStepLength()

◆ GetTrackID()

◆ GetTurnsTaken()

◆ GetWeight()

◆ GetX()

◆ Getx()

◆ GetY()

◆ Gety()

◆ GetZ()

◆ Getz()

◆ operator delete()

◆ operator new()

Field Documentation

◆ energy

◆ extra

◆ sHit

◆ weight