| 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 //
>> 27 // $Id: G4OpticalSurface.hh 80747 2014-05-09 12:53:43Z gcosmo $
>> 28 //
>> 29 //
26 ////////////////////////////////////////////// 30 ////////////////////////////////////////////////////////////////////////
27 // G4OpticalSurface Definition 31 // G4OpticalSurface Definition
28 ////////////////////////////////////////////// 32 ////////////////////////////////////////////////////////////////////////
29 // 33 //
30 // File: G4OpticalSurface.hh 34 // File: G4OpticalSurface.hh
31 // Description: A optical surface class for us 35 // Description: A optical surface class for use in G4OpBoundaryProcess
32 // Version: 2.0 36 // Version: 2.0
33 // Created: 1997-06-26 37 // Created: 1997-06-26
34 // Author: Peter Gumplinger 38 // Author: Peter Gumplinger
35 // Updated: 1999-10-29 add method and clas 39 // Updated: 1999-10-29 add method and class descriptors
36 // 2017-02-24 Mariele Stockhoff a << 40 // mail: gum@triumf.ca
37 // 41 //
38 // Class Description: <<
39 // A optical surface class for use in the G4Op <<
40 // Contains the enumerations: G4OpticalSurface <<
41 // and G4OpticalSurfaceModel. <<
42 ////////////////////////////////////////////// 42 ////////////////////////////////////////////////////////////////////////
43 43
44 #ifndef G4OpticalSurface_h 44 #ifndef G4OpticalSurface_h
45 #define G4OpticalSurface_h 1 45 #define G4OpticalSurface_h 1
46 46
>> 47 /////////////
>> 48 // Includes
>> 49 /////////////
>> 50
>> 51 #include "G4Types.hh"
47 #include "G4Physics2DVector.hh" 52 #include "G4Physics2DVector.hh"
48 #include "G4SurfaceProperty.hh" 53 #include "G4SurfaceProperty.hh"
49 #include "G4Types.hh" <<
50 54
51 // clang-format off << 55 // Class Description:
>> 56 // A optical surface class for use in the G4OpBoundaryProcess class.
>> 57 // Contains the enumerations: G4OpticalSurfaceFinish, G4OpticalSurfaceType,
>> 58 // and G4OpticalSurfaceModel.
>> 59 // Class Description - End:
>> 60
52 enum G4OpticalSurfaceFinish 61 enum G4OpticalSurfaceFinish
53 { 62 {
54 polished, // smooth perfectly p << 63 polished, // smooth perfectly polished surface
55 polishedfrontpainted, // smooth top-layer ( << 64 polishedfrontpainted, // smooth top-layer (front) paint
56 polishedbackpainted, // same is 'polished' << 65 polishedbackpainted, // same is 'polished' but with a back-paint
57 << 66
58 ground, // rough surface << 67 ground, // rough surface
59 groundfrontpainted, // rough top-layer (fro << 68 groundfrontpainted, // rough top-layer (front) paint
60 groundbackpainted, // same as 'ground' but << 69 groundbackpainted, // same as 'ground' but with a back-paint
61 << 70
62 // for LBNL LUT model << 71 polishedlumirrorair, // mechanically polished surface, with lumirror
63 polishedlumirrorair, // mechanically polis << 72 polishedlumirrorglue, // mechanically polished surface, with lumirror & meltmount
64 polishedlumirrorglue, // mechanically polis << 73 polishedair, // mechanically polished surface
65 // meltmount << 74 polishedteflonair, // mechanically polished surface, with teflon
66 polishedair, // mechanically polis << 75 polishedtioair, // mechanically polished surface, with tio paint
67 polishedteflonair, // mechanically polis << 76 polishedtyvekair, // mechanically polished surface, with tyvek
68 polishedtioair, // mechanically polis << 77 polishedvm2000air, // mechanically polished surface, with esr film
69 polishedtyvekair, // mechanically polis << 78 polishedvm2000glue, // mechanically polished surface, with esr film & meltmount
70 polishedvm2000air, // mechanically polis << 79
71 polishedvm2000glue, // mechanically polis << 80 etchedlumirrorair, // chemically etched surface, with lumirror
72 // meltmount << 81 etchedlumirrorglue, // chemically etched surface, with lumirror & meltmount
73 << 82 etchedair, // chemically etched surface
74 etchedlumirrorair, // chemically etched su << 83 etchedteflonair, // chemically etched surface, with teflon
75 etchedlumirrorglue, // chemically etched su << 84 etchedtioair, // chemically etched surface, with tio paint
76 etchedair, // chemically etched su << 85 etchedtyvekair, // chemically etched surface, with tyvek
77 etchedteflonair, // chemically etched su << 86 etchedvm2000air, // chemically etched surface, with esr film
78 etchedtioair, // chemically etched su << 87 etchedvm2000glue, // chemically etched surface, with esr film & meltmount
79 etchedtyvekair, // chemically etched su << 88
80 etchedvm2000air, // chemically etched su << 89 groundlumirrorair, // rough-cut surface, with lumirror
81 etchedvm2000glue, // chemically etched su << 90 groundlumirrorglue, // rough-cut surface, with lumirror & meltmount
82 << 91 groundair, // rough-cut surface
83 groundlumirrorair, // rough-cut surface, w << 92 groundteflonair, // rough-cut surface, with teflon
84 groundlumirrorglue, // rough-cut surface, w << 93 groundtioair, // rough-cut surface, with tio paint
85 groundair, // rough-cut surface << 94 groundtyvekair, // rough-cut surface, with tyvek
86 groundteflonair, // rough-cut surface, w << 95 groundvm2000air, // rough-cut surface, with esr film
87 groundtioair, // rough-cut surface, w << 96 groundvm2000glue // rough-cut surface, with esr film & meltmount
88 groundtyvekair, // rough-cut surface, w <<
89 groundvm2000air, // rough-cut surface, w <<
90 groundvm2000glue, // rough-cut surface, w <<
91 <<
92 // for DAVIS model <<
93 Rough_LUT, // rough surface <<
94 RoughTeflon_LUT, // rough surface wra <<
95 RoughESR_LUT, // rough surface wra <<
96 RoughESRGrease_LUT, // rough surface wra <<
97 // and coupled with <<
98 Polished_LUT, // polished surface <<
99 PolishedTeflon_LUT, // polished surface <<
100 PolishedESR_LUT, // polished surface <<
101 PolishedESRGrease_LUT, // polished surface <<
102 // and coupled with <<
103 Detector_LUT // polished surface <<
104 }; 97 };
105 98
106 enum G4OpticalSurfaceModel 99 enum G4OpticalSurfaceModel
107 { 100 {
108 glisur, // original GEANT3 model << 101 glisur, // original GEANT3 model
109 unified, // UNIFIED model << 102 unified, // UNIFIED model
110 LUT, // Look-Up-Table model (LBNL model << 103 LUT, // Look-Up-Table model
111 DAVIS, // DAVIS model << 104 dichroic // dichroic filter
112 dichroic // dichroic filter <<
113 }; 105 };
114 106
115 // clang-format on <<
116 <<
117 class G4MaterialPropertiesTable; 107 class G4MaterialPropertiesTable;
118 108
>> 109 /////////////////////
>> 110 // Class Definition
>> 111 /////////////////////
>> 112
119 class G4OpticalSurface : public G4SurfacePrope 113 class G4OpticalSurface : public G4SurfaceProperty
120 { 114 {
121 public: <<
122 // Constructor of an optical surface object. <<
123 G4OpticalSurface(const G4String& name, G4Opt <<
124 G4OpticalSurfaceFinish finish = polished, <<
125 G4double value = 1.0); <<
126 <<
127 ~G4OpticalSurface() override; <<
128 <<
129 G4OpticalSurface(const G4OpticalSurface& rig <<
130 G4OpticalSurface& operator=(const G4OpticalS <<
131 <<
132 G4bool operator==(const G4OpticalSurface& ri <<
133 G4bool operator!=(const G4OpticalSurface& ri <<
134 115
135 void SetType(const G4SurfaceType& type) over << 116 public: // Without description
>> 117
>> 118 //////////////
>> 119 // Operators
>> 120 //////////////
>> 121
>> 122 G4OpticalSurface(const G4OpticalSurface &right);
>> 123 G4OpticalSurface & operator=(const G4OpticalSurface &right);
>> 124
>> 125 G4int operator==(const G4OpticalSurface &right) const;
>> 126 G4int operator!=(const G4OpticalSurface &right) const;
136 127
137 // Returns the optical surface finish. << 128 public: // With description
138 inline G4OpticalSurfaceFinish GetFinish() co <<
139 129
140 // Sets the optical surface finish. << 130 ////////////////////////////////
141 void SetFinish(const G4OpticalSurfaceFinish) << 131 // Constructors and Destructor
>> 132 ////////////////////////////////
142 133
143 // Returns the optical surface model used. << 134 G4OpticalSurface(const G4String& name,
144 inline G4OpticalSurfaceModel GetModel() cons << 135 G4OpticalSurfaceModel model = glisur,
>> 136 G4OpticalSurfaceFinish finish = polished,
>> 137 G4SurfaceType type = dielectric_dielectric,
>> 138 G4double value = 1.0);
>> 139 // Constructor of an optical surface object.
145 140
146 // Sets the optical surface model to be foll << 141 public: // Without description
147 inline void SetModel(const G4OpticalSurfaceM <<
148 142
149 // Returns an unified model surface paramete << 143 virtual ~G4OpticalSurface();
150 inline G4double GetSigmaAlpha() const { retu <<
151 144
152 // Sets an unified model surface parameter. << 145 ////////////
153 inline void SetSigmaAlpha(const G4double s_a << 146 // Methods
>> 147 ////////////
154 148
155 // Returns the optical surface polish type. << 149 // public methods
156 G4double GetPolish() const { return polish; <<
157 150
158 // Sets the optical surface polish type. << 151 public: // With description
159 inline void SetPolish(const G4double plsh) { <<
160 152
161 // Retrieves the pointer of the G4MaterialPr << 153 void SetType(const G4SurfaceType& type);
162 // attached to optical surface. <<
163 inline G4MaterialPropertiesTable* GetMateria <<
164 { <<
165 return theMaterialPropertiesTable; <<
166 } <<
167 154
168 // Attaches a G4MaterialPropertiesTable to t << 155 inline G4OpticalSurfaceFinish GetFinish() const { return theFinish; }
169 inline void SetMaterialPropertiesTable(G4Mat << 156 // Returns the optical surface finish.
170 { << 157 void SetFinish(const G4OpticalSurfaceFinish );
171 theMaterialPropertiesTable = anMPT; << 158 // Sets the optical surface finish.
172 } <<
173 159
174 // Prints information about the optical surf << 160 inline G4OpticalSurfaceModel GetModel() const { return theModel; }
175 void DumpInfo() const; << 161 // Returns the optical surface model used.
>> 162 inline void SetModel(const G4OpticalSurfaceModel model)
>> 163 { theModel = model; }
>> 164 // Sets the optical surface model to be followed.
176 165
177 // call the correct ReadXXXFile << 166 inline G4double GetSigmaAlpha() const { return sigma_alpha; }
178 void ReadDataFile(); << 167 // Returns an unified model surface parameter.
>> 168 inline void SetSigmaAlpha(const G4double s_a) { sigma_alpha = s_a; }
>> 169 // Sets an unified model surface parameter.
179 170
180 // read a zlib-compressed file << 171 G4double GetPolish() const { return polish; }
181 void ReadCompressedFile(const G4String&, std << 172 // Returns the optical surface polish type.
>> 173 inline void SetPolish(const G4double plsh) { polish=plsh; }
>> 174 // Sets the optical surface polish type.
182 175
183 // Method to read the Look-Up-Table into arr << 176 inline G4MaterialPropertiesTable* GetMaterialPropertiesTable() const
184 void ReadLUTFile(); << 177 { return theMaterialPropertiesTable; }
>> 178 // Retrieves the pointer of the G4MaterialPropertiesTable
>> 179 // attached to optical surface.
185 180
186 // for DAVIS model << 181 inline void SetMaterialPropertiesTable(G4MaterialPropertiesTable *anMPT)
187 inline G4double GetAngularDistributionValue( << 182 { theMaterialPropertiesTable = anMPT; }
>> 183 // Attaches a G4MaterialPropertiesTable to the optical surface.
188 184
189 // Returns the AngularDistributionValue << 185 void DumpInfo() const;
190 inline G4double GetAngularDistributionValueL << 186 // Prints information about the optical surface.
191 187
192 // Method to read the Davis Look-Up-Table in << 188 void ReadLUTFile(void);
193 void ReadLUTDAVISFile(); << 189 // Method to read the Look-Up-Table into array AngularDistribution
194 190
195 // Method to read the Look-Up-Table for refl << 191 inline G4double GetAngularDistributionValue(G4int, G4int, G4int);
196 void ReadReflectivityLUTFile(); <<
197 192
198 // Returns the reflectivity value from the D << 193 inline G4int GetThetaIndexMax(void) const { return thetaIndexMax; }
199 inline G4double GetReflectivityLUTValue(G4in << 194 inline G4int GetPhiIndexMax(void) const { return phiIndexMax; }
200 195
201 // Returns the number of lines in the Davis << 196 void ReadDichroicFile(void);
202 G4int GetInmax() const; << 197 // Method to read the dichroic surface data file into Dichroic
203 198
204 // Returns the number of probability values << 199 inline G4Physics2DVector* GetDichroicVector();
205 G4int GetLUTbins() const; <<
206 200
207 // Returns the number of reflectivity values << 201 private:
208 G4int GetRefMax() const; <<
209 202
210 G4int GetThetaIndexMax() const; << 203 // ------------------
211 G4int GetPhiIndexMax() const; << 204 // Basic data members ( To define an optical surface)
>> 205 // ------------------
212 206
213 // Method to read the dichroic surface data << 207 G4OpticalSurfaceModel theModel; // Surface model
214 void ReadDichroicFile(); << 208 G4OpticalSurfaceFinish theFinish; // Surface finish
215 209
216 inline G4Physics2DVector* GetDichroicVector( << 210 G4double sigma_alpha; // The sigma of micro-facet polar angle
>> 211 G4double polish; // Polish parameter in glisur model
217 212
218 private: << 213 G4MaterialPropertiesTable* theMaterialPropertiesTable;
219 G4OpticalSurfaceModel theModel; // Surface <<
220 G4OpticalSurfaceFinish theFinish; // Surfac <<
221 214
222 G4double sigma_alpha; // The sigma of micro << 215 static const G4int incidentIndexMax = 91;
223 G4double polish; // Polish parameter in gli << 216 static const G4int thetaIndexMax = 45;
>> 217 static const G4int phiIndexMax = 37;
224 218
225 G4MaterialPropertiesTable* theMaterialProper << 219 G4float* AngularDistribution;
226 220
227 static const G4int incidentIndexMax = 91; << 221 G4Physics2DVector* DichroicVector;
228 static const G4int thetaIndexMax = 45; <<
229 static const G4int phiIndexMax = 37; <<
230 222
231 G4float* AngularDistribution; <<
232 G4Physics2DVector* DichroicVector; <<
233 <<
234 // for DAVIS model <<
235 static const G4int indexmax = 7280001; // 3 <<
236 static const G4int RefMax = 90; <<
237 static const G4int LUTbins = 20000; <<
238 G4float* AngularDistributionLUT; <<
239 G4float* Reflectivity; <<
240 }; 223 };
241 224
242 //////////////////// 225 ////////////////////
243 // Inline methods 226 // Inline methods
244 //////////////////// 227 ////////////////////
245 228
246 inline G4double G4OpticalSurface::GetAngularDi << 229 inline
247 G4int angleIncident, G4int thetaIndex, G4int << 230 G4double G4OpticalSurface::GetAngularDistributionValue(G4int angleIncident,
248 { << 231 G4int thetaIndex,
249 G4int product = angleIncident * thetaIndex * << 232 G4int phiIndex)
250 if (product < 0 || product >= incidentIndexM << 233 {
251 G4ExceptionDescription ed; << 234 return AngularDistribution[angleIncident+
252 ed << "Index angleIncident: " << angleInci << 235 thetaIndex*incidentIndexMax+
253 << " phiIndex: " << phiIndex << " out o << 236 phiIndex*thetaIndexMax*incidentIndexMax];
254 G4Exception("G4OpticalSurface::GetAngularD <<
255 return 0.; <<
256 } <<
257 return (G4double)AngularDistribution[angleIn <<
258 phiInde <<
259 } <<
260 <<
261 inline G4double G4OpticalSurface::GetAngularDi <<
262 { <<
263 if (i < 0 || i >= indexmax) { <<
264 G4ExceptionDescription ed; <<
265 ed << "Index " << i << " out of range!"; <<
266 G4Exception("G4OpticalSurface::GetAngularD <<
267 return 0.; <<
268 } <<
269 return (G4double)AngularDistributionLUT[i]; <<
270 } 237 }
271 238
272 inline G4double G4OpticalSurface::GetReflectiv << 239 inline
>> 240 G4Physics2DVector* G4OpticalSurface::GetDichroicVector()
273 { 241 {
274 if (i < 0 || i >= RefMax) { << 242 return DichroicVector;
275 G4ExceptionDescription ed; <<
276 ed << "Index " << i << " out of range!"; <<
277 G4Exception("G4OpticalSurface::GetReflecti <<
278 return 0.; <<
279 } <<
280 return (G4double)Reflectivity[i]; <<
281 } 243 }
282 <<
283 inline G4Physics2DVector* G4OpticalSurface::Ge <<
284 244
285 #endif /* G4OpticalSurface_h */ 245 #endif /* G4OpticalSurface_h */
286 246