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

refactor(.gitignore): removed html/ from .gitignore

Browse Source
This commit is contained in:
Emily Boudreaux
2025-07-01 11:40:51 -04:00
parent 0c16e81e98
commit 7df6f60912
197 changed files with 6248 additions and 4744 deletions
Download Patch File Download Diff File Expand all files Collapse all files

340
docs/html/classgridfire_1_1_adaptive_engine_view.html
View File

@@ -137,9 +137,9 @@ Public Member Functions</h2></td></tr>
<tr class="memitem:ad599363cdd457e72e2e2937b0222c455" id="r_ad599363cdd457e72e2e2937b0222c455"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad599363cdd457e72e2e2937b0222c455">AdaptiveEngineView</a> (<a class="el" href="classgridfire_1_1_dynamic_engine.html">DynamicEngine</a> &amp;baseEngine)</td></tr>
<tr class="memdesc:ad599363cdd457e72e2e2937b0222c455"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an <a class="el" href="classgridfire_1_1_adaptive_engine_view.html" title="An engine view that dynamically adapts the reaction network based on runtime conditions.">AdaptiveEngineView</a>. <br /></td></tr>
<tr class="separator:ad599363cdd457e72e2e2937b0222c455"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a44c4fb7568ddbb20a08f328c2fbf1fdf" id="r_a44c4fb7568ddbb20a08f328c2fbf1fdf"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a44c4fb7568ddbb20a08f328c2fbf1fdf">update</a> (const <a class="el" href="structgridfire_1_1_net_in.html">NetIn</a> &amp;netIn)</td></tr>
<tr class="memdesc:a44c4fb7568ddbb20a08f328c2fbf1fdf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Updates the active species and reactions based on the current conditions. <br /></td></tr>
<tr class="separator:a44c4fb7568ddbb20a08f328c2fbf1fdf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7d61e73f5158f1574cda3edc90c51f7e" id="r_a7d61e73f5158f1574cda3edc90c51f7e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7d61e73f5158f1574cda3edc90c51f7e">update</a> (const <a class="el" href="structgridfire_1_1_net_in.html">NetIn</a> &amp;netIn) override</td></tr>
<tr class="memdesc:a7d61e73f5158f1574cda3edc90c51f7e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Updates the active species and reactions based on the current conditions. <br /></td></tr>
<tr class="separator:a7d61e73f5158f1574cda3edc90c51f7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac83a8efe25c0e5b9bf7756ac3a500bb1" id="r_ac83a8efe25c0e5b9bf7756ac3a500bb1"><td class="memItemLeft" align="right" valign="top">const std::vector&lt; fourdst::atomic::Species &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac83a8efe25c0e5b9bf7756ac3a500bb1">getNetworkSpecies</a> () const override</td></tr>
<tr class="memdesc:ac83a8efe25c0e5b9bf7756ac3a500bb1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the list of active species in the network. <br /></td></tr>
<tr class="separator:ac83a8efe25c0e5b9bf7756ac3a500bb1"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -161,7 +161,7 @@ Public Member Functions</h2></td></tr>
<tr class="memitem:a048d4b1d41ecb4125a558d1b9ed7cb31" id="r_a048d4b1d41ecb4125a558d1b9ed7cb31"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a048d4b1d41ecb4125a558d1b9ed7cb31">calculateMolarReactionFlow</a> (const <a class="el" href="classgridfire_1_1reaction_1_1_reaction.html">reaction::Reaction</a> &amp;reaction, const std::vector&lt; double &gt; &amp;Y_culled, double T9, double rho) const override</td></tr>
<tr class="memdesc:a048d4b1d41ecb4125a558d1b9ed7cb31"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculates the molar reaction flow for a given reaction in the active network. <br /></td></tr>
<tr class="separator:a048d4b1d41ecb4125a558d1b9ed7cb31"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a12cc2f352678fba9688363ba1876ab9c" id="r_a12cc2f352678fba9688363ba1876ab9c"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classgridfire_1_1reaction_1_1_logical_reaction_set.html">reaction::LogicalReactionSet</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a12cc2f352678fba9688363ba1876ab9c">getNetworkReactions</a> () const override</td></tr>
<tr class="memitem:a12cc2f352678fba9688363ba1876ab9c" id="r_a12cc2f352678fba9688363ba1876ab9c"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="namespacegridfire_1_1reaction.html#aa86f08712565f278adacc7cd2361eb31">reaction::LogicalReactionSet</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a12cc2f352678fba9688363ba1876ab9c">getNetworkReactions</a> () const override</td></tr>
<tr class="memdesc:a12cc2f352678fba9688363ba1876ab9c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the set of active logical reactions in the network. <br /></td></tr>
<tr class="separator:a12cc2f352678fba9688363ba1876ab9c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a93b38d0fdc4647f6f7340172dae17872" id="r_a93b38d0fdc4647f6f7340172dae17872"><td class="memItemLeft" align="right" valign="top">std::unordered_map&lt; fourdst::atomic::Species, double &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a93b38d0fdc4647f6f7340172dae17872">getSpeciesTimescales</a> (const std::vector&lt; double &gt; &amp;Y_culled, double T9, double rho) const override</td></tr>
@@ -170,6 +170,10 @@ Public Member Functions</h2></td></tr>
<tr class="memitem:aee095b30a9dce5fcb5ae2fa1d2aa192c" id="r_aee095b30a9dce5fcb5ae2fa1d2aa192c"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classgridfire_1_1_dynamic_engine.html">DynamicEngine</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aee095b30a9dce5fcb5ae2fa1d2aa192c">getBaseEngine</a> () const override</td></tr>
<tr class="memdesc:aee095b30a9dce5fcb5ae2fa1d2aa192c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the base engine. <br /></td></tr>
<tr class="separator:aee095b30a9dce5fcb5ae2fa1d2aa192c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aae4ddbef1c4e2202fd236221a4bf376b" id="r_aae4ddbef1c4e2202fd236221a4bf376b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aae4ddbef1c4e2202fd236221a4bf376b">setScreeningModel</a> (<a class="el" href="namespacegridfire_1_1screening.html#aa82aafbc4f8c28d0a75b60798e3a7d25">screening::ScreeningType</a> model) override</td></tr>
<tr class="separator:aae4ddbef1c4e2202fd236221a4bf376b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0ab1199f900a58f309c3c36532c9164f" id="r_a0ab1199f900a58f309c3c36532c9164f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacegridfire_1_1screening.html#aa82aafbc4f8c28d0a75b60798e3a7d25">screening::ScreeningType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0ab1199f900a58f309c3c36532c9164f">getScreeningModel</a> () const override</td></tr>
<tr class="separator:a0ab1199f900a58f309c3c36532c9164f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classgridfire_1_1_engine"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_classgridfire_1_1_engine')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgridfire_1_1_engine.html">gridfire::Engine</a></td></tr>
<tr class="memitem:a2e7970bed2100699f226f4141d5db037 inherit pub_methods_classgridfire_1_1_engine" id="r_a2e7970bed2100699f226f4141d5db037"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1_engine.html#a2e7970bed2100699f226f4141d5db037">~Engine</a> ()=default</td></tr>
<tr class="memdesc:a2e7970bed2100699f226f4141d5db037 inherit pub_methods_classgridfire_1_1_engine"><td class="mdescLeft">&#160;</td><td class="mdescRight">Virtual destructor. <br /></td></tr>
@@ -209,6 +213,14 @@ Private Member Functions</h2></td></tr>
<tr class="memitem:aedc0dedb51c81e03f253cc409a5d5c40" id="r_aedc0dedb51c81e03f253cc409a5d5c40"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aedc0dedb51c81e03f253cc409a5d5c40">validateState</a> () const</td></tr>
<tr class="memdesc:aedc0dedb51c81e03f253cc409a5d5c40"><td class="mdescLeft">&#160;</td><td class="mdescRight">Validates that the <a class="el" href="classgridfire_1_1_adaptive_engine_view.html" title="An engine view that dynamically adapts the reaction network based on runtime conditions.">AdaptiveEngineView</a> is not stale. <br /></td></tr>
<tr class="separator:aedc0dedb51c81e03f253cc409a5d5c40"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abdbaf4b87629efe43ac1255dad424c0c" id="r_abdbaf4b87629efe43ac1255dad424c0c"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="structgridfire_1_1_adaptive_engine_view_1_1_reaction_flow.html">ReactionFlow</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abdbaf4b87629efe43ac1255dad424c0c">calculateAllReactionFlows</a> (const <a class="el" href="structgridfire_1_1_net_in.html">NetIn</a> &amp;netIn, std::vector&lt; double &gt; &amp;out_Y_Full) const</td></tr>
<tr class="separator:abdbaf4b87629efe43ac1255dad424c0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0ed21f7e7c1034fc87b40d4116c4221b" id="r_a0ed21f7e7c1034fc87b40d4116c4221b"><td class="memItemLeft" align="right" valign="top">std::unordered_set&lt; fourdst::atomic::Species &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0ed21f7e7c1034fc87b40d4116c4221b">findReachableSpecies</a> (const <a class="el" href="structgridfire_1_1_net_in.html">NetIn</a> &amp;netIn) const</td></tr>
<tr class="separator:a0ed21f7e7c1034fc87b40d4116c4221b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a42417e96fe9fd623458af109401daf08" id="r_a42417e96fe9fd623458af109401daf08"><td class="memItemLeft" align="right" valign="top">std::vector&lt; const <a class="el" href="classgridfire_1_1reaction_1_1_logical_reaction.html">reaction::LogicalReaction</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a42417e96fe9fd623458af109401daf08">cullReactionsByFlow</a> (const std::vector&lt; <a class="el" href="structgridfire_1_1_adaptive_engine_view_1_1_reaction_flow.html">ReactionFlow</a> &gt; &amp;allFlows, const std::unordered_set&lt; fourdst::atomic::Species &gt; &amp;reachableSpecies, const std::vector&lt; double &gt; &amp;Y_full, double maxFlow) const</td></tr>
<tr class="separator:a42417e96fe9fd623458af109401daf08"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa79fb382c98461b02a2c30668491e6c5" id="r_aa79fb382c98461b02a2c30668491e6c5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa79fb382c98461b02a2c30668491e6c5">finalizeActiveSet</a> (const std::vector&lt; const <a class="el" href="classgridfire_1_1reaction_1_1_logical_reaction.html">reaction::LogicalReaction</a> * &gt; &amp;finalReactions)</td></tr>
<tr class="separator:aa79fb382c98461b02a2c30668491e6c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
Private Attributes</h2></td></tr>
@@ -220,7 +232,7 @@ Private Attributes</h2></td></tr>
<tr class="separator:a4d38b46be9f25c7afe7ddd2b284253f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af4bc9fc6e4afcd6a53c49ca6e2a95940" id="r_af4bc9fc6e4afcd6a53c49ca6e2a95940"><td class="memItemLeft" align="right" valign="top">std::vector&lt; fourdst::atomic::Species &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af4bc9fc6e4afcd6a53c49ca6e2a95940">m_activeSpecies</a></td></tr>
<tr class="separator:af4bc9fc6e4afcd6a53c49ca6e2a95940"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a19fc7e02e216b797aa643fa35e429800" id="r_a19fc7e02e216b797aa643fa35e429800"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgridfire_1_1reaction_1_1_logical_reaction_set.html">reaction::LogicalReactionSet</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a19fc7e02e216b797aa643fa35e429800">m_activeReactions</a></td></tr>
<tr class="memitem:a19fc7e02e216b797aa643fa35e429800" id="r_a19fc7e02e216b797aa643fa35e429800"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacegridfire_1_1reaction.html#aa86f08712565f278adacc7cd2361eb31">reaction::LogicalReactionSet</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a19fc7e02e216b797aa643fa35e429800">m_activeReactions</a></td></tr>
<tr class="separator:a19fc7e02e216b797aa643fa35e429800"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5f66204a0ff5b27eed243afddecb0093" id="r_a5f66204a0ff5b27eed243afddecb0093"><td class="memItemLeft" align="right" valign="top">std::vector&lt; size_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5f66204a0ff5b27eed243afddecb0093">m_speciesIndexMap</a></td></tr>
<tr class="separator:a5f66204a0ff5b27eed243afddecb0093"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -233,7 +245,7 @@ Private Attributes</h2></td></tr>
<div class="textblock"><p>An engine view that dynamically adapts the reaction network based on runtime conditions. </p>
<p>This class implements an <a class="el" href="classgridfire_1_1_engine_view.html" title="Abstract base class for a &quot;view&quot; of a reaction network engine.">EngineView</a> that dynamically culls species and reactions from the full reaction network based on their reaction flow rates and connectivity. This allows for efficient simulation of reaction networks by focusing computational effort on the most important species and reactions.</p>
<p>The <a class="el" href="classgridfire_1_1_adaptive_engine_view.html" title="An engine view that dynamically adapts the reaction network based on runtime conditions.">AdaptiveEngineView</a> maintains a subset of "active" species and reactions, and maps between the full network indices and the active subset indices. This allows the base engine to operate on the full network data, while the <a class="el" href="classgridfire_1_1_adaptive_engine_view.html" title="An engine view that dynamically adapts the reaction network based on runtime conditions.">AdaptiveEngineView</a> provides a reduced view for external clients.</p>
<p>The adaptation process is driven by the <code><a class="el" href="#a44c4fb7568ddbb20a08f328c2fbf1fdf" title="Updates the active species and reactions based on the current conditions.">update()</a></code> method, which performs the following steps:</p><ol type="1">
<p>The adaptation process is driven by the <code><a class="el" href="#a7d61e73f5158f1574cda3edc90c51f7e" title="Updates the active species and reactions based on the current conditions.">update()</a></code> method, which performs the following steps:</p><ol type="1">
<li><b>Reaction Flow Calculation:</b> Calculates the molar reaction flow rate for each reaction in the full network based on the current temperature, density, and composition.</li>
<li><b>Reaction Culling:</b> Culls reactions with flow rates below a threshold, determined by a relative culling threshold multiplied by the maximum flow rate.</li>
<li><b>Connectivity Analysis:</b> Performs a connectivity analysis to identify species that are reachable from the initial fuel species through the culled reaction network.</li>
@@ -245,9 +257,9 @@ Private Attributes</h2></td></tr>
<dd>
<a class="el" href="engine__view__abstract_8h.html" title="Abstract interfaces for engine &quot;views&quot; in GridFire.">engine_view_abstract.h</a> </dd>
<dd>
<a class="el" href="#a44c4fb7568ddbb20a08f328c2fbf1fdf" title="Updates the active species and reactions based on the current conditions.">AdaptiveEngineView::update()</a> </dd></dl>
<a class="el" href="#a7d61e73f5158f1574cda3edc90c51f7e" title="Updates the active species and reactions based on the current conditions.">AdaptiveEngineView::update()</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8h_source.html#l00045">45</a> of file <a class="el" href="engine__adaptive_8h_source.html">engine_adaptive.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8h_source.html#l00047">47</a> of file <a class="el" href="engine__adaptive_8h_source.html">engine_adaptive.h</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="afec39b2faa34ea65c5488dd8e11ba3c3" name="afec39b2faa34ea65c5488dd8e11ba3c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afec39b2faa34ea65c5488dd8e11ba3c3">&#9670;&#160;</a></span>Config</h2>
@@ -269,7 +281,7 @@ Private Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8h_source.html#l00226">226</a> of file <a class="el" href="engine__adaptive_8h_source.html">engine_adaptive.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8h_source.html#l00232">232</a> of file <a class="el" href="engine__adaptive_8h_source.html">engine_adaptive.h</a>.</p>
</div>
</div>
@@ -293,7 +305,7 @@ Private Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8h_source.html#l00227">227</a> of file <a class="el" href="engine__adaptive_8h_source.html">engine_adaptive.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8h_source.html#l00233">233</a> of file <a class="el" href="engine__adaptive_8h_source.html">engine_adaptive.h</a>.</p>
</div>
</div>
@@ -335,6 +347,37 @@ Private Attributes</h2></td></tr>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="abdbaf4b87629efe43ac1255dad424c0c" name="abdbaf4b87629efe43ac1255dad424c0c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abdbaf4b87629efe43ac1255dad424c0c">&#9670;&#160;</a></span>calculateAllReactionFlows()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::vector&lt; <a class="el" href="structgridfire_1_1_adaptive_engine_view_1_1_reaction_flow.html">AdaptiveEngineView::ReactionFlow</a> &gt; gridfire::AdaptiveEngineView::calculateAllReactionFlows </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structgridfire_1_1_net_in.html">NetIn</a> &amp;</td> <td class="paramname"><span class="paramname"><em>netIn</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::vector&lt; double &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>out_Y_Full</em></span>&#160;) const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8cpp_source.html#l00268">268</a> of file <a class="el" href="engine__adaptive_8cpp_source.html">engine_adaptive.cpp</a>.</p>
</div>
</div>
<a id="a048d4b1d41ecb4125a558d1b9ed7cb31" name="a048d4b1d41ecb4125a558d1b9ed7cb31"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a048d4b1d41ecb4125a558d1b9ed7cb31">&#9670;&#160;</a></span>calculateMolarReactionFlow()</h2>
@@ -367,7 +410,7 @@ Private Attributes</h2></td></tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span></span> </td>
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
@@ -386,7 +429,7 @@ Private Attributes</h2></td></tr>
<p>This method maps the culled abundances to the full network abundances and calls the base engine to calculate the molar reaction flow.</p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">std::runtime_error</td><td>If the <a class="el" href="classgridfire_1_1_adaptive_engine_view.html" title="An engine view that dynamically adapts the reaction network based on runtime conditions.">AdaptiveEngineView</a> is stale (i.e., <code><a class="el" href="#a44c4fb7568ddbb20a08f328c2fbf1fdf" title="Updates the active species and reactions based on the current conditions.">update()</a></code> has not been called). </td></tr>
<tr><td class="paramname">std::runtime_error</td><td>If the <a class="el" href="classgridfire_1_1_adaptive_engine_view.html" title="An engine view that dynamically adapts the reaction network based on runtime conditions.">AdaptiveEngineView</a> is stale (i.e., <code><a class="el" href="#a7d61e73f5158f1574cda3edc90c51f7e" title="Updates the active species and reactions based on the current conditions.">update()</a></code> has not been called). </td></tr>
<tr><td class="paramname">std::runtime_error</td><td>If the reaction is not part of the active reactions in the adaptive engine view. </td></tr>
</table>
</dd>
@@ -394,7 +437,7 @@ Private Attributes</h2></td></tr>
<p>Implements <a class="el" href="classgridfire_1_1_dynamic_engine.html#a6633b1757c41dd9e1c397333f4f9e785">gridfire::DynamicEngine</a>.</p>
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8cpp_source.html#l00278">278</a> of file <a class="el" href="engine__adaptive_8cpp_source.html">engine_adaptive.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8cpp_source.html#l00175">175</a> of file <a class="el" href="engine__adaptive_8cpp_source.html">engine_adaptive.cpp</a>.</p>
</div>
</div>
@@ -425,7 +468,7 @@ Private Attributes</h2></td></tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span></span> </td>
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
@@ -443,15 +486,15 @@ Private Attributes</h2></td></tr>
<p>This method maps the culled abundances to the full network abundances, calls the base engine to calculate the RHS and energy generation, and then maps the full network derivatives back to the culled derivatives.</p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">std::runtime_error</td><td>If the <a class="el" href="classgridfire_1_1_adaptive_engine_view.html" title="An engine view that dynamically adapts the reaction network based on runtime conditions.">AdaptiveEngineView</a> is stale (i.e., <code><a class="el" href="#a44c4fb7568ddbb20a08f328c2fbf1fdf" title="Updates the active species and reactions based on the current conditions.">update()</a></code> has not been called). </td></tr>
<tr><td class="paramname">std::runtime_error</td><td>If the <a class="el" href="classgridfire_1_1_adaptive_engine_view.html" title="An engine view that dynamically adapts the reaction network based on runtime conditions.">AdaptiveEngineView</a> is stale (i.e., <code><a class="el" href="#a7d61e73f5158f1574cda3edc90c51f7e" title="Updates the active species and reactions based on the current conditions.">update()</a></code> has not been called). </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#a44c4fb7568ddbb20a08f328c2fbf1fdf" title="Updates the active species and reactions based on the current conditions.">AdaptiveEngineView::update()</a> </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#a7d61e73f5158f1574cda3edc90c51f7e" title="Updates the active species and reactions based on the current conditions.">AdaptiveEngineView::update()</a> </dd></dl>
<p>Implements <a class="el" href="classgridfire_1_1_engine.html#ac8b56124b6b49cd1802addb74a9a47c2">gridfire::Engine</a>.</p>
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8cpp_source.html#l00223">223</a> of file <a class="el" href="engine__adaptive_8cpp_source.html">engine_adaptive.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8cpp_source.html#l00120">120</a> of file <a class="el" href="engine__adaptive_8cpp_source.html">engine_adaptive.cpp</a>.</p>
</div>
</div>
@@ -473,7 +516,7 @@ Private Attributes</h2></td></tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
@@ -481,7 +524,7 @@ Private Attributes</h2></td></tr>
<p>Constructs the reaction index map. </p>
<dl class="section return"><dt>Returns</dt><dd>A vector mapping culled reaction indices to full reaction indices.</dd></dl>
<p>This method creates a map from the indices of the active reactions to the indices of the corresponding reactions in the full network.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#a44c4fb7568ddbb20a08f328c2fbf1fdf" title="Updates the active species and reactions based on the current conditions.">AdaptiveEngineView::update()</a> </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#a7d61e73f5158f1574cda3edc90c51f7e" title="Updates the active species and reactions based on the current conditions.">AdaptiveEngineView::update()</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8cpp_source.html#l00053">53</a> of file <a class="el" href="engine__adaptive_8cpp_source.html">engine_adaptive.cpp</a>.</p>
@@ -505,7 +548,7 @@ Private Attributes</h2></td></tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
@@ -513,10 +556,105 @@ Private Attributes</h2></td></tr>
<p>Constructs the species index map. </p>
<dl class="section return"><dt>Returns</dt><dd>A vector mapping culled species indices to full species indices.</dd></dl>
<p>This method creates a map from the indices of the active species to the indices of the corresponding species in the full network.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#a44c4fb7568ddbb20a08f328c2fbf1fdf" title="Updates the active species and reactions based on the current conditions.">AdaptiveEngineView::update()</a> </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#a7d61e73f5158f1574cda3edc90c51f7e" title="Updates the active species and reactions based on the current conditions.">AdaptiveEngineView::update()</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8cpp_source.html#l00024">24</a> of file <a class="el" href="engine__adaptive_8cpp_source.html">engine_adaptive.cpp</a>.</p>
</div>
</div>
<a id="a42417e96fe9fd623458af109401daf08" name="a42417e96fe9fd623458af109401daf08"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a42417e96fe9fd623458af109401daf08">&#9670;&#160;</a></span>cullReactionsByFlow()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::vector&lt; const <a class="el" href="classgridfire_1_1reaction_1_1_logical_reaction.html">reaction::LogicalReaction</a> * &gt; gridfire::AdaptiveEngineView::cullReactionsByFlow </td>
<td>(</td>
<td class="paramtype">const std::vector&lt; <a class="el" href="structgridfire_1_1_adaptive_engine_view_1_1_reaction_flow.html">ReactionFlow</a> &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>allFlows</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::unordered_set&lt; fourdst::atomic::Species &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>reachableSpecies</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector&lt; double &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>Y_full</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em>maxFlow</em></span>&#160;) const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8cpp_source.html#l00342">342</a> of file <a class="el" href="engine__adaptive_8cpp_source.html">engine_adaptive.cpp</a>.</p>
</div>
</div>
<a id="aa79fb382c98461b02a2c30668491e6c5" name="aa79fb382c98461b02a2c30668491e6c5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa79fb382c98461b02a2c30668491e6c5">&#9670;&#160;</a></span>finalizeActiveSet()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void gridfire::AdaptiveEngineView::finalizeActiveSet </td>
<td>(</td>
<td class="paramtype">const std::vector&lt; const <a class="el" href="classgridfire_1_1reaction_1_1_logical_reaction.html">reaction::LogicalReaction</a> * &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>finalReactions</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8cpp_source.html#l00385">385</a> of file <a class="el" href="engine__adaptive_8cpp_source.html">engine_adaptive.cpp</a>.</p>
</div>
</div>
<a id="a0ed21f7e7c1034fc87b40d4116c4221b" name="a0ed21f7e7c1034fc87b40d4116c4221b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ed21f7e7c1034fc87b40d4116c4221b">&#9670;&#160;</a></span>findReachableSpecies()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::unordered_set&lt; Species &gt; gridfire::AdaptiveEngineView::findReachableSpecies </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structgridfire_1_1_net_in.html">NetIn</a> &amp;</td> <td class="paramname"><span class="paramname"><em>netIn</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8cpp_source.html#l00299">299</a> of file <a class="el" href="engine__adaptive_8cpp_source.html">engine_adaptive.cpp</a>.</p>
</div>
</div>
<a id="ac9aab6f60e80a9228b2b19b1b10449ef" name="ac9aab6f60e80a9228b2b19b1b10449ef"></a>
@@ -563,15 +701,15 @@ Private Attributes</h2></td></tr>
<p>This method maps the culled abundances to the full network abundances and calls the base engine to generate the Jacobian matrix.</p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">std::runtime_error</td><td>If the <a class="el" href="classgridfire_1_1_adaptive_engine_view.html" title="An engine view that dynamically adapts the reaction network based on runtime conditions.">AdaptiveEngineView</a> is stale (i.e., <code><a class="el" href="#a44c4fb7568ddbb20a08f328c2fbf1fdf" title="Updates the active species and reactions based on the current conditions.">update()</a></code> has not been called). </td></tr>
<tr><td class="paramname">std::runtime_error</td><td>If the <a class="el" href="classgridfire_1_1_adaptive_engine_view.html" title="An engine view that dynamically adapts the reaction network based on runtime conditions.">AdaptiveEngineView</a> is stale (i.e., <code><a class="el" href="#a7d61e73f5158f1574cda3edc90c51f7e" title="Updates the active species and reactions based on the current conditions.">update()</a></code> has not been called). </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#a44c4fb7568ddbb20a08f328c2fbf1fdf" title="Updates the active species and reactions based on the current conditions.">AdaptiveEngineView::update()</a> </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#a7d61e73f5158f1574cda3edc90c51f7e" title="Updates the active species and reactions based on the current conditions.">AdaptiveEngineView::update()</a> </dd></dl>
<p>Implements <a class="el" href="classgridfire_1_1_dynamic_engine.html#a0a2fb3435ee3271ab9c806f225c61a7f">gridfire::DynamicEngine</a>.</p>
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8cpp_source.html#l00241">241</a> of file <a class="el" href="engine__adaptive_8cpp_source.html">engine_adaptive.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8cpp_source.html#l00138">138</a> of file <a class="el" href="engine__adaptive_8cpp_source.html">engine_adaptive.cpp</a>.</p>
</div>
</div>
@@ -602,7 +740,7 @@ Private Attributes</h2></td></tr>
<p>This method calls the base engine to generate the stoichiometry matrix.</p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">std::runtime_error</td><td>If the <a class="el" href="classgridfire_1_1_adaptive_engine_view.html" title="An engine view that dynamically adapts the reaction network based on runtime conditions.">AdaptiveEngineView</a> is stale (i.e., <code><a class="el" href="#a44c4fb7568ddbb20a08f328c2fbf1fdf" title="Updates the active species and reactions based on the current conditions.">update()</a></code> has not been called). </td></tr>
<tr><td class="paramname">std::runtime_error</td><td>If the <a class="el" href="classgridfire_1_1_adaptive_engine_view.html" title="An engine view that dynamically adapts the reaction network based on runtime conditions.">AdaptiveEngineView</a> is stale (i.e., <code><a class="el" href="#a7d61e73f5158f1574cda3edc90c51f7e" title="Updates the active species and reactions based on the current conditions.">update()</a></code> has not been called). </td></tr>
</table>
</dd>
</dl>
@@ -610,7 +748,7 @@ Private Attributes</h2></td></tr>
<p>Implements <a class="el" href="classgridfire_1_1_dynamic_engine.html#aeae6d84ef74d88fd2cdf07b82e98a16f">gridfire::DynamicEngine</a>.</p>
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8cpp_source.html#l00263">263</a> of file <a class="el" href="engine__adaptive_8cpp_source.html">engine_adaptive.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8cpp_source.html#l00160">160</a> of file <a class="el" href="engine__adaptive_8cpp_source.html">engine_adaptive.cpp</a>.</p>
</div>
</div>
@@ -632,7 +770,7 @@ Private Attributes</h2></td></tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span></span> </td>
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel nodiscard">nodiscard</span><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
@@ -642,7 +780,7 @@ Private Attributes</h2></td></tr>
<p>Implements <a class="el" href="classgridfire_1_1_engine_view.html#ad294227f8b5cf6d970c349eabf5447a6">gridfire::EngineView&lt; DynamicEngine &gt;</a>.</p>
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8h_source.html#l00224">224</a> of file <a class="el" href="engine__adaptive_8h_source.html">engine_adaptive.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8h_source.html#l00226">226</a> of file <a class="el" href="engine__adaptive_8h_source.html">engine_adaptive.h</a>.</p>
</div>
</div>
@@ -668,7 +806,7 @@ Private Attributes</h2></td></tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span></span> </td>
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
@@ -685,16 +823,16 @@ Private Attributes</h2></td></tr>
<p>This method maps the culled indices to the full network indices and calls the base engine to get the Jacobian matrix entry.</p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">std::runtime_error</td><td>If the <a class="el" href="classgridfire_1_1_adaptive_engine_view.html" title="An engine view that dynamically adapts the reaction network based on runtime conditions.">AdaptiveEngineView</a> is stale (i.e., <code><a class="el" href="#a44c4fb7568ddbb20a08f328c2fbf1fdf" title="Updates the active species and reactions based on the current conditions.">update()</a></code> has not been called). </td></tr>
<tr><td class="paramname">std::runtime_error</td><td>If the <a class="el" href="classgridfire_1_1_adaptive_engine_view.html" title="An engine view that dynamically adapts the reaction network based on runtime conditions.">AdaptiveEngineView</a> is stale (i.e., <code><a class="el" href="#a7d61e73f5158f1574cda3edc90c51f7e" title="Updates the active species and reactions based on the current conditions.">update()</a></code> has not been called). </td></tr>
<tr><td class="paramname">std::out_of_range</td><td>If the culled index is out of bounds for the species index map. </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#a44c4fb7568ddbb20a08f328c2fbf1fdf" title="Updates the active species and reactions based on the current conditions.">AdaptiveEngineView::update()</a> </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#a7d61e73f5158f1574cda3edc90c51f7e" title="Updates the active species and reactions based on the current conditions.">AdaptiveEngineView::update()</a> </dd></dl>
<p>Implements <a class="el" href="classgridfire_1_1_dynamic_engine.html#a05d15ff35a6bc06a2fa7eda19838bd07">gridfire::DynamicEngine</a>.</p>
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8cpp_source.html#l00252">252</a> of file <a class="el" href="engine__adaptive_8cpp_source.html">engine_adaptive.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8cpp_source.html#l00149">149</a> of file <a class="el" href="engine__adaptive_8cpp_source.html">engine_adaptive.cpp</a>.</p>
</div>
</div>
@@ -708,7 +846,7 @@ Private Attributes</h2></td></tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classgridfire_1_1reaction_1_1_logical_reaction_set.html">reaction::LogicalReactionSet</a> &amp; gridfire::AdaptiveEngineView::getNetworkReactions </td>
<td class="memname">const <a class="el" href="namespacegridfire_1_1reaction.html#aa86f08712565f278adacc7cd2361eb31">reaction::LogicalReactionSet</a> &amp; gridfire::AdaptiveEngineView::getNetworkReactions </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
@@ -716,7 +854,7 @@ Private Attributes</h2></td></tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span></span> </td>
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
@@ -726,7 +864,7 @@ Private Attributes</h2></td></tr>
<p>Implements <a class="el" href="classgridfire_1_1_dynamic_engine.html#ad2a82099edbb374bbb2c9509ccdb1037">gridfire::DynamicEngine</a>.</p>
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8cpp_source.html#l00295">295</a> of file <a class="el" href="engine__adaptive_8cpp_source.html">engine_adaptive.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8cpp_source.html#l00192">192</a> of file <a class="el" href="engine__adaptive_8cpp_source.html">engine_adaptive.cpp</a>.</p>
</div>
</div>
@@ -748,7 +886,7 @@ Private Attributes</h2></td></tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span></span> </td>
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
@@ -758,7 +896,36 @@ Private Attributes</h2></td></tr>
<p>Implements <a class="el" href="classgridfire_1_1_engine.html#a020e1b493d6964cafdad08fde697ceb3">gridfire::Engine</a>.</p>
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8cpp_source.html#l00219">219</a> of file <a class="el" href="engine__adaptive_8cpp_source.html">engine_adaptive.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8cpp_source.html#l00116">116</a> of file <a class="el" href="engine__adaptive_8cpp_source.html">engine_adaptive.cpp</a>.</p>
</div>
</div>
<a id="a0ab1199f900a58f309c3c36532c9164f" name="a0ab1199f900a58f309c3c36532c9164f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ab1199f900a58f309c3c36532c9164f">&#9670;&#160;</a></span>getScreeningModel()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacegridfire_1_1screening.html#aa82aafbc4f8c28d0a75b60798e3a7d25">screening::ScreeningType</a> gridfire::AdaptiveEngineView::getScreeningModel </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="classgridfire_1_1_dynamic_engine.html#a7a203f8e0f3a6744ddc912dfbcfdbcc0">gridfire::DynamicEngine</a>.</p>
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8cpp_source.html#l00220">220</a> of file <a class="el" href="engine__adaptive_8cpp_source.html">engine_adaptive.cpp</a>.</p>
</div>
</div>
@@ -789,7 +956,7 @@ Private Attributes</h2></td></tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span></span> </td>
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
@@ -807,14 +974,14 @@ Private Attributes</h2></td></tr>
<p>This method maps the culled abundances to the full network abundances and calls the base engine to compute the species timescales.</p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">std::runtime_error</td><td>If the <a class="el" href="classgridfire_1_1_adaptive_engine_view.html" title="An engine view that dynamically adapts the reaction network based on runtime conditions.">AdaptiveEngineView</a> is stale (i.e., <code><a class="el" href="#a44c4fb7568ddbb20a08f328c2fbf1fdf" title="Updates the active species and reactions based on the current conditions.">update()</a></code> has not been called). </td></tr>
<tr><td class="paramname">std::runtime_error</td><td>If the <a class="el" href="classgridfire_1_1_adaptive_engine_view.html" title="An engine view that dynamically adapts the reaction network based on runtime conditions.">AdaptiveEngineView</a> is stale (i.e., <code><a class="el" href="#a7d61e73f5158f1574cda3edc90c51f7e" title="Updates the active species and reactions based on the current conditions.">update()</a></code> has not been called). </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classgridfire_1_1_dynamic_engine.html#a5d8ba98b230d2849035ee2507728fa15">gridfire::DynamicEngine</a>.</p>
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8cpp_source.html#l00299">299</a> of file <a class="el" href="engine__adaptive_8cpp_source.html">engine_adaptive.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8cpp_source.html#l00196">196</a> of file <a class="el" href="engine__adaptive_8cpp_source.html">engine_adaptive.cpp</a>.</p>
</div>
</div>
@@ -840,7 +1007,7 @@ Private Attributes</h2></td></tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span></span> </td>
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
@@ -857,16 +1024,16 @@ Private Attributes</h2></td></tr>
<p>This method maps the culled indices to the full network indices and calls the base engine to get the stoichiometry matrix entry.</p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">std::runtime_error</td><td>If the <a class="el" href="classgridfire_1_1_adaptive_engine_view.html" title="An engine view that dynamically adapts the reaction network based on runtime conditions.">AdaptiveEngineView</a> is stale (i.e., <code><a class="el" href="#a44c4fb7568ddbb20a08f328c2fbf1fdf" title="Updates the active species and reactions based on the current conditions.">update()</a></code> has not been called). </td></tr>
<tr><td class="paramname">std::runtime_error</td><td>If the <a class="el" href="classgridfire_1_1_adaptive_engine_view.html" title="An engine view that dynamically adapts the reaction network based on runtime conditions.">AdaptiveEngineView</a> is stale (i.e., <code><a class="el" href="#a7d61e73f5158f1574cda3edc90c51f7e" title="Updates the active species and reactions based on the current conditions.">update()</a></code> has not been called). </td></tr>
<tr><td class="paramname">std::out_of_range</td><td>If the culled index is out of bounds for the species or reaction index map. </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#a44c4fb7568ddbb20a08f328c2fbf1fdf" title="Updates the active species and reactions based on the current conditions.">AdaptiveEngineView::update()</a> </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#a7d61e73f5158f1574cda3edc90c51f7e" title="Updates the active species and reactions based on the current conditions.">AdaptiveEngineView::update()</a> </dd></dl>
<p>Implements <a class="el" href="classgridfire_1_1_dynamic_engine.html#afa108dd5227dbb1045e90d7b3bd8b84f">gridfire::DynamicEngine</a>.</p>
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8cpp_source.html#l00268">268</a> of file <a class="el" href="engine__adaptive_8cpp_source.html">engine_adaptive.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8cpp_source.html#l00165">165</a> of file <a class="el" href="engine__adaptive_8cpp_source.html">engine_adaptive.cpp</a>.</p>
</div>
</div>
@@ -888,7 +1055,7 @@ Private Attributes</h2></td></tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
@@ -902,7 +1069,7 @@ Private Attributes</h2></td></tr>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A vector of abundances for the full network, with the abundances of the active species copied from the culled vector. </dd></dl>
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8cpp_source.html#l00319">319</a> of file <a class="el" href="engine__adaptive_8cpp_source.html">engine_adaptive.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8cpp_source.html#l00224">224</a> of file <a class="el" href="engine__adaptive_8cpp_source.html">engine_adaptive.cpp</a>.</p>
</div>
</div>
@@ -924,7 +1091,7 @@ Private Attributes</h2></td></tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
@@ -944,7 +1111,7 @@ Private Attributes</h2></td></tr>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8cpp_source.html#l00346">346</a> of file <a class="el" href="engine__adaptive_8cpp_source.html">engine_adaptive.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8cpp_source.html#l00251">251</a> of file <a class="el" href="engine__adaptive_8cpp_source.html">engine_adaptive.cpp</a>.</p>
</div>
</div>
@@ -966,7 +1133,7 @@ Private Attributes</h2></td></tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
@@ -986,7 +1153,7 @@ Private Attributes</h2></td></tr>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8cpp_source.html#l00337">337</a> of file <a class="el" href="engine__adaptive_8cpp_source.html">engine_adaptive.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8cpp_source.html#l00242">242</a> of file <a class="el" href="engine__adaptive_8cpp_source.html">engine_adaptive.cpp</a>.</p>
</div>
</div>
@@ -1008,7 +1175,7 @@ Private Attributes</h2></td></tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
@@ -1022,15 +1189,47 @@ Private Attributes</h2></td></tr>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A vector of abundances for the active species, with the abundances of the active species copied from the full vector. </dd></dl>
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8cpp_source.html#l00328">328</a> of file <a class="el" href="engine__adaptive_8cpp_source.html">engine_adaptive.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8cpp_source.html#l00233">233</a> of file <a class="el" href="engine__adaptive_8cpp_source.html">engine_adaptive.cpp</a>.</p>
</div>
</div>
<a id="a44c4fb7568ddbb20a08f328c2fbf1fdf" name="a44c4fb7568ddbb20a08f328c2fbf1fdf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a44c4fb7568ddbb20a08f328c2fbf1fdf">&#9670;&#160;</a></span>update()</h2>
<a id="aae4ddbef1c4e2202fd236221a4bf376b" name="aae4ddbef1c4e2202fd236221a4bf376b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aae4ddbef1c4e2202fd236221a4bf376b">&#9670;&#160;</a></span>setScreeningModel()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void gridfire::AdaptiveEngineView::setScreeningModel </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacegridfire_1_1screening.html#aa82aafbc4f8c28d0a75b60798e3a7d25">screening::ScreeningType</a></td> <td class="paramname"><span class="paramname"><em>model</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="classgridfire_1_1_dynamic_engine.html#a3fb44b6f55563a2f590f31916528f2bd">gridfire::DynamicEngine</a>.</p>
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8cpp_source.html#l00216">216</a> of file <a class="el" href="engine__adaptive_8cpp_source.html">engine_adaptive.cpp</a>.</p>
</div>
</div>
<a id="a7d61e73f5158f1574cda3edc90c51f7e" name="a7d61e73f5158f1574cda3edc90c51f7e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7d61e73f5158f1574cda3edc90c51f7e">&#9670;&#160;</a></span>update()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void gridfire::AdaptiveEngineView::update </td>
@@ -1039,6 +1238,11 @@ Private Attributes</h2></td></tr>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Updates the active species and reactions based on the current conditions. </p>
@@ -1065,6 +1269,8 @@ Private Attributes</h2></td></tr>
<dd>
<a class="el" href="#a89614f4a48f60c4170a0197f45303e7c" title="Constructs the reaction index map.">AdaptiveEngineView::constructReactionIndexMap()</a> </dd></dl>
<p>Implements <a class="el" href="classgridfire_1_1_dynamic_engine.html#acd500e1cd788df1dc105d28a20dc5f4f">gridfire::DynamicEngine</a>.</p>
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8cpp_source.html#l00085">85</a> of file <a class="el" href="engine__adaptive_8cpp_source.html">engine_adaptive.cpp</a>.</p>
</div>
@@ -1095,12 +1301,12 @@ Private Attributes</h2></td></tr>
<p>Validates that the <a class="el" href="classgridfire_1_1_adaptive_engine_view.html" title="An engine view that dynamically adapts the reaction network based on runtime conditions.">AdaptiveEngineView</a> is not stale. </p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">std::runtime_error</td><td>If the <a class="el" href="classgridfire_1_1_adaptive_engine_view.html" title="An engine view that dynamically adapts the reaction network based on runtime conditions.">AdaptiveEngineView</a> is stale (i.e., <code><a class="el" href="#a44c4fb7568ddbb20a08f328c2fbf1fdf" title="Updates the active species and reactions based on the current conditions.">update()</a></code> has not been called). </td></tr>
<tr><td class="paramname">std::runtime_error</td><td>If the <a class="el" href="classgridfire_1_1_adaptive_engine_view.html" title="An engine view that dynamically adapts the reaction network based on runtime conditions.">AdaptiveEngineView</a> is stale (i.e., <code><a class="el" href="#a7d61e73f5158f1574cda3edc90c51f7e" title="Updates the active species and reactions based on the current conditions.">update()</a></code> has not been called). </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8cpp_source.html#l00355">355</a> of file <a class="el" href="engine__adaptive_8cpp_source.html">engine_adaptive.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8cpp_source.html#l00260">260</a> of file <a class="el" href="engine__adaptive_8cpp_source.html">engine_adaptive.cpp</a>.</p>
</div>
</div>
@@ -1115,7 +1321,7 @@ Private Attributes</h2></td></tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classgridfire_1_1reaction_1_1_logical_reaction_set.html">reaction::LogicalReactionSet</a> gridfire::AdaptiveEngineView::m_activeReactions</td>
<td class="memname"><a class="el" href="namespacegridfire_1_1reaction.html#aa86f08712565f278adacc7cd2361eb31">reaction::LogicalReactionSet</a> gridfire::AdaptiveEngineView::m_activeReactions</td>
</tr>
</table>
</td>
@@ -1125,7 +1331,7 @@ Private Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8h_source.html#l00234">234</a> of file <a class="el" href="engine__adaptive_8h_source.html">engine_adaptive.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8h_source.html#l00240">240</a> of file <a class="el" href="engine__adaptive_8h_source.html">engine_adaptive.h</a>.</p>
</div>
</div>
@@ -1149,7 +1355,7 @@ Private Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8h_source.html#l00233">233</a> of file <a class="el" href="engine__adaptive_8h_source.html">engine_adaptive.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8h_source.html#l00239">239</a> of file <a class="el" href="engine__adaptive_8h_source.html">engine_adaptive.h</a>.</p>
</div>
</div>
@@ -1173,7 +1379,7 @@ Private Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8h_source.html#l00231">231</a> of file <a class="el" href="engine__adaptive_8h_source.html">engine_adaptive.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8h_source.html#l00237">237</a> of file <a class="el" href="engine__adaptive_8h_source.html">engine_adaptive.h</a>.</p>
</div>
</div>
@@ -1197,7 +1403,7 @@ Private Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8h_source.html#l00228">228</a> of file <a class="el" href="engine__adaptive_8h_source.html">engine_adaptive.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8h_source.html#l00234">234</a> of file <a class="el" href="engine__adaptive_8h_source.html">engine_adaptive.h</a>.</p>
</div>
</div>
@@ -1221,7 +1427,7 @@ Private Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8h_source.html#l00239">239</a> of file <a class="el" href="engine__adaptive_8h_source.html">engine_adaptive.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8h_source.html#l00245">245</a> of file <a class="el" href="engine__adaptive_8h_source.html">engine_adaptive.h</a>.</p>
</div>
</div>
@@ -1245,7 +1451,7 @@ Private Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8h_source.html#l00229">229</a> of file <a class="el" href="engine__adaptive_8h_source.html">engine_adaptive.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8h_source.html#l00235">235</a> of file <a class="el" href="engine__adaptive_8h_source.html">engine_adaptive.h</a>.</p>
</div>
</div>
@@ -1269,7 +1475,7 @@ Private Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8h_source.html#l00237">237</a> of file <a class="el" href="engine__adaptive_8h_source.html">engine_adaptive.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8h_source.html#l00243">243</a> of file <a class="el" href="engine__adaptive_8h_source.html">engine_adaptive.h</a>.</p>
</div>
</div>
@@ -1293,13 +1499,13 @@ Private Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8h_source.html#l00236">236</a> of file <a class="el" href="engine__adaptive_8h_source.html">engine_adaptive.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="engine__adaptive_8h_source.html#l00242">242</a> of file <a class="el" href="engine__adaptive_8h_source.html">engine_adaptive.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/network/include/gridfire/engine/<a class="el" href="engine__adaptive_8h_source.html">engine_adaptive.h</a></li>
<li>src/network/lib/engine/<a class="el" href="engine__adaptive_8cpp_source.html">engine_adaptive.cpp</a></li>
<li>src/network/include/gridfire/engine/views/<a class="el" href="engine__adaptive_8h_source.html">engine_adaptive.h</a></li>
<li>src/network/lib/engine/views/<a class="el" href="engine__adaptive_8cpp_source.html">engine_adaptive.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->