123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369 |
- <html>
- <head>
- <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
- <title>Error Stepper</title>
- <link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css">
- <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
- <link rel="home" href="../../index.html" title="Chapter 1. Boost.Numeric.Odeint">
- <link rel="up" href="../concepts.html" title="Concepts">
- <link rel="prev" href="stepper.html" title="Stepper">
- <link rel="next" href="controlled_stepper.html" title="Controlled Stepper">
- </head>
- <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
- <table cellpadding="2" width="100%"><tr>
- <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../logo.jpg"></td>
- <td align="center"><a href="../../../../../../../index.html">Home</a></td>
- <td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td>
- <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
- <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
- <td align="center"><a href="../../../../../../../more/index.htm">More</a></td>
- </tr></table>
- <hr>
- <div class="spirit-nav">
- <a accesskey="p" href="stepper.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../concepts.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="controlled_stepper.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
- </div>
- <div class="section">
- <div class="titlepage"><div><div><h3 class="title">
- <a name="boost_numeric_odeint.concepts.error_stepper"></a><a class="link" href="error_stepper.html" title="Error Stepper">Error Stepper</a>
- </h3></div></div></div>
- <p>
- This concepts specifies the interface an error stepper has to fulfill to
- be used within a ControlledErrorStepper. An error stepper must always fulfill
- the stepper concept. This can trivially implemented by
- </p>
- <p>
- </p>
- <pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">System</span> <span class="special">></span>
- <span class="identifier">error_stepper</span><span class="special">::</span><span class="identifier">do_step</span><span class="special">(</span> <span class="identifier">System</span> <span class="identifier">sys</span> <span class="special">,</span> <span class="identifier">state_type</span> <span class="special">&</span><span class="identifier">x</span> <span class="special">,</span> <span class="identifier">time_type</span> <span class="identifier">t</span> <span class="special">,</span> <span class="identifier">time_type</span> <span class="identifier">dt</span> <span class="special">)</span>
- <span class="special">{</span>
- <span class="identifier">state_type</span> <span class="identifier">xerr</span><span class="special">;</span>
- <span class="comment">// allocate xerr</span>
- <span class="identifier">do_step</span><span class="special">(</span> <span class="identifier">sys</span> <span class="special">,</span> <span class="identifier">x</span> <span class="special">,</span> <span class="identifier">t</span> <span class="special">,</span> <span class="identifier">dt</span> <span class="special">,</span> <span class="identifier">xerr</span> <span class="special">);</span>
- <span class="special">}</span>
- </pre>
- <p>
- </p>
- <h5>
- <a name="boost_numeric_odeint.concepts.error_stepper.h0"></a>
- <span class="phrase"><a name="boost_numeric_odeint.concepts.error_stepper.description"></a></span><a class="link" href="error_stepper.html#boost_numeric_odeint.concepts.error_stepper.description">Description</a>
- </h5>
- <p>
- An error stepper following this Error Stepper concept is capable of doing
- one step of the solution <span class="emphasis"><em>x(t)</em></span> of an ODE with step-size
- <span class="emphasis"><em>dt</em></span> to obtain <span class="emphasis"><em>x(t+dt)</em></span> and also computing
- an error estimate <span class="emphasis"><em>x<sub>err</sub></em></span> of the result. Error Steppers
- can be Runge-Kutta steppers, symplectic steppers as well as implicit steppers.
- Based on the stepper type, the ODE is defined as <a class="link" href="system.html" title="System">System</a>,
- <a class="link" href="symplectic_system.html" title="Symplectic System">Symplectic
- System</a>, <a class="link" href="simple_symplectic_system.html" title="Simple Symplectic System">Simple
- Symplectic System</a> or <a class="link" href="implicit_system.html" title="Implicit System">Implicit
- System</a>.
- </p>
- <h5>
- <a name="boost_numeric_odeint.concepts.error_stepper.h1"></a>
- <span class="phrase"><a name="boost_numeric_odeint.concepts.error_stepper.refinement_of"></a></span><a class="link" href="error_stepper.html#boost_numeric_odeint.concepts.error_stepper.refinement_of">Refinement
- of</a>
- </h5>
- <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
- <li class="listitem">
- DefaultConstructable
- </li>
- <li class="listitem">
- CopyConstructable
- </li>
- <li class="listitem">
- Stepper
- </li>
- </ul></div>
- <h5>
- <a name="boost_numeric_odeint.concepts.error_stepper.h2"></a>
- <span class="phrase"><a name="boost_numeric_odeint.concepts.error_stepper.associated_types"></a></span><a class="link" href="error_stepper.html#boost_numeric_odeint.concepts.error_stepper.associated_types">Associated
- types</a>
- </h5>
- <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
- <li class="listitem">
- <p><span class="bold"><strong>state_type</strong></span></p>
- <p><code class="computeroutput"><span class="identifier">Stepper</span><span class="special">::</span><span class="identifier">state_type</span></code></p>
- <p>The
- type characterizing the state of the ODE, hence <span class="emphasis"><em>x</em></span>.</p>
- </li>
- <li class="listitem">
- <p><span class="bold"><strong>deriv_type</strong></span></p>
- <p><code class="computeroutput"><span class="identifier">Stepper</span><span class="special">::</span><span class="identifier">deriv_type</span></code></p>
- <p>The
- type characterizing the derivative of the ODE, hence <span class="emphasis"><em>d x/dt</em></span>.</p>
- </li>
- <li class="listitem">
- <p><span class="bold"><strong>time_type</strong></span></p>
- <p><code class="computeroutput"><span class="identifier">Stepper</span><span class="special">::</span><span class="identifier">time_type</span></code></p>
- <p>The
- type characterizing the dependent variable of the ODE, hence the time
- <span class="emphasis"><em>t</em></span>.</p>
- </li>
- <li class="listitem">
- <p><span class="bold"><strong>value_type</strong></span></p>
- <p><code class="computeroutput"><span class="identifier">Stepper</span><span class="special">::</span><span class="identifier">value_type</span></code></p>
- <p>The
- numerical data type which is used within the stepper, something like
- <code class="computeroutput"><span class="keyword">float</span></code>, <code class="computeroutput"><span class="keyword">double</span></code>,
- <code class="computeroutput"><span class="identifier">complex</span><span class="special">&</span><span class="identifier">lt</span><span class="special">;</span> <span class="keyword">double</span> <span class="special">&</span><span class="identifier">gt</span><span class="special">;</span></code>.</p>
- </li>
- <li class="listitem">
- <p><span class="bold"><strong>order_type</strong></span></p>
- <p><code class="computeroutput"><span class="identifier">Stepper</span><span class="special">::</span><span class="identifier">order_type</span></code></p>
- <p>The
- type characterizing the order of the ODE, typically <code class="computeroutput"><span class="keyword">unsigned</span>
- <span class="keyword">short</span></code>.</p>
- </li>
- <li class="listitem">
- <p><span class="bold"><strong>stepper_category</strong></span></p>
- <p><code class="computeroutput"><span class="identifier">Stepper</span><span class="special">::</span><span class="identifier">stepper_category</span></code></p>
- <p>A
- tag type characterizing the category of the stepper. This type must be
- convertible to <code class="computeroutput"><span class="identifier">error_stepper_tag</span></code>.</p>
- </li>
- </ul></div>
- <h5>
- <a name="boost_numeric_odeint.concepts.error_stepper.h3"></a>
- <span class="phrase"><a name="boost_numeric_odeint.concepts.error_stepper.notation"></a></span><a class="link" href="error_stepper.html#boost_numeric_odeint.concepts.error_stepper.notation">Notation</a>
- </h5>
- <div class="variablelist">
- <p class="title"><b></b></p>
- <dl class="variablelist">
- <dt><span class="term"><code class="computeroutput"><span class="identifier">ErrorStepper</span></code></span></dt>
- <dd><p>
- A type that is a model of Error Stepper
- </p></dd>
- <dt><span class="term"><code class="computeroutput"><span class="identifier">State</span></code></span></dt>
- <dd><p>
- A type representing the state <span class="emphasis"><em>x</em></span> of the ODE
- </p></dd>
- <dt><span class="term"><code class="computeroutput"><span class="identifier">Error</span></code></span></dt>
- <dd><p>
- A type representing the error calculated by the stepper, usually same
- as <code class="computeroutput"><span class="identifier">State</span></code>
- </p></dd>
- <dt><span class="term"><code class="computeroutput"><span class="identifier">Time</span></code></span></dt>
- <dd><p>
- A type representing the time <span class="emphasis"><em>t</em></span> of the ODE
- </p></dd>
- <dt><span class="term"><code class="computeroutput"><span class="identifier">stepper</span></code></span></dt>
- <dd><p>
- An object of type <code class="computeroutput"><span class="identifier">ErrorStepper</span></code>
- </p></dd>
- <dt><span class="term"><code class="computeroutput"><span class="identifier">x</span></code></span></dt>
- <dd><p>
- Object of type <code class="computeroutput"><span class="identifier">State</span></code>
- </p></dd>
- <dt><span class="term"><code class="computeroutput"><span class="identifier">xerr</span></code></span></dt>
- <dd><p>
- Object of type <code class="computeroutput"><span class="identifier">Error</span></code>
- </p></dd>
- <dt><span class="term"><code class="computeroutput"><span class="identifier">t</span></code>, <code class="computeroutput"><span class="identifier">dt</span></code></span></dt>
- <dd><p>
- Objects of type <code class="computeroutput"><span class="identifier">Time</span></code>
- </p></dd>
- <dt><span class="term"><code class="computeroutput"><span class="identifier">sys</span></code></span></dt>
- <dd><p>
- An object defining the ODE, should be a model of either <a class="link" href="system.html" title="System">System</a>,
- <a class="link" href="symplectic_system.html" title="Symplectic System">Symplectic
- System</a>, <a class="link" href="simple_symplectic_system.html" title="Simple Symplectic System">Simple
- Symplectic System</a> or <a class="link" href="implicit_system.html" title="Implicit System">Implicit
- System</a>.
- </p></dd>
- </dl>
- </div>
- <h5>
- <a name="boost_numeric_odeint.concepts.error_stepper.h4"></a>
- <span class="phrase"><a name="boost_numeric_odeint.concepts.error_stepper.valid_expressions"></a></span><a class="link" href="error_stepper.html#boost_numeric_odeint.concepts.error_stepper.valid_expressions">Valid
- Expressions</a>
- </h5>
- <div class="informaltable"><table class="table">
- <colgroup>
- <col>
- <col>
- <col>
- <col>
- </colgroup>
- <thead><tr>
- <th>
- <p>
- Name
- </p>
- </th>
- <th>
- <p>
- Expression
- </p>
- </th>
- <th>
- <p>
- Type
- </p>
- </th>
- <th>
- <p>
- Semantics
- </p>
- </th>
- </tr></thead>
- <tbody>
- <tr>
- <td>
- <p>
- Get the stepper order
- </p>
- </td>
- <td>
- <p>
- <code class="computeroutput"><span class="identifier">stepper</span><span class="special">.</span><span class="identifier">order</span><span class="special">()</span></code>
- </p>
- </td>
- <td>
- <p>
- <code class="computeroutput"><span class="identifier">order_type</span></code>
- </p>
- </td>
- <td>
- <p>
- Returns the order of the stepper for one step without error estimation.
- </p>
- </td>
- </tr>
- <tr>
- <td>
- <p>
- Get the stepper order
- </p>
- </td>
- <td>
- <p>
- <code class="computeroutput"><span class="identifier">stepper</span><span class="special">.</span><span class="identifier">stepper_order</span><span class="special">()</span></code>
- </p>
- </td>
- <td>
- <p>
- <code class="computeroutput"><span class="identifier">order_type</span></code>
- </p>
- </td>
- <td>
- <p>
- Returns the order of the stepper for one error estimation step
- which is used for error calculation.
- </p>
- </td>
- </tr>
- <tr>
- <td>
- <p>
- Get the error order
- </p>
- </td>
- <td>
- <p>
- <code class="computeroutput"><span class="identifier">stepper</span><span class="special">.</span><span class="identifier">errorr_order</span><span class="special">()</span></code>
- </p>
- </td>
- <td>
- <p>
- <code class="computeroutput"><span class="identifier">order_type</span></code>
- </p>
- </td>
- <td>
- <p>
- Returns the order of the error step which is used for error calculation.
- </p>
- </td>
- </tr>
- <tr>
- <td>
- <p>
- Do step
- </p>
- </td>
- <td>
- <p>
- <code class="computeroutput"><span class="identifier">stepper</span><span class="special">.</span><span class="identifier">do_step</span><span class="special">(</span>
- <span class="identifier">sys</span> <span class="special">,</span>
- <span class="identifier">x</span> <span class="special">,</span>
- <span class="identifier">t</span> <span class="special">,</span>
- <span class="identifier">dt</span> <span class="special">)</span></code>
- </p>
- </td>
- <td>
- <p>
- <code class="computeroutput"><span class="keyword">void</span></code>
- </p>
- </td>
- <td>
- <p>
- Performs one step of step size <code class="computeroutput"><span class="identifier">dt</span></code>.
- The newly obtained state is written in-place to <code class="computeroutput"><span class="identifier">x</span></code>.
- </p>
- </td>
- </tr>
- <tr>
- <td>
- <p>
- Do step with error estimation
- </p>
- </td>
- <td>
- <p>
- <code class="computeroutput"><span class="identifier">stepper</span><span class="special">.</span><span class="identifier">do_step</span><span class="special">(</span>
- <span class="identifier">sys</span> <span class="special">,</span>
- <span class="identifier">x</span> <span class="special">,</span>
- <span class="identifier">t</span> <span class="special">,</span>
- <span class="identifier">dt</span> <span class="special">,</span>
- <span class="identifier">xerr</span> <span class="special">)</span></code>
- </p>
- </td>
- <td>
- <p>
- <code class="computeroutput"><span class="keyword">void</span></code>
- </p>
- </td>
- <td>
- <p>
- Performs one step of step size <code class="computeroutput"><span class="identifier">dt</span></code>
- with error estimation. The newly obtained state is written in-place
- to <code class="computeroutput"><span class="identifier">x</span></code> and the estimated
- error to <code class="computeroutput"><span class="identifier">xerr</span></code>.
- </p>
- </td>
- </tr>
- </tbody>
- </table></div>
- <h5>
- <a name="boost_numeric_odeint.concepts.error_stepper.h5"></a>
- <span class="phrase"><a name="boost_numeric_odeint.concepts.error_stepper.models"></a></span><a class="link" href="error_stepper.html#boost_numeric_odeint.concepts.error_stepper.models">Models</a>
- </h5>
- <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
- <li class="listitem">
- <code class="computeroutput"><span class="identifier">runge_kutta_cash_karp54</span></code>
- </li>
- <li class="listitem">
- <code class="computeroutput"><span class="identifier">runge_kutta_dopri5</span></code>
- </li>
- <li class="listitem">
- <code class="computeroutput"><span class="identifier">runge_kutta_fehlberg78</span></code>
- </li>
- <li class="listitem">
- <code class="computeroutput"><span class="identifier">rosenbrock4</span></code>
- </li>
- </ul></div>
- </div>
- <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
- <td align="left"></td>
- <td align="right"><div class="copyright-footer">Copyright © 2009-2015 Karsten Ahnert and Mario Mulansky<p>
- Distributed under the Boost Software License, Version 1.0. (See accompanying
- 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>)
- </p>
- </div></td>
- </tr></table>
- <hr>
- <div class="spirit-nav">
- <a accesskey="p" href="stepper.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../concepts.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="controlled_stepper.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
- </div>
- </body>
- </html>
|