Geant4 wrapper for the Geant4 fast simulation shower model. More...

#include <Geant4FastSimShowerModel.h>

Inheritance diagram for dd4hep::sim::Geant4FastSimShowerModel:

Public Member Functions
	Geant4FastSimShowerModel (Geant4Context *context, const std::string &nam)
	Standard constructor. More...

virtual	~Geant4FastSimShowerModel ()
	Default destructor. More...

virtual void	constructGeo (Geant4DetectorConstructionContext *ctxt) override
	Geometry construction callback. Called at "Construct()". More...

virtual void	constructField (Geant4DetectorConstructionContext *ctxt) override
	Electromagnetic field construction callback. Called at "ConstructSDandField()". More...

virtual void	constructSensitives (Geant4DetectorConstructionContext *ctxt) override
	Sensitive detector construction callback. Called at "ConstructSDandField()". More...

virtual bool	check_applicability (const G4ParticleDefinition &particle)
	User callback to determine if the model is applicable for the particle type. More...

virtual bool	check_trigger (const G4FastTrack &track)
	User callback to determine if the shower creation should be triggered. More...

virtual void	modelShower (const G4FastTrack &track, G4FastStep &step)
	User callback to model the particle/energy shower. More...

Public Member Functions inherited from dd4hep::sim::Geant4DetectorConstruction
	Geant4DetectorConstruction (Geant4Context *context, const std::string &nam)
	Standard Constructor. More...

virtual	~Geant4DetectorConstruction ()
	Default destructor. More...

virtual G4VSensitiveDetector *	createSensitiveDetector (const std::string &type, const std::string &name)
	Create Geant4 sensitive detector object using the factory mechanism. More...

Public Member Functions inherited from dd4hep::sim::Geant4Action
	Geant4Action (Geant4Context *context, const std::string &nam)
	Standard constructor. More...

long	addRef ()
	Increase reference count. More...

long	release ()
	Decrease reference count. Implicit destruction. More...

Geant4Context *	context () const
	Access the context. More...

virtual void	updateContext (Geant4Context *ctxt)
	Set or update client context. More...

virtual void	configureFiber (Geant4Context *thread_context)
	Set or update client for the use in a new thread fiber. More...

const std::string &	name () const
	Access name of the action. More...

const char *	c_name () const
	Access name of the action. More...

void	setName (const std::string &new_name)
	Set the object name. More...

PropertyManager &	properties ()
	Access to the properties of the object. More...

PrintLevel	outputLevel () const
	Access the output level. More...

PrintLevel	setOutputLevel (PrintLevel new_level)
	Set the output level; returns previous value. More...

Geant4UIMessenger *	control () const
	Access to the UI messenger. More...

virtual void	enableUI ()
	Enable and install UI messenger. More...

template<typename T >
Geant4Action &	declareProperty (const std::string &nam, T &val)
	Declare property. More...

template<typename T >
Geant4Action &	declareProperty (const char *nam, T &val)
	Declare property. More...

bool	hasProperty (const std::string &name) const
	Check property for existence. More...

Property &	property (const std::string &name)
	Access single property. More...

virtual void	installMessengers ()
	Install property control messenger if wanted. More...

virtual void	installCommandMessenger ()
	Install command control messenger if wanted. More...

virtual void	installPropertyMessenger ()
	Install property control messenger if wanted. More...

void	print (const char *fmt,...) const
	Support for messages with variable output level using output level. More...

void	printM1 (const char *fmt,...) const
	Support for messages with variable output level using output level-1. More...

void	printM2 (const char *fmt,...) const
	Support for messages with variable output level using output level-2. More...

void	printP1 (const char *fmt,...) const
	Support for messages with variable output level using output level+1. More...

void	printP2 (const char *fmt,...) const
	Support for messages with variable output level using output level+2. More...

void	always (const char *fmt,...) const
	Support of always printed messages. More...

void	debug (const char *fmt,...) const
	Support of debug messages. More...

void	info (const char *fmt,...) const
	Support of info messages. More...

void	warning (const char *fmt,...) const
	Support of warning messages. More...

void	error (const char *fmt,...) const
	Support of error messages. More...

bool	return_error (bool return_value, const char *fmt,...) const
	Action to support error messages. More...

void	fatal (const char *fmt,...) const
	Support of fatal messages. Throws exception. More...

void	except (const char *fmt,...) const
	Support of exceptions: Print fatal message and throw runtime_error. More...

void	abortRun (const std::string &exception, const char *fmt,...) const
	Abort Geant4 Run by throwing a G4Exception with type RunMustBeAborted. More...

