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

12
docs/html/screening__weak_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/screening/screening_weak.h Source File</title>
<title>GridFire: src/include/gridfire/screening/screening_weak.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>
@@ -133,7 +133,7 @@ $(function(){initNavTree('screening__weak_8h_source.html',''); initResizable(tru
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> <span class="keyword">const</span> CppAD::AD&lt;double&gt; rho</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> ) <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"><a class="line" href="classgridfire_1_1screening_1_1_weak_screening_model.html#a0a4d7d6d36dbe7b764b613d34f18386f"> 81</a></span> quill::Logger* <a class="code hl_variable" href="classgridfire_1_1screening_1_1_weak_screening_model.html#a0a4d7d6d36dbe7b764b613d34f18386f">m_logger</a> = fourdst::logging::LogManager::getInstance().getLogger(<span class="stringliteral">&quot;log&quot;</span>);</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"><a class="line" href="classgridfire_1_1screening_1_1_weak_screening_model.html#a0a4d7d6d36dbe7b764b613d34f18386f"> 81</a></span> [[maybe_unused]] quill::Logger* <a class="code hl_variable" href="classgridfire_1_1screening_1_1_weak_screening_model.html#a0a4d7d6d36dbe7b764b613d34f18386f">m_logger</a> = fourdst::logging::LogManager::getInstance().getLogger(<span class="stringliteral">&quot;log&quot;</span>);</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> </div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div>
@@ -156,7 +156,7 @@ $(function(){initNavTree('screening__weak_8h_source.html',''); initResizable(tru
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno"> 145</span> <span class="keyword">const</span> T T9,</div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno"> 146</span> <span class="keyword">const</span> T rho</div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno"> 147</span> )<span class="keyword"> const </span>{</div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno"> 148</span> LOG_TRACE_L1(</div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno"> 148</span> LOG_TRACE_L3(</div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno"> 149</span> <a class="code hl_variable" href="classgridfire_1_1screening_1_1_weak_screening_model.html#a0a4d7d6d36dbe7b764b613d34f18386f">m_logger</a>,</div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno"> 150</span> <span class="stringliteral">&quot;Calculating weak screening factors for {} reactions...&quot;</span>,</div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno"> 151</span> reactions.<a class="code hl_function" href="classgridfire_1_1reaction_1_1_templated_reaction_set.html#a6a1dc3c56690386ae9f6aa5c2aa37ba2">size</a>()</div>
@@ -223,14 +223,14 @@ $(function(){initNavTree('screening__weak_8h_source.html',''); initResizable(tru
</div>
<div class="line"><a id="l00212" name="l00212"></a><span class="lineno"> 212</span> </div>
<div class="line"><a id="l00213" name="l00213"></a><span class="lineno"> 213</span>}</div>
<div class="ttc" id="aclassgridfire_1_1reaction_1_1_templated_reaction_set_html_a6a1dc3c56690386ae9f6aa5c2aa37ba2"><div class="ttname"><a href="classgridfire_1_1reaction_1_1_templated_reaction_set.html#a6a1dc3c56690386ae9f6aa5c2aa37ba2">gridfire::reaction::TemplatedReactionSet::size</a></div><div class="ttdeci">size_t size() const</div><div class="ttdoc">Gets the number of reactions in the set.</div><div class="ttdef"><b>Definition</b> <a href="reaction_8h_source.html#l00453">reaction.h:453</a></div></div>
<div class="ttc" id="aclassgridfire_1_1reaction_1_1_templated_reaction_set_html_a6a1dc3c56690386ae9f6aa5c2aa37ba2"><div class="ttname"><a href="classgridfire_1_1reaction_1_1_templated_reaction_set.html#a6a1dc3c56690386ae9f6aa5c2aa37ba2">gridfire::reaction::TemplatedReactionSet::size</a></div><div class="ttdeci">size_t size() const</div><div class="ttdoc">Gets the number of reactions in the set.</div><div class="ttdef"><b>Definition</b> <a href="reaction_8h_source.html#l00459">reaction.h:459</a></div></div>
<div class="ttc" id="aclassgridfire_1_1screening_1_1_screening_model_html"><div class="ttname"><a href="classgridfire_1_1screening_1_1_screening_model.html">gridfire::screening::ScreeningModel</a></div><div class="ttdoc">An abstract base class for plasma screening models.</div><div class="ttdef"><b>Definition</b> <a href="screening__abstract_8h_source.html#l00027">screening_abstract.h:27</a></div></div>
<div class="ttc" id="aclassgridfire_1_1screening_1_1_weak_screening_model_html"><div class="ttname"><a href="classgridfire_1_1screening_1_1_weak_screening_model.html">gridfire::screening::WeakScreeningModel</a></div><div class="ttdoc">Implements the weak screening model based on the Debye-Hückel approximation.</div><div class="ttdef"><b>Definition</b> <a href="#l00026">screening_weak.h:26</a></div></div>
<div class="ttc" id="aclassgridfire_1_1screening_1_1_weak_screening_model_html_a0a4d7d6d36dbe7b764b613d34f18386f"><div class="ttname"><a href="classgridfire_1_1screening_1_1_weak_screening_model.html#a0a4d7d6d36dbe7b764b613d34f18386f">gridfire::screening::WeakScreeningModel::m_logger</a></div><div class="ttdeci">quill::Logger * m_logger</div><div class="ttdoc">Logger instance for recording trace and debug information.</div><div class="ttdef"><b>Definition</b> <a href="#l00081">screening_weak.h:81</a></div></div>
<div class="ttc" id="aclassgridfire_1_1screening_1_1_weak_screening_model_html_a2695206d46b9d2c2503f8e58c44df88f"><div class="ttname"><a href="classgridfire_1_1screening_1_1_weak_screening_model.html#a2695206d46b9d2c2503f8e58c44df88f">gridfire::screening::WeakScreeningModel::calculateFactors_impl</a></div><div class="ttdeci">std::vector&lt; T &gt; calculateFactors_impl(const reaction::LogicalReactionSet &amp;reactions, const std::vector&lt; fourdst::atomic::Species &gt; &amp;species, const std::vector&lt; T &gt; &amp;Y, const T T9, const T rho) const</div><div class="ttdoc">Template implementation for calculating weak screening factors.</div><div class="ttdef"><b>Definition</b> <a href="#l00141">screening_weak.h:141</a></div></div>
<div class="ttc" id="aclassgridfire_1_1screening_1_1_weak_screening_model_html_afbaeaefe6b3ab3ecf81889ddc1cff76c"><div class="ttname"><a href="classgridfire_1_1screening_1_1_weak_screening_model.html#afbaeaefe6b3ab3ecf81889ddc1cff76c">gridfire::screening::WeakScreeningModel::calculateScreeningFactors</a></div><div class="ttdeci">std::vector&lt; double &gt; calculateScreeningFactors(const reaction::LogicalReactionSet &amp;reactions, const std::vector&lt; fourdst::atomic::Species &gt; &amp;species, const std::vector&lt; double &gt; &amp;Y, const double T9, const double rho) const override</div><div class="ttdoc">Calculates weak screening factors for a set of reactions.</div><div class="ttdef"><b>Definition</b> <a href="screening__weak_8cpp_source.html#l00022">screening_weak.cpp:22</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_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#l00563">reaction.h:563</a></div></div>
<div class="ttc" id="anamespacegridfire_1_1screening_html"><div class="ttname"><a href="namespacegridfire_1_1screening.html">gridfire::screening</a></div><div class="ttdef"><b>Definition</b> <a href="screening__abstract_8h_source.html#l00011">screening_abstract.h:11</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="ascreening__abstract_8h_html"><div class="ttname"><a href="screening__abstract_8h.html">screening_abstract.h</a></div></div>
@@ -239,7 +239,7 @@ $(function(){initNavTree('screening__weak_8h_source.html',''); initResizable(tru
<!-- 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="dir_a1a1065684fbb5b386566d81dc65d72d.html">screening</a></li><li class="navelem"><a class="el" href="screening__weak_8h.html">screening_weak.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="dir_ad59de2d6f32552fa0ecb4acca2fbb0b.html">screening</a></li><li class="navelem"><a class="el" href="screening__weak_8h.html">screening_weak.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>