Geant4 Cross Reference

Cross-Referencing   Geant4
Geant4/processes/electromagnetic/utils/include/G4ElectronIonPair.hh

Version: [ ReleaseNotes ] [ 1.0 ] [ 1.1 ] [ 2.0 ] [ 3.0 ] [ 3.1 ] [ 3.2 ] [ 4.0 ] [ 4.0.p1 ] [ 4.0.p2 ] [ 4.1 ] [ 4.1.p1 ] [ 5.0 ] [ 5.0.p1 ] [ 5.1 ] [ 5.1.p1 ] [ 5.2 ] [ 5.2.p1 ] [ 5.2.p2 ] [ 6.0 ] [ 6.0.p1 ] [ 6.1 ] [ 6.2 ] [ 6.2.p1 ] [ 6.2.p2 ] [ 7.0 ] [ 7.0.p1 ] [ 7.1 ] [ 7.1.p1 ] [ 8.0 ] [ 8.0.p1 ] [ 8.1 ] [ 8.1.p1 ] [ 8.1.p2 ] [ 8.2 ] [ 8.2.p1 ] [ 8.3 ] [ 8.3.p1 ] [ 8.3.p2 ] [ 9.0 ] [ 9.0.p1 ] [ 9.0.p2 ] [ 9.1 ] [ 9.1.p1 ] [ 9.1.p2 ] [ 9.1.p3 ] [ 9.2 ] [ 9.2.p1 ] [ 9.2.p2 ] [ 9.2.p3 ] [ 9.2.p4 ] [ 9.3 ] [ 9.3.p1 ] [ 9.3.p2 ] [ 9.4 ] [ 9.4.p1 ] [ 9.4.p2 ] [ 9.4.p3 ] [ 9.4.p4 ] [ 9.5 ] [ 9.5.p1 ] [ 9.5.p2 ] [ 9.6 ] [ 9.6.p1 ] [ 9.6.p2 ] [ 9.6.p3 ] [ 9.6.p4 ] [ 10.0 ] [ 10.0.p1 ] [ 10.0.p2 ] [ 10.0.p3 ] [ 10.0.p4 ] [ 10.1 ] [ 10.1.p1 ] [ 10.1.p2 ] [ 10.1.p3 ] [ 10.2 ] [ 10.2.p1 ] [ 10.2.p2 ] [ 10.2.p3 ] [ 10.3 ] [ 10.3.p1 ] [ 10.3.p2 ] [ 10.3.p3 ] [ 10.4 ] [ 10.4.p1 ] [ 10.4.p2 ] [ 10.4.p3 ] [ 10.5 ] [ 10.5.p1 ] [ 10.6 ] [ 10.6.p1 ] [ 10.6.p2 ] [ 10.6.p3 ] [ 10.7 ] [ 10.7.p1 ] [ 10.7.p2 ] [ 10.7.p3 ] [ 10.7.p4 ] [ 11.0 ] [ 11.0.p1 ] [ 11.0.p2 ] [ 11.0.p3, ] [ 11.0.p4 ] [ 11.1 ] [ 11.1.1 ] [ 11.1.2 ] [ 11.1.3 ] [ 11.2 ] [ 11.2.1 ] [ 11.2.2 ] [ 11.3.0 ]

Diff markup

