1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
|
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Stepper</title>
<link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.78.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="implicit_system.html" title="Implicit 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"><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="implicit_system.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="error_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.stepper"></a><a class="link" href="stepper.html" title="Stepper">Stepper</a>
</h3></div></div></div>
<p>
This concepts specifies the interface a simple stepper has to fulfill to
be used within the <a class="link" href="../odeint_in_detail/integrate_functions.html" title="Integrate functions">integrate
functions</a>.
</p>
<h5>
<a name="boost_numeric_odeint.concepts.stepper.h0"></a>
<span class="phrase"><a name="boost_numeric_odeint.concepts.stepper.description"></a></span><a class="link" href="stepper.html#boost_numeric_odeint.concepts.stepper.description">Description</a>
</h5>
<p>
The basic stepper concept. A basic stepper following this Stepper concept
is able to perform a single step of the solution <span class="emphasis"><em>x(t)</em></span>
of an ODE to obtain <span class="emphasis"><em>x(t+dt)</em></span> using a given step size
<span class="emphasis"><em>dt</em></span>. Basic steppers can be Runge-Kutta steppers, symplectic
steppers as well as implicit steppers. Depending on the actual stepper, 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>. Note that all error steppers are also basic steppers.
</p>
<h5>
<a name="boost_numeric_odeint.concepts.stepper.h1"></a>
<span class="phrase"><a name="boost_numeric_odeint.concepts.stepper.refinement_of"></a></span><a class="link" href="stepper.html#boost_numeric_odeint.concepts.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>
</ul></div>
<h5>
<a name="boost_numeric_odeint.concepts.stepper.h2"></a>
<span class="phrase"><a name="boost_numeric_odeint.concepts.stepper.associated_types"></a></span><a class="link" href="stepper.html#boost_numeric_odeint.concepts.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">stepper_tag</span></code>.</p>
</li>
</ul></div>
<h5>
<a name="boost_numeric_odeint.concepts.stepper.h3"></a>
<span class="phrase"><a name="boost_numeric_odeint.concepts.stepper.notation"></a></span><a class="link" href="stepper.html#boost_numeric_odeint.concepts.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">Stepper</span></code></span></dt>
<dd><p>
A type that is a model of 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">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">Stepper</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">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. Depending on the Stepper this might be
a model of <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.stepper.h4"></a>
<span class="phrase"><a name="boost_numeric_odeint.concepts.stepper.valid_expressions"></a></span><a class="link" href="stepper.html#boost_numeric_odeint.concepts.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 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.
</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 in <code class="computeroutput"><span class="identifier">x</span></code>.
</p>
</td>
</tr>
</tbody>
</table></div>
<h5>
<a name="boost_numeric_odeint.concepts.stepper.h5"></a>
<span class="phrase"><a name="boost_numeric_odeint.concepts.stepper.models"></a></span><a class="link" href="stepper.html#boost_numeric_odeint.concepts.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_kutta4</span></code>
</li>
<li class="listitem">
<code class="computeroutput"><span class="identifier">euler</span></code>
</li>
<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">modified_midpoint</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-2012 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="implicit_system.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="error_stepper.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
|
