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

8
docs/html/screening__bare_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_bare.h Source File</title>
<title>GridFire: src/include/gridfire/screening/screening_bare.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>
@@ -154,13 +154,13 @@ $(function(){initNavTree('screening__bare_8h_source.html',''); initResizable(tru
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span> }</div>
</div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</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_bare_screening_model_html"><div class="ttname"><a href="classgridfire_1_1screening_1_1_bare_screening_model.html">gridfire::screening::BareScreeningModel</a></div><div class="ttdoc">A screening model that applies no screening effect.</div><div class="ttdef"><b>Definition</b> <a href="#l00021">screening_bare.h:21</a></div></div>
<div class="ttc" id="aclassgridfire_1_1screening_1_1_bare_screening_model_html_a51119d705267e0b415aae8b4881d8c96"><div class="ttname"><a href="classgridfire_1_1screening_1_1_bare_screening_model.html#a51119d705267e0b415aae8b4881d8c96">gridfire::screening::BareScreeningModel::ADDouble</a></div><div class="ttdeci">CppAD::AD&lt; double &gt; ADDouble</div><div class="ttdoc">Alias for CppAD Automatic Differentiation type for double precision.</div><div class="ttdef"><b>Definition</b> <a href="#l00023">screening_bare.h:23</a></div></div>
<div class="ttc" id="aclassgridfire_1_1screening_1_1_bare_screening_model_html_a6c93b72c8ca34623127f0846d8dee50a"><div class="ttname"><a href="classgridfire_1_1screening_1_1_bare_screening_model.html#a6c93b72c8ca34623127f0846d8dee50a">gridfire::screening::BareScreeningModel::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 screening factors.</div><div class="ttdef"><b>Definition</b> <a href="#l00126">screening_bare.h:126</a></div></div>
<div class="ttc" id="aclassgridfire_1_1screening_1_1_bare_screening_model_html_ac35ad34c5da7e1b5087552aa5c83fe60"><div class="ttname"><a href="classgridfire_1_1screening_1_1_bare_screening_model.html#ac35ad34c5da7e1b5087552aa5c83fe60">gridfire::screening::BareScreeningModel::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 screening factors, which are always 1.0.</div><div class="ttdef"><b>Definition</b> <a href="screening__bare_8cpp_source.html#l00022">screening_bare.cpp:22</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="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>
@@ -169,7 +169,7 @@ $(function(){initNavTree('screening__bare_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__bare_8h.html">screening_bare.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__bare_8h.html">screening_bare.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>