2025-07-01 07:24:18 -04:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
< html xmlns = "http://www.w3.org/1999/xhtml" lang = "en-US" >
< head >
< meta http-equiv = "Content-Type" content = "text/xhtml;charset=UTF-8" / >
< meta http-equiv = "X-UA-Compatible" content = "IE=11" / >
< meta name = "generator" content = "Doxygen 1.13.2" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1" / >
< title > GridFire: gridfire Namespace Reference< / title >
< link href = "tabs.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "jquery.js" > < / script >
< script type = "text/javascript" src = "dynsections.js" > < / script >
< script type = "text/javascript" src = "clipboard.js" > < / script >
< link href = "navtree.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "navtreedata.js" > < / script >
< script type = "text/javascript" src = "navtree.js" > < / script >
< script type = "text/javascript" src = "resize.js" > < / script >
< script type = "text/javascript" src = "cookie.js" > < / script >
< link href = "search/search.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "search/searchdata.js" > < / script >
< script type = "text/javascript" src = "search/search.js" > < / script >
< link href = "doxygen.css" rel = "stylesheet" type = "text/css" / >
< link href = "doxygen-awesome.css" rel = "stylesheet" type = "text/css" / >
< link href = "doxygen-awesome-sidebar-only.css" rel = "stylesheet" type = "text/css" / >
< / head >
< body >
< div id = "top" > <!-- do not remove this div, it is closed by doxygen! -->
< div id = "titlearea" >
< table cellspacing = "0" cellpadding = "0" >
< tbody >
< tr id = "projectrow" >
< td id = "projectalign" >
2025-07-31 15:04:57 -04:00
< div id = "projectname" > GridFire< span id = "projectnumber" >   0.6.0< / span >
2025-07-01 07:24:18 -04:00
< / div >
< div id = "projectbrief" > General Purpose Nuclear Network< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
< / script >
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
< / script >
< script type = "text/javascript" src = "menudata.js" > < / script >
< script type = "text/javascript" src = "menu.js" > < / script >
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
/* @license-end */
< / script >
< div id = "main-nav" > < / div >
< / div > <!-- top -->
< div id = "side-nav" class = "ui-resizable side-nav-resizable" >
< div id = "nav-tree" >
< div id = "nav-tree-contents" >
< div id = "nav-sync" class = "sync" > < / div >
< / div >
< / div >
< div id = "splitbar" style = "-moz-user-select:none;"
class="ui-resizable-handle">
< / div >
< / div >
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& dn=expat.txt MIT */
$(function(){initNavTree('namespacegridfire.html',''); initResizable(true); });
/* @license-end */
< / script >
< div id = "doc-content" >
<!-- window showing the filter options -->
< div id = "MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
< / div >
<!-- iframe showing the search results (closed by default) -->
< div id = "MSearchResultsWindow" >
< div id = "MSearchResults" >
< div class = "SRPage" >
< div id = "SRIndex" >
< div id = "SRResults" > < / div >
< div class = "SRStatus" id = "Loading" > Loading...< / div >
< div class = "SRStatus" id = "Searching" > Searching...< / div >
< div class = "SRStatus" id = "NoMatches" > No Matches< / div >
< / div >
< / div >
< / div >
< / div >
< div class = "header" >
< div class = "summary" >
< a href = "#namespaces" > Namespaces< / a > |
< a href = "#nested-classes" > Classes< / a > |
< a href = "#concepts" > Concepts< / a > |
< a href = "#typedef-members" > Typedefs< / a > |
< a href = "#enum-members" > Enumerations< / a > |
< a href = "#func-members" > Functions< / a > |
< a href = "#var-members" > Variables< / a > < / div >
< div class = "headertitle" > < div class = "title" > gridfire Namespace Reference< / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a id = "namespaces" name = "namespaces" > < / a >
Namespaces< / h2 > < / td > < / tr >
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > namespace   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "namespacegridfire_1_1approx8.html" > approx8< / a > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2025-07-24 11:10:45 -04:00
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > namespace   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "namespacegridfire_1_1exceptions.html" > exceptions< / a > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > namespace   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "namespacegridfire_1_1expectations.html" > expectations< / a > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2025-07-01 11:40:51 -04:00
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > namespace   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "namespacegridfire_1_1io.html" > io< / a > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2025-07-24 11:10:45 -04:00
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > namespace   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "namespacegridfire_1_1partition.html" > partition< / a > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2025-07-01 07:24:18 -04:00
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > namespace   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "namespacegridfire_1_1reaclib.html" > reaclib< / a > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > namespace   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "namespacegridfire_1_1reaction.html" > reaction< / a > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2025-07-01 11:40:51 -04:00
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > namespace   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "namespacegridfire_1_1screening.html" > screening< / a > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2025-07-01 07:24:18 -04:00
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > namespace   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "namespacegridfire_1_1solver.html" > solver< / a > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2025-07-01 11:40:51 -04:00
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > namespace   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "namespacegridfire_1_1utils.html" > utils< / a > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2025-07-01 07:24:18 -04:00
< / table > < table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a id = "nested-classes" name = "nested-classes" > < / a >
Classes< / h2 > < / td > < / tr >
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > class   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classgridfire_1_1_adaptive_engine_view.html" > AdaptiveEngineView< / a > < / td > < / tr >
< tr class = "memdesc:" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > An engine view that dynamically adapts the reaction network based on runtime conditions. < a href = "classgridfire_1_1_adaptive_engine_view.html#details" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2025-07-24 11:10:45 -04:00
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > class   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classgridfire_1_1_defined_engine_view.html" > DefinedEngineView< / a > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2025-07-01 07:24:18 -04:00
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > class   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classgridfire_1_1_dynamic_engine.html" > DynamicEngine< / a > < / td > < / tr >
< tr class = "memdesc:" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Abstract class for engines supporting Jacobian and stoichiometry operations. < a href = "classgridfire_1_1_dynamic_engine.html#details" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > class   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classgridfire_1_1_engine.html" > Engine< / a > < / td > < / tr >
< tr class = "memdesc:" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Abstract base class for a reaction network engine. < a href = "classgridfire_1_1_engine.html#details" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > class   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classgridfire_1_1_engine_view.html" > EngineView< / a > < / td > < / tr >
< tr class = "memdesc:" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Abstract base class for a "view" of a reaction network engine. < a href = "classgridfire_1_1_engine_view.html#details" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2025-07-01 11:40:51 -04:00
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > class   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classgridfire_1_1_file_defined_engine_view.html" > FileDefinedEngineView< / a > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2025-07-01 07:24:18 -04:00
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > class   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classgridfire_1_1_graph_engine.html" > GraphEngine< / a > < / td > < / tr >
< tr class = "memdesc:" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > A reaction network engine that uses a graph-based representation. < a href = "classgridfire_1_1_graph_engine.html#details" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2025-07-24 11:10:45 -04:00
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > class   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classgridfire_1_1_multiscale_partitioning_engine_view.html" > MultiscalePartitioningEngineView< / a > < / td > < / tr >
< tr class = "memdesc:" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > An engine view that partitions the reaction network into multiple groups based on timescales. < a href = "classgridfire_1_1_multiscale_partitioning_engine_view.html#details" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2025-07-01 07:24:18 -04:00
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > struct   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structgridfire_1_1_net_in.html" > NetIn< / a > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > struct   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structgridfire_1_1_net_out.html" > NetOut< / a > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > class   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classgridfire_1_1_network.html" > Network< / a > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2025-07-24 11:10:45 -04:00
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > class   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classgridfire_1_1_network_priming_engine_view.html" > NetworkPrimingEngineView< / a > < / td > < / tr >
< tr class = "memdesc:" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Provides a view of a < a class = "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. < a href = "classgridfire_1_1_network_priming_engine_view.html#details" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > struct   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structgridfire_1_1_priming_report.html" > PrimingReport< / a > < / td > < / tr >
< tr class = "memdesc:" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Captures the result of a network priming operation. < a href = "structgridfire_1_1_priming_report.html#details" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > struct   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structgridfire_1_1_q_s_e_cache_config.html" > QSECacheConfig< / a > < / td > < / tr >
< tr class = "memdesc:" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Configuration struct for the QSE cache. < a href = "structgridfire_1_1_q_s_e_cache_config.html#details" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > struct   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structgridfire_1_1_q_s_e_cache_key.html" > QSECacheKey< / a > < / td > < / tr >
< tr class = "memdesc:" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Key struct for the QSE abundance cache. < a href = "structgridfire_1_1_q_s_e_cache_key.html#details" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > class   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classgridfire_1_1_reaction.html" > Reaction< / a > < / td > < / tr >
< tr class = "memdesc:" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Represents a single nuclear reaction from a specific data source. < a href = "classgridfire_1_1_reaction.html#details" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2025-07-01 07:24:18 -04:00
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > struct   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structgridfire_1_1_step_derivatives.html" > StepDerivatives< / a > < / td > < / tr >
< tr class = "memdesc:" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Structure holding derivatives and energy generation for a network step. < a href = "structgridfire_1_1_step_derivatives.html#details" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table > < table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a id = "concepts" name = "concepts" > < / a >
Concepts< / h2 > < / td > < / tr >
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > concept   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "conceptgridfire_1_1_is_arithmetic_or_a_d.html" > IsArithmeticOrAD< / a > < / td > < / tr >
< tr class = "memdesc:" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Concept for types allowed in engine calculations. < br / > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > concept   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "conceptgridfire_1_1_engine_type.html" > EngineType< / a > < / td > < / tr >
< tr class = "memdesc:" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Concept for types allowed as engine bases in EngineView. < br / > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table > < table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a id = "typedef-members" name = "typedef-members" > < / a >
Typedefs< / h2 > < / td > < / tr >
2025-07-24 11:10:45 -04:00
< tr class = "memitem:a898dfe22579e649935645cbd6f073178" id = "r_a898dfe22579e649935645cbd6f073178" > < td class = "memItemLeft" align = "right" valign = "top" > using  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#a898dfe22579e649935645cbd6f073178" > SparsityPattern< / a > = std::vector< std::pair< size_t, size_t> > < / td > < / tr >
< tr class = "separator:a898dfe22579e649935645cbd6f073178" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2025-07-01 07:24:18 -04:00
< tr class = "memitem:a1121d0b2d005195333412559fa29d3cc" id = "r_a1121d0b2d005195333412559fa29d3cc" > < td class = "memItemLeft" align = "right" valign = "top" > typedef CppAD::AD< double >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#a1121d0b2d005195333412559fa29d3cc" > ADDouble< / a > < / td > < / tr >
< tr class = "memdesc:a1121d0b2d005195333412559fa29d3cc" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Alias for CppAD AD type for double precision. < br / > < / td > < / tr >
< tr class = "separator:a1121d0b2d005195333412559fa29d3cc" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2025-07-24 11:10:45 -04:00
< tr class = "memitem:a3b1f70dc7ff5b501809330a97079e4f6" id = "r_a3b1f70dc7ff5b501809330a97079e4f6" > < td class = "memItemLeft" align = "right" valign = "top" > using  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#a3b1f70dc7ff5b501809330a97079e4f6" > BuildDepthType< / a > = std::variant< < a class = "el" href = "#a0210bd2e07538932135a56b62b8ddb57" > NetworkBuildDepth< / a > , int> < / td > < / tr >
< tr class = "memdesc:a3b1f70dc7ff5b501809330a97079e4f6" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Variant specifying either a predefined < a class = "el" href = "#a0210bd2e07538932135a56b62b8ddb57" title = "Specifies supported depths for building the reaction network." > NetworkBuildDepth< / a > or a custom integer depth. < br / > < / td > < / tr >
< tr class = "separator:a3b1f70dc7ff5b501809330a97079e4f6" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:aa86f08712565f278adacc7cd2361eb31" id = "r_aa86f08712565f278adacc7cd2361eb31" > < td class = "memItemLeft" align = "right" valign = "top" > using  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#aa86f08712565f278adacc7cd2361eb31" > LogicalReactionSet< / a > < / td > < / tr >
< tr class = "memdesc:aa86f08712565f278adacc7cd2361eb31" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > A set of logical reactions. < br / > < / td > < / tr >
< tr class = "separator:aa86f08712565f278adacc7cd2361eb31" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ad838ce3fb6cc02c3fd90b924a0dd91b1" id = "r_ad838ce3fb6cc02c3fd90b924a0dd91b1" > < td class = "memItemLeft" align = "right" valign = "top" > using  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#ad838ce3fb6cc02c3fd90b924a0dd91b1" > ReactionSet< / a > < / td > < / tr >
< tr class = "memdesc:ad838ce3fb6cc02c3fd90b924a0dd91b1" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > A set of reactions, typically from a single source like REACLIB. < br / > < / td > < / tr >
< tr class = "separator:ad838ce3fb6cc02c3fd90b924a0dd91b1" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2025-07-01 07:24:18 -04:00
< / table > < table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a id = "enum-members" name = "enum-members" > < / a >
Enumerations< / h2 > < / td > < / tr >
2025-07-24 11:10:45 -04:00
< tr class = "memitem:a0210bd2e07538932135a56b62b8ddb57" id = "r_a0210bd2e07538932135a56b62b8ddb57" > < td class = "memItemLeft" align = "right" valign = "top" > enum class   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#a0210bd2e07538932135a56b62b8ddb57" > NetworkBuildDepth< / a > { < br / >
    < a class = "el" href = "#a0210bd2e07538932135a56b62b8ddb57abbd47109890259c0127154db1af26c75" > Full< / a > = -1
