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

11
docs/html/classgridfire_1_1screening_1_1_screening_model.html
View File

@@ -117,8 +117,9 @@ Inheritance diagram for gridfire::screening::ScreeningModel:</div>
<div class="center">
<img src="classgridfire_1_1screening_1_1_screening_model.png" usemap="#gridfire::screening::ScreeningModel_map" alt=""/>
<map id="gridfire::screening::ScreeningModel_map" name="gridfire::screening::ScreeningModel_map">
<area href="classgridfire_1_1screening_1_1_bare_screening_model.html" title="A screening model that applies no screening effect." alt="gridfire::screening::BareScreeningModel" shape="rect" coords="0,56,245,80"/>
<area href="classgridfire_1_1screening_1_1_weak_screening_model.html" title="Implements the weak screening model based on the Debye-Hückel approximation." alt="gridfire::screening::WeakScreeningModel" shape="rect" coords="255,56,500,80"/>
<area href="class_py_screening.html" alt="PyScreening" shape="rect" coords="0,56,245,80"/>
<area href="classgridfire_1_1screening_1_1_bare_screening_model.html" title="A screening model that applies no screening effect." alt="gridfire::screening::BareScreeningModel" shape="rect" coords="255,56,500,80"/>
<area href="classgridfire_1_1screening_1_1_weak_screening_model.html" title="Implements the weak screening model based on the Debye-Hückel approximation." alt="gridfire::screening::WeakScreeningModel" shape="rect" coords="510,56,755,80"/>
</map>
</div></div>
<table class="memberdecls">
@@ -252,7 +253,7 @@ Public Member Functions</h2></td></tr>
<dl class="section return"><dt>Returns</dt><dd>A vector of screening factors (dimensionless), as AD types.</dd></dl>
<p><b>Note</b> This method is essential for including the effects of screening in the Jacobian matrix of the reaction network. </p>
<p>Implemented in <a class="el" href="classgridfire_1_1screening_1_1_bare_screening_model.html#ac5647d633cd5bbd7cb5136b7fa4cad99">gridfire::screening::BareScreeningModel</a>, and <a class="el" href="classgridfire_1_1screening_1_1_weak_screening_model.html#ac6bc78769670a460af1ff88284cb8ad4">gridfire::screening::WeakScreeningModel</a>.</p>
<p>Implemented in <a class="el" href="classgridfire_1_1screening_1_1_bare_screening_model.html#ac5647d633cd5bbd7cb5136b7fa4cad99">gridfire::screening::BareScreeningModel</a>, <a class="el" href="classgridfire_1_1screening_1_1_weak_screening_model.html#ac6bc78769670a460af1ff88284cb8ad4">gridfire::screening::WeakScreeningModel</a>, and <a class="el" href="class_py_screening.html#a5539d59311c778cf7f0006acc8f84ade">PyScreening</a>.</p>
</div>
</div>
@@ -328,12 +329,12 @@ Public Member Functions</h2></td></tr>
<div class="line"> <span class="comment">// ... use screening_factors[i] ...</span></div>
<div class="line">}</div>
</div><!-- fragment -->
<p>Implemented in <a class="el" href="classgridfire_1_1screening_1_1_bare_screening_model.html#ac35ad34c5da7e1b5087552aa5c83fe60">gridfire::screening::BareScreeningModel</a>, and <a class="el" href="classgridfire_1_1screening_1_1_weak_screening_model.html#afbaeaefe6b3ab3ecf81889ddc1cff76c">gridfire::screening::WeakScreeningModel</a>.</p>
<p>Implemented in <a class="el" href="classgridfire_1_1screening_1_1_bare_screening_model.html#ac35ad34c5da7e1b5087552aa5c83fe60">gridfire::screening::BareScreeningModel</a>, <a class="el" href="classgridfire_1_1screening_1_1_weak_screening_model.html#afbaeaefe6b3ab3ecf81889ddc1cff76c">gridfire::screening::WeakScreeningModel</a>, and <a class="el" href="class_py_screening.html#a2b8756c197eb89e77cb6dd231c979315">PyScreening</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/network/include/gridfire/screening/<a class="el" href="screening__abstract_8h_source.html">screening_abstract.h</a></li>
<li>src/include/gridfire/screening/<a class="el" href="screening__abstract_8h_source.html">screening_abstract.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->