2025-11-24 09:08:28 -05: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::StepDerivatives< T > Struct Template 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-27 15:06:27 -05:00
< div id = "projectname" > GridFire< span id = "projectnumber" >   v0.7.0_rc2< / span >
2025-11-24 09:08:28 -05: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('structgridfire_1_1engine_1_1_step_derivatives.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 = "structgridfire_1_1engine_1_1_step_derivatives-members.html" > List of all members< / a > < / div >
< div class = "headertitle" > < div class = "title" > gridfire::engine::StepDerivatives< T > Struct Template Reference< / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< p > Structure holding derivatives and energy generation for a network step.
< a href = "#details" > More...< / a > < / p >
< p > < code > #include < engine_abstract.h> < / code > < / p >
< div class = "dynheader" >
Collaboration diagram for gridfire::engine::StepDerivatives< T > :< / div >
< div class = "dyncontent" >
2025-11-27 15:06:27 -05:00
< div class = "center" > < div class = "zoom" > < iframe scrolling = "no" frameborder = "0" src = "structgridfire_1_1engine_1_1_step_derivatives__coll__graph.svg" width = "100%" height = "455" > < p > < b > This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.< / b > < / p > < / iframe > < / div > < / div >
2025-11-24 09:08:28 -05:00
< 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:ab6f82eeaf31cdb66fb40267838b19a34" id = "r_ab6f82eeaf31cdb66fb40267838b19a34" > < td class = "memItemLeft" align = "right" valign = "top" >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#ab6f82eeaf31cdb66fb40267838b19a34" > StepDerivatives< / a > ()< / td > < / tr >
< tr class = "separator:ab6f82eeaf31cdb66fb40267838b19a34" > < 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:aad90bec88a31fce600c60c29835410b1" id = "r_aad90bec88a31fce600c60c29835410b1" > < td class = "memItemLeft" align = "right" valign = "top" > std::map< fourdst::atomic::Species, T >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#aad90bec88a31fce600c60c29835410b1" > dydt< / a > {}< / td > < / tr >
< tr class = "memdesc:aad90bec88a31fce600c60c29835410b1" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Derivatives of abundances (dY/dt for each species). < br / > < / td > < / tr >
< tr class = "separator:aad90bec88a31fce600c60c29835410b1" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ab00be76673548db59c4097f19dc8be93" id = "r_ab00be76673548db59c4097f19dc8be93" > < td class = "memItemLeft" align = "right" valign = "top" > T  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#ab00be76673548db59c4097f19dc8be93" > nuclearEnergyGenerationRate< / a > = T(0.0)< / td > < / tr >
< tr class = "memdesc:ab00be76673548db59c4097f19dc8be93" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Specific energy generation rate (e.g., erg/g/s). < br / > < / td > < / tr >
< tr class = "separator:ab00be76673548db59c4097f19dc8be93" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ac269799f25d23045bf60dd27376d4337" id = "r_ac269799f25d23045bf60dd27376d4337" > < td class = "memItemLeft" align = "right" valign = "top" > std::map< fourdst::atomic::Species, std::unordered_map< std::string, T > >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#ac269799f25d23045bf60dd27376d4337" > reactionContributions< / a > {}< / td > < / tr >
< tr class = "separator:ac269799f25d23045bf60dd27376d4337" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2025-11-27 15:06:27 -05:00
< tr class = "memitem:a5e1ac820ff9682d74474c31b235b2848" id = "r_a5e1ac820ff9682d74474c31b235b2848" > < td class = "memItemLeft" align = "right" valign = "top" > T  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#a5e1ac820ff9682d74474c31b235b2848" > neutrinoEnergyLossRate< / a > = T(0.0)< / td > < / tr >
< tr class = "separator:a5e1ac820ff9682d74474c31b235b2848" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a97a3fe3cf9178044bcb57e371063a820" id = "r_a97a3fe3cf9178044bcb57e371063a820" > < td class = "memItemLeft" align = "right" valign = "top" > T  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#a97a3fe3cf9178044bcb57e371063a820" > totalNeutrinoFlux< / a > = T(0.0)< / td > < / tr >
< tr class = "separator:a97a3fe3cf9178044bcb57e371063a820" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2025-11-24 09:08:28 -05:00
< / table >
< a name = "details" id = "details" > < / a > < h2 class = "groupheader" > Detailed Description< / h2 >
< div class = "textblock" > < div class = "compoundTemplParams" > template< IsArithmeticOrAD T> < br / >
struct gridfire::engine::StepDerivatives< T > < / div > < p > Structure holding derivatives and energy generation for a network step. < / p >
< dl class = "tparams" > < dt > Template Parameters< / dt > < dd >
< table class = "tparams" >
< tr > < td class = "paramname" > T< / td > < td > Numeric type (double or CppAD::AD< double> ).< / td > < / tr >
< / table >
< / dd >
< / dl >
< p > This struct is used to return both the time derivatives of all species abundances and the specific nuclear energy generation rate for a single network evaluation.< / p >
< p > Example usage: < / p > < div class = "fragment" > < div class = "line" > < a class = "code hl_function" href = "#ab6f82eeaf31cdb66fb40267838b19a34" > StepDerivatives< double> < / a > result = < a class = "code hl_namespace" href = "namespacegridfire_1_1engine.html" > engine< / a > .calculateRHSAndEnergy(Y, T9, rho);< / div >
< div class = "line" > < span class = "keywordflow" > for< / span > (< span class = "keywordtype" > double< / span > dydt_i : result.< a class = "code hl_variable" href = "#aad90bec88a31fce600c60c29835410b1" > dydt< / a > ) {< / div >
< div class = "line" > < span class = "comment" > // Use derivative< / span > < / div >
< div class = "line" > }< / div >
< div class = "line" > < span class = "keywordtype" > double< / span > energyRate = result.< a class = "code hl_variable" href = "#ab00be76673548db59c4097f19dc8be93" > nuclearEnergyGenerationRate< / a > ;< / div >
< div class = "ttc" id = "anamespacegridfire_1_1engine_html" > < div class = "ttname" > < a href = "namespacegridfire_1_1engine.html" > gridfire::engine< / a > < / div > < div class = "ttdef" > < b > Definition< / b > dynamic_engine_diagnostics.h:38< / div > < / div >
< div class = "ttc" id = "astructgridfire_1_1engine_1_1_step_derivatives_html_aad90bec88a31fce600c60c29835410b1" > < div class = "ttname" > < a href = "#aad90bec88a31fce600c60c29835410b1" > gridfire::engine::StepDerivatives::dydt< / a > < / div > < div class = "ttdeci" > std::map< fourdst::atomic::Species, T > dydt< / div > < div class = "ttdoc" > Derivatives of abundances (dY/dt for each species).< / div > < div class = "ttdef" > < b > Definition< / b > engine_abstract.h:54< / div > < / div >
< div class = "ttc" id = "astructgridfire_1_1engine_1_1_step_derivatives_html_ab00be76673548db59c4097f19dc8be93" > < div class = "ttname" > < a href = "#ab00be76673548db59c4097f19dc8be93" > gridfire::engine::StepDerivatives::nuclearEnergyGenerationRate< / a > < / div > < div class = "ttdeci" > T nuclearEnergyGenerationRate< / div > < div class = "ttdoc" > Specific energy generation rate (e.g., erg/g/s).< / div > < div class = "ttdef" > < b > Definition< / b > engine_abstract.h:55< / div > < / div >
2025-11-27 15:06:27 -05:00
< div class = "ttc" id = "astructgridfire_1_1engine_1_1_step_derivatives_html_ab6f82eeaf31cdb66fb40267838b19a34" > < div class = "ttname" > < a href = "#ab6f82eeaf31cdb66fb40267838b19a34" > gridfire::engine::StepDerivatives::StepDerivatives< / a > < / div > < div class = "ttdeci" > StepDerivatives()< / div > < div class = "ttdef" > < b > Definition< / b > engine_abstract.h:61< / div > < / div >
2025-11-24 09:08:28 -05:00
< / div > <!-- fragment --> < / div > < h2 class = "groupheader" > Constructor & Destructor Documentation< / h2 >
< a id = "ab6f82eeaf31cdb66fb40267838b19a34" name = "ab6f82eeaf31cdb66fb40267838b19a34" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ab6f82eeaf31cdb66fb40267838b19a34" > ◆   < / a > < / span > StepDerivatives()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< div class = "memtemplate" >
template< IsArithmeticOrAD T> < / div >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > < a class = "el" href = "structgridfire_1_1engine_1_1_step_derivatives.html" > gridfire::engine::StepDerivatives< / a > < T > ::StepDerivatives < / 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 inline" > inline< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< / div >
< / div >
< h2 class = "groupheader" > Member Data Documentation< / h2 >
< a id = "aad90bec88a31fce600c60c29835410b1" name = "aad90bec88a31fce600c60c29835410b1" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#aad90bec88a31fce600c60c29835410b1" > ◆   < / a > < / span > dydt< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< div class = "memtemplate" >
template< IsArithmeticOrAD T> < / div >
< table class = "memname" >
< tr >
< td class = "memname" > std::map< fourdst::atomic::Species, T> < a class = "el" href = "structgridfire_1_1engine_1_1_step_derivatives.html" > gridfire::engine::StepDerivatives< / a > < T > ::dydt {}< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Derivatives of abundances (dY/dt for each species). < / p >
2025-11-27 15:06:27 -05:00
< / div >
< / div >
< a id = "a5e1ac820ff9682d74474c31b235b2848" name = "a5e1ac820ff9682d74474c31b235b2848" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a5e1ac820ff9682d74474c31b235b2848" > ◆   < / a > < / span > neutrinoEnergyLossRate< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< div class = "memtemplate" >
template< IsArithmeticOrAD T> < / div >
< table class = "memname" >
< tr >
< td class = "memname" > T < a class = "el" href = "structgridfire_1_1engine_1_1_step_derivatives.html" > gridfire::engine::StepDerivatives< / a > < T > ::neutrinoEnergyLossRate = T(0.0)< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
2025-11-24 09:08:28 -05:00
< / div >
< / div >
< a id = "ab00be76673548db59c4097f19dc8be93" name = "ab00be76673548db59c4097f19dc8be93" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ab00be76673548db59c4097f19dc8be93" > ◆   < / a > < / span > nuclearEnergyGenerationRate< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< div class = "memtemplate" >
template< IsArithmeticOrAD T> < / div >
< table class = "memname" >
< tr >
< td class = "memname" > T < a class = "el" href = "structgridfire_1_1engine_1_1_step_derivatives.html" > gridfire::engine::StepDerivatives< / a > < T > ::nuclearEnergyGenerationRate = T(0.0)< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Specific energy generation rate (e.g., erg/g/s). < / p >
< / div >
< / div >
< a id = "ac269799f25d23045bf60dd27376d4337" name = "ac269799f25d23045bf60dd27376d4337" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ac269799f25d23045bf60dd27376d4337" > ◆   < / a > < / span > reactionContributions< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< div class = "memtemplate" >
template< IsArithmeticOrAD T> < / div >
< table class = "memname" >
< tr >
< td class = "memname" > std::map< fourdst::atomic::Species, std::unordered_map< std::string, T> > < a class = "el" href = "structgridfire_1_1engine_1_1_step_derivatives.html" > gridfire::engine::StepDerivatives< / a > < T > ::reactionContributions {}< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
2025-11-27 15:06:27 -05:00
< / div >
< / div >
< a id = "a97a3fe3cf9178044bcb57e371063a820" name = "a97a3fe3cf9178044bcb57e371063a820" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a97a3fe3cf9178044bcb57e371063a820" > ◆   < / a > < / span > totalNeutrinoFlux< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< div class = "memtemplate" >
template< IsArithmeticOrAD T> < / div >
< table class = "memname" >
< tr >
< td class = "memname" > T < a class = "el" href = "structgridfire_1_1engine_1_1_step_derivatives.html" > gridfire::engine::StepDerivatives< / a > < T > ::totalNeutrinoFlux = T(0.0)< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
2025-11-24 09:08:28 -05:00
< / div >
< / div >
< hr / > The documentation for this struct was generated from the following file:< ul >
< li > src/include/gridfire/engine/< a class = "el" href = "engine__abstract_8h.html" > engine_abstract.h< / 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 = "namespacegridfire.html" > gridfire< / a > < / li > < li class = "navelem" > < a class = "el" href = "namespacegridfire_1_1engine.html" > engine< / a > < / li > < li class = "navelem" > < a class = "el" href = "structgridfire_1_1engine_1_1_step_derivatives.html" > StepDerivatives< / 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 >
