1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>Class template implicit_euler</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="../../../header/boost/numeric/odeint/stepper/implicit_euler_hpp.html" title="Header <boost/numeric/odeint/stepper/implicit_euler.hpp>"> 9<link rel="prev" href="../../../header/boost/numeric/odeint/stepper/implicit_euler_hpp.html" title="Header <boost/numeric/odeint/stepper/implicit_euler.hpp>"> 10<link rel="next" href="../../../header/boost/numeric/odeint/stepper/modified_midpoint_hpp.html" title="Header <boost/numeric/odeint/stepper/modified_midpoint.hpp>"> 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/implicit_euler_hpp.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../header/boost/numeric/odeint/stepper/implicit_euler_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/modified_midpoint_hpp.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="refentry"> 26<a name="boost.numeric.odeint.implicit_euler"></a><div class="titlepage"></div> 27<div class="refnamediv"> 28<h2><span class="refentrytitle">Class template implicit_euler</span></h2> 29<p>boost::numeric::odeint::implicit_euler</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: <<a class="link" href="../../../header/boost/numeric/odeint/stepper/implicit_euler_hpp.html" title="Header <boost/numeric/odeint/stepper/implicit_euler.hpp>">boost/numeric/odeint/stepper/implicit_euler.hpp</a>> 33 34</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> ValueType<span class="special">,</span> <span class="keyword">typename</span> Resizer <span class="special">=</span> <span class="identifier">initially_resizer</span><span class="special">></span> 35<span class="keyword">class</span> <a class="link" href="implicit_euler.html" title="Class template implicit_euler">implicit_euler</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">ValueType</span> <a name="boost.numeric.odeint.implicit_euler.value_type"></a><span class="identifier">value_type</span><span class="special">;</span> 39 <span class="keyword">typedef</span> <span class="identifier">value_type</span> <a name="boost.numeric.odeint.implicit_euler.time_type"></a><span class="identifier">time_type</span><span class="special">;</span> 40 <span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">numeric</span><span class="special">::</span><span class="identifier">ublas</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">value_type</span> <span class="special">></span> <a name="boost.numeric.odeint.implicit_euler.state_type"></a><span class="identifier">state_type</span><span class="special">;</span> 41 <span class="keyword">typedef</span> <span class="identifier">state_wrapper</span><span class="special"><</span> <span class="identifier">state_type</span> <span class="special">></span> <a name="boost.numeric.odeint.implicit_euler.wrapped_state_type"></a><span class="identifier">wrapped_state_type</span><span class="special">;</span> 42 <span class="keyword">typedef</span> <span class="identifier">state_type</span> <a name="boost.numeric.odeint.implicit_euler.deriv_type"></a><span class="identifier">deriv_type</span><span class="special">;</span> 43 <span class="keyword">typedef</span> <span class="identifier">state_wrapper</span><span class="special"><</span> <span class="identifier">deriv_type</span> <span class="special">></span> <a name="boost.numeric.odeint.implicit_euler.wrapped_deriv_type"></a><span class="identifier">wrapped_deriv_type</span><span class="special">;</span> 44 <span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">numeric</span><span class="special">::</span><span class="identifier">ublas</span><span class="special">::</span><span class="identifier">matrix</span><span class="special"><</span> <span class="identifier">value_type</span> <span class="special">></span> <a name="boost.numeric.odeint.implicit_euler.matrix_type"></a><span class="identifier">matrix_type</span><span class="special">;</span> 45 <span class="keyword">typedef</span> <span class="identifier">state_wrapper</span><span class="special"><</span> <span class="identifier">matrix_type</span> <span class="special">></span> <a name="boost.numeric.odeint.implicit_euler.wrapped_matrix_type"></a><span class="identifier">wrapped_matrix_type</span><span class="special">;</span> 46 <span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">numeric</span><span class="special">::</span><span class="identifier">ublas</span><span class="special">::</span><span class="identifier">permutation_matrix</span><span class="special"><</span> <span class="identifier">size_t</span> <span class="special">></span> <a name="boost.numeric.odeint.implicit_euler.pmatrix_type"></a><span class="identifier">pmatrix_type</span><span class="special">;</span> 47 <span class="keyword">typedef</span> <span class="identifier">state_wrapper</span><span class="special"><</span> <span class="identifier">pmatrix_type</span> <span class="special">></span> <a name="boost.numeric.odeint.implicit_euler.wrapped_pmatrix_type"></a><span class="identifier">wrapped_pmatrix_type</span><span class="special">;</span> 48 <span class="keyword">typedef</span> <span class="identifier">Resizer</span> <a name="boost.numeric.odeint.implicit_euler.resizer_type"></a><span class="identifier">resizer_type</span><span class="special">;</span> 49 <span class="keyword">typedef</span> <span class="identifier">stepper_tag</span> <a name="boost.numeric.odeint.implicit_euler.stepper_category"></a><span class="identifier">stepper_category</span><span class="special">;</span> 50 <span class="keyword">typedef</span> <span class="identifier">implicit_euler</span><span class="special"><</span> <span class="identifier">ValueType</span><span class="special">,</span> <span class="identifier">Resizer</span> <span class="special">></span> <a name="boost.numeric.odeint.implicit_euler.stepper_type"></a><span class="identifier">stepper_type</span><span class="special">;</span> 51 52 <span class="comment">// <a class="link" href="implicit_euler.html#boost.numeric.odeint.implicit_eulerconstruct-copy-destruct">construct/copy/destruct</a></span> 53 <a class="link" href="implicit_euler.html#idm45875526211568-bb"><span class="identifier">implicit_euler</span></a><span class="special">(</span><span class="identifier">value_type</span> <span class="special">=</span> <span class="number">1E</span><span class="special">-</span><span class="number">6</span><span class="special">)</span><span class="special">;</span> 54 55 <span class="comment">// <a class="link" href="implicit_euler.html#idm45875526219120-bb">public member functions</a></span> 56 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> System<span class="special">></span> 57 <span class="keyword">void</span> <a class="link" href="implicit_euler.html#idm45875526218560-bb"><span class="identifier">do_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">&</span><span class="special">,</span> <span class="identifier">time_type</span><span class="special">,</span> <span class="identifier">time_type</span><span class="special">)</span><span class="special">;</span> 58 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> StateType<span class="special">></span> <span class="keyword">void</span> <a class="link" href="implicit_euler.html#idm45875526214112-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">&</span><span class="special">)</span><span class="special">;</span> 59 60 <span class="comment">// <a class="link" href="implicit_euler.html#idm45875526210304-bb">private member functions</a></span> 61 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> StateIn<span class="special">></span> <span class="keyword">bool</span> <a class="link" href="implicit_euler.html#idm45875526209728-bb"><span class="identifier">resize_impl</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">StateIn</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 62 <span class="keyword">void</span> <a class="link" href="implicit_euler.html#idm45875526207344-bb"><span class="identifier">solve</span></a><span class="special">(</span><span class="identifier">state_type</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">matrix_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 63<span class="special">}</span><span class="special">;</span></pre></div> 64<div class="refsect1"> 65<a name="idm45600372271552"></a><h2>Description</h2> 66<div class="refsect2"> 67<a name="idm45600372271136"></a><h3> 68<a name="boost.numeric.odeint.implicit_eulerconstruct-copy-destruct"></a><code class="computeroutput">implicit_euler</code> 69 public 70 construct/copy/destruct</h3> 71<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idm45875526211568-bb"></a><span class="identifier">implicit_euler</span><span class="special">(</span><span class="identifier">value_type</span> epsilon <span class="special">=</span> <span class="number">1E</span><span class="special">-</span><span class="number">6</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div> 72</div> 73<div class="refsect2"> 74<a name="idm45600372262208"></a><h3> 75<a name="idm45875526219120-bb"></a><code class="computeroutput">implicit_euler</code> public member functions</h3> 76<div class="orderedlist"><ol class="orderedlist" type="1"> 77<li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> System<span class="special">></span> 78 <span class="keyword">void</span> <a name="idm45875526218560-bb"></a><span class="identifier">do_step</span><span class="special">(</span><span class="identifier">System</span> system<span class="special">,</span> <span class="identifier">state_type</span> <span class="special">&</span> x<span class="special">,</span> <span class="identifier">time_type</span> t<span class="special">,</span> <span class="identifier">time_type</span> dt<span class="special">)</span><span class="special">;</span></pre></li> 79<li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> StateType<span class="special">></span> <span class="keyword">void</span> <a name="idm45875526214112-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">&</span> x<span class="special">)</span><span class="special">;</span></pre></li> 80</ol></div> 81</div> 82<div class="refsect2"> 83<a name="idm45600372238848"></a><h3> 84<a name="idm45875526210304-bb"></a><code class="computeroutput">implicit_euler</code> private member functions</h3> 85<div class="orderedlist"><ol class="orderedlist" type="1"> 86<li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> StateIn<span class="special">></span> <span class="keyword">bool</span> <a name="idm45875526209728-bb"></a><span class="identifier">resize_impl</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">StateIn</span> <span class="special">&</span> x<span class="special">)</span><span class="special">;</span></pre></li> 87<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm45875526207344-bb"></a><span class="identifier">solve</span><span class="special">(</span><span class="identifier">state_type</span> <span class="special">&</span> x<span class="special">,</span> <span class="identifier">matrix_type</span> <span class="special">&</span> m<span class="special">)</span><span class="special">;</span></pre></li> 88</ol></div> 89</div> 90</div> 91</div> 92<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 93<td align="left"></td> 94<td align="right"><div class="copyright-footer">Copyright © 2009-2015 Karsten Ahnert and Mario Mulansky<p> 95 Distributed under the Boost Software License, Version 1.0. (See accompanying 96 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>) 97 </p> 98</div></td> 99</tr></table> 100<hr> 101<div class="spirit-nav"> 102<a accesskey="p" href="../../../header/boost/numeric/odeint/stepper/implicit_euler_hpp.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../header/boost/numeric/odeint/stepper/implicit_euler_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/modified_midpoint_hpp.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> 103</div> 104</body> 105</html> 106
