Boost  v1.57.0
doxygen for www.boost.org
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
boost::numeric::odeint::runge_kutta_cash_karp54< State, Value, Deriv, Time, Algebra, Operations, Resizer > Class Template Reference

The Runge-Kutta Cash-Karp method. More...

#include <runge_kutta_cash_karp54.hpp>

Inheritance diagram for boost::numeric::odeint::runge_kutta_cash_karp54< State, Value, Deriv, Time, Algebra, Operations, Resizer >:
Collaboration diagram for boost::numeric::odeint::runge_kutta_cash_karp54< State, Value, Deriv, Time, Algebra, Operations, Resizer >:

Public Types

typedef
explicit_error_generic_rk
< 6, 5, 5, 4, State, Value,
Deriv, Time, Algebra,
Operations, Resizer > 
stepper_base_type
 
typedef
stepper_base_type::state_type 
state_type
 
typedef
stepper_base_type::value_type 
value_type
 
typedef
stepper_base_type::deriv_type 
deriv_type
 
typedef
stepper_base_type::time_type 
time_type
 
typedef
stepper_base_type::algebra_type 
algebra_type
 
typedef
stepper_base_type::operations_type 
operations_type
 
typedef
stepper_base_type::resizer_type 
resizer_typ
 
typedef
stepper_base_type::stepper_type 
stepper_type
 
typedef
stepper_base_type::wrapped_state_type 
wrapped_state_type
 
typedef
stepper_base_type::wrapped_deriv_type 
wrapped_deriv_type
 
typedef
stepper_base_type::resizer_type 
resizer_type
 
typedef
detail::generic_rk_algorithm
< StageCount, Value, Algebra,
Operations > 
rk_algorithm_type
 
typedef
rk_algorithm_type::coef_a_type 
coef_a_type
 
typedef
rk_algorithm_type::coef_b_type 
coef_b_type
 
typedef
rk_algorithm_type::coef_c_type 
coef_c_type
 
typedef algebra_stepper_base
< Algebra, Operations > 
algebra_stepper_base_type
 
typedef explicit_error_stepper_tag stepper_category
 
typedef
explicit_error_stepper_base
< explicit_error_generic_rk
< StageCount, Order,
StepperOrder, ErrorOrder,
State, Value, Deriv, Time,
Algebra, Operations, Resizer >
, Order, StepperOrder,
ErrorOrder, State, Value,
Deriv, Time, Algebra,
Operations, Resizer > 
internal_stepper_base_type
 
typedef unsigned short order_type
 

Public Member Functions

 runge_kutta_cash_karp54 (const algebra_type &algebra=algebra_type())
 Constructs the runge_kutta_cash_karp54 class. More...
 
void do_step_impl (System system, const StateIn &in, const DerivIn &dxdt, time_type t, StateOut &out, time_type dt, Err &xerr)
 This method performs one step. More...
 
void do_step_impl (System system, const StateIn &in, const DerivIn &dxdt, time_type t, StateOut &out, time_type dt)
 This method performs one step. More...
 
void adjust_size (const StateIn &x)
 Adjust the size of all temporaries in the stepper manually. More...
 
order_type order (void) const
 
order_type stepper_order (void) const
 
order_type error_order (void) const
 
void do_step (System system, StateInOut &x, time_type t, time_type dt)
 This method performs one step. More...
 
void do_step (System system, const StateInOut &x, time_type t, time_type dt)
 Second version to solve the forwarding problem, can be called with Boost.Range as StateInOut. More...
 
boost::disable_if
< boost::is_same< DerivIn,
time_type >, void >::type 
do_step (System system, StateInOut &x, const DerivIn &dxdt, time_type t, time_type dt)
 The method performs one step with the stepper passed by Stepper. More...
 
boost::disable_if
< boost::is_same< StateIn,
time_type >, void >::type 
do_step (System system, const StateIn &in, time_type t, StateOut &out, time_type dt)
 The method performs one step with the stepper passed by Stepper. More...
 
