| Geant4 Cross Reference |
1 //
2 // ********************************************************************
3 // * License and Disclaimer *
4 // * *
5 // * The Geant4 software is copyright of the Copyright Holders of *
6 // * the Geant4 Collaboration. It is provided under the terms and *
7 // * conditions of the Geant4 Software License, included in the file *
8 // * LICENSE and available at http://cern.ch/geant4/license . These *
9 // * include a list of copyright holders. *
10 // * *
11 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file LICENSE and URL above *
16 // * for the full disclaimer and the limitation of liability. *
17 // * *
18 // * This code implementation is the result of the scientific and *
19 // * technical work of the GEANT4 collaboration. *
20 // * By using, copying, modifying or distributing the software (or *
21 // * any work based on the software) you agree to acknowledge its *
22 // * use in resulting scientific publications, and indicate your *
23 // * acceptance of all terms of the Geant4 Software license. *
24 // ********************************************************************
25 //
26 // G4WorkerRunManager
27 //
28 // Class description:
29 //
30 // This is a class for run control in GEANT4 for multi-threading.
31 // It extends G4RunManager re-implementing multi-threaded behavior in
32 // key methods. See documentation for G4RunManager.
33 // User should never initialize instances of this class, that are usually
34 // handled by G4MTRunManager. There exists one instance of this class for
35 // each worker in a MT application.
36
37 // Original authors: X.Dong, A.Dotti - 2013
38 // --------------------------------------------------------------------
39 #ifndef G4WorkerRunManager_hh
40 #define G4WorkerRunManager_hh 1
41
42 #include "G4RNGHelper.hh"
43 #include "G4RunManager.hh"
44
45 class G4WorkerThread;
46 class G4WorkerRunManagerKernel;
47
48 class G4WorkerRunManager : public G4RunManager
49 {
50 public:
51 static G4WorkerRunManager* GetWorkerRunManager();
52 static G4WorkerRunManagerKernel* GetWorkerRunManagerKernel();
53
54 G4WorkerRunManager();
55 ~G4WorkerRunManager() override;
56
57 void InitializeGeometry() override;
58 void RunInitialization() override;
59 void DoEventLoop(G4int n_event, const char* macroFile = nullptr, G4int n_select = -1) override;
60 void ProcessOneEvent(G4int i_event) override;
61 G4Event* GenerateEvent(G4int i_event) override;
62
63 void RunTermination() override;
64 void TerminateEventLoop() override;
65
66 // This function is called by the thread function: it should
67 // loop until some work is requested.
68 virtual void DoWork();
69
70 // Sets the worker context.
71 inline void SetWorkerThread(G4WorkerThread* wc) { workerContext = wc; }
72
73 void SetUserInitialization(G4VUserPhysicsList* userInit) override;
74 void SetUserInitialization(G4VUserDetectorConstruction* userInit) override;
75 void SetUserInitialization(G4VUserActionInitialization* userInit) override;
76 void SetUserInitialization(G4UserWorkerInitialization* userInit) override;
77 void SetUserInitialization(G4UserWorkerThreadInitialization* userInit) override;
78 void SetUserAction(G4UserRunAction* userAction) override;
79 void SetUserAction(G4VUserPrimaryGeneratorAction* userAction) override;
80 void SetUserAction(G4UserEventAction* userAction) override;
81 void SetUserAction(G4UserStackingAction* userAction) override;
82 void SetUserAction(G4UserTrackingAction* userAction) override;
83 void SetUserAction(G4UserSteppingAction* userAction) override;
84
85 void RestoreRndmEachEvent(G4bool flag) override { readStatusFromFile = flag; }
86
87 protected:
88 void ConstructScoringWorlds() override;
89 void StoreRNGStatus(const G4String& filenamePrefix) override;
90 void rndmSaveThisRun() override;
91 void rndmSaveThisEvent() override;
92
93 // This method will merge (reduce) the results
94 // of this run into the global run
95 virtual void MergePartialResults(G4bool mergeEvents = true);
96
97 protected:
98 G4WorkerThread* workerContext = nullptr;
99 #ifdef G4MULTITHREADED
100 G4bool visIsSetUp = false;
101 #endif
102
103 G4bool eventLoopOnGoing = false;
104 G4bool runIsSeeded = false;
105 G4int nevModulo = -1;
106 G4int currEvID = -1;
107 G4int luxury = -1;
108 G4SeedsQueue seedsQueue;
109 G4bool readStatusFromFile = false;
110
111 protected:
112 virtual void SetupDefaultRNGEngine();
113 };
114
115 #endif // G4WorkerRunManager_hh
116