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

docs(docs): rebuilt

Browse Source
This commit is contained in:
Emily Boudreaux
2025-07-31 10:54:31 -04:00
parent 2aaeb6440e
commit 63265a2dc3
271 changed files with 5003 additions and 5941 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/html/structgridfire_1_1_priming_report.html
View File

@@ -110,7 +110,7 @@ $(function(){initNavTree('structgridfire_1_1_priming_report.html',''); initResiz
<p>Captures the result of a network priming operation.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="reporting_8h_source.html">reporting.h</a>&gt;</code></p>
<p><code>#include &lt;reporting.h&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
@@ -134,8 +134,6 @@ Friends</h2></td></tr>
<p>Contains the finalized composition, the changes in mass fractions for species, a success flag, and a detailed status code.</p>
<dl class="section pre"><dt>Precondition</dt><dd>A priming algorithm must be executed before constructing a valid report. </dd></dl>
<dl class="section post"><dt>Postcondition</dt><dd>All fields reflect the outcome of the priming run. </dd></dl>
<p class="definition">Definition at line <a class="el" href="reporting_8h_source.html#l00067">67</a> of file <a class="el" href="reporting_8h_source.html">reporting.h</a>.</p>
</div><h2 class="groupheader">Friends And Related Symbol Documentation</h2>
<a id="ac6c3112c984203fd5a672006be421736" name="ac6c3112c984203fd5a672006be421736"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac6c3112c984203fd5a672006be421736">&#9670;&#160;</a></span>operator&lt;&lt;</h2>
@@ -175,8 +173,6 @@ Friends</h2></td></tr>
<dl class="section return"><dt>Returns</dt><dd>Reference to the modified output stream. </dd></dl>
<dl class="section post"><dt>Postcondition</dt><dd>The stream contains a textual representation of the report. </dd></dl>
<p class="definition">Definition at line <a class="el" href="reporting_8h_source.html#l00089">89</a> of file <a class="el" href="reporting_8h_source.html">reporting.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
@@ -193,8 +189,6 @@ Friends</h2></td></tr>
</div><div class="memdoc">
<p>List of pairs (species, rate change) representing destruction (&lt;0) or creation (&gt;0) rates of species during priming. </p>
<p class="definition">Definition at line <a class="el" href="reporting_8h_source.html#l00074">74</a> of file <a class="el" href="reporting_8h_source.html">reporting.h</a>.</p>
</div>
</div>
<a id="a15032fd3354bd8fb383e13929bbd0ceb" name="a15032fd3354bd8fb383e13929bbd0ceb"></a>
@@ -210,8 +204,6 @@ Friends</h2></td></tr>
</div><div class="memdoc">
<p>Finalized composition after priming. </p>
<p class="definition">Definition at line <a class="el" href="reporting_8h_source.html#l00069">69</a> of file <a class="el" href="reporting_8h_source.html">reporting.h</a>.</p>
</div>
</div>
<a id="a5fec4b465afb4f2d9bc30cd1cab1b50d" name="a5fec4b465afb4f2d9bc30cd1cab1b50d"></a>
@@ -227,8 +219,6 @@ Friends</h2></td></tr>
</div><div class="memdoc">
<p>Detailed status code indicating the result. </p>
<p class="definition">Definition at line <a class="el" href="reporting_8h_source.html#l00078">78</a> of file <a class="el" href="reporting_8h_source.html">reporting.h</a>.</p>
</div>
</div>
<a id="afa4dd791ddd9df84039554524b681fb3" name="afa4dd791ddd9df84039554524b681fb3"></a>
@@ -244,12 +234,10 @@ Friends</h2></td></tr>
</div><div class="memdoc">
<p>True if priming completed without error. </p>
<p class="definition">Definition at line <a class="el" href="reporting_8h_source.html#l00076">76</a> of file <a class="el" href="reporting_8h_source.html">reporting.h</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>src/include/gridfire/engine/types/<a class="el" href="reporting_8h_source.html">reporting.h</a></li>
<li>src/include/gridfire/engine/types/<a class="el" href="reporting_8h.html">reporting.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->