<trclass="memdesc:"><tdclass="mdescLeft"> </td><tdclass="mdescRight">An engine view that dynamically adapts the reaction network based on runtime conditions. <ahref="classgridfire_1_1engine_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_1engine_1_1_dynamic_engine.html#details">More...</a><br/></td></tr>
<trclass="memdesc:"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Structure holding derivatives of energy generation rate with respect to T and rho. <ahref="structgridfire_1_1engine_1_1_energy_derivatives.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_1engine_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_1engine_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_1engine_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_1engine_1_1_multiscale_partitioning_engine_view.html#details">More...</a><br/></td></tr>
<trclass="memdesc:"><tdclass="mdescLeft"> </td><tdclass="mdescRight">A wrapper class for handling the network Jacobian matrix. <ahref="classgridfire_1_1engine_1_1_network_jacobian.html#details">More...</a><br/></td></tr>
<trclass="memdesc:"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Provides a view of a <aclass="el"href="classgridfire_1_1engine_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_1engine_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_1engine_1_1_priming_report.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_1engine_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_1engine_1_1_step_derivatives.html#details">More...</a><br/></td></tr>
<trclass="memdesc:a9de1791ec719c0a9b76b835703336870"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Type alias for sparsity pattern representation. <br/></td></tr>
<trclass="memdesc:a4562b782e8096986a9b0cc95aa8c1c02"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Alias for CppAD AD type for double precision. <br/></td></tr>
<trclass="memdesc:a55cd7c313bbfafd5b6a1bcd6329ed99b"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Variant specifying either a predefined <aclass="el"href="#a782fbc9eca00df10e4a204ae6da733e7"title="Specifies supported depths for building the reaction network.">NetworkBuildDepth</a> or a custom integer depth. <br/></td></tr>
<trclass="memdesc:aa7b127f4fe99188e3d94ff11608d54f0"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Represents an entry in the Jacobian matrix. <br/></td></tr>
<trclass="memitem:a4d057e41b489bf20744dfa8d2958ad5a"id="r_a4d057e41b489bf20744dfa8d2958ad5a"><tdclass="memItemLeft"align="right"valign="top">enum class  </td><tdclass="memItemRight"valign="bottom"><aclass="el"href="#a4d057e41b489bf20744dfa8d2958ad5a">EngineStatus</a> { <aclass="el"href="#a4d057e41b489bf20744dfa8d2958ad5aa74eb855e4de6fe58228f03006c02fd8a">OKAY</a>
<trclass="memdesc:a4d057e41b489bf20744dfa8d2958ad5a"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Enumeration of possible engine statuses. <ahref="#a4d057e41b489bf20744dfa8d2958ad5a">More...</a><br/></td></tr>
<trclass="memdesc:a775506bb881280f73264db27cb8388f9"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Flags to specify which types of nuclear reactions to include when constructing a reaction network. <ahref="#a775506bb881280f73264db27cb8388f9">More...</a><br/></td></tr>
<trclass="memitem:a782fbc9eca00df10e4a204ae6da733e7"id="r_a782fbc9eca00df10e4a204ae6da733e7"><tdclass="memItemLeft"align="right"valign="top">enum class  </td><tdclass="memItemRight"valign="bottom"><aclass="el"href="#a782fbc9eca00df10e4a204ae6da733e7">NetworkBuildDepth</a> { <br/>
<trclass="memdesc:a782fbc9eca00df10e4a204ae6da733e7"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Specifies supported depths for building the reaction network. <ahref="#a782fbc9eca00df10e4a204ae6da733e7">More...</a><br/></td></tr>
<trclass="memitem:a5387db1ec0b039955487fbc4c0034854"id="r_a5387db1ec0b039955487fbc4c0034854"><tdclass="memItemLeft"align="right"valign="top">enum class  </td><tdclass="memItemRight"valign="bottom"><aclass="el"href="#a5387db1ec0b039955487fbc4c0034854">EngineTypes</a> { <br/>
<trclass="memdesc:a5387db1ec0b039955487fbc4c0034854"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Enumeration of different engine types available in GridFire. <ahref="#a5387db1ec0b039955487fbc4c0034854">More...</a><br/></td></tr>
<trclass="memitem:ada706e6a92b733f6be85aa4425b135c1"id="r_ada706e6a92b733f6be85aa4425b135c1"><tdclass="memItemLeft"align="right"valign="top">enum class  </td><tdclass="memItemRight"valign="bottom"><aclass="el"href="#ada706e6a92b733f6be85aa4425b135c1">PrimingReportStatus</a> { <aclass="el"href="#ada706e6a92b733f6be85aa4425b135c1ad0749aaba8b833466dfcbb0428e4f89c">SUCCESS</a>
<trclass="memdesc:ada706e6a92b733f6be85aa4425b135c1"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Enumerates outcome codes for a network priming operation. <ahref="#ada706e6a92b733f6be85aa4425b135c1">More...</a><br/></td></tr>
<trclass="memitem:a83c9d755597668bba3cf00cd0ea10ee3"id="r_a83c9d755597668bba3cf00cd0ea10ee3"><tdclass="memItemLeft"align="right"valign="top">enum class  </td><tdclass="memItemRight"valign="bottom"><aclass="el"href="#a83c9d755597668bba3cf00cd0ea10ee3">SpeciesStatus</a> { <aclass="el"href="#a83c9d755597668bba3cf00cd0ea10ee3a18ff74f43da410c5529f7d6fca84f115">ACTIVE</a>
<trclass="memdesc:a83c9d755597668bba3cf00cd0ea10ee3"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Enumerates the status of a species in the simulation. <ahref="#a83c9d755597668bba3cf00cd0ea10ee3">More...</a><br/></td></tr>
<trclass="memdesc:a006018e8e5f80ddb857009dbad962753"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Convert <aclass="el"href="#a4d057e41b489bf20744dfa8d2958ad5a"title="Enumeration of possible engine statuses.">EngineStatus</a> enum to string representation. <br/></td></tr>
<trclass="memdesc:a956ff12cef0dda2b9209ceab68199090"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Helper function to convert <aclass="el"href="#a775506bb881280f73264db27cb8388f9"title="Flags to specify which types of nuclear reactions to include when constructing a reaction network.">NetworkConstructionFlags</a> to their underlying integer type. <br/></td></tr>
<trclass="memdesc:a69216b717d99f53cf2d1419e23b69119"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Bitwise OR operator for <aclass="el"href="#a775506bb881280f73264db27cb8388f9"title="Flags to specify which types of nuclear reactions to include when constructing a reaction network.">NetworkConstructionFlags</a>. <br/></td></tr>
<trclass="memdesc:ace3a790fb57920fd12328fa9c5a3a1de"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Bitwise AND operator for <aclass="el"href="#a775506bb881280f73264db27cb8388f9"title="Flags to specify which types of nuclear reactions to include when constructing a reaction network.">NetworkConstructionFlags</a>. <br/></td></tr>
<trclass="memdesc:a7377e1152d165cfb9eadc16c5dc2f492"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Checks if a specific flag is set within a <aclass="el"href="#a775506bb881280f73264db27cb8388f9"title="Flags to specify which types of nuclear reactions to include when constructing a reaction network.">NetworkConstructionFlags</a> value. <br/></td></tr>
<trclass="memdesc:aea27cb9ed6d613ae9e4b7fa89767861a"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Converts <aclass="el"href="#a775506bb881280f73264db27cb8388f9"title="Flags to specify which types of nuclear reactions to include when constructing a reaction network.">NetworkConstructionFlags</a> to a human-readable string. <br/></td></tr>
<trclass="memdesc:a7b64607db49cfc042cbee63be5351549"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Builds a nuclear reaction network from the Reaclib library based on an initial composition. <br/></td></tr>
<trclass="memdesc:aa6552165b4b36ea227479567880d8402"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Primes absent species in the network to their equilibrium abundances. <br/></td></tr>
<trclass="memdesc:a589015f6509c051c16b3e4ebc7550dd2"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Converts an <aclass="el"href="#a5387db1ec0b039955487fbc4c0034854"title="Enumeration of different engine types available in GridFire.">EngineTypes</a> enum value to its corresponding string representation. <br/></td></tr>
<trclass="memdesc:afacda3b01618f041a81fa516547564fa"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Regularizes the given Jacobian matrix based on the provided composition. <br/></td></tr>
<trclass="memdesc:a6d1bd8b2b8161b50a260bf012c3f058f"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Convert a <aclass="el"href="#a83c9d755597668bba3cf00cd0ea10ee3"title="Enumerates the status of a species in the simulation.">SpeciesStatus</a> enum value to its string representation. <br/></td></tr>
<trclass="memdesc:acbe76badc77637ba89e4017130d110b1"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Minimum density threshold below which reactions are ignored. <br/></td></tr>
<trclass="memdesc:a35ed65ea4d304098e4de3e0f0191304f"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Minimum abundance threshold below which species are ignored. <br/></td></tr>
<trclass="memdesc:ad84c68dc3c04ab08a9dc8cee5fde28dd"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Minimum value for Jacobian matrix entries. <br/></td></tr>
<trclass="memdesc:ae769a7e049c0b79e58675103b21f918f"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Minimum abundance for a species to contribute to the Jacobian. <br/></td></tr>
<trclass="memdesc:a1ec7640033e9b4418220e91f17bde16b"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Mapping from <aclass="el"href="#ada706e6a92b733f6be85aa4425b135c1"title="Enumerates outcome codes for a network priming operation.">PrimingReportStatus</a> codes to human-readable strings. <br/></td></tr>
<p>Variant specifying either a predefined <aclass="el"href="#a782fbc9eca00df10e4a204ae6da733e7"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>
<p>This enum defines the various states an engine can be in after performing calculations, such as being up-to-date (OKAY), needing an update (STALE), or encountering an error (ERROR). </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="#a55cd7c313bbfafd5b6a1bcd6329ed99b"title="Variant specifying either a predefined NetworkBuildDepth or a custom integer depth.">BuildDepthType</a>. </dd></dl>
<p>Flags to specify which types of nuclear reactions to include when constructing a reaction network. </p>
<p>These flags allow fine-grained control over the inclusion of strong and weak nuclear reactions (beta decay, electron/positron capture) from various sources (Reaclib, WRL) during network construction. They can be combined using bitwise operations to create custom reaction sets. </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_1engine_1_1_priming_report.html"title="Captures the result of a network priming operation.">PrimingReport</a> for data associated with each status. </dd></dl>
<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">weakInterpolator</td><td>Interpolator to build weak rates from. Must be constructed and owned by the caller. </td></tr>
<tr><tdclass="paramname">maxLayers</td><td>Variant specifying either a predefined <aclass="el"href="#a782fbc9eca00df10e4a204ae6da733e7"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>
<p>Converts an <aclass="el"href="#a5387db1ec0b039955487fbc4c0034854"title="Enumeration of different engine types available in GridFire.">EngineTypes</a> enum value to its corresponding string representation. </p>
<dlclass="params"><dt>Parameters</dt><dd>
<tableclass="params">
<tr><tdclass="paramname">type</td><td>The <aclass="el"href="#a5387db1ec0b039955487fbc4c0034854"title="Enumeration of different engine types available in GridFire.">EngineTypes</a> enum value to convert. </td></tr>
</table>
</dd>
</dl>
<dlclass="section return"><dt>Returns</dt><dd>A string_view representing the name of the engine type. </dd></dl>
<p>Convert <aclass="el"href="#a4d057e41b489bf20744dfa8d2958ad5a"title="Enumeration of possible engine statuses.">EngineStatus</a> enum to string representation. </p>
<dlclass="params"><dt>Parameters</dt><dd>
<tableclass="params">
<tr><tdclass="paramname">status</td><td>The <aclass="el"href="#a4d057e41b489bf20744dfa8d2958ad5a"title="Enumeration of possible engine statuses.">EngineStatus</a> value to convert. </td></tr>
</table>
</dd>
</dl>
<dlclass="section return"><dt>Returns</dt><dd>A string_view representing the name of the <aclass="el"href="#a4d057e41b489bf20744dfa8d2958ad5a"title="Enumeration of possible engine statuses.">EngineStatus</a>. </dd></dl>
<p>Checks if a specific flag is set within a <aclass="el"href="#a775506bb881280f73264db27cb8388f9"title="Flags to specify which types of nuclear reactions to include when constructing a reaction network.">NetworkConstructionFlags</a> value. </p>
<p>This function determines whether a particular flag is present in a given <aclass="el"href="#a775506bb881280f73264db27cb8388f9"title="Flags to specify which types of nuclear reactions to include when constructing a reaction network.">NetworkConstructionFlags</a> value.</p>
<dlclass="params"><dt>Parameters</dt><dd>
<tableclass="params">
<tr><tdclass="paramname">flags</td><td>The <aclass="el"href="#a775506bb881280f73264db27cb8388f9"title="Flags to specify which types of nuclear reactions to include when constructing a reaction network.">NetworkConstructionFlags</a> value to check. </td></tr>
<tr><tdclass="paramname">flag_to_check</td><td>The specific flag to look for. </td></tr>
</table>
</dd>
</dl>
<dlclass="section return"><dt>Returns</dt><dd>True if the flag is set; otherwise, false. </dd></dl>
<p>Converts <aclass="el"href="#a775506bb881280f73264db27cb8388f9"title="Flags to specify which types of nuclear reactions to include when constructing a reaction network.">NetworkConstructionFlags</a> to a human-readable string. </p>
<p>This function generates a comma-separated string representation of the set flags within a <aclass="el"href="#a775506bb881280f73264db27cb8388f9"title="Flags to specify which types of nuclear reactions to include when constructing a reaction network.">NetworkConstructionFlags</a> value. If no flags are set, it returns "No reactions".</p>
<dlclass="params"><dt>Parameters</dt><dd>
<tableclass="params">
<tr><tdclass="paramname">flags</td><td>The <aclass="el"href="#a775506bb881280f73264db27cb8388f9"title="Flags to specify which types of nuclear reactions to include when constructing a reaction network.">NetworkConstructionFlags</a> value to convert. </td></tr>
</table>
</dd>
</dl>
<dlclass="section return"><dt>Returns</dt><dd>A string listing the set flags or "No reactions" if none are set. </dd></dl>
<p>Bitwise AND operator for <aclass="el"href="#a775506bb881280f73264db27cb8388f9"title="Flags to specify which types of nuclear reactions to include when constructing a reaction network.">NetworkConstructionFlags</a>. </p>
<p>This operator allows checking for common flags between two <aclass="el"href="#a775506bb881280f73264db27cb8388f9"title="Flags to specify which types of nuclear reactions to include when constructing a reaction network.">NetworkConstructionFlags</a> values using the bitwise AND operation.</p>
<dlclass="params"><dt>Parameters</dt><dd>
<tableclass="params">
<tr><tdclass="paramname">lhs</td><td>The left-hand side <aclass="el"href="#a775506bb881280f73264db27cb8388f9"title="Flags to specify which types of nuclear reactions to include when constructing a reaction network.">NetworkConstructionFlags</a> value. </td></tr>
<tr><tdclass="paramname">rhs</td><td>The right-hand side <aclass="el"href="#a775506bb881280f73264db27cb8388f9"title="Flags to specify which types of nuclear reactions to include when constructing a reaction network.">NetworkConstructionFlags</a> value. </td></tr>
</table>
</dd>
</dl>
<dlclass="section return"><dt>Returns</dt><dd>A new <aclass="el"href="#a775506bb881280f73264db27cb8388f9"title="Flags to specify which types of nuclear reactions to include when constructing a reaction network.">NetworkConstructionFlags</a> value representing the intersection of the two inputs. </dd></dl>
<p>Bitwise OR operator for <aclass="el"href="#a775506bb881280f73264db27cb8388f9"title="Flags to specify which types of nuclear reactions to include when constructing a reaction network.">NetworkConstructionFlags</a>. </p>
<p>This operator allows combining two <aclass="el"href="#a775506bb881280f73264db27cb8388f9"title="Flags to specify which types of nuclear reactions to include when constructing a reaction network.">NetworkConstructionFlags</a> values using the bitwise OR operation.</p>
<dlclass="params"><dt>Parameters</dt><dd>
<tableclass="params">
<tr><tdclass="paramname">lhs</td><td>The left-hand side <aclass="el"href="#a775506bb881280f73264db27cb8388f9"title="Flags to specify which types of nuclear reactions to include when constructing a reaction network.">NetworkConstructionFlags</a> value. </td></tr>
<tr><tdclass="paramname">rhs</td><td>The right-hand side <aclass="el"href="#a775506bb881280f73264db27cb8388f9"title="Flags to specify which types of nuclear reactions to include when constructing a reaction network.">NetworkConstructionFlags</a> value. </td></tr>
</table>
</dd>
</dl>
<dlclass="section return"><dt>Returns</dt><dd>A new <aclass="el"href="#a775506bb881280f73264db27cb8388f9"title="Flags to specify which types of nuclear reactions to include when constructing a reaction network.">NetworkConstructionFlags</a> value representing the combination of the two inputs. </dd></dl>
<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_1engine_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>
<tr><tdclass="paramname">ignoredReactionTypes</td><td>Types of reactions to ignore during priming (e.g., weak reactions). </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_1engine_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>
<p>Regularizes the given Jacobian matrix based on the provided composition. </p>
<p>This function applies regularization techniques to the Jacobian matrix to improve its numerical stability. Specifically any (row, column) entries corresponding to species who's abundance is below a threshold of MIN_ABUNDANCE_TO_CONTRIBUTE_TO_JACOBIAN in the provided composition will be set to zero if those entries were either infinite or NaN.</p>
<dlclass="params"><dt>Parameters</dt><dd>
<tableclass="params">
<tr><tdclass="paramname">jacobian</td><td>The <aclass="el"href="classgridfire_1_1engine_1_1_network_jacobian.html"title="A wrapper class for handling the network Jacobian matrix.">NetworkJacobian</a> to be regularized. </td></tr>
<tr><tdclass="paramname">comp</td><td>The composition used for regularization. </td></tr>
<tr><tdclass="paramname">logger</td><td>Optional logger for logging regularization steps and information. </td></tr>
</table>
</dd>
</dl>
<dlclass="section return"><dt>Returns</dt><dd>A new <aclass="el"href="classgridfire_1_1engine_1_1_network_jacobian.html"title="A wrapper class for handling the network Jacobian matrix.">NetworkJacobian</a> instance representing the regularized Jacobian matrix. </dd></dl>
<p>Convert a <aclass="el"href="#a83c9d755597668bba3cf00cd0ea10ee3"title="Enumerates the status of a species in the simulation.">SpeciesStatus</a> enum value to its string representation. </p>
<dlclass="params"><dt>Parameters</dt><dd>
<tableclass="params">
<tr><tdclass="paramname">status</td><td>The <aclass="el"href="#a83c9d755597668bba3cf00cd0ea10ee3"title="Enumerates the status of a species in the simulation.">SpeciesStatus</a> value to convert. </td></tr>
</table>
</dd>
</dl>
<dlclass="section return"><dt>Returns</dt><dd>A string representing the <aclass="el"href="#a83c9d755597668bba3cf00cd0ea10ee3"title="Enumerates the status of a species in the simulation.">SpeciesStatus</a>. </dd></dl>
<p>Helper function to convert <aclass="el"href="#a775506bb881280f73264db27cb8388f9"title="Flags to specify which types of nuclear reactions to include when constructing a reaction network.">NetworkConstructionFlags</a> to their underlying integer type. </p>
<p>This function facilitates bitwise operations on <aclass="el"href="#a775506bb881280f73264db27cb8388f9"title="Flags to specify which types of nuclear reactions to include when constructing a reaction network.">NetworkConstructionFlags</a> by converting them to their underlying integer representation.</p>
<dlclass="params"><dt>Parameters</dt><dd>
<tableclass="params">
<tr><tdclass="paramname">f</td><td>The <aclass="el"href="#a775506bb881280f73264db27cb8388f9"title="Flags to specify which types of nuclear reactions to include when constructing a reaction network.">NetworkConstructionFlags</a> value to convert. </td></tr>
</table>
</dd>
</dl>
<dlclass="section return"><dt>Returns</dt><dd>The underlying integer representation of the flag. </dd></dl>
<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>
<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>
<p>Mapping from <aclass="el"href="#ada706e6a92b733f6be85aa4425b135c1"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="#ada706e6a92b733f6be85aa4425b135c1"title="Enumerates outcome codes for a network priming operation.">PrimingReportStatus</a> values. </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<divid="nav-path"class="navpath"><!-- id is needed for treeview function! -->
<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>
