diff options
Diffstat (limited to 'libs/numeric/odeint/doc/html/boost/numeric/odeint/integrate_idp19069360.html')
| -rw-r--r-- | libs/numeric/odeint/doc/html/boost/numeric/odeint/integrate_idp19069360.html | 116 |
1 files changed, 116 insertions, 0 deletions
diff --git a/libs/numeric/odeint/doc/html/boost/numeric/odeint/integrate_idp19069360.html b/libs/numeric/odeint/doc/html/boost/numeric/odeint/integrate_idp19069360.html new file mode 100644 index 000000000..450b50df2 --- /dev/null +++ b/libs/numeric/odeint/doc/html/boost/numeric/odeint/integrate_idp19069360.html @@ -0,0 +1,116 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Function template integrate</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="../../../header/boost/numeric/odeint/integrate/integrate_hpp.html" title="Header <boost/numeric/odeint/integrate/integrate.hpp>"> +<link rel="prev" href="../../../header/boost/numeric/odeint/integrate/integrate_hpp.html" title="Header <boost/numeric/odeint/integrate/integrate.hpp>"> +<link rel="next" href="integrate_idp36962784.html" title="Function template integrate"> +</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="../../../header/boost/numeric/odeint/integrate/integrate_hpp.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../header/boost/numeric/odeint/integrate/integrate_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="integrate_idp36962784.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.numeric.odeint.integrate_idp19069360"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Function template integrate</span></h2> +<p>boost::numeric::odeint::integrate — Integrates the ODE. </p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../../header/boost/numeric/odeint/integrate/integrate_hpp.html" title="Header <boost/numeric/odeint/integrate/integrate.hpp>">boost/numeric/odeint/integrate/integrate.hpp</a>> + +</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> System<span class="special">,</span> <span class="keyword">typename</span> State<span class="special">,</span> <span class="keyword">typename</span> Time<span class="special">,</span> <span class="keyword">typename</span> Observer<span class="special">></span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">enable_if</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">has_value_type</span><span class="special"><</span> <span class="identifier">State</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span><span class="special">,</span> <span class="identifier">size_t</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> + <span class="identifier">integrate</span><span class="special">(</span><span class="identifier">System</span> system<span class="special">,</span> <span class="identifier">State</span> <span class="special">&</span> start_state<span class="special">,</span> <span class="identifier">Time</span> start_time<span class="special">,</span> + <span class="identifier">Time</span> end_time<span class="special">,</span> <span class="identifier">Time</span> dt<span class="special">,</span> <span class="identifier">Observer</span> observer<span class="special">)</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idp105333664"></a><h2>Description</h2> +<p>Integrates the ODE given by system from start_time to end_time starting with start_state as initial condition and dt as initial time step. This function uses a dense output dopri5 stepper and performs an adaptive integration with step size control, thus dt changes during the integration. This method uses standard error bounds of 1E-6. After each step, the observer is called.</p> +<div class="note"><table border="0" summary="Note"> +<tr> +<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../../../doc/src/images/note.png"></td> +<th align="left">Note</th> +</tr> +<tr><td align="left" valign="top"><p>A second version of this function template exists which explicitly expects the value type as template parameter, i.e. integrate< double >( sys , x , t0 , t1 , dt , obs );</p></td></tr> +</table></div> +<p> + + +</p> +<div class="variablelist"><table border="0" class="variablelist compact"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody> +<tr> +<td><p><span class="term">Parameters:</span></p></td> +<td><div class="variablelist"><table border="0" class="variablelist compact"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody> +<tr> +<td><p><span class="term"><code class="computeroutput">dt</code></span></p></td> +<td><p>Initial step size, will be adjusted during the integration. </p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">end_time</code></span></p></td> +<td><p>End time of the integration. </p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">observer</code></span></p></td> +<td><p>Observer that will be called after each time step. </p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">start_state</code></span></p></td> +<td><p>The initial state. </p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">start_time</code></span></p></td> +<td><p>Start time of the integration. </p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">system</code></span></p></td> +<td><p>The system function to solve, hence the r.h.s. of the ordinary differential equation. </p></td> +</tr> +</tbody> +</table></div></td> +</tr> +<tr> +<td><p><span class="term">Returns:</span></p></td> +<td><p>The number of steps performed. </p></td> +</tr> +</tbody> +</table></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-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="../../../header/boost/numeric/odeint/integrate/integrate_hpp.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../header/boost/numeric/odeint/integrate/integrate_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="integrate_idp36962784.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> |