Geant4  10.03
G4MultiLevelLocator.hh
Go to the documentation of this file.
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 //
27 // $Id: G4MultiLevelLocator.hh 94380 2015-11-13 10:14:39Z gcosmo $
28 //
29 //
30 // Class G4MultiLevelLocator
31 //
32 // class description:
33 //
34 // Implementing the calculation of the intersection point with a boundary when
35 // PropagationInField is used. Derived from method LocateIntersectionPoint()
36 // from G4PropagatorInField, it is based on a linear method for finding the
37 // intersection point by means of a 'depth' algorithm in case of slow progress
38 // (intersection is not found after 100 trials).
39 
40 // History:
41 // -------
42 // 27.10.08 - Tatiana Nikitina: Derived from LocateIntersectionPoint() from
43 // G4PropagatorInField class
44 // ---------------------------------------------------------------------------
45 
46 #ifndef G4MULTILEVELLOCATOR_HH
47 #define G4MULTILEVELLOCATOR_HH
48 
50 
52 {
53  public: // with description
54 
55  G4MultiLevelLocator(G4Navigator *theNavigator);
56  // Constructor
58  // Default destructor
59 
61  const G4FieldTrack& curveStartPointTangent, // A
62  const G4FieldTrack& curveEndPointTangent, // B
63  const G4ThreeVector& trialPoint, // E
64  G4FieldTrack& intersectPointTangent, // Output
65  G4bool& recalculatedEndPoint, // Out
66  G4double& fPreviousSafety, // In/Out
68  // If such an intersection exists, this function calculates the
69  // intersection point of the true path of the particle with the surface
70  // of the current volume (or of one of its daughters).
71  // Should use lateral displacement as measure of convergence
72 
73  void ReportStatistics();
74 
75  inline void SetMaxSteps(unsigned int valMax) { fMaxSteps= valMax; }
76  inline void SetWarnSteps(unsigned int valWarn) { fWarnSteps= valWarn; }
77 
78  private:
79 
80  void ReportFieldValue( const G4FieldTrack& locationPV,
81  const char* nameLoc,
82  const G4EquationOfMotion* equation );
83 
84  // Invariants -- parameters
85  // ====================================
86  static const G4int max_depth=10;
87  unsigned int fMaxSteps; // Effort abandoned; signal particle is looping
88  unsigned int fWarnSteps; // Warn about many steps (but it has succeeded)
89 
90  // State - varies during simulation
91  // ====================================
92  G4FieldTrack* ptrInterMedFT[max_depth+1];
93  // Used to store intermediate tracks values in case of too slow progress
94 
95  unsigned long int fNumCalls;
97  // Counters for statistics & debugging
98 };
99 
100 #endif
G4FieldTrack * ptrInterMedFT[max_depth+1]
void ReportFieldValue(const G4FieldTrack &locationPV, const char *nameLoc, const G4EquationOfMotion *equation)
CLHEP::Hep3Vector G4ThreeVector
G4bool EstimateIntersectionPoint(const G4FieldTrack &curveStartPointTangent, const G4FieldTrack &curveEndPointTangent, const G4ThreeVector &trialPoint, G4FieldTrack &intersectPointTangent, G4bool &recalculatedEndPoint, G4double &fPreviousSafety, G4ThreeVector &fPreviousSftOrigin)
void SetWarnSteps(unsigned int valWarn)
int G4int
Definition: G4Types.hh:78
unsigned long int fNumAdvanceTrials
static const G4int max_depth
G4MultiLevelLocator(G4Navigator *theNavigator)
bool G4bool
Definition: G4Types.hh:79
#define fPreviousSftOrigin
#define fPreviousSafety
void SetMaxSteps(unsigned int valMax)
double G4double
Definition: G4Types.hh:76
unsigned long int fNumAdvanceGood
unsigned long int fNumAdvanceFull
unsigned long int fNumCalls