#include <FastCaloSimTool.h>

Inheritance diagram for FastCaloSimTool:

Collaboration diagram for FastCaloSimTool:

Public Member Functions
	FastCaloSimTool (const std::string &type, const std::string &name, const IInterface *parent)
	Default constructor. More...

	~FastCaloSimTool ()

virtual StatusCode	BeginOfAthenaEvent () override final
	Begin of an athena event - do any thing that needs to be done at the beginning of each athena event. More...

virtual StatusCode	EndOfAthenaEvent () override final
	End of an athena event - do any thing that needs to be done at the end of each athena event. More...

StatusCode	initializeFastSim () override
	Construct and setup the fast simulation model. More...

Protected Member Functions
virtual G4VFastSimulationModel *	makeFastSimModel () override final
	Method to make the actual fast simulation model itself, which will be owned by the tool. More...

G4VFastSimulationModel *	getFastSimModel ()
	Retrieve the current Fast Simulation Model. More...

G4Region *	getRegion () const

Protected Attributes
Gaudi::Property< std::string >	m_regionName {this, "RegionName", ""}
	The region to which this fast sim is assigned. More...

Gaudi::Property< bool >	m_noRegions {this, "NoRegions", false}
	This Fast Simulation has no regions associated with it. More...

Private Member Functions
void	setFastSimModel (G4VFastSimulationModel *)
	Set the current model. In hive, this gets assigned as the thread-local model. More...

void	deleteFastSimModel ()
	Delete the current model. More...

Private Attributes
ServiceHandle< ISF::IFastCaloSimParamSvc >	m_FastCaloSimSvc {this, "ISF_FastCaloSimV2ParamSvc", "ISF_FastCaloSimV2ParamSvc"}

PublicToolHandle< IFastCaloSimCaloTransportation >	m_FastCaloSimCaloTransportation {this, "FastCaloSimCaloTransportation", "FastCaloSimCaloTransportation", ""}

PublicToolHandle< IFastCaloSimCaloExtrapolation >	m_FastCaloSimCaloExtrapolation {this, "FastCaloSimCaloExtrapolation", "FastCaloSimCaloExtrapolation", ""}

PublicToolHandle< IG4CaloTransportTool >	m_G4CaloTransportTool {this, "G4CaloTransportTool", "G4CaloTransportTool", ""}

PublicToolHandle< IPunchThroughSimWrapper >	m_PunchThroughSimWrapper {this, "PunchThroughSimWrapper", "PunchThroughSimWrapper", ""}

ServiceHandle< IAthRNGSvc >	m_rndmGenSvc {this, "RandomSvc", "AthRNGSvc", ""}

Gaudi::Property< std::string >	m_randomEngineName {this, "RandomStream", ""}

Gaudi::Property< std::string >	m_CaloCellContainerSDName {this, "CaloCellContainerSDName", "", "Name of the associated CaloCellContainerSD"}

Gaudi::Property< bool >	m_doG4Transport {this, "doG4Transport", false, "Flag to enable G4 transportation"}

Gaudi::Property< bool >	m_doPhotons {this, "doPhotons", true, "Flag to enable FCS simulation for photons"}
	Optional flags that allow to further limit the usage of fast simulation beyond the default configuration Note: For fast simulation jobs, default values should be used. More...

Gaudi::Property< bool >	m_doElectrons {this, "doElectrons", true, "Flag to enable FCS simulation for electrons and positrons"}

Gaudi::Property< bool >	m_doHadrons {this, "doHadrons", true, "Flag to enable FCS simulation for pions and other hadrons"}

Gaudi::Property< float >	m_AbsEtaMin {this, "AbsEtaMin", 0, "Abs(Eta) lower bound for FastCaloSim"}

Gaudi::Property< float >	m_AbsEtaMax {this, "AbsEtaMax", 10, "Abs(Eta) upper bound for FastCaloSim"}

Gaudi::Property< float >	m_EkinMinPhotons {this, "EkinMinPhotons", 0, "Kinetic photon energy lower bound for FastCaloSim"}