boost::disable_if
< boost::is_same< DerivIn,
time_type >, void >::type 
do_step (System system, const StateIn &in, const DerivIn &dxdt, time_type t, StateOut &out, time_type dt)
 The method performs one step with the stepper passed by Stepper. More...
 
void do_step (System system, StateInOut &x, time_type t, time_type dt, Err &xerr)
 The method performs one step with the stepper passed by Stepper and estimates the error. More...
 
void do_step (System system, const StateInOut &x, time_type t, time_type dt, Err &xerr)
 Second version to solve the forwarding problem, can be called with Boost.Range as StateInOut. More...
 
boost::disable_if
< boost::is_same< DerivIn,
time_type >, void >::type 
do_step (System system, StateInOut &x, const DerivIn &dxdt, time_type t, time_type dt, Err &xerr)
 The method performs one step with the stepper passed by Stepper. More...
 
void do_step (System system, const StateIn &in, time_type t, StateOut &out, time_type dt, Err &xerr)
 The method performs one step with the stepper passed by Stepper. More...
 
void do_step (System system, const StateIn &in, const DerivIn &dxdt, time_type t, StateOut &out, time_type dt, Err &xerr)
 The method performs one step with the stepper passed by Stepper. More...
 
algebra_typealgebra ()
 
const algebra_typealgebra () const
 

Static Public Attributes

static const size_t stage_count
 
static const order_type order_value
 
static const order_type stepper_order_value
 
static const order_type error_order_value
 

Protected Attributes

wrapped_deriv_type m_dxdt
 
algebra_type m_algebra
 

Detailed Description

template<class State, class Value = double, class Deriv = State, class Time = Value, class Algebra = typename algebra_dispatcher< State >::algebra_type, class Operations = typename operations_dispatcher< State >::operations_type, class Resizer = initially_resizer>
class boost::numeric::odeint::runge_kutta_cash_karp54< State, Value, Deriv, Time, Algebra, Operations, Resizer >

The Runge-Kutta Cash-Karp method.

The Runge-Kutta Cash-Karp method is one of the standard methods for solving ordinary differential equations, see en.wikipedia.org/wiki/Cash-Karp_methods. The method is explicit and fulfills the Error Stepper concept. Step size control is provided but continuous output is not available for this method.

This class derives from explicit_error_stepper_base and inherits its interface via CRTP (current recurring template pattern). Furthermore, it derivs from explicit_error_generic_rk which is a generic Runge-Kutta algorithm with error estimation. For more details see explicit_error_stepper_base and explicit_error_generic_rk.

Template Parameters
StateThe state type.
ValueThe value type.
DerivThe type representing the time derivative of the state.
TimeThe time representing the independent variable - the time.
AlgebraThe algebra type.
OperationsThe operations type.
ResizerThe resizer policy type.

Member Typedef Documentation

