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

40
docs/html/engine__graph_8h.html
View File

@@ -107,11 +107,11 @@ $(function(){initNavTree('engine__graph_8h.html',''); initResizable(true); });
<div class="headertitle"><div class="title">engine_graph.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;fourdst/composition/atomicSpecies.h&quot;</code><br />
<div class="textblock"><code>#include &quot;fourdst/atomic/atomicSpecies.h&quot;</code><br />
<code>#include &quot;fourdst/composition/composition.h&quot;</code><br />
<code>#include &quot;fourdst/logging/logging.h&quot;</code><br />
<code>#include &quot;fourdst/config/config.h&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="reaction_8h.html">gridfire/reaction/reaction.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="engine__abstract_8h.html">gridfire/engine/engine_abstract.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 />
@@ -143,38 +143,40 @@ 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">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1_graph_engine.html">gridfire::GraphEngine</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A reaction network engine that uses a graph-based representation. <a href="classgridfire_1_1_graph_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_graph_engine.html">gridfire::engine::GraphEngine</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A reaction network engine that uses a graph-based representation. <a href="classgridfire_1_1engine_1_1_graph_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">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1_graph_engine_1_1_precomputed_reaction.html">gridfire::GraphEngine::PrecomputedReaction</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_graph_engine_1_1_precomputed_reaction.html">gridfire::engine::GraphEngine::PrecomputedReaction</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_1_graph_engine_1_1constants.html">gridfire::GraphEngine::constants</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_graph_engine_1_1constants.html">gridfire::engine::GraphEngine::constants</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_1_graph_engine_1_1_atomic_reverse_rate.html">gridfire::GraphEngine::AtomicReverseRate</a></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_graph_engine_1_1_atomic_reverse_rate.html">gridfire::engine::GraphEngine::AtomicReverseRate</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="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>
<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:a1121d0b2d005195333412559fa29d3cc" id="r_a1121d0b2d005195333412559fa29d3cc"><td class="memItemLeft" align="right" valign="top">typedef CppAD::AD&lt; double &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire.html#a1121d0b2d005195333412559fa29d3cc">gridfire::ADDouble</a></td></tr>
<tr class="memdesc:a1121d0b2d005195333412559fa29d3cc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Alias for CppAD AD type for double precision. <br /></td></tr>
<tr class="separator:a1121d0b2d005195333412559fa29d3cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4562b782e8096986a9b0cc95aa8c1c02" id="r_a4562b782e8096986a9b0cc95aa8c1c02"><td class="memItemLeft" align="right" valign="top">typedef CppAD::AD&lt; double &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1engine.html#a4562b782e8096986a9b0cc95aa8c1c02">gridfire::engine::ADDouble</a></td></tr>
<tr class="memdesc:a4562b782e8096986a9b0cc95aa8c1c02"><td class="mdescLeft">&#160;</td><td class="mdescRight">Alias for CppAD AD type for double precision. <br /></td></tr>
<tr class="separator:a4562b782e8096986a9b0cc95aa8c1c02"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:ada3c137c014ecd8d06200fea2d1a9f50" id="r_ada3c137c014ecd8d06200fea2d1a9f50"><td class="memItemLeft" align="right" valign="top">static constexpr double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire.html#ada3c137c014ecd8d06200fea2d1a9f50">gridfire::MIN_DENSITY_THRESHOLD</a> = 1e-18</td></tr>
<tr class="memdesc:ada3c137c014ecd8d06200fea2d1a9f50"><td class="mdescLeft">&#160;</td><td class="mdescRight">Minimum density threshold below which reactions are ignored. <br /></td></tr>
<tr class="separator:ada3c137c014ecd8d06200fea2d1a9f50"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a96c062f94713921e5d7568ecedcdcb06" id="r_a96c062f94713921e5d7568ecedcdcb06"><td class="memItemLeft" align="right" valign="top">static constexpr double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire.html#a96c062f94713921e5d7568ecedcdcb06">gridfire::MIN_ABUNDANCE_THRESHOLD</a> = 1e-18</td></tr>
<tr class="memdesc:a96c062f94713921e5d7568ecedcdcb06"><td class="mdescLeft">&#160;</td><td class="mdescRight">Minimum abundance threshold below which species are ignored. <br /></td></tr>
<tr class="separator:a96c062f94713921e5d7568ecedcdcb06"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae01b1738df1921db565bcbd68dd6cf64" id="r_ae01b1738df1921db565bcbd68dd6cf64"><td class="memItemLeft" align="right" valign="top">static constexpr double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire.html#ae01b1738df1921db565bcbd68dd6cf64">gridfire::MIN_JACOBIAN_THRESHOLD</a> = 1e-24</td></tr>
<tr class="memdesc:ae01b1738df1921db565bcbd68dd6cf64"><td class="mdescLeft">&#160;</td><td class="mdescRight">Minimum value for Jacobian matrix entries. <br /></td></tr>
<tr class="separator:ae01b1738df1921db565bcbd68dd6cf64"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acbe76badc77637ba89e4017130d110b1" id="r_acbe76badc77637ba89e4017130d110b1"><td class="memItemLeft" align="right" valign="top">static constexpr double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1engine.html#acbe76badc77637ba89e4017130d110b1">gridfire::engine::MIN_DENSITY_THRESHOLD</a> = 1e-18</td></tr>
<tr class="memdesc:acbe76badc77637ba89e4017130d110b1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Minimum density threshold below which reactions are ignored. <br /></td></tr>
<tr class="separator:acbe76badc77637ba89e4017130d110b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a35ed65ea4d304098e4de3e0f0191304f" id="r_a35ed65ea4d304098e4de3e0f0191304f"><td class="memItemLeft" align="right" valign="top">static constexpr double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1engine.html#a35ed65ea4d304098e4de3e0f0191304f">gridfire::engine::MIN_ABUNDANCE_THRESHOLD</a> = 1e-18</td></tr>
<tr class="memdesc:a35ed65ea4d304098e4de3e0f0191304f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Minimum abundance threshold below which species are ignored. <br /></td></tr>
<tr class="separator:a35ed65ea4d304098e4de3e0f0191304f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad84c68dc3c04ab08a9dc8cee5fde28dd" id="r_ad84c68dc3c04ab08a9dc8cee5fde28dd"><td class="memItemLeft" align="right" valign="top">static constexpr double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1engine.html#ad84c68dc3c04ab08a9dc8cee5fde28dd">gridfire::engine::MIN_JACOBIAN_THRESHOLD</a> = 1e-24</td></tr>
<tr class="memdesc:ad84c68dc3c04ab08a9dc8cee5fde28dd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Minimum value for Jacobian matrix entries. <br /></td></tr>
<tr class="separator:ad84c68dc3c04ab08a9dc8cee5fde28dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->