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

docs(docs): rebuild with more usage examples

Browse Source
This commit is contained in:
Emily Boudreaux
2025-07-30 15:12:46 -04:00
parent 24870ffcbc
commit cd60ae5c1e
79 changed files with 5050 additions and 4496 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
docs/html/namespacegridfire.html
View File

@@ -265,8 +265,6 @@ Functions</h2></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:afd6f117eb2da3bab3873edc09d0926cf" id="r_afd6f117eb2da3bab3873edc09d0926cf"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#afd6f117eb2da3bab3873edc09d0926cf">s_debug</a> = false</td></tr>
<tr class="separator:afd6f117eb2da3bab3873edc09d0926cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ada3c137c014ecd8d06200fea2d1a9f50" id="r_ada3c137c014ecd8d06200fea2d1a9f50"><td class="memItemLeft" align="right" valign="top">static constexpr double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ada3c137c014ecd8d06200fea2d1a9f50">MIN_DENSITY_THRESHOLD</a> = 1e-18</td></tr>
<tr class="memdesc:ada3c137c014ecd8d06200fea2d1a9f50"><td class="mdescLeft">&#160;</td><td class="mdescRight">Minimum density threshold below which reactions are ignored. <br /></td></tr>
<tr class="separator:ada3c137c014ecd8d06200fea2d1a9f50"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -300,7 +298,7 @@ Variables</h2></td></tr>
<p>Alias for CppAD AD type for double precision. </p>
<p>This alias simplifies the use of the CppAD automatic differentiation type. </p>
<p class="definition">Definition at line <a class="el" href="engine__graph_8h_source.html#l00045">45</a> of file <a class="el" href="engine__graph_8h_source.html">engine_graph.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="engine__graph_8h_source.html#l00044">44</a> of file <a class="el" href="engine__graph_8h_source.html">engine_graph.h</a>.</p>
</div>
</div>
@@ -824,7 +822,7 @@ Resolved integer depth from maxLayers must not be zero. </dd></dl>
<p>Minimum abundance threshold below which species are ignored. </p>
<p>Species with abundances below this threshold are treated as zero in reaction rate calculations. This helps to improve performance by avoiding unnecessary calculations for trace species. </p>
<p class="definition">Definition at line <a class="el" href="engine__graph_8h_source.html#l00067">67</a> of file <a class="el" href="engine__graph_8h_source.html">engine_graph.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="engine__graph_8h_source.html#l00066">66</a> of file <a class="el" href="engine__graph_8h_source.html">engine_graph.h</a>.</p>
</div>
</div>
@@ -851,7 +849,7 @@ Resolved integer depth from maxLayers must not be zero. </dd></dl>
<p>Minimum density threshold below which reactions are ignored. </p>
<p>Reactions are not calculated if the density falls below this threshold. This helps to improve performance by avoiding unnecessary calculations in very low-density regimes. </p>
<p class="definition">Definition at line <a class="el" href="engine__graph_8h_source.html#l00058">58</a> of file <a class="el" href="engine__graph_8h_source.html">engine_graph.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="engine__graph_8h_source.html#l00057">57</a> of file <a class="el" href="engine__graph_8h_source.html">engine_graph.h</a>.</p>
</div>
</div>
@@ -878,7 +876,7 @@ Resolved integer depth from maxLayers must not be zero. </dd></dl>
<p>Minimum value for Jacobian matrix entries. </p>
<p>Jacobian matrix entries with absolute values below this threshold are treated as zero to maintain sparsity and improve performance. </p>
<p class="definition">Definition at line <a class="el" href="engine__graph_8h_source.html#l00075">75</a> of file <a class="el" href="engine__graph_8h_source.html">engine_graph.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="engine__graph_8h_source.html#l00074">74</a> of file <a class="el" href="engine__graph_8h_source.html">engine_graph.h</a>.</p>
</div>
</div>
@@ -923,30 +921,6 @@ Resolved integer depth from maxLayers must not be zero. </dd></dl>
<p class="definition">Definition at line <a class="el" href="reporting_8h_source.html#l00047">47</a> of file <a class="el" href="reporting_8h_source.html">reporting.h</a>.</p>
</div>
</div>
<a id="afd6f117eb2da3bab3873edc09d0926cf" name="afd6f117eb2da3bab3873edc09d0926cf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afd6f117eb2da3bab3873edc09d0926cf">&#9670;&#160;</a></span>s_debug</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool gridfire::s_debug = false</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel static">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="engine__graph_8h_source.html#l00039">39</a> of file <a class="el" href="engine__graph_8h_source.html">engine_graph.h</a>.</p>
</div>
</div>
<a id="a8b632637f62614f509cde0e404a79054" name="a8b632637f62614f509cde0e404a79054"></a>