| 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$
>> 27 //
26 // ------------------------------------------- 28 // -------------------------------------------------------------------
27 // 29 //
28 // GEANT4 Class header file 30 // GEANT4 Class header file
29 // 31 //
30 // 32 //
31 // File name: G4VMscModel 33 // File name: G4VMscModel
32 // 34 //
33 // Author: Vladimir Ivanchenko 35 // Author: Vladimir Ivanchenko
34 // 36 //
35 // Creation date: 07.03.2008 37 // Creation date: 07.03.2008
36 // 38 //
37 // Modifications: 39 // Modifications:
38 // 07.04.2009 V.Ivanchenko moved msc methods f 40 // 07.04.2009 V.Ivanchenko moved msc methods from G4VEmModel to G4VMscModel
39 // 26.03.2012 V.Ivanchenko added transport x-s 41 // 26.03.2012 V.Ivanchenko added transport x-section pointer and Get?Set methods
40 // 42 //
41 // Class Description: 43 // Class Description:
42 // 44 //
43 // General interface to msc models 45 // General interface to msc models
44 46
45 // ------------------------------------------- 47 // -------------------------------------------------------------------
46 // 48 //
47 #ifndef G4VMscModel_h 49 #ifndef G4VMscModel_h
48 #define G4VMscModel_h 1 50 #define G4VMscModel_h 1
49 51
50 #include <CLHEP/Units/SystemOfUnits.h> 52 #include <CLHEP/Units/SystemOfUnits.h>
51 53
52 #include "G4VEmModel.hh" 54 #include "G4VEmModel.hh"
53 #include "G4MscStepLimitType.hh" 55 #include "G4MscStepLimitType.hh"
54 #include "globals.hh" 56 #include "globals.hh"
55 #include "G4ThreeVector.hh" 57 #include "G4ThreeVector.hh"
56 #include "G4Track.hh" 58 #include "G4Track.hh"
57 #include "G4SafetyHelper.hh" 59 #include "G4SafetyHelper.hh"
>> 60 #include "G4VEnergyLossProcess.hh"
58 #include "G4PhysicsTable.hh" 61 #include "G4PhysicsTable.hh"
59 #include "G4ThreeVector.hh" 62 #include "G4ThreeVector.hh"
60 #include <vector> 63 #include <vector>
61 64
62 class G4ParticleChangeForMSC; 65 class G4ParticleChangeForMSC;
63 class G4ParticleDefinition; <<
64 class G4VEnergyLossProcess; <<
65 66
66 class G4VMscModel : public G4VEmModel 67 class G4VMscModel : public G4VEmModel
67 { 68 {
68 69
69 public: 70 public:
70 71
71 explicit G4VMscModel(const G4String& nam); 72 explicit G4VMscModel(const G4String& nam);
72 73
73 ~G4VMscModel() override; << 74 virtual ~G4VMscModel();
74 75
75 virtual G4double ComputeTruePathLengthLimit( 76 virtual G4double ComputeTruePathLengthLimit(const G4Track& track,
76 G4double& stepLimit) = 0; << 77 G4double& stepLimit);
77 78
78 virtual G4double ComputeGeomPathLength(G4dou << 79 virtual G4double ComputeGeomPathLength(G4double truePathLength);
79 80
80 virtual G4double ComputeTrueStepLength(G4dou << 81 virtual G4double ComputeTrueStepLength(G4double geomPathLength);
81 82
82 virtual G4ThreeVector& SampleScattering(cons 83 virtual G4ThreeVector& SampleScattering(const G4ThreeVector&,
83 G4double safety) = 0; << 84 G4double safety);
84 <<
85 void InitialiseParameters(const G4ParticleDe <<
86 <<
87 void DumpParameters(std::ostream& out) const <<
88 85
89 // empty method 86 // empty method
90 void SampleSecondaries(std::vector<G4Dynamic << 87 virtual void SampleSecondaries(std::vector<G4DynamicParticle*>*,
91 const G4MaterialCutsCouple*, << 88 const G4MaterialCutsCouple*,
92 const G4DynamicParticle*, << 89 const G4DynamicParticle*,
93 G4double tmin, G4double tmax) override; << 90 G4double tmin,
>> 91 G4double tmax) override;
94 92
95 //========================================== 93 //================================================================
96 // Set parameters of multiple scattering mo 94 // Set parameters of multiple scattering models
97 //========================================== 95 //================================================================
98 96
99 inline void SetStepLimitType(G4MscStepLimitT 97 inline void SetStepLimitType(G4MscStepLimitType);
100 98
101 inline void SetLateralDisplasmentFlag(G4bool 99 inline void SetLateralDisplasmentFlag(G4bool val);
102 100
103 inline void SetRangeFactor(G4double); 101 inline void SetRangeFactor(G4double);
104 102
105 inline void SetGeomFactor(G4double); 103 inline void SetGeomFactor(G4double);
106 104
107 inline void SetSkin(G4double); 105 inline void SetSkin(G4double);
108 106
109 inline void SetLambdaLimit(G4double); <<
110 <<
111 inline void SetSafetyFactor(G4double); <<
112 <<
113 inline void SetSampleZ(G4bool); 107 inline void SetSampleZ(G4bool);
114 108
115 //========================================== 109 //================================================================
116 // Get/Set access to Physics Tables 110 // Get/Set access to Physics Tables
117 //========================================== 111 //================================================================
118 112
119 inline G4VEnergyLossProcess* GetIonisation() 113 inline G4VEnergyLossProcess* GetIonisation() const;
120 114
121 inline void SetIonisation(G4VEnergyLossProce 115 inline void SetIonisation(G4VEnergyLossProcess*,
122 const G4ParticleDefinition* part); 116 const G4ParticleDefinition* part);
123 117
124 //========================================== 118 //================================================================
125 // Run time methods 119 // Run time methods
126 //========================================== 120 //================================================================
127 121
128 protected: 122 protected:
129 123
130 // initialisation of the ParticleChange for 124 // initialisation of the ParticleChange for the model
131 // initialisation of interface with geometry 125 // initialisation of interface with geometry and ionisation
132 G4ParticleChangeForMSC* 126 G4ParticleChangeForMSC*
133 GetParticleChangeForMSC(const G4ParticleDefi 127 GetParticleChangeForMSC(const G4ParticleDefinition* p = nullptr);
134 128
135 // convert true length to geometry length 129 // convert true length to geometry length
136 inline G4double ConvertTrueToGeom(G4double& 130 inline G4double ConvertTrueToGeom(G4double& tLength, G4double& gLength);
137 131
138 // should be set before initialisation <<
139 inline void SetUseSplineForMSC(G4bool val); <<
140 <<
141 public: 132 public:
142 133
143 // compute safety 134 // compute safety
144 inline G4double ComputeSafety(const G4ThreeV 135 inline G4double ComputeSafety(const G4ThreeVector& position,
145 G4double limit= DBL_MAX); 136 G4double limit= DBL_MAX);
146 137
147 // compute linear distance to a geometry bou 138 // compute linear distance to a geometry boundary
148 inline G4double ComputeGeomLimit(const G4Tra 139 inline G4double ComputeGeomLimit(const G4Track&, G4double& presafety,
149 G4double limit); 140 G4double limit);
150 141
151 G4double GetDEDX(const G4ParticleDefinition* << 142 inline G4double GetDEDX(const G4ParticleDefinition* part,
152 G4double kineticEner << 143 G4double kineticEnergy,
153 const G4MaterialCuts << 144 const G4MaterialCutsCouple* couple);
154 <<
155 G4double GetDEDX(const G4ParticleDefinition* <<
156 G4double kineticEner <<
157 const G4MaterialCuts <<
158 G4double logKineticE <<
159 <<
160 G4double GetRange(const G4ParticleDefinition <<
161 G4double kineticEne <<
162 const G4MaterialCut <<
163 145
164 G4double GetRange(const G4ParticleDefinition << 146 inline G4double GetRange(const G4ParticleDefinition* part,
165 G4double kineticEne 147 G4double kineticEnergy,
166 const G4MaterialCut << 148 const G4MaterialCutsCouple* couple);
167 G4double logKinetic <<
168 149
169 G4double GetEnergy(const G4ParticleDefinitio << 150 inline G4double GetEnergy(const G4ParticleDefinition* part,
170 G4double range, 151 G4double range,
171 const G4MaterialCutsCouple* couple); 152 const G4MaterialCutsCouple* couple);
172 153
173 // G4MaterialCutsCouple should be defined be 154 // G4MaterialCutsCouple should be defined before call to this method
174 inline 155 inline
175 G4double GetTransportMeanFreePath(const G4Pa 156 G4double GetTransportMeanFreePath(const G4ParticleDefinition* part,
176 G4double k << 157 G4double kinEnergy);
177 158
178 inline << 159 private:
179 G4double GetTransportMeanFreePath(const G4Pa <<
180 G4double k <<
181 G4double l <<
182 160
183 // hide assignment operator 161 // hide assignment operator
184 G4VMscModel & operator=(const G4VMscModel & 162 G4VMscModel & operator=(const G4VMscModel &right) = delete;
185 G4VMscModel(const G4VMscModel&) = delete; 163 G4VMscModel(const G4VMscModel&) = delete;
186 164
187 private: << 165 G4SafetyHelper* safetyHelper;
188 << 166 G4VEnergyLossProcess* ionisation;
189 G4SafetyHelper* safetyHelper = nullptr; << 167 const G4ParticleDefinition* currentPart;
190 G4VEnergyLossProcess* ionisation = nullptr; << 168
191 const G4ParticleDefinition* currentPart = nu << 169 G4double dedx;
192 << 170 G4double localtkin;
193 G4double dedx = 0.0; << 171 G4double localrange;
194 G4double localtkin = 0.0; <<
195 G4double localrange = DBL_MAX; <<
196 172
197 protected: 173 protected:
198 174
199 G4double facrange = 0.04; << 175 G4double facrange;
200 G4double facgeom = 2.5; << 176 G4double facgeom;
201 G4double facsafety = 0.6; << 177 G4double facsafety;
202 G4double skin = 1.0; << 178 G4double skin;
203 G4double dtrl = 0.05; << 179 G4double dtrl;
204 G4double lambdalimit; 180 G4double lambdalimit;
205 G4double geomMin; 181 G4double geomMin;
206 G4double geomMax; 182 G4double geomMax;
207 183
208 G4ThreeVector fDisplacement; << 184 G4ThreeVector fDisplacement;
209 G4MscStepLimitType steppingAlgorithm; 185 G4MscStepLimitType steppingAlgorithm;
210 186
211 G4bool samplez = false; << 187 G4bool samplez;
212 G4bool latDisplasment = true; << 188 G4bool latDisplasment;
213 189
214 private: <<
215 <<
216 G4bool useSpline = true; <<
217 }; 190 };
218 191
219 //....oooOO0OOooo........oooOO0OOooo........oo 192 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
220 //....oooOO0OOooo........oooOO0OOooo........oo 193 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
221 194
222 inline void G4VMscModel::SetLateralDisplasment 195 inline void G4VMscModel::SetLateralDisplasmentFlag(G4bool val)
223 { 196 {
224 if(!IsLocked()) { latDisplasment = val; } 197 if(!IsLocked()) { latDisplasment = val; }
225 } 198 }
226 199
227 //....oooOO0OOooo........oooOO0OOooo........oo 200 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
228 201
229 inline void G4VMscModel::SetSkin(G4double val) 202 inline void G4VMscModel::SetSkin(G4double val)
230 { 203 {
231 if(!IsLocked()) { skin = val; } 204 if(!IsLocked()) { skin = val; }
232 } 205 }
233 206
234 //....oooOO0OOooo........oooOO0OOooo........oo 207 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
235 208
236 inline void G4VMscModel::SetRangeFactor(G4doub 209 inline void G4VMscModel::SetRangeFactor(G4double val)
237 { 210 {
238 if(!IsLocked()) { facrange = val; } 211 if(!IsLocked()) { facrange = val; }
239 } 212 }
240 213
241 //....oooOO0OOooo........oooOO0OOooo........oo 214 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
242 215
243 inline void G4VMscModel::SetGeomFactor(G4doubl 216 inline void G4VMscModel::SetGeomFactor(G4double val)
244 { 217 {
245 if(!IsLocked()) { facgeom = val; } 218 if(!IsLocked()) { facgeom = val; }
246 } 219 }
247 220
248 //....oooOO0OOooo........oooOO0OOooo........oo 221 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
249 222
250 inline void G4VMscModel::SetLambdaLimit(G4doub <<
251 { <<
252 if(!IsLocked()) { lambdalimit = val; } <<
253 } <<
254 <<
255 //....oooOO0OOooo........oooOO0OOooo........oo <<
256 <<
257 inline void G4VMscModel::SetSafetyFactor(G4dou <<
258 { <<
259 if(!IsLocked()) { facsafety = val; } <<
260 } <<
261 <<
262 //....oooOO0OOooo........oooOO0OOooo........oo <<
263 <<
264 inline void G4VMscModel::SetStepLimitType(G4Ms 223 inline void G4VMscModel::SetStepLimitType(G4MscStepLimitType val)
265 { 224 {
266 if(!IsLocked()) { steppingAlgorithm = val; } 225 if(!IsLocked()) { steppingAlgorithm = val; }
267 } 226 }
268 227
269 //....oooOO0OOooo........oooOO0OOooo........oo 228 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
270 229
271 inline void G4VMscModel::SetSampleZ(G4bool val 230 inline void G4VMscModel::SetSampleZ(G4bool val)
272 { 231 {
273 if(!IsLocked()) { samplez = val; } 232 if(!IsLocked()) { samplez = val; }
274 } 233 }
275 234
276 //....oooOO0OOooo........oooOO0OOooo........oo 235 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
277 236
278 inline G4double G4VMscModel::ComputeSafety(con 237 inline G4double G4VMscModel::ComputeSafety(const G4ThreeVector& position,
279 G4double limit) 238 G4double limit)
280 { 239 {
281 return safetyHelper->ComputeSafety(position 240 return safetyHelper->ComputeSafety(position, limit);
282 } 241 }
283 242
284 //....oooOO0OOooo........oooOO0OOooo........oo 243 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
285 244
286 inline G4double G4VMscModel::ConvertTrueToGeom 245 inline G4double G4VMscModel::ConvertTrueToGeom(G4double& tlength,
287 G4double& glength) 246 G4double& glength)
288 { 247 {
289 glength = ComputeGeomPathLength(tlength); 248 glength = ComputeGeomPathLength(tlength);
290 // should return true length 249 // should return true length
291 return tlength; 250 return tlength;
292 } 251 }
293 252
294 //....oooOO0OOooo........oooOO0OOooo........oo 253 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
295 254
296 inline G4double G4VMscModel::ComputeGeomLimit( 255 inline G4double G4VMscModel::ComputeGeomLimit(const G4Track& track,
297 G4double& presafety, 256 G4double& presafety,
298 G4double limit) 257 G4double limit)
299 { 258 {
300 return safetyHelper->CheckNextStep( 259 return safetyHelper->CheckNextStep(
301 track.GetStep()->GetPreStepPoint()-> 260 track.GetStep()->GetPreStepPoint()->GetPosition(),
302 track.GetMomentumDirection(), 261 track.GetMomentumDirection(),
303 limit, presafety); 262 limit, presafety);
304 } 263 }
305 264
306 //....oooOO0OOooo........oooOO0OOooo........oo 265 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
307 266
308 inline G4VEnergyLossProcess* G4VMscModel::GetI << 267 inline G4double
>> 268 G4VMscModel::GetDEDX(const G4ParticleDefinition* part,
>> 269 G4double kinEnergy, const G4MaterialCutsCouple* couple)
309 { 270 {
310 return ionisation; << 271 G4double x;
>> 272 if(ionisation) { x = ionisation->GetDEDX(kinEnergy, couple); }
>> 273 else {
>> 274 G4double q = part->GetPDGCharge()*inveplus;
>> 275 x = dedx*q*q;
>> 276 }
>> 277 return x;
311 } 278 }
312 279
313 //....oooOO0OOooo........oooOO0OOooo........oo 280 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
314 281
315 inline void G4VMscModel::SetIonisation(G4VEner << 282 inline G4double
316 const G4ParticleDefinition* par << 283 G4VMscModel::GetRange(const G4ParticleDefinition* part,
>> 284 G4double kinEnergy, const G4MaterialCutsCouple* couple)
317 { 285 {
318 ionisation = p; << 286 //G4cout << "G4VMscModel::GetRange E(MeV)= " << kinEnergy << " "
319 currentPart = part; << 287 // << ionisation << " " << part->GetParticleName()
>> 288 // << G4endl;
>> 289 localtkin = kinEnergy;
>> 290 if(ionisation) {
>> 291 localrange = ionisation->GetRangeForLoss(kinEnergy, couple);
>> 292 } else {
>> 293 G4double q = part->GetPDGCharge()*inveplus;
>> 294 localrange = kinEnergy/(dedx*q*q*couple->GetMaterial()->GetDensity());
>> 295 }
>> 296 //G4cout << "R(mm)= " << localrange << " " << ionisation << G4endl;
>> 297 return localrange;
320 } 298 }
321 299
322 //....oooOO0OOooo........oooOO0OOooo........oo 300 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
323 301
324 inline G4double 302 inline G4double
325 G4VMscModel::GetTransportMeanFreePath(const G4 << 303 G4VMscModel::GetEnergy(const G4ParticleDefinition* part,
326 G4double << 304 G4double range, const G4MaterialCutsCouple* couple)
327 { 305 {
328 G4double x; << 306 G4double e;
329 if (nullptr != xSectionTable) { << 307 //G4cout << "G4VMscModel::GetEnergy R(mm)= " << range << " " << ionisation
330 x = pFactor*(*xSectionTable)[basedCoupleIn << 308 // << " Rlocal(mm)= " << localrange << " Elocal(MeV)= " << localtkin
331 } else { << 309 // << G4endl;
332 x = pFactor*CrossSectionPerVolume(pBaseMat << 310 if(ionisation) { e = ionisation->GetKineticEnergy(range, couple); }
>> 311 else {
>> 312 e = localtkin;
>> 313 if(localrange > range) {
>> 314 G4double q = part->GetPDGCharge()*inveplus;
>> 315 e -= (localrange - range)*dedx*q*q*couple->GetMaterial()->GetDensity();
>> 316 }
333 } 317 }
334 return (x > 0.0) ? 1.0/x : DBL_MAX; << 318 return e;
335 } 319 }
336 320
337 //....oooOO0OOooo........oooOO0OOooo........oo 321 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
338 322
339 inline G4double << 323 inline G4VEnergyLossProcess* G4VMscModel::GetIonisation() const
340 G4VMscModel::GetTransportMeanFreePath(const G4 <<
341 G4double <<
342 { 324 {
343 G4double x; << 325 return ionisation;
344 if (nullptr != xSectionTable) { <<
345 x = pFactor*(*xSectionTable)[basedCoupleIn <<
346 } else { <<
347 x = pFactor*CrossSectionPerVolume(pBaseMat <<
348 } <<
349 return (x > 0.0) ? 1.0/x : DBL_MAX; <<
350 } 326 }
351 327
352 //....oooOO0OOooo........oooOO0OOooo........oo 328 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
353 329
354 inline void G4VMscModel::SetUseSplineForMSC(G4 << 330 inline void G4VMscModel::SetIonisation(G4VEnergyLossProcess* p,
>> 331 const G4ParticleDefinition* part)
355 { 332 {
356 useSpline = val; << 333 ionisation = p;
>> 334 currentPart = part;
>> 335 }
>> 336
>> 337 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
>> 338
>> 339 inline G4double
>> 340 G4VMscModel::GetTransportMeanFreePath(const G4ParticleDefinition* part,
>> 341 G4double ekin)
>> 342 {
>> 343 G4double x;
>> 344 if(xSectionTable) {
>> 345 G4int idx = CurrentCouple()->GetIndex();
>> 346 x = (*xSectionTable)[(*theDensityIdx)[idx]]->Value(ekin, idxTable)
>> 347 *(*theDensityFactor)[idx]/(ekin*ekin);
>> 348 } else {
>> 349 x = CrossSectionPerVolume(CurrentCouple()->GetMaterial(), part, ekin,
>> 350 0.0, DBL_MAX);
>> 351 }
>> 352 x = (x > 0.0) ? 1.0/x : DBL_MAX;
>> 353 return x;
357 } 354 }
358 355
359 //....oooOO0OOooo........oooOO0OOooo........oo 356 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
360 357
361 #endif 358 #endif
>> 359
362 360