Gaudi::Property< float >	m_EkinMaxPhotons {this, "EkinMaxPhotons", std::numeric_limits<float>::max(), "Kinetic photon energy upper bound for FastCaloSim"}

Gaudi::Property< float >	m_EkinMinElectrons {this, "EkinMinElectrons", 0, "Kinetic electron energy lower bound for FastCaloSim"}

Gaudi::Property< float >	m_EkinMaxElectrons {this, "EkinMaxElectrons", std::numeric_limits<float>::max(), "Kinetic electron energy upper bound for FastCaloSim"}

Gaudi::Property< bool >	m_doPunchThrough {this, "doPunchThrough", true, "Run punchthrough simulation for particle entering Calo-MS boundary"}

G4VFastSimulationModel *	m_FastSimModel {}
	The Fast Simulation Model to which this thing corresponds. More...

Detailed Description

Definition at line 26 of file FastCaloSimTool.h.

Constructor & Destructor Documentation

◆ FastCaloSimTool()

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

Default constructor.

Definition at line 11 of file FastCaloSimTool.cxx.

 : FastSimulationBase(type, name, parent)
 {
 }

◆ ~FastCaloSimTool()

FastCaloSimTool::~FastCaloSimTool ( )

inline

Definition at line 31 of file FastCaloSimTool.h.

31 {}

Member Function Documentation

◆ BeginOfAthenaEvent()

StatusCode FastCaloSimTool::BeginOfAthenaEvent ( )

finaloverridevirtual

Begin of an athena event - do any thing that needs to be done at the beginning of each athena event.

Reimplemented from FastSimulationBase.

Definition at line 16 of file FastCaloSimTool.cxx.

                                               {
   // Get current event context
   const EventContext& ctx = Gaudi::Hive::currentContext();
  
   if( !getFastSimModel() ){
     ATH_MSG_ERROR ("BeginOfAthenaEvent: FastSimModel was never created!");
     return StatusCode::FAILURE;
   }
   else{
     FastCaloSim *localFastSimModel = dynamic_cast<FastCaloSim*>(getFastSimModel());
     if(!localFastSimModel){
       ATH_MSG_ERROR ("BeginOfAthenaEvent: Failed to cast m_FastSimModel into G4VFastSimulationModel.");
       return StatusCode::FAILURE;
     }
     localFastSimModel->StartOfAthenaEvent(ctx);
   }
  
   return StatusCode::SUCCESS;
 }

◆ deleteFastSimModel()

void FastSimulationBase::deleteFastSimModel ( )

privateinherited

Delete the current model.

Definition at line 78 of file FastSimulationBase.cxx.

 {
 #ifdef G4MULTITHREADED
   for(auto& threadMapPair : m_fastsimmodelThreadMap)
     {
       auto fastSimModel = threadMapPair.second;
       if (fastSimModel)
     delete fastSimModel;      
     }
   m_fastsimmodelThreadMap.clear();
 #else
   if(m_FastSimModel)
     {
       delete m_FastSimModel;
       m_FastSimModel = 0;
     }
 #endif
 }

◆ EndOfAthenaEvent()

StatusCode FastCaloSimTool::EndOfAthenaEvent ( )

finaloverridevirtual

End of an athena event - do any thing that needs to be done at the end of each athena event.

Reimplemented from FastSimulationBase.

Definition at line 36 of file FastCaloSimTool.cxx.

                                             {
  
   // Get current event context
   const EventContext& ctx = Gaudi::Hive::currentContext();
  
   if( !getFastSimModel() ){
     ATH_MSG_ERROR ("EndOfAthenaEvent: FastSimModel was never created!");
     return StatusCode::FAILURE;
   }
   else{
     FastCaloSim *localFastSimModel = dynamic_cast<FastCaloSim*>(getFastSimModel());
     if(!localFastSimModel){
       ATH_MSG_ERROR ("EndOfAthenaEvent: Failed to cast m_FastSimModel into G4VFastSimulationModel.");
       return StatusCode::FAILURE;
     }
     localFastSimModel->EndOfAthenaEvent(ctx);
   }
   
   return StatusCode::SUCCESS;
 }

