tboudreaux/libcomposition
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
d68808666ebee8243a255dba67d1b3555602f8a6
libcomposition/docs/html/composition_8h_source.html

402 lines
78 KiB
HTML
Raw Normal View History

docs(docs): added robust docs
2025-07-24 09:35:52 -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>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>
<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">
docs(docs): rebuilt
2025-11-08 06:42:51 -05:00
<div id="projectname">fourdst::libcomposition<span id="projectnumber">&#160;v2.0.0</span>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
</div>
<div id="projectbrief">Robust atomic species information library</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('composition_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">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 &lt;string&gt;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#include &lt;unordered_map&gt;</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include &lt;set&gt;</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
docs(docs): rebuilt
2025-11-08 06:42:51 -05:00
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#include &lt;optional&gt;</span></div>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="preprocessor">#include &quot;fourdst/config/config.h&quot;</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="preprocessor">#include &quot;fourdst/logging/logging.h&quot;</span></div>
docs(docs): rebuilt docs
2025-10-12 10:22:43 -04:00
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="preprocessor">#include &quot;<a class="code" href="composition__abstract_8h.html">fourdst/composition/composition_abstract.h</a>&quot;</span></div>
docs(docs): rebuilt
2025-11-08 06:42:51 -05:00
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="preprocessor">#include &quot;<a class="code" href="atomic_species_8h.html">fourdst/atomic/atomicSpecies.h</a>&quot;</span></div>
docs(docs): rebuilt docs
2025-10-12 10:22:43 -04:00
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div>
docs(docs): rebuilt
2025-11-08 06:42:51 -05:00
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacefourdst_1_1composition.html">fourdst::composition</a> {</div>
docs(docs): rebuilt docs
2025-10-12 10:22:43 -04:00
<div class="foldopen" id="foldopen00044" data-start="{" data-end="};">
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="structfourdst_1_1composition_1_1_canonical_composition.html"> 44</a></span> <span class="keyword">struct </span><a class="code hl_struct" href="structfourdst_1_1composition_1_1_canonical_composition.html">CanonicalComposition</a> {</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"><a class="line" href="structfourdst_1_1composition_1_1_canonical_composition.html#abe5b01574242f8eaabd00c3d653291f7"> 45</a></span> <span class="keywordtype">double</span> <a class="code hl_variable" href="structfourdst_1_1composition_1_1_canonical_composition.html#abe5b01574242f8eaabd00c3d653291f7">X</a> = 0.0; </div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="structfourdst_1_1composition_1_1_canonical_composition.html#a93927bfccc5d2b3906565d092ed4f7f4"> 46</a></span> <span class="keywordtype">double</span> <a class="code hl_variable" href="structfourdst_1_1composition_1_1_canonical_composition.html#a93927bfccc5d2b3906565d092ed4f7f4">Y</a> = 0.0; </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"><a class="line" href="structfourdst_1_1composition_1_1_canonical_composition.html#ae1981f5ddd36abd17a4a69fa1f43de18"> 47</a></span> <span class="keywordtype">double</span> <a class="code hl_variable" href="structfourdst_1_1composition_1_1_canonical_composition.html#ae1981f5ddd36abd17a4a69fa1f43de18">Z</a> = 0.0; </div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span></div>
<div class="foldopen" id="foldopen00055" data-start="{" data-end="}">
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"><a class="line" href="structfourdst_1_1composition_1_1_canonical_composition.html#a6e447cb601af6bcbd09e290aef759672"> 55</a></span> <span class="keyword">friend</span> std::ostream&amp; <a class="code hl_friend" href="structfourdst_1_1composition_1_1_canonical_composition.html#a6e447cb601af6bcbd09e290aef759672">operator&lt;&lt;</a>(std::ostream&amp; os, <span class="keyword">const</span> <a class="code hl_struct" href="structfourdst_1_1composition_1_1_canonical_composition.html">CanonicalComposition</a>&amp; <a class="code hl_namespace" href="namespacefourdst_1_1composition.html">composition</a>) {</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> os &lt;&lt; <span class="stringliteral">&quot;&lt;CanonicalComposition: &quot;</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> &lt;&lt; <span class="stringliteral">&quot;X = &quot;</span> &lt;&lt; <a class="code hl_namespace" href="namespacefourdst_1_1composition.html">composition</a>.X &lt;&lt; <span class="stringliteral">&quot;, &quot;</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> &lt;&lt; <span class="stringliteral">&quot;Y = &quot;</span> &lt;&lt; <a class="code hl_namespace" href="namespacefourdst_1_1composition.html">composition</a>.Y &lt;&lt; <span class="stringliteral">&quot;, &quot;</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> &lt;&lt; <span class="stringliteral">&quot;Z = &quot;</span> &lt;&lt; <a class="code hl_namespace" href="namespacefourdst_1_1composition.html">composition</a>.Z &lt;&lt; <span class="stringliteral">&quot;&gt;&quot;</span>;</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> <span class="keywordflow">return</span> os;</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> }</div>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
</div>
docs(docs): rebuilt docs
2025-10-12 10:22:43 -04:00
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> };</div>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
</div>
docs(docs): rebuilt docs
2025-10-12 10:22:43 -04:00
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span></div>
docs(docs): rebuilt
2025-11-08 06:42:51 -05:00
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> <span class="comment">// ReSharper disable once CppClassCanBeFinal</span></div>
<div class="foldopen" id="foldopen00097" data-start="{" data-end="};">
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition.html"> 97</a></span> <span class="keyword">class </span><a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a23b83b76ee025f6fc009184ee19bba88">Composition</a> : <span class="keyword">public</span> <a class="code hl_class" href="class_composition_abstract.html">CompositionAbstract</a> {</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> <span class="keyword">private</span>:</div>
<div class="foldopen" id="foldopen00106" data-start="{" data-end="};">
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"><a class="line" href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.html"> 106</a></span> <span class="keyword">struct </span><a class="code hl_struct" href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.html">CompositionCache</a> {</div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"><a class="line" href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.html#a459e01b94eb0e78dd95bb6932a967f13"> 107</a></span> std::optional&lt;CanonicalComposition&gt; <a class="code hl_variable" href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.html#a459e01b94eb0e78dd95bb6932a967f13">canonicalComp</a>; </div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"><a class="line" href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.html#add5ce97ae6a1796c5f6488bfa1555be6"> 108</a></span> std::optional&lt;std::vector&lt;double&gt;&gt; <a class="code hl_variable" href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.html#add5ce97ae6a1796c5f6488bfa1555be6">massFractions</a>; </div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"><a class="line" href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.html#a41ce9d6b4a0f00030e3027b23c0269fb"> 109</a></span> std::optional&lt;std::vector&lt;double&gt;&gt; <a class="code hl_variable" href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.html#a41ce9d6b4a0f00030e3027b23c0269fb">numberFractions</a>; </div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"><a class="line" href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.html#ab74c9cd92ba8aaf5f95c8ca5284206a6"> 110</a></span> std::optional&lt;std::vector&lt;double&gt;&gt; <a class="code hl_variable" href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.html#ab74c9cd92ba8aaf5f95c8ca5284206a6">molarAbundances</a>; </div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"><a class="line" href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.html#a14761ff2df5423884330e423ec38e98c"> 111</a></span> std::optional&lt;std::vector&lt;atomic::Species&gt;&gt; <a class="code hl_variable" href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.html#a14761ff2df5423884330e423ec38e98c">sortedSpecies</a>; </div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"><a class="line" href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.html#abe45010a5104562d3ebecc77393c04ce"> 112</a></span> std::optional&lt;std::vector&lt;std::string&gt;&gt; <a class="code hl_variable" href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.html#abe45010a5104562d3ebecc77393c04ce">sortedSymbols</a>; </div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"><a class="line" href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.html#ae844e5a1d2b85c7cfee50157ccf189ce"> 113</a></span> std::optional&lt;double&gt; <a class="code hl_variable" href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.html#ae844e5a1d2b85c7cfee50157ccf189ce">Ye</a>; </div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span></div>
<div class="foldopen" id="foldopen00118" data-start="{" data-end="}">
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"><a class="line" href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.html#ac8b576c3b48c4cedda6e9e2790072b0d"> 118</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.html#ac8b576c3b48c4cedda6e9e2790072b0d">clear</a>() {</div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> <a class="code hl_variable" href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.html#a459e01b94eb0e78dd95bb6932a967f13">canonicalComp</a> = std::nullopt;</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_1_composition_1_1_composition_cache.html#add5ce97ae6a1796c5f6488bfa1555be6">massFractions</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_1_composition_1_1_composition_cache.html#a41ce9d6b4a0f00030e3027b23c0269fb">numberFractions</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_1_composition_1_1_composition_cache.html#ab74c9cd92ba8aaf5f95c8ca5284206a6">molarAbundances</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_1_composition_1_1_composition_cache.html#abe45010a5104562d3ebecc77393c04ce">sortedSymbols</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_1_composition_1_1_composition_cache.html#a14761ff2df5423884330e423ec38e98c">sortedSpecies</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_1_composition_1_1_composition_cache.html#ae844e5a1d2b85c7cfee50157ccf189ce">Ye</a> = std::nullopt;</div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span> }</div>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
</div>
docs(docs): rebuilt
2025-11-08 06:42:51 -05:00
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span></div>
<div class="foldopen" id="foldopen00132" data-start="{" data-end="}">
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"><a class="line" href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.html#af291583560120bb53c4546a598666477"> 132</a></span> [[nodiscard]] <span class="keywordtype">bool</span> <a class="code hl_function" href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.html#af291583560120bb53c4546a598666477">is_clear</a>()<span class="keyword"> const </span>{</div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span> <span class="keywordflow">return</span> !<a class="code hl_variable" href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.html#a459e01b94eb0e78dd95bb6932a967f13">canonicalComp</a>.has_value() &amp;&amp; !<a class="code hl_variable" href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.html#add5ce97ae6a1796c5f6488bfa1555be6">massFractions</a>.has_value() &amp;&amp;</div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span> !<a class="code hl_variable" href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.html#a41ce9d6b4a0f00030e3027b23c0269fb">numberFractions</a>.has_value() &amp;&amp; !<a class="code hl_variable" href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.html#ab74c9cd92ba8aaf5f95c8ca5284206a6">molarAbundances</a>.has_value() &amp;&amp; !<a class="code hl_variable" href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.html#abe45010a5104562d3ebecc77393c04ce">sortedSymbols</a>.has_value() &amp;&amp;</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_1_composition_1_1_composition_cache.html#ae844e5a1d2b85c7cfee50157ccf189ce">Ye</a>.has_value() &amp;&amp; !<a class="code hl_variable" href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.html#a14761ff2df5423884330e423ec38e98c">sortedSpecies</a>.has_value();</div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span> }</div>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
</div>
docs(docs): rebuilt
2025-11-08 06:42:51 -05:00
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span> };</div>
docs(docs): rebuilt docs
2025-10-12 10:22:43 -04:00
</div>
docs(docs): rebuilt
2025-11-08 06:42:51 -05:00
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span> <span class="keyword">private</span>:</div>
<div class="foldopen" id="foldopen00144" data-start="{" data-end="}">
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition.html#a46a706f9e4c06a45b45ae3dffdde5e9e"> 144</a></span> <span class="keyword">static</span> quill::Logger* <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a46a706f9e4c06a45b45ae3dffdde5e9e">getLogger</a>() {</div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno"> 145</span> <span class="keyword">static</span> quill::Logger* logger = logging::LogManager::getInstance().getLogger(<span class="stringliteral">&quot;log&quot;</span>);</div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno"> 146</span> <span class="keywordflow">return</span> logger;</div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno"> 147</span> }</div>
docs(docs): rebuilt docs
2025-10-12 10:22:43 -04:00
</div>
docs(docs): rebuilt
2025-11-08 06:42:51 -05:00
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno"> 148</span> </div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition.html#a452b0affb86dc971a96c80d01f4fcb2b"> 149</a></span> std::set&lt;atomic::Species&gt; <a class="code hl_variable" href="classfourdst_1_1composition_1_1_composition.html#a452b0affb86dc971a96c80d01f4fcb2b">m_registeredSpecies</a>; </div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition.html#aa05a640e0ea80142682bf4ee30a93c7f"> 150</a></span> std::map&lt;atomic::Species, double&gt; <a class="code hl_variable" href="classfourdst_1_1composition_1_1_composition.html#aa05a640e0ea80142682bf4ee30a93c7f">m_molarAbundances</a>; </div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno"> 151</span> </div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition.html#a02cd9d9608da082a200fdfa86d14bf5d"> 152</a></span> <span class="keyword">mutable</span> <a class="code hl_struct" href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.html">CompositionCache</a> <a class="code hl_variable" href="classfourdst_1_1composition_1_1_composition.html#a02cd9d9608da082a200fdfa86d14bf5d">m_cache</a>; </div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno"> 153</span> </div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno"> 154</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition.html#a23b83b76ee025f6fc009184ee19bba88"> 160</a></span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a23b83b76ee025f6fc009184ee19bba88">Composition</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno"> 161</span></div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition.html#a08c1d1fe9384c5255a6ba40e34b18315"> 165</a></span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a08c1d1fe9384c5255a6ba40e34b18315">~Composition</a>() <span class="keyword">override</span> = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno"> 166</span></div>
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno"> 177</span> <span class="keyword">explicit</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a23b83b76ee025f6fc009184ee19bba88">Composition</a>(<span class="keyword">const</span> std::vector&lt;std::string&gt;&amp; symbols);</div>
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno"> 178</span></div>
<div class="line"><a id="l00192" name="l00192"></a><span class="lineno"> 192</span> <span class="keyword">explicit</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a23b83b76ee025f6fc009184ee19bba88">Composition</a>(<span class="keyword">const</span> std::vector&lt;atomic::Species&gt;&amp; species);</div>
<div class="line"><a id="l00193" name="l00193"></a><span class="lineno"> 193</span></div>
<div class="line"><a id="l00204" name="l00204"></a><span class="lineno"> 204</span> <span class="keyword">explicit</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a23b83b76ee025f6fc009184ee19bba88">Composition</a>(<span class="keyword">const</span> std::set&lt;std::string&gt;&amp; symbols);</div>
<div class="line"><a id="l00205" name="l00205"></a><span class="lineno"> 205</span></div>
<div class="line"><a id="l00219" name="l00219"></a><span class="lineno"> 219</span> <span class="keyword">explicit</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a23b83b76ee025f6fc009184ee19bba88">Composition</a>(<span class="keyword">const</span> std::set&lt;atomic::Species&gt;&amp; species);</div>
<div class="line"><a id="l00220" name="l00220"></a><span class="lineno"> 220</span></div>
<div class="line"><a id="l00236" name="l00236"></a><span class="lineno"> 236</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a23b83b76ee025f6fc009184ee19bba88">Composition</a>(<span class="keyword">const</span> std::vector&lt;std::string&gt;&amp; symbols, <span class="keyword">const</span> std::vector&lt;double&gt;&amp; molarAbundances);</div>
<div class="line"><a id="l00237" name="l00237"></a><span class="lineno"> 237</span></div>
<div class="line"><a id="l00252" name="l00252"></a><span class="lineno"> 252</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a23b83b76ee025f6fc009184ee19bba88">Composition</a>(<span class="keyword">const</span> std::vector&lt;atomic::Species&gt;&amp; species, <span class="keyword">const</span> std::vector&lt;double&gt;&amp; molarAbundances);</div>
<div class="line"><a id="l00253" name="l00253"></a><span class="lineno"> 253</span></div>
<div class="line"><a id="l00269" name="l00269"></a><span class="lineno"> 269</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a23b83b76ee025f6fc009184ee19bba88">Composition</a>(<span class="keyword">const</span> std::set&lt;std::string&gt;&amp; symbols, <span class="keyword">const</span> std::vector&lt;double&gt;&amp; molarAbundances);</div>
<div class="line"><a id="l00270" name="l00270"></a><span class="lineno"> 270</span></div>
<div class="line"><a id="l00275" name="l00275"></a><span class="lineno"> 275</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a23b83b76ee025f6fc009184ee19bba88">Composition</a>(<span class="keyword">const</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a23b83b76ee025f6fc009184ee19bba88">Composition</a>&amp; <a class="code hl_namespace" href="namespacefourdst_1_1composition.html">composition</a>);</div>
<div class="line"><a id="l00276" name="l00276"></a><span class="lineno"> 276</span></div>
<div class="line"><a id="l00282" name="l00282"></a><span class="lineno"> 282</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a23b83b76ee025f6fc009184ee19bba88">Composition</a>&amp; <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a4ec1e23cfecef764cb831171fed62fc2">operator=</a>(<a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a23b83b76ee025f6fc009184ee19bba88">Composition</a> <span class="keyword">const</span>&amp; other);</div>
<div class="line"><a id="l00283" name="l00283"></a><span class="lineno"> 283</span></div>
<div class="line"><a id="l00298" name="l00298"></a><span class="lineno"> 298</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a3ab4dcda0bfd1a35b169bcc57fe66725">registerSymbol</a>(<span class="keyword">const</span> std::string&amp; symbol);</div>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
<div class="line"><a id="l00299" name="l00299"></a><span class="lineno"> 299</span></div>
docs(docs): rebuilt
2025-11-08 06:42:51 -05:00
<div class="line"><a id="l00314" name="l00314"></a><span class="lineno"> 314</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a3ab4dcda0bfd1a35b169bcc57fe66725">registerSymbol</a>(<span class="keyword">const</span> std::vector&lt;std::string&gt;&amp; symbols);</div>
<div class="line"><a id="l00315" name="l00315"></a><span class="lineno"> 315</span></div>
<div class="line"><a id="l00338" name="l00338"></a><span class="lineno"> 338</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a392a34c19f45d6c936cc7030e6cfaf3f">registerSpecies</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structfourdst_1_1atomic_1_1_species.html">atomic::Species</a>&amp; species) <span class="keyword">noexcept</span>;</div>
<div class="line"><a id="l00339" name="l00339"></a><span class="lineno"> 339</span> </div>
docs(docs): rebuilt docs
2025-10-12 10:22:43 -04:00
<div class="line"><a id="l00340" name="l00340"></a><span class="lineno"> 340</span></div>
docs(docs): rebuilt
2025-11-08 06:42:51 -05:00
<div class="line"><a id="l00360" name="l00360"></a><span class="lineno"> 360</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a392a34c19f45d6c936cc7030e6cfaf3f">registerSpecies</a>(<span class="keyword">const</span> std::vector&lt;atomic::Species&gt;&amp; species) <span class="keyword">noexcept</span>;</div>
<div class="line"><a id="l00361" name="l00361"></a><span class="lineno"> 361</span></div>
<div class="line"><a id="l00367" name="l00367"></a><span class="lineno"> 367</span> [[nodiscard]] <span class="keywordtype">bool</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a194f715788e7921bd611579440de2ecd">contains</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structfourdst_1_1atomic_1_1_species.html">atomic::Species</a>&amp; species) <span class="keyword">const</span> <span class="keyword">noexcept</span> <span class="keyword">override</span>;</div>
<div class="line"><a id="l00368" name="l00368"></a><span class="lineno"> 368</span></div>
<div class="line"><a id="l00375" name="l00375"></a><span class="lineno"> 375</span> [[nodiscard]] <span class="keywordtype">bool</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a194f715788e7921bd611579440de2ecd">contains</a>(<span class="keyword">const</span> std::string&amp; symbol) <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00376" name="l00376"></a><span class="lineno"> 376</span></div>
<div class="line"><a id="l00381" name="l00381"></a><span class="lineno"> 381</span> [[nodiscard]] <span class="keywordtype">size_t</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a9d177d36b728442bcbd8cb66712c7c75">size</a>() const noexcept override;</div>
<div class="line"><a id="l00382" name="l00382"></a><span class="lineno"> 382</span></div>
<div class="line"><a id="l00399" name="l00399"></a><span class="lineno"> 399</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a262d7133035d4e6f45daa81827abf5e7">setMolarAbundance</a>(</div>
<div class="line"><a id="l00400" name="l00400"></a><span class="lineno"> 400</span> const std::<span class="keywordtype">string</span>&amp; symbol,</div>
<div class="line"><a id="l00401" name="l00401"></a><span class="lineno"> 401</span> const <span class="keywordtype">double</span>&amp; molar_abundance</div>
<div class="line"><a id="l00402" name="l00402"></a><span class="lineno"> 402</span> );</div>
<div class="line"><a id="l00403" name="l00403"></a><span class="lineno"> 403</span></div>
<div class="line"><a id="l00423" name="l00423"></a><span class="lineno"> 423</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a262d7133035d4e6f45daa81827abf5e7">setMolarAbundance</a>(</div>
<div class="line"><a id="l00424" name="l00424"></a><span class="lineno"> 424</span> const <a class="code hl_namespace" href="namespacefourdst_1_1atomic.html">atomic</a>::Species&amp; species,</div>
<div class="line"><a id="l00425" name="l00425"></a><span class="lineno"> 425</span> const <span class="keywordtype">double</span>&amp; molar_abundance</div>
<div class="line"><a id="l00426" name="l00426"></a><span class="lineno"> 426</span> );</div>
<div class="line"><a id="l00427" name="l00427"></a><span class="lineno"> 427</span></div>
<div class="line"><a id="l00443" name="l00443"></a><span class="lineno"> 443</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a262d7133035d4e6f45daa81827abf5e7">setMolarAbundance</a>(</div>
<div class="line"><a id="l00444" name="l00444"></a><span class="lineno"> 444</span> const std::vector&lt;std::<span class="keywordtype">string</span>&gt;&amp; symbols,</div>
<div class="line"><a id="l00445" name="l00445"></a><span class="lineno"> 445</span> const std::vector&lt;<span class="keywordtype">double</span>&gt;&amp; molar_abundances</div>
<div class="line"><a id="l00446" name="l00446"></a><span class="lineno"> 446</span> );</div>
<div class="line"><a id="l00447" name="l00447"></a><span class="lineno"> 447</span></div>
<div class="line"><a id="l00466" name="l00466"></a><span class="lineno"> 466</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a262d7133035d4e6f45daa81827abf5e7">setMolarAbundance</a>(</div>
<div class="line"><a id="l00467" name="l00467"></a><span class="lineno"> 467</span> const std::vector&lt;<a class="code hl_namespace" href="namespacefourdst_1_1atomic.html">atomic</a>::Species&gt;&amp; species,</div>
<div class="line"><a id="l00468" name="l00468"></a><span class="lineno"> 468</span> const std::vector&lt;<span class="keywordtype">double</span>&gt;&amp; molar_abundances</div>
<div class="line"><a id="l00469" name="l00469"></a><span class="lineno"> 469</span> );</div>
<div class="line"><a id="l00470" name="l00470"></a><span class="lineno"> 470</span></div>
<div class="line"><a id="l00487" name="l00487"></a><span class="lineno"> 487</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a262d7133035d4e6f45daa81827abf5e7">setMolarAbundance</a>(</div>
<div class="line"><a id="l00488" name="l00488"></a><span class="lineno"> 488</span> const std::set&lt;std::<span class="keywordtype">string</span>&gt;&amp; symbols,</div>
<div class="line"><a id="l00489" name="l00489"></a><span class="lineno"> 489</span> const std::vector&lt;<span class="keywordtype">double</span>&gt;&amp; molar_abundances</div>
<div class="line"><a id="l00490" name="l00490"></a><span class="lineno"> 490</span> );</div>
docs(docs): rebuilt docs
2025-10-12 10:22:43 -04:00
<div class="line"><a id="l00491" name="l00491"></a><span class="lineno"> 491</span></div>
docs(docs): rebuilt
2025-11-08 06:42:51 -05:00
<div class="line"><a id="l00511" name="l00511"></a><span class="lineno"> 511</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a262d7133035d4e6f45daa81827abf5e7">setMolarAbundance</a>(</div>
<div class="line"><a id="l00512" name="l00512"></a><span class="lineno"> 512</span> const std::set&lt;<a class="code hl_namespace" href="namespacefourdst_1_1atomic.html">atomic</a>::Species&gt;&amp; species,</div>
<div class="line"><a id="l00513" name="l00513"></a><span class="lineno"> 513</span> const std::vector&lt;<span class="keywordtype">double</span>&gt;&amp; molar_abundances</div>
<div class="line"><a id="l00514" name="l00514"></a><span class="lineno"> 514</span> );</div>
<div class="line"><a id="l00515" name="l00515"></a><span class="lineno"> 515</span></div>
<div class="line"><a id="l00524" name="l00524"></a><span class="lineno"> 524</span> [[nodiscard]] std::set&lt;std::<span class="keywordtype">string</span>&gt; <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a3ae885c28580ae15be8c16614bef3b0e">getRegisteredSymbols</a>() const noexcept override;</div>
<div class="line"><a id="l00525" name="l00525"></a><span class="lineno"> 525</span></div>
<div class="line"><a id="l00534" name="l00534"></a><span class="lineno"> 534</span> [[nodiscard]] const std::set&lt;<a class="code hl_namespace" href="namespacefourdst_1_1atomic.html">atomic</a>::Species&gt; &amp;<a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a33db253ca50431b5166d43412ff18f71">getRegisteredSpecies</a>() const noexcept override;</div>
<div class="line"><a id="l00535" name="l00535"></a><span class="lineno"> 535</span></div>
<div class="line"><a id="l00542" name="l00542"></a><span class="lineno"> 542</span> [[nodiscard]] std::unordered_map&lt;<a class="code hl_namespace" href="namespacefourdst_1_1atomic.html">atomic</a>::Species, <span class="keywordtype">double</span>&gt; <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a9ea2b673341fdc67afeb0f0517a54c8c">getMassFraction</a>() const noexcept override;</div>
<div class="line"><a id="l00543" name="l00543"></a><span class="lineno"> 543</span></div>
<div class="line"><a id="l00552" name="l00552"></a><span class="lineno"> 552</span> [[nodiscard]] <span class="keywordtype">double</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a9ea2b673341fdc67afeb0f0517a54c8c">getMassFraction</a>(const std::<span class="keywordtype">string</span>&amp; symbol) const override;</div>
<div class="line"><a id="l00553" name="l00553"></a><span class="lineno"> 553</span></div>
<div class="line"><a id="l00571" name="l00571"></a><span class="lineno"> 571</span> [[nodiscard]] <span class="keywordtype">double</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a9ea2b673341fdc67afeb0f0517a54c8c">getMassFraction</a>(const <a class="code hl_namespace" href="namespacefourdst_1_1atomic.html">atomic</a>::Species&amp; species) const override;</div>
<div class="line"><a id="l00572" name="l00572"></a><span class="lineno"> 572</span></div>
<div class="line"><a id="l00581" name="l00581"></a><span class="lineno"> 581</span> [[nodiscard]] <span class="keywordtype">double</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a34f71d4d8f0297c576fd62fabd490305">getNumberFraction</a>(const std::<span class="keywordtype">string</span>&amp; symbol) const override;</div>
docs(docs): rebuilt docs
2025-10-12 10:22:43 -04:00
<div class="line"><a id="l00582" name="l00582"></a><span class="lineno"> 582</span></div>
docs(docs): rebuilt
2025-11-08 06:42:51 -05:00
<div class="line"><a id="l00599" name="l00599"></a><span class="lineno"> 599</span> [[nodiscard]] <span class="keywordtype">double</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a34f71d4d8f0297c576fd62fabd490305">getNumberFraction</a>(const <a class="code hl_namespace" href="namespacefourdst_1_1atomic.html">atomic</a>::Species&amp; species) const override;</div>
<div class="line"><a id="l00600" name="l00600"></a><span class="lineno"> 600</span></div>
<div class="line"><a id="l00607" name="l00607"></a><span class="lineno"> 607</span> [[nodiscard]] std::unordered_map&lt;<a class="code hl_namespace" href="namespacefourdst_1_1atomic.html">atomic</a>::Species, <span class="keywordtype">double</span>&gt; <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a34f71d4d8f0297c576fd62fabd490305">getNumberFraction</a>() const noexcept override;</div>
<div class="line"><a id="l00608" name="l00608"></a><span class="lineno"> 608</span></div>
<div class="line"><a id="l00619" name="l00619"></a><span class="lineno"> 619</span> [[nodiscard]] <span class="keywordtype">double</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#add67a92d73e3a57a2bbdb52bc9ca3bfe">getMolarAbundance</a>(const std::<span class="keywordtype">string</span>&amp; symbol) const override;</div>
<div class="line"><a id="l00620" name="l00620"></a><span class="lineno"> 620</span></div>
<div class="line"><a id="l00630" name="l00630"></a><span class="lineno"> 630</span> [[nodiscard]] <span class="keywordtype">double</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#add67a92d73e3a57a2bbdb52bc9ca3bfe">getMolarAbundance</a>(const <a class="code hl_namespace" href="namespacefourdst_1_1atomic.html">atomic</a>::Species&amp; species) const override;</div>
<div class="line"><a id="l00631" name="l00631"></a><span class="lineno"> 631</span></div>
<div class="line"><a id="l00645" name="l00645"></a><span class="lineno"> 645</span> [[nodiscard]] <span class="keywordtype">double</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#afbbb5e51ad5ae5c0fa6bc0094195aecd">getMeanParticleMass</a>() const noexcept override;</div>
<div class="line"><a id="l00646" name="l00646"></a><span class="lineno"> 646</span></div>
<div class="line"><a id="l00660" name="l00660"></a><span class="lineno"> 660</span> [[nodiscard]] <span class="keywordtype">double</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a90fc71d1fe03017ee4c7a1cac69d24fb">getElectronAbundance</a>() const noexcept override;</div>
<div class="line"><a id="l00661" name="l00661"></a><span class="lineno"> 661</span> </div>
docs(docs): rebuilt docs
2025-10-12 10:22:43 -04:00
<div class="line"><a id="l00662" name="l00662"></a><span class="lineno"> 662</span></div>
docs(docs): rebuilt
2025-11-08 06:42:51 -05:00
<div class="line"><a id="l00677" name="l00677"></a><span class="lineno"> 677</span> [[nodiscard]] <a class="code hl_struct" href="structfourdst_1_1composition_1_1_canonical_composition.html">CanonicalComposition</a> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#aac5b214a3d1278e127422224cb9cee50">getCanonicalComposition</a>() const;</div>
<div class="line"><a id="l00678" name="l00678"></a><span class="lineno"> 678</span></div>
<div class="line"><a id="l00684" name="l00684"></a><span class="lineno"> 684</span> [[nodiscard]] std::vector&lt;<span class="keywordtype">double</span>&gt; <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#af4f44aaf8b7e0d63872a70b5e2131369">getMassFractionVector</a>() const noexcept override;</div>
<div class="line"><a id="l00685" name="l00685"></a><span class="lineno"> 685</span></div>
<div class="line"><a id="l00691" name="l00691"></a><span class="lineno"> 691</span> [[nodiscard]] std::vector&lt;<span class="keywordtype">double</span>&gt; <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#ae4f72972cf4d1ff422d0790080e11473">getNumberFractionVector</a>() const noexcept override;</div>
docs(docs): rebuilt docs
2025-10-12 10:22:43 -04:00
<div class="line"><a id="l00692" name="l00692"></a><span class="lineno"> 692</span></div>
docs(docs): rebuilt
2025-11-08 06:42:51 -05:00
<div class="line"><a id="l00698" name="l00698"></a><span class="lineno"> 698</span> [[nodiscard]] std::vector&lt;<span class="keywordtype">double</span>&gt; <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#abcb391f5fca2b636127e48e681e4c3ee">getMolarAbundanceVector</a>() const noexcept override;</div>
<div class="line"><a id="l00699" name="l00699"></a><span class="lineno"> 699</span></div>
<div class="line"><a id="l00708" name="l00708"></a><span class="lineno"> 708</span> [[nodiscard]] <span class="keywordtype">size_t</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a0d94f62402bb90b5d12679faeaa8c5d7">getSpeciesIndex</a>(const std::<span class="keywordtype">string</span>&amp; symbol) const override;</div>
<div class="line"><a id="l00709" name="l00709"></a><span class="lineno"> 709</span></div>
<div class="line"><a id="l00717" name="l00717"></a><span class="lineno"> 717</span> [[nodiscard]] <span class="keywordtype">size_t</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a0d94f62402bb90b5d12679faeaa8c5d7">getSpeciesIndex</a>(const <a class="code hl_namespace" href="namespacefourdst_1_1atomic.html">atomic</a>::Species&amp; species) const override;</div>
<div class="line"><a id="l00718" name="l00718"></a><span class="lineno"> 718</span></div>
<div class="line"><a id="l00726" name="l00726"></a><span class="lineno"> 726</span> [[nodiscard]] <a class="code hl_namespace" href="namespacefourdst_1_1atomic.html">atomic</a>::Species <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#ae4f854ded38f5e6fcd157a74a57cbf0c">getSpeciesAtIndex</a>(<span class="keywordtype">size_t</span> index) const override;</div>
<div class="line"><a id="l00727" name="l00727"></a><span class="lineno"> 727</span></div>
<div class="line"><a id="l00734" name="l00734"></a><span class="lineno"> 734</span> friend std::ostream&amp; operator&lt;&lt;(std::ostream&amp; os, const <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a23b83b76ee025f6fc009184ee19bba88">Composition</a>&amp; <a class="code hl_namespace" href="namespacefourdst_1_1composition.html">composition</a>);</div>
docs(docs): rebuilt docs
2025-10-12 10:22:43 -04:00
<div class="line"><a id="l00735" name="l00735"></a><span class="lineno"> 735</span></div>
docs(docs): rebuilt
2025-11-08 06:42:51 -05:00
<div class="foldopen" id="foldopen00753" data-start="{" data-end="}">
<div class="line"><a id="l00753" name="l00753"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition.html#ab1701644ff1c83c220dc04eb58d1621b"> 753</a></span> auto <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#ab1701644ff1c83c220dc04eb58d1621b">begin</a>() {</div>
<div class="line"><a id="l00754" name="l00754"></a><span class="lineno"> 754</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="classfourdst_1_1composition_1_1_composition.html#aa05a640e0ea80142682bf4ee30a93c7f">m_molarAbundances</a>.begin();</div>
<div class="line"><a id="l00755" name="l00755"></a><span class="lineno"> 755</span> }</div>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
</div>
docs(docs): rebuilt
2025-11-08 06:42:51 -05:00
<div class="line"><a id="l00756" name="l00756"></a><span class="lineno"> 756</span></div>
<div class="foldopen" id="foldopen00774" data-start="{" data-end="}">
<div class="line"><a id="l00774" name="l00774"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition.html#adf41a833e8b704daf4f581fca5c8cb9b"> 774</a></span> [[nodiscard]] <span class="keyword">auto</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#adf41a833e8b704daf4f581fca5c8cb9b">begin</a>()<span class="keyword"> const </span>{</div>
<div class="line"><a id="l00775" name="l00775"></a><span class="lineno"> 775</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="classfourdst_1_1composition_1_1_composition.html#aa05a640e0ea80142682bf4ee30a93c7f">m_molarAbundances</a>.cbegin();</div>
<div class="line"><a id="l00776" name="l00776"></a><span class="lineno"> 776</span> }</div>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
</div>
docs(docs): rebuilt
2025-11-08 06:42:51 -05:00
<div class="line"><a id="l00777" name="l00777"></a><span class="lineno"> 777</span></div>
<div class="foldopen" id="foldopen00795" data-start="{" data-end="}">
<div class="line"><a id="l00795" name="l00795"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition.html#adeaf6f1213e78cb1fe8a8317f0a8adc2"> 795</a></span> <span class="keyword">auto</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#adeaf6f1213e78cb1fe8a8317f0a8adc2">end</a>() {</div>
<div class="line"><a id="l00796" name="l00796"></a><span class="lineno"> 796</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="classfourdst_1_1composition_1_1_composition.html#aa05a640e0ea80142682bf4ee30a93c7f">m_molarAbundances</a>.end();</div>
<div class="line"><a id="l00797" name="l00797"></a><span class="lineno"> 797</span> }</div>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
</div>
docs(docs): rebuilt
2025-11-08 06:42:51 -05:00
<div class="line"><a id="l00798" name="l00798"></a><span class="lineno"> 798</span></div>
<div class="foldopen" id="foldopen00816" data-start="{" data-end="}">
<div class="line"><a id="l00816" name="l00816"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition.html#aed2f5676f8f742199f01e4d1e9664bdd"> 816</a></span> [[nodiscard]] <span class="keyword">auto</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#aed2f5676f8f742199f01e4d1e9664bdd">end</a>()<span class="keyword"> const </span>{</div>
<div class="line"><a id="l00817" name="l00817"></a><span class="lineno"> 817</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="classfourdst_1_1composition_1_1_composition.html#aa05a640e0ea80142682bf4ee30a93c7f">m_molarAbundances</a>.cend();</div>
<div class="line"><a id="l00818" name="l00818"></a><span class="lineno"> 818</span> }</div>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
</div>
docs(docs): rebuilt
2025-11-08 06:42:51 -05:00
<div class="line"><a id="l00819" name="l00819"></a><span class="lineno"> 819</span> </div>
<div class="line"><a id="l00820" name="l00820"></a><span class="lineno"> 820</span> };</div>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
</div>
docs(docs): rebuilt
2025-11-08 06:42:51 -05:00
<div class="line"><a id="l00821" name="l00821"></a><span class="lineno"> 821</span>}; <span class="comment">// namespace fourdst::composition</span></div>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
<div class="ttc" id="aatomic_species_8h_html"><div class="ttname"><a href="atomic_species_8h.html">atomicSpecies.h</a></div></div>
docs(docs): rebuilt
2025-11-08 06:42:51 -05:00
<div class="ttc" id="aclass_composition_abstract_html"><div class="ttname"><a href="class_composition_abstract.html">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#l00033">composition_abstract.h:33</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a02cd9d9608da082a200fdfa86d14bf5d"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.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="#l00152">composition.h:152</a></div></div>
docs(docs): rebuilt docs
2025-10-12 10:22:43 -04:00
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a08c1d1fe9384c5255a6ba40e34b18315"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a08c1d1fe9384c5255a6ba40e34b18315">fourdst::composition::Composition::~Composition</a></div><div class="ttdeci">~Composition() override=default</div><div class="ttdoc">Default destructor.</div></div>
docs(docs): rebuilt
2025-11-08 06:42:51 -05:00
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a0d94f62402bb90b5d12679faeaa8c5d7"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a0d94f62402bb90b5d12679faeaa8c5d7">fourdst::composition::Composition::getSpeciesIndex</a></div><div class="ttdeci">size_t getSpeciesIndex(const std::string &amp;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#l00438">composition.cpp:438</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a194f715788e7921bd611579440de2ecd"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a194f715788e7921bd611579440de2ecd">fourdst::composition::Composition::contains</a></div><div class="ttdeci">bool contains(const atomic::Species &amp;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#l00509">composition.cpp:509</a></div></div>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a23b83b76ee025f6fc009184ee19bba88"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a23b83b76ee025f6fc009184ee19bba88">fourdst::composition::Composition::Composition</a></div><div class="ttdeci">Composition()=default</div><div class="ttdoc">Default constructor.</div></div>
docs(docs): rebuilt
2025-11-08 06:42:51 -05:00
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a262d7133035d4e6f45daa81827abf5e7"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a262d7133035d4e6f45daa81827abf5e7">fourdst::composition::Composition::setMolarAbundance</a></div><div class="ttdeci">void setMolarAbundance(const std::string &amp;symbol, const double &amp;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#l00529">composition.cpp:529</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a33db253ca50431b5166d43412ff18f71"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a33db253ca50431b5166d43412ff18f71">fourdst::composition::Composition::getRegisteredSpecies</a></div><div class="ttdeci">const std::set&lt; atomic::Species &gt; &amp; 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#l00222">composition.cpp:222</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a34f71d4d8f0297c576fd62fabd490305"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a34f71d4d8f0297c576fd62fabd490305">fourdst::composition::Composition::getNumberFraction</a></div><div class="ttdeci">double getNumberFraction(const std::string &amp;symbol) const override</div><div class="ttdoc">Gets the number fraction for a given symbol. See the overload for species-based lookup for more detai...</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00260">composition.cpp:260</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a392a34c19f45d6c936cc7030e6cfaf3f"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a392a34c19f45d6c936cc7030e6cfaf3f">fourdst::composition::Composition::registerSpecies</a></div><div class="ttdeci">void registerSpecies(const atomic::Species &amp;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#l00197">composition.cpp:197</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a3ab4dcda0bfd1a35b169bcc57fe66725"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a3ab4dcda0bfd1a35b169bcc57fe66725">fourdst::composition::Composition::registerSymbol</a></div><div class="ttdeci">void registerSymbol(const std::string &amp;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#l00178">composition.cpp:178</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a3ae885c28580ae15be8c16614bef3b0e"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a3ae885c28580ae15be8c16614bef3b0e">fourdst::composition::Composition::getRegisteredSymbols</a></div><div class="ttdeci">std::set&lt; std::string &gt; 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#l00214">composition.cpp:214</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a452b0affb86dc971a96c80d01f4fcb2b"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a452b0affb86dc971a96c80d01f4fcb2b">fourdst::composition::Composition::m_registeredSpecies</a></div><div class="ttdeci">std::set&lt; atomic::Species &gt; m_registeredSpecies</div><div class="ttdoc">Set of registered species in the composition.</div><div class="ttdef"><b>Definition</b> <a href="#l00149">composition.h:149</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a46a706f9e4c06a45b45ae3dffdde5e9e"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.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="#l00144">composition.h:144</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a4ec1e23cfecef764cb831171fed62fc2"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a4ec1e23cfecef764cb831171fed62fc2">fourdst::composition::Composition::operator=</a></div><div class="ttdeci">Composition &amp; operator=(Composition const &amp;other)</div><div class="ttdoc">Assignment operator.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00168">composition.cpp:168</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a90fc71d1fe03017ee4c7a1cac69d24fb"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.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#l00321">composition.cpp:321</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a9d177d36b728442bcbd8cb66712c7c75"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.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#l00525">composition.cpp:525</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a9ea2b673341fdc67afeb0f0517a54c8c"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a9ea2b673341fdc67afeb0f0517a54c8c">fourdst::composition::Composition::getMassFraction</a></div><div class="ttdeci">std::unordered_map&lt; atomic::Species, double &gt; 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#l00251">composition.cpp:251</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_aa05a640e0ea80142682bf4ee30a93c7f"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#aa05a640e0ea80142682bf4ee30a93c7f">fourdst::composition::Composition::m_molarAbundances</a></div><div class="ttdeci">std::map&lt; atomic::Species, double &gt; m_molarAbundances</div><div class="ttdoc">Map of species to their molar abundances.</div><div class="ttdef"><b>Definition</b> <a href="#l00150">composition.h:150</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_aac5b214a3d1278e127422224cb9cee50"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.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#l00330">composition.cpp:330</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_ab1701644ff1c83c220dc04eb58d1621b"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#ab1701644ff1c83c220dc04eb58d1621b">fourdst::composition::Composition::begin</a></div><div class="ttdeci">auto begin()</div><div class="ttdoc">Returns an iterator to the beginning of the molar abundance map.</div><div class="ttdef"><b>Definition</b> <a href="#l00753">composition.h:753</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_abcb391f5fca2b636127e48e681e4c3ee"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#abcb391f5fca2b636127e48e681e4c3ee">fourdst::composition::Composition::getMolarAbundanceVector</a></div><div class="ttdeci">std::vector&lt; double &gt; 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#l00416">composition.cpp:416</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_add67a92d73e3a57a2bbdb52bc9ca3bfe"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#add67a92d73e3a57a2bbdb52bc9ca3bfe">fourdst::composition::Composition::getMolarAbundance</a></div><div class="ttdeci">double getMolarAbundance(const std::string &amp;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#l00291">composition.cpp:291</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_adeaf6f1213e78cb1fe8a8317f0a8adc2"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#adeaf6f1213e78cb1fe8a8317f0a8adc2">fourdst::composition::Composition::end</a></div><div class="ttdeci">auto end()</div><div class="ttdoc">Returns an iterator to the end of the molar abundance map.</div><div class="ttdef"><b>Definition</b> <a href="#l00795">composition.h:795</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_adf41a833e8b704daf4f581fca5c8cb9b"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#adf41a833e8b704daf4f581fca5c8cb9b">fourdst::composition::Composition::begin</a></div><div class="ttdeci">auto begin() const</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="#l00774">composition.h:774</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_ae4f72972cf4d1ff422d0790080e11473"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#ae4f72972cf4d1ff422d0790080e11473">fourdst::composition::Composition::getNumberFractionVector</a></div><div class="ttdeci">std::vector&lt; double &gt; 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#l00395">composition.cpp:395</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_ae4f854ded38f5e6fcd157a74a57cbf0c"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.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#l00483">composition.cpp:483</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_aed2f5676f8f742199f01e4d1e9664bdd"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#aed2f5676f8f742199f01e4d1e9664bdd">fourdst::composition::Composition::end</a></div><div class="ttdeci">auto end() const</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="#l00816">composition.h:816</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_af4f44aaf8b7e0d63872a70b5e2131369"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#af4f44aaf8b7e0d63872a70b5e2131369">fourdst::composition::Composition::getMassFractionVector</a></div><div class="ttdeci">std::vector&lt; double &gt; 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#l00373">composition.cpp:373</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_afbbb5e51ad5ae5c0fa6bc0094195aecd"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.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#l00311">composition.cpp:311</a></div></div>
docs(docs): rebuilt docs
2025-10-12 10:22:43 -04:00
<div class="ttc" id="acomposition__abstract_8h_html"><div class="ttname"><a href="composition__abstract_8h.html">composition_abstract.h</a></div></div>
docs(docs): rebuilt
2025-11-08 06:42:51 -05:00
<div class="ttc" id="anamespacefourdst_1_1atomic_html"><div class="ttname"><a href="namespacefourdst_1_1atomic.html">fourdst::atomic</a></div><div class="ttdoc">Contains canonical information about atomic species and elements used by 4D-STAR.</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>
docs(docs): rebuilt docs for version 1.7.0
2025-09-16 11:24:28 -04:00
<div class="ttc" id="astructfourdst_1_1atomic_1_1_species_html"><div class="ttname"><a href="structfourdst_1_1atomic_1_1_species.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="atomic_species_8h_source.html#l00051">atomicSpecies.h:51</a></div></div>
docs(docs): rebuilt docs
2025-10-12 10:22:43 -04:00
<div class="ttc" id="astructfourdst_1_1composition_1_1_canonical_composition_html"><div class="ttname"><a href="structfourdst_1_1composition_1_1_canonical_composition.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="#l00044">composition.h:44</a></div></div>
<div class="ttc" id="astructfourdst_1_1composition_1_1_canonical_composition_html_a6e447cb601af6bcbd09e290aef759672"><div class="ttname"><a href="structfourdst_1_1composition_1_1_canonical_composition.html#a6e447cb601af6bcbd09e290aef759672">fourdst::composition::CanonicalComposition::operator&lt;&lt;</a></div><div class="ttdeci">friend std::ostream &amp; operator&lt;&lt;(std::ostream &amp;os, const CanonicalComposition &amp;composition)</div><div class="ttdoc">Overloads the stream insertion operator for easy printing.</div><div class="ttdef"><b>Definition</b> <a href="#l00055">composition.h:55</a></div></div>
<div class="ttc" id="astructfourdst_1_1composition_1_1_canonical_composition_html_a93927bfccc5d2b3906565d092ed4f7f4"><div class="ttname"><a href="structfourdst_1_1composition_1_1_canonical_composition.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="#l00046">composition.h:46</a></div></div>
<div class="ttc" id="astructfourdst_1_1composition_1_1_canonical_composition_html_abe5b01574242f8eaabd00c3d653291f7"><div class="ttname"><a href="structfourdst_1_1composition_1_1_canonical_composition.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="#l00045">composition.h:45</a></div></div>
<div class="ttc" id="astructfourdst_1_1composition_1_1_canonical_composition_html_ae1981f5ddd36abd17a4a69fa1f43de18"><div class="ttname"><a href="structfourdst_1_1composition_1_1_canonical_composition.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="#l00047">composition.h:47</a></div></div>
docs(docs): rebuilt
2025-11-08 06:42:51 -05:00
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_1_1_composition_cache_html"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.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="#l00106">composition.h:106</a></div></div>
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_1_1_composition_cache_html_a14761ff2df5423884330e423ec38e98c"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.html#a14761ff2df5423884330e423ec38e98c">fourdst::composition::Composition::CompositionCache::sortedSpecies</a></div><div class="ttdeci">std::optional&lt; std::vector&lt; atomic::Species &gt; &gt; sortedSpecies</div><div class="ttdoc">Cached vector of sorted species (by mass).</div><div class="ttdef"><b>Definition</b> <a href="#l00111">composition.h:111</a></div></div>
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_1_1_composition_cache_html_a41ce9d6b4a0f00030e3027b23c0269fb"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.html#a41ce9d6b4a0f00030e3027b23c0269fb">fourdst::composition::Composition::CompositionCache::numberFractions</a></div><div class="ttdeci">std::optional&lt; std::vector&lt; double &gt; &gt; numberFractions</div><div class="ttdoc">Cached vector of number fractions.</div><div class="ttdef"><b>Definition</b> <a href="#l00109">composition.h:109</a></div></div>
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_1_1_composition_cache_html_a459e01b94eb0e78dd95bb6932a967f13"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.html#a459e01b94eb0e78dd95bb6932a967f13">fourdst::composition::Composition::CompositionCache::canonicalComp</a></div><div class="ttdeci">std::optional&lt; CanonicalComposition &gt; canonicalComp</div><div class="ttdoc">Cached canonical composition data.</div><div class="ttdef"><b>Definition</b> <a href="#l00107">composition.h:107</a></div></div>
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_1_1_composition_cache_html_ab74c9cd92ba8aaf5f95c8ca5284206a6"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.html#ab74c9cd92ba8aaf5f95c8ca5284206a6">fourdst::composition::Composition::CompositionCache::molarAbundances</a></div><div class="ttdeci">std::optional&lt; std::vector&lt; double &gt; &gt; molarAbundances</div><div class="ttdoc">Cached vector of molar abundances.</div><div class="ttdef"><b>Definition</b> <a href="#l00110">composition.h:110</a></div></div>
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_1_1_composition_cache_html_abe45010a5104562d3ebecc77393c04ce"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.html#abe45010a5104562d3ebecc77393c04ce">fourdst::composition::Composition::CompositionCache::sortedSymbols</a></div><div class="ttdeci">std::optional&lt; std::vector&lt; std::string &gt; &gt; sortedSymbols</div><div class="ttdoc">Cached vector of sorted species (by mass).</div><div class="ttdef"><b>Definition</b> <a href="#l00112">composition.h:112</a></div></div>
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_1_1_composition_cache_html_ac8b576c3b48c4cedda6e9e2790072b0d"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.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="#l00118">composition.h:118</a></div></div>
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_1_1_composition_cache_html_add5ce97ae6a1796c5f6488bfa1555be6"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.html#add5ce97ae6a1796c5f6488bfa1555be6">fourdst::composition::Composition::CompositionCache::massFractions</a></div><div class="ttdeci">std::optional&lt; std::vector&lt; double &gt; &gt; massFractions</div><div class="ttdoc">Cached vector of mass fractions.</div><div class="ttdef"><b>Definition</b> <a href="#l00108">composition.h:108</a></div></div>
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_1_1_composition_cache_html_ae844e5a1d2b85c7cfee50157ccf189ce"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.html#ae844e5a1d2b85c7cfee50157ccf189ce">fourdst::composition::Composition::CompositionCache::Ye</a></div><div class="ttdeci">std::optional&lt; double &gt; Ye</div><div class="ttdoc">Cached electron abundance.</div><div class="ttdef"><b>Definition</b> <a href="#l00113">composition.h:113</a></div></div>
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_1_1_composition_cache_html_af291583560120bb53c4546a598666477"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.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="#l00132">composition.h:132</a></div></div>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
</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.13.2 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue Copy Permalink