| 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 // class G4SafetyHelper 26 // class G4SafetyHelper
27 // 27 //
28 // Class description: 28 // Class description:
29 // 29 //
30 // This class is a helper for physics processe 30 // This class is a helper for physics processes which require
31 // knowledge of the safety, and the step size 31 // knowledge of the safety, and the step size for the 'mass' geometry
32 32
33 // First version: J.Apostolakis, July 5th, 2 33 // First version: J.Apostolakis, July 5th, 2006
34 // ------------------------------------------- 34 // --------------------------------------------------------------------
35 #ifndef G4SAFETYHELPER_HH 35 #ifndef G4SAFETYHELPER_HH
36 #define G4SAFETYHELPER_HH 1 36 #define G4SAFETYHELPER_HH 1
37 37
38 #include <vector> 38 #include <vector>
39 39
40 #include "G4Types.hh" 40 #include "G4Types.hh"
41 #include "G4ThreeVector.hh" 41 #include "G4ThreeVector.hh"
42 #include "G4Navigator.hh" 42 #include "G4Navigator.hh"
43 43
44 class G4PathFinder; 44 class G4PathFinder;
45 45
46 class G4SafetyHelper 46 class G4SafetyHelper
47 { 47 {
48 public: // with description 48 public: // with description
49 49
50 G4SafetyHelper(); 50 G4SafetyHelper();
51 ~G4SafetyHelper(); 51 ~G4SafetyHelper();
52 // Constructor and destructor 52 // Constructor and destructor
53 53
54 G4double CheckNextStep( const G4ThreeVecto 54 G4double CheckNextStep( const G4ThreeVector& position,
55 const G4ThreeVecto 55 const G4ThreeVector& direction,
56 const G4double cur 56 const G4double currentMaxStep,
57 G4double& ne 57 G4double& newSafety );
58 // Return linear step for mass geometry 58 // Return linear step for mass geometry
59 59
60 G4double ComputeSafety( const G4ThreeVecto 60 G4double ComputeSafety( const G4ThreeVector& pGlobalPoint,
61 G4double maxRadius 61 G4double maxRadius = DBL_MAX );
62 // Return safety for all geometries. 62 // Return safety for all geometries.
63 // 63 //
64 // The 2nd argument is the radius of you 64 // The 2nd argument is the radius of your interest (e.g. maximum
65 // displacement). Giving this you can re 65 // displacement). Giving this you can reduce the average computational
66 // cost. If the second argument is not g 66 // cost. If the second argument is not given, this is the real
67 // isotropic safety 67 // isotropic safety
68 68
69 void Locate(const G4ThreeVector& pGlobalPo 69 void Locate(const G4ThreeVector& pGlobalPoint,
70 const G4ThreeVector& direction 70 const G4ThreeVector& direction);
71 // Locate the point for all geometries 71 // Locate the point for all geometries
72 72
73 void ReLocateWithinVolume(const G4ThreeVec 73 void ReLocateWithinVolume(const G4ThreeVector& pGlobalPoint );
74 // Relocate the point in the volume of i 74 // Relocate the point in the volume of interest
75 75
76 inline void EnableParallelNavigation(G4boo 76 inline void EnableParallelNavigation(G4bool parallel);
77 // To have parallel worlds considered, 77 // To have parallel worlds considered, must be true.
78 // Alternative is to use single (mass) 78 // Alternative is to use single (mass) Navigator directly
79 79
80 void InitialiseNavigator(); 80 void InitialiseNavigator();
81 // Check for new navigator for tracking, 81 // Check for new navigator for tracking, and reinitialise pointer
82 82
83 inline G4int SetVerboseLevel( G4int lev ); 83 inline G4int SetVerboseLevel( G4int lev );
84 inline G4VPhysicalVolume* GetWorldVolume() 84 inline G4VPhysicalVolume* GetWorldVolume();
85 inline void SetCurrentSafety(G4double val, 85 inline void SetCurrentSafety(G4double val, const G4ThreeVector& pos);
86 86
87 public: // without description 87 public: // without description
88 88
89 void InitialiseHelper(); 89 void InitialiseHelper();
90 90
91 private: 91 private:
92 92
93 G4PathFinder* fpPathFinder = nullptr; 93 G4PathFinder* fpPathFinder = nullptr;
94 G4Navigator* fpMassNavigator = nullptr; 94 G4Navigator* fpMassNavigator = nullptr;
95 95
96 G4bool fUseParallelGeometries = false; 96 G4bool fUseParallelGeometries = false;
97 // Flag whether to use PathFinder or sin 97 // Flag whether to use PathFinder or single (mass) Navigator directly
98 // By default, one geometry only 98 // By default, one geometry only
99 G4bool fFirstCall = true; 99 G4bool fFirstCall = true;
100 // Flag of first call 100 // Flag of first call
101 G4int fVerbose = 0; 101 G4int fVerbose = 0;
102 // Whether to print warning in case of m 102 // Whether to print warning in case of move outside safety
103 103
104 // State used during tracking -- for optim 104 // State used during tracking -- for optimisation
105 105
106 G4ThreeVector fLastSafetyPosition; 106 G4ThreeVector fLastSafetyPosition;
107 G4double fLastSafety = 0.0; 107 G4double fLastSafety = 0.0;
108 108
109 // const G4double fRecomputeFactor = 0.0; 109 // const G4double fRecomputeFactor = 0.0;
110 // parameter for further optimisation: 110 // parameter for further optimisation:
111 // if ( move < fact*safety ) do fast r 111 // if ( move < fact*safety ) do fast recomputation of safety
112 112
113 // End State (tracking) 113 // End State (tracking)
114 }; 114 };
115 115
116 // ------------------------------------------- 116 // --------------------------------------------------------------------
117 // Inline definitions 117 // Inline definitions
118 // ------------------------------------------- 118 // --------------------------------------------------------------------
119 119
120 inline G4int G4SafetyHelper::SetVerboseLevel( 120 inline G4int G4SafetyHelper::SetVerboseLevel( G4int lev )
121 { 121 {
122 G4int oldlv = fVerbose; 122 G4int oldlv = fVerbose;
123 fVerbose = lev; 123 fVerbose = lev;
124 return oldlv; 124 return oldlv;
125 } 125 }
126 126
127 inline 127 inline
128 void G4SafetyHelper::EnableParallelNavigation( 128 void G4SafetyHelper::EnableParallelNavigation(G4bool parallel)
129 { 129 {
130 fUseParallelGeometries = parallel; 130 fUseParallelGeometries = parallel;
131 } 131 }
132 132
133 inline 133 inline
134 G4VPhysicalVolume* G4SafetyHelper::GetWorldVol 134 G4VPhysicalVolume* G4SafetyHelper::GetWorldVolume()
135 { 135 {
136 return fpMassNavigator->GetWorldVolume(); 136 return fpMassNavigator->GetWorldVolume();
137 } 137 }
138 138
139 inline 139 inline
140 void G4SafetyHelper::SetCurrentSafety(G4double 140 void G4SafetyHelper::SetCurrentSafety(G4double val, const G4ThreeVector& pos)
141 { 141 {
142 fLastSafety = val; 142 fLastSafety = val;
143 fLastSafetyPosition = pos; 143 fLastSafetyPosition = pos;
144 } 144 }
145 145
146 #endif 146 #endif
147 147