G4UA::AthenaStackingActionTool Class Reference

Tool which manages the AthenaStackingAction. More...

#include <AthenaStackingActionTool.h>

Inheritance diagram for G4UA::AthenaStackingActionTool:

Collaboration diagram for G4UA::AthenaStackingActionTool:

Public Member Functions
	AthenaStackingActionTool (const std::string &type, const std::string &name, const IInterface *parent)
	Standard constructor.
virtual StatusCode	initialize () override final
	Initialize the tool.
virtual StatusCode	fillUserAction (G4AtlasUserActions &actionLists) override final
	Fill the user action lists.
StatusCode	BeginOfAthenaEvent (HitCollectionMap &) override
	Calls BeginOfAthenaEvent.
StatusCode	EndOfAthenaEvent (HitCollectionMap &) override
	Calls EndOfAthenaEvent.

Protected Member Functions
virtual std::unique_ptr< AthenaStackingAction >	makeAndFillAction (G4AtlasUserActions &actionLists) override final
	Make the action and push onto the lists.

Protected Attributes
ThreadSpecificUserAction< AthenaStackingAction >	m_actions
	Thread-specific storage of the user action.

Private Attributes
AthenaStackingAction::Config	m_config
	Configuration parameters.
bool	m_useDebugAction
	Use the debug version of the stacking action.

Detailed Description

Tool which manages the AthenaStackingAction.

Author

Steve Farrell Steve.nosp@m.n.Fa.nosp@m.rrell.nosp@m.@cer.nosp@m.n.ch

Definition at line 27 of file AthenaStackingActionTool.h.

Constructor & Destructor Documentation

AthenaStackingActionTool()

G4UA::AthenaStackingActionTool::AthenaStackingActionTool	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent )

Standard constructor.

Definition at line 14 of file AthenaStackingActionTool.cxx.

    : UserActionToolBase<AthenaStackingAction>(type, name, parent),
      m_config { /*killAllNeutrinos*/ false,
                 /*photonEnergyCut*/ -1.,
                 /*applyNRR*/                      false,
                 /*russianRouletteNeutronThreshold*/ -1.,
                 /*russianRouletteNeutronWeight*/    -1.,
                 /*applyPRR*/                      false,
                 /*russianRoulettePhotonThreshold*/  -1.,
                 /*russianRoulettePhotonWeight*/     -1.,
                 /*isISFJob*/ false
      },
      m_useDebugAction(false)
  {
    declareProperty("KillAllNeutrinos", m_config.killAllNeutrinos,
                    "Toggle killing of all neutrinos");
    declareProperty("PhotonEnergyCut", m_config.photonEnergyCut,
                    "Energy threshold for tracking photons");
    declareProperty("ApplyNRR", m_config.applyNRR,
                    "Apply the Neutron Russian Roulette");
    declareProperty("NRRThreshold", m_config.russianRouletteNeutronThreshold,
                    "Energy threshold for the Neutron Russian Roulette");
    declareProperty("NRRWeight", m_config.russianRouletteNeutronWeight,
                    "Weight for the Neutron Russian Roulette");
    declareProperty("ApplyPRR", m_config.applyPRR,
                    "Apply the Photon Russian Roulette");
    declareProperty("PRRThreshold", m_config.russianRoulettePhotonThreshold,
                    "Energy threshold for the Photon Russian Roulette");
    declareProperty("PRRWeight", m_config.russianRoulettePhotonWeight,
                    "Weight for the Photon Russian Roulette");
    declareProperty("IsISFJob", m_config.isISFJob, "");
    declareProperty("UseDebugAction", m_useDebugAction);
  }

Member Function Documentation

BeginOfAthenaEvent()

StatusCode G4UA::UserActionToolBase< AthenaStackingAction >::BeginOfAthenaEvent ( HitCollectionMap & )

inlineoverrideinherited

Calls BeginOfAthenaEvent.

Definition at line 59 of file UserActionToolBase.h.

{return StatusCode::SUCCESS;};

EndOfAthenaEvent()

StatusCode G4UA::UserActionToolBase< AthenaStackingAction >::EndOfAthenaEvent ( HitCollectionMap & )

inlineoverrideinherited

Calls EndOfAthenaEvent.

Definition at line 61 of file UserActionToolBase.h.

{return StatusCode::SUCCESS;};

fillUserAction()

virtual StatusCode G4UA::UserActionToolBase< AthenaStackingAction >::fillUserAction ( G4AtlasUserActions & actionLists )

inlinefinaloverridevirtualinherited

Fill the user action lists.

Definition at line 47 of file UserActionToolBase.h.

      {
        auto myAction = makeAndFillAction(actionLists);
        if(myAction == nullptr) {
          ATH_MSG_ERROR( "Failed to construct user action in " << name() );
          return StatusCode::FAILURE;
        }
        m_actions.set( std::move(myAction) );
        return StatusCode::SUCCESS;
      }

initialize()

StatusCode G4UA::AthenaStackingActionTool::initialize ( )

finaloverridevirtual

Initialize the tool.

Definition at line 53 of file AthenaStackingActionTool.cxx.

  {
    ATH_MSG_DEBUG( "Initializing " << name() );
    ATH_MSG_DEBUG( "KillAllNeutrinos: " << m_config.killAllNeutrinos );
    ATH_MSG_DEBUG( "PhotonEnergyCut: " << m_config.photonEnergyCut );
    ATH_MSG_DEBUG( "RussianRouletteNeutronThreshold: " << m_config.russianRouletteNeutronThreshold );
    ATH_MSG_DEBUG( "RussianRouletteNeutronWeight: " << m_config.russianRouletteNeutronWeight );
    ATH_MSG_DEBUG( "RussianRoulettePhotonThreshold: " << m_config.russianRoulettePhotonThreshold );
    ATH_MSG_DEBUG( "RussianRoulettePhotonWeight: " << m_config.russianRoulettePhotonWeight );
    return StatusCode::SUCCESS;
  }

makeAndFillAction()

std::unique_ptr< AthenaStackingAction > G4UA::AthenaStackingActionTool::makeAndFillAction ( G4AtlasUserActions & actionLists )

finaloverrideprotectedvirtual

Make the action and push onto the lists.

Implements G4UA::UserActionToolBase< AthenaStackingAction >.

Definition at line 69 of file AthenaStackingActionTool.cxx.

  {
    ATH_MSG_DEBUG("Creating an AthenaStackingAction");
    // Create and configure the action plugin.
    std::unique_ptr<AthenaStackingAction> action{nullptr};
    if (m_useDebugAction) {
      action = std::make_unique<AthenaDebugStackingAction>(m_config);
    } else {
      action = std::make_unique<AthenaStackingAction>(m_config);
    }
    actionLists.stackingActions.push_back( action.get() );
    return action;
  }

Member Data Documentation

m_actions

ThreadSpecificUserAction<AthenaStackingAction> G4UA::UserActionToolBase< AthenaStackingAction >::m_actions

protectedinherited

Thread-specific storage of the user action.

Definition at line 70 of file UserActionToolBase.h.

m_config

AthenaStackingAction::Config G4UA::AthenaStackingActionTool::m_config

private

Configuration parameters.

Definition at line 48 of file AthenaStackingActionTool.h.

m_useDebugAction

bool G4UA::AthenaStackingActionTool::m_useDebugAction

private

Use the debug version of the stacking action.

Definition at line 51 of file AthenaStackingActionTool.h.

---

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

• AthenaStackingActionTool.h
• AthenaStackingActionTool.cxx