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::Engine Class 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-11-04 14:04:26 -05:00
< div id = "projectname" > GridFire< span id = "projectnumber" >   v0.7.0-alpha< / 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('classgridfire_1_1_engine.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 = "#pub-methods" > Public Member Functions< / a > |
< a href = "classgridfire_1_1_engine-members.html" > List of all members< / a > < / div >
< div class = "headertitle" > < div class = "title" > gridfire::Engine Class Reference< span class = "mlabels" > < span class = "mlabel abstract" > abstract< / span > < / span > < / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< p > Abstract base class for a reaction network engine.
< a href = "#details" > More...< / a > < / p >
2025-07-31 10:54:31 -04:00
< p > < code > #include < engine_abstract.h> < / code > < / p >
2025-07-01 07:24:18 -04:00
< div class = "dynheader" >
Inheritance diagram for gridfire::Engine:< / div >
< div class = "dyncontent" >
2025-11-06 09:16:40 -05:00
< div class = "center" > < div class = "zoom" > < iframe scrolling = "no" frameborder = "0" src = "classgridfire_1_1_engine__inherit__graph.svg" width = "100%" height = "487" > < p > < b > This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.< / b > < / p > < / iframe > < / div > < / div >
< center > < span class = "legend" > [< a target = "top" href = "graph_legend.html" > legend< / a > ]< / span > < / center > < / div >
2025-07-01 07:24:18 -04:00
< table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a id = "pub-methods" name = "pub-methods" > < / a >
Public Member Functions< / h2 > < / td > < / tr >
< tr class = "memitem:a2e7970bed2100699f226f4141d5db037" id = "r_a2e7970bed2100699f226f4141d5db037" > < td class = "memItemLeft" align = "right" valign = "top" > virtual  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#a2e7970bed2100699f226f4141d5db037" > ~Engine< / a > ()=default< / td > < / tr >
< tr class = "memdesc:a2e7970bed2100699f226f4141d5db037" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Virtual destructor. < br / > < / td > < / tr >
< tr class = "separator:a2e7970bed2100699f226f4141d5db037" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a020e1b493d6964cafdad08fde697ceb3" id = "r_a020e1b493d6964cafdad08fde697ceb3" > < td class = "memItemLeft" align = "right" valign = "top" > virtual const std::vector< fourdst::atomic::Species > &   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#a020e1b493d6964cafdad08fde697ceb3" > getNetworkSpecies< / a > () const =0< / td > < / tr >
< tr class = "memdesc:a020e1b493d6964cafdad08fde697ceb3" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Get the list of species in the network. < br / > < / td > < / tr >
< tr class = "separator:a020e1b493d6964cafdad08fde697ceb3" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2025-10-08 11:17:09 -04:00
< tr class = "memitem:add48d3af9ebde17717e42e220e349740" id = "r_add48d3af9ebde17717e42e220e349740" > < td class = "memItemLeft" align = "right" valign = "top" > virtual std::expected< < a class = "el" href = "structgridfire_1_1_step_derivatives.html" > StepDerivatives< / a > < double > , < a class = "el" href = "structgridfire_1_1expectations_1_1_stale_engine_error.html" > expectations::StaleEngineError< / a > >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#add48d3af9ebde17717e42e220e349740" > calculateRHSAndEnergy< / a > (const fourdst::composition::Composition & comp, double T9, double rho) const =0< / td > < / tr >
< tr class = "memdesc:add48d3af9ebde17717e42e220e349740" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Calculate the right-hand side (dY/dt) and energy generation. < br / > < / td > < / tr >
< tr class = "separator:add48d3af9ebde17717e42e220e349740" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2025-07-01 07:24:18 -04:00
< / table >
< a name = "details" id = "details" > < / a > < h2 class = "groupheader" > Detailed Description< / h2 >
< div class = "textblock" > < p > Abstract base class for a reaction network engine. < / p >
< p > This class defines the minimal interface for a reaction network engine, which is responsible for evaluating the right-hand side (dY/dt) and energy generation for a given set of abundances, temperature, and density.< / p >
< p > Intended usage: Derive from this class to implement a concrete engine for a specific network or integration method.< / p >
< p > Example: < / p > < div class = "fragment" > < div class = "line" > < span class = "keyword" > class < / span > MyEngine : < span class = "keyword" > public< / span > < a class = "code hl_class" href = "classgridfire_1_1_engine.html" > gridfire::Engine< / a > {< / div >
< div class = "line" > < span class = "comment" > // Implement required methods...< / span > < / div >
< div class = "line" > };< / div >
2025-10-08 11:17:09 -04:00
< div class = "ttc" id = "aclassgridfire_1_1_engine_html" > < div class = "ttname" > < a href = "classgridfire_1_1_engine.html" > gridfire::Engine< / a > < / div > < div class = "ttdoc" > Abstract base class for a reaction network engine.< / div > < div class = "ttdef" > < b > Definition< / b > engine_abstract.h:96< / div > < / div >
2025-07-31 10:54:31 -04:00
< / div > <!-- fragment --> < / div > < h2 class = "groupheader" > Constructor & Destructor Documentation< / h2 >
2025-07-01 07:24:18 -04:00
< a id = "a2e7970bed2100699f226f4141d5db037" name = "a2e7970bed2100699f226f4141d5db037" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a2e7970bed2100699f226f4141d5db037" > ◆   < / a > < / span > ~Engine()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > virtual gridfire::Engine::~Engine < / td >
< td > (< / td >
< td class = "paramname" > < span class = "paramname" > < em > < / em > < / span > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel virtual" > virtual< / span > < span class = "mlabel default" > default< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Virtual destructor. < / p >
< / div >
< / div >
< h2 class = "groupheader" > Member Function Documentation< / h2 >
2025-10-08 11:17:09 -04:00
< a id = "add48d3af9ebde17717e42e220e349740" name = "add48d3af9ebde17717e42e220e349740" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#add48d3af9ebde17717e42e220e349740" > ◆   < / a > < / span > calculateRHSAndEnergy()< / h2 >
2025-07-01 07:24:18 -04:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
2025-07-24 11:10:45 -04:00
< td class = "memname" > virtual std::expected< < a class = "el" href = "structgridfire_1_1_step_derivatives.html" > StepDerivatives< / a > < double > , < a class = "el" href = "structgridfire_1_1expectations_1_1_stale_engine_error.html" > expectations::StaleEngineError< / a > > gridfire::Engine::calculateRHSAndEnergy < / td >
2025-07-01 07:24:18 -04:00
< td > (< / td >
2025-10-08 11:17:09 -04:00
< td class = "paramtype" > const fourdst::composition::Composition & < / td > < td class = "paramname" > < span class = "paramname" > < em > comp< / em > < / span > , < / td >
2025-07-01 07:24:18 -04:00
< / 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 >   ) const< / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
2025-07-01 11:40:51 -04:00
< span class = "mlabels" > < span class = "mlabel nodiscard" > nodiscard< / span > < span class = "mlabel pure-virtual" > pure virtual< / span > < / span > < / td >
2025-07-01 07:24:18 -04:00
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Calculate the right-hand side (dY/dt) and energy generation. < / p >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
2025-10-08 11:17:09 -04:00
< tr > < td class = "paramname" > comp< / td > < td > Composition object containing current abundances. < / td > < / tr >
2025-07-01 07:24:18 -04:00
< tr > < td class = "paramname" > T9< / td > < td > Temperature in units of 10^9 K. < / td > < / tr >
< tr > < td class = "paramname" > rho< / td > < td > Density in g/cm^3. < / td > < / tr >
< / table >
< / dd >
< / dl >
2025-11-04 14:04:26 -05:00
< dl class = "section return" > < dt > Returns< / dt > < dd > expected< StepDerivatives< double> > containing either dY/dt and energy generation rate or a stale engine error indicating that the engine must be updated< / dd > < / dl >
2025-07-01 07:24:18 -04:00
< p > This function must be implemented by derived classes to compute the time derivatives of all species and the specific nuclear energy generation rate for the current state. < / p >
2025-11-04 14:04:26 -05:00
< p > Implemented in < a class = "el" href = "classgridfire_1_1_adaptive_engine_view.html#ac5545d546166de94514871d7ad7b8669" > gridfire::AdaptiveEngineView< / a > , < a class = "el" href = "classgridfire_1_1_defined_engine_view.html#af273b29d7700cdc34da6e2712fffc5c2" > gridfire::DefinedEngineView< / a > , < a class = "el" href = "classgridfire_1_1_graph_engine.html#a7acc98647427981a9602d251c9288012" > gridfire::GraphEngine< / a > , < a class = "el" href = "classgridfire_1_1_multiscale_partitioning_engine_view.html#a5c1ab19bc3394a5d29241ef02073c4cb" > gridfire::MultiscalePartitioningEngineView< / a > , < a class = "el" href = "class_py_dynamic_engine.html#a6bd76ef1df93d361bf5791270390c914" > PyDynamicEngine< / a > , and < a class = "el" href = "class_py_engine.html#a7a298603e9d94ca58dc0db53e5b07add" > PyEngine< / a > .< / p >
2025-07-01 07:24:18 -04:00
< / div >
< / div >
< a id = "a020e1b493d6964cafdad08fde697ceb3" name = "a020e1b493d6964cafdad08fde697ceb3" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a020e1b493d6964cafdad08fde697ceb3" > ◆   < / a > < / span > getNetworkSpecies()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > virtual const std::vector< fourdst::atomic::Species > & gridfire::Engine::getNetworkSpecies < / td >
< td > (< / td >
< td class = "paramname" > < span class = "paramname" > < em > < / em > < / span > < / td > < td > )< / td >
< td > const< / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
2025-07-01 11:40:51 -04:00
< span class = "mlabels" > < span class = "mlabel nodiscard" > nodiscard< / span > < span class = "mlabel pure-virtual" > pure virtual< / span > < / span > < / td >
2025-07-01 07:24:18 -04:00
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Get the list of species in the network. < / p >
< dl class = "section return" > < dt > Returns< / dt > < dd > Vector of Species objects representing all network species. < / dd > < / dl >
2025-07-24 11:10:45 -04:00
< p > Implemented in < a class = "el" href = "classgridfire_1_1_adaptive_engine_view.html#ac83a8efe25c0e5b9bf7756ac3a500bb1" > gridfire::AdaptiveEngineView< / a > , < a class = "el" href = "classgridfire_1_1_defined_engine_view.html#a1a55f9748c45af6f13e16a6b6ceaa211" > gridfire::DefinedEngineView< / a > , < a class = "el" href = "classgridfire_1_1_graph_engine.html#a0ed390f3e598ebba4e245ac90bb78767" > gridfire::GraphEngine< / a > , < a class = "el" href = "classgridfire_1_1_multiscale_partitioning_engine_view.html#a696f74f5135bbd62169b6577f92fee80" > gridfire::MultiscalePartitioningEngineView< / a > , < a class = "el" href = "class_py_dynamic_engine.html#afc745e7ab5da5d8b3cf916044515cd7d" > PyDynamicEngine< / a > , and < a class = "el" href = "class_py_engine.html#a2d240423899e039c2ca688e96f8af1f2" > PyEngine< / a > .< / p >
2025-07-01 07:24:18 -04:00
< / div >
< / div >
< hr / > The documentation for this class was generated from the following file:< ul >
2025-07-31 10:54:31 -04:00
< li > src/include/gridfire/engine/< a class = "el" href = "engine__abstract_8h.html" > engine_abstract.h< / a > < / li >
2025-07-01 07:24:18 -04:00
< / ul >
< / 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 = "navelem" > < a class = "el" href = "classgridfire_1_1_engine.html" > Engine< / 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 >
