Analysis Software
Documentation for sPHENIX simulation software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Acts::Navigator::State Struct Reference

#include <acts/blob/sPHENIX/Core/include/Acts/Propagator/Navigator.hpp>

+ Collaboration diagram for Acts::Navigator::State:

Public Member Functions

auto navSurface () const
 
auto navLayer () const
 
auto navBoundary () const
 

Public Attributes

NavigationSurfaces navSurfaces = {}
 the vector of navigation surfaces to work through
 
std::size_t navSurfaceIndex = navSurfaces.size()
 the current surface index of the navigation state
 
NavigationLayers navLayers = {}
 the vector of navigation layers to work through
 
std::size_t navLayerIndex = navLayers.size()
 the current layer index of the navigation state
 
NavigationBoundaries navBoundaries = {}
 the vector of boundary surfaces to work through
 
std::size_t navBoundaryIndex = navBoundaries.size()
 the current boundary index of the navigation state
 
ExternalSurfaces externalSurfaces = {}
 Externally provided surfaces - these are tried to be hit.
 
const TrackingVolumeworldVolume = nullptr
 Navigation state: the world volume.
 
const TrackingVolumestartVolume = nullptr
 Navigation state: the start volume.
 
const LayerstartLayer = nullptr
 Navigation state: the start layer.
 
const SurfacestartSurface = nullptr
 Navigation state: the start surface.
 
const SurfacecurrentSurface = nullptr
 Navigation state - external state: the current surface.
 
const TrackingVolumecurrentVolume = nullptr
 Navigation state: the current volume.
 
const TrackingVolumetargetVolume = nullptr
 Navigation state: the target volume.
 
const LayertargetLayer = nullptr
 Navigation state: the target layer.
 
const SurfacetargetSurface = nullptr
 Navigation state: the target surface.
 
bool startLayerResolved = false
 Indicator for start layer treatment.
 
bool targetReached = false
 Indicator if the target is reached.
 
bool lastHierarchySurfaceReached = false
 
bool navigationBreak = false
 Navigation state : a break has been detected.
 
Stage navigationStage = Stage::undefined
 
bool forceIntersectBoundaries = false
 Force intersection with boundaries.
 

Detailed Description

Nested State struct

It acts as an internal state which is created for every propagation/extrapolation step and keep thread-local navigation information

Definition at line 136 of file Navigator.hpp.

View newest version in sPHENIX GitHub at line 136 of file Navigator.hpp

Member Function Documentation

auto Acts::Navigator::State::navBoundary ( ) const
inline

Definition at line 157 of file Navigator.hpp.

View newest version in sPHENIX GitHub at line 157 of file Navigator.hpp

References navBoundaries, and navBoundaryIndex.

auto Acts::Navigator::State::navLayer ( ) const
inline

Definition at line 156 of file Navigator.hpp.

View newest version in sPHENIX GitHub at line 156 of file Navigator.hpp

References navLayerIndex, and navLayers.

auto Acts::Navigator::State::navSurface ( ) const
inline

Definition at line 155 of file Navigator.hpp.

View newest version in sPHENIX GitHub at line 155 of file Navigator.hpp

References navSurfaceIndex, and navSurfaces.

Member Data Documentation

const Surface* Acts::Navigator::State::currentSurface = nullptr

Navigation state - external state: the current surface.

Definition at line 172 of file Navigator.hpp.

View newest version in sPHENIX GitHub at line 172 of file Navigator.hpp

Referenced by Acts::Test::testNavigatorStatePointers().

const TrackingVolume* Acts::Navigator::State::currentVolume = nullptr

Navigation state: the current volume.

Definition at line 174 of file Navigator.hpp.

View newest version in sPHENIX GitHub at line 174 of file Navigator.hpp

Referenced by Acts::Test::testNavigatorStatePointers().

ExternalSurfaces Acts::Navigator::State::externalSurfaces = {}

Externally provided surfaces - these are tried to be hit.

Definition at line 160 of file Navigator.hpp.

View newest version in sPHENIX GitHub at line 160 of file Navigator.hpp

Referenced by Acts::Test::testNavigatorStateVectors().

bool Acts::Navigator::State::forceIntersectBoundaries = false

Force intersection with boundaries.

Definition at line 194 of file Navigator.hpp.

View newest version in sPHENIX GitHub at line 194 of file Navigator.hpp

bool Acts::Navigator::State::lastHierarchySurfaceReached = false

Indicator that the last VolumeHierarchy surface was reached skip the next layer targeting to the next boundary/volume

Definition at line 188 of file Navigator.hpp.

View newest version in sPHENIX GitHub at line 188 of file Navigator.hpp

