| Geant4 Cross Reference |
1 // 1 //
2 // ******************************************* 2 // ********************************************************************
3 // * License and Disclaimer 3 // * License and Disclaimer *
4 // * 4 // * *
5 // * The Geant4 software is copyright of th 5 // * The Geant4 software is copyright of the Copyright Holders of *
6 // * the Geant4 Collaboration. It is provided 6 // * the Geant4 Collaboration. It is provided under the terms and *
7 // * conditions of the Geant4 Software License 7 // * conditions of the Geant4 Software License, included in the file *
8 // * LICENSE and available at http://cern.ch/ 8 // * LICENSE and available at http://cern.ch/geant4/license . These *
9 // * include a list of copyright holders. 9 // * include a list of copyright holders. *
10 // * 10 // * *
11 // * Neither the authors of this software syst 11 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing fin 12 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warran 13 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assum 14 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file 15 // * use. Please see the license in the file LICENSE and URL above *
16 // * for the full disclaimer and the limitatio 16 // * for the full disclaimer and the limitation of liability. *
17 // * 17 // * *
18 // * This code implementation is the result 18 // * This code implementation is the result of the scientific and *
19 // * technical work of the GEANT4 collaboratio 19 // * technical work of the GEANT4 collaboration. *
20 // * By using, copying, modifying or distri 20 // * By using, copying, modifying or distributing the software (or *
21 // * any work based on the software) you ag 21 // * any work based on the software) you agree to acknowledge its *
22 // * use in resulting scientific publicati 22 // * use in resulting scientific publications, and indicate your *
23 // * acceptance of all terms of the Geant4 Sof 23 // * acceptance of all terms of the Geant4 Software license. *
24 // ******************************************* 24 // ********************************************************************
25 // 25 //
26 // 26 //
>> 27 // $Id: G4GlobalFastSimulationManager.hh 68056 2013-03-13 14:44:48Z gcosmo $
27 // 28 //
28 // << 29 //
29 //-------------------------------------------- 30 //---------------------------------------------------------------
30 // 31 //
31 // G4GlobalFastSimulationManager.hh 32 // G4GlobalFastSimulationManager.hh
32 // 33 //
33 // Description: 34 // Description:
34 // A singleton class which manages the Fast << 35 // A singleton class which manages the Fast Simulation managers
35 // attached to envelopes. 36 // attached to envelopes.
36 // 37 //
37 // History: 38 // History:
38 // June 98: Verderi && MoraDeFreitas - "G4P 39 // June 98: Verderi && MoraDeFreitas - "G4ParallelWorld" becomes
39 // "G4FlavoredParallelWorld"; some 40 // "G4FlavoredParallelWorld"; some method name changes;
40 // GetFlavoredWorldForThis now ret << 41 // GetFlavoredWorldForThis now returns a
41 // G4FlavoredParallelWorld pointer 42 // G4FlavoredParallelWorld pointer.
42 // Feb 98: Verderi && MoraDeFreitas - First 43 // Feb 98: Verderi && MoraDeFreitas - First Implementation.
43 // 44 //
44 //-------------------------------------------- 45 //---------------------------------------------------------------
45 46
46 #ifndef G4GLOBALFASTSIMULATIONMANAGER_HH << 47 #ifndef G4GlobalFastSimulationManager_hh
47 #define G4GLOBALFASTSIMULATIONMANAGER_HH << 48 #define G4GlobalFastSimulationManager_hh
48 49
49 #include "G4FastSimulationManager.hh" << 50 #include "globals.hh"
50 #include "G4FastSimulationManagerProcess.hh" <<
51 #include "G4FastSimulationVector.hh" 51 #include "G4FastSimulationVector.hh"
>> 52
52 #include "G4VGlobalFastSimulationManager.hh" 53 #include "G4VGlobalFastSimulationManager.hh"
53 #include "globals.hh" << 54 #include "G4FastSimulationManager.hh"
>> 55 #include "G4FastSimulationManagerProcess.hh"
>> 56
54 57
55 class G4FastSimulationMessenger; 58 class G4FastSimulationMessenger;
56 template <class T> <<
57 class G4ThreadLocalSingleton; <<
58 59
59 enum listType << 60 enum listType {
60 { <<
61 NAMES_ONLY, 61 NAMES_ONLY,
62 MODELS, 62 MODELS,
63 ISAPPLICABLE 63 ISAPPLICABLE
64 }; 64 };
65 65
>> 66
66 // Class Description: 67 // Class Description:
67 // This a singleton class which provides the m 68 // This a singleton class which provides the management of the G4FastSimulationManager
68 // objects and some ghost facilities. << 69 // objects and some ghost facilities.
69 // 70 //
70 // You can get access to it by: 71 // You can get access to it by:
71 // 72 //
72 // #include "G4GlobalFastSimulationManager.hh" 73 // #include "G4GlobalFastSimulationManager.hh"
73 // ... 74 // ...
74 // ... 75 // ...
75 // G4GlobalFastSimulationManager* globalFSM; 76 // G4GlobalFastSimulationManager* globalFSM;
76 // globalFSM = G4GlobalFastSimulationManager:: 77 // globalFSM = G4GlobalFastSimulationManager::getGlobalFastSimulationManager();
77 // ... 78 // ...
78 // ... 79 // ...
79 // << 80 //
80 // Presently, you will mainly need to use the << 81 // Presently, you will mainly need to use the GlobalFastSimulationManager if you use ghost
81 // geometries. 82 // geometries.
82 // 83 //
83 84
84 class G4GlobalFastSimulationManager 85 class G4GlobalFastSimulationManager
85 { 86 {
86 friend class G4ThreadLocalSingleton<G4Global <<
87 87
88 public: << 88 public: // With description
89 // Destructor << 89
90 ~G4GlobalFastSimulationManager(); << 90 static G4GlobalFastSimulationManager* GetGlobalFastSimulationManager();
91 << 91 // Provides a global access to the GlobalFastSimulationManager
92 // Provides a global access to the GlobalF << 92 static G4GlobalFastSimulationManager* GetInstance();
93 static G4GlobalFastSimulationManager* GetG << 93 // Same as GetGlobalFastSimulationManager()
94 << 94
95 // Same as GetGlobalFastSimulationManager( << 95 G4VFastSimulationModel* GetFastSimulationModel(const G4String& modelName,
96 static G4GlobalFastSimulationManager* GetI << 96 const G4VFastSimulationModel* previousFound = 0) const;
97 << 97 // Iterative fetch of G4VFastSimulationModel objects by name:
98 // Iterative fetch of G4VFastSimulationMod << 98 // o returns the G4VFastSimulationModel* of model with name modelName;
99 // o returns the G4VFastSimulationModel << 99 // o returns 0 if no model found;
100 // o returns 0 if no model found; << 100 // o usage:
101 // o usage: << 101 // myModel = gblManager->GetFastSimulationModel("MyModel");
102 // myModel = gblManager->GetFastSim << 102 // o note for the case of several models having the same name:
103 // o note for the case of several model << 103 // - to get the first "MyModel" model:
104 // - to get the first "MyModel" mod << 104 // myModel1 = gblManager->GetFastSimulationModel("MyModel", 0);
105 // myModel1 = gblManager->GetF << 105 // - to get the next one:
106 // - to get the next one: << 106 // myModel2 = gblManager->GetFastSimulationModel("MyModel", myModel1);
107 // myModel2 = gblManager->GetF << 107 // - and so on.
108 // - and so on. << 108 // - When gblManager->GetFastSimulationModel("MyModel", myModel_n)
109 // - When gblManager->GetFastSimula << 109 // returns a null pointer, no extra model with name "MyModel" exist.
110 // returns a null pointer, no ext << 110
111 G4VFastSimulationModel* << 111
112 GetFastSimulationModel(const G4String& mod << 112 public: // Without description
113 const G4VFastSimula << 113
114 << 114 // Destructor
115 // << 115 ~G4GlobalFastSimulationManager();
116 // G4FastSimulationManager(Process)'s mana << 116
117 // << 117 //
118 // Methods for a G4FastSimulationManager t << 118 // G4FastSimulationManager(Process)'s management, no intended for general use.
119 // << 119 //
120 void AddFastSimulationManager(G4FastSimula << 120 // Methods for a G4FastSimulationManager to register itself
121 void RemoveFastSimulationManager(G4FastSim << 121 //
122 // << 122 void AddFastSimulationManager(G4FastSimulationManager*);
123 // G4FastSimulationManagerProcess bookeepi << 123 void RemoveFastSimulationManager(G4FastSimulationManager*);
124 // << 124 //
125 void AddFSMP(G4FastSimulationManagerProces << 125 // G4FastSimulationManagerProcess bookeeping:
126 void RemoveFSMP(G4FastSimulationManagerPro << 126 //
127 << 127 void AddFSMP(G4FastSimulationManagerProcess*);
128 // Flag that the Parameterisation must be << 128 void RemoveFSMP(G4FastSimulationManagerProcess*);
129 void FastSimulationNeedsToBeClosed(); << 129
130 << 130
131 // Show the fast simulation setup : world( << 131 // Flag that the Parameterisation must be closed.
132 // Requires the geometry to be closed. << 132 void FastSimulationNeedsToBeClosed();
133 void ShowSetup(); << 133
134 << 134
135 void ListEnvelopes(const G4String& aName = << 135 public: // With description
136 void ListEnvelopes(const G4ParticleDefinit << 136 void ShowSetup();
137 << 137 // Show the fast simulation setup : world(s), region(s), model(s) and links between them.
138 void ActivateFastSimulationModel(const G4S << 138 // Requires the geometry to be closed.
139 void InActivateFastSimulationModel(const G << 139
140 << 140
141 void Flush(); << 141 public: // Without description
142 << 142
143 private: << 143 void ListEnvelopes(const G4String& aName = "all",
144 // Private construtor insures singleton cl << 144 listType aListType = NAMES_ONLY);
145 G4GlobalFastSimulationManager(); << 145 void ListEnvelopes(const G4ParticleDefinition* );
146 << 146
147 // recursive display of regions, models, e << 147 void ActivateFastSimulationModel(const G4String&);
148 void DisplayRegion(G4Region* motherRegion, << 148 void InActivateFastSimulationModel(const G4String&);
149 std::vector<G4ParticleD << 149
150 << 150
151 G4FastSimulationMessenger* fTheFastSimulat << 151
152 G4FastSimulationVector<G4FastSimulationMan << 152 private:
153 G4FastSimulationVector<G4FastSimulationMan << 153 // Private construtor insures singleton class
>> 154 G4GlobalFastSimulationManager();
>> 155
>> 156 // recursive display of regions, models, etc...
>> 157 void DisplayRegion(G4Region* motherRegion, G4int depth, std::vector<G4ParticleDefinition*>& particles) const;
>> 158
>> 159 // The single instance.
>> 160 static G4ThreadLocal G4GlobalFastSimulationManager* fGlobalFastSimulationManager;
>> 161 G4FastSimulationMessenger* fTheFastSimulationMessenger;
>> 162 G4FastSimulationVector <G4FastSimulationManager> ManagedManagers;
>> 163 G4FastSimulationVector <G4FastSimulationManagerProcess> fFSMPVector;
154 }; 164 };
155 165
156 #endif << 166 #endif
>> 167 // end of #ifndef G4GlobalFastSimulationManager_hh
157 168