docs(docs): added extensive docs

This commit is contained in:
2025-07-01 15:06:22 -04:00
parent 5b4db3ea43
commit 131f61c9e7
134 changed files with 5101 additions and 2191 deletions

View File

@@ -557,20 +557,20 @@ $(function(){initNavTree('engine__adaptive_8cpp_source.html',''); initResizable(
<div class="line"><a id="l00405" name="l00405"></a><span class="lineno"> 405</span>}</div>
<div class="line"><a id="l00406" name="l00406"></a><span class="lineno"> 406</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 &amp;reaction, const std::vector&lt; double &gt; &amp;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="#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="#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&lt; fourdst::atomic::Species &gt; findReachableSpecies(const NetIn &amp;netIn) const</div><div class="ttdef"><b>Definition</b> <a href="#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="#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&lt; fourdst::atomic::Species &gt; findReachableSpecies(const NetIn &amp;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="#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 &amp; 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="#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 &amp; m_config</div><div class="ttdef"><b>Definition</b> <a href="engine__adaptive_8h_source.html#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="engine__adaptive_8h_source.html#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&lt; size_t &gt; m_reactionIndexMap</div><div class="ttdef"><b>Definition</b> <a href="engine__adaptive_8h_source.html#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 &amp; 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="engine__adaptive_8h_source.html#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="engine__adaptive_8h_source.html#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&lt; size_t &gt; 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="engine__adaptive_8h_source.html#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="#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="#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&lt; double &gt; mapFullToCulled(const std::vector&lt; double &gt; &amp;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="#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&lt; const reaction::LogicalReaction * &gt; cullReactionsByFlow(const std::vector&lt; ReactionFlow &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</div><div class="ttdef"><b>Definition</b> <a href="#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&lt; const reaction::LogicalReaction * &gt; cullReactionsByFlow(const std::vector&lt; ReactionFlow &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</div><div class="ttdoc">Culls reactions from the network based on their flow rates.</div><div class="ttdef"><b>Definition</b> <a href="#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="#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 &amp; m_baseEngine</div><div class="ttdef"><b>Definition</b> <a href="engine__adaptive_8h_source.html#l00237">engine_adaptive.h:237</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&lt; size_t &gt; m_speciesIndexMap</div><div class="ttdef"><b>Definition</b> <a href="engine__adaptive_8h_source.html#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="engine__adaptive_8h_source.html#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 &amp; m_baseEngine</div><div class="ttdoc">The underlying engine to which this view delegates calculations.</div><div class="ttdef"><b>Definition</b> <a href="engine__adaptive_8h_source.html#l00268">engine_adaptive.h:268</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&lt; size_t &gt; 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="engine__adaptive_8h_source.html#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="engine__adaptive_8h_source.html#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="#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&lt; double &gt; mapCulledToFull(const std::vector&lt; double &gt; &amp;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="#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&lt; double &gt; calculateRHSAndEnergy(const std::vector&lt; double &gt; &amp;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="#l00120">engine_adaptive.cpp:120</a></div></div>
@@ -579,21 +579,21 @@ $(function(){initNavTree('engine__adaptive_8cpp_source.html',''); initResizable(
<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&lt; size_t &gt; constructSpeciesIndexMap() const</div><div class="ttdoc">Constructs the species index map.</div><div class="ttdef"><b>Definition</b> <a href="#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="#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&lt; fourdst::atomic::Species, double &gt; getSpeciesTimescales(const std::vector&lt; double &gt; &amp;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="#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&lt; const reaction::LogicalReaction * &gt; &amp;finalReactions)</div><div class="ttdef"><b>Definition</b> <a href="#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="#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&lt; ReactionFlow &gt; calculateAllReactionFlows(const NetIn &amp;netIn, std::vector&lt; double &gt; &amp;out_Y_Full) const</div><div class="ttdef"><b>Definition</b> <a href="#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="engine__adaptive_8h_source.html#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&lt; const reaction::LogicalReaction * &gt; &amp;finalReactions)</div><div class="ttdoc">Finalizes the set of active species and reactions.</div><div class="ttdef"><b>Definition</b> <a href="#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="#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&lt; ReactionFlow &gt; calculateAllReactionFlows(const NetIn &amp;netIn, std::vector&lt; double &gt; &amp;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="#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="engine__adaptive_8h_source.html#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&lt; fourdst::atomic::Species &gt; &amp; 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="#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&lt; double &gt; &amp;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="#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 &amp;baseEngine)</div><div class="ttdoc">Constructs an AdaptiveEngineView.</div><div class="ttdef"><b>Definition</b> <a href="#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="#l00260">engine_adaptive.cpp:260</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&lt; fourdst::atomic::Species &gt; m_activeSpecies</div><div class="ttdef"><b>Definition</b> <a href="engine__adaptive_8h_source.html#l00239">engine_adaptive.h:239</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&lt; fourdst::atomic::Species &gt; 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="engine__adaptive_8h_source.html#l00271">engine_adaptive.h:271</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_1reaction_1_1_reaction_html"><div class="ttname"><a href="classgridfire_1_1reaction_1_1_reaction.html">gridfire::reaction::Reaction</a></div><div class="ttdoc">Represents a single nuclear reaction from a specific data source.</div><div class="ttdef"><b>Definition</b> <a href="reaction_8h_source.html#l00072">reaction.h:72</a></div></div>
<div class="ttc" id="aengine__adaptive_8h_html"><div class="ttname"><a href="engine__adaptive_8h.html">engine_adaptive.h</a></div></div>
<div 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&lt; LogicalReaction &gt; 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="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>