Geant4RunActionSequence &	runAction () const
	Access to the main run action sequence from the kernel object. More...

Geant4EventActionSequence &	eventAction () const
	Access to the main event action sequence from the kernel object. More...

Geant4SteppingActionSequence &	steppingAction () const
	Access to the main stepping action sequence from the kernel object. More...

Geant4TrackingActionSequence &	trackingAction () const
	Access to the main tracking action sequence from the kernel object. More...

Geant4StackingActionSequence &	stackingAction () const
	Access to the main stacking action sequence from the kernel object. More...

Geant4GeneratorActionSequence &	generatorAction () const
	Access to the main generator action sequence from the kernel object. More...

Protected Types
typedef std::map< const G4ParticleDefinition *, double >	ParticleCut

typedef std::map< std::string, std::string >	ParticleConfig

typedef Geant4ShowerModelWrapper *	Wrapper

Protected Member Functions
	DDG4_DEFINE_ACTION_CONSTRUCTORS (Geant4FastSimShowerModel)
	Define standard assignments and constructors. More...

G4Material *	getMaterial (const std::string &name) const
	Get parametrization material. More...

G4ParticleDefinition *	getParticleDefinition (const std::string &name) const
	Access particle definition from string. More...

G4Region *	getRegion (const std::string &nam) const
	Access the region from the detector description by name. More...

void	addShowerModel (G4Region *region)
	Add shower model to region's fast simulation manager. More...

void	killParticle (G4FastStep &step, double deposit, double step_length=0e0)
	Kill primary particle when creating the shower. More...

Protected Member Functions inherited from dd4hep::sim::Geant4Action
	DDG4_DEFINE_ACTION_CONSTRUCTORS (Geant4Action)
	Define standard assignments and constructors. More...

virtual	~Geant4Action ()
	Default destructor. More...

Protected Attributes
std::string	m_regionName { "Region-name-not-specified"}
	Property: Region name to which this parametrization should be applied. More...

std::vector< std::string >	m_applicablePartNames { }
	Property: Particle names for which this parametrization is applicable. More...

bool	m_enable { false }
	Property: Parametrisation control: Enable/disable fast simulation. More...

double	m_stepX0 { 0.1 }
	Property: Defines step length. More...

ParticleConfig	m_eMin { }
	Property: Set minimum kinetic energy to trigger parametrisation. More...

ParticleConfig	m_eMax { }
	Property: Set maximum kinetic energy to trigger parametrisation. More...

ParticleConfig	m_eKill { }
	Property: Set maximum kinetic energy for particles to be killed. More...

ParticleConfig	m_eTriggerNames { }
	Property: Set minimal kinetic energy for particles to trigger the model. More...

std::set< const G4ParticleDefinition * >	m_applicableParticles { }
	Particle definitions for which this parametrization is applicable. More...

ParticleCut	m_eTriggerCut { }
	Particle cut to trigger model simulation indexed by G4ParticleDefinition. More...

G4VFastSimulationModel *	m_model { nullptr }
	Reference to the G4 fast simulation model. More...

Wrapper	m_wrapper { nullptr }
	Reference to the shower model. More...

Protected Attributes inherited from dd4hep::sim::Geant4Action
Geant4Context *	m_context { nullptr }
	Reference to the Geant4 context. More...

Geant4UIMessenger *	m_control { nullptr }
	Control directory of this action. More...

int	m_outputLevel { 3 }
	Default property: Output level. More...

bool	m_needsControl { false }
	Default property: Flag to create control instance. More...

std::string	m_name { }
	Action name. More...

PropertyManager	m_properties { }
	Property pool. More...

long	m_refCount { 1 }
	Reference count. Initial value: 1. More...

Detailed Description

Geant4 wrapper for the Geant4 fast simulation shower model.

Geant4 wrapper for the Geant4 fast simulation shower model

Author: M.Frank

Version: 1.0

Definition at line 50 of file Geant4FastSimShowerModel.h.

Member Typedef Documentation

◆ ParticleConfig

typedef std::map<std::string, std::string> dd4hep::sim::Geant4FastSimShowerModel::ParticleConfig

protected

Definition at line 54 of file Geant4FastSimShowerModel.h.

◆ ParticleCut

typedef std::map<const G4ParticleDefinition*, double> dd4hep::sim::Geant4FastSimShowerModel::ParticleCut

protected

Definition at line 53 of file Geant4FastSimShowerModel.h.

◆ Wrapper

typedef Geant4ShowerModelWrapper* dd4hep::sim::Geant4FastSimShowerModel::Wrapper

protected

Definition at line 55 of file Geant4FastSimShowerModel.h.

Constructor & Destructor Documentation

