tboudreaux/GridFire
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(rebuilt-docs): rebuild docs for v0.7.6rc4.0

Browse Source
This commit is contained in:
Emily Boudreaux
2026-04-20 12:45:31 -04:00
parent cf26983fe2
commit 7d611c56ad
2879 changed files with 341584 additions and 181414 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
docs/html/engine__partitioning__trigger_8h.html
View File

@@ -3,16 +3,18 @@
<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="generator" content="Doxygen 1.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GridFire: src/include/gridfire/solver/strategies/triggers/engine_partitioning_trigger.h File 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="resize.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>
@@ -27,7 +29,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">GridFire<span id="projectnumber">&#160;v0.7.1_rc2</span>
<div id="projectname">GridFire<span id="projectnumber">&#160;v0.7.6rc4.0</span>
</div>
<div id="projectbrief">General Purpose Nuclear Network</div>
</td>
@@ -36,19 +38,24 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<!-- Generated by Doxygen 1.13.2 -->
<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">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @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');
$(document).ready(function() { init_search(); });
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
/* @license-end */
</script>
@@ -66,7 +73,7 @@ $(function() {
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('engine__partitioning__trigger_8h.html',''); initResizable(); });
$(function(){initNavTree('engine__partitioning__trigger_8h.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
@@ -104,8 +111,9 @@ $(document).ready(function(){initNavTree('engine__partitioning__trigger_8h.html'
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="trigger__abstract_8h.html">gridfire/trigger/trigger_abstract.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="trigger__result_8h.html">gridfire/trigger/trigger_result.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="CVODE__solver__strategy_8h.html">gridfire/solver/strategies/CVODE_solver_strategy.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="_point_solver_8h.html">gridfire/solver/strategies/PointSolver.h</a>&quot;</code><br />
<code>#include &quot;fourdst/logging/logging.h&quot;</code><br />
<code>#include &quot;<a class="el" href="config_8h.html">gridfire/config/config.h</a>&quot;</code><br />
<code>#include &lt;string&gt;</code><br />
<code>#include &lt;deque&gt;</code><br />
<code>#include &lt;memory&gt;</code><br />
@@ -122,34 +130,36 @@ This graph shows which files directly or indirectly include this file:</div>
</div><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 &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1SimulationTimeTrigger.html">gridfire::trigger::solver::CVODE::SimulationTimeTrigger</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</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="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_simulation_time_trigger.html">gridfire::trigger::solver::CVODE::SimulationTimeTrigger</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</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_1_c_v_o_d_e_1_1_simulation_time_trigger.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1OffDiagonalTrigger.html">gridfire::trigger::solver::CVODE::OffDiagonalTrigger</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</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="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_off_diagonal_trigger.html">gridfire::trigger::solver::CVODE::OffDiagonalTrigger</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Triggers when any off-diagonal Jacobian entry magnitude exceeds a threshold. <a href="classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_off_diagonal_trigger.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1TimestepCollapseTrigger.html">gridfire::trigger::solver::CVODE::TimestepCollapseTrigger</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</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="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_timestep_collapse_trigger.html">gridfire::trigger::solver::CVODE::TimestepCollapseTrigger</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Triggers when the timestep deviates from its recent average beyond a threshold. <a href="classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_timestep_collapse_trigger.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1trigger_1_1solver_1_1CVODE_1_1ConvergenceFailureTrigger.html">gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger</a></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_convergence_failure_trigger.html">gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_boundary_flux_trigger.html">gridfire::trigger::solver::CVODE::BoundaryFluxTrigger</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespacegridfire" id="r_namespacegridfire"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire.html">gridfire</a></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire.html">gridfire</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:namespacegridfire_1_1trigger" id="r_namespacegridfire_1_1trigger"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1trigger.html">gridfire::trigger</a></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1trigger.html">gridfire::trigger</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:namespacegridfire_1_1trigger_1_1solver" id="r_namespacegridfire_1_1trigger_1_1solver"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1trigger_1_1solver.html">gridfire::trigger::solver</a></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1trigger_1_1solver.html">gridfire::trigger::solver</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:namespacegridfire_1_1trigger_1_1solver_1_1CVODE" id="r_namespacegridfire_1_1trigger_1_1solver_1_1CVODE"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1trigger_1_1solver_1_1CVODE.html">gridfire::trigger::solver::CVODE</a></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e.html">gridfire::trigger::solver::CVODE</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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&lt; <a class="el" href="classgridfire_1_1trigger_1_1Trigger.html">Trigger</a>&lt; <a class="el" href="structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext.html">gridfire::solver::CVODESolverStrategy::TimestepContext</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1trigger_1_1solver_1_1CVODE.html#aa2e951d13f36bb742fd27b83caa6d4d5">gridfire::trigger::solver::CVODE::makeEnginePartitioningTrigger</a> (const double simulationTimeInterval, const double offDiagonalThreshold, const double timestepCollapseRatio, const size_t maxConvergenceFailures)</td></tr>
<tr class="memdesc:aa2e951d13f36bb742fd27b83caa6d4d5"><td class="mdescLeft">&#160;</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">&#160;</td></tr>
<tr class="memitem:a0e69d41f7cc0095b9bf7313ec436ab54" id="r_a0e69d41f7cc0095b9bf7313ec436ab54"><td class="memItemLeft" align="right" valign="top">std::unique_ptr&lt; <a class="el" href="classgridfire_1_1trigger_1_1_trigger.html">Trigger</a>&lt; <a class="el" href="structgridfire_1_1solver_1_1_point_solver_timestep_context.html">gridfire::solver::PointSolverTimestepContext</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e.html#a0e69d41f7cc0095b9bf7313ec436ab54">gridfire::trigger::solver::CVODE::makeEnginePartitioningTrigger</a> (const <a class="el" href="structgridfire_1_1config_1_1_trigger_config.html">config::TriggerConfig</a> &amp;cfg)</td></tr>
<tr class="memdesc:a0e69d41f7cc0095b9bf7313ec436ab54"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compose a trigger suitable for deciding engine re-partitioning during <a class="el" href="namespacegridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e.html">CVODE</a> solves. <br /></td></tr>
<tr class="separator:a0e69d41f7cc0095b9bf7313ec436ab54"><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>CVODE-specific triggers that decide when to (re)partition the reaction network engine. </p>
@@ -171,7 +181,7 @@ Functions</h2></td></tr>
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_b0856f6b0d80ccb263b2f415c91f9e17.html">include</a></li><li class="navelem"><a class="el" href="dir_3626e0c0e3c5d7812d6b277dfa4ec364.html">gridfire</a></li><li class="navelem"><a class="el" href="dir_e2a8863ee8e7cd9122c04bdba1c35a3b.html">solver</a></li><li class="navelem"><a class="el" href="dir_230a420a279f78b45ea47b2d650bf1a7.html">strategies</a></li><li class="navelem"><a class="el" href="dir_3c6e26120bd25666a475751afc8a34bc.html">triggers</a></li><li class="navelem"><a class="el" href="engine__partitioning__trigger_8h.html">engine_partitioning_trigger.h</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>
<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.13.2 </li>
</ul>
</div>
</body>