| 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 // G4ParticlesWorkspace
27 //
28 // Class description:
29 //
30 // Class managing the per-thread state of particles, those which
31 // have a per-thread state and dependent classes (if any).
32 // In particular, it owns the arrays that implement 'split' classes
33 // and classes/objects which are owned by the split classes.
34 // The classes/objects affected are
35 // - 'split' classes part of its state is per-thread,
36 // - per-thread objects, in particular those which are owned
37 // by the split classes.
38 // Goal: Take ownership and control of per-thread state of classes
39 // to work with multi-threading.
40
41 // Authors: J.Apostolakis & A.Dotti, 4 October 2013
42 // --------------------------------------------------------------------
43 #ifndef G4PARTICLESWORKSPACE_HH
44 #define G4PARTICLESWORKSPACE_HH
45
46 #include "G4ParticleDefinition.hh"
47 #include "G4TWorkspacePool.hh"
48
49 class G4ParticlesWorkspace
50 {
51 public:
52 using pool_type = G4TWorkspacePool<G4ParticlesWorkspace>;
53
54 G4ParticlesWorkspace(G4bool verbose = false);
55 ~G4ParticlesWorkspace() = default;
56
57 // Take ownership
58 void UseWorkspace();
59
60 // Release ownership
61 void ReleaseWorkspace();
62
63 // Release ownership and destroy
64 void DestroyWorkspace();
65
66 // To be called at start of each run (especially 2nd and further runs)
67 void InitialiseWorkspace();
68
69 void SetVerbose(G4bool v) { fVerbose = v; }
70 G4bool GetVerbose() { return fVerbose; }
71
72 static pool_type* GetPool();
73
74 protected: // Implementation methods
75 void InitialiseParticles();
76
77 private:
78 // Helper pointer - can be per instance or shared
79 G4PDefManager* fpPDefSIM = nullptr;
80
81 // Per Instance variables
82 // NOTE: the ownership of the Data Arrays is IN this object
83
84 // Store SubInstanceManager object pointers (SIM pointers)
85 G4PDefData* fpPDefOffset = nullptr;
86
87 G4bool fVerbose = false;
88 };
89
90 #endif
91