typedef algebra_stepper_base< Algebra , Operations > boost::numeric::odeint::explicit_error_stepper_base< explicit_error_generic_rk< StageCount, Order, StepperOrder, ErrorOrder, State, Value, Deriv, Time, Algebra, Operations, Resizer > , Order, StepperOrder, ErrorOrder, State, Value, Deriv, Time, Algebra, Operations, Resizer >::algebra_stepper_base_type
inherited
template<class State , class Value = double, class Deriv = State, class Time = Value, class Algebra = typename algebra_dispatcher< State >::algebra_type, class Operations = typename operations_dispatcher< State >::operations_type, class Resizer = initially_resizer>
typedef stepper_base_type::algebra_type boost::numeric::odeint::runge_kutta_cash_karp54< State, Value, Deriv, Time, Algebra, Operations, Resizer >::algebra_type
typedef rk_algorithm_type::coef_a_type boost::numeric::odeint::explicit_error_generic_rk< StageCount, Order, StepperOrder, ErrorOrder, State, Value, Deriv, Time, Algebra, Operations, Resizer >::coef_a_type
inherited
typedef rk_algorithm_type::coef_b_type boost::numeric::odeint::explicit_error_generic_rk< StageCount, Order, StepperOrder, ErrorOrder, State, Value, Deriv, Time, Algebra, Operations, Resizer >::coef_b_type
inherited
typedef rk_algorithm_type::coef_c_type boost::numeric::odeint::explicit_error_generic_rk< StageCount, Order, StepperOrder, ErrorOrder, State, Value, Deriv, Time, Algebra, Operations, Resizer >::coef_c_type
inherited
template<class State , class Value = double, class Deriv = State, class Time = Value, class Algebra = typename algebra_dispatcher< State >::algebra_type, class Operations = typename operations_dispatcher< State >::operations_type, class Resizer = initially_resizer>
typedef stepper_base_type::deriv_type boost::numeric::odeint::runge_kutta_cash_karp54< State, Value, Deriv, Time, Algebra, Operations, Resizer >::deriv_type
typedef explicit_error_stepper_base< explicit_error_generic_rk< StageCount, Order, StepperOrder, ErrorOrder, State, Value, Deriv, Time, Algebra, Operations, Resizer > , Order , StepperOrder , ErrorOrder , State , Value , Deriv , Time , Algebra , Operations , Resizer > boost::numeric::odeint::explicit_error_stepper_base< explicit_error_generic_rk< StageCount, Order, StepperOrder, ErrorOrder, State, Value, Deriv, Time, Algebra, Operations, Resizer > , Order, StepperOrder, ErrorOrder, State, Value, Deriv, Time, Algebra, Operations, Resizer >::internal_stepper_base_type
inherited
template<class State , class Value = double, class Deriv = State, class Time = Value, class Algebra = typename algebra_dispatcher< State >::algebra_type, class Operations = typename operations_dispatcher< State >::operations_type, class Resizer = initially_resizer>
typedef stepper_base_type::operations_type boost::numeric::odeint::runge_kutta_cash_karp54< State, Value, Deriv, Time, Algebra, Operations, Resizer >::operations_type
typedef unsigned short boost::numeric::odeint::explicit_error_stepper_base< explicit_error_generic_rk< StageCount, Order, StepperOrder, ErrorOrder, State, Value, Deriv, Time, Algebra, Operations, Resizer > , Order, StepperOrder, ErrorOrder, State, Value, Deriv, Time, Algebra, Operations, Resizer >::order_type
inherited
template<class State , class Value = double, class Deriv = State, class Time = Value, class Algebra = typename algebra_dispatcher< State >::algebra_type, class Operations = typename operations_dispatcher< State >::operations_type, class Resizer = initially_resizer>
typedef stepper_base_type::resizer_type boost::numeric::odeint::runge_kutta_cash_karp54< State, Value, Deriv, Time, Algebra, Operations, Resizer >::resizer_typ
typedef stepper_base_type::resizer_type boost::numeric::odeint::explicit_error_generic_rk< StageCount, Order, StepperOrder, ErrorOrder, State, Value, Deriv, Time, Algebra, Operations, Resizer >::resizer_type
inherited
typedef detail::generic_rk_algorithm< StageCount , Value , Algebra , Operations > boost::numeric::odeint::explicit_error_generic_rk< StageCount, Order, StepperOrder, ErrorOrder, State, Value, Deriv, Time, Algebra, Operations, Resizer >::rk_algorithm_type
inherited
template<class State , class Value = double, class Deriv = State, class Time = Value, class Algebra = typename algebra_dispatcher< State >::algebra_type, class Operations = typename operations_dispatcher< State >::operations_type, class Resizer = initially_resizer>
typedef stepper_base_type::state_type boost::numeric::odeint::runge_kutta_cash_karp54< State, Value, Deriv, Time, Algebra, Operations, Resizer >::state_type
template<class State , class Value = double, class Deriv = State, class Time = Value, class Algebra = typename algebra_dispatcher< State >::algebra_type, class Operations = typename operations_dispatcher< State >::operations_type, class Resizer = initially_resizer>
typedef explicit_error_generic_rk< 6 , 5 , 5 , 4 , State , Value , Deriv , Time , Algebra , Operations , Resizer > boost::numeric::odeint::runge_kutta_cash_karp54< State, Value, Deriv, Time, Algebra, Operations, Resizer >::stepper_base_type
typedef explicit_error_stepper_tag boost::numeric::odeint::explicit_error_stepper_base< explicit_error_generic_rk< StageCount, Order, StepperOrder, ErrorOrder, State, Value, Deriv, Time, Algebra, Operations, Resizer > , Order, StepperOrder, ErrorOrder, State, Value, Deriv, Time, Algebra, Operations, Resizer >::stepper_category
inherited
template<class State , class Value = double, class Deriv = State, class Time = Value, class Algebra = typename algebra_dispatcher< State >::algebra_type, class Operations = typename operations_dispatcher< State >::operations_type, class Resizer = initially_resizer>
typedef stepper_base_type::stepper_type boost::numeric::odeint::runge_kutta_cash_karp54< State, Value, Deriv, Time, Algebra, Operations, Resizer >::stepper_type
template<class State , class Value = double, class Deriv = State, class Time = Value, class Algebra = typename algebra_dispatcher< State >::algebra_type, class Operations = typename operations_dispatcher< State >::operations_type, class Resizer = initially_resizer>
typedef stepper_base_type::time_type boost::numeric::odeint::runge_kutta_cash_karp54< State, Value, Deriv, Time, Algebra, Operations, Resizer >::time_type
template<class State , class Value = double, class Deriv = State, class Time = Value, class Algebra = typename algebra_dispatcher< State >::algebra_type, class Operations = typename operations_dispatcher< State >::operations_type, class Resizer = initially_resizer>
typedef stepper_base_type::value_type boost::numeric::odeint::runge_kutta_cash_karp54< State, Value, Deriv, Time, Algebra, Operations, Resizer >::value_type
template<class State , class Value = double, class Deriv = State, class Time = Value, class Algebra = typename algebra_dispatcher< State >::algebra_type, class Operations = typename operations_dispatcher< State >::operations_type, class Resizer = initially_resizer>
typedef stepper_base_type::wrapped_deriv_type boost::numeric::odeint::runge_kutta_cash_karp54< State, Value, Deriv, Time, Algebra, Operations, Resizer >::wrapped_deriv_type
template<class State , class Value = double, class Deriv = State, class Time = Value, class Algebra = typename algebra_dispatcher< State >::algebra_type, class Operations = typename operations_dispatcher< State >::operations_type, class Resizer = initially_resizer>
typedef stepper_base_type::wrapped_state_type boost::numeric::odeint::runge_kutta_cash_karp54< State, Value, Deriv, Time, Algebra, Operations, Resizer >::wrapped_state_type

