RMGManager.hh

// Copyright (C) 2022 Luigi Pertoldi <https://orcid.org/0000-0002-0467-2571>
//
// This program is free software: you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License as published by the Free
// Software Foundation, either version 3 of the License, or (at your option) any
// later version.
//
// This program is distributed in the hope that it will be useful, but WITHOUT
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
// FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
// details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
#ifndef _RMG_MANAGER_HH_
#define _RMG_MANAGER_HH_
 
#include <atomic>
#include <memory>
#include <set>
#include <vector>
 
#include "G4RunManager.hh"
#include "G4RunManagerFactory.hh"
#include "G4Threading.hh"
#include "G4VisManager.hh"
#include "globals.hh"
 
#include "RMGExceptionHandler.hh"
#include "RMGLog.hh"
#include "RMGOutputManager.hh"
#include "RMGUserInit.hh"
 
class G4VUserPhysicsList;
class RMGHardware;
class RMGUserAction;
class G4GenericMessenger;
class G4UIExecutive;
class RMGManager {
 
  public:
 
    RMGManager() = delete;
    RMGManager(std::string app_name, int argc, char** argv);
    ~RMGManager() = default;
 
    RMGManager(RMGManager const&) = delete;
    RMGManager& operator=(RMGManager const&) = delete;
    RMGManager(RMGManager&&) = delete;
    RMGManager& operator=(RMGManager&&) = delete;
 
    // getters
    static RMGManager* Instance() { return fRMGManager; }
    G4RunManager* GetG4RunManager();
    G4VisManager* GetG4VisManager();
    RMGHardware* GetDetectorConstruction();
    G4VUserPhysicsList* GetProcessesList();
    [[nodiscard]] auto GetUserInit() const { return fUserInit; }
    [[nodiscard]] auto GetOutputManager() const { return RMGOutputManager::Instance(); }
    [[nodiscard]] int GetPrintModulo() const { return fPrintModulo; }

    [[nodiscard]] bool IsExecSequential() const {
      return fG4RunManager->GetRunManagerType() == G4RunManager::RMType::sequentialRM;
    }

    [[nodiscard]] int GetProcessNumberOffset() const {
      if (fProcessNumber > 0 && (fG4RunManager && !IsExecSequential()))
        RMGLog::OutDev(RMGLog::fatal, "wrong setup for process-based parallelization.");
      return fProcessNumber;
    }

    [[nodiscard]] bool IsMultiProcessing() const { return fMultiProcessing; }
 
    // setters
    void SetUserInit(G4RunManager* g4_manager) {
      fG4RunManager = std::unique_ptr<G4RunManager>(g4_manager);
    }

    void SetUserInit(G4VisManager* vis) { fG4VisManager = std::unique_ptr<G4VisManager>(vis); }
    void SetUserInit(RMGHardware* det) { fDetectorConstruction = det; }
    void SetUserInit(G4VUserPhysicsList* proc) { fPhysicsList = proc; }

    void SetInteractive(bool flag = true) { fInteractive = flag; }
    void SetNumberOfThreads(int nthreads) { fNThreads = nthreads; }
    [[nodiscard]] int GetNumberOfThreads() const { return fNThreads; }
    void SetPrintModulo(int n_ev) { fPrintModulo = n_ev > 0 ? n_ev : -1; }

    void IncludeMacroFile(std::string filename) { fMacroFilesOrContents.emplace_back(filename); }
    void RegisterG4Alias(std::string alias, std::string value) { fG4Aliases.emplace(alias, value); }
    void Initialize();
    void Run();

    void SetRandEngine(std::string name);
    void SetRandEngineSeed(int seed);
    void SetRandEngineInternalSeed(int index);
    void SetRandSystemEntropySeed();
    bool ApplyRandEngineForCurrentThread();
    [[nodiscard]] bool GetRandIsControlled() const { return fIsRandControlled; }
    [[nodiscard]] bool GetRandEngineSelected() const { return !fRandEngineName.empty(); }

    void SetLogLevel(std::string level);

    void EnableMultiProcessing(int proc_num) {
      fProcessNumber = proc_num;
      fMultiProcessing = true;
    }

    [[nodiscard]] bool HadWarning() const {
      return fExceptionHandler->HadWarning() || RMGLog::HadWarning();
    }

    [[nodiscard]] bool HadError() const {
      return fExceptionHandler->HadError() || RMGLog::HadError();
    }

    // NOLINTNEXTLINE(readability-make-member-function-const)
    void ActivateOptionalOutputScheme(std::string name) {
      GetUserInit()->ActivateOptionalOutputScheme(name);
    }

    static void AbortRunGracefully() {
      if (!fAbortRun.is_lock_free()) {
        // A non-lock-free atomic cannot be safely set from the signal handler that calls this.
        // Should not happen for bool on real platforms.
        RMGLog::Out(RMGLog::error, "cannot abort run gracefully: abort flag is not lock-free");
        return;
      }
      fAbortRun = true;
    }

    static bool ShouldAbortRun() { return fAbortRun; }
 
  private:
 
    void SetUpDefaultG4RunManager(G4RunManagerType type = G4RunManagerType::Default);
    void SetUpDefaultG4VisManager();
    void SetUpDefaultDetectorConstruction();
    void SetUpDefaultProcessesList();
    void SetUpDefaultUserAction();
    void CheckRandEngineMTState();
 
    std::unique_ptr<G4UIExecutive> StartInteractiveSession();
 
    std::string fApplicationName;
    int fArgc;
    char** fArgv;
    std::map<std::string, std::string> fG4Aliases;
    std::vector<std::string> fMacroFilesOrContents;
    bool fInteractive = false;
    int fPrintModulo = -1;
    int fNThreads = 1;
    int fProcessNumber = 0;
    bool fMultiProcessing = false;
 
    bool fIsRandControlled = false;
    bool fIsRandControlledAtEngineChange = false;
    std::string fRandEngineName;
 
    static RMGManager* fRMGManager;
    static std::atomic<bool> fAbortRun;
 
    std::unique_ptr<G4RunManager> fG4RunManager = nullptr;
    std::unique_ptr<G4VisManager> fG4VisManager = nullptr;
 
    RMGExceptionHandler* fExceptionHandler = nullptr;
    G4VUserPhysicsList* fPhysicsList = nullptr;
    RMGHardware* fDetectorConstruction = nullptr;
 
    RMGUserAction* fUserAction = nullptr;
    // store partial custom actions to be used later in RMGUserAction
    std::shared_ptr<RMGUserInit> fUserInit;
 
    // messenger stuff
    std::unique_ptr<G4GenericMessenger> fMessenger;
    std::unique_ptr<G4GenericMessenger> fLogMessenger;
    std::unique_ptr<G4GenericMessenger> fRandMessenger;
    void DefineCommands();
};
 
#endif
 
// vim: tabstop=2 shiftwidth=2 expandtab