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.4.p3)


  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 // $Id$
                                                   >>  27 //
                                                   >>  28 //
 26 #ifndef G4ElectronIonPair_h                        29 #ifndef G4ElectronIonPair_h
 27 #define G4ElectronIonPair_h 1                      30 #define G4ElectronIonPair_h 1
 28                                                    31 
 29 // -------------------------------------------     32 // -------------------------------------------------------------
 30 //                                                 33 //
 31 // GEANT4 Class header file                        34 // GEANT4 Class header file
 32 //                                                 35 //
 33 //                                                 36 //
 34 // File name:     G4ElectronIonPair                37 // File name:     G4ElectronIonPair
 35 //                                                 38 //
 36 // Author:        Vladimir Ivanchenko              39 // Author:        Vladimir Ivanchenko
 37 //                                                 40 //
 38 // Creation date: 08.07.2008                       41 // Creation date: 08.07.2008
 39 //                                                 42 //
 40 // Modifications:                                  43 // Modifications:
 41 //                                                 44 //
 42 //                                                 45 //
 43 // Class Description:                              46 // Class Description:
 44 //   Compution on number of electon-ion or ele     47 //   Compution on number of electon-ion or electorn-hole pairs
 45 //   at the step of a particle and sampling io     48 //   at the step of a particle and sampling ionisation points 
 46 //   in space                                      49 //   in space
 47 //                                                 50 //
 48 // Based on ICRU Report 31, 1979                   51 // Based on ICRU Report 31, 1979
 49 // "Average Energy Required to Produce an Ion      52 // "Average Energy Required to Produce an Ion Pair" 
 50 //                                                 53 //
 51 // 06.04.2010 V. Grichine, substitute Gauss by     54 // 06.04.2010 V. Grichine, substitute Gauss by Gamma for ionisation 
 52 //                         distribution at fix     55 //                         distribution at fixed energy deposition
 53 //                                                 56 // 
 54 // -------------------------------------------     57 // -------------------------------------------------------------
 55                                                    58 
 56 //....oooOO0OOooo........oooOO0OOooo........oo     59 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
 57 //....oooOO0OOooo........oooOO0OOooo........oo     60 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
 58                                                    61 
 59 #include "globals.hh"                              62 #include "globals.hh"
 60 #include "G4Step.hh"                               63 #include "G4Step.hh"
 61 #include "G4ParticleDefinition.hh"                 64 #include "G4ParticleDefinition.hh"
 62 #include "G4ThreeVector.hh"                        65 #include "G4ThreeVector.hh"
 63 #include "G4VProcess.hh"                           66 #include "G4VProcess.hh"
 64 #include "Randomize.hh"                            67 #include "Randomize.hh"
 65 #include <vector>                                  68 #include <vector>
 66                                                    69 
 67 //....oooOO0OOooo........oooOO0OOooo........oo     70 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
 68                                                    71 
 69 class G4Material;                                  72 class G4Material;
 70                                                    73 
 71 class G4ElectronIonPair                            74 class G4ElectronIonPair
 72 {                                                  75 {
 73 public:                                            76 public: 
 74                                                    77 
 75   explicit G4ElectronIonPair(G4int verb);          78   explicit G4ElectronIonPair(G4int verb);
 76                                                    79 
 77   virtual ~G4ElectronIonPair();                    80   virtual ~G4ElectronIonPair();
 78                                                    81 
 79   // compute mean number of ionisation points      82   // compute mean number of ionisation points at a step
 80   G4double MeanNumberOfIonsAlongStep(const G4P     83   G4double MeanNumberOfIonsAlongStep(const G4ParticleDefinition*, 
 81              const G4Material*,                    84              const G4Material*,
 82              G4double edepTotal,                   85              G4double edepTotal,
 83              G4double edepNIEL = 0.0);             86              G4double edepNIEL = 0.0);
 84                                                    87 
 85   inline G4double MeanNumberOfIonsAlongStep(co     88   inline G4double MeanNumberOfIonsAlongStep(const G4Step*); 
 86                                                    89 
 87   inline G4int SampleNumberOfIonsAlongStep(con     90   inline G4int SampleNumberOfIonsAlongStep(const G4Step*); 
 88                                                    91 
 89   // returns pointer to the new vector of posi     92   // returns pointer to the new vector of positions of
 90   // ionisation points in the World coordinate     93   // ionisation points in the World coordinate system 
 91   std::vector<G4ThreeVector>* SampleIonsAlongS     94   std::vector<G4ThreeVector>* SampleIonsAlongStep(const G4Step*);
 92                                                    95 
 93   // compute number of holes in the atom after     96   // compute number of holes in the atom after PostStep interaction
 94   G4int ResidualeChargePostStep(const G4Partic     97   G4int ResidualeChargePostStep(const G4ParticleDefinition*,
 95         const G4TrackVector* secondary = nullp     98         const G4TrackVector* secondary = nullptr,
 96         G4int processSubType = -1) const;          99         G4int processSubType = -1) const;
 97                                                   100 
 98   inline G4int ResidualeChargePostStep(const G    101   inline G4int ResidualeChargePostStep(const G4Step*) const;
 99                                                   102 
100   // find mean energies per ionisation            103   // find mean energies per ionisation 
101   G4double FindG4MeanEnergyPerIonPair(const G4    104   G4double FindG4MeanEnergyPerIonPair(const G4Material*) const;
102                                                   105 
103   // dump mean energies per ionisation used in    106   // dump mean energies per ionisation used in run time
104   void DumpMeanEnergyPerIonPair() const;          107   void DumpMeanEnergyPerIonPair() const;
105                                                   108 
106   // dump G4 list                                 109   // dump G4 list
107   void DumpG4MeanEnergyPerIonPair() const;        110   void DumpG4MeanEnergyPerIonPair() const;
108                                                   111 
109   inline void SetVerbose(G4int);                  112   inline void SetVerbose(G4int);
110                                                   113 
111   // hide assignment operator                  << 
112   G4ElectronIonPair & operator=(const G4Electr << 
113   G4ElectronIonPair(const G4ElectronIonPair&)  << 
114                                                << 
115 private:                                          114 private:
116                                                   115 
117   void Initialise();                              116   void Initialise();
118                                                   117 
119   G4double FindMeanEnergyPerIonPair(const G4Ma    118   G4double FindMeanEnergyPerIonPair(const G4Material*) const;
                                                   >> 119 
                                                   >> 120   // hide assignment operator
                                                   >> 121   G4ElectronIonPair & operator=(const G4ElectronIonPair &right) = delete;
                                                   >> 122   G4ElectronIonPair(const G4ElectronIonPair&) = delete;
120                                                   123 
121   // cache                                        124   // cache
122   const G4Material*  curMaterial;                 125   const G4Material*  curMaterial;
123   G4double           curMeanEnergy;               126   G4double           curMeanEnergy;
124                                                   127 
125   G4double invFanoFactor;                         128   G4double invFanoFactor;
126                                                   129   
127   G4int    verbose;                               130   G4int    verbose;             
128   G4int    nMaterials;                            131   G4int    nMaterials;
129                                                   132 
130   // list of G4 NIST materials with mean energ    133   // list of G4 NIST materials with mean energy per ion defined 
131   std::vector<G4double>  g4MatData;               134   std::vector<G4double>  g4MatData;
132   std::vector<G4String>  g4MatNames;              135   std::vector<G4String>  g4MatNames;
133 };                                                136 };
134                                                   137 
135 inline G4double                                   138 inline G4double 
136 G4ElectronIonPair::MeanNumberOfIonsAlongStep(c    139 G4ElectronIonPair::MeanNumberOfIonsAlongStep(const G4Step* step) 
137 {                                                 140 {
138   return MeanNumberOfIonsAlongStep(step->GetTr    141   return MeanNumberOfIonsAlongStep(step->GetTrack()->GetParticleDefinition(),
139            step->GetPreStepPoint()->GetMateria    142            step->GetPreStepPoint()->GetMaterial(),
140            step->GetTotalEnergyDeposit(),         143            step->GetTotalEnergyDeposit(),
141            step->GetNonIonizingEnergyDeposit()    144            step->GetNonIonizingEnergyDeposit());
142 }                                                 145 }
143                                                   146 
144 inline G4int                                      147 inline G4int 
145 G4ElectronIonPair::SampleNumberOfIonsAlongStep    148 G4ElectronIonPair::SampleNumberOfIonsAlongStep(const G4Step* step) 
146 {                                                 149 {
147   // use gamma distribution with mean value n=    150   // use gamma distribution with mean value n=meanion and 
148   // dispersion D=meanion/invFanoFactor           151   // dispersion D=meanion/invFanoFactor
149   G4double meanion = MeanNumberOfIonsAlongStep    152   G4double meanion = MeanNumberOfIonsAlongStep(step);
150   return G4lrint(G4RandGamma::shoot(meanion*in    153   return G4lrint(G4RandGamma::shoot(meanion*invFanoFactor,invFanoFactor));
151 }                                                 154 } 
152                                                   155 
153 inline G4int                                      156 inline G4int 
154 G4ElectronIonPair::ResidualeChargePostStep(con    157 G4ElectronIonPair::ResidualeChargePostStep(const G4Step* step) const
155 {                                                 158 {
156   G4int subtype = -1;                             159   G4int subtype = -1;
157   const G4VProcess* proc = step->GetPostStepPo    160   const G4VProcess* proc = step->GetPostStepPoint()->GetProcessDefinedStep();
158   if(proc) { subtype = proc->GetProcessSubType    161   if(proc) { subtype = proc->GetProcessSubType(); }
159   return ResidualeChargePostStep(step->GetTrac    162   return ResidualeChargePostStep(step->GetTrack()->GetParticleDefinition(),
160          step->GetSecondary(),                    163          step->GetSecondary(),
161          subtype);                                164          subtype);
162 }                                                 165 }
163                                                   166 
164 inline void G4ElectronIonPair::SetVerbose(G4in    167 inline void G4ElectronIonPair::SetVerbose(G4int val)
165 {                                                 168 {
166   verbose = val;                                  169   verbose = val;
167 }                                                 170 }
168                                                   171 
169 #endif                                            172 #endif
170                                                   173 
171                                                   174