Differences between /processes/electromagnetic/utils/include/G4ElectronIonPair.hh (Version 11.3.0) and /processes/electromagnetic/utils/include/G4ElectronIonPair.hh (Version 10.5.p1)


  1 //                                                  1 //
  2 // *******************************************      2 // ********************************************************************
  3 // * License and Disclaimer                         3 // * License and Disclaimer                                           *
  4 // *                                                4 // *                                                                  *
  5 // * The  Geant4 software  is  copyright of th      5 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
  6 // * the Geant4 Collaboration.  It is provided      6 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
  7 // * conditions of the Geant4 Software License      7 // * conditions of the Geant4 Software License,  included in the file *
  8 // * LICENSE and available at  http://cern.ch/      8 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
  9 // * include a list of copyright holders.           9 // * include a list of copyright holders.                             *
 10 // *                                               10 // *                                                                  *
 11 // * Neither the authors of this software syst     11 // * Neither the authors of this software system, nor their employing *
 12 // * institutes,nor the agencies providing fin     12 // * institutes,nor the agencies providing financial support for this *
 13 // * work  make  any representation or  warran     13 // * work  make  any representation or  warranty, express or implied, *
 14 // * regarding  this  software system or assum     14 // * regarding  this  software system or assume any liability for its *
 15 // * use.  Please see the license in the file      15 // * use.  Please see the license in the file  LICENSE  and URL above *
 16 // * for the full disclaimer and the limitatio     16 // * for the full disclaimer and the limitation of liability.         *
 17 // *                                               17 // *                                                                  *
 18 // * This  code  implementation is the result      18 // * This  code  implementation is the result of  the  scientific and *
 19 // * technical work of the GEANT4 collaboratio     19 // * technical work of the GEANT4 collaboration.                      *
 20 // * By using,  copying,  modifying or  distri     20 // * By using,  copying,  modifying or  distributing the software (or *
 21 // * any work based  on the software)  you  ag     21 // * any work based  on the software)  you  agree  to acknowledge its *
 22 // * use  in  resulting  scientific  publicati     22 // * use  in  resulting  scientific  publications,  and indicate your *
 23 // * acceptance of all terms of the Geant4 Sof     23 // * acceptance of all terms of the Geant4 Software license.          *
 24 // *******************************************     24 // ********************************************************************
 25 //                                                 25 //
                                                   >>  26 //
                                                   >>  27 //
 26 #ifndef G4ElectronIonPair_h                        28 #ifndef G4ElectronIonPair_h
 27 #define G4ElectronIonPair_h 1                      29 #define G4ElectronIonPair_h 1
 28                                                    30 
 29 // -------------------------------------------     31 // -------------------------------------------------------------
 30 //                                                 32 //
 31 // GEANT4 Class header file                        33 // GEANT4 Class header file
 32 //                                                 34 //
 33 //                                                 35 //
 34 // File name:     G4ElectronIonPair                36 // File name:     G4ElectronIonPair
 35 //                                                 37 //
 36 // Author:        Vladimir Ivanchenko              38 // Author:        Vladimir Ivanchenko
 37 //                                                 39 //
 38 // Creation date: 08.07.2008                       40 // Creation date: 08.07.2008
 39 //                                                 41 //
 40 // Modifications:                                  42 // Modifications:
 41 //                                                 43 //
 42 //                                                 44 //
 43 // Class Description:                              45 // Class Description:
 44 //   Compution on number of electon-ion or ele     46 //   Compution on number of electon-ion or electorn-hole pairs
 45 //   at the step of a particle and sampling io     47 //   at the step of a particle and sampling ionisation points 
 46 //   in space                                      48 //   in space
 47 //                                                 49 //
 48 // Based on ICRU Report 31, 1979                   50 // Based on ICRU Report 31, 1979
 49 // "Average Energy Required to Produce an Ion      51 // "Average Energy Required to Produce an Ion Pair" 
 50 //                                                 52 //
 51 // 06.04.2010 V. Grichine, substitute Gauss by     53 // 06.04.2010 V. Grichine, substitute Gauss by Gamma for ionisation 
 52 //                         distribution at fix     54 //                         distribution at fixed energy deposition
 53 //                                                 55 // 
 54 // -------------------------------------------     56 // -------------------------------------------------------------
 55                                                    57 
 56 //....oooOO0OOooo........oooOO0OOooo........oo     58 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
 57 //....oooOO0OOooo........oooOO0OOooo........oo     59 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
 58                                                    60 
 59 #include "globals.hh"                              61 #include "globals.hh"
 60 #include "G4Step.hh"                               62 #include "G4Step.hh"
 61 #include "G4ParticleDefinition.hh"                 63 #include "G4ParticleDefinition.hh"
 62 #include "G4ThreeVector.hh"                        64 #include "G4ThreeVector.hh"
 63 #include "G4VProcess.hh"                           65 #include "G4VProcess.hh"
 64 #include "Randomize.hh"                            66 #include "Randomize.hh"
 65 #include <vector>                                  67 #include <vector>
 66                                                    68 
 67 //....oooOO0OOooo........oooOO0OOooo........oo     69 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
 68                                                    70 
 69 class G4Material;                                  71 class G4Material;
 70                                                    72 
 71 class G4ElectronIonPair                            73 class G4ElectronIonPair
 72 {                                                  74 {
 73 public:                                            75 public: 
 74                                                    76 
 75   explicit G4ElectronIonPair(G4int verb);          77   explicit G4ElectronIonPair(G4int verb);
 76                                                    78 
 77   virtual ~G4ElectronIonPair();                    79   virtual ~G4ElectronIonPair();
 78                                                    80 
 79   // compute mean number of ionisation points      81   // compute mean number of ionisation points at a step
 80   G4double MeanNumberOfIonsAlongStep(const G4P     82   G4double MeanNumberOfIonsAlongStep(const G4ParticleDefinition*, 
 81              const G4Material*,                    83              const G4Material*,
 82              G4double edepTotal,                   84              G4double edepTotal,
 83              G4double edepNIEL = 0.0);             85              G4double edepNIEL = 0.0);
 84                                                    86 
 85   inline G4double MeanNumberOfIonsAlongStep(co     87   inline G4double MeanNumberOfIonsAlongStep(const G4Step*); 
 86                                                    88 
 87   inline G4int SampleNumberOfIonsAlongStep(con     89   inline G4int SampleNumberOfIonsAlongStep(const G4Step*); 
 88                                                    90 
 89   // returns pointer to the new vector of posi     91   // returns pointer to the new vector of positions of
 90   // ionisation points in the World coordinate     92   // ionisation points in the World coordinate system 
 91   std::vector<G4ThreeVector>* SampleIonsAlongS     93   std::vector<G4ThreeVector>* SampleIonsAlongStep(const G4Step*);
 92                                                    94 
 93   // compute number of holes in the atom after     95   // compute number of holes in the atom after PostStep interaction
 94   G4int ResidualeChargePostStep(const G4Partic     96   G4int ResidualeChargePostStep(const G4ParticleDefinition*,
 95         const G4TrackVector* secondary = nullp     97         const G4TrackVector* secondary = nullptr,
 96         G4int processSubType = -1) const;          98         G4int processSubType = -1) const;
 97                                                    99 
 98   inline G4int ResidualeChargePostStep(const G    100   inline G4int ResidualeChargePostStep(const G4Step*) const;
 99                                                   101 
100   // find mean energies per ionisation            102   // find mean energies per ionisation 
101   G4double FindG4MeanEnergyPerIonPair(const G4    103   G4double FindG4MeanEnergyPerIonPair(const G4Material*) const;
102                                                   104 
103   // dump mean energies per ionisation used in    105   // dump mean energies per ionisation used in run time
104   void DumpMeanEnergyPerIonPair() const;          106   void DumpMeanEnergyPerIonPair() const;
105                                                   107 
106   // dump G4 list                                 108   // dump G4 list
107   void DumpG4MeanEnergyPerIonPair() const;        109   void DumpG4MeanEnergyPerIonPair() const;
108                                                   110 
109   inline void SetVerbose(G4int);                  111   inline void SetVerbose(G4int);
110                                                   112 
111   // hide assignment operator                  << 
112   G4ElectronIonPair & operator=(const G4Electr << 
113   G4ElectronIonPair(const G4ElectronIonPair&)  << 
114                                                << 
115 private:                                          113 private:
116                                                   114 
117   void Initialise();                              115   void Initialise();
118                                                   116 
119   G4double FindMeanEnergyPerIonPair(const G4Ma    117   G4double FindMeanEnergyPerIonPair(const G4Material*) const;
                                                   >> 118 
                                                   >> 119   // hide assignment operator
                                                   >> 120   G4ElectronIonPair & operator=(const G4ElectronIonPair &right) = delete;
                                                   >> 121   G4ElectronIonPair(const G4ElectronIonPair&) = delete;
120                                                   122 
121   // cache                                        123   // cache
122   const G4Material*  curMaterial;                 124   const G4Material*  curMaterial;
123   G4double           curMeanEnergy;               125   G4double           curMeanEnergy;
124                                                   126 
125   G4double invFanoFactor;                         127   G4double invFanoFactor;
126                                                   128   
127   G4int    verbose;                               129   G4int    verbose;             
128   G4int    nMaterials;                            130   G4int    nMaterials;
129                                                   131 
130   // list of G4 NIST materials with mean energ    132   // list of G4 NIST materials with mean energy per ion defined 
131   std::vector<G4double>  g4MatData;               133   std::vector<G4double>  g4MatData;
132   std::vector<G4String>  g4MatNames;              134   std::vector<G4String>  g4MatNames;
133 };                                                135 };
134                                                   136 
135 inline G4double                                   137 inline G4double 
136 G4ElectronIonPair::MeanNumberOfIonsAlongStep(c    138 G4ElectronIonPair::MeanNumberOfIonsAlongStep(const G4Step* step) 
137 {                                                 139 {
138   return MeanNumberOfIonsAlongStep(step->GetTr    140   return MeanNumberOfIonsAlongStep(step->GetTrack()->GetParticleDefinition(),
139            step->GetPreStepPoint()->GetMateria    141            step->GetPreStepPoint()->GetMaterial(),
140            step->GetTotalEnergyDeposit(),         142            step->GetTotalEnergyDeposit(),
141            step->GetNonIonizingEnergyDeposit()    143            step->GetNonIonizingEnergyDeposit());
142 }                                                 144 }
143                                                   145 
144 inline G4int                                      146 inline G4int 
145 G4ElectronIonPair::SampleNumberOfIonsAlongStep    147 G4ElectronIonPair::SampleNumberOfIonsAlongStep(const G4Step* step) 
146 {                                                 148 {
147   // use gamma distribution with mean value n=    149   // use gamma distribution with mean value n=meanion and 
148   // dispersion D=meanion/invFanoFactor           150   // dispersion D=meanion/invFanoFactor
149   G4double meanion = MeanNumberOfIonsAlongStep    151   G4double meanion = MeanNumberOfIonsAlongStep(step);
150   return G4lrint(G4RandGamma::shoot(meanion*in    152   return G4lrint(G4RandGamma::shoot(meanion*invFanoFactor,invFanoFactor));
151 }                                                 153 } 
152                                                   154 
153 inline G4int                                      155 inline G4int 
154 G4ElectronIonPair::ResidualeChargePostStep(con    156 G4ElectronIonPair::ResidualeChargePostStep(const G4Step* step) const
155 {                                                 157 {
156   G4int subtype = -1;                             158   G4int subtype = -1;
157   const G4VProcess* proc = step->GetPostStepPo    159   const G4VProcess* proc = step->GetPostStepPoint()->GetProcessDefinedStep();
158   if(proc) { subtype = proc->GetProcessSubType    160   if(proc) { subtype = proc->GetProcessSubType(); }
159   return ResidualeChargePostStep(step->GetTrac    161   return ResidualeChargePostStep(step->GetTrack()->GetParticleDefinition(),
160          step->GetSecondary(),                    162          step->GetSecondary(),
161          subtype);                                163          subtype);
162 }                                                 164 }
163                                                   165 
164 inline void G4ElectronIonPair::SetVerbose(G4in    166 inline void G4ElectronIonPair::SetVerbose(G4int val)
165 {                                                 167 {
166   verbose = val;                                  168   verbose = val;
167 }                                                 169 }
168                                                   170 
169 #endif                                            171 #endif
170                                                   172 
171                                                   173