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

Action to decide whether or not to store trajectory information. More...

#include <BDSTrackingAction.hh>

Inheritance diagram for BDSTrackingAction:
Inheritance graph
Collaboration diagram for BDSTrackingAction:
Collaboration graph

Public Member Functions

 BDSTrackingAction (G4bool batchMode, G4bool storeTrajectoryIn, const BDS::TrajectoryOptions &storeTrajectoryOptionsIn, BDSEventAction *eventActionIn, G4int verboseSteppingEventStartIn, G4int verboseSteppingEventStopIn, G4bool verboseSteppingPrimaryOnlyIn, G4int verboseSteppingLevelIn, BDSPolarizationState *defaultPolarisationIn=nullptr)
 
virtual void PreUserTrackingAction (const G4Track *track)
 Used to decide whether or not to store trajectories.
 
virtual void PostUserTrackingAction (const G4Track *track)
 Detect whether track is a primary and if so whether it ended in a collimator.
 

Private Member Functions

 BDSTrackingAction ()=delete
 No default constructor required.
 

Private Attributes

const G4bool interactive
 
const G4bool storeTrajectory
 
const BDS::TrajectoryOptions storeTrajectoryOptions
 Cache of flag from global constants to control storing all trajectories.
 
BDSEventAction * eventAction
 Cache of trajectory options.
 
G4int verboseSteppingEventStart
 
G4int verboseSteppingEventStop
 
G4bool verboseSteppingPrimaryOnly
 
G4int verboseSteppingLevel
 
BDSPolarizationState * defaultPolarisation
 

Detailed Description

Action to decide whether or not to store trajectory information.

Definition at line 35 of file BDSTrackingAction.hh.

Constructor & Destructor Documentation

◆ BDSTrackingAction()

BDSTrackingAction::BDSTrackingAction ( G4bool  batchMode,
G4bool  storeTrajectoryIn,
const BDS::TrajectoryOptions &  storeTrajectoryOptionsIn,
BDSEventAction *  eventActionIn,
G4int  verboseSteppingEventStartIn,
G4int  verboseSteppingEventStopIn,
G4bool  verboseSteppingPrimaryOnlyIn,
G4int  verboseSteppingLevelIn,
BDSPolarizationState *  defaultPolarisationIn = nullptr 
)

Definition at line 41 of file BDSTrackingAction.cc.

◆ ~BDSTrackingAction()

BDSTrackingAction::~BDSTrackingAction ( )
virtual

Definition at line 61 of file BDSTrackingAction.cc.

Member Function Documentation

◆ PostUserTrackingAction()

void BDSTrackingAction::PostUserTrackingAction ( const G4Track *  track)
virtual

Detect whether track is a primary and if so whether it ended in a collimator.

Definition at line 125 of file BDSTrackingAction.cc.

References eventAction, BDSEventAction::SetPrimaryAbsorbedInCollimator(), and BDSAcceleratorModel::VolumeSet().

Here is the call graph for this function:

◆ PreUserTrackingAction()

void BDSTrackingAction::PreUserTrackingAction ( const G4Track *  track)
virtual

Used to decide whether or not to store trajectories.

Definition at line 66 of file BDSTrackingAction.cc.

References BDSIntegratorMag::currentTrackIsPrimary, eventAction, BDSEventAction::IncrementNTracks(), interactive, BDS::IsIon(), BDSEventAction::RegisterPrimaryTrajectory(), storeTrajectoryOptions, and BDS::VerboseThisEvent().

Here is the call graph for this function:

Field Documentation

◆ defaultPolarisation

BDSPolarizationState* BDSTrackingAction::defaultPolarisation
private

Definition at line 74 of file BDSTrackingAction.hh.

◆ eventAction

BDSEventAction* BDSTrackingAction::eventAction
private

Cache of trajectory options.

Cache of event action to communicate whether a primary stopped in a collimator or not.

Definition at line 68 of file BDSTrackingAction.hh.

Referenced by PostUserTrackingAction(), and PreUserTrackingAction().

◆ interactive

const G4bool BDSTrackingAction::interactive
private

Whether we're using the visualiser - in which case always store trajectories for visualisation.

Definition at line 62 of file BDSTrackingAction.hh.

Referenced by PreUserTrackingAction().

◆ storeTrajectory

const G4bool BDSTrackingAction::storeTrajectory
private

Definition at line 64 of file BDSTrackingAction.hh.

◆ storeTrajectoryOptions

const BDS::TrajectoryOptions BDSTrackingAction::storeTrajectoryOptions
private

Cache of flag from global constants to control storing all trajectories.

Definition at line 65 of file BDSTrackingAction.hh.

Referenced by PreUserTrackingAction().

◆ verboseSteppingEventStart

G4int BDSTrackingAction::verboseSteppingEventStart
private

Definition at line 70 of file BDSTrackingAction.hh.

◆ verboseSteppingEventStop

G4int BDSTrackingAction::verboseSteppingEventStop
private

Definition at line 71 of file BDSTrackingAction.hh.

◆ verboseSteppingLevel

G4int BDSTrackingAction::verboseSteppingLevel
private

Definition at line 73 of file BDSTrackingAction.hh.

◆ verboseSteppingPrimaryOnly

G4bool BDSTrackingAction::verboseSteppingPrimaryOnly
private

Definition at line 72 of file BDSTrackingAction.hh.


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