odeint/iterator/adaptive_iterator.hpp

0001
0002 /*
0003  [auto_generated]
0004  boost/numeric/odeint/iterator/adaptive_iterator.hpp
0005
0006  [begin_description]
0007  Iterator for iterating throught the solution of an ODE with adaptive step size. The dereferenced types containes also the time.
0008  [end_description]
0009
0010  Copyright 2012-2013 Karsten Ahnert
0011  Copyright 2012 Mario Mulansky
0012
0013  Distributed under the Boost Software License, Version 1.0.
0014  (See accompanying file LICENSE_1_0.txt or
0015  copy at http://www.boost.org/LICENSE_1_0.txt)
0016  */
0017
0018
0019 #ifndef BOOST_NUMERIC_ODEINT_ITERATOR_ADAPTIVE_ITERATOR_HPP_INCLUDED
0020 #define BOOST_NUMERIC_ODEINT_ITERATOR_ADAPTIVE_ITERATOR_HPP_INCLUDED
0021
0022 #include <boost/numeric/odeint/util/stepper_traits.hpp>
0023 #include <boost/numeric/odeint/util/unit_helper.hpp>
0024 #include <boost/numeric/odeint/stepper/stepper_categories.hpp>
0025 #include <boost/numeric/odeint/stepper/controlled_step_result.hpp>
0026 #include <boost/numeric/odeint/iterator/impl/adaptive_iterator_impl.hpp>
0027
0028 namespace boost {
0029 namespace numeric {
0030 namespace odeint {
0031
0032     /* use the adaptive_iterator_impl with the right tags */
0033     template< class Stepper , class System , class State
0034 #ifndef DOXYGEN_SKIP
0035         , class StepperTag = typename base_tag< typename traits::stepper_category< Stepper >::type >::type
0036 #endif
0037     >
0038     class adaptive_iterator : public adaptive_iterator_impl<
0039             adaptive_iterator< Stepper , System , State , StepperTag > ,
0040             Stepper , System , State , detail::ode_state_iterator_tag , StepperTag
0041         >
0042     {
0043         typedef typename traits::time_type< Stepper >::type time_type;
0044         typedef adaptive_iterator< Stepper , System , State , StepperTag > iterator_type;
0045
0046     public:
0047         adaptive_iterator( Stepper stepper , System sys , State &s , time_type t_start , time_type t_end , time_type dt )
0048             : adaptive_iterator_impl< iterator_type , Stepper , System , State , detail::ode_state_iterator_tag , StepperTag >( stepper , sys , s , t_start , t_end , dt )
0049         {}
0050
0051         adaptive_iterator( Stepper stepper , System sys , State &s )
0052             : adaptive_iterator_impl< iterator_type , Stepper , System , State , detail::ode_state_iterator_tag , StepperTag >( stepper , sys , s )
0053         {}
0054     };
0055
0056
0057
0058
0059     template< class Stepper , class System , class State >
0060     adaptive_iterator< Stepper , System , State > make_adaptive_iterator_begin(
0061         Stepper stepper ,
0062         System system ,
0063         State &x ,
0064         typename traits::time_type< Stepper >::type t_start ,
0065         typename traits::time_type< Stepper >::type t_end ,
0066         typename traits::time_type< Stepper >::type dt )
0067     {
0068         return adaptive_iterator< Stepper , System , State >( stepper , system , x , t_start , t_end , dt );
0069     }
0070
0071
0072     template< class Stepper , class System , class State >
0073     adaptive_iterator< Stepper , System , State > make_adaptive_iterator_end(
0074         Stepper stepper ,
0075         System system ,
0076         State &x )
0077     {
0078         return adaptive_iterator< Stepper , System , State >( stepper , system , x );
0079     }
0080
0081
0082     template< class Stepper , class System , class State >
0083     std::pair< adaptive_iterator< Stepper , System , State > , adaptive_iterator< Stepper , System , State > >
0084     make_adaptive_range(
0085         Stepper stepper ,
0086         System system ,
0087         State &x ,
0088         typename traits::time_type< Stepper >::type t_start ,
0089         typename traits::time_type< Stepper >::type t_end ,
0090         typename traits::time_type< Stepper >::type dt )
0091     {
0092         return std::make_pair(
0093             adaptive_iterator< Stepper , System , State >( stepper , system , x , t_start , t_end , dt ) ,
0094             adaptive_iterator< Stepper , System , State >( stepper , system , x )
0095             );
0096     }
0097
0098     /**
0099      * \class adaptive_iterator
0100      *
0101      * \brief ODE Iterator with adaptive step size. The value type of this iterator is the state type of the stepper.
0102      *
0103      * Implements an iterator representing the solution of an ODE from t_start
0104      * to t_end evaluated at steps with an adaptive step size dt.
0105      * After each iteration the iterator dereferences to the state x at the next
0106      * time t+dt where dt is controlled by the stepper.
0107      * This iterator can be used with ControlledSteppers and
0108      * DenseOutputSteppers and it always makes use of the all the given steppers
0109      * capabilities. A for_each over such an iterator range behaves similar to
0110      * the integrate_adaptive routine.
0111      *
0112      * adaptive_iterator is a model of single-pass iterator.
0113      *
0114      * The value type of this iterator is the state type of the stepper. Hence one can only access the state and not the current time.
0115      *
0116      * \tparam Stepper The stepper type which should be used during the iteration.
0117      * \tparam System The type of the system function (ODE) which should be solved.
0118      * \tparam State The state type of the ODE.
0119      */
0120
0121
0122
0123
0124
0125
0126     /**
0127      * \fn make_adaptive_iterator_begin( Stepper stepper , System system , State &x ,
0128         typename traits::time_type< Stepper >::type t_start ,
0129         typename traits::time_type< Stepper >::type t_end ,
0130         typename traits::time_type< Stepper >::type dt )
0131      *
0132      * \brief Factory function for adaptive_iterator. Constructs a begin iterator.
0133      *
0134      * \param stepper The stepper to use during the iteration.
0135      * \param system The system function (ODE) to solve.
0136      * \param x The initial state.
0137      * \param t_start The initial time.
0138      * \param t_end The end time, at which the iteration should stop.
0139      * \param dt The initial time step.
0140      * \returns The adaptive iterator.
0141      */
0142
0143
0144     /**
0145      * \fn make_adaptive_iterator_end( Stepper stepper , System system , State &x )
0146      * \brief Factory function for adaptive_iterator. Constructs a end iterator.
0147      *
0148      * \param stepper The stepper to use during the iteration.
0149      * \param system The system function (ODE) to solve.
0150      * \param x The initial state.
0151      * \returns The adaptive iterator.
0152      */
0153
0154
0155     /**
0156      * \fn make_adaptive_range( Stepper stepper , System system , State &x ,
0157         typename traits::time_type< Stepper >::type t_start ,
0158         typename traits::time_type< Stepper >::type t_end ,
0159         typename traits::time_type< Stepper >::type dt )
0160      *
0161      * \brief Factory function to construct a single pass range of adaptive iterators. A range is here a pair of adaptive_iterator.
0162      *
0163      * \param stepper The stepper to use during the iteration.
0164      * \param system The system function (ODE) to solve.
0165      * \param x The initial state.
0166      * \param t_start The initial time.
0167      * \param t_end The end time, at which the iteration should stop.
0168      * \param dt The initial time step.
0169      * \returns The adaptive range.
0170      */
0171
0172
0173
0174
0175
0176
0177 } // namespace odeint
0178 } // namespace numeric
0179 } // namespace boost
0180
0181
0182
0183 #endif // BOOST_NUMERIC_ODEINT_ITERATOR_ADAPTIVE_ITERATOR_HPP_INCLUDED