G4UA::LooperKiller Class Reference

A user action to kill looping tracks. More...

#include <LooperKiller.h>

Inheritance diagram for G4UA::LooperKiller:

Collaboration diagram for G4UA::LooperKiller:

Classes
struct	Config
struct	Report

Public Member Functions
	LooperKiller (const Config &config)
virtual void	UserSteppingAction (const G4Step *) override
const Report &	getReport () const
	Retrieve 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 Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

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

Private Attributes
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...
Config	m_config
	My configuration options. More...
Report	m_report
int	m_count_steps
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 to kill looping tracks.

Definition at line 22 of file LooperKiller.h.

Member Typedef Documentation

StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> G4UA::LooperKiller::StoreGateSvc_t

private

Definition at line 54 of file LooperKiller.h.

Constructor & Destructor Documentation

LooperKiller()

G4UA::LooperKiller::LooperKiller

(

const Config &

config

)

Definition at line 31 of file LooperKiller.cxx.

    : AthMessaging(Gaudi::svcLocator()->service<IMessageSvc>("MessageSvc"),
                   "LooperKiller"),
      m_evtStore("StoreGateSvc/StoreGateSvc", "LooperKiller"),
      m_detStore("StoreGateSvc/DetectorStore", "LooperKiller"),
      m_config(config), m_report(), m_count_steps(0)
  {
  }

Member Function Documentation

getReport()

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

inline

Retrieve results.

Definition at line 49 of file LooperKiller.h.

      { return m_report; }

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();
  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 164 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 179 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_initialized.test_and_set()) initMessaging();
  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;
}

UserSteppingAction()

void G4UA::LooperKiller::UserSteppingAction ( const G4Step *  aStep )

overridevirtual

Definition at line 41 of file LooperKiller.cxx.

  {
 
    if (aStep->GetTrack()->GetCurrentStepNumber() < m_config.MaxSteps) {
      if (m_count_steps==0) return;
      // Track recovered...
      ATH_MSG_WARNING("Track finished on its own.  Congrats.  Moving on with the event.");
      m_count_steps = 0;
      G4TransportationManager *tm = G4TransportationManager::GetTransportationManager();
      tm->GetNavigatorForTracking()->SetVerboseLevel(0);
      tm->GetPropagatorInField()->SetVerboseLevel(0);
      G4RunManagerKernel *rmk = G4RunManagerKernel::GetRunManagerKernel();
      rmk->GetTrackingManager()->SetVerboseLevel(0);
      rmk->GetTrackingManager()->GetSteppingManager()->SetVerboseLevel(0);
      rmk->GetStackManager()->SetVerboseLevel(0);
      return;
    } else if (aStep->GetTrack()->GetCurrentStepNumber() == m_config.MaxSteps) {
      ATH_MSG_WARNING("LooperKiller triggered!! Hold on to your hats!!!!!!!!" );
    }
 
    G4TransportationManager *tm = G4TransportationManager::GetTransportationManager();
    tm->GetNavigatorForTracking()->SetVerboseLevel(m_config.VerboseLevel);
    tm->GetPropagatorInField()->SetVerboseLevel(m_config.VerboseLevel);
 
    G4RunManagerKernel *rmk = G4RunManagerKernel::GetRunManagerKernel();
    rmk->GetTrackingManager()->SetVerboseLevel(m_config.VerboseLevel);
    rmk->GetTrackingManager()->GetSteppingManager()->SetVerboseLevel(m_config.VerboseLevel);
    rmk->GetStackManager()->SetVerboseLevel(m_config.VerboseLevel);
 
    m_count_steps++;
 
    if (m_count_steps>m_config.PrintSteps) {
      m_count_steps = 0;
      m_report.killed_tracks++;
      aStep->GetTrack()->SetTrackStatus(fStopAndKill);
      tm->GetNavigatorForTracking()->SetVerboseLevel(0);
      tm->GetPropagatorInField()->SetVerboseLevel(0);
      rmk->GetTrackingManager()->SetVerboseLevel(0);
      rmk->GetTrackingManager()->GetSteppingManager()->SetVerboseLevel(0);
      rmk->GetStackManager()->SetVerboseLevel(0);
      int pdg_id{0};
      TrackHelper trackHelper(aStep->GetTrack());
      if ( m_config.BSM_Only && (trackHelper.IsPrimary() || trackHelper.IsRegisteredSecondary()) ) {
        HepMC::GenParticlePtr part = trackHelper.GetTrackInformation()->GetCurrentGenParticle();
        if (part) { pdg_id = part->pdg_id(); }
      }
      if ( !m_config.BSM_Only || MC::isBSM(pdg_id)) { // Sometimes we may ony want to bail out for BSM particles.
        // Bail out...
        if (m_config.AbortEvent){
          rmk->GetEventManager()->AbortCurrentEvent();
          rmk->GetEventManager()->GetNonconstCurrentEvent()->SetEventAborted();
        }
        if (m_config.SetError){
 
          // Set error state in eventInfo
          SG::ReadHandle<xAOD::EventInfo> eic("McEventInfo");
          if (! eic.isValid()){
            ATH_MSG_WARNING( "Failed to retrieve EventInfo" );
          } else {
            eic->updateErrorState(xAOD::EventInfo::Core,xAOD::EventInfo::Error);
            ATH_MSG_WARNING( "Set error state in event info!" );
          }
        } // End of set error
      } // End of BSM-only check
      const std::string name = aStep->GetTrack()->GetDefinition()->GetParticleName();
      if ( ( m_config.BSM_Only && !MC::isBSM(pdg_id) ) || !m_config.AbortEvent )  {
          ATH_MSG_INFO ("Quietly stopped tracking looping " << name
                        << " (trackID " << aStep->GetTrack()->GetTrackID()
                        << ", track pos: "<<aStep->GetTrack()->GetPosition()
                        << ", mom: "<<aStep->GetTrack()->GetMomentum()
                        << ", parentID " << aStep->GetTrack()->GetParentID() << ")");
        } else {
          ATH_MSG_WARNING ("Stopped tracking looping " << name
                        << " (trackID " << aStep->GetTrack()->GetTrackID()
                        << ", track pos: "<<aStep->GetTrack()->GetPosition()
                        << ", mom: "<<aStep->GetTrack()->GetMomentum()
                        << ", parentID " << aStep->GetTrack()->GetParentID() << "). The event will abort now.");
        }
    } // End of handling end of error time
  }

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_config

Config G4UA::LooperKiller::m_config

private

My configuration options.

Definition at line 61 of file LooperKiller.h.

m_count_steps

int G4UA::LooperKiller::m_count_steps

private

Definition at line 63 of file LooperKiller.h.

m_detStore

StoreGateSvc_t G4UA::LooperKiller::m_detStore

private

Pointer to StoreGate (detector store by default)

Definition at line 58 of file LooperKiller.h.

m_evtStore

StoreGateSvc_t G4UA::LooperKiller::m_evtStore

private

Pointer to StoreGate (event store by default)

Definition at line 56 of file LooperKiller.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_report

Report G4UA::LooperKiller::m_report

private

Definition at line 62 of file LooperKiller.h.

---

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

• LooperKiller.h
• LooperKiller.cxx