Class Navigator¶
Defined in File Navigator.hpp
Nested Relationships¶
Nested Types¶
Class Documentation¶
-
class
Acts
::
Navigator
¶ Navigator class.
This is an Actor to be added to the ActorList in order to navigate through the static tracking geometry setup.
The current navigation stage is cached in the state struct and updated when necessary. If any surface in the extrapolation flow is hit, it is set to the propagation satate, such that other actors can deal wit it. This navigation actor thus always needs to run first! It does two things: it figures out the order of volumes, layers and surfaces. For each propagation step, the operator() runs, which checks if the current surface (or layer/volume boundary) is reached.
The current target surface is the surface pointed to by of the iterators for the surfaces, layers or volume boundaries. If a surface is found, the state.navigation.currentSurface pointer is set. This enables subsequent actors to react. Secondly, this actor uses the ordered iterators to figure out which surface, layer or volume boundary is supposed to be hit next. It then sets the maximum step size to the path length found out by straight line intersection. If the state is not on surface, it also re-computes the step size, to make sure we end up at the desired surface.
Public Types
-
using
ExternalSurfaces
= std::multimap<uint64_t, GeometryIdentifier>¶
-
using
NavigationBoundaries
= std::vector<BoundaryIntersection>¶
-
using
NavigationBoundaryIter
= NavigationBoundaries::iterator¶
-
using
NavigationLayerIter
= NavigationLayers::iterator¶
-
using
NavigationLayers
= std::vector<LayerIntersection>¶
-
using
NavigationSurfaceIter
= NavigationSurfaces::iterator¶
-
using
NavigationSurfaces
= std::vector<SurfaceIntersection>¶
Public Functions
-
Navigator
(std::shared_ptr<const TrackingGeometry> tGeometry = nullptr)¶ Constructor with shared tracking geometry.
- Parameters
tGeometry
: The tracking geometry for the navigator
-
template<typename
propagator_state_t
, typenamestepper_t
>
voidstatus
(propagator_state_t &state, const stepper_t &stepper) const¶ Navigator status call, will be called in two modes.
(a) It initializes the Navigation stream if start volume is not yet defined:
initialize the volume
establish the start layer and start volume
set the current surface to the start surface
(b) It establishes the currentSurface status during the propagation flow, currentSurface can be
surfaces still to be handled within a layer
layers still to be handled within a volume
boundaries still to be handled to exit a volume
- Template Parameters
propagator_state_t
: is the type of Propagatgor statestepper_t
: is the used type of the Stepper by the Propagator
- Parameters
[inout] state
: is the mutable propagator state object[in] stepper
: Stepper in use
-
template<typename
propagator_state_t
, typenamestepper_t
>
voidtarget
(propagator_state_t &state, const stepper_t &stepper) const¶ Navigator target call.
Call options (a) there are still surfaces to be resolved: handle those (b) there no surfaces but still layers to be resolved, handle those (c) there are no surfaces nor layers to be resolved, handle boundary
- Template Parameters
propagator_state_t
: is the type of Propagatgor statestepper_t
: is the used type of the Stepper by the Propagator
- Parameters
[inout] state
: is the mutable propagator state object[in] stepper
: Stepper in use
Public Members
-
bool
resolveMaterial
= true¶ stop at every material surface (whether it is passive or not)
-
bool
resolvePassive
= false¶ stop at every surface regardless what it is
-
bool
resolveSensitive
= true¶ Configuration for this Navigator stop at every sensitive surface (whether it has material or not)
-
double
tolerance
= s_onSurfaceTolerance¶ The tolerance used to defined “reached”.
-
std::shared_ptr<const TrackingGeometry>
trackingGeometry
¶ Tracking Geometry for this Navigator.
-
struct
State
¶ Nested State struct.
It acts as an internal state which is created for every propagation/extrapolation step and keep thread-local navigation information
Public Members
-
const TrackingVolume *
currentVolume
= nullptr¶ Navigation state: the current volume.
-
ExternalSurfaces
externalSurfaces
= {}¶ Externally provided surfaces - these are tried to be hit.
-
bool
lastHierarchySurfaceReached
= false¶ Indicator that the last VolumeHierarchy surface was reached skip the next layer targeting to the next boundary/volume.
-
NavigationBoundaries
navBoundaries
= {}¶ the vector of boundary surfaces to work through
-
NavigationBoundaryIter
navBoundaryIter
= navBoundaries.end()¶ the current boundary iterator of the navigation state
-
bool
navigationBreak
= false¶ Navigation state : a break has been detected.
-
NavigationLayerIter
navLayerIter
= navLayers.end()¶ the current layer iterator of the navigation state
-
NavigationLayers
navLayers
= {}¶ the vector of navigation layers to work through
-
NavigationSurfaceIter
navSurfaceIter
= navSurfaces.end()¶ the current surface iterator of the navigation state
-
NavigationSurfaces
navSurfaces
= {}¶ the vector of navigation surfaces to work through
-
bool
startLayerResolved
= false¶ Indicator for start layer treatment.
-
const TrackingVolume *
startVolume
= nullptr¶ Navigation state: the start volume.
-
bool
targetReached
= false¶ Indicator if the target is reached.
-
const TrackingVolume *
targetVolume
= nullptr¶ Navigation state: the target volume.
-
const TrackingVolume *
worldVolume
= nullptr¶ Navigation sate: the world volume.
-
const TrackingVolume *
-
using