| 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 // -------------------------------------------------------------------
27 //
28 // GEANT4 Class header file
29 //
30 //
31 // File name: G4LossTableManager
32 //
33 // Author: Vladimir Ivanchenko on base of G4LossTables class
34 // and Maria Grazia Pia ideas
35 //
36 // Creation date: 03.01.2002
37 //
38 // Modifications by V.Ivanchenko
39 //
40 // Class Description:
41 //
42 // A utility static class, responsable for the energy loss tables
43 // for each particle
44 //
45 // Energy loss processes have to register their tables with this
46 // class. The responsibility of creating and deleting the tables
47 // remains with the energy loss classes.
48
49 // -------------------------------------------------------------------
50 //
51
52 #ifndef G4LossTableManager_h
53 #define G4LossTableManager_h 1
54
55 #include <map>
56 #include <vector>
57 #include "globals.hh"
58 #include "G4ThreadLocalSingleton.hh"
59 #include "G4VEnergyLossProcess.hh"
60 #include "G4EmParameters.hh"
61
62 class G4PhysicsTable;
63 class G4MaterialCutsCouple;
64 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
77 class G4LossTableManager
78 {
79
80 friend class G4ThreadLocalSingleton<G4LossTableManager>;
81
82 public:
83
84 static G4LossTableManager* Instance();
85
86 ~G4LossTableManager();
87
88 //-------------------------------------------------
89 // initialisation before a new run
90 //-------------------------------------------------
91
92 void PreparePhysicsTable(const G4ParticleDefinition* aParticle,
93 G4VEnergyLossProcess* p);
94
95 void PreparePhysicsTable(const G4ParticleDefinition* aParticle,
96 G4VEmProcess* p);
97
98 void PreparePhysicsTable(const G4ParticleDefinition* aParticle,
99 G4VMultipleScattering* p);
100
101 void BuildPhysicsTable(const G4ParticleDefinition* aParticle);
102
103 void BuildPhysicsTable(const G4ParticleDefinition* aParticle,
104 G4VEnergyLossProcess* p);
105
106 void LocalPhysicsTables(const G4ParticleDefinition* aParticle,
107 G4VEnergyLossProcess* p);
108
109 void DumpHtml();
110
111 //-------------------------------------------------
112 // Run time access to DEDX, range, energy for a given particle,
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
126 inline G4double GetCSDARange(
127 const G4ParticleDefinition *aParticle,
128 G4double kineticEnergy,
129 const G4MaterialCutsCouple *couple);
130
131 inline G4double GetRangeFromRestricteDEDX(
132 const G4ParticleDefinition *aParticle,
133 G4double kineticEnergy,
134 const G4MaterialCutsCouple *couple);
135
136 inline G4double GetEnergy(
137 const G4ParticleDefinition *aParticle,
138 G4double range,
139 const G4MaterialCutsCouple *couple);
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 initialisation
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
161 void DeRegister(G4VEmProcess* p);
162
163 void Register(G4VProcess* p);
164
165 void DeRegister(G4VProcess* p);
166
167 void Register(G4VEmModel* p);
168
169 void DeRegister(G4VEmModel* p);
170
171 void Register(G4VEmFluctuationModel* p);
172
173 void DeRegister(G4VEmFluctuationModel* p);
174
175 void RegisterExtraParticle(const G4ParticleDefinition* aParticle,
176 G4VEnergyLossProcess* p);
177
178 void SetVerbose(G4int val);
179
180 void ResetParameters();
181
182 void SetAtomDeexcitation(G4VAtomDeexcitation*);
183
184 void SetSubCutProducer(G4VSubCutProducer*);
185
186 void SetNIELCalculator(G4NIELCalculator*);
187
188 //-------------------------------------------------
189 // Access methods
190 //-------------------------------------------------
191
192 inline G4bool IsMaster() const;
193
194 G4VEnergyLossProcess* GetEnergyLossProcess(const G4ParticleDefinition*);
195
196 const std::vector<G4VEnergyLossProcess*>& GetEnergyLossProcessVector();
197
198 const std::vector<G4VEmProcess*>& GetEmProcessVector();
199
200 const std::vector<G4VMultipleScattering*>& GetMultipleScatteringVector();
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(G4VEmProcess*);
219
220 inline G4VEmProcess* GetGammaGeneralProcess();
221
222 inline void SetElectronGeneralProcess(G4VEmProcess*);
223
224 inline G4VEmProcess* GetElectronGeneralProcess();
225
226 inline void SetPositronGeneralProcess(G4VEmProcess*);
227
228 inline G4VEmProcess* GetPositronGeneralProcess();
229
230 G4LossTableManager(G4LossTableManager &) = delete;
231 G4LossTableManager & operator=(const G4LossTableManager &right) = delete;
232
233 private:
234
235 //-------------------------------------------------
236 // Private methods and members
237 //-------------------------------------------------
238
239 G4LossTableManager();
240
241 void Clear();
242
243 G4VEnergyLossProcess* BuildTables(const G4ParticleDefinition* aParticle);
244
245 void CopyTables(const G4ParticleDefinition* aParticle,
246 G4VEnergyLossProcess*);
247
248 void ParticleHaveNoLoss(const G4ParticleDefinition* aParticle);
249
250 void CopyDEDXTables();
251
252 void PrintEWarning(G4String, G4double);
253
254 static G4ThreadLocal G4LossTableManager* instance;
255
256 typedef const G4ParticleDefinition* PD;
257
258 // cache
259 G4VEnergyLossProcess* currentLoss{nullptr};
260 PD currentParticle{nullptr};
261 PD theElectron;
262 PD theGenericIon{nullptr};
263 PD firstParticle{nullptr};
264
265 G4LossTableBuilder* tableBuilder;
266 G4EmCorrections* emCorrections;
267 G4EmConfigurator* emConfigurator{nullptr};
268 G4ElectronIonPair* emElectronIonPair{nullptr};
269 G4NIELCalculator* nielCalculator{nullptr};
270 G4VAtomDeexcitation* atomDeexcitation{nullptr};
271 G4VSubCutProducer* subcutProducer{nullptr};
272
273 G4EmParameters* theParameters;
274 G4VEmProcess* gGeneral{nullptr};
275 G4VEmProcess* eGeneral{nullptr};
276 G4VEmProcess* pGeneral{nullptr};
277
278 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_vector;
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_vector;
293 std::vector<G4bool> tables_are_built;
294 std::vector<G4bool> isActive;
295 std::vector<G4VMultipleScattering*> msc_vector;
296 std::vector<G4VEmProcess*> emp_vector;
297 std::vector<G4VEmModel*> mod_vector;
298 std::vector<G4VEmFluctuationModel*> fmod_vector;
299 std::vector<G4VProcess*> p_vector;
300
301 std::map<PD,G4VEnergyLossProcess*,std::less<PD> > loss_map;
302 };
303
304 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
305 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
306
307 inline
308 G4double G4LossTableManager::GetDEDX(const G4ParticleDefinition *aParticle,
309 G4double kineticEnergy,
310 const G4MaterialCutsCouple *couple)
311 {
312 if(aParticle != currentParticle) { GetEnergyLossProcess(aParticle); }
313 return currentLoss ? currentLoss->GetDEDX(kineticEnergy, couple) : 0.0;
314 }
315
316 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo.....
317
318 inline
319 G4double G4LossTableManager::GetCSDARange(const G4ParticleDefinition *aParticle,
320 G4double kineticEnergy,
321 const G4MaterialCutsCouple *couple)
322 {
323 if(aParticle != currentParticle) { GetEnergyLossProcess(aParticle); }
324 return currentLoss ? currentLoss->GetCSDARange(kineticEnergy, couple) : DBL_MAX;
325 }
326
327 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo.....
328
329 inline
330 G4double G4LossTableManager::GetRangeFromRestricteDEDX(
331 const G4ParticleDefinition *aParticle,
332 G4double kineticEnergy,
333 const G4MaterialCutsCouple *couple)
334 {
335 if(aParticle != currentParticle) { GetEnergyLossProcess(aParticle); }
336 return currentLoss ? currentLoss->GetRange(kineticEnergy, couple) : DBL_MAX;
337 }
338
339 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo.....
340
341 inline
342 G4double G4LossTableManager::GetRange(const G4ParticleDefinition *aParticle,
343 G4double kineticEnergy,
344 const G4MaterialCutsCouple *couple)
345 {
346 if(aParticle != currentParticle) { GetEnergyLossProcess(aParticle); }
347 return currentLoss ? currentLoss->GetRange(kineticEnergy, couple) : DBL_MAX;
348 }
349
350 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
351
352 inline
353 G4double G4LossTableManager::GetEnergy(const G4ParticleDefinition *aParticle,
354 G4double range,
355 const G4MaterialCutsCouple *couple)
356 {
357 if(aParticle != currentParticle) { GetEnergyLossProcess(aParticle); }
358 return currentLoss ? currentLoss->GetKineticEnergy(range, couple) : 0.0;
359 }
360
361 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
362
363 inline
364 G4double G4LossTableManager::GetDEDXDispersion(
365 const G4MaterialCutsCouple *couple,
366 const G4DynamicParticle* dp,
367 G4double& length)
368 {
369 const G4ParticleDefinition* aParticle = dp->GetParticleDefinition();
370 if(aParticle != currentParticle) { GetEnergyLossProcess(aParticle); }
371 return currentLoss ? currentLoss->GetDEDXDispersion(couple, dp, length) : 0.0;
372 }
373
374 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo.....
375
376 inline G4bool G4LossTableManager::IsMaster() const
377 {
378 return isMaster;
379 }
380
381 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
382
383 inline G4EmCorrections* G4LossTableManager::EmCorrections()
384 {
385 return emCorrections;
386 }
387
388 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
389
390 inline G4VAtomDeexcitation* G4LossTableManager::AtomDeexcitation()
391 {
392 return atomDeexcitation;
393 }
394
395 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo.....
396
397 inline G4VSubCutProducer* G4LossTableManager::SubCutProducer()
398 {
399 return subcutProducer;
400 }
401
402 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
403
404 inline G4LossTableBuilder* G4LossTableManager::GetTableBuilder()
405 {
406 return tableBuilder;
407 }
408
409 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
410
411 inline void G4LossTableManager::SetGammaGeneralProcess(G4VEmProcess* ptr)
412 {
413 gGeneral = ptr;
414 }
415
416 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
417
418 inline G4VEmProcess* G4LossTableManager::GetGammaGeneralProcess()
419 {
420 return gGeneral;
421 }
422
423 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
424
425 inline void G4LossTableManager::SetElectronGeneralProcess(G4VEmProcess* ptr)
426 {
427 eGeneral = ptr;
428 }
429
430 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
431
432 inline G4VEmProcess* G4LossTableManager::GetElectronGeneralProcess()
433 {
434 return eGeneral;
435 }
436
437 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
438
439 inline void G4LossTableManager::SetPositronGeneralProcess(G4VEmProcess* ptr)
440 {
441 pGeneral = ptr;
442 }
443
444 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
445
446 inline G4VEmProcess* G4LossTableManager::GetPositronGeneralProcess()
447 {
448 return pGeneral;
449 }
450 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
451
452 #endif
453