Tatooine: tatooine::ode::boost::default_error_checker< Value, Algebra, Operations > Class Template Reference

Tatooine

The default error checker to be used with Runge-Kutta error steppers. More...

#include <controller_runge_kutta_with_domain_check.h>

Collaboration diagram for tatooine::ode::boost::default_error_checker< Value, Algebra, Operations >:

Public Types
using	value_type = Value

using	algebra_type = Algebra

using	operations_type = Operations

Public Member Functions
	default_error_checker (value_type eps_abs=static_cast< value_type >(1.0e-6), value_type eps_rel=static_cast< value_type >(1.0e-6), value_type a_x=static_cast< value_type >(1), value_type a_dxdt=static_cast< value_type >(1))

template<typename State , typename Deriv , typename Err , typename Time >
value_type	error (const State &x_old, const Deriv &dxdt_old, Err &x_err, Time dt) const

template<typename State , typename Deriv , typename Err , typename Time >
value_type	error (algebra_type &algebra, const State &x_old, const Deriv &dxdt_old, Err &x_err, Time dt) const

Private Attributes
value_type	m_eps_abs

value_type	m_eps_rel

value_type	m_a_x

value_type	m_a_dxdt

Detailed Description

template<typename Value, typename Algebra = ::boost::numeric::odeint::range_algebra, typename Operations = ::boost::numeric::odeint::default_operations>
class tatooine::ode::boost::default_error_checker< Value, Algebra, Operations >

The default error checker to be used with Runge-Kutta error steppers.

This class provides the default mechanism to compare the error estimates reported by Runge-Kutta error steppers with user defined error bounds. It is used by the controlled_runge_kutta_with_domain_check steppers.

Template Parameters

Value	The value type.
Algebra	The algebra type.
Operations	The operations type.

Member Typedef Documentation

◆ algebra_type

template<typename Value , typename Algebra = ::boost::numeric::odeint::range_algebra, typename Operations = ::boost::numeric::odeint::default_operations>

using tatooine::ode::boost::default_error_checker< Value, Algebra, Operations >::algebra_type = Algebra

◆ operations_type

template<typename Value , typename Algebra = ::boost::numeric::odeint::range_algebra, typename Operations = ::boost::numeric::odeint::default_operations>

using tatooine::ode::boost::default_error_checker< Value, Algebra, Operations >::operations_type = Operations

◆ value_type

template<typename Value , typename Algebra = ::boost::numeric::odeint::range_algebra, typename Operations = ::boost::numeric::odeint::default_operations>

using tatooine::ode::boost::default_error_checker< Value, Algebra, Operations >::value_type = Value

Constructor & Destructor Documentation

◆ default_error_checker()

template<typename Value , typename Algebra = ::boost::numeric::odeint::range_algebra, typename Operations = ::boost::numeric::odeint::default_operations>

tatooine::ode::boost::default_error_checker< Value, Algebra, Operations >::default_error_checker	(	value_type	eps_abs = `static_cast<value_type>(1.0e-6)`,
		value_type	eps_rel = `static_cast<value_type>(1.0e-6)`,
		value_type	a_x = `static_cast<value_type>(1)`,
		value_type	a_dxdt = `static_cast<value_type>(1)`
	)

inline

Member Function Documentation

◆ error() [1/2]

template<typename Value , typename Algebra = ::boost::numeric::odeint::range_algebra, typename Operations = ::boost::numeric::odeint::default_operations>

template<typename State , typename Deriv , typename Err , typename Time >

value_type tatooine::ode::boost::default_error_checker< Value, Algebra, Operations >::error	(	algebra_type &	algebra,
		const State &	x_old,
		const Deriv &	dxdt_old,
		Err &	x_err,
		Time	dt
	)		const

inline

◆ error() [2/2]

template<typename Value , typename Algebra = ::boost::numeric::odeint::range_algebra, typename Operations = ::boost::numeric::odeint::default_operations>

template<typename State , typename Deriv , typename Err , typename Time >

value_type tatooine::ode::boost::default_error_checker< Value, Algebra, Operations >::error	(	const State &	x_old,
		const Deriv &	dxdt_old,
		Err &	x_err,
		Time	dt
	)		const

inline

Member Data Documentation

◆ m_a_dxdt

template<typename Value , typename Algebra = ::boost::numeric::odeint::range_algebra, typename Operations = ::boost::numeric::odeint::default_operations>

value_type tatooine::ode::boost::default_error_checker< Value, Algebra, Operations >::m_a_dxdt

private

◆ m_a_x

template<typename Value , typename Algebra = ::boost::numeric::odeint::range_algebra, typename Operations = ::boost::numeric::odeint::default_operations>

value_type tatooine::ode::boost::default_error_checker< Value, Algebra, Operations >::m_a_x

private

◆ m_eps_abs

template<typename Value , typename Algebra = ::boost::numeric::odeint::range_algebra, typename Operations = ::boost::numeric::odeint::default_operations>

value_type tatooine::ode::boost::default_error_checker< Value, Algebra, Operations >::m_eps_abs

private

◆ m_eps_rel

template<typename Value , typename Algebra = ::boost::numeric::odeint::range_algebra, typename Operations = ::boost::numeric::odeint::default_operations>

value_type tatooine::ode::boost::default_error_checker< Value, Algebra, Operations >::m_eps_rel

private

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

/mnt/data/home/ci/builds/Bicifxyn/0/libs/tatooine2/fields/include/tatooine/ode/boost/controller_runge_kutta_with_domain_check.h