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

14
docs/html/structgridfire_1_1_step_derivatives.html
View File

@@ -135,11 +135,11 @@ struct gridfire::StepDerivatives&lt; T &gt;</div><p>Structure holding derivative
<div class="line"> <span class="comment">// Use derivative</span></div>
<div class="line">}</div>
<div class="line"><span class="keywordtype">double</span> energyRate = result.<a class="code hl_variable" href="#ab4aeb41be952c7b5844e1ee81fef9008">nuclearEnergyGenerationRate</a>;</div>
<div class="ttc" id="astructgridfire_1_1_step_derivatives_html"><div class="ttname"><a href="structgridfire_1_1_step_derivatives.html">gridfire::StepDerivatives</a></div><div class="ttdoc">Structure holding derivatives and energy generation for a network step.</div><div class="ttdef"><b>Definition</b> <a href="engine__abstract_8h_source.html#l00053">engine_abstract.h:53</a></div></div>
<div class="ttc" id="astructgridfire_1_1_step_derivatives_html_ab4aeb41be952c7b5844e1ee81fef9008"><div class="ttname"><a href="#ab4aeb41be952c7b5844e1ee81fef9008">gridfire::StepDerivatives::nuclearEnergyGenerationRate</a></div><div class="ttdeci">T nuclearEnergyGenerationRate</div><div class="ttdoc">Specific energy generation rate (e.g., erg/g/s).</div><div class="ttdef"><b>Definition</b> <a href="engine__abstract_8h_source.html#l00055">engine_abstract.h:55</a></div></div>
<div class="ttc" id="astructgridfire_1_1_step_derivatives_html_ae0de268b86c2404379409c4feae0b34d"><div class="ttname"><a href="#ae0de268b86c2404379409c4feae0b34d">gridfire::StepDerivatives::dydt</a></div><div class="ttdeci">std::vector&lt; T &gt; dydt</div><div class="ttdoc">Derivatives of abundances (dY/dt for each species).</div><div class="ttdef"><b>Definition</b> <a href="engine__abstract_8h_source.html#l00054">engine_abstract.h:54</a></div></div>
<div class="ttc" id="astructgridfire_1_1_step_derivatives_html"><div class="ttname"><a href="structgridfire_1_1_step_derivatives.html">gridfire::StepDerivatives</a></div><div class="ttdoc">Structure holding derivatives and energy generation for a network step.</div><div class="ttdef"><b>Definition</b> <a href="engine__abstract_8h_source.html#l00060">engine_abstract.h:60</a></div></div>
<div class="ttc" id="astructgridfire_1_1_step_derivatives_html_ab4aeb41be952c7b5844e1ee81fef9008"><div class="ttname"><a href="#ab4aeb41be952c7b5844e1ee81fef9008">gridfire::StepDerivatives::nuclearEnergyGenerationRate</a></div><div class="ttdeci">T nuclearEnergyGenerationRate</div><div class="ttdoc">Specific energy generation rate (e.g., erg/g/s).</div><div class="ttdef"><b>Definition</b> <a href="engine__abstract_8h_source.html#l00062">engine_abstract.h:62</a></div></div>
<div class="ttc" id="astructgridfire_1_1_step_derivatives_html_ae0de268b86c2404379409c4feae0b34d"><div class="ttname"><a href="#ae0de268b86c2404379409c4feae0b34d">gridfire::StepDerivatives::dydt</a></div><div class="ttdeci">std::vector&lt; T &gt; dydt</div><div class="ttdoc">Derivatives of abundances (dY/dt for each species).</div><div class="ttdef"><b>Definition</b> <a href="engine__abstract_8h_source.html#l00061">engine_abstract.h:61</a></div></div>
</div><!-- fragment -->
<p class="definition">Definition at line <a class="el" href="engine__abstract_8h_source.html#l00053">53</a> of file <a class="el" href="engine__abstract_8h_source.html">engine_abstract.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="engine__abstract_8h_source.html#l00060">60</a> of file <a class="el" href="engine__abstract_8h_source.html">engine_abstract.h</a>.</p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="ae0de268b86c2404379409c4feae0b34d" name="ae0de268b86c2404379409c4feae0b34d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae0de268b86c2404379409c4feae0b34d">&#9670;&#160;</a></span>dydt</h2>
@@ -157,7 +157,7 @@ template&lt;IsArithmeticOrAD T&gt; </div>
<p>Derivatives of abundances (dY/dt for each species). </p>
<p class="definition">Definition at line <a class="el" href="engine__abstract_8h_source.html#l00054">54</a> of file <a class="el" href="engine__abstract_8h_source.html">engine_abstract.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="engine__abstract_8h_source.html#l00061">61</a> of file <a class="el" href="engine__abstract_8h_source.html">engine_abstract.h</a>.</p>
</div>
</div>
@@ -177,12 +177,12 @@ template&lt;IsArithmeticOrAD T&gt; </div>
<p>Specific energy generation rate (e.g., erg/g/s). </p>
<p class="definition">Definition at line <a class="el" href="engine__abstract_8h_source.html#l00055">55</a> of file <a class="el" href="engine__abstract_8h_source.html">engine_abstract.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="engine__abstract_8h_source.html#l00062">62</a> of file <a class="el" href="engine__abstract_8h_source.html">engine_abstract.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__abstract_8h_source.html">engine_abstract.h</a></li>
<li>src/include/gridfire/engine/<a class="el" href="engine__abstract_8h_source.html">engine_abstract.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->