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

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template runge_kutta_dopri5</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/stepper/runge_kutta_dopri5_hpp.html" title="Header &lt;boost/numeric/odeint/stepper/runge_kutta_dopri5.hpp&gt;">
   9 <link rel="prev" href="../../../header/boost/numeric/odeint/stepper/runge_kutta_dopri5_hpp.html" title="Header &lt;boost/numeric/odeint/stepper/runge_kutta_dopri5.hpp&gt;">
  10 <link rel="next" href="../../../header/boost/numeric/odeint/stepper/runge_kutta_fehlberg78_hpp.html" title="Header &lt;boost/numeric/odeint/stepper/runge_kutta_fehlberg78.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/stepper/runge_kutta_dopri5_hpp.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../header/boost/numeric/odeint/stepper/runge_kutta_dopri5_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/stepper/runge_kutta_fehlberg78_hpp.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.numeric.odeint.runge_kutta_dopri5"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class template runge_kutta_dopri5</span></h2>
  29 <p>boost::numeric::odeint::runge_kutta_dopri5 &#8212; The Runge-Kutta Dormand-Prince 5 method. </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/stepper/runge_kutta_dopri5_hpp.html" title="Header &lt;boost/numeric/odeint/stepper/runge_kutta_dopri5.hpp&gt;">boost/numeric/odeint/stepper/runge_kutta_dopri5.hpp</a>&gt;
  33
  34 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> State<span class="special">,</span> <span class="keyword">typename</span> Value <span class="special">=</span> <span class="keyword">double</span><span class="special">,</span> <span class="keyword">typename</span> Deriv <span class="special">=</span> <span class="identifier">State</span><span class="special">,</span>
  35          <span class="keyword">typename</span> Time <span class="special">=</span> <span class="identifier">Value</span><span class="special">,</span>
  36          <span class="keyword">typename</span> Algebra <span class="special">=</span> <span class="keyword">typename</span> <span class="identifier">algebra_dispatcher</span><span class="special">&lt;</span> <span class="identifier">State</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">algebra_type</span><span class="special">,</span>
  37          <span class="keyword">typename</span> Operations <span class="special">=</span> <span class="keyword">typename</span> <span class="identifier">operations_dispatcher</span><span class="special">&lt;</span> <span class="identifier">State</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">operations_type</span><span class="special">,</span>
  38          <span class="keyword">typename</span> Resizer <span class="special">=</span> <span class="identifier">initially_resizer</span><span class="special">&gt;</span>
  39 <span class="keyword">class</span> <a class="link" href="runge_kutta_dopri5.html" title="Class template runge_kutta_dopri5">runge_kutta_dopri5</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">explicit_error_stepper_fsal_base</span> <span class="special">{</span>
  40 <span class="keyword">public</span><span class="special">:</span>
  41   <span class="comment">// types</span>
  42   <span class="keyword">typedef</span> <span class="identifier">explicit_error_stepper_fsal_base</span><span class="special">&lt;</span> <a class="link" href="runge_kutta_dopri5.html" title="Class template runge_kutta_dopri5">runge_kutta_dopri5</a><span class="special">&lt;</span> <span class="special">...</span> <span class="special">&gt;</span><span class="special">,</span><span class="special">...</span> <span class="special">&gt;</span> <a name="boost.numeric.odeint.runge_kutta_dopri5.stepper_base_type"></a><span class="identifier">stepper_base_type</span><span class="special">;</span>
  43   <span class="keyword">typedef</span> <span class="identifier">stepper_base_type</span><span class="special">::</span><span class="identifier">state_type</span>                                     <a name="boost.numeric.odeint.runge_kutta_dopri5.state_type"></a><span class="identifier">state_type</span><span class="special">;</span>
  44   <span class="keyword">typedef</span> <span class="identifier">stepper_base_type</span><span class="special">::</span><span class="identifier">value_type</span>                                     <a name="boost.numeric.odeint.runge_kutta_dopri5.value_type"></a><span class="identifier">value_type</span><span class="special">;</span>
  45   <span class="keyword">typedef</span> <span class="identifier">stepper_base_type</span><span class="special">::</span><span class="identifier">deriv_type</span>                                     <a name="boost.numeric.odeint.runge_kutta_dopri5.deriv_type"></a><span class="identifier">deriv_type</span><span class="special">;</span>
  46   <span class="keyword">typedef</span> <span class="identifier">stepper_base_type</span><span class="special">::</span><span class="identifier">time_type</span>                                      <a name="boost.numeric.odeint.runge_kutta_dopri5.time_type"></a><span class="identifier">time_type</span><span class="special">;</span>
  47   <span class="keyword">typedef</span> <span class="identifier">stepper_base_type</span><span class="special">::</span><span class="identifier">algebra_type</span>                                   <a name="boost.numeric.odeint.runge_kutta_dopri5.algebra_type"></a><span class="identifier">algebra_type</span><span class="special">;</span>
  48   <span class="keyword">typedef</span> <span class="identifier">stepper_base_type</span><span class="special">::</span><span class="identifier">operations_type</span>                                <a name="boost.numeric.odeint.runge_kutta_dopri5.operations_type"></a><span class="identifier">operations_type</span><span class="special">;</span>
  49   <span class="keyword">typedef</span> <span class="identifier">stepper_base_type</span><span class="special">::</span><span class="identifier">resizer_type</span>                                   <a name="boost.numeric.odeint.runge_kutta_dopri5.resizer_type"></a><span class="identifier">resizer_type</span><span class="special">;</span>
  50
  51   <span class="comment">// <a class="link" href="runge_kutta_dopri5.html#boost.numeric.odeint.runge_kutta_dopri5construct-copy-destruct">construct/copy/destruct</a></span>
  52   <a class="link" href="runge_kutta_dopri5.html#idm45853738591248-bb"><span class="identifier">runge_kutta_dopri5</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">algebra_type</span> <span class="special">&amp;</span> <span class="special">=</span> <span class="identifier">algebra_type</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span>
  53
  54   <span class="comment">// <a class="link" href="runge_kutta_dopri5.html#idm45853738643664-bb">public member functions</a></span>
  55   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> System<span class="special">,</span> <span class="keyword">typename</span> StateIn<span class="special">,</span> <span class="keyword">typename</span> DerivIn<span class="special">,</span>
  56            <span class="keyword">typename</span> StateOut<span class="special">,</span> <span class="keyword">typename</span> DerivOut<span class="special">&gt;</span>
  57     <span class="keyword">void</span> <a class="link" href="runge_kutta_dopri5.html#idm45853738643104-bb"><span class="identifier">do_step_impl</span></a><span class="special">(</span><span class="identifier">System</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">StateIn</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">DerivIn</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">time_type</span><span class="special">,</span>
  58                       <span class="identifier">StateOut</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">DerivOut</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">time_type</span><span class="special">)</span><span class="special">;</span>
  59   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> System<span class="special">,</span> <span class="keyword">typename</span> StateIn<span class="special">,</span> <span class="keyword">typename</span> DerivIn<span class="special">,</span>
  60            <span class="keyword">typename</span> StateOut<span class="special">,</span> <span class="keyword">typename</span> DerivOut<span class="special">,</span> <span class="keyword">typename</span> Err<span class="special">&gt;</span>
  61     <span class="keyword">void</span> <a class="link" href="runge_kutta_dopri5.html#idm45853738626576-bb"><span class="identifier">do_step_impl</span></a><span class="special">(</span><span class="identifier">System</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">StateIn</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">DerivIn</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">time_type</span><span class="special">,</span>
  62                       <span class="identifier">StateOut</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">DerivOut</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">time_type</span><span class="special">,</span> <span class="identifier">Err</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  63   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> StateOut<span class="special">,</span> <span class="keyword">typename</span> StateIn1<span class="special">,</span> <span class="keyword">typename</span> DerivIn1<span class="special">,</span>
  64            <span class="keyword">typename</span> StateIn2<span class="special">,</span> <span class="keyword">typename</span> DerivIn2<span class="special">&gt;</span>
  65     <span class="keyword">void</span> <a class="link" href="runge_kutta_dopri5.html#idm45853738608320-bb"><span class="identifier">calc_state</span></a><span class="special">(</span><span class="identifier">time_type</span><span class="special">,</span> <span class="identifier">StateOut</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">StateIn1</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">DerivIn1</span> <span class="special">&amp;</span><span class="special">,</span>
  66                     <span class="identifier">time_type</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">StateIn2</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">DerivIn2</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">time_type</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  67   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> StateIn<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="runge_kutta_dopri5.html#idm45853738595024-bb"><span class="identifier">adjust_size</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">StateIn</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  68
  69   <span class="comment">// <a class="link" href="runge_kutta_dopri5.html#idm45853738587968-bb">private member functions</a></span>
  70   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> StateIn<span class="special">&gt;</span> <span class="keyword">bool</span> <a class="link" href="runge_kutta_dopri5.html#idm45853738587392-bb"><span class="identifier">resize_k_x_tmp_impl</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">StateIn</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  71   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> StateIn<span class="special">&gt;</span> <span class="keyword">bool</span> <a class="link" href="runge_kutta_dopri5.html#idm45853738585008-bb"><span class="identifier">resize_dxdt_tmp_impl</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">StateIn</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  72 <span class="special">}</span><span class="special">;</span></pre></div>
  73 <div class="refsect1">
  74 <a name="idm45221355286640"></a><h2>Description</h2>
  75 <p>The Runge-Kutta Dormand-Prince 5 method is a very popular method for solving ODEs, see <a href="../../../" target="_top"></a>. The method is explicit and fulfills the Error Stepper concept. Step size control is provided but continuous output is available which make this method favourable for many applications.</p>
  76 <p>This class derives from explicit_error_stepper_fsal_base and inherits its interface via CRTP (current recurring template pattern). The method possesses the FSAL (first-same-as-last) property. See explicit_error_stepper_fsal_base for more details.</p>
  77 <p>
  78 </p>
  79 <div class="refsect2">
  80 <a name="idm45221355284528"></a><h3>Template Parameters</h3>
  81 <div class="orderedlist"><ol class="orderedlist" type="1">
  82 <li class="listitem">
  83 <pre class="literallayout"><span class="keyword">typename</span> State</pre>
  84 <p>The state type. </p>
  85 </li>
  86 <li class="listitem">
  87 <pre class="literallayout"><span class="keyword">typename</span> Value <span class="special">=</span> <span class="keyword">double</span></pre>
  88 <p>The value type. </p>
  89 </li>
  90 <li class="listitem">
  91 <pre class="literallayout"><span class="keyword">typename</span> Deriv <span class="special">=</span> <span class="identifier">State</span></pre>
  92 <p>The type representing the time derivative of the state. </p>
  93 </li>
  94 <li class="listitem">
  95 <pre class="literallayout"><span class="keyword">typename</span> Time <span class="special">=</span> <span class="identifier">Value</span></pre>
  96 <p>The time representing the independent variable - the time. </p>
  97 </li>
  98 <li class="listitem">
  99 <pre class="literallayout"><span class="keyword">typename</span> Algebra <span class="special">=</span> <span class="keyword">typename</span> <span class="identifier">algebra_dispatcher</span><span class="special">&lt;</span> <span class="identifier">State</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">algebra_type</span></pre>
 100 <p>The algebra type. </p>
 101 </li>
 102 <li class="listitem">
 103 <pre class="literallayout"><span class="keyword">typename</span> Operations <span class="special">=</span> <span class="keyword">typename</span> <span class="identifier">operations_dispatcher</span><span class="special">&lt;</span> <span class="identifier">State</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">operations_type</span></pre>
 104 <p>The operations type. </p>
 105 </li>
 106 <li class="listitem">
 107 <pre class="literallayout"><span class="keyword">typename</span> Resizer <span class="special">=</span> <span class="identifier">initially_resizer</span></pre>
 108 <p>The resizer policy type. </p>
 109 </li>
 110 </ol></div>
 111 </div>
 112 <div class="refsect2">
 113 <a name="idm45221355256912"></a><h3>
 114 <a name="boost.numeric.odeint.runge_kutta_dopri5construct-copy-destruct"></a><code class="computeroutput">runge_kutta_dopri5</code>
 115         public
 116        construct/copy/destruct</h3>
 117 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
 118 <pre class="literallayout"><a name="idm45853738591248-bb"></a><span class="identifier">runge_kutta_dopri5</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">algebra_type</span> <span class="special">&amp;</span> algebra <span class="special">=</span> <span class="identifier">algebra_type</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre>Constructs the <code class="computeroutput"><a class="link" href="runge_kutta_dopri5.html" title="Class template runge_kutta_dopri5">runge_kutta_dopri5</a></code> class. This constructor can be used as a default constructor if the algebra has a default constructor. <p>
 119 </p>
 120 <div class="variablelist"><table border="0" class="variablelist compact">
 121 <colgroup>
 122 <col align="left" valign="top">
 123 <col>
 124 </colgroup>
 125 <tbody><tr>
 126 <td><p><span class="term">Parameters:</span></p></td>
 127 <td><div class="variablelist"><table border="0" class="variablelist compact">
 128 <colgroup>
 129 <col align="left" valign="top">
 130 <col>
 131 </colgroup>
 132 <tbody><tr>
 133 <td><p><span class="term"><code class="computeroutput">algebra</code></span></p></td>
 134 <td><p>A copy of algebra is made and stored inside explicit_stepper_base. </p></td>
 135 </tr></tbody>
 136 </table></div></td>
 137 </tr></tbody>
 138 </table></div>
 139 </li></ol></div>
 140 </div>
 141 <div class="refsect2">
 142 <a name="idm45221355242512"></a><h3>
 143 <a name="idm45853738643664-bb"></a><code class="computeroutput">runge_kutta_dopri5</code> public member functions</h3>
 144 <div class="orderedlist"><ol class="orderedlist" type="1">
 145 <li class="listitem">
 146 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> System<span class="special">,</span> <span class="keyword">typename</span> StateIn<span class="special">,</span> <span class="keyword">typename</span> DerivIn<span class="special">,</span>
 147          <span class="keyword">typename</span> StateOut<span class="special">,</span> <span class="keyword">typename</span> DerivOut<span class="special">&gt;</span>
 148   <span class="keyword">void</span> <a name="idm45853738643104-bb"></a><span class="identifier">do_step_impl</span><span class="special">(</span><span class="identifier">System</span> system<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">StateIn</span> <span class="special">&amp;</span> in<span class="special">,</span>
 149                     <span class="keyword">const</span> <span class="identifier">DerivIn</span> <span class="special">&amp;</span> dxdt_in<span class="special">,</span> <span class="identifier">time_type</span> t<span class="special">,</span> <span class="identifier">StateOut</span> <span class="special">&amp;</span> out<span class="special">,</span>
 150                     <span class="identifier">DerivOut</span> <span class="special">&amp;</span> dxdt_out<span class="special">,</span> <span class="identifier">time_type</span> dt<span class="special">)</span><span class="special">;</span></pre>This method performs one step. The derivative <code class="computeroutput">dxdt_in</code> of <code class="computeroutput">in</code> at the time <code class="computeroutput">t</code> is passed to the method. The result is updated out-of-place, hence the input is in <code class="computeroutput">in</code> and the output in <code class="computeroutput">out</code>. Furthermore, the derivative is update out-of-place, hence the input is assumed to be in <code class="computeroutput">dxdt_in</code> and the output in <code class="computeroutput">dxdt_out</code>. Access to this step functionality is provided by explicit_error_stepper_fsal_base and <code class="computeroutput">do_step_impl</code> should not be called directly. <p>
 151 </p>
 152 <div class="variablelist"><table border="0" class="variablelist compact">
 153 <colgroup>
 154 <col align="left" valign="top">
 155 <col>
 156 </colgroup>
 157 <tbody><tr>
 158 <td><p><span class="term">Parameters:</span></p></td>
 159 <td><div class="variablelist"><table border="0" class="variablelist compact">
 160 <colgroup>
 161 <col align="left" valign="top">
 162 <col>
 163 </colgroup>
 164 <tbody>
 165 <tr>
 166 <td><p><span class="term"><code class="computeroutput">dt</code></span></p></td>
 167 <td><p>The step size. </p></td>
 168 </tr>
 169 <tr>
 170 <td><p><span class="term"><code class="computeroutput">dxdt_in</code></span></p></td>
 171 <td><p>The derivative of x at t. dxdt_in is not modified by this method </p></td>
 172 </tr>
 173 <tr>
 174 <td><p><span class="term"><code class="computeroutput">dxdt_out</code></span></p></td>
 175 <td><p>The result of the new derivative at time t+dt. </p></td>
 176 </tr>
 177 <tr>
 178 <td><p><span class="term"><code class="computeroutput">in</code></span></p></td>
 179 <td><p>The state of the ODE which should be solved. in is not modified in this method </p></td>
 180 </tr>
 181 <tr>
 182 <td><p><span class="term"><code class="computeroutput">out</code></span></p></td>
 183 <td><p>The result of the step is written in out. </p></td>
 184 </tr>
 185 <tr>
 186 <td><p><span class="term"><code class="computeroutput">system</code></span></p></td>
 187 <td><p>The system function to solve, hence the r.h.s. of the ODE. It must fulfill the Simple System concept. </p></td>
 188 </tr>
 189 <tr>
 190 <td><p><span class="term"><code class="computeroutput">t</code></span></p></td>
 191 <td><p>The value of the time, at which the step should be performed. </p></td>
 192 </tr>
 193 </tbody>
 194 </table></div></td>
 195 </tr></tbody>
 196 </table></div>
 197 </li>
 198 <li class="listitem">
 199 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> System<span class="special">,</span> <span class="keyword">typename</span> StateIn<span class="special">,</span> <span class="keyword">typename</span> DerivIn<span class="special">,</span>
 200          <span class="keyword">typename</span> StateOut<span class="special">,</span> <span class="keyword">typename</span> DerivOut<span class="special">,</span> <span class="keyword">typename</span> Err<span class="special">&gt;</span>
 201   <span class="keyword">void</span> <a name="idm45853738626576-bb"></a><span class="identifier">do_step_impl</span><span class="special">(</span><span class="identifier">System</span> system<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">StateIn</span> <span class="special">&amp;</span> in<span class="special">,</span>
 202                     <span class="keyword">const</span> <span class="identifier">DerivIn</span> <span class="special">&amp;</span> dxdt_in<span class="special">,</span> <span class="identifier">time_type</span> t<span class="special">,</span> <span class="identifier">StateOut</span> <span class="special">&amp;</span> out<span class="special">,</span>
 203                     <span class="identifier">DerivOut</span> <span class="special">&amp;</span> dxdt_out<span class="special">,</span> <span class="identifier">time_type</span> dt<span class="special">,</span> <span class="identifier">Err</span> <span class="special">&amp;</span> xerr<span class="special">)</span><span class="special">;</span></pre>This method performs one step. The derivative <code class="computeroutput">dxdt_in</code> of <code class="computeroutput">in</code> at the time <code class="computeroutput">t</code> is passed to the method. The result is updated out-of-place, hence the input is in <code class="computeroutput">in</code> and the output in <code class="computeroutput">out</code>. Furthermore, the derivative is update out-of-place, hence the input is assumed to be in <code class="computeroutput">dxdt_in</code> and the output in <code class="computeroutput">dxdt_out</code>. Access to this step functionality is provided by explicit_error_stepper_fsal_base and <code class="computeroutput">do_step_impl</code> should not be called directly. An estimation of the error is calculated. <p>
 204 </p>
 205 <div class="variablelist"><table border="0" class="variablelist compact">
 206 <colgroup>
 207 <col align="left" valign="top">
 208 <col>
 209 </colgroup>
 210 <tbody><tr>
 211 <td><p><span class="term">Parameters:</span></p></td>
 212 <td><div class="variablelist"><table border="0" class="variablelist compact">
 213 <colgroup>
 214 <col align="left" valign="top">
 215 <col>
 216 </colgroup>
 217 <tbody>
 218 <tr>
 219 <td><p><span class="term"><code class="computeroutput">dt</code></span></p></td>
 220 <td><p>The step size. </p></td>
 221 </tr>
 222 <tr>
 223 <td><p><span class="term"><code class="computeroutput">dxdt_in</code></span></p></td>
 224 <td><p>The derivative of x at t. dxdt_in is not modified by this method </p></td>
 225 </tr>
 226 <tr>
 227 <td><p><span class="term"><code class="computeroutput">dxdt_out</code></span></p></td>
 228 <td><p>The result of the new derivative at time t+dt. </p></td>
 229 </tr>
 230 <tr>
 231 <td><p><span class="term"><code class="computeroutput">in</code></span></p></td>
 232 <td><p>The state of the ODE which should be solved. in is not modified in this method </p></td>
 233 </tr>
 234 <tr>
 235 <td><p><span class="term"><code class="computeroutput">out</code></span></p></td>
 236 <td><p>The result of the step is written in out. </p></td>
 237 </tr>
 238 <tr>
 239 <td><p><span class="term"><code class="computeroutput">system</code></span></p></td>
 240 <td><p>The system function to solve, hence the r.h.s. of the ODE. It must fulfill the Simple System concept. </p></td>
 241 </tr>
 242 <tr>
 243 <td><p><span class="term"><code class="computeroutput">t</code></span></p></td>
 244 <td><p>The value of the time, at which the step should be performed. </p></td>
 245 </tr>
 246 <tr>
 247 <td><p><span class="term"><code class="computeroutput">xerr</code></span></p></td>
 248 <td><p>An estimation of the error. </p></td>
 249 </tr>
 250 </tbody>
 251 </table></div></td>
 252 </tr></tbody>
 253 </table></div>
 254 </li>
 255 <li class="listitem">
 256 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> StateOut<span class="special">,</span> <span class="keyword">typename</span> StateIn1<span class="special">,</span> <span class="keyword">typename</span> DerivIn1<span class="special">,</span>
 257          <span class="keyword">typename</span> StateIn2<span class="special">,</span> <span class="keyword">typename</span> DerivIn2<span class="special">&gt;</span>
 258   <span class="keyword">void</span> <a name="idm45853738608320-bb"></a><span class="identifier">calc_state</span><span class="special">(</span><span class="identifier">time_type</span> t<span class="special">,</span> <span class="identifier">StateOut</span> <span class="special">&amp;</span> x<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">StateIn1</span> <span class="special">&amp;</span> x_old<span class="special">,</span>
 259                   <span class="keyword">const</span> <span class="identifier">DerivIn1</span> <span class="special">&amp;</span> deriv_old<span class="special">,</span> <span class="identifier">time_type</span> t_old<span class="special">,</span>
 260                   <span class="keyword">const</span> <span class="identifier">StateIn2</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">DerivIn2</span> <span class="special">&amp;</span> deriv_new<span class="special">,</span>
 261                   <span class="identifier">time_type</span> t_new<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>This method is used for continuous output and it calculates the state <code class="computeroutput">x</code> at a time <code class="computeroutput">t</code> from the knowledge of two states <code class="computeroutput">old_state</code> and <code class="computeroutput">current_state</code> at time points <code class="computeroutput">t_old</code> and <code class="computeroutput">t_new</code>. It also uses internal variables to calculate the result. Hence this method must be called after two successful <code class="computeroutput">do_step</code> calls. </li>
 262 <li class="listitem">
 263 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> StateIn<span class="special">&gt;</span> <span class="keyword">void</span> <a name="idm45853738595024-bb"></a><span class="identifier">adjust_size</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">StateIn</span> <span class="special">&amp;</span> x<span class="special">)</span><span class="special">;</span></pre>Adjust the size of all temporaries in the stepper manually. <p>
 264 </p>
 265 <div class="variablelist"><table border="0" class="variablelist compact">
 266 <colgroup>
 267 <col align="left" valign="top">
 268 <col>
 269 </colgroup>
 270 <tbody><tr>
 271 <td><p><span class="term">Parameters:</span></p></td>
 272 <td><div class="variablelist"><table border="0" class="variablelist compact">
 273 <colgroup>
 274 <col align="left" valign="top">
 275 <col>
 276 </colgroup>
 277 <tbody><tr>
 278 <td><p><span class="term"><code class="computeroutput">x</code></span></p></td>
 279 <td><p>A state from which the size of the temporaries to be resized is deduced. </p></td>
 280 </tr></tbody>
 281 </table></div></td>
 282 </tr></tbody>
 283 </table></div>
 284 </li>
 285 </ol></div>
 286 </div>
 287 <div class="refsect2">
 288 <a name="idm45221355104384"></a><h3>
 289 <a name="idm45853738587968-bb"></a><code class="computeroutput">runge_kutta_dopri5</code> private member functions</h3>
 290 <div class="orderedlist"><ol class="orderedlist" type="1">
 291 <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> StateIn<span class="special">&gt;</span> <span class="keyword">bool</span> <a name="idm45853738587392-bb"></a><span class="identifier">resize_k_x_tmp_impl</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">StateIn</span> <span class="special">&amp;</span> x<span class="special">)</span><span class="special">;</span></pre></li>
 292 <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> StateIn<span class="special">&gt;</span> <span class="keyword">bool</span> <a name="idm45853738585008-bb"></a><span class="identifier">resize_dxdt_tmp_impl</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">StateIn</span> <span class="special">&amp;</span> x<span class="special">)</span><span class="special">;</span></pre></li>
 293 </ol></div>
 294 </div>
 295 </div>
 296 </div>
 297 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 298 <td align="left"></td>
 299 <td align="right"><div class="copyright-footer">Copyright &#169; 2009-2015 Karsten Ahnert and Mario Mulansky<p>
 300         Distributed under the Boost Software License, Version 1.0. (See accompanying
 301         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>)
 302       </p>
 303 </div></td>
 304 </tr></table>
 305 <hr>
 306 <div class="spirit-nav">
 307 <a accesskey="p" href="../../../header/boost/numeric/odeint/stepper/runge_kutta_dopri5_hpp.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../header/boost/numeric/odeint/stepper/runge_kutta_dopri5_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/stepper/runge_kutta_fehlberg78_hpp.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
 308 </div>
 309 </body>
 310 </html>