Geant4  10.03.p02
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
G4GeometryWorkspacePool.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 // $Id: G4GeometryWorkspacePool.hh 79096 2014-02-14 16:07:39Z gcosmo $
28 //
29 //
30 // ------------------------------------------------------------
31 // GEANT 4 class header file
32 //
33 // Class Description:
34 //
35 // Create and recycle Workspaces
36 // Only one object of this type exists; true Singleton (not per thread).
37 
38 // Author: John Apostolakis (CERN), December 2013
39 // ------------------------------------------------------------
40 
41 #ifndef G4GEOMETRYWORKSPACEPOOL_HH
42 #define G4GEOMETRYWORKSPACEPOOL_HH
43 
44 #include "G4Types.hh"
45 
47 
48 // Note: Investigate potential to make it a template - on the workspace type
49 
51 {
52  public:
53 
55 
57  // For use with simple MT mode
58  // Each thread gets a workspace and uses it until end
59 
60  void CreateAndUseWorkspace();
61  // Create it (as above) and use it
62 
64  // For use with 'dynamic' model of threading. Workspaces can be recycled.
65  // Reuse an existing workspace or create a new one if needed.
66  // This will never fail, except if system is out of resources
67 
68  inline G4GeometryWorkspace* GetWorkspace() { return fMyWorkspace; }
69  // Give back the existing, active workspace for my thread / task
70 
71  void Recycle( G4GeometryWorkspace * );
72  // Keep the unused Workspace for recycling
73 
75  // To be called once at the end of the job
76 
77  protected:
78 
80  // Destroy workspace after releasing it
81 
82  // void RegisterWarehouse( G4GeometryWarehouse *);
83  // The (optional) warehouse keeps a list of free workspaces
84 
85  private:
86 
89 
90  private:
91 
92  static G4GeometryWorkspacePool* thePool;
93 
94  // void* fWarehouse;
95  // G4GeometryWarehouse* fWarehouse;
96  // This is "void" to hide the actual container type for workspaces
97  // Implementations: a simple STL contaier for MT or something better
98  // for tbb.
99  // Further development: template parameter with portable default
100 
101  static G4ThreadLocal G4GeometryWorkspace* fMyWorkspace;
102  // The thread's workspace - if assigned.
103  // --> Can we do without this ? It is dirty!!
104 };
105 
106 #endif
G4GeometryWorkspace * GetWorkspace()
#define G4ThreadLocal
Definition: tls.hh:89
void ReleaseAndDestroyWorkspace(G4GeometryWorkspace *)
G4GeometryWorkspace * FindOrCreateWorkspace()
G4GeometryWorkspace * CreateWorkspace()
static G4GeometryWorkspacePool * GetInstance()
void Recycle(G4GeometryWorkspace *)