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

docs(docs): rebuilt for version v0.7.1_rc2

Browse Source
This commit is contained in:
Emily M. Boudreaux
2025-11-28 09:46:00 -05:00
parent 033c5a083d
commit a472dc5214
2480 changed files with 231104 additions and 76191 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
docs/html/construction_8h.html
View File

@@ -3,18 +3,16 @@
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.13.2"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GridFire: src/include/gridfire/engine/procedures/construction.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
@@ -29,7 +27,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">GridFire<span id="projectnumber">&#160;v0.7.0_rc2</span>
<div id="projectname">GridFire<span id="projectnumber">&#160;v0.7.1_rc2</span>
</div>
<div id="projectbrief">General Purpose Nuclear Network</div>
</td>
@@ -38,24 +36,19 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
@@ -73,7 +66,7 @@ $(function() {
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('construction_8h.html',''); initResizable(true); });
$(document).ready(function(){initNavTree('construction_8h.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
@@ -127,9 +120,9 @@ This graph shows which files directly or indirectly include this file:</div>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
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="memitem:namespacegridfire" id="r_namespacegridfire"><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="memitem:namespacegridfire_1_1engine" id="r_namespacegridfire_1_1engine"><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>
@@ -155,21 +148,21 @@ Enumerations</h2></td></tr>
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></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="memdesc:a956ff12cef0dda2b9209ceab68199090"><td class="mdescLeft">&#160;</td><td class="mdescRight">Helper function to convert NetworkConstructionFlags 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="memdesc:a69216b717d99f53cf2d1419e23b69119"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bitwise OR operator for NetworkConstructionFlags. <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="memdesc:ace3a790fb57920fd12328fa9c5a3a1de"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bitwise AND operator for NetworkConstructionFlags. <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="memdesc:a7377e1152d165cfb9eadc16c5dc2f492"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if a specific flag is set within a NetworkConstructionFlags 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="memdesc:aea27cb9ed6d613ae9e4b7fa89767861a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts NetworkConstructionFlags 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="memitem:a7b64607db49cfc042cbee63be5351549" id="r_a7b64607db49cfc042cbee63be5351549"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgridfire_1_1reaction_1_1ReactionSet.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_1WeakRateInterpolator.html">rates::weak::WeakRateInterpolator</a> &amp;weakInterpolator, <a class="el" href="namespacegridfire_1_1engine.html#a540b6420c7b6271717ec9b640140f6c0">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>
@@ -181,7 +174,7 @@ Functions</h2></td></tr>
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_b0856f6b0d80ccb263b2f415c91f9e17.html">include</a></li><li class="navelem"><a class="el" href="dir_3626e0c0e3c5d7812d6b277dfa4ec364.html">gridfire</a></li><li class="navelem"><a class="el" href="dir_aff155d61c3b73b9ab7dcdc908c4d49e.html">engine</a></li><li class="navelem"><a class="el" href="dir_fedd162cb41c94f7e299c266e75251fd.html">procedures</a></li><li class="navelem"><a class="el" href="construction_8h.html">construction.h</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2 </li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
</ul>
</div>
</body>