◆ getFastSimModel()

G4VFastSimulationModel * FastSimulationBase::getFastSimModel ( )

protectedinherited

Retrieve the current Fast Simulation Model.

In MT, this means the thread-local Fast Simulation Model. Otherwise, it is simply the single Fast Simulation Model.

Definition at line 52 of file FastSimulationBase.cxx.

 {
 #ifdef G4MULTITHREADED
   // Get current thread-ID
   const auto tid = std::this_thread::get_id();
   // Retrieve it from the FastSimModel map
   auto fastsimmodelPair = m_fastsimmodelThreadMap.find(tid);
   if(fastsimmodelPair == m_fastsimmodelThreadMap.end()) return nullptr;
   return fastsimmodelPair->second;
 #else
   return m_FastSimModel;
 #endif
 }

◆ getRegion()

G4Region * FastSimulationBase::getRegion ( ) const

protectedinherited

Definition at line 22 of file FastSimulationBase.cxx.

 {
   if (m_regionName.value().empty()) {
     return nullptr;
   }
   return G4RegionStore::GetInstance()->GetRegion(m_regionName.value());
 }

◆ initializeFastSim()

StatusCode FastSimulationBase::initializeFastSim ( )

overrideinherited

Construct and setup the fast simulation model.

This method invokes the makeFastSimModel of the derived concrete tool type and assigns the configured regions. Errors are reported if regions are missing. In multi-threading jobs, this method is called once per worker thread.

Definition at line 32 of file FastSimulationBase.cxx.

                                                 {
   ATH_MSG_VERBOSE( name() << "::initializeFastSim()" );
  
   // Make sure Fast Simulation Model isn't already registered
   if(getFastSimModel()){
     ATH_MSG_ERROR("Trying to create a Fast Simulation Model which already exists!");
     return StatusCode::FAILURE;
   }
  
   // Make the FastSimModel stored by this tool
   auto* fastsimmodel = makeFastSimModel();
   setFastSimModel(fastsimmodel);
  
   // Set the verbosity information on this thing - this will have to go into the makeFastSimModel methods...
   //if(msgLvl(MSG::VERBOSE)) m_FastSimModel->SetVerboseLevel(10);
   //else if(msgLvl(MSG::DEBUG)) m_FastSimModel->SetVerboseLevel(5);
  
   return StatusCode::SUCCESS;
 }

◆ makeFastSimModel()

G4VFastSimulationModel * FastCaloSimTool::makeFastSimModel ( )

finaloverrideprotectedvirtual

Method to make the actual fast simulation model itself, which will be owned by the tool.

Must be implemented in all concrete base classes.

Definition at line 58 of file FastCaloSimTool.cxx.

 {
   ATH_MSG_DEBUG("Initializing Fast Sim Model");
  
   // Create the FastCaloSim fast simulation model
   return new FastCaloSim(name(), getRegion(), m_rndmGenSvc, m_randomEngineName,  m_FastCaloSimCaloTransportation, m_FastCaloSimCaloExtrapolation, m_G4CaloTransportTool, m_PunchThroughSimWrapper, m_FastCaloSimSvc, m_CaloCellContainerSDName, m_doG4Transport, m_doPhotons, m_doElectrons, m_doHadrons, m_AbsEtaMin, m_AbsEtaMax, m_EkinMinPhotons, m_EkinMaxPhotons, m_EkinMinElectrons, m_EkinMaxElectrons, m_doPunchThrough, this);
 }

◆ setFastSimModel()

void FastSimulationBase::setFastSimModel ( G4VFastSimulationModel * fastsimmodel )

privateinherited

Set the current model. In hive, this gets assigned as the thread-local model.

