Geant4 10.7.0
Toolkit for the simulation of the passage of particles through matter
Loading...
Searching...
No Matches
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
33// G4RunManager. G4UserWorkerInitialization class has five virtual methods
34// as the user hooks which are invoked at several occasions of the life
35// cycle of each thread.
36//
37// - virtual void WorkerInitialize() const
38// This method is called after the tread is created but before the
39// G4WorkerRunManager 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 G4UserWorkerInitialization_hh
63#define G4UserWorkerInitialization_hh
64
66{
67 public: // with description
70
71 virtual void WorkerInitialize() const;
72 // This method is called after the tread is created but before the
73 // G4WorkerRunManager is instantiated.
74
75 virtual void WorkerStart() const;
76 // This method is called once at the beginning of simulation job
77 // when kernel classes and user action classes have already instantiated
78 // but geometry and physics have not been yet initialized. This situation
79 // is identical to "PreInit" state in the sequential mode.
80
81 virtual void WorkerRunStart() const;
82 // This method is called before an event loop. Geometry and physics have
83 // already been set up for the thread. All threads are synchronized and
84 // ready to start the local event loop. This situation is identical to
85 // "Idle" state in the sequential mode.
86
87 virtual void WorkerRunEnd() const;
88 // This method is called for each thread, when the local event loop has
89 // finished but before the synchronization over threads.
90
91 virtual void WorkerStop() const;
92 // This method is called once at the end of simulation job.
93 // Implement here a clean up action.
94};
95
96#endif // G4UserWorkerInitialization_hh