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

@@ -1,10 +1,13 @@
var classgridfire_1_1_graph_engine =
[
[ "constants", "structgridfire_1_1_graph_engine_1_1constants.html", "structgridfire_1_1_graph_engine_1_1constants" ],
[ "PrecomputedReaction", "structgridfire_1_1_graph_engine_1_1_precomputed_reaction.html", "structgridfire_1_1_graph_engine_1_1_precomputed_reaction" ],
[ "GraphEngine", "classgridfire_1_1_graph_engine.html#a9f74786ff930ab72664b31f29d05a30c", null ],
[ "GraphEngine", "classgridfire_1_1_graph_engine.html#a9c285e3a38de6e73503a4e19666678e2", null ],
[ "GraphEngine", "classgridfire_1_1_graph_engine.html#a1e7e851dfa21d41c2dc533ba56fc4c7b", null ],
[ "calculateAllDerivatives", "classgridfire_1_1_graph_engine.html#a71a3d1181b90c3becdc5d9a3da05b9c9", null ],
[ "calculateAllDerivatives", "classgridfire_1_1_graph_engine.html#aaf4d54e4b774ab8ec8eabec006579d31", null ],
[ "calculateAllDerivatives", "classgridfire_1_1_graph_engine.html#af41df9ce979b6410e12642cb093916c9", null ],
[ "calculateAllDerivativesUsingPrecomputation", "classgridfire_1_1_graph_engine.html#a63639f4430d0889605c10839a6f32af9", null ],
[ "calculateMolarReactionFlow", "classgridfire_1_1_graph_engine.html#a9245642b741f215e52861d00e756fb3f", null ],
[ "calculateMolarReactionFlow", "classgridfire_1_1_graph_engine.html#a5e96b5a0b34c8932f0e14eabda57f1a4", null ],
[ "calculateRHSAndEnergy", "classgridfire_1_1_graph_engine.html#a8b3baf29829c7ae0a61430ea70632bbf", null ],
@@ -21,26 +24,31 @@ var classgridfire_1_1_graph_engine =
[ "getSpeciesTimescales", "classgridfire_1_1_graph_engine.html#a26215593544c3a52597194602e4e25dd", null ],
[ "getStoichiometryMatrixEntry", "classgridfire_1_1_graph_engine.html#a6b5feaf788bade212b7c8df7ac8c8152", null ],
[ "involvesSpecies", "classgridfire_1_1_graph_engine.html#aa6202cee0c3c481eda77cc9a91bc126b", null ],
[ "isPrecomputationEnabled", "classgridfire_1_1_graph_engine.html#a015f8975701f028c29835d3a9794e00f", null ],
[ "populateReactionIDMap", "classgridfire_1_1_graph_engine.html#a26602e1b3c610780a47b5a6511d6d567", null ],
[ "populateSpeciesToIndexMap", "classgridfire_1_1_graph_engine.html#a47202c43342b96480070874bffce1391", null ],
[ "precomputeNetwork", "classgridfire_1_1_graph_engine.html#a92644bc333bff69c5685be4552ca12fd", null ],
[ "recordADTape", "classgridfire_1_1_graph_engine.html#a95563f6bc86007d9ee053a0f1e15b889", null ],
[ "reserveJacobianMatrix", "classgridfire_1_1_graph_engine.html#a5a5458ed01923124f2d7e1f04f32f138", null ],
[ "setPrecomputation", "classgridfire_1_1_graph_engine.html#a6c5410878496abc349ba30b691cdf0f1", null ],
[ "setScreeningModel", "classgridfire_1_1_graph_engine.html#a8110e687844f921438bb517e1d8ce62f", null ],
[ "syncInternalMaps", "classgridfire_1_1_graph_engine.html#acdce8d87e23a2cd1504bc9472e538c0f", null ],
[ "update", "classgridfire_1_1_graph_engine.html#a51b4cedf9b00de79fb6eef243631b04d", null ],
[ "validateComposition", "classgridfire_1_1_graph_engine.html#aeeafeab40a5f4dbfae78bdc87e25e93f", null ],
[ "validateConservation", "classgridfire_1_1_graph_engine.html#acf4cfccea20f5cb31c9886bf233a28be", null ],
[ "m_config", "classgridfire_1_1_graph_engine.html#a3b17102b143435ddfdc015d7a50c4b18", null ],
[ "m_constants", "classgridfire_1_1_graph_engine.html#a0837bab6dcd111d9075c9343b90d64f1", null ],
[ "m_constants", "classgridfire_1_1_graph_engine.html#a10c01bc20ae668c2857efb2a1783098e", null ],
[ "m_jacobianMatrix", "classgridfire_1_1_graph_engine.html#a2f1718c89d4aaad028102724d18fa910", null ],
[ "m_logger", "classgridfire_1_1_graph_engine.html#a483979fc154adc88d029b3b672066d53", null ],
[ "m_networkSpecies", "classgridfire_1_1_graph_engine.html#a92d26068ba139e47d335f5fe9e2814cc", null ],
[ "m_networkSpeciesMap", "classgridfire_1_1_graph_engine.html#a30e09ed0bce6aa5fc89beaa316a7b827", null ],
[ "m_precomputedReactions", "classgridfire_1_1_graph_engine.html#a5d431d5385b1219ba29689eb29601ea3", null ],
[ "m_reactionIDMap", "classgridfire_1_1_graph_engine.html#a5d6cc63b99b467c2a976d1fbaaa1dfa3", null ],
[ "m_reactions", "classgridfire_1_1_graph_engine.html#acb7c4f5108b0efeae48ad15598e808c3", null ],
[ "m_rhsADFun", "classgridfire_1_1_graph_engine.html#a2e22b111f6d00ecc9e3804a71f1ce876", null ],
[ "m_screeningModel", "classgridfire_1_1_graph_engine.html#af17cf3762abac3efcab9a8e87c961210", null ],
[ "m_screeningType", "classgridfire_1_1_graph_engine.html#a52edc3e88f1e8fc497e1e63972d63c80", null ],
[ "m_speciesToIndexMap", "classgridfire_1_1_graph_engine.html#ad8237c252145a75092202d00f5e1ddf7", null ],
[ "m_stoichiometryMatrix", "classgridfire_1_1_graph_engine.html#ad1cb5fd32efc37668e2d9ecf0c72ad24", null ]
[ "m_stoichiometryMatrix", "classgridfire_1_1_graph_engine.html#ad1cb5fd32efc37668e2d9ecf0c72ad24", null ],
[ "m_usePrecomputation", "classgridfire_1_1_graph_engine.html#a191cff35402d3c97c82c5c966a39d0de", null ]
];