Class to control step sizes using well-known method [10]. More...

#include <num_collect/ode/basic_step_size_controller.h>

Inheritance diagram for num_collect::ode::basic_step_size_controller< Formula >:

Collaboration diagram for num_collect::ode::basic_step_size_controller< Formula >:

Public Types
using	base_type
	Base class.

using	formula_type
	Type of formula.

using	problem_type
	Type of problem.

using	scalar_type
	Type of scalars.

using	variable_type
	Type of variables.

Public Types inherited from num_collect::ode::step_size_controller_base< basic_step_size_controller< Formula >, Formula >
using	formula_type
	Type of formula.

using	formula_type
	Type of formula.

using	problem_type
	Type of problem.

using	problem_type
	Type of problem.

using	scalar_type
	Type of scalars.

using	scalar_type
	Type of scalars.

using	variable_type
	Type of variables.

using	variable_type
	Type of variables.

Public Member Functions
	basic_step_size_controller ()
	Constructor.

auto	check_and_calc_next (scalar_type &step_size, const variable_type &variable, const variable_type &error) -> bool
	Check the error estimate and calculate the next step size.

void	init ()
	Initialize.

auto	max_step_size_factor (const scalar_type &val) -> basic_step_size_controller &
	Set the maximum factor of step sizes.

auto	step_size_factor_safety_coeff (const scalar_type &val) -> basic_step_size_controller &
	Set the safety coefficient for factors of step sizes.

Public Member Functions inherited from num_collect::ode::step_size_controller_base< basic_step_size_controller< Formula >, Formula >
auto	limits () const -> const step_size_limits< scalar_type > &
	Get the limits of step sizes.

auto	limits () const -> const step_size_limits< scalar_type > &
	Get the limits of step sizes.

auto	limits (const step_size_limits< scalar_type > &val) -> basic_step_size_controller< Formula > &
	Set the limits of step sizes.

auto	limits (const step_size_limits< scalar_type > &val) -> basic_step_size_controller< Formula > &
	Set the limits of step sizes.

auto	reduction_rate (const scalar_type &val) -> basic_step_size_controller< Formula > &
	Set the rate to reduce step sizes when error is large.

auto	reduction_rate (const scalar_type &val) -> basic_step_size_controller< Formula > &
	Set the rate to reduce step sizes when error is large.

auto	tolerances () const -> const error_tolerances< variable_type > &
	Get the error tolerances.

auto	tolerances () const -> const error_tolerances< variable_type > &
	Get the error tolerances.

auto	tolerances (const error_tolerances< variable_type > &val) -> basic_step_size_controller< Formula > &
	Set the error tolerances.

auto	tolerances (const error_tolerances< variable_type > &val) -> basic_step_size_controller< Formula > &
	Set the error tolerances.

Public Member Functions inherited from num_collect::logging::logging_mixin
	logging_mixin (log_tag_view tag)
	Constructor.

template<typename Child>
void	configure_child_algorithm_logger_if_exists (Child &child)
	Configure a logger of a child algorithm if exists.

auto	logger () const noexcept -> const num_collect::logging::logger &
	Access to the logger.

auto	logger () noexcept -> num_collect::logging::logger &
	Access to the logger.

Private Member Functions
void	calc_next (scalar_type &step_size, const variable_type &variable, const variable_type &error)
	Calculate the next step size.

Private Attributes
scalar_type	max_step_size_factor_ {default_max_step_size_factor}
	Maximum factor of step sizes.

scalar_type	step_size_factor_safety_coeff_
	Safety coefficient for factors of step sizes.

Static Private Attributes
static constexpr auto	default_max_step_size_factor
	Default maximum factor of step sizes.

static constexpr auto	default_step_size_factor_safety_coeff
	Default safety coefficient for factors of step sizes.

Additional Inherited Members
Protected Member Functions inherited from num_collect::ode::step_size_controller_base< basic_step_size_controller< Formula >, Formula >
	step_size_controller_base (logging::log_tag_view tag)
	Constructor.

	step_size_controller_base (logging::log_tag_view tag)
	Constructor.

auto	derived () const noexcept -> const basic_step_size_controller< Formula > &
	Access derived object.

auto	derived () const noexcept -> const basic_step_size_controller< Formula > &
	Access derived object.

