| 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 // G4UserWorkerThreadInitialization
27 //
28 // Class description:
29 //
30 // This class is used for multi-threading.
31 // It encapsulates the mechanism of starting/stopping threads.
32
33 // Author: M.Asai, A.Dotti (SLAC), 16 September 2013
34 // --------------------------------------------------------------------
35 #ifndef G4UserWorkerThreadInitialization_hh
36 #define G4UserWorkerThreadInitialization_hh 1
37
38 //class G4VUserPrimaryGeneratorAction;
39 //class G4UserRunAction;
40 //class G4UserEventAction;
41 //class G4UserStackingAction;
42 //class G4UserTrackingAction;
43 //class G4UserSteppingAction;
44 class G4WorkerThread;
45 class G4WorkerRunManager;
46
47 #include "G4Threading.hh"
48 #include "Randomize.hh"
49
50 class G4UserWorkerThreadInitialization
51 {
52 public:
53 G4UserWorkerThreadInitialization() = default;
54 virtual ~G4UserWorkerThreadInitialization() = default;
55
56 // Called by the kernel to create a new thread/worker and start work.
57 // User should not re-implement this function (in derived class), except
58 // only if he/she wants to rewrite the default threading model (see
59 // StartThread() function).
60 virtual G4Thread* CreateAndStartWorker(G4WorkerThread* workerThreadContext);
61
62 // Called by worker threads to set the Random Number Generator Engine.
63 // The default implementation "clones" the engine from the master thread
64 // User needs to re-implement this method if using a non-standard
65 // RNG Engine (i.e. a different one w.r.t. the one provided in the CLHEP
66 // version supported by Geant4).
67 // Important: this method is called by all threads at the same time;
68 // it is user responsibilitiy to make it thread-safe.
69 virtual void SetupRNGEngine(const CLHEP::HepRandomEngine* aRNGEngine) const;
70
71 // Called by the kernel when threads need to be terminated. Implements
72 // logic of joining the "aThread". Calling thread will wait for "aThread"
73 // to end. Users should not re-implement this function (in derived class),
74 // except only if he/she wants to rewrite the default threading model (see
75 // StartThread() function).
76 virtual void JoinWorker(G4Thread* aThread);
77
78 // Called by StartThread() function to create a run-manager implementing
79 // worker behvior. User should re-implement this function in a derived
80 // class to instantiate his/her user-defined WorkerRunManager.
81 // By default this method instantiates a G4WorkerRunManager object.
82 virtual G4WorkerRunManager* CreateWorkerRunManager() const;
83 };
84
85 #endif
86