Homec4science
Diffusion GooseFEM (master) Browse

rGOOSEFEM/classGooseFEM_1_1Iterate_1_1StopList.html
4e3b20a7c308master

Last Change
Raw File

classGooseFEM_1_1Iterate_1_1StopList.html
View Options

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GooseFEM: GooseFEM::Iterate::StopList Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
<script type="text/javascript" src="darkmode_toggle.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">GooseFEM<span id="projectnumber">&#160;1.4.1.dev2+g78f16df</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.10.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('classGooseFEM_1_1Iterate_1_1StopList.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classGooseFEM_1_1Iterate_1_1StopList-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">GooseFEM::Iterate::StopList Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Class to perform a residual check based on the last "n" iterations.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="Iterate_8h_source.html">GooseFEM/Iterate.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a5ee3466590f52900ab6646ee87124c1e" id="r_a5ee3466590f52900ab6646ee87124c1e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5ee3466590f52900ab6646ee87124c1e">StopList</a> (<a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">size_t</a> <a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">n</a>=1)</td></tr>
<tr class="memdesc:a5ee3466590f52900ab6646ee87124c1e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
<tr class="separator:a5ee3466590f52900ab6646ee87124c1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acd49d166b7903b3603a9fc48c355846f" id="r_acd49d166b7903b3603a9fc48c355846f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#acd49d166b7903b3603a9fc48c355846f">reset</a> ()</td></tr>
<tr class="memdesc:acd49d166b7903b3603a9fc48c355846f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset all residuals to infinity. <br /></td></tr>
<tr class="separator:acd49d166b7903b3603a9fc48c355846f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8febd6b513ef0bc3b69c796e00026faa" id="r_a8febd6b513ef0bc3b69c796e00026faa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8febd6b513ef0bc3b69c796e00026faa">reset</a> (<a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">size_t</a> <a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">n</a>)</td></tr>
<tr class="memdesc:a8febd6b513ef0bc3b69c796e00026faa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset all residuals to infinity, and change the number of residuals to check. <br /></td></tr>
<tr class="separator:a8febd6b513ef0bc3b69c796e00026faa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a090cc9c9b89ddb40cb8fb3d90d2033cb" id="r_a090cc9c9b89ddb40cb8fb3d90d2033cb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a090cc9c9b89ddb40cb8fb3d90d2033cb">roll_insert</a> (<a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">double</a> <a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">res</a>)</td></tr>
<tr class="memdesc:a090cc9c9b89ddb40cb8fb3d90d2033cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Roll the list with the residuals, and add a new residual to the end. <br /></td></tr>
<tr class="separator:a090cc9c9b89ddb40cb8fb3d90d2033cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4e658fd2cf70531998e9819487d20bf1" id="r_a4e658fd2cf70531998e9819487d20bf1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">bool</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4e658fd2cf70531998e9819487d20bf1">descending</a> () <a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">const</a></td></tr>
<tr class="memdesc:a4e658fd2cf70531998e9819487d20bf1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check of the sequence of <code>n</code> residuals is in descending order. <br /></td></tr>
<tr class="separator:a4e658fd2cf70531998e9819487d20bf1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0ac7ea29823d228b6cadc9a63c45b3cd" id="r_a0ac7ea29823d228b6cadc9a63c45b3cd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">bool</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0ac7ea29823d228b6cadc9a63c45b3cd">all_less</a> (<a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">double</a> <a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">tol</a>) <a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">const</a></td></tr>
<tr class="memdesc:a0ac7ea29823d228b6cadc9a63c45b3cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check of the sequence of <code>n</code> residuals are all below a tolerance. <br /></td></tr>
<tr class="separator:a0ac7ea29823d228b6cadc9a63c45b3cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afe4fa211201ce12dfcae8789a2b7897c" id="r_afe4fa211201ce12dfcae8789a2b7897c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">const</a> std::vector&lt; <a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">double</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#afe4fa211201ce12dfcae8789a2b7897c">data</a> () <a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">const</a></td></tr>
<tr class="memdesc:afe4fa211201ce12dfcae8789a2b7897c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the historic residuals. <br /></td></tr>
<tr class="separator:afe4fa211201ce12dfcae8789a2b7897c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0be4e6312bae831857761a9a7ef611c5" id="r_a0be4e6312bae831857761a9a7ef611c5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">const</a> std::vector&lt; <a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">double</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0be4e6312bae831857761a9a7ef611c5">get</a> () <a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">const</a></td></tr>
<tr class="memdesc:a0be4e6312bae831857761a9a7ef611c5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the historic residuals. <br /></td></tr>
<tr class="separator:a0be4e6312bae831857761a9a7ef611c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Class to perform a residual check based on the last "n" iterations. </p>
<p>A typical usage is in dynamic simulations where equilibrium is checked based on a force residual. Fluctuations could however be responsible for this criterion to be triggered too early. By checking several time-steps such case can be avoided. </p>
<p class="definition">Definition at line <a class="el" href="Iterate_8h_source.html#l00027">27</a> of file <a class="el" href="Iterate_8h_source.html">Iterate.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a5ee3466590f52900ab6646ee87124c1e" name="a5ee3466590f52900ab6646ee87124c1e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5ee3466590f52900ab6646ee87124c1e">&#9670;&#160;</a></span>StopList()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">GooseFEM::Iterate::StopList::StopList </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">size_t</a></td> <td class="paramname"><span class="paramname"><em>n</em><span class="paramdefsep"> = </span><span class="paramdefval">1</span></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">n</td><td>Number of consecutive iterations to consider. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="Iterate_8h_source.html#l00034">34</a> of file <a class="el" href="Iterate_8h_source.html">Iterate.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a0ac7ea29823d228b6cadc9a63c45b3cd" name="a0ac7ea29823d228b6cadc9a63c45b3cd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ac7ea29823d228b6cadc9a63c45b3cd">&#9670;&#160;</a></span>all_less()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">bool</a> GooseFEM::Iterate::StopList::all_less </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">double</a></td> <td class="paramname"><span class="paramname"><em>tol</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check of the sequence of <code>n</code> residuals are all below a tolerance. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">tol</td><td>Tolerance. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if all <code>n</code> residuals are less than the tolerance. </dd></dl>
<p class="definition">Definition at line <a class="el" href="Iterate_8h_source.html#l00091">91</a> of file <a class="el" href="Iterate_8h_source.html">Iterate.h</a>.</p>
</div>
</div>
<a id="afe4fa211201ce12dfcae8789a2b7897c" name="afe4fa211201ce12dfcae8789a2b7897c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afe4fa211201ce12dfcae8789a2b7897c">&#9670;&#160;</a></span>data()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">const</a> std::vector&lt; <a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">double</a> &gt; &amp; GooseFEM::Iterate::StopList::data </td>
<td>(</td>
<td class="paramname"><span class="paramname"></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the historic residuals. </p>
<p class="definition">Definition at line <a class="el" href="Iterate_8h_source.html#l00099">99</a> of file <a class="el" href="Iterate_8h_source.html">Iterate.h</a>.</p>
</div>
</div>
<a id="a4e658fd2cf70531998e9819487d20bf1" name="a4e658fd2cf70531998e9819487d20bf1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4e658fd2cf70531998e9819487d20bf1">&#9670;&#160;</a></span>descending()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">bool</a> GooseFEM::Iterate::StopList::descending </td>
<td>(</td>
<td class="paramname"><span class="paramname"></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check of the sequence of <code>n</code> residuals is in descending order. </p>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if the <code>n</code> residuals are in descending order. </dd></dl>
<p class="definition">Definition at line <a class="el" href="Iterate_8h_source.html#l00080">80</a> of file <a class="el" href="Iterate_8h_source.html">Iterate.h</a>.</p>
</div>
</div>
<a id="a0be4e6312bae831857761a9a7ef611c5" name="a0be4e6312bae831857761a9a7ef611c5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0be4e6312bae831857761a9a7ef611c5">&#9670;&#160;</a></span>get()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">const</a> std::vector&lt; <a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">double</a> &gt; &amp; GooseFEM::Iterate::StopList::get </td>
<td>(</td>
<td class="paramname"><span class="paramname"></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the historic residuals. </p>
<p class="definition">Definition at line <a class="el" href="Iterate_8h_source.html#l00108">108</a> of file <a class="el" href="Iterate_8h_source.html">Iterate.h</a>.</p>
</div>
</div>
<a id="acd49d166b7903b3603a9fc48c355846f" name="acd49d166b7903b3603a9fc48c355846f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acd49d166b7903b3603a9fc48c355846f">&#9670;&#160;</a></span>reset() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">void</a> GooseFEM::Iterate::StopList::reset </td>
<td>(</td>
<td class="paramname"><span class="paramname"></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reset all residuals to infinity. </p>
<p class="definition">Definition at line <a class="el" href="Iterate_8h_source.html#l00043">43</a> of file <a class="el" href="Iterate_8h_source.html">Iterate.h</a>.</p>
</div>
</div>
<a id="a8febd6b513ef0bc3b69c796e00026faa" name="a8febd6b513ef0bc3b69c796e00026faa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8febd6b513ef0bc3b69c796e00026faa">&#9670;&#160;</a></span>reset() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">void</a> GooseFEM::Iterate::StopList::reset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">size_t</a></td> <td class="paramname"><span class="paramname"><em>n</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reset all residuals to infinity, and change the number of residuals to check. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">n</td><td>Number of consecutive iterations to consider. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="Iterate_8h_source.html#l00053">53</a> of file <a class="el" href="Iterate_8h_source.html">Iterate.h</a>.</p>
</div>
</div>
<a id="a090cc9c9b89ddb40cb8fb3d90d2033cb" name="a090cc9c9b89ddb40cb8fb3d90d2033cb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a090cc9c9b89ddb40cb8fb3d90d2033cb">&#9670;&#160;</a></span>roll_insert()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">void</a> GooseFEM::Iterate::StopList::roll_insert </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">double</a></td> <td class="paramname"><span class="paramname"><em>res</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Roll the list with the residuals, and add a new residual to the end. </p>
<p>In Python code this function corresponds to:: </p><pre class="fragment"> residuals = residuals[1:] + [new_residual]
</pre><p> I.e. the residual of <code>n</code> iterations ago will be forgotten.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">res</td><td>New residual to add to the list of residuals. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="Iterate_8h_source.html#l00069">69</a> of file <a class="el" href="Iterate_8h_source.html">Iterate.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>GooseFEM/<a class="el" href="Iterate_8h_source.html">Iterate.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespaceGooseFEM.html">GooseFEM</a></li><li class="navelem"><a class="el" href="namespaceGooseFEM_1_1Iterate.html">Iterate</a></li><li class="navelem"><a class="el" href="classGooseFEM_1_1Iterate_1_1StopList.html">StopList</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0 </li>
</ul>
</div>
</body>
</html>
c4science · Help