| 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 G4VNavigation 26 // class G4VNavigation
27 // 27 //
28 // Class description: 28 // Class description:
29 // 29 //
30 // Navigation interface common between all nav 30 // Navigation interface common between all navigator types.
31 31
32 // Author: G. Amadio - CERN, March 2022 32 // Author: G. Amadio - CERN, March 2022
33 // ------------------------------------------- 33 // --------------------------------------------------------------------
34 #ifndef G4VNAVIGATION_HH 34 #ifndef G4VNAVIGATION_HH
35 #define G4VNAVIGATION_HH 35 #define G4VNAVIGATION_HH
36 36
37 #include "G4ThreeVector.hh" 37 #include "G4ThreeVector.hh"
38 38
39 class G4LogicalVolume; 39 class G4LogicalVolume;
40 class G4VPhysicalVolume; 40 class G4VPhysicalVolume;
41 class G4NavigationHistory; 41 class G4NavigationHistory;
42 42
43 /** 43 /**
44 * @brief G4VNavigation class holds the common 44 * @brief G4VNavigation class holds the common navigation interface
45 * for all geometry navigator types. 45 * for all geometry navigator types.
46 */ 46 */
47 47
48 class G4VNavigation 48 class G4VNavigation
49 { 49 {
50 public: 50 public:
51 /** Virtual Destructor. */ 51 /** Virtual Destructor. */
52 virtual ~G4VNavigation() = default; << 52 virtual ~G4VNavigation() {}
53 53
54 /** 54 /**
55 * Search positioned volumes in mother at cu 55 * Search positioned volumes in mother at current top level of @p history
56 * for volume containing @p globalPoint. Do 56 * for volume containing @p globalPoint. Do not test against @p blockedVol.
57 * If a containing volume is found, push it 57 * If a containing volume is found, push it onto navigation history state.
58 * @param[in,out] history Navigation history 58 * @param[in,out] history Navigation history.
59 * @param[in,out] blockedVol Blocked volume 59 * @param[in,out] blockedVol Blocked volume that should be ignored in queries.
60 * @param[in,out] blockedNum Copy number for 60 * @param[in,out] blockedNum Copy number for blocked replica volumes.
61 * @param[in,out] globalPoint Global point 61 * @param[in,out] globalPoint Global point
62 * @param[in,out] globalDirection Pointer to 62 * @param[in,out] globalDirection Pointer to global direction or null pointer.
63 * @param[in,out] localPoint = global point 63 * @param[in,out] localPoint = global point in local system on entry, point
64 * in new system on exit. 64 * in new system on exit.
65 * @returns Whether a containing volume has 65 * @returns Whether a containing volume has been found.
66 */ 66 */
67 virtual G4bool LevelLocate(G4NavigationHisto 67 virtual G4bool LevelLocate(G4NavigationHistory& history,
68 const G4VPhysical 68 const G4VPhysicalVolume* blockedVol,
69 const G4int block 69 const G4int blockedNum,
70 const G4ThreeVect 70 const G4ThreeVector& globalPoint,
71 const G4ThreeVect 71 const G4ThreeVector* globalDirection,
72 const G4bool pLoc 72 const G4bool pLocatedOnEdge,
73 G4ThreeVector& lo 73 G4ThreeVector& localPoint) = 0;
74 74
75 /** 75 /**
76 * Compute the length of a step to the next 76 * Compute the length of a step to the next boundary.
77 * Do not test against @p pBlockedPhysical. 77 * Do not test against @p pBlockedPhysical. Identify the next candidate volume
78 * (if a daughter of current volume), and re 78 * (if a daughter of current volume), and return it in pBlockedPhysical,
79 * blockedReplicaNo. 79 * blockedReplicaNo.
80 * @param[in] localPoint Local point 80 * @param[in] localPoint Local point
81 * @param[in] localDirection Pointer to loca 81 * @param[in] localDirection Pointer to local direction or null pointer.
82 * @param[in] currentProposedStepLength Curr 82 * @param[in] currentProposedStepLength Current proposed step length.
83 * @param[in,out] newSafety New safety. 83 * @param[in,out] newSafety New safety.
84 * @param[in,out] history Navigation history 84 * @param[in,out] history Navigation history.
85 * @param[in,out] validExitNormal Flag to in 85 * @param[in,out] validExitNormal Flag to indicate whether exit normal is
86 * valid or not. 86 * valid or not.
87 * @param[in,out] exitNormal Exit normal. 87 * @param[in,out] exitNormal Exit normal.
88 * @param[in,out] entering Flag to indicate 88 * @param[in,out] entering Flag to indicate whether we are entering a volume.
89 * @param[in,out] exiting Flag to indicate w 89 * @param[in,out] exiting Flag to indicate whether we are exiting a volume.
90 * @param[in,out] pBlockedPhysical Blocked p 90 * @param[in,out] pBlockedPhysical Blocked physical volume that should be
91 * ignored in queries. 91 * ignored in queries.
92 * @param[in,out] blockedReplicaNo Copy numb 92 * @param[in,out] blockedReplicaNo Copy number for blocked replica volumes.
93 * @returns Length from current point to nex 93 * @returns Length from current point to next boundary surface along @p
94 * localDirection. 94 * localDirection.
95 */ 95 */
96 virtual G4double ComputeStep(const G4ThreeVe 96 virtual G4double ComputeStep(const G4ThreeVector& localPoint,
97 const G4ThreeVe 97 const G4ThreeVector& localDirection,
98 const G4double 98 const G4double currentProposedStepLength,
99 G4double& newSa 99 G4double& newSafety,
100 G4NavigationHis 100 G4NavigationHistory& history,
101 G4bool& validEx 101 G4bool& validExitNormal,
102 G4ThreeVector& 102 G4ThreeVector& exitNormal,
103 G4bool& exiting 103 G4bool& exiting,
104 G4bool& enterin 104 G4bool& entering,
105 G4VPhysicalVolu 105 G4VPhysicalVolume*(*pBlockedPhysical),
106 G4int& blockedR 106 G4int& blockedReplicaNo) = 0;
107 107
108 /** 108 /**
109 * Compute the distance to the closest surfa 109 * Compute the distance to the closest surface.
110 * @param[in] globalPoint Global point. 110 * @param[in] globalPoint Global point.
111 * @param[in] history Navigation history. 111 * @param[in] history Navigation history.
112 * @param[in] pMaxLength Maximum step length 112 * @param[in] pMaxLength Maximum step length beyond which volumes need not be
113 * checked. 113 * checked.
114 * @returns Length from current point to clo 114 * @returns Length from current point to closest surface.
115 */ 115 */
116 virtual G4double ComputeSafety(const G4Three 116 virtual G4double ComputeSafety(const G4ThreeVector& globalpoint,
117 const G4Navig 117 const G4NavigationHistory& history,
118 const G4doubl 118 const G4double pMaxLength = DBL_MAX) = 0;
119 119
120 /** 120 /**
121 * Update internal navigation state to take 121 * Update internal navigation state to take into account that location
122 * has been moved, but remains within the @p 122 * has been moved, but remains within the @p motherPhysical volume.
123 * @param[in] motherPhysical Current physic 123 * @param[in] motherPhysical Current physical volume.
124 * @param[in] localPoint Local point. 124 * @param[in] localPoint Local point.
125 */ 125 */
126 virtual void RelocateWithinVolume(G4VPhysica 126 virtual void RelocateWithinVolume(G4VPhysicalVolume* /* motherPhysical */,
127 const G4Th 127 const G4ThreeVector& /* localPoint */)
128 { 128 {
129 /* do nothing by default */ 129 /* do nothing by default */
130 } 130 }
131 131
132 /** Get current verbosity level */ 132 /** Get current verbosity level */
133 virtual G4int GetVerboseLevel() const { retu 133 virtual G4int GetVerboseLevel() const { return fVerbose; }
134 134
135 /** Set current verbosity level */ 135 /** Set current verbosity level */
136 virtual void SetVerboseLevel(G4int level) { 136 virtual void SetVerboseLevel(G4int level) { fVerbose = level; }
137 137
138 /** 138 /**
139 * Set check mode. 139 * Set check mode.
140 * When enabled, forces navigator to run in 140 * When enabled, forces navigator to run in "check mode", hence using
141 * additional verifications and stricter con 141 * additional verifications and stricter condictions for ensuring correctness.
142 * Effective only when G4VERBOSE is enabled. 142 * Effective only when G4VERBOSE is enabled.
143 */ 143 */
144 void CheckMode(G4bool mode) { fCheck = mode; 144 void CheckMode(G4bool mode) { fCheck = mode; }
145 145
146 protected: 146 protected:
147 G4int fVerbose = 0; 147 G4int fVerbose = 0;
148 G4bool fCheck = false; 148 G4bool fCheck = false;
149 }; 149 };
150 150
151 #endif 151 #endif
152 152