| 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 //
27 // Author: Jonathan Madsen (May 28st 2020)
28 //
29 // class description:
30 //
31 // This class is used for multi-threaded Geant4.
32 // The object of this class can be set to G4MTRunManager, but not to
33 // G4RunManager. G4UserTaskInitialization class has five virtual methods as
34 // the user hooks which are invoked at several occasions of the life cycle
35 // of each thread.
36 //
37 // - virtual void WorkerInitialize() const
38 // This method is called after the tread is created but before the
39 // G4WorkerTaskRunManager is instantiated.
40 // - virtual void WorkerStart() const
41 // This method is called once at the beginning of simulation job when
42 // kernel classes and user action classes have already instantiated but
43 // geometry and physics have not been yet initialized. This situation is
44 // identical to "PreInit" state in the sequential mode.
45 // - virtual void WorkerRunStart() const
46 // This method is called before an event loop. Geometry and physics have
47 // already been set up for the thread. All threads are synchronized and
48 // ready to start the local event loop. This situation is identical to
49 // "Idle" state in the sequential mode.
50 // - virtual void WorkerRunEnd() const
51 // This method is called for each thread when the local event loop is
52 // done, but before the synchronization over threads.
53 // - virtual void WorkerStop() const
54 // This method is called once at the end of simulation job.
55 //
56 // Note: This object should be instantiated only once and set to
57 // G4MTRunManager,
58 // while these five methods are invoked for each worker thread. Thus, to
59 // store thread-local objects, use G4ThreadLocal keyword.
60 //
61
62 #ifndef G4UserTaskInitialization_hh
63 #define G4UserTaskInitialization_hh
64
65 #include "G4UserWorkerInitialization.hh"
66
67 class G4UserTaskInitialization : public G4UserWorkerInitialization
68 {
69 public: // with description
70 G4UserTaskInitialization() = default;
71 ~G4UserTaskInitialization() override = default;
72
73 // This method is called after the tread is created but before the
74 // G4WorkerTaskRunManager is instantiated.
75 void WorkerInitialize() const override {}
76
77 // This method is called once at the beginning of simulation job
78 // when kernel classes and user action classes have already instantiated
79 // but geometry and physics have not been yet initialized. This situation
80 // is identical to "PreInit" state in the sequential mode.
81 void WorkerStart() const override {}
82
83 // This method is called before an event loop. Geometry and physics have
84 // already been set up for the thread. All threads are synchronized and
85 // ready to start the local event loop. This situation is identical to
86 // "Idle" state in the sequential mode.
87 void WorkerRunStart() const override {}
88
89 // This method is called for each thread, when the local event loop has
90 // finished but before the synchronization over threads.
91 void WorkerRunEnd() const override {}
92
93 // This method is called once at the end of simulation job.
94 // Implement here a clean up action.
95 void WorkerStop() const override {}
96 };
97
98 #endif // G4UserTaskInitialization_hh
99