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

docs(docs): added doxygen html directory

Browse Source
This commit is contained in:
Emily Boudreaux
2025-07-01 07:24:18 -04:00
parent 58a0007351
commit 40b28477ed
410 changed files with 231801 additions and 128 deletions
Download Patch File Download Diff File Expand all files Collapse all files

201
docs/html/namespacegridfire_1_1solver.html Normal file
View File

@@ -0,0 +1,201 @@
<!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 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="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;0.0.1a</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('namespacegridfire_1_1solver.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="#nested-classes">Classes</a> &#124;
<a href="#typedef-members">Typedefs</a> </div>
<div class="headertitle"><div class="title">gridfire::solver 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 &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1solver_1_1_direct_network_solver.html">DirectNetworkSolver</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A network solver that directly integrates the reaction network ODEs. <a href="classgridfire_1_1solver_1_1_direct_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_1dynamic_q_s_e_species_indices.html">dynamicQSESpeciesIndices</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Structure to hold indices of dynamic and QSE species. <a href="structgridfire_1_1solver_1_1dynamic_q_s_e_species_indices.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_1solver_1_1_network_solver_strategy.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_1_network_solver_strategy.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_1solver_1_1_q_s_e_network_solver.html">QSENetworkSolver</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A network solver that uses a Quasi-Steady-State Equilibrium (QSE) approach. <a href="classgridfire_1_1solver_1_1_q_s_e_network_solver.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="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a8118d08bc25e439754b43a3f5ecc1db3" id="r_a8118d08bc25e439754b43a3f5ecc1db3"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8118d08bc25e439754b43a3f5ecc1db3">DynamicNetworkSolverStrategy</a> = <a class="el" href="classgridfire_1_1solver_1_1_network_solver_strategy.html">NetworkSolverStrategy</a>&lt;<a class="el" href="classgridfire_1_1_dynamic_engine.html">DynamicEngine</a>&gt;</td></tr>
<tr class="memdesc:a8118d08bc25e439754b43a3f5ecc1db3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type alias for a network solver strategy that uses a <a class="el" href="classgridfire_1_1_dynamic_engine.html" title="Abstract class for engines supporting Jacobian and stoichiometry operations.">DynamicEngine</a>. <br /></td></tr>
<tr class="separator:a8118d08bc25e439754b43a3f5ecc1db3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af3b10822ab58b55365577755c1f4faf6" id="r_af3b10822ab58b55365577755c1f4faf6"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af3b10822ab58b55365577755c1f4faf6">AdaptiveNetworkSolverStrategy</a> = <a class="el" href="classgridfire_1_1solver_1_1_network_solver_strategy.html">NetworkSolverStrategy</a>&lt;<a class="el" href="classgridfire_1_1_adaptive_engine_view.html">AdaptiveEngineView</a>&gt;</td></tr>
<tr class="memdesc:af3b10822ab58b55365577755c1f4faf6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type alias for a network solver strategy that uses an <a class="el" href="classgridfire_1_1_adaptive_engine_view.html" title="An engine view that dynamically adapts the reaction network based on runtime conditions.">AdaptiveEngineView</a>. <br /></td></tr>
<tr class="separator:af3b10822ab58b55365577755c1f4faf6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5361d6cf364f0ba2f88285a60bb9cd92" id="r_a5361d6cf364f0ba2f88285a60bb9cd92"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5361d6cf364f0ba2f88285a60bb9cd92">StaticNetworkSolverStrategy</a> = <a class="el" href="classgridfire_1_1solver_1_1_network_solver_strategy.html">NetworkSolverStrategy</a>&lt;<a class="el" href="classgridfire_1_1_engine.html">Engine</a>&gt;</td></tr>
<tr class="memdesc:a5361d6cf364f0ba2f88285a60bb9cd92"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type alias for a network solver strategy that uses a static <a class="el" href="classgridfire_1_1_engine.html" title="Abstract base class for a reaction network engine.">Engine</a>. <br /></td></tr>
<tr class="separator:a5361d6cf364f0ba2f88285a60bb9cd92"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="af3b10822ab58b55365577755c1f4faf6" name="af3b10822ab58b55365577755c1f4faf6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af3b10822ab58b55365577755c1f4faf6">&#9670;&#160;</a></span>AdaptiveNetworkSolverStrategy</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="#af3b10822ab58b55365577755c1f4faf6">gridfire::solver::AdaptiveNetworkSolverStrategy</a> = <a class="el" href="classgridfire_1_1solver_1_1_network_solver_strategy.html">NetworkSolverStrategy</a>&lt;<a class="el" href="classgridfire_1_1_adaptive_engine_view.html">AdaptiveEngineView</a>&gt;</td>
</tr>
</table>
</div><div class="memdoc">
<p>Type alias for a network solver strategy that uses an <a class="el" href="classgridfire_1_1_adaptive_engine_view.html" title="An engine view that dynamically adapts the reaction network based on runtime conditions.">AdaptiveEngineView</a>. </p>
<p class="definition">Definition at line <a class="el" href="solver_8h_source.html#l00074">74</a> of file <a class="el" href="solver_8h_source.html">solver.h</a>.</p>
</div>
</div>
<a id="a8118d08bc25e439754b43a3f5ecc1db3" name="a8118d08bc25e439754b43a3f5ecc1db3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8118d08bc25e439754b43a3f5ecc1db3">&#9670;&#160;</a></span>DynamicNetworkSolverStrategy</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="#a8118d08bc25e439754b43a3f5ecc1db3">gridfire::solver::DynamicNetworkSolverStrategy</a> = <a class="el" href="classgridfire_1_1solver_1_1_network_solver_strategy.html">NetworkSolverStrategy</a>&lt;<a class="el" href="classgridfire_1_1_dynamic_engine.html">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_1_dynamic_engine.html" title="Abstract class for engines supporting Jacobian and stoichiometry operations.">DynamicEngine</a>. </p>
<p class="definition">Definition at line <a class="el" href="solver_8h_source.html#l00069">69</a> of file <a class="el" href="solver_8h_source.html">solver.h</a>.</p>
</div>
</div>
<a id="a5361d6cf364f0ba2f88285a60bb9cd92" name="a5361d6cf364f0ba2f88285a60bb9cd92"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5361d6cf364f0ba2f88285a60bb9cd92">&#9670;&#160;</a></span>StaticNetworkSolverStrategy</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="#a5361d6cf364f0ba2f88285a60bb9cd92">gridfire::solver::StaticNetworkSolverStrategy</a> = <a class="el" href="classgridfire_1_1solver_1_1_network_solver_strategy.html">NetworkSolverStrategy</a>&lt;<a class="el" href="classgridfire_1_1_engine.html">Engine</a>&gt;</td>
</tr>
</table>
</div><div class="memdoc">
<p>Type alias for a network solver strategy that uses a static <a class="el" href="classgridfire_1_1_engine.html" title="Abstract base class for a reaction network engine.">Engine</a>. </p>
<p class="definition">Definition at line <a class="el" href="solver_8h_source.html#l00079">79</a> of file <a class="el" href="solver_8h_source.html">solver.h</a>.</p>
</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_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.13.2 </li>
</ul>
</div>
</body>
</html>