| Geant4 Cross Reference |
1 // 1 //
2 // ******************************************* 2 // ********************************************************************
3 // * License and Disclaimer << 3 // * DISCLAIMER *
4 // * 4 // * *
5 // * The Geant4 software is copyright of th << 5 // * The following disclaimer summarizes all the specific disclaimers *
6 // * the Geant4 Collaboration. It is provided << 6 // * of contributors to this software. The specific disclaimers,which *
7 // * conditions of the Geant4 Software License << 7 // * govern, are listed with their locations in: *
8 // * LICENSE and available at http://cern.ch/ << 8 // * http://cern.ch/geant4/license *
9 // * include a list of copyright holders. <<
10 // * 9 // * *
11 // * Neither the authors of this software syst 10 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing fin 11 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warran 12 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assum 13 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file << 14 // * use. *
16 // * for the full disclaimer and the limitatio <<
17 // * 15 // * *
18 // * This code implementation is the result << 16 // * This code implementation is the intellectual property of the *
19 // * technical work of the GEANT4 collaboratio << 17 // * GEANT4 collaboration. *
20 // * By using, copying, modifying or distri << 18 // * By copying, distributing or modifying the Program (or any work *
21 // * any work based on the software) you ag << 19 // * based on the Program) you indicate your acceptance of this *
22 // * use in resulting scientific publicati << 20 // * statement, and all its terms. *
23 // * acceptance of all terms of the Geant4 Sof <<
24 // ******************************************* 21 // ********************************************************************
25 // 22 //
>> 23 //
>> 24 //
26 // ------------------------------------------- 25 // -------------------------------------------------------------------
27 // 26 //
28 // GEANT4 Class header file 27 // GEANT4 Class header file
29 // 28 //
30 // 29 //
31 // File name: G4LossTableManager 30 // File name: G4LossTableManager
32 // 31 //
33 // Author: Vladimir Ivanchenko on base 32 // Author: Vladimir Ivanchenko on base of G4LossTables class
34 // and Maria Grazia Pia ideas << 33 // and Maria Grazia Pia ideas
35 // << 34 //
36 // Creation date: 03.01.2002 35 // Creation date: 03.01.2002
37 // 36 //
38 // Modifications by V.Ivanchenko << 37 // Modifications:
>> 38 //
39 // 39 //
40 // Class Description: << 40 // Class Description:
41 // 41 //
42 // A utility static class, responsable for the 42 // A utility static class, responsable for the energy loss tables
43 // for each particle 43 // for each particle
44 // 44 //
45 // Energy loss processes have to register thei << 45 // Energy loss processes have to register their tables with this
46 // class. The responsibility of creating and d 46 // class. The responsibility of creating and deleting the tables
47 // remains with the energy loss classes. 47 // remains with the energy loss classes.
48 48
49 // ------------------------------------------- 49 // -------------------------------------------------------------------
50 // 50 //
51 51
52 #ifndef G4LossTableManager_h 52 #ifndef G4LossTableManager_h
53 #define G4LossTableManager_h 1 53 #define G4LossTableManager_h 1
54 54
55 #include <map> << 55
56 #include <vector> << 56 #include "g4std/map"
>> 57 #include "g4std/vector"
57 #include "globals.hh" 58 #include "globals.hh"
58 #include "G4ThreadLocalSingleton.hh" << 59 #include "G4LossTableBuilder.hh"
59 #include "G4VEnergyLossProcess.hh" << 60 #include "G4VEnergyLossSTD.hh"
60 #include "G4EmParameters.hh" <<
61 61
62 class G4PhysicsTable; 62 class G4PhysicsTable;
63 class G4MaterialCutsCouple; << 63 class G4Material;
>> 64 class G4EnergyLossMessengerSTD;
64 class G4ParticleDefinition; 65 class G4ParticleDefinition;
65 class G4Region; <<
66 class G4EmSaturation; <<
67 class G4EmConfigurator; <<
68 class G4ElectronIonPair; <<
69 class G4NIELCalculator; <<
70 class G4VMultipleScattering; <<
71 class G4VEmProcess; <<
72 class G4EmCorrections; <<
73 class G4LossTableBuilder; <<
74 class G4VAtomDeexcitation; <<
75 class G4VSubCutProducer; <<
76 66
77 class G4LossTableManager << 67 class G4LossTableManager
78 { 68 {
79 69
80 friend class G4ThreadLocalSingleton<G4LossTabl <<
81 <<
82 public: 70 public:
83 71
84 static G4LossTableManager* Instance(); 72 static G4LossTableManager* Instance();
85 73
86 ~G4LossTableManager(); 74 ~G4LossTableManager();
87 75
88 //------------------------------------------ << 76 void Clear();
89 // initialisation before a new run <<
90 //------------------------------------------ <<
91 <<
92 void PreparePhysicsTable(const G4ParticleDef <<
93 G4VEnergyLossProces <<
94 <<
95 void PreparePhysicsTable(const G4ParticleDef <<
96 G4VEmProcess* p); <<
97 <<
98 void PreparePhysicsTable(const G4ParticleDef <<
99 G4VMultipleScatteri <<
100 <<
101 void BuildPhysicsTable(const G4ParticleDefin <<
102 <<
103 void BuildPhysicsTable(const G4ParticleDefin <<
104 G4VEnergyLossProcess* <<
105 <<
106 void LocalPhysicsTables(const G4ParticleDefi <<
107 G4VEnergyLossProcess <<
108 <<
109 void DumpHtml(); <<
110 <<
111 //------------------------------------------ <<
112 // Run time access to DEDX, range, energy fo <<
113 // energy, and G4MaterialCutsCouple <<
114 //------------------------------------------ <<
115 <<
116 inline G4double GetDEDX( <<
117 const G4ParticleDefinition *aParticle, <<
118 G4double kineticEnergy, <<
119 const G4MaterialCutsCouple *couple); <<
120 <<
121 inline G4double GetRange( <<
122 const G4ParticleDefinition *aParticle, <<
123 G4double kineticEnergy, <<
124 const G4MaterialCutsCouple *couple); <<
125 77
126 inline G4double GetCSDARange( << 78 // get the DEDX or the range for a given particle/energy/material
>> 79 G4double GetDEDX(
127 const G4ParticleDefinition *aParticle, 80 const G4ParticleDefinition *aParticle,
128 G4double kineticEnergy, 81 G4double kineticEnergy,
129 const G4MaterialCutsCouple *couple); << 82 const G4Material *aMaterial);
130 83
131 inline G4double GetRangeFromRestricteDEDX( << 84 G4double GetRange(
132 const G4ParticleDefinition *aParticle, 85 const G4ParticleDefinition *aParticle,
133 G4double kineticEnergy, 86 G4double kineticEnergy,
134 const G4MaterialCutsCouple *couple); << 87 const G4Material *aMaterial);
135 << 88
136 inline G4double GetEnergy( << 89 G4double GetEnergy(
137 const G4ParticleDefinition *aParticle, 90 const G4ParticleDefinition *aParticle,
138 G4double range, 91 G4double range,
139 const G4MaterialCutsCouple *couple); << 92 const G4Material *aMaterial);
140 <<
141 inline G4double GetDEDXDispersion( <<
142 const G4MaterialCutsCouple *couple, <<
143 const G4DynamicParticle* dp, <<
144 G4double& length); <<
145 <<
146 //------------------------------------------ <<
147 // Methods to be called only at initialisati <<
148 // and at the end of the job <<
149 //------------------------------------------ <<
150 <<
151 void Register(G4VEnergyLossProcess* p); <<
152 <<
153 void DeRegister(G4VEnergyLossProcess* p); <<
154 <<
155 void Register(G4VMultipleScattering* p); <<
156 <<
157 void DeRegister(G4VMultipleScattering* p); <<
158 <<
159 void Register(G4VEmProcess* p); <<
160 93
161 void DeRegister(G4VEmProcess* p); << 94 // to be called only by energy loss processes
>> 95 void Register(G4VEnergyLossSTD* p);
162 96
163 void Register(G4VProcess* p); << 97 void BuildDEDXTable(const G4ParticleDefinition* aParticle);
164 98
165 void DeRegister(G4VProcess* p); << 99 void RetrieveDEDXTable(const G4ParticleDefinition* aParticle,
>> 100 G4VEnergyLossSTD*);
166 101
167 void Register(G4VEmModel* p); << 102 void SetLossFluctuations(G4bool val);
168 103
169 void DeRegister(G4VEmModel* p); << 104 void SetSubCutoff(G4bool val);
170 105
171 void Register(G4VEmFluctuationModel* p); << 106 void SetIntegral(G4bool val);
172 107
173 void DeRegister(G4VEmFluctuationModel* p); << 108 void SetRandomStep(G4bool val);
174 109
175 void RegisterExtraParticle(const G4ParticleD << 110 void SetMinSubRange(G4double val);
176 G4VEnergyLossProc <<
177 111
178 void SetVerbose(G4int val); << 112 void SetMinEnergy(G4double val);
179 113
180 void ResetParameters(); << 114 void SetMaxEnergy(G4double val);
181 115
182 void SetAtomDeexcitation(G4VAtomDeexcitation << 116 void SetStepLimits(G4double v1, G4double v2);
183 117
184 void SetSubCutProducer(G4VSubCutProducer*); << 118 G4bool StorePhysicsTable(G4VEnergyLossSTD* el,
185 << 119 const G4String& dedx_file,
186 void SetNIELCalculator(G4NIELCalculator*); << 120 const G4String& range_file,
187 << 121 const G4String& inv_range_file,
188 //------------------------------------------ << 122 G4bool ascii);
189 // Access methods <<
190 //------------------------------------------ <<
191 <<
192 inline G4bool IsMaster() const; <<
193 <<
194 G4VEnergyLossProcess* GetEnergyLossProcess(c <<
195 123
196 const std::vector<G4VEnergyLossProcess*>& Ge <<
197 <<
198 const std::vector<G4VEmProcess*>& GetEmProce <<
199 <<
200 const std::vector<G4VMultipleScattering*>& G <<
201 <<
202 G4EmSaturation* EmSaturation(); <<
203 <<
204 G4EmConfigurator* EmConfigurator(); <<
205 <<
206 G4ElectronIonPair* ElectronIonPair(); <<
207 <<
208 G4NIELCalculator* NIELCalculator(); <<
209 <<
210 inline G4EmCorrections* EmCorrections(); <<
211 <<
212 inline G4VAtomDeexcitation* AtomDeexcitation <<
213 <<
214 inline G4VSubCutProducer* SubCutProducer(); <<
215 <<
216 inline G4LossTableBuilder* GetTableBuilder() <<
217 <<
218 inline void SetGammaGeneralProcess(G4VEmProc <<
219 <<
220 inline G4VEmProcess* GetGammaGeneralProcess( <<
221 <<
222 inline void SetElectronGeneralProcess(G4VEmP <<
223 <<
224 inline G4VEmProcess* GetElectronGeneralProce <<
225 <<
226 inline void SetPositronGeneralProcess(G4VEmP <<
227 <<
228 inline G4VEmProcess* GetPositronGeneralProce <<
229 <<
230 G4LossTableManager(G4LossTableManager &) = d <<
231 G4LossTableManager & operator=(const G4LossT <<
232 <<
233 private: 124 private:
234 125
235 //------------------------------------------ <<
236 // Private methods and members <<
237 //------------------------------------------ <<
238 <<
239 G4LossTableManager(); 126 G4LossTableManager();
240 127
241 void Clear(); << 128 void Initialise();
242 <<
243 G4VEnergyLossProcess* BuildTables(const G4Pa <<
244 <<
245 void CopyTables(const G4ParticleDefinition* <<
246 G4VEnergyLossProcess*); <<
247 129
248 void ParticleHaveNoLoss(const G4ParticleDefi << 130 G4VEnergyLossSTD* BuildTables(const G4ParticleDefinition* aParticle);
249 131
250 void CopyDEDXTables(); << 132 // G4LossTableManager(const G4LossTableManager&);
>> 133 // const G4LossTableManager& operator=(const G4LossTableManager& right);
251 134
252 void PrintEWarning(G4String, G4double); << 135 private:
253 136
254 static G4ThreadLocal G4LossTableManager* ins << 137 static G4LossTableManager* theInstance;
255 138
256 typedef const G4ParticleDefinition* PD; 139 typedef const G4ParticleDefinition* PD;
>> 140 G4std::map<PD,G4VEnergyLossSTD*,G4std::less<PD> > loss_map;
257 141
258 // cache << 142 G4std::vector<G4VEnergyLossSTD*> loss_vector;
259 G4VEnergyLossProcess* currentLoss{nullptr}; << 143 G4std::vector<PD> part_vector;
260 PD currentParticle{nullptr}; << 144 G4std::vector<PD> base_part_vector;
261 PD theElectron; << 145 G4std::vector<G4bool> tables_are_built;
262 PD theGenericIon{nullptr}; << 146 G4std::vector<G4PhysicsTable*> dedx_vector;
263 PD firstParticle{nullptr}; << 147 G4std::vector<G4PhysicsTable*> range_vector;
264 << 148 G4std::vector<G4PhysicsTable*> inv_range_vector;
265 G4LossTableBuilder* tableBuilder; << 149
266 G4EmCorrections* emCorrections; << 150 // cash
267 G4EmConfigurator* emConfigurator{nullptr}; << 151 G4VEnergyLossSTD* currentLoss;
268 G4ElectronIonPair* emElectronIonPair{nullptr << 152 PD currentParticle;
269 G4NIELCalculator* nielCalculator{nullptr}; << 153 PD theElectron;
270 G4VAtomDeexcitation* atomDeexcitation{nullpt <<
271 G4VSubCutProducer* subcutProducer{nullptr}; <<
272 <<
273 G4EmParameters* theParameters; <<
274 G4VEmProcess* gGeneral{nullptr}; <<
275 G4VEmProcess* eGeneral{nullptr}; <<
276 G4VEmProcess* pGeneral{nullptr}; <<
277 154
>> 155 G4int n_loss;
>> 156
>> 157 G4bool all_tables_are_built;
>> 158 G4bool all_particles_are_mapped;
>> 159 G4bool electron_table_are_built;
>> 160 G4bool lossFluctuationFlag;
>> 161 G4bool subCutoffFlag;
>> 162 G4bool rndmStepFlag;
>> 163 G4bool integral;
>> 164
>> 165 G4double minSubRange;
>> 166 G4double maxRangeVariation;
>> 167 G4double maxFinalStep;
>> 168 G4double minKinEnergy;
>> 169 G4double maxKinEnergy;
>> 170
>> 171 G4VEnergyLossSTD* eIonisation;
>> 172 G4LossTableBuilder* tableBuilder;
>> 173 G4EnergyLossMessengerSTD* theMessenger;
278 G4int verbose; 174 G4int verbose;
279 G4int n_loss{0}; <<
280 G4int run{-1}; <<
281 <<
282 G4bool all_tables_are_built{false}; <<
283 G4bool startInitialisation{false}; <<
284 G4bool resetParam{true}; <<
285 G4bool isMaster{false}; <<
286 <<
287 std::vector<G4VEnergyLossProcess*> loss_vect <<
288 std::vector<PD> part_vector; <<
289 std::vector<PD> base_part_vector; <<
290 std::vector<G4PhysicsTable*> dedx_vector; <<
291 std::vector<G4PhysicsTable*> range_vector; <<
292 std::vector<G4PhysicsTable*> inv_range_vecto <<
293 std::vector<G4bool> tables_are_built; <<
294 std::vector<G4bool> isActive; <<
295 std::vector<G4VMultipleScattering*> msc_vect <<
296 std::vector<G4VEmProcess*> emp_vector; <<
297 std::vector<G4VEmModel*> mod_vector; <<
298 std::vector<G4VEmFluctuationModel*> fmod_vec <<
299 std::vector<G4VProcess*> p_vector; <<
300 175
301 std::map<PD,G4VEnergyLossProcess*,std::less< <<
302 }; 176 };
303 177
304 //....oooOO0OOooo........oooOO0OOooo........oo 178 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
305 //....oooOO0OOooo........oooOO0OOooo........oo <<
306 <<
307 inline <<
308 G4double G4LossTableManager::GetDEDX(const G4P <<
309 G4double <<
310 const G4M <<
311 { <<
312 if(aParticle != currentParticle) { GetEnergy <<
313 return currentLoss ? currentLoss->GetDEDX(ki <<
314 } <<
315 <<
316 //....oooOO0OOooo........oooOO0OOooo........oo 179 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo.....
317 180
318 inline << 181 inline G4double G4LossTableManager::GetDEDX(
319 G4double G4LossTableManager::GetCSDARange(cons << 182 const G4ParticleDefinition *aParticle,
320 G4do << 183 G4double kineticEnergy,
321 cons << 184 const G4Material *aMaterial)
322 { << 185 {
323 if(aParticle != currentParticle) { GetEnergy << 186 if(aParticle != currentParticle) {
324 return currentLoss ? currentLoss->GetCSDARan << 187 G4std::map<PD, G4VEnergyLossSTD*,G4std::less<PD> >::const_iterator pos;
>> 188 if((pos = loss_map.find(aParticle)) == loss_map.end()) return 0.0;
>> 189 currentParticle = aParticle;
>> 190 currentLoss = (*pos).second;
>> 191 }
>> 192 return currentLoss->GetDEDX(kineticEnergy, aMaterial);
325 } 193 }
326 194
327 //....oooOO0OOooo........oooOO0OOooo........oo 195 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo.....
328 196
329 inline << 197 inline G4double G4LossTableManager::GetRange(
330 G4double G4LossTableManager::GetRangeFromRestr << 198 const G4ParticleDefinition *aParticle,
331 const G4ParticleD << 199 G4double kineticEnergy,
332 G4double kineticE << 200 const G4Material *aMaterial)
333 const G4MaterialC << 201 {
334 { << 202 if(aParticle != currentParticle) {
335 if(aParticle != currentParticle) { GetEnergy << 203 G4std::map<PD, G4VEnergyLossSTD*, G4std::less<PD> >::const_iterator pos;
336 return currentLoss ? currentLoss->GetRange(k << 204 if((pos = loss_map.find(aParticle)) == loss_map.end()) return 0.0;
337 } << 205 currentParticle = aParticle;
338 << 206 currentLoss = (*pos).second;
339 //....oooOO0OOooo........oooOO0OOooo........oo << 207 }
340 << 208 return currentLoss->GetRange(kineticEnergy, aMaterial);
341 inline <<
342 G4double G4LossTableManager::GetRange(const G4 <<
343 G4double <<
344 const G4 <<
345 { <<
346 if(aParticle != currentParticle) { GetEnergy <<
347 return currentLoss ? currentLoss->GetRange(k <<
348 } 209 }
349 210
350 //....oooOO0OOooo........oooOO0OOooo........oo 211 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
351 212
352 inline << 213 inline G4double G4LossTableManager::GetEnergy(
353 G4double G4LossTableManager::GetEnergy(const G << 214 const G4ParticleDefinition *aParticle,
354 G4doubl << 215 G4double range,
355 const G << 216 const G4Material *aMaterial)
356 { << 217 {
357 if(aParticle != currentParticle) { GetEnergy << 218 if(aParticle != currentParticle) {
358 return currentLoss ? currentLoss->GetKinetic << 219 G4std::map<PD,G4VEnergyLossSTD*,G4std::less<PD> >::const_iterator pos;
>> 220 if((pos = loss_map.find(aParticle)) == loss_map.end()) return 0.0;
>> 221 currentParticle = aParticle;
>> 222 currentLoss = (*pos).second;
>> 223 }
>> 224 return currentLoss->GetKineticEnergy(range, aMaterial);
359 } 225 }
360 226
361 //....oooOO0OOooo........oooOO0OOooo........oo 227 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
362 228
363 inline <<
364 G4double G4LossTableManager::GetDEDXDispersion <<
365 const G4MaterialC <<
366 const G4DynamicPa <<
367 G4double& length) <<
368 { <<
369 const G4ParticleDefinition* aParticle = dp-> <<
370 if(aParticle != currentParticle) { GetEnergy <<
371 return currentLoss ? currentLoss->GetDEDXDis <<
372 } <<
373 <<
374 //....oooOO0OOooo........oooOO0OOooo........oo <<
375 <<
376 inline G4bool G4LossTableManager::IsMaster() c <<
377 { <<
378 return isMaster; <<
379 } <<
380 <<
381 //....oooOO0OOooo........oooOO0OOooo........oo <<
382 <<
383 inline G4EmCorrections* G4LossTableManager::Em <<
384 { <<
385 return emCorrections; <<
386 } <<
387 <<
388 //....oooOO0OOooo........oooOO0OOooo........oo <<
389 <<
390 inline G4VAtomDeexcitation* G4LossTableManager <<
391 { <<
392 return atomDeexcitation; <<
393 } <<
394 <<
395 //....oooOO0OOooo........oooOO0OOooo........oo <<
396 <<
397 inline G4VSubCutProducer* G4LossTableManager:: <<
398 { <<
399 return subcutProducer; <<
400 } <<
401 <<
402 //....oooOO0OOooo........oooOO0OOooo........oo <<
403 <<
404 inline G4LossTableBuilder* G4LossTableManager: <<
405 { <<
406 return tableBuilder; <<
407 } <<
408 <<
409 //....oooOO0OOooo........oooOO0OOooo........oo <<
410 <<
411 inline void G4LossTableManager::SetGammaGenera <<
412 { <<
413 gGeneral = ptr; <<
414 } <<
415 <<
416 //....oooOO0OOooo........oooOO0OOooo........oo <<
417 <<
418 inline G4VEmProcess* G4LossTableManager::GetGa <<
419 { <<
420 return gGeneral; <<
421 } <<
422 <<
423 //....oooOO0OOooo........oooOO0OOooo........oo <<
424 <<
425 inline void G4LossTableManager::SetElectronGen <<
426 { <<
427 eGeneral = ptr; <<
428 } <<
429 <<
430 //....oooOO0OOooo........oooOO0OOooo........oo <<
431 <<
432 inline G4VEmProcess* G4LossTableManager::GetEl <<
433 { <<
434 return eGeneral; <<
435 } <<
436 <<
437 //....oooOO0OOooo........oooOO0OOooo........oo <<
438 <<
439 inline void G4LossTableManager::SetPositronGen <<
440 { <<
441 pGeneral = ptr; <<
442 } <<
443 <<
444 //....oooOO0OOooo........oooOO0OOooo........oo <<
445 <<
446 inline G4VEmProcess* G4LossTableManager::GetPo <<
447 { <<
448 return pGeneral; <<
449 } <<
450 //....oooOO0OOooo........oooOO0OOooo........oo <<
451 <<
452 #endif 229 #endif
>> 230
453 231