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

24
docs/html/priming_8h.html
View File

@@ -107,8 +107,8 @@ $(function(){initNavTree('priming_8h.html',''); initResizable(true); });
<div class="contents">
<div class="textblock"><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="engine__graph_8h.html">gridfire/engine/engine_graph.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;fourdst/composition/atomicSpecies.h&quot;</code><br />
<code>#include &quot;<a class="el" href="types_8h.html">gridfire/types/types.h</a>&quot;</code><br />
<code>#include &quot;fourdst/atomic/atomicSpecies.h&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for priming.h:</div>
<div class="dyncontent">
@@ -124,18 +124,20 @@ This graph shows which files directly or indirectly include this file:</div>
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="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a66905e14e8bb9a353889d9d014c61d12" id="r_a66905e14e8bb9a353889d9d014c61d12"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgridfire_1_1_priming_report.html">PrimingReport</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire.html#a66905e14e8bb9a353889d9d014c61d12">gridfire::primeNetwork</a> (const <a class="el" href="structgridfire_1_1_net_in.html">NetIn</a> &amp;netIn, <a class="el" href="classgridfire_1_1_graph_engine.html">GraphEngine</a> &amp;engine, const std::optional&lt; std::vector&lt; <a class="el" href="namespacegridfire_1_1reaction.html#a026997f11e811fa7754ac9121c4ba74e">reaction::ReactionType</a> &gt; &gt; &amp;ignoredReactionTypes)</td></tr>
<tr class="memdesc:a66905e14e8bb9a353889d9d014c61d12"><td class="mdescLeft">&#160;</td><td class="mdescRight">Primes absent species in the network to their equilibrium abundances. <br /></td></tr>
<tr class="separator:a66905e14e8bb9a353889d9d014c61d12"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4a5cebf9768d6401c1f0e7f50e9f4d5d" id="r_a4a5cebf9768d6401c1f0e7f50e9f4d5d"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire.html#a4a5cebf9768d6401c1f0e7f50e9f4d5d">gridfire::calculateDestructionRateConstant</a> (const <a class="el" href="classgridfire_1_1_dynamic_engine.html">DynamicEngine</a> &amp;engine, const fourdst::atomic::Species &amp;species, const fourdst::composition::Composition &amp;composition, double T9, double rho, const std::optional&lt; std::vector&lt; <a class="el" href="namespacegridfire_1_1reaction.html#a026997f11e811fa7754ac9121c4ba74e">reaction::ReactionType</a> &gt; &gt; &amp;reactionTypesToIgnore)</td></tr>
<tr class="memdesc:a4a5cebf9768d6401c1f0e7f50e9f4d5d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Computes the destruction rate constant for a specific species. <br /></td></tr>
<tr class="separator:a4a5cebf9768d6401c1f0e7f50e9f4d5d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afe8beb35efa1d8708187c8eb2d4a37b3" id="r_afe8beb35efa1d8708187c8eb2d4a37b3"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire.html#afe8beb35efa1d8708187c8eb2d4a37b3">gridfire::calculateCreationRate</a> (const <a class="el" href="classgridfire_1_1_dynamic_engine.html">DynamicEngine</a> &amp;engine, const fourdst::atomic::Species &amp;species, const fourdst::composition::Composition &amp;composition, double T9, double rho, const std::optional&lt; std::vector&lt; <a class="el" href="namespacegridfire_1_1reaction.html#a026997f11e811fa7754ac9121c4ba74e">reaction::ReactionType</a> &gt; &gt; &amp;reactionTypesToIgnore)</td></tr>
<tr class="memdesc:afe8beb35efa1d8708187c8eb2d4a37b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Computes the creation rate for a specific species. <br /></td></tr>
<tr class="separator:afe8beb35efa1d8708187c8eb2d4a37b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa6552165b4b36ea227479567880d8402" id="r_aa6552165b4b36ea227479567880d8402"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgridfire_1_1engine_1_1_priming_report.html">PrimingReport</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1engine.html#aa6552165b4b36ea227479567880d8402">gridfire::engine::primeNetwork</a> (const <a class="el" href="structgridfire_1_1_net_in.html">NetIn</a> &amp;netIn, <a class="el" href="classgridfire_1_1engine_1_1_graph_engine.html">GraphEngine</a> &amp;engine, const std::optional&lt; std::vector&lt; <a class="el" href="namespacegridfire_1_1reaction.html#a026997f11e811fa7754ac9121c4ba74e">reaction::ReactionType</a> &gt; &gt; &amp;ignoredReactionTypes)</td></tr>
<tr class="memdesc:aa6552165b4b36ea227479567880d8402"><td class="mdescLeft">&#160;</td><td class="mdescRight">Primes absent species in the network to their equilibrium abundances. <br /></td></tr>
<tr class="separator:aa6552165b4b36ea227479567880d8402"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9dc985b6bf1b86754f49b72dba478862" id="r_a9dc985b6bf1b86754f49b72dba478862"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1engine.html#a9dc985b6bf1b86754f49b72dba478862">gridfire::engine::calculateDestructionRateConstant</a> (const <a class="el" href="classgridfire_1_1engine_1_1_dynamic_engine.html">DynamicEngine</a> &amp;engine, const fourdst::atomic::Species &amp;species, const fourdst::composition::Composition &amp;composition, double T9, double rho, const std::optional&lt; std::vector&lt; <a class="el" href="namespacegridfire_1_1reaction.html#a026997f11e811fa7754ac9121c4ba74e">reaction::ReactionType</a> &gt; &gt; &amp;reactionTypesToIgnore)</td></tr>
<tr class="memdesc:a9dc985b6bf1b86754f49b72dba478862"><td class="mdescLeft">&#160;</td><td class="mdescRight">Computes the destruction rate constant for a specific species. <br /></td></tr>
<tr class="separator:a9dc985b6bf1b86754f49b72dba478862"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afb18048942c7af6debe9c0479a395a13" id="r_afb18048942c7af6debe9c0479a395a13"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1engine.html#afb18048942c7af6debe9c0479a395a13">gridfire::engine::calculateCreationRate</a> (const <a class="el" href="classgridfire_1_1engine_1_1_dynamic_engine.html">DynamicEngine</a> &amp;engine, const fourdst::atomic::Species &amp;species, const fourdst::composition::Composition &amp;composition, double T9, double rho, const std::optional&lt; std::vector&lt; <a class="el" href="namespacegridfire_1_1reaction.html#a026997f11e811fa7754ac9121c4ba74e">reaction::ReactionType</a> &gt; &gt; &amp;reactionTypesToIgnore)</td></tr>
<tr class="memdesc:afb18048942c7af6debe9c0479a395a13"><td class="mdescLeft">&#160;</td><td class="mdescRight">Computes the creation rate for a specific species. <br /></td></tr>
<tr class="separator:afb18048942c7af6debe9c0479a395a13"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->