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: PyPartitionFunction 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_partition_function.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 = "#pri-methods" > Private Member Functions< / a > |
< a href = "class_py_partition_function-members.html" > List of all members< / a > < / div >
< div class = "headertitle" > < div class = "title" > PyPartitionFunction 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_partition.h> < / code > < / p >
2025-07-24 11:10:45 -04:00
< div class = "dynheader" >
Inheritance diagram for PyPartitionFunction:< / div >
< div class = "dyncontent" >
< div class = "center" >
< img src = "class_py_partition_function.png" usemap = "#PyPartitionFunction_map" alt = "" / >
< map id = "PyPartitionFunction_map" name = "PyPartitionFunction_map" >
< area href = "classgridfire_1_1partition_1_1_partition_function.html" title = "Abstract interface for evaluating nuclear partition functions." alt = "gridfire::partition::PartitionFunction" shape = "rect" coords = "0,0,205,24" / >
< / map >
< / div > < / div >
< table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a id = "pri-methods" name = "pri-methods" > < / a >
Private Member Functions< / h2 > < / td > < / tr >
< tr class = "memitem:a83aca0bc261734b7d3df8269f730c69b" id = "r_a83aca0bc261734b7d3df8269f730c69b" > < td class = "memItemLeft" align = "right" valign = "top" > double  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#a83aca0bc261734b7d3df8269f730c69b" > evaluate< / a > (int z, int a, double T9) const override< / td > < / tr >
< tr class = "memdesc:a83aca0bc261734b7d3df8269f730c69b" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Evaluate the partition function for a given isotope. < br / > < / td > < / tr >
< tr class = "separator:a83aca0bc261734b7d3df8269f730c69b" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a260df9689bf698970ebf5104977a3dcf" id = "r_a260df9689bf698970ebf5104977a3dcf" > < td class = "memItemLeft" align = "right" valign = "top" > double  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#a260df9689bf698970ebf5104977a3dcf" > evaluateDerivative< / a > (int z, int a, double T9) const override< / td > < / tr >
< tr class = "memdesc:a260df9689bf698970ebf5104977a3dcf" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Evaluate the temperature derivative of the partition function. < br / > < / td > < / tr >
< tr class = "separator:a260df9689bf698970ebf5104977a3dcf" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a0f288a01a3ed7fb92fff5d9fd7d56aa8" id = "r_a0f288a01a3ed7fb92fff5d9fd7d56aa8" > < td class = "memItemLeft" align = "right" valign = "top" > bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#a0f288a01a3ed7fb92fff5d9fd7d56aa8" > supports< / a > (int z, int a) const override< / td > < / tr >
< tr class = "memdesc:a0f288a01a3ed7fb92fff5d9fd7d56aa8" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Check if this partition function supports an isotope. < br / > < / td > < / tr >
< tr class = "separator:a0f288a01a3ed7fb92fff5d9fd7d56aa8" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a07f4d0ff83822dd2800897161d2a3717" id = "r_a07f4d0ff83822dd2800897161d2a3717" > < td class = "memItemLeft" align = "right" valign = "top" > std::string  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#a07f4d0ff83822dd2800897161d2a3717" > type< / a > () const override< / td > < / tr >
< tr class = "memdesc:a07f4d0ff83822dd2800897161d2a3717" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Get the human-readable type of this partition function. < br / > < / td > < / tr >
< tr class = "separator:a07f4d0ff83822dd2800897161d2a3717" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:af918b357e38fb82499ad53584557c43d" id = "r_af918b357e38fb82499ad53584557c43d" > < td class = "memItemLeft" align = "right" valign = "top" > std::unique_ptr< < a class = "el" href = "classgridfire_1_1partition_1_1_partition_function.html" > gridfire::partition::PartitionFunction< / a > >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#af918b357e38fb82499ad53584557c43d" > clone< / a > () const override< / td > < / tr >
< tr class = "memdesc:af918b357e38fb82499ad53584557c43d" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Create a deep copy of this PartitionFunction. < br / > < / td > < / tr >
< tr class = "separator:af918b357e38fb82499ad53584557c43d" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table > < table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a id = "inherited" name = "inherited" > < / a >
Additional Inherited Members< / h2 > < / td > < / tr >
< tr class = "inherit_header pub_methods_classgridfire_1_1partition_1_1_partition_function" > < td colspan = "2" onclick = "javascript:dynsection.toggleInherit('pub_methods_classgridfire_1_1partition_1_1_partition_function')" > < img src = "closed.png" alt = "-" / >   Public Member Functions inherited from < a class = "el" href = "classgridfire_1_1partition_1_1_partition_function.html" > gridfire::partition::PartitionFunction< / a > < / td > < / tr >
< tr class = "memitem:a197a0663dcfb4ab4be3b0e14b98391db inherit pub_methods_classgridfire_1_1partition_1_1_partition_function" id = "r_a197a0663dcfb4ab4be3b0e14b98391db" > < td class = "memItemLeft" align = "right" valign = "top" > virtual  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classgridfire_1_1partition_1_1_partition_function.html#a197a0663dcfb4ab4be3b0e14b98391db" > ~PartitionFunction< / a > ()=default< / td > < / tr >
< tr class = "memdesc:a197a0663dcfb4ab4be3b0e14b98391db inherit pub_methods_classgridfire_1_1partition_1_1_partition_function" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Virtual destructor. < br / > < / td > < / tr >
< tr class = "separator:a197a0663dcfb4ab4be3b0e14b98391db inherit pub_methods_classgridfire_1_1partition_1_1_partition_function" > < 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 = "af918b357e38fb82499ad53584557c43d" name = "af918b357e38fb82499ad53584557c43d" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#af918b357e38fb82499ad53584557c43d" > ◆   < / a > < / span > clone()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > std::unique_ptr< < a class = "el" href = "classgridfire_1_1partition_1_1_partition_function.html" > gridfire::partition::PartitionFunction< / a > > PyPartitionFunction::clone < / 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 private" > private< / span > < span class = "mlabel virtual" > virtual< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Create a deep copy of this PartitionFunction. < / p >
< dl class = "section return" > < dt > Returns< / dt > < dd > Unique pointer to a new PartitionFunction instance with identical state. < / dd > < / dl >
< dl class = "section post" > < dt > Postcondition< / dt > < dd > The caller owns the returned object and must manage its lifetime. < / dd > < / dl >
< p > Implements < a class = "el" href = "classgridfire_1_1partition_1_1_partition_function.html#a677a90f992fd56b8718e36655c33ce6d" > gridfire::partition::PartitionFunction< / a > .< / p >
< / div >
< / div >
< a id = "a83aca0bc261734b7d3df8269f730c69b" name = "a83aca0bc261734b7d3df8269f730c69b" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a83aca0bc261734b7d3df8269f730c69b" > ◆   < / a > < / span > evaluate()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > double PyPartitionFunction::evaluate < / td >
< td > (< / td >
< td class = "paramtype" > int< / td > < td class = "paramname" > < span class = "paramname" > < em > z< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > int< / td > < td class = "paramname" > < span class = "paramname" > < em > a< / 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 >   ) const< / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel override" > override< / span > < span class = "mlabel private" > private< / span > < span class = "mlabel virtual" > virtual< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Evaluate the partition function for a given isotope. < / p >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > z< / td > < td > Proton number (atomic number) of the isotope; must be > = 1. < / td > < / tr >
< tr > < td class = "paramname" > a< / td > < td > Mass number of the isotope; must be > = z. < / td > < / tr >
< tr > < td class = "paramname" > T9< / td > < td > Temperature in units of 10^9 K; must be > 0. < / td > < / tr >
< / table >
< / dd >
< / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > Partition function value (dimensionless) at the specified temperature. < / dd > < / dl >
< dl class = "section pre" > < dt > Precondition< / dt > < dd > Derived implementation supports (z, a) and T9 > 0. < / dd > < / dl >
< dl class = "section post" > < dt > Postcondition< / dt > < dd > No side effects; pure function. < / dd > < / dl >
< p > Implements < a class = "el" href = "classgridfire_1_1partition_1_1_partition_function.html#a08ee79b7d8723b4e00ee1fc9cdfbe817" > gridfire::partition::PartitionFunction< / a > .< / p >
< / div >
< / div >
< a id = "a260df9689bf698970ebf5104977a3dcf" name = "a260df9689bf698970ebf5104977a3dcf" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a260df9689bf698970ebf5104977a3dcf" > ◆   < / a > < / span > evaluateDerivative()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > double PyPartitionFunction::evaluateDerivative < / td >
< td > (< / td >
< td class = "paramtype" > int< / td > < td class = "paramname" > < span class = "paramname" > < em > z< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > int< / td > < td class = "paramname" > < span class = "paramname" > < em > a< / 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 >   ) const< / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel override" > override< / span > < span class = "mlabel private" > private< / span > < span class = "mlabel virtual" > virtual< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Evaluate the temperature derivative of the partition function. < / p >
< p > Computes d/dT (partition function) at the given parameters.< / p >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > z< / td > < td > Proton number (atomic number) of the isotope; must be > = 1. < / td > < / tr >
< tr > < td class = "paramname" > a< / td > < td > Mass number of the isotope; must be > = z. < / td > < / tr >
< tr > < td class = "paramname" > T9< / td > < td > Temperature in units of 10^9 K; must be > 0. < / td > < / tr >
< / table >
< / dd >
< / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > Temperature derivative of the partition function. < / dd > < / dl >
< dl class = "section pre" > < dt > Precondition< / dt > < dd > Derived implementation supports (z, a) and T9 > 0. < / dd > < / dl >
< dl class = "section post" > < dt > Postcondition< / dt > < dd > No side effects; pure function. < / dd > < / dl >
< p > Implements < a class = "el" href = "classgridfire_1_1partition_1_1_partition_function.html#a14009bdaca47f3eddf2c6c023845db5a" > gridfire::partition::PartitionFunction< / a > .< / p >
< / div >
< / div >
< a id = "a0f288a01a3ed7fb92fff5d9fd7d56aa8" name = "a0f288a01a3ed7fb92fff5d9fd7d56aa8" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a0f288a01a3ed7fb92fff5d9fd7d56aa8" > ◆   < / a > < / span > supports()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > bool PyPartitionFunction::supports < / td >
< td > (< / td >
< td class = "paramtype" > int< / td > < td class = "paramname" > < span class = "paramname" > < em > z< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > int< / td > < td class = "paramname" > < span class = "paramname" > < em > a< / em > < / span >   ) const< / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel override" > override< / span > < span class = "mlabel private" > private< / span > < span class = "mlabel virtual" > virtual< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Check if this partition function supports an isotope. < / p >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > z< / td > < td > Proton number of the isotope. < / td > < / tr >
< tr > < td class = "paramname" > a< / td > < td > Mass number of the isotope. < / td > < / tr >
< / table >
< / dd >
< / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > true if evaluate and evaluateDerivative can be called for this isotope; false otherwise. < / dd > < / dl >
< dl class = "section post" > < dt > Postcondition< / dt > < dd > No side effects. < / dd > < / dl >
< p > Implements < a class = "el" href = "classgridfire_1_1partition_1_1_partition_function.html#a6df4191d10516477371a0384e1e55bf5" > gridfire::partition::PartitionFunction< / a > .< / p >
< / div >
< / div >
< a id = "a07f4d0ff83822dd2800897161d2a3717" name = "a07f4d0ff83822dd2800897161d2a3717" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a07f4d0ff83822dd2800897161d2a3717" > ◆   < / a > < / span > type()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > std::string PyPartitionFunction::type < / 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 private" > private< / span > < span class = "mlabel virtual" > virtual< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Get the human-readable type of this partition function. < / p >
< dl class = "section return" > < dt > Returns< / dt > < dd > String identifier for the partition function implementation. < / dd > < / dl >
< dl class = "section post" > < dt > Postcondition< / dt > < dd > No side effects. < / dd > < / dl >
< p > Implements < a class = "el" href = "classgridfire_1_1partition_1_1_partition_function.html#ab0c67985a972707eac0ebc64417dfb97" > gridfire::partition::PartitionFunction< / a > .< / p >
< / 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/partition/trampoline/< a class = "el" href = "py__partition_8h.html" > py_partition.h< / a > < / li >
< li > src/python/partition/trampoline/< a class = "el" href = "py__partition_8cpp.html" > py_partition.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_partition_function.html" > PyPartitionFunction< / 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 >
