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

16
docs/html/logging_8h_source.html
View File

@@ -111,18 +111,18 @@ $(function(){initNavTree('logging_8h_source.html',''); initResizable(true); });
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
<div class="foldopen" id="foldopen00008" data-start="{" data-end="}">
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"><a class="line" href="namespacegridfire_1_1utils.html"> 8</a></span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacegridfire_1_1utils.html">gridfire::utils</a> {</div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> std::string <a class="code hl_function" href="namespacegridfire_1_1utils.html#af56693a70d9e2b40c8ae2c3bcd4b26c8">formatNuclearTimescaleLogString</a>(</div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> <span class="keyword">const</span> <a class="code hl_class" href="classgridfire_1_1_dynamic_engine.html">DynamicEngine</a>&amp; engine,</div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> <span class="keyword">const</span> std::vector&lt;double&gt;&amp; Y,</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> <span class="keyword">const</span> <span class="keywordtype">double</span> T9,</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> <span class="keyword">const</span> <span class="keywordtype">double</span> rho</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> );</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span>}</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> std::string <a class="code hl_function" href="namespacegridfire_1_1utils.html#af56693a70d9e2b40c8ae2c3bcd4b26c8">formatNuclearTimescaleLogString</a>(</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> <span class="keyword">const</span> <a class="code hl_class" href="classgridfire_1_1_dynamic_engine.html">DynamicEngine</a>&amp; engine,</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> <span class="keyword">const</span> std::vector&lt;double&gt;&amp; Y,</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> <span class="keyword">const</span> <span class="keywordtype">double</span> T9,</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> <span class="keyword">const</span> <span class="keywordtype">double</span> rho</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> );</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span>}</div>
</div>
<div class="ttc" id="aclassgridfire_1_1_dynamic_engine_html"><div class="ttname"><a href="classgridfire_1_1_dynamic_engine.html">gridfire::DynamicEngine</a></div><div class="ttdoc">Abstract class for engines supporting Jacobian and stoichiometry operations.</div><div class="ttdef"><b>Definition</b> <a href="engine__abstract_8h_source.html#l00121">engine_abstract.h:121</a></div></div>
<div class="ttc" id="aengine__abstract_8h_html"><div class="ttname"><a href="engine__abstract_8h.html">engine_abstract.h</a></div><div class="ttdoc">Abstract interfaces for reaction network engines in GridFire.</div></div>
<div class="ttc" id="anamespacegridfire_1_1utils_html"><div class="ttname"><a href="namespacegridfire_1_1utils.html">gridfire::utils</a></div><div class="ttdef"><b>Definition</b> <a href="#l00008">logging.h:8</a></div></div>
<div class="ttc" id="anamespacegridfire_1_1utils_html_af56693a70d9e2b40c8ae2c3bcd4b26c8"><div class="ttname"><a href="namespacegridfire_1_1utils.html#af56693a70d9e2b40c8ae2c3bcd4b26c8">gridfire::utils::formatNuclearTimescaleLogString</a></div><div class="ttdeci">std::string formatNuclearTimescaleLogString(const DynamicEngine &amp;engine, const std::vector&lt; double &gt; &amp;Y, const double T9, const double rho)</div><div class="ttdef"><b>Definition</b> <a href="logging_8cpp_source.html#l00013">logging.cpp:13</a></div></div>
<div class="ttc" id="anamespacegridfire_1_1utils_html_af56693a70d9e2b40c8ae2c3bcd4b26c8"><div class="ttname"><a href="namespacegridfire_1_1utils.html#af56693a70d9e2b40c8ae2c3bcd4b26c8">gridfire::utils::formatNuclearTimescaleLogString</a></div><div class="ttdeci">std::string formatNuclearTimescaleLogString(const DynamicEngine &amp;engine, const std::vector&lt; double &gt; &amp;Y, const double T9, const double rho)</div><div class="ttdoc">Formats a map of nuclear species timescales into a human-readable string.</div><div class="ttdef"><b>Definition</b> <a href="logging_8cpp_source.html#l00013">logging.cpp:13</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->