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.
virtual void	BeginOfEventAction (const G4Event *event) override final
	Start timing this Geant4 event.
virtual void	EndOfEventAction (const G4Event *event) override final
	Finish timing this Geant4 event.
const Report &	getReport () const
	Retrieve my timing results.
bool	msgLvl (const MSG::Level lvl) const
	Test the output level.
MsgStream &	msg () const
	The standard message stream.
MsgStream &	msg (const MSG::Level lvl) const
	The standard message stream.
void	setLevel (MSG::Level lvl)
	Change the current logging level.

Private Member Functions
void	initMessaging () const
	Initialize our message level and MessageSvc.

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

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.

    : AthMessaging("G4SimTimer"),
      m_firstEvent(true)
  {}

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.

  {
    //ATH_MSG_INFO("beginOfEvent");
    m_eventTimer.Start();
  }

EndOfEventAction()

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

finaloverridevirtual

Finish timing this Geant4 event.

Definition at line 52 of file G4SimTimer.cxx.

  {
    m_eventTimer.Stop();
    // We define time as user+system time.
    auto eventTime = m_eventTimer.GetUserElapsed() + m_eventTimer.GetSystemElapsed();
    // Skip the first event
    if(!m_firstEvent) {
      m_results.nEvent++;
      m_results.eventTime += eventTime;
      m_results.eventTimeSquared += eventTime*eventTime;
      auto meanSigma = m_results.meanAndSigma();
      ATH_MSG_INFO("Event  " << m_results.nEvent << " took " <<
                   std::setprecision(4) << eventTime << " s. New average " <<
                   std::setprecision(4) << meanSigma.first << " +- " <<
                   std::setprecision(4) << meanSigma.second);
    }
    else m_firstEvent = false;
  }

getReport()

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

inline

Retrieve my timing results.

Definition at line 77 of file G4SimTimer.h.

      { 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.

{
  m_imsg = Athena::getMessageSvc();
  // If user did not set an explicit level, set a default
  if (m_lvl == MSG::NIL) {
    m_lvl = m_imsg ?
      static_cast<MSG::Level>( m_imsg.load()->outputLevel(m_nm) ) :
      MSG::INFO;
  }
}

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 163 of file AthMessaging.h.

{
  MsgStream* ms = m_msg_tls.get();
  if (!ms) {
    if (!m_initialized.test_and_set()) initMessaging();
    ms = new MsgStream(m_imsg,m_nm);
    m_msg_tls.reset( ms );
  }
 
  ms->setLevel (m_lvl);
  return *ms;
}

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 178 of file AthMessaging.h.

{ return msg() << lvl; }

msgLvl()

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

inlineinherited

Test the output level.

Parameters

lvl	The message level to test against

Returns

boolean Indicating if messages at given level will be printed

Return values

true	Messages at level "lvl" will be printed

Definition at line 151 of file AthMessaging.h.

{
  if (m_lvl <= lvl) {
    msg() << lvl;
    return true;
  } else {
    return false;
  }
}

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.

{
  m_lvl = lvl;
}

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.

{ nullptr };

m_lvl

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

mutableprivateinherited

Current logging level.

Definition at line 138 of file AthMessaging.h.

{ MSG::NIL };

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:

• G4SimTimer.h
• G4SimTimer.cxx