Definition at line 66 of file FastSimulationBase.cxx.

 {
 #ifdef G4MULTITHREADED
   // Make sure one isn't already assigned
   const auto tid = std::this_thread::get_id();
   ATH_MSG_DEBUG("Creating and registering FastSimModel " << fastsimmodel << " in thread " << tid);
   m_fastsimmodelThreadMap.insert( std::make_pair(tid, fastsimmodel) );
 #else
   m_FastSimModel = fastsimmodel;
 #endif
 }

Member Data Documentation

◆ m_AbsEtaMax

Gaudi::Property<float> FastCaloSimTool::m_AbsEtaMax {this, "AbsEtaMax", 10, "Abs(Eta) upper bound for FastCaloSim"}

private

Definition at line 72 of file FastCaloSimTool.h.

◆ m_AbsEtaMin

Gaudi::Property<float> FastCaloSimTool::m_AbsEtaMin {this, "AbsEtaMin", 0, "Abs(Eta) lower bound for FastCaloSim"}

private

Definition at line 71 of file FastCaloSimTool.h.

◆ m_CaloCellContainerSDName

Gaudi::Property<std::string> FastCaloSimTool::m_CaloCellContainerSDName {this, "CaloCellContainerSDName", "", "Name of the associated CaloCellContainerSD"}

private

Definition at line 62 of file FastCaloSimTool.h.

◆ m_doElectrons

Gaudi::Property<bool> FastCaloSimTool::m_doElectrons {this, "doElectrons", true, "Flag to enable FCS simulation for electrons and positrons"}

private

Definition at line 69 of file FastCaloSimTool.h.

◆ m_doG4Transport

Gaudi::Property<bool> FastCaloSimTool::m_doG4Transport {this, "doG4Transport", false, "Flag to enable G4 transportation"}

private

Definition at line 64 of file FastCaloSimTool.h.

◆ m_doHadrons

Gaudi::Property<bool> FastCaloSimTool::m_doHadrons {this, "doHadrons", true, "Flag to enable FCS simulation for pions and other hadrons"}

private

Definition at line 70 of file FastCaloSimTool.h.

◆ m_doPhotons

Gaudi::Property<bool> FastCaloSimTool::m_doPhotons {this, "doPhotons", true, "Flag to enable FCS simulation for photons"}

private

Optional flags that allow to further limit the usage of fast simulation beyond the default configuration Note: For fast simulation jobs, default values should be used.

They are only useful in special cases where you want to further limit the usage of fast sim, e.g. if we want to replace certain parts of full simulation

Definition at line 68 of file FastCaloSimTool.h.

◆ m_doPunchThrough

Gaudi::Property<bool> FastCaloSimTool::m_doPunchThrough {this, "doPunchThrough", true, "Run punchthrough simulation for particle entering Calo-MS boundary"}

private

Definition at line 77 of file FastCaloSimTool.h.

◆ m_EkinMaxElectrons

Gaudi::Property<float> FastCaloSimTool::m_EkinMaxElectrons {this, "EkinMaxElectrons", std::numeric_limits<float>::max(), "Kinetic electron energy upper bound for FastCaloSim"}

private

Definition at line 76 of file FastCaloSimTool.h.

◆ m_EkinMaxPhotons

Gaudi::Property<float> FastCaloSimTool::m_EkinMaxPhotons {this, "EkinMaxPhotons", std::numeric_limits<float>::max(), "Kinetic photon energy upper bound for FastCaloSim"}

private

Definition at line 74 of file FastCaloSimTool.h.

◆ m_EkinMinElectrons

Gaudi::Property<float> FastCaloSimTool::m_EkinMinElectrons {this, "EkinMinElectrons", 0, "Kinetic electron energy lower bound for FastCaloSim"}

private

Definition at line 75 of file FastCaloSimTool.h.

◆ m_EkinMinPhotons

Gaudi::Property<float> FastCaloSimTool::m_EkinMinPhotons {this, "EkinMinPhotons", 0, "Kinetic photon energy lower bound for FastCaloSim"}

private

Definition at line 73 of file FastCaloSimTool.h.

