Geant4  10.00.p03
G4UserWorkerInitialization.hh
Go to the documentation of this file.
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 // 25 Feb 2013: Andrea Dotti, first implementation
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 G4RunManager.
33 // G4UserWorkerInitialization class has five virtual methods as the user hooks
34 // which are invoked at several occasions of the life cycle of each thread.
35 //
36 // - virtual void WorkerInitialize() const
37 // This method is called after the tread is created but before the G4WorkerRunManager
38 // is instantiated.
39 // - virtual void WorkerStart() const
40 // This method is called once at the beginning of simulation job when kernel
41 // classes and user action classes have already instantiated but geometry and
42 // physics have not been yet initialized. This situation is identical to
43 // "PreInit" state in the sequential mode.
44 // - virtual void WorkerRunStart() const
45 // This method is called before an event loop. Geometry and physics have already
46 // been set up for the thread. All threads are synchronized and ready to start
47 // the local event loop. This situation is identical to "Idle" state in the sequential mode.
48 // - virtual void WorkerRunEnd() const
49 // This method is called for each thread when the local event loop is done, but
50 // before the synchronization over threads.
51 // - virtual void WorkerStop() const
52 // This method is called once at the end of simulation job.
53 //
54 // Note: This object should be instantiated only once and set to G4MTRunManager,
55 // while these five methods are invoked for each worker thread. Thus, to store
56 // thread-local objects, use G4ThreadLocal keyword.
57 //
58 
59 #ifndef G4UserWorkerInitialization_hh
60 #define G4UserWorkerInitialization_hh
61 
63 public: // with description
66 
67  virtual void WorkerInitialize() const;
68  // This method is called after the tread is created but before the
69  // G4WorkerRunManager is instantiated.
70 
71  virtual void WorkerStart() const;
72  // This method is called once at the beginning of simulation job
73  // when kernel classes and user action classes have already instantiated
74  // but geometry and physics have not been yet initialized. This situation
75  // is identical to "PreInit" state in the sequential mode.
76 
77  virtual void WorkerRunStart() const;
78  // This method is called before an event loop. Geometry and physics have
79  // already been set up for the thread. All threads are synchronized and
80  // ready to start the local event loop. This situation is identical to
81  // "Idle" state in the sequential mode.
82 
83  virtual void WorkerRunEnd() const;
84  // This method is called for each thread, when the local event loop has
85  // finished but before the synchronization over threads.
86 
87  virtual void WorkerStop() const;
88  // This method is called once at the end of simulation job.
89  // Implement here a clean up action.
90 
91 };
92 
93 #endif //G4UserWorkerInitialization_hh
94