273 lines
18 KiB
HTML
273 lines
18 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 Namespace 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('namespacegridfire_1_1partition.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="#namespaces">Namespaces</a> |
|
|
<a href="#nested-classes">Classes</a> |
|
|
<a href="#enum-members">Enumerations</a> |
|
|
<a href="#var-members">Variables</a> </div>
|
|
<div class="headertitle"><div class="title">gridfire::partition Namespace Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
|
|
Namespaces</h2></td></tr>
|
|
<tr class="memitem:namespacegridfire_1_1partition_1_1record" id="r_namespacegridfire_1_1partition_1_1record"><td class="memItemLeft" align="right" valign="top">namespace  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1partition_1_1record.html">record</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
|
|
Classes</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1partition_1_1CompositePartitionFunction.html">CompositePartitionFunction</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Combines multiple <a class="el" href="classgridfire_1_1partition_1_1PartitionFunction.html" title="Abstract interface for evaluating nuclear partition functions.">PartitionFunction</a> instances into a single composite strategy. <a href="classgridfire_1_1partition_1_1CompositePartitionFunction.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1partition_1_1GroundStatePartitionFunction.html">GroundStatePartitionFunction</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Partition function implementation for nuclear ground states. <a href="classgridfire_1_1partition_1_1GroundStatePartitionFunction.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1partition_1_1PartitionFunction.html">PartitionFunction</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Abstract interface for evaluating nuclear partition functions. <a href="classgridfire_1_1partition_1_1PartitionFunction.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1partition_1_1RauscherThielemannPartitionFunction.html">RauscherThielemannPartitionFunction</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Partition function using Rauscher-Thielemann tabulated normalized G-values. <a href="classgridfire_1_1partition_1_1RauscherThielemannPartitionFunction.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
|
|
Enumerations</h2></td></tr>
|
|
<tr class="memitem:ae931a76ba5efada4ca45ac93333e728c" id="r_ae931a76ba5efada4ca45ac93333e728c"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1partition.html#ae931a76ba5efada4ca45ac93333e728c">BasePartitionType</a> { <a class="el" href="namespacegridfire_1_1partition.html#ae931a76ba5efada4ca45ac93333e728ca4ca5b5dcd7343b06b860f05f3bc454b1">RauscherThielemann</a>
|
|
, <a class="el" href="namespacegridfire_1_1partition.html#ae931a76ba5efada4ca45ac93333e728cab3ecbf203bf429cbb751d1de1e58f335">GroundState</a>
|
|
}</td></tr>
|
|
<tr class="memdesc:ae931a76ba5efada4ca45ac93333e728c"><td class="mdescLeft"> </td><td class="mdescRight">Enumerates available partition function implementations. <a href="namespacegridfire_1_1partition.html#ae931a76ba5efada4ca45ac93333e728c">More...</a><br /></td></tr>
|
|
<tr class="separator:ae931a76ba5efada4ca45ac93333e728c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
|
|
Variables</h2></td></tr>
|
|
<tr class="memitem:a97237521bc760f7521346f8db472dc8e" id="r_a97237521bc760f7521346f8db472dc8e"><td class="memItemLeft" align="right" valign="top">std::unordered_map< <a class="el" href="namespacegridfire_1_1partition.html#ae931a76ba5efada4ca45ac93333e728c">BasePartitionType</a>, std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1partition.html#a97237521bc760f7521346f8db472dc8e">basePartitionTypeToString</a></td></tr>
|
|
<tr class="memdesc:a97237521bc760f7521346f8db472dc8e"><td class="mdescLeft"> </td><td class="mdescRight">Mapping from BasePartitionType enum to human-readable string. <br /></td></tr>
|
|
<tr class="separator:a97237521bc760f7521346f8db472dc8e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a84de6308486d35ce8bc1a9dea52dfa4a" id="r_a84de6308486d35ce8bc1a9dea52dfa4a"><td class="memItemLeft" align="right" valign="top">std::unordered_map< std::string, <a class="el" href="namespacegridfire_1_1partition.html#ae931a76ba5efada4ca45ac93333e728c">BasePartitionType</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1partition.html#a84de6308486d35ce8bc1a9dea52dfa4a">stringToBasePartitionType</a></td></tr>
|
|
<tr class="memdesc:a84de6308486d35ce8bc1a9dea52dfa4a"><td class="mdescLeft"> </td><td class="mdescRight">Mapping from string to BasePartitionType enum. <br /></td></tr>
|
|
<tr class="separator:a84de6308486d35ce8bc1a9dea52dfa4a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1e08a3c20c55bc6fa4a4ecdf7ea57b8f" id="r_a1e08a3c20c55bc6fa4a4ecdf7ea57b8f"><td class="memItemLeft" align="right" valign="top">static constexpr std::array< double, 24 > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1partition.html#a1e08a3c20c55bc6fa4a4ecdf7ea57b8f">RT_TEMPERATURE_GRID_T9</a></td></tr>
|
|
<tr class="separator:a1e08a3c20c55bc6fa4a4ecdf7ea57b8f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Enumeration Type Documentation</h2>
|
|
<a id="ae931a76ba5efada4ca45ac93333e728c" name="ae931a76ba5efada4ca45ac93333e728c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae931a76ba5efada4ca45ac93333e728c">◆ </a></span>BasePartitionType</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="namespacegridfire_1_1partition.html#ae931a76ba5efada4ca45ac93333e728c">gridfire::partition::BasePartitionType</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enumerates available partition function implementations. </p>
|
|
<p>RauscherThielemann: Uses tabulated normalized G-values and linear interpolation. GroundState: Uses ground state spin (J) to compute partition function as 2J+1. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ae931a76ba5efada4ca45ac93333e728ca4ca5b5dcd7343b06b860f05f3bc454b1" name="ae931a76ba5efada4ca45ac93333e728ca4ca5b5dcd7343b06b860f05f3bc454b1"></a>RauscherThielemann </td><td class="fielddoc"><p>Rauscher-Thielemann partition function. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ae931a76ba5efada4ca45ac93333e728cab3ecbf203bf429cbb751d1de1e58f335" name="ae931a76ba5efada4ca45ac93333e728cab3ecbf203bf429cbb751d1de1e58f335"></a>GroundState </td><td class="fielddoc"><p>Ground state partition function. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Variable Documentation</h2>
|
|
<a id="a97237521bc760f7521346f8db472dc8e" name="a97237521bc760f7521346f8db472dc8e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a97237521bc760f7521346f8db472dc8e">◆ </a></span>basePartitionTypeToString</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<<a class="el" href="namespacegridfire_1_1partition.html#ae931a76ba5efada4ca45ac93333e728c">BasePartitionType</a>, std::string> gridfire::partition::basePartitionTypeToString</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Initial value:</b><div class="fragment"><div class="line">= {</div>
|
|
<div class="line"> {<a class="code hl_enumvalue" href="namespacegridfire_1_1partition.html#ae931a76ba5efada4ca45ac93333e728ca4ca5b5dcd7343b06b860f05f3bc454b1">RauscherThielemann</a>, <span class="stringliteral">"RauscherThielemann"</span>},</div>
|
|
<div class="line"> {<a class="code hl_enumvalue" href="namespacegridfire_1_1partition.html#ae931a76ba5efada4ca45ac93333e728cab3ecbf203bf429cbb751d1de1e58f335">GroundState</a>, <span class="stringliteral">"GroundState"</span>}</div>
|
|
<div class="line"> }</div>
|
|
<div class="ttc" id="anamespacegridfire_1_1partition_html_ae931a76ba5efada4ca45ac93333e728ca4ca5b5dcd7343b06b860f05f3bc454b1"><div class="ttname"><a href="namespacegridfire_1_1partition.html#ae931a76ba5efada4ca45ac93333e728ca4ca5b5dcd7343b06b860f05f3bc454b1">gridfire::partition::RauscherThielemann</a></div><div class="ttdeci">@ RauscherThielemann</div><div class="ttdoc">Rauscher-Thielemann partition function.</div><div class="ttdef"><b>Definition</b> partition_types.h:16</div></div>
|
|
<div class="ttc" id="anamespacegridfire_1_1partition_html_ae931a76ba5efada4ca45ac93333e728cab3ecbf203bf429cbb751d1de1e58f335"><div class="ttname"><a href="namespacegridfire_1_1partition.html#ae931a76ba5efada4ca45ac93333e728cab3ecbf203bf429cbb751d1de1e58f335">gridfire::partition::GroundState</a></div><div class="ttdeci">@ GroundState</div><div class="ttdoc">Ground state partition function.</div><div class="ttdef"><b>Definition</b> partition_types.h:17</div></div>
|
|
</div><!-- fragment -->
|
|
<p>Mapping from BasePartitionType enum to human-readable string. </p>
|
|
<p>Used for logging, reporting, or serialization. Ensure that all enum values are represented in this map. </p><dl class="section pre"><dt>Precondition</dt><dd>Contains entries for all values of BasePartitionType. </dd></dl>
|
|
<dl class="section post"><dt>Postcondition</dt><dd>Can convert BasePartitionType to corresponding string. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1e08a3c20c55bc6fa4a4ecdf7ea57b8f" name="a1e08a3c20c55bc6fa4a4ecdf7ea57b8f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1e08a3c20c55bc6fa4a4ecdf7ea57b8f">◆ </a></span>RT_TEMPERATURE_GRID_T9</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">constexpr std::array<double, 24> gridfire::partition::RT_TEMPERATURE_GRID_T9</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Initial value:</b><div class="fragment"><div class="line">= {</div>
|
|
<div class="line"> 0.01, 0.15, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9, 1.0, 1.5,</div>
|
|
<div class="line"> 2.0, 2.5, 3.0, 3.5, 4.0, 4.5, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0</div>
|
|
<div class="line"> }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a84de6308486d35ce8bc1a9dea52dfa4a" name="a84de6308486d35ce8bc1a9dea52dfa4a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a84de6308486d35ce8bc1a9dea52dfa4a">◆ </a></span>stringToBasePartitionType</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<std::string, <a class="el" href="namespacegridfire_1_1partition.html#ae931a76ba5efada4ca45ac93333e728c">BasePartitionType</a>> gridfire::partition::stringToBasePartitionType</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Initial value:</b><div class="fragment"><div class="line">= {</div>
|
|
<div class="line"> {<span class="stringliteral">"RauscherThielemann"</span>, <a class="code hl_enumvalue" href="namespacegridfire_1_1partition.html#ae931a76ba5efada4ca45ac93333e728ca4ca5b5dcd7343b06b860f05f3bc454b1">RauscherThielemann</a>},</div>
|
|
<div class="line"> {<span class="stringliteral">"GroundState"</span>, <a class="code hl_enumvalue" href="namespacegridfire_1_1partition.html#ae931a76ba5efada4ca45ac93333e728cab3ecbf203bf429cbb751d1de1e58f335">GroundState</a>}</div>
|
|
<div class="line"> }</div>
|
|
</div><!-- fragment -->
|
|
<p>Mapping from string to BasePartitionType enum. </p>
|
|
<p>Used for parsing configuration or user input. Strings must match exactly to one of the defined partition types. </p><dl class="section pre"><dt>Precondition</dt><dd>Uses keys that exactly match the outputs of basePartitionTypeToString. </dd></dl>
|
|
<dl class="section post"><dt>Postcondition</dt><dd>Can convert valid string identifiers back to BasePartitionType. </dd></dl>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname">std::out_of_range</td><td>if accessed with a non-existing key via at(). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
</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="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>
|