DD4hep  1.37.0
Detector Description Toolkit for High Energy Physics
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
dd4hep::sim::Geant4HepEmTrackingPhysics Class Reference

DDG4 physics constructor that installs the G4HepEm vectorised EM tracking manager. More...

Inheritance diagram for dd4hep::sim::Geant4HepEmTrackingPhysics:
dd4hep::sim::Geant4PhysicsList dd4hep::sim::Geant4Action

Public Member Functions

 Geant4HepEmTrackingPhysics (Geant4Context *context, const std::string &nam)
 Standard constructor. More...
 
virtual ~Geant4HepEmTrackingPhysics ()=default
 Default destructor. More...
 
virtual void constructProcesses (G4VUserPhysicsList *) override
 Callback to install the G4HepEmTrackingManager on e-, e+ and gamma. More...
 
- Public Member Functions inherited from dd4hep::sim::Geant4PhysicsList
 Geant4PhysicsList (Geant4Context *context, const std::string &nam)
 Standard constructor with initailization parameters. More...
 
virtual ~Geant4PhysicsList ()
 Default destructor. More...
 
void dump ()
 Dump content to stdout. More...
 
virtual void installCommandMessenger () override
 Install command control messenger if wanted. More...
 
PhysicsProcessesprocesses ()
 Access all physics processes. More...
 
const PhysicsProcessesprocesses () const
 Access all physics processes. More...
 
ParticleProcessesprocesses (const std::string &part_name)
 Access processes for one particle type. More...
 
const ParticleProcessesprocesses (const std::string &part_name) const
 Access processes for one particle type (CONST) More...
 
PhysicsProcessesdiscreteProcesses ()
 Access all physics discrete processes. More...
 
const PhysicsProcessesdiscreteProcesses () const
 Access all physics discrete processes. More...
 
ParticleProcessesdiscreteProcesses (const std::string &part_name)
 Access discrete processes for one particle type. More...
 
const ParticleProcessesdiscreteProcesses (const std::string &part_name) const
 Access discrete processes for one particle type (CONST) More...
 
PhysicsConstructor physics (const std::string &name) const
 Access physics constructor by name. More...
 
ParticleConstructorsparticles ()
 Access all physics particles. More...
 
const ParticleConstructorsparticles () const
 Access all physics particles. More...
 
ParticleConstructorsparticlegroups ()
 Access all physics particlegroups. More...
 
const ParticleConstructorsparticlegroups () const
 Access all physics particlegroups. More...
 
PhysicsConstructorsphysics ()
 Access all physics constructors. More...
 
const PhysicsConstructorsphysics () const
 Access all physics constructors. More...
 
void addParticleConstructor (const std::string &part_name)
 Add physics particle constructor by name. More...
 
void addParticleGroup (const std::string &part_name)
 Add physics particle group constructor by name (Leptons, Bosons, Mesons, etc.) More...
 
void addParticleProcess (const std::string &part_name, const std::string &proc_name, int ordAtRestDoIt, int ordAlongSteptDoIt, int ordPostStepDoIt)
 Add particle process by name with arguments. More...
 
void addDiscreteParticleProcess (const std::string &part_name, const std::string &proc_name)
 Add discrete particle process by name with arguments. More...
 
void addPhysicsConstructor (const std::string &physics_name)
 Add PhysicsConstructor by name. More...
 
void adoptPhysicsConstructor (Geant4Action *action)
 Add PhysicsConstructor as Geant4Action object. More...
 
G4VPhysicsConstructoraddPhysicsConstructorType (const std::string &physics_name)
 Callback to add a physics type to the physics list. More...
 
virtual void constructPhysics (G4VModularPhysicsList *physics)
 constructPhysics callback More...
 
virtual void constructParticles (G4VUserPhysicsList *physics)
 Callback to construct particles. More...
 
virtual void enable (G4VUserPhysicsList *physics)
 Enable physics list: actions necessary to be propagated to Geant4. 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 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...
 

Protected Member Functions

 DDG4_DEFINE_ACTION_CONSTRUCTORS (Geant4HepEmTrackingPhysics)
 Define standard assignments and constructors. 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::vector< std::string > m_woodcockRegions
 G4Region names in which Woodcock tracking is activated for photons. 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...
 

Additional Inherited Members

- Public Types inherited from dd4hep::sim::Geant4PhysicsList
typedef std::vector< ProcessParticleProcesses
 
typedef std::map< std::string, ParticleProcessesPhysicsProcesses
 
typedef std::vector< ParticleConstructorParticleConstructors
 
typedef std::vector< PhysicsConstructorPhysicsConstructors
 
- Public Attributes inherited from dd4hep::sim::Geant4PhysicsList
PhysicsProcesses m_processes
 
PhysicsProcesses m_discreteProcesses
 
PhysicsConstructors m_physics
 
ParticleConstructors m_particles
 
ParticleConstructors m_particlegroups
 

Detailed Description

DDG4 physics constructor that installs the G4HepEm vectorised EM tracking manager.

Replaces the Geant4 stepping loop for e-, e+ and gamma with G4HepEmTrackingManager, providing SIMD-vectorised EM physics.

A single G4HepEmTrackingManager instance is created per call to constructProcesses() and registered with all three particle types (e-, e+, gamma). This is the canonical G4HepEm usage pattern: G4HepEmTrackingManager::HandOverOneTrack() dispatches internally on particle type, so one shared instance handles all three species.

Geant4 owns and deletes the tracking manager.

Author
W. Deconinck
Version
1.0

Definition at line 93 of file Geant4HepEmTrackingPhysics.cpp.

Constructor & Destructor Documentation

◆ Geant4HepEmTrackingPhysics()

dd4hep::sim::Geant4HepEmTrackingPhysics::Geant4HepEmTrackingPhysics ( Geant4Context context,
const std::string &  nam 
)
inline

Standard constructor.

Definition at line 103 of file Geant4HepEmTrackingPhysics.cpp.

◆ ~Geant4HepEmTrackingPhysics()

virtual dd4hep::sim::Geant4HepEmTrackingPhysics::~Geant4HepEmTrackingPhysics ( )
virtualdefault

Default destructor.

Member Function Documentation

◆ constructProcesses()

virtual void dd4hep::sim::Geant4HepEmTrackingPhysics::constructProcesses ( G4VUserPhysicsList *  )
inlineoverridevirtual

Callback to install the G4HepEmTrackingManager on e-, e+ and gamma.

Called from within G4VPhysicsConstructor::ConstructProcess() by the DDG4 action sequence, after ConstructParticle() has been executed.

Creates one G4HepEmTrackingManager and registers it with all three EM particle types. Ownership is transferred to Geant4: the pointer is stored (non-owning) inside each particle's TLS data slot, and G4VUserPhysicsList::RemoveTrackingManager() will delete it at thread / run teardown.

Reimplemented from dd4hep::sim::Geant4PhysicsList.

Definition at line 122 of file Geant4HepEmTrackingPhysics.cpp.

◆ DDG4_DEFINE_ACTION_CONSTRUCTORS()

dd4hep::sim::Geant4HepEmTrackingPhysics::DDG4_DEFINE_ACTION_CONSTRUCTORS ( Geant4HepEmTrackingPhysics  )
protected

Define standard assignments and constructors.

Member Data Documentation

◆ m_woodcockRegions

std::vector<std::string> dd4hep::sim::Geant4HepEmTrackingPhysics::m_woodcockRegions
protected

G4Region names in which Woodcock tracking is activated for photons.

Definition at line 99 of file Geant4HepEmTrackingPhysics.cpp.


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