SteppingAction Class Reference

The Class for the stepping action. More...

#include <SteppingAction.h>

Inheritance diagram for SteppingAction:

Collaboration diagram for SteppingAction:

Public Member Functions
	SteppingAction ()
	Constructor.
virtual	~SteppingAction ()
	Destructor.
void	setMaxNumberSteps (int maxSteps)
	Sets the maximum number of steps before a track is stopped and killed. More...
void	setStoreTrajectories (bool store)
	Sets the trajectory option to enable storing of the simulated particle trajectories.
void	setAbsorbersR (const std::vector< float > &vec)
	Sets the radii of absorbers for killing tracks across them. More...
virtual void	UserSteppingAction (const G4Step *step)
	The method will be called at each step during simulation. More...

Protected Attributes
int	m_maxNumberSteps
	The maximum number of steps before the track transportation is stopped and the track is killed.
bool	m_storeTrajectories = false
	if true, check if the track has attached trajectory info and append step information if necessary
std::vector< float >	m_absorbers
	The absorbers defined at given radii where tracks across them will be destroyed.

Detailed Description

The Class for the stepping action.

This class is called for each step during the Geant4 transportation. It implements protection mechanisms to remove unreasonable tracks.

Definition at line 29 of file SteppingAction.h.

Member Function Documentation

setAbsorbersR()

void setAbsorbersR ( const std::vector< float > &  vec )

inline

Sets the radii of absorbers for killing tracks across them.

This set is used in the PXD only simulation for PXD gain calibration.

Parameters

vec	The c++ vector with the radii of absorbers in cm

Definition at line 55 of file SteppingAction.h.

{ m_absorbers = vec; };

setMaxNumberSteps()

void setMaxNumberSteps ( int  maxSteps )

inline

Sets the maximum number of steps before a track is stopped and killed.

Parameters

maxSteps

The maximum number of steps.

Definition at line 46 of file SteppingAction.h.

UserSteppingAction()

void UserSteppingAction ( const G4Step *  step )

virtual

The method will be called at each step during simulation.

Parameters

step	The pointer of current step.

Definition at line 38 of file SteppingAction.cc.

{
  G4Track* track = step->GetTrack();
 
  //------------------------------
  // Check for NULL world volume
  //------------------------------
  if (track->GetVolume() == NULL) {
    B2WARNING("SteppingAction: Track in NULL volume, terminating!\n"
              << "step_no=" << track->GetCurrentStepNumber() << " type=" << track->GetDefinition()->GetParticleName()
              << "\n position=" << G4BestUnit(track->GetPosition(), "Length") << " momentum=" << G4BestUnit(track->GetMomentum(), "Energy"));
    track->SetTrackStatus(fStopAndKill);
    return;
  }
 
  //------------------------------
  // Check for absorbers
  //------------------------------
  for (auto& rAbsorber : m_absorbers) {
    const G4ThreeVector stepPrePos = step->GetPreStepPoint()->GetPosition() / CLHEP::mm * Unit::mm;
    const G4ThreeVector stepPostPos = step->GetPostStepPoint()->GetPosition() / CLHEP::mm * Unit::mm;
    if (stepPrePos.perp() < (rAbsorber * Unit::cm) && stepPostPos.perp() > (rAbsorber * Unit::cm)) {
      //B2WARNING("SteppingAction: Track across absorbers, terminating!\n"
      //<< "step_no=" << track->GetCurrentStepNumber() << " type=" << track->GetDefinition()->GetParticleName()
      //<< "\n position=" << G4BestUnit(track->GetPosition(), "Length") << " momentum=" << G4BestUnit(track->GetMomentum(), "Energy") << "\n  PrePos.perp=" << stepPrePos.perp() << ", PostPos.perp=" << stepPostPos.perp() << " cm" );
      track->SetTrackStatus(fStopAndKill);
      return;
    }
  }
 
  //---------------------------------------
  // Check for very high number of steps.
  //---------------------------------------
  if (track->GetCurrentStepNumber() > m_maxNumberSteps) {
    B2WARNING("SteppingAction: Too many steps for this track, terminating!\n"
              << "step_no=" << track->GetCurrentStepNumber() << "type=" << track->GetDefinition()->GetParticleName()
              << "\n position=" << G4BestUnit(track->GetPosition(), "Length") << " momentum=" << G4BestUnit(track->GetMomentum(), "Energy"));
    track->SetTrackStatus(fStopAndKill);
    return;
  }
 
  //-----------------------------------------------------------
  // Check if there is an attached trajectory. If so, fill it.
  //-----------------------------------------------------------
  if (m_storeTrajectories) {
    TrackInfo* info = dynamic_cast<TrackInfo*>(track->GetUserInformation());
    if (info && info->getTrajectory()) {
      MCParticleTrajectory& trajectory = *(info->getTrajectory());
      if (trajectory.empty()) {
        const G4ThreeVector stepPos = step->GetPreStepPoint()->GetPosition() / CLHEP::mm * Unit::mm;
        const G4ThreeVector stepMom = step->GetPreStepPoint()->GetMomentum() / CLHEP::MeV * Unit::MeV;
        trajectory.addPoint(
          stepPos.x(), stepPos.y(), stepPos.z(),
          stepMom.x(), stepMom.y(), stepMom.z()
        );
      }
      const G4ThreeVector stepPos = step->GetPostStepPoint()->GetPosition() / CLHEP::mm * Unit::mm;
      const G4ThreeVector stepMom = step->GetPostStepPoint()->GetMomentum() / CLHEP::MeV * Unit::MeV;
      trajectory.addPoint(
        stepPos.x(), stepPos.y(), stepPos.z(),
        stepMom.x(), stepMom.y(), stepMom.z()
      );
    }
  }
}

---

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

• simulation/kernel/include/SteppingAction.h
• simulation/kernel/src/SteppingAction.cc