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

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

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

51
docs/html/class_py_dynamic_engine-members.html
View File

@@ -105,29 +105,38 @@ $(function(){initNavTree('class_py_dynamic_engine.html',''); initResizable(true)
<p>This is the complete list of members for <a class="el" href="class_py_dynamic_engine.html">PyDynamicEngine</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="class_py_dynamic_engine.html#a6224f546ba66b1257506b1fc9f47195a">calculateMolarReactionFlow</a>(const gridfire::reaction::Reaction &amp;reaction, const std::vector&lt; double &gt; &amp;Y, double T9, double rho) const override</td><td class="entry"><a class="el" href="class_py_dynamic_engine.html">PyDynamicEngine</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_py_dynamic_engine.html#a5b7f0cfe327c634ec125303256de8b9a">calculateRHSAndEnergy</a>(const std::vector&lt; double &gt; &amp;Y, double T9, double rho) const override</td><td class="entry"><a class="el" href="class_py_dynamic_engine.html">PyDynamicEngine</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_py_dynamic_engine.html#a5bd40c752db1badcd600797c9113121d">generateJacobianMatrix</a>(const std::vector&lt; double &gt; &amp;Y_dynamic, double T9, double rho) const override</td><td class="entry"><a class="el" href="class_py_dynamic_engine.html">PyDynamicEngine</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_py_dynamic_engine.html#aa0f1fd3f0c0185395193d1b6897d64c5">generateJacobianMatrix</a>(const std::vector&lt; double &gt; &amp;Y_dynamic, double T9, double rho, const gridfire::SparsityPattern &amp;sparsityPattern) const override</td><td class="entry"><a class="el" href="class_py_dynamic_engine.html">PyDynamicEngine</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_py_dynamic_engine.html#a2066649ca11a869c054079ea12d8d0e9">generateStoichiometryMatrix</a>() override</td><td class="entry"><a class="el" href="class_py_dynamic_engine.html">PyDynamicEngine</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_py_dynamic_engine.html#adba68716d832b6100e08d32fbc36f13c">getDepth</a>() const override</td><td class="entry"><a class="el" href="class_py_dynamic_engine.html">PyDynamicEngine</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_py_dynamic_engine.html#a1c888bbc0618f1ae02d9a53e45f3c159">getJacobianMatrixEntry</a>(int i, int j) const override</td><td class="entry"><a class="el" href="class_py_dynamic_engine.html">PyDynamicEngine</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_py_dynamic_engine.html#a5988cfba247631ba6c00795cafda9a38">getNetworkReactions</a>() const override</td><td class="entry"><a class="el" href="class_py_dynamic_engine.html">PyDynamicEngine</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classgridfire_1_1_dynamic_engine.html#a264bd5a8891c8c5f0dff32867effe547">calculateEpsDerivatives</a>(const fourdst::composition::Composition &amp;comp, double T9, double rho) const =0</td><td class="entry"><a class="el" href="classgridfire_1_1_dynamic_engine.html">gridfire::DynamicEngine</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_py_dynamic_engine.html#a6224f546ba66b1257506b1fc9f47195a">calculateMolarReactionFlow</a>(const gridfire::reaction::Reaction &amp;reaction, const std::vector&lt; double &gt; &amp;Y, double T9, double rho) const override</td><td class="entry"><a class="el" href="class_py_dynamic_engine.html">PyDynamicEngine</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classgridfire_1_1_dynamic_engine.html#a39cf5b738eea0a275bf8c0eb5789fab3">gridfire::DynamicEngine::calculateMolarReactionFlow</a>(const reaction::Reaction &amp;reaction, const fourdst::composition::Composition &amp;comp, double T9, double rho) const =0</td><td class="entry"><a class="el" href="classgridfire_1_1_dynamic_engine.html">gridfire::DynamicEngine</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_py_dynamic_engine.html#a5b7f0cfe327c634ec125303256de8b9a">calculateRHSAndEnergy</a>(const std::vector&lt; double &gt; &amp;Y, double T9, double rho) const override</td><td class="entry"><a class="el" href="class_py_dynamic_engine.html">PyDynamicEngine</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classgridfire_1_1_engine.html#add48d3af9ebde17717e42e220e349740">gridfire::DynamicEngine::calculateRHSAndEnergy</a>(const fourdst::composition::Composition &amp;comp, double T9, double rho) const =0</td><td class="entry"><a class="el" href="classgridfire_1_1_engine.html">gridfire::Engine</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_py_dynamic_engine.html#a5bd40c752db1badcd600797c9113121d">generateJacobianMatrix</a>(const std::vector&lt; double &gt; &amp;Y_dynamic, double T9, double rho) const override</td><td class="entry"><a class="el" href="class_py_dynamic_engine.html">PyDynamicEngine</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_py_dynamic_engine.html#aa0f1fd3f0c0185395193d1b6897d64c5">generateJacobianMatrix</a>(const std::vector&lt; double &gt; &amp;Y_dynamic, double T9, double rho, const gridfire::SparsityPattern &amp;sparsityPattern) const override</td><td class="entry"><a class="el" href="class_py_dynamic_engine.html">PyDynamicEngine</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classgridfire_1_1_dynamic_engine.html#a21d15531309456ee83f7675251e7a1bf">gridfire::DynamicEngine::generateJacobianMatrix</a>(const fourdst::composition::Composition &amp;comp, double T9, double rho) const =0</td><td class="entry"><a class="el" href="classgridfire_1_1_dynamic_engine.html">gridfire::DynamicEngine</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classgridfire_1_1_dynamic_engine.html#a11d602a708af4629f51873b17f7b8dbd">gridfire::DynamicEngine::generateJacobianMatrix</a>(const fourdst::composition::Composition &amp;comp, double T9, double rho, const SparsityPattern &amp;sparsityPattern) const</td><td class="entry"><a class="el" href="classgridfire_1_1_dynamic_engine.html">gridfire::DynamicEngine</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_py_dynamic_engine.html#a2066649ca11a869c054079ea12d8d0e9">generateStoichiometryMatrix</a>() override</td><td class="entry"><a class="el" href="class_py_dynamic_engine.html">PyDynamicEngine</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_py_dynamic_engine.html#adba68716d832b6100e08d32fbc36f13c">getDepth</a>() const override</td><td class="entry"><a class="el" href="class_py_dynamic_engine.html">PyDynamicEngine</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_py_dynamic_engine.html#a1c888bbc0618f1ae02d9a53e45f3c159">getJacobianMatrixEntry</a>(int i, int j) const override</td><td class="entry"><a class="el" href="class_py_dynamic_engine.html">PyDynamicEngine</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classgridfire_1_1_dynamic_engine.html#a88dbf350dc0ea3e2b64d825f489e0d60">gridfire::DynamicEngine::getJacobianMatrixEntry</a>(const fourdst::atomic::Species &amp;rowSpecies, const fourdst::atomic::Species &amp;colSpecies) const =0</td><td class="entry"><a class="el" href="classgridfire_1_1_dynamic_engine.html">gridfire::DynamicEngine</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_py_dynamic_engine.html#a1d5143640666631501cf229bc491516e">getNetworkReactions</a>() const override</td><td class="entry"><a class="el" href="class_py_dynamic_engine.html">PyDynamicEngine</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_py_dynamic_engine.html#afc745e7ab5da5d8b3cf916044515cd7d">getNetworkSpecies</a>() const override</td><td class="entry"><a class="el" href="class_py_dynamic_engine.html">PyDynamicEngine</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_py_dynamic_engine.html#ab4cfdca5e15957c5cef75ffa6dedeee5">getScreeningModel</a>() const override</td><td class="entry"><a class="el" href="class_py_dynamic_engine.html">PyDynamicEngine</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_py_dynamic_engine.html#a020044829e0146427ed4830e5b02c4f3">getSpeciesDestructionTimescales</a>(const std::vector&lt; double &gt; &amp;Y, double T9, double rho) const override</td><td class="entry"><a class="el" href="class_py_dynamic_engine.html">PyDynamicEngine</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_py_dynamic_engine.html#a2ee1d745c1c21b9fcb652c96c42f1091">getSpeciesIndex</a>(const fourdst::atomic::Species &amp;species) const override</td><td class="entry"><a class="el" href="class_py_dynamic_engine.html">PyDynamicEngine</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_py_dynamic_engine.html#a02a4c86c9637a3c9c9ca8ddd82ecff22">getSpeciesTimescales</a>(const std::vector&lt; double &gt; &amp;Y, double T9, double rho) const override</td><td class="entry"><a class="el" href="class_py_dynamic_engine.html">PyDynamicEngine</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_py_dynamic_engine.html#ab48ef6db18da20024aa563a91fa16f83">getStoichiometryMatrixEntry</a>(int speciesIndex, int reactionIndex) const override</td><td class="entry"><a class="el" href="class_py_dynamic_engine.html">PyDynamicEngine</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_py_dynamic_engine.html#a55bf19ed7534a312a36faf74753f7b14">isStale</a>(const gridfire::NetIn &amp;netIn) override</td><td class="entry"><a class="el" href="class_py_dynamic_engine.html">PyDynamicEngine</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_py_dynamic_engine.html#a2246382b1c98ba69cdb419bba63a6d03">m_species_cache</a></td><td class="entry"><a class="el" href="class_py_dynamic_engine.html">PyDynamicEngine</a></td><td class="entry"><span class="mlabel">mutable</span><span class="mlabel">private</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_py_dynamic_engine.html#a61bb4b430fe740cfb2c24e5cc673e4ac">mapNetInToMolarAbundanceVector</a>(const gridfire::NetIn &amp;netIn) const override</td><td class="entry"><a class="el" href="class_py_dynamic_engine.html">PyDynamicEngine</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_py_dynamic_engine.html#ac22a10412be6649bf379e6d61113c878">primeEngine</a>(const gridfire::NetIn &amp;netIn) override</td><td class="entry"><a class="el" href="class_py_dynamic_engine.html">PyDynamicEngine</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_py_dynamic_engine.html#a3d30a9116825ab2c5c209bc2712126bc">rebuild</a>(const fourdst::composition::Composition &amp;comp, gridfire::BuildDepthType depth) override</td><td class="entry"><a class="el" href="class_py_dynamic_engine.html">PyDynamicEngine</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_py_dynamic_engine.html#afd818c408c64d207e71b1a90426328d6">setNetworkReactions</a>(const gridfire::reaction::LogicalReactionSet &amp;reactions) override</td><td class="entry"><a class="el" href="class_py_dynamic_engine.html">PyDynamicEngine</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_py_dynamic_engine.html#afa3abfd612033336a656f092721c14ac">setScreeningModel</a>(gridfire::screening::ScreeningType model) override</td><td class="entry"><a class="el" href="class_py_dynamic_engine.html">PyDynamicEngine</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_py_dynamic_engine.html#af8e6a8cd44f278535d7bcc9a896d6da8">update</a>(const gridfire::NetIn &amp;netIn) override</td><td class="entry"><a class="el" href="class_py_dynamic_engine.html">PyDynamicEngine</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classgridfire_1_1_engine.html#a2e7970bed2100699f226f4141d5db037">~Engine</a>()=default</td><td class="entry"><a class="el" href="classgridfire_1_1_engine.html">gridfire::Engine</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_py_dynamic_engine.html#a020044829e0146427ed4830e5b02c4f3">getSpeciesDestructionTimescales</a>(const std::vector&lt; double &gt; &amp;Y, double T9, double rho) const override</td><td class="entry"><a class="el" href="class_py_dynamic_engine.html">PyDynamicEngine</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classgridfire_1_1_dynamic_engine.html#a25c040d3078f6ff2ef38f733eb68f1fa">gridfire::DynamicEngine::getSpeciesDestructionTimescales</a>(const fourdst::composition::Composition &amp;comp, double T9, double rho) const =0</td><td class="entry"><a class="el" href="classgridfire_1_1_dynamic_engine.html">gridfire::DynamicEngine</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_py_dynamic_engine.html#a95d10a7b240d543a1bc6c67ddf2dc8e0">getSpeciesIndex</a>(const fourdst::atomic::Species &amp;species) const override</td><td class="entry"><a class="el" href="class_py_dynamic_engine.html">PyDynamicEngine</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_py_dynamic_engine.html#a02a4c86c9637a3c9c9ca8ddd82ecff22">getSpeciesTimescales</a>(const std::vector&lt; double &gt; &amp;Y, double T9, double rho) const override</td><td class="entry"><a class="el" href="class_py_dynamic_engine.html">PyDynamicEngine</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classgridfire_1_1_dynamic_engine.html#ae7114f5ebc6667b5e5971c0450ed03d9">gridfire::DynamicEngine::getSpeciesTimescales</a>(const fourdst::composition::Composition &amp;comp, double T9, double rho) const =0</td><td class="entry"><a class="el" href="classgridfire_1_1_dynamic_engine.html">gridfire::DynamicEngine</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_py_dynamic_engine.html#ab48ef6db18da20024aa563a91fa16f83">getStoichiometryMatrixEntry</a>(int speciesIndex, int reactionIndex) const override</td><td class="entry"><a class="el" href="class_py_dynamic_engine.html">PyDynamicEngine</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classgridfire_1_1_dynamic_engine.html#ad19c8451b6f624e2938f771cc067d5c1">gridfire::DynamicEngine::getStoichiometryMatrixEntry</a>(const fourdst::atomic::Species &amp;species, const reaction::Reaction &amp;reaction) const =0</td><td class="entry"><a class="el" href="classgridfire_1_1_dynamic_engine.html">gridfire::DynamicEngine</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_py_dynamic_engine.html#a55bf19ed7534a312a36faf74753f7b14">isStale</a>(const gridfire::NetIn &amp;netIn) override</td><td class="entry"><a class="el" href="class_py_dynamic_engine.html">PyDynamicEngine</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_py_dynamic_engine.html#a2246382b1c98ba69cdb419bba63a6d03">m_species_cache</a></td><td class="entry"><a class="el" href="class_py_dynamic_engine.html">PyDynamicEngine</a></td><td class="entry"><span class="mlabel">mutable</span><span class="mlabel">private</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_py_dynamic_engine.html#a61bb4b430fe740cfb2c24e5cc673e4ac">mapNetInToMolarAbundanceVector</a>(const gridfire::NetIn &amp;netIn) const override</td><td class="entry"><a class="el" href="class_py_dynamic_engine.html">PyDynamicEngine</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_py_dynamic_engine.html#ac22a10412be6649bf379e6d61113c878">primeEngine</a>(const gridfire::NetIn &amp;netIn) override</td><td class="entry"><a class="el" href="class_py_dynamic_engine.html">PyDynamicEngine</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_py_dynamic_engine.html#a3d30a9116825ab2c5c209bc2712126bc">rebuild</a>(const fourdst::composition::Composition &amp;comp, gridfire::BuildDepthType depth) override</td><td class="entry"><a class="el" href="class_py_dynamic_engine.html">PyDynamicEngine</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_py_dynamic_engine.html#af469cba3be850d53f659ec173f0eb4e4">setNetworkReactions</a>(const gridfire::reaction::ReactionSet &amp;reactions) override</td><td class="entry"><a class="el" href="class_py_dynamic_engine.html">PyDynamicEngine</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_py_dynamic_engine.html#afa3abfd612033336a656f092721c14ac">setScreeningModel</a>(gridfire::screening::ScreeningType model) override</td><td class="entry"><a class="el" href="class_py_dynamic_engine.html">PyDynamicEngine</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_py_dynamic_engine.html#af8e6a8cd44f278535d7bcc9a896d6da8">update</a>(const gridfire::NetIn &amp;netIn) override</td><td class="entry"><a class="el" href="class_py_dynamic_engine.html">PyDynamicEngine</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classgridfire_1_1_engine.html#a2e7970bed2100699f226f4141d5db037">~Engine</a>()=default</td><td class="entry"><a class="el" href="classgridfire_1_1_engine.html">gridfire::Engine</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
</table></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->