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

docs(docs): added extensive docs

Browse Source
This commit is contained in:
Emily Boudreaux
2025-07-01 15:06:22 -04:00
parent 5b4db3ea43
commit 131f61c9e7
134 changed files with 5101 additions and 2191 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
docs/html/functions_vars.html
View File

@@ -109,11 +109,13 @@ $(function(){initNavTree('functions_vars.html',''); initResizable(true); });
<li>a4&#160;:&#160;<a class="el" href="structgridfire_1_1reaction_1_1_rate_coefficient_set.html#ae57b2eac71cb4ed9947f40c9cb8fc3ca">gridfire::reaction::RateCoefficientSet</a></li>
<li>a5&#160;:&#160;<a class="el" href="structgridfire_1_1reaction_1_1_rate_coefficient_set.html#a8c79db4e649b4eb1d29c43ebe4e95458">gridfire::reaction::RateCoefficientSet</a></li>
<li>a6&#160;:&#160;<a class="el" href="structgridfire_1_1reaction_1_1_rate_coefficient_set.html#adf8e6ed7f91cb9e15d1469a808b1877a">gridfire::reaction::RateCoefficientSet</a></li>
<li>affected_species_indices&#160;:&#160;<a class="el" href="structgridfire_1_1_graph_engine_1_1_precomputed_reaction.html#a3e2e67e532970738d20491ea56b170f3">gridfire::GraphEngine::PrecomputedReaction</a></li>
<li>aIon&#160;:&#160;<a class="el" href="structgridfire_1_1approx8_1_1_approx8_net.html#a296e54c1b22f0c5d4d07a13577c6e069">gridfire::approx8::Approx8Net</a></li>
</ul>
<h3><a id="index_c" name="index_c"></a>- c -</h3><ul>
<li>c&#160;:&#160;<a class="el" href="structgridfire_1_1_graph_engine_1_1constants.html#a8bea6e348699c1aea93d17bb56739306">gridfire::GraphEngine::constants</a></li>
<li>chapter&#160;:&#160;<a class="el" href="structgridfire_1_1reaclib_1_1_reaction_record.html#a5c853b69a23b0a8c39ab4b55ac3fe3cc">gridfire::reaclib::ReactionRecord</a></li>
<li>coeffs&#160;:&#160;<a class="el" href="structgridfire_1_1reaclib_1_1_reaction_record.html#a80803f612e574859fde0a163bca84bc0">gridfire::reaclib::ReactionRecord</a></li>
<li>composition&#160;:&#160;<a class="el" href="structgridfire_1_1_net_in.html#a13058f4929e72c1187abbebcddb8aed1">gridfire::NetIn</a>, <a class="el" href="structgridfire_1_1_net_out.html#a073529511ae0e52f868b47cce0e8ac0a">gridfire::NetOut</a></li>
@@ -165,7 +167,7 @@ $(function(){initNavTree('functions_vars.html',''); initResizable(true); });
<li>m_baseEngine&#160;:&#160;<a class="el" href="classgridfire_1_1_adaptive_engine_view.html#a4d38b46be9f25c7afe7ddd2b284253f8">gridfire::AdaptiveEngineView</a>, <a class="el" href="classgridfire_1_1_file_defined_engine_view.html#ad8454c98fa9a4bb45dc81059bc51fc81">gridfire::FileDefinedEngineView</a></li>
<li>m_chapter&#160;:&#160;<a class="el" href="classgridfire_1_1reaction_1_1_reaction.html#a16f9cbb6269817099d3dc07d4e63da7b">gridfire::reaction::Reaction</a></li>
<li>m_config&#160;:&#160;<a class="el" href="classgridfire_1_1_adaptive_engine_view.html#a14171a9ccc45a63996a967c72983de30">gridfire::AdaptiveEngineView</a>, <a class="el" href="classgridfire_1_1_file_defined_engine_view.html#a7a80966c023ae722239491af58609362">gridfire::FileDefinedEngineView</a>, <a class="el" href="classgridfire_1_1_graph_engine.html#a3b17102b143435ddfdc015d7a50c4b18">gridfire::GraphEngine</a>, <a class="el" href="classgridfire_1_1io_1_1_m_e_s_a_network_file_parser.html#aea206c3a7600db8d657666fef88fa20d">gridfire::io::MESANetworkFileParser</a>, <a class="el" href="classgridfire_1_1io_1_1_simple_reaction_list_file_parser.html#a4061e99bd77a3de0d6d9e317bfc74874">gridfire::io::SimpleReactionListFileParser</a>, <a class="el" href="classgridfire_1_1_network.html#a9f8802012728ef5fea0e8cd465044e09">gridfire::Network</a>, <a class="el" href="classgridfire_1_1solver_1_1_direct_network_solver.html#a0d1b52d06b0521e7c556d75cd8d2ffe6">gridfire::solver::DirectNetworkSolver</a>, <a class="el" href="classgridfire_1_1solver_1_1_q_s_e_network_solver.html#a7d19b6e50db34d38c81afec76bbedee1">gridfire::solver::QSENetworkSolver</a></li>
<li>m_constants&#160;:&#160;<a class="el" href="classgridfire_1_1_graph_engine.html#a0837bab6dcd111d9075c9343b90d64f1">gridfire::GraphEngine</a>, <a class="el" href="classgridfire_1_1_network.html#adf7002883160101c9f9d1b376b265410">gridfire::Network</a></li>
<li>m_constants&#160;:&#160;<a class="el" href="classgridfire_1_1_graph_engine.html#a10c01bc20ae668c2857efb2a1783098e">gridfire::GraphEngine</a>, <a class="el" href="classgridfire_1_1_network.html#adf7002883160101c9f9d1b376b265410">gridfire::Network</a></li>
<li>m_dt0&#160;:&#160;<a class="el" href="classgridfire_1_1approx8_1_1_approx8_network.html#a6ed8022834e9541b3e547dd867648b0f">gridfire::approx8::Approx8Network</a></li>
<li>m_dynamicSpeciesIndices&#160;:&#160;<a class="el" href="structgridfire_1_1solver_1_1_q_s_e_network_solver_1_1_eigen_functor.html#a08ce53701b152f3ce108c1c18ce64de2">gridfire::solver::QSENetworkSolver::EigenFunctor&lt; T &gt;</a>, <a class="el" href="structgridfire_1_1solver_1_1_q_s_e_network_solver_1_1_jacobian_functor.html#a2071ce797f94ae1a3ea6d934748672ce">gridfire::solver::QSENetworkSolver::JacobianFunctor</a>, <a class="el" href="structgridfire_1_1solver_1_1_q_s_e_network_solver_1_1_r_h_s_functor.html#a3ac1ef529627d21f7d1ad718dc87f7f9">gridfire::solver::QSENetworkSolver::RHSFunctor</a></li>
<li>m_engine&#160;:&#160;<a class="el" href="structgridfire_1_1solver_1_1_direct_network_solver_1_1_jacobian_functor.html#a56f8b2b222fb2a7dac190ead0babfdd0">gridfire::solver::DirectNetworkSolver::JacobianFunctor</a>, <a class="el" href="structgridfire_1_1solver_1_1_direct_network_solver_1_1_r_h_s_functor.html#a04f8c84e46e6fbd0977e50fda4829d1a">gridfire::solver::DirectNetworkSolver::RHSFunctor</a>, <a class="el" href="classgridfire_1_1solver_1_1_network_solver_strategy.html#a724924d94eaf82b67d9988a55c3261e8">gridfire::solver::NetworkSolverStrategy&lt; EngineT &gt;</a>, <a class="el" href="structgridfire_1_1solver_1_1_q_s_e_network_solver_1_1_eigen_functor.html#a93b46ca95ddf9e4d21d02700621e6285">gridfire::solver::QSENetworkSolver::EigenFunctor&lt; T &gt;</a>, <a class="el" href="structgridfire_1_1solver_1_1_q_s_e_network_solver_1_1_jacobian_functor.html#aaaa82eff96e6127a6de05444f730e43a">gridfire::solver::QSENetworkSolver::JacobianFunctor</a>, <a class="el" href="structgridfire_1_1solver_1_1_q_s_e_network_solver_1_1_r_h_s_functor.html#a0d8d28a6559cfed5e7cd683523d49b2c">gridfire::solver::QSENetworkSolver::RHSFunctor</a></li>
@@ -184,6 +186,7 @@ $(function(){initNavTree('functions_vars.html',''); initResizable(true); });
<li>m_numSpecies&#160;:&#160;<a class="el" href="structgridfire_1_1solver_1_1_direct_network_solver_1_1_jacobian_functor.html#a3f624142212b5e6ff65f5706953fe353">gridfire::solver::DirectNetworkSolver::JacobianFunctor</a>, <a class="el" href="structgridfire_1_1solver_1_1_direct_network_solver_1_1_r_h_s_functor.html#ac4a1af03d2a4fbc5cc2407b8a6833147">gridfire::solver::DirectNetworkSolver::RHSFunctor</a></li>
<li>m_parser&#160;:&#160;<a class="el" href="classgridfire_1_1_file_defined_engine_view.html#a0a9b07176cb93b54c677b6ce71fda500">gridfire::FileDefinedEngineView</a></li>
<li>m_peName&#160;:&#160;<a class="el" href="classgridfire_1_1reaction_1_1_reaction.html#a6124aa9fc2306349e1dd879a37923248">gridfire::reaction::Reaction</a></li>
<li>m_precomputedReactions&#160;:&#160;<a class="el" href="classgridfire_1_1_graph_engine.html#a5d431d5385b1219ba29689eb29601ea3">gridfire::GraphEngine</a></li>
<li>m_products&#160;:&#160;<a class="el" href="classgridfire_1_1reaction_1_1_reaction.html#a4b5607ed413acdf29539b8a57461e49e">gridfire::reaction::Reaction</a></li>
<li>m_QSESpeciesIndices&#160;:&#160;<a class="el" href="structgridfire_1_1solver_1_1_q_s_e_network_solver_1_1_eigen_functor.html#abaf28fdd93e881ef56c24f541be7492d">gridfire::solver::QSENetworkSolver::EigenFunctor&lt; T &gt;</a>, <a class="el" href="structgridfire_1_1solver_1_1_q_s_e_network_solver_1_1_jacobian_functor.html#a1b92391170eb46771bd499aa8d115334">gridfire::solver::QSENetworkSolver::JacobianFunctor</a>, <a class="el" href="structgridfire_1_1solver_1_1_q_s_e_network_solver_1_1_r_h_s_functor.html#a6be7259897a47ce480b289144b06e269">gridfire::solver::QSENetworkSolver::RHSFunctor</a></li>
<li>m_qValue&#160;:&#160;<a class="el" href="classgridfire_1_1reaction_1_1_reaction.html#a59122a2898bb9af640cc3e9aeb49028b">gridfire::reaction::Reaction</a></li>
@@ -207,6 +210,7 @@ $(function(){initNavTree('functions_vars.html',''); initResizable(true); });
<li>m_stoichiometryMatrix&#160;:&#160;<a class="el" href="classgridfire_1_1_graph_engine.html#ad1cb5fd32efc37668e2d9ecf0c72ad24">gridfire::GraphEngine</a></li>
<li>m_T9&#160;:&#160;<a class="el" href="structgridfire_1_1solver_1_1_direct_network_solver_1_1_jacobian_functor.html#a88f5fc48a555b369f1e2688d6bb67b83">gridfire::solver::DirectNetworkSolver::JacobianFunctor</a>, <a class="el" href="structgridfire_1_1solver_1_1_direct_network_solver_1_1_r_h_s_functor.html#a082844f1eae0609e66620575210e8823">gridfire::solver::DirectNetworkSolver::RHSFunctor</a>, <a class="el" href="structgridfire_1_1solver_1_1_q_s_e_network_solver_1_1_eigen_functor.html#a6771ae56ddd9058954b42ee92a378309">gridfire::solver::QSENetworkSolver::EigenFunctor&lt; T &gt;</a>, <a class="el" href="structgridfire_1_1solver_1_1_q_s_e_network_solver_1_1_jacobian_functor.html#a85f88639447a9a706008efece82ff289">gridfire::solver::QSENetworkSolver::JacobianFunctor</a>, <a class="el" href="structgridfire_1_1solver_1_1_q_s_e_network_solver_1_1_r_h_s_functor.html#a35026100163c7cc6fdb4c2e4d988b8cb">gridfire::solver::QSENetworkSolver::RHSFunctor</a></li>
<li>m_tMax&#160;:&#160;<a class="el" href="classgridfire_1_1approx8_1_1_approx8_network.html#a6fadf388f07c160f1887a3cb72eaa869">gridfire::approx8::Approx8Network</a></li>
<li>m_usePrecomputation&#160;:&#160;<a class="el" href="classgridfire_1_1_graph_engine.html#a191cff35402d3c97c82c5c966a39d0de">gridfire::GraphEngine</a></li>
<li>m_y&#160;:&#160;<a class="el" href="classgridfire_1_1approx8_1_1_approx8_network.html#abf9f13ff532917ddac4a7d987698836d">gridfire::approx8::Approx8Network</a></li>
<li>m_Y_QSE&#160;:&#160;<a class="el" href="structgridfire_1_1solver_1_1_q_s_e_network_solver_1_1_r_h_s_functor.html#a02c23ef20d616bf5a591a274b66cd75a">gridfire::solver::QSENetworkSolver::RHSFunctor</a></li>
<li>m_YFull&#160;:&#160;<a class="el" href="structgridfire_1_1solver_1_1_q_s_e_network_solver_1_1_eigen_functor.html#a2dca32a9e0bea5aea2a565f94b99a8de">gridfire::solver::QSENetworkSolver::EigenFunctor&lt; T &gt;</a></li>
@@ -215,6 +219,7 @@ $(function(){initNavTree('functions_vars.html',''); initResizable(true); });
<h3><a id="index_n" name="index_n"></a>- n -</h3><ul>
<li>Na&#160;:&#160;<a class="el" href="structgridfire_1_1_graph_engine_1_1constants.html#a5ccc874d6704615e0ce54c14dc67699d">gridfire::GraphEngine::constants</a></li>
<li>nIso&#160;:&#160;<a class="el" href="structgridfire_1_1approx8_1_1_approx8_net.html#a31928b4041479da6515a90569322fc02">gridfire::approx8::Approx8Net</a></li>
<li>nuclearEnergyGenerationRate&#160;:&#160;<a class="el" href="structgridfire_1_1_step_derivatives.html#ab4aeb41be952c7b5844e1ee81fef9008">gridfire::StepDerivatives&lt; T &gt;</a></li>
<li>num_steps&#160;:&#160;<a class="el" href="structgridfire_1_1_net_out.html#a51c16703132cf739ec2fd89eae7badd6">gridfire::NetOut</a></li>
@@ -234,7 +239,9 @@ $(function(){initNavTree('functions_vars.html',''); initResizable(true); });
<h3><a id="index_r" name="index_r"></a>- r -</h3><ul>
<li>reactant_powers&#160;:&#160;<a class="el" href="structgridfire_1_1_graph_engine_1_1_precomputed_reaction.html#a03d596c88289e21e7bd18711e3a1f275">gridfire::GraphEngine::PrecomputedReaction</a></li>
<li>reactants_str&#160;:&#160;<a class="el" href="structgridfire_1_1reaclib_1_1_reaction_record.html#a67afc513db8dbcc43d79733e22ca8d39">gridfire::reaclib::ReactionRecord</a></li>
<li>reaction_index&#160;:&#160;<a class="el" href="structgridfire_1_1_graph_engine_1_1_precomputed_reaction.html#a93635f6940d3534e949f402503c3d497">gridfire::GraphEngine::PrecomputedReaction</a></li>
<li>reactionPENames&#160;:&#160;<a class="el" href="structgridfire_1_1io_1_1_parsed_network_data.html#a5145c672877638e6113abf1f719b246d">gridfire::io::ParsedNetworkData</a></li>
<li>reactionPtr&#160;:&#160;<a class="el" href="structgridfire_1_1_adaptive_engine_view_1_1_reaction_flow.html#a3bb21f20df8115d37108cf3c3be3bc6f">gridfire::AdaptiveEngineView::ReactionFlow</a></li>
<li>reverse&#160;:&#160;<a class="el" href="structgridfire_1_1reaclib_1_1_reaction_record.html#aa1fd4f510d7c00d2e4197e9b9caf29fd">gridfire::reaclib::ReactionRecord</a></li>
@@ -242,10 +249,22 @@ $(function(){initNavTree('functions_vars.html',''); initResizable(true); });
</ul>
<h3><a id="index_s" name="index_s"></a>- s -</h3><ul>
<li>stoichiometric_coefficients&#160;:&#160;<a class="el" href="structgridfire_1_1_graph_engine_1_1_precomputed_reaction.html#a7a7e9167b19e339e0d69544b9c00e79c">gridfire::GraphEngine::PrecomputedReaction</a></li>
<li>symmetry_factor&#160;:&#160;<a class="el" href="structgridfire_1_1_graph_engine_1_1_precomputed_reaction.html#ac42504e868c0b9fd9ac9a405ea739f0e">gridfire::GraphEngine::PrecomputedReaction</a></li>
</ul>
<h3><a id="index_t" name="index_t"></a>- t -</h3><ul>
<li>temperature&#160;:&#160;<a class="el" href="structgridfire_1_1_net_in.html#a5be0f5195a5cd1dd177b9fc5ab83a7be">gridfire::NetIn</a></li>
<li>tMax&#160;:&#160;<a class="el" href="structgridfire_1_1_net_in.html#a0a8d820cfeaa92ee31f253795c57e0d1">gridfire::NetIn</a></li>
</ul>
<h3><a id="index_u" name="index_u"></a>- u -</h3><ul>
<li>u&#160;:&#160;<a class="el" href="structgridfire_1_1_graph_engine_1_1constants.html#a3597bc632a5dd50aaa0044d8c18ca423">gridfire::GraphEngine::constants</a></li>
<li>unique_reactant_indices&#160;:&#160;<a class="el" href="structgridfire_1_1_graph_engine_1_1_precomputed_reaction.html#a510e380116e2e6d9158cf00fedac2666">gridfire::GraphEngine::PrecomputedReaction</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->