| Geant4 Cross Reference |
1 // 1
2 // *******************************************
3 // * License and Disclaimer
4 // *
5 // * The Geant4 software is copyright of th
6 // * the Geant4 Collaboration. It is provided
7 // * conditions of the Geant4 Software License
8 // * LICENSE and available at http://cern.ch/
9 // * include a list of copyright holders.
10 // *
11 // * Neither the authors of this software syst
12 // * institutes,nor the agencies providing fin
13 // * work make any representation or warran
14 // * regarding this software system or assum
15 // * use. Please see the license in the file
16 // * for the full disclaimer and the limitatio
17 // *
18 // * This code implementation is the result
19 // * technical work of the GEANT4 collaboratio
20 // * By using, copying, modifying or distri
21 // * any work based on the software) you ag
22 // * use in resulting scientific publicati
23 // * acceptance of all terms of the Geant4 Sof
24 // *******************************************
25 //
26 // class G4VNavigation
27 //
28 // Class description:
29 //
30 // Navigation interface common between all nav
31
32 // Author: G. Amadio - CERN, March 2022
33 // -------------------------------------------
34 #ifndef G4VNAVIGATION_HH
35 #define G4VNAVIGATION_HH
36
37 #include "G4ThreeVector.hh"
38
39 class G4LogicalVolume;
40 class G4VPhysicalVolume;
41 class G4NavigationHistory;
42
43 /**
44 * @brief G4VNavigation class holds the common
45 * for all geometry navigator types.
46 */
47
48 class G4VNavigation
49 {
50 public:
51 /** Virtual Destructor. */
52 virtual ~G4VNavigation() = default;
53
54 /**
55 * Search positioned volumes in mother at cu
56 * for volume containing @p globalPoint. Do
57 * If a containing volume is found, push it
58 * @param[in,out] history Navigation history
59 * @param[in,out] blockedVol Blocked volume
60 * @param[in,out] blockedNum Copy number for
61 * @param[in,out] globalPoint Global point
62 * @param[in,out] globalDirection Pointer to
63 * @param[in,out] localPoint = global point
64 * in new system on exit.
65 * @returns Whether a containing volume has
66 */
67 virtual G4bool LevelLocate(G4NavigationHisto
68 const G4VPhysical
69 const G4int block
70 const G4ThreeVect
71 const G4ThreeVect
72 const G4bool pLoc
73 G4ThreeVector& lo
74
75 /**
76 * Compute the length of a step to the next
77 * Do not test against @p pBlockedPhysical.
78 * (if a daughter of current volume), and re
79 * blockedReplicaNo.
80 * @param[in] localPoint Local point
81 * @param[in] localDirection Pointer to loca
82 * @param[in] currentProposedStepLength Curr
83 * @param[in,out] newSafety New safety.
84 * @param[in,out] history Navigation history
85 * @param[in,out] validExitNormal Flag to in
86 * valid or not.
87 * @param[in,out] exitNormal Exit normal.
88 * @param[in,out] entering Flag to indicate
89 * @param[in,out] exiting Flag to indicate w
90 * @param[in,out] pBlockedPhysical Blocked p
91 * ignored in queries.
92 * @param[in,out] blockedReplicaNo Copy numb
93 * @returns Length from current point to nex
94 * localDirection.
95 */
96 virtual G4double ComputeStep(const G4ThreeVe
97 const G4ThreeVe
98 const G4double
99 G4double& newSa
100 G4NavigationHis
101 G4bool& validEx
102 G4ThreeVector&
103 G4bool& exiting
104 G4bool& enterin
105 G4VPhysicalVolu
106 G4int& blockedR
107
108 /**
109 * Compute the distance to the closest surfa
110 * @param[in] globalPoint Global point.
111 * @param[in] history Navigation history.
112 * @param[in] pMaxLength Maximum step length
113 * checked.
114 * @returns Length from current point to clo
115 */
116 virtual G4double ComputeSafety(const G4Three
117 const G4Navig
118 const G4doubl
119
120 /**
121 * Update internal navigation state to take
122 * has been moved, but remains within the @p
123 * @param[in] motherPhysical Current physic
124 * @param[in] localPoint Local point.
125 */
126 virtual void RelocateWithinVolume(G4VPhysica
127 const G4Th
128 {
129 /* do nothing by default */
130 }
131
132 /** Get current verbosity level */
133 virtual G4int GetVerboseLevel() const { retu
134
135 /** Set current verbosity level */
136 virtual void SetVerboseLevel(G4int level) {
137
138 /**
139 * Set check mode.
140 * When enabled, forces navigator to run in
141 * additional verifications and stricter con
142 * Effective only when G4VERBOSE is enabled.
143 */
144 void CheckMode(G4bool mode) { fCheck = mode;
145
146 protected:
147 G4int fVerbose = 0;
148 G4bool fCheck = false;
149 };
150
151 #endif
152