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

docs(docs): rebuilt

Browse Source
This commit is contained in:
Emily Boudreaux
2025-11-05 18:38:07 -05:00
parent 18d289da7e
commit ba306523d6
202 changed files with 11748 additions and 3895 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
docs/html/classgridfire_1_1reaction_1_1_reaclib_reaction.html
View File

@@ -152,6 +152,8 @@ Public Member Functions</h2></td></tr>
<tr class="memitem:adfed51cf788a7ed4770cbd5945ddab2f" id="r_adfed51cf788a7ed4770cbd5945ddab2f"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structgridfire_1_1reaction_1_1_rate_coefficient_set.html">RateCoefficientSet</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#adfed51cf788a7ed4770cbd5945ddab2f">rateCoefficients</a> () const</td></tr>
<tr class="memdesc:adfed51cf788a7ed4770cbd5945ddab2f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the set of rate coefficients. <br /></td></tr>
<tr class="separator:adfed51cf788a7ed4770cbd5945ddab2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aefd0436ae72880358214d5b79c9c79eb" id="r_aefd0436ae72880358214d5b79c9c79eb"><td class="memItemLeft" align="right" valign="top">std::optional&lt; std::vector&lt; <a class="el" href="structgridfire_1_1reaction_1_1_rate_coefficient_set.html">RateCoefficientSet</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aefd0436ae72880358214d5b79c9c79eb">getRateCoefficients</a> () const override</td></tr>
<tr class="separator:aefd0436ae72880358214d5b79c9c79eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a171b690e1abaf23f11a94c39e9f8c944" id="r_a171b690e1abaf23f11a94c39e9f8c944"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a171b690e1abaf23f11a94c39e9f8c944">contains</a> (const fourdst::atomic::Species &amp;species) const override</td></tr>
<tr class="memdesc:a171b690e1abaf23f11a94c39e9f8c944"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if the reaction involves a given species as a reactant or product. <br /></td></tr>
<tr class="separator:a171b690e1abaf23f11a94c39e9f8c944"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -818,6 +820,33 @@ template&lt;typename T&gt; </div>
<p>Calculates the excess energy from the mass difference of reactants and products. </p>
<dl class="section return"><dt>Returns</dt><dd>The excess energy in MeV. </dd></dl>
</div>
</div>
<a id="aefd0436ae72880358214d5b79c9c79eb" name="aefd0436ae72880358214d5b79c9c79eb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aefd0436ae72880358214d5b79c9c79eb">&#9670;&#160;</a></span>getRateCoefficients()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::optional&lt; std::vector&lt; <a class="el" href="structgridfire_1_1reaction_1_1_rate_coefficient_set.html">RateCoefficientSet</a> &gt; &gt; gridfire::reaction::ReaclibReaction::getRateCoefficients </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="classgridfire_1_1reaction_1_1_reaction.html#a6c51c30a0eec2f00c7d1f1c0be44cb0b">gridfire::reaction::Reaction</a>.</p>
</div>
</div>
<a id="a661dd461e51c37133f7f9931389fd3cc" name="a661dd461e51c37133f7f9931389fd3cc"></a>