Files
GridFire/docs/html/partition__composite_8h_source.html

169 lines
20 KiB
HTML
Raw Permalink 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/composite/partition_composite.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__composite_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_composite.h</div></div>
</div><!--header-->
<div class="contents">
<a href="partition__composite_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 &quot;<a class="code" href="partition__abstract_8h.html">gridfire/partition/partition_abstract.h</a>&quot;</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &quot;<a class="code" href="partition__types_8h.html">gridfire/partition/partition_types.h</a>&quot;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> </div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include &quot;fourdst/logging/logging.h&quot;</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include &lt;unordered_map&gt;</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> </div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#include &lt;memory&gt;</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> </div>
<div class="foldopen" id="foldopen00015" data-start="{" data-end="}">
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"><a class="line" href="namespacegridfire_1_1partition.html"> 15</a></span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacegridfire_1_1partition.html">gridfire::partition</a> {</div>
<div class="foldopen" id="foldopen00027" data-start="{" data-end="};">
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"><a class="line" href="classgridfire_1_1partition_1_1_composite_partition_function.html"> 27</a></span> <span class="keyword">class </span><a class="code hl_function" href="classgridfire_1_1partition_1_1_composite_partition_function.html#ad80743933712de627c6a69d06d42ceb5">CompositePartitionFunction</a> final : <span class="keyword">public</span> <a class="code hl_class" href="classgridfire_1_1partition_1_1_partition_function.html">PartitionFunction</a> {</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">explicit</span> <a class="code hl_function" href="classgridfire_1_1partition_1_1_composite_partition_function.html#ad80743933712de627c6a69d06d42ceb5">CompositePartitionFunction</a>(<span class="keyword">const</span> std::vector&lt;BasePartitionType&gt;&amp; partitionFunctions);</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <a class="code hl_function" href="classgridfire_1_1partition_1_1_composite_partition_function.html#ad80743933712de627c6a69d06d42ceb5">CompositePartitionFunction</a>(<span class="keyword">const</span> <a class="code hl_function" href="classgridfire_1_1partition_1_1_composite_partition_function.html#ad80743933712de627c6a69d06d42ceb5">CompositePartitionFunction</a>&amp; other);</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> [[nodiscard]] <span class="keywordtype">double</span> <a class="code hl_function" href="classgridfire_1_1partition_1_1_composite_partition_function.html#a8d6d278fcb5b8478b0e27535f877ee2b">evaluate</a>(<span class="keywordtype">int</span> z, <span class="keywordtype">int</span> a, <span class="keywordtype">double</span> T9) <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> [[nodiscard]] <span class="keywordtype">double</span> <a class="code hl_function" href="classgridfire_1_1partition_1_1_composite_partition_function.html#ac8900afaa5edd24fcb8eaf19e7379183">evaluateDerivative</a>(<span class="keywordtype">int</span> z, <span class="keywordtype">int</span> a, <span class="keywordtype">double</span> T9) <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> [[nodiscard]] <span class="keywordtype">bool</span> <a class="code hl_function" href="classgridfire_1_1partition_1_1_composite_partition_function.html#ae8908a78f087ea516cdd5a4cdd449a9c">supports</a>(<span class="keywordtype">int</span> z, <span class="keywordtype">int</span> a) <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> [[nodiscard]] std::string <a class="code hl_function" href="classgridfire_1_1partition_1_1_composite_partition_function.html#a66560e21a4a7b08e8da135ce8279ed88">type</a>() <span class="keyword">const override</span>;</div>
<div class="foldopen" id="foldopen00088" data-start="{" data-end="}">
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"><a class="line" href="classgridfire_1_1partition_1_1_composite_partition_function.html#a7b000d55c7d1f489e54a57f7f4e3808a"> 88</a></span> [[nodiscard]] std::unique_ptr&lt;PartitionFunction&gt; <a class="code hl_function" href="classgridfire_1_1partition_1_1_composite_partition_function.html#a7b000d55c7d1f489e54a57f7f4e3808a">clone</a>()<span class="keyword"> const override </span>{</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> <span class="keywordflow">return</span> std::make_unique&lt;CompositePartitionFunction&gt;(*<span class="keyword">this</span>);</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> }</div>
</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"><a class="line" href="classgridfire_1_1partition_1_1_composite_partition_function.html#ae0fc1c6abdc86009ba0fc6c9f270ff8b"> 92</a></span> quill::Logger* <a class="code hl_variable" href="classgridfire_1_1partition_1_1_composite_partition_function.html#ae0fc1c6abdc86009ba0fc6c9f270ff8b">m_logger</a> = fourdst::logging::LogManager::getInstance().getLogger(<span class="stringliteral">&quot;log&quot;</span>);</div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"><a class="line" href="classgridfire_1_1partition_1_1_composite_partition_function.html#a85aaac230e9de2fd50d4d453f6d5def8"> 93</a></span> std::vector&lt;std::unique_ptr&lt;PartitionFunction&gt;&gt; <a class="code hl_variable" href="classgridfire_1_1partition_1_1_composite_partition_function.html#a85aaac230e9de2fd50d4d453f6d5def8">m_partitionFunctions</a>; </div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> std::unique_ptr&lt;PartitionFunction&gt; <a class="code hl_function" href="classgridfire_1_1partition_1_1_composite_partition_function.html#a44325e313db7f8f901c0dd5d84d4845b">selectPartitionFunction</a>(<span class="keyword">const</span> <a class="code hl_enumeration" href="namespacegridfire_1_1partition.html#ae931a76ba5efada4ca45ac93333e728c">BasePartitionType</a> <a class="code hl_function" href="classgridfire_1_1partition_1_1_composite_partition_function.html#a66560e21a4a7b08e8da135ce8279ed88">type</a>) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> };</div>
</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> }</div>
</div>
<div class="ttc" id="aclassgridfire_1_1partition_1_1_composite_partition_function_html_a44325e313db7f8f901c0dd5d84d4845b"><div class="ttname"><a href="classgridfire_1_1partition_1_1_composite_partition_function.html#a44325e313db7f8f901c0dd5d84d4845b">gridfire::partition::CompositePartitionFunction::selectPartitionFunction</a></div><div class="ttdeci">std::unique_ptr&lt; PartitionFunction &gt; selectPartitionFunction(const BasePartitionType type) const</div><div class="ttdef"><b>Definition</b> <a href="partition__composite_8cpp_source.html#l00092">partition_composite.cpp:92</a></div></div>
<div class="ttc" id="aclassgridfire_1_1partition_1_1_composite_partition_function_html_a66560e21a4a7b08e8da135ce8279ed88"><div class="ttname"><a href="classgridfire_1_1partition_1_1_composite_partition_function.html#a66560e21a4a7b08e8da135ce8279ed88">gridfire::partition::CompositePartitionFunction::type</a></div><div class="ttdeci">std::string type() const override</div><div class="ttdef"><b>Definition</b> <a href="partition__composite_8cpp_source.html#l00076">partition_composite.cpp:76</a></div></div>
<div class="ttc" id="aclassgridfire_1_1partition_1_1_composite_partition_function_html_a7b000d55c7d1f489e54a57f7f4e3808a"><div class="ttname"><a href="classgridfire_1_1partition_1_1_composite_partition_function.html#a7b000d55c7d1f489e54a57f7f4e3808a">gridfire::partition::CompositePartitionFunction::clone</a></div><div class="ttdeci">std::unique_ptr&lt; PartitionFunction &gt; clone() const override</div><div class="ttdef"><b>Definition</b> <a href="#l00088">partition_composite.h:88</a></div></div>
<div class="ttc" id="aclassgridfire_1_1partition_1_1_composite_partition_function_html_a85aaac230e9de2fd50d4d453f6d5def8"><div class="ttname"><a href="classgridfire_1_1partition_1_1_composite_partition_function.html#a85aaac230e9de2fd50d4d453f6d5def8">gridfire::partition::CompositePartitionFunction::m_partitionFunctions</a></div><div class="ttdeci">std::vector&lt; std::unique_ptr&lt; PartitionFunction &gt; &gt; m_partitionFunctions</div><div class="ttdoc">Set of partition functions to use in the composite partition function.</div><div class="ttdef"><b>Definition</b> <a href="#l00093">partition_composite.h:93</a></div></div>
<div class="ttc" id="aclassgridfire_1_1partition_1_1_composite_partition_function_html_a8d6d278fcb5b8478b0e27535f877ee2b"><div class="ttname"><a href="classgridfire_1_1partition_1_1_composite_partition_function.html#a8d6d278fcb5b8478b0e27535f877ee2b">gridfire::partition::CompositePartitionFunction::evaluate</a></div><div class="ttdeci">double evaluate(int z, int a, double T9) const override</div><div class="ttdef"><b>Definition</b> <a href="partition__composite_8cpp_source.html#l00027">partition_composite.cpp:27</a></div></div>
<div class="ttc" id="aclassgridfire_1_1partition_1_1_composite_partition_function_html_ac8900afaa5edd24fcb8eaf19e7379183"><div class="ttname"><a href="classgridfire_1_1partition_1_1_composite_partition_function.html#ac8900afaa5edd24fcb8eaf19e7379183">gridfire::partition::CompositePartitionFunction::evaluateDerivative</a></div><div class="ttdeci">double evaluateDerivative(int z, int a, double T9) const override</div><div class="ttdef"><b>Definition</b> <a href="partition__composite_8cpp_source.html#l00048">partition_composite.cpp:48</a></div></div>
<div class="ttc" id="aclassgridfire_1_1partition_1_1_composite_partition_function_html_ad80743933712de627c6a69d06d42ceb5"><div class="ttname"><a href="classgridfire_1_1partition_1_1_composite_partition_function.html#ad80743933712de627c6a69d06d42ceb5">gridfire::partition::CompositePartitionFunction::CompositePartitionFunction</a></div><div class="ttdeci">CompositePartitionFunction(const std::vector&lt; BasePartitionType &gt; &amp;partitionFunctions)</div><div class="ttdef"><b>Definition</b> <a href="partition__composite_8cpp_source.html#l00011">partition_composite.cpp:11</a></div></div>
<div class="ttc" id="aclassgridfire_1_1partition_1_1_composite_partition_function_html_ae0fc1c6abdc86009ba0fc6c9f270ff8b"><div class="ttname"><a href="classgridfire_1_1partition_1_1_composite_partition_function.html#ae0fc1c6abdc86009ba0fc6c9f270ff8b">gridfire::partition::CompositePartitionFunction::m_logger</a></div><div class="ttdeci">quill::Logger * m_logger</div><div class="ttdef"><b>Definition</b> <a href="#l00092">partition_composite.h:92</a></div></div>
<div class="ttc" id="aclassgridfire_1_1partition_1_1_composite_partition_function_html_ae8908a78f087ea516cdd5a4cdd449a9c"><div class="ttname"><a href="classgridfire_1_1partition_1_1_composite_partition_function.html#ae8908a78f087ea516cdd5a4cdd449a9c">gridfire::partition::CompositePartitionFunction::supports</a></div><div class="ttdeci">bool supports(int z, int a) const override</div><div class="ttdef"><b>Definition</b> <a href="partition__composite_8cpp_source.html#l00066">partition_composite.cpp:66</a></div></div>
<div class="ttc" id="aclassgridfire_1_1partition_1_1_partition_function_html"><div class="ttname"><a href="classgridfire_1_1partition_1_1_partition_function.html">gridfire::partition::PartitionFunction</a></div><div class="ttdoc">Abstract interface for evaluating nuclear partition functions.</div><div class="ttdef"><b>Definition</b> <a href="partition__abstract_8h_source.html#l00017">partition_abstract.h:17</a></div></div>
<div class="ttc" id="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="#l00015">partition_composite.h:15</a></div></div>
<div class="ttc" id="anamespacegridfire_1_1partition_html_ae931a76ba5efada4ca45ac93333e728c"><div class="ttname"><a href="namespacegridfire_1_1partition.html#ae931a76ba5efada4ca45ac93333e728c">gridfire::partition::BasePartitionType</a></div><div class="ttdeci">BasePartitionType</div><div class="ttdoc">Enumerates available partition function implementations.</div><div class="ttdef"><b>Definition</b> <a href="partition__types_8h_source.html#l00015">partition_types.h:15</a></div></div>
<div class="ttc" id="apartition__abstract_8h_html"><div class="ttname"><a href="partition__abstract_8h.html">partition_abstract.h</a></div></div>
<div class="ttc" id="apartition__types_8h_html"><div class="ttname"><a href="partition__types_8h.html">partition_types.h</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_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="dir_f575fd282ecf3769a887e0c3d3cafd55.html">composite</a></li><li class="navelem"><a class="el" href="partition__composite_8h.html">partition_composite.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>