2026-04-20 12:45:31 -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: GFContext Struct 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" >
2026-06-14 08:36:52 -04:00
< div id = "projectname" > GridFire< span id = "projectnumber" >   v1.0.2< / span >
2026-04-20 12:45:31 -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('struct_g_f_context.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 = "#pub-attribs" > Public Attributes< / a > |
< a href = "struct_g_f_context-members.html" > List of all members< / a > < / div >
< div class = "headertitle" > < div class = "title" > GFContext Struct Reference< span class = "mlabels" > < span class = "mlabel abstract" > abstract< / span > < / span > < / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< p > < code > #include < gridfire_context.h> < / code > < / p >
< div class = "dynheader" >
Inheritance diagram for GFContext:< / div >
< div class = "dyncontent" >
< div class = "center" > < iframe scrolling = "no" frameborder = "0" src = "struct_g_f_context__inherit__graph.svg" width = "259" height = "111" > < p > < b > This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.< / b > < / p > < / iframe > < / div >
< center > < span class = "legend" > [< a target = "top" href = "graph_legend.html" > legend< / a > ]< / span > < / center > < / div >
< div class = "dynheader" >
Collaboration diagram for GFContext:< / div >
< div class = "dyncontent" >
< div class = "center" > < div class = "zoom" > < iframe scrolling = "no" frameborder = "0" src = "struct_g_f_context__coll__graph.svg" width = "100%" height = "529" > < 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 >
< 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:a4da09184145ea3bddef5dee206dea458" id = "r_a4da09184145ea3bddef5dee206dea458" > < td class = "memItemLeft" align = "right" valign = "top" > virtual  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#a4da09184145ea3bddef5dee206dea458" > ~GFContext< / a > ()=default< / td > < / tr >
< tr class = "separator:a4da09184145ea3bddef5dee206dea458" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ad3067d7c133f7e60849e8214fad6ed4e" id = "r_ad3067d7c133f7e60849e8214fad6ed4e" > < td class = "memItemLeft" align = "right" valign = "top" > virtual void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#ad3067d7c133f7e60849e8214fad6ed4e" > init_species_map< / a > (const std::vector< std::string > & species_names)< / td > < / tr >
< tr class = "separator:ad3067d7c133f7e60849e8214fad6ed4e" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a18aab1769f5e3071d768753141f15c6c" id = "r_a18aab1769f5e3071d768753141f15c6c" > < td class = "memItemLeft" align = "right" valign = "top" > virtual void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#a18aab1769f5e3071d768753141f15c6c" > init_engine_from_policy< / a > (const std::string & policy_name, const double *abundances, size_t num_species)< / td > < / tr >
< tr class = "separator:a18aab1769f5e3071d768753141f15c6c" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ae1d09e19a43ddca42a1c3d360daf548e" id = "r_ae1d09e19a43ddca42a1c3d360daf548e" > < td class = "memItemLeft" align = "right" valign = "top" > virtual void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#ae1d09e19a43ddca42a1c3d360daf548e" > init_solver_from_engine< / a > ()=0< / td > < / tr >
< tr class = "separator:ae1d09e19a43ddca42a1c3d360daf548e" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a4aa31d479303659b475558ef2df30cbe" id = "r_a4aa31d479303659b475558ef2df30cbe" > < td class = "memItemLeft" align = "right" valign = "top" > fourdst::composition::Composition  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#a4aa31d479303659b475558ef2df30cbe" > init_composition_from_abundance_vector< / a > (const std::vector< double > & abundances, size_t num_species) const< / td > < / tr >
< tr class = "separator:a4aa31d479303659b475558ef2df30cbe" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table > < table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a id = "pub-attribs" name = "pub-attribs" > < / a >
Public Attributes< / h2 > < / td > < / tr >
< tr class = "memitem:a6d053d819a80084fcda10cb00d06f9f8" id = "r_a6d053d819a80084fcda10cb00d06f9f8" > < td class = "memItemLeft" align = "right" valign = "top" > std::unique_ptr< < a class = "el" href = "classgridfire_1_1policy_1_1_network_policy.html" > gridfire::policy::NetworkPolicy< / a > >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#a6d053d819a80084fcda10cb00d06f9f8" > policy< / a > < / td > < / tr >
< tr class = "separator:a6d053d819a80084fcda10cb00d06f9f8" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ab566b9194a7869f6b69ba7adc67d5d34" id = "r_ab566b9194a7869f6b69ba7adc67d5d34" > < td class = "memItemLeft" align = "right" valign = "top" > const < a class = "el" href = "classgridfire_1_1engine_1_1_dynamic_engine.html" > gridfire::engine::DynamicEngine< / a > *  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#ab566b9194a7869f6b69ba7adc67d5d34" > engine< / a > < / td > < / tr >
< tr class = "separator:ab566b9194a7869f6b69ba7adc67d5d34" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:af77eab6a1ee3b0c1ebf50b7200040dfa" id = "r_af77eab6a1ee3b0c1ebf50b7200040dfa" > < td class = "memItemLeft" align = "right" valign = "top" > std::unique_ptr< < a class = "el" href = "classgridfire_1_1engine_1_1scratch_1_1_state_blob.html" > gridfire::engine::scratch::StateBlob< / a > >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#af77eab6a1ee3b0c1ebf50b7200040dfa" > engine_ctx< / a > < / td > < / tr >
< tr class = "separator:af77eab6a1ee3b0c1ebf50b7200040dfa" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ad65d2f34696aa6368a49768fc5c0ebf7" id = "r_ad65d2f34696aa6368a49768fc5c0ebf7" > < td class = "memItemLeft" align = "right" valign = "top" > std::vector< fourdst::atomic::Species >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#ad65d2f34696aa6368a49768fc5c0ebf7" > speciesList< / a > < / td > < / tr >
< tr class = "separator:ad65d2f34696aa6368a49768fc5c0ebf7" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a82e384a1c565caee2f23eaeccd701a58" id = "r_a82e384a1c565caee2f23eaeccd701a58" > < td class = "memItemLeft" align = "right" valign = "top" > std::string  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#a82e384a1c565caee2f23eaeccd701a58" > last_error< / a > < / td > < / tr >
< tr class = "separator:a82e384a1c565caee2f23eaeccd701a58" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table >
< h2 class = "groupheader" > Constructor & Destructor Documentation< / h2 >
< a id = "a4da09184145ea3bddef5dee206dea458" name = "a4da09184145ea3bddef5dee206dea458" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a4da09184145ea3bddef5dee206dea458" > ◆   < / a > < / span > ~GFContext()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > virtual GFContext::~GFContext < / 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" >
< / div >
< / div >
< h2 class = "groupheader" > Member Function Documentation< / h2 >
< a id = "a4aa31d479303659b475558ef2df30cbe" name = "a4aa31d479303659b475558ef2df30cbe" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a4aa31d479303659b475558ef2df30cbe" > ◆   < / a > < / span > init_composition_from_abundance_vector()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > fourdst::composition::Composition GFContext::init_composition_from_abundance_vector < / td >
< td > (< / td >
< td class = "paramtype" > const std::vector< double > & < / td > < td class = "paramname" > < span class = "paramname" > < em > abundances< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > size_t< / td > < td class = "paramname" > < span class = "paramname" > < em > num_species< / em > < / span >   ) const< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< / div >
< / div >
< a id = "a18aab1769f5e3071d768753141f15c6c" name = "a18aab1769f5e3071d768753141f15c6c" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a18aab1769f5e3071d768753141f15c6c" > ◆   < / a > < / span > init_engine_from_policy()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > void GFContext::init_engine_from_policy < / td >
< td > (< / td >
< td class = "paramtype" > const std::string & < / td > < td class = "paramname" > < span class = "paramname" > < em > policy_name< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const double *< / td > < td class = "paramname" > < span class = "paramname" > < em > abundances< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > size_t< / td > < td class = "paramname" > < span class = "paramname" > < em > num_species< / em > < / span >   )< / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel virtual" > virtual< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< / div >
< / div >
< a id = "ae1d09e19a43ddca42a1c3d360daf548e" name = "ae1d09e19a43ddca42a1c3d360daf548e" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ae1d09e19a43ddca42a1c3d360daf548e" > ◆   < / a > < / span > init_solver_from_engine()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > virtual void GFContext::init_solver_from_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 pure-virtual" > pure virtual< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Implemented in < a class = "el" href = "struct_g_f_grid_context.html#afe26323c4fb2f87c5740199c64833e70" > GFGridContext< / a > , and < a class = "el" href = "struct_g_f_point_context.html#a0fc95dc7b98865f7821ff945e809635a" > GFPointContext< / a > .< / p >
< / div >
< / div >
< a id = "ad3067d7c133f7e60849e8214fad6ed4e" name = "ad3067d7c133f7e60849e8214fad6ed4e" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ad3067d7c133f7e60849e8214fad6ed4e" > ◆   < / a > < / span > init_species_map()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > void GFContext::init_species_map < / td >
< td > (< / td >
< td class = "paramtype" > const std::vector< std::string > & < / td > < td class = "paramname" > < span class = "paramname" > < em > species_names< / em > < / span > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel virtual" > virtual< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< / div >
< / div >
< h2 class = "groupheader" > Member Data Documentation< / h2 >
< a id = "ab566b9194a7869f6b69ba7adc67d5d34" name = "ab566b9194a7869f6b69ba7adc67d5d34" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ab566b9194a7869f6b69ba7adc67d5d34" > ◆   < / a > < / span > engine< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > const < a class = "el" href = "classgridfire_1_1engine_1_1_dynamic_engine.html" > gridfire::engine::DynamicEngine< / a > * GFContext::engine< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< / div >
< / div >
< a id = "af77eab6a1ee3b0c1ebf50b7200040dfa" name = "af77eab6a1ee3b0c1ebf50b7200040dfa" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#af77eab6a1ee3b0c1ebf50b7200040dfa" > ◆   < / a > < / span > engine_ctx< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > std::unique_ptr< < a class = "el" href = "classgridfire_1_1engine_1_1scratch_1_1_state_blob.html" > gridfire::engine::scratch::StateBlob< / a > > GFContext::engine_ctx< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< / div >
< / div >
< a id = "a82e384a1c565caee2f23eaeccd701a58" name = "a82e384a1c565caee2f23eaeccd701a58" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a82e384a1c565caee2f23eaeccd701a58" > ◆   < / a > < / span > last_error< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > std::string GFContext::last_error< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< / div >
< / div >
< a id = "a6d053d819a80084fcda10cb00d06f9f8" name = "a6d053d819a80084fcda10cb00d06f9f8" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a6d053d819a80084fcda10cb00d06f9f8" > ◆   < / a > < / span > policy< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > std::unique_ptr< < a class = "el" href = "classgridfire_1_1policy_1_1_network_policy.html" > gridfire::policy::NetworkPolicy< / a > > GFContext::policy< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< / div >
< / div >
< a id = "ad65d2f34696aa6368a49768fc5c0ebf7" name = "ad65d2f34696aa6368a49768fc5c0ebf7" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ad65d2f34696aa6368a49768fc5c0ebf7" > ◆   < / a > < / span > speciesList< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > std::vector< fourdst::atomic::Species> GFContext::speciesList< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< / div >
< / div >
< hr / > The documentation for this struct was generated from the following files:< ul >
< li > src/extern/include/gridfire/extern/< a class = "el" href = "gridfire__context_8h.html" > gridfire_context.h< / a > < / li >
< li > src/extern/lib/< a class = "el" href = "gridfire__context_8cpp.html" > gridfire_context.cpp< / a > < / li >
< / 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 = "struct_g_f_context.html" > GFContext< / 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 >
