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

docs(docs): added extensive docs

Browse Source
This commit is contained in:
Emily Boudreaux
2025-07-01 15:06:22 -04:00
parent 5b4db3ea43
commit 131f61c9e7
134 changed files with 5101 additions and 2191 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/html/screening__bare_8cpp_source.html
View File

@@ -137,9 +137,9 @@ $(function(){initNavTree('screening__bare_8cpp_source.html',''); initResizable(t
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> }</div>
</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span>}</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="ttdef"><b>Definition</b> <a href="screening__bare_8h_source.html#l00010">screening_bare.h:10</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="ttdef"><b>Definition</b> <a href="screening__bare_8h_source.html#l00039">screening_bare.h:39</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="ttdef"><b>Definition</b> <a href="#l00022">screening_bare.cpp:22</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="screening__bare_8h_source.html#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="screening__bare_8h_source.html#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="#l00022">screening_bare.cpp:22</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_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="anamespacegridfire_1_1screening_html_ae7dd1a7ccb7bf3c05084094ab008d8a3"><div class="ttname"><a href="namespacegridfire_1_1screening.html#ae7dd1a7ccb7bf3c05084094ab008d8a3">gridfire::screening::ADDouble</a></div><div class="ttdeci">CppAD::AD&lt; double &gt; ADDouble</div><div class="ttdef"><b>Definition</b> <a href="#l00011">screening_bare.cpp:11</a></div></div>