Constructor & Destructor Documentation

template<class State , class Value = double, class Deriv = State, class Time = Value, class Algebra = typename algebra_dispatcher< State >::algebra_type, class Operations = typename operations_dispatcher< State >::operations_type, class Resizer = initially_resizer>
boost::numeric::odeint::runge_kutta_cash_karp54< State, Value, Deriv, Time, Algebra, Operations, Resizer >::runge_kutta_cash_karp54 ( const algebra_type algebra = algebra_type())
inline

Constructs the runge_kutta_cash_karp54 class.

This constructor can be used as a default constructor if the algebra has a default constructor.

Parameters
algebraA copy of algebra is made and stored inside explicit_stepper_base.

Member Function Documentation

void boost::numeric::odeint::explicit_error_generic_rk< StageCount, Order, StepperOrder, ErrorOrder, State, Value, Deriv, Time, Algebra, Operations, Resizer >::adjust_size ( const StateIn &  x)
inlineinherited
template<class Algebra, class Operations>
algebra_type & boost::numeric::odeint::algebra_stepper_base< Algebra, Operations >::algebra ( )
inlineinherited
Returns
A reference to the algebra which is held by this class.
template<class Algebra, class Operations>
const algebra_type & boost::numeric::odeint::algebra_stepper_base< Algebra, Operations >::algebra ( ) const
inlineinherited
Returns
A const reference to the algebra which is held by this class.
void boost::numeric::odeint::explicit_error_stepper_base< explicit_error_generic_rk< StageCount, Order, StepperOrder, ErrorOrder, State, Value, Deriv, Time, Algebra, Operations, Resizer > , Order, StepperOrder, ErrorOrder, State, Value, Deriv, Time, Algebra, Operations, Resizer >::do_step ( System  system,
StateInOut &  x,
time_type  t,
time_type  dt 
)
inlineinherited

