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-04 14:04:26 -05:00
parent e87206a4a3
commit 77e6a918a5
710 changed files with 14858 additions and 5874 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
docs/html/priming_8h.html
View File

@@ -29,7 +29,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">GridFire<span id="projectnumber">&#160;0.6.0</span>
<div id="projectname">GridFire<span id="projectnumber">&#160;v0.7.0-alpha</span>
</div>
<div id="projectbrief">General Purpose Nuclear Network</div>
</td>
@@ -106,6 +106,7 @@ $(function(){initNavTree('priming_8h.html',''); initResizable(true); });
</div><!--header-->
<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 />
</div><table class="memberdecls">
@@ -116,15 +117,15 @@ Namespaces</h2></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:a3cd451f4b7a7bc7c2d7007ebb343e9ac" id="r_a3cd451f4b7a7bc7c2d7007ebb343e9ac"><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#a3cd451f4b7a7bc7c2d7007ebb343e9ac">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_dynamic_engine.html">DynamicEngine</a> &amp;engine)</td></tr>
<tr class="memdesc:a3cd451f4b7a7bc7c2d7007ebb343e9ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Primes absent species in the network to their equilibrium abundances. <br /></td></tr>
<tr class="separator:a3cd451f4b7a7bc7c2d7007ebb343e9ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab6e14208fad69f4031411a9346c12397" id="r_ab6e14208fad69f4031411a9346c12397"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire.html#ab6e14208fad69f4031411a9346c12397">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)</td></tr>
<tr class="memdesc:ab6e14208fad69f4031411a9346c12397"><td class="mdescLeft">&#160;</td><td class="mdescRight">Computes the destruction rate constant for a specific species. <br /></td></tr>
<tr class="separator:ab6e14208fad69f4031411a9346c12397"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8995b949592d59850e45a3fd27306369" id="r_a8995b949592d59850e45a3fd27306369"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire.html#a8995b949592d59850e45a3fd27306369">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)</td></tr>
<tr class="memdesc:a8995b949592d59850e45a3fd27306369"><td class="mdescLeft">&#160;</td><td class="mdescRight">Computes the creation rate for a specific species. <br /></td></tr>
<tr class="separator:a8995b949592d59850e45a3fd27306369"><td class="memSeparator" colspan="2">&#160;</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>
</table>
</div><!-- contents -->
</div><!-- doc-content -->