detray::constrained_step< scalar_t > Struct Template Reference

Struct that can be configured with a number of different step sizes by other actors and will then resolve the strictest one. More...

#include <detray/propagator/constrained_step.hpp>

Collaboration diagram for detray::constrained_step< scalar_t >:

Public Member Functions
scalar_t	min () const
template<step::constraint type = step::constraint::e_actor>
void	release ()
	Remove [all] constraints.
template<step::constraint type> requires (type != step::constraint::e_all)
void	set (const scalar_t step_size)
	Register a new.
template<step::constraint type = step::constraint::e_all>
scalar_t	size (const step::direction dir=step::direction::e_forward) const
	Return the strictest active step-size constraint, with direction applied.

Public Attributes
darray< scalar_t, 4 >	_constraints
	Current step size constraints from accuracy, actors, aborters or user.

Detailed Description

template<concepts::scalar scalar_t>
struct detray::constrained_step< scalar_t >

Struct that can be configured with a number of different step sizes by other actors and will then resolve the strictest one.

Member Function Documentation

min()

template<concepts::scalar scalar_t>

scalar_t detray::constrained_step< scalar_t >::min

(

)

const

Returns

the strongest constraint

set()

template<concepts::scalar scalar_t>

template<step::constraint type>
requires (type != step::constraint::e_all)

void detray::constrained_step< scalar_t >::set

(

const scalar_t

step_size

)

Register a new.

Parameters

step_size

constraint

size()

template<concepts::scalar scalar_t>

template<step::constraint type = step::constraint::e_all>

scalar_t detray::constrained_step< scalar_t >::size

(

const step::direction

dir = step::direction::e_forward

)

const

Return the strictest active step-size constraint, with direction applied.

Parameters

dir	Requested stepping direction.

Returns

the current step size constraint for a given type or overall

Member Data Documentation

_constraints

template<concepts::scalar scalar_t>

darray<scalar_t, 4> detray::constrained_step< scalar_t >::_constraints

Initial value:

= {std::numeric_limits<scalar_t>::max(),
                                      std::numeric_limits<scalar_t>::max(),
                                      std::numeric_limits<scalar_t>::max(),
                                      std::numeric_limits<scalar_t>::max()}

Current step size constraints from accuracy, actors, aborters or user.