189 lines
17 KiB
HTML
189 lines
17 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
|
<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="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="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>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
|
|
<link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">GridFire<span id="projectnumber"> v0.7.0_rc2</span>
|
|
</div>
|
|
<div id="projectbrief">General Purpose Nuclear Network</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.13.2 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&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&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search',true);
|
|
$(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function(){initNavTree('construction_8h.html',''); initResizable(true); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#namespaces">Namespaces</a> |
|
|
<a href="#enum-members">Enumerations</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<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 "<a class="el" href="reaction_8h.html">gridfire/reaction/reaction.h</a>"</code><br />
|
|
<code>#include "<a class="el" href="building_8h.html">gridfire/engine/types/building.h</a>"</code><br />
|
|
<code>#include "fourdst/composition/composition_abstract.h"</code><br />
|
|
<code>#include <variant></code><br />
|
|
<code>#include "<a class="el" href="weak__interpolator_8h.html">gridfire/reaction/weak/weak_interpolator.h</a>"</code><br />
|
|
</div><div class="textblock"><div class="dynheader">
|
|
Include dependency graph for construction.h:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="construction_8h__incl.svg" width="100%" height="527"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div></div>
|
|
</div>
|
|
</div><div class="textblock"><div class="dynheader">
|
|
This graph shows which files directly or indirectly include this file:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="construction_8h__dep__incl.svg" width="100%" height="600"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div></div>
|
|
</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  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire.html">gridfire</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace  </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"> </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:a775506bb881280f73264db27cb8388f9" id="r_a775506bb881280f73264db27cb8388f9"><td class="memItemLeft" align="right" valign="top">enum class  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1engine.html#a775506bb881280f73264db27cb8388f9">gridfire::engine::NetworkConstructionFlags</a> : uint32_t { <br />
|
|
  <a class="el" href="namespacegridfire_1_1engine.html#a775506bb881280f73264db27cb8388f9ab50339a10e1de285ac99d4c3990b8693">gridfire::engine::NONE</a> = 0
|
|
, <a class="el" href="namespacegridfire_1_1engine.html#a775506bb881280f73264db27cb8388f9a8211eaf8b0f0de1a6b0bf199da5975e1">gridfire::engine::REACLIB_STRONG</a> = 1 << 0
|
|
, <a class="el" href="namespacegridfire_1_1engine.html#a775506bb881280f73264db27cb8388f9a08b95f789a0c024936e08b95c41865c4">gridfire::engine::WRL_BETA_MINUS</a> = 1 << 1
|
|
, <a class="el" href="namespacegridfire_1_1engine.html#a775506bb881280f73264db27cb8388f9a49e3e12f2ea5b0d29df72a8a36f18d4a">gridfire::engine::WRL_BETA_PLUS</a> = 1 << 2
|
|
, <br />
|
|
  <a class="el" href="namespacegridfire_1_1engine.html#a775506bb881280f73264db27cb8388f9af3d03bd75d332304afee1ab36498223e">gridfire::engine::WRL_ELECTRON_CAPTURE</a> = 1 << 3
|
|
, <a class="el" href="namespacegridfire_1_1engine.html#a775506bb881280f73264db27cb8388f9a0712c13f98dca85d8d8bb9606283b955">gridfire::engine::WRL_POSITRON_CAPTURE</a> = 1 << 4
|
|
, <a class="el" href="namespacegridfire_1_1engine.html#a775506bb881280f73264db27cb8388f9ab736eb13fff62c962f63232ec57f2692">gridfire::engine::REACLIB_WEAK</a> = 1 << 5
|
|
, <a class="el" href="namespacegridfire_1_1engine.html#a775506bb881280f73264db27cb8388f9afc9a7c10ff86192133ca7a280783bfe4">gridfire::engine::WRL_WEAK</a> = WRL_BETA_MINUS | WRL_BETA_PLUS | WRL_ELECTRON_CAPTURE | WRL_POSITRON_CAPTURE
|
|
, <br />
|
|
  <a class="el" href="namespacegridfire_1_1engine.html#a775506bb881280f73264db27cb8388f9af9885ed04411bef7b70f78b643c6a220">gridfire::engine::REACLIB</a> = REACLIB_STRONG | REACLIB_WEAK
|
|
, <a class="el" href="namespacegridfire_1_1engine.html#a775506bb881280f73264db27cb8388f9a5b39c8b553c821e7cddc6da64b5bd2ee">gridfire::engine::DEFAULT</a> = REACLIB
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="memdesc:a775506bb881280f73264db27cb8388f9"><td class="mdescLeft"> </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"> </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:a956ff12cef0dda2b9209ceab68199090" id="r_a956ff12cef0dda2b9209ceab68199090"><td class="memItemLeft" align="right" valign="top">constexpr auto </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"> </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"> </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> </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"> </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"> </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> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1engine.html#ace3a790fb57920fd12328fa9c5a3a1de">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:ace3a790fb57920fd12328fa9c5a3a1de"><td class="mdescLeft"> </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"> </td></tr>
|
|
<tr class="memitem:a7377e1152d165cfb9eadc16c5dc2f492" id="r_a7377e1152d165cfb9eadc16c5dc2f492"><td class="memItemLeft" align="right" valign="top">bool </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"> </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"> </td></tr>
|
|
<tr class="memitem:aea27cb9ed6d613ae9e4b7fa89767861a" id="r_aea27cb9ed6d613ae9e4b7fa89767861a"><td class="memItemLeft" align="right" valign="top">std::string </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"> </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"> </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> </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 &composition, const <a class="el" href="classgridfire_1_1rates_1_1weak_1_1_weak_rate_interpolator.html">rates::weak::WeakRateInterpolator</a> &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"> </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"> </td></tr>
|
|
</table>
|
|
<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! -->
|
|
<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>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|