ECCE @ EIC Software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
G4ElectronIonPair.hh
Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file G4ElectronIonPair.hh
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 #ifndef G4ElectronIonPair_h
29 #define G4ElectronIonPair_h 1
30 
31 // -------------------------------------------------------------
32 //
33 // GEANT4 Class header file
34 //
35 //
36 // File name: G4ElectronIonPair
37 //
38 // Author: Vladimir Ivanchenko
39 //
40 // Creation date: 08.07.2008
41 //
42 // Modifications:
43 //
44 //
45 // Class Description:
46 // Compution on number of electon-ion or electorn-hole pairs
47 // at the step of a particle and sampling ionisation points
48 // in space
49 //
50 // Based on ICRU Report 31, 1979
51 // "Average Energy Required to Produce an Ion Pair"
52 //
53 // 06.04.2010 V. Grichine, substitute Gauss by Gamma for ionisation
54 // distribution at fixed energy deposition
55 //
56 // -------------------------------------------------------------
57 
58 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
59 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
60 
61 #include "globals.hh"
62 #include "G4Step.hh"
63 #include "G4ParticleDefinition.hh"
64 #include "G4ThreeVector.hh"
65 #include "G4VProcess.hh"
66 #include "Randomize.hh"
67 #include <vector>
68 
69 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
70 
71 class G4Material;
72 
74 {
75 public:
76 
77  explicit G4ElectronIonPair(G4int verb);
78 
79  virtual ~G4ElectronIonPair();
80 
81  // compute mean number of ionisation points at a step
83  const G4Material*,
84  G4double edepTotal,
85  G4double edepNIEL = 0.0);
86 
88 
90 
91  // returns pointer to the new vector of positions of
92  // ionisation points in the World coordinate system
93  std::vector<G4ThreeVector>* SampleIonsAlongStep(const G4Step*);
94 
95  // compute number of holes in the atom after PostStep interaction
97  const G4TrackVector* secondary = nullptr,
98  G4int processSubType = -1) const;
99 
100  inline G4int ResidualeChargePostStep(const G4Step*) const;
101 
102  // find mean energies per ionisation
104 
105  // dump mean energies per ionisation used in run time
106  void DumpMeanEnergyPerIonPair() const;
107 
108  // dump G4 list
109  void DumpG4MeanEnergyPerIonPair() const;
110 
111  inline void SetVerbose(G4int);
112 
113 private:
114 
115  void Initialise();
116 
118 
119  // hide assignment operator
121  G4ElectronIonPair(const G4ElectronIonPair&) = delete;
122 
123  // cache
126 
128 
131 
132  // list of G4 NIST materials with mean energy per ion defined
133  std::vector<G4double> g4MatData;
134  std::vector<G4String> g4MatNames;
135 };
136 
137 inline G4double
139 {
141  step->GetPreStepPoint()->GetMaterial(),
142  step->GetTotalEnergyDeposit(),
144 }
145 
146 inline G4int
148 {
149  // use gamma distribution with mean value n=meanion and
150  // dispersion D=meanion/invFanoFactor
151  G4double meanion = MeanNumberOfIonsAlongStep(step);
152  return G4lrint(G4RandGamma::shoot(meanion*invFanoFactor,invFanoFactor));
153 }
154 
155 inline G4int
157 {
158  G4int subtype = -1;
159  const G4VProcess* proc = step->GetPostStepPoint()->GetProcessDefinedStep();
160  if(proc) { subtype = proc->GetProcessSubType(); }
162  step->GetSecondary(),
163  subtype);
164 }
165 
167 {
168  verbose = val;
169 }
170 
171 #endif
172