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

docs(docs): rebuilt docs with loads more detail for triggers and weak reactions

Browse Source
This commit is contained in:
Emily Boudreaux
2025-10-08 11:17:09 -04:00
parent 8a0b5b2c36
commit 274c566726
600 changed files with 39207 additions and 9125 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/html/engine_8h.html
View File

@@ -154,7 +154,7 @@ GraphEngine Example</h2>
<div class="line"> </div>
<div class="line"><span class="comment">// Create a GraphEngine</span></div>
<div class="line"><a class="code hl_class" href="classgridfire_1_1_graph_engine.html">gridfire::GraphEngine</a> engine(composition);</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> engine_graph.h:100</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> engine_graph.h:97</div></div>
<div class="ttc" id="aengine__graph_8h_html"><div class="ttname"><a href="engine__graph_8h.html">engine_graph.h</a></div></div>
</div><!-- fragment --><h2><a class="anchor" id="AdaptiveEngineViewExample"></a>
AdaptiveEngineView Example</h2>
@@ -171,7 +171,7 @@ AdaptiveEngineView Example</h2>
<div class="line"> </div>
<div class="line"><span class="comment">// Create an AdaptiveEngineView</span></div>
<div class="line"><a class="code hl_class" href="classgridfire_1_1_adaptive_engine_view.html">gridfire::AdaptiveEngineView</a> engine(baseEngine);</div>
<div class="ttc" id="aclassgridfire_1_1_adaptive_engine_view_html"><div class="ttname"><a href="classgridfire_1_1_adaptive_engine_view.html">gridfire::AdaptiveEngineView</a></div><div class="ttdoc">An engine view that dynamically adapts the reaction network based on runtime conditions.</div><div class="ttdef"><b>Definition</b> engine_adaptive.h:50</div></div>
<div class="ttc" id="aclassgridfire_1_1_adaptive_engine_view_html"><div class="ttname"><a href="classgridfire_1_1_adaptive_engine_view.html">gridfire::AdaptiveEngineView</a></div><div class="ttdoc">An engine view that dynamically adapts the reaction network based on runtime conditions.</div><div class="ttdef"><b>Definition</b> engine_adaptive.h:49</div></div>
<div class="ttc" id="aengine__adaptive_8h_html"><div class="ttname"><a href="engine__adaptive_8h.html">engine_adaptive.h</a></div></div>
</div><!-- fragment --><h2><a class="anchor" id="DefinedEngineViewExample"></a>
DefinedEngineView Example</h2>
@@ -206,7 +206,7 @@ MultiscalePartitioningEngineView Example</h2>
<div class="line"> </div>
<div class="line"><span class="comment">// Create a MultiscalePartitioningEngineView</span></div>
<div class="line"><a class="code hl_class" href="classgridfire_1_1_multiscale_partitioning_engine_view.html">gridfire::MultiscalePartitioningEngineView</a> engine(baseEngine);</div>
<div class="ttc" id="aclassgridfire_1_1_multiscale_partitioning_engine_view_html"><div class="ttname"><a href="classgridfire_1_1_multiscale_partitioning_engine_view.html">gridfire::MultiscalePartitioningEngineView</a></div><div class="ttdoc">An engine view that partitions the reaction network into multiple groups based on timescales.</div><div class="ttdef"><b>Definition</b> engine_multiscale.h:182</div></div>
<div class="ttc" id="aclassgridfire_1_1_multiscale_partitioning_engine_view_html"><div class="ttname"><a href="classgridfire_1_1_multiscale_partitioning_engine_view.html">gridfire::MultiscalePartitioningEngineView</a></div><div class="ttdoc">An engine view that partitions the reaction network into multiple groups based on timescales.</div><div class="ttdef"><b>Definition</b> engine_multiscale.h:180</div></div>
<div class="ttc" id="aengine__multiscale_8h_html"><div class="ttname"><a href="engine__multiscale_8h.html">engine_multiscale.h</a></div></div>
</div><!-- fragment --><h2><a class="anchor" id="NetworkPrimingEngineViewExample"></a>
NetworkPrimingEngineView Example</h2>
@@ -224,7 +224,7 @@ NetworkPrimingEngineView Example</h2>
<div class="line"><span class="comment">// Create a NetworkPrimingEngineView</span></div>
<div class="line">std::string primingSymbol = <span class="stringliteral">&quot;p&quot;</span>;</div>
<div class="line"><a class="code hl_class" href="classgridfire_1_1_network_priming_engine_view.html">gridfire::NetworkPrimingEngineView</a> engine(primingSymbol, baseEngine);</div>
<div class="ttc" id="aclassgridfire_1_1_network_priming_engine_view_html"><div class="ttname"><a href="classgridfire_1_1_network_priming_engine_view.html">gridfire::NetworkPrimingEngineView</a></div><div class="ttdoc">Provides a view of a DynamicEngine filtered to reactions involving a specified priming species.</div><div class="ttdef"><b>Definition</b> engine_priming.h:30</div></div>
<div class="ttc" id="aclassgridfire_1_1_network_priming_engine_view_html"><div class="ttname"><a href="classgridfire_1_1_network_priming_engine_view.html">gridfire::NetworkPrimingEngineView</a></div><div class="ttdoc">Provides a view of a DynamicEngine filtered to reactions involving a specified priming species.</div><div class="ttdef"><b>Definition</b> engine_priming.h:28</div></div>
<div class="ttc" id="aengine__priming_8h_html"><div class="ttname"><a href="engine__priming_8h.html">engine_priming.h</a></div></div>
</div><!-- fragment --> </div></div><!-- contents -->
</div><!-- doc-content -->