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

docs(docs): rebuilt docs

Browse Source
This commit is contained in:
Emily Boudreaux
2025-11-24 09:08:28 -05:00
parent 9fab4fbfae
commit 22c0329de0
2410 changed files with 309008 additions and 146081 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
docs/html/engine__abstract_8h.html
View File

@@ -102,8 +102,9 @@ $(function(){initNavTree('engine__abstract_8h.html',''); initResizable(true); })
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#namespaces">Namespaces</a> &#124;
<a href="#concepts">Concepts</a> &#124;
<a href="#typedef-members">Typedefs</a> </div>
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">engine_abstract.h File Reference</div></div>
</div><!--header-->
<div class="contents">
@@ -111,12 +112,13 @@ $(function(){initNavTree('engine__abstract_8h.html',''); initResizable(true); })
<p>Abstract interfaces for reaction network engines in GridFire.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="reaction_8h.html">gridfire/reaction/reaction.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="network_8h.html">gridfire/network.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="types_8h.html">gridfire/types/types.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="screening__abstract_8h.html">gridfire/screening/screening_abstract.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="screening__types_8h.html">gridfire/screening/screening_types.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="reporting_8h.html">gridfire/engine/types/reporting.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="building_8h.html">gridfire/engine/types/building.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="expected__engine_8h.html">gridfire/expectations/expected_engine.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="jacobian_8h.html">gridfire/engine/types/jacobian.h</a>&quot;</code><br />
<code>#include &quot;fourdst/composition/composition_abstract.h&quot;</code><br />
<code>#include &lt;vector&gt;</code><br />
<code>#include &lt;unordered_map&gt;</code><br />
<code>#include &lt;utility&gt;</code><br />
@@ -134,33 +136,47 @@ 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">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1_step_derivatives.html">gridfire::StepDerivatives&lt; T &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Structure holding derivatives and energy generation for a network step. <a href="structgridfire_1_1_step_derivatives.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_1engine_1_1_step_derivatives.html">gridfire::engine::StepDerivatives&lt; T &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Structure holding derivatives and energy generation for a network step. <a href="structgridfire_1_1engine_1_1_step_derivatives.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_1_energy_derivatives.html">gridfire::EnergyDerivatives</a></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_1engine_1_1_energy_derivatives.html">gridfire::engine::EnergyDerivatives</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Structure holding derivatives of energy generation rate with respect to T and rho. <a href="structgridfire_1_1engine_1_1_energy_derivatives.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_1_engine.html">gridfire::Engine</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Abstract base class for a reaction network engine. <a href="classgridfire_1_1_engine.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_1engine_1_1_engine.html">gridfire::engine::Engine</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Abstract base class for a reaction network engine. <a href="classgridfire_1_1engine_1_1_engine.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_1_dynamic_engine.html">gridfire::DynamicEngine</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Abstract class for engines supporting Jacobian and stoichiometry operations. <a href="classgridfire_1_1_dynamic_engine.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_1engine_1_1_dynamic_engine.html">gridfire::engine::DynamicEngine</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Abstract class for engines supporting Jacobian and stoichiometry operations. <a href="classgridfire_1_1engine_1_1_dynamic_engine.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="namespaces" name="namespaces"></a>
Namespaces</h2></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>
</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_1_is_arithmetic_or_a_d.html">gridfire::IsArithmeticOrAD</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Concept for types allowed in engine calculations. <br /></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_1engine.html">gridfire::engine</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:a898dfe22579e649935645cbd6f073178" id="r_a898dfe22579e649935645cbd6f073178"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire.html#a898dfe22579e649935645cbd6f073178">gridfire::SparsityPattern</a> = std::vector&lt;std::pair&lt;size_t, size_t&gt;&gt;</td></tr>
<tr class="separator:a898dfe22579e649935645cbd6f073178"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9de1791ec719c0a9b76b835703336870" id="r_a9de1791ec719c0a9b76b835703336870"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1engine.html#a9de1791ec719c0a9b76b835703336870">gridfire::engine::SparsityPattern</a> = std::vector&lt;std::pair&lt;size_t, size_t&gt;&gt;</td></tr>
<tr class="memdesc:a9de1791ec719c0a9b76b835703336870"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type alias for sparsity pattern representation. <br /></td></tr>
<tr class="separator:a9de1791ec719c0a9b76b835703336870"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a4d057e41b489bf20744dfa8d2958ad5a" id="r_a4d057e41b489bf20744dfa8d2958ad5a"><td class="memItemLeft" align="right" valign="top">enum class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1engine.html#a4d057e41b489bf20744dfa8d2958ad5a">gridfire::engine::EngineStatus</a> { <a class="el" href="namespacegridfire_1_1engine.html#a4d057e41b489bf20744dfa8d2958ad5aa74eb855e4de6fe58228f03006c02fd8a">gridfire::engine::OKAY</a>
, <a class="el" href="namespacegridfire_1_1engine.html#a4d057e41b489bf20744dfa8d2958ad5aa4d855a061b3066dc14a3b12ed26b5456">gridfire::engine::STALE</a>
, <a class="el" href="namespacegridfire_1_1engine.html#a4d057e41b489bf20744dfa8d2958ad5aabb1ca97ec761fc37101737ba0aa2e7c5">gridfire::engine::ERROR</a>
, <a class="el" href="namespacegridfire_1_1engine.html#a4d057e41b489bf20744dfa8d2958ad5aa4905ac9d6a22bdfc1ae096094ce6248d">gridfire::engine::COUNT</a>
}</td></tr>
<tr class="memdesc:a4d057e41b489bf20744dfa8d2958ad5a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enumeration of possible engine statuses. <a href="namespacegridfire_1_1engine.html#a4d057e41b489bf20744dfa8d2958ad5a">More...</a><br /></td></tr>
<tr class="separator:a4d057e41b489bf20744dfa8d2958ad5a"><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:a006018e8e5f80ddb857009dbad962753" id="r_a006018e8e5f80ddb857009dbad962753"><td class="memItemLeft" align="right" valign="top">constexpr std::string_view&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1engine.html#a006018e8e5f80ddb857009dbad962753">gridfire::engine::EngineStatus_to_string</a> (const <a class="el" href="namespacegridfire_1_1engine.html#a4d057e41b489bf20744dfa8d2958ad5a">EngineStatus</a> status)</td></tr>
<tr class="memdesc:a006018e8e5f80ddb857009dbad962753"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert <a class="el" href="namespacegridfire_1_1engine.html#a4d057e41b489bf20744dfa8d2958ad5a" title="Enumeration of possible engine statuses.">EngineStatus</a> enum to string representation. <br /></td></tr>
<tr class="separator:a006018e8e5f80ddb857009dbad962753"><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>Abstract interfaces for reaction network engines in GridFire. </p>