FastCaloSimTool Class Reference

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

Protected Attributes
Gaudi::Property< std::vector< std::string > >	m_regionNames {this, "RegionNames", {}}
	All the regions 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", ""}
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"}
G4VFastSimulationModel *	m_FastSimModel {}
	The Fast Simulation Model to which this thing corresponds. More...

Detailed Description

Definition at line 23 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 28 of file FastCaloSimTool.h.

{}

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 99 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 73 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
}

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 23 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);
 
  // Go through the regions and hook the fast simulation up
  G4RegionStore* regionStore = G4RegionStore::GetInstance();
  bool missedOne = false;
  for (const auto& myreg : m_regionNames.value()){
    int found=0; // Regions with more than one name...
    for (auto* areg : *regionStore){
      if (myreg.data()==areg->GetName()){
        ++found;
        G4FastSimulationManager* theFastSimulationManager = areg->GetFastSimulationManager();
 
        // Build a new fast sim manager if necessary
        if ( theFastSimulationManager == 0 ) theFastSimulationManager = new G4FastSimulationManager(areg);
        theFastSimulationManager->AddFastSimulationModel(getFastSimModel());
        theFastSimulationManager->ActivateFastSimulationModel(getFastSimModel()->GetName());
      }
    } // Loop over regions
    if (0==found){
      ATH_MSG_ERROR( "Region " << myreg << " not found." );
      missedOne=true;
    } else {
      ATH_MSG_VERBOSE( found << " copies of region " << myreg << " found; fast simulation " << name() << " assigned." );
    }
  } // Loop over regions I want
 
  // Crash out if we have failed to assign a volume - this is bad news!
  if (missedOne && !m_noRegions){
    ATH_MSG_ERROR( "Failed to assign at least one volume to Fast Simulation Model " << name() );
    return StatusCode::FAILURE;
  }
 
  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(), m_rndmGenSvc, m_randomEngineName,  m_FastCaloSimCaloTransportation, m_FastCaloSimCaloExtrapolation, m_G4CaloTransportTool, m_FastCaloSimSvc, m_CaloCellContainerSDName, m_doG4Transport, 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 87 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_CaloCellContainerSDName

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

private

Definition at line 56 of file FastCaloSimTool.h.

m_doG4Transport

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

private

Definition at line 58 of file FastCaloSimTool.h.

m_FastCaloSimCaloExtrapolation

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

private

Definition at line 48 of file FastCaloSimTool.h.

m_FastCaloSimCaloTransportation

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

private

Definition at line 46 of file FastCaloSimTool.h.

m_FastCaloSimSvc

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

private

Definition at line 44 of file FastCaloSimTool.h.

m_FastSimModel

G4VFastSimulationModel* FastSimulationBase::m_FastSimModel {}

privateinherited

The Fast Simulation Model to which this thing corresponds.

Definition at line 74 of file FastSimulationBase.h.

m_G4CaloTransportTool

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

private

Definition at line 50 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 55 of file FastSimulationBase.h.

m_randomEngineName

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

private

Definition at line 54 of file FastCaloSimTool.h.

m_regionNames

Gaudi::Property<std::vector<std::string> > FastSimulationBase::m_regionNames {this, "RegionNames", {}}

protectedinherited

All the regions to which this fast sim is assigned.

Definition at line 53 of file FastSimulationBase.h.

m_rndmGenSvc

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

private

Definition at line 52 of file FastCaloSimTool.h.

---

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

• FastCaloSimTool.h
• FastCaloSimTool.cxx