Analysis Software
Documentation for sPHENIX simulation software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
ActsExamples::ParticleKillAction Class Reference

#include <acts/blob/sPHENIX/Examples/Algorithms/Geant4/include/ActsExamples/Geant4/ParticleKillAction.hpp>

+ Inheritance diagram for ActsExamples::ParticleKillAction:
+ Collaboration diagram for ActsExamples::ParticleKillAction:

Classes

struct  Config
 Configuration of the Stepping action. More...
 

Public Member Functions

 ParticleKillAction (const Config &cfg, std::unique_ptr< const Acts::Logger > logger=Acts::getDefaultLogger("ParticleKillAction", Acts::Logging::INFO))
 
 ~ParticleKillAction () override=default
 
void UserSteppingAction (const G4Step *step) override
 Called every step, conditionally sets the tracking state to fStopAndKill
 

Private Member Functions

const Acts::Loggerlogger () const
 

Private Attributes

Config m_cfg
 
std::unique_ptr< const
Acts::Logger
m_logger
 

Detailed Description

A G4SteppingAction that is called for every step in the simulation process.

It checks whether the particle can be killed according to the user settings e.g. if its position exceeds the configured values for |z| or r.

Definition at line 30 of file ParticleKillAction.hpp.

View newest version in sPHENIX GitHub at line 30 of file ParticleKillAction.hpp

Constructor & Destructor Documentation

ActsExamples::ParticleKillAction::ParticleKillAction ( const Config cfg,
std::unique_ptr< const Acts::Logger logger = Acts::getDefaultLogger("ParticleKillAction",                                                Acts::Logging::INFO) 
)

Construct the stepping action

Parameters
cfgthe configuration struct
loggerthe ACTS logging instance

Definition at line 25 of file ParticleKillAction.cpp.

View newest version in sPHENIX GitHub at line 25 of file ParticleKillAction.cpp

ActsExamples::ParticleKillAction::~ParticleKillAction ( )
overridedefault

Member Function Documentation

const Acts::Logger& ActsExamples::ParticleKillAction::logger ( ) const
inlineprivate

Definition at line 57 of file ParticleKillAction.hpp.

View newest version in sPHENIX GitHub at line 57 of file ParticleKillAction.hpp

References m_logger.

void ActsExamples::ParticleKillAction::UserSteppingAction ( const G4Step *  step)
override

Called every step, conditionally sets the tracking state to fStopAndKill

Parameters
stepis the Geant4 step of the particle

Definition at line 29 of file ParticleKillAction.cpp.

View newest version in sPHENIX GitHub at line 29 of file ParticleKillAction.cpp

References ACTS_DEBUG, m_cfg(), Acts::UnitConstants::mm, Acts::UnitConstants::ns, Acts::Test::pos, and Acts::Test::time.

+ Here is the call graph for this function:

Member Data Documentation

Config ActsExamples::ParticleKillAction::m_cfg
private

Definition at line 59 of file ParticleKillAction.hpp.

View newest version in sPHENIX GitHub at line 59 of file ParticleKillAction.hpp

std::unique_ptr<const Acts::Logger> ActsExamples::ParticleKillAction::m_logger
private

Definition at line 60 of file ParticleKillAction.hpp.

View newest version in sPHENIX GitHub at line 60 of file ParticleKillAction.hpp

Referenced by logger().


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