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.
StatusCode	initializeFastSim () override
	Construct and setup the fast simulation model.
virtual StatusCode	BeginOfAthenaEvent (HitCollectionMap &) override
	Begin of an athena event - do anything that needs to be done at the beginning of each athena event.
virtual StatusCode	EndOfAthenaEvent (HitCollectionMap &) override
	End of an athena event - do any tidying up required at the end of each athena event.

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

Protected Attributes
Gaudi::Property< std::string >	m_regionName {this, "RegionName", ""}
	The region to which this fast sim is assigned.
Gaudi::Property< bool >	m_noRegions {this, "NoRegions", false}
	This Fast Simulation has no regions associated with it.

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", ""}
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_doPunchThrough {this, "doPunchThrough", true, "Run punchthrough simulation for particle entering Calo-MS boundary"}

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 9 of file FastCaloSimTool.cxx.

: FastSimulationBase(type, name, parent)
{
}

Member Function Documentation

BeginOfAthenaEvent()

virtual StatusCode FastSimulationBase::BeginOfAthenaEvent ( HitCollectionMap & )

inlineoverridevirtualinherited

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

Definition at line 43 of file FastSimulationBase.h.

{ return StatusCode::SUCCESS; }

EndOfAthenaEvent()

virtual StatusCode FastSimulationBase::EndOfAthenaEvent ( HitCollectionMap & )

inlineoverridevirtualinherited

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

Definition at line 46 of file FastSimulationBase.h.

{ return StatusCode::SUCCESS; }

getRegion()

G4Region * FastSimulationBase::getRegion ( ) const

protectedinherited

Definition at line 18 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. It is the derived class's responsibility to assign the fast simulation model to the correct regions. The fast simulation model is registered for deletion. In multi-threaded jobs, this method is called once on each geant4 worker thread during detector construction (ConstructSDandField).

Definition at line 28 of file FastSimulationBase.cxx.

                                                {
  ATH_MSG_VERBOSE( name() << "::initializeFastSim()" );
 
  // Instantiate the FastSimModel for this geant4 thread and register it for deletion
  G4AutoDelete::Register(makeFastSimModel());
 
  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 14 of file FastCaloSimTool.cxx.

{
  ATH_MSG_DEBUG("Initializing Fast Sim Model");
 
  // Create the FastCaloSim fast simulation model
  return new FastCaloSim(name(), getRegion(), m_FastCaloSimCaloTransportation, m_FastCaloSimCaloExtrapolation, m_G4CaloTransportTool, m_PunchThroughSimWrapper, m_FastCaloSimSvc, m_CaloCellContainerSDName, m_doG4Transport, m_doPunchThrough, this);
}

Member Data Documentation

m_CaloCellContainerSDName

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

private

Definition at line 49 of file FastCaloSimTool.h.

{this, "CaloCellContainerSDName", "", "Name of the associated CaloCellContainerSD"};

m_doG4Transport

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

private

Definition at line 51 of file FastCaloSimTool.h.

{this, "doG4Transport", false, "Flag to enable G4 transportation"};

m_doPunchThrough

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

private

Definition at line 53 of file FastCaloSimTool.h.

{this, "doPunchThrough", true, "Run punchthrough simulation for particle entering Calo-MS boundary"};

m_FastCaloSimCaloExtrapolation

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

private

Definition at line 42 of file FastCaloSimTool.h.

{this, "FastCaloSimCaloExtrapolation", "FastCaloSimCaloExtrapolation", ""};

m_FastCaloSimCaloTransportation

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

private

Definition at line 40 of file FastCaloSimTool.h.

{this, "FastCaloSimCaloTransportation", "FastCaloSimCaloTransportation", ""};

m_FastCaloSimSvc

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

private

Definition at line 38 of file FastCaloSimTool.h.

{this, "ISF_FastCaloSimV2ParamSvc", "ISF_FastCaloSimV2ParamSvc"};

m_G4CaloTransportTool

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

private

Definition at line 44 of file FastCaloSimTool.h.

{this, "G4CaloTransportTool", "G4CaloTransportTool", ""};

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.

{this, "NoRegions", false};

m_PunchThroughSimWrapper

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

private

Definition at line 46 of file FastCaloSimTool.h.

{this, "PunchThroughSimWrapper", "PunchThroughSimWrapper", ""};

m_regionName

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

protectedinherited

The region to which this fast sim is assigned.

Definition at line 53 of file FastSimulationBase.h.

{this, "RegionName", ""};

---

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

• FastCaloSimTool.h
• FastCaloSimTool.cxx