| 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 // GEANT4 Class header file 28 // GEANT4 Class header file
29 // 29 //
30 // File name: G4OpticalParameters 30 // File name: G4OpticalParameters
31 // 31 //
32 // Author: Daren Sawkey based on G4EmPa 32 // Author: Daren Sawkey based on G4EmParameters
33 // 33 //
34 // Creation date: 14.07.2020 34 // Creation date: 14.07.2020
35 // 35 //
36 // Modifications: 36 // Modifications:
37 // 37 //
38 // 38 //
39 // Class Description: 39 // Class Description:
40 // 40 //
41 // A utility static class, responsable for kee 41 // A utility static class, responsable for keeping parameters
42 // for all optical physics processes and model 42 // for all optical physics processes and models.
43 // 43 //
44 // It is initialized by the master thread but 44 // It is initialized by the master thread but can be updated
45 // at any moment. Parameters may be used in ru 45 // at any moment. Parameters may be used in run time or at
46 // initialisation 46 // initialisation
47 // 47 //
48 // ------------------------------------------- 48 // -------------------------------------------------------------------
49 // 49 //
50 50
51 #ifndef G4OpticalParameters_h 51 #ifndef G4OpticalParameters_h
52 #define G4OpticalParameters_h 1 52 #define G4OpticalParameters_h 1
53 53
54 #include "globals.hh" 54 #include "globals.hh"
55 #include "G4ios.hh" 55 #include "G4ios.hh"
56 #include "G4ThreeVector.hh" 56 #include "G4ThreeVector.hh"
57 #include "G4Threading.hh" 57 #include "G4Threading.hh"
58 #include <vector> 58 #include <vector>
59 59
60 class G4OpticalParametersMessenger; 60 class G4OpticalParametersMessenger;
61 class G4StateManager; 61 class G4StateManager;
62 62
63 enum G4OpticalProcessIndex 63 enum G4OpticalProcessIndex
64 { 64 {
65 kCerenkov, ///< Cerenkov process index 65 kCerenkov, ///< Cerenkov process index
66 kScintillation, ///< Scintillation process 66 kScintillation, ///< Scintillation process index
67 kAbsorption, ///< Absorption process ind 67 kAbsorption, ///< Absorption process index
68 kRayleigh, ///< Rayleigh scattering pr 68 kRayleigh, ///< Rayleigh scattering process index
69 kMieHG, ///< Mie scattering process 69 kMieHG, ///< Mie scattering process index
70 kBoundary, ///< Boundary process index 70 kBoundary, ///< Boundary process index
71 kWLS, ///< Wave Length Shifting p 71 kWLS, ///< Wave Length Shifting process index
72 kWLS2, ///< Second Wave Length Shi 72 kWLS2, ///< Second Wave Length Shifting process index
73 kNoProcess ///< Number of processes, n 73 kNoProcess ///< Number of processes, no selected process
74 }; 74 };
75 75
76 /// Return the name for a given optical proces 76 /// Return the name for a given optical process index
77 G4String G4OpticalProcessName(G4int); 77 G4String G4OpticalProcessName(G4int);
78 78
79 inline G4String G4OpticalProcessName(G4int pro 79 inline G4String G4OpticalProcessName(G4int processNumber)
80 { 80 {
81 switch(processNumber) 81 switch(processNumber)
82 { 82 {
83 case kCerenkov: 83 case kCerenkov:
84 return "Cerenkov"; 84 return "Cerenkov";
85 case kScintillation: 85 case kScintillation:
86 return "Scintillation"; 86 return "Scintillation";
87 case kAbsorption: 87 case kAbsorption:
88 return "OpAbsorption"; 88 return "OpAbsorption";
89 case kRayleigh: 89 case kRayleigh:
90 return "OpRayleigh"; 90 return "OpRayleigh";
91 case kMieHG: 91 case kMieHG:
92 return "OpMieHG"; 92 return "OpMieHG";
93 case kBoundary: 93 case kBoundary:
94 return "OpBoundary"; 94 return "OpBoundary";
95 case kWLS: 95 case kWLS:
96 return "OpWLS"; 96 return "OpWLS";
97 case kWLS2: 97 case kWLS2:
98 return "OpWLS2"; 98 return "OpWLS2";
99 default: 99 default:
100 return "NoProcess"; 100 return "NoProcess";
101 } 101 }
102 } 102 }
103 103
104 class G4OpticalParameters 104 class G4OpticalParameters
105 { 105 {
106 public: 106 public:
107 static G4OpticalParameters* Instance(); 107 static G4OpticalParameters* Instance();
108 108
109 ~G4OpticalParameters(); 109 ~G4OpticalParameters();
110 110
111 void SetDefaults(); 111 void SetDefaults();
112 112
113 // printing 113 // printing
114 void StreamInfo(std::ostream& os) const; 114 void StreamInfo(std::ostream& os) const;
115 void Dump() const; 115 void Dump() const;
116 friend std::ostream& operator<<(std::ostream 116 friend std::ostream& operator<<(std::ostream& os, const G4OpticalParameters&);
117 117
118 void SetVerboseLevel(G4int); 118 void SetVerboseLevel(G4int);
119 G4int GetVerboseLevel() const; 119 G4int GetVerboseLevel() const;
120 120
121 void SetProcessActivation(const G4String&, 121 void SetProcessActivation(const G4String&, G4bool);
122 G4bool GetProcessActivation(const G4String&) 122 G4bool GetProcessActivation(const G4String&) const;
123 123
124 // Cerenkov 124 // Cerenkov
125 void SetCerenkovMaxPhotonsPerStep(G4int); 125 void SetCerenkovMaxPhotonsPerStep(G4int);
126 G4int GetCerenkovMaxPhotonsPerStep() const; 126 G4int GetCerenkovMaxPhotonsPerStep() const;
127 void SetCerenkovVerboseLevel(G4int); 127 void SetCerenkovVerboseLevel(G4int);
128 G4int GetCerenkovVerboseLevel() const; 128 G4int GetCerenkovVerboseLevel() const;
129 void SetCerenkovMaxBetaChange(G4double); 129 void SetCerenkovMaxBetaChange(G4double);
130 G4double GetCerenkovMaxBetaChange() const; 130 G4double GetCerenkovMaxBetaChange() const;
131 void SetCerenkovTrackSecondariesFirst(G4bo 131 void SetCerenkovTrackSecondariesFirst(G4bool);
132 G4bool GetCerenkovTrackSecondariesFirst() co 132 G4bool GetCerenkovTrackSecondariesFirst() const;
133 void SetCerenkovStackPhotons(G4bool); 133 void SetCerenkovStackPhotons(G4bool);
134 G4bool GetCerenkovStackPhotons() const; 134 G4bool GetCerenkovStackPhotons() const;
135 135
136 // Scintillation 136 // Scintillation
137 void SetScintByParticleType(G4bool); 137 void SetScintByParticleType(G4bool);
138 G4bool GetScintByParticleType() const; 138 G4bool GetScintByParticleType() const;
139 void SetScintTrackInfo(G4bool); 139 void SetScintTrackInfo(G4bool);
140 G4bool GetScintTrackInfo() const; 140 G4bool GetScintTrackInfo() const;
141 void SetScintTrackSecondariesFirst(G4bool) 141 void SetScintTrackSecondariesFirst(G4bool);
142 G4bool GetScintTrackSecondariesFirst() const 142 G4bool GetScintTrackSecondariesFirst() const;
143 void SetScintFiniteRiseTime(G4bool); 143 void SetScintFiniteRiseTime(G4bool);
144 G4bool GetScintFiniteRiseTime() const; 144 G4bool GetScintFiniteRiseTime() const;
145 void SetScintStackPhotons(G4bool); 145 void SetScintStackPhotons(G4bool);
146 G4bool GetScintStackPhotons() const; 146 G4bool GetScintStackPhotons() const;
147 void SetScintVerboseLevel(G4int); 147 void SetScintVerboseLevel(G4int);
148 G4int GetScintVerboseLevel() const; 148 G4int GetScintVerboseLevel() const;
>> 149 void SetScintEnhancedTimeConstants(G4bool);
>> 150 G4bool GetScintEnhancedTimeConstants() const;
149 151
150 // WLS 152 // WLS
151 void SetWLSTimeProfile(const G4String&); 153 void SetWLSTimeProfile(const G4String&);
152 G4String GetWLSTimeProfile() const; 154 G4String GetWLSTimeProfile() const;
153 void SetWLSVerboseLevel(G4int); 155 void SetWLSVerboseLevel(G4int);
154 G4int GetWLSVerboseLevel() const; 156 G4int GetWLSVerboseLevel() const;
155 157
156 // WLS2 158 // WLS2
157 void SetWLS2TimeProfile(const G4String&) 159 void SetWLS2TimeProfile(const G4String&);
158 G4String GetWLS2TimeProfile() const; 160 G4String GetWLS2TimeProfile() const;
159 void SetWLS2VerboseLevel(G4int); 161 void SetWLS2VerboseLevel(G4int);
160 G4int GetWLS2VerboseLevel() const; 162 G4int GetWLS2VerboseLevel() const;
161 163
162 // boundary 164 // boundary
163 void SetBoundaryVerboseLevel(G4int); 165 void SetBoundaryVerboseLevel(G4int);
164 G4int GetBoundaryVerboseLevel() const; 166 G4int GetBoundaryVerboseLevel() const;
165 void SetBoundaryInvokeSD(G4bool); 167 void SetBoundaryInvokeSD(G4bool);
166 G4bool GetBoundaryInvokeSD() const; 168 G4bool GetBoundaryInvokeSD() const;
167 169
168 // absorption 170 // absorption
169 void SetAbsorptionVerboseLevel(G4int); 171 void SetAbsorptionVerboseLevel(G4int);
170 G4int GetAbsorptionVerboseLevel() const; 172 G4int GetAbsorptionVerboseLevel() const;
171 173
172 // rayleigh 174 // rayleigh
173 void SetRayleighVerboseLevel(G4int); 175 void SetRayleighVerboseLevel(G4int);
174 G4int GetRayleighVerboseLevel() const; 176 G4int GetRayleighVerboseLevel() const;
175 177
176 // mie 178 // mie
177 void SetMieVerboseLevel(G4int); 179 void SetMieVerboseLevel(G4int);
178 G4int GetMieVerboseLevel() const; 180 G4int GetMieVerboseLevel() const;
179 181
180 private: 182 private:
181 G4OpticalParameters(); 183 G4OpticalParameters();
182 void Initialise(); 184 void Initialise();
183 G4bool IsLocked() const; 185 G4bool IsLocked() const;
184 void PrintWarning(G4ExceptionDescription& ed 186 void PrintWarning(G4ExceptionDescription& ed) const;
185 187
186 static G4OpticalParameters* theInstance; 188 static G4OpticalParameters* theInstance;
187 189
188 G4OpticalParametersMessenger* theMessenger; 190 G4OpticalParametersMessenger* theMessenger;
189 G4StateManager* fStateManager; 191 G4StateManager* fStateManager;
190 192
191 G4int verboseLevel; 193 G4int verboseLevel;
192 194
193 // Whether to activate each process 195 // Whether to activate each process
194 std::map<G4String, G4bool> processActivation 196 std::map<G4String, G4bool> processActivation;
195 197
196 // cerenkov///////////////// 198 // cerenkov/////////////////
197 G4bool cerenkovStackPhotons; 199 G4bool cerenkovStackPhotons;
198 G4bool cerenkovTrackSecondariesFirst; 200 G4bool cerenkovTrackSecondariesFirst;
199 G4int cerenkovVerboseLevel; 201 G4int cerenkovVerboseLevel;
200 G4int cerenkovMaxPhotons; 202 G4int cerenkovMaxPhotons;
201 G4double cerenkovMaxBetaChange; 203 G4double cerenkovMaxBetaChange;
202 204
203 // scintillation ///////////////// 205 // scintillation /////////////////
204 206
205 /// option to set a finite rise-time; Note: 207 /// option to set a finite rise-time; Note: the G4Scintillation
206 /// process expects the user to have set the 208 /// process expects the user to have set the constant material
207 /// property SCINTILLATIONRISETIME{1,2,3} 209 /// property SCINTILLATIONRISETIME{1,2,3}
208 G4bool scintFiniteRiseTime; 210 G4bool scintFiniteRiseTime;
209 211
210 /// option to allow for the light yield to 212 /// option to allow for the light yield to be a function of
211 /// particle type and deposited energy in ca 213 /// particle type and deposited energy in case of non-linear
212 /// light emission in scintillators 214 /// light emission in scintillators
213 G4bool scintByParticleType; 215 G4bool scintByParticleType;
214 216
215 /// option to allow for G4ScintillationTrack 217 /// option to allow for G4ScintillationTrackInformation
216 /// to be attached to a scintillation photon 218 /// to be attached to a scintillation photon's track
217 G4bool scintTrackInfo; 219 G4bool scintTrackInfo;
218 220
219 /// option to allow stacking of secondary Sc 221 /// option to allow stacking of secondary Scintillation photons
220 G4bool scintStackPhotons; 222 G4bool scintStackPhotons;
221 223
222 G4int scintVerboseLevel; 224 G4int scintVerboseLevel;
223 G4bool scintTrackSecondariesFirst; 225 G4bool scintTrackSecondariesFirst;
224 226
225 ///////////////// WLS 227 ///////////////// WLS
226 G4String wlsTimeProfileName; 228 G4String wlsTimeProfileName;
227 G4int wlsVerboseLevel; 229 G4int wlsVerboseLevel;
228 230
229 ///////////////// WLS2 231 ///////////////// WLS2
230 G4String wls2TimeProfileName; 232 G4String wls2TimeProfileName;
231 G4int wls2VerboseLevel; 233 G4int wls2VerboseLevel;
232 234
233 //////////////// absorption 235 //////////////// absorption
234 G4int absorptionVerboseLevel; 236 G4int absorptionVerboseLevel;
235 237
236 //////////////// rayleigh 238 //////////////// rayleigh
237 G4int rayleighVerboseLevel; 239 G4int rayleighVerboseLevel;
238 240
239 //////////////// mie 241 //////////////// mie
240 G4int mieVerboseLevel; 242 G4int mieVerboseLevel;
241 243
242 //////////////// boundary 244 //////////////// boundary
243 /// G4OpBoundaryProcess to call InvokeSD met 245 /// G4OpBoundaryProcess to call InvokeSD method
244 G4bool boundaryInvokeSD; 246 G4bool boundaryInvokeSD;
245 G4int boundaryVerboseLevel; 247 G4int boundaryVerboseLevel;
246 248
247 #ifdef G4MULTITHREADED 249 #ifdef G4MULTITHREADED
248 static G4Mutex opticalParametersMutex; 250 static G4Mutex opticalParametersMutex;
249 #endif 251 #endif
250 }; 252 };
251 253
252 //....oooOO0OOooo........oooOO0OOooo........oo 254 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
253 255
254 #endif 256 #endif
255 257