DD4hep  1.30.0
Detector Description Toolkit for High Energy Physics
Public Member Functions | Public Attributes | List of all members
dd4hep::sim::Geant4FSShowerModel< CONCRETE_MODEL > Class Template Reference

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

#include <Geant4FastSimShowerModel.h>

Inheritance diagram for dd4hep::sim::Geant4FSShowerModel< CONCRETE_MODEL >:
dd4hep::sim::Geant4FastSimShowerModel dd4hep::sim::Geant4DetectorConstruction dd4hep::sim::Geant4Action

Public Member Functions

 Geant4FSShowerModel (Geant4Context *context, const std::string &nam)
 Standard constructor. More...
 
virtual ~Geant4FSShowerModel ()
 Default destructor. More...
 
void initialize ()
 Declare optional properties from embedded structure. 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) override
 User callback to determine if the model is applicable for the particle type. More...
 
virtual bool check_trigger (const G4FastTrack &track) override
 User callback to determine if the shower creation should be triggered. More...
 
virtual void modelShower (const G4FastTrack &track, G4FastStep &step) override
 User callback to model the particle/energy shower. More...
 
void initialize ()
 Declare optional properties from embedded structure. More...
 
void constructSensitives (Geant4DetectorConstructionContext *ctxt)
 Sensitive detector construction callback. Called at "ConstructSDandField()". More...
 
void modelShower (const G4FastTrack &track, G4FastStep &step)
 User callback to model the particle/energy shower. More...
 
void initialize ()
 Declare optional properties from embedded structure. More...
 
void constructSensitives (Geant4DetectorConstructionContext *ctxt)
 Sensitive detector construction callback. Called at "ConstructSDandField()". More...
 
void modelShower (const G4FastTrack &track, G4FastStep &step)
 User callback to model the particle/energy shower. More...
 
void initialize ()
 Declare optional properties from embedded structure. More...
 
bool check_trigger (const G4FastTrack &)
 User callback to determine if the shower creation should be triggered. More...
 
void modelShower (const G4FastTrack &track, G4FastStep &step)
 User callback to model the particle/energy shower. More...
 
- Public Member Functions inherited from dd4hep::sim::Geant4FastSimShowerModel
 Geant4FastSimShowerModel (Geant4Context *context, const std::string &nam)
 Standard constructor. More...
 
