192 lines
12 KiB
HTML
192 lines
12 KiB
HTML
|
<!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.9.8"/>
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||
|
|
<title>GridFire: gridfire::trigger::solver::CVODE Namespace 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>
|
||
|
|
<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>
|
||
|
|
<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>
|
||
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||
|
|
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
|
||
|
|
<link href="doxygen-awesome-sidebar-only.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">GridFire<span id="projectnumber"> v0.7.1_rc2</span>
|
||
|
|
</div>
|
||
|
|
<div id="projectbrief">General Purpose Nuclear Network</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<!-- end header part -->
|
||
|
|
<!-- Generated by Doxygen 1.9.8 -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&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&dn=expat.txt MIT */
|
||
|
|
$(function() {
|
||
|
|
initMenu('',true,false,'search.php','Search');
|
||
|
|
$(document).ready(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&dn=expat.txt MIT */
|
||
|
|
$(document).ready(function(){initNavTree('namespacegridfire_1_1trigger_1_1solver_1_1CVODE.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="#nested-classes">Classes</a> |
|
||
|
|
<a href="#func-members">Functions</a> </div>
|
||
|
|
<div class="headertitle"><div class="title">gridfire::trigger::solver::CVODE Namespace Reference</div></div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
<table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
|
||
|
|
Classes</h2></td></tr>
|
||
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger.html">ConvergenceFailureTrigger</a></td></tr>
|
||
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1OffDiagonalTrigger.html">OffDiagonalTrigger</a></td></tr>
|
||
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Triggers when any off-diagonal Jacobian entry magnitude exceeds a threshold. <a href="classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1OffDiagonalTrigger.html#details">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger.html">SimulationTimeTrigger</a></td></tr>
|
||
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Triggers when the current simulation time advances by at least a fixed interval. <a href="classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger.html#details">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger.html">TimestepCollapseTrigger</a></td></tr>
|
||
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Triggers when the timestep deviates from its recent average beyond a threshold. <a href="classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger.html#details">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table><table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
|
||
|
|
Functions</h2></td></tr>
|
||
|
|
<tr class="memitem:aa2e951d13f36bb742fd27b83caa6d4d5" id="r_aa2e951d13f36bb742fd27b83caa6d4d5"><td class="memItemLeft" align="right" valign="top">std::unique_ptr< <a class="el" href="classgridfire_1_1trigger_1_1Trigger.html">Trigger</a>< <a class="el" href="structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext.html">gridfire::solver::CVODESolverStrategy::TimestepContext</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1trigger_1_1solver_1_1CVODE.html#aa2e951d13f36bb742fd27b83caa6d4d5">makeEnginePartitioningTrigger</a> (const double simulationTimeInterval, const double offDiagonalThreshold, const double timestepCollapseRatio, const size_t maxConvergenceFailures)</td></tr>
|
||
|
|
<tr class="memdesc:aa2e951d13f36bb742fd27b83caa6d4d5"><td class="mdescLeft"> </td><td class="mdescRight">Compose a trigger suitable for deciding engine re-partitioning during <a class="el" href="namespacegridfire_1_1trigger_1_1solver_1_1CVODE.html">CVODE</a> solves. <br /></td></tr>
|
||
|
|
<tr class="separator:aa2e951d13f36bb742fd27b83caa6d4d5"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table>
|
||
|
|
<h2 class="groupheader">Function Documentation</h2>
|
||
|
|
<a id="aa2e951d13f36bb742fd27b83caa6d4d5" name="aa2e951d13f36bb742fd27b83caa6d4d5"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa2e951d13f36bb742fd27b83caa6d4d5">◆ </a></span>makeEnginePartitioningTrigger()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">std::unique_ptr< <a class="el" href="classgridfire_1_1trigger_1_1Trigger.html">Trigger</a>< <a class="el" href="structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext.html">gridfire::solver::CVODESolverStrategy::TimestepContext</a> > > gridfire::trigger::solver::CVODE::makeEnginePartitioningTrigger </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const double </td>
|
||
|
|
<td class="paramname"><em>simulationTimeInterval</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">const double </td>
|
||
|
|
<td class="paramname"><em>offDiagonalThreshold</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">const double </td>
|
||
|
|
<td class="paramname"><em>timestepCollapseRatio</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">const size_t </td>
|
||
|
|
<td class="paramname"><em>maxConvergenceFailures</em> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Compose a trigger suitable for deciding engine re-partitioning during <a class="el" href="namespacegridfire_1_1trigger_1_1solver_1_1CVODE.html">CVODE</a> solves. </p>
|
||
|
|
<p>Policy (as of implementation):</p><ul>
|
||
|
|
<li>OR of the following three conditions: 1) Every 1000th firing of SimulationTimeTrigger(simulationTimeInterval) 2) OffDiagonalTrigger(offDiagonalThreshold) 3) Every 10th firing of TimestepCollapseTrigger(timestepGrowthThreshold,
|
||
|
|
timestepGrowthRelative, timestepGrowthWindowSize)</li>
|
||
|
|
</ul>
|
||
|
|
<p>See <a class="el" href="engine__partitioning__trigger_8cpp.html">engine_partitioning_trigger.cpp</a> for construction details using <a class="el" href="classgridfire_1_1trigger_1_1OrTrigger.html" title="Logical disjunction of two triggers with short-circuit evaluation.">OrTrigger</a> and <a class="el" href="classgridfire_1_1trigger_1_1EveryNthTrigger.html" title="Pass-through trigger that fires every Nth time its child trigger is true.">EveryNthTrigger</a> from <a class="el" href="trigger__logical_8h.html" title="Combinators for composing triggers with boolean logic (AND/OR/NOT/EveryNth).">trigger_logical.h</a>.</p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">simulationTimeInterval</td><td>Interval used by <a class="el" href="classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger.html" title="Triggers when the current simulation time advances by at least a fixed interval.">SimulationTimeTrigger</a> (> 0). </td></tr>
|
||
|
|
<tr><td class="paramname">offDiagonalThreshold</td><td>Off-diagonal Jacobian magnitude threshold (>= 0). </td></tr>
|
||
|
|
<tr><td class="paramname">timestepCollapseRatio</td><td>Threshold for timestep deviation (>= 0, and <= 1 when relative). </td></tr>
|
||
|
|
<tr><td class="paramname">maxConvergenceFailures</td><td>Window size for timestep averaging (>= 1 recommended). </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>A unique_ptr to a composed Trigger<TimestepContext> implementing the policy above.</dd></dl>
|
||
|
|
<dl class="section note"><dt>Note</dt><dd>The exact policy is subject to change; this function centralizes that decision. </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</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="namespacegridfire.html">gridfire</a></li><li class="navelem"><a class="el" href="namespacegridfire_1_1trigger.html">trigger</a></li><li class="navelem"><a class="el" href="namespacegridfire_1_1trigger_1_1solver.html">solver</a></li><li class="navelem"><a class="el" href="namespacegridfire_1_1trigger_1_1solver_1_1CVODE.html">CVODE</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.9.8 </li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|