• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>System</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 1. Boost.Numeric.Odeint">
8<link rel="up" href="../concepts.html" title="Concepts">
9<link rel="prev" href="../concepts.html" title="Concepts">
10<link rel="next" href="second_order_system.html" title="Second Order System">
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="../concepts.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="second_order_system.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
24</div>
25<div class="section">
26<div class="titlepage"><div><div><h3 class="title">
27<a name="boost_numeric_odeint.concepts.system"></a><a class="link" href="system.html" title="System">System</a>
28</h3></div></div></div>
29<h5>
30<a name="boost_numeric_odeint.concepts.system.h0"></a>
31        <span class="phrase"><a name="boost_numeric_odeint.concepts.system.description"></a></span><a class="link" href="system.html#boost_numeric_odeint.concepts.system.description">Description</a>
32      </h5>
33<p>
34        The System concept models the algorithmic implementation of the rhs. of the
35        ODE <span class="emphasis"><em>x' = f(x,t)</em></span>. The only requirement for this concept
36        is that it should be callable with a specific parameter syntax (see below).
37        A System is typically implemented as a function or a functor. Systems fulfilling
38        this concept are required by all Runge-Kutta steppers as well as the Bulirsch-Stoer
39        steppers. However, symplectic and implicit steppers work with other system
40        concepts, see <a class="link" href="symplectic_system.html" title="Symplectic System">Symplectic
41        System</a> and <a class="link" href="implicit_system.html" title="Implicit System">Implicit
42        System</a>.
43      </p>
44<h5>
45<a name="boost_numeric_odeint.concepts.system.h1"></a>
46        <span class="phrase"><a name="boost_numeric_odeint.concepts.system.notation"></a></span><a class="link" href="system.html#boost_numeric_odeint.concepts.system.notation">Notation</a>
47      </h5>
48<div class="variablelist">
49<p class="title"><b></b></p>
50<dl class="variablelist">
51<dt><span class="term"><code class="computeroutput"><span class="identifier">System</span></code></span></dt>
52<dd><p>
53              A type that is a model of System
54            </p></dd>
55<dt><span class="term"><code class="computeroutput"><span class="identifier">State</span></code></span></dt>
56<dd><p>
57              A type representing the state <span class="emphasis"><em>x</em></span> of the ODE
58            </p></dd>
59<dt><span class="term"><code class="computeroutput"><span class="identifier">Deriv</span></code></span></dt>
60<dd><p>
61              A type representing the derivative <span class="emphasis"><em>x'</em></span> of the ODE
62            </p></dd>
63<dt><span class="term"><code class="computeroutput"><span class="identifier">Time</span></code></span></dt>
64<dd><p>
65              A type representing the time
66            </p></dd>
67<dt><span class="term"><code class="computeroutput"><span class="identifier">sys</span></code></span></dt>
68<dd><p>
69              An object of type <code class="computeroutput"><span class="identifier">System</span></code>
70            </p></dd>
71<dt><span class="term"><code class="computeroutput"><span class="identifier">x</span></code></span></dt>
72<dd><p>
73              Object of type <code class="computeroutput"><span class="identifier">State</span></code>
74            </p></dd>
75<dt><span class="term"><code class="computeroutput"><span class="identifier">dxdt</span></code></span></dt>
76<dd><p>
77              Object of type <code class="computeroutput"><span class="identifier">Deriv</span></code>
78            </p></dd>
79<dt><span class="term"><code class="computeroutput"><span class="identifier">t</span></code></span></dt>
80<dd><p>
81              Object of type <code class="computeroutput"><span class="identifier">Time</span></code>
82            </p></dd>
83</dl>
84</div>
85<h5>
86<a name="boost_numeric_odeint.concepts.system.h2"></a>
87        <span class="phrase"><a name="boost_numeric_odeint.concepts.system.valid_expressions"></a></span><a class="link" href="system.html#boost_numeric_odeint.concepts.system.valid_expressions">Valid expressions</a>
88      </h5>
89<div class="informaltable"><table class="table">
90<colgroup>
91<col>
92<col>
93<col>
94<col>
95</colgroup>
96<thead><tr>
97<th>
98                <p>
99                  Name
100                </p>
101              </th>
102<th>
103                <p>
104                  Expression
105                </p>
106              </th>
107<th>
108                <p>
109                  Type
110                </p>
111              </th>
112<th>
113                <p>
114                  Semantics
115                </p>
116              </th>
117</tr></thead>
118<tbody><tr>
119<td>
120                <p>
121                  Calculate <span class="emphasis"><em>dx/dt := f(x,t)</em></span>
122                </p>
123              </td>
124<td>
125                <p>
126                  <code class="computeroutput"><span class="identifier">sys</span><span class="special">(</span>
127                  <span class="identifier">x</span> <span class="special">,</span>
128                  <span class="identifier">dxdt</span> <span class="special">,</span>
129                  <span class="identifier">t</span> <span class="special">)</span></code>
130                </p>
131              </td>
132<td>
133                <p>
134                  <code class="computeroutput"><span class="keyword">void</span></code>
135                </p>
136              </td>
137<td>
138                <p>
139                  Calculates f(x,t), the result is stored into dxdt
140                </p>
141              </td>
142</tr></tbody>
143</table></div>
144</div>
145<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
146<td align="left"></td>
147<td align="right"><div class="copyright-footer">Copyright © 2009-2015 Karsten Ahnert and Mario Mulansky<p>
148        Distributed under the Boost Software License, Version 1.0. (See accompanying
149        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>)
150      </p>
151</div></td>
152</tr></table>
153<hr>
154<div class="spirit-nav">
155<a accesskey="p" href="../concepts.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="second_order_system.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
156</div>
157</body>
158</html>
159