diff options
Diffstat (limited to 'boost/numeric/odeint/integrate/integrate_const.hpp')
| -rw-r--r-- | boost/numeric/odeint/integrate/integrate_const.hpp | 203 |
1 files changed, 120 insertions, 83 deletions
diff --git a/boost/numeric/odeint/integrate/integrate_const.hpp b/boost/numeric/odeint/integrate/integrate_const.hpp index ba2d891e97..fae683f978 100644 --- a/boost/numeric/odeint/integrate/integrate_const.hpp +++ b/boost/numeric/odeint/integrate/integrate_const.hpp @@ -8,7 +8,7 @@ [end_description] Copyright 2011-2013 Karsten Ahnert - Copyright 2011-2012 Mario Mulansky + Copyright 2011-2015 Mario Mulansky Distributed under the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or @@ -23,6 +23,7 @@ #include <boost/numeric/odeint/stepper/stepper_categories.hpp> #include <boost/numeric/odeint/integrate/null_observer.hpp> +#include <boost/numeric/odeint/integrate/check_adapter.hpp> #include <boost/numeric/odeint/integrate/detail/integrate_const.hpp> #include <boost/numeric/odeint/integrate/detail/integrate_adaptive.hpp> @@ -31,91 +32,120 @@ namespace numeric { namespace odeint { - - - /* * Integrates with constant time step dt. */ -template< class Stepper , class System , class State , class Time , class Observer > +template<class Stepper, class System, class State, class Time, class Observer, class StepOverflowChecker> size_t integrate_const( - Stepper stepper , System system , State &start_state , - Time start_time , Time end_time , Time dt , - Observer observer -) -{ - typedef typename odeint::unwrap_reference< Stepper >::type::stepper_category stepper_category; + Stepper stepper, System system, State &start_state, + Time start_time, Time end_time, Time dt, + Observer observer, StepOverflowChecker checker +) { + typedef typename odeint::unwrap_reference<Stepper>::type::stepper_category stepper_category; // we want to get as fast as possible to the end - if( boost::is_same< null_observer , Observer >::value ) - { + // no overflow checks needed + if (boost::is_same<null_observer, Observer>::value) { return detail::integrate_adaptive( - stepper , system , start_state , - start_time , end_time , dt , - observer , stepper_category() ); + stepper, system, start_state, + start_time, end_time, dt, + observer, stepper_category()); + } + else { + // unwrap references + typedef typename odeint::unwrap_reference< Stepper >::type stepper_type; + typedef typename odeint::unwrap_reference< Observer >::type observer_type; + typedef typename odeint::unwrap_reference< StepOverflowChecker >::type checker_type; + + return detail::integrate_const(checked_stepper<stepper_type, checker_type>(stepper, checker), + system, start_state, + start_time, end_time, dt, + checked_observer<observer_type, checker_type>(observer, checker), + stepper_category()); } - else - { - return detail::integrate_const( stepper , system , start_state , - start_time , end_time , dt , - observer , stepper_category() ); - } } /** - * \brief Second version to solve the forwarding problem, - * can be called with Boost.Range as start_state. - */ -template< class Stepper , class System , class State , class Time , class Observer > +* \brief Second version to solve the forwarding problem, +* can be called with Boost.Range as start_state. +*/ +template<class Stepper, class System, class State, class Time, class Observer, class StepOverflowChecker > size_t integrate_const( - Stepper stepper , System system , const State &start_state , - Time start_time , Time end_time , Time dt , - Observer observer -) -{ - typedef typename odeint::unwrap_reference< Stepper >::type::stepper_category stepper_category; + Stepper stepper, System system, const State &start_state, + Time start_time, Time end_time, Time dt, + Observer observer, StepOverflowChecker checker +) { + typedef typename odeint::unwrap_reference<Stepper>::type::stepper_category stepper_category; // we want to get as fast as possible to the end - if( boost::is_same< null_observer , Observer >::value ) - { + + if (boost::is_same<null_observer, Observer>::value) { return detail::integrate_adaptive( - stepper , system , start_state , - start_time , end_time , dt , - observer , stepper_category() ); + stepper, system, start_state, + start_time, end_time, dt, + observer, stepper_category()); } - else - { - return detail::integrate_const( stepper , system , start_state , - start_time , end_time , dt , - observer , stepper_category() ); + else { + typedef typename odeint::unwrap_reference< Stepper >::type stepper_type; + typedef typename odeint::unwrap_reference< Observer >::type observer_type; + typedef typename odeint::unwrap_reference< StepOverflowChecker >::type checker_type; + + return detail::integrate_const(checked_stepper<stepper_type, checker_type>(stepper, checker), + system, start_state, + start_time, end_time, dt, + checked_observer<observer_type, checker_type>(observer, checker), + stepper_category()); } } +/** +* \brief integrate_const without step overflow checker +*/ +template<class Stepper, class System, class State, class Time, class Observer> +size_t integrate_const( + Stepper stepper, System system, State &start_state, + Time start_time, Time end_time, Time dt, Observer observer) +{ + typedef typename odeint::unwrap_reference<Stepper>::type::stepper_category stepper_category; + return detail::integrate_const(stepper, system, start_state, + start_time, end_time, dt, observer, stepper_category()); +} +/** +* \brief Second version to solve the forwarding problem, +* can be called with Boost.Range as start_state. +*/ +template<class Stepper, class System, class State, class Time, class Observer> +size_t integrate_const( + Stepper stepper, System system, const State &start_state, + Time start_time, Time end_time, Time dt, Observer observer +) { + typedef typename odeint::unwrap_reference<Stepper>::type::stepper_category stepper_category; + return detail::integrate_const(stepper, system, start_state, + start_time, end_time, dt, observer, stepper_category()); +} /** - * \brief integrate_const without observer calls - */ -template< class Stepper , class System , class State , class Time > +* \brief integrate_const without observer calls +*/ +template<class Stepper, class System, class State, class Time> size_t integrate_const( - Stepper stepper , System system , State &start_state , - Time start_time , Time end_time , Time dt -) -{ - return integrate_const( stepper , system , start_state , start_time , end_time , dt , null_observer() ); + Stepper stepper, System system, State &start_state, + Time start_time, Time end_time, Time dt +) { + return integrate_const(stepper, system, start_state, start_time, end_time, dt, null_observer()); } /** - * \brief Second version to solve the forwarding problem, - * can be called with Boost.Range as start_state. - */ -template< class Stepper , class System , class State , class Time > +* \brief Second version to solve the forwarding problem, +* can be called with Boost.Range as start_state. +*/ +template<class Stepper, class System, class State, class Time> size_t integrate_const( - Stepper stepper , System system , const State &start_state , - Time start_time , Time end_time , Time dt -) -{ - return integrate_const( stepper , system , start_state , start_time , end_time , dt , null_observer() ); + Stepper stepper, System system, const State &start_state, + Time start_time, Time end_time, Time dt +) { + return integrate_const(stepper, system, start_state, start_time, end_time, dt, null_observer()); } @@ -124,30 +154,37 @@ size_t integrate_const( /********* DOXYGEN *********/ - /** - * \fn integrate_const( Stepper stepper , System system , State &start_state , Time start_time , Time end_time , Time dt , Observer observer ) - * \brief Integrates the ODE with constant step size. - * - * 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. - * - * \param stepper The stepper to be used for numerical integration. - * \param system Function/Functor defining the rhs of the ODE. - * \param start_state The initial condition x0. - * \param start_time The initial time t0. - * \param end_time The final integration time tend. - * \param dt The time step between observer calls, _not_ necessarily the - * time step of the integration. - * \param observer Function/Functor called at equidistant time intervals. - * \return The number of steps performed. - */ +/** + * \fn integrate_const( Stepper stepper , System system , State &start_state , Time start_time , + * Time end_time , Time dt , Observer observer , StepOverflowChecker checker ) + * \brief Integrates the ODE with constant step size. + * + * 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. + * If a max_step_checker is provided as StepOverflowChecker, a + * no_progress_error is thrown if too many steps (default: 500) are performed + * without progress, i.e. in between observer calls. If no checker is provided, + * no such overflow check is performed. + * + * \param stepper The stepper to be used for numerical integration. + * \param system Function/Functor defining the rhs of the ODE. + * \param start_state The initial condition x0. + * \param start_time The initial time t0. + * \param end_time The final integration time tend. + * \param dt The time step between observer calls, _not_ necessarily the + * time step of the integration. + * \param observer [optional] Function/Functor called at equidistant time intervals. + * \param checker [optional] Functor to check for step count overflows, if no + * checker is provided, no exception is thrown. + * \return The number of steps performed. + */ } // namespace odeint } // namespace numeric |