| 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: G4PropagatorInField.hh,v 1.19 2009-11-13 17:34:26 japost Exp $
>> 28 // GEANT4 tag $Name: geant4-09-04-patch-02 $
>> 29 //
>> 30 //
26 // Class G4PropagatorInField 31 // Class G4PropagatorInField
27 // 32 //
28 // class description: 33 // class description:
29 // 34 //
30 // This class performs the navigation/propagat 35 // This class performs the navigation/propagation of a particle/track
31 // in a magnetic field. The field is in genera 36 // in a magnetic field. The field is in general non-uniform.
32 // For the calculation of the path, it relies 37 // For the calculation of the path, it relies on the class G4ChordFinder.
>> 38 //
>> 39 // Key Method: ComputeStep(..)
33 40
34 // History: 41 // History:
35 // ------- 42 // -------
36 // 25.10.96 John Apostolakis, design and impl 43 // 25.10.96 John Apostolakis, design and implementation
37 // 25.03.97 John Apostolakis, adaptation for 44 // 25.03.97 John Apostolakis, adaptation for G4Transportation and cleanup
38 // 8.11.02 John Apostolakis, changes to enab 45 // 8.11.02 John Apostolakis, changes to enable use of safety in intersecting
39 // ------------------------------------------- 46 // ---------------------------------------------------------------------------
>> 47
40 #ifndef G4PropagatorInField_hh 48 #ifndef G4PropagatorInField_hh
41 #define G4PropagatorInField_hh 1 49 #define G4PropagatorInField_hh 1
42 50
43 #include "G4Types.hh" 51 #include "G4Types.hh"
44 52
45 #include <vector> 53 #include <vector>
46 54
47 #include "G4FieldTrack.hh" 55 #include "G4FieldTrack.hh"
48 #include "G4FieldManager.hh" 56 #include "G4FieldManager.hh"
49 #include "G4VIntersectionLocator.hh" 57 #include "G4VIntersectionLocator.hh"
50 58
51 class G4ChordFinder; 59 class G4ChordFinder;
52 60
53 class G4Navigator; 61 class G4Navigator;
54 class G4VPhysicalVolume; 62 class G4VPhysicalVolume;
55 class G4VCurvedTrajectoryFilter; 63 class G4VCurvedTrajectoryFilter;
56 64
57 class G4PropagatorInField 65 class G4PropagatorInField
58 { 66 {
59 67
60 public: // with description 68 public: // with description
61 69
62 G4PropagatorInField( G4Navigator* theNaviga << 70 G4PropagatorInField( G4Navigator *theNavigator,
63 G4FieldManager* detect << 71 G4FieldManager *detectorFieldMgr,
64 G4VIntersectionLocator << 72 G4VIntersectionLocator *vLocator=0 );
65 ~G4PropagatorInField(); 73 ~G4PropagatorInField();
66 74
67 G4double ComputeStep( G4FieldTrack& pFieldT << 75 G4double ComputeStep( G4FieldTrack &pFieldTrack,
68 G4double pCurrentProp << 76 G4double pCurrentProposedStepLength,
69 G4double& pNewSafety, << 77 G4double &pNewSafety,
70 G4VPhysicalVolume* pP << 78 G4VPhysicalVolume *pPhysVol=0 );
71 G4bool canRelaxDeltaC <<
72 // Compute the next geometric Step 79 // Compute the next geometric Step
73 80
74 inline G4ThreeVector EndPosition() const; << 81 inline G4ThreeVector EndPosition() const;
75 inline G4ThreeVector EndMomentumDir() const << 82 inline G4ThreeVector EndMomentumDir() const;
76 inline G4bool IsParticleLooping() co << 83 inline G4bool IsParticleLooping() const;
77 // Return the state after the Step 84 // Return the state after the Step
78 85
79 inline G4double GetEpsilonStep() const; << 86 inline G4double GetEpsilonStep() const;
80 // Relative accuracy for current Step (Ca 87 // Relative accuracy for current Step (Calc.)
81 inline void SetEpsilonStep(G4double new << 88 inline void SetEpsilonStep(G4double newEps);
82 // The ratio DeltaOneStep()/h_current_ste 89 // The ratio DeltaOneStep()/h_current_step
83 90
84 G4FieldManager* FindAndSetFieldManager(G4VP << 91 inline void SetChargeMomentumMass( G4double charge, // in e+ units
>> 92 G4double momentum, // in Geant4 units
>> 93 G4double pMass );
>> 94 // Inform this and all associated classes of q, p, m
>> 95
>> 96 G4FieldManager* FindAndSetFieldManager(G4VPhysicalVolume* pCurrentPhysVol);
85 // Set (and return) the correct field man 97 // Set (and return) the correct field manager (global or local),
86 // if it exists. << 98 // if it exists.
87 // Should be called before ComputeStep is 99 // Should be called before ComputeStep is called;
88 // Currently, ComputeStep will call it, i << 100 // - currently, ComputeStep will call it, if it has not been called.
89 101
90 inline G4ChordFinder* GetChordFinder(); 102 inline G4ChordFinder* GetChordFinder();
91 103
92 G4int SetVerboseLevel( G4int verbose << 104 G4int SetVerboseLevel( G4int verbose );
93 inline G4int GetVerboseLevel() const; << 105 inline G4int GetVerboseLevel() const;
94 inline G4int Verbose() const; << 106 inline G4int Verbose() const;
95 inline void CheckMode(G4bool mode); << 107
96 << 108 inline G4int GetMaxLoopCount() const;
97 inline void SetVerboseTrace( G4bool enabl << 109 inline void SetMaxLoopCount( G4int new_max );
98 inline G4bool GetVerboseTrace(); << 110 // A maximum for the number of steps that a (looping) particle can take.
99 // Tracing key parts of Compute Step << 111
100 << 112 void printStatus( const G4FieldTrack& startFT,
101 inline G4int GetMaxLoopCount() const; << 113 const G4FieldTrack& currentFT,
102 inline void SetMaxLoopCount( G4int new_max << 114 G4double requestStep,
103 // A maximum for the number of substeps t << 115 G4double safety,
104 // Above this number it is signaled as << 116 G4int step,
105 << 117 G4VPhysicalVolume* startVolume);
106 void printStatus( const G4FieldTrack& <<
107 const G4FieldTrack& <<
108 G4double <<
109 G4double <<
110 G4int <<
111 G4VPhysicalVolume* <<
112 // Print Method - useful mostly for debug 118 // Print Method - useful mostly for debugging.
113 119
114 inline G4FieldTrack GetEndState() const; 120 inline G4FieldTrack GetEndState() const;
115 121
116 inline G4double GetMinimumEpsilonStep() con << 122 inline G4double GetMinimumEpsilonStep() const; // Min for relative accuracy
117 inline void SetMinimumEpsilonStep( G4do << 123 inline void SetMinimumEpsilonStep( G4double newEpsMin ); // of any step
118 inline G4double GetMaximumEpsilonStep() con << 124 inline G4double GetMaximumEpsilonStep() const;
119 inline void SetMaximumEpsilonStep( G4do << 125 inline void SetMaximumEpsilonStep( G4double newEpsMax );
120 // The 4 above methods are now obsolescen 126 // The 4 above methods are now obsolescent but *for now* will work
121 // They are being replaced by same-name m 127 // They are being replaced by same-name methods in G4FieldManager,
122 // allowing the specialisation in differe 128 // allowing the specialisation in different volumes.
123 // Their new behaviour is to change the v 129 // Their new behaviour is to change the values for the global field
124 // manager 130 // manager
125 131
126 void SetLargestAcceptableStep( G4double << 132 inline void SetLargestAcceptableStep( G4double newBigDist );
127 G4double GetLargestAcceptableStep(); << 133 inline G4double GetLargestAcceptableStep();
128 void ResetLargestAcceptableStep(); <<
129 // Obtain / change the size of the larges <<
130 // Reset method uses the world volume's <<
131 <<
132 G4double GetMaxStepSizeMultiplier(); <<
133 void SetMaxStepSizeMultiplier(G4double <<
134 // Control extra Multiplier parameter for <<
135 G4double GetMinBigDistance(); <<
136 void SetMinBigDistance(G4double val); <<
137 // Control minimum 'directional' distance <<
138 134
139 void SetTrajectoryFilter(G4VCurvedTrajector 135 void SetTrajectoryFilter(G4VCurvedTrajectoryFilter* filter);
140 // Set the filter that examines & stores 136 // Set the filter that examines & stores 'intermediate'
141 // curved trajectory points. Currently o << 137 // curved trajectory points. Currently only position is stored.
142 138
143 std::vector<G4ThreeVector>* GimmeTrajectory 139 std::vector<G4ThreeVector>* GimmeTrajectoryVectorAndForgetIt() const;
144 // Access the points which have passed by 140 // Access the points which have passed by the filter.
145 // Responsibility for deleting the points 141 // Responsibility for deleting the points lies with the client.
146 // This method MUST BE called exactly ONC 142 // This method MUST BE called exactly ONCE per step.
147 143
148 void ClearPropagatorState(); 144 void ClearPropagatorState();
149 // Clear all the State of this class and 145 // Clear all the State of this class and its current associates
150 // --> the current field manager & chord << 146 // --> the current field manager & chord finder will also be called
151 147
152 inline void SetDetectorFieldManager( G4Fiel 148 inline void SetDetectorFieldManager( G4FieldManager* newGlobalFieldManager );
153 // Update this (dangerous) state -- for t 149 // Update this (dangerous) state -- for the time being
154 150
155 inline void SetUseSafetyForOptimization( 151 inline void SetUseSafetyForOptimization( G4bool );
156 inline G4bool GetUseSafetyForOptimization() 152 inline G4bool GetUseSafetyForOptimization();
157 // Toggle & view parameter for using safe 153 // Toggle & view parameter for using safety to discard
158 // unneccesary calls to navigator (thus ' << 154 // unneccesary calls to navigator (thus 'optimising' performance)
159 inline G4bool IntersectChord( const G4Three << 155 inline G4bool IntersectChord( G4ThreeVector StartPointA,
160 const G4Three << 156 G4ThreeVector EndPointB,
161 G4doubl << 157 G4double &NewSafety,
162 G4doubl << 158 G4double &LinearStepLength,
163 G4Three << 159 G4ThreeVector &IntersectionPoint);
164 // Intersect the chord from StartPointA t 160 // Intersect the chord from StartPointA to EndPointB
165 // and return whether an intersection occ 161 // and return whether an intersection occurred
166 // NOTE: Safety is changed! << 162 // NOTE : SAFETY IS CHANGED
167 163
168 inline G4bool IsFirstStepInVolume(); <<
169 inline G4bool IsLastStepInVolume(); <<
170 inline void PrepareNewTrack(); <<
171 <<
172 inline G4VIntersectionLocator* GetIntersect 164 inline G4VIntersectionLocator* GetIntersectionLocator();
173 inline void SetIntersectionLocator(G4VInter << 165 inline void SetIntersectionLocator(G4VIntersectionLocator *pLocator );
174 // Change or get the object which calcula 166 // Change or get the object which calculates the exact
175 // intersection point with the next bound << 167 // intersection point with the next boundary
176 << 168
177 inline G4int GetIterationsToIncreaseChordDi <<
178 inline void SetIterationsToIncreaseChordDi <<
179 // Control the parameter which enables th <<
180 // which ensures that chord segments ar <<
181 // their sagitta is small than delta-ch <<
182 // The Set method increases the value of <<
183 // doubling it once the number of itera <<
184 // value of 'IncreaseChordDistanceThres <<
185 // again every time the iteration count <<
186 // value. <<
187 // Note: delta-chord is reset to its orig <<
188 // each call to ComputeStep. <<
189 <<
190 public: // without description 169 public: // without description
191 170
192 inline G4double GetDeltaIntersection() cons << 171 inline G4double GetDeltaIntersection() const;
193 inline G4double GetDeltaOneStep() const; << 172 inline G4double GetDeltaOneStep() const;
194 173
195 inline G4FieldManager* GetCurrentFieldManag << 174 inline G4FieldManager* GetCurrentFieldManager();
196 inline G4EquationOfMotion* GetCurrentEquati << 175 inline void SetNavigatorForPropagating( G4Navigator *SimpleOrMultiNavigator );
197 // Auxiliary methods - their results can << 176 inline G4Navigator* GetNavigatorForPropagating();
198 <<
199 inline void SetNavigatorForPropagating(G4Na <<
200 inline G4Navigator* GetNavigatorForPropagat <<
201 177
202 inline void SetThresholdNoZeroStep( G4int n 178 inline void SetThresholdNoZeroStep( G4int noAct,
203 G4int n 179 G4int noHarsh,
204 G4int n 180 G4int noAbandon );
205 inline G4int GetThresholdNoZeroSteps( G4int 181 inline G4int GetThresholdNoZeroSteps( G4int i );
206 182
207 inline G4double GetZeroStepThreshold(); << 183 inline G4double GetZeroStepThreshold();
208 inline void SetZeroStepThreshold( G4dou << 184 inline void SetZeroStepThreshold( G4double newLength );
209 << 185
210 void RefreshIntersectionLocator(); 186 void RefreshIntersectionLocator();
211 // Update the Locator with parameters fro 187 // Update the Locator with parameters from this class
212 // and from current field manager << 188 // and from current field manager
213 189
214 protected: // without description << 190 protected: // with description
215 191
216 void PrintStepLengthDiagnostic( G4double 192 void PrintStepLengthDiagnostic( G4double currentProposedStepLength,
217 G4double 193 G4double decreaseFactor,
218 G4double 194 G4double stepTrial,
219 const G4FieldTrac 195 const G4FieldTrack& aFieldTrack);
220 <<
221 void ReportLoopingParticle( G4int count, G <<
222 G4double stepRe <<
223 const G4ThreeVe <<
224 G4VPhysicalVolu <<
225 void ReportStuckParticle(G4int noZeroSteps, <<
226 G4double lastTried <<
227 <<
228 private: 196 private:
229 <<
230 // ---------------------------------------- 197 // ----------------------------------------------------------------------
231 // DATA Members 198 // DATA Members
232 // ---------------------------------------- 199 // ----------------------------------------------------------------------
233 200
234 // ======================================= 201 // ==================================================================
235 // INVARIANTS - Must not change during tra 202 // INVARIANTS - Must not change during tracking
236 203
237 // ** PARAMETERS ----------- 204 // ** PARAMETERS -----------
238 G4int fMax_loop_count = 1000; << 205 G4int fMax_loop_count;
239 // Limit for the number of sub-steps take << 206 // Limit for the number of sub-steps taken in one call to ComputeStep
240 G4int fIncreaseChordDistanceThreshold = 100 << 207 G4bool fUseSafetyForOptimisation;
241 G4bool fUseSafetyForOptimisation = true; << 208
242 // (false) is less sensitive to incorrect << 209 // Thresholds for identifying "abnormal" cases - which cause looping
243 << 210 G4int fActionThreshold_NoZeroSteps; // Threshold # - above it act
244 // Thresholds for identifying "abnormal" c << 211 G4int fSevereActionThreshold_NoZeroSteps; // Threshold # to act harshly
245 // << 212 G4int fAbandonThreshold_NoZeroSteps; // Threshold # to abandon
246 G4int fActionThreshold_NoZeroSteps = 2; << 213 G4double fZeroStepThreshold;
247 G4int fSevereActionThreshold_NoZeroSteps = << 214 // Threshold *length* for counting of tiny or 'zero' steps
248 G4int fAbandonThreshold_NoZeroSteps = 50; << 215
249 G4double fZeroStepThreshold = 0.0; <<
250 // Threshold *length* for counting of tin <<
251 <<
252 // Parameters related to handling of very l <<
253 // occur typically in large volumes with <<
254 G4double fLargestAcceptableStep; 216 G4double fLargestAcceptableStep;
255 // Maximum size of a step - for optimizat << 217 // Maximum size of a step - for optimization (and to avoid problems)
256 G4double fMaxStepSizeMultiplier = 3; <<
257 // Multiplier for directional exit distan <<
258 G4double fMinBigDistance= 100. ; // * CLHEP <<
259 // Minimum distance added to directional <<
260 // ** End of PARAMETERS ----- 218 // ** End of PARAMETERS -----
261 219
262 G4double kCarTolerance; 220 G4double kCarTolerance;
263 // Geometrical tolerance defining surfa 221 // Geometrical tolerance defining surface thickness
264 222
265 G4bool fAllocatedLocator; << 223 G4bool fAllocatedLocator; // Book-keeping
266 224
267 // --------------------------------------- 225 // --------------------------------------------------------
268 // ** Dependent Objects - to which work is 226 // ** Dependent Objects - to which work is delegated
269 227
270 G4FieldManager* fDetectorFieldMgr; << 228 G4FieldManager *fDetectorFieldMgr;
271 // The Field Manager of the whole Dete 229 // The Field Manager of the whole Detector. (default)
272 230
273 G4VIntersectionLocator* fIntersectionLocato << 231 G4VIntersectionLocator *fIntersectionLocator;
274 // Refines candidate intersection 232 // Refines candidate intersection
275 233
276 G4VCurvedTrajectoryFilter* fpTrajectoryFilt << 234 G4VCurvedTrajectoryFilter* fpTrajectoryFilter;
277 // The filter encapsulates the algorithm 235 // The filter encapsulates the algorithm which selects which
278 // intermediate points should be stored i 236 // intermediate points should be stored in a trajectory.
279 // When it is NULL, no intermediate point 237 // When it is NULL, no intermediate points will be stored.
280 // Else PIF::ComputeStep must submit (all 238 // Else PIF::ComputeStep must submit (all) intermediate
281 // points it calculates, to this filter. 239 // points it calculates, to this filter. (jacek 04/11/2002)
282 240
283 G4Navigator* fNavigator; << 241 G4Navigator *fNavigator;
284 // Set externally - only by tracking / ru 242 // Set externally - only by tracking / run manager
285 // 243 //
286 // ** End of Dependent Objects ----------- 244 // ** End of Dependent Objects ----------------------------
287 245
288 // End of INVARIANTS 246 // End of INVARIANTS
289 // ======================================= 247 // ==================================================================
290 248
291 // STATE information 249 // STATE information
292 // ----------------- 250 // -----------------
293 G4FieldManager* fCurrentFieldMgr; << 251 G4FieldManager *fCurrentFieldMgr;
294 // The Field Manager of the current volu << 252 // The Field Manager of the current volume (may be the global)
295 G4bool fSetFieldMgr = false; // Has it bee << 253 G4bool fSetFieldMgr; // Has it been set for the current step
296 254
297 // Parameters of current step 255 // Parameters of current step
298 G4double fEpsilonStep; // Relati << 256 G4double fCharge, fInitialMomentumModulus, fMass;
299 G4FieldTrack End_PointAndTangent; // End po << 257 G4double fEpsilonStep; // Relative accuracy of current Step
300 G4bool fParticleIsLooping = false; << 258 G4FieldTrack End_PointAndTangent; // End point storage
301 G4int fNoZeroStep = 0; // Count << 259 G4bool fParticleIsLooping;
>> 260 G4int fNoZeroStep; // Count of zero Steps
302 261
303 // State used for Optimisation 262 // State used for Optimisation
304 G4double fFull_CurveLen_of_LastAttempt = -1 << 263 G4double fFull_CurveLen_of_LastAttempt;
305 G4double fLast_ProposedStepLength = -1; << 264 G4double fLast_ProposedStepLength;
306 // Previous step information -- for use i << 265 // Previous step information -- for use in adjust step size
307 G4ThreeVector fPreviousSftOrigin; << 266 G4ThreeVector fPreviousSftOrigin;
308 G4double fPreviousSafety = 0.0; << 267 G4double fPreviousSafety;
309 // Last safety origin & value: for optimi << 268 // Last safety origin & value: for optimisation
310 << 269
311 G4int fVerboseLevel = 0; << 270 G4int fVerboseLevel;
312 G4bool fVerbTracePiF = false; << 271 // For debuging purposes
313 G4bool fCheck = false; << 272
314 // For debugging purposes << 273 private:
315 <<
316 G4bool fFirstStepInVolume = true; <<
317 G4bool fLastStepInVolume = true; <<
318 G4bool fNewTrack = true; <<
319 }; 274 };
320 275
321 // Inline methods << 276 // Inline methods.
322 // << 277 // *******************************
>> 278
323 #include "G4PropagatorInField.icc" 279 #include "G4PropagatorInField.icc"
324 280
325 #endif 281 #endif
326 282