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

docs(docs): asdded and cleaned up docs

Browse Source
This commit is contained in:
Emily Boudreaux
2025-07-24 11:10:45 -04:00
parent cc3708fda5
commit ba9b3e2392
808 changed files with 140326 additions and 9346 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/html/network_8h_source.html
View File

@@ -5,7 +5,7 @@
<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/network/include/gridfire/network.h Source File</title>
<title>GridFire: src/include/gridfire/network.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>
@@ -214,10 +214,8 @@ $(function(){initNavTree('network_8h_source.html',''); initResizable(true); });
</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> </div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> </div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> <a class="code hl_typedef" href="namespacegridfire_1_1reaction.html#aa86f08712565f278adacc7cd2361eb31">reaction::LogicalReactionSet</a> <a class="code hl_function" href="namespacegridfire.html#aa77f83539d9ae90e3bf541309bd9c83a">build_reaclib_nuclear_network</a>(<span class="keyword">const</span> fourdst::composition::Composition &amp;composition, <span class="keywordtype">bool</span> reverse);</div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> </div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> </div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span>} <span class="comment">// namespace nuclearNetwork</span></div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> </div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span>} <span class="comment">// namespace nuclearNetwork</span></div>
<div class="ttc" id="aclassgridfire_1_1_network_html_a0bb7c7be9a3c3212ef6dcbf26dcacb16"><div class="ttname"><a href="classgridfire_1_1_network.html#a0bb7c7be9a3c3212ef6dcbf26dcacb16">gridfire::Network::m_logManager</a></div><div class="ttdeci">fourdst::logging::LogManager &amp; m_logManager</div><div class="ttdoc">Log manager instance.</div><div class="ttdef"><b>Definition</b> <a href="#l00097">network.h:97</a></div></div>
<div class="ttc" id="aclassgridfire_1_1_network_html_a20b631f2404bfdec2333f680a62abf55"><div class="ttname"><a href="classgridfire_1_1_network.html#a20b631f2404bfdec2333f680a62abf55">gridfire::Network::Network</a></div><div class="ttdeci">Network(const NetworkFormat format=NetworkFormat::APPROX8)</div><div class="ttdef"><b>Definition</b> <a href="network_8cpp_source.html#l00041">network.cpp:41</a></div></div>
<div class="ttc" id="aclassgridfire_1_1_network_html_a315a123499719178286b29e2aca69118"><div class="ttname"><a href="classgridfire_1_1_network.html#a315a123499719178286b29e2aca69118">gridfire::Network::getFormat</a></div><div class="ttdeci">NetworkFormat getFormat() const</div><div class="ttdef"><b>Definition</b> <a href="network_8cpp_source.html#l00054">network.cpp:54</a></div></div>
@@ -231,14 +229,12 @@ $(function(){initNavTree('network_8h_source.html',''); initResizable(true); });
<div class="ttc" id="aclassgridfire_1_1_network_html_ae93ad65deba79def4b77d420e7affa0b"><div class="ttname"><a href="classgridfire_1_1_network.html#ae93ad65deba79def4b77d420e7affa0b">gridfire::Network::isStiff</a></div><div class="ttdeci">virtual bool isStiff() const</div><div class="ttdef"><b>Definition</b> <a href="#l00092">network.h:92</a></div></div>
<div class="ttc" id="aclassgridfire_1_1_network_html_aefe364ae5af783e19e7b93bfd475566e"><div class="ttname"><a href="classgridfire_1_1_network.html#aefe364ae5af783e19e7b93bfd475566e">gridfire::Network::m_stiff</a></div><div class="ttdeci">bool m_stiff</div><div class="ttdoc">Flag indicating if the network is stiff.</div><div class="ttdef"><b>Definition</b> <a href="#l00103">network.h:103</a></div></div>
<div class="ttc" id="aclassgridfire_1_1_network_html_afc8d5172dd0e2295248b42dcb52b655c"><div class="ttname"><a href="classgridfire_1_1_network.html#afc8d5172dd0e2295248b42dcb52b655c">gridfire::Network::evaluate</a></div><div class="ttdeci">virtual NetOut evaluate(const NetIn &amp;netIn)=0</div><div class="ttdoc">Evaluate the network based on the input parameters.</div></div>
<div class="ttc" id="anamespacegridfire_1_1reaction_html_aa86f08712565f278adacc7cd2361eb31"><div class="ttname"><a href="namespacegridfire_1_1reaction.html#aa86f08712565f278adacc7cd2361eb31">gridfire::reaction::LogicalReactionSet</a></div><div class="ttdeci">TemplatedReactionSet&lt; LogicalReaction &gt; LogicalReactionSet</div><div class="ttdoc">A set of logical reactions.</div><div class="ttdef"><b>Definition</b> <a href="reaction_8h_source.html#l00557">reaction.h:557</a></div></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#l00024">engine_abstract.h:24</a></div></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_a3f3d6b3f9742b70e62049ccefbb60f37"><div class="ttname"><a href="namespacegridfire.html#a3f3d6b3f9742b70e62049ccefbb60f37">gridfire::NetworkFormat</a></div><div class="ttdeci">NetworkFormat</div><div class="ttdef"><b>Definition</b> <a href="#l00041">network.h:41</a></div></div>
<div class="ttc" id="anamespacegridfire_html_a3f3d6b3f9742b70e62049ccefbb60f37a1fc7adf719c40457abfdb8334675faea"><div class="ttname"><a href="namespacegridfire.html#a3f3d6b3f9742b70e62049ccefbb60f37a1fc7adf719c40457abfdb8334675faea">gridfire::APPROX8</a></div><div class="ttdeci">@ APPROX8</div><div class="ttdoc">Approx8 nuclear reaction network format.</div><div class="ttdef"><b>Definition</b> <a href="#l00042">network.h:42</a></div></div>
<div class="ttc" id="anamespacegridfire_html_a3f3d6b3f9742b70e62049ccefbb60f37a9b8db7b445ae4f1bd114caa42a583182"><div class="ttname"><a href="namespacegridfire.html#a3f3d6b3f9742b70e62049ccefbb60f37a9b8db7b445ae4f1bd114caa42a583182">gridfire::REACLIB</a></div><div class="ttdeci">@ REACLIB</div><div class="ttdoc">General REACLIB nuclear reaction network format.</div><div class="ttdef"><b>Definition</b> <a href="#l00043">network.h:43</a></div></div>
<div class="ttc" id="anamespacegridfire_html_a3f3d6b3f9742b70e62049ccefbb60f37aac700abde5f6ff8b7328193eb19697b2"><div class="ttname"><a href="namespacegridfire.html#a3f3d6b3f9742b70e62049ccefbb60f37aac700abde5f6ff8b7328193eb19697b2">gridfire::UNKNOWN</a></div><div class="ttdeci">@ UNKNOWN</div><div class="ttdef"><b>Definition</b> <a href="#l00044">network.h:44</a></div></div>
<div class="ttc" id="anamespacegridfire_html_a4e9cabad30b57d636c2f0d73d8cc6bb4"><div class="ttname"><a href="namespacegridfire.html#a4e9cabad30b57d636c2f0d73d8cc6bb4">gridfire::FormatStringLookup</a></div><div class="ttdeci">static std::unordered_map&lt; NetworkFormat, std::string &gt; FormatStringLookup</div><div class="ttdef"><b>Definition</b> <a href="#l00047">network.h:47</a></div></div>
<div class="ttc" id="anamespacegridfire_html_aa77f83539d9ae90e3bf541309bd9c83a"><div class="ttname"><a href="namespacegridfire.html#aa77f83539d9ae90e3bf541309bd9c83a">gridfire::build_reaclib_nuclear_network</a></div><div class="ttdeci">reaction::LogicalReactionSet build_reaclib_nuclear_network(const fourdst::composition::Composition &amp;composition, bool reverse)</div><div class="ttdef"><b>Definition</b> <a href="network_8cpp_source.html#l00064">network.cpp:64</a></div></div>
<div class="ttc" id="areaction_8h_html"><div class="ttname"><a href="reaction_8h.html">reaction.h</a></div><div class="ttdoc">Defines classes for representing and managing nuclear reactions.</div></div>
<div class="ttc" id="astructgridfire_1_1_net_in_html"><div class="ttname"><a href="structgridfire_1_1_net_in.html">gridfire::NetIn</a></div><div class="ttdef"><b>Definition</b> <a href="#l00053">network.h:53</a></div></div>
<div class="ttc" id="astructgridfire_1_1_net_in_html_a06f0dff9f8927b7cf2da3004c8fa1577"><div class="ttname"><a href="structgridfire_1_1_net_in.html#a06f0dff9f8927b7cf2da3004c8fa1577">gridfire::NetIn::density</a></div><div class="ttdeci">double density</div><div class="ttdoc">Density in g/cm^3.</div><div class="ttdef"><b>Definition</b> <a href="#l00058">network.h:58</a></div></div>
@@ -259,7 +255,7 @@ $(function(){initNavTree('network_8h_source.html',''); initResizable(true); });
<!-- 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_fc4c7f03e1a69a98c370fae55a743828.html">network</a></li><li class="navelem"><a class="el" href="dir_5cccfa813acdf3744b542715860d37b2.html">include</a></li><li class="navelem"><a class="el" href="dir_2a1262ef5950eb718393488a3eb5aa9f.html">gridfire</a></li><li class="navelem"><a class="el" href="network_8h.html">network.h</a></li>
<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="network_8h.html">network.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>