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

41
docs/html/class_py_engine.html
View File

@@ -122,15 +122,9 @@ Collaboration diagram for PyEngine:</div>
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a2d240423899e039c2ca688e96f8af1f2" id="r_a2d240423899e039c2ca688e96f8af1f2"><td class="memItemLeft" align="right" valign="top">const std::vector&lt; fourdst::atomic::Species &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2d240423899e039c2ca688e96f8af1f2">getNetworkSpecies</a> () const override</td></tr>
<tr class="memdesc:a2d240423899e039c2ca688e96f8af1f2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the list of species in the network. <br /></td></tr>
<tr class="separator:a2d240423899e039c2ca688e96f8af1f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7a298603e9d94ca58dc0db53e5b07add" id="r_a7a298603e9d94ca58dc0db53e5b07add"><td class="memItemLeft" align="right" valign="top">std::expected&lt; <a class="el" href="structgridfire_1_1_step_derivatives.html">gridfire::StepDerivatives</a>&lt; double &gt;, <a class="el" href="structgridfire_1_1expectations_1_1_stale_engine_error.html">gridfire::expectations::StaleEngineError</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7a298603e9d94ca58dc0db53e5b07add">calculateRHSAndEnergy</a> (const fourdst::composition::Composition &amp;comp, double T9, double rho) const override</td></tr>
<tr class="memdesc:a7a298603e9d94ca58dc0db53e5b07add"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculate the right-hand side (dY/dt) and energy generation. <br /></td></tr>
<tr class="separator:a7a298603e9d94ca58dc0db53e5b07add"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classgridfire_1_1_engine"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_classgridfire_1_1_engine')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgridfire_1_1_engine.html">gridfire::Engine</a></td></tr>
<tr class="memitem:a2e7970bed2100699f226f4141d5db037 inherit pub_methods_classgridfire_1_1_engine" id="r_a2e7970bed2100699f226f4141d5db037"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1_engine.html#a2e7970bed2100699f226f4141d5db037">~Engine</a> ()=default</td></tr>
<tr class="memdesc:a2e7970bed2100699f226f4141d5db037 inherit pub_methods_classgridfire_1_1_engine"><td class="mdescLeft">&#160;</td><td class="mdescRight">Virtual destructor. <br /></td></tr>
<tr class="separator:a2e7970bed2100699f226f4141d5db037 inherit pub_methods_classgridfire_1_1_engine"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad707c62fb28025de64d6b3380567fac0" id="r_ad707c62fb28025de64d6b3380567fac0"><td class="memItemLeft" align="right" valign="top">std::expected&lt; gridfire::StepDerivatives&lt; double &gt;, gridfire::expectations::StaleEngineError &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad707c62fb28025de64d6b3380567fac0">calculateRHSAndEnergy</a> (const fourdst::composition::CompositionAbstract &amp;comp, double T9, double rho) const override</td></tr>
<tr class="separator:ad707c62fb28025de64d6b3380567fac0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
Private Attributes</h2></td></tr>
@@ -138,8 +132,8 @@ Private Attributes</h2></td></tr>
<tr class="separator:a73caaa7606e2cdfd1aa82729a78ebb73"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a7a298603e9d94ca58dc0db53e5b07add" name="a7a298603e9d94ca58dc0db53e5b07add"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7a298603e9d94ca58dc0db53e5b07add">&#9670;&#160;</a></span>calculateRHSAndEnergy()</h2>
<a id="ad707c62fb28025de64d6b3380567fac0" name="ad707c62fb28025de64d6b3380567fac0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad707c62fb28025de64d6b3380567fac0">&#9670;&#160;</a></span>calculateRHSAndEnergy()</h2>
<div class="memitem">
<div class="memproto">
@@ -148,9 +142,9 @@ Private Attributes</h2></td></tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::expected&lt; <a class="el" href="structgridfire_1_1_step_derivatives.html">gridfire::StepDerivatives</a>&lt; double &gt;, <a class="el" href="structgridfire_1_1expectations_1_1_stale_engine_error.html">gridfire::expectations::StaleEngineError</a> &gt; PyEngine::calculateRHSAndEnergy </td>
<td class="memname">std::expected&lt; gridfire::StepDerivatives&lt; double &gt;, gridfire::expectations::StaleEngineError &gt; PyEngine::calculateRHSAndEnergy </td>
<td>(</td>
<td class="paramtype">const fourdst::composition::Composition &amp;</td> <td class="paramname"><span class="paramname"><em>comp</em></span>, </td>
<td class="paramtype">const fourdst::composition::CompositionAbstract &amp;</td> <td class="paramname"><span class="paramname"><em>comp</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
@@ -165,25 +159,11 @@ Private Attributes</h2></td></tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span></span> </td>
<span class="mlabels"><span class="mlabel override">override</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Calculate the right-hand side (dY/dt) and energy generation. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">comp</td><td>Composition object containing current abundances. </td></tr>
<tr><td class="paramname">T9</td><td>Temperature in units of 10^9 K. </td></tr>
<tr><td class="paramname">rho</td><td>Density in g/cm^3. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>expected&lt;StepDerivatives&lt;double&gt;&gt; containing either dY/dt and energy generation rate or a stale engine error indicating that the engine must be updated</dd></dl>
<p>This function must be implemented by derived classes to compute the time derivatives of all species and the specific nuclear energy generation rate for the current state. </p>
<p>Implements <a class="el" href="classgridfire_1_1_engine.html#add48d3af9ebde17717e42e220e349740">gridfire::Engine</a>.</p>
</div>
</div>
<a id="a2d240423899e039c2ca688e96f8af1f2" name="a2d240423899e039c2ca688e96f8af1f2"></a>
@@ -204,16 +184,11 @@ Private Attributes</h2></td></tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span></span> </td>
<span class="mlabels"><span class="mlabel override">override</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the list of species in the network. </p>
<dl class="section return"><dt>Returns</dt><dd>Vector of Species objects representing all network species. </dd></dl>
<p>Implements <a class="el" href="classgridfire_1_1_engine.html#a020e1b493d6964cafdad08fde697ceb3">gridfire::Engine</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>