This method performs one step.

It transforms the result in-place.

Parameters
systemThe system function to solve, hence the r.h.s. of the ordinary differential equation. It must fulfill the Simple System concept.
xThe state of the ODE which should be solved. After calling do_step the result is updated in x.
tThe value of the time, at which the step should be performed.
dtThe step size.
void boost::numeric::odeint::explicit_error_stepper_base< explicit_error_generic_rk< StageCount, Order, StepperOrder, ErrorOrder, State, Value, Deriv, Time, Algebra, Operations, Resizer > , Order, StepperOrder, ErrorOrder, State, Value, Deriv, Time, Algebra, Operations, Resizer >::do_step ( System  system,
const StateInOut &  x,
time_type  t,
time_type  dt 
)
inlineinherited

Second version to solve the forwarding problem, can be called with Boost.Range as StateInOut.

boost::disable_if< boost::is_same< DerivIn , time_type > , void >::type boost::numeric::odeint::explicit_error_stepper_base< explicit_error_generic_rk< StageCount, Order, StepperOrder, ErrorOrder, State, Value, Deriv, Time, Algebra, Operations, Resizer > , Order, StepperOrder, ErrorOrder, State, Value, Deriv, Time, Algebra, Operations, Resizer >::do_step ( System  system,
StateInOut &  x,
const DerivIn &  dxdt,
time_type  t,
time_type  dt 
)
inlineinherited

The method performs one step with the stepper passed by Stepper.

Additionally to the other method the derivative of x is also passed to this method. It is supposed to be used in the following way:

sys( x , dxdt , t );
stepper.do_step( sys , x , dxdt , t , dt );

The result is updated in place in x. This method is disabled if Time and Deriv are of the same type. In this case the method could not be distinguished from other do_step versions.

Note
This method does not solve the forwarding problem.
Parameters
systemThe system function to solve, hence the r.h.s. of the ODE. It must fulfill the Simple System concept.
xThe state of the ODE which should be solved. After calling do_step the result is updated in x.
dxdtThe derivative of x at t.
tThe value of the time, at which the step should be performed.
dtThe step size.
boost::disable_if< boost::is_same< StateIn , time_type > , void >::type boost::numeric::odeint::explicit_error_stepper_base< explicit_error_generic_rk< StageCount, Order, StepperOrder, ErrorOrder, State, Value, Deriv, Time, Algebra, Operations, Resizer > , Order, StepperOrder, ErrorOrder, State, Value, Deriv, Time, Algebra, Operations, Resizer >::do_step ( System  system,
const StateIn &  in,
time_type  t,
StateOut &  out,
time_type  dt 
)
inlineinherited

The method performs one step with the stepper passed by Stepper.

The state of the ODE is updated out-of-place. This method is disabled if StateIn and Time are the same type. In this case the method can not be distinguished from other do_step variants.

