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

docs(docs): rebuilt docs with loads more detail for triggers and weak reactions

Browse Source
This commit is contained in:
Emily Boudreaux
2025-10-08 11:17:09 -04:00
parent 8a0b5b2c36
commit 274c566726
600 changed files with 39207 additions and 9125 deletions
Download Patch File Download Diff File Expand all files Collapse all files

59
docs/html/namespacegridfire_1_1utils.html
View File

@@ -100,20 +100,59 @@ $(function(){initNavTree('namespacegridfire_1_1utils.html',''); initResizable(tr
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">gridfire::utils Namespace Reference</div></div>
</div><!--header-->
<div class="contents">
<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_1utils_1_1_column.html">Column</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_1utils_1_1_column_base.html">ColumnBase</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:af56693a70d9e2b40c8ae2c3bcd4b26c8" id="r_af56693a70d9e2b40c8ae2c3bcd4b26c8"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af56693a70d9e2b40c8ae2c3bcd4b26c8">formatNuclearTimescaleLogString</a> (const <a class="el" href="classgridfire_1_1_dynamic_engine.html">DynamicEngine</a> &amp;engine, const std::vector&lt; double &gt; &amp;Y, const double T9, const double rho)</td></tr>
<tr class="memdesc:af56693a70d9e2b40c8ae2c3bcd4b26c8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Formats a map of nuclear species timescales into a human-readable string. <br /></td></tr>
<tr class="separator:af56693a70d9e2b40c8ae2c3bcd4b26c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a05fda32d3fc4ab10060b8c4c251c2f3d" id="r_a05fda32d3fc4ab10060b8c4c251c2f3d"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a05fda32d3fc4ab10060b8c4c251c2f3d">formatNuclearTimescaleLogString</a> (const <a class="el" href="classgridfire_1_1_dynamic_engine.html">DynamicEngine</a> &amp;engine, const fourdst::composition::Composition &amp;composition, double T9, double rho)</td></tr>
<tr class="memdesc:a05fda32d3fc4ab10060b8c4c251c2f3d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Formats a map of nuclear species timescales into a human-readable string. <br /></td></tr>
<tr class="separator:a05fda32d3fc4ab10060b8c4c251c2f3d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6451ba6762273b91a8281043cfaa5d2a" id="r_a6451ba6762273b91a8281043cfaa5d2a"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6451ba6762273b91a8281043cfaa5d2a">format_table</a> (const std::string &amp;tableName, const std::vector&lt; std::unique_ptr&lt; <a class="el" href="classgridfire_1_1utils_1_1_column_base.html">ColumnBase</a> &gt; &gt; &amp;columns)</td></tr>
<tr class="separator:a6451ba6762273b91a8281043cfaa5d2a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="af56693a70d9e2b40c8ae2c3bcd4b26c8" name="af56693a70d9e2b40c8ae2c3bcd4b26c8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af56693a70d9e2b40c8ae2c3bcd4b26c8">&#9670;&#160;</a></span>formatNuclearTimescaleLogString()</h2>
<a id="a6451ba6762273b91a8281043cfaa5d2a" name="a6451ba6762273b91a8281043cfaa5d2a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6451ba6762273b91a8281043cfaa5d2a">&#9670;&#160;</a></span>format_table()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string gridfire::utils::format_table </td>
<td>(</td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>tableName</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector&lt; std::unique_ptr&lt; <a class="el" href="classgridfire_1_1utils_1_1_column_base.html">ColumnBase</a> &gt; &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>columns</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a05fda32d3fc4ab10060b8c4c251c2f3d" name="a05fda32d3fc4ab10060b8c4c251c2f3d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a05fda32d3fc4ab10060b8c4c251c2f3d">&#9670;&#160;</a></span>formatNuclearTimescaleLogString()</h2>
<div class="memitem">
<div class="memproto">
@@ -126,17 +165,17 @@ Functions</h2></td></tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector&lt; double &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>Y</em></span>, </td>
<td class="paramtype">const fourdst::composition::Composition &amp;</td> <td class="paramname"><span class="paramname"><em>composition</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const double</td> <td class="paramname"><span class="paramname"><em>T9</em></span>, </td>
<td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em>T9</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const double</td> <td class="paramname"><span class="paramname"><em>rho</em></span>&#160;)</td>
<td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em>rho</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
@@ -168,7 +207,7 @@ Functions</h2></td></tr>
<li>The final string, including header and footer lines, is returned.</li>
</ol>
<p><b>Usage</b> </p><div class="fragment"><div class="line"><span class="comment">// Assume &#39;my_engine&#39; is a valid DynamicEngine object and Y, T9, rho are initialized.</span></div>
<div class="line">std::string log_output = <a class="code hl_function" href="#af56693a70d9e2b40c8ae2c3bcd4b26c8">gridfire::utils::formatNuclearTimescaleLogString</a>(my_engine, Y, T9, rho);</div>
<div class="line">std::string log_output = <a class="code hl_function" href="#a05fda32d3fc4ab10060b8c4c251c2f3d">gridfire::utils::formatNuclearTimescaleLogString</a>(my_engine, Y, T9, rho);</div>
<div class="line">std::cout &lt;&lt; log_output;</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Example Output:</span></div>
@@ -179,7 +218,7 @@ Functions</h2></td></tr>
<div class="line"><span class="comment">// he4 inf</span></div>
<div class="line"><span class="comment">// c12 8.765e-02</span></div>
<div class="line"><span class="comment">// ==========================</span></div>
<div class="ttc" id="anamespacegridfire_1_1utils_html_af56693a70d9e2b40c8ae2c3bcd4b26c8"><div class="ttname"><a href="#af56693a70d9e2b40c8ae2c3bcd4b26c8">gridfire::utils::formatNuclearTimescaleLogString</a></div><div class="ttdeci">std::string formatNuclearTimescaleLogString(const DynamicEngine &amp;engine, const std::vector&lt; double &gt; &amp;Y, const double T9, const double rho)</div><div class="ttdoc">Formats a map of nuclear species timescales into a human-readable string.</div><div class="ttdef"><b>Definition</b> logging.cpp:13</div></div>
<div class="ttc" id="anamespacegridfire_1_1utils_html_a05fda32d3fc4ab10060b8c4c251c2f3d"><div class="ttname"><a href="#a05fda32d3fc4ab10060b8c4c251c2f3d">gridfire::utils::formatNuclearTimescaleLogString</a></div><div class="ttdeci">std::string formatNuclearTimescaleLogString(const DynamicEngine &amp;engine, const fourdst::composition::Composition &amp;composition, double T9, double rho)</div><div class="ttdoc">Formats a map of nuclear species timescales into a human-readable string.</div><div class="ttdef"><b>Definition</b> logging.cpp:12</div></div>
</div><!-- fragment -->
</div>
</div>