| Geant4 Cross Reference |
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 // 26 //
27 // ------------------------------------------- 27 // -------------------------------------------------------------------
28 // 28 //
29 // GEANT4 Class file 29 // GEANT4 Class file
30 // 30 //
31 // 31 //
32 // File name: G4EmSaturation 32 // File name: G4EmSaturation
33 // 33 //
34 // Author: Vladimir Ivanchenko 34 // Author: Vladimir Ivanchenko
35 // 35 //
36 // Creation date: 18.02.2008 36 // Creation date: 18.02.2008
37 // 37 //
38 // Modifications: 38 // Modifications:
39 // 39 //
40 // ------------------------------------------- 40 // -------------------------------------------------------------
41 41
42 //....oooOO0OOooo........oooOO0OOooo........oo 42 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
43 //....oooOO0OOooo........oooOO0OOooo........oo 43 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
44 44
45 #include "G4EmSaturation.hh" 45 #include "G4EmSaturation.hh"
46 #include "G4PhysicalConstants.hh" 46 #include "G4PhysicalConstants.hh"
47 #include "G4SystemOfUnits.hh" 47 #include "G4SystemOfUnits.hh"
48 #include "G4LossTableManager.hh" 48 #include "G4LossTableManager.hh"
49 #include "G4NistManager.hh" 49 #include "G4NistManager.hh"
50 #include "G4Material.hh" 50 #include "G4Material.hh"
51 #include "G4MaterialCutsCouple.hh" 51 #include "G4MaterialCutsCouple.hh"
52 #include "G4ParticleTable.hh" 52 #include "G4ParticleTable.hh"
53 53
54 //....oooOO0OOooo........oooOO0OOooo........oo 54 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
55 55
56 std::size_t G4EmSaturation::nMaterials = 0; << 56 G4int G4EmSaturation::nMaterials = 0;
57 std::vector<G4double> G4EmSaturation::massFact 57 std::vector<G4double> G4EmSaturation::massFactors;
58 std::vector<G4double> G4EmSaturation::effCharg 58 std::vector<G4double> G4EmSaturation::effCharges;
59 std::vector<G4double> G4EmSaturation::g4MatDat 59 std::vector<G4double> G4EmSaturation::g4MatData;
60 std::vector<G4String> G4EmSaturation::g4MatNam 60 std::vector<G4String> G4EmSaturation::g4MatNames;
61 61
62 G4EmSaturation::G4EmSaturation(G4int verb) 62 G4EmSaturation::G4EmSaturation(G4int verb)
63 { 63 {
64 verbose = verb; 64 verbose = verb;
>> 65
65 nWarnings = nG4Birks = 0; 66 nWarnings = nG4Birks = 0;
66 67
67 electron = nullptr; 68 electron = nullptr;
68 proton = nullptr; 69 proton = nullptr;
69 nist = G4NistManager::Instance(); 70 nist = G4NistManager::Instance();
70 InitialiseG4Saturation(); <<
71 } 71 }
72 72
73 //....oooOO0OOooo........oooOO0OOooo........oo 73 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
74 74
75 G4EmSaturation::~G4EmSaturation() = default; << 75 G4EmSaturation::~G4EmSaturation()
>> 76 {}
76 77
77 //....oooOO0OOooo........oooOO0OOooo........oo 78 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
78 79
79 G4double G4EmSaturation::VisibleEnergyDepositi 80 G4double G4EmSaturation::VisibleEnergyDeposition(
80 const G4 81 const G4ParticleDefinition* p,
81 const G4 82 const G4MaterialCutsCouple* couple,
82 G4double 83 G4double length,
83 G4double 84 G4double edep,
84 G4double 85 G4double niel) const
85 { 86 {
86 // no energy deposition <<
87 if(edep <= 0.0) { return 0.0; } 87 if(edep <= 0.0) { return 0.0; }
88 88
89 // zero step length may happens only if step <<
90 // is applied, in that case saturation shoul <<
91 if(length <= 0.0) { return edep; } <<
92 <<
93 G4double evis = edep; 89 G4double evis = edep;
94 G4double bfactor = couple->GetMaterial()->Ge 90 G4double bfactor = couple->GetMaterial()->GetIonisation()->GetBirksConstant();
95 91
96 if(bfactor > 0.0) { 92 if(bfactor > 0.0) {
97 93
98 // atomic relaxations for gamma incident 94 // atomic relaxations for gamma incident
99 if(22 == p->GetPDGEncoding()) { 95 if(22 == p->GetPDGEncoding()) {
100 //G4cout << "%% gamma edep= " << edep/ke << 96 //G4cout << "%% gamma edep= " << edep/keV << " keV " <<manager << G4endl;
101 evis /= (1.0 + bfactor*edep/ 97 evis /= (1.0 + bfactor*edep/
102 G4LossTableManager::Instance()->GetRan 98 G4LossTableManager::Instance()->GetRange(electron,edep,couple));
103 99
104 // energy loss 100 // energy loss
105 } else { 101 } else {
106 102
107 // protections 103 // protections
108 G4double nloss = std::max(niel, 0.0); 104 G4double nloss = std::max(niel, 0.0);
109 G4double eloss = edep - nloss; 105 G4double eloss = edep - nloss;
110 106
111 // neutrons and neutral hadrons 107 // neutrons and neutral hadrons
112 if(0.0 == p->GetPDGCharge() || eloss < 0 << 108 if(0.0 == p->GetPDGCharge() || eloss < 0.0 || length <= 0.0) {
113 nloss = edep; 109 nloss = edep;
114 eloss = 0.0; 110 eloss = 0.0;
115 } else { 111 } else {
116 112
117 // continues energy loss 113 // continues energy loss
118 eloss /= (1.0 + bfactor*eloss/length); 114 eloss /= (1.0 + bfactor*eloss/length);
119 } 115 }
120 // non-ionizing energy loss 116 // non-ionizing energy loss
121 if(nloss > 0.0) { 117 if(nloss > 0.0) {
122 std::size_t idx = couple->GetMaterial( << 118 G4int idx = couple->GetMaterial()->GetIndex();
123 G4double escaled = nloss*massFactors[i 119 G4double escaled = nloss*massFactors[idx];
124 /* << 120 /*
125 G4cout << "%% p edep= " << nloss/keV < 121 G4cout << "%% p edep= " << nloss/keV << " keV Escaled= "
126 << escaled << " MeV in " << co 122 << escaled << " MeV in " << couple->GetMaterial()->GetName()
127 << " " << p->GetParticleName() << 123 << " " << p->GetParticleName()
128 << G4endl; << 124 << G4endl;
129 G4cout << proton->GetParticleName() << G4end << 125 */
130 */ <<
131 G4double range = G4LossTableManager::I 126 G4double range = G4LossTableManager::Instance()
132 ->GetRange(proton,escaled,couple)/ef 127 ->GetRange(proton,escaled,couple)/effCharges[idx];
133 nloss /= (1.0 + bfactor*nloss/range); 128 nloss /= (1.0 + bfactor*nloss/range);
134 } 129 }
135 evis = eloss + nloss; 130 evis = eloss + nloss;
136 } 131 }
137 } 132 }
138 return evis; 133 return evis;
139 } 134 }
140 135
141 //....oooOO0OOooo........oooOO0OOooo........oo 136 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
142 137
143 void G4EmSaturation::InitialiseG4Saturation() 138 void G4EmSaturation::InitialiseG4Saturation()
144 { 139 {
145 if(nMaterials == G4Material::GetNumberOfMate <<
146 nMaterials = G4Material::GetNumberOfMaterial 140 nMaterials = G4Material::GetNumberOfMaterials();
147 massFactors.resize(nMaterials, 1.0); 141 massFactors.resize(nMaterials, 1.0);
148 effCharges.resize(nMaterials, 1.0); 142 effCharges.resize(nMaterials, 1.0);
149 143
150 if(0 == nG4Birks) { InitialiseG4materials() 144 if(0 == nG4Birks) { InitialiseG4materials(); }
151 145
152 for(std::size_t i=0; i<nMaterials; ++i) { << 146 for(G4int i=0; i<nMaterials; ++i) {
153 InitialiseBirksCoefficient((*G4Material::G 147 InitialiseBirksCoefficient((*G4Material::GetMaterialTable())[i]);
154 } 148 }
155 if(verbose > 0) { DumpBirksCoefficients(); } 149 if(verbose > 0) { DumpBirksCoefficients(); }
156 } 150 }
157 151
158 //....oooOO0OOooo........oooOO0OOooo........oo 152 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
159 153
160 G4double G4EmSaturation::FindG4BirksCoefficien 154 G4double G4EmSaturation::FindG4BirksCoefficient(const G4Material* mat)
161 { 155 {
162 if(0 == nG4Birks) { InitialiseG4materials() 156 if(0 == nG4Birks) { InitialiseG4materials(); }
163 157
164 G4String name = mat->GetName(); 158 G4String name = mat->GetName();
165 // is this material in the vector? 159 // is this material in the vector?
166 160
167 for(G4int j=0; j<nG4Birks; ++j) { 161 for(G4int j=0; j<nG4Birks; ++j) {
168 if(name == g4MatNames[j]) { 162 if(name == g4MatNames[j]) {
169 if(verbose > 0) 163 if(verbose > 0)
170 G4cout << "### G4EmSaturation::FindG4B 164 G4cout << "### G4EmSaturation::FindG4BirksCoefficient for "
171 << name << " is " << g4MatData[ 165 << name << " is " << g4MatData[j]*MeV/mm << " mm/MeV "
172 << G4endl; 166 << G4endl;
173 return g4MatData[j]; 167 return g4MatData[j];
174 } 168 }
175 } 169 }
176 return 0.0; 170 return 0.0;
177 } 171 }
178 172
179 //....oooOO0OOooo........oooOO0OOooo........oo 173 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
180 174
181 void G4EmSaturation::InitialiseBirksCoefficien 175 void G4EmSaturation::InitialiseBirksCoefficient(const G4Material* mat)
182 { 176 {
183 // electron and proton should exist in any c 177 // electron and proton should exist in any case
184 if(nullptr == electron) { << 178 if(!electron) {
185 electron = G4ParticleTable::GetParticleTab 179 electron = G4ParticleTable::GetParticleTable()->FindParticle("e-");
186 proton = G4ParticleTable::GetParticleTable 180 proton = G4ParticleTable::GetParticleTable()->FindParticle("proton");
187 if(nullptr == electron) { << 181 if(!electron || !proton) {
188 G4Exception("G4EmSaturation::InitialiseB 182 G4Exception("G4EmSaturation::InitialiseBirksCoefficient", "em0001",
189 FatalException, "electron should exist") << 183 FatalException, "both electron and proton should exist");
190 } 184 }
191 } 185 }
192 186
193 G4double curBirks = mat->GetIonisation()->Ge 187 G4double curBirks = mat->GetIonisation()->GetBirksConstant();
194 188
195 G4String name = mat->GetName(); 189 G4String name = mat->GetName();
196 190
197 // material has no Birks coeffitient defined 191 // material has no Birks coeffitient defined
198 // seach in the Geant4 list 192 // seach in the Geant4 list
199 if(curBirks == 0.0) { 193 if(curBirks == 0.0) {
200 for(G4int j=0; j<nG4Birks; ++j) { 194 for(G4int j=0; j<nG4Birks; ++j) {
201 if(name == g4MatNames[j]) { 195 if(name == g4MatNames[j]) {
202 mat->GetIonisation()->SetBirksConstant 196 mat->GetIonisation()->SetBirksConstant(g4MatData[j]);
203 curBirks = g4MatData[j]; 197 curBirks = g4MatData[j];
204 break; 198 break;
205 } 199 }
206 } 200 }
207 } 201 }
208 202
209 if(curBirks == 0.0) { return; } 203 if(curBirks == 0.0) { return; }
210 204
211 // compute mean mass ratio 205 // compute mean mass ratio
212 G4double curRatio = 0.0; 206 G4double curRatio = 0.0;
213 G4double curChargeSq = 0.0; 207 G4double curChargeSq = 0.0;
214 G4double norm = 0.0; 208 G4double norm = 0.0;
215 const G4ElementVector* theElementVector = ma 209 const G4ElementVector* theElementVector = mat->GetElementVector();
216 const G4double* theAtomNumDensityVector = ma 210 const G4double* theAtomNumDensityVector = mat->GetVecNbOfAtomsPerVolume();
217 std::size_t nelm = mat->GetNumberOfElements( << 211 size_t nelm = mat->GetNumberOfElements();
218 for (std::size_t i=0; i<nelm; ++i) { << 212 for (size_t i=0; i<nelm; ++i) {
219 const G4Element* elm = (*theElementVector) 213 const G4Element* elm = (*theElementVector)[i];
220 G4int Z = elm->GetZasInt(); << 214 G4double Z = elm->GetZ();
221 G4double w = theAtomNumDensityVector[i]; << 215 G4double w = Z*Z*theAtomNumDensityVector[i];
222 curRatio += w/nist->GetAtomicMassAmu(Z); << 216 curRatio += w/nist->GetAtomicMassAmu(G4int(Z));
223 curChargeSq += (Z*Z)*w; << 217 curChargeSq = Z*Z*w;
224 norm += w; 218 norm += w;
225 } 219 }
226 if ( norm > 0.0) { norm = 1.0/norm; } << 220 curRatio *= proton_mass_c2/norm;
227 curRatio *= (CLHEP::proton_mass_c2*norm); << 221 curChargeSq /= norm;
228 curChargeSq *= norm; <<
229 222
230 // store results 223 // store results
231 std::size_t idx = mat->GetIndex(); << 224 G4int idx = mat->GetIndex();
232 massFactors[idx] = curRatio; 225 massFactors[idx] = curRatio;
233 effCharges[idx] = curChargeSq; 226 effCharges[idx] = curChargeSq;
234 } 227 }
235 228
236 //....oooOO0OOooo........oooOO0OOooo........oo 229 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
237 230
238 void G4EmSaturation::DumpBirksCoefficients() 231 void G4EmSaturation::DumpBirksCoefficients()
239 { 232 {
240 G4cout << "### Birks coefficients used in ru 233 G4cout << "### Birks coefficients used in run time" << G4endl;
241 const G4MaterialTable* mtable = G4Material:: 234 const G4MaterialTable* mtable = G4Material::GetMaterialTable();
242 for(std::size_t i=0; i<nMaterials; ++i) { << 235 for(G4int i=0; i<nMaterials; ++i) {
243 const G4Material* mat = (*mtable)[i]; 236 const G4Material* mat = (*mtable)[i];
244 G4double br = mat->GetIonisation()->GetBir 237 G4double br = mat->GetIonisation()->GetBirksConstant();
245 if(br > 0.0) { 238 if(br > 0.0) {
246 G4cout << " " << mat->GetName() << " 239 G4cout << " " << mat->GetName() << " "
247 << br*MeV/mm << " mm/MeV" << " " 240 << br*MeV/mm << " mm/MeV" << " "
248 << br*mat->GetDensity()*MeV*cm2/g 241 << br*mat->GetDensity()*MeV*cm2/g
249 << " g/cm^2/MeV massFactor= " << mass 242 << " g/cm^2/MeV massFactor= " << massFactors[i]
250 << " effCharge= " << effCharges[i] << G 243 << " effCharge= " << effCharges[i] << G4endl;
251 } 244 }
252 } 245 }
253 } 246 }
254 247
255 //....oooOO0OOooo........oooOO0OOooo........oo 248 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
256 249
257 void G4EmSaturation::DumpG4BirksCoefficients() 250 void G4EmSaturation::DumpG4BirksCoefficients()
258 { 251 {
259 if(nG4Birks > 0) { 252 if(nG4Birks > 0) {
260 G4cout << "### Birks coefficients for Gean 253 G4cout << "### Birks coefficients for Geant4 materials" << G4endl;
261 for(G4int i=0; i<nG4Birks; ++i) { 254 for(G4int i=0; i<nG4Birks; ++i) {
262 G4cout << " " << g4MatNames[i] << " 255 G4cout << " " << g4MatNames[i] << " "
263 << g4MatData[i]*MeV/mm << " mm/Me 256 << g4MatData[i]*MeV/mm << " mm/MeV" << G4endl;
264 } 257 }
265 } 258 }
266 } 259 }
267 260
268 //....oooOO0OOooo........oooOO0OOooo........oo 261 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
269 262
270 void G4EmSaturation::InitialiseG4materials() 263 void G4EmSaturation::InitialiseG4materials()
271 { 264 {
272 nG4Birks = 4; 265 nG4Birks = 4;
273 g4MatData.reserve(nG4Birks); 266 g4MatData.reserve(nG4Birks);
274 267
275 // M.Hirschberg et al., IEEE Trans. Nuc. Sci 268 // M.Hirschberg et al., IEEE Trans. Nuc. Sci. 39 (1992) 511
276 // SCSN-38 kB = 0.00842 g/cm^2/MeV; rho = 1. 269 // SCSN-38 kB = 0.00842 g/cm^2/MeV; rho = 1.06 g/cm^3
277 g4MatNames.push_back("G4_POLYSTYRENE"); 270 g4MatNames.push_back("G4_POLYSTYRENE");
278 g4MatData.push_back(0.07943*mm/MeV); 271 g4MatData.push_back(0.07943*mm/MeV);
279 272
280 // C.Fabjan (private communication) 273 // C.Fabjan (private communication)
281 // kB = 0.006 g/cm^2/MeV; rho = 7.13 g/cm^3 274 // kB = 0.006 g/cm^2/MeV; rho = 7.13 g/cm^3
282 g4MatNames.push_back("G4_BGO"); 275 g4MatNames.push_back("G4_BGO");
283 g4MatData.push_back(0.008415*mm/MeV); 276 g4MatData.push_back(0.008415*mm/MeV);
284 277
285 // A.Ribon analysis of publications 278 // A.Ribon analysis of publications
286 // Scallettar et al., Phys. Rev. A25 (1982) 279 // Scallettar et al., Phys. Rev. A25 (1982) 2419.
287 // NIM A 523 (2004) 275. 280 // NIM A 523 (2004) 275.
288 // kB = 0.022 g/cm^2/MeV; rho = 1.396 g/cm^3 281 // kB = 0.022 g/cm^2/MeV; rho = 1.396 g/cm^3;
289 // ATLAS Efield = 10 kV/cm provide the stron 282 // ATLAS Efield = 10 kV/cm provide the strongest effect
290 // kB = 0.1576*mm/MeV 283 // kB = 0.1576*mm/MeV
291 // A. Kiryunin and P.Strizenec "Geant4 hadro 284 // A. Kiryunin and P.Strizenec "Geant4 hadronic
292 // working group meeting " kB = 0.041/9.13 g 285 // working group meeting " kB = 0.041/9.13 g/cm^2/MeV
293 g4MatNames.push_back("G4_lAr"); 286 g4MatNames.push_back("G4_lAr");
294 g4MatData.push_back(0.032*mm/MeV); 287 g4MatData.push_back(0.032*mm/MeV);
295 288
296 //G4_BARIUM_FLUORIDE 289 //G4_BARIUM_FLUORIDE
297 //G4_CESIUM_IODIDE 290 //G4_CESIUM_IODIDE
298 //G4_GEL_PHOTO_EMULSION 291 //G4_GEL_PHOTO_EMULSION
299 //G4_PHOTO_EMULSION 292 //G4_PHOTO_EMULSION
300 //G4_PLASTIC_SC_VINYLTOLUENE 293 //G4_PLASTIC_SC_VINYLTOLUENE
301 //G4_SODIUM_IODIDE 294 //G4_SODIUM_IODIDE
302 //G4_STILBENE 295 //G4_STILBENE
303 //G4_lAr 296 //G4_lAr
304 297
305 //G4_PbWO4 - CMS value 298 //G4_PbWO4 - CMS value
306 g4MatNames.push_back("G4_PbWO4"); 299 g4MatNames.push_back("G4_PbWO4");
307 g4MatData.push_back(0.0333333*mm/MeV); 300 g4MatData.push_back(0.0333333*mm/MeV);
308 301
309 //G4_Lucite 302 //G4_Lucite
310 303
311 } 304 }
312 305
313 //....oooOO0OOooo........oooOO0OOooo........oo 306 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
314 307