Chris@16: /*
Chris@16:  [auto_generated]
Chris@16:  boost/numeric/odeint/integrate/integrate_adaptive.hpp
Chris@16: 
Chris@16:  [begin_description]
Chris@16:  Adaptive integration of ODEs.
Chris@16:  [end_description]
Chris@16: 
Chris@101:  Copyright 2011-2013 Karsten Ahnert
Chris@101:  Copyright 2011-2012 Mario Mulansky
Chris@16: 
Chris@16:  Distributed under the Boost Software License, Version 1.0.
Chris@16:  (See accompanying file LICENSE_1_0.txt or
Chris@16:  copy at http://www.boost.org/LICENSE_1_0.txt)
Chris@16:  */
Chris@16: 
Chris@16: 
Chris@16: #ifndef BOOST_NUMERIC_ODEINT_INTEGRATE_INTEGRATE_ADAPTIVE_HPP_INCLUDED
Chris@16: #define BOOST_NUMERIC_ODEINT_INTEGRATE_INTEGRATE_ADAPTIVE_HPP_INCLUDED
Chris@16: 
Chris@16: #include <boost/type_traits/is_same.hpp>
Chris@16: 
Chris@16: #include <boost/numeric/odeint/stepper/stepper_categories.hpp>
Chris@16: #include <boost/numeric/odeint/integrate/null_observer.hpp>
Chris@16: #include <boost/numeric/odeint/integrate/detail/integrate_adaptive.hpp>
Chris@16: 
Chris@16: namespace boost {
Chris@16: namespace numeric {
Chris@16: namespace odeint {
Chris@16: 
Chris@16: 
Chris@16: /*
Chris@16:  * the two overloads are needed in order to solve the forwarding problem
Chris@16:  */
Chris@16: template< class Stepper , class System , class State , class Time , class Observer >
Chris@16: size_t integrate_adaptive(
Chris@16:         Stepper stepper , System system , State &start_state ,
Chris@16:         Time start_time , Time end_time , Time dt ,
Chris@16:         Observer observer )
Chris@16: {
Chris@101:     typedef typename odeint::unwrap_reference< Stepper >::type::stepper_category stepper_category;
Chris@16:     return detail::integrate_adaptive(
Chris@16:             stepper , system , start_state ,
Chris@16:             start_time , end_time , dt ,
Chris@101:             observer , stepper_category() );
Chris@16: 
Chris@16:     /*
Chris@16:      * Suggestion for a new extendable version:
Chris@16:      *
Chris@16:      * integrator_adaptive< Stepper , System, State , Time , Observer , typename Stepper::stepper_category > integrator;
Chris@16:      * return integrator.run( stepper , system , start_state , start_time , end_time , dt , observer );
Chris@16:      */
Chris@16: }
Chris@16: 
Chris@16: /**
Chris@16:  * \brief Second version to solve the forwarding problem,
Chris@16:  * can be called with Boost.Range as start_state.
Chris@16:  */
Chris@16: template< class Stepper , class System , class State , class Time , class Observer >
Chris@16: size_t integrate_adaptive(
Chris@16:         Stepper stepper , System system , const State &start_state ,
Chris@16:         Time start_time , Time end_time , Time dt ,
Chris@16:         Observer observer )
Chris@16: {
Chris@101:     typedef typename odeint::unwrap_reference< Stepper >::type::stepper_category stepper_category;
Chris@16:     return detail::integrate_adaptive(
Chris@16:             stepper , system , start_state ,
Chris@16:             start_time , end_time , dt ,
Chris@101:             observer , stepper_category() );
Chris@16: }
Chris@16: 
Chris@16: 
Chris@16: 
Chris@16: 
Chris@16: /**
Chris@16:  * \brief integrate_adaptive without an observer.
Chris@16:  */
Chris@16: template< class Stepper , class System , class State , class Time >
Chris@16: size_t integrate_adaptive(
Chris@16:         Stepper stepper , System system , State &start_state ,
Chris@16:         Time start_time , Time end_time , Time dt )
Chris@16: {
Chris@16:     return integrate_adaptive( stepper , system , start_state , start_time , end_time , dt , null_observer() );
Chris@16: }
Chris@16: 
Chris@16: /**
Chris@16:  * \brief Second version to solve the forwarding problem,
Chris@16:  * can be called with Boost.Range as start_state.
Chris@16:  */
Chris@16: template< class Stepper , class System , class State , class Time >
Chris@16: size_t integrate_adaptive(
Chris@16:         Stepper stepper , System system , const State &start_state ,
Chris@16:         Time start_time , Time end_time , Time dt )
Chris@16: {
Chris@16:     return integrate_adaptive( stepper , system , start_state , start_time , end_time , dt , null_observer() );
Chris@16: }
Chris@16: 
Chris@16: 
Chris@16: /************* DOXYGEN ************/
Chris@16: 
Chris@16:     /** 
Chris@16:      * \fn integrate_adaptive( Stepper stepper , System system , State &start_state , Time start_time , Time end_time , Time dt , Observer observer )
Chris@16:      * \brief Integrates the ODE with adaptive step size.
Chris@16:      * 
Chris@16:      * This function integrates the ODE given by system with the given stepper.
Chris@16:      * The observer is called after each step. If the stepper has no error 
Chris@16:      * control, the step size remains constant and the observer is called at
Chris@16:      * equidistant time points t0+n*dt. If the stepper is a ControlledStepper,
Chris@16:      * the step size is adjusted and the observer is called in non-equidistant
Chris@16:      * intervals.
Chris@16:      *
Chris@16:      * \param stepper The stepper to be used for numerical integration.
Chris@16:      * \param system Function/Functor defining the rhs of the ODE.
Chris@16:      * \param start_state The initial condition x0.
Chris@16:      * \param start_time The initial time t0.
Chris@16:      * \param end_time The final integration time tend.
Chris@16:      * \param dt The time step between observer calls, _not_ necessarily the 
Chris@16:      * time step of the integration.
Chris@16:      * \param observer Function/Functor called at equidistant time intervals.
Chris@16:      * \return The number of steps performed.
Chris@16:      */
Chris@16: 
Chris@16: } // namespace odeint
Chris@16: } // namespace numeric
Chris@16: } // namespace boost
Chris@16: 
Chris@16: 
Chris@16: 
Chris@16: #endif // BOOST_NUMERIC_ODEINT_INTEGRATE_INTEGRATE_ADAPTIVE_HPP_INCLUDED