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

docs(docs): rebuild with more usage examples

Browse Source
This commit is contained in:
Emily Boudreaux
2025-07-30 15:12:46 -04:00
parent 24870ffcbc
commit cd60ae5c1e
79 changed files with 5050 additions and 4496 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/html/engine__multiscale_8cpp_source.html
View File

@@ -1842,7 +1842,7 @@ $(function(){initNavTree('engine__multiscale_8cpp_source.html',''); initResizabl
<div class="line"><a id="l01642" name="l01642"></a><span class="lineno"> 1642</span> </div>
<div class="line"><a id="l01643" name="l01643"></a><span class="lineno"> 1643</span>}</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#l00130">engine_abstract.h:130</a></div></div>
<div class="ttc" id="aclassgridfire_1_1_graph_engine_html"><div class="ttname"><a href="classgridfire_1_1_graph_engine.html">gridfire::GraphEngine</a></div><div class="ttdoc">A reaction network engine that uses a graph-based representation.</div><div class="ttdef"><b>Definition</b> <a href="engine__graph_8h_source.html#l00101">engine_graph.h:101</a></div></div>
<div class="ttc" id="aclassgridfire_1_1_graph_engine_html"><div class="ttname"><a href="classgridfire_1_1_graph_engine.html">gridfire::GraphEngine</a></div><div class="ttdoc">A reaction network engine that uses a graph-based representation.</div><div class="ttdef"><b>Definition</b> <a href="engine__graph_8h_source.html#l00100">engine_graph.h:100</a></div></div>
<div class="ttc" id="aclassgridfire_1_1_graph_engine_html_a0ed390f3e598ebba4e245ac90bb78767"><div class="ttname"><a href="classgridfire_1_1_graph_engine.html#a0ed390f3e598ebba4e245ac90bb78767">gridfire::GraphEngine::getNetworkSpecies</a></div><div class="ttdeci">const std::vector&lt; fourdst::atomic::Species &gt; &amp; getNetworkSpecies() const override</div><div class="ttdoc">Gets the list of species in the network.</div><div class="ttdef"><b>Definition</b> <a href="engine__graph_8cpp_source.html#l00162">engine_graph.cpp:162</a></div></div>
<div class="ttc" id="aclassgridfire_1_1_multiscale_partitioning_engine_view_html_a0437c51f94bf834a11adf481b2afad93"><div class="ttname"><a href="classgridfire_1_1_multiscale_partitioning_engine_view.html#a0437c51f94bf834a11adf481b2afad93">gridfire::MultiscalePartitioningEngineView::m_baseEngine</a></div><div class="ttdeci">GraphEngine &amp; m_baseEngine</div><div class="ttdoc">The base engine to which this view delegates calculations.</div><div class="ttdef"><b>Definition</b> <a href="engine__multiscale_8h_source.html#l00914">engine_multiscale.h:914</a></div></div>
<div class="ttc" id="aclassgridfire_1_1_multiscale_partitioning_engine_view_html_a05730ced13ac5331060ca011f0da6235"><div class="ttname"><a href="classgridfire_1_1_multiscale_partitioning_engine_view.html#a05730ced13ac5331060ca011f0da6235">gridfire::MultiscalePartitioningEngineView::primeEngine</a></div><div class="ttdeci">PrimingReport primeEngine(const NetIn &amp;netIn) override</div><div class="ttdoc">Primes the engine with a specific species.</div><div class="ttdef"><b>Definition</b> <a href="#l00793">engine_multiscale.cpp:793</a></div></div>