Geant4  10.00.p02
G4LossTableManager.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 // $Id: G4LossTableManager.hh 76333 2013-11-08 14:31:50Z gcosmo $
27 //
28 //
29 // -------------------------------------------------------------------
30 //
31 // GEANT4 Class header file
32 //
33 //
34 // File name: G4LossTableManager
35 //
36 // Author: Vladimir Ivanchenko on base of G4LossTables class
37 // and Maria Grazia Pia ideas
38 //
39 // Creation date: 03.01.2002
40 //
41 // Modifications:
42 //
43 // 20-01-03 Migrade to cut per region (V.Ivanchenko)
44 // 17-02-03 Fix problem of store/restore tables for ions (V.Ivanchenko)
45 // 10-03-03 Add Ion registration (V.Ivanchenko)
46 // 25-03-03 Add deregistration (V.Ivanchenko)
47 // 26-03-03 Add GetDEDXDispersion (V.Ivanchenko)
48 // 02-04-03 Change messenger (V.Ivanchenko)
49 // 23-07-03 Add exchange with G4EnergyLossTables (V.Ivanchenko)
50 // 05-10-03 Add G4VEmProcesses registration (V.Ivanchenko)
51 // 17-10-03 Add SetParameters method (V.Ivanchenko)
52 // 12-11-03 G4EnergyLossSTD -> G4EnergyLossProcess (V.Ivanchenko)
53 // 14-01-04 Activate precise range calculation (V.Ivanchenko)
54 // 08-11-04 Migration to new interface of Store/Retrieve tables (V.Ivantchenko)
55 // 10-01-06 PreciseRange -> CSDARange (V.Ivantchenko)
56 // 20-01-06 Introduce GetSubDEDX method (VI)
57 // 26-01-06 Rename GetRange -> GetRangeFromRestricteDEDX (V.Ivanchenko)
58 // 10-05-06 Add methods SetMscStepLimitation, FacRange and MscFlag (VI)
59 // 22-05-06 Add methods Set/Get bremsTh (VI)
60 // 12-02-07 Add SetSkin, SetLinearLossLimit (V.Ivanchenko)
61 // 18-06-07 Move definition of msc parameters to G4EmProcessOptions (V.Ivanchenko)
62 // 12-04-10 Added PreparePhsyicsTables and BuildPhysicsTables entries (V.Ivanchenko)
63 // 04-06-13 Adaptation for MT mode, new method LocalPhysicsTables (V.Ivanchenko)
64 //
65 // Class Description:
66 //
67 // A utility static class, responsable for the energy loss tables
68 // for each particle
69 //
70 // Energy loss processes have to register their tables with this
71 // class. The responsibility of creating and deleting the tables
72 // remains with the energy loss classes.
73 
74 // -------------------------------------------------------------------
75 //
76 
77 #ifndef G4LossTableManager_h
78 #define G4LossTableManager_h 1
79 
80 #include <map>
81 #include <vector>
82 #include "globals.hh"
83 #include "G4VEnergyLossProcess.hh"
85 
86 class G4PhysicsTable;
91 class G4VEmProcess;
92 class G4EmCorrections;
93 class G4EmSaturation;
94 class G4EmConfigurator;
95 class G4ElectronIonPair;
96 class G4LossTableBuilder;
98 class G4Region;
99 
101 {
102 
104 
105 public:
106 
107  static G4LossTableManager* Instance();
108 
110 
111  //-------------------------------------------------
112  // called from destructor
113  //-------------------------------------------------
114 
115  void Clear();
116 
117  //-------------------------------------------------
118  // initialisation before a new run
119  //-------------------------------------------------
120 
121  void PreparePhysicsTable(const G4ParticleDefinition* aParticle,
122  G4VEnergyLossProcess* p, G4bool theMaster);
123 
124  void PreparePhysicsTable(const G4ParticleDefinition* aParticle,
125  G4VEmProcess* p, G4bool theMaster);
126 
127  void PreparePhysicsTable(const G4ParticleDefinition* aParticle,
128  G4VMultipleScattering* p, G4bool theMaster);
129 
130  void BuildPhysicsTable(const G4ParticleDefinition* aParticle);
131 
132  void BuildPhysicsTable(const G4ParticleDefinition* aParticle,
134 
135  void LocalPhysicsTables(const G4ParticleDefinition* aParticle,
137 
138  //-------------------------------------------------
139  // Run time access to DEDX, range, energy for a given particle,
140  // energy, and G4MaterialCutsCouple
141  //-------------------------------------------------
142 
144  const G4ParticleDefinition *aParticle,
145  G4double kineticEnergy,
146  const G4MaterialCutsCouple *couple);
147 
149  const G4ParticleDefinition *aParticle,
150  G4double kineticEnergy,
151  const G4MaterialCutsCouple *couple);
152 
154  const G4ParticleDefinition *aParticle,
155  G4double kineticEnergy,
156  const G4MaterialCutsCouple *couple);
157 
159  const G4ParticleDefinition *aParticle,
160  G4double kineticEnergy,
161  const G4MaterialCutsCouple *couple);
162 
164  const G4ParticleDefinition *aParticle,
165  G4double kineticEnergy,
166  const G4MaterialCutsCouple *couple);
167 
169  const G4ParticleDefinition *aParticle,
170  G4double range,
171  const G4MaterialCutsCouple *couple);
172 
174  const G4MaterialCutsCouple *couple,
175  const G4DynamicParticle* dp,
176  G4double& length);
177 
178  //-------------------------------------------------
179  // Methods to be called only at initialisation
180  //-------------------------------------------------
181 
183 
185 
187 
189 
190  void Register(G4VEmProcess* p);
191 
192  void DeRegister(G4VEmProcess* p);
193 
194  void Register(G4VEmModel* p);
195 
196  void DeRegister(G4VEmModel* p);
197 
199 
201 
202  void RegisterExtraParticle(const G4ParticleDefinition* aParticle,
204 
205  void SetLossFluctuations(G4bool val);
206 
207  void SetSubCutoff(G4bool val, const G4Region* r=0);
208 
209  void SetIntegral(G4bool val);
210 
211  void SetRandomStep(G4bool val);
212 
213  void SetMinSubRange(G4double val);
214 
215  void SetMinEnergy(G4double val);
216 
217  void SetMaxEnergy(G4double val);
218 
220 
221  void SetMaxEnergyForMuons(G4double val);
222 
223  void SetDEDXBinning(G4int val);
224 
226 
227  void SetLambdaBinning(G4int val);
228 
230 
231  void SetStepFunction(G4double v1, G4double v2);
232 
233  void SetBuildCSDARange(G4bool val);
234 
235  void SetLPMFlag(G4bool val);
236 
237  void SetSplineFlag(G4bool val);
238 
239  void SetLinearLossLimit(G4double val);
240 
241  void SetBremsstrahlungTh(G4double val);
242 
244 
245  void SetVerbose(G4int val);
246 
247  //-------------------------------------------------
248  // Access methods
249  //-------------------------------------------------
250 
252 
253  G4bool BuildCSDARange() const;
254 
255  G4bool LPMFlag() const;
256 
257  G4bool SplineFlag() const;
258 
259  G4bool IsMaster() const;
260 
261  G4double BremsstrahlungTh() const;
262 
264 
265  G4double MinKinEnergy() const;
266 
267  G4double MaxKinEnergy() const;
268 
269  const std::vector<G4VEnergyLossProcess*>& GetEnergyLossProcessVector();
270 
271  const std::vector<G4VEmProcess*>& GetEmProcessVector();
272 
273  const std::vector<G4VMultipleScattering*>& GetMultipleScatteringVector();
274 
276 
278 
280 
282 
284 
286 
288 
290 
291 private:
292 
293  //-------------------------------------------------
294  // Private methods and members
295  //-------------------------------------------------
296 
298 
300 
301  void CopyTables(const G4ParticleDefinition* aParticle,
303 
304  void ParticleHaveNoLoss(const G4ParticleDefinition* aParticle);
305 
306  void SetParameters(const G4ParticleDefinition* aParticle,
308 
309  void CopyDEDXTables();
310 
313 
314  //static G4ThreadLocal G4LossTableManager* theInstance;
315 
316  typedef const G4ParticleDefinition* PD;
317 
318  std::map<PD,G4VEnergyLossProcess*,std::less<PD> > loss_map;
319 
320  std::vector<G4VEnergyLossProcess*> loss_vector;
321  std::vector<PD> part_vector;
322  std::vector<PD> base_part_vector;
323  std::vector<G4bool> tables_are_built;
324  std::vector<G4bool> isActive;
325  std::vector<G4PhysicsTable*> dedx_vector;
326  std::vector<G4PhysicsTable*> range_vector;
327  std::vector<G4PhysicsTable*> inv_range_vector;
328  std::vector<G4VMultipleScattering*> msc_vector;
329  std::vector<G4VEmProcess*> emp_vector;
330  std::vector<G4VEmModel*> mod_vector;
331  std::vector<G4VEmFluctuationModel*> fmod_vector;
332 
333  // cash
339 
342 
345 
359 
368 
376 
380 
381 };
382 
383 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
384 
385 #endif
386 
G4EmConfigurator * EmConfigurator()
void SetRandomStep(G4bool val)
G4bool SplineFlag() const
static G4LossTableManager * Instance()
G4VAtomDeexcitation * atomDeexcitation
G4double GetDEDX(const G4ParticleDefinition *aParticle, G4double kineticEnergy, const G4MaterialCutsCouple *couple)
void SetBremsstrahlungTh(G4double val)
std::vector< G4VEmModel * > mod_vector
G4double GetDEDXDispersion(const G4MaterialCutsCouple *couple, const G4DynamicParticle *dp, G4double &length)
G4ElectronIonPair * emElectronIonPair
void DeRegister(G4VEnergyLossProcess *p)
void SetLambdaBinning(G4int val)
G4EmSaturation * emSaturation
G4double GetSubDEDX(const G4ParticleDefinition *aParticle, G4double kineticEnergy, const G4MaterialCutsCouple *couple)
G4bool BuildCSDARange() const
G4EnergyLossMessenger * GetMessenger()
void CopyTables(const G4ParticleDefinition *aParticle, G4VEnergyLossProcess *)
G4double FactorForAngleLimit() const
void SetFactorForAngleLimit(G4double val)
std::vector< G4PhysicsTable * > range_vector
const std::vector< G4VEmProcess * > & GetEmProcessVector()
int G4int
Definition: G4Types.hh:78
G4double GetCSDARange(const G4ParticleDefinition *aParticle, G4double kineticEnergy, const G4MaterialCutsCouple *couple)
G4LossTableBuilder * GetTableBuilder()
std::map< PD, G4VEnergyLossProcess *, std::less< PD > > loss_map
G4EmConfigurator * emConfigurator
void SetBuildCSDARange(G4bool val)
G4VEnergyLossProcess * BuildTables(const G4ParticleDefinition *aParticle)
void ParticleHaveNoLoss(const G4ParticleDefinition *aParticle)
void SetParameters(const G4ParticleDefinition *aParticle, G4VEnergyLossProcess *)
G4double MinKinEnergy() const
void SetLPMFlag(G4bool val)
std::vector< G4VEmFluctuationModel * > fmod_vector
bool G4bool
Definition: G4Types.hh:79
G4EmCorrections * EmCorrections()
G4VEnergyLossProcess * currentLoss
G4ElectronIonPair * ElectronIonPair()
G4EmSaturation * EmSaturation()
void SetMaxEnergyForCSDARange(G4double val)
G4bool IsMaster() const
void Register(G4VEnergyLossProcess *p)
void SetDEDXBinningForCSDARange(G4int val)
G4double GetEnergy(const G4ParticleDefinition *aParticle, G4double range, const G4MaterialCutsCouple *couple)
const std::vector< G4VEnergyLossProcess * > & GetEnergyLossProcessVector()
void SetSubCutoff(G4bool val, const G4Region *r=0)
G4double BremsstrahlungTh() const
G4double GetRangeFromRestricteDEDX(const G4ParticleDefinition *aParticle, G4double kineticEnergy, const G4MaterialCutsCouple *couple)
void RegisterExtraParticle(const G4ParticleDefinition *aParticle, G4VEnergyLossProcess *p)
G4LossTableManager & operator=(const G4LossTableManager &right)
std::vector< G4PhysicsTable * > inv_range_vector
const G4ParticleDefinition * PD
void SetMinSubRange(G4double val)
G4EmCorrections * emCorrections
void SetMinEnergy(G4double val)
G4VEnergyLossProcess * GetEnergyLossProcess(const G4ParticleDefinition *)
void SetMaxEnergy(G4double val)
void SetStepFunction(G4double v1, G4double v2)
void BuildPhysicsTable(const G4ParticleDefinition *aParticle)
G4LossTableBuilder * tableBuilder
void SetLinearLossLimit(G4double val)
G4int GetNumberOfBinsPerDecade() const
std::vector< G4PhysicsTable * > dedx_vector
std::vector< G4VEnergyLossProcess * > loss_vector
void PreparePhysicsTable(const G4ParticleDefinition *aParticle, G4VEnergyLossProcess *p, G4bool theMaster)
void SetVerbose(G4int val)
void LocalPhysicsTables(const G4ParticleDefinition *aParticle, G4VEnergyLossProcess *p)
void SetDEDXBinning(G4int val)
void SetMaxEnergyForMuons(G4double val)
std::vector< PD > part_vector
void SetIntegral(G4bool val)
void SetLossFluctuations(G4bool val)
std::vector< G4bool > isActive
G4VAtomDeexcitation * AtomDeexcitation()
std::vector< G4VEmProcess * > emp_vector
double G4double
Definition: G4Types.hh:76
std::vector< PD > base_part_vector
G4double MaxKinEnergy() const
G4double GetRange(const G4ParticleDefinition *aParticle, G4double kineticEnergy, const G4MaterialCutsCouple *couple)
std::vector< G4VMultipleScattering * > msc_vector
void SetAtomDeexcitation(G4VAtomDeexcitation *)
G4EnergyLossMessenger * theMessenger
void SetSplineFlag(G4bool val)
const std::vector< G4VMultipleScattering * > & GetMultipleScatteringVector()
std::vector< G4bool > tables_are_built