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

69
docs/html/construction_8h.html
View File

@@ -106,9 +106,12 @@ $(function(){initNavTree('construction_8h.html',''); initResizable(true); });
<div class="headertitle"><div class="title">construction.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Functions for constructing nuclear reaction networks.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="reaction_8h.html">gridfire/reaction/reaction.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="building_8h.html">gridfire/engine/types/building.h</a>&quot;</code><br />
<code>#include &quot;fourdst/composition/composition.h&quot;</code><br />
<code>#include &quot;fourdst/composition/composition_abstract.h&quot;</code><br />
<code>#include &lt;variant&gt;</code><br />
<code>#include &quot;<a class="el" href="weak__interpolator_8h.html">gridfire/reaction/weak/weak_interpolator.h</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
@@ -126,44 +129,54 @@ 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="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ad7f0577c2f88caaf0cec6cf80c04892b" id="r_ad7f0577c2f88caaf0cec6cf80c04892b"><td class="memItemLeft" align="right" valign="top">enum class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire.html#ad7f0577c2f88caaf0cec6cf80c04892b">gridfire::NetworkConstructionFlags</a> : uint32_t { <br />
&#160;&#160;<a class="el" href="namespacegridfire.html#ad7f0577c2f88caaf0cec6cf80c04892bab50339a10e1de285ac99d4c3990b8693">gridfire::NONE</a> = 0
, <a class="el" href="namespacegridfire.html#ad7f0577c2f88caaf0cec6cf80c04892ba3dfb3ae3cdaa322f0388f1a531c39520">gridfire::STRONG</a> = 1 &lt;&lt; 0
, <a class="el" href="namespacegridfire.html#ad7f0577c2f88caaf0cec6cf80c04892ba079cbe546b094a3228f3d2308de42371">gridfire::BETA_MINUS</a> = 1 &lt;&lt; 1
, <a class="el" href="namespacegridfire.html#ad7f0577c2f88caaf0cec6cf80c04892baec3e428817690ce788dd410655d44ac7">gridfire::BETA_PLUS</a> = 1 &lt;&lt; 2
<tr class="memitem:a775506bb881280f73264db27cb8388f9" id="r_a775506bb881280f73264db27cb8388f9"><td class="memItemLeft" align="right" valign="top">enum class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1engine.html#a775506bb881280f73264db27cb8388f9">gridfire::engine::NetworkConstructionFlags</a> : uint32_t { <br />
&#160;&#160;<a class="el" href="namespacegridfire_1_1engine.html#a775506bb881280f73264db27cb8388f9ab50339a10e1de285ac99d4c3990b8693">gridfire::engine::NONE</a> = 0
, <a class="el" href="namespacegridfire_1_1engine.html#a775506bb881280f73264db27cb8388f9a3dfb3ae3cdaa322f0388f1a531c39520">gridfire::engine::STRONG</a> = 1 &lt;&lt; 0
, <a class="el" href="namespacegridfire_1_1engine.html#a775506bb881280f73264db27cb8388f9a079cbe546b094a3228f3d2308de42371">gridfire::engine::BETA_MINUS</a> = 1 &lt;&lt; 1
, <a class="el" href="namespacegridfire_1_1engine.html#a775506bb881280f73264db27cb8388f9aec3e428817690ce788dd410655d44ac7">gridfire::engine::BETA_PLUS</a> = 1 &lt;&lt; 2
, <br />
&#160;&#160;<a class="el" href="namespacegridfire.html#ad7f0577c2f88caaf0cec6cf80c04892ba26b6967eb578cb1b08373b342bf72ef7">gridfire::ELECTRON_CAPTURE</a> = 1 &lt;&lt; 3
, <a class="el" href="namespacegridfire.html#ad7f0577c2f88caaf0cec6cf80c04892bae0be5539e1cf1c424806baa62540aa9d">gridfire::POSITRON_CAPTURE</a> = 1 &lt;&lt; 4
, <a class="el" href="namespacegridfire.html#ad7f0577c2f88caaf0cec6cf80c04892bab736eb13fff62c962f63232ec57f2692">gridfire::REACLIB_WEAK</a> = 1 &lt;&lt; 5
, <a class="el" href="namespacegridfire.html#ad7f0577c2f88caaf0cec6cf80c04892bafc9a7c10ff86192133ca7a280783bfe4">gridfire::WRL_WEAK</a> = BETA_MINUS | BETA_PLUS | ELECTRON_CAPTURE | POSITRON_CAPTURE
&#160;&#160;<a class="el" href="namespacegridfire_1_1engine.html#a775506bb881280f73264db27cb8388f9a26b6967eb578cb1b08373b342bf72ef7">gridfire::engine::ELECTRON_CAPTURE</a> = 1 &lt;&lt; 3
, <a class="el" href="namespacegridfire_1_1engine.html#a775506bb881280f73264db27cb8388f9ae0be5539e1cf1c424806baa62540aa9d">gridfire::engine::POSITRON_CAPTURE</a> = 1 &lt;&lt; 4
, <a class="el" href="namespacegridfire_1_1engine.html#a775506bb881280f73264db27cb8388f9ab736eb13fff62c962f63232ec57f2692">gridfire::engine::REACLIB_WEAK</a> = 1 &lt;&lt; 5
, <a class="el" href="namespacegridfire_1_1engine.html#a775506bb881280f73264db27cb8388f9afc9a7c10ff86192133ca7a280783bfe4">gridfire::engine::WRL_WEAK</a> = BETA_MINUS | BETA_PLUS | ELECTRON_CAPTURE | POSITRON_CAPTURE
, <br />
&#160;&#160;<a class="el" href="namespacegridfire.html#ad7f0577c2f88caaf0cec6cf80c04892baf9885ed04411bef7b70f78b643c6a220">gridfire::REACLIB</a> = STRONG | REACLIB_WEAK
, <a class="el" href="namespacegridfire.html#ad7f0577c2f88caaf0cec6cf80c04892ba5b39c8b553c821e7cddc6da64b5bd2ee">gridfire::DEFAULT</a> = REACLIB
, <a class="el" href="namespacegridfire.html#ad7f0577c2f88caaf0cec6cf80c04892ba5fb1f955b45e38e31789286a1790398d">gridfire::ALL</a> = STRONG | WRL_WEAK
&#160;&#160;<a class="el" href="namespacegridfire_1_1engine.html#a775506bb881280f73264db27cb8388f9af9885ed04411bef7b70f78b643c6a220">gridfire::engine::REACLIB</a> = STRONG | REACLIB_WEAK
, <a class="el" href="namespacegridfire_1_1engine.html#a775506bb881280f73264db27cb8388f9a5b39c8b553c821e7cddc6da64b5bd2ee">gridfire::engine::DEFAULT</a> = REACLIB
, <a class="el" href="namespacegridfire_1_1engine.html#a775506bb881280f73264db27cb8388f9a5fb1f955b45e38e31789286a1790398d">gridfire::engine::ALL</a> = STRONG | WRL_WEAK
<br />
}</td></tr>
<tr class="separator:ad7f0577c2f88caaf0cec6cf80c04892b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memdesc:a775506bb881280f73264db27cb8388f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flags to specify which types of nuclear reactions to include when constructing a reaction network. <a href="namespacegridfire_1_1engine.html#a775506bb881280f73264db27cb8388f9">More...</a><br /></td></tr>
<tr class="separator:a775506bb881280f73264db27cb8388f9"><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:a0c42ac7834a0ecb0e36c1e673a403349" id="r_a0c42ac7834a0ecb0e36c1e673a403349"><td class="memItemLeft" align="right" valign="top">constexpr auto&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire.html#a0c42ac7834a0ecb0e36c1e673a403349">gridfire::to_underlying</a> (<a class="el" href="namespacegridfire.html#ad7f0577c2f88caaf0cec6cf80c04892b">NetworkConstructionFlags</a> f) noexcept</td></tr>
<tr class="separator:a0c42ac7834a0ecb0e36c1e673a403349"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1504ccf93263bae031d95d4d3880999e" id="r_a1504ccf93263bae031d95d4d3880999e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacegridfire.html#ad7f0577c2f88caaf0cec6cf80c04892b">NetworkConstructionFlags</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire.html#a1504ccf93263bae031d95d4d3880999e">gridfire::operator|</a> (const <a class="el" href="namespacegridfire.html#ad7f0577c2f88caaf0cec6cf80c04892b">NetworkConstructionFlags</a> lhs, const <a class="el" href="namespacegridfire.html#ad7f0577c2f88caaf0cec6cf80c04892b">NetworkConstructionFlags</a> rhs)</td></tr>
<tr class="separator:a1504ccf93263bae031d95d4d3880999e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6de955e2cf2f0e0241bceabdee69f3f6" id="r_a6de955e2cf2f0e0241bceabdee69f3f6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacegridfire.html#ad7f0577c2f88caaf0cec6cf80c04892b">NetworkConstructionFlags</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire.html#a6de955e2cf2f0e0241bceabdee69f3f6">gridfire::operator&amp;</a> (const <a class="el" href="namespacegridfire.html#ad7f0577c2f88caaf0cec6cf80c04892b">NetworkConstructionFlags</a> lhs, const <a class="el" href="namespacegridfire.html#ad7f0577c2f88caaf0cec6cf80c04892b">NetworkConstructionFlags</a> rhs)</td></tr>
<tr class="separator:a6de955e2cf2f0e0241bceabdee69f3f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5ad8e76156fd708fe6f3bb0f2ad8650b" id="r_a5ad8e76156fd708fe6f3bb0f2ad8650b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire.html#a5ad8e76156fd708fe6f3bb0f2ad8650b">gridfire::has_flag</a> (const <a class="el" href="namespacegridfire.html#ad7f0577c2f88caaf0cec6cf80c04892b">NetworkConstructionFlags</a> flags, const <a class="el" href="namespacegridfire.html#ad7f0577c2f88caaf0cec6cf80c04892b">NetworkConstructionFlags</a> flag_to_check)</td></tr>
<tr class="separator:a5ad8e76156fd708fe6f3bb0f2ad8650b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7c96c92c72485f364466c6b979959ef7" id="r_a7c96c92c72485f364466c6b979959ef7"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire.html#a7c96c92c72485f364466c6b979959ef7">gridfire::NetworkConstructionFlagsToString</a> (<a class="el" href="namespacegridfire.html#ad7f0577c2f88caaf0cec6cf80c04892b">NetworkConstructionFlags</a> flags)</td></tr>
<tr class="separator:a7c96c92c72485f364466c6b979959ef7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0bc156f634a447f88a19de3be961c00b" id="r_a0bc156f634a447f88a19de3be961c00b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgridfire_1_1reaction_1_1_reaction_set.html">reaction::ReactionSet</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire.html#a0bc156f634a447f88a19de3be961c00b">gridfire::build_nuclear_network</a> (const fourdst::composition::Composition &amp;composition, const <a class="el" href="classgridfire_1_1rates_1_1weak_1_1_weak_rate_interpolator.html">rates::weak::WeakRateInterpolator</a> &amp;weakInterpolator, <a class="el" href="namespacegridfire.html#a3b1f70dc7ff5b501809330a97079e4f6">BuildDepthType</a> maxLayers=<a class="el" href="namespacegridfire.html#a0210bd2e07538932135a56b62b8ddb57abbd47109890259c0127154db1af26c75">NetworkBuildDepth::Full</a>, <a class="el" href="namespacegridfire.html#ad7f0577c2f88caaf0cec6cf80c04892b">NetworkConstructionFlags</a> ReactionTypes=<a class="el" href="namespacegridfire.html#ad7f0577c2f88caaf0cec6cf80c04892ba5b39c8b553c821e7cddc6da64b5bd2ee">NetworkConstructionFlags::DEFAULT</a>)</td></tr>
<tr class="memdesc:a0bc156f634a447f88a19de3be961c00b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Builds a nuclear reaction network from the Reaclib library based on an initial composition. <br /></td></tr>
<tr class="separator:a0bc156f634a447f88a19de3be961c00b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a956ff12cef0dda2b9209ceab68199090" id="r_a956ff12cef0dda2b9209ceab68199090"><td class="memItemLeft" align="right" valign="top">constexpr auto&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1engine.html#a956ff12cef0dda2b9209ceab68199090">gridfire::engine::to_underlying</a> (<a class="el" href="namespacegridfire_1_1engine.html#a775506bb881280f73264db27cb8388f9">NetworkConstructionFlags</a> f) noexcept</td></tr>
<tr class="memdesc:a956ff12cef0dda2b9209ceab68199090"><td class="mdescLeft">&#160;</td><td class="mdescRight">Helper function to convert <a class="el" href="namespacegridfire_1_1engine.html#a775506bb881280f73264db27cb8388f9" title="Flags to specify which types of nuclear reactions to include when constructing a reaction network.">NetworkConstructionFlags</a> to their underlying integer type. <br /></td></tr>
<tr class="separator:a956ff12cef0dda2b9209ceab68199090"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a69216b717d99f53cf2d1419e23b69119" id="r_a69216b717d99f53cf2d1419e23b69119"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacegridfire_1_1engine.html#a775506bb881280f73264db27cb8388f9">NetworkConstructionFlags</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1engine.html#a69216b717d99f53cf2d1419e23b69119">gridfire::engine::operator|</a> (const <a class="el" href="namespacegridfire_1_1engine.html#a775506bb881280f73264db27cb8388f9">NetworkConstructionFlags</a> lhs, const <a class="el" href="namespacegridfire_1_1engine.html#a775506bb881280f73264db27cb8388f9">NetworkConstructionFlags</a> rhs)</td></tr>
<tr class="memdesc:a69216b717d99f53cf2d1419e23b69119"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bitwise OR operator for <a class="el" href="namespacegridfire_1_1engine.html#a775506bb881280f73264db27cb8388f9" title="Flags to specify which types of nuclear reactions to include when constructing a reaction network.">NetworkConstructionFlags</a>. <br /></td></tr>
<tr class="separator:a69216b717d99f53cf2d1419e23b69119"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ace3a790fb57920fd12328fa9c5a3a1de" id="r_ace3a790fb57920fd12328fa9c5a3a1de"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacegridfire_1_1engine.html#a775506bb881280f73264db27cb8388f9">NetworkConstructionFlags</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1engine.html#ace3a790fb57920fd12328fa9c5a3a1de">gridfire::engine::operator&amp;</a> (const <a class="el" href="namespacegridfire_1_1engine.html#a775506bb881280f73264db27cb8388f9">NetworkConstructionFlags</a> lhs, const <a class="el" href="namespacegridfire_1_1engine.html#a775506bb881280f73264db27cb8388f9">NetworkConstructionFlags</a> rhs)</td></tr>
<tr class="memdesc:ace3a790fb57920fd12328fa9c5a3a1de"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bitwise AND operator for <a class="el" href="namespacegridfire_1_1engine.html#a775506bb881280f73264db27cb8388f9" title="Flags to specify which types of nuclear reactions to include when constructing a reaction network.">NetworkConstructionFlags</a>. <br /></td></tr>
<tr class="separator:ace3a790fb57920fd12328fa9c5a3a1de"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7377e1152d165cfb9eadc16c5dc2f492" id="r_a7377e1152d165cfb9eadc16c5dc2f492"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1engine.html#a7377e1152d165cfb9eadc16c5dc2f492">gridfire::engine::has_flag</a> (const <a class="el" href="namespacegridfire_1_1engine.html#a775506bb881280f73264db27cb8388f9">NetworkConstructionFlags</a> flags, const <a class="el" href="namespacegridfire_1_1engine.html#a775506bb881280f73264db27cb8388f9">NetworkConstructionFlags</a> flag_to_check)</td></tr>
<tr class="memdesc:a7377e1152d165cfb9eadc16c5dc2f492"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if a specific flag is set within a <a class="el" href="namespacegridfire_1_1engine.html#a775506bb881280f73264db27cb8388f9" title="Flags to specify which types of nuclear reactions to include when constructing a reaction network.">NetworkConstructionFlags</a> value. <br /></td></tr>
<tr class="separator:a7377e1152d165cfb9eadc16c5dc2f492"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aea27cb9ed6d613ae9e4b7fa89767861a" id="r_aea27cb9ed6d613ae9e4b7fa89767861a"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1engine.html#aea27cb9ed6d613ae9e4b7fa89767861a">gridfire::engine::NetworkConstructionFlagsToString</a> (<a class="el" href="namespacegridfire_1_1engine.html#a775506bb881280f73264db27cb8388f9">NetworkConstructionFlags</a> flags)</td></tr>
<tr class="memdesc:aea27cb9ed6d613ae9e4b7fa89767861a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts <a class="el" href="namespacegridfire_1_1engine.html#a775506bb881280f73264db27cb8388f9" title="Flags to specify which types of nuclear reactions to include when constructing a reaction network.">NetworkConstructionFlags</a> to a human-readable string. <br /></td></tr>
<tr class="separator:aea27cb9ed6d613ae9e4b7fa89767861a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7b64607db49cfc042cbee63be5351549" id="r_a7b64607db49cfc042cbee63be5351549"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgridfire_1_1reaction_1_1_reaction_set.html">reaction::ReactionSet</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1engine.html#a7b64607db49cfc042cbee63be5351549">gridfire::engine::build_nuclear_network</a> (const fourdst::composition::CompositionAbstract &amp;composition, const <a class="el" href="classgridfire_1_1rates_1_1weak_1_1_weak_rate_interpolator.html">rates::weak::WeakRateInterpolator</a> &amp;weakInterpolator, <a class="el" href="namespacegridfire_1_1engine.html#a55cd7c313bbfafd5b6a1bcd6329ed99b">BuildDepthType</a> maxLayers=<a class="el" href="namespacegridfire_1_1engine.html#a782fbc9eca00df10e4a204ae6da733e7abbd47109890259c0127154db1af26c75">NetworkBuildDepth::Full</a>, <a class="el" href="namespacegridfire_1_1engine.html#a775506bb881280f73264db27cb8388f9">NetworkConstructionFlags</a> ReactionTypes=<a class="el" href="namespacegridfire_1_1engine.html#a775506bb881280f73264db27cb8388f9a5b39c8b553c821e7cddc6da64b5bd2ee">NetworkConstructionFlags::DEFAULT</a>)</td></tr>
<tr class="memdesc:a7b64607db49cfc042cbee63be5351549"><td class="mdescLeft">&#160;</td><td class="mdescRight">Builds a nuclear reaction network from the Reaclib library based on an initial composition. <br /></td></tr>
<tr class="separator:a7b64607db49cfc042cbee63be5351549"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Functions for constructing nuclear reaction networks. </p>
</div></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->