| Geant4 Cross Reference |
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 // class G4VNavigation
27 //
28 // Class description:
29 //
30 // Navigation interface common between all navigator types.
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 navigation interface
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 current top level of @p history
56 * for volume containing @p globalPoint. Do not test against @p blockedVol.
57 * If a containing volume is found, push it onto navigation history state.
58 * @param[in,out] history Navigation history.
59 * @param[in,out] blockedVol Blocked volume that should be ignored in queries.
60 * @param[in,out] blockedNum Copy number for blocked replica volumes.
61 * @param[in,out] globalPoint Global point
62 * @param[in,out] globalDirection Pointer to global direction or null pointer.
63 * @param[in,out] localPoint = global point in local system on entry, point
64 * in new system on exit.
65 * @returns Whether a containing volume has been found.
66 */
67 virtual G4bool LevelLocate(G4NavigationHistory& history,
68 const G4VPhysicalVolume* blockedVol,
69 const G4int blockedNum,
70 const G4ThreeVector& globalPoint,
71 const G4ThreeVector* globalDirection,
72 const G4bool pLocatedOnEdge,
73 G4ThreeVector& localPoint) = 0;
74
75 /**
76 * Compute the length of a step to the next boundary.
77 * Do not test against @p pBlockedPhysical. Identify the next candidate volume
78 * (if a daughter of current volume), and return it in pBlockedPhysical,
79 * blockedReplicaNo.
80 * @param[in] localPoint Local point
81 * @param[in] localDirection Pointer to local direction or null pointer.
82 * @param[in] currentProposedStepLength Current proposed step length.
83 * @param[in,out] newSafety New safety.
84 * @param[in,out] history Navigation history.
85 * @param[in,out] validExitNormal Flag to indicate whether exit normal is
86 * valid or not.
87 * @param[in,out] exitNormal Exit normal.
88 * @param[in,out] entering Flag to indicate whether we are entering a volume.
89 * @param[in,out] exiting Flag to indicate whether we are exiting a volume.
90 * @param[in,out] pBlockedPhysical Blocked physical volume that should be
91 * ignored in queries.
92 * @param[in,out] blockedReplicaNo Copy number for blocked replica volumes.
93 * @returns Length from current point to next boundary surface along @p
94 * localDirection.
95 */
96 virtual G4double ComputeStep(const G4ThreeVector& localPoint,
97 const G4ThreeVector& localDirection,
98 const G4double currentProposedStepLength,
99 G4double& newSafety,
100 G4NavigationHistory& history,
101 G4bool& validExitNormal,
102 G4ThreeVector& exitNormal,
103 G4bool& exiting,
104 G4bool& entering,
105 G4VPhysicalVolume*(*pBlockedPhysical),
106 G4int& blockedReplicaNo) = 0;
107
108 /**
109 * Compute the distance to the closest surface.
110 * @param[in] globalPoint Global point.
111 * @param[in] history Navigation history.
112 * @param[in] pMaxLength Maximum step length beyond which volumes need not be
113 * checked.
114 * @returns Length from current point to closest surface.
115 */
116 virtual G4double ComputeSafety(const G4ThreeVector& globalpoint,
117 const G4NavigationHistory& history,
118 const G4double pMaxLength = DBL_MAX) = 0;
119
120 /**
121 * Update internal navigation state to take into account that location
122 * has been moved, but remains within the @p motherPhysical volume.
123 * @param[in] motherPhysical Current physical volume.
124 * @param[in] localPoint Local point.
125 */
126 virtual void RelocateWithinVolume(G4VPhysicalVolume* /* motherPhysical */,
127 const G4ThreeVector& /* localPoint */)
128 {
129 /* do nothing by default */
130 }
131
132 /** Get current verbosity level */
133 virtual G4int GetVerboseLevel() const { return fVerbose; }
134
135 /** Set current verbosity level */
136 virtual void SetVerboseLevel(G4int level) { fVerbose = level; }
137
138 /**
139 * Set check mode.
140 * When enabled, forces navigator to run in "check mode", hence using
141 * additional verifications and stricter condictions for ensuring correctness.
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