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

docs(docs): asdded and cleaned up docs

Browse Source
This commit is contained in:
Emily Boudreaux
2025-07-24 11:10:45 -04:00
parent cc3708fda5
commit ba9b3e2392
808 changed files with 140326 additions and 9346 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
docs/html/functions_g.html
View File

@@ -102,19 +102,34 @@ $(function(){initNavTree('functions_g.html',''); initResizable(true); });
<div class="textblock">Here is a list of all class members with links to the classes they belong to:</div>
<h3><a id="index_g" name="index_g"></a>- g -</h3><ul>
<li>generateJacobianMatrix()&#160;:&#160;<a class="el" href="classgridfire_1_1_adaptive_engine_view.html#ac9aab6f60e80a9228b2b19b1b10449ef">gridfire::AdaptiveEngineView</a>, <a class="el" href="classgridfire_1_1_dynamic_engine.html#a0a2fb3435ee3271ab9c806f225c61a7f">gridfire::DynamicEngine</a>, <a class="el" href="classgridfire_1_1_file_defined_engine_view.html#a48b2451f96b8f5511ffc4071519c0810">gridfire::FileDefinedEngineView</a>, <a class="el" href="classgridfire_1_1_graph_engine.html#ae347ff0316e532e0298ec8c913908105">gridfire::GraphEngine</a></li>
<li>generateStoichiometryMatrix()&#160;:&#160;<a class="el" href="classgridfire_1_1_adaptive_engine_view.html#a231193a61ba5a31e8eb92b0d4ce69111">gridfire::AdaptiveEngineView</a>, <a class="el" href="classgridfire_1_1_dynamic_engine.html#aeae6d84ef74d88fd2cdf07b82e98a16f">gridfire::DynamicEngine</a>, <a class="el" href="classgridfire_1_1_file_defined_engine_view.html#a27a5163157cc15c4cb3b99a5d3564dbd">gridfire::FileDefinedEngineView</a>, <a class="el" href="classgridfire_1_1_graph_engine.html#aed726d36ee2b3796beff6067a1e4db38">gridfire::GraphEngine</a></li>
<li>getBaseEngine()&#160;:&#160;<a class="el" href="classgridfire_1_1_adaptive_engine_view.html#aee095b30a9dce5fcb5ae2fa1d2aa192c">gridfire::AdaptiveEngineView</a>, <a class="el" href="classgridfire_1_1_engine_view.html#ad294227f8b5cf6d970c349eabf5447a6">gridfire::EngineView&lt; EngineT &gt;</a>, <a class="el" href="classgridfire_1_1_file_defined_engine_view.html#a4c8b273c5cb3d470567c5691b68493a3">gridfire::FileDefinedEngineView</a></li>
<li>G_norm_high&#160;:&#160;<a class="el" href="structgridfire_1_1partition_1_1_rauscher_thielemann_partition_function_1_1_interpolation_points.html#a3cb7ee6f3031997aab99c5502b61d90e">gridfire::partition::RauscherThielemannPartitionFunction::InterpolationPoints</a></li>
<li>G_norm_low&#160;:&#160;<a class="el" href="structgridfire_1_1partition_1_1_rauscher_thielemann_partition_function_1_1_interpolation_points.html#a7d291ba80f958fe34ae72b21c6fab380">gridfire::partition::RauscherThielemannPartitionFunction::InterpolationPoints</a></li>
<li>generateJacobianMatrix()&#160;:&#160;<a class="el" href="classgridfire_1_1_adaptive_engine_view.html#a03fc187d3d306b9058103b9522cbbaeb">gridfire::AdaptiveEngineView</a>, <a class="el" href="classgridfire_1_1_defined_engine_view.html#ad25c722eaee1f28f8ed7b4d33a1f69ae">gridfire::DefinedEngineView</a>, <a class="el" href="classgridfire_1_1_dynamic_engine.html#a29bdd4231c29c3a4e524ad6ca66a127d">gridfire::DynamicEngine</a>, <a class="el" href="classgridfire_1_1_graph_engine.html#ad049a295e2bb0f3e97b76d5742875119">gridfire::GraphEngine</a>, <a class="el" href="classgridfire_1_1_multiscale_partitioning_engine_view.html#acdf5ad8765290ea2b78170235aea391d">gridfire::MultiscalePartitioningEngineView</a>, <a class="el" href="class_py_dynamic_engine.html#a5bd40c752db1badcd600797c9113121d">PyDynamicEngine</a></li>
<li>generateStoichiometryMatrix()&#160;:&#160;<a class="el" href="classgridfire_1_1_adaptive_engine_view.html#a231193a61ba5a31e8eb92b0d4ce69111">gridfire::AdaptiveEngineView</a>, <a class="el" href="classgridfire_1_1_defined_engine_view.html#ad07221be49ae1b5133c5b987dafac3b6">gridfire::DefinedEngineView</a>, <a class="el" href="classgridfire_1_1_dynamic_engine.html#aeae6d84ef74d88fd2cdf07b82e98a16f">gridfire::DynamicEngine</a>, <a class="el" href="classgridfire_1_1_graph_engine.html#aed726d36ee2b3796beff6067a1e4db38">gridfire::GraphEngine</a>, <a class="el" href="classgridfire_1_1_multiscale_partitioning_engine_view.html#abe76a46784b1ebc8ad67a9eec40d369a">gridfire::MultiscalePartitioningEngineView</a>, <a class="el" href="class_py_dynamic_engine.html#a2066649ca11a869c054079ea12d8d0e9">PyDynamicEngine</a></li>
<li>get_interpolation_points()&#160;:&#160;<a class="el" href="classgridfire_1_1partition_1_1_rauscher_thielemann_partition_function.html#a3baed110ab1b12e22071dc2d92c55db9">gridfire::partition::RauscherThielemannPartitionFunction</a></li>
<li>getBaseEngine()&#160;:&#160;<a class="el" href="classgridfire_1_1_adaptive_engine_view.html#aee095b30a9dce5fcb5ae2fa1d2aa192c">gridfire::AdaptiveEngineView</a>, <a class="el" href="classgridfire_1_1_defined_engine_view.html#a69b9a5812ad8bda13f956acd0da24484">gridfire::DefinedEngineView</a>, <a class="el" href="classgridfire_1_1_engine_view.html#ad294227f8b5cf6d970c349eabf5447a6">gridfire::EngineView&lt; EngineT &gt;</a>, <a class="el" href="classgridfire_1_1_multiscale_partitioning_engine_view.html#a22bd1f0e821ed415611d75bac67063d1">gridfire::MultiscalePartitioningEngineView</a>, <a class="el" href="class_py_dynamic_engine_view.html#a51680b135cfc3eea40daf9ef5aa903e0">PyDynamicEngineView</a>, <a class="el" href="class_py_engine_view.html#a3cd83dc57b521c65a14edf70357a8845">PyEngineView</a></li>
<li>getDepth()&#160;:&#160;<a class="el" href="classgridfire_1_1_dynamic_engine.html#a04317b66ef14d519264bc30ee69f5bf9">gridfire::DynamicEngine</a>, <a class="el" href="classgridfire_1_1_graph_engine.html#a166a5f4349580f9aa0b930afec73fcc4">gridfire::GraphEngine</a>, <a class="el" href="class_py_dynamic_engine.html#adba68716d832b6100e08d32fbc36f13c">PyDynamicEngine</a></li>
<li>getDynamicSpecies()&#160;:&#160;<a class="el" href="classgridfire_1_1_multiscale_partitioning_engine_view.html#a1e04e8cb8c84b1bd033ac599accf0888">gridfire::MultiscalePartitioningEngineView</a></li>
<li>getFastSpecies()&#160;:&#160;<a class="el" href="classgridfire_1_1_multiscale_partitioning_engine_view.html#a3c82e4e082d1c82b1b090ac9847c7c5e">gridfire::MultiscalePartitioningEngineView</a></li>
<li>getFormat()&#160;:&#160;<a class="el" href="classgridfire_1_1_network.html#a315a123499719178286b29e2aca69118">gridfire::Network</a></li>
<li>getJacobianMatrixEntry()&#160;:&#160;<a class="el" href="classgridfire_1_1_adaptive_engine_view.html#a4710d218c8a0fd161e994ecd60b48e58">gridfire::AdaptiveEngineView</a>, <a class="el" href="classgridfire_1_1_dynamic_engine.html#a05d15ff35a6bc06a2fa7eda19838bd07">gridfire::DynamicEngine</a>, <a class="el" href="classgridfire_1_1_file_defined_engine_view.html#a0ef8804780d13bbfce0856237bb00470">gridfire::FileDefinedEngineView</a>, <a class="el" href="classgridfire_1_1_graph_engine.html#a303e6093591cde91430f866a04a8be7c">gridfire::GraphEngine</a></li>
<li>getJacobianMatrixEntry()&#160;:&#160;<a class="el" href="classgridfire_1_1_adaptive_engine_view.html#a4710d218c8a0fd161e994ecd60b48e58">gridfire::AdaptiveEngineView</a>, <a class="el" href="classgridfire_1_1_defined_engine_view.html#a273b175049f5ce7b9208e931ad139e1b">gridfire::DefinedEngineView</a>, <a class="el" href="classgridfire_1_1_dynamic_engine.html#a05d15ff35a6bc06a2fa7eda19838bd07">gridfire::DynamicEngine</a>, <a class="el" href="classgridfire_1_1_graph_engine.html#a303e6093591cde91430f866a04a8be7c">gridfire::GraphEngine</a>, <a class="el" href="classgridfire_1_1_multiscale_partitioning_engine_view.html#ac961484383e86d9712a424728e068633">gridfire::MultiscalePartitioningEngineView</a>, <a class="el" href="class_py_dynamic_engine.html#a1c888bbc0618f1ae02d9a53e45f3c159">PyDynamicEngine</a></li>
<li>getMolarAbundance()&#160;:&#160;<a class="el" href="classgridfire_1_1exceptions_1_1_stale_engine_trigger.html#a3183a0030b14253eb49d8304fb6665ea">gridfire::exceptions::StaleEngineTrigger</a></li>
<li>getNetReactionStoichiometry()&#160;:&#160;<a class="el" href="classgridfire_1_1_graph_engine.html#a8c29d8bbde407e913be5eb77efb2c0c9">gridfire::GraphEngine</a></li>
<li>getNetworkReactions()&#160;:&#160;<a class="el" href="classgridfire_1_1_adaptive_engine_view.html#a12cc2f352678fba9688363ba1876ab9c">gridfire::AdaptiveEngineView</a>, <a class="el" href="classgridfire_1_1_dynamic_engine.html#ad2a82099edbb374bbb2c9509ccdb1037">gridfire::DynamicEngine</a>, <a class="el" href="classgridfire_1_1_file_defined_engine_view.html#a5bbea17b69cc8f81bc251a04f4435a0c">gridfire::FileDefinedEngineView</a>, <a class="el" href="classgridfire_1_1_graph_engine.html#ad45650d10fc5dff1673ae3f806d067da">gridfire::GraphEngine</a></li>
<li>getNetworkSpecies()&#160;:&#160;<a class="el" href="classgridfire_1_1_adaptive_engine_view.html#ac83a8efe25c0e5b9bf7756ac3a500bb1">gridfire::AdaptiveEngineView</a>, <a class="el" href="classgridfire_1_1_engine.html#a020e1b493d6964cafdad08fde697ceb3">gridfire::Engine</a>, <a class="el" href="classgridfire_1_1_file_defined_engine_view.html#a8bb583e039b49608272997ed2d3387fa">gridfire::FileDefinedEngineView</a>, <a class="el" href="classgridfire_1_1_graph_engine.html#a0ed390f3e598ebba4e245ac90bb78767">gridfire::GraphEngine</a></li>
<li>getNetworkFile()&#160;:&#160;<a class="el" href="classgridfire_1_1_file_defined_engine_view.html#ae0c35d8963b6ed05aeb88089ce301718">gridfire::FileDefinedEngineView</a></li>
<li>getNetworkReactions()&#160;:&#160;<a class="el" href="classgridfire_1_1_adaptive_engine_view.html#a12cc2f352678fba9688363ba1876ab9c">gridfire::AdaptiveEngineView</a>, <a class="el" href="classgridfire_1_1_defined_engine_view.html#ae03b4f9afac03d4011a4d7cf0423535d">gridfire::DefinedEngineView</a>, <a class="el" href="classgridfire_1_1_dynamic_engine.html#ad2a82099edbb374bbb2c9509ccdb1037">gridfire::DynamicEngine</a>, <a class="el" href="classgridfire_1_1_graph_engine.html#ad45650d10fc5dff1673ae3f806d067da">gridfire::GraphEngine</a>, <a class="el" href="classgridfire_1_1_multiscale_partitioning_engine_view.html#ad751f2c1306895ee74a61f2071ca96eb">gridfire::MultiscalePartitioningEngineView</a>, <a class="el" href="class_py_dynamic_engine.html#a5988cfba247631ba6c00795cafda9a38">PyDynamicEngine</a></li>
<li>getNetworkSpecies()&#160;:&#160;<a class="el" href="classgridfire_1_1_adaptive_engine_view.html#ac83a8efe25c0e5b9bf7756ac3a500bb1">gridfire::AdaptiveEngineView</a>, <a class="el" href="classgridfire_1_1_defined_engine_view.html#a1a55f9748c45af6f13e16a6b6ceaa211">gridfire::DefinedEngineView</a>, <a class="el" href="classgridfire_1_1_engine.html#a020e1b493d6964cafdad08fde697ceb3">gridfire::Engine</a>, <a class="el" href="classgridfire_1_1_graph_engine.html#a0ed390f3e598ebba4e245ac90bb78767">gridfire::GraphEngine</a>, <a class="el" href="classgridfire_1_1_multiscale_partitioning_engine_view.html#a696f74f5135bbd62169b6577f92fee80">gridfire::MultiscalePartitioningEngineView</a>, <a class="el" href="class_py_dynamic_engine.html#afc745e7ab5da5d8b3cf916044515cd7d">PyDynamicEngine</a>, <a class="el" href="class_py_engine.html#a2d240423899e039c2ca688e96f8af1f2">PyEngine</a></li>
<li>getParser()&#160;:&#160;<a class="el" href="classgridfire_1_1_file_defined_engine_view.html#aea834dc382ff1d663040db4532ea928f">gridfire::FileDefinedEngineView</a></li>
<li>getPartitionFunction()&#160;:&#160;<a class="el" href="classgridfire_1_1_graph_engine.html#add98ece49ec5c538bddf3cc77004fe44">gridfire::GraphEngine</a></li>
<li>getReactionSetSpecies()&#160;:&#160;<a class="el" href="classgridfire_1_1reaction_1_1_templated_reaction_set.html#a1596de3439735a45ac344fa85ace6c82">gridfire::reaction::TemplatedReactionSet&lt; ReactionT &gt;</a></li>
<li>getScreeningModel()&#160;:&#160;<a class="el" href="classgridfire_1_1_adaptive_engine_view.html#a0ab1199f900a58f309c3c36532c9164f">gridfire::AdaptiveEngineView</a>, <a class="el" href="classgridfire_1_1_dynamic_engine.html#a7a203f8e0f3a6744ddc912dfbcfdbcc0">gridfire::DynamicEngine</a>, <a class="el" href="classgridfire_1_1_file_defined_engine_view.html#adbc50f397445f92b810d80cf329b8626">gridfire::FileDefinedEngineView</a>, <a class="el" href="classgridfire_1_1_graph_engine.html#a697f2004e0d02c59e83c7890742d7c9a">gridfire::GraphEngine</a></li>
<li>getSpeciesTimescales()&#160;:&#160;<a class="el" href="classgridfire_1_1_adaptive_engine_view.html#a93b38d0fdc4647f6f7340172dae17872">gridfire::AdaptiveEngineView</a>, <a class="el" href="classgridfire_1_1_dynamic_engine.html#a5d8ba98b230d2849035ee2507728fa15">gridfire::DynamicEngine</a>, <a class="el" href="classgridfire_1_1_file_defined_engine_view.html#ace3c6ea4841318c08695973ab3dcddc6">gridfire::FileDefinedEngineView</a>, <a class="el" href="classgridfire_1_1_graph_engine.html#a26215593544c3a52597194602e4e25dd">gridfire::GraphEngine</a></li>
<li>getStoichiometryMatrixEntry()&#160;:&#160;<a class="el" href="classgridfire_1_1_adaptive_engine_view.html#a67b4ea8cad115394bb4a42cc39d696f9">gridfire::AdaptiveEngineView</a>, <a class="el" href="classgridfire_1_1_dynamic_engine.html#afa108dd5227dbb1045e90d7b3bd8b84f">gridfire::DynamicEngine</a>, <a class="el" href="classgridfire_1_1_file_defined_engine_view.html#a9da9224f5c99a5068f3d8cbf066e4693">gridfire::FileDefinedEngineView</a>, <a class="el" href="classgridfire_1_1_graph_engine.html#a6b5feaf788bade212b7c8df7ac8c8152">gridfire::GraphEngine</a></li>
<li>GraphEngine()&#160;:&#160;<a class="el" href="classgridfire_1_1_graph_engine.html#a9f74786ff930ab72664b31f29d05a30c">gridfire::GraphEngine</a></li>
<li>getScreeningModel()&#160;:&#160;<a class="el" href="classgridfire_1_1_adaptive_engine_view.html#a0ab1199f900a58f309c3c36532c9164f">gridfire::AdaptiveEngineView</a>, <a class="el" href="classgridfire_1_1_defined_engine_view.html#a3c657b82a0117118a4bb0ce7f624ae0c">gridfire::DefinedEngineView</a>, <a class="el" href="classgridfire_1_1_dynamic_engine.html#a7a203f8e0f3a6744ddc912dfbcfdbcc0">gridfire::DynamicEngine</a>, <a class="el" href="classgridfire_1_1_graph_engine.html#a697f2004e0d02c59e83c7890742d7c9a">gridfire::GraphEngine</a>, <a class="el" href="classgridfire_1_1_multiscale_partitioning_engine_view.html#a7bfb4e6fec2f337a1dea69e3d4f1fc82">gridfire::MultiscalePartitioningEngineView</a>, <a class="el" href="class_py_dynamic_engine.html#ab4cfdca5e15957c5cef75ffa6dedeee5">PyDynamicEngine</a></li>
<li>getSpeciesDestructionTimescales()&#160;:&#160;<a class="el" href="classgridfire_1_1_adaptive_engine_view.html#a522e78bce9ff062939572248d57f8cea">gridfire::AdaptiveEngineView</a>, <a class="el" href="classgridfire_1_1_defined_engine_view.html#a3d58e36ed8a6a0d82bb65e91090f7491">gridfire::DefinedEngineView</a>, <a class="el" href="classgridfire_1_1_dynamic_engine.html#a6ca0f315f75252ca505507a61556dda6">gridfire::DynamicEngine</a>, <a class="el" href="classgridfire_1_1_graph_engine.html#aef8f6bde24d27345067b71084330c7da">gridfire::GraphEngine</a>, <a class="el" href="classgridfire_1_1_multiscale_partitioning_engine_view.html#aa38c367ef3c74d012ccd10521cd5a727">gridfire::MultiscalePartitioningEngineView</a>, <a class="el" href="class_py_dynamic_engine.html#a020044829e0146427ed4830e5b02c4f3">PyDynamicEngine</a></li>
<li>getSpeciesIndex()&#160;:&#160;<a class="el" href="classgridfire_1_1_adaptive_engine_view.html#a9055feb245524a5a9549ace935f059ff">gridfire::AdaptiveEngineView</a>, <a class="el" href="classgridfire_1_1_defined_engine_view.html#abfee22688617ffe91c69be93049c89b3">gridfire::DefinedEngineView</a>, <a class="el" href="classgridfire_1_1_dynamic_engine.html#ad3d56a8b9161b9cc7f4da51f6bf7e8c9">gridfire::DynamicEngine</a>, <a class="el" href="classgridfire_1_1_graph_engine.html#a914f6abc61805cddaebcb8f3cf470dda">gridfire::GraphEngine</a>, <a class="el" href="classgridfire_1_1_multiscale_partitioning_engine_view.html#a91d32b7197fcb27ee697d5bfde960f3f">gridfire::MultiscalePartitioningEngineView</a>, <a class="el" href="class_py_dynamic_engine.html#a2ee1d745c1c21b9fcb652c96c42f1091">PyDynamicEngine</a></li>
<li>getSpeciesTimescales()&#160;:&#160;<a class="el" href="classgridfire_1_1_adaptive_engine_view.html#a4e856d6d4d2fc220952bbb7e6b2f85d9">gridfire::AdaptiveEngineView</a>, <a class="el" href="classgridfire_1_1_defined_engine_view.html#ac8daafabbc76f4b6811bede241a03d72">gridfire::DefinedEngineView</a>, <a class="el" href="classgridfire_1_1_dynamic_engine.html#a6772ac384b4c3d3e91712041e4aaa813">gridfire::DynamicEngine</a>, <a class="el" href="classgridfire_1_1_graph_engine.html#a65f9f33cddb0bbd1da7c9d0cff23d581">gridfire::GraphEngine</a>, <a class="el" href="classgridfire_1_1_multiscale_partitioning_engine_view.html#a560612347bbd5b7b380e990624d01105">gridfire::MultiscalePartitioningEngineView</a>, <a class="el" href="class_py_dynamic_engine.html#a02a4c86c9637a3c9c9ca8ddd82ecff22">PyDynamicEngine</a></li>
<li>getState()&#160;:&#160;<a class="el" href="classgridfire_1_1exceptions_1_1_stale_engine_trigger.html#a06eb9eb03750038c193c23c7f53668f5">gridfire::exceptions::StaleEngineTrigger</a></li>
<li>getStoichiometryMatrixEntry()&#160;:&#160;<a class="el" href="classgridfire_1_1_adaptive_engine_view.html#a67b4ea8cad115394bb4a42cc39d696f9">gridfire::AdaptiveEngineView</a>, <a class="el" href="classgridfire_1_1_defined_engine_view.html#afa2820971397114d788730cc33feefe2">gridfire::DefinedEngineView</a>, <a class="el" href="classgridfire_1_1_dynamic_engine.html#afa108dd5227dbb1045e90d7b3bd8b84f">gridfire::DynamicEngine</a>, <a class="el" href="classgridfire_1_1_graph_engine.html#a6b5feaf788bade212b7c8df7ac8c8152">gridfire::GraphEngine</a>, <a class="el" href="classgridfire_1_1_multiscale_partitioning_engine_view.html#a510b920dea726aef859ac1f6d051807e">gridfire::MultiscalePartitioningEngineView</a>, <a class="el" href="class_py_dynamic_engine.html#ab48ef6db18da20024aa563a91fa16f83">PyDynamicEngine</a></li>
<li>GraphEngine()&#160;:&#160;<a class="el" href="classgridfire_1_1_graph_engine.html#afad967546b611d9c005268760feb75d5">gridfire::GraphEngine</a></li>
<li>ground_state_spin&#160;:&#160;<a class="el" href="structgridfire_1_1partition_1_1_rauscher_thielemann_partition_function_1_1_isotope_data.html#aec714697f3f5102124561252233fc350">gridfire::partition::RauscherThielemannPartitionFunction::IsotopeData</a>, <a class="el" href="structgridfire_1_1partition_1_1record_1_1_rauscher_thielemann_partition_data_record.html#acf5c38826050594aee98d746d0ba40b2">gridfire::partition::record::RauscherThielemannPartitionDataRecord</a></li>
<li>GroundStatePartitionFunction()&#160;:&#160;<a class="el" href="classgridfire_1_1partition_1_1_ground_state_partition_function.html#a8afa2aee993eb3ed8d01c887d39b57eb">gridfire::partition::GroundStatePartitionFunction</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->