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