boost::numeric::odeint::default_error_checker< Value, Algebra, Operations > Class Template Reference

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

#include <controlled_runge_kutta.hpp>

Inheritance diagram for boost::numeric::odeint::default_error_checker< Value, Algebra, Operations >:

Public Types
typedef Value	value_type
typedef Algebra	algebra_type
typedef Operations	operations_type

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<class State , class Deriv , class Err , class Time >
value_type	error (const State &x_old, const Deriv &dxdt_old, Err &x_err, Time dt) const
template<class State , class Deriv , class Err , class Time >
value_type	error (algebra_type &algebra, const State &x_old, const Deriv &dxdt_old, Err &x_err, Time dt) const

Detailed Description

template<class Value, class Algebra, class Operations>
class boost::numeric::odeint::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 steppers.

Template Parameters

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

Member Typedef Documentation

template<class Value, class Algebra, class Operations>

typedef Algebra boost::numeric::odeint::default_error_checker< Value, Algebra, Operations >::algebra_type

template<class Value, class Algebra, class Operations>

typedef Operations boost::numeric::odeint::default_error_checker< Value, Algebra, Operations >::operations_type

template<class Value, class Algebra, class Operations>

typedef Value boost::numeric::odeint::default_error_checker< Value, Algebra, Operations >::value_type

Constructor & Destructor Documentation

template<class Value, class Algebra, class Operations>

boost::numeric::odeint::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

template<class Value, class Algebra, class Operations>

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

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

inline

Referenced by boost::numeric::odeint::default_error_checker< value_type, algebra_type, operations_type >::error(), boost::numeric::odeint::bulirsch_stoer_dense_out< State, Value, Deriv, Time, Algebra, Operations, Resizer >::try_step(), and boost::numeric::odeint::bulirsch_stoer< State, Value, Deriv, Time, Algebra, Operations, Resizer >::try_step().

template<class Value, class Algebra, class Operations>

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

value_type boost::numeric::odeint::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

---

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

• boost_1_57_0/boost/numeric/odeint/stepper/controlled_runge_kutta.hpp