NeutronFastSimTool Class Reference

#include <NeutronFastSimTool.h>

Inheritance diagram for NeutronFastSimTool:

Collaboration diagram for NeutronFastSimTool:

Public Member Functions
	NeutronFastSimTool (const std::string &type, const std::string &name, const IInterface *parent)
	~NeutronFastSimTool ()
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...
virtual StatusCode	EndOfAthenaEvent () override
	End of an athena event - do any tidying up required at the end 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...
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
std::string	m_trackFastSimSDName
double	m_etaCut
double	m_timeCut
	!< Eta cut for primaries More...
G4VFastSimulationModel *	m_FastSimModel {}
	The Fast Simulation Model to which this thing corresponds. More...

Detailed Description

Definition at line 14 of file NeutronFastSimTool.h.

Constructor & Destructor Documentation

NeutronFastSimTool()

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

Definition at line 9 of file NeutronFastSimTool.cxx.

  : FastSimulationBase(type,name,parent),
    m_trackFastSimSDName("TrackFastSimSDTool"),
    m_etaCut(6.0),
    m_timeCut(150.)
{
  declareProperty("TrackFastSimSDName", m_trackFastSimSDName);
  declareProperty("PrimaryEtaCut",m_etaCut);
  declareProperty("NeutronTimeCut",m_timeCut);
}

~NeutronFastSimTool()

NeutronFastSimTool::~NeutronFastSimTool ( )

inline

Definition at line 19 of file NeutronFastSimTool.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 42 of file FastSimulationBase.h.

{ 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()

virtual StatusCode FastSimulationBase::EndOfAthenaEvent ( )

inlineoverridevirtualinherited

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

Reimplemented in FastCaloSimTool.

Definition at line 45 of file FastSimulationBase.h.

{ 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 * NeutronFastSimTool::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 20 of file NeutronFastSimTool.cxx.

{
  ATH_MSG_DEBUG( "Initializing Fast Sim Model" );
 
  // Create a fresh Fast Sim Model
  return new NeutronFastSim(name(), getRegion(), m_trackFastSimSDName,m_etaCut,m_timeCut);
}

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_etaCut

double NeutronFastSimTool::m_etaCut

private

Definition at line 27 of file NeutronFastSimTool.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_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_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_timeCut

double NeutronFastSimTool::m_timeCut

private

!< Eta cut for primaries

Definition at line 28 of file NeutronFastSimTool.h.

m_trackFastSimSDName

std::string NeutronFastSimTool::m_trackFastSimSDName

private

Definition at line 26 of file NeutronFastSimTool.h.

---

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

• NeutronFastSimTool.h
• NeutronFastSimTool.cxx