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

246
docs/html/classgridfire_1_1solver_1_1_grid_solver.html Normal file
View File

@@ -0,0 +1,246 @@
<!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.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GridFire: gridfire::solver::GridSolver 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="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>
<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">&#160;v0.7.6rc4.0</span>
</div>
<div id="projectbrief">General Purpose Nuclear Network</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- 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',true);
$(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('classgridfire_1_1solver_1_1_grid_solver.html',''); initResizable(true); });
/* @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="classgridfire_1_1solver_1_1_grid_solver-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">gridfire::solver::GridSolver Class Reference<span class="mlabels"><span class="mlabel final">final</span></span></div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;GridSolver.h&gt;</code></p>
<div class="dynheader">
Inheritance diagram for gridfire::solver::GridSolver:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classgridfire_1_1solver_1_1_grid_solver__inherit__graph.svg" width="227" height="111"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for gridfire::solver::GridSolver:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classgridfire_1_1solver_1_1_grid_solver__coll__graph.svg" width="227" height="111"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<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:ad678bd60b23cd2b88c36bcd6898ccc3f" id="r_ad678bd60b23cd2b88c36bcd6898ccc3f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad678bd60b23cd2b88c36bcd6898ccc3f">GridSolver</a> (const <a class="el" href="classgridfire_1_1engine_1_1_dynamic_engine.html">engine::DynamicEngine</a> &amp;engine, const <a class="el" href="namespacegridfire_1_1solver.html#a3ba32e30d3e30cbbca5ffb22dff077ee">SingleZoneDynamicNetworkSolver</a> &amp;solver)</td></tr>
<tr class="separator:ad678bd60b23cd2b88c36bcd6898ccc3f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a735386e65c8904137eb3af27bfe0ac1d" id="r_a735386e65c8904137eb3af27bfe0ac1d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a735386e65c8904137eb3af27bfe0ac1d">~GridSolver</a> () override=default</td></tr>
<tr class="separator:a735386e65c8904137eb3af27bfe0ac1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aba2dba489f9fa8e644606fbf2b913fca" id="r_aba2dba489f9fa8e644606fbf2b913fca"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="structgridfire_1_1_net_out.html">NetOut</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aba2dba489f9fa8e644606fbf2b913fca">evaluate</a> (<a class="el" href="structgridfire_1_1solver_1_1_solver_context_base.html">SolverContextBase</a> &amp;ctx, const std::vector&lt; <a class="el" href="structgridfire_1_1_net_in.html">NetIn</a> &gt; &amp;netIns) const override</td></tr>
<tr class="separator:aba2dba489f9fa8e644606fbf2b913fca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classgridfire_1_1solver_1_1_multi_zone_network_solver"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_classgridfire_1_1solver_1_1_multi_zone_network_solver')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgridfire_1_1solver_1_1_multi_zone_network_solver.html">gridfire::solver::MultiZoneNetworkSolver&lt; engine::DynamicEngine &gt;</a></td></tr>
<tr class="memitem:add7bc564ea0cf2490d856f7e47b4813d inherit pub_methods_classgridfire_1_1solver_1_1_multi_zone_network_solver" id="r_add7bc564ea0cf2490d856f7e47b4813d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1solver_1_1_multi_zone_network_solver.html#add7bc564ea0cf2490d856f7e47b4813d">MultiZoneNetworkSolver</a> (const EngineT &amp;engine, const <a class="el" href="classgridfire_1_1solver_1_1_single_zone_network_solver.html">SingleZoneNetworkSolver</a>&lt; EngineT &gt; &amp;solver)</td></tr>
<tr class="separator:add7bc564ea0cf2490d856f7e47b4813d inherit pub_methods_classgridfire_1_1solver_1_1_multi_zone_network_solver"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e5b61c8a13ab247ab88f2b361fa65ff inherit pub_methods_classgridfire_1_1solver_1_1_multi_zone_network_solver" id="r_a8e5b61c8a13ab247ab88f2b361fa65ff"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1solver_1_1_multi_zone_network_solver.html#a8e5b61c8a13ab247ab88f2b361fa65ff">~MultiZoneNetworkSolver</a> ()=default</td></tr>
<tr class="separator:a8e5b61c8a13ab247ab88f2b361fa65ff inherit pub_methods_classgridfire_1_1solver_1_1_multi_zone_network_solver"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:add7bc564ea0cf2490d856f7e47b4813d inherit pub_methods_classgridfire_1_1solver_1_1_multi_zone_network_solver" id="r_add7bc564ea0cf2490d856f7e47b4813d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1solver_1_1_multi_zone_network_solver.html#add7bc564ea0cf2490d856f7e47b4813d">MultiZoneNetworkSolver</a> (const EngineT &amp;engine, const <a class="el" href="classgridfire_1_1solver_1_1_single_zone_network_solver.html">SingleZoneNetworkSolver</a>&lt; EngineT &gt; &amp;solver)</td></tr>
<tr class="separator:add7bc564ea0cf2490d856f7e47b4813d inherit pub_methods_classgridfire_1_1solver_1_1_multi_zone_network_solver"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e5b61c8a13ab247ab88f2b361fa65ff inherit pub_methods_classgridfire_1_1solver_1_1_multi_zone_network_solver" id="r_a8e5b61c8a13ab247ab88f2b361fa65ff"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1solver_1_1_multi_zone_network_solver.html#a8e5b61c8a13ab247ab88f2b361fa65ff">~MultiZoneNetworkSolver</a> ()=default</td></tr>
<tr class="separator:a8e5b61c8a13ab247ab88f2b361fa65ff inherit pub_methods_classgridfire_1_1solver_1_1_multi_zone_network_solver"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_attribs_classgridfire_1_1solver_1_1_multi_zone_network_solver"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pro_attribs_classgridfire_1_1solver_1_1_multi_zone_network_solver')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classgridfire_1_1solver_1_1_multi_zone_network_solver.html">gridfire::solver::MultiZoneNetworkSolver&lt; engine::DynamicEngine &gt;</a></td></tr>
<tr class="memitem:a72ca011952a904c0becb0067c369b906 inherit pro_attribs_classgridfire_1_1solver_1_1_multi_zone_network_solver" id="r_a72ca011952a904c0becb0067c369b906"><td class="memItemLeft" align="right" valign="top">const EngineT &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1solver_1_1_multi_zone_network_solver.html#a72ca011952a904c0becb0067c369b906">m_engine</a></td></tr>
<tr class="memdesc:a72ca011952a904c0becb0067c369b906 inherit pro_attribs_classgridfire_1_1solver_1_1_multi_zone_network_solver"><td class="mdescLeft">&#160;</td><td class="mdescRight">The engine used by this solver strategy. <br /></td></tr>
<tr class="separator:a72ca011952a904c0becb0067c369b906 inherit pro_attribs_classgridfire_1_1solver_1_1_multi_zone_network_solver"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0c1c9d301507063b2d2b316c0696b188 inherit pro_attribs_classgridfire_1_1solver_1_1_multi_zone_network_solver" id="r_a0c1c9d301507063b2d2b316c0696b188"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classgridfire_1_1solver_1_1_single_zone_network_solver.html">SingleZoneNetworkSolver</a>&lt; EngineT &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1solver_1_1_multi_zone_network_solver.html#a0c1c9d301507063b2d2b316c0696b188">m_solver</a></td></tr>
<tr class="separator:a0c1c9d301507063b2d2b316c0696b188 inherit pro_attribs_classgridfire_1_1solver_1_1_multi_zone_network_solver"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a72ca011952a904c0becb0067c369b906 inherit pro_attribs_classgridfire_1_1solver_1_1_multi_zone_network_solver" id="r_a72ca011952a904c0becb0067c369b906"><td class="memItemLeft" align="right" valign="top">const EngineT &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1solver_1_1_multi_zone_network_solver.html#a72ca011952a904c0becb0067c369b906">m_engine</a></td></tr>
<tr class="memdesc:a72ca011952a904c0becb0067c369b906 inherit pro_attribs_classgridfire_1_1solver_1_1_multi_zone_network_solver"><td class="mdescLeft">&#160;</td><td class="mdescRight">The engine used by this solver strategy. <br /></td></tr>
<tr class="separator:a72ca011952a904c0becb0067c369b906 inherit pro_attribs_classgridfire_1_1solver_1_1_multi_zone_network_solver"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0c1c9d301507063b2d2b316c0696b188 inherit pro_attribs_classgridfire_1_1solver_1_1_multi_zone_network_solver" id="r_a0c1c9d301507063b2d2b316c0696b188"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classgridfire_1_1solver_1_1_single_zone_network_solver.html">SingleZoneNetworkSolver</a>&lt; EngineT &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1solver_1_1_multi_zone_network_solver.html#a0c1c9d301507063b2d2b316c0696b188">m_solver</a></td></tr>
<tr class="separator:a0c1c9d301507063b2d2b316c0696b188 inherit pro_attribs_classgridfire_1_1solver_1_1_multi_zone_network_solver"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ad678bd60b23cd2b88c36bcd6898ccc3f" name="ad678bd60b23cd2b88c36bcd6898ccc3f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad678bd60b23cd2b88c36bcd6898ccc3f">&#9670;&#160;</a></span>GridSolver()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gridfire::solver::GridSolver::GridSolver </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgridfire_1_1engine_1_1_dynamic_engine.html">engine::DynamicEngine</a> &amp;</td> <td class="paramname"><span class="paramname"><em>engine</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="namespacegridfire_1_1solver.html#a3ba32e30d3e30cbbca5ffb22dff077ee">SingleZoneDynamicNetworkSolver</a> &amp;</td> <td class="paramname"><span class="paramname"><em>solver</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a735386e65c8904137eb3af27bfe0ac1d" name="a735386e65c8904137eb3af27bfe0ac1d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a735386e65c8904137eb3af27bfe0ac1d">&#9670;&#160;</a></span>~GridSolver()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">gridfire::solver::GridSolver::~GridSolver </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel override">override</span><span class="mlabel default">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aba2dba489f9fa8e644606fbf2b913fca" name="aba2dba489f9fa8e644606fbf2b913fca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aba2dba489f9fa8e644606fbf2b913fca">&#9670;&#160;</a></span>evaluate()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::vector&lt; <a class="el" href="structgridfire_1_1_net_out.html">NetOut</a> &gt; gridfire::solver::GridSolver::evaluate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structgridfire_1_1solver_1_1_solver_context_base.html">SolverContextBase</a> &amp;</td> <td class="paramname"><span class="paramname"><em>ctx</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector&lt; <a class="el" href="structgridfire_1_1_net_in.html">NetIn</a> &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>netIns</em></span>&#160;) const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="classgridfire_1_1solver_1_1_multi_zone_network_solver.html#ab9f86bfb1e576a2a520bee7b205bf0d1">gridfire::solver::MultiZoneNetworkSolver&lt; engine::DynamicEngine &gt;</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/include/gridfire/solver/strategies/<a class="el" href="_grid_solver_8h.html">GridSolver.h</a></li>
<li>src/lib/solver/strategies/<a class="el" href="_grid_solver_8cpp.html">GridSolver.cpp</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="namespacegridfire.html">gridfire</a></li><li class="navelem"><a class="el" href="namespacegridfire_1_1solver.html">solver</a></li><li class="navelem"><a class="el" href="classgridfire_1_1solver_1_1_grid_solver.html">GridSolver</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.13.2 </li>
</ul>
</div>
</body>
</html>