docs(docs): added extensive docs
This commit is contained in:
@@ -165,83 +165,83 @@ $(function(){initNavTree('engine__adaptive_8h_source.html',''); initResizable(tr
|
||||
<div class="line"><a id="l00220" name="l00220"></a><span class="lineno"> 220</span> ) <span class="keyword">const override</span>;</div>
|
||||
<div class="line"><a id="l00221" name="l00221"></a><span class="lineno"> 221</span></div>
|
||||
<div class="line"><a id="l00226" name="l00226"></a><span class="lineno"><a class="line" href="classgridfire_1_1_adaptive_engine_view.html#aee095b30a9dce5fcb5ae2fa1d2aa192c"> 226</a></span> [[nodiscard]] <span class="keyword">const</span> <a class="code hl_class" href="classgridfire_1_1_dynamic_engine.html">DynamicEngine</a>& <a class="code hl_function" href="classgridfire_1_1_adaptive_engine_view.html#aee095b30a9dce5fcb5ae2fa1d2aa192c">getBaseEngine</a>()<span class="keyword"> const override </span>{ <span class="keywordflow">return</span> <a class="code hl_variable" href="classgridfire_1_1_adaptive_engine_view.html#a4d38b46be9f25c7afe7ddd2b284253f8">m_baseEngine</a>; }</div>
|
||||
<div class="line"><a id="l00227" name="l00227"></a><span class="lineno"> 227</span> </div>
|
||||
<div class="line"><a id="l00228" name="l00228"></a><span class="lineno"> 228</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classgridfire_1_1_adaptive_engine_view.html#aae4ddbef1c4e2202fd236221a4bf376b">setScreeningModel</a>(<a class="code hl_enumeration" href="namespacegridfire_1_1screening.html#aa82aafbc4f8c28d0a75b60798e3a7d25">screening::ScreeningType</a> model) <span class="keyword">override</span>;</div>
|
||||
<div class="line"><a id="l00229" name="l00229"></a><span class="lineno"> 229</span> </div>
|
||||
<div class="line"><a id="l00230" name="l00230"></a><span class="lineno"> 230</span> [[nodiscard]] <a class="code hl_enumeration" href="namespacegridfire_1_1screening.html#aa82aafbc4f8c28d0a75b60798e3a7d25">screening::ScreeningType</a> <a class="code hl_function" href="classgridfire_1_1_adaptive_engine_view.html#a0ab1199f900a58f309c3c36532c9164f">getScreeningModel</a>() <span class="keyword">const override</span>;</div>
|
||||
<div class="line"><a id="l00231" name="l00231"></a><span class="lineno"> 231</span> <span class="keyword">private</span>:</div>
|
||||
<div class="line"><a id="l00232" name="l00232"></a><span class="lineno"><a class="line" href="classgridfire_1_1_adaptive_engine_view.html#afec39b2faa34ea65c5488dd8e11ba3c3"> 232</a></span> <span class="keyword">using </span><a class="code hl_typedef" href="classgridfire_1_1_adaptive_engine_view.html#afec39b2faa34ea65c5488dd8e11ba3c3">Config</a> = fourdst::config::Config;</div>
|
||||
<div class="line"><a id="l00233" name="l00233"></a><span class="lineno"><a class="line" href="classgridfire_1_1_adaptive_engine_view.html#a5eaf7c3a4e28cd3a4f34979b88a80103"> 233</a></span> <span class="keyword">using </span><a class="code hl_typedef" href="classgridfire_1_1_adaptive_engine_view.html#a5eaf7c3a4e28cd3a4f34979b88a80103">LogManager</a> = fourdst::logging::LogManager;</div>
|
||||
<div class="line"><a id="l00234" name="l00234"></a><span class="lineno"><a class="line" href="classgridfire_1_1_adaptive_engine_view.html#a14171a9ccc45a63996a967c72983de30"> 234</a></span> <a class="code hl_typedef" href="classgridfire_1_1_adaptive_engine_view.html#afec39b2faa34ea65c5488dd8e11ba3c3">Config</a>& <a class="code hl_variable" href="classgridfire_1_1_adaptive_engine_view.html#a14171a9ccc45a63996a967c72983de30">m_config</a> = Config::getInstance();</div>
|
||||
<div class="line"><a id="l00235" name="l00235"></a><span class="lineno"><a class="line" href="classgridfire_1_1_adaptive_engine_view.html#ac5bdbe46f87d38d9f23ece5743dcd193"> 235</a></span> quill::Logger* <a class="code hl_variable" href="classgridfire_1_1_adaptive_engine_view.html#ac5bdbe46f87d38d9f23ece5743dcd193">m_logger</a> = LogManager::getInstance().getLogger(<span class="stringliteral">"log"</span>);</div>
|
||||
<div class="line"><a id="l00236" name="l00236"></a><span class="lineno"> 236</span> </div>
|
||||
<div class="line"><a id="l00237" name="l00237"></a><span class="lineno"><a class="line" href="classgridfire_1_1_adaptive_engine_view.html#a4d38b46be9f25c7afe7ddd2b284253f8"> 237</a></span> <a class="code hl_class" href="classgridfire_1_1_dynamic_engine.html">DynamicEngine</a>& <a class="code hl_variable" href="classgridfire_1_1_adaptive_engine_view.html#a4d38b46be9f25c7afe7ddd2b284253f8">m_baseEngine</a>;</div>
|
||||
<div class="line"><a id="l00238" name="l00238"></a><span class="lineno"> 238</span> </div>
|
||||
<div class="line"><a id="l00239" name="l00239"></a><span class="lineno"><a class="line" href="classgridfire_1_1_adaptive_engine_view.html#af4bc9fc6e4afcd6a53c49ca6e2a95940"> 239</a></span> std::vector<fourdst::atomic::Species> <a class="code hl_variable" href="classgridfire_1_1_adaptive_engine_view.html#af4bc9fc6e4afcd6a53c49ca6e2a95940">m_activeSpecies</a>;</div>
|
||||
<div class="line"><a id="l00240" name="l00240"></a><span class="lineno"><a class="line" href="classgridfire_1_1_adaptive_engine_view.html#a19fc7e02e216b797aa643fa35e429800"> 240</a></span> <a class="code hl_typedef" href="namespacegridfire_1_1reaction.html#aa86f08712565f278adacc7cd2361eb31">reaction::LogicalReactionSet</a> <a class="code hl_variable" href="classgridfire_1_1_adaptive_engine_view.html#a19fc7e02e216b797aa643fa35e429800">m_activeReactions</a>;</div>
|
||||
<div class="line"><a id="l00241" name="l00241"></a><span class="lineno"> 241</span> </div>
|
||||
<div class="line"><a id="l00242" name="l00242"></a><span class="lineno"><a class="line" href="classgridfire_1_1_adaptive_engine_view.html#a5f66204a0ff5b27eed243afddecb0093"> 242</a></span> std::vector<size_t> <a class="code hl_variable" href="classgridfire_1_1_adaptive_engine_view.html#a5f66204a0ff5b27eed243afddecb0093">m_speciesIndexMap</a>;</div>
|
||||
<div class="line"><a id="l00243" name="l00243"></a><span class="lineno"><a class="line" href="classgridfire_1_1_adaptive_engine_view.html#a21c6e33bbf8c18fd5b5eaabb469054de"> 243</a></span> std::vector<size_t> <a class="code hl_variable" href="classgridfire_1_1_adaptive_engine_view.html#a21c6e33bbf8c18fd5b5eaabb469054de">m_reactionIndexMap</a>;</div>
|
||||
<div class="line"><a id="l00244" name="l00244"></a><span class="lineno"> 244</span> </div>
|
||||
<div class="line"><a id="l00245" name="l00245"></a><span class="lineno"><a class="line" href="classgridfire_1_1_adaptive_engine_view.html#a63580db57e0f48f508906a11ccfd465e"> 245</a></span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="classgridfire_1_1_adaptive_engine_view.html#a63580db57e0f48f508906a11ccfd465e">m_isStale</a> = <span class="keyword">true</span>;</div>
|
||||
<div class="line"><a id="l00246" name="l00246"></a><span class="lineno"> 246</span> </div>
|
||||
<div class="line"><a id="l00247" name="l00247"></a><span class="lineno"> 247</span> <span class="keyword">private</span>:</div>
|
||||
<div class="foldopen" id="foldopen00251" data-start="{" data-end="};">
|
||||
<div class="line"><a id="l00251" name="l00251"></a><span class="lineno"><a class="line" href="structgridfire_1_1_adaptive_engine_view_1_1_reaction_flow.html"> 251</a></span> <span class="keyword">struct </span><a class="code hl_struct" href="structgridfire_1_1_adaptive_engine_view_1_1_reaction_flow.html">ReactionFlow</a> {</div>
|
||||
<div class="line"><a id="l00252" name="l00252"></a><span class="lineno"><a class="line" href="structgridfire_1_1_adaptive_engine_view_1_1_reaction_flow.html#a3bb21f20df8115d37108cf3c3be3bc6f"> 252</a></span> <span class="keyword">const</span> <a class="code hl_class" href="classgridfire_1_1reaction_1_1_logical_reaction.html">reaction::LogicalReaction</a>* <a class="code hl_variable" href="structgridfire_1_1_adaptive_engine_view_1_1_reaction_flow.html#a3bb21f20df8115d37108cf3c3be3bc6f">reactionPtr</a>;</div>
|
||||
<div class="line"><a id="l00253" name="l00253"></a><span class="lineno"><a class="line" href="structgridfire_1_1_adaptive_engine_view_1_1_reaction_flow.html#a6c2e9087f6c8af5d89a5f0de7bd4a5b4"> 253</a></span> <span class="keywordtype">double</span> <a class="code hl_variable" href="structgridfire_1_1_adaptive_engine_view_1_1_reaction_flow.html#a6c2e9087f6c8af5d89a5f0de7bd4a5b4">flowRate</a>;</div>
|
||||
<div class="line"><a id="l00254" name="l00254"></a><span class="lineno"> 254</span> };</div>
|
||||
</div>
|
||||
<div class="line"><a id="l00255" name="l00255"></a><span class="lineno"> 255</span> <span class="keyword">private</span>:</div>
|
||||
<div class="line"><a id="l00266" name="l00266"></a><span class="lineno"> 266</span> [[nodiscard]] std::vector<size_t> <a class="code hl_function" href="classgridfire_1_1_adaptive_engine_view.html#a896d29325b4233e83d9298850b617a2d">constructSpeciesIndexMap</a>() <span class="keyword">const</span>;</div>
|
||||
<div class="line"><a id="l00267" name="l00267"></a><span class="lineno"> 267</span></div>
|
||||
<div class="line"><a id="l00278" name="l00278"></a><span class="lineno"> 278</span> [[nodiscard]] std::vector<size_t> <a class="code hl_function" href="classgridfire_1_1_adaptive_engine_view.html#a89614f4a48f60c4170a0197f45303e7c">constructReactionIndexMap</a>() <span class="keyword">const</span>;</div>
|
||||
<div class="line"><a id="l00227" name="l00227"></a><span class="lineno"> 227</span></div>
|
||||
<div class="line"><a id="l00243" name="l00243"></a><span class="lineno"> 243</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classgridfire_1_1_adaptive_engine_view.html#aae4ddbef1c4e2202fd236221a4bf376b">setScreeningModel</a>(<a class="code hl_enumeration" href="namespacegridfire_1_1screening.html#aa82aafbc4f8c28d0a75b60798e3a7d25">screening::ScreeningType</a> model) <span class="keyword">override</span>;</div>
|
||||
<div class="line"><a id="l00244" name="l00244"></a><span class="lineno"> 244</span></div>
|
||||
<div class="line"><a id="l00258" name="l00258"></a><span class="lineno"> 258</span> [[nodiscard]] <a class="code hl_enumeration" href="namespacegridfire_1_1screening.html#aa82aafbc4f8c28d0a75b60798e3a7d25">screening::ScreeningType</a> <a class="code hl_function" href="classgridfire_1_1_adaptive_engine_view.html#a0ab1199f900a58f309c3c36532c9164f">getScreeningModel</a>() <span class="keyword">const override</span>;</div>
|
||||
<div class="line"><a id="l00259" name="l00259"></a><span class="lineno"> 259</span> <span class="keyword">private</span>:</div>
|
||||
<div class="line"><a id="l00260" name="l00260"></a><span class="lineno"><a class="line" href="classgridfire_1_1_adaptive_engine_view.html#afec39b2faa34ea65c5488dd8e11ba3c3"> 260</a></span> <span class="keyword">using </span><a class="code hl_typedef" href="classgridfire_1_1_adaptive_engine_view.html#afec39b2faa34ea65c5488dd8e11ba3c3">Config</a> = fourdst::config::Config;</div>
|
||||
<div class="line"><a id="l00261" name="l00261"></a><span class="lineno"><a class="line" href="classgridfire_1_1_adaptive_engine_view.html#a5eaf7c3a4e28cd3a4f34979b88a80103"> 261</a></span> <span class="keyword">using </span><a class="code hl_typedef" href="classgridfire_1_1_adaptive_engine_view.html#a5eaf7c3a4e28cd3a4f34979b88a80103">LogManager</a> = fourdst::logging::LogManager;</div>
|
||||
<div class="line"><a id="l00263" name="l00263"></a><span class="lineno"><a class="line" href="classgridfire_1_1_adaptive_engine_view.html#a14171a9ccc45a63996a967c72983de30"> 263</a></span> <a class="code hl_typedef" href="classgridfire_1_1_adaptive_engine_view.html#afec39b2faa34ea65c5488dd8e11ba3c3">Config</a>& <a class="code hl_variable" href="classgridfire_1_1_adaptive_engine_view.html#a14171a9ccc45a63996a967c72983de30">m_config</a> = Config::getInstance();</div>
|
||||
<div class="line"><a id="l00265" name="l00265"></a><span class="lineno"><a class="line" href="classgridfire_1_1_adaptive_engine_view.html#ac5bdbe46f87d38d9f23ece5743dcd193"> 265</a></span> quill::Logger* <a class="code hl_variable" href="classgridfire_1_1_adaptive_engine_view.html#ac5bdbe46f87d38d9f23ece5743dcd193">m_logger</a> = LogManager::getInstance().getLogger(<span class="stringliteral">"log"</span>);</div>
|
||||
<div class="line"><a id="l00266" name="l00266"></a><span class="lineno"> 266</span></div>
|
||||
<div class="line"><a id="l00268" name="l00268"></a><span class="lineno"><a class="line" href="classgridfire_1_1_adaptive_engine_view.html#a4d38b46be9f25c7afe7ddd2b284253f8"> 268</a></span> <a class="code hl_class" href="classgridfire_1_1_dynamic_engine.html">DynamicEngine</a>& <a class="code hl_variable" href="classgridfire_1_1_adaptive_engine_view.html#a4d38b46be9f25c7afe7ddd2b284253f8">m_baseEngine</a>;</div>
|
||||
<div class="line"><a id="l00269" name="l00269"></a><span class="lineno"> 269</span></div>
|
||||
<div class="line"><a id="l00271" name="l00271"></a><span class="lineno"><a class="line" href="classgridfire_1_1_adaptive_engine_view.html#af4bc9fc6e4afcd6a53c49ca6e2a95940"> 271</a></span> std::vector<fourdst::atomic::Species> <a class="code hl_variable" href="classgridfire_1_1_adaptive_engine_view.html#af4bc9fc6e4afcd6a53c49ca6e2a95940">m_activeSpecies</a>;</div>
|
||||
<div class="line"><a id="l00273" name="l00273"></a><span class="lineno"><a class="line" href="classgridfire_1_1_adaptive_engine_view.html#a19fc7e02e216b797aa643fa35e429800"> 273</a></span> <a class="code hl_typedef" href="namespacegridfire_1_1reaction.html#aa86f08712565f278adacc7cd2361eb31">reaction::LogicalReactionSet</a> <a class="code hl_variable" href="classgridfire_1_1_adaptive_engine_view.html#a19fc7e02e216b797aa643fa35e429800">m_activeReactions</a>;</div>
|
||||
<div class="line"><a id="l00274" name="l00274"></a><span class="lineno"> 274</span></div>
|
||||
<div class="line"><a id="l00276" name="l00276"></a><span class="lineno"><a class="line" href="classgridfire_1_1_adaptive_engine_view.html#a5f66204a0ff5b27eed243afddecb0093"> 276</a></span> std::vector<size_t> <a class="code hl_variable" href="classgridfire_1_1_adaptive_engine_view.html#a5f66204a0ff5b27eed243afddecb0093">m_speciesIndexMap</a>;</div>
|
||||
<div class="line"><a id="l00278" name="l00278"></a><span class="lineno"><a class="line" href="classgridfire_1_1_adaptive_engine_view.html#a21c6e33bbf8c18fd5b5eaabb469054de"> 278</a></span> std::vector<size_t> <a class="code hl_variable" href="classgridfire_1_1_adaptive_engine_view.html#a21c6e33bbf8c18fd5b5eaabb469054de">m_reactionIndexMap</a>;</div>
|
||||
<div class="line"><a id="l00279" name="l00279"></a><span class="lineno"> 279</span></div>
|
||||
<div class="line"><a id="l00287" name="l00287"></a><span class="lineno"> 287</span> [[nodiscard]] std::vector<double> <a class="code hl_function" href="classgridfire_1_1_adaptive_engine_view.html#a68695f056b660e91285b7e5a931612e1">mapCulledToFull</a>(<span class="keyword">const</span> std::vector<double>& culled) <span class="keyword">const</span>;</div>
|
||||
<div class="line"><a id="l00288" name="l00288"></a><span class="lineno"> 288</span></div>
|
||||
<div class="line"><a id="l00296" name="l00296"></a><span class="lineno"> 296</span> [[nodiscard]] std::vector<double> <a class="code hl_function" href="classgridfire_1_1_adaptive_engine_view.html#a3d9d8e862d1c2f0a8ba460c57f6a7f44">mapFullToCulled</a>(<span class="keyword">const</span> std::vector<double>& full) <span class="keyword">const</span>;</div>
|
||||
<div class="line"><a id="l00297" name="l00297"></a><span class="lineno"> 297</span></div>
|
||||
<div class="line"><a id="l00306" name="l00306"></a><span class="lineno"> 306</span> [[nodiscard]] <span class="keywordtype">size_t</span> <a class="code hl_function" href="classgridfire_1_1_adaptive_engine_view.html#a256d14a333f9401039b826cc889761a8">mapCulledToFullSpeciesIndex</a>(<span class="keywordtype">size_t</span> culledSpeciesIndex) <span class="keyword">const</span>;</div>
|
||||
<div class="line"><a id="l00307" name="l00307"></a><span class="lineno"> 307</span></div>
|
||||
<div class="line"><a id="l00316" name="l00316"></a><span class="lineno"> 316</span> [[nodiscard]] <span class="keywordtype">size_t</span> <a class="code hl_function" href="classgridfire_1_1_adaptive_engine_view.html#a91e742642d8a8d9ec0620779927e5101">mapCulledToFullReactionIndex</a>(<span class="keywordtype">size_t</span> culledReactionIndex) <span class="keyword">const</span>;</div>
|
||||
<div class="line"><a id="l00317" name="l00317"></a><span class="lineno"> 317</span></div>
|
||||
<div class="line"><a id="l00323" name="l00323"></a><span class="lineno"> 323</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classgridfire_1_1_adaptive_engine_view.html#aedc0dedb51c81e03f253cc409a5d5c40">validateState</a>() <span class="keyword">const</span>;</div>
|
||||
<div class="line"><a id="l00324" name="l00324"></a><span class="lineno"> 324</span> </div>
|
||||
<div class="line"><a id="l00325" name="l00325"></a><span class="lineno"> 325</span> std::vector<ReactionFlow> <a class="code hl_function" href="classgridfire_1_1_adaptive_engine_view.html#abdbaf4b87629efe43ac1255dad424c0c">calculateAllReactionFlows</a>(</div>
|
||||
<div class="line"><a id="l00326" name="l00326"></a><span class="lineno"> 326</span> <span class="keyword">const</span> <a class="code hl_struct" href="structgridfire_1_1_net_in.html">NetIn</a>& netIn,</div>
|
||||
<div class="line"><a id="l00327" name="l00327"></a><span class="lineno"> 327</span> std::vector<double>& out_Y_Full</div>
|
||||
<div class="line"><a id="l00328" name="l00328"></a><span class="lineno"> 328</span> ) <span class="keyword">const</span>;</div>
|
||||
<div class="line"><a id="l00329" name="l00329"></a><span class="lineno"> 329</span> [[nodiscard]] std::unordered_set<fourdst::atomic::Species> <a class="code hl_function" href="classgridfire_1_1_adaptive_engine_view.html#a0ed21f7e7c1034fc87b40d4116c4221b">findReachableSpecies</a>(</div>
|
||||
<div class="line"><a id="l00330" name="l00330"></a><span class="lineno"> 330</span> <span class="keyword">const</span> <a class="code hl_struct" href="structgridfire_1_1_net_in.html">NetIn</a>& netIn</div>
|
||||
<div class="line"><a id="l00331" name="l00331"></a><span class="lineno"> 331</span> ) <span class="keyword">const</span>;</div>
|
||||
<div class="line"><a id="l00332" name="l00332"></a><span class="lineno"> 332</span> [[nodiscard]] std::vector<const reaction::LogicalReaction*> <a class="code hl_function" href="classgridfire_1_1_adaptive_engine_view.html#a42417e96fe9fd623458af109401daf08">cullReactionsByFlow</a>(</div>
|
||||
<div class="line"><a id="l00333" name="l00333"></a><span class="lineno"> 333</span> <span class="keyword">const</span> std::vector<ReactionFlow>& allFlows,</div>
|
||||
<div class="line"><a id="l00334" name="l00334"></a><span class="lineno"> 334</span> <span class="keyword">const</span> std::unordered_set<fourdst::atomic::Species>& reachableSpecies,</div>
|
||||
<div class="line"><a id="l00335" name="l00335"></a><span class="lineno"> 335</span> <span class="keyword">const</span> std::vector<double>& Y_full,</div>
|
||||
<div class="line"><a id="l00336" name="l00336"></a><span class="lineno"> 336</span> <span class="keywordtype">double</span> maxFlow</div>
|
||||
<div class="line"><a id="l00337" name="l00337"></a><span class="lineno"> 337</span> ) <span class="keyword">const</span>;</div>
|
||||
<div class="line"><a id="l00338" name="l00338"></a><span class="lineno"> 338</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classgridfire_1_1_adaptive_engine_view.html#aa79fb382c98461b02a2c30668491e6c5">finalizeActiveSet</a>(</div>
|
||||
<div class="line"><a id="l00339" name="l00339"></a><span class="lineno"> 339</span> <span class="keyword">const</span> std::vector<const reaction::LogicalReaction*>& finalReactions</div>
|
||||
<div class="line"><a id="l00340" name="l00340"></a><span class="lineno"> 340</span> );</div>
|
||||
<div class="line"><a id="l00341" name="l00341"></a><span class="lineno"> 341</span> };</div>
|
||||
<div class="line"><a id="l00281" name="l00281"></a><span class="lineno"><a class="line" href="classgridfire_1_1_adaptive_engine_view.html#a63580db57e0f48f508906a11ccfd465e"> 281</a></span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="classgridfire_1_1_adaptive_engine_view.html#a63580db57e0f48f508906a11ccfd465e">m_isStale</a> = <span class="keyword">true</span>;</div>
|
||||
<div class="line"><a id="l00282" name="l00282"></a><span class="lineno"> 282</span> </div>
|
||||
<div class="line"><a id="l00283" name="l00283"></a><span class="lineno"> 283</span> <span class="keyword">private</span>:</div>
|
||||
<div class="foldopen" id="foldopen00287" data-start="{" data-end="};">
|
||||
<div class="line"><a id="l00287" name="l00287"></a><span class="lineno"><a class="line" href="structgridfire_1_1_adaptive_engine_view_1_1_reaction_flow.html"> 287</a></span> <span class="keyword">struct </span><a class="code hl_struct" href="structgridfire_1_1_adaptive_engine_view_1_1_reaction_flow.html">ReactionFlow</a> {</div>
|
||||
<div class="line"><a id="l00288" name="l00288"></a><span class="lineno"><a class="line" href="structgridfire_1_1_adaptive_engine_view_1_1_reaction_flow.html#a3bb21f20df8115d37108cf3c3be3bc6f"> 288</a></span> <span class="keyword">const</span> <a class="code hl_class" href="classgridfire_1_1reaction_1_1_logical_reaction.html">reaction::LogicalReaction</a>* <a class="code hl_variable" href="structgridfire_1_1_adaptive_engine_view_1_1_reaction_flow.html#a3bb21f20df8115d37108cf3c3be3bc6f">reactionPtr</a>;</div>
|
||||
<div class="line"><a id="l00289" name="l00289"></a><span class="lineno"><a class="line" href="structgridfire_1_1_adaptive_engine_view_1_1_reaction_flow.html#a6c2e9087f6c8af5d89a5f0de7bd4a5b4"> 289</a></span> <span class="keywordtype">double</span> <a class="code hl_variable" href="structgridfire_1_1_adaptive_engine_view_1_1_reaction_flow.html#a6c2e9087f6c8af5d89a5f0de7bd4a5b4">flowRate</a>;</div>
|
||||
<div class="line"><a id="l00290" name="l00290"></a><span class="lineno"> 290</span> };</div>
|
||||
</div>
|
||||
<div class="line"><a id="l00342" name="l00342"></a><span class="lineno"> 342</span>}</div>
|
||||
<div class="line"><a id="l00291" name="l00291"></a><span class="lineno"> 291</span> <span class="keyword">private</span>:</div>
|
||||
<div class="line"><a id="l00302" name="l00302"></a><span class="lineno"> 302</span> [[nodiscard]] std::vector<size_t> <a class="code hl_function" href="classgridfire_1_1_adaptive_engine_view.html#a896d29325b4233e83d9298850b617a2d">constructSpeciesIndexMap</a>() <span class="keyword">const</span>;</div>
|
||||
<div class="line"><a id="l00303" name="l00303"></a><span class="lineno"> 303</span></div>
|
||||
<div class="line"><a id="l00314" name="l00314"></a><span class="lineno"> 314</span> [[nodiscard]] std::vector<size_t> <a class="code hl_function" href="classgridfire_1_1_adaptive_engine_view.html#a89614f4a48f60c4170a0197f45303e7c">constructReactionIndexMap</a>() <span class="keyword">const</span>;</div>
|
||||
<div class="line"><a id="l00315" name="l00315"></a><span class="lineno"> 315</span></div>
|
||||
<div class="line"><a id="l00323" name="l00323"></a><span class="lineno"> 323</span> [[nodiscard]] std::vector<double> <a class="code hl_function" href="classgridfire_1_1_adaptive_engine_view.html#a68695f056b660e91285b7e5a931612e1">mapCulledToFull</a>(<span class="keyword">const</span> std::vector<double>& culled) <span class="keyword">const</span>;</div>
|
||||
<div class="line"><a id="l00324" name="l00324"></a><span class="lineno"> 324</span></div>
|
||||
<div class="line"><a id="l00332" name="l00332"></a><span class="lineno"> 332</span> [[nodiscard]] std::vector<double> <a class="code hl_function" href="classgridfire_1_1_adaptive_engine_view.html#a3d9d8e862d1c2f0a8ba460c57f6a7f44">mapFullToCulled</a>(<span class="keyword">const</span> std::vector<double>& full) <span class="keyword">const</span>;</div>
|
||||
<div class="line"><a id="l00333" name="l00333"></a><span class="lineno"> 333</span></div>
|
||||
<div class="line"><a id="l00342" name="l00342"></a><span class="lineno"> 342</span> [[nodiscard]] <span class="keywordtype">size_t</span> <a class="code hl_function" href="classgridfire_1_1_adaptive_engine_view.html#a256d14a333f9401039b826cc889761a8">mapCulledToFullSpeciesIndex</a>(<span class="keywordtype">size_t</span> culledSpeciesIndex) <span class="keyword">const</span>;</div>
|
||||
<div class="line"><a id="l00343" name="l00343"></a><span class="lineno"> 343</span></div>
|
||||
<div class="line"><a id="l00352" name="l00352"></a><span class="lineno"> 352</span> [[nodiscard]] <span class="keywordtype">size_t</span> <a class="code hl_function" href="classgridfire_1_1_adaptive_engine_view.html#a91e742642d8a8d9ec0620779927e5101">mapCulledToFullReactionIndex</a>(<span class="keywordtype">size_t</span> culledReactionIndex) <span class="keyword">const</span>;</div>
|
||||
<div class="line"><a id="l00353" name="l00353"></a><span class="lineno"> 353</span></div>
|
||||
<div class="line"><a id="l00359" name="l00359"></a><span class="lineno"> 359</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classgridfire_1_1_adaptive_engine_view.html#aedc0dedb51c81e03f253cc409a5d5c40">validateState</a>() <span class="keyword">const</span>;</div>
|
||||
<div class="line"><a id="l00360" name="l00360"></a><span class="lineno"> 360</span></div>
|
||||
<div class="line"><a id="l00382" name="l00382"></a><span class="lineno"> 382</span> std::vector<ReactionFlow> <a class="code hl_function" href="classgridfire_1_1_adaptive_engine_view.html#abdbaf4b87629efe43ac1255dad424c0c">calculateAllReactionFlows</a>(</div>
|
||||
<div class="line"><a id="l00383" name="l00383"></a><span class="lineno"> 383</span> <span class="keyword">const</span> <a class="code hl_struct" href="structgridfire_1_1_net_in.html">NetIn</a>& netIn,</div>
|
||||
<div class="line"><a id="l00384" name="l00384"></a><span class="lineno"> 384</span> std::vector<double>& out_Y_Full</div>
|
||||
<div class="line"><a id="l00385" name="l00385"></a><span class="lineno"> 385</span> ) <span class="keyword">const</span>;</div>
|
||||
<div class="line"><a id="l00403" name="l00403"></a><span class="lineno"> 403</span> [[nodiscard]] std::unordered_set<fourdst::atomic::Species> <a class="code hl_function" href="classgridfire_1_1_adaptive_engine_view.html#a0ed21f7e7c1034fc87b40d4116c4221b">findReachableSpecies</a>(</div>
|
||||
<div class="line"><a id="l00404" name="l00404"></a><span class="lineno"> 404</span> <span class="keyword">const</span> <a class="code hl_struct" href="structgridfire_1_1_net_in.html">NetIn</a>& netIn</div>
|
||||
<div class="line"><a id="l00405" name="l00405"></a><span class="lineno"> 405</span> ) <span class="keyword">const</span>;</div>
|
||||
<div class="line"><a id="l00426" name="l00426"></a><span class="lineno"> 426</span> [[nodiscard]] std::vector<const reaction::LogicalReaction*> <a class="code hl_function" href="classgridfire_1_1_adaptive_engine_view.html#a42417e96fe9fd623458af109401daf08">cullReactionsByFlow</a>(</div>
|
||||
<div class="line"><a id="l00427" name="l00427"></a><span class="lineno"> 427</span> <span class="keyword">const</span> std::vector<ReactionFlow>& allFlows,</div>
|
||||
<div class="line"><a id="l00428" name="l00428"></a><span class="lineno"> 428</span> <span class="keyword">const</span> std::unordered_set<fourdst::atomic::Species>& reachableSpecies,</div>
|
||||
<div class="line"><a id="l00429" name="l00429"></a><span class="lineno"> 429</span> <span class="keyword">const</span> std::vector<double>& Y_full,</div>
|
||||
<div class="line"><a id="l00430" name="l00430"></a><span class="lineno"> 430</span> <span class="keywordtype">double</span> maxFlow</div>
|
||||
<div class="line"><a id="l00431" name="l00431"></a><span class="lineno"> 431</span> ) <span class="keyword">const</span>;</div>
|
||||
<div class="line"><a id="l00447" name="l00447"></a><span class="lineno"> 447</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classgridfire_1_1_adaptive_engine_view.html#aa79fb382c98461b02a2c30668491e6c5">finalizeActiveSet</a>(</div>
|
||||
<div class="line"><a id="l00448" name="l00448"></a><span class="lineno"> 448</span> <span class="keyword">const</span> std::vector<const reaction::LogicalReaction*>& finalReactions</div>
|
||||
<div class="line"><a id="l00449" name="l00449"></a><span class="lineno"> 449</span> );</div>
|
||||
<div class="line"><a id="l00450" name="l00450"></a><span class="lineno"> 450</span> };</div>
|
||||
</div>
|
||||
<div class="line"><a id="l00451" name="l00451"></a><span class="lineno"> 451</span>}</div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_adaptive_engine_view_html_a048d4b1d41ecb4125a558d1b9ed7cb31"><div class="ttname"><a href="classgridfire_1_1_adaptive_engine_view.html#a048d4b1d41ecb4125a558d1b9ed7cb31">gridfire::AdaptiveEngineView::calculateMolarReactionFlow</a></div><div class="ttdeci">double calculateMolarReactionFlow(const reaction::Reaction &reaction, const std::vector< double > &Y_culled, double T9, double rho) const override</div><div class="ttdoc">Calculates the molar reaction flow for a given reaction in the active network.</div><div class="ttdef"><b>Definition</b> <a href="engine__adaptive_8cpp_source.html#l00175">engine_adaptive.cpp:175</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_adaptive_engine_view_html_a0ab1199f900a58f309c3c36532c9164f"><div class="ttname"><a href="classgridfire_1_1_adaptive_engine_view.html#a0ab1199f900a58f309c3c36532c9164f">gridfire::AdaptiveEngineView::getScreeningModel</a></div><div class="ttdeci">screening::ScreeningType getScreeningModel() const override</div><div class="ttdef"><b>Definition</b> <a href="engine__adaptive_8cpp_source.html#l00220">engine_adaptive.cpp:220</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_adaptive_engine_view_html_a0ed21f7e7c1034fc87b40d4116c4221b"><div class="ttname"><a href="classgridfire_1_1_adaptive_engine_view.html#a0ed21f7e7c1034fc87b40d4116c4221b">gridfire::AdaptiveEngineView::findReachableSpecies</a></div><div class="ttdeci">std::unordered_set< fourdst::atomic::Species > findReachableSpecies(const NetIn &netIn) const</div><div class="ttdef"><b>Definition</b> <a href="engine__adaptive_8cpp_source.html#l00299">engine_adaptive.cpp:299</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_adaptive_engine_view_html_a0ab1199f900a58f309c3c36532c9164f"><div class="ttname"><a href="classgridfire_1_1_adaptive_engine_view.html#a0ab1199f900a58f309c3c36532c9164f">gridfire::AdaptiveEngineView::getScreeningModel</a></div><div class="ttdeci">screening::ScreeningType getScreeningModel() const override</div><div class="ttdoc">Gets the screening model from the base engine.</div><div class="ttdef"><b>Definition</b> <a href="engine__adaptive_8cpp_source.html#l00220">engine_adaptive.cpp:220</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_adaptive_engine_view_html_a0ed21f7e7c1034fc87b40d4116c4221b"><div class="ttname"><a href="classgridfire_1_1_adaptive_engine_view.html#a0ed21f7e7c1034fc87b40d4116c4221b">gridfire::AdaptiveEngineView::findReachableSpecies</a></div><div class="ttdeci">std::unordered_set< fourdst::atomic::Species > findReachableSpecies(const NetIn &netIn) const</div><div class="ttdoc">Finds all species that are reachable from the initial fuel through the reaction network.</div><div class="ttdef"><b>Definition</b> <a href="engine__adaptive_8cpp_source.html#l00299">engine_adaptive.cpp:299</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_adaptive_engine_view_html_a12cc2f352678fba9688363ba1876ab9c"><div class="ttname"><a href="classgridfire_1_1_adaptive_engine_view.html#a12cc2f352678fba9688363ba1876ab9c">gridfire::AdaptiveEngineView::getNetworkReactions</a></div><div class="ttdeci">const reaction::LogicalReactionSet & getNetworkReactions() const override</div><div class="ttdoc">Gets the set of active logical reactions in the network.</div><div class="ttdef"><b>Definition</b> <a href="engine__adaptive_8cpp_source.html#l00192">engine_adaptive.cpp:192</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_adaptive_engine_view_html_a14171a9ccc45a63996a967c72983de30"><div class="ttname"><a href="classgridfire_1_1_adaptive_engine_view.html#a14171a9ccc45a63996a967c72983de30">gridfire::AdaptiveEngineView::m_config</a></div><div class="ttdeci">Config & m_config</div><div class="ttdef"><b>Definition</b> <a href="#l00234">engine_adaptive.h:234</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_adaptive_engine_view_html_a19fc7e02e216b797aa643fa35e429800"><div class="ttname"><a href="classgridfire_1_1_adaptive_engine_view.html#a19fc7e02e216b797aa643fa35e429800">gridfire::AdaptiveEngineView::m_activeReactions</a></div><div class="ttdeci">reaction::LogicalReactionSet m_activeReactions</div><div class="ttdef"><b>Definition</b> <a href="#l00240">engine_adaptive.h:240</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_adaptive_engine_view_html_a21c6e33bbf8c18fd5b5eaabb469054de"><div class="ttname"><a href="classgridfire_1_1_adaptive_engine_view.html#a21c6e33bbf8c18fd5b5eaabb469054de">gridfire::AdaptiveEngineView::m_reactionIndexMap</a></div><div class="ttdeci">std::vector< size_t > m_reactionIndexMap</div><div class="ttdef"><b>Definition</b> <a href="#l00243">engine_adaptive.h:243</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_adaptive_engine_view_html_a14171a9ccc45a63996a967c72983de30"><div class="ttname"><a href="classgridfire_1_1_adaptive_engine_view.html#a14171a9ccc45a63996a967c72983de30">gridfire::AdaptiveEngineView::m_config</a></div><div class="ttdeci">Config & m_config</div><div class="ttdoc">A reference to the singleton Config instance, used for retrieving configuration parameters.</div><div class="ttdef"><b>Definition</b> <a href="#l00263">engine_adaptive.h:263</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_adaptive_engine_view_html_a19fc7e02e216b797aa643fa35e429800"><div class="ttname"><a href="classgridfire_1_1_adaptive_engine_view.html#a19fc7e02e216b797aa643fa35e429800">gridfire::AdaptiveEngineView::m_activeReactions</a></div><div class="ttdeci">reaction::LogicalReactionSet m_activeReactions</div><div class="ttdoc">The set of reactions that are currently active in the network.</div><div class="ttdef"><b>Definition</b> <a href="#l00273">engine_adaptive.h:273</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_adaptive_engine_view_html_a21c6e33bbf8c18fd5b5eaabb469054de"><div class="ttname"><a href="classgridfire_1_1_adaptive_engine_view.html#a21c6e33bbf8c18fd5b5eaabb469054de">gridfire::AdaptiveEngineView::m_reactionIndexMap</a></div><div class="ttdeci">std::vector< size_t > m_reactionIndexMap</div><div class="ttdoc">A map from the indices of the active reactions to the indices of the corresponding reactions in the f...</div><div class="ttdef"><b>Definition</b> <a href="#l00278">engine_adaptive.h:278</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_adaptive_engine_view_html_a231193a61ba5a31e8eb92b0d4ce69111"><div class="ttname"><a href="classgridfire_1_1_adaptive_engine_view.html#a231193a61ba5a31e8eb92b0d4ce69111">gridfire::AdaptiveEngineView::generateStoichiometryMatrix</a></div><div class="ttdeci">void generateStoichiometryMatrix() override</div><div class="ttdoc">Generates the stoichiometry matrix for the active reactions and species.</div><div class="ttdef"><b>Definition</b> <a href="engine__adaptive_8cpp_source.html#l00160">engine_adaptive.cpp:160</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_adaptive_engine_view_html_a256d14a333f9401039b826cc889761a8"><div class="ttname"><a href="classgridfire_1_1_adaptive_engine_view.html#a256d14a333f9401039b826cc889761a8">gridfire::AdaptiveEngineView::mapCulledToFullSpeciesIndex</a></div><div class="ttdeci">size_t mapCulledToFullSpeciesIndex(size_t culledSpeciesIndex) const</div><div class="ttdoc">Maps a culled species index to a full species index.</div><div class="ttdef"><b>Definition</b> <a href="engine__adaptive_8cpp_source.html#l00242">engine_adaptive.cpp:242</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_adaptive_engine_view_html_a3d9d8e862d1c2f0a8ba460c57f6a7f44"><div class="ttname"><a href="classgridfire_1_1_adaptive_engine_view.html#a3d9d8e862d1c2f0a8ba460c57f6a7f44">gridfire::AdaptiveEngineView::mapFullToCulled</a></div><div class="ttdeci">std::vector< double > mapFullToCulled(const std::vector< double > &full) const</div><div class="ttdoc">Maps a vector of full abundances to a vector of culled abundances.</div><div class="ttdef"><b>Definition</b> <a href="engine__adaptive_8cpp_source.html#l00233">engine_adaptive.cpp:233</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_adaptive_engine_view_html_a42417e96fe9fd623458af109401daf08"><div class="ttname"><a href="classgridfire_1_1_adaptive_engine_view.html#a42417e96fe9fd623458af109401daf08">gridfire::AdaptiveEngineView::cullReactionsByFlow</a></div><div class="ttdeci">std::vector< const reaction::LogicalReaction * > cullReactionsByFlow(const std::vector< ReactionFlow > &allFlows, const std::unordered_set< fourdst::atomic::Species > &reachableSpecies, const std::vector< double > &Y_full, double maxFlow) const</div><div class="ttdef"><b>Definition</b> <a href="engine__adaptive_8cpp_source.html#l00342">engine_adaptive.cpp:342</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_adaptive_engine_view_html_a42417e96fe9fd623458af109401daf08"><div class="ttname"><a href="classgridfire_1_1_adaptive_engine_view.html#a42417e96fe9fd623458af109401daf08">gridfire::AdaptiveEngineView::cullReactionsByFlow</a></div><div class="ttdeci">std::vector< const reaction::LogicalReaction * > cullReactionsByFlow(const std::vector< ReactionFlow > &allFlows, const std::unordered_set< fourdst::atomic::Species > &reachableSpecies, const std::vector< double > &Y_full, double maxFlow) const</div><div class="ttdoc">Culls reactions from the network based on their flow rates.</div><div class="ttdef"><b>Definition</b> <a href="engine__adaptive_8cpp_source.html#l00342">engine_adaptive.cpp:342</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_adaptive_engine_view_html_a4710d218c8a0fd161e994ecd60b48e58"><div class="ttname"><a href="classgridfire_1_1_adaptive_engine_view.html#a4710d218c8a0fd161e994ecd60b48e58">gridfire::AdaptiveEngineView::getJacobianMatrixEntry</a></div><div class="ttdeci">double getJacobianMatrixEntry(const int i_culled, const int j_culled) const override</div><div class="ttdoc">Gets an entry from the Jacobian matrix for the active species.</div><div class="ttdef"><b>Definition</b> <a href="engine__adaptive_8cpp_source.html#l00149">engine_adaptive.cpp:149</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_adaptive_engine_view_html_a4d38b46be9f25c7afe7ddd2b284253f8"><div class="ttname"><a href="classgridfire_1_1_adaptive_engine_view.html#a4d38b46be9f25c7afe7ddd2b284253f8">gridfire::AdaptiveEngineView::m_baseEngine</a></div><div class="ttdeci">DynamicEngine & m_baseEngine</div><div class="ttdef"><b>Definition</b> <a href="#l00237">engine_adaptive.h:237</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_adaptive_engine_view_html_a5eaf7c3a4e28cd3a4f34979b88a80103"><div class="ttname"><a href="classgridfire_1_1_adaptive_engine_view.html#a5eaf7c3a4e28cd3a4f34979b88a80103">gridfire::AdaptiveEngineView::LogManager</a></div><div class="ttdeci">fourdst::logging::LogManager LogManager</div><div class="ttdef"><b>Definition</b> <a href="#l00233">engine_adaptive.h:233</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_adaptive_engine_view_html_a5f66204a0ff5b27eed243afddecb0093"><div class="ttname"><a href="classgridfire_1_1_adaptive_engine_view.html#a5f66204a0ff5b27eed243afddecb0093">gridfire::AdaptiveEngineView::m_speciesIndexMap</a></div><div class="ttdeci">std::vector< size_t > m_speciesIndexMap</div><div class="ttdef"><b>Definition</b> <a href="#l00242">engine_adaptive.h:242</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_adaptive_engine_view_html_a63580db57e0f48f508906a11ccfd465e"><div class="ttname"><a href="classgridfire_1_1_adaptive_engine_view.html#a63580db57e0f48f508906a11ccfd465e">gridfire::AdaptiveEngineView::m_isStale</a></div><div class="ttdeci">bool m_isStale</div><div class="ttdef"><b>Definition</b> <a href="#l00245">engine_adaptive.h:245</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_adaptive_engine_view_html_a4d38b46be9f25c7afe7ddd2b284253f8"><div class="ttname"><a href="classgridfire_1_1_adaptive_engine_view.html#a4d38b46be9f25c7afe7ddd2b284253f8">gridfire::AdaptiveEngineView::m_baseEngine</a></div><div class="ttdeci">DynamicEngine & m_baseEngine</div><div class="ttdoc">The underlying engine to which this view delegates calculations.</div><div class="ttdef"><b>Definition</b> <a href="#l00268">engine_adaptive.h:268</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_adaptive_engine_view_html_a5eaf7c3a4e28cd3a4f34979b88a80103"><div class="ttname"><a href="classgridfire_1_1_adaptive_engine_view.html#a5eaf7c3a4e28cd3a4f34979b88a80103">gridfire::AdaptiveEngineView::LogManager</a></div><div class="ttdeci">fourdst::logging::LogManager LogManager</div><div class="ttdef"><b>Definition</b> <a href="#l00261">engine_adaptive.h:261</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_adaptive_engine_view_html_a5f66204a0ff5b27eed243afddecb0093"><div class="ttname"><a href="classgridfire_1_1_adaptive_engine_view.html#a5f66204a0ff5b27eed243afddecb0093">gridfire::AdaptiveEngineView::m_speciesIndexMap</a></div><div class="ttdeci">std::vector< size_t > m_speciesIndexMap</div><div class="ttdoc">A map from the indices of the active species to the indices of the corresponding species in the full ...</div><div class="ttdef"><b>Definition</b> <a href="#l00276">engine_adaptive.h:276</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_adaptive_engine_view_html_a63580db57e0f48f508906a11ccfd465e"><div class="ttname"><a href="classgridfire_1_1_adaptive_engine_view.html#a63580db57e0f48f508906a11ccfd465e">gridfire::AdaptiveEngineView::m_isStale</a></div><div class="ttdeci">bool m_isStale</div><div class="ttdoc">A flag indicating whether the view is stale and needs to be updated.</div><div class="ttdef"><b>Definition</b> <a href="#l00281">engine_adaptive.h:281</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_adaptive_engine_view_html_a67b4ea8cad115394bb4a42cc39d696f9"><div class="ttname"><a href="classgridfire_1_1_adaptive_engine_view.html#a67b4ea8cad115394bb4a42cc39d696f9">gridfire::AdaptiveEngineView::getStoichiometryMatrixEntry</a></div><div class="ttdeci">int getStoichiometryMatrixEntry(const int speciesIndex_culled, const int reactionIndex_culled) const override</div><div class="ttdoc">Gets an entry from the stoichiometry matrix for the active species and reactions.</div><div class="ttdef"><b>Definition</b> <a href="engine__adaptive_8cpp_source.html#l00165">engine_adaptive.cpp:165</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_adaptive_engine_view_html_a68695f056b660e91285b7e5a931612e1"><div class="ttname"><a href="classgridfire_1_1_adaptive_engine_view.html#a68695f056b660e91285b7e5a931612e1">gridfire::AdaptiveEngineView::mapCulledToFull</a></div><div class="ttdeci">std::vector< double > mapCulledToFull(const std::vector< double > &culled) const</div><div class="ttdoc">Maps a vector of culled abundances to a vector of full abundances.</div><div class="ttdef"><b>Definition</b> <a href="engine__adaptive_8cpp_source.html#l00224">engine_adaptive.cpp:224</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_adaptive_engine_view_html_a7b276b7210be588263395bdb0497fc6d"><div class="ttname"><a href="classgridfire_1_1_adaptive_engine_view.html#a7b276b7210be588263395bdb0497fc6d">gridfire::AdaptiveEngineView::calculateRHSAndEnergy</a></div><div class="ttdeci">StepDerivatives< double > calculateRHSAndEnergy(const std::vector< double > &Y_culled, const double T9, const double rho) const override</div><div class="ttdoc">Calculates the right-hand side (dY/dt) and energy generation for the active species.</div><div class="ttdef"><b>Definition</b> <a href="engine__adaptive_8cpp_source.html#l00120">engine_adaptive.cpp:120</a></div></div>
|
||||
@@ -250,17 +250,17 @@ $(function(){initNavTree('engine__adaptive_8h_source.html',''); initResizable(tr
|
||||
<div class="ttc" id="aclassgridfire_1_1_adaptive_engine_view_html_a896d29325b4233e83d9298850b617a2d"><div class="ttname"><a href="classgridfire_1_1_adaptive_engine_view.html#a896d29325b4233e83d9298850b617a2d">gridfire::AdaptiveEngineView::constructSpeciesIndexMap</a></div><div class="ttdeci">std::vector< size_t > constructSpeciesIndexMap() const</div><div class="ttdoc">Constructs the species index map.</div><div class="ttdef"><b>Definition</b> <a href="engine__adaptive_8cpp_source.html#l00024">engine_adaptive.cpp:24</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_adaptive_engine_view_html_a91e742642d8a8d9ec0620779927e5101"><div class="ttname"><a href="classgridfire_1_1_adaptive_engine_view.html#a91e742642d8a8d9ec0620779927e5101">gridfire::AdaptiveEngineView::mapCulledToFullReactionIndex</a></div><div class="ttdeci">size_t mapCulledToFullReactionIndex(size_t culledReactionIndex) const</div><div class="ttdoc">Maps a culled reaction index to a full reaction index.</div><div class="ttdef"><b>Definition</b> <a href="engine__adaptive_8cpp_source.html#l00251">engine_adaptive.cpp:251</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_adaptive_engine_view_html_a93b38d0fdc4647f6f7340172dae17872"><div class="ttname"><a href="classgridfire_1_1_adaptive_engine_view.html#a93b38d0fdc4647f6f7340172dae17872">gridfire::AdaptiveEngineView::getSpeciesTimescales</a></div><div class="ttdeci">std::unordered_map< fourdst::atomic::Species, double > getSpeciesTimescales(const std::vector< double > &Y_culled, double T9, double rho) const override</div><div class="ttdoc">Computes timescales for all active species in the network.</div><div class="ttdef"><b>Definition</b> <a href="engine__adaptive_8cpp_source.html#l00196">engine_adaptive.cpp:196</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_adaptive_engine_view_html_aa79fb382c98461b02a2c30668491e6c5"><div class="ttname"><a href="classgridfire_1_1_adaptive_engine_view.html#aa79fb382c98461b02a2c30668491e6c5">gridfire::AdaptiveEngineView::finalizeActiveSet</a></div><div class="ttdeci">void finalizeActiveSet(const std::vector< const reaction::LogicalReaction * > &finalReactions)</div><div class="ttdef"><b>Definition</b> <a href="engine__adaptive_8cpp_source.html#l00385">engine_adaptive.cpp:385</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_adaptive_engine_view_html_aae4ddbef1c4e2202fd236221a4bf376b"><div class="ttname"><a href="classgridfire_1_1_adaptive_engine_view.html#aae4ddbef1c4e2202fd236221a4bf376b">gridfire::AdaptiveEngineView::setScreeningModel</a></div><div class="ttdeci">void setScreeningModel(screening::ScreeningType model) override</div><div class="ttdef"><b>Definition</b> <a href="engine__adaptive_8cpp_source.html#l00216">engine_adaptive.cpp:216</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_adaptive_engine_view_html_abdbaf4b87629efe43ac1255dad424c0c"><div class="ttname"><a href="classgridfire_1_1_adaptive_engine_view.html#abdbaf4b87629efe43ac1255dad424c0c">gridfire::AdaptiveEngineView::calculateAllReactionFlows</a></div><div class="ttdeci">std::vector< ReactionFlow > calculateAllReactionFlows(const NetIn &netIn, std::vector< double > &out_Y_Full) const</div><div class="ttdef"><b>Definition</b> <a href="engine__adaptive_8cpp_source.html#l00268">engine_adaptive.cpp:268</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_adaptive_engine_view_html_ac5bdbe46f87d38d9f23ece5743dcd193"><div class="ttname"><a href="classgridfire_1_1_adaptive_engine_view.html#ac5bdbe46f87d38d9f23ece5743dcd193">gridfire::AdaptiveEngineView::m_logger</a></div><div class="ttdeci">quill::Logger * m_logger</div><div class="ttdef"><b>Definition</b> <a href="#l00235">engine_adaptive.h:235</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_adaptive_engine_view_html_aa79fb382c98461b02a2c30668491e6c5"><div class="ttname"><a href="classgridfire_1_1_adaptive_engine_view.html#aa79fb382c98461b02a2c30668491e6c5">gridfire::AdaptiveEngineView::finalizeActiveSet</a></div><div class="ttdeci">void finalizeActiveSet(const std::vector< const reaction::LogicalReaction * > &finalReactions)</div><div class="ttdoc">Finalizes the set of active species and reactions.</div><div class="ttdef"><b>Definition</b> <a href="engine__adaptive_8cpp_source.html#l00385">engine_adaptive.cpp:385</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_adaptive_engine_view_html_aae4ddbef1c4e2202fd236221a4bf376b"><div class="ttname"><a href="classgridfire_1_1_adaptive_engine_view.html#aae4ddbef1c4e2202fd236221a4bf376b">gridfire::AdaptiveEngineView::setScreeningModel</a></div><div class="ttdeci">void setScreeningModel(screening::ScreeningType model) override</div><div class="ttdoc">Sets the screening model for the base engine.</div><div class="ttdef"><b>Definition</b> <a href="engine__adaptive_8cpp_source.html#l00216">engine_adaptive.cpp:216</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_adaptive_engine_view_html_abdbaf4b87629efe43ac1255dad424c0c"><div class="ttname"><a href="classgridfire_1_1_adaptive_engine_view.html#abdbaf4b87629efe43ac1255dad424c0c">gridfire::AdaptiveEngineView::calculateAllReactionFlows</a></div><div class="ttdeci">std::vector< ReactionFlow > calculateAllReactionFlows(const NetIn &netIn, std::vector< double > &out_Y_Full) const</div><div class="ttdoc">Calculates the molar reaction flow rate for all reactions in the full network.</div><div class="ttdef"><b>Definition</b> <a href="engine__adaptive_8cpp_source.html#l00268">engine_adaptive.cpp:268</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_adaptive_engine_view_html_ac5bdbe46f87d38d9f23ece5743dcd193"><div class="ttname"><a href="classgridfire_1_1_adaptive_engine_view.html#ac5bdbe46f87d38d9f23ece5743dcd193">gridfire::AdaptiveEngineView::m_logger</a></div><div class="ttdeci">quill::Logger * m_logger</div><div class="ttdoc">A pointer to the logger instance, used for logging messages.</div><div class="ttdef"><b>Definition</b> <a href="#l00265">engine_adaptive.h:265</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_adaptive_engine_view_html_ac83a8efe25c0e5b9bf7756ac3a500bb1"><div class="ttname"><a href="classgridfire_1_1_adaptive_engine_view.html#ac83a8efe25c0e5b9bf7756ac3a500bb1">gridfire::AdaptiveEngineView::getNetworkSpecies</a></div><div class="ttdeci">const std::vector< fourdst::atomic::Species > & getNetworkSpecies() const override</div><div class="ttdoc">Gets the list of active species in the network.</div><div class="ttdef"><b>Definition</b> <a href="engine__adaptive_8cpp_source.html#l00116">engine_adaptive.cpp:116</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_adaptive_engine_view_html_ac9aab6f60e80a9228b2b19b1b10449ef"><div class="ttname"><a href="classgridfire_1_1_adaptive_engine_view.html#ac9aab6f60e80a9228b2b19b1b10449ef">gridfire::AdaptiveEngineView::generateJacobianMatrix</a></div><div class="ttdeci">void generateJacobianMatrix(const std::vector< double > &Y_culled, const double T9, const double rho) override</div><div class="ttdoc">Generates the Jacobian matrix for the active species.</div><div class="ttdef"><b>Definition</b> <a href="engine__adaptive_8cpp_source.html#l00138">engine_adaptive.cpp:138</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_adaptive_engine_view_html_ad599363cdd457e72e2e2937b0222c455"><div class="ttname"><a href="classgridfire_1_1_adaptive_engine_view.html#ad599363cdd457e72e2e2937b0222c455">gridfire::AdaptiveEngineView::AdaptiveEngineView</a></div><div class="ttdeci">AdaptiveEngineView(DynamicEngine &baseEngine)</div><div class="ttdoc">Constructs an AdaptiveEngineView.</div><div class="ttdef"><b>Definition</b> <a href="engine__adaptive_8cpp_source.html#l00013">engine_adaptive.cpp:13</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_adaptive_engine_view_html_aedc0dedb51c81e03f253cc409a5d5c40"><div class="ttname"><a href="classgridfire_1_1_adaptive_engine_view.html#aedc0dedb51c81e03f253cc409a5d5c40">gridfire::AdaptiveEngineView::validateState</a></div><div class="ttdeci">void validateState() const</div><div class="ttdoc">Validates that the AdaptiveEngineView is not stale.</div><div class="ttdef"><b>Definition</b> <a href="engine__adaptive_8cpp_source.html#l00260">engine_adaptive.cpp:260</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_adaptive_engine_view_html_aee095b30a9dce5fcb5ae2fa1d2aa192c"><div class="ttname"><a href="classgridfire_1_1_adaptive_engine_view.html#aee095b30a9dce5fcb5ae2fa1d2aa192c">gridfire::AdaptiveEngineView::getBaseEngine</a></div><div class="ttdeci">const DynamicEngine & getBaseEngine() const override</div><div class="ttdoc">Gets the base engine.</div><div class="ttdef"><b>Definition</b> <a href="#l00226">engine_adaptive.h:226</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_adaptive_engine_view_html_af4bc9fc6e4afcd6a53c49ca6e2a95940"><div class="ttname"><a href="classgridfire_1_1_adaptive_engine_view.html#af4bc9fc6e4afcd6a53c49ca6e2a95940">gridfire::AdaptiveEngineView::m_activeSpecies</a></div><div class="ttdeci">std::vector< fourdst::atomic::Species > m_activeSpecies</div><div class="ttdef"><b>Definition</b> <a href="#l00239">engine_adaptive.h:239</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_adaptive_engine_view_html_afec39b2faa34ea65c5488dd8e11ba3c3"><div class="ttname"><a href="classgridfire_1_1_adaptive_engine_view.html#afec39b2faa34ea65c5488dd8e11ba3c3">gridfire::AdaptiveEngineView::Config</a></div><div class="ttdeci">fourdst::config::Config Config</div><div class="ttdef"><b>Definition</b> <a href="#l00232">engine_adaptive.h:232</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_adaptive_engine_view_html_af4bc9fc6e4afcd6a53c49ca6e2a95940"><div class="ttname"><a href="classgridfire_1_1_adaptive_engine_view.html#af4bc9fc6e4afcd6a53c49ca6e2a95940">gridfire::AdaptiveEngineView::m_activeSpecies</a></div><div class="ttdeci">std::vector< fourdst::atomic::Species > m_activeSpecies</div><div class="ttdoc">The set of species that are currently active in the network.</div><div class="ttdef"><b>Definition</b> <a href="#l00271">engine_adaptive.h:271</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_adaptive_engine_view_html_afec39b2faa34ea65c5488dd8e11ba3c3"><div class="ttname"><a href="classgridfire_1_1_adaptive_engine_view.html#afec39b2faa34ea65c5488dd8e11ba3c3">gridfire::AdaptiveEngineView::Config</a></div><div class="ttdeci">fourdst::config::Config Config</div><div class="ttdef"><b>Definition</b> <a href="#l00260">engine_adaptive.h:260</a></div></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#l00121">engine_abstract.h:121</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_engine_view_html"><div class="ttname"><a href="classgridfire_1_1_engine_view.html">gridfire::EngineView</a></div><div class="ttdoc">Abstract base class for a "view" of a reaction network engine.</div><div class="ttdef"><b>Definition</b> <a href="engine__view__abstract_8h_source.html#l00074">engine_view_abstract.h:74</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1reaction_1_1_logical_reaction_html"><div class="ttname"><a href="classgridfire_1_1reaction_1_1_logical_reaction.html">gridfire::reaction::LogicalReaction</a></div><div class="ttdoc">Represents a "logical" reaction that aggregates rates from multiple sources.</div><div class="ttdef"><b>Definition</b> <a href="reaction_8h_source.html#l00308">reaction.h:308</a></div></div>
|
||||
@@ -269,14 +269,14 @@ $(function(){initNavTree('engine__adaptive_8h_source.html',''); initResizable(tr
|
||||
<div class="ttc" id="aengine__view__abstract_8h_html"><div class="ttname"><a href="engine__view__abstract_8h.html">engine_view_abstract.h</a></div><div class="ttdoc">Abstract interfaces for engine "views" in GridFire.</div></div>
|
||||
<div class="ttc" id="anamespacegridfire_1_1reaction_html"><div class="ttname"><a href="namespacegridfire_1_1reaction.html">gridfire::reaction</a></div><div class="ttdef"><b>Definition</b> <a href="reaction_8h_source.html#l00025">reaction.h:25</a></div></div>
|
||||
<div class="ttc" id="anamespacegridfire_1_1reaction_html_aa86f08712565f278adacc7cd2361eb31"><div class="ttname"><a href="namespacegridfire_1_1reaction.html#aa86f08712565f278adacc7cd2361eb31">gridfire::reaction::LogicalReactionSet</a></div><div class="ttdeci">TemplatedReactionSet< LogicalReaction > LogicalReactionSet</div><div class="ttdoc">A set of logical reactions.</div><div class="ttdef"><b>Definition</b> <a href="reaction_8h_source.html#l00557">reaction.h:557</a></div></div>
|
||||
<div class="ttc" id="anamespacegridfire_1_1screening_html_aa82aafbc4f8c28d0a75b60798e3a7d25"><div class="ttname"><a href="namespacegridfire_1_1screening.html#aa82aafbc4f8c28d0a75b60798e3a7d25">gridfire::screening::ScreeningType</a></div><div class="ttdeci">ScreeningType</div><div class="ttdef"><b>Definition</b> <a href="screening__types_8h_source.html#l00008">screening_types.h:8</a></div></div>
|
||||
<div class="ttc" id="anamespacegridfire_1_1screening_html_aa82aafbc4f8c28d0a75b60798e3a7d25"><div class="ttname"><a href="namespacegridfire_1_1screening.html#aa82aafbc4f8c28d0a75b60798e3a7d25">gridfire::screening::ScreeningType</a></div><div class="ttdeci">ScreeningType</div><div class="ttdoc">Enumerates the available plasma screening models.</div><div class="ttdef"><b>Definition</b> <a href="screening__types_8h_source.html#l00015">screening_types.h:15</a></div></div>
|
||||
<div class="ttc" id="anamespacegridfire_html"><div class="ttname"><a href="namespacegridfire.html">gridfire</a></div><div class="ttdef"><b>Definition</b> <a href="engine__abstract_8h_source.html#l00024">engine_abstract.h:24</a></div></div>
|
||||
<div class="ttc" id="anetwork_8h_html"><div class="ttname"><a href="network_8h.html">network.h</a></div></div>
|
||||
<div class="ttc" id="ascreening__abstract_8h_html"><div class="ttname"><a href="screening__abstract_8h.html">screening_abstract.h</a></div></div>
|
||||
<div class="ttc" id="ascreening__types_8h_html"><div class="ttname"><a href="screening__types_8h.html">screening_types.h</a></div></div>
|
||||
<div class="ttc" id="astructgridfire_1_1_adaptive_engine_view_1_1_reaction_flow_html"><div class="ttname"><a href="structgridfire_1_1_adaptive_engine_view_1_1_reaction_flow.html">gridfire::AdaptiveEngineView::ReactionFlow</a></div><div class="ttdoc">A struct to hold a reaction and its flow rate.</div><div class="ttdef"><b>Definition</b> <a href="#l00251">engine_adaptive.h:251</a></div></div>
|
||||
<div class="ttc" id="astructgridfire_1_1_adaptive_engine_view_1_1_reaction_flow_html_a3bb21f20df8115d37108cf3c3be3bc6f"><div class="ttname"><a href="structgridfire_1_1_adaptive_engine_view_1_1_reaction_flow.html#a3bb21f20df8115d37108cf3c3be3bc6f">gridfire::AdaptiveEngineView::ReactionFlow::reactionPtr</a></div><div class="ttdeci">const reaction::LogicalReaction * reactionPtr</div><div class="ttdef"><b>Definition</b> <a href="#l00252">engine_adaptive.h:252</a></div></div>
|
||||
<div class="ttc" id="astructgridfire_1_1_adaptive_engine_view_1_1_reaction_flow_html_a6c2e9087f6c8af5d89a5f0de7bd4a5b4"><div class="ttname"><a href="structgridfire_1_1_adaptive_engine_view_1_1_reaction_flow.html#a6c2e9087f6c8af5d89a5f0de7bd4a5b4">gridfire::AdaptiveEngineView::ReactionFlow::flowRate</a></div><div class="ttdeci">double flowRate</div><div class="ttdef"><b>Definition</b> <a href="#l00253">engine_adaptive.h:253</a></div></div>
|
||||
<div class="ttc" id="astructgridfire_1_1_adaptive_engine_view_1_1_reaction_flow_html"><div class="ttname"><a href="structgridfire_1_1_adaptive_engine_view_1_1_reaction_flow.html">gridfire::AdaptiveEngineView::ReactionFlow</a></div><div class="ttdoc">A struct to hold a reaction and its flow rate.</div><div class="ttdef"><b>Definition</b> <a href="#l00287">engine_adaptive.h:287</a></div></div>
|
||||
<div class="ttc" id="astructgridfire_1_1_adaptive_engine_view_1_1_reaction_flow_html_a3bb21f20df8115d37108cf3c3be3bc6f"><div class="ttname"><a href="structgridfire_1_1_adaptive_engine_view_1_1_reaction_flow.html#a3bb21f20df8115d37108cf3c3be3bc6f">gridfire::AdaptiveEngineView::ReactionFlow::reactionPtr</a></div><div class="ttdeci">const reaction::LogicalReaction * reactionPtr</div><div class="ttdef"><b>Definition</b> <a href="#l00288">engine_adaptive.h:288</a></div></div>
|
||||
<div class="ttc" id="astructgridfire_1_1_adaptive_engine_view_1_1_reaction_flow_html_a6c2e9087f6c8af5d89a5f0de7bd4a5b4"><div class="ttname"><a href="structgridfire_1_1_adaptive_engine_view_1_1_reaction_flow.html#a6c2e9087f6c8af5d89a5f0de7bd4a5b4">gridfire::AdaptiveEngineView::ReactionFlow::flowRate</a></div><div class="ttdeci">double flowRate</div><div class="ttdef"><b>Definition</b> <a href="#l00289">engine_adaptive.h:289</a></div></div>
|
||||
<div class="ttc" id="astructgridfire_1_1_net_in_html"><div class="ttname"><a href="structgridfire_1_1_net_in.html">gridfire::NetIn</a></div><div class="ttdef"><b>Definition</b> <a href="network_8h_source.html#l00053">network.h:53</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#l00053">engine_abstract.h:53</a></div></div>
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
|
||||
Reference in New Issue
Block a user