File StandardAborters.hpp

namespace Acts

Note

This file is foreseen for the Geometry module to replace Extent

struct EndOfWorldReached
#include <Acts/Propagator/StandardAborters.hpp>

This is the condition that the end of World has been reached it then triggers an propagation abort.

Public Functions

EndOfWorldReached() = default
template<typename propagator_state_t, typename stepper_t>
inline bool operator()(propagator_state_t &state, const stepper_t&) const

boolean operator for abort condition without using the result

Template Parameters

propagator_state_t – Type of the propagator state

Parameters

state[inout] The propagation state object

struct PathLimitReached
#include <Acts/Propagator/StandardAborters.hpp>

This is the condition that the pathLimit has been reached.

Public Functions

template<typename propagator_state_t, typename stepper_t>
inline bool operator()(propagator_state_t &state, const stepper_t &stepper) const

boolean operator for abort condition without using the result

Template Parameters
  • propagator_state_t – Type of the propagator state

  • stepper_t – Type of the stepper

Parameters
  • state[inout] The propagation state object

  • stepper[in] Stepper used for propagation

Public Members

double internalLimit = std::numeric_limits<double>::max()

Boolean switch for Loop protection.

struct SurfaceReached
#include <Acts/Propagator/StandardAborters.hpp>

This is the condition that the Surface has been reached it then triggers an propagation abort of the propagation.

Public Functions

SurfaceReached() = default
template<typename propagator_state_t, typename stepper_t>
inline bool operator()(propagator_state_t &state, const stepper_t &stepper) const

boolean operator for abort condition without using the result

Template Parameters
  • propagator_state_t – Type of the propagator state

  • stepper_t – Type of the stepper

Parameters
  • state[inout] The propagation state object

  • stepper[in] Stepper used for propagation

template<typename propagator_state_t, typename stepper_t>
inline bool operator()(propagator_state_t &state, const stepper_t &stepper, const Surface &targetSurface) const

boolean operator for abort condition without using the result

Template Parameters
  • propagator_state_t – Type of the propagator state

  • stepper_t – Type of the stepper

Parameters
  • state[inout] The propagation state object

  • stepper[in] Stepper used for the progation

  • targetSurface[in] The target surface

struct TargetOptions
#include <Acts/Propagator/StandardAborters.hpp>

TargetOptions struct for geometry interface.

Public Functions

inline TargetOptions(NavigationDirection ndir)

create target options

Public Members

BoundaryCheck boundaryCheck = false

Target Boundary check directive - always false here.

NavigationDirection navDir = NavigationDirection::Forward

Navigation direction.

double pathLimit = std::numeric_limits<double>::max()

The path limit.

const Surface *startObject = nullptr

Object to check against - always nullptr here.