tboudreaux/GridFire
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
perf/openMP
GridFire/docs/html/py__partition_8h_source.html

141 lines
12 KiB
HTML
Raw Permalink Normal View History

docs(docs): asdded and cleaned up docs
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: src/python/partition/trampoline/py_partition.h Source File</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">
<div id="projectname">GridFire<span id="projectnumber">&#160;0.0.1a</span>
</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&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;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&amp;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&amp;dn=expat.txt MIT */
$(function(){initNavTree('py__partition_8h_source.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="headertitle"><div class="title">py_partition.h</div></div>
</div><!--header-->
<div class="contents">
<a href="py__partition_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span> </div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#include &lt;pybind11/pybind11.h&gt;</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &lt;pybind11/stl.h&gt;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> </div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include &quot;<a class="code" href="partition_8h.html">gridfire/partition/partition.h</a>&quot;</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
<div class="foldopen" id="foldopen00009" data-start="{" data-end="};">
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"><a class="line" href="class_py_partition_function.html"> 9</a></span><span class="keyword">class </span><a class="code hl_class" href="class_py_partition_function.html">PyPartitionFunction</a> final : <span class="keyword">public</span> <a class="code hl_class" href="classgridfire_1_1partition_1_1_partition_function.html">gridfire::partition::PartitionFunction</a> {</div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> <span class="keywordtype">double</span> <a class="code hl_function" href="class_py_partition_function.html#a83aca0bc261734b7d3df8269f730c69b">evaluate</a>(<span class="keywordtype">int</span> z, <span class="keywordtype">int</span> a, <span class="keywordtype">double</span> T9) <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> <span class="keywordtype">double</span> <a class="code hl_function" href="class_py_partition_function.html#a260df9689bf698970ebf5104977a3dcf">evaluateDerivative</a>(<span class="keywordtype">int</span> z, <span class="keywordtype">int</span> a, <span class="keywordtype">double</span> T9) <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_py_partition_function.html#a0f288a01a3ed7fb92fff5d9fd7d56aa8">supports</a>(<span class="keywordtype">int</span> z, <span class="keywordtype">int</span> a) <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> std::string <a class="code hl_function" href="class_py_partition_function.html#a07f4d0ff83822dd2800897161d2a3717">type</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> std::unique_ptr&lt;gridfire::partition::PartitionFunction&gt; <a class="code hl_function" href="class_py_partition_function.html#af918b357e38fb82499ad53584557c43d">clone</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span>};</div>
</div>
<div class="ttc" id="aclass_py_partition_function_html"><div class="ttname"><a href="class_py_partition_function.html">PyPartitionFunction</a></div><div class="ttdef"><b>Definition</b> <a href="#l00009">py_partition.h:9</a></div></div>
<div class="ttc" id="aclass_py_partition_function_html_a07f4d0ff83822dd2800897161d2a3717"><div class="ttname"><a href="class_py_partition_function.html#a07f4d0ff83822dd2800897161d2a3717">PyPartitionFunction::type</a></div><div class="ttdeci">std::string type() const override</div><div class="ttdoc">Get the human-readable type of this partition function.</div><div class="ttdef"><b>Definition</b> <a href="py__partition_8cpp_source.html#l00042">py_partition.cpp:42</a></div></div>
<div class="ttc" id="aclass_py_partition_function_html_a0f288a01a3ed7fb92fff5d9fd7d56aa8"><div class="ttname"><a href="class_py_partition_function.html#a0f288a01a3ed7fb92fff5d9fd7d56aa8">PyPartitionFunction::supports</a></div><div class="ttdeci">bool supports(int z, int a) const override</div><div class="ttdoc">Check if this partition function supports an isotope.</div><div class="ttdef"><b>Definition</b> <a href="py__partition_8cpp_source.html#l00033">py_partition.cpp:33</a></div></div>
<div class="ttc" id="aclass_py_partition_function_html_a260df9689bf698970ebf5104977a3dcf"><div class="ttname"><a href="class_py_partition_function.html#a260df9689bf698970ebf5104977a3dcf">PyPartitionFunction::evaluateDerivative</a></div><div class="ttdeci">double evaluateDerivative(int z, int a, double T9) const override</div><div class="ttdoc">Evaluate the temperature derivative of the partition function.</div><div class="ttdef"><b>Definition</b> <a href="py__partition_8cpp_source.html#l00024">py_partition.cpp:24</a></div></div>
<div class="ttc" id="aclass_py_partition_function_html_a83aca0bc261734b7d3df8269f730c69b"><div class="ttname"><a href="class_py_partition_function.html#a83aca0bc261734b7d3df8269f730c69b">PyPartitionFunction::evaluate</a></div><div class="ttdeci">double evaluate(int z, int a, double T9) const override</div><div class="ttdoc">Evaluate the partition function for a given isotope.</div><div class="ttdef"><b>Definition</b> <a href="py__partition_8cpp_source.html#l00015">py_partition.cpp:15</a></div></div>
<div class="ttc" id="aclass_py_partition_function_html_af918b357e38fb82499ad53584557c43d"><div class="ttname"><a href="class_py_partition_function.html#af918b357e38fb82499ad53584557c43d">PyPartitionFunction::clone</a></div><div class="ttdeci">std::unique_ptr&lt; gridfire::partition::PartitionFunction &gt; clone() const override</div><div class="ttdoc">Create a deep copy of this PartitionFunction.</div><div class="ttdef"><b>Definition</b> <a href="py__partition_8cpp_source.html#l00050">py_partition.cpp:50</a></div></div>
<div class="ttc" id="aclassgridfire_1_1partition_1_1_partition_function_html"><div class="ttname"><a href="classgridfire_1_1partition_1_1_partition_function.html">gridfire::partition::PartitionFunction</a></div><div class="ttdoc">Abstract interface for evaluating nuclear partition functions.</div><div class="ttdef"><b>Definition</b> <a href="partition__abstract_8h_source.html#l00017">partition_abstract.h:17</a></div></div>
<div class="ttc" id="apartition_8h_html"><div class="ttname"><a href="partition_8h.html">partition.h</a></div></div>
</div><!-- fragment --></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="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_5c0d64f70903e893b1efe571a4b8de29.html">python</a></li><li class="navelem"><a class="el" href="dir_7eae81c2ec58ffa76af06bb25bb86137.html">partition</a></li><li class="navelem"><a class="el" href="dir_97105ebeaecd797c90bf23079fd9b0e6.html">trampoline</a></li><li class="navelem"><a class="el" href="py__partition_8h.html">py_partition.h</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>
Reference in New Issue Copy Permalink