LArFastShowerTool Class Reference

NEEDS DOCUMENTATION. More...

#include <LArFastShowerTool.h>

Inheritance diagram for LArFastShowerTool:

Collaboration diagram for LArFastShowerTool:

Public Member Functions
	LArFastShowerTool (const std::string &type, const std::string &name, const IInterface *parent)
	Default constructor. More...
virtual	~LArFastShowerTool ()
	Default destructor. More...
StatusCode	initialize () override final
StatusCode	EndOfAthenaEvent () override final
	End of an athena event - do any tidying up required at the end of each athena event. More...
StatusCode	initializeFastSim () override
	Construct and setup the fast simulation model. More...
virtual StatusCode	BeginOfAthenaEvent () override
	Begin of an athena event - do anything that needs to be done at the beginning of each athena event. 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
std::string	m_fastSimDedicatedSD
	Shower library sensitive detector for this shower. More...
ServiceHandle< ILArG4ShowerLibSvc >	m_showerLibSvc
	Pointer to the shower library service. More...
FastShowerConfigStruct	m_configuration
G4VFastSimulationModel *	m_FastSimModel {}
	The Fast Simulation Model to which this thing corresponds. More...

Detailed Description

NEEDS DOCUMENTATION.

Definition at line 20 of file LArFastShowerTool.h.

Constructor & Destructor Documentation

LArFastShowerTool()

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

Default constructor.

Definition at line 12 of file LArFastShowerTool.cxx.

  : FastSimulationBase(type, name, parent),
    m_fastSimDedicatedSD (""), // Empty by default.
    m_showerLibSvc("LArG4ShowerLibSvc", name)
{
  declareProperty("EFlagToShowerLib", m_configuration.m_e_FlagShowerLib = true, "Switch for e+/- frozen showers");
  declareProperty("EMinEneShowerLib", m_configuration.m_e_MinEneShowerLib = 0.0*CLHEP::GeV, "Minimum energy for e+/- frozen showers");
  declareProperty("EMaxEneShowerLib", m_configuration.m_e_MaxEneShowerLib = 1.0*CLHEP::GeV, "Maximum energy for e+/- frozen showers");
 
  declareProperty("GFlagToShowerLib", m_configuration.m_g_FlagShowerLib = true, "Switch for photon frozen showers");
  declareProperty("GMinEneShowerLib", m_configuration.m_g_MinEneShowerLib = 0.*CLHEP::GeV, "Minimum energy for photon frozen showers");
  declareProperty("GMaxEneShowerLib", m_configuration.m_g_MaxEneShowerLib = 0.010*CLHEP::GeV, "Maximum energy for photon frozen showers");
 
  declareProperty("NeutFlagToShowerLib", m_configuration.m_Neut_FlagShowerLib = true, "Switch for neutron frozen showers");
  declareProperty("NeutMinEneShowerLib", m_configuration.m_Neut_MinEneShowerLib = 0.0*CLHEP::GeV, "Minimum energy for neutron frozen showers");
  declareProperty("NeutMaxEneShowerLib", m_configuration.m_Neut_MaxEneShowerLib = 0.1*CLHEP::GeV, "Maximum energy for neutron frozen showers");
 
  declareProperty("PionFlagToShowerLib", m_configuration.m_Pion_FlagShowerLib = true, "Switch for neutron frozen showers");
  declareProperty("PionMinEneShowerLib", m_configuration.m_Pion_MinEneShowerLib = 0.0*CLHEP::GeV, "Minimum energy for neutron frozen showers");
  declareProperty("PionMaxEneShowerLib", m_configuration.m_Pion_MaxEneShowerLib = 2.0*CLHEP::GeV, "Maximum energy for neutron frozen showers");
 
  declareProperty("ContainLow",   m_configuration.m_containLow = true, "Switch for containment at low eta");
  declareProperty("AbsLowEta",    m_configuration.m_absLowEta, "");
  declareProperty("ContainHigh",  m_configuration.m_containHigh = true, "Switch for containment at high eta");
  declareProperty("AbsHighEta",   m_configuration.m_absHighEta, "");
  declareProperty("ContainCrack", m_configuration.m_containCrack = true, "Switch for containment in the crack region");
  declareProperty("AbsCrackEta1", m_configuration.m_absCrackEta1, "");
  declareProperty("AbsCrackEta2", m_configuration.m_absCrackEta2, "");
 
  declareProperty("GeneratedStartingPointsFile", m_configuration.m_generated_starting_points_file = "",
                  "Name of file for generated SPs. Do not touch until you want to produce a new library");
  declareProperty("GeneratedStartingPointsRatio", m_configuration.m_generated_starting_points_ratio = 0.02, "Ratio of SPs that goes to output");
  declareProperty("DetectorTag", m_configuration.m_detector_tag, "Which detector is this?");
  declareProperty("ApplyRRWeights", m_configuration.m_applyRRWeights, "Should the weights set by NRR/PRR be applied to Frozen Shower Energy deposits?");
  declareProperty("SensitiveDetector" , m_fastSimDedicatedSD , "Fast sim dedicated SD for this setup");
  declareProperty("ShowerLibSvc" , m_showerLibSvc, "Handle on the shower library service");
  m_configuration.m_showerLibSvcName = m_showerLibSvc.name();
 
}

