| Geant4 Cross Reference |
1 // 1 //
2 // ******************************************* 2 // ********************************************************************
3 // * License and Disclaimer 3 // * License and Disclaimer *
4 // * 4 // * *
5 // * The Geant4 software is copyright of th 5 // * The Geant4 software is copyright of the Copyright Holders of *
6 // * the Geant4 Collaboration. It is provided 6 // * the Geant4 Collaboration. It is provided under the terms and *
7 // * conditions of the Geant4 Software License 7 // * conditions of the Geant4 Software License, included in the file *
8 // * LICENSE and available at http://cern.ch/ 8 // * LICENSE and available at http://cern.ch/geant4/license . These *
9 // * include a list of copyright holders. 9 // * include a list of copyright holders. *
10 // * 10 // * *
11 // * Neither the authors of this software syst 11 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing fin 12 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warran 13 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assum 14 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file 15 // * use. Please see the license in the file LICENSE and URL above *
16 // * for the full disclaimer and the limitatio 16 // * for the full disclaimer and the limitation of liability. *
17 // * 17 // * *
18 // * This code implementation is the result 18 // * This code implementation is the result of the scientific and *
19 // * technical work of the GEANT4 collaboratio 19 // * technical work of the GEANT4 collaboration. *
20 // * By using, copying, modifying or distri 20 // * By using, copying, modifying or distributing the software (or *
21 // * any work based on the software) you ag 21 // * any work based on the software) you agree to acknowledge its *
22 // * use in resulting scientific publicati 22 // * use in resulting scientific publications, and indicate your *
23 // * acceptance of all terms of the Geant4 Sof 23 // * acceptance of all terms of the Geant4 Software license. *
24 // ******************************************* 24 // ********************************************************************
25 // 25 //
26 // Author: Jonathan Madsen (May 28st 2020) 26 // Author: Jonathan Madsen (May 28st 2020)
27 // 27 //
28 // class description: 28 // class description:
29 // 29 //
30 // This class is used for multi-threaded 30 // This class is used for multi-threaded Geant4.
31 // It encapsulates the mechanism of start 31 // It encapsulates the mechanism of starting/stopping threads.
32 32
33 #ifndef G4UserTaskThreadInitialization_hh 33 #ifndef G4UserTaskThreadInitialization_hh
34 #define G4UserTaskThreadInitialization_hh 34 #define G4UserTaskThreadInitialization_hh
35 35
36 //class G4VUserPrimaryGeneratorAction; << 36 class G4VUserPrimaryGeneratorAction;
37 //class G4UserRunAction; << 37 class G4UserRunAction;
38 //class G4UserEventAction; << 38 class G4UserEventAction;
39 //class G4UserStackingAction; << 39 class G4UserStackingAction;
40 //class G4UserTrackingAction; << 40 class G4UserTrackingAction;
41 //class G4UserSteppingAction; << 41 class G4UserSteppingAction;
42 42
43 class G4WorkerThread; 43 class G4WorkerThread;
44 class G4WorkerTaskRunManager; 44 class G4WorkerTaskRunManager;
45 45
46 #include "G4Threading.hh" 46 #include "G4Threading.hh"
47 #include "G4UserWorkerThreadInitialization.hh" 47 #include "G4UserWorkerThreadInitialization.hh"
48 #include "Randomize.hh" 48 #include "Randomize.hh"
49 49
50 class G4UserTaskThreadInitialization : public 50 class G4UserTaskThreadInitialization : public G4UserWorkerThreadInitialization
51 { 51 {
52 public: // with description 52 public: // with description
53 G4UserTaskThreadInitialization() = default 53 G4UserTaskThreadInitialization() = default;
54 ~G4UserTaskThreadInitialization() override 54 ~G4UserTaskThreadInitialization() override = default;
55 55
56 // Called by the kernel to create a new t 56 // Called by the kernel to create a new thread/worker
57 // and start work. 57 // and start work.
58 // Usere should not re-implement this func 58 // Usere should not re-implement this function (in derived class), except only
59 // if he/she wants to verwrite the default 59 // if he/she wants to verwrite the default threading model (see StartThread
60 // function) 60 // function)
61 G4Thread* CreateAndStartWorker(G4WorkerThr 61 G4Thread* CreateAndStartWorker(G4WorkerThread* workerThreadContext) override;
62 62
63 // Called by worker threads to set the Ran 63 // Called by worker threads to set the Random Number Generator Engine
64 // The default implementation "clones" the 64 // The default implementation "clones" the engine from the master thread
65 // User needs to re-implement this method 65 // User needs to re-implement this method if using a non-standard
66 // RNG Engine (i.e. a different one w.r.t. 66 // RNG Engine (i.e. a different one w.r.t. the one provided in the CLHEP
67 // version supported by G4. 67 // version supported by G4.
68 // Important: this method is called by all 68 // Important: this method is called by all threads at the same time
69 // if is user responsibilitiy to make it 69 // if is user responsibilitiy to make it thread-safe
70 void SetupRNGEngine(const CLHEP::HepRandom 70 void SetupRNGEngine(const CLHEP::HepRandomEngine* aRNGEngine) const override;
71 71
72 // Called by the kernel when threads need 72 // Called by the kernel when threads need to be terminated. Implements logic
73 // of joining the aThread. Calling thread 73 // of joining the aThread. Calling thread will wait for aThread to end. Usere
74 // should not re-implement this function ( 74 // should not re-implement this function (in derived class), except only if
75 // he/she wants to verwrite the default th 75 // he/she wants to verwrite the default threading model (see StartThread
76 // function) 76 // function)
77 void JoinWorker(G4Thread* aThread) overrid 77 void JoinWorker(G4Thread* aThread) override;
78 78
79 // Called by StartThread function to creat 79 // Called by StartThread function to create a run-manager implementing worker
80 // behvior. User should re-implemtn this f 80 // behvior. User should re-implemtn this function in derived class to
81 // instantiate his/her user-defined Worker 81 // instantiate his/her user-defined WorkerRunManager. By default this method
82 // instantiates G4WorkerTaskRunManager obj 82 // instantiates G4WorkerTaskRunManager object.
83 G4WorkerRunManager* CreateWorkerRunManager 83 G4WorkerRunManager* CreateWorkerRunManager() const override;
84 }; 84 };
85 85
86 #endif // G4UserTaskThreadInitialization_hh 86 #endif // G4UserTaskThreadInitialization_hh
87 87