◆ m_FastCaloSimCaloExtrapolation

PublicToolHandle<IFastCaloSimCaloExtrapolation> FastCaloSimTool::m_FastCaloSimCaloExtrapolation {this, "FastCaloSimCaloExtrapolation", "FastCaloSimCaloExtrapolation", ""}

private

Definition at line 51 of file FastCaloSimTool.h.

◆ m_FastCaloSimCaloTransportation

PublicToolHandle<IFastCaloSimCaloTransportation> FastCaloSimTool::m_FastCaloSimCaloTransportation {this, "FastCaloSimCaloTransportation", "FastCaloSimCaloTransportation", ""}

private

Definition at line 49 of file FastCaloSimTool.h.

◆ m_FastCaloSimSvc

ServiceHandle<ISF::IFastCaloSimParamSvc> FastCaloSimTool::m_FastCaloSimSvc {this, "ISF_FastCaloSimV2ParamSvc", "ISF_FastCaloSimV2ParamSvc"}

private

Definition at line 47 of file FastCaloSimTool.h.

◆ m_FastSimModel

G4VFastSimulationModel* FastSimulationBase::m_FastSimModel {}

privateinherited

The Fast Simulation Model to which this thing corresponds.

Definition at line 78 of file FastSimulationBase.h.

◆ m_G4CaloTransportTool

PublicToolHandle<IG4CaloTransportTool> FastCaloSimTool::m_G4CaloTransportTool {this, "G4CaloTransportTool", "G4CaloTransportTool", ""}

private

Definition at line 53 of file FastCaloSimTool.h.

◆ m_noRegions

Gaudi::Property<bool> FastSimulationBase::m_noRegions {this, "NoRegions", false}

protectedinherited

This Fast Simulation has no regions associated with it.

Definition at line 59 of file FastSimulationBase.h.

◆ m_PunchThroughSimWrapper

PublicToolHandle<IPunchThroughSimWrapper> FastCaloSimTool::m_PunchThroughSimWrapper {this, "PunchThroughSimWrapper", "PunchThroughSimWrapper", ""}

private

Definition at line 55 of file FastCaloSimTool.h.

◆ m_randomEngineName

Gaudi::Property<std::string> FastCaloSimTool::m_randomEngineName {this, "RandomStream", ""}

private

Definition at line 60 of file FastCaloSimTool.h.

◆ m_regionName

Gaudi::Property<std::string> FastSimulationBase::m_regionName {this, "RegionName", ""}

protectedinherited

The region to which this fast sim is assigned.

Definition at line 57 of file FastSimulationBase.h.

◆ m_rndmGenSvc

ServiceHandle<IAthRNGSvc> FastCaloSimTool::m_rndmGenSvc {this, "RandomSvc", "AthRNGSvc", ""}

private

Definition at line 58 of file FastCaloSimTool.h.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FastCaloSimTool()

◆ ~FastCaloSimTool()

Member Function Documentation

◆ BeginOfAthenaEvent()

◆ deleteFastSimModel()

◆ EndOfAthenaEvent()

◆ getFastSimModel()

◆ getRegion()

◆ initializeFastSim()

◆ makeFastSimModel()

◆ setFastSimModel()

Member Data Documentation

◆ m_AbsEtaMax

◆ m_AbsEtaMin

◆ m_CaloCellContainerSDName

◆ m_doElectrons

◆ m_doG4Transport

◆ m_doHadrons

◆ m_doPhotons

◆ m_doPunchThrough

◆ m_EkinMaxElectrons

◆ m_EkinMaxPhotons

◆ m_EkinMinElectrons

◆ m_EkinMinPhotons

◆ m_FastCaloSimCaloExtrapolation

◆ m_FastCaloSimCaloTransportation

◆ m_FastCaloSimSvc

◆ m_FastSimModel

◆ m_G4CaloTransportTool

◆ m_noRegions

◆ m_PunchThroughSimWrapper

◆ m_randomEngineName

◆ m_regionName

◆ m_rndmGenSvc