580 lines
30 KiB
HTML
580 lines
30 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::CompositePartitionFunction 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_1CompositePartitionFunction.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-methods">Private Member Functions</a> |
|
||
|
|
<a href="#pri-attribs">Private Attributes</a> |
|
||
|
|
<a href="classgridfire_1_1partition_1_1CompositePartitionFunction-members.html">List of all members</a> </div>
|
||
|
|
<div class="headertitle"><div class="title">gridfire::partition::CompositePartitionFunction Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div></div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
|
||
|
|
<p>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></p>
|
||
|
|
|
||
|
|
<p><code>#include <partition_composite.h></code></p>
|
||
|
|
<div class="dynheader">
|
||
|
|
Inheritance diagram for gridfire::partition::CompositePartitionFunction:</div>
|
||
|
|
<div class="dyncontent">
|
||
|
|
<div class="center"><iframe scrolling="no" frameborder="0" src="classgridfire_1_1partition_1_1CompositePartitionFunction__inherit__graph.svg" width="220" 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::CompositePartitionFunction:</div>
|
||
|
|
<div class="dyncontent">
|
||
|
|
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="classgridfire_1_1partition_1_1CompositePartitionFunction__coll__graph.svg" width="100%" height="421"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div></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:ad80743933712de627c6a69d06d42ceb5" id="r_ad80743933712de627c6a69d06d42ceb5"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1partition_1_1CompositePartitionFunction.html#ad80743933712de627c6a69d06d42ceb5">CompositePartitionFunction</a> (const std::vector< <a class="el" href="namespacegridfire_1_1partition.html#ae931a76ba5efada4ca45ac93333e728c">BasePartitionType</a> > &partitionFunctions)</td></tr>
|
||
|
|
<tr class="separator:ad80743933712de627c6a69d06d42ceb5"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ac1bc5bedabef400fab6aceb477dbc6b9" id="r_ac1bc5bedabef400fab6aceb477dbc6b9"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1partition_1_1CompositePartitionFunction.html#ac1bc5bedabef400fab6aceb477dbc6b9">CompositePartitionFunction</a> (const <a class="el" href="classgridfire_1_1partition_1_1CompositePartitionFunction.html">CompositePartitionFunction</a> &other)</td></tr>
|
||
|
|
<tr class="separator:ac1bc5bedabef400fab6aceb477dbc6b9"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a8d6d278fcb5b8478b0e27535f877ee2b" id="r_a8d6d278fcb5b8478b0e27535f877ee2b"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1partition_1_1CompositePartitionFunction.html#a8d6d278fcb5b8478b0e27535f877ee2b">evaluate</a> (int z, int a, double T9) const override</td></tr>
|
||
|
|
<tr class="separator:a8d6d278fcb5b8478b0e27535f877ee2b"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ac8900afaa5edd24fcb8eaf19e7379183" id="r_ac8900afaa5edd24fcb8eaf19e7379183"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1partition_1_1CompositePartitionFunction.html#ac8900afaa5edd24fcb8eaf19e7379183">evaluateDerivative</a> (int z, int a, double T9) const override</td></tr>
|
||
|
|
<tr class="separator:ac8900afaa5edd24fcb8eaf19e7379183"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ae8908a78f087ea516cdd5a4cdd449a9c" id="r_ae8908a78f087ea516cdd5a4cdd449a9c"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1partition_1_1CompositePartitionFunction.html#ae8908a78f087ea516cdd5a4cdd449a9c">supports</a> (int z, int a) const override</td></tr>
|
||
|
|
<tr class="separator:ae8908a78f087ea516cdd5a4cdd449a9c"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a66560e21a4a7b08e8da135ce8279ed88" id="r_a66560e21a4a7b08e8da135ce8279ed88"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1partition_1_1CompositePartitionFunction.html#a66560e21a4a7b08e8da135ce8279ed88">type</a> () const override</td></tr>
|
||
|
|
<tr class="separator:a66560e21a4a7b08e8da135ce8279ed88"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a7b000d55c7d1f489e54a57f7f4e3808a" id="r_a7b000d55c7d1f489e54a57f7f4e3808a"><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_1CompositePartitionFunction.html#a7b000d55c7d1f489e54a57f7f4e3808a">clone</a> () const override</td></tr>
|
||
|
|
<tr class="separator:a7b000d55c7d1f489e54a57f7f4e3808a"><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-methods" name="pri-methods"></a>
|
||
|
|
Private Member Functions</h2></td></tr>
|
||
|
|
<tr class="memitem:a32f397abf9e9ace9f0c721e4e14eb60b" id="r_a32f397abf9e9ace9f0c721e4e14eb60b"><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_1CompositePartitionFunction.html#a32f397abf9e9ace9f0c721e4e14eb60b">selectPartitionFunction</a> (<a class="el" href="namespacegridfire_1_1partition.html#ae931a76ba5efada4ca45ac93333e728c">BasePartitionType</a> <a class="el" href="classgridfire_1_1partition_1_1CompositePartitionFunction.html#a66560e21a4a7b08e8da135ce8279ed88">type</a>) const</td></tr>
|
||
|
|
<tr class="separator:a32f397abf9e9ace9f0c721e4e14eb60b"><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:ae0fc1c6abdc86009ba0fc6c9f270ff8b" id="r_ae0fc1c6abdc86009ba0fc6c9f270ff8b"><td class="memItemLeft" align="right" valign="top">quill::Logger * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1partition_1_1CompositePartitionFunction.html#ae0fc1c6abdc86009ba0fc6c9f270ff8b">m_logger</a> = fourdst::logging::LogManager::getInstance().getLogger("log")</td></tr>
|
||
|
|
<tr class="separator:ae0fc1c6abdc86009ba0fc6c9f270ff8b"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a85aaac230e9de2fd50d4d453f6d5def8" id="r_a85aaac230e9de2fd50d4d453f6d5def8"><td class="memItemLeft" align="right" valign="top">std::vector< 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_1CompositePartitionFunction.html#a85aaac230e9de2fd50d4d453f6d5def8">m_partitionFunctions</a></td></tr>
|
||
|
|
<tr class="memdesc:a85aaac230e9de2fd50d4d453f6d5def8"><td class="mdescLeft"> </td><td class="mdescRight">Set of partition functions to use in the composite partition function. <br /></td></tr>
|
||
|
|
<tr class="separator:a85aaac230e9de2fd50d4d453f6d5def8"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a9aea5eda63b9be4d3b8f65c13d317dcc" id="r_a9aea5eda63b9be4d3b8f65c13d317dcc"><td class="memItemLeft" align="right" valign="top">std::unordered_map< uint_fast32_t, const <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_1CompositePartitionFunction.html#a9aea5eda63b9be4d3b8f65c13d317dcc">m_supportCache</a></td></tr>
|
||
|
|
<tr class="memdesc:a9aea5eda63b9be4d3b8f65c13d317dcc"><td class="mdescLeft"> </td><td class="mdescRight">Cache mapping isotope keys to supporting partition functions for fast lookup. <br /></td></tr>
|
||
|
|
<tr class="separator:a9aea5eda63b9be4d3b8f65c13d317dcc"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table>
|
||
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||
|
|
<div class="textblock"><p>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. </p>
|
||
|
|
<p>Maintains an ordered list of sub-functions and delegates evaluation and derivative calls to the first function that supports the requested isotope.</p>
|
||
|
|
<p>See <a class="el" href="partition__composite_8cpp.html">partition_composite.cpp</a> for details on sub-function selection and error logging.</p>
|
||
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
||
|
|
<table class="exception">
|
||
|
|
<tr><td class="paramname">std::runtime_error</td><td>If no sub-function supports a given (z,a,T9) in evaluate or evaluateDerivative. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
||
|
|
<a id="ad80743933712de627c6a69d06d42ceb5" name="ad80743933712de627c6a69d06d42ceb5"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad80743933712de627c6a69d06d42ceb5">◆ </a></span>CompositePartitionFunction() <span class="overload">[1/2]</span></h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">gridfire::partition::CompositePartitionFunction::CompositePartitionFunction </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const std::vector< <a class="el" href="namespacegridfire_1_1partition.html#ae931a76ba5efada4ca45ac93333e728c">BasePartitionType</a> > & </td>
|
||
|
|
<td class="paramname"><em>partitionFunctions</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
<pre class="fragment"> @brief Construct a composite function from specified types.
|
||
|
|
|
||
|
|
Instantiates sub-functions according to the order of types provided.
|
||
|
|
@param partitionFunctions List of BasePartitionType identifiers for sub-functions.
|
||
|
|
@pre partitionFunctions must not be empty.
|
||
|
|
@post m_partitionFunctions contains instances matching each type.
|
||
|
|
</pre><ul>
|
||
|
|
<li><br />
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="ac1bc5bedabef400fab6aceb477dbc6b9" name="ac1bc5bedabef400fab6aceb477dbc6b9"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac1bc5bedabef400fab6aceb477dbc6b9">◆ </a></span>CompositePartitionFunction() <span class="overload">[2/2]</span></h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">gridfire::partition::CompositePartitionFunction::CompositePartitionFunction </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const <a class="el" href="classgridfire_1_1partition_1_1CompositePartitionFunction.html">CompositePartitionFunction</a> & </td>
|
||
|
|
<td class="paramname"><em>other</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
<pre class="fragment"> @brief Copy constructor.
|
||
|
|
|
||
|
|
Creates deep clones of the sub-functions in another composite.
|
||
|
|
@param other Existing composite to copy from.
|
||
|
|
@post m_partitionFunctions contains clones of other's sub-functions.
|
||
|
|
</pre><ul>
|
||
|
|
<li><br />
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
||
|
|
<a id="a7b000d55c7d1f489e54a57f7f4e3808a" name="a7b000d55c7d1f489e54a57f7f4e3808a"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7b000d55c7d1f489e54a57f7f4e3808a">◆ </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::CompositePartitionFunction::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 Clone this composite partition function.
|
||
|
|
|
||
|
|
@return Unique pointer to a deep copy of this object.
|
||
|
|
</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="a8d6d278fcb5b8478b0e27535f877ee2b" name="a8d6d278fcb5b8478b0e27535f877ee2b"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8d6d278fcb5b8478b0e27535f877ee2b">◆ </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::CompositePartitionFunction::evaluate </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 class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">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 composite partition function.
|
||
|
|
|
||
|
|
Calls evaluate on the first sub-function supporting the isotope.
|
||
|
|
@param z Atomic number (>=1).
|
||
|
|
@param a Mass number (>=z).
|
||
|
|
@param T9 Temperature in 10^9 K.
|
||
|
|
@return Partition function value from supporting sub-function.
|
||
|
|
@throws std::runtime_error If no sub-function supports (z,a,T9).
|
||
|
|
</pre><ul>
|
||
|
|
<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="ac8900afaa5edd24fcb8eaf19e7379183" name="ac8900afaa5edd24fcb8eaf19e7379183"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac8900afaa5edd24fcb8eaf19e7379183">◆ </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::CompositePartitionFunction::evaluateDerivative </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 class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">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 temperature derivative of the composite function.
|
||
|
|
|
||
|
|
Delegates to the first supporting sub-function's derivative.
|
||
|
|
@param z Atomic number.
|
||
|
|
@param a Mass number.
|
||
|
|
@param T9 Temperature in 10^9 K.
|
||
|
|
@return d/dT9 of the partition function.
|
||
|
|
@throws std::runtime_error If no sub-function supports (z,a,T9).
|
||
|
|
</pre><ul>
|
||
|
|
<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="a32f397abf9e9ace9f0c721e4e14eb60b" name="a32f397abf9e9ace9f0c721e4e14eb60b"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a32f397abf9e9ace9f0c721e4e14eb60b">◆ </a></span>selectPartitionFunction()</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::CompositePartitionFunction::selectPartitionFunction </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype"><a class="el" href="namespacegridfire_1_1partition.html#ae931a76ba5efada4ca45ac93333e728c">BasePartitionType</a> </td>
|
||
|
|
<td class="paramname"><em>type</em></td><td>)</td>
|
||
|
|
<td> const</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
<pre class="fragment"> @brief Instantiate a sub-function by its type.
|
||
|
|
|
||
|
|
@param type Enumeration value selecting the desired function implementation.
|
||
|
|
@return Unique pointer to a new PartitionFunction instance of the given type.
|
||
|
|
@throws std::runtime_error If the given type is not recognized.
|
||
|
|
</pre><ul>
|
||
|
|
<li><br />
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="ae8908a78f087ea516cdd5a4cdd449a9c" name="ae8908a78f087ea516cdd5a4cdd449a9c"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae8908a78f087ea516cdd5a4cdd449a9c">◆ </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::CompositePartitionFunction::supports </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> 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 support across all sub-functions.
|
||
|
|
|
||
|
|
@param z Atomic number.
|
||
|
|
@param a Mass number.
|
||
|
|
@return true if any sub-function supports (z,a); false otherwise.
|
||
|
|
</pre><ul>
|
||
|
|
<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="a66560e21a4a7b08e8da135ce8279ed88" name="a66560e21a4a7b08e8da135ce8279ed88"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a66560e21a4a7b08e8da135ce8279ed88">◆ </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::CompositePartitionFunction::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">override</span><span class="mlabel">virtual</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
<pre class="fragment"> @brief Get composite type identifier.
|
||
|
|
|
||
|
|
Concatenates the type() strings of all sub-functions.
|
||
|
|
@return A string like "CompositePartitionFunction(func1, func2, ...)".
|
||
|
|
</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="ae0fc1c6abdc86009ba0fc6c9f270ff8b" name="ae0fc1c6abdc86009ba0fc6c9f270ff8b"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae0fc1c6abdc86009ba0fc6c9f270ff8b">◆ </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::CompositePartitionFunction::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>
|
||
|
|
<a id="a85aaac230e9de2fd50d4d453f6d5def8" name="a85aaac230e9de2fd50d4d453f6d5def8"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a85aaac230e9de2fd50d4d453f6d5def8">◆ </a></span>m_partitionFunctions</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">std::vector<std::unique_ptr<<a class="el" href="classgridfire_1_1partition_1_1PartitionFunction.html">PartitionFunction</a>> > gridfire::partition::CompositePartitionFunction::m_partitionFunctions</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Set of partition functions to use in the composite partition function. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a9aea5eda63b9be4d3b8f65c13d317dcc" name="a9aea5eda63b9be4d3b8f65c13d317dcc"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9aea5eda63b9be4d3b8f65c13d317dcc">◆ </a></span>m_supportCache</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<uint_fast32_t, const <a class="el" href="classgridfire_1_1partition_1_1PartitionFunction.html">PartitionFunction</a>&> gridfire::partition::CompositePartitionFunction::m_supportCache</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">mutable</span><span class="mlabel">private</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Cache mapping isotope keys to supporting partition functions for fast lookup. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
||
|
|
<li>src/include/gridfire/partition/composite/<a class="el" href="partition__composite_8h.html">partition_composite.h</a></li>
|
||
|
|
<li>src/lib/partition/composite/<a class="el" href="partition__composite_8cpp.html">partition_composite.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_1CompositePartitionFunction.html">CompositePartitionFunction</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>
|