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

521 lines
126 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 docs
2025-10-12 10:22:43 -04:00
<div id="projectname">fourdst::libcomposition<span id="projectnumber">&#160;v1.9.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>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#include &lt;utility&gt;</span></div>
<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>
<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/composition/atomicSpecies.h</a>&quot;</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="foldopen" id="foldopen00034" data-start="{" data-end="}">
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"><a class="line" href="namespacefourdst_1_1composition.html"> 34</a></span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacefourdst_1_1composition.html">fourdst::composition</a> {</div>
<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>
<div class="foldopen" id="foldopen00070" data-start="{" data-end="};">
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"><a class="line" href="structfourdst_1_1composition_1_1_global_composition.html"> 70</a></span> <span class="keyword">struct </span><a class="code hl_struct" href="structfourdst_1_1composition_1_1_global_composition.html">GlobalComposition</a> {</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"><a class="line" href="structfourdst_1_1composition_1_1_global_composition.html#a0df6ecfe28d13cbffd0abcbfec9aee41"> 71</a></span> <span class="keywordtype">double</span> <a class="code hl_variable" href="structfourdst_1_1composition_1_1_global_composition.html#a0df6ecfe28d13cbffd0abcbfec9aee41">specificNumberDensity</a>; </div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"><a class="line" href="structfourdst_1_1composition_1_1_global_composition.html#a9c35810d965841a755da9ce4644a2f1b"> 72</a></span> <span class="keywordtype">double</span> <a class="code hl_variable" href="structfourdst_1_1composition_1_1_global_composition.html#a9c35810d965841a755da9ce4644a2f1b">meanParticleMass</a>; </div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> </div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> <span class="comment">// Overload the output stream operator for GlobalComposition</span></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <span class="keyword">friend</span> std::ostream&amp; <a class="code hl_friend" href="structfourdst_1_1composition_1_1_global_composition.html#a3c072a749c3648607771ac9105181f26">operator&lt;&lt;</a>(std::ostream&amp; os, <span class="keyword">const</span> <a class="code hl_struct" href="structfourdst_1_1composition_1_1_global_composition.html">GlobalComposition</a>&amp; comp);</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</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="l00077" name="l00077"></a><span class="lineno"> 77</span></div>
<div class="foldopen" id="foldopen00084" data-start="{" data-end="};">
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"><a class="line" href="structfourdst_1_1composition_1_1_composition_entry.html"> 84</a></span> <span class="keyword">struct </span><a class="code hl_function" href="structfourdst_1_1composition_1_1_composition_entry.html#a1cccb94c150dd1dcde860f55fbeaf2bd">CompositionEntry</a> {</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"><a class="line" href="structfourdst_1_1composition_1_1_composition_entry.html#ac273debdba6a1b3ac0f11698c399d38e"> 85</a></span> std::string <a class="code hl_variable" href="structfourdst_1_1composition_1_1_composition_entry.html#ac273debdba6a1b3ac0f11698c399d38e">m_symbol</a>; </div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"><a class="line" href="structfourdst_1_1composition_1_1_composition_entry.html#a79039cbdc76b4401eb2ce44b85467503"> 86</a></span> <a class="code hl_struct" href="structfourdst_1_1atomic_1_1_species.html">atomic::Species</a> <a class="code hl_variable" href="structfourdst_1_1composition_1_1_composition_entry.html#a79039cbdc76b4401eb2ce44b85467503">m_isotope</a>; </div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"><a class="line" href="structfourdst_1_1composition_1_1_composition_entry.html#a1e860519bea86793413ed67c76d18c8b"> 87</a></span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="structfourdst_1_1composition_1_1_composition_entry.html#a1e860519bea86793413ed67c76d18c8b">m_massFracMode</a> = <span class="keyword">true</span>; </div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> </div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"><a class="line" href="structfourdst_1_1composition_1_1_composition_entry.html#adc20165bf94e18eea3458003025579ac"> 89</a></span> <span class="keywordtype">double</span> <a class="code hl_variable" href="structfourdst_1_1composition_1_1_composition_entry.html#adc20165bf94e18eea3458003025579ac">m_massFraction</a> = 0.0; </div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"><a class="line" href="structfourdst_1_1composition_1_1_composition_entry.html#a2b5e245f7dabb11076efdbe1ed516d9f"> 90</a></span> <span class="keywordtype">double</span> <a class="code hl_variable" href="structfourdst_1_1composition_1_1_composition_entry.html#a2b5e245f7dabb11076efdbe1ed516d9f">m_numberFraction</a> = 0.0; </div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"><a class="line" href="structfourdst_1_1composition_1_1_composition_entry.html#a0498d707d8ea78be39283786c10657ef"> 91</a></span> <span class="keywordtype">double</span> <a class="code hl_variable" href="structfourdst_1_1composition_1_1_composition_entry.html#a0498d707d8ea78be39283786c10657ef">m_relAbundance</a> = 0.0; </div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"><a class="line" href="structfourdst_1_1composition_1_1_composition_entry.html#acd41be41f03c819521bab28ea0d8bed2"> 92</a></span> <span class="keywordtype">double</span> <a class="code hl_variable" href="structfourdst_1_1composition_1_1_composition_entry.html#acd41be41f03c819521bab28ea0d8bed2">m_molesPerMass</a> = 0.0;</div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"><a class="line" href="structfourdst_1_1composition_1_1_composition_entry.html#a3b056b6b923016d271f034333c96d039"> 93</a></span> <span class="keywordtype">double</span> <a class="code hl_variable" href="structfourdst_1_1composition_1_1_composition_entry.html#a3b056b6b923016d271f034333c96d039">m_cachedNumberFraction</a> = 0.0; </div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> </div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> </div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"><a class="line" href="structfourdst_1_1composition_1_1_composition_entry.html#a391e899874cd7ef299a3ae1f64c016d2"> 96</a></span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="structfourdst_1_1composition_1_1_composition_entry.html#a391e899874cd7ef299a3ae1f64c016d2">m_initialized</a> = <span class="keyword">false</span>; </div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span></div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> <a class="code hl_function" href="structfourdst_1_1composition_1_1_composition_entry.html#a1cccb94c150dd1dcde860f55fbeaf2bd">CompositionEntry</a>();</div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span></div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> <span class="keyword">explicit</span> <a class="code hl_function" href="structfourdst_1_1composition_1_1_composition_entry.html#a1cccb94c150dd1dcde860f55fbeaf2bd">CompositionEntry</a>(<span class="keyword">const</span> std::string&amp; <a class="code hl_function" href="structfourdst_1_1composition_1_1_composition_entry.html#a50d18b4c27611fa9314dd756af54c2f0">symbol</a>, <span class="keywordtype">bool</span> massFracMode=<span class="keyword">true</span>);</div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span></div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"><a class="line" href="structfourdst_1_1composition_1_1_composition_entry.html#a38f3e109b2952c1f0e7444d7fb9e93a0"> 120</a></span> <a class="code hl_function" href="structfourdst_1_1composition_1_1_composition_entry.html#a38f3e109b2952c1f0e7444d7fb9e93a0">CompositionEntry</a>(<span class="keyword">const</span> <a class="code hl_function" href="structfourdst_1_1composition_1_1_composition_entry.html#a1cccb94c150dd1dcde860f55fbeaf2bd">CompositionEntry</a>&amp; entry);</div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span></div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span> <span class="keywordtype">void</span> <a class="code hl_function" href="structfourdst_1_1composition_1_1_composition_entry.html#a5885a0e33687bceb15b225a00163e9d3">setSpecies</a>(<span class="keyword">const</span> std::string&amp; <a class="code hl_function" href="structfourdst_1_1composition_1_1_composition_entry.html#a50d18b4c27611fa9314dd756af54c2f0">symbol</a>);</div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span></div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span> [[nodiscard]] std::string <a class="code hl_function" href="structfourdst_1_1composition_1_1_composition_entry.html#a50d18b4c27611fa9314dd756af54c2f0">symbol</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span></div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span> [[nodiscard]] <span class="keywordtype">double</span> <a class="code hl_function" href="structfourdst_1_1composition_1_1_composition_entry.html#a66cb086719d7f654869bd7b0cee87ffc">mass_fraction</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno"> 143</span></div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno"> 150</span> [[nodiscard]] <span class="keywordtype">double</span> <a class="code hl_function" href="structfourdst_1_1composition_1_1_composition_entry.html#a2d55492d285068d4a64db5602dfb1c78">number_fraction</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno"> 151</span></div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno"> 157</span> [[nodiscard]] <span class="keywordtype">double</span> <a class="code hl_function" href="structfourdst_1_1composition_1_1_composition_entry.html#a2d55492d285068d4a64db5602dfb1c78">number_fraction</a>(<span class="keywordtype">double</span> totalMolesPerMass) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno"> 158</span></div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno"> 163</span> [[nodiscard]] <span class="keywordtype">double</span> <a class="code hl_function" href="structfourdst_1_1composition_1_1_composition_entry.html#ab6619d23e111905d1e3ab16ee822d96c">rel_abundance</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno"> 164</span></div>
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno"> 169</span> [[nodiscard]] <a class="code hl_struct" href="structfourdst_1_1atomic_1_1_species.html">atomic::Species</a> <a class="code hl_function" href="structfourdst_1_1composition_1_1_composition_entry.html#af49920b1168be92d517aea03a308fee1">isotope</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno"> 170</span></div>
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno"> 175</span> [[nodiscard]] <span class="keywordtype">bool</span> <a class="code hl_function" href="structfourdst_1_1composition_1_1_composition_entry.html#a14f12b8b0178df2e32e2023bd4564ddc">getMassFracMode</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno"> 176</span></div>
<div class="line"><a id="l00183" name="l00183"></a><span class="lineno"> 183</span> <span class="keywordtype">void</span> <a class="code hl_function" href="structfourdst_1_1composition_1_1_composition_entry.html#a4d6df43e098e7e2e2d94ff7fb76cb4c2">setMassFraction</a>(<span class="keywordtype">double</span> <a class="code hl_function" href="structfourdst_1_1composition_1_1_composition_entry.html#a66cb086719d7f654869bd7b0cee87ffc">mass_fraction</a>);</div>
<div class="line"><a id="l00184" name="l00184"></a><span class="lineno"> 184</span></div>
<div class="line"><a id="l00191" name="l00191"></a><span class="lineno"> 191</span> <span class="keywordtype">void</span> <a class="code hl_function" href="structfourdst_1_1composition_1_1_composition_entry.html#a9ec47cf4b3399128d3836c1b24b031b0">setNumberFraction</a>(<span class="keywordtype">double</span> <a class="code hl_function" href="structfourdst_1_1composition_1_1_composition_entry.html#a2d55492d285068d4a64db5602dfb1c78">number_fraction</a>);</div>
<div class="line"><a id="l00192" name="l00192"></a><span class="lineno"> 192</span></div>
<div class="line"><a id="l00198" name="l00198"></a><span class="lineno"> 198</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="structfourdst_1_1composition_1_1_composition_entry.html#a3fb3f63a4e5675c6fefb662a8e3e7aa3">setMassFracMode</a>(<span class="keywordtype">double</span> meanMolarMass);</div>
<div class="line"><a id="l00199" name="l00199"></a><span class="lineno"> 199</span></div>
<div class="line"><a id="l00205" name="l00205"></a><span class="lineno"> 205</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="structfourdst_1_1composition_1_1_composition_entry.html#a00332551f5b2f0d7f10b12a091e21fa8">setNumberFracMode</a>(<span class="keywordtype">double</span> totalMolesPerMass);</div>
<div class="line"><a id="l00206" name="l00206"></a><span class="lineno"> 206</span></div>
<div class="line"><a id="l00213" name="l00213"></a><span class="lineno"> 213</span> <span class="keyword">friend</span> std::ostream&amp; <a class="code hl_friend" href="structfourdst_1_1composition_1_1_composition_entry.html#ae7a6a113fc5914248eff5629716d6eb2">operator&lt;&lt;</a>(std::ostream&amp; os, <span class="keyword">const</span> <a class="code hl_function" href="structfourdst_1_1composition_1_1_composition_entry.html#a1cccb94c150dd1dcde860f55fbeaf2bd">CompositionEntry</a>&amp; entry);</div>
<div class="line"><a id="l00214" name="l00214"></a><span class="lineno"> 214</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="l00215" name="l00215"></a><span class="lineno"> 215</span></div>
<div class="foldopen" id="foldopen00255" data-start="{" data-end="};">
<div class="line"><a id="l00255" name="l00255"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition.html"> 255</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="l00256" name="l00256"></a><span class="lineno"> 256</span> <span class="keyword">private</span>:</div>
<div class="foldopen" id="foldopen00257" data-start="{" data-end="};">
<div class="line"><a id="l00257" name="l00257"></a><span class="lineno"><a class="line" href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.html"> 257</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="l00258" name="l00258"></a><span class="lineno"><a class="line" href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.html#a9a9dc0e4ec0d094e604569de9ce6c125"> 258</a></span> std::optional&lt;GlobalComposition&gt; <a class="code hl_variable" href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.html#a9a9dc0e4ec0d094e604569de9ce6c125">globalComp</a>; </div>
<div class="line"><a id="l00259" name="l00259"></a><span class="lineno"><a class="line" href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.html#a459e01b94eb0e78dd95bb6932a967f13"> 259</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="l00260" name="l00260"></a><span class="lineno"><a class="line" href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.html#add5ce97ae6a1796c5f6488bfa1555be6"> 260</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="l00261" name="l00261"></a><span class="lineno"><a class="line" href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.html#a41ce9d6b4a0f00030e3027b23c0269fb"> 261</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="l00262" name="l00262"></a><span class="lineno"><a class="line" href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.html#ab74c9cd92ba8aaf5f95c8ca5284206a6"> 262</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="l00263" name="l00263"></a><span class="lineno"><a class="line" href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.html#a14761ff2df5423884330e423ec38e98c"> 263</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="l00264" name="l00264"></a><span class="lineno"><a class="line" href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.html#abe45010a5104562d3ebecc77393c04ce"> 264</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="l00265" name="l00265"></a><span class="lineno"><a class="line" href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.html#ae844e5a1d2b85c7cfee50157ccf189ce"> 265</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="l00266" name="l00266"></a><span class="lineno"> 266</span> </div>
<div class="foldopen" id="foldopen00267" data-start="{" data-end="}">
<div class="line"><a id="l00267" name="l00267"></a><span class="lineno"><a class="line" href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.html#ac8b576c3b48c4cedda6e9e2790072b0d"> 267</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="l00268" name="l00268"></a><span class="lineno"> 268</span> <a class="code hl_variable" href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.html#a9a9dc0e4ec0d094e604569de9ce6c125">globalComp</a> = std::nullopt;</div>
<div class="line"><a id="l00269" name="l00269"></a><span class="lineno"> 269</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="l00270" name="l00270"></a><span class="lineno"> 270</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="l00271" name="l00271"></a><span class="lineno"> 271</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="l00272" name="l00272"></a><span class="lineno"> 272</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="l00273" name="l00273"></a><span class="lineno"> 273</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="l00274" name="l00274"></a><span class="lineno"> 274</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="l00275" name="l00275"></a><span class="lineno"> 275</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="l00276" name="l00276"></a><span class="lineno"> 276</span> }</div>
</div>
<div class="line"><a id="l00277" name="l00277"></a><span class="lineno"> 277</span> </div>
<div class="foldopen" id="foldopen00278" data-start="{" data-end="}">
<div class="line"><a id="l00278" name="l00278"></a><span class="lineno"><a class="line" href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.html#af291583560120bb53c4546a598666477"> 278</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="l00279" name="l00279"></a><span class="lineno"> 279</span> <span class="keywordflow">return</span> !<a class="code hl_variable" href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.html#a9a9dc0e4ec0d094e604569de9ce6c125">globalComp</a>.has_value() &amp;&amp; !<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="l00280" name="l00280"></a><span class="lineno"> 280</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="l00281" name="l00281"></a><span class="lineno"> 281</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="l00282" name="l00282"></a><span class="lineno"> 282</span> }</div>
</div>
<div class="line"><a id="l00283" name="l00283"></a><span class="lineno"> 283</span> };</div>
</div>
<div class="line"><a id="l00284" name="l00284"></a><span class="lineno"> 284</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00285" name="l00285"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition.html#a1f96b2c567364368ea5ee6f0826f3091"> 285</a></span> config::Config&amp; <a class="code hl_variable" href="classfourdst_1_1composition_1_1_composition.html#a1f96b2c567364368ea5ee6f0826f3091">m_config</a> = config::Config::getInstance();</div>
<div class="line"><a id="l00286" name="l00286"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition.html#a40b2128948f01630cd2968488b450ce5"> 286</a></span> logging::LogManager&amp; <a class="code hl_variable" href="classfourdst_1_1composition_1_1_composition.html#a40b2128948f01630cd2968488b450ce5">m_logManager</a> = logging::LogManager::getInstance();</div>
<div class="line"><a id="l00287" name="l00287"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition.html#ab6c66f35e1fb05dd24aacaf90e115c5e"> 287</a></span> quill::Logger* <a class="code hl_variable" href="classfourdst_1_1composition_1_1_composition.html#ab6c66f35e1fb05dd24aacaf90e115c5e">m_logger</a> = <a class="code hl_variable" href="classfourdst_1_1composition_1_1_composition.html#a40b2128948f01630cd2968488b450ce5">m_logManager</a>.getLogger(<span class="stringliteral">&quot;log&quot;</span>);</div>
<div class="line"><a id="l00288" name="l00288"></a><span class="lineno"> 288</span> </div>
<div class="line"><a id="l00289" name="l00289"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition.html#aa00cbc0933d8a22bb900ac21a338e5ac"> 289</a></span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="classfourdst_1_1composition_1_1_composition.html#aa00cbc0933d8a22bb900ac21a338e5ac">m_finalized</a> = <span class="keyword">false</span>; </div>
<div class="line"><a id="l00290" name="l00290"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition.html#addae4484da7d5072ab66a721dbe04ced"> 290</a></span> <span class="keywordtype">double</span> <a class="code hl_variable" href="classfourdst_1_1composition_1_1_composition.html#addae4484da7d5072ab66a721dbe04ced">m_specificNumberDensity</a> = 0.0; </div>
<div class="line"><a id="l00291" name="l00291"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition.html#a4a36c8d22ce61023e7bea1d9417577d4"> 291</a></span> <span class="keywordtype">double</span> <a class="code hl_variable" href="classfourdst_1_1composition_1_1_composition.html#a4a36c8d22ce61023e7bea1d9417577d4">m_meanParticleMass</a> = 0.0; </div>
<div class="line"><a id="l00292" name="l00292"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition.html#a671f1ee8be00f4ff8c1d94fabb382380"> 292</a></span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="classfourdst_1_1composition_1_1_composition.html#a671f1ee8be00f4ff8c1d94fabb382380">m_massFracMode</a> = <span class="keyword">true</span>; </div>
<div class="line"><a id="l00293" name="l00293"></a><span class="lineno"> 293</span> </div>
<div class="line"><a id="l00294" name="l00294"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition.html#a39bfcb7d81d723cbd9d021abd533b4d6"> 294</a></span> std::set&lt;std::string&gt; <a class="code hl_variable" href="classfourdst_1_1composition_1_1_composition.html#a39bfcb7d81d723cbd9d021abd533b4d6">m_registeredSymbols</a>; </div>
<div class="line"><a id="l00295" name="l00295"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition.html#aa7f2753b10e85ae3bbf0c3d600a973db"> 295</a></span> std::unordered_map&lt;std::string, CompositionEntry&gt; <a class="code hl_variable" href="classfourdst_1_1composition_1_1_composition.html#aa7f2753b10e85ae3bbf0c3d600a973db">m_compositions</a>; </div>
<div class="line"><a id="l00296" name="l00296"></a><span class="lineno"> 296</span> </div>
<div class="line"><a id="l00297" name="l00297"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition.html#a02cd9d9608da082a200fdfa86d14bf5d"> 297</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="l00298" name="l00298"></a><span class="lineno"> 298</span> </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 docs
2025-10-12 10:22:43 -04:00
<div class="line"><a id="l00305" name="l00305"></a><span class="lineno"> 305</span> <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a8fdac26e6298008aaeaa5b15f7fe244f">isValidSymbol</a>(<span class="keyword">const</span> std::string&amp; symbol);</div>
<div class="line"><a id="l00306" name="l00306"></a><span class="lineno"> 306</span></div>
<div class="line"><a id="l00312" name="l00312"></a><span class="lineno"> 312</span> [[nodiscard]] <span class="keywordtype">bool</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#addf03ba8b988970d341884d487aa94d5">isValidComposition</a>(<span class="keyword">const</span> std::vector&lt;double&gt;&amp; fractions) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00313" name="l00313"></a><span class="lineno"> 313</span></div>
<div class="line"><a id="l00319" name="l00319"></a><span class="lineno"> 319</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a86982685c34db4a8f079ddafc25c594e">validateComposition</a>(<span class="keyword">const</span> std::vector&lt;double&gt;&amp; fractions) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00320" name="l00320"></a><span class="lineno"> 320</span></div>
<div class="line"><a id="l00326" name="l00326"></a><span class="lineno"> 326</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a869dbae3db9d09c57b2df56a813a55fb">finalizeMassFracMode</a>(<span class="keywordtype">bool</span> norm);</div>
<div class="line"><a id="l00327" name="l00327"></a><span class="lineno"> 327</span></div>
<div class="line"><a id="l00333" name="l00333"></a><span class="lineno"> 333</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a461ab4e9cb5975cf865db5f16f03ddfe">finalizeNumberFracMode</a>(<span class="keywordtype">bool</span> norm);</div>
<div class="line"><a id="l00334" name="l00334"></a><span class="lineno"> 334</span> </div>
<div class="line"><a id="l00335" name="l00335"></a><span class="lineno"> 335</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00339" name="l00339"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition.html#a23b83b76ee025f6fc009184ee19bba88"> 339</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="l00340" name="l00340"></a><span class="lineno"> 340</span></div>
<div class="line"><a id="l00344" name="l00344"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition.html#a08c1d1fe9384c5255a6ba40e34b18315"> 344</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="l00345" name="l00345"></a><span class="lineno"> 345</span></div>
<div class="line"><a id="l00355" name="l00355"></a><span class="lineno"> 355</span> [[nodiscard]] <span class="keywordtype">bool</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a72d063a74a9d2197065884a2cea57a14">finalize</a>(<span class="keywordtype">bool</span> norm=<span class="keyword">false</span>);</div>
<div class="line"><a id="l00356" name="l00356"></a><span class="lineno"> 356</span></div>
<div class="line"><a id="l00370" name="l00370"></a><span class="lineno"> 370</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="l00371" name="l00371"></a><span class="lineno"> 371</span></div>
<div class="line"><a id="l00382" name="l00382"></a><span class="lineno"> 382</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="l00383" name="l00383"></a><span class="lineno"> 383</span></div>
<div class="line"><a id="l00401" name="l00401"></a><span class="lineno"> 401</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; fractions, <span class="keywordtype">bool</span> massFracMode=<span class="keyword">true</span>);</div>
<div class="line"><a id="l00402" name="l00402"></a><span class="lineno"> 402</span></div>
<div class="line"><a id="l00407" name="l00407"></a><span class="lineno"> 407</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="l00408" name="l00408"></a><span class="lineno"> 408</span></div>
<div class="line"><a id="l00414" name="l00414"></a><span class="lineno"> 414</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="l00415" name="l00415"></a><span class="lineno"> 415</span></div>
<div class="line"><a id="l00430" name="l00430"></a><span class="lineno"> 430</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a1bc2e64f87c12befdc2bc767e7405661">registerSymbol</a>(<span class="keyword">const</span> std::string&amp; symbol, <span class="keywordtype">bool</span> massFracMode=<span class="keyword">true</span>);</div>
<div class="line"><a id="l00431" name="l00431"></a><span class="lineno"> 431</span></div>
<div class="line"><a id="l00445" name="l00445"></a><span class="lineno"> 445</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a1bc2e64f87c12befdc2bc767e7405661">registerSymbol</a>(<span class="keyword">const</span> std::vector&lt;std::string&gt;&amp; symbols, <span class="keywordtype">bool</span> massFracMode=<span class="keyword">true</span>);</div>
<div class="line"><a id="l00446" name="l00446"></a><span class="lineno"> 446</span></div>
<div class="line"><a id="l00460" name="l00460"></a><span class="lineno"> 460</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a4ce00f73cc133bb1bac2b030b93ab480">registerSpecies</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structfourdst_1_1atomic_1_1_species.html">fourdst::atomic::Species</a>&amp; species, <span class="keywordtype">bool</span> massFracMode=<span class="keyword">true</span>);</div>
<div class="line"><a id="l00461" name="l00461"></a><span class="lineno"> 461</span> </div>
<div class="line"><a id="l00462" name="l00462"></a><span class="lineno"> 462</span></div>
<div class="line"><a id="l00477" name="l00477"></a><span class="lineno"> 477</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a4ce00f73cc133bb1bac2b030b93ab480">registerSpecies</a>(<span class="keyword">const</span> std::vector&lt;fourdst::atomic::Species&gt;&amp; species, <span class="keywordtype">bool</span> massFracMode=<span class="keyword">true</span>);</div>
<div class="line"><a id="l00478" name="l00478"></a><span class="lineno"> 478</span> </div>
<div class="line"><a id="l00479" name="l00479"></a><span class="lineno"> 479</span></div>
<div class="line"><a id="l00484" name="l00484"></a><span class="lineno"> 484</span> [[nodiscard]] std::set&lt;std::string&gt; <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a3f10f38878ba4be121d6d77a8b1f4d7a">getRegisteredSymbols</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00485" name="l00485"></a><span class="lineno"> 485</span></div>
<div class="line"><a id="l00490" name="l00490"></a><span class="lineno"> 490</span> [[nodiscard]] std::set&lt;fourdst::atomic::Species&gt; <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#af61ebe73a8b5926eb23037bb078fa87a">getRegisteredSpecies</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00491" name="l00491"></a><span class="lineno"> 491</span></div>
<div class="line"><a id="l00508" name="l00508"></a><span class="lineno"> 508</span> <span class="keywordtype">double</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a493224656aa3ade68389250720ef09af">setMassFraction</a>(<span class="keyword">const</span> std::string&amp; symbol, <span class="keyword">const</span> <span class="keywordtype">double</span>&amp; mass_fraction);</div>
<div class="line"><a id="l00509" name="l00509"></a><span class="lineno"> 509</span></div>
<div class="line"><a id="l00519" name="l00519"></a><span class="lineno"> 519</span> std::vector&lt;double&gt; <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a493224656aa3ade68389250720ef09af">setMassFraction</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; mass_fractions);</div>
<div class="line"><a id="l00520" name="l00520"></a><span class="lineno"> 520</span></div>
<div class="line"><a id="l00530" name="l00530"></a><span class="lineno"> 530</span> <span class="keywordtype">double</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a493224656aa3ade68389250720ef09af">setMassFraction</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structfourdst_1_1atomic_1_1_species.html">fourdst::atomic::Species</a>&amp; species, <span class="keyword">const</span> <span class="keywordtype">double</span>&amp; mass_fraction);</div>
<div class="line"><a id="l00531" name="l00531"></a><span class="lineno"> 531</span></div>
<div class="line"><a id="l00539" name="l00539"></a><span class="lineno"> 539</span> std::vector&lt;double&gt; <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a493224656aa3ade68389250720ef09af">setMassFraction</a>(<span class="keyword">const</span> std::vector&lt;fourdst::atomic::Species&gt;&amp; species, <span class="keyword">const</span> std::vector&lt;double&gt;&amp; mass_fractions);</div>
<div class="line"><a id="l00540" name="l00540"></a><span class="lineno"> 540</span></div>
<div class="line"><a id="l00551" name="l00551"></a><span class="lineno"> 551</span> <span class="keywordtype">double</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a7d4d748f3ee25e68751fb143717ed080">setNumberFraction</a>(<span class="keyword">const</span> std::string&amp; symbol, <span class="keyword">const</span> <span class="keywordtype">double</span>&amp; number_fraction);</div>
<div class="line"><a id="l00552" name="l00552"></a><span class="lineno"> 552</span></div>
<div class="line"><a id="l00561" name="l00561"></a><span class="lineno"> 561</span> std::vector&lt;double&gt; <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a7d4d748f3ee25e68751fb143717ed080">setNumberFraction</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; number_fractions);</div>
<div class="line"><a id="l00562" name="l00562"></a><span class="lineno"> 562</span></div>
<div class="line"><a id="l00572" name="l00572"></a><span class="lineno"> 572</span> <span class="keywordtype">double</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a7d4d748f3ee25e68751fb143717ed080">setNumberFraction</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structfourdst_1_1atomic_1_1_species.html">fourdst::atomic::Species</a>&amp; species, <span class="keyword">const</span> <span class="keywordtype">double</span>&amp; number_fraction);</div>
<div class="line"><a id="l00573" name="l00573"></a><span class="lineno"> 573</span></div>
<div class="line"><a id="l00581" name="l00581"></a><span class="lineno"> 581</span> std::vector&lt;double&gt; <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a7d4d748f3ee25e68751fb143717ed080">setNumberFraction</a>(<span class="keyword">const</span> std::vector&lt;fourdst::atomic::Species&gt;&amp; species, <span class="keyword">const</span> std::vector&lt;double&gt;&amp; number_fractions);</div>
<div class="line"><a id="l00582" name="l00582"></a><span class="lineno"> 582</span></div>
<div class="line"><a id="l00595" name="l00595"></a><span class="lineno"> 595</span> [[nodiscard]] <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a23b83b76ee025f6fc009184ee19bba88">Composition</a> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a3aead72892606725a4149a5f65bd31ec">mix</a>(<span class="keyword">const</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a23b83b76ee025f6fc009184ee19bba88">Composition</a>&amp; other, <span class="keywordtype">double</span> fraction) <span class="keyword">const</span>;</div>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
<div class="line"><a id="l00596" name="l00596"></a><span class="lineno"> 596</span></div>
docs(docs): rebuilt docs
2025-10-12 10:22:43 -04:00
<div class="line"><a id="l00603" name="l00603"></a><span class="lineno"> 603</span> [[nodiscard]] std::unordered_map&lt;std::string, double&gt; <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#aae07019ab6e02394e6ea353e0b98a417">getMassFraction</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00604" name="l00604"></a><span class="lineno"> 604</span></div>
<div class="line"><a id="l00613" name="l00613"></a><span class="lineno"> 613</span> [[nodiscard]] <span class="keywordtype">double</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#aae07019ab6e02394e6ea353e0b98a417">getMassFraction</a>(<span class="keyword">const</span> std::string&amp; symbol) <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00614" name="l00614"></a><span class="lineno"> 614</span></div>
<div class="line"><a id="l00623" name="l00623"></a><span class="lineno"> 623</span> [[nodiscard]] <span class="keywordtype">double</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#aae07019ab6e02394e6ea353e0b98a417">getMassFraction</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structfourdst_1_1atomic_1_1_species.html">fourdst::atomic::Species</a>&amp; species) <span class="keyword">const override</span>;</div>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
<div class="line"><a id="l00624" name="l00624"></a><span class="lineno"> 624</span></div>
docs(docs): rebuilt docs
2025-10-12 10:22:43 -04:00
<div class="line"><a id="l00633" name="l00633"></a><span class="lineno"> 633</span> [[nodiscard]] <span class="keywordtype">double</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#ae46fb8c3020dadd69080a7acd2054ea1">getNumberFraction</a>(<span class="keyword">const</span> std::string&amp; symbol) <span class="keyword">const override</span>;</div>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
<div class="line"><a id="l00634" name="l00634"></a><span class="lineno"> 634</span></div>
docs(docs): rebuilt docs
2025-10-12 10:22:43 -04:00
<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_1_composition.html#ae46fb8c3020dadd69080a7acd2054ea1">getNumberFraction</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structfourdst_1_1atomic_1_1_species.html">fourdst::atomic::Species</a>&amp; species) <span class="keyword">const override</span>;</div>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
<div class="line"><a id="l00644" name="l00644"></a><span class="lineno"> 644</span></div>
docs(docs): rebuilt docs
2025-10-12 10:22:43 -04:00
<div class="line"><a id="l00651" name="l00651"></a><span class="lineno"> 651</span> [[nodiscard]] std::unordered_map&lt;std::string, double&gt; <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#ae46fb8c3020dadd69080a7acd2054ea1">getNumberFraction</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00652" name="l00652"></a><span class="lineno"> 652</span></div>
<div class="line"><a id="l00661" name="l00661"></a><span class="lineno"> 661</span> [[nodiscard]] <span class="keywordtype">double</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#add67a92d73e3a57a2bbdb52bc9ca3bfe">getMolarAbundance</a>(<span class="keyword">const</span> std::string&amp; symbol) <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00662" name="l00662"></a><span class="lineno"> 662</span></div>
<div class="line"><a id="l00671" name="l00671"></a><span class="lineno"> 671</span> [[nodiscard]] <span class="keywordtype">double</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#add67a92d73e3a57a2bbdb52bc9ca3bfe">getMolarAbundance</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structfourdst_1_1atomic_1_1_species.html">fourdst::atomic::Species</a>&amp; species) <span class="keyword">const override</span>;</div>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
<div class="line"><a id="l00672" name="l00672"></a><span class="lineno"> 672</span></div>
docs(docs): rebuilt docs
2025-10-12 10:22:43 -04:00
<div class="line"><a id="l00681" name="l00681"></a><span class="lineno"> 681</span> [[nodiscard]] std::pair&lt;CompositionEntry, GlobalComposition&gt; <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a1138c86f7ccd39594601c2ec63ad89e9">getComposition</a>(<span class="keyword">const</span> std::string&amp; symbol) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00682" name="l00682"></a><span class="lineno"> 682</span></div>
<div class="line"><a id="l00691" name="l00691"></a><span class="lineno"> 691</span> [[nodiscard]] std::pair&lt;CompositionEntry, GlobalComposition&gt; <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a1138c86f7ccd39594601c2ec63ad89e9">getComposition</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structfourdst_1_1atomic_1_1_species.html">fourdst::atomic::Species</a>&amp; species) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00692" name="l00692"></a><span class="lineno"> 692</span></div>
<div class="line"><a id="l00699" name="l00699"></a><span class="lineno"> 699</span> [[nodiscard]] std::pair&lt;std::unordered_map&lt;std::string, CompositionEntry&gt;, <a class="code hl_struct" href="structfourdst_1_1composition_1_1_global_composition.html">GlobalComposition</a>&gt; <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a1138c86f7ccd39594601c2ec63ad89e9">getComposition</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00700" name="l00700"></a><span class="lineno"> 700</span></div>
<div class="line"><a id="l00707" name="l00707"></a><span class="lineno"> 707</span> [[nodiscard]] <span class="keywordtype">double</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a796386824d1358527fed7c6b537935d8">getMeanParticleMass</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00708" name="l00708"></a><span class="lineno"> 708</span></div>
<div class="line"><a id="l00715" name="l00715"></a><span class="lineno"> 715</span> [[nodiscard]] <span class="keywordtype">double</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#af7dd8f7d69727acfacf1bf58c4083a27">getMeanAtomicNumber</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00716" name="l00716"></a><span class="lineno"> 716</span></div>
<div class="line"><a id="l00723" name="l00723"></a><span class="lineno"> 723</span> [[nodiscard]] <span class="keywordtype">double</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a62dcfcf8f824d6af7903a9a9c3d5721e">getElectronAbundance</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00724" name="l00724"></a><span class="lineno"> 724</span></div>
<div class="line"><a id="l00734" name="l00734"></a><span class="lineno"> 734</span> [[nodiscard]] <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a23b83b76ee025f6fc009184ee19bba88">Composition</a> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a17635cd21744c7cf86cb1eb75152c816">subset</a>(<span class="keyword">const</span> std::vector&lt;std::string&gt;&amp; symbols, <span class="keyword">const</span> std::string&amp; method=<span class="stringliteral">&quot;norm&quot;</span>) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00735" name="l00735"></a><span class="lineno"> 735</span></div>
<div class="line"><a id="l00741" name="l00741"></a><span class="lineno"> 741</span> [[nodiscard]] <span class="keywordtype">bool</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#ac01ae1967c266d8187bc6e104c8a0d19">hasSymbol</a>(<span class="keyword">const</span> std::string&amp; symbol) <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00742" name="l00742"></a><span class="lineno"> 742</span></div>
<div class="line"><a id="l00748" name="l00748"></a><span class="lineno"> 748</span> [[nodiscard]] <span class="keywordtype">bool</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a55dfadad6cf5fb249356edad1733a813">hasSpecies</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structfourdst_1_1atomic_1_1_species.html">fourdst::atomic::Species</a> &amp;species) <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00749" name="l00749"></a><span class="lineno"> 749</span></div>
<div class="line"><a id="l00757" name="l00757"></a><span class="lineno"> 757</span> [[nodiscard]] <span class="keywordtype">bool</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a7efe2cd3a69b743bf2086941b6dfd965">contains</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structfourdst_1_1atomic_1_1_species.html">atomic::Species</a>&amp; isotope) <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00758" name="l00758"></a><span class="lineno"> 758</span></div>
<div class="line"><a id="l00767" name="l00767"></a><span class="lineno"> 767</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a0af981ed1074b26c237cf6cf35f82c9e">setCompositionMode</a>(<span class="keywordtype">bool</span> massFracMode);</div>
<div class="line"><a id="l00768" name="l00768"></a><span class="lineno"> 768</span></div>
<div class="line"><a id="l00778" name="l00778"></a><span class="lineno"> 778</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#ac75dbc8377556c835455991c7c7fe206">getCanonicalComposition</a>(<span class="keywordtype">bool</span> harsh=<span class="keyword">false</span>) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00779" name="l00779"></a><span class="lineno"> 779</span></div>
<div class="line"><a id="l00787" name="l00787"></a><span class="lineno"> 787</span> [[nodiscard]] std::vector&lt;double&gt; <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a85169b763138ab72047e43e07af978fb">getMassFractionVector</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00788" name="l00788"></a><span class="lineno"> 788</span></div>
<div class="line"><a id="l00796" name="l00796"></a><span class="lineno"> 796</span> [[nodiscard]] std::vector&lt;double&gt; <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a49d2eba540f28324c6b7145a5b6cabfd">getNumberFractionVector</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00797" name="l00797"></a><span class="lineno"> 797</span></div>
<div class="line"><a id="l00805" name="l00805"></a><span class="lineno"> 805</span> [[nodiscard]] std::vector&lt;double&gt; <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#abed665c07c42b40682da453576621399">getMolarAbundanceVector</a>() <span class="keyword">const override</span>;</div>
docs(docs): rebuilt docs for version 1.7.0
2025-09-16 11:24:28 -04:00
<div class="line"><a id="l00806" name="l00806"></a><span class="lineno"> 806</span></div>
docs(docs): rebuilt docs
2025-10-12 10:22:43 -04:00
<div class="line"><a id="l00817" name="l00817"></a><span class="lineno"> 817</span> [[nodiscard]] <span class="keywordtype">size_t</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a0d94f62402bb90b5d12679faeaa8c5d7">getSpeciesIndex</a>(<span class="keyword">const</span> std::string&amp; symbol) <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00818" name="l00818"></a><span class="lineno"> 818</span></div>
<div class="line"><a id="l00829" name="l00829"></a><span class="lineno"> 829</span> [[nodiscard]] <span class="keywordtype">size_t</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a0d94f62402bb90b5d12679faeaa8c5d7">getSpeciesIndex</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 override</span>;</div>
<div class="line"><a id="l00830" name="l00830"></a><span class="lineno"> 830</span></div>
<div class="line"><a id="l00840" name="l00840"></a><span class="lineno"> 840</span> [[nodiscard]] <a class="code hl_struct" href="structfourdst_1_1atomic_1_1_species.html">atomic::Species</a> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#ae4f854ded38f5e6fcd157a74a57cbf0c">getSpeciesAtIndex</a>(<span class="keywordtype">size_t</span> index) <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00841" name="l00841"></a><span class="lineno"> 841</span></div>
<div class="line"><a id="l00848" name="l00848"></a><span class="lineno"> 848</span> <span class="keyword">friend</span> std::ostream&amp; <a class="code hl_friend" href="classfourdst_1_1composition_1_1_composition.html#a36c2525d21cd932065bb2bb30bc57fb4">operator&lt;&lt;</a>(std::ostream&amp; os, <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="l00849" name="l00849"></a><span class="lineno"> 849</span></div>
<div class="line"><a id="l00858" name="l00858"></a><span class="lineno"> 858</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a23b83b76ee025f6fc009184ee19bba88">Composition</a> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a24a3bdeb8e8e55b54ecdee6dcb0d9561">operator+</a>(<span class="keyword">const</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a23b83b76ee025f6fc009184ee19bba88">Composition</a>&amp; other) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00859" name="l00859"></a><span class="lineno"> 859</span></div>
<div class="foldopen" id="foldopen00864" data-start="{" data-end="}">
<div class="line"><a id="l00864" name="l00864"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition.html#ab1701644ff1c83c220dc04eb58d1621b"> 864</a></span> <span class="keyword">auto</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#ab1701644ff1c83c220dc04eb58d1621b">begin</a>() {</div>
<div class="line"><a id="l00865" name="l00865"></a><span class="lineno"> 865</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="classfourdst_1_1composition_1_1_composition.html#aa7f2753b10e85ae3bbf0c3d600a973db">m_compositions</a>.begin();</div>
<div class="line"><a id="l00866" name="l00866"></a><span class="lineno"> 866</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="l00867" name="l00867"></a><span class="lineno"> 867</span></div>
<div class="foldopen" id="foldopen00872" data-start="{" data-end="}">
<div class="line"><a id="l00872" name="l00872"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition.html#adf41a833e8b704daf4f581fca5c8cb9b"> 872</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="l00873" name="l00873"></a><span class="lineno"> 873</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="classfourdst_1_1composition_1_1_composition.html#aa7f2753b10e85ae3bbf0c3d600a973db">m_compositions</a>.cbegin();</div>
<div class="line"><a id="l00874" name="l00874"></a><span class="lineno"> 874</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="l00875" name="l00875"></a><span class="lineno"> 875</span></div>
<div class="foldopen" id="foldopen00880" data-start="{" data-end="}">
<div class="line"><a id="l00880" name="l00880"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition.html#adeaf6f1213e78cb1fe8a8317f0a8adc2"> 880</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="l00881" name="l00881"></a><span class="lineno"> 881</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="classfourdst_1_1composition_1_1_composition.html#aa7f2753b10e85ae3bbf0c3d600a973db">m_compositions</a>.end();</div>
<div class="line"><a id="l00882" name="l00882"></a><span class="lineno"> 882</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="l00883" name="l00883"></a><span class="lineno"> 883</span></div>
<div class="foldopen" id="foldopen00888" data-start="{" data-end="}">
<div class="line"><a id="l00888" name="l00888"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition.html#aed2f5676f8f742199f01e4d1e9664bdd"> 888</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="l00889" name="l00889"></a><span class="lineno"> 889</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="classfourdst_1_1composition_1_1_composition.html#aa7f2753b10e85ae3bbf0c3d600a973db">m_compositions</a>.cend();</div>
<div class="line"><a id="l00890" name="l00890"></a><span class="lineno"> 890</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="l00891" name="l00891"></a><span class="lineno"> 891</span> </div>
<div class="line"><a id="l00892" name="l00892"></a><span class="lineno"> 892</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="l00893" name="l00893"></a><span class="lineno"> 893</span>}; <span class="comment">// namespace fourdst::composition</span></div>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
</div>
<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 docs
2025-10-12 10:22:43 -04: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#l00032">composition_abstract.h:32</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="#l00297">composition.h:297</a></div></div>
<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>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a0af981ed1074b26c237cf6cf35f82c9e"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a0af981ed1074b26c237cf6cf35f82c9e">fourdst::composition::Composition::setCompositionMode</a></div><div class="ttdeci">void setCompositionMode(bool massFracMode)</div><div class="ttdoc">Sets the composition mode (mass fraction vs. number fraction).</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00762">composition.cpp:762</a></div></div>
<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#l00917">composition.cpp:917</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a1138c86f7ccd39594601c2ec63ad89e9"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a1138c86f7ccd39594601c2ec63ad89e9">fourdst::composition::Composition::getComposition</a></div><div class="ttdeci">std::pair&lt; std::unordered_map&lt; std::string, CompositionEntry &gt;, GlobalComposition &gt; getComposition() const</div><div class="ttdoc">Gets all composition entries and the global composition data.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00682">composition.cpp:682</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a17635cd21744c7cf86cb1eb75152c816"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a17635cd21744c7cf86cb1eb75152c816">fourdst::composition::Composition::subset</a></div><div class="ttdeci">Composition subset(const std::vector&lt; std::string &gt; &amp;symbols, const std::string &amp;method=&quot;norm&quot;) const</div><div class="ttdoc">Creates a new Composition object containing a subset of species from this one.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00734">composition.cpp:734</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a1bc2e64f87c12befdc2bc767e7405661"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a1bc2e64f87c12befdc2bc767e7405661">fourdst::composition::Composition::registerSymbol</a></div><div class="ttdeci">void registerSymbol(const std::string &amp;symbol, bool massFracMode=true)</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#l00255">composition.cpp:255</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a1f96b2c567364368ea5ee6f0826f3091"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a1f96b2c567364368ea5ee6f0826f3091">fourdst::composition::Composition::m_config</a></div><div class="ttdeci">config::Config &amp; m_config</div><div class="ttdef"><b>Definition</b> <a href="#l00285">composition.h:285</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 docs
2025-10-12 10:22:43 -04:00
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a24a3bdeb8e8e55b54ecdee6dcb0d9561"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a24a3bdeb8e8e55b54ecdee6dcb0d9561">fourdst::composition::Composition::operator+</a></div><div class="ttdeci">Composition operator+(const Composition &amp;other) const</div><div class="ttdoc">Overloads the + operator to mix two compositions with a 50/50 fraction.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l01054">composition.cpp:1054</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a36c2525d21cd932065bb2bb30bc57fb4"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a36c2525d21cd932065bb2bb30bc57fb4">fourdst::composition::Composition::operator&lt;&lt;</a></div><div class="ttdeci">friend std::ostream &amp; operator&lt;&lt;(std::ostream &amp;os, const Composition &amp;composition)</div><div class="ttdoc">Overloaded output stream operator for Composition.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l01078">composition.cpp:1078</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a39bfcb7d81d723cbd9d021abd533b4d6"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a39bfcb7d81d723cbd9d021abd533b4d6">fourdst::composition::Composition::m_registeredSymbols</a></div><div class="ttdeci">std::set&lt; std::string &gt; m_registeredSymbols</div><div class="ttdoc">The registered symbols.</div><div class="ttdef"><b>Definition</b> <a href="#l00294">composition.h:294</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a3aead72892606725a4149a5f65bd31ec"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a3aead72892606725a4149a5f65bd31ec">fourdst::composition::Composition::mix</a></div><div class="ttdeci">Composition mix(const Composition &amp;other, double fraction) const</div><div class="ttdoc">Mixes this composition with another to produce a new composition.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00533">composition.cpp:533</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a3f10f38878ba4be121d6d77a8b1f4d7a"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a3f10f38878ba4be121d6d77a8b1f4d7a">fourdst::composition::Composition::getRegisteredSymbols</a></div><div class="ttdeci">std::set&lt; std::string &gt; getRegisteredSymbols() const override</div><div class="ttdoc">Gets the registered symbols.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00309">composition.cpp:309</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a40b2128948f01630cd2968488b450ce5"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a40b2128948f01630cd2968488b450ce5">fourdst::composition::Composition::m_logManager</a></div><div class="ttdeci">logging::LogManager &amp; m_logManager</div><div class="ttdef"><b>Definition</b> <a href="#l00286">composition.h:286</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a461ab4e9cb5975cf865db5f16f03ddfe"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a461ab4e9cb5975cf865db5f16f03ddfe">fourdst::composition::Composition::finalizeNumberFracMode</a></div><div class="ttdeci">bool finalizeNumberFracMode(bool norm)</div><div class="ttdoc">Finalizes the composition in number fraction mode.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00489">composition.cpp:489</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a493224656aa3ade68389250720ef09af"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a493224656aa3ade68389250720ef09af">fourdst::composition::Composition::setMassFraction</a></div><div class="ttdeci">double setMassFraction(const std::string &amp;symbol, const double &amp;mass_fraction)</div><div class="ttdoc">Sets the mass fraction for a given symbol.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00343">composition.cpp:343</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a49d2eba540f28324c6b7145a5b6cabfd"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a49d2eba540f28324c6b7145a5b6cabfd">fourdst::composition::Composition::getNumberFractionVector</a></div><div class="ttdeci">std::vector&lt; double &gt; getNumberFractionVector() const 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#l00866">composition.cpp:866</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a4a36c8d22ce61023e7bea1d9417577d4"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a4a36c8d22ce61023e7bea1d9417577d4">fourdst::composition::Composition::m_meanParticleMass</a></div><div class="ttdeci">double m_meanParticleMass</div><div class="ttdoc">The mean particle mass of the composition (\sum_{i} \frac{n_i}{m_i}. where n_i is the number fraction...</div><div class="ttdef"><b>Definition</b> <a href="#l00291">composition.h:291</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a4ce00f73cc133bb1bac2b030b93ab480"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a4ce00f73cc133bb1bac2b030b93ab480">fourdst::composition::Composition::registerSpecies</a></div><div class="ttdeci">void registerSpecies(const fourdst::atomic::Species &amp;species, bool massFracMode=true)</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#l00293">composition.cpp:293</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#l00243">composition.cpp:243</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a55dfadad6cf5fb249356edad1733a813"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a55dfadad6cf5fb249356edad1733a813">fourdst::composition::Composition::hasSpecies</a></div><div class="ttdeci">bool hasSpecies(const fourdst::atomic::Species &amp;species) const override</div><div class="ttdoc">Checks if a species is registered in the composition.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l01029">composition.cpp:1029</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a62dcfcf8f824d6af7903a9a9c3d5721e"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a62dcfcf8f824d6af7903a9a9c3d5721e">fourdst::composition::Composition::getElectronAbundance</a></div><div class="ttdeci">double getElectronAbundance() const 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#l00716">composition.cpp:716</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a671f1ee8be00f4ff8c1d94fabb382380"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a671f1ee8be00f4ff8c1d94fabb382380">fourdst::composition::Composition::m_massFracMode</a></div><div class="ttdeci">bool m_massFracMode</div><div class="ttdoc">True if mass fraction mode, false if number fraction mode.</div><div class="ttdef"><b>Definition</b> <a href="#l00292">composition.h:292</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a72d063a74a9d2197065884a2cea57a14"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a72d063a74a9d2197065884a2cea57a14">fourdst::composition::Composition::finalize</a></div><div class="ttdeci">bool finalize(bool norm=false)</div><div class="ttdoc">Finalizes the composition, making it ready for querying.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00445">composition.cpp:445</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a796386824d1358527fed7c6b537935d8"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a796386824d1358527fed7c6b537935d8">fourdst::composition::Composition::getMeanParticleMass</a></div><div class="ttdeci">double getMeanParticleMass() const 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#l00690">composition.cpp:690</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a7d4d748f3ee25e68751fb143717ed080"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a7d4d748f3ee25e68751fb143717ed080">fourdst::composition::Composition::setNumberFraction</a></div><div class="ttdeci">double setNumberFraction(const std::string &amp;symbol, const double &amp;number_fraction)</div><div class="ttdoc">Sets the number fraction for a given symbol.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00374">composition.cpp:374</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a7efe2cd3a69b743bf2086941b6dfd965"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a7efe2cd3a69b743bf2086941b6dfd965">fourdst::composition::Composition::contains</a></div><div class="ttdeci">bool contains(const atomic::Species &amp;isotope) const override</div><div class="ttdoc">Checks if a given isotope is present in the composition.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l01038">composition.cpp:1038</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a85169b763138ab72047e43e07af978fb"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a85169b763138ab72047e43e07af978fb">fourdst::composition::Composition::getMassFractionVector</a></div><div class="ttdeci">std::vector&lt; double &gt; getMassFractionVector() const 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#l00840">composition.cpp:840</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a86982685c34db4a8f079ddafc25c594e"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a86982685c34db4a8f079ddafc25c594e">fourdst::composition::Composition::validateComposition</a></div><div class="ttdeci">void validateComposition(const std::vector&lt; double &gt; &amp;fractions) const</div><div class="ttdoc">Validates the given fractions, throwing an exception on failure.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00327">composition.cpp:327</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a869dbae3db9d09c57b2df56a813a55fb"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a869dbae3db9d09c57b2df56a813a55fb">fourdst::composition::Composition::finalizeMassFracMode</a></div><div class="ttdeci">bool finalizeMassFracMode(bool norm)</div><div class="ttdoc">Finalizes the composition in mass fraction mode.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00453">composition.cpp:453</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a8fdac26e6298008aaeaa5b15f7fe244f"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a8fdac26e6298008aaeaa5b15f7fe244f">fourdst::composition::Composition::isValidSymbol</a></div><div class="ttdeci">static bool isValidSymbol(const std::string &amp;symbol)</div><div class="ttdoc">Checks if the given symbol is valid by checking against the global species database.</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_aa00cbc0933d8a22bb900ac21a338e5ac"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#aa00cbc0933d8a22bb900ac21a338e5ac">fourdst::composition::Composition::m_finalized</a></div><div class="ttdeci">bool m_finalized</div><div class="ttdoc">True if the composition is finalized.</div><div class="ttdef"><b>Definition</b> <a href="#l00289">composition.h:289</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_aa7f2753b10e85ae3bbf0c3d600a973db"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#aa7f2753b10e85ae3bbf0c3d600a973db">fourdst::composition::Composition::m_compositions</a></div><div class="ttdeci">std::unordered_map&lt; std::string, CompositionEntry &gt; m_compositions</div><div class="ttdoc">The compositions.</div><div class="ttdef"><b>Definition</b> <a href="#l00295">composition.h:295</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_aae07019ab6e02394e6ea353e0b98a417"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#aae07019ab6e02394e6ea353e0b98a417">fourdst::composition::Composition::getMassFraction</a></div><div class="ttdeci">std::unordered_map&lt; std::string, double &gt; getMassFraction() const 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#l00601">composition.cpp:601</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 composition map.</div><div class="ttdef"><b>Definition</b> <a href="#l00864">composition.h:864</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_ab6c66f35e1fb05dd24aacaf90e115c5e"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#ab6c66f35e1fb05dd24aacaf90e115c5e">fourdst::composition::Composition::m_logger</a></div><div class="ttdeci">quill::Logger * m_logger</div><div class="ttdef"><b>Definition</b> <a href="#l00287">composition.h:287</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_abed665c07c42b40682da453576621399"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#abed665c07c42b40682da453576621399">fourdst::composition::Composition::getMolarAbundanceVector</a></div><div class="ttdeci">std::vector&lt; double &gt; getMolarAbundanceVector() const 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#l00891">composition.cpp:891</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_ac01ae1967c266d8187bc6e104c8a0d19"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#ac01ae1967c266d8187bc6e104c8a0d19">fourdst::composition::Composition::hasSymbol</a></div><div class="ttdeci">bool hasSymbol(const std::string &amp;symbol) const override</div><div class="ttdoc">Checks if a symbol is registered in the composition.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l01023">composition.cpp:1023</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_ac75dbc8377556c835455991c7c7fe206"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#ac75dbc8377556c835455991c7c7fe206">fourdst::composition::Composition::getCanonicalComposition</a></div><div class="ttdeci">CanonicalComposition getCanonicalComposition(bool harsh=false) const</div><div class="ttdoc">Gets the current canonical composition (X, Y, Z).</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00785">composition.cpp:785</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 abundance (X_i / A_i) for a given symbol.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00641">composition.cpp:641</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_addae4484da7d5072ab66a721dbe04ced"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#addae4484da7d5072ab66a721dbe04ced">fourdst::composition::Composition::m_specificNumberDensity</a></div><div class="ttdeci">double m_specificNumberDensity</div><div class="ttdoc">The specific number density of the composition (\sum_{i} X_i m_i. Where X_i is the number fraction of...</div><div class="ttdef"><b>Definition</b> <a href="#l00290">composition.h:290</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_addf03ba8b988970d341884d487aa94d5"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#addf03ba8b988970d341884d487aa94d5">fourdst::composition::Composition::isValidComposition</a></div><div class="ttdeci">bool isValidComposition(const std::vector&lt; double &gt; &amp;fractions) const</div><div class="ttdoc">Checks if the given fractions are valid (sum to ~1.0).</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00334">composition.cpp:334</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 composition map.</div><div class="ttdef"><b>Definition</b> <a href="#l00880">composition.h:880</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 composition map.</div><div class="ttdef"><b>Definition</b> <a href="#l00872">composition.h:872</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_ae46fb8c3020dadd69080a7acd2054ea1"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#ae46fb8c3020dadd69080a7acd2054ea1">fourdst::composition::Composition::getNumberFraction</a></div><div class="ttdeci">std::unordered_map&lt; std::string, double &gt; getNumberFraction() const 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#l00633">composition.cpp:633</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#l00993">composition.cpp:993</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 composition map.</div><div class="ttdef"><b>Definition</b> <a href="#l00888">composition.h:888</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_af61ebe73a8b5926eb23037bb078fa87a"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#af61ebe73a8b5926eb23037bb078fa87a">fourdst::composition::Composition::getRegisteredSpecies</a></div><div class="ttdeci">std::set&lt; fourdst::atomic::Species &gt; getRegisteredSpecies() const 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#l00313">composition.cpp:313</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_af7dd8f7d69727acfacf1bf58c4083a27"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#af7dd8f7d69727acfacf1bf58c4083a27">fourdst::composition::Composition::getMeanAtomicNumber</a></div><div class="ttdeci">double getMeanAtomicNumber() const override</div><div class="ttdoc">Compute the mean atomic number of the composition.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00698">composition.cpp:698</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="ttdef"><b>Definition</b> <a href="#l00034">composition.h:34</a></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>
<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="ttdef"><b>Definition</b> <a href="#l00257">composition.h:257</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="#l00263">composition.h:263</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="#l00261">composition.h:261</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="#l00259">composition.h:259</a></div></div>
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_1_1_composition_cache_html_a9a9dc0e4ec0d094e604569de9ce6c125"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.html#a9a9dc0e4ec0d094e604569de9ce6c125">fourdst::composition::Composition::CompositionCache::globalComp</a></div><div class="ttdeci">std::optional&lt; GlobalComposition &gt; globalComp</div><div class="ttdoc">Cached global composition data.</div><div class="ttdef"><b>Definition</b> <a href="#l00258">composition.h:258</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="#l00262">composition.h:262</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="#l00264">composition.h:264</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="ttdef"><b>Definition</b> <a href="#l00267">composition.h:267</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="#l00260">composition.h:260</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="#l00265">composition.h:265</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="ttdef"><b>Definition</b> <a href="#l00278">composition.h:278</a></div></div>
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_a00332551f5b2f0d7f10b12a091e21fa8"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#a00332551f5b2f0d7f10b12a091e21fa8">fourdst::composition::CompositionEntry::setNumberFracMode</a></div><div class="ttdeci">bool setNumberFracMode(double totalMolesPerMass)</div><div class="ttdoc">Switches the mode to number fraction mode.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00171">composition.cpp:171</a></div></div>
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_a0498d707d8ea78be39283786c10657ef"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#a0498d707d8ea78be39283786c10657ef">fourdst::composition::CompositionEntry::m_relAbundance</a></div><div class="ttdeci">double m_relAbundance</div><div class="ttdoc">The relative abundance, used internally for conversions. For mass fraction mode, this is X_i / A_i; f...</div><div class="ttdef"><b>Definition</b> <a href="#l00091">composition.h:91</a></div></div>
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_a14f12b8b0178df2e32e2023bd4564ddc"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#a14f12b8b0178df2e32e2023bd4564ddc">fourdst::composition::CompositionEntry::getMassFracMode</a></div><div class="ttdeci">bool getMassFracMode() const</div><div class="ttdoc">Gets the mode of the composition entry.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00183">composition.cpp:183</a></div></div>
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_a1cccb94c150dd1dcde860f55fbeaf2bd"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#a1cccb94c150dd1dcde860f55fbeaf2bd">fourdst::composition::CompositionEntry::CompositionEntry</a></div><div class="ttdeci">CompositionEntry()</div><div class="ttdoc">Default constructor. Initializes a default entry (H-1), but in an uninitialized state.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00069">composition.cpp:69</a></div></div>
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_a1e860519bea86793413ed67c76d18c8b"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#a1e860519bea86793413ed67c76d18c8b">fourdst::composition::CompositionEntry::m_massFracMode</a></div><div class="ttdeci">bool m_massFracMode</div><div class="ttdoc">The mode of the composition entry. True if mass fraction, false if number fraction.</div><div class="ttdef"><b>Definition</b> <a href="#l00087">composition.h:87</a></div></div>
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_a2b5e245f7dabb11076efdbe1ed516d9f"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#a2b5e245f7dabb11076efdbe1ed516d9f">fourdst::composition::CompositionEntry::m_numberFraction</a></div><div class="ttdeci">double m_numberFraction</div><div class="ttdoc">The number fraction (mole fraction) of the species. Valid only if m_massFracMode is false.</div><div class="ttdef"><b>Definition</b> <a href="#l00090">composition.h:90</a></div></div>
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_a2d55492d285068d4a64db5602dfb1c78"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#a2d55492d285068d4a64db5602dfb1c78">fourdst::composition::CompositionEntry::number_fraction</a></div><div class="ttdeci">double number_fraction() const</div><div class="ttdoc">Gets the number fraction of the species.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00110">composition.cpp:110</a></div></div>
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_a38f3e109b2952c1f0e7444d7fb9e93a0"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#a38f3e109b2952c1f0e7444d7fb9e93a0">fourdst::composition::CompositionEntry::CompositionEntry</a></div><div class="ttdeci">CompositionEntry(const CompositionEntry &amp;entry)</div><div class="ttdoc">Copy constructor.</div></div>
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_a391e899874cd7ef299a3ae1f64c016d2"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#a391e899874cd7ef299a3ae1f64c016d2">fourdst::composition::CompositionEntry::m_initialized</a></div><div class="ttdeci">bool m_initialized</div><div class="ttdoc">True if the composition entry has been initialized with a valid species.</div><div class="ttdef"><b>Definition</b> <a href="#l00096">composition.h:96</a></div></div>
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_a3b056b6b923016d271f034333c96d039"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#a3b056b6b923016d271f034333c96d039">fourdst::composition::CompositionEntry::m_cachedNumberFraction</a></div><div class="ttdeci">double m_cachedNumberFraction</div><div class="ttdoc">Cached number fraction for conversions when in mass fraction mode.</div><div class="ttdef"><b>Definition</b> <a href="#l00093">composition.h:93</a></div></div>
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_a3fb3f63a4e5675c6fefb662a8e3e7aa3"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#a3fb3f63a4e5675c6fefb662a8e3e7aa3">fourdst::composition::CompositionEntry::setMassFracMode</a></div><div class="ttdeci">bool setMassFracMode(double meanMolarMass)</div><div class="ttdoc">Switches the mode to mass fraction mode.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00159">composition.cpp:159</a></div></div>
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_a4d6df43e098e7e2e2d94ff7fb76cb4c2"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#a4d6df43e098e7e2e2d94ff7fb76cb4c2">fourdst::composition::CompositionEntry::setMassFraction</a></div><div class="ttdeci">void setMassFraction(double mass_fraction)</div><div class="ttdoc">Sets the mass fraction of the species.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00134">composition.cpp:134</a></div></div>
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_a50d18b4c27611fa9314dd756af54c2f0"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#a50d18b4c27611fa9314dd756af54c2f0">fourdst::composition::CompositionEntry::symbol</a></div><div class="ttdeci">std::string symbol() const</div><div class="ttdoc">Gets the chemical symbol of the species.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00098">composition.cpp:98</a></div></div>
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_a5885a0e33687bceb15b225a00163e9d3"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#a5885a0e33687bceb15b225a00163e9d3">fourdst::composition::CompositionEntry::setSpecies</a></div><div class="ttdeci">void setSpecies(const std::string &amp;symbol)</div><div class="ttdoc">Sets the species for the composition entry. This can only be done once.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00086">composition.cpp:86</a></div></div>
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_a66cb086719d7f654869bd7b0cee87ffc"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#a66cb086719d7f654869bd7b0cee87ffc">fourdst::composition::CompositionEntry::mass_fraction</a></div><div class="ttdeci">double mass_fraction() const</div><div class="ttdoc">Gets the mass fraction of the species.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00102">composition.cpp:102</a></div></div>
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_a79039cbdc76b4401eb2ce44b85467503"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#a79039cbdc76b4401eb2ce44b85467503">fourdst::composition::CompositionEntry::m_isotope</a></div><div class="ttdeci">atomic::Species m_isotope</div><div class="ttdoc">The atomic::Species object containing detailed isotope data.</div><div class="ttdef"><b>Definition</b> <a href="#l00086">composition.h:86</a></div></div>
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_a9ec47cf4b3399128d3836c1b24b031b0"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#a9ec47cf4b3399128d3836c1b24b031b0">fourdst::composition::CompositionEntry::setNumberFraction</a></div><div class="ttdeci">void setNumberFraction(double number_fraction)</div><div class="ttdoc">Sets the number fraction of the species.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00148">composition.cpp:148</a></div></div>
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_ab6619d23e111905d1e3ab16ee822d96c"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#ab6619d23e111905d1e3ab16ee822d96c">fourdst::composition::CompositionEntry::rel_abundance</a></div><div class="ttdeci">double rel_abundance() const</div><div class="ttdoc">Gets the relative abundance of the species.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00126">composition.cpp:126</a></div></div>
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_ac273debdba6a1b3ac0f11698c399d38e"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#ac273debdba6a1b3ac0f11698c399d38e">fourdst::composition::CompositionEntry::m_symbol</a></div><div class="ttdeci">std::string m_symbol</div><div class="ttdoc">The chemical symbol of the species (e.g., &quot;H-1&quot;, &quot;Fe-56&quot;).</div><div class="ttdef"><b>Definition</b> <a href="#l00085">composition.h:85</a></div></div>
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_acd41be41f03c819521bab28ea0d8bed2"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#acd41be41f03c819521bab28ea0d8bed2">fourdst::composition::CompositionEntry::m_molesPerMass</a></div><div class="ttdeci">double m_molesPerMass</div><div class="ttdef"><b>Definition</b> <a href="#l00092">composition.h:92</a></div></div>
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_adc20165bf94e18eea3458003025579ac"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#adc20165bf94e18eea3458003025579ac">fourdst::composition::CompositionEntry::m_massFraction</a></div><div class="ttdeci">double m_massFraction</div><div class="ttdoc">The mass fraction of the species. Valid only if m_massFracMode is true.</div><div class="ttdef"><b>Definition</b> <a href="#l00089">composition.h:89</a></div></div>
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_ae7a6a113fc5914248eff5629716d6eb2"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#ae7a6a113fc5914248eff5629716d6eb2">fourdst::composition::CompositionEntry::operator&lt;&lt;</a></div><div class="ttdeci">friend std::ostream &amp; operator&lt;&lt;(std::ostream &amp;os, const CompositionEntry &amp;entry)</div><div class="ttdoc">Overloaded output stream operator for CompositionEntry.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l01070">composition.cpp:1070</a></div></div>
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_af49920b1168be92d517aea03a308fee1"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#af49920b1168be92d517aea03a308fee1">fourdst::composition::CompositionEntry::isotope</a></div><div class="ttdeci">atomic::Species isotope() const</div><div class="ttdoc">Gets the isotope data for the species.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00130">composition.cpp:130</a></div></div>
<div class="ttc" id="astructfourdst_1_1composition_1_1_global_composition_html"><div class="ttname"><a href="structfourdst_1_1composition_1_1_global_composition.html">fourdst::composition::GlobalComposition</a></div><div class="ttdoc">Represents global properties of a finalized composition.</div><div class="ttdef"><b>Definition</b> <a href="#l00070">composition.h:70</a></div></div>
<div class="ttc" id="astructfourdst_1_1composition_1_1_global_composition_html_a0df6ecfe28d13cbffd0abcbfec9aee41"><div class="ttname"><a href="structfourdst_1_1composition_1_1_global_composition.html#a0df6ecfe28d13cbffd0abcbfec9aee41">fourdst::composition::GlobalComposition::specificNumberDensity</a></div><div class="ttdeci">double specificNumberDensity</div><div class="ttdoc">The specific number density (moles per unit mass, sum of X_i/M_i), where X_i is mass fraction and M_i...</div><div class="ttdef"><b>Definition</b> <a href="#l00071">composition.h:71</a></div></div>
<div class="ttc" id="astructfourdst_1_1composition_1_1_global_composition_html_a3c072a749c3648607771ac9105181f26"><div class="ttname"><a href="structfourdst_1_1composition_1_1_global_composition.html#a3c072a749c3648607771ac9105181f26">fourdst::composition::GlobalComposition::operator&lt;&lt;</a></div><div class="ttdeci">friend std::ostream &amp; operator&lt;&lt;(std::ostream &amp;os, const GlobalComposition &amp;comp)</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l01060">composition.cpp:1060</a></div></div>
<div class="ttc" id="astructfourdst_1_1composition_1_1_global_composition_html_a9c35810d965841a755da9ce4644a2f1b"><div class="ttname"><a href="structfourdst_1_1composition_1_1_global_composition.html#a9c35810d965841a755da9ce4644a2f1b">fourdst::composition::GlobalComposition::meanParticleMass</a></div><div class="ttdeci">double meanParticleMass</div><div class="ttdoc">The mean mass per particle (inverse of specific number density). Units: g/mol.</div><div class="ttdef"><b>Definition</b> <a href="#l00072">composition.h:72</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