Note
This method does not solve the forwarding problem.
Parameters
systemThe system function to solve, hence the r.h.s. of the ODE. It must fulfill the Simple System concept.
inThe state of the ODE which should be solved. in is not modified in this method
tThe value of the time, at which the step should be performed.
outThe result of the step is written in out.
dtThe step size.
boost::disable_if< boost::is_same< DerivIn , time_type > , void >::type boost::numeric::odeint::explicit_error_stepper_base< explicit_error_generic_rk< StageCount, Order, StepperOrder, ErrorOrder, State, Value, Deriv, Time, Algebra, Operations, Resizer > , Order, StepperOrder, ErrorOrder, State, Value, Deriv, Time, Algebra, Operations, Resizer >::do_step ( System  system,
const StateIn &  in,
const DerivIn &  dxdt,
time_type  t,
StateOut &  out,
time_type  dt 
)
inlineinherited

The method performs one step with the stepper passed by Stepper.

The state of the ODE is updated out-of-place. Furthermore, the derivative of x at t is passed to the stepper. It is supposed to be used in the following way:

sys( in , dxdt , t );
stepper.do_step( sys , in , dxdt , t , out , dt );

This method is disabled if DerivIn and Time are of same type.

Note
This method does not solve the forwarding problem.
Parameters
systemThe system function to solve, hence the r.h.s. of the ODE. It must fulfill the Simple System concept.
inThe state of the ODE which should be solved. in is not modified in this method
dxdtThe derivative of x at t.
tThe value of the time, at which the step should be performed.
outThe result of the step is written in out.
dtThe step size.
void boost::numeric::odeint::explicit_error_stepper_base< explicit_error_generic_rk< StageCount, Order, StepperOrder, ErrorOrder, State, Value, Deriv, Time, Algebra, Operations, Resizer > , Order, StepperOrder, ErrorOrder, State, Value, Deriv, Time, Algebra, Operations, Resizer >::do_step ( System  system,
StateInOut &  x,
time_type  t,
time_type  dt,
Err &  xerr 
)
inlineinherited

The method performs one step with the stepper passed by Stepper and estimates the error.

The state of the ODE is updated in-place.

Parameters
systemThe system function to solve, hence the r.h.s. of the ODE. It must fulfill the Simple System concept.
xThe state of the ODE which should be solved. x is updated by this method.
tThe value of the time, at which the step should be performed.
dtThe step size.
xerrThe estimation of the error is stored in xerr.
void boost::numeric::odeint::explicit_error_stepper_base< explicit_error_generic_rk< StageCount, Order, StepperOrder, ErrorOrder, State, Value, Deriv, Time, Algebra, Operations, Resizer > , Order, StepperOrder, ErrorOrder, State, Value, Deriv, Time, Algebra, Operations, Resizer >::do_step ( System  system,
const StateInOut &  x,
time_type  t,
time_type  dt,
Err &  xerr 
)
inlineinherited

Second version to solve the forwarding problem, can be called with Boost.Range as StateInOut.

boost::disable_if< boost::is_same< DerivIn , time_type > , void >::type boost::numeric::odeint::explicit_error_stepper_base< explicit_error_generic_rk< StageCount, Order, StepperOrder, ErrorOrder, State, Value, Deriv, Time, Algebra, Operations, Resizer > , Order, StepperOrder, ErrorOrder, State, Value, Deriv, Time, Algebra, Operations, Resizer >::do_step ( System  system,
StateInOut &  x,
const DerivIn &  dxdt,
time_type  t,
time_type  dt,
Err &  xerr 
)
inlineinherited

The method performs one step with the stepper passed by Stepper.

Additionally to the other method the derivative of x is also passed to this method. It is supposed to be used in the following way:

sys( x , dxdt , t );
stepper.do_step( sys , x , dxdt , t , dt , xerr );

The result is updated in place in x. This method is disabled if Time and DerivIn are of the same type. In this case the method could not be distinguished from other do_step versions.

