<trclass="memdesc:"><tdclass="mdescLeft"> </td><tdclass="mdescRight">An engine view that dynamically adapts the reaction network based on runtime conditions. <ahref="classgridfire_1_1_adaptive_engine_view.html#details">More...</a><br/></td></tr>
<trclass="memdesc:"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Abstract class for engines supporting Jacobian and stoichiometry operations. <ahref="classgridfire_1_1_dynamic_engine.html#details">More...</a><br/></td></tr>
<trclass="memdesc:"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Abstract base class for a reaction network engine. <ahref="classgridfire_1_1_engine.html#details">More...</a><br/></td></tr>
<trclass="memdesc:"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Abstract base class for a "view" of a reaction network engine. <ahref="classgridfire_1_1_engine_view.html#details">More...</a><br/></td></tr>
<trclass="memdesc:"><tdclass="mdescLeft"> </td><tdclass="mdescRight">A reaction network engine that uses a graph-based representation. <ahref="classgridfire_1_1_graph_engine.html#details">More...</a><br/></td></tr>
<trclass="memdesc:"><tdclass="mdescLeft"> </td><tdclass="mdescRight">An engine view that partitions the reaction network into multiple groups based on timescales. <ahref="classgridfire_1_1_multiscale_partitioning_engine_view.html#details">More...</a><br/></td></tr>
<trclass="memdesc:"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Provides a view of a <aclass="el"href="classgridfire_1_1_dynamic_engine.html"title="Abstract class for engines supporting Jacobian and stoichiometry operations.">DynamicEngine</a> filtered to reactions involving a specified priming species. <ahref="classgridfire_1_1_network_priming_engine_view.html#details">More...</a><br/></td></tr>
<trclass="memdesc:"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Captures the result of a network priming operation. <ahref="structgridfire_1_1_priming_report.html#details">More...</a><br/></td></tr>
<trclass="memdesc:"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Configuration struct for the QSE cache. <ahref="structgridfire_1_1_q_s_e_cache_config.html#details">More...</a><br/></td></tr>
<trclass="memdesc:"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Key struct for the QSE abundance cache. <ahref="structgridfire_1_1_q_s_e_cache_key.html#details">More...</a><br/></td></tr>
<trclass="memdesc:"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Represents a single nuclear reaction from a specific data source. <ahref="classgridfire_1_1_reaction.html#details">More...</a><br/></td></tr>
<trclass="memdesc:"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Structure holding derivatives and energy generation for a network step. <ahref="structgridfire_1_1_step_derivatives.html#details">More...</a><br/></td></tr>
<trclass="memdesc:a1121d0b2d005195333412559fa29d3cc"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Alias for CppAD AD type for double precision. <br/></td></tr>
<trclass="memdesc:a3b1f70dc7ff5b501809330a97079e4f6"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Variant specifying either a predefined <aclass="el"href="#a0210bd2e07538932135a56b62b8ddb57"title="Specifies supported depths for building the reaction network.">NetworkBuildDepth</a> or a custom integer depth. <br/></td></tr>
<trclass="memdesc:ad838ce3fb6cc02c3fd90b924a0dd91b1"><tdclass="mdescLeft"> </td><tdclass="mdescRight">A set of reactions, typically from a single source like REACLIB. <br/></td></tr>
<trclass="memitem:a0210bd2e07538932135a56b62b8ddb57"id="r_a0210bd2e07538932135a56b62b8ddb57"><tdclass="memItemLeft"align="right"valign="top">enum class  </td><tdclass="memItemRight"valign="bottom"><aclass="el"href="#a0210bd2e07538932135a56b62b8ddb57">NetworkBuildDepth</a> { <br/>
<trclass="memdesc:a0210bd2e07538932135a56b62b8ddb57"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Specifies supported depths for building the reaction network. <ahref="#a0210bd2e07538932135a56b62b8ddb57">More...</a><br/></td></tr>
<trclass="memitem:a8bea3d74f35d640e693fa398e9b3e154"id="r_a8bea3d74f35d640e693fa398e9b3e154"><tdclass="memItemLeft"align="right"valign="top">enum class  </td><tdclass="memItemRight"valign="bottom"><aclass="el"href="#a8bea3d74f35d640e693fa398e9b3e154">PrimingReportStatus</a> { <br/>
<trclass="memdesc:a8bea3d74f35d640e693fa398e9b3e154"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Enumerates outcome codes for a network priming operation. <ahref="#a8bea3d74f35d640e693fa398e9b3e154">More...</a><br/></td></tr>
<trclass="memdesc:aedddb89e400a6111f69bfe0c3fd4214e"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Builds a nuclear reaction network from the Reaclib library based on an initial composition. <br/></td></tr>
<trclass="memdesc:acd0bfdfbce4e84af102d62ff8a797c9f"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Primes absent species in the network to their equilibrium abundances. <br/></td></tr>
<trclass="memdesc:a8f26d5f5fabb42e88261e42bc060cea2"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Computes the destruction rate constant for a specific species. <br/></td></tr>
<trclass="memdesc:a7c4b6104d5dfc5afddda36f726c5d07d"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Computes the creation rate for a specific species. <br/></td></tr>
<trclass="memdesc:ada3c137c014ecd8d06200fea2d1a9f50"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Minimum density threshold below which reactions are ignored. <br/></td></tr>
<trclass="memdesc:a96c062f94713921e5d7568ecedcdcb06"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Minimum abundance threshold below which species are ignored. <br/></td></tr>
<trclass="memdesc:ae01b1738df1921db565bcbd68dd6cf64"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Minimum value for Jacobian matrix entries. <br/></td></tr>
<trclass="memdesc:a02be158966bf82a91b159b7a962c3fa5"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Mapping from <aclass="el"href="#a8bea3d74f35d640e693fa398e9b3e154"title="Enumerates outcome codes for a network priming operation.">PrimingReportStatus</a> codes to human-readable strings. <br/></td></tr>
<pclass="definition">Definition at line <aclass="el"href="engine__graph_8h_source.html#l00044">44</a> of file <aclass="el"href="engine__graph_8h_source.html">engine_graph.h</a>.</p>
<p>Variant specifying either a predefined <aclass="el"href="#a0210bd2e07538932135a56b62b8ddb57"title="Specifies supported depths for building the reaction network.">NetworkBuildDepth</a> or a custom integer depth. </p>
<dlclass="section pre"><dt>Precondition</dt><dd>If using the integer alternative, the value must be >= 0 or -1 to indicate a full build. </dd></dl>
<dlclass="section post"><dt>Postcondition</dt><dd>The network builder will interpret and apply the specified depth to control reaction expansion. </dd></dl>
<pclass="definition">Definition at line <aclass="el"href="building_8h_source.html#l00037">37</a> of file <aclass="el"href="building_8h_source.html">building.h</a>.</p>
<pclass="definition">Definition at line <aclass="el"href="reaction_8h_source.html#l00563">563</a> of file <aclass="el"href="reaction_8h_source.html">reaction.h</a>.</p>
<p>A set of reactions, typically from a single source like REACLIB. </p>
<pclass="definition">Definition at line <aclass="el"href="reaction_8h_source.html#l00562">562</a> of file <aclass="el"href="reaction_8h_source.html">reaction.h</a>.</p>
<pclass="definition">Definition at line <aclass="el"href="engine__abstract_8h_source.html#l00065">65</a> of file <aclass="el"href="engine__abstract_8h_source.html">engine_abstract.h</a>.</p>
<p>Specifies supported depths for building the reaction network. </p>
<p>Values:</p><ul>
<li>Full: Build the complete network (infinite depth).</li>
<li>Shallow: Build only direct reactions (depth = 1).</li>
<li>SecondOrder: Include reactions up to second order (depth = 2).</li>
<li>ThirdOrder: Include reactions up to third order (depth = 3).</li>
<li>FourthOrder: Include reactions up to fourth order (depth = 4).</li>
<li>FifthOrder: Include reactions up to fifth order (depth = 5).</li>
</ul>
<dlclass="section note"><dt>Note</dt><dd>For custom build depths, see <aclass="el"href="#a3b1f70dc7ff5b501809330a97079e4f6"title="Variant specifying either a predefined NetworkBuildDepth or a custom integer depth.">BuildDepthType</a>. </dd></dl>
<pclass="definition">Definition at line <aclass="el"href="building_8h_source.html#l00021">21</a> of file <aclass="el"href="building_8h_source.html">building.h</a>.</p>
<pclass="definition">Definition at line <aclass="el"href="network_8h_source.html#l00041">41</a> of file <aclass="el"href="network_8h_source.html">network.h</a>.</p>
<p>Enumerates outcome codes for a network priming operation. </p>
<p>These status codes indicate the reason for success or failure of the priming process:</p><ul>
<li>FULL_SUCCESS: Priming completed successfully with all species processed.</li>
<li>NO_SPECIES_TO_PRIME: There were no species eligible for priming.</li>
<li>MAX_ITERATIONS_REACHED: The algorithm reached its iteration limit without converging.</li>
<li>FAILED_TO_FINALIZE_COMPOSITION: Unable to build a valid Composition object at end.</li>
<li>FAILED_TO_FIND_CREATION_CHANNEL: No reaction path found to create the priming species.</li>
<li>FAILED_TO_FIND_PRIMING_REACTIONS: No reactions containing the priming species were found.</li>
<li>BASE_NETWORK_TOO_SHALLOW: The provided base network depth was insufficient for priming.</li>
</ul>
<dlclass="section see"><dt>See also</dt><dd><aclass="el"href="structgridfire_1_1_priming_report.html"title="Captures the result of a network priming operation.">PrimingReport</a> for data associated with each status. </dd></dl>
<pclass="definition">Definition at line <aclass="el"href="reporting_8h_source.html#l00031">31</a> of file <aclass="el"href="reporting_8h_source.html">reporting.h</a>.</p>
<pclass="definition">Definition at line <aclass="el"href="construction_8cpp_source.html#l00024">24</a> of file <aclass="el"href="construction_8cpp_source.html">construction.cpp</a>.</p>
<p>Builds a nuclear reaction network from the Reaclib library based on an initial composition. </p>
<p>Constructs a layered reaction network by collecting reactions up to the specified depth from the Reaclib dataset. Starting species are those with non-zero mass fractions in the input composition. Layers expand by including products of collected reactions until the depth limit. Optionally selects reverse reactions instead of forward.</p>
<p>See implementation in <aclass="el"href="construction_8cpp.html">construction.cpp</a> for details on the layering algorithm, logging, and performance.</p>
<dlclass="params"><dt>Parameters</dt><dd>
<tableclass="params">
<tr><tdclass="paramname">composition</td><td>Mapping of isotopic species to their mass fractions; species with positive mass fraction seed the network. </td></tr>
<tr><tdclass="paramname">maxLayers</td><td>Variant specifying either a predefined <aclass="el"href="#a0210bd2e07538932135a56b62b8ddb57"title="Specifies supported depths for building the reaction network.">NetworkBuildDepth</a> or a custom integer depth; negative depth (Full) collects all reactions, zero is invalid. </td></tr>
<tr><tdclass="paramname">reverse</td><td>If true, collects reverse reactions (decays or back-reactions); if false, uses forward reactions. </td></tr>
</table>
</dd>
</dl>
<dlclass="section pre"><dt>Precondition</dt><dd>composition must have at least one species with positive mass fraction. </dd>
<dd>
Resolved integer depth from maxLayers must not be zero. </dd></dl>
<dlclass="section post"><dt>Postcondition</dt><dd>Returned network includes only reactions satisfying the depth and reverse criteria. </dd></dl>
<dlclass="section return"><dt>Returns</dt><dd>A <aclass="el"href="namespacegridfire_1_1reaction.html#aa86f08712565f278adacc7cd2361eb31"title="A set of logical reactions.">LogicalReactionSet</a> encapsulating the collected reactions for graph-based engines. </dd></dl>
<dlclass="exception"><dt>Exceptions</dt><dd>
<tableclass="exception">
<tr><tdclass="paramname">std::logic_error</td><td>If the resolved network depth is zero (no reactions can be collected). </td></tr>
<p>Computes the creation rate for a specific species. </p>
<p>Sums molar reaction flows for all reactions where the species appears as a product (positive stoichiometry).</p>
<dlclass="params"><dt>Parameters</dt><dd>
<tableclass="params">
<tr><tdclass="paramname">engine</td><td><aclass="el"href="classgridfire_1_1_engine.html"title="Abstract base class for a reaction network engine.">Engine</a> providing the current set of network reactions and flow calculations. </td></tr>
<tr><tdclass="paramname">species</td><td>The atomic species whose creation rate is computed. </td></tr>
<tr><tdclass="paramname">Y</td><td>Vector of molar abundances for all species in the engine. </td></tr>
<tr><tdclass="paramname">T9</td><td>Temperature in units of 10^9 K. </td></tr>
<tr><tdclass="paramname">rho</td><td>Density of the medium. </td></tr>
</table>
</dd>
</dl>
<dlclass="section pre"><dt>Precondition</dt><dd>Y.size() matches engine.getNetworkReactions().size() mapping species order. </dd></dl>
<dlclass="section post"><dt>Postcondition</dt><dd>Returned creation rate is non-negative. </dd></dl>
<dlclass="section return"><dt>Returns</dt><dd>Sum of stoichiometry-weighted creation flows for the species. </dd></dl>
<pclass="definition">Definition at line <aclass="el"href="priming_8cpp_source.html#l00213">213</a> of file <aclass="el"href="priming_8cpp_source.html">priming.cpp</a>.</p>
<p>Computes the destruction rate constant for a specific species. </p>
<p>Calculates the sum of molar reaction flows for all reactions where the species is a reactant (negative stoichiometry) after scaling its abundance to unity.</p>
<dlclass="params"><dt>Parameters</dt><dd>
<tableclass="params">
<tr><tdclass="paramname">engine</td><td><aclass="el"href="classgridfire_1_1_engine.html"title="Abstract base class for a reaction network engine.">Engine</a> providing the current set of network reactions and flow calculations. </td></tr>
<tr><tdclass="paramname">species</td><td>The atomic species whose destruction rate is computed. </td></tr>
<tr><tdclass="paramname">Y</td><td>Vector of molar abundances for all species in the engine. </td></tr>
<tr><tdclass="paramname">T9</td><td>Temperature in units of 10^9 K. </td></tr>
<tr><tdclass="paramname">rho</td><td>Density of the medium. </td></tr>
</table>
</dd>
</dl>
<dlclass="section pre"><dt>Precondition</dt><dd>Y.size() matches engine.getNetworkReactions().size() mapping species order. </dd></dl>
<dlclass="section post"><dt>Postcondition</dt><dd>Returned rate constant is non-negative. </dd></dl>
<dlclass="section return"><dt>Returns</dt><dd>Sum of absolute stoichiometry-weighted destruction flows for the species. </dd></dl>
<pclass="definition">Definition at line <aclass="el"href="priming_8cpp_source.html#l00193">193</a> of file <aclass="el"href="priming_8cpp_source.html">priming.cpp</a>.</p>
<pclass="definition">Definition at line <aclass="el"href="priming_8cpp_source.html#l00017">17</a> of file <aclass="el"href="priming_8cpp_source.html">priming.cpp</a>.</p>
<p>Primes absent species in the network to their equilibrium abundances. </p>
<p>Executes a network priming algorithm that iteratively rebuilds the reaction network, calculates equilibrium mass fractions for species with zero initial abundance, and applies mass transfers based on reaction flows.</p>
<p>Refer to <aclass="el"href="priming_8cpp.html">priming.cpp</a> for implementation details on logging, algorithmic steps, and error handling.</p>
<dlclass="params"><dt>Parameters</dt><dd>
<tableclass="params">
<tr><tdclass="paramname">netIn</td><td>Input network data containing initial composition, temperature, and density. </td></tr>
<tr><tdclass="paramname">engine</td><td><aclass="el"href="classgridfire_1_1_dynamic_engine.html"title="Abstract class for engines supporting Jacobian and stoichiometry operations.">DynamicEngine</a> used to build and evaluate the reaction network. </td></tr>
</table>
</dd>
</dl>
<dlclass="section pre"><dt>Precondition</dt><dd>netIn.composition defines species and their mass fractions; engine is constructed with a valid network. </dd></dl>
<dlclass="section post"><dt>Postcondition</dt><dd>engine.networkReactions restored to its initial state; returned report contains primedComposition, massFractionChanges for each species, success flag, and status code. </dd></dl>
<dlclass="section return"><dt>Returns</dt><dd><aclass="el"href="structgridfire_1_1_priming_report.html"title="Captures the result of a network priming operation.">PrimingReport</a> encapsulating the results of the priming operation. </dd></dl>
<pclass="definition">Definition at line <aclass="el"href="priming_8cpp_source.html#l00039">39</a> of file <aclass="el"href="priming_8cpp_source.html">priming.cpp</a>.</p>
<pclass="definition">Definition at line <aclass="el"href="network_8cpp_source.html#l00065">65</a> of file <aclass="el"href="network_8cpp_source.html">network.cpp</a>.</p>
<pclass="definition">Definition at line <aclass="el"href="network_8h_source.html#l00047">47</a> of file <aclass="el"href="network_8h_source.html">network.h</a>.</p>
<p>Minimum abundance threshold below which species are ignored. </p>
<p>Species with abundances below this threshold are treated as zero in reaction rate calculations. This helps to improve performance by avoiding unnecessary calculations for trace species. </p>
<pclass="definition">Definition at line <aclass="el"href="engine__graph_8h_source.html#l00066">66</a> of file <aclass="el"href="engine__graph_8h_source.html">engine_graph.h</a>.</p>
<p>Minimum density threshold below which reactions are ignored. </p>
<p>Reactions are not calculated if the density falls below this threshold. This helps to improve performance by avoiding unnecessary calculations in very low-density regimes. </p>
<pclass="definition">Definition at line <aclass="el"href="engine__graph_8h_source.html#l00057">57</a> of file <aclass="el"href="engine__graph_8h_source.html">engine_graph.h</a>.</p>
<pclass="definition">Definition at line <aclass="el"href="engine__graph_8h_source.html#l00074">74</a> of file <aclass="el"href="engine__graph_8h_source.html">engine_graph.h</a>.</p>
<divclass="line"> {<aclass="code hl_enumvalue"href="#a8bea3d74f35d640e693fa398e9b3e154a708c14ec56942aa5f32e7bef1e29db45">PrimingReportStatus::NO_SPECIES_TO_PRIME</a>, <spanclass="stringliteral">"No Species to Prime"</span>},</div>
<p>Mapping from <aclass="el"href="#a8bea3d74f35d640e693fa398e9b3e154"title="Enumerates outcome codes for a network priming operation.">PrimingReportStatus</a> codes to human-readable strings. </p>
<p>Used when formatting or logging the priming status. No preconditions. The map contains entries for all <aclass="el"href="#a8bea3d74f35d640e693fa398e9b3e154"title="Enumerates outcome codes for a network priming operation.">PrimingReportStatus</a> values. </p>
<pclass="definition">Definition at line <aclass="el"href="reporting_8h_source.html#l00047">47</a> of file <aclass="el"href="reporting_8h_source.html">reporting.h</a>.</p>
<pclass="definition">Definition at line <aclass="el"href="engine__multiscale_8cpp_source.html#l00150">150</a> of file <aclass="el"href="engine__multiscale_8cpp_source.html">engine_multiscale.cpp</a>.</p>
<liclass="footer">Generated by <ahref="https://www.doxygen.org/index.html"><imgclass="footer"src="doxygen.svg"width="104"height="31"alt="doxygen"/></a> 1.13.2 </li>
