docs(docs): asdded and cleaned up docs

This commit is contained in:
2025-07-24 11:10:45 -04:00
parent cc3708fda5
commit ba9b3e2392
808 changed files with 140326 additions and 9346 deletions

View File

@@ -117,10 +117,13 @@ Public Attributes</h2></td></tr>
<tr class="memitem:a8bea6e348699c1aea93d17bb56739306" id="r_a8bea6e348699c1aea93d17bb56739306"><td class="memItemLeft" align="right" valign="top">const double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8bea6e348699c1aea93d17bb56739306">c</a> = Constants::getInstance().get(&quot;c&quot;).value</td></tr>
<tr class="memdesc:a8bea6e348699c1aea93d17bb56739306"><td class="mdescLeft">&#160;</td><td class="mdescRight">Speed of light in cm/s. <br /></td></tr>
<tr class="separator:a8bea6e348699c1aea93d17bb56739306"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a29c8ae2b5c1d5fecd25c4fde2b623f7f" id="r_a29c8ae2b5c1d5fecd25c4fde2b623f7f"><td class="memItemLeft" align="right" valign="top">const double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a29c8ae2b5c1d5fecd25c4fde2b623f7f">kB</a> = Constants::getInstance().get(&quot;kB&quot;).value</td></tr>
<tr class="memdesc:a29c8ae2b5c1d5fecd25c4fde2b623f7f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Boltzmann constant in erg/K. <br /></td></tr>
<tr class="separator:a29c8ae2b5c1d5fecd25c4fde2b623f7f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="engine__graph_8h_source.html#l00320">320</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#l00400">400</a> of file <a class="el" href="engine__graph_8h_source.html">engine_graph.h</a>.</p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="a8bea6e348699c1aea93d17bb56739306" name="a8bea6e348699c1aea93d17bb56739306"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8bea6e348699c1aea93d17bb56739306">&#9670;&#160;</a></span>c</h2>
@@ -136,7 +139,25 @@ Public Attributes</h2></td></tr>
<p>Speed of light in cm/s. </p>
<p class="definition">Definition at line <a class="el" href="engine__graph_8h_source.html#l00323">323</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#l00403">403</a> of file <a class="el" href="engine__graph_8h_source.html">engine_graph.h</a>.</p>
</div>
</div>
<a id="a29c8ae2b5c1d5fecd25c4fde2b623f7f" name="a29c8ae2b5c1d5fecd25c4fde2b623f7f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a29c8ae2b5c1d5fecd25c4fde2b623f7f">&#9670;&#160;</a></span>kB</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const double gridfire::GraphEngine::constants::kB = Constants::getInstance().get(&quot;kB&quot;).value</td>
</tr>
</table>
</div><div class="memdoc">
<p>Boltzmann constant in erg/K. </p>
<p class="definition">Definition at line <a class="el" href="engine__graph_8h_source.html#l00404">404</a> of file <a class="el" href="engine__graph_8h_source.html">engine_graph.h</a>.</p>
</div>
</div>
@@ -154,7 +175,7 @@ Public Attributes</h2></td></tr>
<p>Avogadro's number. </p>
<p class="definition">Definition at line <a class="el" href="engine__graph_8h_source.html#l00322">322</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#l00402">402</a> of file <a class="el" href="engine__graph_8h_source.html">engine_graph.h</a>.</p>
</div>
</div>
@@ -172,12 +193,12 @@ Public Attributes</h2></td></tr>
<p>Atomic mass unit in g. </p>
<p class="definition">Definition at line <a class="el" href="engine__graph_8h_source.html#l00321">321</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#l00401">401</a> of file <a class="el" href="engine__graph_8h_source.html">engine_graph.h</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>src/network/include/gridfire/engine/<a class="el" href="engine__graph_8h_source.html">engine_graph.h</a></li>
<li>src/include/gridfire/engine/<a class="el" href="engine__graph_8h_source.html">engine_graph.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->