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

20
docs/html/annotated.html
View File

@@ -111,10 +111,10 @@ $(function(){initNavTree('annotated.html',''); initResizable(true); });
<tr id="row_0_0_2_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgridfire_1_1approx8_1_1_jacobian.html" target="_self">Jacobian</a></td><td class="desc">Functor to calculate the <a class="el" href="structgridfire_1_1approx8_1_1_jacobian.html" title="Functor to calculate the Jacobian matrix for implicit solvers.">Jacobian</a> matrix for implicit solvers </td></tr>
<tr id="row_0_0_3_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgridfire_1_1approx8_1_1_o_d_e.html" target="_self">ODE</a></td><td class="desc">Functor to calculate the derivatives for the <a class="el" href="structgridfire_1_1approx8_1_1_o_d_e.html" title="Functor to calculate the derivatives for the ODE solver.">ODE</a> solver </td></tr>
<tr id="row_0_1_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_1_" class="arrow" onclick="dynsection.toggleFolder('0_1_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespacegridfire_1_1io.html" target="_self">io</a></td><td class="desc"></td></tr>
<tr id="row_0_1_0_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgridfire_1_1io_1_1_m_e_s_a_network_file_parser.html" target="_self">MESANetworkFileParser</a></td><td class="desc"></td></tr>
<tr id="row_0_1_1_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgridfire_1_1io_1_1_network_file_parser.html" target="_self">NetworkFileParser</a></td><td class="desc"></td></tr>
<tr id="row_0_1_2_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgridfire_1_1io_1_1_parsed_network_data.html" target="_self">ParsedNetworkData</a></td><td class="desc"></td></tr>
<tr id="row_0_1_3_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgridfire_1_1io_1_1_simple_reaction_list_file_parser.html" target="_self">SimpleReactionListFileParser</a></td><td class="desc"></td></tr>
<tr id="row_0_1_0_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgridfire_1_1io_1_1_m_e_s_a_network_file_parser.html" target="_self">MESANetworkFileParser</a></td><td class="desc">A parser for MESA-format network files </td></tr>
<tr id="row_0_1_1_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgridfire_1_1io_1_1_network_file_parser.html" target="_self">NetworkFileParser</a></td><td class="desc">An abstract base class for network file parsers </td></tr>
<tr id="row_0_1_2_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgridfire_1_1io_1_1_parsed_network_data.html" target="_self">ParsedNetworkData</a></td><td class="desc">Holds the data parsed from a network file </td></tr>
<tr id="row_0_1_3_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgridfire_1_1io_1_1_simple_reaction_list_file_parser.html" target="_self">SimpleReactionListFileParser</a></td><td class="desc">A parser for simple text files containing a list of reactions </td></tr>
<tr id="row_0_2_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_2_" class="arrow" onclick="dynsection.toggleFolder('0_2_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespacegridfire_1_1reaclib.html" target="_self">reaclib</a></td><td class="desc"></td></tr>
<tr id="row_0_2_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgridfire_1_1reaclib_1_1_reaction_record.html" target="_self">ReactionRecord</a></td><td class="desc"></td></tr>
<tr id="row_0_3_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_3_" class="arrow" onclick="dynsection.toggleFolder('0_3_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespacegridfire_1_1reaction.html" target="_self">reaction</a></td><td class="desc"></td></tr>
@@ -123,9 +123,9 @@ $(function(){initNavTree('annotated.html',''); initResizable(true); });
<tr id="row_0_3_2_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgridfire_1_1reaction_1_1_reaction.html" target="_self">Reaction</a></td><td class="desc">Represents a single nuclear reaction from a specific data source </td></tr>
<tr id="row_0_3_3_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgridfire_1_1reaction_1_1_templated_reaction_set.html" target="_self">TemplatedReactionSet</a></td><td class="desc"></td></tr>
<tr id="row_0_4_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_4_" class="arrow" onclick="dynsection.toggleFolder('0_4_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespacegridfire_1_1screening.html" target="_self">screening</a></td><td class="desc"></td></tr>
<tr id="row_0_4_0_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgridfire_1_1screening_1_1_bare_screening_model.html" target="_self">BareScreeningModel</a></td><td class="desc"></td></tr>
<tr id="row_0_4_1_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgridfire_1_1screening_1_1_screening_model.html" target="_self">ScreeningModel</a></td><td class="desc"></td></tr>
<tr id="row_0_4_2_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgridfire_1_1screening_1_1_weak_screening_model.html" target="_self">WeakScreeningModel</a></td><td class="desc"></td></tr>
<tr id="row_0_4_0_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgridfire_1_1screening_1_1_bare_screening_model.html" target="_self">BareScreeningModel</a></td><td class="desc">A screening model that applies no screening effect </td></tr>
<tr id="row_0_4_1_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgridfire_1_1screening_1_1_screening_model.html" target="_self">ScreeningModel</a></td><td class="desc">An abstract base class for plasma screening models </td></tr>
<tr id="row_0_4_2_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgridfire_1_1screening_1_1_weak_screening_model.html" target="_self">WeakScreeningModel</a></td><td class="desc">Implements the weak screening model based on the Debye-Hückel approximation </td></tr>
<tr id="row_0_5_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_5_" class="arrow" onclick="dynsection.toggleFolder('0_5_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespacegridfire_1_1solver.html" target="_self">solver</a></td><td class="desc"></td></tr>
<tr id="row_0_5_0_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span id="arr_0_5_0_" class="arrow" onclick="dynsection.toggleFolder('0_5_0_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgridfire_1_1solver_1_1_direct_network_solver.html" target="_self">DirectNetworkSolver</a></td><td class="desc">A network solver that directly integrates the reaction network ODEs </td></tr>
<tr id="row_0_5_0_0_" class="even"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgridfire_1_1solver_1_1_direct_network_solver_1_1_jacobian_functor.html" target="_self">JacobianFunctor</a></td><td class="desc">Functor for calculating the Jacobian matrix </td></tr>
@@ -141,8 +141,10 @@ $(function(){initNavTree('annotated.html',''); initResizable(true); });
<tr id="row_0_7_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgridfire_1_1_dynamic_engine.html" target="_self">DynamicEngine</a></td><td class="desc">Abstract class for engines supporting Jacobian and stoichiometry operations </td></tr>
<tr id="row_0_8_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgridfire_1_1_engine.html" target="_self">Engine</a></td><td class="desc">Abstract base class for a reaction network engine </td></tr>
<tr id="row_0_9_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgridfire_1_1_engine_view.html" target="_self">EngineView</a></td><td class="desc">Abstract base class for a "view" of a reaction network engine </td></tr>
<tr id="row_0_10_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgridfire_1_1_file_defined_engine_view.html" target="_self">FileDefinedEngineView</a></td><td class="desc"></td></tr>
<tr id="row_0_11_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgridfire_1_1_graph_engine.html" target="_self">GraphEngine</a></td><td class="desc">A reaction network engine that uses a graph-based representation </td></tr>
<tr id="row_0_10_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgridfire_1_1_file_defined_engine_view.html" target="_self">FileDefinedEngineView</a></td><td class="desc">An engine view that uses a user-defined reaction network from a file </td></tr>
<tr id="row_0_11_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_11_" class="arrow" onclick="dynsection.toggleFolder('0_11_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgridfire_1_1_graph_engine.html" target="_self">GraphEngine</a></td><td class="desc">A reaction network engine that uses a graph-based representation </td></tr>
<tr id="row_0_11_0_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgridfire_1_1_graph_engine_1_1constants.html" target="_self">constants</a></td><td class="desc"></td></tr>
<tr id="row_0_11_1_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgridfire_1_1_graph_engine_1_1_precomputed_reaction.html" target="_self">PrecomputedReaction</a></td><td class="desc"></td></tr>
<tr id="row_0_12_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgridfire_1_1_net_in.html" target="_self">NetIn</a></td><td class="desc"></td></tr>
<tr id="row_0_13_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgridfire_1_1_net_out.html" target="_self">NetOut</a></td><td class="desc"></td></tr>
<tr id="row_0_14_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgridfire_1_1_network.html" target="_self">Network</a></td><td class="desc"></td></tr>