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

docs(docs): asdded and cleaned up docs

Browse Source
This commit is contained in:
Emily Boudreaux
2025-07-24 11:10:45 -04:00
parent cc3708fda5
commit ba9b3e2392
808 changed files with 140326 additions and 9346 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
docs/html/solver_8h.html
View File

@@ -5,7 +5,7 @@
<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: src/network/include/gridfire/solver/solver.h File Reference</title>
<title>GridFire: src/include/gridfire/solver/solver.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>
@@ -113,36 +113,19 @@ $(function(){initNavTree('solver_8h.html',''); initResizable(true); });
<code>#include &quot;fourdst/logging/logging.h&quot;</code><br />
<code>#include &quot;fourdst/config/config.h&quot;</code><br />
<code>#include &quot;quill/Logger.h&quot;</code><br />
<code>#include &quot;unsupported/Eigen/NonLinearOptimization&quot;</code><br />
<code>#include &lt;vector&gt;</code><br />
</div>
<p><a href="solver_8h_source.html">Go to the source code of this file.</a></p>
<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">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1solver_1_1dynamic_q_s_e_species_indices.html">gridfire::solver::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">gridfire::solver::NetworkSolverStrategy&lt; EngineT &gt;</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">gridfire::solver::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>
<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_q_s_e_network_solver_1_1_r_h_s_functor.html">gridfire::solver::QSENetworkSolver::RHSFunctor</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Functor for calculating the right-hand side of the ODEs for the dynamic species. <a href="structgridfire_1_1solver_1_1_q_s_e_network_solver_1_1_r_h_s_functor.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_q_s_e_network_solver_1_1_jacobian_functor.html">gridfire::solver::QSENetworkSolver::JacobianFunctor</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Functor for calculating the Jacobian matrix of the ODEs for the dynamic species. <a href="structgridfire_1_1solver_1_1_q_s_e_network_solver_1_1_jacobian_functor.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_q_s_e_network_solver_1_1_eigen_functor.html">gridfire::solver::QSENetworkSolver::EigenFunctor&lt; T &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Functor for calculating the residual and Jacobian for the QSE species using Eigen. <a href="structgridfire_1_1solver_1_1_q_s_e_network_solver_1_1_eigen_functor.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_direct_network_solver.html">gridfire::solver::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_1_direct_network_solver_1_1_r_h_s_functor.html">gridfire::solver::DirectNetworkSolver::RHSFunctor</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Functor for calculating the right-hand side of the ODEs. <a href="structgridfire_1_1solver_1_1_direct_network_solver_1_1_r_h_s_functor.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_direct_network_solver_1_1_r_h_s_manager.html">gridfire::solver::DirectNetworkSolver::RHSManager</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_direct_network_solver_1_1_jacobian_functor.html">gridfire::solver::DirectNetworkSolver::JacobianFunctor</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Functor for calculating the Jacobian matrix. <a href="structgridfire_1_1solver_1_1_direct_network_solver_1_1_jacobian_functor.html#details">More...</a><br /></td></tr>
@@ -160,19 +143,13 @@ 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="namespacegridfire_1_1solver.html#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>
<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="namespacegridfire_1_1solver.html#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>
<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="namespacegridfire_1_1solver.html#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>
<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>
</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="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_fc4c7f03e1a69a98c370fae55a743828.html">network</a></li><li class="navelem"><a class="el" href="dir_5cccfa813acdf3744b542715860d37b2.html">include</a></li><li class="navelem"><a class="el" href="dir_2a1262ef5950eb718393488a3eb5aa9f.html">gridfire</a></li><li class="navelem"><a class="el" href="dir_aa1cdef39099aefa25ac81305b9dae77.html">solver</a></li><li class="navelem"><a class="el" href="solver_8h.html">solver.h</a></li>
<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="solver_8h.html">solver.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.13.2 </li>
</ul>
</div>