| Geant4 Cross Reference |
1 //
2 // ********************************************************************
3 // * License and Disclaimer *
4 // * *
5 // * The Geant4 software is copyright of the Copyright Holders of *
6 // * the Geant4 Collaboration. It is provided under the terms and *
7 // * conditions of the Geant4 Software License, included in the file *
8 // * LICENSE and available at http://cern.ch/geant4/license . These *
9 // * include a list of copyright holders. *
10 // * *
11 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file LICENSE and URL above *
16 // * for the full disclaimer and the limitation of liability. *
17 // * *
18 // * This code implementation is the result of the scientific and *
19 // * technical work of the GEANT4 collaboration. *
20 // * By using, copying, modifying or distributing the software (or *
21 // * any work based on the software) you agree to acknowledge its *
22 // * use in resulting scientific publications, and indicate your *
23 // * acceptance of all terms of the Geant4 Software license. *
24 // ********************************************************************
25 //
26 // Class G4MultiLevelLocator
27 //
28 // class description:
29 //
30 // Implementing the calculation of the intersection point with a boundary when
31 // PropagationInField is used. Derived from method LocateIntersectionPoint()
32 // from G4PropagatorInField, it is based on a linear method for finding the
33 // intersection point by means of a 'depth' algorithm in case of slow progress
34 // (intersection is not found after 100 trials).
35
36 // History:
37 // -------
38 // 27.10.08 - Tatiana Nikitina: Derived from LocateIntersectionPoint() from
39 // G4PropagatorInField class
40 // ---------------------------------------------------------------------------
41
42 #ifndef G4MULTILEVELLOCATOR_HH
43 #define G4MULTILEVELLOCATOR_HH
44
45 #include "G4VIntersectionLocator.hh"
46
47 class G4MultiLevelLocator : public G4VIntersectionLocator
48 {
49 public: // with description
50
51 G4MultiLevelLocator(G4Navigator *theNavigator);
52 // Constructor
53 ~G4MultiLevelLocator() override;
54 // Default destructor
55
56 G4bool EstimateIntersectionPoint(
57 const G4FieldTrack& curveStartPointTangent, // A
58 const G4FieldTrack& curveEndPointTangent, // B
59 const G4ThreeVector& trialPoint, // E
60 G4FieldTrack& intersectPointTangent, // Output
61 G4bool& recalculatedEndPoint, // Out
62 G4double& fPreviousSafety, // In/Out
63 G4ThreeVector& fPreviousSftOrigin) override; // In/Out
64 // If such an intersection exists, this function calculates the
65 // intersection point of the true path of the particle with the surface
66 // of the current volume (or of one of its daughters).
67 // Should use lateral displacement as measure of convergence
68
69 void ReportStatistics();
70
71 inline void SetMaxSteps(unsigned int valMax) { fMaxSteps= valMax; }
72 inline void SetWarnSteps(unsigned int valWarn) { fWarnSteps= valWarn; }
73
74 private:
75
76 void ReportFieldValue( const G4FieldTrack& locationPV,
77 const char* nameLoc,
78 const G4EquationOfMotion* equation );
79
80 // Invariants -- parameters
81 // ====================================
82 static const G4int max_depth = 10;
83 unsigned int fMaxSteps = 10000; // Effort abandoned; signal is looping
84 unsigned int fWarnSteps = 1000; // Warn about many steps (but succeeded)
85
86 // State - varies during simulation
87 // ====================================
88 G4FieldTrack* ptrInterMedFT[max_depth+1];
89 // Used to store intermediate tracks values in case of too slow progress
90
91 unsigned long int fNumCalls = 0;
92 unsigned long int fNumAdvanceFull = 0,
93 fNumAdvanceGood = 0,
94 fNumAdvanceTrials = 0;
95 // Counters for statistics & debugging
96 };
97
98 #endif
99