ATLAS Offline Software
Classes | Public Member Functions | Private Member Functions | Private Attributes | List of all members
G4UA::G4SimTimer Class Reference

A user action for monitoring G4 runtime at event and run level. More...

#include <G4SimTimer.h>

Inheritance diagram for G4UA::G4SimTimer:
Collaboration diagram for G4UA::G4SimTimer:

Classes

struct  Report
 Simple struct which holds timing results for an action instance. More...
 

Public Member Functions

 G4SimTimer ()
 Constructor. More...
 
virtual void BeginOfEventAction (const G4Event *event) override final
 Start timing this Geant4 event. More...
 
virtual void EndOfEventAction (const G4Event *event) override final
 Finish timing this Geant4 event. More...
 
const ReportgetReport () const
 Retrieve my timing results. More...
 
bool msgLvl (const MSG::Level lvl) const
 Test the output level. More...
 
MsgStream & msg () const
 The standard message stream. More...
 
MsgStream & msg (const MSG::Level lvl) const
 The standard message stream. More...
 
void setLevel (MSG::Level lvl)
 Change the current logging level. More...
 

Private Member Functions

void initMessaging () const
 Initialize our message level and MessageSvc. More...
 

Private Attributes

G4Timer m_eventTimer
 My private instance of an event timer. More...
 
Report m_results
 My timing results. More...
 
bool m_firstEvent
 Used to skip the first event. More...
 
std::string m_nm
 Message source name. More...
 
boost::thread_specific_ptr< MsgStream > m_msg_tls
 MsgStream instance (a std::cout like with print-out levels) More...
 
std::atomic< IMessageSvc * > m_imsg { nullptr }
 MessageSvc pointer. More...
 
std::atomic< MSG::Level > m_lvl { MSG::NIL }
 Current logging level. More...
 
std::atomic_flag m_initialized ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT
 Messaging initialized (initMessaging) More...
 

Detailed Description

A user action for monitoring G4 runtime at event and run level.

This class implements the event and run action interfaces. The implementation was mostly taken from the previous G4SimTimer design. Results across worker threads are merged in finalize method of the G4SimTimerTool.

IMPORTANT NOTE: The G4SimTimer results will seem nonsensical in MT because the USER time is reported which sums over all threads in the process. The per-event timing can roughly be determined by dividing by the number of threads, but this is only precise when averaged over all events.

Todo:
TODO: Enable the run timer using a run-action (now possible).
Author
Steve Farrell <Steven.Farrell>

Definition at line 40 of file G4SimTimer.h.

Constructor & Destructor Documentation

◆ G4SimTimer()

G4UA::G4SimTimer::G4SimTimer ( )

Constructor.

Definition at line 35 of file G4SimTimer.cxx.

36  : AthMessaging("G4SimTimer"),
37  m_firstEvent(true)
38  {}

Member Function Documentation

◆ BeginOfEventAction()

void G4UA::G4SimTimer::BeginOfEventAction ( const G4Event *  event)
finaloverridevirtual

Start timing this Geant4 event.

Definition at line 43 of file G4SimTimer.cxx.

44  {
45  //ATH_MSG_INFO("beginOfEvent");
46  m_eventTimer.Start();
47  }

◆ EndOfEventAction()

void G4UA::G4SimTimer::EndOfEventAction ( const G4Event *  event)
finaloverridevirtual

Finish timing this Geant4 event.

Definition at line 52 of file G4SimTimer.cxx.

53  {
54  m_eventTimer.Stop();
55  // We define time as user+system time.
56  auto eventTime = m_eventTimer.GetUserElapsed() + m_eventTimer.GetSystemElapsed();
57  // Skip the first event
58  if(!m_firstEvent) {
59  m_results.nEvent++;
60  m_results.eventTime += eventTime;
61  m_results.eventTimeSquared += eventTime*eventTime;
62  auto meanSigma = m_results.meanAndSigma();
63  ATH_MSG_INFO("Event " << m_results.nEvent << " took " <<
64  std::setprecision(4) << eventTime << " s. New average " <<
65  std::setprecision(4) << meanSigma.first << " +- " <<
66  std::setprecision(4) << meanSigma.second);
67  }
68  else m_firstEvent = false;
69  }

◆ getReport()

const Report& G4UA::G4SimTimer::getReport ( ) const
inline

Retrieve my timing results.

Definition at line 77 of file G4SimTimer.h.

78  { return m_results; }

◆ initMessaging()

void AthMessaging::initMessaging ( ) const
privateinherited

Initialize our message level and MessageSvc.

This method should only be called once.

Definition at line 39 of file AthMessaging.cxx.

40 {
42  m_lvl = m_imsg ?
43  static_cast<MSG::Level>( m_imsg.load()->outputLevel(m_nm) ) :
44  MSG::INFO;
45 }

◆ msg() [1/2]

MsgStream & AthMessaging::msg ( ) const
inlineinherited

The standard message stream.

Returns a reference to the default message stream May not be invoked before sysInitialize() has been invoked.

Definition at line 164 of file AthMessaging.h.

165 {
166  MsgStream* ms = m_msg_tls.get();
167  if (!ms) {
168  if (!m_initialized.test_and_set()) initMessaging();
169  ms = new MsgStream(m_imsg,m_nm);
170  m_msg_tls.reset( ms );
171  }
172 
173  ms->setLevel (m_lvl);
174  return *ms;
175 }