◆ Geant4FastSimShowerModel()

Geant4FastSimShowerModel::Geant4FastSimShowerModel	(	Geant4Context *	context,
		const std::string &	nam
	)

Standard constructor.

Definition at line 90 of file Geant4FastSimShowerModel.cpp.

◆ ~Geant4FastSimShowerModel()

Geant4FastSimShowerModel::~Geant4FastSimShowerModel ( )

virtual

Default destructor.

Definition at line 105 of file Geant4FastSimShowerModel.cpp.

Member Function Documentation

◆ addShowerModel()

void Geant4FastSimShowerModel::addShowerModel ( G4Region * region )

protected

Add shower model to region's fast simulation manager.

Definition at line 152 of file Geant4FastSimShowerModel.cpp.

◆ check_applicability()

bool Geant4FastSimShowerModel::check_applicability ( const G4ParticleDefinition & particle )

virtual

User callback to determine if the model is applicable for the particle type.

Reimplemented in dd4hep::sim::Geant4FSShowerModel< CONCRETE_MODEL >.

Definition at line 204 of file Geant4FastSimShowerModel.cpp.

◆ check_trigger()

bool Geant4FastSimShowerModel::check_trigger ( const G4FastTrack & track )

virtual

User callback to determine if the shower creation should be triggered.

Reimplemented in dd4hep::sim::Geant4FSShowerModel< CONCRETE_MODEL >, and dd4hep::sim::Geant4FSShowerModel< CONCRETE_MODEL >.

Definition at line 211 of file Geant4FastSimShowerModel.cpp.

◆ constructField()

void Geant4FastSimShowerModel::constructField ( Geant4DetectorConstructionContext * ctxt )

overridevirtual

Electromagnetic field construction callback. Called at "ConstructSDandField()".

Reimplemented from dd4hep::sim::Geant4DetectorConstruction.

Reimplemented in dd4hep::sim::Geant4FSShowerModel< CONCRETE_MODEL >.

Definition at line 180 of file Geant4FastSimShowerModel.cpp.

◆ constructGeo()

void Geant4FastSimShowerModel::constructGeo ( Geant4DetectorConstructionContext * ctxt )

overridevirtual

Geometry construction callback. Called at "Construct()".

Reimplemented from dd4hep::sim::Geant4DetectorConstruction.

Reimplemented in dd4hep::sim::Geant4FSShowerModel< CONCRETE_MODEL >.

Definition at line 171 of file Geant4FastSimShowerModel.cpp.

◆ constructSensitives()

void Geant4FastSimShowerModel::constructSensitives ( Geant4DetectorConstructionContext * ctxt )

overridevirtual

Sensitive detector construction callback. Called at "ConstructSDandField()".

Reimplemented from dd4hep::sim::Geant4DetectorConstruction.

Reimplemented in dd4hep::sim::Geant4FSShowerModel< CONCRETE_MODEL >, dd4hep::sim::Geant4FSShowerModel< CONCRETE_MODEL >, dd4hep::sim::Geant4GFlashShowerModel, and dd4hep::sim::Geant4FSShowerModel< CONCRETE_MODEL >.

Definition at line 184 of file Geant4FastSimShowerModel.cpp.

◆ DDG4_DEFINE_ACTION_CONSTRUCTORS()

dd4hep::sim::Geant4FastSimShowerModel::DDG4_DEFINE_ACTION_CONSTRUCTORS ( Geant4FastSimShowerModel )

protected

Define standard assignments and constructors.

◆ getMaterial()

G4Material * Geant4FastSimShowerModel::getMaterial ( const std::string & name ) const

protected

Get parametrization material.

Definition at line 119 of file Geant4FastSimShowerModel.cpp.

◆ getParticleDefinition()

G4ParticleDefinition * Geant4FastSimShowerModel::getParticleDefinition ( const std::string & name ) const

protected

Access particle definition from string.

Definition at line 111 of file Geant4FastSimShowerModel.cpp.

◆ getRegion()

G4Region * Geant4FastSimShowerModel::getRegion ( const std::string & nam ) const

protected

Access the region from the detector description by name.

Definition at line 134 of file Geant4FastSimShowerModel.cpp.

◆ killParticle()

void Geant4FastSimShowerModel::killParticle	(	G4FastStep &	step,
		double	deposit,
		double	step_length = `0e0`
	)

protected

Kill primary particle when creating the shower.

Definition at line 197 of file Geant4FastSimShowerModel.cpp.

◆ modelShower()

void Geant4FastSimShowerModel::modelShower	(	const G4FastTrack &	track,
		G4FastStep &	step
	)

virtual

