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

102
docs/html/namespacegridfire_1_1solver.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: gridfire::solver 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>
<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('namespacegridfire_1_1solver.html',''); initResizable(); });
$(function(){initNavTree('namespacegridfire_1_1solver.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
@@ -94,6 +101,7 @@ $(document).ready(function(){initNavTree('namespacegridfire_1_1solver.html','');
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#concepts">Concepts</a> &#124;
<a href="#typedef-members">Typedefs</a> </div>
<div class="headertitle"><div class="title">gridfire::solver Namespace Reference</div></div>
</div><!--header-->
@@ -101,36 +109,88 @@ $(document).ready(function(){initNavTree('namespacegridfire_1_1solver.html','');
<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_1solver_1_1CVODESolverStrategy.html">CVODESolverStrategy</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stiff ODE integrator backed by SUNDIALS CVODE (BDF) for network + energy. <a href="classgridfire_1_1solver_1_1CVODESolverStrategy.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_1solver_1_1_grid_solver.html">GridSolver</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_1solver_1_1NetworkSolverStrategy.html">NetworkSolverStrategy</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Abstract base class for network solver strategies. <a href="classgridfire_1_1solver_1_1NetworkSolverStrategy.html#details">More...</a><br /></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1solver_1_1_grid_solver_context.html">GridSolverContext</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1solver_1_1SolverContextBase.html">SolverContextBase</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Base class for solver callback contexts. <a href="classgridfire_1_1solver_1_1SolverContextBase.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_1solver_1_1_multi_zone_network_solver.html">MultiZoneNetworkSolver</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_1solver_1_1_point_solver.html">PointSolver</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stiff ODE integrator backed by SUNDIALS CVODE (BDF) for network + energy. <a href="classgridfire_1_1solver_1_1_point_solver.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">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1solver_1_1_point_solver_context.html">PointSolverContext</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1solver_1_1_point_solver_timestep_context.html">PointSolverTimestepContext</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_1solver_1_1_single_zone_network_solver.html">SingleZoneNetworkSolver</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Abstract base class for network solver strategies. <a href="classgridfire_1_1solver_1_1_single_zone_network_solver.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">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1solver_1_1_solver_context_base.html">SolverContextBase</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1solver_1_1_timestep_context_base.html">TimestepContextBase</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Base class for solver callback contexts. <a href="classgridfire_1_1solver_1_1_timestep_context_base.html#details">More...</a><br /></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="concepts" name="concepts"></a>
Concepts</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">concept &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="conceptgridfire_1_1solver_1_1_is_engine.html">IsEngine</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="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:aa32e3cd33f25e8743556a54b6847cdc0" id="r_aa32e3cd33f25e8743556a54b6847cdc0"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1solver.html#aa32e3cd33f25e8743556a54b6847cdc0">DynamicNetworkSolverStrategy</a> = <a class="el" href="classgridfire_1_1solver_1_1NetworkSolverStrategy.html">NetworkSolverStrategy</a>&lt; <a class="el" href="classgridfire_1_1engine_1_1DynamicEngine.html">engine::DynamicEngine</a> &gt;</td></tr>
<tr class="memdesc:aa32e3cd33f25e8743556a54b6847cdc0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type alias for a network solver strategy that uses a DynamicEngine. <br /></td></tr>
<tr class="separator:aa32e3cd33f25e8743556a54b6847cdc0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a472214bac45251c72c311af1d615e6ea" id="r_a472214bac45251c72c311af1d615e6ea"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a472214bac45251c72c311af1d615e6ea">TimestepCallback</a> = std::function&lt;void(const <a class="el" href="structgridfire_1_1solver_1_1_point_solver_timestep_context.html">PointSolverTimestepContext</a>&amp; context)&gt;</td></tr>
<tr class="memdesc:a472214bac45251c72c311af1d615e6ea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type alias for a timestep callback function. <br /></td></tr>
<tr class="separator:a472214bac45251c72c311af1d615e6ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3ba32e30d3e30cbbca5ffb22dff077ee" id="r_a3ba32e30d3e30cbbca5ffb22dff077ee"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3ba32e30d3e30cbbca5ffb22dff077ee">SingleZoneDynamicNetworkSolver</a> = <a class="el" href="classgridfire_1_1solver_1_1_single_zone_network_solver.html">SingleZoneNetworkSolver</a>&lt;<a class="el" href="classgridfire_1_1engine_1_1_dynamic_engine.html">engine::DynamicEngine</a>&gt;</td></tr>
<tr class="memdesc:a3ba32e30d3e30cbbca5ffb22dff077ee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type alias for a network solver strategy that uses a <a class="el" href="classgridfire_1_1engine_1_1_dynamic_engine.html" title="Abstract class for engines supporting Jacobian and stoichiometry operations.">DynamicEngine</a>. <br /></td></tr>
<tr class="separator:a3ba32e30d3e30cbbca5ffb22dff077ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a521165ce7610e3438607af6500f82fdd" id="r_a521165ce7610e3438607af6500f82fdd"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a521165ce7610e3438607af6500f82fdd">MultiZoneDynamicNetworkSolver</a> = <a class="el" href="classgridfire_1_1solver_1_1_multi_zone_network_solver.html">MultiZoneNetworkSolver</a>&lt;<a class="el" href="classgridfire_1_1engine_1_1_dynamic_engine.html">engine::DynamicEngine</a>&gt;</td></tr>
<tr class="separator:a521165ce7610e3438607af6500f82fdd"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="aa32e3cd33f25e8743556a54b6847cdc0" name="aa32e3cd33f25e8743556a54b6847cdc0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa32e3cd33f25e8743556a54b6847cdc0">&#9670;&#160;</a></span>DynamicNetworkSolverStrategy</h2>
<a id="a521165ce7610e3438607af6500f82fdd" name="a521165ce7610e3438607af6500f82fdd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a521165ce7610e3438607af6500f82fdd">&#9670;&#160;</a></span>MultiZoneDynamicNetworkSolver</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="namespacegridfire_1_1solver.html#aa32e3cd33f25e8743556a54b6847cdc0">gridfire::solver::DynamicNetworkSolverStrategy</a> = typedef <a class="el" href="classgridfire_1_1solver_1_1NetworkSolverStrategy.html">NetworkSolverStrategy</a>&lt;<a class="el" href="classgridfire_1_1engine_1_1DynamicEngine.html">engine::DynamicEngine</a>&gt;</td>
<td class="memname">using <a class="el" href="#a521165ce7610e3438607af6500f82fdd">gridfire::solver::MultiZoneDynamicNetworkSolver</a> = <a class="el" href="classgridfire_1_1solver_1_1_multi_zone_network_solver.html">MultiZoneNetworkSolver</a>&lt;<a class="el" href="classgridfire_1_1engine_1_1_dynamic_engine.html">engine::DynamicEngine</a>&gt;</td>
</tr>
</table>
</div><div class="memdoc">
<p>Type alias for a network solver strategy that uses a DynamicEngine. </p>
</div>
</div>
<a id="a3ba32e30d3e30cbbca5ffb22dff077ee" name="a3ba32e30d3e30cbbca5ffb22dff077ee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3ba32e30d3e30cbbca5ffb22dff077ee">&#9670;&#160;</a></span>SingleZoneDynamicNetworkSolver</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="#a3ba32e30d3e30cbbca5ffb22dff077ee">gridfire::solver::SingleZoneDynamicNetworkSolver</a> = <a class="el" href="classgridfire_1_1solver_1_1_single_zone_network_solver.html">SingleZoneNetworkSolver</a>&lt;<a class="el" href="classgridfire_1_1engine_1_1_dynamic_engine.html">engine::DynamicEngine</a>&gt;</td>
</tr>
</table>
</div><div class="memdoc">
<p>Type alias for a network solver strategy that uses a <a class="el" href="classgridfire_1_1engine_1_1_dynamic_engine.html" title="Abstract class for engines supporting Jacobian and stoichiometry operations.">DynamicEngine</a>. </p>
</div>
</div>
<a id="a472214bac45251c72c311af1d615e6ea" name="a472214bac45251c72c311af1d615e6ea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a472214bac45251c72c311af1d615e6ea">&#9670;&#160;</a></span>TimestepCallback</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="#a472214bac45251c72c311af1d615e6ea">gridfire::solver::TimestepCallback</a> = std::function&lt;void(const <a class="el" href="structgridfire_1_1solver_1_1_point_solver_timestep_context.html">PointSolverTimestepContext</a>&amp; context)&gt;</td>
</tr>
</table>
</div><div class="memdoc">
<p>Type alias for a timestep callback function. </p>
</div>
</div>
@@ -140,7 +200,7 @@ Typedefs</h2></td></tr>
<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_1solver.html">solver</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>