Geant4  10.00.p01
G4ElectronIonPair.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: G4ElectronIonPair.hh 69580 2013-05-08 13:57:53Z gcosmo $
27 //
28 //
29 #ifndef G4ElectronIonPair_h
30 #define G4ElectronIonPair_h 1
31 
32 // -------------------------------------------------------------
33 //
34 // GEANT4 Class header file
35 //
36 //
37 // File name: G4ElectronIonPair
38 //
39 // Author: Vladimir Ivanchenko
40 //
41 // Creation date: 08.07.2008
42 //
43 // Modifications:
44 //
45 //
46 // Class Description:
47 // Compution on number of electon-ion or electorn-hole pairs
48 // at the step of a particle and sampling ionisation points
49 // in space
50 //
51 // Based on ICRU Report 31, 1979
52 // "Average Energy Required to Produce an Ion Pair"
53 //
54 // 06.04.2010 V. Grichine, substitute Gauss by Gamma for ionisation
55 // distribution at fixed energy deposition
56 //
57 // -------------------------------------------------------------
58 
59 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
60 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
61 
62 #include "globals.hh"
63 #include "G4Step.hh"
64 #include "G4ParticleDefinition.hh"
65 #include "G4ThreeVector.hh"
66 #include "G4VProcess.hh"
67 #include "Randomize.hh"
68 #include <vector>
69 
70 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
71 
72 class G4Material;
73 
75 {
76 public:
77 
79 
80  virtual ~G4ElectronIonPair();
81 
82  // compute mean number of ionisation points at a step
84  const G4Material*,
85  G4double edepTotal,
86  G4double edepNIEL = 0.0);
87 
89 
91 
92  // returns pointer to the new vector of positions of
93  // ionisation points in the World coordinate system
94  std::vector<G4ThreeVector>* SampleIonsAlongStep(const G4Step*);
95 
96  // compute number of holes in the atom after PostStep interaction
98  const G4TrackVector* secondary = 0,
99  G4int processSubType = -1);
100 
101  inline G4int ResidualeChargePostStep(const G4Step*);
102 
103  // find mean energies per ionisation
105 
106  // dump mean energies per ionisation used in run time
108 
109  // dump G4 list
111 
112  inline void SetVerbose(G4int);
113 
114 private:
115 
116  void Initialise();
117 
119 
120  // hide assignment operator
123 
124  // cash
127 
129 
132 
133  // list of G4 NIST materials with mean energy per ion defined
134  std::vector<G4double> g4MatData;
135  std::vector<G4String> g4MatNames;
136 };
137 
138 inline G4double
140 {
142  step->GetPreStepPoint()->GetMaterial(),
143  step->GetTotalEnergyDeposit(),
145 }
146 
147 inline
149 {
150  // use gamma distribution with mean value n=meanion and
151  // dispersion D=meanion/invFanoFactor
152  G4double meanion = MeanNumberOfIonsAlongStep(step);
153  return G4lrint(G4RandGamma::shoot(meanion*invFanoFactor,invFanoFactor));
154 }
155 
156 inline
158 {
159  G4int subtype = -1;
160  const G4VProcess* proc = step->GetPostStepPoint()->GetProcessDefinedStep();
161  if(proc) { subtype = proc->GetProcessSubType(); }
163  step->GetSecondary(),
164  subtype);
165 }
166 
168 {
169  verbose = val;
170 }
171 
172 #endif
173 
ThreeVector shoot(const G4int Ap, const G4int Af)
G4double MeanNumberOfIonsAlongStep(const G4ParticleDefinition *, const G4Material *, G4double edepTotal, G4double edepNIEL=0.0)
virtual ~G4ElectronIonPair()
G4ElectronIonPair & operator=(const G4ElectronIonPair &right)
const G4Material * curMaterial
G4Material * GetMaterial() const
G4double GetNonIonizingEnergyDeposit() const
G4int ResidualeChargePostStep(const G4ParticleDefinition *, const G4TrackVector *secondary=0, G4int processSubType=-1)
G4double FindG4MeanEnergyPerIonPair(const G4Material *)
int G4int
Definition: G4Types.hh:78
G4StepPoint * GetPreStepPoint() const
std::vector< G4double > g4MatData
G4int SampleNumberOfIonsAlongStep(const G4Step *)
const G4ParticleDefinition * GetParticleDefinition() const
std::vector< G4String > g4MatNames
Definition: G4Step.hh:76
G4double GetTotalEnergyDeposit() const
G4double FindMeanEnergyPerIonPair(const G4Material *)
const G4VProcess * GetProcessDefinedStep() const
std::vector< G4Track * > G4TrackVector
int G4lrint(double ad)
Definition: templates.hh:163
G4StepPoint * GetPostStepPoint() const
std::vector< G4ThreeVector > * SampleIonsAlongStep(const G4Step *)
double G4double
Definition: G4Types.hh:76
G4Track * GetTrack() const
G4int GetProcessSubType() const
Definition: G4VProcess.hh:426
const G4TrackVector * GetSecondary() const