NavigationBoundaries Acts::Navigator::State::navBoundaries = {}

the vector of boundary surfaces to work through

Definition at line 151 of file Navigator.hpp.

View newest version in sPHENIX GitHub at line 151 of file Navigator.hpp

Referenced by navBoundary(), and Acts::Test::testNavigatorStateVectors().

std::size_t Acts::Navigator::State::navBoundaryIndex = navBoundaries.size()

the current boundary index of the navigation state

Definition at line 153 of file Navigator.hpp.

View newest version in sPHENIX GitHub at line 153 of file Navigator.hpp

Referenced by navBoundary().

bool Acts::Navigator::State::navigationBreak = false

Navigation state : a break has been detected.

Definition at line 190 of file Navigator.hpp.

View newest version in sPHENIX GitHub at line 190 of file Navigator.hpp

Stage Acts::Navigator::State::navigationStage = Stage::undefined

Definition at line 192 of file Navigator.hpp.

View newest version in sPHENIX GitHub at line 192 of file Navigator.hpp

std::size_t Acts::Navigator::State::navLayerIndex = navLayers.size()

the current layer index of the navigation state

Definition at line 147 of file Navigator.hpp.

View newest version in sPHENIX GitHub at line 147 of file Navigator.hpp

Referenced by navLayer().

NavigationLayers Acts::Navigator::State::navLayers = {}

the vector of navigation layers to work through

Definition at line 145 of file Navigator.hpp.

View newest version in sPHENIX GitHub at line 145 of file Navigator.hpp

Referenced by navLayer(), and Acts::Test::testNavigatorStateVectors().

std::size_t Acts::Navigator::State::navSurfaceIndex = navSurfaces.size()

the current surface index of the navigation state

Definition at line 141 of file Navigator.hpp.

View newest version in sPHENIX GitHub at line 141 of file Navigator.hpp

Referenced by navSurface().

NavigationSurfaces Acts::Navigator::State::navSurfaces = {}

the vector of navigation surfaces to work through

Definition at line 139 of file Navigator.hpp.

View newest version in sPHENIX GitHub at line 139 of file Navigator.hpp

Referenced by navSurface(), and Acts::Test::testNavigatorStateVectors().

const Layer* Acts::Navigator::State::startLayer = nullptr

Navigation state: the start layer.

Definition at line 168 of file Navigator.hpp.

View newest version in sPHENIX GitHub at line 168 of file Navigator.hpp

Referenced by Acts::Test::testNavigatorStatePointers().

bool Acts::Navigator::State::startLayerResolved = false

Indicator for start layer treatment.

Definition at line 183 of file Navigator.hpp.

View newest version in sPHENIX GitHub at line 183 of file Navigator.hpp

const Surface* Acts::Navigator::State::startSurface = nullptr

Navigation state: the start surface.

Definition at line 170 of file Navigator.hpp.

View newest version in sPHENIX GitHub at line 170 of file Navigator.hpp

Referenced by Acts::Test::testNavigatorStatePointers().

const TrackingVolume* Acts::Navigator::State::startVolume = nullptr

Navigation state: the start volume.

Definition at line 166 of file Navigator.hpp.

View newest version in sPHENIX GitHub at line 166 of file Navigator.hpp

Referenced by Acts::Test::testNavigatorStatePointers().

const Layer* Acts::Navigator::State::targetLayer = nullptr

Navigation state: the target layer.

Definition at line 178 of file Navigator.hpp.

View newest version in sPHENIX GitHub at line 178 of file Navigator.hpp

Referenced by Acts::Test::testNavigatorStatePointers().

bool Acts::Navigator::State::targetReached = false

Indicator if the target is reached.

Definition at line 185 of file Navigator.hpp.

View newest version in sPHENIX GitHub at line 185 of file Navigator.hpp

const Surface* Acts::Navigator::State::targetSurface = nullptr

Navigation state: the target surface.

Definition at line 180 of file Navigator.hpp.

View newest version in sPHENIX GitHub at line 180 of file Navigator.hpp

Referenced by Acts::Test::testNavigatorStatePointers().

const TrackingVolume* Acts::Navigator::State::targetVolume = nullptr

Navigation state: the target volume.

Definition at line 176 of file Navigator.hpp.

View newest version in sPHENIX GitHub at line 176 of file Navigator.hpp

Referenced by Acts::Test::testNavigatorStatePointers().

const TrackingVolume* Acts::Navigator::State::worldVolume = nullptr

Navigation state: the world volume.

Definition at line 163 of file Navigator.hpp.

View newest version in sPHENIX GitHub at line 163 of file Navigator.hpp

Referenced by Acts::Test::testNavigatorStatePointers().


The documentation for this struct was generated from the following file: