Files
GridFire/docs/html/partition__abstract_8h_source.html

148 lines
13 KiB
HTML
Raw Normal View History

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/include/gridfire/partition/partition_abstract.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('partition__abstract_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">partition_abstract.h</div></div>
</div><!--header-->
<div class="contents">
<a href="partition__abstract_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;string&gt;</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &lt;memory&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="keyword">namespace </span><a class="code hl_namespace" href="namespacegridfire_1_1partition.html">gridfire::partition</a> {</div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span></div>
<div class="foldopen" id="foldopen00017" data-start="{" data-end="};">
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="classgridfire_1_1partition_1_1_partition_function.html"> 17</a></span> <span class="keyword">class </span><a class="code hl_class" href="classgridfire_1_1partition_1_1_partition_function.html">PartitionFunction</a> {</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"><a class="line" href="classgridfire_1_1partition_1_1_partition_function.html#a197a0663dcfb4ab4be3b0e14b98391db"> 24</a></span> <span class="keyword">virtual</span> <a class="code hl_function" href="classgridfire_1_1partition_1_1_partition_function.html#a197a0663dcfb4ab4be3b0e14b98391db">~PartitionFunction</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"><a class="line" href="classgridfire_1_1partition_1_1_partition_function.html#a08ee79b7d8723b4e00ee1fc9cdfbe817"> 36</a></span> [[nodiscard]] <span class="keyword">virtual</span> <span class="keywordtype">double</span> <a class="code hl_function" href="classgridfire_1_1partition_1_1_partition_function.html#a08ee79b7d8723b4e00ee1fc9cdfbe817">evaluate</a>(<span class="keywordtype">int</span> z, <span class="keywordtype">int</span> a, <span class="keywordtype">double</span> T9) <span class="keyword">const</span> = 0;</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="classgridfire_1_1partition_1_1_partition_function.html#a14009bdaca47f3eddf2c6c023845db5a"> 50</a></span> [[nodiscard]] <span class="keyword">virtual</span> <span class="keywordtype">double</span> <a class="code hl_function" href="classgridfire_1_1partition_1_1_partition_function.html#a14009bdaca47f3eddf2c6c023845db5a">evaluateDerivative</a>(<span class="keywordtype">int</span> z, <span class="keywordtype">int</span> a, <span class="keywordtype">double</span> T9) <span class="keyword">const</span> = 0;</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"><a class="line" href="classgridfire_1_1partition_1_1_partition_function.html#a6df4191d10516477371a0384e1e55bf5"> 60</a></span> [[nodiscard]] <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classgridfire_1_1partition_1_1_partition_function.html#a6df4191d10516477371a0384e1e55bf5">supports</a>(<span class="keywordtype">int</span> z, <span class="keywordtype">int</span> a) <span class="keyword">const</span> = 0;</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"><a class="line" href="classgridfire_1_1partition_1_1_partition_function.html#ab0c67985a972707eac0ebc64417dfb97"> 68</a></span> [[nodiscard]] <span class="keyword">virtual</span> std::string <a class="code hl_function" href="classgridfire_1_1partition_1_1_partition_function.html#ab0c67985a972707eac0ebc64417dfb97">type</a>() <span class="keyword">const</span> = 0;</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"><a class="line" href="classgridfire_1_1partition_1_1_partition_function.html#a677a90f992fd56b8718e36655c33ce6d"> 76</a></span> [[nodiscard]] <span class="keyword">virtual</span> std::unique_ptr&lt;PartitionFunction&gt; <a class="code hl_function" href="classgridfire_1_1partition_1_1_partition_function.html#a677a90f992fd56b8718e36655c33ce6d">clone</a>() <span class="keyword">const</span> = 0;</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> };</div>
</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span>}</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="#l00017">partition_abstract.h:17</a></div></div>
<div class="ttc" id="aclassgridfire_1_1partition_1_1_partition_function_html_a08ee79b7d8723b4e00ee1fc9cdfbe817"><div class="ttname"><a href="classgridfire_1_1partition_1_1_partition_function.html#a08ee79b7d8723b4e00ee1fc9cdfbe817">gridfire::partition::PartitionFunction::evaluate</a></div><div class="ttdeci">virtual double evaluate(int z, int a, double T9) const =0</div><div class="ttdoc">Evaluate the partition function for a given isotope.</div></div>
<div class="ttc" id="aclassgridfire_1_1partition_1_1_partition_function_html_a14009bdaca47f3eddf2c6c023845db5a"><div class="ttname"><a href="classgridfire_1_1partition_1_1_partition_function.html#a14009bdaca47f3eddf2c6c023845db5a">gridfire::partition::PartitionFunction::evaluateDerivative</a></div><div class="ttdeci">virtual double evaluateDerivative(int z, int a, double T9) const =0</div><div class="ttdoc">Evaluate the temperature derivative of the partition function.</div></div>
<div class="ttc" id="aclassgridfire_1_1partition_1_1_partition_function_html_a197a0663dcfb4ab4be3b0e14b98391db"><div class="ttname"><a href="classgridfire_1_1partition_1_1_partition_function.html#a197a0663dcfb4ab4be3b0e14b98391db">gridfire::partition::PartitionFunction::~PartitionFunction</a></div><div class="ttdeci">virtual ~PartitionFunction()=default</div><div class="ttdoc">Virtual destructor.</div></div>
<div class="ttc" id="aclassgridfire_1_1partition_1_1_partition_function_html_a677a90f992fd56b8718e36655c33ce6d"><div class="ttname"><a href="classgridfire_1_1partition_1_1_partition_function.html#a677a90f992fd56b8718e36655c33ce6d">gridfire::partition::PartitionFunction::clone</a></div><div class="ttdeci">virtual std::unique_ptr&lt; PartitionFunction &gt; clone() const =0</div><div class="ttdoc">Create a deep copy of this PartitionFunction.</div></div>
<div class="ttc" id="aclassgridfire_1_1partition_1_1_partition_function_html_a6df4191d10516477371a0384e1e55bf5"><div class="ttname"><a href="classgridfire_1_1partition_1_1_partition_function.html#a6df4191d10516477371a0384e1e55bf5">gridfire::partition::PartitionFunction::supports</a></div><div class="ttdeci">virtual bool supports(int z, int a) const =0</div><div class="ttdoc">Check if this partition function supports an isotope.</div></div>
<div class="ttc" id="aclassgridfire_1_1partition_1_1_partition_function_html_ab0c67985a972707eac0ebc64417dfb97"><div class="ttname"><a href="classgridfire_1_1partition_1_1_partition_function.html#ab0c67985a972707eac0ebc64417dfb97">gridfire::partition::PartitionFunction::type</a></div><div class="ttdeci">virtual std::string type() const =0</div><div class="ttdoc">Get the human-readable type of this partition function.</div></div>
<div class="ttc" id="anamespacegridfire_1_1partition_html"><div class="ttname"><a href="namespacegridfire_1_1partition.html">gridfire::partition</a></div><div class="ttdef"><b>Definition</b> <a href="partition__composite_8h_source.html#l00015">partition_composite.h:15</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_b0856f6b0d80ccb263b2f415c91f9e17.html">include</a></li><li class="navelem"><a class="el" href="dir_3626e0c0e3c5d7812d6b277dfa4ec364.html">gridfire</a></li><li class="navelem"><a class="el" href="dir_1d1d50ce0d70b163d7d102a960190628.html">partition</a></li><li class="navelem"><a class="el" href="partition__abstract_8h.html">partition_abstract.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>