Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world. Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

This is the documentation for an old version of boost. Click here for the latest Boost documentation.
Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext

Function template integrate_const

boost::numeric::odeint::integrate_const — Integrates the ODE with constant step size.

Synopsis

// In header: <boost/numeric/odeint/integrate/integrate_const.hpp>


template<typename Stepper, typename System, typename State, typename Time, 
         typename Observer> 
  size_t integrate_const(Stepper stepper, System system, State & start_state, 
                         Time start_time, Time end_time, Time dt, 
                         Observer observer);

Description

Integrates the ODE defined by system using the given stepper. This method ensures that the observer is called at constant intervals dt. If the Stepper is a normal stepper without step size control, dt is also used for the numerical scheme. If a ControlledStepper is provided, the algorithm might reduce the step size to meet the error bounds, but it is ensured that the observer is always called at equidistant time points t0 + n*dt. If a DenseOutputStepper is used, the step size also may vary and the dense output is used to call the observer at equidistant time points.

Parameters:

dt

The time step between observer calls, not necessarily the time step of the integration.

end_time

The final integration time tend.

observer

Function/Functor called at equidistant time intervals.

start_state

The initial condition x0.

start_time

The initial time t0.

stepper

The stepper to be used for numerical integration.

system

Function/Functor defining the rhs of the ODE.

Returns:

The number of steps performed.


PrevUpHomeNext