Files
GridFire/docs/html/namespacegridfire_1_1reaclib.html

295 lines
15 KiB
HTML
Raw Normal View History

<!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: gridfire::reaclib Namespace 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">&#160;0.0.1a</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&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(); });
});
/* @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&amp;dn=expat.txt MIT */
$(function(){initNavTree('namespacegridfire_1_1reaclib.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="#nested-classes">Classes</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle"><div class="title">gridfire::reaclib 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">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1reaclib_1_1_reaction_record.html">ReactionRecord</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:a91c7971c9d0a2971b9a6fa4d841c761d" id="r_a91c7971c9d0a2971b9a6fa4d841c761d"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="namespacegridfire_1_1reaction.html#aa86f08712565f278adacc7cd2361eb31">reaction::LogicalReactionSet</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a91c7971c9d0a2971b9a6fa4d841c761d">get_all_reactions</a> ()</td></tr>
<tr class="memdesc:a91c7971c9d0a2971b9a6fa4d841c761d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides global access to the fully initialized REACLIB reaction set. <br /></td></tr>
<tr class="separator:a91c7971c9d0a2971b9a6fa4d841c761d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6bb94d5adc7bb9db5a67f770f7453e63" id="r_a6bb94d5adc7bb9db5a67f770f7453e63"><td class="memItemLeft" align="right" valign="top">std::ostream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6bb94d5adc7bb9db5a67f770f7453e63">operator&lt;&lt;</a> (std::ostream &amp;os, const <a class="el" href="structgridfire_1_1reaclib_1_1_reaction_record.html">ReactionRecord</a> &amp;r)</td></tr>
<tr class="separator:a6bb94d5adc7bb9db5a67f770f7453e63"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afc0deac6cbef076e8884e66fd3ab66e0" id="r_afc0deac6cbef076e8884e66fd3ab66e0"><td class="memItemLeft" align="right" valign="top">static std::vector&lt; fourdst::atomic::Species &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#afc0deac6cbef076e8884e66fd3ab66e0">parseSpeciesString</a> (const std::string_view str)</td></tr>
<tr class="separator:afc0deac6cbef076e8884e66fd3ab66e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a02ff11b88be94392151873e06a30b276" id="r_a02ff11b88be94392151873e06a30b276"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a02ff11b88be94392151873e06a30b276">initializeAllReaclibReactions</a> ()</td></tr>
<tr class="separator:a02ff11b88be94392151873e06a30b276"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:af6ff0dfe7ffe34c73ba9acbab5ef8a66" id="r_af6ff0dfe7ffe34c73ba9acbab5ef8a66"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af6ff0dfe7ffe34c73ba9acbab5ef8a66">s_initialized</a> = false</td></tr>
<tr class="separator:af6ff0dfe7ffe34c73ba9acbab5ef8a66"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5dba5efc372d2a9e9e846dfd6563f3c0" id="r_a5dba5efc372d2a9e9e846dfd6563f3c0"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="namespacegridfire_1_1reaction.html#aa86f08712565f278adacc7cd2361eb31">reaction::LogicalReactionSet</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5dba5efc372d2a9e9e846dfd6563f3c0">s_all_reaclib_reactions_ptr</a> = nullptr</td></tr>
<tr class="separator:a5dba5efc372d2a9e9e846dfd6563f3c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="a91c7971c9d0a2971b9a6fa4d841c761d" name="a91c7971c9d0a2971b9a6fa4d841c761d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a91c7971c9d0a2971b9a6fa4d841c761d">&#9670;&#160;</a></span>get_all_reactions()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="namespacegridfire_1_1reaction.html#aa86f08712565f278adacc7cd2361eb31">reaction::LogicalReactionSet</a> &amp; gridfire::reaclib::get_all_reactions </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides global access to the fully initialized REACLIB reaction set. </p>
<p>This function uses a singleton pattern to ensure the reaction data is loaded from the embedded binary only once, the very first time it is requested.</p>
<dl class="section return"><dt>Returns</dt><dd>A constant reference to the application-wide reaction set. </dd></dl>
<p class="definition">Definition at line <a class="el" href="reaclib_8cpp_source.html#l00138">138</a> of file <a class="el" href="reaclib_8cpp_source.html">reaclib.cpp</a>.</p>
</div>
</div>
<a id="a02ff11b88be94392151873e06a30b276" name="a02ff11b88be94392151873e06a30b276"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a02ff11b88be94392151873e06a30b276">&#9670;&#160;</a></span>initializeAllReaclibReactions()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void gridfire::reaclib::initializeAllReaclibReactions </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel static">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="reaclib_8cpp_source.html#l00079">79</a> of file <a class="el" href="reaclib_8cpp_source.html">reaclib.cpp</a>.</p>
</div>
</div>
<a id="a6bb94d5adc7bb9db5a67f770f7453e63" name="a6bb94d5adc7bb9db5a67f770f7453e63"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6bb94d5adc7bb9db5a67f770f7453e63">&#9670;&#160;</a></span>operator&lt;&lt;()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::ostream &amp; gridfire::reaclib::operator&lt;&lt; </td>
<td>(</td>
<td class="paramtype">std::ostream &amp;</td> <td class="paramname"><span class="paramname"><em>os</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structgridfire_1_1reaclib_1_1_reaction_record.html">ReactionRecord</a> &amp;</td> <td class="paramname"><span class="paramname"><em>r</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="reaclib_8cpp_source.html#l00044">44</a> of file <a class="el" href="reaclib_8cpp_source.html">reaclib.cpp</a>.</p>
</div>
</div>
<a id="afc0deac6cbef076e8884e66fd3ab66e0" name="afc0deac6cbef076e8884e66fd3ab66e0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afc0deac6cbef076e8884e66fd3ab66e0">&#9670;&#160;</a></span>parseSpeciesString()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static std::vector&lt; fourdst::atomic::Species &gt; gridfire::reaclib::parseSpeciesString </td>
<td>(</td>
<td class="paramtype">const std::string_view</td> <td class="paramname"><span class="paramname"><em>str</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel static">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="reaclib_8cpp_source.html#l00058">58</a> of file <a class="el" href="reaclib_8cpp_source.html">reaclib.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a5dba5efc372d2a9e9e846dfd6563f3c0" name="a5dba5efc372d2a9e9e846dfd6563f3c0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5dba5efc372d2a9e9e846dfd6563f3c0">&#9670;&#160;</a></span>s_all_reaclib_reactions_ptr</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacegridfire_1_1reaction.html#aa86f08712565f278adacc7cd2361eb31">reaction::LogicalReactionSet</a>* gridfire::reaclib::s_all_reaclib_reactions_ptr = nullptr</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel static">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="reaclib_8cpp_source.html#l00029">29</a> of file <a class="el" href="reaclib_8cpp_source.html">reaclib.cpp</a>.</p>
</div>
</div>
<a id="af6ff0dfe7ffe34c73ba9acbab5ef8a66" name="af6ff0dfe7ffe34c73ba9acbab5ef8a66"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af6ff0dfe7ffe34c73ba9acbab5ef8a66">&#9670;&#160;</a></span>s_initialized</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool gridfire::reaclib::s_initialized = false</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel static">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="reaclib_8h_source.html#l00007">7</a> of file <a class="el" href="reaclib_8h_source.html">reaclib.h</a>.</p>
</div>
</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="namespacegridfire.html">gridfire</a></li><li class="navelem"><a class="el" href="namespacegridfire_1_1reaclib.html">reaclib</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>