EIC code displayed by LXR master/​include/​DDG4/​Geant4Kernel.h	Source navigation Diff markup Identifier search General search
	Version: master test Revert   Change

File indexing completed on 2025-07-11 08:30:02

 //==========================================================================
 //  AIDA Detector description implementation 
 //--------------------------------------------------------------------------
 // Copyright (C) Organisation europeenne pour la Recherche nucleaire (CERN)
 // All rights reserved.
 //
 // For the licensing terms see $DD4hepINSTALL/LICENSE.
 // For the list of contributors see $DD4hepINSTALL/doc/CREDITS.
 //
 // Author     : M.Frank
 //
 //==========================================================================
 #ifndef DDG4_GEANT4KERNEL_H
 #define DDG4_GEANT4KERNEL_H
 
 // Framework include files
 #include <DDG4/Geant4ActionContainer.h>
 
 // C/C++ include files
 #include <map>
 #include <typeinfo>
 #include <functional>
 
 // Forward declarations
 class G4RunManager;
 class G4UIdirectory;
 class G4VPhysicalVolume;
 
 /// Namespace for the AIDA detector description toolkit
 namespace dd4hep {
 
   // Forward declarations
   class Geant4Interrupts;
 
   /// Namespace for the Geant4 based simulation part of the AIDA detector description toolkit
   namespace sim {
 
     // Forward declarations
     class Geant4Interrupts;
     class Geant4ActionPhase;
 
     /// Helper class to indicate the end of the input file
     class DD4hep_End_Of_File : public std::exception {
     public:
       DD4hep_End_Of_File() : std::exception() {}
       virtual const char* what() const noexcept override { return "Reached end of input file"; }
     };
 
     /// Helper class to indicate the stop of processing
     class DD4hep_Stop_Processing : public std::exception {
     public:
       DD4hep_Stop_Processing() : std::exception() {}
       virtual const char* what() const noexcept override { return "Event loop STOP signalled. Processing stops"; }
     };
 
     /// Class, which allows all Geant4Action derivatives to access the DDG4 kernel structures.
     /**
      *  To implement access to a user specified framework please see class Geant4Context.
      *
      *  \author  M.Frank
      *  \version 1.0
      *  \ingroup DD4HEP_SIMULATION
      */
     class Geant4Kernel : public Geant4ActionContainer  {
     public:
       typedef std::map<unsigned long, Geant4Kernel*>    Workers;
       typedef std::map<std::string, Geant4ActionPhase*> Phases;
       typedef std::map<std::string, Geant4Action*>      GlobalActions;
       typedef std::map<std::string,int>                 ClientOutputLevels;
       typedef std::pair<void*, const std::type_info*>   UserFramework;
       using UserCallbacks = std::vector<std::function<void()> >;
 
       enum event_loop_status  {
         EVENTLOOP_HALT = 0,
         EVENTLOOP_RUNNING = 1,
       };
       
     protected:
       /// Reference to the run manager
       G4RunManager*      m_runManager  { nullptr };
       /// Top level control directory
       G4UIdirectory*     m_control     { nullptr };
       /// Reference to Geant4 track manager
       G4TrackingManager* m_trackMgr    { nullptr };
       /// Detector description object
       Detector*          m_detDesc     { nullptr };
       /// Property pool
       PropertyManager    m_properties          { };
       /// Reference to the user framework
       UserFramework      m_userFramework       { };
 
       /// Action phases
       Phases        m_phases                   { };
       /// Worker threads
       Workers       m_workers                  { };
       /// Globally registered actions
       GlobalActions m_globalActions            { };
       /// Globally registered filters of sensitive detectors
       GlobalActions m_globalFilters            { };
       /// Property: Client output levels
       ClientOutputLevels m_clientLevels        { };
       /// Property: Name of the G4UI command tree
       std::string   m_controlName              { };
       /// Property: Name of the UI action. Must be member of the global actions
       std::string   m_uiName                   { };
       /// Property: Name of the G4 run manager factory to be used. Default: Geant4RunManager
       std::string   m_runManagerType;
       /// Property: Name of the default factory to create G4VSensitiveDetector instances
       std::string   m_dfltSensitiveDetectorType;
       /// Property: Names with specialized factories to create G4VSensitiveDetector instances
       std::map<std::string, std::string> m_sensitiveDetectorTypes;
       /// Property: Number of events to be executed in batch mode
       long          m_numEvent       = 10;
       /// Property: Output level
       int           m_outputLevel    = 0;
 
       /// Master property: Number of execution threads in multi threaded mode.
       int           m_numThreads     = 0;
       /// Master property: Instantiate the Geant4 scoring manager object
       int           m_haveScoringMgr = false;
       /// Master property: Flag if event loop is enabled
       int           m_processEvents  = EVENTLOOP_RUNNING;
 
       
       /// Registered action callbacks on configure
       UserCallbacks m_actionConfigure  { };
       /// Registered action callbacks on initialize
       UserCallbacks m_actionInitialize { };
       /// Registered action callbacks on terminate
       UserCallbacks m_actionTerminate  { };
 
 
       /// Flag: Master instance (id<0) or worker (id >= 0)
       unsigned long      m_id = 0, m_ident = 0;
       /// Access to geometry world
       G4VPhysicalVolume* m_world  = 0;
 
       /// Parent reference
       Geant4Kernel*      m_master         { nullptr };
       /// Thread context reference
       Geant4Context*     m_threadContext  { nullptr };
       /// Interrupt/signal handler: only on master instance
       Geant4Interrupts*  m_interrupts     { nullptr };
 
       bool isMaster() const  { return this == m_master; }
       bool isWorker() const  { return this != m_master; }
 
 #ifndef __CINT__
       /// Standard constructor for workers
       Geant4Kernel(Geant4Kernel* m, unsigned long identifier);
 #endif
 
     public:
       /// Standard constructor for the master instance
       Geant4Kernel(Detector& description);
 
       /// Thread's master context
       Geant4Kernel& master()  const  { return *m_master; }
 
       //bool isMultiThreaded() const { return m_multiThreaded; }
       bool isMultiThreaded() const { return m_numThreads > 0; }
 
       /// Access thread identifier
       static unsigned long int thread_self();
 
     public:
 
       /// Embedded helper class to facilitate map access to the phases.
       /** @class PhaseSelector Geant4Kernel.h DDG4/Geant4Kernel.h
        *
        * @author  M.Frank
        * @version 1.0
        */
       class PhaseSelector {
       public:
         /// Reference to embedding object
         Geant4Kernel* m_kernel;
         /// Standard constructor
         PhaseSelector(Geant4Kernel* kernel);
         /// Copy constructor
         PhaseSelector(const PhaseSelector& c);
         /// Assignment operator
         PhaseSelector& operator=(const PhaseSelector& c);
         /// Phase access to the map
         Geant4ActionPhase& operator[](const std::string& name) const;
       } phase;
 
       enum State {
         SETTING_UP, INITIALIZED
       };
       /// Default destructor
       virtual ~Geant4Kernel();
 
 #ifndef __CINT__
       /// Instance accessor
       static Geant4Kernel& instance(Detector& description);
 #endif
       /// Access phase phases
       const Phases& phases() const              {        return m_phases;          }
       /// Access to detector description
       Detector& detectorDescription() const     {        return *m_detDesc;        }
       /// Access the tracking manager
       G4TrackingManager* trackMgr() const       {        return m_trackMgr;        }
       /// Access the tracking manager
       void setTrackMgr(G4TrackingManager* mgr)  {        m_trackMgr = mgr;         }
       /// Access the command directory
       const std::string& directoryName() const  {        return m_controlName;     }
       /// Access worker identifier
       unsigned long id()  const                 {        return m_ident;           }
       /// Access to the Geant4 run manager
       G4RunManager& runManager();
       /// Generic framework access
       UserFramework& userFramework()            {        return m_userFramework;   }
       /// Set the framework context to the kernel object
       template <typename T> void setUserFramework(T* object)   {
         m_userFramework = UserFramework(object,&typeid(T));
       }
       /// Property access: Name of the default factory to create G4VSensitiveDetector instances
       const std::string defaultSensitiveDetectorType()  const  {
         return m_dfltSensitiveDetectorType;
       }
       /// Property access: Names with specialized factories to create G4VSensitiveDetector instances
       const std::map<std::string, std::string>& sensitiveDetectorTypes()  const   {
         return m_sensitiveDetectorTypes;
       }
       /// Add new sensitive type to factory list
       /** This is present mainly for debugging purposes and tests.
        * Never necessary in real life!
        * For all practical purpose the default type Geant4SensDet is sufficient.
        *
        */
       void defineSensitiveDetectorType(const std::string& type, const std::string& factory);
       /// Access to geometry world
       G4VPhysicalVolume* world()  const;
       /// Set the geometry world
       void setWorld(G4VPhysicalVolume* volume);
       
       /** Property access                            */
       /// Access to the properties of the object
       PropertyManager& properties()             {        return m_properties;      }
       /// Print the property values
       void printProperties() const;
       /// Declare property
       template <typename T> Geant4Kernel& declareProperty(const std::string& nam, T& val);
       /// Declare property
       template <typename T> Geant4Kernel& declareProperty(const char* nam, T& val);
       /// Check property for existence
       bool hasProperty(const std::string& name) const;
       /// Access single property
       Property& property(const std::string& name);
 
       /** Output level settings                       */
       /// Access the output level
       PrintLevel outputLevel() const  {        return (PrintLevel)m_outputLevel;    }
       /// Set the global output level of the kernel object; returns previous value
       PrintLevel setOutputLevel(PrintLevel new_level);
       /// Fill cache with the global output level of a named object. Must be set before instantiation
       void setOutputLevel(const std::string object, PrintLevel new_level);
       /// Retrieve the global output level of a named object.
       PrintLevel getOutputLevel(const std::string object) const;
 
       /// Register configure callback. Signature:   (function)()
       void register_configure(const std::function<void()>& callback);
       /// Register initialize callback. Signature:  (function)()
       void register_initialize(const std::function<void()>& callback);
       /// Register terminate callback. Signature:   (function)()
       void register_terminate(const std::function<void()>& callback);
 
       /// Access interrupt handler. Will be created on the first call
       Geant4Interrupts& interruptHandler()  const;
       /// Trigger smooth end-of-event-loop with finishing currently processing event
       void triggerStop();
       /// Check if event processing should be continued
       bool processEvents()  const;
       /// Install DDG4 default handler for a given signal. If no handler: return false
       bool registerInterruptHandler(int sig_num);
       /// (Re-)apply registered interrupt handlers to override potentially later registrations by other libraries
       /** In this case we overwrite signal handlers applied by Geant4.
        */
       void applyInterruptHandlers();
       
       /// Register action by name to be retrieved when setting up and connecting action objects
       /** Note: registered actions MUST be unique.
        *  However, not all actions need to registered....
        *  Only register those, you later need to retrieve by name.
        */
       Geant4Kernel& registerGlobalAction(Geant4Action* action);
       /// Retrieve action from repository
       Geant4Action* globalAction(const std::string& action_name, bool throw_if_not_present = true);
       /// Register filter by name to be retrieved when setting up and connecting filter objects
       /** Note: registered filters MUST be unique.
        *  However, not all filters need to registered....
        *  Only register those, you later need to retrieve by name.
        */
       Geant4Kernel& registerGlobalFilter(Geant4Action* filter);
       /// Retrieve filter from repository
       Geant4Action* globalFilter(const std::string& filter_name, bool throw_if_not_present = true);
 
       /// Access phase by name
       Geant4ActionPhase* getPhase(const std::string& name);
 
       /// Add a new phase to the phase
       virtual Geant4ActionPhase* addSimplePhase(const std::string& name, bool throw_on_exist);
 
       /// Add a new phase to the phase
       virtual Geant4ActionPhase* addPhase(const std::string& name, const std::type_info& arg1, const std::type_info& arg2,
                                           const std::type_info& arg3, bool throw_on_exist);
       /// Add a new phase to the phase
       template <typename A0> Geant4ActionPhase* addPhase(const std::string& name, bool throw_on_exist = true) {
         return addPhase(name, typeid(A0), typeid(void), typeid(void), throw_on_exist);
       }
       /// Add a new phase to the phase
       template <typename A0, typename A1>
       Geant4ActionPhase* addPhase(const std::string& name, bool throw_on_exist = true) {
         return addPhase(name, typeid(A0), typeid(A1), typeid(void), throw_on_exist);
       }
       /// Add a new phase to the phase
       template <typename A0, typename A1, typename A2>
       Geant4ActionPhase* addPhase(const std::string& name, bool throw_on_exist = true) {
         return addPhase(name, typeid(A0), typeid(A1), typeid(A2), throw_on_exist);
       }
       /// Remove an existing phase from the phase. If not existing returns false
       virtual bool removePhase(const std::string& name);
       /// Destroy all phases. To be called only at shutdown.
       virtual void destroyPhases();
 
       /// Execute phase action if it exists
       virtual bool executePhase(const std::string& name, const void** args)  const;
 
       /// Construct detector geometry using description plugin
       virtual void loadGeometry(const std::string& compact_file);
       /// Load XML file 
       virtual void loadXML(const char* fname);
 
       /** Geant4 Multi threading support */
       /// Create identified worker instance
       virtual Geant4Kernel& createWorker();
       /// Access worker instance by its identifier
       Geant4Kernel& worker(unsigned long thread_identifier, bool create_if=false);
       /// Access number of workers
       int numWorkers() const;
 
       /// Run the simulation: Configure Geant4
       virtual int configure();
       /// Run the simulation: Initialize Geant4
       virtual int initialize();
       /// Run the simulation: Simulate the number of events given by the property "NumEvents"
       virtual int run();
       /// Run the simulation: Simulate the number of events "num_events" and modify the property "NumEvents"
       virtual int runEvents(int num_events);
       /// Run the simulation: Terminate Geant4
       virtual int terminate()  override;
     };
     /// Declare property
     template <typename T> Geant4Kernel& Geant4Kernel::declareProperty(const std::string& nam, T& val) {
       m_properties.add(nam, val);
       return *this;
     }
 
     /// Declare property
     template <typename T> Geant4Kernel& Geant4Kernel::declareProperty(const char* nam, T& val) {
       m_properties.add(nam, val);
       return *this;
     }
 
     /// Main executor steering the Geant4 execution
     class Geant4Exec {
     public:
       /// Configure the application
       static int configure(Geant4Kernel& kernel);
       /// Initialize the application
       static int initialize(Geant4Kernel& kernel);
       /// Run the application and simulate events
       static int run(Geant4Kernel& kernel);
       /// Terminate the application
       static int terminate(Geant4Kernel& kernel);
     };
 
   }    // End namespace sim
 }      // End namespace dd4hep
 #endif // DDG4_GEANT4KERNEL_H

This page was automatically generated by the 2.3.7 LXR engine. The LXR team