libs/numeric/odeint/doc/html/boost/numeric/odeint/rosenbrock4_controller.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template rosenbrock4_controller</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&#160;1.&#160;Boost.Numeric.Odeint">
   8 <link rel="up" href="../../../header/boost/numeric/odeint/stepper/rosenbrock4_controller_hpp.html" title="Header &lt;boost/numeric/odeint/stepper/rosenbrock4_controller.hpp&gt;">
   9 <link rel="prev" href="../../../header/boost/numeric/odeint/stepper/rosenbrock4_controller_hpp.html" title="Header &lt;boost/numeric/odeint/stepper/rosenbrock4_controller.hpp&gt;">
  10 <link rel="next" href="../../../header/boost/numeric/odeint/stepper/rosenbrock4_dense_output_hpp.html" title="Header &lt;boost/numeric/odeint/stepper/rosenbrock4_dense_output.hpp&gt;">
  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="../../../header/boost/numeric/odeint/stepper/rosenbrock4_controller_hpp.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../header/boost/numeric/odeint/stepper/rosenbrock4_controller_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="../../../header/boost/numeric/odeint/stepper/rosenbrock4_dense_output_hpp.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.numeric.odeint.rosenbrock4_controller"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class template rosenbrock4_controller</span></h2>
  29 <p>boost::numeric::odeint::rosenbrock4_controller</p>
  30 </div>
  31 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  32 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../../header/boost/numeric/odeint/stepper/rosenbrock4_controller_hpp.html" title="Header &lt;boost/numeric/odeint/stepper/rosenbrock4_controller.hpp&gt;">boost/numeric/odeint/stepper/rosenbrock4_controller.hpp</a>&gt;
  33
  34 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Stepper<span class="special">&gt;</span>
  35 <span class="keyword">class</span> <a class="link" href="rosenbrock4_controller.html" title="Class template rosenbrock4_controller">rosenbrock4_controller</a> <span class="special">{</span>
  36 <span class="keyword">public</span><span class="special">:</span>
  37   <span class="comment">// types</span>
  38   <span class="keyword">typedef</span> <span class="identifier">Stepper</span>                           <a name="boost.numeric.odeint.rosenbrock4_controller.stepper_type"></a><span class="identifier">stepper_type</span><span class="special">;</span>
  39   <span class="keyword">typedef</span> <span class="identifier">stepper_type</span><span class="special">::</span><span class="identifier">value_type</span>          <a name="boost.numeric.odeint.rosenbrock4_controller.value_type"></a><span class="identifier">value_type</span><span class="special">;</span>
  40   <span class="keyword">typedef</span> <span class="identifier">stepper_type</span><span class="special">::</span><span class="identifier">state_type</span>          <a name="boost.numeric.odeint.rosenbrock4_controller.state_type"></a><span class="identifier">state_type</span><span class="special">;</span>
  41   <span class="keyword">typedef</span> <span class="identifier">stepper_type</span><span class="special">::</span><span class="identifier">wrapped_state_type</span>  <a name="boost.numeric.odeint.rosenbrock4_controller.wrapped_state_type"></a><span class="identifier">wrapped_state_type</span><span class="special">;</span>
  42   <span class="keyword">typedef</span> <span class="identifier">stepper_type</span><span class="special">::</span><span class="identifier">time_type</span>           <a name="boost.numeric.odeint.rosenbrock4_controller.time_type"></a><span class="identifier">time_type</span><span class="special">;</span>
  43   <span class="keyword">typedef</span> <span class="identifier">stepper_type</span><span class="special">::</span><span class="identifier">deriv_type</span>          <a name="boost.numeric.odeint.rosenbrock4_controller.deriv_type"></a><span class="identifier">deriv_type</span><span class="special">;</span>
  44   <span class="keyword">typedef</span> <span class="identifier">stepper_type</span><span class="special">::</span><span class="identifier">wrapped_deriv_type</span>  <a name="boost.numeric.odeint.rosenbrock4_controller.wrapped_deriv_type"></a><span class="identifier">wrapped_deriv_type</span><span class="special">;</span>
  45   <span class="keyword">typedef</span> <span class="identifier">stepper_type</span><span class="special">::</span><span class="identifier">resizer_type</span>        <a name="boost.numeric.odeint.rosenbrock4_controller.resizer_type"></a><span class="identifier">resizer_type</span><span class="special">;</span>
  46   <span class="keyword">typedef</span> <span class="identifier">controlled_stepper_tag</span>            <a name="boost.numeric.odeint.rosenbrock4_controller.stepper_category"></a><span class="identifier">stepper_category</span><span class="special">;</span>
  47   <span class="keyword">typedef</span> <span class="identifier">rosenbrock4_controller</span><span class="special">&lt;</span> <span class="identifier">Stepper</span> <span class="special">&gt;</span> <a name="boost.numeric.odeint.rosenbrock4_controller.controller_type"></a><span class="identifier">controller_type</span><span class="special">;</span>
  48
  49   <span class="comment">// <a class="link" href="rosenbrock4_controller.html#boost.numeric.odeint.rosenbrock4_controllerconstruct-copy-destruct">construct/copy/destruct</a></span>
  50   <a class="link" href="rosenbrock4_controller.html#idm45853738947328-bb"><span class="identifier">rosenbrock4_controller</span></a><span class="special">(</span><span class="identifier">value_type</span> <span class="special">=</span> <span class="number">1</span><span class="special">.</span><span class="number">0e</span><span class="special">-</span><span class="number">6</span><span class="special">,</span> <span class="identifier">value_type</span> <span class="special">=</span> <span class="number">1</span><span class="special">.</span><span class="number">0e</span><span class="special">-</span><span class="number">6</span><span class="special">,</span>
  51                          <span class="keyword">const</span> <span class="identifier">stepper_type</span> <span class="special">&amp;</span> <span class="special">=</span> <span class="identifier">stepper_type</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span>
  52   <a class="link" href="rosenbrock4_controller.html#idm45853738944112-bb"><span class="identifier">rosenbrock4_controller</span></a><span class="special">(</span><span class="identifier">value_type</span><span class="special">,</span> <span class="identifier">value_type</span><span class="special">,</span> <span class="identifier">time_type</span><span class="special">,</span>
  53                          <span class="keyword">const</span> <span class="identifier">stepper_type</span> <span class="special">&amp;</span> <span class="special">=</span> <span class="identifier">stepper_type</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span>
  54
  55   <span class="comment">// <a class="link" href="rosenbrock4_controller.html#idm45853738968144-bb">public member functions</a></span>
  56   <span class="identifier">value_type</span> <a class="link" href="rosenbrock4_controller.html#idm45853738967584-bb"><span class="identifier">error</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">state_type</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">state_type</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">state_type</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  57   <span class="identifier">value_type</span> <a class="link" href="rosenbrock4_controller.html#idm45853738964672-bb"><span class="identifier">last_error</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  58   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> System<span class="special">&gt;</span>
  59     <span class="identifier">boost</span><span class="special">::</span><span class="identifier">numeric</span><span class="special">::</span><span class="identifier">odeint</span><span class="special">::</span><span class="identifier">controlled_step_result</span>
  60     <a class="link" href="rosenbrock4_controller.html#idm45853738962864-bb"><span class="identifier">try_step</span></a><span class="special">(</span><span class="identifier">System</span><span class="special">,</span> <span class="identifier">state_type</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">time_type</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">time_type</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  61   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> System<span class="special">&gt;</span>
  62     <span class="identifier">boost</span><span class="special">::</span><span class="identifier">numeric</span><span class="special">::</span><span class="identifier">odeint</span><span class="special">::</span><span class="identifier">controlled_step_result</span>
  63     <a class="link" href="rosenbrock4_controller.html#idm45853738958384-bb"><span class="identifier">try_step</span></a><span class="special">(</span><span class="identifier">System</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">state_type</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">time_type</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">state_type</span> <span class="special">&amp;</span><span class="special">,</span>
  64              <span class="identifier">time_type</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  65   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> StateType<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="rosenbrock4_controller.html#idm45853738953216-bb"><span class="identifier">adjust_size</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">StateType</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  66   <span class="identifier">stepper_type</span> <span class="special">&amp;</span> <a class="link" href="rosenbrock4_controller.html#idm45853738950832-bb"><span class="identifier">stepper</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span><span class="special">;</span>
  67   <span class="keyword">const</span> <span class="identifier">stepper_type</span> <span class="special">&amp;</span> <a class="link" href="rosenbrock4_controller.html#idm45853738949296-bb"><span class="identifier">stepper</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  68
  69   <span class="comment">// <a class="link" href="rosenbrock4_controller.html#idm45853738940784-bb">protected member functions</a></span>
  70   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> StateIn<span class="special">&gt;</span> <span class="keyword">bool</span> <a class="link" href="rosenbrock4_controller.html#idm45853738940208-bb"><span class="identifier">resize_m_xerr</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">StateIn</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  71   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> StateIn<span class="special">&gt;</span> <span class="keyword">bool</span> <a class="link" href="rosenbrock4_controller.html#idm45853738937824-bb"><span class="identifier">resize_m_xnew</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">StateIn</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  72 <span class="special">}</span><span class="special">;</span></pre></div>
  73 <div class="refsect1">
  74 <a name="idm45221357199616"></a><h2>Description</h2>
  75 <div class="refsect2">
  76 <a name="idm45221357199200"></a><h3>
  77 <a name="boost.numeric.odeint.rosenbrock4_controllerconstruct-copy-destruct"></a><code class="computeroutput">rosenbrock4_controller</code>
  78         public
  79        construct/copy/destruct</h3>
  80 <div class="orderedlist"><ol class="orderedlist" type="1">
  81 <li class="listitem"><pre class="literallayout"><a name="idm45853738947328-bb"></a><span class="identifier">rosenbrock4_controller</span><span class="special">(</span><span class="identifier">value_type</span> atol <span class="special">=</span> <span class="number">1</span><span class="special">.</span><span class="number">0e</span><span class="special">-</span><span class="number">6</span><span class="special">,</span> <span class="identifier">value_type</span> rtol <span class="special">=</span> <span class="number">1</span><span class="special">.</span><span class="number">0e</span><span class="special">-</span><span class="number">6</span><span class="special">,</span>
  82                        <span class="keyword">const</span> <span class="identifier">stepper_type</span> <span class="special">&amp;</span> stepper <span class="special">=</span> <span class="identifier">stepper_type</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre></li>
  83 <li class="listitem"><pre class="literallayout"><a name="idm45853738944112-bb"></a><span class="identifier">rosenbrock4_controller</span><span class="special">(</span><span class="identifier">value_type</span> atol<span class="special">,</span> <span class="identifier">value_type</span> rtol<span class="special">,</span> <span class="identifier">time_type</span> max_dt<span class="special">,</span>
  84                        <span class="keyword">const</span> <span class="identifier">stepper_type</span> <span class="special">&amp;</span> stepper <span class="special">=</span> <span class="identifier">stepper_type</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre></li>
  85 </ol></div>
  86 </div>
  87 <div class="refsect2">
  88 <a name="idm45221357167312"></a><h3>
  89 <a name="idm45853738968144-bb"></a><code class="computeroutput">rosenbrock4_controller</code> public member functions</h3>
  90 <div class="orderedlist"><ol class="orderedlist" type="1">
  91 <li class="listitem"><pre class="literallayout"><span class="identifier">value_type</span> <a name="idm45853738967584-bb"></a><span class="identifier">error</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">state_type</span> <span class="special">&amp;</span> x<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">state_type</span> <span class="special">&amp;</span> xold<span class="special">,</span>
  92                  <span class="keyword">const</span> <span class="identifier">state_type</span> <span class="special">&amp;</span> xerr<span class="special">)</span><span class="special">;</span></pre></li>
  93 <li class="listitem"><pre class="literallayout"><span class="identifier">value_type</span> <a name="idm45853738964672-bb"></a><span class="identifier">last_error</span><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
  94 <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> System<span class="special">&gt;</span>
  95   <span class="identifier">boost</span><span class="special">::</span><span class="identifier">numeric</span><span class="special">::</span><span class="identifier">odeint</span><span class="special">::</span><span class="identifier">controlled_step_result</span>
  96   <a name="idm45853738962864-bb"></a><span class="identifier">try_step</span><span class="special">(</span><span class="identifier">System</span> sys<span class="special">,</span> <span class="identifier">state_type</span> <span class="special">&amp;</span> x<span class="special">,</span> <span class="identifier">time_type</span> <span class="special">&amp;</span> t<span class="special">,</span> <span class="identifier">time_type</span> <span class="special">&amp;</span> dt<span class="special">)</span><span class="special">;</span></pre></li>
  97 <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> System<span class="special">&gt;</span>
  98   <span class="identifier">boost</span><span class="special">::</span><span class="identifier">numeric</span><span class="special">::</span><span class="identifier">odeint</span><span class="special">::</span><span class="identifier">controlled_step_result</span>
  99   <a name="idm45853738958384-bb"></a><span class="identifier">try_step</span><span class="special">(</span><span class="identifier">System</span> sys<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">state_type</span> <span class="special">&amp;</span> x<span class="special">,</span> <span class="identifier">time_type</span> <span class="special">&amp;</span> t<span class="special">,</span> <span class="identifier">state_type</span> <span class="special">&amp;</span> xout<span class="special">,</span>
 100            <span class="identifier">time_type</span> <span class="special">&amp;</span> dt<span class="special">)</span><span class="special">;</span></pre></li>
 101 <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> StateType<span class="special">&gt;</span> <span class="keyword">void</span> <a name="idm45853738953216-bb"></a><span class="identifier">adjust_size</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">StateType</span> <span class="special">&amp;</span> x<span class="special">)</span><span class="special">;</span></pre></li>
 102 <li class="listitem"><pre class="literallayout"><span class="identifier">stepper_type</span> <span class="special">&amp;</span> <a name="idm45853738950832-bb"></a><span class="identifier">stepper</span><span class="special">(</span><span class="keyword">void</span><span class="special">)</span><span class="special">;</span></pre></li>
 103 <li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <span class="identifier">stepper_type</span> <span class="special">&amp;</span> <a name="idm45853738949296-bb"></a><span class="identifier">stepper</span><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
 104 </ol></div>
 105 </div>
 106 <div class="refsect2">
 107 <a name="idm45221357089664"></a><h3>
 108 <a name="idm45853738940784-bb"></a><code class="computeroutput">rosenbrock4_controller</code> protected member functions</h3>
 109 <div class="orderedlist"><ol class="orderedlist" type="1">
 110 <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> StateIn<span class="special">&gt;</span> <span class="keyword">bool</span> <a name="idm45853738940208-bb"></a><span class="identifier">resize_m_xerr</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">StateIn</span> <span class="special">&amp;</span> x<span class="special">)</span><span class="special">;</span></pre></li>
 111 <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> StateIn<span class="special">&gt;</span> <span class="keyword">bool</span> <a name="idm45853738937824-bb"></a><span class="identifier">resize_m_xnew</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">StateIn</span> <span class="special">&amp;</span> x<span class="special">)</span><span class="special">;</span></pre></li>
 112 </ol></div>
 113 </div>
 114 </div>
 115 </div>
 116 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 117 <td align="left"></td>
 118 <td align="right"><div class="copyright-footer">Copyright &#169; 2009-2015 Karsten Ahnert and Mario Mulansky<p>
 119         Distributed under the Boost Software License, Version 1.0. (See accompanying
 120         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>)
 121       </p>
 122 </div></td>
 123 </tr></table>
 124 <hr>
 125 <div class="spirit-nav">
 126 <a accesskey="p" href="../../../header/boost/numeric/odeint/stepper/rosenbrock4_controller_hpp.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../header/boost/numeric/odeint/stepper/rosenbrock4_controller_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="../../../header/boost/numeric/odeint/stepper/rosenbrock4_dense_output_hpp.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
 127 </div>
 128 </body>
 129 </html>