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

74
docs/html/network_8cpp_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/lib/network.cpp Source File</title>
<title>GridFire: src/lib/network.cpp 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>
@@ -173,53 +173,25 @@ $(function(){initNavTree('network_8cpp_source.html',''); initResizable(true); })
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> }</div>
</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> </div>
<div class="foldopen" id="foldopen00064" data-start="{" data-end="}">
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"><a class="line" href="namespacegridfire.html#aa77f83539d9ae90e3bf541309bd9c83a"> 64</a></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="l00065" name="l00065"></a><span class="lineno"> 65</span> <span class="keyword">using namespace </span><a class="code hl_namespace" href="namespacegridfire_1_1reaction.html">reaction</a>;</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> std::vector&lt;Reaction&gt; reaclibReactions;</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> <span class="keyword">auto</span> logger = fourdst::logging::LogManager::getInstance().getLogger(<span class="stringliteral">&quot;log&quot;</span>);</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> <span class="comment">// Trim whitespace from both ends of a string</span></div>
<div class="foldopen" id="foldopen00065" data-start="{" data-end="}">
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"><a class="line" href="namespacegridfire.html#a8b245f261cd8d1711ae8d593b054cf98"> 65</a></span> std::string <a class="code hl_function" href="namespacegridfire.html#a8b245f261cd8d1711ae8d593b054cf98">trim_whitespace</a>(<span class="keyword">const</span> std::string&amp; str) {</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> <span class="keyword">auto</span> startIt = str.begin();</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> <span class="keyword">const</span> <span class="keyword">auto</span> endIt = str.end();</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> </div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> <span class="keywordflow">for</span> (<span class="keyword">const</span> <span class="keyword">auto</span> &amp;<a class="code hl_namespace" href="namespacegridfire_1_1reaction.html">reaction</a>: <a class="code hl_function" href="namespacegridfire_1_1reaclib.html#a91c7971c9d0a2971b9a6fa4d841c761d">reaclib::get_all_reactions</a>()) {</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> <span class="keywordflow">if</span> (<a class="code hl_namespace" href="namespacegridfire_1_1reaction.html">reaction</a>.is_reverse() != reverse) {</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> <span class="keywordflow">continue</span>; <span class="comment">// Skip reactions that do not match the requested direction</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> }</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> <span class="keywordtype">bool</span> gotReaction = <span class="keyword">true</span>;</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> <span class="keyword">const</span> <span class="keyword">auto</span>&amp; reactants = <a class="code hl_namespace" href="namespacegridfire_1_1reaction.html">reaction</a>.reactants();</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <span class="keywordflow">for</span> (<span class="keyword">const</span> <span class="keyword">auto</span>&amp; reactant : reactants) {</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> <span class="keywordflow">if</span> (!composition.contains(reactant)) {</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> gotReaction = <span class="keyword">false</span>;</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> <span class="keywordflow">break</span>; <span class="comment">// If any reactant is not in the composition, skip this reaction</span></div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> }</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> }</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> <span class="keywordflow">if</span> (gotReaction) {</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> LOG_TRACE_L3(logger, <span class="stringliteral">&quot;Adding reaction {} to REACLIB reaction set.&quot;</span>, <a class="code hl_namespace" href="namespacegridfire_1_1reaction.html">reaction</a>.peName());</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> reaclibReactions.push_back(<a class="code hl_namespace" href="namespacegridfire_1_1reaction.html">reaction</a>);</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> }</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> }</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> <span class="keyword">const</span> ReactionSet reactionSet(reaclibReactions);</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> <span class="keywordflow">return</span> packReactionSetToLogicalReactionSet(reactionSet);</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> }</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> <span class="keywordflow">while</span> (startIt != endIt &amp;&amp; std::isspace(<span class="keyword">static_cast&lt;</span><span class="keywordtype">unsigned</span> <span class="keywordtype">char</span><span class="keyword">&gt;</span>(*startIt))) {</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> ++startIt;</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> }</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> <span class="keywordflow">if</span> (startIt == endIt) {</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> <span class="keywordflow">return</span> <span class="stringliteral">&quot;&quot;</span>;</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> }</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <span class="keyword">const</span> <span class="keyword">auto</span> ritr = std::find_if(str.rbegin(), std::string::const_reverse_iterator(startIt),</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> [](<span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> ch){ return !std::isspace(ch); });</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> <span class="keywordflow">return</span> std::string(startIt, ritr.base());</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> }</div>
</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> </div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> <span class="comment">// Trim whitespace from both ends of a string</span></div>
<div class="foldopen" id="foldopen00091" data-start="{" data-end="}">
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"><a class="line" href="namespacegridfire.html#a8b245f261cd8d1711ae8d593b054cf98"> 91</a></span> std::string <a class="code hl_function" href="namespacegridfire.html#a8b245f261cd8d1711ae8d593b054cf98">trim_whitespace</a>(<span class="keyword">const</span> std::string&amp; str) {</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> <span class="keyword">auto</span> startIt = str.begin();</div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> <span class="keyword">auto</span> endIt = str.end();</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> </div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> <span class="keywordflow">while</span> (startIt != endIt &amp;&amp; std::isspace(<span class="keyword">static_cast&lt;</span><span class="keywordtype">unsigned</span> <span class="keywordtype">char</span><span class="keyword">&gt;</span>(*startIt))) {</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> ++startIt;</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> }</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> <span class="keywordflow">if</span> (startIt == endIt) {</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> <span class="keywordflow">return</span> <span class="stringliteral">&quot;&quot;</span>;</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> }</div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> <span class="keyword">auto</span> ritr = std::find_if(str.rbegin(), std::string::const_reverse_iterator(startIt),</div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> [](<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> ch){ return !std::isspace(ch); });</div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> <span class="keywordflow">return</span> std::string(startIt, ritr.base());</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> }</div>
</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="l00079" name="l00079"></a><span class="lineno"> 79</span> </div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</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="network_8h_source.html#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="#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="#l00054">network.cpp:54</a></div></div>
@@ -228,14 +200,10 @@ $(function(){initNavTree('network_8cpp_source.html',''); initResizable(true); })
<div class="ttc" id="aclassgridfire_1_1_network_html_a960d309defc570f92d296ce4b93920e5"><div class="ttname"><a href="classgridfire_1_1_network.html#a960d309defc570f92d296ce4b93920e5">gridfire::Network::m_logger</a></div><div class="ttdeci">quill::Logger * m_logger</div><div class="ttdoc">Logger instance.</div><div class="ttdef"><b>Definition</b> <a href="network_8h_source.html#l00098">network.h:98</a></div></div>
<div class="ttc" id="aclassgridfire_1_1_network_html_a9f8802012728ef5fea0e8cd465044e09"><div class="ttname"><a href="classgridfire_1_1_network.html#a9f8802012728ef5fea0e8cd465044e09">gridfire::Network::m_config</a></div><div class="ttdeci">fourdst::config::Config &amp; m_config</div><div class="ttdoc">Configuration instance.</div><div class="ttdef"><b>Definition</b> <a href="network_8h_source.html#l00096">network.h:96</a></div></div>
<div class="ttc" id="aclassgridfire_1_1_network_html_adf7002883160101c9f9d1b376b265410"><div class="ttname"><a href="classgridfire_1_1_network.html#adf7002883160101c9f9d1b376b265410">gridfire::Network::m_constants</a></div><div class="ttdeci">fourdst::constant::Constants &amp; m_constants</div><div class="ttdef"><b>Definition</b> <a href="network_8h_source.html#l00101">network.h:101</a></div></div>
<div class="ttc" id="anamespacegridfire_1_1reaclib_html_a91c7971c9d0a2971b9a6fa4d841c761d"><div class="ttname"><a href="namespacegridfire_1_1reaclib.html#a91c7971c9d0a2971b9a6fa4d841c761d">gridfire::reaclib::get_all_reactions</a></div><div class="ttdeci">const reaction::LogicalReactionSet &amp; get_all_reactions()</div><div class="ttdoc">Provides global access to the fully initialized REACLIB reaction set.</div><div class="ttdef"><b>Definition</b> <a href="reaclib_8cpp_source.html#l00138">reaclib.cpp:138</a></div></div>
<div class="ttc" id="anamespacegridfire_1_1reaction_html"><div class="ttname"><a href="namespacegridfire_1_1reaction.html">gridfire::reaction</a></div><div class="ttdef"><b>Definition</b> <a href="reaction_8h_source.html#l00025">reaction.h:25</a></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="network_8h_source.html#l00041">network.h:41</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="network_8h_source.html#l00044">network.h:44</a></div></div>
<div class="ttc" id="anamespacegridfire_html_a8b245f261cd8d1711ae8d593b054cf98"><div class="ttname"><a href="namespacegridfire.html#a8b245f261cd8d1711ae8d593b054cf98">gridfire::trim_whitespace</a></div><div class="ttdeci">std::string trim_whitespace(const std::string &amp;str)</div><div class="ttdef"><b>Definition</b> <a href="#l00091">network.cpp:91</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="#l00064">network.cpp:64</a></div></div>
<div class="ttc" id="anamespacegridfire_html_a8b245f261cd8d1711ae8d593b054cf98"><div class="ttname"><a href="namespacegridfire.html#a8b245f261cd8d1711ae8d593b054cf98">gridfire::trim_whitespace</a></div><div class="ttdeci">std::string trim_whitespace(const std::string &amp;str)</div><div class="ttdef"><b>Definition</b> <a href="#l00065">network.cpp:65</a></div></div>
<div class="ttc" id="anetwork_8h_html"><div class="ttname"><a href="network_8h.html">network.h</a></div></div>
<div class="ttc" id="areaclib_8h_html"><div class="ttname"><a href="reaclib_8h.html">reaclib.h</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>
@@ -246,7 +214,7 @@ $(function(){initNavTree('network_8cpp_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_a7655658c851688eff9381235a9676f0.html">lib</a></li><li class="navelem"><a class="el" href="network_8cpp.html">network.cpp</a></li>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_c85d3e3c5052e9ad9ce18c6863244a25.html">lib</a></li><li class="navelem"><a class="el" href="network_8cpp.html">network.cpp</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>