TestActionTimer.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/

//                                                              //
//     $Id: TestActionTimer.h 660034 2015-04-10 17:20:49Z jchapman $ //
//                                                              //
//                      TestActionTimer                         //
//      Code for text output (into log file)                    //
//      of information about the time spent simulating          //
//      various pieces of the detector and particles.           //
//                                                              //
//      Written by                                              //
//         Zachary Marshall, Caltech, USA                       //
//         Wolfgang Ehrenfeld, University of Hamburg, Germany   //
//                                                              //
//      @version $Revision: 660034 $ //
//                                                              //
 
#ifndef TestActionTimer_H
#define TestActionTimer_H
 
 
#include <string>
#include <vector>
 
#include "G4String.hh"
 
#include "G4UserEventAction.hh"
#include "G4UserRunAction.hh"
#include "G4UserSteppingAction.hh"
 
// Forward declarations
class G4Run;
class G4Event;
class G4Step;
class G4Timer;
class ITHistSvc;
 
namespace G4UA
{

 
  class TestActionTimer:
  public G4UserEventAction, public G4UserRunAction,  public G4UserSteppingAction
  {
 
  public:
    TestActionTimer();
 
    TestActionTimer(const TestActionTimer&) = delete;
    TestActionTimer& operator=(const TestActionTimer&) = delete;

    struct Report
    {
      int nev=0;
      std::vector<double> time; 
      std::vector<std::string> timeName;  
      double runTime=0;
      void merge(const Report& rep){
        nev+=rep.nev;
        runTime+=rep.runTime;
        // copy first report
        if(time.empty()){
          time=rep.time;
          timeName=rep.timeName;
          return;
        }
        // sum the following ones
        for(unsigned int i=0;i<time.size();++i)
          time[i]+=rep.time[i];
      }
    };
 
    const Report& getReport() const
    { return m_report; }
 
    virtual void BeginOfEventAction(const G4Event*) override;
    virtual void EndOfEventAction(const G4Event*) override;
    virtual void BeginOfRunAction(const G4Run*) override;
    virtual void EndOfRunAction(const G4Run*) override;
    virtual void UserSteppingAction(const G4Step*) override;
 
    /* Enumeration for timers to be used
       First timers are by subdetector, second few are by particle
       These are not straightforward for the non-expert to interpret*/
    enum { eEMB, eEMEC, eFC1, eFC23, eFCO, eHEC, eCry, eLAr, eHCB,
      ePre, eMu, ePx, eSct, eITkPix, eITkStrip, eSev, eTrt, eHGTD, eOther,
      eElec, ePos, eGam, eNeut, eMax };
 
  private:
 
    Report m_report{};
 
    G4Timer* m_runTimer{};                     
    G4Timer* m_eventTimer{};                   
    double  m_eventTime{};           
 
    std::vector<G4Timer*> m_timer{};           
 
    double TimerSum(G4Timer* timer) const;   
 
    void PPanic();                           
    void VPanic();                           
    int ClassifyVolume( G4String& ) const; 
 
  }; // class TestActionTimer
 
} // namespace G4UA
 
#endif // #define TestActionTimer_H