~LArFastShowerTool()

virtual LArFastShowerTool::~LArFastShowerTool ( )

inlinevirtual

Default destructor.

Definition at line 26 of file LArFastShowerTool.h.

Member Function Documentation

BeginOfAthenaEvent()

virtual StatusCode FastSimulationBase::BeginOfAthenaEvent ( )

inlineoverridevirtualinherited

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

Reimplemented in FastCaloSimTool.

Definition at line 41 of file FastSimulationBase.h.

{ 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 LArFastShowerTool::EndOfAthenaEvent ( )

finaloverridevirtual

End of an athena event - do any tidying up required at the end of each athena event.

Reimplemented from FastSimulationBase.

Definition at line 83 of file LArFastShowerTool.cxx.

{
  // SD is taken care of by the SD tools
  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
}

initialize()

StatusCode LArFastShowerTool::initialize ( )

finaloverride

Definition at line 53 of file LArFastShowerTool.cxx.

{
  ATH_MSG_VERBOSE( name() << "::initialize()" );
  CHECK( m_showerLibSvc.retrieve() );
  return FastSimulationBase::initialize();
}

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 * LArFastShowerTool::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 60 of file LArFastShowerTool.cxx.

{
  ATH_MSG_DEBUG( "Initializing Fast Sim Model" );
  IFastSimDedicatedSD* fastSD = dynamic_cast<IFastSimDedicatedSD*>(
    G4SDManager::GetSDMpointer()->FindSensitiveDetector(m_fastSimDedicatedSD, false) );
  if (fastSD) {
    ATH_MSG_DEBUG( "SD " << m_fastSimDedicatedSD << " already created." );
  } else if ("BarrelFastSimDedicatedSD" == m_fastSimDedicatedSD){
    fastSD = new BarrelFastSimDedicatedSD( &*detStore(), msgLevel(MSG::DEBUG) );
  } else if ("EndcapFastSimDedicatedSD" == m_fastSimDedicatedSD){
    fastSD = new EndcapFastSimDedicatedSD( &*detStore(), msgLevel(MSG::DEBUG) );
  } else if ("FCALFastSimDedicatedSD" == m_fastSimDedicatedSD){
    fastSD = new FCALFastSimDedicatedSD( &*detStore(), msgLevel(MSG::DEBUG) );
  } else {
    ATH_MSG_FATAL( "Fast sim SD type " << m_fastSimDedicatedSD << " not found!" );
    throw std::runtime_error("Bad SD name");
  }
  G4SDManager::GetSDMpointer()->AddNewDetector(fastSD);
 
  // Create a fresh Fast Sim Model
  return new LArFastShower(name(), m_configuration, fastSD);
}

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_configuration

FastShowerConfigStruct LArFastShowerTool::m_configuration

private

Definition at line 41 of file LArFastShowerTool.h.

m_fastSimDedicatedSD

std::string LArFastShowerTool::m_fastSimDedicatedSD

private

Shower library sensitive detector for this shower.

Definition at line 39 of file LArFastShowerTool.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_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_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_showerLibSvc

ServiceHandle<ILArG4ShowerLibSvc> LArFastShowerTool::m_showerLibSvc

private

Pointer to the shower library service.

Definition at line 40 of file LArFastShowerTool.h.

---

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

• LArFastShowerTool.h
• LArFastShowerTool.cxx