| 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 //
>> 28 //
26 // Class G4VIntersectionLocator 29 // Class G4VIntersectionLocator
27 // 30 //
28 // class description: 31 // class description:
29 // 32 //
30 // Base class for the calculation of the inter 33 // Base class for the calculation of the intersection point with a boundary
31 // when PropagationInField is used. 34 // when PropagationInField is used.
32 // Gives possibility to choose the method of i 35 // Gives possibility to choose the method of intersection; concrete locators
33 // implemented are: G4SimpleLocator, G4MultiLe 36 // implemented are: G4SimpleLocator, G4MultiLevelLocator, G4BrentLocator.
34 // 37 //
35 // Key Method: EstimateIntersectionPoint() 38 // Key Method: EstimateIntersectionPoint()
36 39
>> 40 // History:
>> 41 // -------
37 // 27.10.08 - John Apostolakis, Tatiana Nikiti 42 // 27.10.08 - John Apostolakis, Tatiana Nikitina: Design and implementation
38 // ------------------------------------------- 43 // ---------------------------------------------------------------------------
>> 44
39 #ifndef G4VINTERSECTIONLOCATOR_HH 45 #ifndef G4VINTERSECTIONLOCATOR_HH
40 #define G4VINTERSECTIONLOCATOR_HH 46 #define G4VINTERSECTIONLOCATOR_HH
41 47
42 #include "G4Types.hh" 48 #include "G4Types.hh"
43 #include "G4ThreeVector.hh" 49 #include "G4ThreeVector.hh"
44 #include "G4FieldTrack.hh" 50 #include "G4FieldTrack.hh"
45 51
46 #include "G4Navigator.hh" 52 #include "G4Navigator.hh"
47 #include "G4ChordFinder.hh" 53 #include "G4ChordFinder.hh"
48 54
49 class G4VIntersectionLocator 55 class G4VIntersectionLocator
50 { 56 {
51 public: // with description 57 public: // with description
52 58
53 G4VIntersectionLocator(G4Navigator *theNa 59 G4VIntersectionLocator(G4Navigator *theNavigator);
54 // Constructor 60 // Constructor
55 virtual ~G4VIntersectionLocator(); 61 virtual ~G4VIntersectionLocator();
56 // Default destructor 62 // Default destructor
57 63
58 virtual G4bool EstimateIntersectionPoint( 64 virtual G4bool EstimateIntersectionPoint(
59 const G4FieldTrack& curveStartP << 65 const G4FieldTrack& curveStartPointTangent, // A
60 const G4FieldTrack& curveEndPoi << 66 const G4FieldTrack& curveEndPointTangent, // B
61 const G4ThreeVector& trialPoint, << 67 const G4ThreeVector& trialPoint, // E
62 G4FieldTrack& intersectPo << 68 G4FieldTrack& intersectPointTangent, // Output
63 G4bool& recalculate << 69 G4bool& recalculatedEndPoint, // Out
64 G4double& fPreviousSa << 70 G4double& fPreviousSafety, // In/Out
65 G4ThreeVector& fPreviousSf << 71 G4ThreeVector& fPreviousSftOrigin) = 0; // In/Out
66 // If such an intersection exists, this 72 // If such an intersection exists, this function calculates the
67 // intersection point of the true path 73 // intersection point of the true path of the particle with the surface
68 // of the current volume (or of one of 74 // of the current volume (or of one of its daughters).
69 // Should use lateral displacement as m 75 // Should use lateral displacement as measure of convergence
70 // NOTE: changes the safety! 76 // NOTE: changes the safety!
71 77
72 void printStatus( const G4FieldTrack& sta 78 void printStatus( const G4FieldTrack& startFT,
73 const G4FieldTrack& cur 79 const G4FieldTrack& currentFT,
74 G4double req 80 G4double requestStep,
75 G4double saf 81 G4double safety,
76 G4int ste 82 G4int stepNum);
77 // Print Method, useful mostly for debu 83 // Print Method, useful mostly for debugging
78 84
79 inline G4bool IntersectChord( const G4Thr 85 inline G4bool IntersectChord( const G4ThreeVector& StartPointA,
80 const G4Thr 86 const G4ThreeVector& EndPointB,
81 G4double& << 87 G4double &NewSafety,
82 G4double& << 88 G4double &PreviousSafety, // In/Out
83 G4ThreeVect << 89 G4ThreeVector &PreviousSftOrigin, // In/Out
84 G4double& << 90 G4double &LinearStepLength,
85 G4ThreeVect << 91 G4ThreeVector &IntersectionPoint,
86 G4bool* << 92 G4bool *calledNavigator=0 );
87 // Intersect the chord from StartPointA 93 // Intersect the chord from StartPointA to EndPointB and return
88 // whether an intersection occurred. NO 94 // whether an intersection occurred. NOTE: changes the Safety!
89 95
90 inline void SetEpsilonStepFor( G4double E << 96 inline void SetEpsilonStepFor( G4double EpsilonStep );
91 inline void SetDeltaIntersectionFor( G4do << 97 inline void SetDeltaIntersectionFor( G4double deltaIntersection );
92 inline void SetNavigatorFor( G4Navigator* << 98 inline void SetNavigatorFor( G4Navigator *fNavigator );
93 inline void SetChordFinderFor(G4ChordFind << 99 inline void SetChordFinderFor(G4ChordFinder *fCFinder );
94 // These parameters must be set at each 100 // These parameters must be set at each step, in case they were changed
>> 101
95 // Note: This simple approach ensures t 102 // Note: This simple approach ensures that all scenarios are considered.
96 // Future refinement may identify << 103 // [ Future refinement may identify which are invariant during a
97 // track, run or event << 104 // track, run or event ]
98 105
99 inline void SetVerboseFor(G4int fVerbose << 106 inline void SetVerboseFor(G4int fVerbose);
100 inline G4int GetVerboseFor(); << 107 inline G4int GetVerboseFor();
101 // Controling verbosity enables checkin 108 // Controling verbosity enables checking of the locating of intersections
102 109
103 public: // without description 110 public: // without description
104 111
105 // Additional inline Set/Get methods for p 112 // Additional inline Set/Get methods for parameters, dependent objects
106 113
107 inline G4double GetDeltaIntersection 114 inline G4double GetDeltaIntersectionFor();
108 inline G4double GetEpsilonStepFor(); 115 inline G4double GetEpsilonStepFor();
109 inline G4Navigator* GetNavigatorFor(); 116 inline G4Navigator* GetNavigatorFor();
110 inline G4ChordFinder* GetChordFinderFor(); 117 inline G4ChordFinder* GetChordFinderFor();
111 118
112 inline void SetSafetyParametersFor(G4bool << 119 inline void SetSafetyParametersFor(G4bool UseSafety );
113 120
114 inline void AddAdjustementOfFoundIntersect << 121 inline void AddAdjustementOfFoundIntersection(G4bool UseCorrection);
115 inline G4bool GetAdjustementOfFoundInterse 122 inline G4bool GetAdjustementOfFoundIntersection();
116 // Methods to be made Obsolete - replace 123 // Methods to be made Obsolete - replaced by methods below
117 inline void AdjustIntersections(G4bool Use << 124 inline void AdjustIntersections(G4bool UseCorrection);
118 inline G4bool AreIntersectionsAdjusted(){ 125 inline G4bool AreIntersectionsAdjusted(){ return fUseNormalCorrection; }
119 // Change adjustment flag ( New Interfa 126 // Change adjustment flag ( New Interface )
120 127
121 static void printStatus( const G4FieldTrac 128 static void printStatus( const G4FieldTrack& startFT,
122 const G4FieldTrac 129 const G4FieldTrack& currentFT,
123 G4double 130 G4double requestStep,
124 G4double 131 G4double safety,
125 G4int 132 G4int stepNum,
126 std::ostrea 133 std::ostream& oss,
127 G4int 134 G4int verboseLevel );
128 // Print Method for any ostream - e.g. c 135 // Print Method for any ostream - e.g. cerr -- and for G4Exception
129 << 136
130 inline void SetCheckMode( G4bool value ) { <<
131 inline G4bool GetCheckMode() { <<
132 <<
133 protected: // with description 137 protected: // with description
134 138
135 G4FieldTrack ReEstimateEndpoint( const G4F << 139 G4FieldTrack ReEstimateEndpoint( const G4FieldTrack &CurrentStateA,
136 const G4F << 140 const G4FieldTrack &EstimtdEndStateB,
137 G4d 141 G4double linearDistSq, // not used
138 G4d 142 G4double curveDist ); // not used
139 // Return new estimate for state after c 143 // Return new estimate for state after curveDist starting from
140 // CurrentStateA, to replace EstimtdEndS 144 // CurrentStateA, to replace EstimtdEndStateB, and report displacement
141 // (if field is compiled verbose) 145 // (if field is compiled verbose)
142 146
143 G4bool CheckAndReEstimateEndpoint( const G 147 G4bool CheckAndReEstimateEndpoint( const G4FieldTrack& CurrentStartA,
144 const G 148 const G4FieldTrack& EstimatedEndB,
145 G 149 G4FieldTrack& RevisedEndPoint,
146 G 150 G4int & errorCode);
147 // Check whether EndB is too far from St 151 // Check whether EndB is too far from StartA to be reached
148 // and if, re-estimate new value for End 152 // and if, re-estimate new value for EndB (return in RevisedEndPoint)
149 // Report error if EndB is before Start 153 // Report error if EndB is before StartA (in curve length)
150 // In that case return errorCode = 2. 154 // In that case return errorCode = 2.
151 155
152 G4ThreeVector GetSurfaceNormal(const G4Thr << 156 G4ThreeVector GetSurfaceNormal(const G4ThreeVector &CurrentInt_Point,
153 G4boo << 157 G4bool &validNormal); // const
154 // Position *must* be the intersection p 158 // Position *must* be the intersection point from last call
155 // to G4Navigator's ComputeStep (via In 159 // to G4Navigator's ComputeStep (via IntersectChord )
156 // Will try to use cached (last) value i 160 // Will try to use cached (last) value in Navigator for speed,
157 // if it was kept and valid. 161 // if it was kept and valid.
158 // Value returned is in global coordinat 162 // Value returned is in global coordinates.
159 // It does NOT guarantee to obtain Norma 163 // It does NOT guarantee to obtain Normal. This can happen eg if:
160 // - the "Intersection" Point is not on 164 // - the "Intersection" Point is not on a surface, potentially due to
161 // - inaccuracies in the transformation 165 // - inaccuracies in the transformations used, or
162 // - issues with the Solid. 166 // - issues with the Solid.
163 167
164 G4ThreeVector GetGlobalSurfaceNormal(const << 168 G4ThreeVector GetGlobalSurfaceNormal(const G4ThreeVector &CurrentE_Point,
165 << 169 G4bool &validNormal);
166 // Return the SurfaceNormal of Intersect 170 // Return the SurfaceNormal of Intersecting Solid in global coordinates
167 // Costlier then GetSurfaceNormal 171 // Costlier then GetSurfaceNormal
168 172
169 G4bool AdjustmentOfFoundIntersection(const << 173 G4bool AdjustmentOfFoundIntersection(const G4ThreeVector &A,
170 const << 174 const G4ThreeVector &CurrentE_Point,
171 const << 175 const G4ThreeVector &CurrentF_Point,
172 const << 176 const G4ThreeVector &MomentumDir,
173 const 177 const G4bool IntersectAF,
174 << 178 G4ThreeVector &IntersectionPoint,
175 << 179 G4double &NewSafety,
176 << 180 G4double &fPrevSafety,
177 << 181 G4ThreeVector &fPrevSftOrigin );
178 // Optional method for adjustment of loc 182 // Optional method for adjustment of located intersection point
179 // using the surface-normal 183 // using the surface-normal
180 184
181 void ReportTrialStep( G4int step_no, 185 void ReportTrialStep( G4int step_no,
182 const G4ThreeVector& 186 const G4ThreeVector& ChordAB_v,
183 const G4ThreeVector& 187 const G4ThreeVector& ChordEF_v,
184 const G4ThreeVector& 188 const G4ThreeVector& NewMomentumDir,
185 const G4ThreeVector& 189 const G4ThreeVector& NormalAtEntry,
186 G4bool validNormal 190 G4bool validNormal );
187 // Print a three-line report on the curr 191 // Print a three-line report on the current "sub-step", ie trial
188 // intersection 192 // intersection
189 193
190 G4bool LocateGlobalPointWithinVolumeAndChe 194 G4bool LocateGlobalPointWithinVolumeAndCheck( const G4ThreeVector& pos );
191 // Locate point using navigator - update 195 // Locate point using navigator - updates state of Navigator.
192 // By default, it assumes that the point 196 // By default, it assumes that the point is inside the current volume,
193 // and returns true. 197 // and returns true.
194 // In check mode, checks whether the poi 198 // In check mode, checks whether the point is *inside* the volume.
195 // If it is inside, it returns true. 199 // If it is inside, it returns true.
196 // If not, issues a warning and return 200 // If not, issues a warning and returns false.
197 201
198 void LocateGlobalPointWithinVolumeCheckAnd 202 void LocateGlobalPointWithinVolumeCheckAndReport( const G4ThreeVector& pos,
199 co 203 const G4String& CodeLocationInfo,
200 204 G4int CheckMode );
201 // As above, but report information abou 205 // As above, but report information about code location.
202 // If CheckMode > 1, report extra inform 206 // If CheckMode > 1, report extra information.
>> 207
>> 208 inline void SetCheckMode( G4bool value ) { fCheckMode = value; }
>> 209 inline G4bool GetCheckMode() { return fCheckMode; }
203 210
204 protected: // without description 211 protected: // without description
205 212
206 // Auxiliary methods -- to report issues 213 // Auxiliary methods -- to report issues
207 214
208 void ReportReversedPoints( std::ostringstr 215 void ReportReversedPoints( std::ostringstream& ossMsg,
209 const G4FieldTr 216 const G4FieldTrack& StartPointVel,
210 const G4FieldTr 217 const G4FieldTrack& EndPointVel,
211 G4double 218 G4double NewSafety, G4double epsStep,
212 const G4FieldTr 219 const G4FieldTrack& CurrentA_PointVelocity,
213 const G4FieldTr 220 const G4FieldTrack& CurrentB_PointVelocity,
214 const G4FieldTr 221 const G4FieldTrack& SubStart_PointVelocity,
215 const G4ThreeVe 222 const G4ThreeVector& CurrentE_Point,
216 const G4FieldTr 223 const G4FieldTrack& ApproxIntersecPointV,
217 G4int sbstp_no, 224 G4int sbstp_no, G4int sbstp_no_p, G4int depth );
218 // Build error messsage (in ossMsg) to r 225 // Build error messsage (in ossMsg) to report that point 'B' has
219 // gone past 'A' 226 // gone past 'A'
220 227
221 void ReportProgress( std::ostream& oss, 228 void ReportProgress( std::ostream& oss,
222 const G4FieldTrack& S 229 const G4FieldTrack& StartPointVel,
223 const G4FieldTrack& E 230 const G4FieldTrack& EndPointVel,
224 G4int s 231 G4int substep_no,
225 const G4FieldTrack& A 232 const G4FieldTrack& A_PtVel, // G4double safetyA
226 const G4FieldTrack& B 233 const G4FieldTrack& B_PtVel,
227 G4double s 234 G4double safetyLast,
228 G4int d 235 G4int depth= -1 );
229 // Report the current status / progress 236 // Report the current status / progress in finding the first intersection
230 237
231 void ReportImmediateHit( const char* 238 void ReportImmediateHit( const char* MethodName,
232 const G4ThreeVec 239 const G4ThreeVector& StartPosition,
233 const G4ThreeVec 240 const G4ThreeVector& TrialPoint,
234 G4double << 241 double tolerance,
235 unsigned long 242 unsigned long int numCalls );
236 // Report case: trial point is 'close' t 243 // Report case: trial point is 'close' to start, within tolerance
237 244
238 private: // no description 245 private: // no description
239 246
240 G4ThreeVector GetLocalSurfaceNormal(const << 247 G4ThreeVector GetLocalSurfaceNormal(const G4ThreeVector &CurrentE_Point,
241 << 248 G4bool &validNormal);
242 // Return the SurfaceNormal of Intersect 249 // Return the SurfaceNormal of Intersecting Solid in local coordinates
243 250
244 G4ThreeVector GetLastSurfaceNormal( const 251 G4ThreeVector GetLastSurfaceNormal( const G4ThreeVector& intersectPoint,
245 << 252 G4bool &validNormal) const;
246 // Position *must* be the intersection p 253 // Position *must* be the intersection point from last call
247 // to G4Navigator's ComputeStep (via In 254 // to G4Navigator's ComputeStep (via IntersectChord )
248 // Temporary - will use the same method 255 // Temporary - will use the same method in the Navigator
249 256
250 protected: 257 protected:
251 258
252 G4double kCarTolerance; / << 259 G4double kCarTolerance; // Constant
253 260
254 G4int fVerboseLevel = 0; / << 261 G4int fVerboseLevel; // For debugging
255 G4bool fUseNormalCorrection = false; / << 262 G4bool fUseNormalCorrection; // Configuration parameter
256 G4bool fCheckMode = false; << 263 G4bool fCheckMode;
257 G4bool fiUseSafety = false; // Whethe <<
258 264
259 G4Navigator* fiNavigator; << 265 G4Navigator *fiNavigator;
260 266
261 G4ChordFinder* fiChordFinder = nullptr; / << 267 G4ChordFinder *fiChordFinder;
262 G4double fiEpsilonStep = -1.0; / << 268 G4double fiEpsilonStep;
263 G4double fiDeltaIntersection = -1.0; / << 269 G4double fiDeltaIntersection;
>> 270 G4bool fiUseSafety;
264 // Parameters set at each physical step 271 // Parameters set at each physical step by calling method
265 // by G4PropagatorInField 272 // by G4PropagatorInField
266 273
267 G4Navigator *fHelpingNavigator; 274 G4Navigator *fHelpingNavigator;
268 // Helper for location 275 // Helper for location
269 276
270 G4TouchableHistory *fpTouchable = nullptr; << 277 G4TouchableHistory *fpTouchable;
271 // Touchable history hook 278 // Touchable history hook
272 }; 279 };
273 280
274 #include "G4VIntersectionLocator.icc" 281 #include "G4VIntersectionLocator.icc"
275 282
276 #endif 283 #endif
277 284