mirror of
https://github.com/boostorg/odeint.git
synced 2025-05-11 05:24:01 +00:00
301 lines
13 KiB
HTML
301 lines
13 KiB
HTML
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
|
|
<title>Stepper</title>
|
|
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
|
|
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
|
|
<link rel="home" href="../../index.html" title="Chapter 1. boost.sandbox.numeric.odeint">
|
|
<link rel="up" href="../concepts.html" title="Concepts">
|
|
<link rel="prev" href="concept_system.html" title="Concept system">
|
|
<link rel="next" href="error_stepper.html" title="Error stepper">
|
|
</head>
|
|
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
|
<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
|
|
<hr>
|
|
<div class="spirit-nav">
|
|
<a accesskey="p" href="concept_system.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../concepts.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="error_stepper.html"><img src="../../images/next.png" alt="Next"></a>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h3 class="title">
|
|
<a name="boost_sandbox_numeric_odeint.concepts.stepper"></a><a class="link" href="stepper.html" title="Stepper">Stepper</a>
|
|
</h3></div></div></div>
|
|
<div class="toc"><dl>
|
|
<dt><span class="section"><a href="stepper.html#boost_sandbox_numeric_odeint.concepts.stepper.description">Description</a></span></dt>
|
|
<dt><span class="section"><a href="stepper.html#boost_sandbox_numeric_odeint.concepts.stepper.refinement_of">Refinement
|
|
of</a></span></dt>
|
|
<dt><span class="section"><a href="stepper.html#boost_sandbox_numeric_odeint.concepts.stepper.associated_types">Associated
|
|
types</a></span></dt>
|
|
<dt><span class="section"><a href="stepper.html#boost_sandbox_numeric_odeint.concepts.stepper.notation">Notation</a></span></dt>
|
|
<dt><span class="section"><a href="stepper.html#boost_sandbox_numeric_odeint.concepts.stepper.valid_expressions">Valid
|
|
expressions</a></span></dt>
|
|
<dt><span class="section"><a href="stepper.html#boost_sandbox_numeric_odeint.concepts.stepper.models">Models</a></span></dt>
|
|
</dl></div>
|
|
<p>
|
|
Concept Stepper
|
|
</p>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h4 class="title">
|
|
<a name="boost_sandbox_numeric_odeint.concepts.stepper.description"></a><a class="link" href="stepper.html#boost_sandbox_numeric_odeint.concepts.stepper.description" title="Description">Description</a>
|
|
</h4></div></div></div>
|
|
<p>
|
|
The basic stepper concept.
|
|
</p>
|
|
<p>
|
|
tba.
|
|
</p>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h4 class="title">
|
|
<a name="boost_sandbox_numeric_odeint.concepts.stepper.refinement_of"></a><a class="link" href="stepper.html#boost_sandbox_numeric_odeint.concepts.stepper.refinement_of" title="Refinement of">Refinement
|
|
of</a>
|
|
</h4></div></div></div>
|
|
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
|
|
<li class="listitem">
|
|
DefaultConstructable
|
|
</li>
|
|
<li class="listitem">
|
|
CopyConstructable
|
|
</li>
|
|
</ul></div>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h4 class="title">
|
|
<a name="boost_sandbox_numeric_odeint.concepts.stepper.associated_types"></a><a class="link" href="stepper.html#boost_sandbox_numeric_odeint.concepts.stepper.associated_types" title="Associated types">Associated
|
|
types</a>
|
|
</h4></div></div></div>
|
|
<div class="itemizedlist"><ul class="itemizedlist" 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>
|
|
</ul></div>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h4 class="title">
|
|
<a name="boost_sandbox_numeric_odeint.concepts.stepper.notation"></a><a class="link" href="stepper.html#boost_sandbox_numeric_odeint.concepts.stepper.notation" title="Notation">Notation</a>
|
|
</h4></div></div></div>
|
|
<div class="variablelist">
|
|
<p class="title"><b></b></p>
|
|
<dl>
|
|
<dt><span class="term">Stepper</span></dt>
|
|
<dd><p>
|
|
A type that is a model of Stepper
|
|
</p></dd>
|
|
<dt><span class="term">State</span></dt>
|
|
<dd><p>
|
|
A type that is the <code class="computeroutput"><span class="identifier">state_type</span></code>
|
|
of Stepper
|
|
</p></dd>
|
|
<dt><span class="term">Time</span></dt>
|
|
<dd><p>
|
|
A type that is the <code class="computeroutput"><span class="identifier">time_type</span></code>
|
|
of Stepper
|
|
</p></dd>
|
|
<dt><span class="term">Order</span></dt>
|
|
<dd><p>
|
|
A type that is the <code class="computeroutput"><span class="identifier">order_type</span></code>
|
|
of Stepper
|
|
</p></dd>
|
|
<dt><span class="term">stepper</span></dt>
|
|
<dd><p>
|
|
An object of type Stepper
|
|
</p></dd>
|
|
<dt><span class="term">x,in,out</span></dt>
|
|
<dd><p>
|
|
Objects of type State
|
|
</p></dd>
|
|
<dt><span class="term">t,dt</span></dt>
|
|
<dd><p>
|
|
Objects of type Time
|
|
</p></dd>
|
|
<dt><span class="term">sys</span></dt>
|
|
<dd><p>
|
|
An object defining the ODE. Depends on the context of the stepper
|
|
</p></dd>
|
|
</dl>
|
|
</div>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h4 class="title">
|
|
<a name="boost_sandbox_numeric_odeint.concepts.stepper.valid_expressions"></a><a class="link" href="stepper.html#boost_sandbox_numeric_odeint.concepts.stepper.valid_expressions" title="Valid expressions">Valid
|
|
expressions</a>
|
|
</h4></div></div></div>
|
|
<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 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</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Returns the order of the stepper which is used for error calculation.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
Do step in-place
|
|
</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 in <code class="computeroutput"><span class="identifier">x</span></code>.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
Do step out-of-place
|
|
</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">in</span> <span class="special">,</span>
|
|
<span class="identifier">t</span> <span class="special">,</span>
|
|
<span class="identifier">out</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. The newly obtained state is written to <code class="computeroutput"><span class="identifier">out</span></code>
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h4 class="title">
|
|
<a name="boost_sandbox_numeric_odeint.concepts.stepper.models"></a><a class="link" href="stepper.html#boost_sandbox_numeric_odeint.concepts.stepper.models" title="Models">Models</a>
|
|
</h4></div></div></div>
|
|
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
|
|
<li class="listitem">
|
|
runge_kutta4
|
|
</li>
|
|
<li class="listitem">
|
|
euler
|
|
</li>
|
|
<li class="listitem">
|
|
runge_kutta_cash_karp54
|
|
</li>
|
|
<li class="listitem">
|
|
runge_kutta_dopri5
|
|
</li>
|
|
</ul></div>
|
|
</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 -2011 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="concept_system.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../concepts.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="error_stepper.html"><img src="../../images/next.png" alt="Next"></a>
|
|
</div>
|
|
</body>
|
|
</html>
|