◆ msg() [2/2]

MsgStream & AthMessaging::msg ( const MSG::Level  lvl) const
inlineinherited

The standard message stream.

Returns a reference to the default message stream May not be invoked before sysInitialize() has been invoked.

Definition at line 179 of file AthMessaging.h.

180 { return msg() << lvl; }

◆ msgLvl()

bool AthMessaging::msgLvl ( const MSG::Level  lvl) const
inlineinherited

Test the output level.

Parameters
lvlThe message level to test against
Returns
boolean Indicating if messages at given level will be printed
Return values
trueMessages at level "lvl" will be printed

Definition at line 151 of file AthMessaging.h.

152 {
153  if (!m_initialized.test_and_set()) initMessaging();
154  if (m_lvl <= lvl) {
155  msg() << lvl;
156  return true;
157  } else {
158  return false;
159  }
160 }

◆ setLevel()

void AthMessaging::setLevel ( MSG::Level  lvl)
inherited

Change the current logging level.

Use this rather than msg().setLevel() for proper operation with MT.

Definition at line 28 of file AthMessaging.cxx.

29 {
30  m_lvl = lvl;
31 }

Member Data Documentation

◆ ATLAS_THREAD_SAFE

std::atomic_flag m_initialized AthMessaging::ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT
mutableprivateinherited

Messaging initialized (initMessaging)

Definition at line 141 of file AthMessaging.h.

◆ m_eventTimer

G4Timer G4UA::G4SimTimer::m_eventTimer
private

My private instance of an event timer.

Definition at line 83 of file G4SimTimer.h.

◆ m_firstEvent

bool G4UA::G4SimTimer::m_firstEvent
private

Used to skip the first event.

Definition at line 89 of file G4SimTimer.h.

◆ m_imsg

std::atomic<IMessageSvc*> AthMessaging::m_imsg { nullptr }
mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

◆ m_lvl

std::atomic<MSG::Level> AthMessaging::m_lvl { MSG::NIL }
mutableprivateinherited

Current logging level.

Definition at line 138 of file AthMessaging.h.

◆ m_msg_tls

boost::thread_specific_ptr<MsgStream> AthMessaging::m_msg_tls
mutableprivateinherited

MsgStream instance (a std::cout like with print-out levels)

Definition at line 132 of file AthMessaging.h.

◆ m_nm

std::string AthMessaging::m_nm
privateinherited

Message source name.

Definition at line 129 of file AthMessaging.h.

◆ m_results

Report G4UA::G4SimTimer::m_results
private

My timing results.

Definition at line 86 of file G4SimTimer.h.


The documentation for this class was generated from the following files:
AthMessaging::m_lvl
std::atomic< MSG::Level > m_lvl
Current logging level.
Definition: AthMessaging.h:138
G4UA::G4SimTimer::Report::eventTime
double eventTime
Accumulated event time.
Definition: G4SimTimer.h:54
G4UA::G4SimTimer::Report::eventTimeSquared
double eventTimeSquared
Accumulated squared event time.
Definition: G4SimTimer.h:56
ATH_MSG_INFO
#define ATH_MSG_INFO(x)
Definition: AthMsgStreamMacros.h:31
G4UA::G4SimTimer::Report::nEvent
unsigned int nEvent
Number of timed G4 events (we skip the first).
Definition: G4SimTimer.h:52
AthMessaging::m_imsg
std::atomic< IMessageSvc * > m_imsg
MessageSvc pointer.
Definition: AthMessaging.h:135
python.SystemOfUnits.ms
int ms
Definition: SystemOfUnits.py:132
Athena::getMessageSvc
IMessageSvc * getMessageSvc(bool quiet=false)
Definition: getMessageSvc.cxx:20
G4UA::G4SimTimer::Report::meanAndSigma
std::pair< double, double > meanAndSigma()
Calculate the mean and sample std dev.
Definition: G4SimTimer.cxx:23
AthMessaging::AthMessaging
AthMessaging()
Default constructor:
TrigConf::MSGTC::Level
Level
Definition: Trigger/TrigConfiguration/TrigConfBase/TrigConfBase/MsgStream.h:21
G4UA::G4SimTimer::m_eventTimer
G4Timer m_eventTimer
My private instance of an event timer.
Definition: G4SimTimer.h:83
AthMessaging::msg
MsgStream & msg() const
The standard message stream.
Definition: AthMessaging.h:164
G4UA::G4SimTimer::m_results
Report m_results
My timing results.
Definition: G4SimTimer.h:86
G4UA::G4SimTimer::m_firstEvent
bool m_firstEvent
Used to skip the first event.
Definition: G4SimTimer.h:89
AthMessaging::m_nm
std::string m_nm
Message source name.
Definition: AthMessaging.h:129
AthMessaging::initMessaging
void initMessaging() const
Initialize our message level and MessageSvc.
Definition: AthMessaging.cxx:39
AthMessaging::m_msg_tls
boost::thread_specific_ptr< MsgStream > m_msg_tls
MsgStream instance (a std::cout like with print-out levels)
Definition: AthMessaging.h:132