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