tboudreaux/GridFire
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
75a88b97207e31ec8695e619f5392ccbcc6af3ab
GridFire/docs/html/building_8h_source.html

145 lines
12 KiB
HTML
Raw Normal View History

docs(docs): asdded and cleaned up docs
2025-07-24 11:10:45 -04:00
<!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/types/building.h Source File</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('building_8h_source.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="headertitle"><div class="title">building.h</div></div>
</div><!--header-->
<div class="contents">
<a href="building_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span> </div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#include &lt;variant&gt;</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span> </div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacegridfire.html">gridfire</a> {</div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span></div>
<div class="foldopen" id="foldopen00021" data-start="{" data-end="};">
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"><a class="line" href="namespacegridfire.html#a0210bd2e07538932135a56b62b8ddb57"> 21</a></span> <span class="keyword">enum class</span> <a class="code hl_enumeration" href="namespacegridfire.html#a0210bd2e07538932135a56b62b8ddb57">NetworkBuildDepth</a> {</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"><a class="line" href="namespacegridfire.html#a0210bd2e07538932135a56b62b8ddb57abbd47109890259c0127154db1af26c75"> 22</a></span> <a class="code hl_enumvalue" href="namespacegridfire.html#a0210bd2e07538932135a56b62b8ddb57abbd47109890259c0127154db1af26c75">Full</a> = -1,</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"><a class="line" href="namespacegridfire.html#a0210bd2e07538932135a56b62b8ddb57a928d0f1285ee7d36c1c2fa1b1b7a164c"> 23</a></span> <a class="code hl_enumvalue" href="namespacegridfire.html#a0210bd2e07538932135a56b62b8ddb57a928d0f1285ee7d36c1c2fa1b1b7a164c">Shallow</a> = 1,</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"><a class="line" href="namespacegridfire.html#a0210bd2e07538932135a56b62b8ddb57a264572d66aed5373d19dc80c7cde1f46"> 24</a></span> <a class="code hl_enumvalue" href="namespacegridfire.html#a0210bd2e07538932135a56b62b8ddb57a264572d66aed5373d19dc80c7cde1f46">SecondOrder</a> = 2,</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"><a class="line" href="namespacegridfire.html#a0210bd2e07538932135a56b62b8ddb57a3fc719e07f9f63e7f11a3d4fb74b476f"> 25</a></span> <a class="code hl_enumvalue" href="namespacegridfire.html#a0210bd2e07538932135a56b62b8ddb57a3fc719e07f9f63e7f11a3d4fb74b476f">ThirdOrder</a> = 3,</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"><a class="line" href="namespacegridfire.html#a0210bd2e07538932135a56b62b8ddb57a100e3bf0197221c19b222badf42aa964"> 26</a></span> <a class="code hl_enumvalue" href="namespacegridfire.html#a0210bd2e07538932135a56b62b8ddb57a100e3bf0197221c19b222badf42aa964">FourthOrder</a> = 4,</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"><a class="line" href="namespacegridfire.html#a0210bd2e07538932135a56b62b8ddb57a5105376c2b90747e00bed5bf2953dd56"> 27</a></span> <a class="code hl_enumvalue" href="namespacegridfire.html#a0210bd2e07538932135a56b62b8ddb57a5105376c2b90747e00bed5bf2953dd56">FifthOrder</a> = 5</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> };</div>
</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"><a class="line" href="namespacegridfire.html#a3b1f70dc7ff5b501809330a97079e4f6"> 37</a></span> <span class="keyword">using </span><a class="code hl_typedef" href="namespacegridfire.html#a3b1f70dc7ff5b501809330a97079e4f6">BuildDepthType</a> = std::variant&lt;NetworkBuildDepth, int&gt;;</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span>}</div>
<div class="ttc" id="anamespacegridfire_html"><div class="ttname"><a href="namespacegridfire.html">gridfire</a></div><div class="ttdef"><b>Definition</b> <a href="engine__abstract_8h_source.html#l00031">engine_abstract.h:31</a></div></div>
<div class="ttc" id="anamespacegridfire_html_a0210bd2e07538932135a56b62b8ddb57"><div class="ttname"><a href="namespacegridfire.html#a0210bd2e07538932135a56b62b8ddb57">gridfire::NetworkBuildDepth</a></div><div class="ttdeci">NetworkBuildDepth</div><div class="ttdoc">Specifies supported depths for building the reaction network.</div><div class="ttdef"><b>Definition</b> <a href="#l00021">building.h:21</a></div></div>
<div class="ttc" id="anamespacegridfire_html_a0210bd2e07538932135a56b62b8ddb57a100e3bf0197221c19b222badf42aa964"><div class="ttname"><a href="namespacegridfire.html#a0210bd2e07538932135a56b62b8ddb57a100e3bf0197221c19b222badf42aa964">gridfire::NetworkBuildDepth::FourthOrder</a></div><div class="ttdeci">@ FourthOrder</div><div class="ttdef"><b>Definition</b> <a href="#l00026">building.h:26</a></div></div>
<div class="ttc" id="anamespacegridfire_html_a0210bd2e07538932135a56b62b8ddb57a264572d66aed5373d19dc80c7cde1f46"><div class="ttname"><a href="namespacegridfire.html#a0210bd2e07538932135a56b62b8ddb57a264572d66aed5373d19dc80c7cde1f46">gridfire::NetworkBuildDepth::SecondOrder</a></div><div class="ttdeci">@ SecondOrder</div><div class="ttdef"><b>Definition</b> <a href="#l00024">building.h:24</a></div></div>
<div class="ttc" id="anamespacegridfire_html_a0210bd2e07538932135a56b62b8ddb57a3fc719e07f9f63e7f11a3d4fb74b476f"><div class="ttname"><a href="namespacegridfire.html#a0210bd2e07538932135a56b62b8ddb57a3fc719e07f9f63e7f11a3d4fb74b476f">gridfire::NetworkBuildDepth::ThirdOrder</a></div><div class="ttdeci">@ ThirdOrder</div><div class="ttdef"><b>Definition</b> <a href="#l00025">building.h:25</a></div></div>
<div class="ttc" id="anamespacegridfire_html_a0210bd2e07538932135a56b62b8ddb57a5105376c2b90747e00bed5bf2953dd56"><div class="ttname"><a href="namespacegridfire.html#a0210bd2e07538932135a56b62b8ddb57a5105376c2b90747e00bed5bf2953dd56">gridfire::NetworkBuildDepth::FifthOrder</a></div><div class="ttdeci">@ FifthOrder</div><div class="ttdef"><b>Definition</b> <a href="#l00027">building.h:27</a></div></div>
<div class="ttc" id="anamespacegridfire_html_a0210bd2e07538932135a56b62b8ddb57a928d0f1285ee7d36c1c2fa1b1b7a164c"><div class="ttname"><a href="namespacegridfire.html#a0210bd2e07538932135a56b62b8ddb57a928d0f1285ee7d36c1c2fa1b1b7a164c">gridfire::NetworkBuildDepth::Shallow</a></div><div class="ttdeci">@ Shallow</div><div class="ttdef"><b>Definition</b> <a href="#l00023">building.h:23</a></div></div>
<div class="ttc" id="anamespacegridfire_html_a0210bd2e07538932135a56b62b8ddb57abbd47109890259c0127154db1af26c75"><div class="ttname"><a href="namespacegridfire.html#a0210bd2e07538932135a56b62b8ddb57abbd47109890259c0127154db1af26c75">gridfire::NetworkBuildDepth::Full</a></div><div class="ttdeci">@ Full</div><div class="ttdef"><b>Definition</b> <a href="#l00022">building.h:22</a></div></div>
<div class="ttc" id="anamespacegridfire_html_a3b1f70dc7ff5b501809330a97079e4f6"><div class="ttname"><a href="namespacegridfire.html#a3b1f70dc7ff5b501809330a97079e4f6">gridfire::BuildDepthType</a></div><div class="ttdeci">std::variant&lt; NetworkBuildDepth, int &gt; BuildDepthType</div><div class="ttdoc">Variant specifying either a predefined NetworkBuildDepth or a custom integer depth.</div><div class="ttdef"><b>Definition</b> <a href="#l00037">building.h:37</a></div></div>
</div><!-- fragment --></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_80d0745b866022f2047f807b3376dff7.html">types</a></li><li class="navelem"><a class="el" href="building_8h.html">building.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>
Reference in New Issue Copy Permalink