Note
This method does not solve the forwarding problem.
Parameters
systemThe system function to solve, hence the r.h.s. of the ODE. It must fulfill the Simple System concept.
xThe state of the ODE which should be solved. After calling do_step the result is updated in x.
dxdtThe derivative of x at t.
tThe value of the time, at which the step should be performed.
dtThe step size.
xerrThe error estimate is stored in xerr.
void boost::numeric::odeint::explicit_error_stepper_base< explicit_error_generic_rk< StageCount, Order, StepperOrder, ErrorOrder, State, Value, Deriv, Time, Algebra, Operations, Resizer > , Order, StepperOrder, ErrorOrder, State, Value, Deriv, Time, Algebra, Operations, Resizer >::do_step ( System  system,
const StateIn &  in,
time_type  t,
StateOut &  out,
time_type  dt,
Err &  xerr 
)
inlineinherited

The method performs one step with the stepper passed by Stepper.

The state of the ODE is updated out-of-place. Furthermore, the error is estimated.

Note
This method does not solve the forwarding problem.
Parameters
systemThe system function to solve, hence the r.h.s. of the ODE. It must fulfill the Simple System concept.
inThe state of the ODE which should be solved. in is not modified in this method
tThe value of the time, at which the step should be performed.
outThe result of the step is written in out.
dtThe step size.
xerrThe error estimate.
void boost::numeric::odeint::explicit_error_stepper_base< explicit_error_generic_rk< StageCount, Order, StepperOrder, ErrorOrder, State, Value, Deriv, Time, Algebra, Operations, Resizer > , Order, StepperOrder, ErrorOrder, State, Value, Deriv, Time, Algebra, Operations, Resizer >::do_step ( System  system,
const StateIn &  in,
const DerivIn &  dxdt,
time_type  t,
StateOut &  out,
time_type  dt,
Err &  xerr 
)
inlineinherited

The method performs one step with the stepper passed by Stepper.

The state of the ODE is updated out-of-place. Furthermore, the derivative of x at t is passed to the stepper and the error is estimated. It is supposed to be used in the following way:

sys( in , dxdt , t );
stepper.do_step( sys , in , dxdt , t , out , dt );

This method is disabled if DerivIn and Time are of same type.

Note
This method does not solve the forwarding problem.
Parameters
systemThe system function to solve, hence the r.h.s. of the ODE. It must fulfill the Simple System concept.
inThe state of the ODE which should be solved. in is not modified in this method
dxdtThe derivative of x at t.
tThe value of the time, at which the step should be performed.
outThe result of the step is written in out.
dtThe step size.
xerrThe error estimate.
void boost::numeric::odeint::explicit_error_generic_rk< StageCount, Order, StepperOrder, ErrorOrder, State, Value, Deriv, Time, Algebra, Operations, Resizer >::do_step_impl ( System  system,
const StateIn &  in,
const DerivIn &  dxdt,
time_type  t,
StateOut &  out,
time_type  dt,
Err &  xerr 
)
inlineinherited

This method performs one step.

The derivative dxdt of in at the time t is passed to the method. The result is updated out-of-place, hence the input is in in and the output in out. Futhermore, an estimation of the error is stored in xerr. do_step_impl is used by explicit_error_stepper_base.

Parameters
systemThe system function to solve, hence the r.h.s. of the ODE. It must fulfill the Simple System concept.
inThe state of the ODE which should be solved. in is not modified in this method
dxdtThe derivative of x at t.
tThe value of the time, at which the step should be performed.
outThe result of the step is written in out.
dtThe step size.
xerrThe result of the error estimation is written in xerr.

References boost::numeric::odeint::explicit_error_generic_rk< StageCount, Order, StepperOrder, ErrorOrder, State, Value, Deriv, Time, Algebra, Operations, Resizer >::do_step_impl(), boost::numeric::odeint::algebra_stepper_base< Algebra, Operations >::m_algebra, and template.

void boost::numeric::odeint::explicit_error_generic_rk< StageCount, Order, StepperOrder, ErrorOrder, State, Value, Deriv, Time, Algebra, Operations, Resizer >::do_step_impl ( System  system,
const StateIn &  in,
const DerivIn &  dxdt,
time_type  t,
StateOut &  out,
time_type  dt 
)
inlineinherited

This method performs one step.