auto	derived () noexcept -> basic_step_size_controller< Formula > &
	Access derived object.

auto	derived () noexcept -> basic_step_size_controller< Formula > &
	Access derived object.

auto	reduce_if_needed (scalar_type &step_size, const variable_type &variable, const variable_type &error) -> bool
	Reduce step size if needed.

auto	reduce_if_needed (scalar_type &step_size, const variable_type &variable, const variable_type &error) -> bool
	Reduce step size if needed.

Detailed Description

template<concepts::formula Formula>
class num_collect::ode::basic_step_size_controller< Formula >

Class to control step sizes using well-known method [10].

Template Parameters

Formula Type of the formula.

Definition at line 47 of file basic_step_size_controller.h.

Member Typedef Documentation

◆ base_type

template<concepts::formula Formula>

using num_collect::ode::basic_step_size_controller< Formula >::base_type

Initial value:

step_size_controller_base<basic_step_size_controller<Formula>, Formula>

num_collect::ode::step_size_controller_base< basic_step_size_controller< Formula >, Formula >::step_size_controller_base

step_size_controller_base(logging::log_tag_view tag)

Definition step_size_controller_base.h:115

Base class.

Definition at line 52 of file basic_step_size_controller.h.

◆ formula_type

template<concepts::formula Formula>

using num_collect::ode::step_size_controller_base< basic_step_size_controller< Formula >, Formula >::formula_type

Type of formula.

Definition at line 43 of file step_size_controller_base.h.

◆ problem_type

template<concepts::formula Formula>

using num_collect::ode::step_size_controller_base< basic_step_size_controller< Formula >, Formula >::problem_type

Type of problem.

Definition at line 46 of file step_size_controller_base.h.

◆ scalar_type

template<concepts::formula Formula>

using num_collect::ode::step_size_controller_base< basic_step_size_controller< Formula >, Formula >::scalar_type

Type of scalars.

Definition at line 52 of file step_size_controller_base.h.

◆ variable_type

template<concepts::formula Formula>

using num_collect::ode::step_size_controller_base< basic_step_size_controller< Formula >, Formula >::variable_type

Type of variables.

Definition at line 49 of file step_size_controller_base.h.

Constructor & Destructor Documentation

◆ basic_step_size_controller()

template<concepts::formula Formula>

num_collect::ode::basic_step_size_controller< Formula >::basic_step_size_controller ( )

inline

Constructor.

Definition at line 63 of file basic_step_size_controller.h.

Member Function Documentation

◆ calc_next()

template<concepts::formula Formula>

void num_collect::ode::basic_step_size_controller< Formula >::calc_next	(	scalar_type &	step_size,
		const variable_type &	variable,
		const variable_type &	error )

inlineprivate

Calculate the next step size.

Parameters

[in,out]	step_size	Step size.
[in]	variable	Variable.
[in]	error	Error estimate.

Definition at line 128 of file basic_step_size_controller.h.

◆ check_and_calc_next()

template<concepts::formula Formula>

auto num_collect::ode::basic_step_size_controller< Formula >::check_and_calc_next	(	scalar_type &	step_size,
		const variable_type &	variable,
		const variable_type &	error ) -> bool

inlinenodiscard

Check the error estimate and calculate the next step size.

Parameters

[in,out]	step_size	Step size.
[in]	variable	Variable.
[in]	error	Error estimate.

Return values

true	Given error satisfies tolerances.
false	Given error doesn't satisfy tolerances.

Definition at line 82 of file basic_step_size_controller.h.

◆ init()

template<concepts::formula Formula>

void num_collect::ode::basic_step_size_controller< Formula >::init ( )

inline

Initialize.

Definition at line 69 of file basic_step_size_controller.h.

◆ max_step_size_factor()

template<concepts::formula Formula>

auto num_collect::ode::basic_step_size_controller< Formula >::max_step_size_factor ( const scalar_type & val ) -> basic_step_size_controller&

inline

Set the maximum factor of step sizes.

Parameters

[in] val Value.

Returns: This.

Definition at line 112 of file basic_step_size_controller.h.

◆ step_size_factor_safety_coeff()

template<concepts::formula Formula>

auto num_collect::ode::basic_step_size_controller< Formula >::step_size_factor_safety_coeff ( const scalar_type & val ) -> basic_step_size_controller&