Import Geant4 11.0.0.beta source tree

This commit is contained in:
Gabriele Cosmo
2021-06-25 16:12:29 +02:00
parent c968e26a39
commit 6399a014b6
4200 changed files with 207479 additions and 237366 deletions
+229 -231
View File
@@ -23,24 +23,29 @@
// * acceptance of all terms of the Geant4 Software license. *
// ********************************************************************
//
// G4MTRunManager
//
// class description:
// This is a class for run control in GEANT4 for multi-threaded runs
// It extends G4RunManager re-implementing multi-threaded behavior in
// key methods. See documentation for G4RunManager
// Users initializes an instance of this class instead of G4RunManager
// to start a multi-threaded simulation.
// Class description:
//
// This is a class for run control in Geant4 of multi-threaded runs.
// It extends G4RunManager re-implementing multi-threaded behavior in
// key methods (see documentation for G4RunManager).
// Users initialise an instance of this class instead of G4RunManager
// to start a multi-threaded simulation.
#ifndef G4MTRunManager_h
#define G4MTRunManager_h 1
// Original authors: X.Dong, A.Dotti - February 2013
// --------------------------------------------------------------------
#ifndef G4MTRunManager_hh
#define G4MTRunManager_hh 1
#include <list>
#include <map>
#include "G4MTBarrier.hh"
#include "G4RNGHelper.hh"
#include "G4RunManager.hh"
#include "G4Threading.hh"
#include "G4Profiler.hh"
#include <list>
#include <map>
class G4MTRunManagerKernel;
class G4ScoringManager;
@@ -54,246 +59,239 @@ class G4MTRunManager : public G4RunManager
{
friend class G4RunManagerFactory;
public:
// the profiler aliases are only used when compiled with GEANT4_USE_TIMEMORY
using ProfilerConfig = G4ProfilerConfig<G4ProfileType::Run>;
public:
public:
G4MTRunManager();
virtual ~G4MTRunManager();
// New method
virtual void SetNumberOfThreads(G4int n);
virtual G4int GetNumberOfThreads() const { return nworkers; }
void SetPinAffinity(G4int n = 1);
G4int GetPinAffinity() const { return pinAffinity; }
using ProfilerConfig = G4ProfilerConfig<G4ProfileType::Run>;
// The profiler aliases are only used when compiled with
// GEANT4_USE_TIMEMORY.
public:
// Inherited methods to re-implement for MT case
virtual void Initialize();
virtual void InitializeEventLoop(G4int n_event, const char* macroFile = 0,
G4int n_select = -1);
virtual void InitializeThreadPool() {}
using masterWorlds_t = std::map<G4int, G4VPhysicalVolume*>;
// Map of defined worlds.
// The following do not do anything for this runmanager
virtual void TerminateOneEvent();
virtual void ProcessOneEvent(G4int i_event);
////virtual void TerminateEventLoop();
virtual void ConstructScoringWorlds();
virtual void RunTermination();
G4MTRunManager();
virtual ~G4MTRunManager();
// The following method should be invoked by G4WorkerRunManager for each
// event. False is returned if no more event to be processed. Note: G4Event
// object must be instantiated by a worker thread. In case no more
// event remains to be processed, that worker thread must delete that G4Event
// object. If a worker runs with its own random number sequence, the boolean
// flag reseedRequired should be set to false. This is *NOT* allowed for the
// first event.
virtual G4bool SetUpAnEvent(G4Event*, long& s1, long& s2, long& s3,
G4bool reseedRequired = true);
// Same as above method, but the seeds are set only once over "eventModulo"
// events. The return value shows the number of events the caller Worker has
// to process (between 1 and eventModulo depending on number of events yet to
// be processed). G4Event object has the event ID of the first event of this
// bunch. If zero is returned no more event needs to be processed, and worker
// thread must delete that G4Event.
virtual G4int SetUpNEvents(G4Event*, G4SeedsQueue* seedsQueue,
G4bool reseedRequired = true);
virtual void SetNumberOfThreads(G4int n);
virtual G4int GetNumberOfThreads() const { return nworkers; }
void SetPinAffinity(G4int n = 1);
inline G4int GetPinAffinity() const { return pinAffinity; }
// Method called by Initialize() method
protected:
// Initialize the seeds list, if derived class does not implement this method
// A default generation will be used (nevents*2 random seeds)
// Return true if initialization is done.
virtual G4bool InitializeSeeds(G4int /*nevts*/) { return false; };
// Adds one seed to the list of seeds
virtual void PrepareCommandsStack();
virtual void StoreRNGStatus(const G4String& filenamePrefix);
virtual void rndmSaveThisRun();
virtual void rndmSaveThisEvent();
virtual void CreateAndStartWorkers();
// Creates worker threads and signal to start
public:
std::vector<G4String> GetCommandStack();
// This method is invoked just before spawning the threads to
// collect from UI managere the list of commands that threads
// will execute.
virtual size_t GetNumberActiveThreads() const { return threads.size(); }
// Returns number of currently active threads.
// This number may be different from the number of threads currently
// in running state (e.g. the number returned by:
// G4Threading::GetNumberOfActiveWorkerThreads() method).
static G4ThreadId GetMasterThreadId();
// Inherited methods to re-implement for MT case
virtual void Initialize();
virtual void InitializeEventLoop(G4int n_event, const char* macroFile = 0,
G4int n_select = -1);
virtual void InitializeThreadPool() {}
protected:
// Number of worker threads. To be set by SetNumberOfThreads() method.
G4int nworkers;
// Force to use this number regardless of SetNumberOfThreads() method.
G4int forcedNwokers;
// The following do not do anything for this runmanager
virtual void TerminateOneEvent();
virtual void ProcessOneEvent(G4int i_event);
virtual void ConstructScoringWorlds();
virtual void RunTermination();
private:
// Pin Affinity parameter
G4int pinAffinity;
// List of workers (i.e. thread)
typedef std::list<G4Thread*> G4ThreadsList;
G4ThreadsList threads;
// List of workers run managers
// List of all workers run managers
std::vector<G4String> uiCmdsForWorkers;
// List of UI commands for workers.
CLHEP::HepRandomEngine* masterRNGEngine;
// Pointer to the mastet thread random engine
protected:
virtual void WaitForReadyWorkers();
// Master thread barrier:
// Call this function to block master thread and
// wait workers to be ready to process work.
// This function will return only when all
// workers are ready to perform event loop.
virtual void WaitForEndEventLoopWorkers();
// Master thread barrier:
// Call this function to block master thread and
// wait workers have finished current event loop.
// This function will return only when all
// workers have finished processing events for this run.
protected:
G4int numberOfEventToBeProcessed;
virtual void TerminateWorkers();
// Empty the workersList
virtual G4bool SetUpAnEvent(G4Event*, long& s1, long& s2, long& s3,
G4bool reseedRequired = true);
// The following method should be invoked by G4WorkerRunManager for each
// event. False is returned if no more event to be processed.
// Note: G4Event object must be instantiated by a worker thread.
// In case no more events remain to be processed, that worker thread must
// delete that G4Event object. If a worker runs with its own random number
// sequence, the Boolean flag 'reseedRequired' should be set to false.
// This is *NOT* allowed for the first event.
public:
virtual void ThisWorkerReady();
// Worker threads barrier:
// This method should be called by each
// worker when ready to start thread event-loop
// This method will return only when all workers
// are ready.
// static void ThisWorkerFinishWork();
// Worker threads barrier:
// This static method should be called by each
// worker when finish to process events
virtual void ThisWorkerEndEventLoop();
// Worker threads barrier:
// This method should be called by each
// worker when worker event loop is terminated.
typedef std::map<G4int, G4VPhysicalVolume*> masterWorlds_t;
static G4ScoringManager* GetMasterScoringManager();
static masterWorlds_t& GetMasterWorlds();
static void addWorld(G4int counter, G4VPhysicalVolume* w);
virtual G4int SetUpNEvents(G4Event*, G4SeedsQueue* seedsQueue,
G4bool reseedRequired = true);
// Same as above method, but seeds are set only once over "eventModulo"
// events. The return value shows the number of events the caller Worker
// has to process (between 1 and eventModulo depending on number of events
// yet to be processed). G4Event object has the event ID of the first
// event of this bunch. If zero is returned no more events need to be
// processed, and worker thread must delete that G4Event.
// Called by Initialize() method.
const CLHEP::HepRandomEngine* getMasterRandomEngine() const
{
return masterRNGEngine;
}
std::vector<G4String> GetCommandStack();
// This method is invoked just before spawning the threads to
// collect from UI manager the list of commands that threads
// will execute.
protected:
// Handling of master thread scoring worlds, access to it is needed by workers
G4MTRUN_DLL static G4ScoringManager* masterScM;
G4MTRUN_DLL static masterWorlds_t masterWorlds;
// Singleton implementing master thread behavior
G4MTRUN_DLL static G4MTRunManager* fMasterRM;
virtual size_t GetNumberActiveThreads() const { return threads.size(); }
// Returns number of currently active threads.
// This number may be different from the number of threads currently
// in running state, e.g. the number returned by:
// G4Threading::GetNumberOfActiveWorkerThreads() method.
private:
G4MTRunManagerKernel* MTkernel;
static G4ThreadId GetMasterThreadId();
public: // with description
static G4MTRunManager* GetMasterRunManager();
// Returns the singleton instance of the run manager common to all threads
// implementing the master behavior
static G4RunManagerKernel* GetMasterRunManagerKernel();
static G4MTRunManagerKernel* GetMTMasterRunManagerKernel();
// Returns the singleton instance of the run manager kernel common to all
// threads
virtual void ThisWorkerReady();
// Worker threads barrier: this method should be called by each
// worker when ready to start thread event-loop.
// This method will return only when all workers are ready.
virtual void SetUserInitialization(G4VUserPhysicsList* userPL);
virtual void SetUserInitialization(G4VUserDetectorConstruction* userDC);
virtual void SetUserInitialization(G4UserWorkerInitialization* userInit);
virtual void SetUserInitialization(
G4UserWorkerThreadInitialization* userInit);
virtual void SetUserInitialization(G4VUserActionInitialization* userInit);
virtual void SetUserAction(G4UserRunAction* userAction);
virtual void SetUserAction(G4VUserPrimaryGeneratorAction* userAction);
virtual void SetUserAction(G4UserEventAction* userAction);
virtual void SetUserAction(G4UserStackingAction* userAction);
virtual void SetUserAction(G4UserTrackingAction* userAction);
virtual void SetUserAction(G4UserSteppingAction* userAction);
virtual void ThisWorkerEndEventLoop();
// Worker threads barrier: this method should be called by each
// worker when worker event loop is terminated.
public:
// To be invoked solely from G4WorkerRunManager to merge the results
void MergeScores(const G4ScoringManager* localScoringManager);
void MergeRun(const G4Run* localRun);
static G4ScoringManager* GetMasterScoringManager();
static masterWorlds_t& GetMasterWorlds();
static void addWorld(G4int counter, G4VPhysicalVolume* w);
public:
// Handling of more than one run per thread
enum class WorkerActionRequest
{
UNDEFINED,
NEXTITERATION, // There is another set of UI commands to be executed
PROCESSUI, // Process UI commands w/o a /run/beamOn
ENDWORKER // Terminate thread, work finished
};
virtual void RequestWorkersProcessCommandsStack();
// Called to force workers to request and process the UI commands stack
// This will block untill all workers have processed UI commands
virtual void ThisWorkerProcessCommandsStackDone();
// Called by workers to signal to master it has completed processing of
// UI commands
virtual WorkerActionRequest ThisWorkerWaitForNextAction();
// Worker thread barrier
// This method should be used by workers' run manager to wait,
// after an event loop for the next action to be performed
// (for example execute a new run)
// This returns the action to be performed
protected:
WorkerActionRequest nextActionRequest;
virtual void NewActionRequest(WorkerActionRequest newRequest);
inline const CLHEP::HepRandomEngine* getMasterRandomEngine() const
{
return masterRNGEngine;
}
protected:
G4int eventModuloDef;
G4int eventModulo;
G4int nSeedsUsed;
G4int nSeedsFilled;
G4int nSeedsMax;
G4int nSeedsPerEvent;
double* randDbl;
static G4MTRunManager* GetMasterRunManager();
// Returns the singleton instance of the run manager common to all
// threads implementing the master behavior
static G4RunManagerKernel* GetMasterRunManagerKernel();
static G4MTRunManagerKernel* GetMTMasterRunManagerKernel();
// Returns the singleton instance of the run manager kernel common to all
//threads
virtual void RefillSeeds();
virtual void SetUserInitialization(G4VUserPhysicsList* userPL);
virtual void SetUserInitialization(G4VUserDetectorConstruction* userDC);
virtual void SetUserInitialization(G4UserWorkerInitialization* userInit);
virtual void SetUserInitialization(G4UserWorkerThreadInitialization* userInit);
virtual void SetUserInitialization(G4VUserActionInitialization* userInit);
virtual void SetUserAction(G4UserRunAction* userAction);
virtual void SetUserAction(G4VUserPrimaryGeneratorAction* userAction);
virtual void SetUserAction(G4UserEventAction* userAction);
virtual void SetUserAction(G4UserStackingAction* userAction);
virtual void SetUserAction(G4UserTrackingAction* userAction);
virtual void SetUserAction(G4UserSteppingAction* userAction);
public:
inline void SetEventModulo(G4int i = 1) { eventModuloDef = i; }
inline G4int GetEventModulo() const { return eventModuloDef; }
// To be invoked solely from G4WorkerRunManager to merge the results
void MergeScores(const G4ScoringManager* localScoringManager);
void MergeRun(const G4Run* localRun);
public:
virtual void AbortRun(G4bool softAbort = false);
virtual void AbortEvent();
// Handling of more than one run per thread
enum class WorkerActionRequest
{
UNDEFINED,
NEXTITERATION, // There is another set of UI commands to be executed
PROCESSUI, // Process UI commands w/o a /run/beamOn
ENDWORKER // Terminate thread, work finished
};
protected:
static G4ThreadId masterThreadId;
static G4int seedOncePerCommunication;
// - If it is set to 0 (default), seeds that are centrally managed
// by G4MTRunManager are set for every event of every worker thread.
// This option guarantees event reproducability regardless of number
// of threads.
// - If it is set to 1, seeds are set only once for the first
// event of each run of each worker thread. Event reproducability is
// guaranteed only if the same number of worker threads are used.
// On the other hand, this option offers better computing performance
// in particular for applications with relatively small primary
// particle energy and large number of events.
// - If it is set to 2, seeds are set only for the first event of
// group of N events. This option is reserved for the future use when
// Geant4 allows number of threads to be dynatically changed during an
// event loop.
public:
static G4int SeedOncePerCommunication();
static void SetSeedOncePerCommunication(G4int val);
static G4ThreadId GetMasterTheadId();
protected:
// Barriers: synch points between master and workers
G4MTBarrier beginOfEventLoopBarrier;
G4MTBarrier endOfEventLoopBarrier;
G4MTBarrier nextActionRequestBarrier;
G4MTBarrier processUIBarrier;
virtual void RequestWorkersProcessCommandsStack();
// Called to force workers to request and process the UI commands stack
// This will block untill all workers have processed UI commands
virtual void ThisWorkerProcessCommandsStackDone();
// Called by workers to signal to master it has completed processing of
// UI commands
virtual WorkerActionRequest ThisWorkerWaitForNextAction();
// Worker thread barrier: this method should be used by workers' run
// manager to wait, after an event loop for the next action to be
// performed (for example execute a new run).
// This returns the action to be performed.
inline void SetEventModulo(G4int i = 1) { eventModuloDef = i; }
inline G4int GetEventModulo() const { return eventModuloDef; }
virtual void AbortRun(G4bool softAbort = false);
virtual void AbortEvent();
static G4int SeedOncePerCommunication();
static void SetSeedOncePerCommunication(G4int val);
static G4ThreadId GetMasterTheadId();
protected:
virtual G4bool InitializeSeeds(G4int /*nevts*/) { return false; };
// Initialize the seeds list, if derived class does not implement this
// method, a default generation will be used (nevents*2 random seeds).
// Return true if initialization is done.
// Adds one seed to the list of seeds.
virtual void PrepareCommandsStack();
virtual void StoreRNGStatus(const G4String& filenamePrefix);
virtual void rndmSaveThisRun();
virtual void rndmSaveThisEvent();
virtual void CreateAndStartWorkers();
// Creates worker threads and signal to start
virtual void WaitForReadyWorkers();
// Master thread barrier: call this function to block master thread and
// wait workers to be ready to process work. This function will return
// only when all workers are ready to perform event loop.
virtual void WaitForEndEventLoopWorkers();
// Master thread barrier: call this function to block master thread and
// wait workers have finished current event loop. This function will
// return only when all workers have finished processing events for
// this run.
virtual void TerminateWorkers();
// Empty the workersList.
virtual void NewActionRequest(WorkerActionRequest newRequest);
virtual void RefillSeeds();
protected:
G4int nworkers = 2;
// Number of worker threads. To be set by SetNumberOfThreads() method.
G4int forcedNwokers = -1;
// Force to use this number regardless of SetNumberOfThreads() method.
G4int numberOfEventToBeProcessed = 0;
G4MTRUN_DLL static G4ScoringManager* masterScM;
// Handling of master thread scoring worlds, access is needed by workers
G4MTRUN_DLL static masterWorlds_t masterWorlds;
G4MTRUN_DLL static G4MTRunManager* fMasterRM;
// Singleton implementing master thread behavior
WorkerActionRequest nextActionRequest = WorkerActionRequest::UNDEFINED;
G4int eventModuloDef = 0;
G4int eventModulo = 1;
G4int nSeedsUsed = 0;
G4int nSeedsFilled = 0;
G4int nSeedsMax = 10000;
G4int nSeedsPerEvent = 2;
G4double* randDbl = nullptr;
static G4ThreadId masterThreadId;
static G4int seedOncePerCommunication;
// - If it is set to 0 (default), seeds that are centrally managed
// by G4MTRunManager are set for every event of every worker thread.
// This option guarantees event reproducibility regardless of number
// of threads.
// - If it is set to 1, seeds are set only once for the first
// event of each run of each worker thread. Event reproducibility is
// guaranteed only if the same number of worker threads are used.
// On the other hand, this option offers better computing performance
// in particular for applications with relatively small primary
// particle energy and large number of events.
// - If it is set to 2, seeds are set only for the first event of
// group of N events. This option is reserved for the future use when
// Geant4 will allow number of threads to be dynamically changed during
// an event loop.
// Barriers: synch points between master and workers
G4MTBarrier beginOfEventLoopBarrier;
G4MTBarrier endOfEventLoopBarrier;
G4MTBarrier nextActionRequestBarrier;
G4MTBarrier processUIBarrier;
private:
using G4ThreadsList = std::list<G4Thread*>;
// List of workers (i.e. thread)
G4int pinAffinity = 0;
// Pin Affinity parameter
G4ThreadsList threads;
// List of workers run managers
// List of all workers run managers
std::vector<G4String> uiCmdsForWorkers;
// List of UI commands for workers.
CLHEP::HepRandomEngine* masterRNGEngine = nullptr;
// Pointer to the mastet thread random engine
G4MTRunManagerKernel* MTkernel = nullptr;
};
#endif // G4MTRunManager_h
#endif // G4MTRunManager_hh