| 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 // Author: Jonathan Madsen (May 28st 2020)
27 //
28 // class description:
29 //
30 // This is a class for mandatory control of GEANT4 kernel.
31 // This class implements Worker behavior in a MT application.
32 //
33 // This class is constructed by G4TaskRunManager. If a user uses his/her own
34 // class instead of G4TaskRunManager, this class must be instantiated by
35 // him/herself at the very beginning of the application and must be deleted
36 // at the very end of the application. Also, following methods must be
37 // invoked in the proper order.
38 // DefineWorldVolume
39 // InitializePhysics
40 // RunInitialization
41 // RunTermination
42 //
43 // User must provide his/her own classes derived from the following
44 // abstract class and register it to the RunManagerKernel.
45 // G4VUserPhysicsList - Particle types, Processes and Cuts
46 //
47 // G4TaskRunManagerKernel does not have any eveny loop. Handling of events
48 // is managed by G4RunManager.
49 //
50 // This class re-implements only the method that require special treatment
51 // to implement worker behavior
52
53 #ifndef G4TaskRunManagerKernel_hh
54 #define G4TaskRunManagerKernel_hh 1
55
56 #include "G4RunManagerKernel.hh"
57 #include "G4TaskRunManager.hh"
58 #include "G4Threading.hh"
59
60 #include "rundefs.hh"
61
62 #include <vector>
63
64 class G4WorkerThread;
65 class G4WorkerTaskRunManager;
66
67 class G4TaskRunManagerKernel : public G4RunManagerKernel
68 {
69 public:
70 G4TaskRunManagerKernel();
71 ~G4TaskRunManagerKernel() override = default;
72
73 public: // with descroption
74 static G4WorkerThread* GetWorkerThread();
75 // G4ThreadPool tasks
76 static void InitializeWorker();
77 static void ExecuteWorkerInit();
78 static void ExecuteWorkerTask();
79 static void TerminateWorkerRunEventLoop();
80 static void TerminateWorker();
81 static void TerminateWorkerRunEventLoop(G4WorkerTaskRunManager*);
82
83 static std::vector<G4String>& InitCommandStack();
84
85 // Fill decay tables with particle definition pointers of
86 // decay products. This method has to be invoked by
87 // MTRunManager before event loop starts on workers.
88 void SetUpDecayChannels();
89
90 // This method should be invoked by G4TaskRunManager
91 void BroadcastAbortRun(G4bool softAbort);
92
93 protected:
94 void SetupShadowProcess() const override;
95 G4RUN_DLL static std::vector<G4String> initCmdStack;
96 };
97
98 #endif // G4TaskRunManagerKernel_hh
99