virtual ~Geant4FastSimShowerModel ()
 Default destructor. 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 G4VSensitiveDetectorcreateSensitiveDetector (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...
 
Geant4Contextcontext () 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...
 
PropertyManagerproperties ()
 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...
 
Geant4UIMessengercontrol () const
 Access to the UI messenger. More...
 
virtual void enableUI ()
 Enable and install UI messenger. More...
 
template<typename T >
Geant4ActiondeclareProperty (const std::string &nam, T &val)
 Declare property. More...
 
template<typename T >
Geant4ActiondeclareProperty (const char *nam, T &val)
 Declare property. More...
 
bool hasProperty (const std::string &name) const
 Check property for existence. More...
 
Propertyproperty (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...
 
Geant4RunActionSequencerunAction () const
 Access to the main run action sequence from the kernel object. More...
 
Geant4EventActionSequenceeventAction () const
 Access to the main event action sequence from the kernel object. More...
 
Geant4SteppingActionSequencesteppingAction () const
 Access to the main stepping action sequence from the kernel object. More...
 
Geant4TrackingActionSequencetrackingAction () const
 Access to the main tracking action sequence from the kernel object. More...
 
Geant4StackingActionSequencestackingAction () const
 Access to the main stacking action sequence from the kernel object. More...
 
Geant4GeneratorActionSequencegeneratorAction () const
 Access to the main generator action sequence from the kernel object. More...
 

Public Attributes

CONCRETE_MODEL locals
 Local parameter buffer to specialize caches, properties etc. More...
 

Additional Inherited Members

- Protected Types inherited from dd4hep::sim::Geant4FastSimShowerModel
typedef std::map< const G4ParticleDefinition *, double > ParticleCut
 
typedef std::map< std::string, std::string > ParticleConfig
 
typedef Geant4ShowerModelWrapperWrapper
 
- Protected Member Functions inherited from dd4hep::sim::Geant4FastSimShowerModel
 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 inherited from dd4hep::sim::Geant4FastSimShowerModel
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
Geant4Contextm_context { nullptr }
 Reference to the Geant4 context. More...
 
Geant4UIMessengerm_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

template<typename CONCRETE_MODEL>
class dd4hep::sim::Geant4FSShowerModel< CONCRETE_MODEL >

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 130 of file Geant4FastSimShowerModel.h.

Constructor & Destructor Documentation

◆ Geant4FSShowerModel()

template<typename CONCRETE_MODEL >
dd4hep::sim::Geant4FSShowerModel< CONCRETE_MODEL >::Geant4FSShowerModel ( Geant4Context context,
const std::string &  nam 
)

Standard constructor.

Definition at line 35 of file Geant4FastSimShowerModel.inl.h.

◆ ~Geant4FSShowerModel()

template<typename CONCRETE_MODEL >
dd4hep::sim::Geant4FSShowerModel< CONCRETE_MODEL >::~Geant4FSShowerModel
virtual

Default destructor.

Definition at line 43 of file Geant4FastSimShowerModel.inl.h.

Member Function Documentation

◆ check_applicability()

template<typename CONCRETE_MODEL >
bool dd4hep::sim::Geant4FSShowerModel< CONCRETE_MODEL >::check_applicability ( const G4ParticleDefinition &  particle)
overridevirtual

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

Default implementation checks if the particle is registered in 'ApplicableParticles'

Reimplemented from dd4hep::sim::Geant4FastSimShowerModel.

Definition at line 71 of file Geant4FastSimShowerModel.inl.h.

◆ check_trigger() [1/2]

bool dd4hep::sim::Geant4FSShowerModel< par01_pion_model >::check_trigger ( const G4FastTrack &  )
virtual

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

Reimplemented from dd4hep::sim::Geant4FastSimShowerModel.

Definition at line 161 of file Geant4P1ShowerModel.cpp.

◆ check_trigger() [2/2]

template<typename CONCRETE_MODEL >
bool dd4hep::sim::Geant4FSShowerModel< CONCRETE_MODEL >::check_trigger ( const G4FastTrack &  track)
overridevirtual

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

Default implementation checks if for all particles registered in 'Etrigger' the kinetic energy is bigger than the value.

Reimplemented from dd4hep::sim::Geant4FastSimShowerModel.

Definition at line 77 of file Geant4FastSimShowerModel.inl.h.

◆ constructField()

template<typename CONCRETE_MODEL >
void dd4hep::sim::Geant4FSShowerModel< CONCRETE_MODEL >::constructField ( Geant4DetectorConstructionContext ctxt)
overridevirtual

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

Reimplemented from dd4hep::sim::Geant4FastSimShowerModel.

Definition at line 59 of file Geant4FastSimShowerModel.inl.h.

◆ constructGeo()

template<typename CONCRETE_MODEL >
void dd4hep::sim::Geant4FSShowerModel< CONCRETE_MODEL >::constructGeo ( Geant4DetectorConstructionContext ctxt)
overridevirtual

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

Reimplemented from dd4hep::sim::Geant4FastSimShowerModel.

Definition at line 53 of file Geant4FastSimShowerModel.inl.h.

◆ constructSensitives() [1/3]

void dd4hep::sim::Geant4FSShowerModel< par01_em_model >::constructSensitives ( Geant4DetectorConstructionContext ctxt)
virtual

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

Reimplemented from dd4hep::sim::Geant4FastSimShowerModel.

Definition at line 75 of file Geant4P1ShowerModel.cpp.

◆ constructSensitives() [2/3]

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

Reimplemented from dd4hep::sim::Geant4FastSimShowerModel.

Definition at line 96 of file Geant4CaloSmearShowerModel.cpp.

◆ constructSensitives() [3/3]

template<typename CONCRETE_MODEL >
void dd4hep::sim::Geant4FSShowerModel< CONCRETE_MODEL >::constructSensitives ( Geant4DetectorConstructionContext ctxt)
overridevirtual

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

Reimplemented from dd4hep::sim::Geant4FastSimShowerModel.

Definition at line 65 of file Geant4FastSimShowerModel.inl.h.

◆ initialize() [1/4]

Declare optional properties from embedded structure.

Definition at line 66 of file Geant4P1ShowerModel.cpp.

◆ initialize() [2/4]

Declare optional properties from embedded structure.

Definition at line 88 of file Geant4CaloSmearShowerModel.cpp.

◆ initialize() [3/4]

template<typename CONCRETE_MODEL >
void dd4hep::sim::Geant4FSShowerModel< CONCRETE_MODEL >::initialize

Declare optional properties from embedded structure.

Definition at line 48 of file Geant4FastSimShowerModel.inl.h.

◆ initialize() [4/4]

Declare optional properties from embedded structure.

Definition at line 154 of file Geant4P1ShowerModel.cpp.

◆ modelShower() [1/4]

void dd4hep::sim::Geant4FSShowerModel< par01_em_model >::modelShower ( const G4FastTrack &  track,
G4FastStep &  step 
)
virtual

User callback to model the particle/energy shower.

Process spot and call sensitive detector

Reimplemented from dd4hep::sim::Geant4FastSimShowerModel.

Definition at line 83 of file Geant4P1ShowerModel.cpp.

◆ modelShower() [2/4]

void dd4hep::sim::Geant4FSShowerModel< calo_smear_model >::modelShower ( const G4FastTrack &  track,
G4FastStep &  step 
)
virtual

User callback to model the particle/energy shower.

Reimplemented from dd4hep::sim::Geant4FastSimShowerModel.

Definition at line 102 of file Geant4CaloSmearShowerModel.cpp.

◆ modelShower() [3/4]

void dd4hep::sim::Geant4FSShowerModel< par01_pion_model >::modelShower ( const G4FastTrack &  track,
G4FastStep &  step 
)
virtual

User callback to model the particle/energy shower.

Process spot and call sensitive detector

Reimplemented from dd4hep::sim::Geant4FastSimShowerModel.

Definition at line 167 of file Geant4P1ShowerModel.cpp.

◆ modelShower() [4/4]

template<typename CONCRETE_MODEL >
void dd4hep::sim::Geant4FSShowerModel< CONCRETE_MODEL >::modelShower ( const G4FastTrack &  track,
G4FastStep &  step 
)
overridevirtual

User callback to model the particle/energy shower.

Reimplemented from dd4hep::sim::Geant4FastSimShowerModel.

Definition at line 83 of file Geant4FastSimShowerModel.inl.h.

Member Data Documentation

◆ locals

template<typename CONCRETE_MODEL >
CONCRETE_MODEL dd4hep::sim::Geant4FSShowerModel< CONCRETE_MODEL >::locals

Local parameter buffer to specialize caches, properties etc.

Definition at line 134 of file Geant4FastSimShowerModel.h.


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