G4RunTool.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef G4ATLASSERVICES_G4RunTool_H
#define G4ATLASSERVICES_G4RunTool_H
 
// Base classes
#include "AthenaBaseComps/AthAlgTool.h"
 
// Gaudi headers
#include "GaudiKernel/ServiceHandle.h"
#include "GaudiKernel/ToolHandle.h"
 
// Athena headers
#include "G4AtlasInterfaces/IG4RunTool.h"
#include "G4AtlasInterfaces/IDetectorConstructionTool.h"
#include "G4AtlasInterfaces/IG4RunTool.h"
#include "G4AtlasInterfaces/IPhysicsListSvc.h"
#include "G4AtlasInterfaces/IPhysicsInitialization.h"
#include "G4AtlasInterfaces/IUserActionSvc.h"
#include "G4AtlasInterfaces/IUserActionTool.h"
#include "G4AtlasInterfaces/IUserLimitsSvc.h"
#include "G4RunManagement/AtlasG4SyncEventUserInfo.h"
 
// STL headers
#include <condition_variable>
#include <memory>
#include <mutex>
#include <queue>
#include <thread>

class G4RunTool : public extends<AthAlgTool , IG4RunTool> {
 public:
 
  // Standard constructor
  using extends::extends;
 
  // Gaudi methods
  virtual StatusCode initialize() override final;
  virtual StatusCode finalize() override final;
  
  // Status management
  virtual void NotifyBeginRun() override;
  virtual void WaitBeginRun() override;
  
  // Event queue management
  virtual size_t Size() const override;
  virtual void PushEvent(UPEvent ev) override;
  virtual UPEvent GetEvent() override;
 
 private:
  void Geant4main();
  void commandLog(int returnCode, const std::string& commandString) const;
 
  ServiceHandle<IPhysicsListSvc> m_physicsListSvc{this, "PhysicsListSvc", "PhysicsListSvc"};
  ServiceHandle<IUserLimitsSvc> m_userLimitsSvc{this, "UserLimitsSvc", "UserLimitsSvc"};
  ServiceHandle<G4UA::IUserActionSvc> m_userActionSvc{this, "UserActionSvc", "G4UA::UserActionSvc"};
 
  ToolHandle<IDetectorConstructionTool> m_detConstruction{this, "DetectorConstruction", "", "Tool handle of the DetectorConstruction"};
  ToolHandleArray<G4UA::IUserActionTool> m_actionTools{this, "UserActionTools", {}, "User action tools to be added to the G4 Action service."};
  PublicToolHandleArray<IPhysicsInitializationTool> m_physicsInitializationTools{this, "PhysicsInitializationTools", {}, "Physics initialization happening after Geant4 initialization"};
 
  Gaudi::Property<bool> m_activateParallelGeometries{this, "ActivateParallelWorlds", false, "Toggle on/off the G4 parallel geometry system"};
 
  Gaudi::Property<std::string> m_libList{this, "Dll", "", ""};
  Gaudi::Property<std::string> m_physList{this, "Physics", "", ""};
  Gaudi::Property<std::string> m_fieldMap{this, "FieldMap", "", ""};
  Gaudi::Property<std::vector<std::string> > m_g4commands{this, "G4Commands", {}, "Commands to be sent to Geant4 UI at initialization"};
 
  Gaudi::Property<int> m_nG4threads{this, "NG4threads", 1, "Number of parallel G4 worker threads to launch"};
  Gaudi::Property<int> m_nG4eventsPerRun{this, "NG4eventsPerRun", 100000, "Number of G4 events foreseen for each Run"};
 
  struct StateSynchronization
  {
    enum class Status {
      Created,
      BeginRun,
      AthenaFinalize,
      Size
    };
    void SetStatus(const Status&);
    void WaitStatus(const Status&);
    Status m_status{Status::Created};
    mutable std::mutex m_mutex;
    std::condition_variable m_cv;
  };
 
  struct EventQueueSynchronization
  {
    std::queue<UPEvent> m_events;
    mutable std::mutex m_mutex;
    std::condition_variable m_cv;
  };
 
  // The Geant4 main thread
  std::unique_ptr<std::thread> m_thread;
  
  // Status management
  StateSynchronization m_statusSync;
  
  // Event queue management
  EventQueueSynchronization m_eventQueueSync;
};
 
#endif