Acts::MultiStepperSurfaceReached Struct Reference

Aborter that stops when all components reach the target surface. More...

#include <Acts/Propagator/MultiStepperAborters.hpp>

Inheritance diagram for Acts::MultiStepperSurfaceReached:

Collaboration diagram for Acts::MultiStepperSurfaceReached:

Public Member Functions
template<typename propagator_state_t, typename stepper_t, typename navigator_t>
bool	checkAbort (propagator_state_t &state, const stepper_t &stepper, const navigator_t &navigator, const Logger &logger) const
	boolean operator for abort condition without using the result
Public Member Functions inherited from Acts::SurfaceReached
	SurfaceReached (double nLimit)
	Constructor with custom near limit.
template<typename propagator_state_t, typename stepper_t, typename navigator_t>
bool	checkAbort (propagator_state_t &state, const stepper_t &stepper, const navigator_t &navigator, const Logger &logger) const
	boolean operator for abort condition without using the result

Public Attributes
bool	averageOnSurface = true
	If this is set, we are also happy if the mean of the components is on the surface.
double	averageOnSurfaceTolerance = 0.2
	A configurable tolerance within which distance to the intersection we consider the surface as reached.
Public Attributes inherited from Acts::SurfaceReached
BoundaryTolerance	boundaryTolerance = BoundaryTolerance::None()
	Boundary tolerance for surface intersection checks.
double	nearLimit = -100 * UnitConstants::um
	Distance limit to discard intersections "behind us".
const Surface *	surface = nullptr
	Target surface to reach for propagation termination.

Detailed Description

Aborter that stops when all components reach the target surface.

Member Function Documentation

checkAbort()

template<typename propagator_state_t, typename stepper_t, typename navigator_t>

bool Acts::MultiStepperSurfaceReached::checkAbort	(	propagator_state_t &	state,
		const stepper_t &	stepper,
		const navigator_t &	navigator,
		const Logger &	logger ) 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
navigator_t	Type of the navigator

Parameters

[in,out]	state	The propagation state object
[in]	stepper	Stepper used for propagation
[in]	navigator	Navigator used for the propagation
	logger	a logger instance

Returns

True if the abort condition is met, false otherwise

Member Data Documentation

averageOnSurface

bool Acts::MultiStepperSurfaceReached::averageOnSurface = true

If this is set, we are also happy if the mean of the components is on the surface.

How the averaging is performed depends on the stepper implementation

averageOnSurfaceTolerance

double Acts::MultiStepperSurfaceReached::averageOnSurfaceTolerance = 0.2

A configurable tolerance within which distance to the intersection we consider the surface as reached.

Has no effect if averageOnSurface is false