2025-07-24 11:10:45 -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: PyEngine 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-07-31 15:04:57 -04:00
< div id = "projectname" > GridFire< span id = "projectnumber" >   0.6.0< / span >
2025-07-24 11:10:45 -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('class_py_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 = "#pri-attribs" > Private Attributes< / a > |
< a href = "class_py_engine-members.html" > List of all members< / a > < / div >
< div class = "headertitle" > < div class = "title" > PyEngine Class Reference< span class = "mlabels" > < span class = "mlabel final" > final< / span > < / span > < / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
2025-07-31 10:54:31 -04:00
< p > < code > #include < py_engine.h> < / code > < / p >
2025-07-24 11:10:45 -04:00
< div class = "dynheader" >
Inheritance diagram for PyEngine:< / div >
< div class = "dyncontent" >
< div class = "center" >
< img src = "class_py_engine.png" usemap = "#PyEngine_map" alt = "" / >
< map id = "PyEngine_map" name = "PyEngine_map" >
< area href = "classgridfire_1_1_engine.html" title = "Abstract base class for a reaction network engine." alt = "gridfire::Engine" shape = "rect" coords = "0,0,98,24" / >
< / map >
< / div > < / div >
< 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:a2d240423899e039c2ca688e96f8af1f2" id = "r_a2d240423899e039c2ca688e96f8af1f2" > < td class = "memItemLeft" align = "right" valign = "top" > const std::vector< fourdst::atomic::Species > &   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#a2d240423899e039c2ca688e96f8af1f2" > getNetworkSpecies< / a > () const override< / td > < / tr >
< tr class = "memdesc:a2d240423899e039c2ca688e96f8af1f2" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Get the list of species in the network. < br / > < / td > < / tr >
< tr class = "separator:a2d240423899e039c2ca688e96f8af1f2" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a2f92602ecf210414b46838fc0a9ae26d" id = "r_a2f92602ecf210414b46838fc0a9ae26d" > < td class = "memItemLeft" align = "right" valign = "top" > std::expected< < a class = "el" href = "structgridfire_1_1_step_derivatives.html" > gridfire::StepDerivatives< / a > < double > , < a class = "el" href = "structgridfire_1_1expectations_1_1_stale_engine_error.html" > gridfire::expectations::StaleEngineError< / a > >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#a2f92602ecf210414b46838fc0a9ae26d" > calculateRHSAndEnergy< / a > (const std::vector< double > & Y, double T9, double rho) const override< / td > < / tr >
< tr class = "separator:a2f92602ecf210414b46838fc0a9ae26d" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "inherit_header pub_methods_classgridfire_1_1_engine" > < td colspan = "2" onclick = "javascript:dynsection.toggleInherit('pub_methods_classgridfire_1_1_engine')" > < img src = "closed.png" alt = "-" / >   Public Member Functions inherited from < a class = "el" href = "classgridfire_1_1_engine.html" > gridfire::Engine< / a > < / td > < / tr >
< tr class = "memitem:a2e7970bed2100699f226f4141d5db037 inherit pub_methods_classgridfire_1_1_engine" id = "r_a2e7970bed2100699f226f4141d5db037" > < td class = "memItemLeft" align = "right" valign = "top" > virtual  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classgridfire_1_1_engine.html#a2e7970bed2100699f226f4141d5db037" > ~Engine< / a > ()=default< / td > < / tr >
< tr class = "memdesc:a2e7970bed2100699f226f4141d5db037 inherit pub_methods_classgridfire_1_1_engine" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Virtual destructor. < br / > < / td > < / tr >
< tr class = "separator:a2e7970bed2100699f226f4141d5db037 inherit pub_methods_classgridfire_1_1_engine" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2025-10-08 11:17:09 -04:00
< tr class = "memitem:add48d3af9ebde17717e42e220e349740 inherit pub_methods_classgridfire_1_1_engine" 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 = "classgridfire_1_1_engine.html#add48d3af9ebde17717e42e220e349740" > calculateRHSAndEnergy< / a > (const fourdst::composition::Composition & comp, double T9, double rho) const =0< / td > < / tr >
< tr class = "memdesc:add48d3af9ebde17717e42e220e349740 inherit pub_methods_classgridfire_1_1_engine" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Calculate the right-hand side (dY/dt) and energy generation. < br / > < / td > < / tr >
< tr class = "separator:add48d3af9ebde17717e42e220e349740 inherit pub_methods_classgridfire_1_1_engine" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2025-07-24 11:10:45 -04:00
< / table > < table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a id = "pri-attribs" name = "pri-attribs" > < / a >
Private Attributes< / h2 > < / td > < / tr >
< tr class = "memitem:a73caaa7606e2cdfd1aa82729a78ebb73" id = "r_a73caaa7606e2cdfd1aa82729a78ebb73" > < td class = "memItemLeft" align = "right" valign = "top" > std::vector< fourdst::atomic::Species >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#a73caaa7606e2cdfd1aa82729a78ebb73" > m_species_cache< / a > < / td > < / tr >
< tr class = "separator:a73caaa7606e2cdfd1aa82729a78ebb73" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table >
2025-07-31 10:54:31 -04:00
< h2 class = "groupheader" > Member Function Documentation< / h2 >
2025-07-24 11:10:45 -04:00
< a id = "a2f92602ecf210414b46838fc0a9ae26d" name = "a2f92602ecf210414b46838fc0a9ae26d" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a2f92602ecf210414b46838fc0a9ae26d" > ◆   < / a > < / span > calculateRHSAndEnergy()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > std::expected< < a class = "el" href = "structgridfire_1_1_step_derivatives.html" > gridfire::StepDerivatives< / a > < double > , < a class = "el" href = "structgridfire_1_1expectations_1_1_stale_engine_error.html" > gridfire::expectations::StaleEngineError< / a > > PyEngine::calculateRHSAndEnergy < / 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 >   ) const< / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
2025-10-08 11:17:09 -04:00
< span class = "mlabels" > < span class = "mlabel override" > override< / span > < / span > < / td >
2025-07-24 11:10:45 -04:00
< / tr >
< / table >
< / div > < div class = "memdoc" >
< / div >
< / div >
< a id = "a2d240423899e039c2ca688e96f8af1f2" name = "a2d240423899e039c2ca688e96f8af1f2" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a2d240423899e039c2ca688e96f8af1f2" > ◆   < / 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" > const std::vector< fourdst::atomic::Species > & PyEngine::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" >
< span class = "mlabels" > < span class = "mlabel override" > override< / span > < span class = "mlabel virtual" > virtual< / span > < / span > < / td >
< / 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 >
< p > Implements < a class = "el" href = "classgridfire_1_1_engine.html#a020e1b493d6964cafdad08fde697ceb3" > gridfire::Engine< / a > .< / p >
< / div >
< / div >
< h2 class = "groupheader" > Member Data Documentation< / h2 >
< a id = "a73caaa7606e2cdfd1aa82729a78ebb73" name = "a73caaa7606e2cdfd1aa82729a78ebb73" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a73caaa7606e2cdfd1aa82729a78ebb73" > ◆   < / a > < / span > m_species_cache< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > std::vector< fourdst::atomic::Species> PyEngine::m_species_cache< / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel mutable" > mutable< / span > < span class = "mlabel private" > private< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< / div >
< / div >
< hr / > The documentation for this class was generated from the following files:< ul >
2025-07-31 10:54:31 -04:00
< li > src/python/engine/trampoline/< a class = "el" href = "py__engine_8h.html" > py_engine.h< / a > < / li >
< li > src/python/engine/trampoline/< a class = "el" href = "py__engine_8cpp.html" > py_engine.cpp< / a > < / li >
2025-07-24 11:10:45 -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 = "class_py_engine.html" > PyEngine< / 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 >
