Class to perform more detailed timing studies of the Geant4 simulation. More...

#include <StepTiming.h>

Inheritance diagram for StepTiming:

Public Types
typedef std::function< void(G4Track , G4LogicalVolume , double)>	callbackType
	Signature of the callback function.

Public Member Functions
	StepTiming (const callbackType &callback)
	Constructor: create an instance with a given callback function.

virtual void	NewStep ()
	Start timing a new step.

virtual void	StepInfo ()
	Step finished, call callback function.

virtual void	AtRestDoItInvoked ()
	ignored, empty stub only implemented because it's pure virtual in base class

virtual void	AlongStepDoItAllDone ()
	ignored, empty stub only implemented because it's pure virtual in base class

virtual void	PostStepDoItAllDone ()
	ignored, empty stub only implemented because it's pure virtual in base class

virtual void	AlongStepDoItOneByOne ()
	ignored, empty stub only implemented because it's pure virtual in base class

virtual void	PostStepDoItOneByOne ()
	ignored, empty stub only implemented because it's pure virtual in base class

virtual void	TrackingStarted ()
	ignored, empty stub only implemented because it's pure virtual in base class

virtual void	DPSLStarted ()
	ignored, empty stub only implemented because it's pure virtual in base class

virtual void	DPSLUserLimit ()
	ignored, empty stub only implemented because it's pure virtual in base class

virtual void	DPSLPostStep ()
	ignored, empty stub only implemented because it's pure virtual in base class

virtual void	DPSLAlongStep ()
	ignored, empty stub only implemented because it's pure virtual in base class

virtual void	VerboseTrack ()
	ignored, empty stub only implemented because it's pure virtual in base class

virtual void	VerboseParticleChange ()
	ignored, empty stub only implemented because it's pure virtual in base class

Private Attributes
callbackType	m_callback
	callback function to call

double	m_startTime {0}
	start time of the step

Detailed Description

Class to perform more detailed timing studies of the Geant4 simulation.

This class overrides the default G4SteppingVerbose implementation which is used by Geant4 to display stepping information. It measures the time for each step and calls a given callback function with a pointer to the track, the volume in which the step occured and the time needed for that step.

Measuring the time in each step causes a overhead of 10%-20% so this should not be used in production

Definition at line 33 of file StepTiming.h.

Member Typedef Documentation

◆ callbackType

typedef std::function<void (G4Track*, G4LogicalVolume*, double)> callbackType

Signature of the callback function.

Definition at line 36 of file StepTiming.h.

Constructor & Destructor Documentation

◆ StepTiming()

StepTiming ( const callbackType & callback )

inlineexplicit

Constructor: create an instance with a given callback function.

Definition at line 38 of file StepTiming.h.

38: G4VSteppingVerbose(), m_callback(callback) {}

Member Function Documentation

◆ AlongStepDoItAllDone()

virtual void AlongStepDoItAllDone ( )

inlinevirtual

ignored, empty stub only implemented because it's pure virtual in base class

Definition at line 46 of file StepTiming.h.

46{};

◆ AlongStepDoItOneByOne()

virtual void AlongStepDoItOneByOne ( )

inlinevirtual

ignored, empty stub only implemented because it's pure virtual in base class

Definition at line 50 of file StepTiming.h.

50{};

◆ AtRestDoItInvoked()

virtual void AtRestDoItInvoked ( )

inlinevirtual

ignored, empty stub only implemented because it's pure virtual in base class

Definition at line 44 of file StepTiming.h.

44{};

◆ DPSLAlongStep()

virtual void DPSLAlongStep ( )

inlinevirtual

ignored, empty stub only implemented because it's pure virtual in base class

Definition at line 62 of file StepTiming.h.

62{};

◆ DPSLPostStep()

virtual void DPSLPostStep ( )

inlinevirtual

ignored, empty stub only implemented because it's pure virtual in base class

Definition at line 60 of file StepTiming.h.

60{};

◆ DPSLStarted()

virtual void DPSLStarted ( )

inlinevirtual

ignored, empty stub only implemented because it's pure virtual in base class

Definition at line 56 of file StepTiming.h.

56{};

◆ DPSLUserLimit()

virtual void DPSLUserLimit ( )

inlinevirtual

ignored, empty stub only implemented because it's pure virtual in base class

Definition at line 58 of file StepTiming.h.

58{};

◆ NewStep()

void NewStep ( )

virtual

Start timing a new step.

Definition at line 21 of file StepTiming.cc.

    {
      //Start timing the step
      m_startTime = Utils::getClock();
    }

◆ PostStepDoItAllDone()

virtual void PostStepDoItAllDone ( )

inlinevirtual

ignored, empty stub only implemented because it's pure virtual in base class

Definition at line 48 of file StepTiming.h.

48{};

◆ PostStepDoItOneByOne()

virtual void PostStepDoItOneByOne ( )

inlinevirtual

ignored, empty stub only implemented because it's pure virtual in base class

Definition at line 52 of file StepTiming.h.

52{};

◆ StepInfo()

void StepInfo ( )

virtual

Step finished, call callback function.

Definition at line 26 of file StepTiming.cc.

    {
      //Step is done, get track and volume
      fTrack = fManager->GetfTrack();
      G4LogicalVolume* volume = fTrack->GetStep()->GetPreStepPoint()->GetPhysicalVolume()->GetLogicalVolume();
      //calculate elapsed time
      const double time = Utils::getClock() - m_startTime;
      //call callback function
      m_callback(fTrack, volume, time);
    }

◆ TrackingStarted()

virtual void TrackingStarted ( )

inlinevirtual

ignored, empty stub only implemented because it's pure virtual in base class

Definition at line 54 of file StepTiming.h.

54{};

◆ VerboseParticleChange()

virtual void VerboseParticleChange ( )

inlinevirtual

ignored, empty stub only implemented because it's pure virtual in base class

Definition at line 66 of file StepTiming.h.

66{};

◆ VerboseTrack()

virtual void VerboseTrack ( )

inlinevirtual

ignored, empty stub only implemented because it's pure virtual in base class

Definition at line 64 of file StepTiming.h.

64{};

Member Data Documentation

◆ m_callback

callbackType m_callback

private

callback function to call

Definition at line 69 of file StepTiming.h.

◆ m_startTime

double m_startTime {0}

private

start time of the step

Definition at line 71 of file StepTiming.h.

71{0};

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

simulation/kernel/include/StepTiming.h
simulation/kernel/src/StepTiming.cc

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ callbackType

Constructor & Destructor Documentation

◆ StepTiming()

Member Function Documentation

◆ AlongStepDoItAllDone()

◆ AlongStepDoItOneByOne()

◆ AtRestDoItInvoked()

◆ DPSLAlongStep()

◆ DPSLPostStep()

◆ DPSLStarted()

◆ DPSLUserLimit()

◆ NewStep()

◆ PostStepDoItAllDone()

◆ PostStepDoItOneByOne()

◆ StepInfo()

◆ TrackingStarted()

◆ VerboseParticleChange()

◆ VerboseTrack()

Member Data Documentation

◆ m_callback

◆ m_startTime