438 lines
88 KiB
HTML
438 lines
88 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>fourdst::libcomposition: src/composition/include/fourdst/composition/composition.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>
|
|
<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">fourdst::libcomposition<span id="projectnumber"> v2.2.1</span>
|
|
</div>
|
|
<div id="projectbrief">Robust atomic species information library</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>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function() { init_codefold(0); });
|
|
/* @license-end */
|
|
</script>
|
|
</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('composition_8h_source.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="headertitle"><div class="title">composition.h</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="composition_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="comment">/* ***********************************************************************</span></div>
|
|
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">//</span></div>
|
|
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment">// Copyright (C) 2025 -- The 4D-STAR Collaboration</span></div>
|
|
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment">// File Author: Emily Boudreaux</span></div>
|
|
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment">// Last Modified: March 26, 2025</span></div>
|
|
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment">//</span></div>
|
|
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment">// 4DSSE is free software; you can use it and/or modify</span></div>
|
|
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment">// it under the terms and restrictions the GNU General Library Public</span></div>
|
|
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment">// License version 3 (GPLv3) as published by the Free Software Foundation.</span></div>
|
|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment">//</span></div>
|
|
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment">// 4DSSE is distributed in the hope that it will be useful,</span></div>
|
|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment">// but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment">// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</span></div>
|
|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment">// See the GNU Library General Public License for more details.</span></div>
|
|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment">//</span></div>
|
|
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment">// You should have received a copy of the GNU Library General Public License</span></div>
|
|
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment">// along with this software; if not, write to the Free Software</span></div>
|
|
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment">// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</span></div>
|
|
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="comment">//</span></div>
|
|
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="comment">// *********************************************************************** */</span></div>
|
|
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#pragma once</span></div>
|
|
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
|
|
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#include <string></span></div>
|
|
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#include <unordered_map></span></div>
|
|
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include <set></span></div>
|
|
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
|
|
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#include <optional></span></div>
|
|
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#include <unordered_set></span></div>
|
|
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
|
|
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="preprocessor">#include "fourdst/config/config.h"</span></div>
|
|
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="preprocessor">#include "fourdst/logging/logging.h"</span></div>
|
|
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="preprocessor">#include "<a class="code" href="composition__abstract_8h.html">fourdst/composition/composition_abstract.h</a>"</span></div>
|
|
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="preprocessor">#include "<a class="code" href="atomicSpecies_8h.html">fourdst/atomic/atomicSpecies.h</a>"</span></div>
|
|
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div>
|
|
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacefourdst_1_1composition.html">fourdst::composition</a> {</div>
|
|
<div class="foldopen" id="foldopen00045" data-start="{" data-end="};">
|
|
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"><a class="line" href="structfourdst_1_1composition_1_1CanonicalComposition.html"> 45</a></span> <span class="keyword">struct </span><a class="code hl_struct" href="structfourdst_1_1composition_1_1CanonicalComposition.html">CanonicalComposition</a> {</div>
|
|
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="structfourdst_1_1composition_1_1CanonicalComposition.html#abe5b01574242f8eaabd00c3d653291f7"> 46</a></span> <span class="keywordtype">double</span> <a class="code hl_variable" href="structfourdst_1_1composition_1_1CanonicalComposition.html#abe5b01574242f8eaabd00c3d653291f7">X</a> = 0.0; </div>
|
|
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"><a class="line" href="structfourdst_1_1composition_1_1CanonicalComposition.html#a93927bfccc5d2b3906565d092ed4f7f4"> 47</a></span> <span class="keywordtype">double</span> <a class="code hl_variable" href="structfourdst_1_1composition_1_1CanonicalComposition.html#a93927bfccc5d2b3906565d092ed4f7f4">Y</a> = 0.0; </div>
|
|
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="structfourdst_1_1composition_1_1CanonicalComposition.html#ae1981f5ddd36abd17a4a69fa1f43de18"> 48</a></span> <span class="keywordtype">double</span> <a class="code hl_variable" href="structfourdst_1_1composition_1_1CanonicalComposition.html#ae1981f5ddd36abd17a4a69fa1f43de18">Z</a> = 0.0; </div>
|
|
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> </div>
|
|
<div class="foldopen" id="foldopen00056" data-start="{" data-end="};">
|
|
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"><a class="line" href="structfourdst_1_1composition_1_1CanonicalComposition.html#a6e447cb601af6bcbd09e290aef759672"> 56</a></span> <span class="keyword">friend</span> std::ostream& <a class="code hl_friend" href="structfourdst_1_1composition_1_1CanonicalComposition.html#a6e447cb601af6bcbd09e290aef759672">operator<<</a>(std::ostream& os, <span class="keyword">const</span> <a class="code hl_struct" href="structfourdst_1_1composition_1_1CanonicalComposition.html">CanonicalComposition</a>& composition) {</div>
|
|
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> os << <span class="stringliteral">"<CanonicalComposition: "</span></div>
|
|
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> << <span class="stringliteral">"X = "</span> << composition.<a class="code hl_variable" href="structfourdst_1_1composition_1_1CanonicalComposition.html#abe5b01574242f8eaabd00c3d653291f7">X</a> << <span class="stringliteral">", "</span></div>
|
|
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> << <span class="stringliteral">"Y = "</span> << composition.<a class="code hl_variable" href="structfourdst_1_1composition_1_1CanonicalComposition.html#a93927bfccc5d2b3906565d092ed4f7f4">Y</a> << <span class="stringliteral">", "</span></div>
|
|
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> << <span class="stringliteral">"Z = "</span> << composition.<a class="code hl_variable" href="structfourdst_1_1composition_1_1CanonicalComposition.html#ae1981f5ddd36abd17a4a69fa1f43de18">Z</a> << <span class="stringliteral">">"</span>;</div>
|
|
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> <span class="keywordflow">return</span> os;</div>
|
|
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> };</div>
|
|
</div>
|
|
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> </div>
|
|
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> <span class="comment">// ReSharper disable once CppClassCanBeFinal</span></div>
|
|
<div class="foldopen" id="foldopen00098" data-start="{" data-end="};">
|
|
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1Composition.html"> 98</a></span> <span class="keyword">class </span><a class="code hl_class" href="classfourdst_1_1composition_1_1Composition.html">Composition</a> final : <span class="keyword">public</span> <a class="code hl_class" href="classfourdst_1_1composition_1_1CompositionAbstract.html">CompositionAbstract</a> {</div>
|
|
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> <span class="keyword">private</span>:</div>
|
|
<div class="foldopen" id="foldopen00107" data-start="{" data-end="};">
|
|
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"><a class="line" href="structfourdst_1_1composition_1_1Composition_1_1CompositionCache.html"> 107</a></span> <span class="keyword">struct </span><a class="code hl_struct" href="structfourdst_1_1composition_1_1Composition_1_1CompositionCache.html">CompositionCache</a> {</div>
|
|
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"><a class="line" href="structfourdst_1_1composition_1_1Composition_1_1CompositionCache.html#a459e01b94eb0e78dd95bb6932a967f13"> 108</a></span> std::optional<CanonicalComposition> <a class="code hl_variable" href="structfourdst_1_1composition_1_1Composition_1_1CompositionCache.html#a459e01b94eb0e78dd95bb6932a967f13">canonicalComp</a>; </div>
|
|
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"><a class="line" href="structfourdst_1_1composition_1_1Composition_1_1CompositionCache.html#add5ce97ae6a1796c5f6488bfa1555be6"> 109</a></span> std::optional<std::vector<double>> <a class="code hl_variable" href="structfourdst_1_1composition_1_1Composition_1_1CompositionCache.html#add5ce97ae6a1796c5f6488bfa1555be6">massFractions</a>; </div>
|
|
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"><a class="line" href="structfourdst_1_1composition_1_1Composition_1_1CompositionCache.html#a41ce9d6b4a0f00030e3027b23c0269fb"> 110</a></span> std::optional<std::vector<double>> <a class="code hl_variable" href="structfourdst_1_1composition_1_1Composition_1_1CompositionCache.html#a41ce9d6b4a0f00030e3027b23c0269fb">numberFractions</a>; </div>
|
|
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"><a class="line" href="structfourdst_1_1composition_1_1Composition_1_1CompositionCache.html#ab74c9cd92ba8aaf5f95c8ca5284206a6"> 111</a></span> std::optional<std::vector<double>> <a class="code hl_variable" href="structfourdst_1_1composition_1_1Composition_1_1CompositionCache.html#ab74c9cd92ba8aaf5f95c8ca5284206a6">molarAbundances</a>; </div>
|
|
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"><a class="line" href="structfourdst_1_1composition_1_1Composition_1_1CompositionCache.html#a14761ff2df5423884330e423ec38e98c"> 112</a></span> std::optional<std::vector<atomic::Species>> <a class="code hl_variable" href="structfourdst_1_1composition_1_1Composition_1_1CompositionCache.html#a14761ff2df5423884330e423ec38e98c">sortedSpecies</a>; </div>
|
|
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"><a class="line" href="structfourdst_1_1composition_1_1Composition_1_1CompositionCache.html#abe45010a5104562d3ebecc77393c04ce"> 113</a></span> std::optional<std::vector<std::string>> <a class="code hl_variable" href="structfourdst_1_1composition_1_1Composition_1_1CompositionCache.html#abe45010a5104562d3ebecc77393c04ce">sortedSymbols</a>; </div>
|
|
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"><a class="line" href="structfourdst_1_1composition_1_1Composition_1_1CompositionCache.html#ae844e5a1d2b85c7cfee50157ccf189ce"> 114</a></span> std::optional<double> <a class="code hl_variable" href="structfourdst_1_1composition_1_1Composition_1_1CompositionCache.html#ae844e5a1d2b85c7cfee50157ccf189ce">Ye</a>; </div>
|
|
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> </div>
|
|
<div class="foldopen" id="foldopen00119" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"><a class="line" href="structfourdst_1_1composition_1_1Composition_1_1CompositionCache.html#ac8b576c3b48c4cedda6e9e2790072b0d"> 119</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="structfourdst_1_1composition_1_1Composition_1_1CompositionCache.html#ac8b576c3b48c4cedda6e9e2790072b0d">clear</a>() {</div>
|
|
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> <a class="code hl_variable" href="structfourdst_1_1composition_1_1Composition_1_1CompositionCache.html#a459e01b94eb0e78dd95bb6932a967f13">canonicalComp</a> = std::nullopt;</div>
|
|
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span> <a class="code hl_variable" href="structfourdst_1_1composition_1_1Composition_1_1CompositionCache.html#add5ce97ae6a1796c5f6488bfa1555be6">massFractions</a> = std::nullopt;</div>
|
|
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span> <a class="code hl_variable" href="structfourdst_1_1composition_1_1Composition_1_1CompositionCache.html#a41ce9d6b4a0f00030e3027b23c0269fb">numberFractions</a> = std::nullopt;</div>
|
|
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span> <a class="code hl_variable" href="structfourdst_1_1composition_1_1Composition_1_1CompositionCache.html#ab74c9cd92ba8aaf5f95c8ca5284206a6">molarAbundances</a> = std::nullopt;</div>
|
|
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> <a class="code hl_variable" href="structfourdst_1_1composition_1_1Composition_1_1CompositionCache.html#abe45010a5104562d3ebecc77393c04ce">sortedSymbols</a> = std::nullopt;</div>
|
|
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> <a class="code hl_variable" href="structfourdst_1_1composition_1_1Composition_1_1CompositionCache.html#a14761ff2df5423884330e423ec38e98c">sortedSpecies</a> = std::nullopt;</div>
|
|
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span> <a class="code hl_variable" href="structfourdst_1_1composition_1_1Composition_1_1CompositionCache.html#ae844e5a1d2b85c7cfee50157ccf189ce">Ye</a> = std::nullopt;</div>
|
|
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span> </div>
|
|
<div class="foldopen" id="foldopen00133" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"><a class="line" href="structfourdst_1_1composition_1_1Composition_1_1CompositionCache.html#af291583560120bb53c4546a598666477"> 133</a></span> [[nodiscard]] <span class="keywordtype">bool</span> <a class="code hl_function" href="structfourdst_1_1composition_1_1Composition_1_1CompositionCache.html#af291583560120bb53c4546a598666477">is_clear</a>()<span class="keyword"> const </span>{</div>
|
|
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span> <span class="keywordflow">return</span> !<a class="code hl_variable" href="structfourdst_1_1composition_1_1Composition_1_1CompositionCache.html#a459e01b94eb0e78dd95bb6932a967f13">canonicalComp</a>.has_value() && !<a class="code hl_variable" href="structfourdst_1_1composition_1_1Composition_1_1CompositionCache.html#add5ce97ae6a1796c5f6488bfa1555be6">massFractions</a>.has_value() &&</div>
|
|
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span> !<a class="code hl_variable" href="structfourdst_1_1composition_1_1Composition_1_1CompositionCache.html#a41ce9d6b4a0f00030e3027b23c0269fb">numberFractions</a>.has_value() && !<a class="code hl_variable" href="structfourdst_1_1composition_1_1Composition_1_1CompositionCache.html#ab74c9cd92ba8aaf5f95c8ca5284206a6">molarAbundances</a>.has_value() && !<a class="code hl_variable" href="structfourdst_1_1composition_1_1Composition_1_1CompositionCache.html#abe45010a5104562d3ebecc77393c04ce">sortedSymbols</a>.has_value() &&</div>
|
|
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span> !<a class="code hl_variable" href="structfourdst_1_1composition_1_1Composition_1_1CompositionCache.html#ae844e5a1d2b85c7cfee50157ccf189ce">Ye</a>.has_value() && !<a class="code hl_variable" href="structfourdst_1_1composition_1_1Composition_1_1CompositionCache.html#a14761ff2df5423884330e423ec38e98c">sortedSpecies</a>.has_value();</div>
|
|
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span> };</div>
|
|
</div>
|
|
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span> <span class="keyword">private</span>:</div>
|
|
<div class="foldopen" id="foldopen00145" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1Composition.html#a46a706f9e4c06a45b45ae3dffdde5e9e"> 145</a></span> <span class="keyword">static</span> quill::Logger* <a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#a46a706f9e4c06a45b45ae3dffdde5e9e">getLogger</a>() {</div>
|
|
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno"> 146</span> <span class="keyword">static</span> quill::Logger* logger = logging::LogManager::getInstance().getLogger(<span class="stringliteral">"log"</span>);</div>
|
|
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno"> 147</span> <span class="keywordflow">return</span> logger;</div>
|
|
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno"> 148</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno"> 149</span> </div>
|
|
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1Composition.html#a452b0affb86dc971a96c80d01f4fcb2b"> 150</a></span> std::set<atomic::Species> <a class="code hl_variable" href="classfourdst_1_1composition_1_1Composition.html#a452b0affb86dc971a96c80d01f4fcb2b">m_registeredSpecies</a>; </div>
|
|
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1Composition.html#aa05a640e0ea80142682bf4ee30a93c7f"> 151</a></span> std::map<atomic::Species, double> <a class="code hl_variable" href="classfourdst_1_1composition_1_1Composition.html#aa05a640e0ea80142682bf4ee30a93c7f">m_molarAbundances</a>; </div>
|
|
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno"> 152</span> </div>
|
|
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1Composition.html#a02cd9d9608da082a200fdfa86d14bf5d"> 153</a></span> <span class="keyword">mutable</span> <a class="code hl_struct" href="structfourdst_1_1composition_1_1Composition_1_1CompositionCache.html">CompositionCache</a> <a class="code hl_variable" href="classfourdst_1_1composition_1_1Composition.html#a02cd9d9608da082a200fdfa86d14bf5d">m_cache</a>; </div>
|
|
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno"> 154</span> </div>
|
|
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno"> 155</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1Composition.html#a23b83b76ee025f6fc009184ee19bba88"> 161</a></span> <a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#a23b83b76ee025f6fc009184ee19bba88">Composition</a>() = <span class="keywordflow">default</span>;</div>
|
|
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno"> 162</span> </div>
|
|
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1Composition.html#a08c1d1fe9384c5255a6ba40e34b18315"> 166</a></span> <a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#a08c1d1fe9384c5255a6ba40e34b18315">~Composition</a>() <span class="keyword">override</span> = <span class="keywordflow">default</span>;</div>
|
|
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno"> 167</span> </div>
|
|
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno"> 178</span> <span class="keyword">explicit</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#a23b83b76ee025f6fc009184ee19bba88">Composition</a>(<span class="keyword">const</span> std::vector<std::string>& symbols);</div>
|
|
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno"> 179</span> </div>
|
|
<div class="line"><a id="l00193" name="l00193"></a><span class="lineno"> 193</span> <span class="keyword">explicit</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#a23b83b76ee025f6fc009184ee19bba88">Composition</a>(<span class="keyword">const</span> std::vector<atomic::Species>& species);</div>
|
|
<div class="line"><a id="l00194" name="l00194"></a><span class="lineno"> 194</span> </div>
|
|
<div class="line"><a id="l00205" name="l00205"></a><span class="lineno"> 205</span> <span class="keyword">explicit</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#a23b83b76ee025f6fc009184ee19bba88">Composition</a>(<span class="keyword">const</span> std::set<std::string>& symbols);</div>
|
|
<div class="line"><a id="l00206" name="l00206"></a><span class="lineno"> 206</span> </div>
|
|
<div class="line"><a id="l00220" name="l00220"></a><span class="lineno"> 220</span> <span class="keyword">explicit</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#a23b83b76ee025f6fc009184ee19bba88">Composition</a>(<span class="keyword">const</span> std::set<atomic::Species>& species);</div>
|
|
<div class="line"><a id="l00221" name="l00221"></a><span class="lineno"> 221</span> </div>
|
|
<div class="line"><a id="l00222" name="l00222"></a><span class="lineno"> 222</span> <span class="keyword">explicit</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#a23b83b76ee025f6fc009184ee19bba88">Composition</a>(<span class="keyword">const</span> std::unordered_set<std::string>& symbols);</div>
|
|
<div class="line"><a id="l00223" name="l00223"></a><span class="lineno"> 223</span> <span class="keyword">explicit</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#a23b83b76ee025f6fc009184ee19bba88">Composition</a>(<span class="keyword">const</span> std::unordered_set<atomic::Species>& species);</div>
|
|
<div class="line"><a id="l00224" name="l00224"></a><span class="lineno"> 224</span> </div>
|
|
<div class="line"><a id="l00240" name="l00240"></a><span class="lineno"> 240</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#a23b83b76ee025f6fc009184ee19bba88">Composition</a>(<span class="keyword">const</span> std::vector<std::string>& symbols, <span class="keyword">const</span> std::vector<double>& molarAbundances);</div>
|
|
<div class="line"><a id="l00241" name="l00241"></a><span class="lineno"> 241</span> </div>
|
|
<div class="line"><a id="l00256" name="l00256"></a><span class="lineno"> 256</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#a23b83b76ee025f6fc009184ee19bba88">Composition</a>(<span class="keyword">const</span> std::vector<atomic::Species>& species, <span class="keyword">const</span> std::vector<double>& molarAbundances);</div>
|
|
<div class="line"><a id="l00257" name="l00257"></a><span class="lineno"> 257</span> </div>
|
|
<div class="line"><a id="l00273" name="l00273"></a><span class="lineno"> 273</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#a23b83b76ee025f6fc009184ee19bba88">Composition</a>(<span class="keyword">const</span> std::set<std::string>& symbols, <span class="keyword">const</span> std::vector<double>& molarAbundances);</div>
|
|
<div class="line"><a id="l00274" name="l00274"></a><span class="lineno"> 274</span> </div>
|
|
<div class="line"><a id="l00275" name="l00275"></a><span class="lineno"> 275</span> <span class="keyword">explicit</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#a23b83b76ee025f6fc009184ee19bba88">Composition</a>(<span class="keyword">const</span> std::unordered_map<std::string, double>& symbolMolarAbundances);</div>
|
|
<div class="line"><a id="l00276" name="l00276"></a><span class="lineno"> 276</span> <span class="keyword">explicit</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#a23b83b76ee025f6fc009184ee19bba88">Composition</a>(<span class="keyword">const</span> std::map<std::string, double>& symbolMolarAbundances);</div>
|
|
<div class="line"><a id="l00277" name="l00277"></a><span class="lineno"> 277</span> </div>
|
|
<div class="line"><a id="l00278" name="l00278"></a><span class="lineno"> 278</span> <span class="keyword">explicit</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#a23b83b76ee025f6fc009184ee19bba88">Composition</a>(<span class="keyword">const</span> std::unordered_map<atomic::Species, double>& speciesMolarAbundances);</div>
|
|
<div class="line"><a id="l00279" name="l00279"></a><span class="lineno"> 279</span> <span class="keyword">explicit</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#a23b83b76ee025f6fc009184ee19bba88">Composition</a>(<span class="keyword">const</span> std::map<atomic::Species, double>& speciesMolarAbundances);</div>
|
|
<div class="line"><a id="l00280" name="l00280"></a><span class="lineno"> 280</span> </div>
|
|
<div class="line"><a id="l00281" name="l00281"></a><span class="lineno"> 281</span> </div>
|
|
<div class="line"><a id="l00286" name="l00286"></a><span class="lineno"> 286</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#a23b83b76ee025f6fc009184ee19bba88">Composition</a>(<span class="keyword">const</span> <a class="code hl_class" href="classfourdst_1_1composition_1_1Composition.html">Composition</a>& composition);</div>
|
|
<div class="line"><a id="l00287" name="l00287"></a><span class="lineno"> 287</span> </div>
|
|
<div class="line"><a id="l00288" name="l00288"></a><span class="lineno"> 288</span> <span class="keyword">explicit</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#a23b83b76ee025f6fc009184ee19bba88">Composition</a>(<span class="keyword">const</span> <a class="code hl_class" href="classfourdst_1_1composition_1_1CompositionAbstract.html">CompositionAbstract</a>& composition);</div>
|
|
<div class="line"><a id="l00289" name="l00289"></a><span class="lineno"> 289</span> </div>
|
|
<div class="line"><a id="l00295" name="l00295"></a><span class="lineno"> 295</span> <a class="code hl_class" href="classfourdst_1_1composition_1_1Composition.html">Composition</a>& <a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#a4ec1e23cfecef764cb831171fed62fc2">operator=</a>(<a class="code hl_class" href="classfourdst_1_1composition_1_1Composition.html">Composition</a> <span class="keyword">const</span>& other);</div>
|
|
<div class="line"><a id="l00296" name="l00296"></a><span class="lineno"> 296</span> </div>
|
|
<div class="line"><a id="l00311" name="l00311"></a><span class="lineno"> 311</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#a3ab4dcda0bfd1a35b169bcc57fe66725">registerSymbol</a>(<span class="keyword">const</span> std::string& symbol);</div>
|
|
<div class="line"><a id="l00312" name="l00312"></a><span class="lineno"> 312</span> </div>
|
|
<div class="line"><a id="l00327" name="l00327"></a><span class="lineno"> 327</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#a3ab4dcda0bfd1a35b169bcc57fe66725">registerSymbol</a>(<span class="keyword">const</span> std::vector<std::string>& symbols);</div>
|
|
<div class="line"><a id="l00328" name="l00328"></a><span class="lineno"> 328</span> </div>
|
|
<div class="line"><a id="l00351" name="l00351"></a><span class="lineno"> 351</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#a392a34c19f45d6c936cc7030e6cfaf3f">registerSpecies</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structfourdst_1_1atomic_1_1Species.html">atomic::Species</a>& species) <span class="keyword">noexcept</span>;</div>
|
|
<div class="line"><a id="l00352" name="l00352"></a><span class="lineno"> 352</span> </div>
|
|
<div class="line"><a id="l00353" name="l00353"></a><span class="lineno"> 353</span> </div>
|
|
<div class="line"><a id="l00373" name="l00373"></a><span class="lineno"> 373</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#a392a34c19f45d6c936cc7030e6cfaf3f">registerSpecies</a>(<span class="keyword">const</span> std::vector<atomic::Species>& species) <span class="keyword">noexcept</span>;</div>
|
|
<div class="line"><a id="l00374" name="l00374"></a><span class="lineno"> 374</span> </div>
|
|
<div class="line"><a id="l00380" name="l00380"></a><span class="lineno"> 380</span> [[nodiscard]] <span class="keywordtype">bool</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#a194f715788e7921bd611579440de2ecd">contains</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structfourdst_1_1atomic_1_1Species.html">atomic::Species</a>& species) <span class="keyword">const</span> <span class="keyword">noexcept</span> <span class="keyword">override</span>;</div>
|
|
<div class="line"><a id="l00381" name="l00381"></a><span class="lineno"> 381</span> </div>
|
|
<div class="line"><a id="l00388" name="l00388"></a><span class="lineno"> 388</span> [[nodiscard]] <span class="keywordtype">bool</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#a194f715788e7921bd611579440de2ecd">contains</a>(<span class="keyword">const</span> std::string& symbol) <span class="keyword">const override</span>;</div>
|
|
<div class="line"><a id="l00389" name="l00389"></a><span class="lineno"> 389</span> </div>
|
|
<div class="line"><a id="l00394" name="l00394"></a><span class="lineno"> 394</span> [[nodiscard]] <span class="keywordtype">size_t</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#a9d177d36b728442bcbd8cb66712c7c75">size</a>() const noexcept override;</div>
|
|
<div class="line"><a id="l00395" name="l00395"></a><span class="lineno"> 395</span> </div>
|
|
<div class="line"><a id="l00412" name="l00412"></a><span class="lineno"> 412</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#a262d7133035d4e6f45daa81827abf5e7">setMolarAbundance</a>(</div>
|
|
<div class="line"><a id="l00413" name="l00413"></a><span class="lineno"> 413</span> const <a class="code hl_namespace" href="namespacestd.html">std</a>::<span class="keywordtype">string</span>& symbol,</div>
|
|
<div class="line"><a id="l00414" name="l00414"></a><span class="lineno"> 414</span> const <span class="keywordtype">double</span>& molar_abundance</div>
|
|
<div class="line"><a id="l00415" name="l00415"></a><span class="lineno"> 415</span> );</div>
|
|
<div class="line"><a id="l00416" name="l00416"></a><span class="lineno"> 416</span> </div>
|
|
<div class="line"><a id="l00436" name="l00436"></a><span class="lineno"> 436</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#a262d7133035d4e6f45daa81827abf5e7">setMolarAbundance</a>(</div>
|
|
<div class="line"><a id="l00437" name="l00437"></a><span class="lineno"> 437</span> const atomic::Species& species,</div>
|
|
<div class="line"><a id="l00438" name="l00438"></a><span class="lineno"> 438</span> const <span class="keywordtype">double</span>& molar_abundance</div>
|
|
<div class="line"><a id="l00439" name="l00439"></a><span class="lineno"> 439</span> );</div>
|
|
<div class="line"><a id="l00440" name="l00440"></a><span class="lineno"> 440</span> </div>
|
|
<div class="line"><a id="l00456" name="l00456"></a><span class="lineno"> 456</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#a262d7133035d4e6f45daa81827abf5e7">setMolarAbundance</a>(</div>
|
|
<div class="line"><a id="l00457" name="l00457"></a><span class="lineno"> 457</span> const <a class="code hl_namespace" href="namespacestd.html">std</a>::vector<<a class="code hl_namespace" href="namespacestd.html">std</a>::<span class="keywordtype">string</span>>& symbols,</div>
|
|
<div class="line"><a id="l00458" name="l00458"></a><span class="lineno"> 458</span> const <a class="code hl_namespace" href="namespacestd.html">std</a>::vector<<span class="keywordtype">double</span>>& molar_abundances</div>
|
|
<div class="line"><a id="l00459" name="l00459"></a><span class="lineno"> 459</span> );</div>
|
|
<div class="line"><a id="l00460" name="l00460"></a><span class="lineno"> 460</span> </div>
|
|
<div class="line"><a id="l00479" name="l00479"></a><span class="lineno"> 479</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#a262d7133035d4e6f45daa81827abf5e7">setMolarAbundance</a>(</div>
|
|
<div class="line"><a id="l00480" name="l00480"></a><span class="lineno"> 480</span> const <a class="code hl_namespace" href="namespacestd.html">std</a>::vector<atomic::Species>& species,</div>
|
|
<div class="line"><a id="l00481" name="l00481"></a><span class="lineno"> 481</span> const <a class="code hl_namespace" href="namespacestd.html">std</a>::vector<<span class="keywordtype">double</span>>& molar_abundances</div>
|
|
<div class="line"><a id="l00482" name="l00482"></a><span class="lineno"> 482</span> );</div>
|
|
<div class="line"><a id="l00483" name="l00483"></a><span class="lineno"> 483</span> </div>
|
|
<div class="line"><a id="l00500" name="l00500"></a><span class="lineno"> 500</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#a262d7133035d4e6f45daa81827abf5e7">setMolarAbundance</a>(</div>
|
|
<div class="line"><a id="l00501" name="l00501"></a><span class="lineno"> 501</span> const <a class="code hl_namespace" href="namespacestd.html">std</a>::set<<a class="code hl_namespace" href="namespacestd.html">std</a>::<span class="keywordtype">string</span>>& symbols,</div>
|
|
<div class="line"><a id="l00502" name="l00502"></a><span class="lineno"> 502</span> const <a class="code hl_namespace" href="namespacestd.html">std</a>::vector<<span class="keywordtype">double</span>>& molar_abundances</div>
|
|
<div class="line"><a id="l00503" name="l00503"></a><span class="lineno"> 503</span> );</div>
|
|
<div class="line"><a id="l00504" name="l00504"></a><span class="lineno"> 504</span> </div>
|
|
<div class="line"><a id="l00524" name="l00524"></a><span class="lineno"> 524</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#a262d7133035d4e6f45daa81827abf5e7">setMolarAbundance</a>(</div>
|
|
<div class="line"><a id="l00525" name="l00525"></a><span class="lineno"> 525</span> const <a class="code hl_namespace" href="namespacestd.html">std</a>::set<atomic::Species>& species,</div>
|
|
<div class="line"><a id="l00526" name="l00526"></a><span class="lineno"> 526</span> const <a class="code hl_namespace" href="namespacestd.html">std</a>::vector<<span class="keywordtype">double</span>>& molar_abundances</div>
|
|
<div class="line"><a id="l00527" name="l00527"></a><span class="lineno"> 527</span> );</div>
|
|
<div class="line"><a id="l00528" name="l00528"></a><span class="lineno"> 528</span> </div>
|
|
<div class="line"><a id="l00537" name="l00537"></a><span class="lineno"> 537</span> [[nodiscard]] <a class="code hl_namespace" href="namespacestd.html">std</a>::set<<a class="code hl_namespace" href="namespacestd.html">std</a>::<span class="keywordtype">string</span>> <a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#a3ae885c28580ae15be8c16614bef3b0e">getRegisteredSymbols</a>() const noexcept override;</div>
|
|
<div class="line"><a id="l00538" name="l00538"></a><span class="lineno"> 538</span> </div>
|
|
<div class="line"><a id="l00547" name="l00547"></a><span class="lineno"> 547</span> [[nodiscard]] const <a class="code hl_namespace" href="namespacestd.html">std</a>::set<atomic::Species> &<a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#a33db253ca50431b5166d43412ff18f71">getRegisteredSpecies</a>() const noexcept override;</div>
|
|
<div class="line"><a id="l00548" name="l00548"></a><span class="lineno"> 548</span> </div>
|
|
<div class="line"><a id="l00555" name="l00555"></a><span class="lineno"> 555</span> [[nodiscard]] <a class="code hl_namespace" href="namespacestd.html">std</a>::unordered_map<atomic::Species, <span class="keywordtype">double</span>> <a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#a9ea2b673341fdc67afeb0f0517a54c8c">getMassFraction</a>() const noexcept override;</div>
|
|
<div class="line"><a id="l00556" name="l00556"></a><span class="lineno"> 556</span> </div>
|
|
<div class="line"><a id="l00565" name="l00565"></a><span class="lineno"> 565</span> [[nodiscard]] <span class="keywordtype">double</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#a9ea2b673341fdc67afeb0f0517a54c8c">getMassFraction</a>(const <a class="code hl_namespace" href="namespacestd.html">std</a>::<span class="keywordtype">string</span>& symbol) const override;</div>
|
|
<div class="line"><a id="l00566" name="l00566"></a><span class="lineno"> 566</span> </div>
|
|
<div class="line"><a id="l00584" name="l00584"></a><span class="lineno"> 584</span> [[nodiscard]] <span class="keywordtype">double</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#a9ea2b673341fdc67afeb0f0517a54c8c">getMassFraction</a>(const atomic::Species& species) const override;</div>
|
|
<div class="line"><a id="l00585" name="l00585"></a><span class="lineno"> 585</span> </div>
|
|
<div class="line"><a id="l00594" name="l00594"></a><span class="lineno"> 594</span> [[nodiscard]] <span class="keywordtype">double</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#a1f87ed64a1be9a6091c852131d24e476">getNumberFraction</a>(const <a class="code hl_namespace" href="namespacestd.html">std</a>::<span class="keywordtype">string</span>& symbol) const override;</div>
|
|
<div class="line"><a id="l00595" name="l00595"></a><span class="lineno"> 595</span> </div>
|
|
<div class="line"><a id="l00612" name="l00612"></a><span class="lineno"> 612</span> [[nodiscard]] <span class="keywordtype">double</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#a1f87ed64a1be9a6091c852131d24e476">getNumberFraction</a>(const atomic::Species& species) const override;</div>
|
|
<div class="line"><a id="l00613" name="l00613"></a><span class="lineno"> 613</span> </div>
|
|
<div class="line"><a id="l00620" name="l00620"></a><span class="lineno"> 620</span> [[nodiscard]] <a class="code hl_namespace" href="namespacestd.html">std</a>::unordered_map<atomic::Species, <span class="keywordtype">double</span>> <a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#a1f87ed64a1be9a6091c852131d24e476">getNumberFraction</a>() const noexcept override;</div>
|
|
<div class="line"><a id="l00621" name="l00621"></a><span class="lineno"> 621</span> </div>
|
|
<div class="line"><a id="l00632" name="l00632"></a><span class="lineno"> 632</span> [[nodiscard]] <span class="keywordtype">double</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#add67a92d73e3a57a2bbdb52bc9ca3bfe">getMolarAbundance</a>(const <a class="code hl_namespace" href="namespacestd.html">std</a>::<span class="keywordtype">string</span>& symbol) const override;</div>
|
|
<div class="line"><a id="l00633" name="l00633"></a><span class="lineno"> 633</span> </div>
|
|
<div class="line"><a id="l00643" name="l00643"></a><span class="lineno"> 643</span> [[nodiscard]] <span class="keywordtype">double</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#add67a92d73e3a57a2bbdb52bc9ca3bfe">getMolarAbundance</a>(const atomic::Species& species) const override;</div>
|
|
<div class="line"><a id="l00644" name="l00644"></a><span class="lineno"> 644</span> </div>
|
|
<div class="line"><a id="l00658" name="l00658"></a><span class="lineno"> 658</span> [[nodiscard]] <span class="keywordtype">double</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#afbbb5e51ad5ae5c0fa6bc0094195aecd">getMeanParticleMass</a>() const noexcept override;</div>
|
|
<div class="line"><a id="l00659" name="l00659"></a><span class="lineno"> 659</span> </div>
|
|
<div class="line"><a id="l00673" name="l00673"></a><span class="lineno"> 673</span> [[nodiscard]] <span class="keywordtype">double</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#a90fc71d1fe03017ee4c7a1cac69d24fb">getElectronAbundance</a>() const noexcept override;</div>
|
|
<div class="line"><a id="l00674" name="l00674"></a><span class="lineno"> 674</span> </div>
|
|
<div class="line"><a id="l00675" name="l00675"></a><span class="lineno"> 675</span> </div>
|
|
<div class="line"><a id="l00690" name="l00690"></a><span class="lineno"> 690</span> [[nodiscard]] <a class="code hl_struct" href="structfourdst_1_1composition_1_1CanonicalComposition.html">CanonicalComposition</a> <a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#aac5b214a3d1278e127422224cb9cee50">getCanonicalComposition</a>() const;</div>
|
|
<div class="line"><a id="l00691" name="l00691"></a><span class="lineno"> 691</span> </div>
|
|
<div class="line"><a id="l00697" name="l00697"></a><span class="lineno"> 697</span> [[nodiscard]] <a class="code hl_namespace" href="namespacestd.html">std</a>::vector<<span class="keywordtype">double</span>> <a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#af4f44aaf8b7e0d63872a70b5e2131369">getMassFractionVector</a>() const noexcept override;</div>
|
|
<div class="line"><a id="l00698" name="l00698"></a><span class="lineno"> 698</span> </div>
|
|
<div class="line"><a id="l00704" name="l00704"></a><span class="lineno"> 704</span> [[nodiscard]] <a class="code hl_namespace" href="namespacestd.html">std</a>::vector<<span class="keywordtype">double</span>> <a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#ae4f72972cf4d1ff422d0790080e11473">getNumberFractionVector</a>() const noexcept override;</div>
|
|
<div class="line"><a id="l00705" name="l00705"></a><span class="lineno"> 705</span> </div>
|
|
<div class="line"><a id="l00711" name="l00711"></a><span class="lineno"> 711</span> [[nodiscard]] <a class="code hl_namespace" href="namespacestd.html">std</a>::vector<<span class="keywordtype">double</span>> <a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#abcb391f5fca2b636127e48e681e4c3ee">getMolarAbundanceVector</a>() const noexcept override;</div>
|
|
<div class="line"><a id="l00712" name="l00712"></a><span class="lineno"> 712</span> </div>
|
|
<div class="line"><a id="l00721" name="l00721"></a><span class="lineno"> 721</span> [[nodiscard]] <span class="keywordtype">size_t</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#a0d94f62402bb90b5d12679faeaa8c5d7">getSpeciesIndex</a>(const <a class="code hl_namespace" href="namespacestd.html">std</a>::<span class="keywordtype">string</span>& symbol) const override;</div>
|
|
<div class="line"><a id="l00722" name="l00722"></a><span class="lineno"> 722</span> </div>
|
|
<div class="line"><a id="l00730" name="l00730"></a><span class="lineno"> 730</span> [[nodiscard]] <span class="keywordtype">size_t</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#a0d94f62402bb90b5d12679faeaa8c5d7">getSpeciesIndex</a>(const atomic::Species& species) const override;</div>
|
|
<div class="line"><a id="l00731" name="l00731"></a><span class="lineno"> 731</span> </div>
|
|
<div class="line"><a id="l00739" name="l00739"></a><span class="lineno"> 739</span> [[nodiscard]] atomic::Species <a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#ae4f854ded38f5e6fcd157a74a57cbf0c">getSpeciesAtIndex</a>(<span class="keywordtype">size_t</span> index) const override;</div>
|
|
<div class="line"><a id="l00740" name="l00740"></a><span class="lineno"> 740</span> </div>
|
|
<div class="line"><a id="l00741" name="l00741"></a><span class="lineno"> 741</span> [[nodiscard]] <a class="code hl_namespace" href="namespacestd.html">std</a>::unique_ptr<<a class="code hl_class" href="classfourdst_1_1composition_1_1CompositionAbstract.html">CompositionAbstract</a>> <a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#a5a1f5661a329ec7bc8b7e118ff9d6c25">clone</a>() const override;</div>
|
|
<div class="line"><a id="l00742" name="l00742"></a><span class="lineno"> 742</span> </div>
|
|
<div class="line"><a id="l00749" name="l00749"></a><span class="lineno"> 749</span> friend <a class="code hl_namespace" href="namespacestd.html">std</a>::ostream& operator<<(<a class="code hl_namespace" href="namespacestd.html">std</a>::ostream& os, const <a class="code hl_class" href="classfourdst_1_1composition_1_1Composition.html">Composition</a>& composition);</div>
|
|
<div class="line"><a id="l00750" name="l00750"></a><span class="lineno"> 750</span> </div>
|
|
<div class="foldopen" id="foldopen00768" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00768" name="l00768"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1Composition.html#a8699ef1c21f7cf21a26ab2f83cfd9785"> 768</a></span> [[nodiscard]] <a class="code hl_namespace" href="namespacestd.html">std</a>::map<atomic::Species, <span class="keywordtype">double</span>>::iterator <a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#a8699ef1c21f7cf21a26ab2f83cfd9785">begin</a>()<span class="keyword"> override </span>{</div>
|
|
<div class="line"><a id="l00769" name="l00769"></a><span class="lineno"> 769</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="classfourdst_1_1composition_1_1Composition.html#aa05a640e0ea80142682bf4ee30a93c7f">m_molarAbundances</a>.begin();</div>
|
|
<div class="line"><a id="l00770" name="l00770"></a><span class="lineno"> 770</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00771" name="l00771"></a><span class="lineno"> 771</span> </div>
|
|
<div class="foldopen" id="foldopen00789" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00789" name="l00789"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1Composition.html#a5f6ca82e740a9297dad4bb9cc1075112"> 789</a></span> [[nodiscard]] std::map<atomic::Species, double>::const_iterator <a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#a5f6ca82e740a9297dad4bb9cc1075112">begin</a>()<span class="keyword"> const override </span>{</div>
|
|
<div class="line"><a id="l00790" name="l00790"></a><span class="lineno"> 790</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="classfourdst_1_1composition_1_1Composition.html#aa05a640e0ea80142682bf4ee30a93c7f">m_molarAbundances</a>.cbegin();</div>
|
|
<div class="line"><a id="l00791" name="l00791"></a><span class="lineno"> 791</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00792" name="l00792"></a><span class="lineno"> 792</span> </div>
|
|
<div class="foldopen" id="foldopen00810" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00810" name="l00810"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1Composition.html#a8c07a604bff4963b9f8a1f11175f97cf"> 810</a></span> [[nodiscard]] std::map<atomic::Species, double>::iterator <a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#a8c07a604bff4963b9f8a1f11175f97cf">end</a>()<span class="keyword"> override </span>{</div>
|
|
<div class="line"><a id="l00811" name="l00811"></a><span class="lineno"> 811</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="classfourdst_1_1composition_1_1Composition.html#aa05a640e0ea80142682bf4ee30a93c7f">m_molarAbundances</a>.end();</div>
|
|
<div class="line"><a id="l00812" name="l00812"></a><span class="lineno"> 812</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00813" name="l00813"></a><span class="lineno"> 813</span> </div>
|
|
<div class="foldopen" id="foldopen00831" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00831" name="l00831"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1Composition.html#a12be36a912c1a1f59affba37d44431ef"> 831</a></span> [[nodiscard]] std::map<atomic::Species, double>::const_iterator <a class="code hl_function" href="classfourdst_1_1composition_1_1Composition.html#a12be36a912c1a1f59affba37d44431ef">end</a>()<span class="keyword"> const override </span>{</div>
|
|
<div class="line"><a id="l00832" name="l00832"></a><span class="lineno"> 832</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="classfourdst_1_1composition_1_1Composition.html#aa05a640e0ea80142682bf4ee30a93c7f">m_molarAbundances</a>.cend();</div>
|
|
<div class="line"><a id="l00833" name="l00833"></a><span class="lineno"> 833</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00834" name="l00834"></a><span class="lineno"> 834</span> </div>
|
|
<div class="line"><a id="l00835" name="l00835"></a><span class="lineno"> 835</span> };</div>
|
|
</div>
|
|
<div class="line"><a id="l00836" name="l00836"></a><span class="lineno"> 836</span> </div>
|
|
<div class="foldopen" id="foldopen00837" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00837" name="l00837"></a><span class="lineno"><a class="line" href="namespacefourdst_1_1composition.html#a06f5abc74104de40349e47ad367c402a"> 837</a></span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="namespacefourdst_1_1composition.html#a06f5abc74104de40349e47ad367c402a">operator==</a>(<span class="keyword">const</span> <a class="code hl_class" href="classfourdst_1_1composition_1_1Composition.html">Composition</a>& a, <span class="keyword">const</span> <a class="code hl_class" href="classfourdst_1_1composition_1_1Composition.html">Composition</a>& b) <span class="keyword">noexcept</span> {</div>
|
|
<div class="line"><a id="l00838" name="l00838"></a><span class="lineno"> 838</span> <span class="keywordflow">if</span> (a.size() != b.size()) <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
|
|
<div class="line"><a id="l00839" name="l00839"></a><span class="lineno"> 839</span> </div>
|
|
<div class="line"><a id="l00840" name="l00840"></a><span class="lineno"> 840</span> <span class="comment">// Compare species sets quickly</span></div>
|
|
<div class="line"><a id="l00841" name="l00841"></a><span class="lineno"> 841</span> <span class="keywordflow">if</span> (a.getRegisteredSpecies() != b.getRegisteredSpecies())</div>
|
|
<div class="line"><a id="l00842" name="l00842"></a><span class="lineno"> 842</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
|
|
<div class="line"><a id="l00843" name="l00843"></a><span class="lineno"> 843</span> </div>
|
|
<div class="line"><a id="l00844" name="l00844"></a><span class="lineno"> 844</span> <span class="comment">// Compare all abundances</span></div>
|
|
<div class="line"><a id="l00845" name="l00845"></a><span class="lineno"> 845</span> <span class="keywordflow">for</span> (<span class="keyword">auto</span> itA = a.begin(), itB = b.begin();</div>
|
|
<div class="line"><a id="l00846" name="l00846"></a><span class="lineno"> 846</span> itA != a.end() && itB != b.end(); ++itA, ++itB) {</div>
|
|
<div class="line"><a id="l00847" name="l00847"></a><span class="lineno"> 847</span> <span class="keywordflow">if</span> (itA->first != itB->first)</div>
|
|
<div class="line"><a id="l00848" name="l00848"></a><span class="lineno"> 848</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
|
|
<div class="line"><a id="l00849" name="l00849"></a><span class="lineno"> 849</span> <span class="keywordflow">if</span> (itA->second != itB->second)</div>
|
|
<div class="line"><a id="l00850" name="l00850"></a><span class="lineno"> 850</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
|
|
<div class="line"><a id="l00851" name="l00851"></a><span class="lineno"> 851</span> }</div>
|
|
<div class="line"><a id="l00852" name="l00852"></a><span class="lineno"> 852</span> <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
|
|
<div class="line"><a id="l00853" name="l00853"></a><span class="lineno"> 853</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00854" name="l00854"></a><span class="lineno"> 854</span>}; <span class="comment">// namespace fourdst::composition</span></div>
|
|
<div class="ttc" id="aatomicSpecies_8h_html"><div class="ttname"><a href="atomicSpecies_8h.html">atomicSpecies.h</a></div></div>
|
|
<div class="ttc" id="aclassfourdst_1_1composition_1_1CompositionAbstract_html"><div class="ttname"><a href="classfourdst_1_1composition_1_1CompositionAbstract.html">fourdst::composition::CompositionAbstract</a></div><div class="ttdoc">Abstract base class for chemical composition representations.</div><div class="ttdef"><b>Definition</b> <a href="composition__abstract_8h_source.html#l00036">composition_abstract.h:36</a></div></div>
|
|
<div class="ttc" id="aclassfourdst_1_1composition_1_1Composition_html"><div class="ttname"><a href="classfourdst_1_1composition_1_1Composition.html">fourdst::composition::Composition</a></div><div class="ttdoc">Manages a collection of chemical species and their abundances.</div><div class="ttdef"><b>Definition</b> <a href="composition_8h_source.html#l00098">composition.h:98</a></div></div>
|
|
<div class="ttc" id="aclassfourdst_1_1composition_1_1Composition_html_a02cd9d9608da082a200fdfa86d14bf5d"><div class="ttname"><a href="classfourdst_1_1composition_1_1Composition.html#a02cd9d9608da082a200fdfa86d14bf5d">fourdst::composition::Composition::m_cache</a></div><div class="ttdeci">CompositionCache m_cache</div><div class="ttdoc">Cache for computed properties to avoid redundant calculations.</div><div class="ttdef"><b>Definition</b> <a href="composition_8h_source.html#l00153">composition.h:153</a></div></div>
|
|
<div class="ttc" id="aclassfourdst_1_1composition_1_1Composition_html_a08c1d1fe9384c5255a6ba40e34b18315"><div class="ttname"><a href="classfourdst_1_1composition_1_1Composition.html#a08c1d1fe9384c5255a6ba40e34b18315">fourdst::composition::Composition::~Composition</a></div><div class="ttdeci">~Composition() override=default</div><div class="ttdoc">Default destructor.</div></div>
|
|
<div class="ttc" id="aclassfourdst_1_1composition_1_1Composition_html_a0d94f62402bb90b5d12679faeaa8c5d7"><div class="ttname"><a href="classfourdst_1_1composition_1_1Composition.html#a0d94f62402bb90b5d12679faeaa8c5d7">fourdst::composition::Composition::getSpeciesIndex</a></div><div class="ttdeci">size_t getSpeciesIndex(const std::string &symbol) const override</div><div class="ttdoc">get the index in the sorted vector representation for a given symbol</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00485">composition.cpp:485</a></div></div>
|
|
<div class="ttc" id="aclassfourdst_1_1composition_1_1Composition_html_a12be36a912c1a1f59affba37d44431ef"><div class="ttname"><a href="classfourdst_1_1composition_1_1Composition.html#a12be36a912c1a1f59affba37d44431ef">fourdst::composition::Composition::end</a></div><div class="ttdeci">std::map< atomic::Species, double >::const_iterator end() const override</div><div class="ttdoc">Returns a const iterator to the end of the molar abundance map.</div><div class="ttdef"><b>Definition</b> <a href="composition_8h_source.html#l00831">composition.h:831</a></div></div>
|
|
<div class="ttc" id="aclassfourdst_1_1composition_1_1Composition_html_a194f715788e7921bd611579440de2ecd"><div class="ttname"><a href="classfourdst_1_1composition_1_1Composition.html#a194f715788e7921bd611579440de2ecd">fourdst::composition::Composition::contains</a></div><div class="ttdeci">bool contains(const atomic::Species &species) const noexcept override</div><div class="ttdoc">Checks if a given species is present in the composition.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00560">composition.cpp:560</a></div></div>
|
|
<div class="ttc" id="aclassfourdst_1_1composition_1_1Composition_html_a1f87ed64a1be9a6091c852131d24e476"><div class="ttname"><a href="classfourdst_1_1composition_1_1Composition.html#a1f87ed64a1be9a6091c852131d24e476">fourdst::composition::Composition::getNumberFraction</a></div><div class="ttdeci">std::unordered_map< atomic::Species, double > getNumberFraction() const noexcept override</div><div class="ttdoc">Gets the number fractions of all species in the composition.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00330">composition.cpp:330</a></div></div>
|
|
<div class="ttc" id="aclassfourdst_1_1composition_1_1Composition_html_a23b83b76ee025f6fc009184ee19bba88"><div class="ttname"><a href="classfourdst_1_1composition_1_1Composition.html#a23b83b76ee025f6fc009184ee19bba88">fourdst::composition::Composition::Composition</a></div><div class="ttdeci">Composition()=default</div><div class="ttdoc">Default constructor.</div></div>
|
|
<div class="ttc" id="aclassfourdst_1_1composition_1_1Composition_html_a262d7133035d4e6f45daa81827abf5e7"><div class="ttname"><a href="classfourdst_1_1composition_1_1Composition.html#a262d7133035d4e6f45daa81827abf5e7">fourdst::composition::Composition::setMolarAbundance</a></div><div class="ttdeci">void setMolarAbundance(const std::string &symbol, const double &molar_abundance)</div><div class="ttdoc">Sets the molar abundance for a given symbol.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00580">composition.cpp:580</a></div></div>
|
|
<div class="ttc" id="aclassfourdst_1_1composition_1_1Composition_html_a33db253ca50431b5166d43412ff18f71"><div class="ttname"><a href="classfourdst_1_1composition_1_1Composition.html#a33db253ca50431b5166d43412ff18f71">fourdst::composition::Composition::getRegisteredSpecies</a></div><div class="ttdeci">const std::set< atomic::Species > & getRegisteredSpecies() const noexcept override</div><div class="ttdoc">Get a set of all species that are registered in the composition.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00269">composition.cpp:269</a></div></div>
|
|
<div class="ttc" id="aclassfourdst_1_1composition_1_1Composition_html_a392a34c19f45d6c936cc7030e6cfaf3f"><div class="ttname"><a href="classfourdst_1_1composition_1_1Composition.html#a392a34c19f45d6c936cc7030e6cfaf3f">fourdst::composition::Composition::registerSpecies</a></div><div class="ttdeci">void registerSpecies(const atomic::Species &species) noexcept</div><div class="ttdoc">Registers a new species by extracting its symbol.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00244">composition.cpp:244</a></div></div>
|
|
<div class="ttc" id="aclassfourdst_1_1composition_1_1Composition_html_a3ab4dcda0bfd1a35b169bcc57fe66725"><div class="ttname"><a href="classfourdst_1_1composition_1_1Composition.html#a3ab4dcda0bfd1a35b169bcc57fe66725">fourdst::composition::Composition::registerSymbol</a></div><div class="ttdeci">void registerSymbol(const std::string &symbol)</div><div class="ttdoc">Registers a new symbol for inclusion in the composition.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00225">composition.cpp:225</a></div></div>
|
|
<div class="ttc" id="aclassfourdst_1_1composition_1_1Composition_html_a3ae885c28580ae15be8c16614bef3b0e"><div class="ttname"><a href="classfourdst_1_1composition_1_1Composition.html#a3ae885c28580ae15be8c16614bef3b0e">fourdst::composition::Composition::getRegisteredSymbols</a></div><div class="ttdeci">std::set< std::string > getRegisteredSymbols() const noexcept override</div><div class="ttdoc">Gets the registered symbols.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00261">composition.cpp:261</a></div></div>
|
|
<div class="ttc" id="aclassfourdst_1_1composition_1_1Composition_html_a452b0affb86dc971a96c80d01f4fcb2b"><div class="ttname"><a href="classfourdst_1_1composition_1_1Composition.html#a452b0affb86dc971a96c80d01f4fcb2b">fourdst::composition::Composition::m_registeredSpecies</a></div><div class="ttdeci">std::set< atomic::Species > m_registeredSpecies</div><div class="ttdoc">Set of registered species in the composition.</div><div class="ttdef"><b>Definition</b> <a href="composition_8h_source.html#l00150">composition.h:150</a></div></div>
|
|
<div class="ttc" id="aclassfourdst_1_1composition_1_1Composition_html_a46a706f9e4c06a45b45ae3dffdde5e9e"><div class="ttname"><a href="classfourdst_1_1composition_1_1Composition.html#a46a706f9e4c06a45b45ae3dffdde5e9e">fourdst::composition::Composition::getLogger</a></div><div class="ttdeci">static quill::Logger * getLogger()</div><div class="ttdoc">Gets the logger instance for the Composition class. This is static to ensure that all composition obj...</div><div class="ttdef"><b>Definition</b> <a href="composition_8h_source.html#l00145">composition.h:145</a></div></div>
|
|
<div class="ttc" id="aclassfourdst_1_1composition_1_1Composition_html_a4ec1e23cfecef764cb831171fed62fc2"><div class="ttname"><a href="classfourdst_1_1composition_1_1Composition.html#a4ec1e23cfecef764cb831171fed62fc2">fourdst::composition::Composition::operator=</a></div><div class="ttdeci">Composition & operator=(Composition const &other)</div><div class="ttdoc">Assignment operator.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00215">composition.cpp:215</a></div></div>
|
|
<div class="ttc" id="aclassfourdst_1_1composition_1_1Composition_html_a5a1f5661a329ec7bc8b7e118ff9d6c25"><div class="ttname"><a href="classfourdst_1_1composition_1_1Composition.html#a5a1f5661a329ec7bc8b7e118ff9d6c25">fourdst::composition::Composition::clone</a></div><div class="ttdeci">std::unique_ptr< CompositionAbstract > clone() const override</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00556">composition.cpp:556</a></div></div>
|
|
<div class="ttc" id="aclassfourdst_1_1composition_1_1Composition_html_a5f6ca82e740a9297dad4bb9cc1075112"><div class="ttname"><a href="classfourdst_1_1composition_1_1Composition.html#a5f6ca82e740a9297dad4bb9cc1075112">fourdst::composition::Composition::begin</a></div><div class="ttdeci">std::map< atomic::Species, double >::const_iterator begin() const override</div><div class="ttdoc">Returns a const iterator to the beginning of the molar abundance map.</div><div class="ttdef"><b>Definition</b> <a href="composition_8h_source.html#l00789">composition.h:789</a></div></div>
|
|
<div class="ttc" id="aclassfourdst_1_1composition_1_1Composition_html_a8699ef1c21f7cf21a26ab2f83cfd9785"><div class="ttname"><a href="classfourdst_1_1composition_1_1Composition.html#a8699ef1c21f7cf21a26ab2f83cfd9785">fourdst::composition::Composition::begin</a></div><div class="ttdeci">std::map< atomic::Species, double >::iterator begin() override</div><div class="ttdoc">Returns an iterator to the beginning of the molar abundance map.</div><div class="ttdef"><b>Definition</b> <a href="composition_8h_source.html#l00768">composition.h:768</a></div></div>
|
|
<div class="ttc" id="aclassfourdst_1_1composition_1_1Composition_html_a8c07a604bff4963b9f8a1f11175f97cf"><div class="ttname"><a href="classfourdst_1_1composition_1_1Composition.html#a8c07a604bff4963b9f8a1f11175f97cf">fourdst::composition::Composition::end</a></div><div class="ttdeci">std::map< atomic::Species, double >::iterator end() override</div><div class="ttdoc">Returns an iterator to the end of the molar abundance map.</div><div class="ttdef"><b>Definition</b> <a href="composition_8h_source.html#l00810">composition.h:810</a></div></div>
|
|
<div class="ttc" id="aclassfourdst_1_1composition_1_1Composition_html_a90fc71d1fe03017ee4c7a1cac69d24fb"><div class="ttname"><a href="classfourdst_1_1composition_1_1Composition.html#a90fc71d1fe03017ee4c7a1cac69d24fb">fourdst::composition::Composition::getElectronAbundance</a></div><div class="ttdeci">double getElectronAbundance() const noexcept override</div><div class="ttdoc">Compute the electron abundance of the composition.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00368">composition.cpp:368</a></div></div>
|
|
<div class="ttc" id="aclassfourdst_1_1composition_1_1Composition_html_a9d177d36b728442bcbd8cb66712c7c75"><div class="ttname"><a href="classfourdst_1_1composition_1_1Composition.html#a9d177d36b728442bcbd8cb66712c7c75">fourdst::composition::Composition::size</a></div><div class="ttdeci">size_t size() const noexcept override</div><div class="ttdoc">Gets the number of registered species in the composition.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00576">composition.cpp:576</a></div></div>
|
|
<div class="ttc" id="aclassfourdst_1_1composition_1_1Composition_html_a9ea2b673341fdc67afeb0f0517a54c8c"><div class="ttname"><a href="classfourdst_1_1composition_1_1Composition.html#a9ea2b673341fdc67afeb0f0517a54c8c">fourdst::composition::Composition::getMassFraction</a></div><div class="ttdeci">std::unordered_map< atomic::Species, double > getMassFraction() const noexcept override</div><div class="ttdoc">Gets the mass fractions of all species in the composition.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00298">composition.cpp:298</a></div></div>
|
|
<div class="ttc" id="aclassfourdst_1_1composition_1_1Composition_html_aa05a640e0ea80142682bf4ee30a93c7f"><div class="ttname"><a href="classfourdst_1_1composition_1_1Composition.html#aa05a640e0ea80142682bf4ee30a93c7f">fourdst::composition::Composition::m_molarAbundances</a></div><div class="ttdeci">std::map< atomic::Species, double > m_molarAbundances</div><div class="ttdoc">Map of species to their molar abundances.</div><div class="ttdef"><b>Definition</b> <a href="composition_8h_source.html#l00151">composition.h:151</a></div></div>
|
|
<div class="ttc" id="aclassfourdst_1_1composition_1_1Composition_html_aac5b214a3d1278e127422224cb9cee50"><div class="ttname"><a href="classfourdst_1_1composition_1_1Composition.html#aac5b214a3d1278e127422224cb9cee50">fourdst::composition::Composition::getCanonicalComposition</a></div><div class="ttdeci">CanonicalComposition getCanonicalComposition() const</div><div class="ttdoc">Compute the canonical composition (X, Y, Z) of the composition.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00377">composition.cpp:377</a></div></div>
|
|
<div class="ttc" id="aclassfourdst_1_1composition_1_1Composition_html_abcb391f5fca2b636127e48e681e4c3ee"><div class="ttname"><a href="classfourdst_1_1composition_1_1Composition.html#abcb391f5fca2b636127e48e681e4c3ee">fourdst::composition::Composition::getMolarAbundanceVector</a></div><div class="ttdeci">std::vector< double > getMolarAbundanceVector() const noexcept override</div><div class="ttdoc">Get a uniform vector representation of the molar abundances stored in the composition object sorted s...</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00463">composition.cpp:463</a></div></div>
|
|
<div class="ttc" id="aclassfourdst_1_1composition_1_1Composition_html_add67a92d73e3a57a2bbdb52bc9ca3bfe"><div class="ttname"><a href="classfourdst_1_1composition_1_1Composition.html#add67a92d73e3a57a2bbdb52bc9ca3bfe">fourdst::composition::Composition::getMolarAbundance</a></div><div class="ttdeci">double getMolarAbundance(const std::string &symbol) const override</div><div class="ttdoc">Gets the molar abundances of all species in the composition.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00338">composition.cpp:338</a></div></div>
|
|
<div class="ttc" id="aclassfourdst_1_1composition_1_1Composition_html_ae4f72972cf4d1ff422d0790080e11473"><div class="ttname"><a href="classfourdst_1_1composition_1_1Composition.html#ae4f72972cf4d1ff422d0790080e11473">fourdst::composition::Composition::getNumberFractionVector</a></div><div class="ttdeci">std::vector< double > getNumberFractionVector() const noexcept override</div><div class="ttdoc">Get a uniform vector representation of the number fractions stored in the composition object sorted s...</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00442">composition.cpp:442</a></div></div>
|
|
<div class="ttc" id="aclassfourdst_1_1composition_1_1Composition_html_ae4f854ded38f5e6fcd157a74a57cbf0c"><div class="ttname"><a href="classfourdst_1_1composition_1_1Composition.html#ae4f854ded38f5e6fcd157a74a57cbf0c">fourdst::composition::Composition::getSpeciesAtIndex</a></div><div class="ttdeci">atomic::Species getSpeciesAtIndex(size_t index) const override</div><div class="ttdoc">Get the species at a given index in the sorted vector representation.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00530">composition.cpp:530</a></div></div>
|
|
<div class="ttc" id="aclassfourdst_1_1composition_1_1Composition_html_af4f44aaf8b7e0d63872a70b5e2131369"><div class="ttname"><a href="classfourdst_1_1composition_1_1Composition.html#af4f44aaf8b7e0d63872a70b5e2131369">fourdst::composition::Composition::getMassFractionVector</a></div><div class="ttdeci">std::vector< double > getMassFractionVector() const noexcept override</div><div class="ttdoc">Get a uniform vector representation of the mass fraction stored in the composition object sorted such...</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00420">composition.cpp:420</a></div></div>
|
|
<div class="ttc" id="aclassfourdst_1_1composition_1_1Composition_html_afbbb5e51ad5ae5c0fa6bc0094195aecd"><div class="ttname"><a href="classfourdst_1_1composition_1_1Composition.html#afbbb5e51ad5ae5c0fa6bc0094195aecd">fourdst::composition::Composition::getMeanParticleMass</a></div><div class="ttdeci">double getMeanParticleMass() const noexcept override</div><div class="ttdoc">Compute the mean particle mass of the composition.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00358">composition.cpp:358</a></div></div>
|
|
<div class="ttc" id="acomposition__abstract_8h_html"><div class="ttname"><a href="composition__abstract_8h.html">composition_abstract.h</a></div></div>
|
|
<div class="ttc" id="anamespacefourdst_1_1composition_html"><div class="ttname"><a href="namespacefourdst_1_1composition.html">fourdst::composition</a></div><div class="ttdoc">Utilities and types for representing and manipulating chemical compositions.</div></div>
|
|
<div class="ttc" id="anamespacefourdst_1_1composition_html_a06f5abc74104de40349e47ad367c402a"><div class="ttname"><a href="namespacefourdst_1_1composition.html#a06f5abc74104de40349e47ad367c402a">fourdst::composition::operator==</a></div><div class="ttdeci">bool operator==(const Composition &a, const Composition &b) noexcept</div><div class="ttdef"><b>Definition</b> <a href="composition_8h_source.html#l00837">composition.h:837</a></div></div>
|
|
<div class="ttc" id="anamespacestd_html"><div class="ttname"><a href="namespacestd.html">std</a></div><div class="ttdoc">STL namespace.</div></div>
|
|
<div class="ttc" id="astructfourdst_1_1atomic_1_1Species_html"><div class="ttname"><a href="structfourdst_1_1atomic_1_1Species.html">fourdst::atomic::Species</a></div><div class="ttdoc">Represents an atomic species (isotope) with its fundamental physical properties.</div><div class="ttdef"><b>Definition</b> <a href="atomicSpecies_8h_source.html#l00051">atomicSpecies.h:51</a></div></div>
|
|
<div class="ttc" id="astructfourdst_1_1composition_1_1CanonicalComposition_html"><div class="ttname"><a href="structfourdst_1_1composition_1_1CanonicalComposition.html">fourdst::composition::CanonicalComposition</a></div><div class="ttdoc">Represents the canonical (X, Y, Z) composition of stellar material.</div><div class="ttdef"><b>Definition</b> <a href="composition_8h_source.html#l00045">composition.h:45</a></div></div>
|
|
<div class="ttc" id="astructfourdst_1_1composition_1_1CanonicalComposition_html_a6e447cb601af6bcbd09e290aef759672"><div class="ttname"><a href="structfourdst_1_1composition_1_1CanonicalComposition.html#a6e447cb601af6bcbd09e290aef759672">fourdst::composition::CanonicalComposition::operator<<</a></div><div class="ttdeci">friend std::ostream & operator<<(std::ostream &os, const CanonicalComposition &composition)</div><div class="ttdoc">Overloads the stream insertion operator for easy printing.</div><div class="ttdef"><b>Definition</b> <a href="composition_8h_source.html#l00056">composition.h:56</a></div></div>
|
|
<div class="ttc" id="astructfourdst_1_1composition_1_1CanonicalComposition_html_a93927bfccc5d2b3906565d092ed4f7f4"><div class="ttname"><a href="structfourdst_1_1composition_1_1CanonicalComposition.html#a93927bfccc5d2b3906565d092ed4f7f4">fourdst::composition::CanonicalComposition::Y</a></div><div class="ttdeci">double Y</div><div class="ttdoc">Mass fraction of Helium.</div><div class="ttdef"><b>Definition</b> <a href="composition_8h_source.html#l00047">composition.h:47</a></div></div>
|
|
<div class="ttc" id="astructfourdst_1_1composition_1_1CanonicalComposition_html_abe5b01574242f8eaabd00c3d653291f7"><div class="ttname"><a href="structfourdst_1_1composition_1_1CanonicalComposition.html#abe5b01574242f8eaabd00c3d653291f7">fourdst::composition::CanonicalComposition::X</a></div><div class="ttdeci">double X</div><div class="ttdoc">Mass fraction of Hydrogen.</div><div class="ttdef"><b>Definition</b> <a href="composition_8h_source.html#l00046">composition.h:46</a></div></div>
|
|
<div class="ttc" id="astructfourdst_1_1composition_1_1CanonicalComposition_html_ae1981f5ddd36abd17a4a69fa1f43de18"><div class="ttname"><a href="structfourdst_1_1composition_1_1CanonicalComposition.html#ae1981f5ddd36abd17a4a69fa1f43de18">fourdst::composition::CanonicalComposition::Z</a></div><div class="ttdeci">double Z</div><div class="ttdoc">Mass fraction of Metals.</div><div class="ttdef"><b>Definition</b> <a href="composition_8h_source.html#l00048">composition.h:48</a></div></div>
|
|
<div class="ttc" id="astructfourdst_1_1composition_1_1Composition_1_1CompositionCache_html"><div class="ttname"><a href="structfourdst_1_1composition_1_1Composition_1_1CompositionCache.html">fourdst::composition::Composition::CompositionCache</a></div><div class="ttdoc">Caches computed properties of the composition to avoid redundant calculations.</div><div class="ttdef"><b>Definition</b> <a href="composition_8h_source.html#l00107">composition.h:107</a></div></div>
|
|
<div class="ttc" id="astructfourdst_1_1composition_1_1Composition_1_1CompositionCache_html_a14761ff2df5423884330e423ec38e98c"><div class="ttname"><a href="structfourdst_1_1composition_1_1Composition_1_1CompositionCache.html#a14761ff2df5423884330e423ec38e98c">fourdst::composition::Composition::CompositionCache::sortedSpecies</a></div><div class="ttdeci">std::optional< std::vector< atomic::Species > > sortedSpecies</div><div class="ttdoc">Cached vector of sorted species (by mass).</div><div class="ttdef"><b>Definition</b> <a href="composition_8h_source.html#l00112">composition.h:112</a></div></div>
|
|
<div class="ttc" id="astructfourdst_1_1composition_1_1Composition_1_1CompositionCache_html_a41ce9d6b4a0f00030e3027b23c0269fb"><div class="ttname"><a href="structfourdst_1_1composition_1_1Composition_1_1CompositionCache.html#a41ce9d6b4a0f00030e3027b23c0269fb">fourdst::composition::Composition::CompositionCache::numberFractions</a></div><div class="ttdeci">std::optional< std::vector< double > > numberFractions</div><div class="ttdoc">Cached vector of number fractions.</div><div class="ttdef"><b>Definition</b> <a href="composition_8h_source.html#l00110">composition.h:110</a></div></div>
|
|
<div class="ttc" id="astructfourdst_1_1composition_1_1Composition_1_1CompositionCache_html_a459e01b94eb0e78dd95bb6932a967f13"><div class="ttname"><a href="structfourdst_1_1composition_1_1Composition_1_1CompositionCache.html#a459e01b94eb0e78dd95bb6932a967f13">fourdst::composition::Composition::CompositionCache::canonicalComp</a></div><div class="ttdeci">std::optional< CanonicalComposition > canonicalComp</div><div class="ttdoc">Cached canonical composition data.</div><div class="ttdef"><b>Definition</b> <a href="composition_8h_source.html#l00108">composition.h:108</a></div></div>
|
|
<div class="ttc" id="astructfourdst_1_1composition_1_1Composition_1_1CompositionCache_html_ab74c9cd92ba8aaf5f95c8ca5284206a6"><div class="ttname"><a href="structfourdst_1_1composition_1_1Composition_1_1CompositionCache.html#ab74c9cd92ba8aaf5f95c8ca5284206a6">fourdst::composition::Composition::CompositionCache::molarAbundances</a></div><div class="ttdeci">std::optional< std::vector< double > > molarAbundances</div><div class="ttdoc">Cached vector of molar abundances.</div><div class="ttdef"><b>Definition</b> <a href="composition_8h_source.html#l00111">composition.h:111</a></div></div>
|
|
<div class="ttc" id="astructfourdst_1_1composition_1_1Composition_1_1CompositionCache_html_abe45010a5104562d3ebecc77393c04ce"><div class="ttname"><a href="structfourdst_1_1composition_1_1Composition_1_1CompositionCache.html#abe45010a5104562d3ebecc77393c04ce">fourdst::composition::Composition::CompositionCache::sortedSymbols</a></div><div class="ttdeci">std::optional< std::vector< std::string > > sortedSymbols</div><div class="ttdoc">Cached vector of sorted species (by mass).</div><div class="ttdef"><b>Definition</b> <a href="composition_8h_source.html#l00113">composition.h:113</a></div></div>
|
|
<div class="ttc" id="astructfourdst_1_1composition_1_1Composition_1_1CompositionCache_html_ac8b576c3b48c4cedda6e9e2790072b0d"><div class="ttname"><a href="structfourdst_1_1composition_1_1Composition_1_1CompositionCache.html#ac8b576c3b48c4cedda6e9e2790072b0d">fourdst::composition::Composition::CompositionCache::clear</a></div><div class="ttdeci">void clear()</div><div class="ttdoc">Clears all cached values.</div><div class="ttdef"><b>Definition</b> <a href="composition_8h_source.html#l00119">composition.h:119</a></div></div>
|
|
<div class="ttc" id="astructfourdst_1_1composition_1_1Composition_1_1CompositionCache_html_add5ce97ae6a1796c5f6488bfa1555be6"><div class="ttname"><a href="structfourdst_1_1composition_1_1Composition_1_1CompositionCache.html#add5ce97ae6a1796c5f6488bfa1555be6">fourdst::composition::Composition::CompositionCache::massFractions</a></div><div class="ttdeci">std::optional< std::vector< double > > massFractions</div><div class="ttdoc">Cached vector of mass fractions.</div><div class="ttdef"><b>Definition</b> <a href="composition_8h_source.html#l00109">composition.h:109</a></div></div>
|
|
<div class="ttc" id="astructfourdst_1_1composition_1_1Composition_1_1CompositionCache_html_ae844e5a1d2b85c7cfee50157ccf189ce"><div class="ttname"><a href="structfourdst_1_1composition_1_1Composition_1_1CompositionCache.html#ae844e5a1d2b85c7cfee50157ccf189ce">fourdst::composition::Composition::CompositionCache::Ye</a></div><div class="ttdeci">std::optional< double > Ye</div><div class="ttdoc">Cached electron abundance.</div><div class="ttdef"><b>Definition</b> <a href="composition_8h_source.html#l00114">composition.h:114</a></div></div>
|
|
<div class="ttc" id="astructfourdst_1_1composition_1_1Composition_1_1CompositionCache_html_af291583560120bb53c4546a598666477"><div class="ttname"><a href="structfourdst_1_1composition_1_1Composition_1_1CompositionCache.html#af291583560120bb53c4546a598666477">fourdst::composition::Composition::CompositionCache::is_clear</a></div><div class="ttdeci">bool is_clear() const</div><div class="ttdoc">Checks if the cache is clear (i.e., all cached values are empty).</div><div class="ttdef"><b>Definition</b> <a href="composition_8h_source.html#l00133">composition.h:133</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_425afc2e69e55565110382214454a15b.html">composition</a></li><li class="navelem"><a class="el" href="dir_cb6fc2f7165eff3b2362b2440dfaea8e.html">include</a></li><li class="navelem"><a class="el" href="dir_3c9efac6790a3720e63e1a08c00d11f2.html">fourdst</a></li><li class="navelem"><a class="el" href="dir_f0fdd83dd0cb4aa6fd6a832374ae4f05.html">composition</a></li><li class="navelem"><a class="el" href="composition_8h.html">composition.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.9.8 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|