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