User callback to model the particle/energy shower.

Reimplemented in dd4hep::sim::Geant4FSShowerModel< CONCRETE_MODEL >, dd4hep::sim::Geant4FSShowerModel< CONCRETE_MODEL >, dd4hep::sim::Geant4FSShowerModel< CONCRETE_MODEL >, and dd4hep::sim::Geant4FSShowerModel< CONCRETE_MODEL >.

Definition at line 226 of file Geant4FastSimShowerModel.cpp.

Member Data Documentation

◆ m_applicableParticles

std::set<const G4ParticleDefinition*> dd4hep::sim::Geant4FastSimShowerModel::m_applicableParticles { }

protected

Particle definitions for which this parametrization is applicable.

Definition at line 75 of file Geant4FastSimShowerModel.h.

◆ m_applicablePartNames

std::vector<std::string> dd4hep::sim::Geant4FastSimShowerModel::m_applicablePartNames { }

protected

Property: Particle names for which this parametrization is applicable.

Definition at line 60 of file Geant4FastSimShowerModel.h.

◆ m_eKill

ParticleConfig dd4hep::sim::Geant4FastSimShowerModel::m_eKill { }

protected

Property: Set maximum kinetic energy for particles to be killed.

Definition at line 70 of file Geant4FastSimShowerModel.h.

◆ m_eMax

ParticleConfig dd4hep::sim::Geant4FastSimShowerModel::m_eMax { }

protected

Property: Set maximum kinetic energy to trigger parametrisation.

Definition at line 68 of file Geant4FastSimShowerModel.h.

◆ m_eMin

ParticleConfig dd4hep::sim::Geant4FastSimShowerModel::m_eMin { }

protected

Property: Set minimum kinetic energy to trigger parametrisation.

Definition at line 66 of file Geant4FastSimShowerModel.h.

◆ m_enable

bool dd4hep::sim::Geant4FastSimShowerModel::m_enable { false }

protected

Property: Parametrisation control: Enable/disable fast simulation.

Definition at line 62 of file Geant4FastSimShowerModel.h.

◆ m_eTriggerCut

ParticleCut dd4hep::sim::Geant4FastSimShowerModel::m_eTriggerCut { }

protected

Particle cut to trigger model simulation indexed by G4ParticleDefinition.

Definition at line 77 of file Geant4FastSimShowerModel.h.

◆ m_eTriggerNames

ParticleConfig dd4hep::sim::Geant4FastSimShowerModel::m_eTriggerNames { }

protected

Property: Set minimal kinetic energy for particles to trigger the model.

Definition at line 72 of file Geant4FastSimShowerModel.h.

◆ m_model

G4VFastSimulationModel* dd4hep::sim::Geant4FastSimShowerModel::m_model { nullptr }

protected

Reference to the G4 fast simulation model.

Definition at line 79 of file Geant4FastSimShowerModel.h.

◆ m_regionName

std::string dd4hep::sim::Geant4FastSimShowerModel::m_regionName { "Region-name-not-specified"}

protected

Property: Region name to which this parametrization should be applied.

Definition at line 58 of file Geant4FastSimShowerModel.h.

◆ m_stepX0

double dd4hep::sim::Geant4FastSimShowerModel::m_stepX0 { 0.1 }

protected

Property: Defines step length.

Definition at line 64 of file Geant4FastSimShowerModel.h.

◆ m_wrapper

Wrapper dd4hep::sim::Geant4FastSimShowerModel::m_wrapper { nullptr }

protected

Reference to the shower model.

Definition at line 81 of file Geant4FastSimShowerModel.h.

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

DDG4/include/DDG4/Geant4FastSimShowerModel.h
DDG4/src/Geant4FastSimShowerModel.cpp

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ ParticleConfig

◆ ParticleCut

◆ Wrapper

Constructor & Destructor Documentation

◆ Geant4FastSimShowerModel()

◆ ~Geant4FastSimShowerModel()

Member Function Documentation

◆ addShowerModel()

◆ check_applicability()

◆ check_trigger()

◆ constructField()

◆ constructGeo()

◆ constructSensitives()

◆ DDG4_DEFINE_ACTION_CONSTRUCTORS()

◆ getMaterial()

◆ getParticleDefinition()

◆ getRegion()

◆ killParticle()

◆ modelShower()

Member Data Documentation

◆ m_applicableParticles

◆ m_applicablePartNames

◆ m_eKill

◆ m_eMax

◆ m_eMin

◆ m_enable

◆ m_eTriggerCut

◆ m_eTriggerNames

◆ m_model

◆ m_regionName

◆ m_stepX0

◆ m_wrapper