The derivative dxdt of in at the time t is passed to the method. The result is updated out-of-place, hence the input is in in and the output in out. Access to this step functionality is provided by explicit_stepper_base and do_step_impl should not be called directly.

Parameters
systemThe system function to solve, hence the r.h.s. of the ODE. It must fulfill the Simple System concept.
inThe state of the ODE which should be solved. in is not modified in this method
dxdtThe derivative of x at t.
tThe value of the time, at which the step should be performed.
outThe result of the step is written in out.
dtThe step size.

References boost::numeric::odeint::detail::_1, boost::bind(), boost::numeric::odeint::algebra_stepper_base< Algebra, Operations >::m_algebra, boost::numeric::odeint::state_wrapper< V, Enabler >::m_v, boost::ref(), and template.

order_type boost::numeric::odeint::explicit_error_stepper_base< explicit_error_generic_rk< StageCount, Order, StepperOrder, ErrorOrder, State, Value, Deriv, Time, Algebra, Operations, Resizer > , Order, StepperOrder, ErrorOrder, State, Value, Deriv, Time, Algebra, Operations, Resizer >::error_order ( void  ) const
inlineinherited
Returns
Returns the order of an error step if the stepper is used without error estimation.
order_type boost::numeric::odeint::explicit_error_stepper_base< explicit_error_generic_rk< StageCount, Order, StepperOrder, ErrorOrder, State, Value, Deriv, Time, Algebra, Operations, Resizer > , Order, StepperOrder, ErrorOrder, State, Value, Deriv, Time, Algebra, Operations, Resizer >::order ( void  ) const
inlineinherited
Returns
Returns the order of the stepper if it used without error estimation.
order_type boost::numeric::odeint::explicit_error_stepper_base< explicit_error_generic_rk< StageCount, Order, StepperOrder, ErrorOrder, State, Value, Deriv, Time, Algebra, Operations, Resizer > , Order, StepperOrder, ErrorOrder, State, Value, Deriv, Time, Algebra, Operations, Resizer >::stepper_order ( void  ) const
inlineinherited
Returns
Returns the order of a step if the stepper is used without error estimation.

Member Data Documentation

const order_type boost::numeric::odeint::explicit_error_stepper_base< explicit_error_generic_rk< StageCount, Order, StepperOrder, ErrorOrder, State, Value, Deriv, Time, Algebra, Operations, Resizer > , Order, StepperOrder, ErrorOrder, State, Value, Deriv, Time, Algebra, Operations, Resizer >::error_order_value
staticinherited
template<class Algebra, class Operations>
algebra_type boost::numeric::odeint::algebra_stepper_base< Algebra, Operations >::m_algebra
protectedinherited
wrapped_deriv_type boost::numeric::odeint::explicit_error_stepper_base< explicit_error_generic_rk< StageCount, Order, StepperOrder, ErrorOrder, State, Value, Deriv, Time, Algebra, Operations, Resizer > , Order, StepperOrder, ErrorOrder, State, Value, Deriv, Time, Algebra, Operations, Resizer >::m_dxdt
protectedinherited
const order_type boost::numeric::odeint::explicit_error_stepper_base< explicit_error_generic_rk< StageCount, Order, StepperOrder, ErrorOrder, State, Value, Deriv, Time, Algebra, Operations, Resizer > , Order, StepperOrder, ErrorOrder, State, Value, Deriv, Time, Algebra, Operations, Resizer >::order_value
staticinherited
const size_t boost::numeric::odeint::explicit_error_generic_rk< StageCount, Order, StepperOrder, ErrorOrder, State, Value, Deriv, Time, Algebra, Operations, Resizer >::stage_count
staticinherited
const order_type boost::numeric::odeint::explicit_error_stepper_base< explicit_error_generic_rk< StageCount, Order, StepperOrder, ErrorOrder, State, Value, Deriv, Time, Algebra, Operations, Resizer > , Order, StepperOrder, ErrorOrder, State, Value, Deriv, Time, Algebra, Operations, Resizer >::stepper_order_value
staticinherited

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