546 lines
27 KiB
HTML
546 lines
27 KiB
HTML
<!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.9.8"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>GridFire: gridfire::partition::GroundStatePartitionFunction 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>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.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"> v0.7.1_rc2</span>
|
|
</div>
|
|
<div id="projectbrief">General Purpose Nuclear Network</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.8 -->
|
|
<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" 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');
|
|
$(document).ready(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 */
|
|
$(document).ready(function(){initNavTree('classgridfire_1_1partition_1_1GroundStatePartitionFunction.html',''); initResizable(); });
|
|
/* @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="#pri-static-methods">Static Private Member Functions</a> |
|
|
<a href="#pri-attribs">Private Attributes</a> |
|
|
<a href="classgridfire_1_1partition_1_1GroundStatePartitionFunction-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">gridfire::partition::GroundStatePartitionFunction Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Partition function implementation for nuclear ground states.
|
|
<a href="classgridfire_1_1partition_1_1GroundStatePartitionFunction.html#details">More...</a></p>
|
|
|
|
<p><code>#include <partition_ground.h></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for gridfire::partition::GroundStatePartitionFunction:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><iframe scrolling="no" frameborder="0" src="classgridfire_1_1partition_1_1GroundStatePartitionFunction__inherit__graph.svg" width="231" height="139"><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 gridfire::partition::GroundStatePartitionFunction:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><iframe scrolling="no" frameborder="0" src="classgridfire_1_1partition_1_1GroundStatePartitionFunction__coll__graph.svg" width="355" height="154"><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>
|
|
<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:a8afa2aee993eb3ed8d01c887d39b57eb" id="r_a8afa2aee993eb3ed8d01c887d39b57eb"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1partition_1_1GroundStatePartitionFunction.html#a8afa2aee993eb3ed8d01c887d39b57eb">GroundStatePartitionFunction</a> ()</td></tr>
|
|
<tr class="separator:a8afa2aee993eb3ed8d01c887d39b57eb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af16da0015489307eb64639efbafbbdd5" id="r_af16da0015489307eb64639efbafbbdd5"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1partition_1_1GroundStatePartitionFunction.html#af16da0015489307eb64639efbafbbdd5">evaluate</a> (const int z, const int a, const double T9) const override</td></tr>
|
|
<tr class="separator:af16da0015489307eb64639efbafbbdd5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0eff10c7b134d9d4081ad72bbc785c5b" id="r_a0eff10c7b134d9d4081ad72bbc785c5b"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1partition_1_1GroundStatePartitionFunction.html#a0eff10c7b134d9d4081ad72bbc785c5b">evaluateDerivative</a> (const int z, const int a, const double T9) const override</td></tr>
|
|
<tr class="separator:a0eff10c7b134d9d4081ad72bbc785c5b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a49b18aae58eb6250aaa23d43d55f02bd" id="r_a49b18aae58eb6250aaa23d43d55f02bd"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1partition_1_1GroundStatePartitionFunction.html#a49b18aae58eb6250aaa23d43d55f02bd">supports</a> (const int z, const int a) const override</td></tr>
|
|
<tr class="separator:a49b18aae58eb6250aaa23d43d55f02bd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af8d0146fc2afedf3785ae9ec932d3250" id="r_af8d0146fc2afedf3785ae9ec932d3250"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1partition_1_1GroundStatePartitionFunction.html#af8d0146fc2afedf3785ae9ec932d3250">type</a> () const override</td></tr>
|
|
<tr class="separator:af8d0146fc2afedf3785ae9ec932d3250"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ade2b0f92a3d9b74968166793466a11e4" id="r_ade2b0f92a3d9b74968166793466a11e4"><td class="memItemLeft" align="right" valign="top">std::unique_ptr< <a class="el" href="classgridfire_1_1partition_1_1PartitionFunction.html">PartitionFunction</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1partition_1_1GroundStatePartitionFunction.html#ade2b0f92a3d9b74968166793466a11e4">clone</a> () const override</td></tr>
|
|
<tr class="separator:ade2b0f92a3d9b74968166793466a11e4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_classgridfire_1_1partition_1_1PartitionFunction"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgridfire_1_1partition_1_1PartitionFunction')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classgridfire_1_1partition_1_1PartitionFunction.html">gridfire::partition::PartitionFunction</a></td></tr>
|
|
<tr class="memitem:a197a0663dcfb4ab4be3b0e14b98391db inherit pub_methods_classgridfire_1_1partition_1_1PartitionFunction" 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_1PartitionFunction.html#a197a0663dcfb4ab4be3b0e14b98391db">~PartitionFunction</a> ()=default</td></tr>
|
|
<tr class="memdesc:a197a0663dcfb4ab4be3b0e14b98391db inherit pub_methods_classgridfire_1_1partition_1_1PartitionFunction"><td class="mdescLeft"> </td><td class="mdescRight">Virtual destructor. <br /></td></tr>
|
|
<tr class="separator:a197a0663dcfb4ab4be3b0e14b98391db inherit pub_methods_classgridfire_1_1partition_1_1PartitionFunction"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-static-methods" name="pri-static-methods"></a>
|
|
Static Private Member Functions</h2></td></tr>
|
|
<tr class="memitem:a0e75ec9b97529783e07953aaf7d70f68" id="r_a0e75ec9b97529783e07953aaf7d70f68"><td class="memItemLeft" align="right" valign="top">static constexpr int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1partition_1_1GroundStatePartitionFunction.html#a0e75ec9b97529783e07953aaf7d70f68">make_key</a> (int z, int a)</td></tr>
|
|
<tr class="separator:a0e75ec9b97529783e07953aaf7d70f68"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
|
|
Private Attributes</h2></td></tr>
|
|
<tr class="memitem:aff8f82f918380795e98c30a00fcd939b" id="r_aff8f82f918380795e98c30a00fcd939b"><td class="memItemLeft" align="right" valign="top">quill::Logger * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1partition_1_1GroundStatePartitionFunction.html#aff8f82f918380795e98c30a00fcd939b">m_logger</a> = fourdst::logging::LogManager::getInstance().getLogger("log")</td></tr>
|
|
<tr class="separator:aff8f82f918380795e98c30a00fcd939b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af7f710edff96b1623c517ddab137c245" id="r_af7f710edff96b1623c517ddab137c245"><td class="memItemLeft" align="right" valign="top">std::unordered_map< int, double > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1partition_1_1GroundStatePartitionFunction.html#af7f710edff96b1623c517ddab137c245">m_ground_state_spin</a></td></tr>
|
|
<tr class="separator:af7f710edff96b1623c517ddab137c245"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Partition function implementation for nuclear ground states. </p>
|
|
<p>Computes the partition function as (2J + 1) based on the ground state spin J of each isotope. The temperature derivative is always zero. Ground state spins are loaded from the fourdst::atomic::species registry at construction. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="partition__ground_8cpp.html">partition_ground.cpp</a> for implementation details. </dd></dl>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a8afa2aee993eb3ed8d01c887d39b57eb" name="a8afa2aee993eb3ed8d01c887d39b57eb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8afa2aee993eb3ed8d01c887d39b57eb">◆ </a></span>GroundStatePartitionFunction()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">gridfire::partition::GroundStatePartitionFunction::GroundStatePartitionFunction </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<pre class="fragment"> @brief Construct and populate the ground state spin map.
|
|
</pre><ul>
|
|
<li>* Loads spins for all isotopes from the atomic species registry into m_ground_state_spin. <dl class="section pre"><dt>Precondition</dt><dd>atomic::species registry is initialized and non-empty. </dd></dl>
|
|
<dl class="section post"><dt>Postcondition</dt><dd>m_ground_state_spin contains entries for each isotope.</dd></dl>
|
|
</li>
|
|
<li><br />
|
|
</li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="ade2b0f92a3d9b74968166793466a11e4" name="ade2b0f92a3d9b74968166793466a11e4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ade2b0f92a3d9b74968166793466a11e4">◆ </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_1PartitionFunction.html">PartitionFunction</a> > gridfire::partition::GroundStatePartitionFunction::clone </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<pre class="fragment"> @brief Create a deep copy of this partition function.
|
|
@return Unique_ptr to a new GroundStatePartitionFunction cloned from this object.
|
|
@post Caller owns the returned instance.
|
|
</pre><ul>
|
|
<li><br />
|
|
</li>
|
|
</ul>
|
|
|
|
<p>Implements <a class="el" href="classgridfire_1_1partition_1_1PartitionFunction.html#a677a90f992fd56b8718e36655c33ce6d">gridfire::partition::PartitionFunction</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af16da0015489307eb64639efbafbbdd5" name="af16da0015489307eb64639efbafbbdd5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af16da0015489307eb64639efbafbbdd5">◆ </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 gridfire::partition::GroundStatePartitionFunction::evaluate </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>z</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>a</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const double </td>
|
|
<td class="paramname"><em>T9</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<pre class="fragment"> @brief Evaluate the ground state partition function.
|
|
</pre><ul>
|
|
<li>* <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; unused for ground state. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section pre"><dt>Precondition</dt><dd>supports(z,a) returns true. </dd></dl>
|
|
<dl class="section post"><dt>Postcondition</dt><dd>No side effects. </dd></dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Dimensionless partition function value = 2*spin + 1. </dd></dl>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname">std::out_of_range</td><td>If the isotope key is not found in m_ground_state_spin.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
</li>
|
|
<li><br />
|
|
</li>
|
|
</ul>
|
|
|
|
<p>Implements <a class="el" href="classgridfire_1_1partition_1_1PartitionFunction.html#a08ee79b7d8723b4e00ee1fc9cdfbe817">gridfire::partition::PartitionFunction</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0eff10c7b134d9d4081ad72bbc785c5b" name="a0eff10c7b134d9d4081ad72bbc785c5b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0eff10c7b134d9d4081ad72bbc785c5b">◆ </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 gridfire::partition::GroundStatePartitionFunction::evaluateDerivative </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>z</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>a</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const double </td>
|
|
<td class="paramname"><em>T9</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<pre class="fragment"> @brief Evaluate the temperature derivative of the ground state partition function.
|
|
</pre><ul>
|
|
<li>* Always returns zero as ground state has no temperature dependence. <dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">z</td><td>Proton number of the isotope; must be supported. </td></tr>
|
|
<tr><td class="paramname">a</td><td>Mass number of the isotope; must be supported. </td></tr>
|
|
<tr><td class="paramname">T9</td><td>Temperature in units of 10^9 K; unused. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section pre"><dt>Precondition</dt><dd>supports(z,a) returns true. </dd></dl>
|
|
<dl class="section post"><dt>Postcondition</dt><dd>No side effects. </dd></dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Zero. </dd></dl>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname">std::out_of_range</td><td>If the isotope key is not found.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
</li>
|
|
<li><br />
|
|
</li>
|
|
</ul>
|
|
|
|
<p>Implements <a class="el" href="classgridfire_1_1partition_1_1PartitionFunction.html#a14009bdaca47f3eddf2c6c023845db5a">gridfire::partition::PartitionFunction</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0e75ec9b97529783e07953aaf7d70f68" name="a0e75ec9b97529783e07953aaf7d70f68"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0e75ec9b97529783e07953aaf7d70f68">◆ </a></span>make_key()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">constexpr int gridfire::partition::GroundStatePartitionFunction::make_key </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>z</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>a</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<pre class="fragment"> @brief Generate a unique lookup key for an isotope.
|
|
</pre><ul>
|
|
<li>* Combines atomic number z and mass number an into a single integer. <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; should be < 1000 to avoid collisions. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section pre"><dt>Precondition</dt><dd>a < 1000. </dd></dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Integer key = z * 1000 + a.</dd></dl>
|
|
</li>
|
|
<li><br />
|
|
</li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a49b18aae58eb6250aaa23d43d55f02bd" name="a49b18aae58eb6250aaa23d43d55f02bd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a49b18aae58eb6250aaa23d43d55f02bd">◆ </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 gridfire::partition::GroundStatePartitionFunction::supports </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>z</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>a</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<pre class="fragment"> @brief Check if ground state data exists for the given isotope.
|
|
</pre><ul>
|
|
<li>* <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 m_ground_state_spin contains the key; false otherwise. </dd></dl>
|
|
<dl class="section post"><dt>Postcondition</dt><dd>No side effects.</dd></dl>
|
|
</li>
|
|
<li><br />
|
|
</li>
|
|
</ul>
|
|
|
|
<p>Implements <a class="el" href="classgridfire_1_1partition_1_1PartitionFunction.html#a6df4191d10516477371a0384e1e55bf5">gridfire::partition::PartitionFunction</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af8d0146fc2afedf3785ae9ec932d3250" name="af8d0146fc2afedf3785ae9ec932d3250"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af8d0146fc2afedf3785ae9ec932d3250">◆ </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 gridfire::partition::GroundStatePartitionFunction::type </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<pre class="fragment"> @brief Get the type identifier of this partition function.
|
|
@return The string literal "GroundState".
|
|
@post No side effects.
|
|
</pre><ul>
|
|
<li><br />
|
|
</li>
|
|
</ul>
|
|
|
|
<p>Implements <a class="el" href="classgridfire_1_1partition_1_1PartitionFunction.html#ab0c67985a972707eac0ebc64417dfb97">gridfire::partition::PartitionFunction</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="af7f710edff96b1623c517ddab137c245" name="af7f710edff96b1623c517ddab137c245"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af7f710edff96b1623c517ddab137c245">◆ </a></span>m_ground_state_spin</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::unordered_map<int, double> gridfire::partition::GroundStatePartitionFunction::m_ground_state_spin</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aff8f82f918380795e98c30a00fcd939b" name="aff8f82f918380795e98c30a00fcd939b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aff8f82f918380795e98c30a00fcd939b">◆ </a></span>m_logger</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">quill::Logger* gridfire::partition::GroundStatePartitionFunction::m_logger = fourdst::logging::LogManager::getInstance().getLogger("log")</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>src/include/gridfire/partition/<a class="el" href="partition__ground_8h.html">partition_ground.h</a></li>
|
|
<li>src/lib/partition/<a class="el" href="partition__ground_8cpp.html">partition_ground.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="namespacegridfire.html">gridfire</a></li><li class="navelem"><a class="el" href="namespacegridfire_1_1partition.html">partition</a></li><li class="navelem"><a class="el" href="classgridfire_1_1partition_1_1GroundStatePartitionFunction.html">GroundStatePartitionFunction</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.9.8 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|