libs/numeric/odeint/doc/html/boost/numeric/odeint/integrat_idm45806991385616.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Function template integrate_adaptive</title>
   5 <link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   7 <link rel="home" href="../../../index.html" title="Chapter&#160;1.&#160;Boost.Numeric.Odeint">
   8 <link rel="up" href="../../../header/boost/numeric/odeint/integrate/integrate_adaptive_hpp.html" title="Header &lt;boost/numeric/odeint/integrate/integrate_adaptive.hpp&gt;">
   9 <link rel="prev" href="../../../header/boost/numeric/odeint/integrate/integrate_adaptive_hpp.html" title="Header &lt;boost/numeric/odeint/integrate/integrate_adaptive.hpp&gt;">
  10 <link rel="next" href="../../../header/boost/numeric/odeint/integrate/integrate_const_hpp.html" title="Header &lt;boost/numeric/odeint/integrate/integrate_const.hpp&gt;">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../logo.jpg"></td>
  15 <td align="center"><a href="../../../../../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="../../../header/boost/numeric/odeint/integrate/integrate_adaptive_hpp.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../header/boost/numeric/odeint/integrate/integrate_adaptive_hpp.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../../../header/boost/numeric/odeint/integrate/integrate_const_hpp.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.numeric.odeint.integrat_idm45806991385616"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Function template integrate_adaptive</span></h2>
  29 <p>boost::numeric::odeint::integrate_adaptive &#8212; Integrates the ODE with adaptive step size. </p>
  30 </div>
  31 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  32 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../../header/boost/numeric/odeint/integrate/integrate_adaptive_hpp.html" title="Header &lt;boost/numeric/odeint/integrate/integrate_adaptive.hpp&gt;">boost/numeric/odeint/integrate/integrate_adaptive.hpp</a>&gt;
  33
  34 </span>
  35 <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Stepper<span class="special">,</span> <span class="keyword">typename</span> System<span class="special">,</span> <span class="keyword">typename</span> State<span class="special">,</span> <span class="keyword">typename</span> Time<span class="special">,</span>
  36          <span class="keyword">typename</span> Observer<span class="special">&gt;</span>
  37   <span class="identifier">size_t</span> <span class="identifier">integrate_adaptive</span><span class="special">(</span><span class="identifier">Stepper</span> stepper<span class="special">,</span> <span class="identifier">System</span> system<span class="special">,</span>
  38                             <span class="identifier">State</span> <span class="special">&amp;</span> start_state<span class="special">,</span> <span class="identifier">Time</span> start_time<span class="special">,</span>
  39                             <span class="identifier">Time</span> end_time<span class="special">,</span> <span class="identifier">Time</span> dt<span class="special">,</span> <span class="identifier">Observer</span> observer<span class="special">)</span><span class="special">;</span></pre></div>
  40 <div class="refsect1">
  41 <a name="idm46278829274096"></a><h2>Description</h2>
  42 <p>This function integrates the ODE given by system with the given stepper. The observer is called after each step. If the stepper has no error control, the step size remains constant and the observer is called at equidistant time points t0+n*dt. If the stepper is a ControlledStepper, the step size is adjusted and the observer is called in non-equidistant intervals.</p>
  43 <p>
  44
  45 </p>
  46 <div class="variablelist"><table border="0" class="variablelist compact">
  47 <colgroup>
  48 <col align="left" valign="top">
  49 <col>
  50 </colgroup>
  51 <tbody>
  52 <tr>
  53 <td><p><span class="term">Parameters:</span></p></td>
  54 <td><div class="variablelist"><table border="0" class="variablelist compact">
  55 <colgroup>
  56 <col align="left" valign="top">
  57 <col>
  58 </colgroup>
  59 <tbody>
  60 <tr>
  61 <td><p><span class="term"><code class="computeroutput">dt</code></span></p></td>
  62 <td><p>The time step between observer calls, <span class="emphasis"><em>not</em></span> necessarily the time step of the integration. </p></td>
  63 </tr>
  64 <tr>
  65 <td><p><span class="term"><code class="computeroutput">end_time</code></span></p></td>
  66 <td><p>The final integration time tend. </p></td>
  67 </tr>
  68 <tr>
  69 <td><p><span class="term"><code class="computeroutput">observer</code></span></p></td>
  70 <td><p>Function/Functor called at equidistant time intervals. </p></td>
  71 </tr>
  72 <tr>
  73 <td><p><span class="term"><code class="computeroutput">start_state</code></span></p></td>
  74 <td><p>The initial condition x0. </p></td>
  75 </tr>
  76 <tr>
  77 <td><p><span class="term"><code class="computeroutput">start_time</code></span></p></td>
  78 <td><p>The initial time t0. </p></td>
  79 </tr>
  80 <tr>
  81 <td><p><span class="term"><code class="computeroutput">stepper</code></span></p></td>
  82 <td><p>The stepper to be used for numerical integration. </p></td>
  83 </tr>
  84 <tr>
  85 <td><p><span class="term"><code class="computeroutput">system</code></span></p></td>
  86 <td><p>Function/Functor defining the rhs of the ODE. </p></td>
  87 </tr>
  88 </tbody>
  89 </table></div></td>
  90 </tr>
  91 <tr>
  92 <td><p><span class="term">Returns:</span></p></td>
  93 <td><p>The number of steps performed. </p></td>
  94 </tr>
  95 </tbody>
  96 </table></div>
  97 </div>
  98 </div>
  99 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 100 <td align="left"></td>
 101 <td align="right"><div class="copyright-footer">Copyright &#169; 2009-2015 Karsten Ahnert and Mario Mulansky<p>
 102         Distributed under the Boost Software License, Version 1.0. (See accompanying
 103         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
 104       </p>
 105 </div></td>
 106 </tr></table>
 107 <hr>
 108 <div class="spirit-nav">
 109 <a accesskey="p" href="../../../header/boost/numeric/odeint/integrate/integrate_adaptive_hpp.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../header/boost/numeric/odeint/integrate/integrate_adaptive_hpp.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../../../header/boost/numeric/odeint/integrate/integrate_const_hpp.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
 110 </div>
 111 </body>
 112 </html>