simcore::g4user::SteppingAction Class Reference

Implements the Geant4 user stepping action. More...

#include <SteppingAction.h>

Public Member Functions
	~SteppingAction ()
	Destructor.
void	UserSteppingAction (const G4Step *step) override
	Callback used to process a step.
void	registerAction (UserAction *steppingAction)
	Register a user action of type SteppingAction with this class.

Private Attributes
std::vector< UserAction * >	steppingActions_
	Collection of user stepping actions.

Detailed Description

Implements the Geant4 user stepping action.

Definition at line 31 of file SteppingAction.h.

Constructor & Destructor Documentation

~SteppingAction()

simcore::g4user::SteppingAction::~SteppingAction ( )

inline

Destructor.

Definition at line 34 of file SteppingAction.h.

{}

Member Function Documentation

registerAction()

void simcore::g4user::SteppingAction::registerAction ( UserAction *  steppingAction )

inline

Register a user action of type SteppingAction with this class.

Parameters

action

User action of type SteppingAction

Definition at line 48 of file SteppingAction.h.

                                                  {
    steppingActions_.push_back(steppingAction);
  }

References steppingActions_.

UserSteppingAction()

void simcore::g4user::SteppingAction::UserSteppingAction ( const G4Step *  step )

override

Callback used to process a step.

Parameters

step	The Geant4 step.

Reset PN/EN flags and updating running energy totals

The process of looping through the secondaries of every step may slow down our simulation. I (Tom E) do not know how much it would slow us down, but we could implement a procedure to make this configurable if we wish.

Definition at line 5 of file SteppingAction.cxx.

                                                          {
  auto event_info{static_cast<UserEventInformation*>(
      G4EventManager::GetEventManager()->GetUserInformation())};
 
  // get the track weights before this step and after this step
  //  ** these weights include the factors of all upstream step weights **
  double track_weight_pre_step = step->GetPreStepPoint()->GetWeight();
  double track_weight_post_step = step->GetPostStepPoint()->GetWeight();
 
  //  so, to get _this_ step's weight, we divide post_weight by pre_weight
  double weight_of_this_step_alone =
      track_weight_post_step / track_weight_pre_step;
 
  event_info->incWeight(weight_of_this_step_alone);
 
  const std::vector<const G4Track*>* secondaries{
      step->GetSecondaryInCurrentStep()};
 
  event_info->lastStepWasPN(false);
  event_info->lastStepWasEN(false);
  if (secondaries) {
    double delta_energy = step->GetPreStepPoint()->GetKineticEnergy() -
                          step->GetPostStepPoint()->GetKineticEnergy();
    for (const G4Track* secondary : *secondaries) {
      const G4VProcess* creator{secondary->GetCreatorProcess()};
      if (creator) {
        const G4String& creator_name{creator->GetProcessName()};
        if (creator_name.contains("photonNuclear")) {
          event_info->addPNEnergy(delta_energy);
          event_info->lastStepWasPN(true);
          break;  // done <- assumes first match determines step process
        }
        if (creator_name.contains("electronNuclear")) {
          event_info->addENEnergy(delta_energy);
          event_info->lastStepWasEN(true);
          break;  // done <- assumes first match determines step process
        }         // creator name matches PN or EN
      }           // creator exists
    }             // loop over secondaries
  }               // secondaries list was created
  // now stepping actions can use getEventInfo()->wasLastStep{P,E}N()
  //  to determine if last step was PN or EN
  for (auto& steppingAction : steppingActions_) steppingAction->stepping(step);
}

References simcore::UserEventInformation::incWeight(), and steppingActions_.

Member Data Documentation

steppingActions_

std::vector<UserAction*> simcore::g4user::SteppingAction::steppingActions_

private

Collection of user stepping actions.

Definition at line 54 of file SteppingAction.h.

Referenced by registerAction(), and UserSteppingAction().

---

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

• SimCore/include/SimCore/G4User/SteppingAction.h
• SimCore/src/SimCore/G4User/SteppingAction.cxx