, < a class = "el" href = "#a0210bd2e07538932135a56b62b8ddb57a928d0f1285ee7d36c1c2fa1b1b7a164c" > Shallow< / a > = 1
, < a class = "el" href = "#a0210bd2e07538932135a56b62b8ddb57a264572d66aed5373d19dc80c7cde1f46" > SecondOrder< / a > = 2
, < a class = "el" href = "#a0210bd2e07538932135a56b62b8ddb57a3fc719e07f9f63e7f11a3d4fb74b476f" > ThirdOrder< / a > = 3
, < br / >
    < a class = "el" href = "#a0210bd2e07538932135a56b62b8ddb57a100e3bf0197221c19b222badf42aa964" > FourthOrder< / a > = 4
, < a class = "el" href = "#a0210bd2e07538932135a56b62b8ddb57a5105376c2b90747e00bed5bf2953dd56" > FifthOrder< / a > = 5
< br / >
}< / td > < / tr >
< tr class = "memdesc:a0210bd2e07538932135a56b62b8ddb57" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Specifies supported depths for building the reaction network. < a href = "#a0210bd2e07538932135a56b62b8ddb57" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:a0210bd2e07538932135a56b62b8ddb57" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a8bea3d74f35d640e693fa398e9b3e154" id = "r_a8bea3d74f35d640e693fa398e9b3e154" > < td class = "memItemLeft" align = "right" valign = "top" > enum class   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#a8bea3d74f35d640e693fa398e9b3e154" > PrimingReportStatus< / a > { < br / >
    < a class = "el" href = "#a8bea3d74f35d640e693fa398e9b3e154a64d98633bac1de0eb2a539cbfd2a5c2a" > FULL_SUCCESS< / a > = 0
, < a class = "el" href = "#a8bea3d74f35d640e693fa398e9b3e154a708c14ec56942aa5f32e7bef1e29db45" > NO_SPECIES_TO_PRIME< / a > = 1
, < a class = "el" href = "#a8bea3d74f35d640e693fa398e9b3e154a5afaf45bc4c02208d502d9c0c26d8287" > MAX_ITERATIONS_REACHED< / a > = 2
, < a class = "el" href = "#a8bea3d74f35d640e693fa398e9b3e154ae8870a753743b62c511c939eef95c93f" > FAILED_TO_FINALIZE_COMPOSITION< / a > = 3
, < br / >
    < a class = "el" href = "#a8bea3d74f35d640e693fa398e9b3e154a9870268bdece09274aea75557a19158a" > FAILED_TO_FIND_CREATION_CHANNEL< / a > = 4
