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-11-25 14:31:59 -05:00
parent b0c68a709f
commit 2eebbf6819
1514 changed files with 83712 additions and 57694 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/html/classgridfire_1_1engine_1_1_engine.html
View File

@@ -29,7 +29,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">GridFire<span id="projectnumber">&#160;v0.7.0-alpha</span>
<div id="projectname">GridFire<span id="projectnumber">&#160;v0.7.0_rc1</span>
</div>
<div id="projectbrief">General Purpose Nuclear Network</div>
</td>
@@ -113,7 +113,7 @@ $(function(){initNavTree('classgridfire_1_1engine_1_1_engine.html',''); initResi
<div class="dynheader">
Inheritance diagram for gridfire::engine::Engine:</div>
<div class="dyncontent">
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="classgridfire_1_1engine_1_1_engine__inherit__graph.svg" width="100%" height="474"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div></div>
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="classgridfire_1_1engine_1_1_engine__inherit__graph.svg" width="100%" height="511"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div></div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
@@ -208,7 +208,7 @@ Public Member Functions</h2></td></tr>
<dl class="section return"><dt>Returns</dt><dd>expected&lt;StepDerivatives&lt;double&gt;&gt; containing either dY/dt and energy generation rate or a stale engine error indicating that the engine must be updated</dd></dl>
<p>This function must be implemented by derived classes to compute the time derivatives of all species and the specific nuclear energy generation rate for the current state. </p>
<p>Implemented in <a class="el" href="classgridfire_1_1engine_1_1_adaptive_engine_view.html#a5de5211bc99a1995143307284be6df4a">gridfire::engine::AdaptiveEngineView</a>, <a class="el" href="classgridfire_1_1engine_1_1_defined_engine_view.html#a82cbef591ef1aafcb9a42e01bf38fc38">gridfire::engine::DefinedEngineView</a>, <a class="el" href="classgridfire_1_1engine_1_1_graph_engine.html#aee098a65f5cecded199d2c00422b398d">gridfire::engine::GraphEngine</a>, and <a class="el" href="classgridfire_1_1engine_1_1_multiscale_partitioning_engine_view.html#aa960005503d18066015aef280680d616">gridfire::engine::MultiscalePartitioningEngineView</a>.</p>
<p>Implemented in <a class="el" href="classgridfire_1_1engine_1_1_adaptive_engine_view.html#a5de5211bc99a1995143307284be6df4a">gridfire::engine::AdaptiveEngineView</a>, <a class="el" href="classgridfire_1_1engine_1_1_defined_engine_view.html#a82cbef591ef1aafcb9a42e01bf38fc38">gridfire::engine::DefinedEngineView</a>, <a class="el" href="classgridfire_1_1engine_1_1_graph_engine.html#aee098a65f5cecded199d2c00422b398d">gridfire::engine::GraphEngine</a>, <a class="el" href="classgridfire_1_1engine_1_1_multiscale_partitioning_engine_view.html#aa960005503d18066015aef280680d616">gridfire::engine::MultiscalePartitioningEngineView</a>, <a class="el" href="class_py_dynamic_engine.html#aac1f2005c0a58befc4e01627c9357924">PyDynamicEngine</a>, and <a class="el" href="class_py_engine.html#abc26a86d4f93b37564d32814edbbac4d">PyEngine</a>.</p>
</div>
</div>
@@ -238,7 +238,7 @@ Public Member Functions</h2></td></tr>
<p>Get the list of species in the network. </p>
<dl class="section return"><dt>Returns</dt><dd>Vector of Species objects representing all network species. </dd></dl>
<p>Implemented in <a class="el" href="classgridfire_1_1engine_1_1_adaptive_engine_view.html#aaa2d47f44e5bb4d9660d7c017cc5085c">gridfire::engine::AdaptiveEngineView</a>, <a class="el" href="classgridfire_1_1engine_1_1_defined_engine_view.html#a0af3e1ac0314a485171f1dda39929cb4">gridfire::engine::DefinedEngineView</a>, <a class="el" href="classgridfire_1_1engine_1_1_graph_engine.html#a8f5099bfda5f6d6e1494788beff9b7c8">gridfire::engine::GraphEngine</a>, and <a class="el" href="classgridfire_1_1engine_1_1_multiscale_partitioning_engine_view.html#aa7aa38cf054988d050c04c59f28efdaa">gridfire::engine::MultiscalePartitioningEngineView</a>.</p>
<p>Implemented in <a class="el" href="classgridfire_1_1engine_1_1_adaptive_engine_view.html#aaa2d47f44e5bb4d9660d7c017cc5085c">gridfire::engine::AdaptiveEngineView</a>, <a class="el" href="classgridfire_1_1engine_1_1_defined_engine_view.html#a0af3e1ac0314a485171f1dda39929cb4">gridfire::engine::DefinedEngineView</a>, <a class="el" href="classgridfire_1_1engine_1_1_graph_engine.html#a8f5099bfda5f6d6e1494788beff9b7c8">gridfire::engine::GraphEngine</a>, <a class="el" href="classgridfire_1_1engine_1_1_multiscale_partitioning_engine_view.html#aa7aa38cf054988d050c04c59f28efdaa">gridfire::engine::MultiscalePartitioningEngineView</a>, <a class="el" href="class_py_dynamic_engine.html#afc745e7ab5da5d8b3cf916044515cd7d">PyDynamicEngine</a>, and <a class="el" href="class_py_engine.html#a2d240423899e039c2ca688e96f8af1f2">PyEngine</a>.</p>
</div>
</div>