G4UA::HyperspaceCatcher Class Reference

User action for catching cases of the hyperspace bug. More...

#include <HyperspaceCatcher.h>

Inheritance diagram for G4UA::HyperspaceCatcher:

Collaboration diagram for G4UA::HyperspaceCatcher:

Classes
struct	Config

Public Member Functions
	HyperspaceCatcher (const Config &config)
virtual void	BeginOfRunAction (const G4Run *) override
virtual void	UserSteppingAction (const G4Step *) override
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
Config	m_config
G4VSolid *	m_world
int	m_killCount
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

User action for catching cases of the hyperspace bug.

Definition at line 23 of file HyperspaceCatcher.h.

Constructor & Destructor Documentation

HyperspaceCatcher()

G4UA::HyperspaceCatcher::HyperspaceCatcher

(

const Config &

config

)

Definition at line 28 of file HyperspaceCatcher.cxx.

                                                          :
    AthMessaging(Gaudi::svcLocator()->service< IMessageSvc >( "MessageSvc" ),"HyperspaceCatcher"),
    m_config(config),
    m_world(0),
    m_killCount(0)
  {}

Member Function Documentation

BeginOfRunAction()

void G4UA::HyperspaceCatcher::BeginOfRunAction ( const G4Run * )

overridevirtual

Definition at line 35 of file HyperspaceCatcher.cxx.

  {
    // Highest level implemented is 2 at the moment
    if (m_config.treatmentLevel>2) m_config.treatmentLevel=2;
    ATH_MSG_INFO("Treatment level set to " << m_config.treatmentLevel );
 
    ATH_MSG_INFO("Set to kill after " << m_config.killAfter );
 
    G4LogicalVolumeStore * lvs = G4LogicalVolumeStore::GetInstance();
    for (auto lv : *lvs){
      if ( lv->GetName()=="Atlas::Atlas" ){
    m_world=lv->GetSolid();
    break;
      }
    }
    if (0==m_world){
      ATH_MSG_FATAL( "Could not find world volume!" );
      throw std::runtime_error("Could not find world volume!");
    }
  }

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;
}

UserSteppingAction()

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

overridevirtual

Definition at line 56 of file HyperspaceCatcher.cxx.

  {
 
    bool hs = false;
 
    // Various levels of testing.  Simple testing at level 0 : just see if it's in the neighborhood
    G4ThreeVector myPos = aStep->GetPostStepPoint()->GetPosition();
    if (std::fabs( myPos.x() )>30000. ||
        std::fabs( myPos.y() )>30000. ||
        std::fabs( myPos.z() )>50000. ){
      hs=true;
    } // Check #1 failed
    if (!hs && m_config.treatmentLevel<=0) return;
 
    if ( m_world->Inside( myPos ) == kOutside ){
      hs=true;
    } // Check #2 failed
    if (!hs && m_config.treatmentLevel<=1) return;
 
    G4VSolid * pre = aStep->GetPreStepPoint()->GetPhysicalVolume() &&
      aStep->GetPreStepPoint()->GetPhysicalVolume()->GetLogicalVolume() ?
      aStep->GetPreStepPoint()->GetPhysicalVolume()->GetLogicalVolume()->GetSolid():0;
    G4VSolid * post = aStep->GetPostStepPoint()->GetPhysicalVolume() &&
      aStep->GetPostStepPoint()->GetPhysicalVolume()->GetLogicalVolume() ?
      aStep->GetPostStepPoint()->GetPhysicalVolume()->GetLogicalVolume()->GetSolid():0;
    if ( (post && post->Inside( myPos ) == kOutside ) ||
         ( pre &&  pre->Inside( aStep->GetPreStepPoint()->GetPosition() ) == kOutside ) ) {
      hs=true;
    } // Check #3 failed
    if (!hs && m_config.treatmentLevel<=2) return;
 
    G4Track *tr = aStep->GetTrack();
    const G4ThreeVector& mom = tr->GetMomentumDirection();
 
    std::cout << "Caught a " << tr->GetDefinition()->GetParticleName() << " at (" << myPos.x()
              << ", " << myPos.y() << ", " << myPos.z() << ") to (" << mom.x() << ", " << mom.y()
              << ", " << mom.z() << ") from ";
    if (aStep->GetPreStepPoint()->GetPhysicalVolume()) {
      std::cout << aStep->GetPreStepPoint()->GetPhysicalVolume()->GetName();
    }
    else std::cout << "noVolume";
    std::cout << " to ";
    if (aStep->GetPostStepPoint()->GetPhysicalVolume()) {
      std::cout << aStep->GetPostStepPoint()->GetPhysicalVolume()->GetName();
    }
    else std::cout << "outOfWorld";
    std::cout << " with KE=" << tr->GetKineticEnergy() << " pT=" << tr->GetMomentum().perp()
              << " eta=" << tr->GetMomentum().eta() << " length " << aStep->GetStepLength() << " energy "
              << aStep->GetTotalEnergyDeposit() << " with process ";
    if (aStep->GetPostStepPoint()->GetProcessDefinedStep()) {
      std::cout << aStep->GetPostStepPoint()->GetProcessDefinedStep()->GetProcessName();
    }
    else std::cout << "Unknown";
    std::cout << " from a ";
    if (tr->GetCreatorProcess()) std::cout << tr->GetCreatorProcess()->GetProcessName();
    else if (tr->GetParentID()==0) std::cout << "Generator";
    else std::cout << "pid="<<tr->GetParentID();
    if (tr->GetLogicalVolumeAtVertex()) std::cout << " in " << tr->GetLogicalVolumeAtVertex()->GetName() << ", ";
    else std::cout << " nowhere, ";
    std::cout << tr->GetTrackLength() << " mm ago" << std::endl;
    ATH_MSG_WARNING( "HYPERSPACE PARTICLE DETECTED!! KILLING!!" );
 
    const G4TrackVector *tv = aStep->GetSecondary();
    for (auto atv : *tv ){
      if ( m_world->Inside( atv->GetPosition() ) == kOutside ){
        atv->SetTrackStatus(fStopAndKill);
        ++m_killCount;
        ATH_MSG_WARNING("Had to kill a secondary as well");
      }
    }
 
    aStep->GetTrack()->SetTrackStatus(fStopAndKill);
    ++m_killCount;
 
    if (m_config.killAfter>0 && m_killCount>m_config.killAfter){
      ATH_MSG_FATAL( m_config.killAfter << " cases of hyperspace bug found.  You have something seriously wrong going on here.  Needs to be fixed.  Bailing out." );
      throw std::runtime_error("Hyperspace bug found");
    }
  }

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::HyperspaceCatcher::m_config

private

Definition at line 42 of file HyperspaceCatcher.h.

m_imsg

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

mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

{ nullptr };

m_killCount

int G4UA::HyperspaceCatcher::m_killCount

private

Definition at line 44 of file HyperspaceCatcher.h.

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_world

G4VSolid* G4UA::HyperspaceCatcher::m_world

private

Definition at line 43 of file HyperspaceCatcher.h.

---

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

• HyperspaceCatcher.h
• HyperspaceCatcher.cxx