, < a class = "el" href = "#a8bea3d74f35d640e693fa398e9b3e154a186367e42446c004076290ca7913d931" > FAILED_TO_FIND_PRIMING_REACTIONS< / a > = 5
, < a class = "el" href = "#a8bea3d74f35d640e693fa398e9b3e154ab837953f2841baabbae6bb5f2e43e71e" > BASE_NETWORK_TOO_SHALLOW< / a > = 6
< br / >
}< / td > < / tr >
< tr class = "memdesc:a8bea3d74f35d640e693fa398e9b3e154" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Enumerates outcome codes for a network priming operation. < a href = "#a8bea3d74f35d640e693fa398e9b3e154" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:a8bea3d74f35d640e693fa398e9b3e154" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2025-07-01 07:24:18 -04:00
< tr class = "memitem:a3f3d6b3f9742b70e62049ccefbb60f37" id = "r_a3f3d6b3f9742b70e62049ccefbb60f37" > < td class = "memItemLeft" align = "right" valign = "top" > enum   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#a3f3d6b3f9742b70e62049ccefbb60f37" > NetworkFormat< / a > { < a class = "el" href = "#a3f3d6b3f9742b70e62049ccefbb60f37a1fc7adf719c40457abfdb8334675faea" > APPROX8< / a >
, < a class = "el" href = "#a3f3d6b3f9742b70e62049ccefbb60f37a9b8db7b445ae4f1bd114caa42a583182" > REACLIB< / a >
, < a class = "el" href = "#a3f3d6b3f9742b70e62049ccefbb60f37aac700abde5f6ff8b7328193eb19697b2" > UNKNOWN< / a >
}< / td > < / tr >
< tr class = "separator:a3f3d6b3f9742b70e62049ccefbb60f37" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table > < table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a id = "func-members" name = "func-members" > < / a >
Functions< / h2 > < / td > < / tr >
2025-07-24 11:10:45 -04:00
< tr class = "memitem:aedddb89e400a6111f69bfe0c3fd4214e" id = "r_aedddb89e400a6111f69bfe0c3fd4214e" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "namespacegridfire_1_1reaction.html#aa86f08712565f278adacc7cd2361eb31" > reaction::LogicalReactionSet< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#aedddb89e400a6111f69bfe0c3fd4214e" > build_reaclib_nuclear_network< / a > (const fourdst::composition::Composition & composition, < a class = "el" href = "#a3b1f70dc7ff5b501809330a97079e4f6" > BuildDepthType< / a > maxLayers=< a class = "el" href = "#a0210bd2e07538932135a56b62b8ddb57abbd47109890259c0127154db1af26c75" > NetworkBuildDepth::Full< / a > , bool reverse=false)< / td > < / tr >
< tr class = "memdesc:aedddb89e400a6111f69bfe0c3fd4214e" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Builds a nuclear reaction network from the Reaclib library based on an initial composition. < br / > < / td > < / tr >
< tr class = "separator:aedddb89e400a6111f69bfe0c3fd4214e" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:acd0bfdfbce4e84af102d62ff8a797c9f" id = "r_acd0bfdfbce4e84af102d62ff8a797c9f" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "structgridfire_1_1_priming_report.html" > PrimingReport< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#acd0bfdfbce4e84af102d62ff8a797c9f" > primeNetwork< / a > (const < a class = "el" href = "structgridfire_1_1_net_in.html" > NetIn< / a > & , < a class = "el" href = "classgridfire_1_1_dynamic_engine.html" > DynamicEngine< / a > & engine)< / td > < / tr >
< tr class = "memdesc:acd0bfdfbce4e84af102d62ff8a797c9f" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Primes absent species in the network to their equilibrium abundances. < br / > < / td > < / tr >
< tr class = "separator:acd0bfdfbce4e84af102d62ff8a797c9f" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a8f26d5f5fabb42e88261e42bc060cea2" id = "r_a8f26d5f5fabb42e88261e42bc060cea2" > < td class = "memItemLeft" align = "right" valign = "top" > double  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#a8f26d5f5fabb42e88261e42bc060cea2" > calculateDestructionRateConstant< / a > (const < a class = "el" href = "classgridfire_1_1_dynamic_engine.html" > DynamicEngine< / a > & engine, const fourdst::atomic::Species & species, const std::vector< double > & Y, double T9, double rho)< / td > < / tr >
< tr class = "memdesc:a8f26d5f5fabb42e88261e42bc060cea2" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Computes the destruction rate constant for a specific species. < br / > < / td > < / tr >
< tr class = "separator:a8f26d5f5fabb42e88261e42bc060cea2" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a7c4b6104d5dfc5afddda36f726c5d07d" id = "r_a7c4b6104d5dfc5afddda36f726c5d07d" > < td class = "memItemLeft" align = "right" valign = "top" > double  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#a7c4b6104d5dfc5afddda36f726c5d07d" > calculateCreationRate< / a > (const < a class = "el" href = "classgridfire_1_1_dynamic_engine.html" > DynamicEngine< / a > & engine, const fourdst::atomic::Species & species, const std::vector< double > & Y, double T9, double rho)< / td > < / tr >
< tr class = "memdesc:a7c4b6104d5dfc5afddda36f726c5d07d" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Computes the creation rate for a specific species. < br / > < / td > < / tr >
< tr class = "separator:a7c4b6104d5dfc5afddda36f726c5d07d" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a745c6568723947f8e1ff874c9d3f4733" id = "r_a745c6568723947f8e1ff874c9d3f4733" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "namespacegridfire_1_1reaction.html#aa86f08712565f278adacc7cd2361eb31" > LogicalReactionSet< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#a745c6568723947f8e1ff874c9d3f4733" > build_reaclib_nuclear_network< / a > (const Composition & composition, < a class = "el" href = "#a3b1f70dc7ff5b501809330a97079e4f6" > BuildDepthType< / a > maxLayers, bool reverse)< / td > < / tr >
< tr class = "separator:a745c6568723947f8e1ff874c9d3f4733" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:aefc63ddbfe97dcb4178c94dfd1c4b256" id = "r_aefc63ddbfe97dcb4178c94dfd1c4b256" > < td class = "memItemLeft" align = "right" valign = "top" > const < a class = "el" href = "classgridfire_1_1reaction_1_1_reaction.html" > reaction::Reaction< / a > *  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#aefc63ddbfe97dcb4178c94dfd1c4b256" > findDominantCreationChannel< / a > (const < a class = "el" href = "classgridfire_1_1_dynamic_engine.html" > DynamicEngine< / a > & engine, const Species & species, const std::vector< double > & Y, const double T9, const double rho)< / td > < / tr >
< tr class = "separator:aefc63ddbfe97dcb4178c94dfd1c4b256" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2025-07-01 07:24:18 -04:00
< tr class = "memitem:a8b245f261cd8d1711ae8d593b054cf98" id = "r_a8b245f261cd8d1711ae8d593b054cf98" > < td class = "memItemLeft" align = "right" valign = "top" > std::string  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#a8b245f261cd8d1711ae8d593b054cf98" > trim_whitespace< / a > (const std::string & str)< / td > < / tr >
< tr class = "separator:a8b245f261cd8d1711ae8d593b054cf98" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table > < table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a id = "var-members" name = "var-members" > < / a >
Variables< / h2 > < / td > < / tr >
< tr class = "memitem:ada3c137c014ecd8d06200fea2d1a9f50" id = "r_ada3c137c014ecd8d06200fea2d1a9f50" > < td class = "memItemLeft" align = "right" valign = "top" > static constexpr double  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#ada3c137c014ecd8d06200fea2d1a9f50" > MIN_DENSITY_THRESHOLD< / a > = 1e-18< / td > < / tr >
< tr class = "memdesc:ada3c137c014ecd8d06200fea2d1a9f50" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Minimum density threshold below which reactions are ignored. < br / > < / td > < / tr >
< tr class = "separator:ada3c137c014ecd8d06200fea2d1a9f50" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a96c062f94713921e5d7568ecedcdcb06" id = "r_a96c062f94713921e5d7568ecedcdcb06" > < td class = "memItemLeft" align = "right" valign = "top" > static constexpr double  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#a96c062f94713921e5d7568ecedcdcb06" > MIN_ABUNDANCE_THRESHOLD< / a > = 1e-18< / td > < / tr >
< tr class = "memdesc:a96c062f94713921e5d7568ecedcdcb06" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Minimum abundance threshold below which species are ignored. < br / > < / td > < / tr >
< tr class = "separator:a96c062f94713921e5d7568ecedcdcb06" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ae01b1738df1921db565bcbd68dd6cf64" id = "r_ae01b1738df1921db565bcbd68dd6cf64" > < td class = "memItemLeft" align = "right" valign = "top" > static constexpr double  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#ae01b1738df1921db565bcbd68dd6cf64" > MIN_JACOBIAN_THRESHOLD< / a > = 1e-24< / td > < / tr >
< tr class = "memdesc:ae01b1738df1921db565bcbd68dd6cf64" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Minimum value for Jacobian matrix entries. < br / > < / td > < / tr >
< tr class = "separator:ae01b1738df1921db565bcbd68dd6cf64" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2025-07-24 11:10:45 -04:00
< tr class = "memitem:a02be158966bf82a91b159b7a962c3fa5" id = "r_a02be158966bf82a91b159b7a962c3fa5" > < td class = "memItemLeft" align = "right" valign = "top" > std::map< < a class = "el" href = "#a8bea3d74f35d640e693fa398e9b3e154" > PrimingReportStatus< / a > , std::string >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#a02be158966bf82a91b159b7a962c3fa5" > PrimingReportStatusStrings< / a > < / td > < / tr >
< tr class = "memdesc:a02be158966bf82a91b159b7a962c3fa5" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Mapping from < a class = "el" href = "#a8bea3d74f35d640e693fa398e9b3e154" title = "Enumerates outcome codes for a network priming operation." > PrimingReportStatus< / a > codes to human-readable strings. < br / > < / td > < / tr >
< tr class = "separator:a02be158966bf82a91b159b7a962c3fa5" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2025-07-01 07:24:18 -04:00
< tr class = "memitem:a4e9cabad30b57d636c2f0d73d8cc6bb4" id = "r_a4e9cabad30b57d636c2f0d73d8cc6bb4" > < td class = "memItemLeft" align = "right" valign = "top" > static std::unordered_map< < a class = "el" href = "#a3f3d6b3f9742b70e62049ccefbb60f37" > NetworkFormat< / a > , std::string >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#a4e9cabad30b57d636c2f0d73d8cc6bb4" > FormatStringLookup< / a > < / td > < / tr >
< tr class = "separator:a4e9cabad30b57d636c2f0d73d8cc6bb4" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2025-07-24 11:10:45 -04:00
< tr class = "memitem:a8b632637f62614f509cde0e404a79054" id = "r_a8b632637f62614f509cde0e404a79054" > < td class = "memItemLeft" align = "right" valign = "top" > static int  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#a8b632637f62614f509cde0e404a79054" > s_operator_parens_called< / a > = 0< / td > < / tr >
< tr class = "separator:a8b632637f62614f509cde0e404a79054" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2025-07-01 07:24:18 -04:00
< / table >
< h2 class = "groupheader" > Typedef Documentation< / h2 >
< a id = "a1121d0b2d005195333412559fa29d3cc" name = "a1121d0b2d005195333412559fa29d3cc" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a1121d0b2d005195333412559fa29d3cc" > ◆   < / a > < / span > ADDouble< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > typedef CppAD::AD< double> < a class = "el" href = "#a1121d0b2d005195333412559fa29d3cc" > gridfire::ADDouble< / a > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Alias for CppAD AD type for double precision. < / p >
< p > This alias simplifies the use of the CppAD automatic differentiation type. < / p >
2025-07-24 11:10:45 -04:00
< / div >
< / div >
< a id = "a3b1f70dc7ff5b501809330a97079e4f6" name = "a3b1f70dc7ff5b501809330a97079e4f6" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a3b1f70dc7ff5b501809330a97079e4f6" > ◆   < / a > < / span > BuildDepthType< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > using < a class = "el" href = "#a3b1f70dc7ff5b501809330a97079e4f6" > gridfire::BuildDepthType< / a > = std::variant< < a class = "el" href = "#a0210bd2e07538932135a56b62b8ddb57" > NetworkBuildDepth< / a > , int> < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Variant specifying either a predefined < a class = "el" href = "#a0210bd2e07538932135a56b62b8ddb57" title = "Specifies supported depths for building the reaction network." > NetworkBuildDepth< / a > or a custom integer depth. < / p >
< dl class = "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 >
< dl class = "section post" > < dt > Postcondition< / dt > < dd > The network builder will interpret and apply the specified depth to control reaction expansion. < / dd > < / dl >
< / div >
< / div >
< a id = "aa86f08712565f278adacc7cd2361eb31" name = "aa86f08712565f278adacc7cd2361eb31" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#aa86f08712565f278adacc7cd2361eb31" > ◆   < / a > < / span > LogicalReactionSet< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > using < a class = "el" href = "namespacegridfire_1_1reaction.html#aa86f08712565f278adacc7cd2361eb31" > gridfire::reaction::LogicalReactionSet< / a > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > A set of logical reactions. < / p >
< / div >
< / div >
< a id = "ad838ce3fb6cc02c3fd90b924a0dd91b1" name = "ad838ce3fb6cc02c3fd90b924a0dd91b1" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ad838ce3fb6cc02c3fd90b924a0dd91b1" > ◆   < / a > < / span > ReactionSet< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > using < a class = "el" href = "namespacegridfire_1_1reaction.html#ad838ce3fb6cc02c3fd90b924a0dd91b1" > gridfire::reaction::ReactionSet< / a > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > A set of reactions, typically from a single source like REACLIB. < / p >
< / div >
< / div >
< a id = "a898dfe22579e649935645cbd6f073178" name = "a898dfe22579e649935645cbd6f073178" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a898dfe22579e649935645cbd6f073178" > ◆   < / a > < / span > SparsityPattern< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > using < a class = "el" href = "#a898dfe22579e649935645cbd6f073178" > gridfire::SparsityPattern< / a > = std::vector< std::pair< size_t, size_t> > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
2025-07-01 07:24:18 -04:00
< / div >
< / div >
< h2 class = "groupheader" > Enumeration Type Documentation< / h2 >
2025-07-24 11:10:45 -04:00
< a id = "a0210bd2e07538932135a56b62b8ddb57" name = "a0210bd2e07538932135a56b62b8ddb57" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a0210bd2e07538932135a56b62b8ddb57" > ◆   < / a > < / span > NetworkBuildDepth< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > enum class < a class = "el" href = "#a0210bd2e07538932135a56b62b8ddb57" > gridfire::NetworkBuildDepth< / a > < / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel strong" > strong< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< 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 >
< dl class = "section note" > < dt > Note< / dt > < dd > For custom build depths, see < a class = "el" href = "#a3b1f70dc7ff5b501809330a97079e4f6" title = "Variant specifying either a predefined NetworkBuildDepth or a custom integer depth." > BuildDepthType< / a > . < / dd > < / dl >
< table class = "fieldtable" >
< tr > < th colspan = "2" > Enumerator< / th > < / tr > < tr > < td class = "fieldname" > < a id = "a0210bd2e07538932135a56b62b8ddb57abbd47109890259c0127154db1af26c75" name = "a0210bd2e07538932135a56b62b8ddb57abbd47109890259c0127154db1af26c75" > < / a > Full  < / td > < td class = "fielddoc" > < / td > < / tr >
< tr > < td class = "fieldname" > < a id = "a0210bd2e07538932135a56b62b8ddb57a928d0f1285ee7d36c1c2fa1b1b7a164c" name = "a0210bd2e07538932135a56b62b8ddb57a928d0f1285ee7d36c1c2fa1b1b7a164c" > < / a > Shallow  < / td > < td class = "fielddoc" > < / td > < / tr >
< tr > < td class = "fieldname" > < a id = "a0210bd2e07538932135a56b62b8ddb57a264572d66aed5373d19dc80c7cde1f46" name = "a0210bd2e07538932135a56b62b8ddb57a264572d66aed5373d19dc80c7cde1f46" > < / a > SecondOrder  < / td > < td class = "fielddoc" > < / td > < / tr >
< tr > < td class = "fieldname" > < a id = "a0210bd2e07538932135a56b62b8ddb57a3fc719e07f9f63e7f11a3d4fb74b476f" name = "a0210bd2e07538932135a56b62b8ddb57a3fc719e07f9f63e7f11a3d4fb74b476f" > < / a > ThirdOrder  < / td > < td class = "fielddoc" > < / td > < / tr >
< tr > < td class = "fieldname" > < a id = "a0210bd2e07538932135a56b62b8ddb57a100e3bf0197221c19b222badf42aa964" name = "a0210bd2e07538932135a56b62b8ddb57a100e3bf0197221c19b222badf42aa964" > < / a > FourthOrder  < / td > < td class = "fielddoc" > < / td > < / tr >
< tr > < td class = "fieldname" > < a id = "a0210bd2e07538932135a56b62b8ddb57a5105376c2b90747e00bed5bf2953dd56" name = "a0210bd2e07538932135a56b62b8ddb57a5105376c2b90747e00bed5bf2953dd56" > < / a > FifthOrder  < / td > < td class = "fielddoc" > < / td > < / tr >
< / table >
< / div >
< / div >
2025-07-01 07:24:18 -04:00
< a id = "a3f3d6b3f9742b70e62049ccefbb60f37" name = "a3f3d6b3f9742b70e62049ccefbb60f37" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a3f3d6b3f9742b70e62049ccefbb60f37" > ◆   < / a > < / span > NetworkFormat< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > enum < a class = "el" href = "#a3f3d6b3f9742b70e62049ccefbb60f37" > gridfire::NetworkFormat< / a > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< table class = "fieldtable" >
< tr > < th colspan = "2" > Enumerator< / th > < / tr > < tr > < td class = "fieldname" > < a id = "a3f3d6b3f9742b70e62049ccefbb60f37a1fc7adf719c40457abfdb8334675faea" name = "a3f3d6b3f9742b70e62049ccefbb60f37a1fc7adf719c40457abfdb8334675faea" > < / a > APPROX8  < / td > < td class = "fielddoc" > < p > Approx8 nuclear reaction network format. < / p >
< / td > < / tr >
< tr > < td class = "fieldname" > < a id = "a3f3d6b3f9742b70e62049ccefbb60f37a9b8db7b445ae4f1bd114caa42a583182" name = "a3f3d6b3f9742b70e62049ccefbb60f37a9b8db7b445ae4f1bd114caa42a583182" > < / a > REACLIB  < / td > < td class = "fielddoc" > < p > General REACLIB nuclear reaction network format. < / p >
< / td > < / tr >
< tr > < td class = "fieldname" > < a id = "a3f3d6b3f9742b70e62049ccefbb60f37aac700abde5f6ff8b7328193eb19697b2" name = "a3f3d6b3f9742b70e62049ccefbb60f37aac700abde5f6ff8b7328193eb19697b2" > < / a > UNKNOWN  < / td > < td class = "fielddoc" > < / td > < / tr >
< / table >
2025-07-24 11:10:45 -04:00
< / div >
< / div >
< a id = "a8bea3d74f35d640e693fa398e9b3e154" name = "a8bea3d74f35d640e693fa398e9b3e154" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a8bea3d74f35d640e693fa398e9b3e154" > ◆   < / a > < / span > PrimingReportStatus< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > enum class < a class = "el" href = "#a8bea3d74f35d640e693fa398e9b3e154" > gridfire::PrimingReportStatus< / a > < / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel strong" > strong< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< 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 >
< dl class = "section see" > < dt > See also< / dt > < dd > < a class = "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 >
< table class = "fieldtable" >
< tr > < th colspan = "2" > Enumerator< / th > < / tr > < tr > < td class = "fieldname" > < a id = "a8bea3d74f35d640e693fa398e9b3e154a64d98633bac1de0eb2a539cbfd2a5c2a" name = "a8bea3d74f35d640e693fa398e9b3e154a64d98633bac1de0eb2a539cbfd2a5c2a" > < / a > FULL_SUCCESS  < / td > < td class = "fielddoc" > < / td > < / tr >
< tr > < td class = "fieldname" > < a id = "a8bea3d74f35d640e693fa398e9b3e154a708c14ec56942aa5f32e7bef1e29db45" name = "a8bea3d74f35d640e693fa398e9b3e154a708c14ec56942aa5f32e7bef1e29db45" > < / a > NO_SPECIES_TO_PRIME  < / td > < td class = "fielddoc" > < / td > < / tr >
< tr > < td class = "fieldname" > < a id = "a8bea3d74f35d640e693fa398e9b3e154a5afaf45bc4c02208d502d9c0c26d8287" name = "a8bea3d74f35d640e693fa398e9b3e154a5afaf45bc4c02208d502d9c0c26d8287" > < / a > MAX_ITERATIONS_REACHED  < / td > < td class = "fielddoc" > < / td > < / tr >
< tr > < td class = "fieldname" > < a id = "a8bea3d74f35d640e693fa398e9b3e154ae8870a753743b62c511c939eef95c93f" name = "a8bea3d74f35d640e693fa398e9b3e154ae8870a753743b62c511c939eef95c93f" > < / a > FAILED_TO_FINALIZE_COMPOSITION  < / td > < td class = "fielddoc" > < / td > < / tr >
< tr > < td class = "fieldname" > < a id = "a8bea3d74f35d640e693fa398e9b3e154a9870268bdece09274aea75557a19158a" name = "a8bea3d74f35d640e693fa398e9b3e154a9870268bdece09274aea75557a19158a" > < / a > FAILED_TO_FIND_CREATION_CHANNEL  < / td > < td class = "fielddoc" > < / td > < / tr >
< tr > < td class = "fieldname" > < a id = "a8bea3d74f35d640e693fa398e9b3e154a186367e42446c004076290ca7913d931" name = "a8bea3d74f35d640e693fa398e9b3e154a186367e42446c004076290ca7913d931" > < / a > FAILED_TO_FIND_PRIMING_REACTIONS  < / td > < td class = "fielddoc" > < / td > < / tr >
< tr > < td class = "fieldname" > < a id = "a8bea3d74f35d640e693fa398e9b3e154ab837953f2841baabbae6bb5f2e43e71e" name = "a8bea3d74f35d640e693fa398e9b3e154ab837953f2841baabbae6bb5f2e43e71e" > < / a > BASE_NETWORK_TOO_SHALLOW  < / td > < td class = "fielddoc" > < / td > < / tr >
< / table >
2025-07-01 07:24:18 -04:00
< / div >
< / div >
< h2 class = "groupheader" > Function Documentation< / h2 >
2025-07-24 11:10:45 -04:00
< a id = "a745c6568723947f8e1ff874c9d3f4733" name = "a745c6568723947f8e1ff874c9d3f4733" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a745c6568723947f8e1ff874c9d3f4733" > ◆   < / a > < / span > build_reaclib_nuclear_network() < span class = "overload" > [1/2]< / span > < / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > < a class = "el" href = "namespacegridfire_1_1reaction.html#aa86f08712565f278adacc7cd2361eb31" > LogicalReactionSet< / a > gridfire::build_reaclib_nuclear_network < / td >
< td > (< / td >
< td class = "paramtype" > const Composition & < / td > < td class = "paramname" > < span class = "paramname" > < em > composition< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > < a class = "el" href = "#a3b1f70dc7ff5b501809330a97079e4f6" > BuildDepthType< / a > < / td > < td class = "paramname" > < span class = "paramname" > < em > maxLayers< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > bool< / td > < td class = "paramname" > < span class = "paramname" > < em > reverse< / em > < / span >   )< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< / div >
< / div >
< a id = "aedddb89e400a6111f69bfe0c3fd4214e" name = "aedddb89e400a6111f69bfe0c3fd4214e" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#aedddb89e400a6111f69bfe0c3fd4214e" > ◆   < / a > < / span > build_reaclib_nuclear_network() < span class = "overload" > [2/2]< / span > < / h2 >
2025-07-01 07:24:18 -04:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2025-07-01 11:40:51 -04:00
< td class = "memname" > < a class = "el" href = "namespacegridfire_1_1reaction.html#aa86f08712565f278adacc7cd2361eb31" > reaction::LogicalReactionSet< / a > gridfire::build_reaclib_nuclear_network < / td >
2025-07-01 07:24:18 -04:00
< td > (< / td >
< td class = "paramtype" > const fourdst::composition::Composition & < / td > < td class = "paramname" > < span class = "paramname" > < em > composition< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
2025-07-24 11:10:45 -04:00
< td class = "paramtype" > < a class = "el" href = "#a3b1f70dc7ff5b501809330a97079e4f6" > BuildDepthType< / a > < / td > < td class = "paramname" > < span class = "paramname" > < em > maxLayers< / em > < / span > < span class = "paramdefsep" > = < / span > < span class = "paramdefval" > < a class = "el" href = "#a0210bd2e07538932135a56b62b8ddb57abbd47109890259c0127154db1af26c75" > NetworkBuildDepth::Full< / a > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > bool< / td > < td class = "paramname" > < span class = "paramname" > < em > reverse< / em > < / span > < span class = "paramdefsep" > = < / span > < span class = "paramdefval" > false< / span >   )< / td >
2025-07-01 07:24:18 -04:00
< / tr >
< / table >
< / div > < div class = "memdoc" >
2025-07-24 11:10:45 -04:00
< 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 < a class = "el" href = "construction_8cpp.html" > construction.cpp< / a > for details on the layering algorithm, logging, and performance.< / p >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > composition< / td > < td > Mapping of isotopic species to their mass fractions; species with positive mass fraction seed the network. < / td > < / tr >
< tr > < td class = "paramname" > maxLayers< / td > < td > Variant specifying either a predefined < a class = "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 > < td class = "paramname" > reverse< / td > < td > If true, collects reverse reactions (decays or back-reactions); if false, uses forward reactions. < / td > < / tr >
< / table >
< / dd >
< / dl >
< dl class = "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 >
< dl class = "section post" > < dt > Postcondition< / dt > < dd > Returned network includes only reactions satisfying the depth and reverse criteria. < / dd > < / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > A < a class = "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 >
< dl class = "exception" > < dt > Exceptions< / dt > < dd >
< table class = "exception" >
< tr > < td class = "paramname" > std::logic_error< / td > < td > If the resolved network depth is zero (no reactions can be collected). < / td > < / tr >
< / table >
< / dd >
< / dl >
< / div >
< / div >
< a id = "a7c4b6104d5dfc5afddda36f726c5d07d" name = "a7c4b6104d5dfc5afddda36f726c5d07d" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a7c4b6104d5dfc5afddda36f726c5d07d" > ◆   < / a > < / span > calculateCreationRate()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > double gridfire::calculateCreationRate < / td >
< td > (< / td >
< td class = "paramtype" > const < a class = "el" href = "classgridfire_1_1_dynamic_engine.html" > DynamicEngine< / a > & < / td > < td class = "paramname" > < span class = "paramname" > < em > engine< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const fourdst::atomic::Species & < / td > < td class = "paramname" > < span class = "paramname" > < em > species< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const std::vector< double > & < / td > < td class = "paramname" > < span class = "paramname" > < em > Y< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > double< / td > < td class = "paramname" > < span class = "paramname" > < em > T9< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > double< / td > < td class = "paramname" > < span class = "paramname" > < em > rho< / em > < / span >   )< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< 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 >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > engine< / td > < td > < a class = "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 > < td class = "paramname" > species< / td > < td > The atomic species whose creation rate is computed. < / td > < / tr >
< tr > < td class = "paramname" > Y< / td > < td > Vector of molar abundances for all species in the engine. < / td > < / tr >
< tr > < td class = "paramname" > T9< / td > < td > Temperature in units of 10^9 K. < / td > < / tr >
< tr > < td class = "paramname" > rho< / td > < td > Density of the medium. < / td > < / tr >
< / table >
< / dd >
< / dl >
< dl class = "section pre" > < dt > Precondition< / dt > < dd > Y.size() matches engine.getNetworkReactions().size() mapping species order. < / dd > < / dl >
< dl class = "section post" > < dt > Postcondition< / dt > < dd > Returned creation rate is non-negative. < / dd > < / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > Sum of stoichiometry-weighted creation flows for the species. < / dd > < / dl >
< / div >
< / div >
< a id = "a8f26d5f5fabb42e88261e42bc060cea2" name = "a8f26d5f5fabb42e88261e42bc060cea2" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a8f26d5f5fabb42e88261e42bc060cea2" > ◆   < / a > < / span > calculateDestructionRateConstant()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > double gridfire::calculateDestructionRateConstant < / td >
< td > (< / td >
< td class = "paramtype" > const < a class = "el" href = "classgridfire_1_1_dynamic_engine.html" > DynamicEngine< / a > & < / td > < td class = "paramname" > < span class = "paramname" > < em > engine< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const fourdst::atomic::Species & < / td > < td class = "paramname" > < span class = "paramname" > < em > species< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const std::vector< double > & < / td > < td class = "paramname" > < span class = "paramname" > < em > Y< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > double< / td > < td class = "paramname" > < span class = "paramname" > < em > T9< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > double< / td > < td class = "paramname" > < span class = "paramname" > < em > rho< / em > < / span >   )< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< 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 >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > engine< / td > < td > < a class = "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 > < td class = "paramname" > species< / td > < td > The atomic species whose destruction rate is computed. < / td > < / tr >
< tr > < td class = "paramname" > Y< / td > < td > Vector of molar abundances for all species in the engine. < / td > < / tr >
< tr > < td class = "paramname" > T9< / td > < td > Temperature in units of 10^9 K. < / td > < / tr >
< tr > < td class = "paramname" > rho< / td > < td > Density of the medium. < / td > < / tr >
< / table >
< / dd >
< / dl >
< dl class = "section pre" > < dt > Precondition< / dt > < dd > Y.size() matches engine.getNetworkReactions().size() mapping species order. < / dd > < / dl >
< dl class = "section post" > < dt > Postcondition< / dt > < dd > Returned rate constant is non-negative. < / dd > < / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > Sum of absolute stoichiometry-weighted destruction flows for the species. < / dd > < / dl >
< / div >
< / div >
< a id = "aefc63ddbfe97dcb4178c94dfd1c4b256" name = "aefc63ddbfe97dcb4178c94dfd1c4b256" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#aefc63ddbfe97dcb4178c94dfd1c4b256" > ◆   < / a > < / span > findDominantCreationChannel()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > const < a class = "el" href = "classgridfire_1_1reaction_1_1_reaction.html" > reaction::Reaction< / a > * gridfire::findDominantCreationChannel < / td >
< td > (< / td >
< td class = "paramtype" > const < a class = "el" href = "classgridfire_1_1_dynamic_engine.html" > DynamicEngine< / a > & < / td > < td class = "paramname" > < span class = "paramname" > < em > engine< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const Species & < / td > < td class = "paramname" > < span class = "paramname" > < em > species< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const std::vector< double > & < / td > < td class = "paramname" > < span class = "paramname" > < em > Y< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const double< / td > < td class = "paramname" > < span class = "paramname" > < em > T9< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const double< / td > < td class = "paramname" > < span class = "paramname" > < em > rho< / em > < / span >   )< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< / div >
< / div >
< a id = "acd0bfdfbce4e84af102d62ff8a797c9f" name = "acd0bfdfbce4e84af102d62ff8a797c9f" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#acd0bfdfbce4e84af102d62ff8a797c9f" > ◆   < / a > < / span > primeNetwork()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > < a class = "el" href = "structgridfire_1_1_priming_report.html" > PrimingReport< / a > gridfire::primeNetwork < / td >
< td > (< / td >
< td class = "paramtype" > const < a class = "el" href = "structgridfire_1_1_net_in.html" > NetIn< / a > & < / td > < td class = "paramname" > < span class = "paramname" > < em > netIn< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > < a class = "el" href = "classgridfire_1_1_dynamic_engine.html" > DynamicEngine< / a > & < / td > < td class = "paramname" > < span class = "paramname" > < em > engine< / em > < / span >   )< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< 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 < a class = "el" href = "priming_8cpp.html" > priming.cpp< / a > for implementation details on logging, algorithmic steps, and error handling.< / p >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > netIn< / td > < td > Input network data containing initial composition, temperature, and density. < / td > < / tr >
< tr > < td class = "paramname" > engine< / td > < td > < a class = "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 >
< dl class = "section pre" > < dt > Precondition< / dt > < dd > netIn.composition defines species and their mass fractions; engine is constructed with a valid network. < / dd > < / dl >
< dl class = "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 >
< dl class = "section return" > < dt > Returns< / dt > < dd > < a class = "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 >
2025-07-01 07:24:18 -04:00
< / div >
< / div >
< a id = "a8b245f261cd8d1711ae8d593b054cf98" name = "a8b245f261cd8d1711ae8d593b054cf98" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a8b245f261cd8d1711ae8d593b054cf98" > ◆   < / a > < / span > trim_whitespace()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > std::string gridfire::trim_whitespace < / td >
< td > (< / td >
< td class = "paramtype" > const std::string & < / td > < td class = "paramname" > < span class = "paramname" > < em > str< / em > < / span > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< / div >
< / div >
< h2 class = "groupheader" > Variable Documentation< / h2 >
< a id = "a4e9cabad30b57d636c2f0d73d8cc6bb4" name = "a4e9cabad30b57d636c2f0d73d8cc6bb4" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a4e9cabad30b57d636c2f0d73d8cc6bb4" > ◆   < / a > < / span > FormatStringLookup< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > std::unordered_map< < a class = "el" href = "#a3f3d6b3f9742b70e62049ccefbb60f37" > NetworkFormat< / a > , std::string> gridfire::FormatStringLookup< / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel inline" > inline< / span > < span class = "mlabel static" > static< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< b > Initial value:< / b > < div class = "fragment" > < div class = "line" > = {< / div >
< div class = "line" > {< a class = "code hl_enumvalue" href = "#a3f3d6b3f9742b70e62049ccefbb60f37a1fc7adf719c40457abfdb8334675faea" > APPROX8< / a > , < span class = "stringliteral" > " Approx8" < / span > },< / div >
< div class = "line" > {< a class = "code hl_enumvalue" href = "#a3f3d6b3f9742b70e62049ccefbb60f37a9b8db7b445ae4f1bd114caa42a583182" > REACLIB< / a > , < span class = "stringliteral" > " REACLIB" < / span > },< / div >
< div class = "line" > {< a class = "code hl_enumvalue" href = "#a3f3d6b3f9742b70e62049ccefbb60f37aac700abde5f6ff8b7328193eb19697b2" > UNKNOWN< / a > , < span class = "stringliteral" > " Unknown" < / span > }< / div >
< div class = "line" > }< / div >
2025-07-31 10:54:31 -04:00
< div class = "ttc" id = "anamespacegridfire_html_a3f3d6b3f9742b70e62049ccefbb60f37a1fc7adf719c40457abfdb8334675faea" > < div class = "ttname" > < a href = "#a3f3d6b3f9742b70e62049ccefbb60f37a1fc7adf719c40457abfdb8334675faea" > gridfire::APPROX8< / a > < / div > < div class = "ttdeci" > @ APPROX8< / div > < div class = "ttdoc" > Approx8 nuclear reaction network format.< / div > < div class = "ttdef" > < b > Definition< / b > network.h:42< / div > < / div >
< div class = "ttc" id = "anamespacegridfire_html_a3f3d6b3f9742b70e62049ccefbb60f37a9b8db7b445ae4f1bd114caa42a583182" > < div class = "ttname" > < a href = "#a3f3d6b3f9742b70e62049ccefbb60f37a9b8db7b445ae4f1bd114caa42a583182" > gridfire::REACLIB< / a > < / div > < div class = "ttdeci" > @ REACLIB< / div > < div class = "ttdoc" > General REACLIB nuclear reaction network format.< / div > < div class = "ttdef" > < b > Definition< / b > network.h:43< / div > < / div >
< div class = "ttc" id = "anamespacegridfire_html_a3f3d6b3f9742b70e62049ccefbb60f37aac700abde5f6ff8b7328193eb19697b2" > < div class = "ttname" > < a href = "#a3f3d6b3f9742b70e62049ccefbb60f37aac700abde5f6ff8b7328193eb19697b2" > gridfire::UNKNOWN< / a > < / div > < div class = "ttdeci" > @ UNKNOWN< / div > < div class = "ttdef" > < b > Definition< / b > network.h:44< / div > < / div >
2025-07-01 07:24:18 -04:00
< / div > <!-- fragment -->
< / div >
< / div >
< a id = "a96c062f94713921e5d7568ecedcdcb06" name = "a96c062f94713921e5d7568ecedcdcb06" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a96c062f94713921e5d7568ecedcdcb06" > ◆   < / a > < / span > MIN_ABUNDANCE_THRESHOLD< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > double gridfire::MIN_ABUNDANCE_THRESHOLD = 1e-18< / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel static" > static< / span > < span class = "mlabel constexpr" > constexpr< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< 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 >
< / div >
< / div >
< a id = "ada3c137c014ecd8d06200fea2d1a9f50" name = "ada3c137c014ecd8d06200fea2d1a9f50" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ada3c137c014ecd8d06200fea2d1a9f50" > ◆   < / a > < / span > MIN_DENSITY_THRESHOLD< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > double gridfire::MIN_DENSITY_THRESHOLD = 1e-18< / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel static" > static< / span > < span class = "mlabel constexpr" > constexpr< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< 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 >
< / div >
< / div >
< a id = "ae01b1738df1921db565bcbd68dd6cf64" name = "ae01b1738df1921db565bcbd68dd6cf64" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ae01b1738df1921db565bcbd68dd6cf64" > ◆   < / a > < / span > MIN_JACOBIAN_THRESHOLD< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > double gridfire::MIN_JACOBIAN_THRESHOLD = 1e-24< / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel static" > static< / span > < span class = "mlabel constexpr" > constexpr< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Minimum value for Jacobian matrix entries. < / p >
< p > Jacobian matrix entries with absolute values below this threshold are treated as zero to maintain sparsity and improve performance. < / p >
2025-07-24 11:10:45 -04:00
< / div >
< / div >
< a id = "a02be158966bf82a91b159b7a962c3fa5" name = "a02be158966bf82a91b159b7a962c3fa5" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a02be158966bf82a91b159b7a962c3fa5" > ◆   < / a > < / span > PrimingReportStatusStrings< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > std::map< < a class = "el" href = "#a8bea3d74f35d640e693fa398e9b3e154" > PrimingReportStatus< / a > , std::string> gridfire::PrimingReportStatusStrings< / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel inline" > inline< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< b > Initial value:< / b > < div class = "fragment" > < div class = "line" > = {< / div >
< div class = "line" > {< a class = "code hl_enumvalue" href = "#a8bea3d74f35d640e693fa398e9b3e154a64d98633bac1de0eb2a539cbfd2a5c2a" > PrimingReportStatus::FULL_SUCCESS< / a > , < span class = "stringliteral" > " Full Success" < / span > },< / div >
< div class = "line" > {< a class = "code hl_enumvalue" href = "#a8bea3d74f35d640e693fa398e9b3e154a708c14ec56942aa5f32e7bef1e29db45" > PrimingReportStatus::NO_SPECIES_TO_PRIME< / a > , < span class = "stringliteral" > " No Species to Prime" < / span > },< / div >
< div class = "line" > {< a class = "code hl_enumvalue" href = "#a8bea3d74f35d640e693fa398e9b3e154a5afaf45bc4c02208d502d9c0c26d8287" > PrimingReportStatus::MAX_ITERATIONS_REACHED< / a > , < span class = "stringliteral" > " Max Iterations Reached" < / span > },< / div >
< div class = "line" > {< a class = "code hl_enumvalue" href = "#a8bea3d74f35d640e693fa398e9b3e154ae8870a753743b62c511c939eef95c93f" > PrimingReportStatus::FAILED_TO_FINALIZE_COMPOSITION< / a > , < span class = "stringliteral" > " Failed to Finalize Composition" < / span > },< / div >
< div class = "line" > {< a class = "code hl_enumvalue" href = "#a8bea3d74f35d640e693fa398e9b3e154a9870268bdece09274aea75557a19158a" > PrimingReportStatus::FAILED_TO_FIND_CREATION_CHANNEL< / a > , < span class = "stringliteral" > " Failed to Find Creation Channel" < / span > },< / div >
< div class = "line" > {< a class = "code hl_enumvalue" href = "#a8bea3d74f35d640e693fa398e9b3e154a186367e42446c004076290ca7913d931" > PrimingReportStatus::FAILED_TO_FIND_PRIMING_REACTIONS< / a > , < span class = "stringliteral" > " Failed to Find Priming Reactions" < / span > },< / div >
< div class = "line" > {< a class = "code hl_enumvalue" href = "#a8bea3d74f35d640e693fa398e9b3e154ab837953f2841baabbae6bb5f2e43e71e" > PrimingReportStatus::BASE_NETWORK_TOO_SHALLOW< / a > , < span class = "stringliteral" > " Base Network Too Shallow" < / span > }< / div >
< div class = "line" > }< / div >
2025-07-31 10:54:31 -04:00
< div class = "ttc" id = "anamespacegridfire_html_a8bea3d74f35d640e693fa398e9b3e154a186367e42446c004076290ca7913d931" > < div class = "ttname" > < a href = "#a8bea3d74f35d640e693fa398e9b3e154a186367e42446c004076290ca7913d931" > gridfire::PrimingReportStatus::FAILED_TO_FIND_PRIMING_REACTIONS< / a > < / div > < div class = "ttdeci" > @ FAILED_TO_FIND_PRIMING_REACTIONS< / div > < div class = "ttdef" > < b > Definition< / b > reporting.h:37< / div > < / div >
< div class = "ttc" id = "anamespacegridfire_html_a8bea3d74f35d640e693fa398e9b3e154a5afaf45bc4c02208d502d9c0c26d8287" > < div class = "ttname" > < a href = "#a8bea3d74f35d640e693fa398e9b3e154a5afaf45bc4c02208d502d9c0c26d8287" > gridfire::PrimingReportStatus::MAX_ITERATIONS_REACHED< / a > < / div > < div class = "ttdeci" > @ MAX_ITERATIONS_REACHED< / div > < div class = "ttdef" > < b > Definition< / b > reporting.h:34< / div > < / div >
< div class = "ttc" id = "anamespacegridfire_html_a8bea3d74f35d640e693fa398e9b3e154a64d98633bac1de0eb2a539cbfd2a5c2a" > < div class = "ttname" > < a href = "#a8bea3d74f35d640e693fa398e9b3e154a64d98633bac1de0eb2a539cbfd2a5c2a" > gridfire::PrimingReportStatus::FULL_SUCCESS< / a > < / div > < div class = "ttdeci" > @ FULL_SUCCESS< / div > < div class = "ttdef" > < b > Definition< / b > reporting.h:32< / div > < / div >
< div class = "ttc" id = "anamespacegridfire_html_a8bea3d74f35d640e693fa398e9b3e154a708c14ec56942aa5f32e7bef1e29db45" > < div class = "ttname" > < a href = "#a8bea3d74f35d640e693fa398e9b3e154a708c14ec56942aa5f32e7bef1e29db45" > gridfire::PrimingReportStatus::NO_SPECIES_TO_PRIME< / a > < / div > < div class = "ttdeci" > @ NO_SPECIES_TO_PRIME< / div > < div class = "ttdef" > < b > Definition< / b > reporting.h:33< / div > < / div >
< div class = "ttc" id = "anamespacegridfire_html_a8bea3d74f35d640e693fa398e9b3e154a9870268bdece09274aea75557a19158a" > < div class = "ttname" > < a href = "#a8bea3d74f35d640e693fa398e9b3e154a9870268bdece09274aea75557a19158a" > gridfire::PrimingReportStatus::FAILED_TO_FIND_CREATION_CHANNEL< / a > < / div > < div class = "ttdeci" > @ FAILED_TO_FIND_CREATION_CHANNEL< / div > < div class = "ttdef" > < b > Definition< / b > reporting.h:36< / div > < / div >
< div class = "ttc" id = "anamespacegridfire_html_a8bea3d74f35d640e693fa398e9b3e154ab837953f2841baabbae6bb5f2e43e71e" > < div class = "ttname" > < a href = "#a8bea3d74f35d640e693fa398e9b3e154ab837953f2841baabbae6bb5f2e43e71e" > gridfire::PrimingReportStatus::BASE_NETWORK_TOO_SHALLOW< / a > < / div > < div class = "ttdeci" > @ BASE_NETWORK_TOO_SHALLOW< / div > < div class = "ttdef" > < b > Definition< / b > reporting.h:38< / div > < / div >
< div class = "ttc" id = "anamespacegridfire_html_a8bea3d74f35d640e693fa398e9b3e154ae8870a753743b62c511c939eef95c93f" > < div class = "ttname" > < a href = "#a8bea3d74f35d640e693fa398e9b3e154ae8870a753743b62c511c939eef95c93f" > gridfire::PrimingReportStatus::FAILED_TO_FINALIZE_COMPOSITION< / a > < / div > < div class = "ttdeci" > @ FAILED_TO_FINALIZE_COMPOSITION< / div > < div class = "ttdef" > < b > Definition< / b > reporting.h:35< / div > < / div >
2025-07-24 11:10:45 -04:00
< / div > <!-- fragment -->
< p > Mapping from < a class = "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 < a class = "el" href = "#a8bea3d74f35d640e693fa398e9b3e154" title = "Enumerates outcome codes for a network priming operation." > PrimingReportStatus< / a > values. < / p >
< / div >
< / div >
< a id = "a8b632637f62614f509cde0e404a79054" name = "a8b632637f62614f509cde0e404a79054" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a8b632637f62614f509cde0e404a79054" > ◆   < / a > < / span > s_operator_parens_called< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > int gridfire::s_operator_parens_called = 0< / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel static" > static< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
2025-07-01 07:24:18 -04:00
< / div >
< / div >
< / div > <!-- contents -->
< / div > <!-- doc - content -->
<!-- start footer part -->
< div id = "nav-path" class = "navpath" > <!-- id is needed for treeview function! -->
< ul >
< li class = "navelem" > < a class = "el" href = "namespacegridfire.html" > gridfire< / a > < / li >
< li class = "footer" > Generated by < a href = "https://www.doxygen.org/index.html" > < img class = "footer" src = "doxygen.svg" width = "104" height = "31" alt = "doxygen" / > < / a > 1.13.2 < / li >
< / ul >
< / div >
< / body >
< / html >
