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

220 lines
38 KiB
HTML
Raw Blame History

<!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_abstract.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">fourdst::libcomposition<span id="projectnumber">&#160;v2.4.9</span>
</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__abstract_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_abstract.h</div></div>
</div><!--header-->
<div class="contents">
<a href="composition__abstract_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span> </div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#include &quot;<a class="code" href="atomic_species_8h.html">fourdst/atomic/atomicSpecies.h</a>&quot;</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &quot;<a class="code" href="composition__abstract__iterator_8h.html">fourdst/composition/iterators/composition_abstract_iterator.h</a>&quot;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> </div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include &lt;unordered_map&gt;</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include &lt;set&gt;</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include &lt;memory&gt;</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> </div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacefourdst_1_1composition.html">fourdst::composition</a> {</div>
<div class="foldopen" id="foldopen00036" data-start="{" data-end="};">
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition_abstract.html"> 36</a></span> <span class="keyword">class </span><a class="code hl_class" href="classfourdst_1_1composition_1_1_composition_abstract.html">CompositionAbstract</a> {</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition_abstract.html#abd12f3a9a5b6217498ff19e25ee3ddb0"> 38</a></span> <span class="keyword">using </span><a class="code hl_typedef" href="classfourdst_1_1composition_1_1_composition_abstract.html#abd12f3a9a5b6217498ff19e25ee3ddb0">iterator</a> = <a class="code hl_class" href="classfourdst_1_1composition_1_1detail_1_1_composition_iterator.html">detail::CompositionIterator&lt;false&gt;</a>;</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition_abstract.html#a0bb9772bc73d637950b6cf2e8e6afeb0"> 39</a></span> <span class="keyword">using </span><a class="code hl_typedef" href="classfourdst_1_1composition_1_1_composition_abstract.html#a0bb9772bc73d637950b6cf2e8e6afeb0">const_iterator</a> = <a class="code hl_class" href="classfourdst_1_1composition_1_1detail_1_1_composition_iterator.html">detail::CompositionIterator&lt;true&gt;</a>;</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition_abstract.html#a83ff77f3f390bb66c978e157d9bb6394"> 43</a></span> <span class="keyword">virtual</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition_abstract.html#a83ff77f3f390bb66c978e157d9bb6394">~CompositionAbstract</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition_abstract.html#a2e6c4d27d2b295b6be87c6964cac1e1e"> 50</a></span> [[nodiscard]] <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition_abstract.html#a2e6c4d27d2b295b6be87c6964cac1e1e">contains</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="keyword">noexcept</span> = 0;</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition_abstract.html#a6fe83824aefb045d8a5399e8ac9852f9"> 57</a></span> [[nodiscard]] <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition_abstract.html#a6fe83824aefb045d8a5399e8ac9852f9">contains</a>(<span class="keyword">const</span> std::string&amp; symbol) <span class="keyword">const</span> = 0;</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> </div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition_abstract.html#af7ec2eaa16a0c78d19728e32469cec06"> 59</a></span> [[nodiscard]] <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition_abstract.html#af7ec2eaa16a0c78d19728e32469cec06">size</a>() const noexcept = 0;</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition_abstract.html#a94c2cadeae32ab19cee42fc1670c4c6c"> 65</a></span> [[nodiscard]] virtual std::set&lt;std::<span class="keywordtype">string</span>&gt; <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition_abstract.html#a94c2cadeae32ab19cee42fc1670c4c6c">getRegisteredSymbols</a>() const noexcept = 0;</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition_abstract.html#ad17ae8649860ef4f7a949e7c9143c0ec"> 71</a></span> [[nodiscard]] virtual const std::vector&lt;<a class="code hl_namespace" href="namespacefourdst_1_1atomic.html">atomic</a>::Species&gt; &amp;<a class="code hl_function" href="classfourdst_1_1composition_1_1_composition_abstract.html#ad17ae8649860ef4f7a949e7c9143c0ec">getRegisteredSpecies</a>() const noexcept = 0;</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition_abstract.html#a3e3248162611754ca4c54b9979f6664d"> 77</a></span> [[nodiscard]] virtual std::unordered_map&lt;<a class="code hl_namespace" href="namespacefourdst.html">fourdst</a>::<a class="code hl_namespace" href="namespacefourdst_1_1atomic.html">atomic</a>::Species, <span class="keywordtype">double</span>&gt; <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition_abstract.html#a3e3248162611754ca4c54b9979f6664d">getMassFraction</a>() const noexcept = 0;</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span></div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition_abstract.html#a65bae043ffbf4514b2593ccb63c6e265"> 83</a></span> [[nodiscard]] virtual std::unordered_map&lt;<a class="code hl_namespace" href="namespacefourdst.html">fourdst</a>::<a class="code hl_namespace" href="namespacefourdst_1_1atomic.html">atomic</a>::Species, <span class="keywordtype">double</span>&gt; <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition_abstract.html#a65bae043ffbf4514b2593ccb63c6e265">getNumberFraction</a>() const noexcept = 0;</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span></div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition_abstract.html#a0ebe22344f785e5db693e04b9b598a5a"> 90</a></span> [[nodiscard]] virtual <span class="keywordtype">double</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition_abstract.html#a3e3248162611754ca4c54b9979f6664d">getMassFraction</a>(const std::<span class="keywordtype">string</span>&amp; symbol) const = 0;</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span></div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition_abstract.html#a0396f17ba252d053c0126323a76e9142"> 97</a></span> [[nodiscard]] virtual <span class="keywordtype">double</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition_abstract.html#a3e3248162611754ca4c54b9979f6664d">getMassFraction</a>(const <a class="code hl_namespace" href="namespacefourdst.html">fourdst</a>::<a class="code hl_namespace" href="namespacefourdst_1_1atomic.html">atomic</a>::Species&amp; species) const = 0;</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span></div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition_abstract.html#af490daa6942717605093b4fca3e676b8"> 104</a></span> [[nodiscard]] virtual <span class="keywordtype">double</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition_abstract.html#a65bae043ffbf4514b2593ccb63c6e265">getNumberFraction</a>(const std::<span class="keywordtype">string</span>&amp; symbol) const = 0;</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span></div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition_abstract.html#a71b351d6e69cf0d7e7c43409e1b13c4c"> 111</a></span> [[nodiscard]] virtual <span class="keywordtype">double</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition_abstract.html#a65bae043ffbf4514b2593ccb63c6e265">getNumberFraction</a>(const <a class="code hl_namespace" href="namespacefourdst.html">fourdst</a>::<a class="code hl_namespace" href="namespacefourdst_1_1atomic.html">atomic</a>::Species&amp; species) const = 0;</div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span></div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition_abstract.html#a29613d8197cee96f764aeeaa3b7286f8"> 118</a></span> [[nodiscard]] virtual <span class="keywordtype">double</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition_abstract.html#a29613d8197cee96f764aeeaa3b7286f8">getMolarAbundance</a>(const std::<span class="keywordtype">string</span>&amp; symbol) const = 0;</div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span></div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition_abstract.html#adf861bd58e80025b021af2949b41d126"> 125</a></span> [[nodiscard]] virtual <span class="keywordtype">double</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition_abstract.html#a29613d8197cee96f764aeeaa3b7286f8">getMolarAbundance</a>(const <a class="code hl_namespace" href="namespacefourdst.html">fourdst</a>::<a class="code hl_namespace" href="namespacefourdst_1_1atomic.html">atomic</a>::Species&amp; species) const = 0;</div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span></div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition_abstract.html#afedcef16ed403b95ce7f1e6756aa46e8"> 131</a></span> [[nodiscard]] virtual <span class="keywordtype">double</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition_abstract.html#afedcef16ed403b95ce7f1e6756aa46e8">getMeanParticleMass</a>() const noexcept = 0;</div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span></div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition_abstract.html#ad0fcf2e51cca02c4224241828335db1a"> 137</a></span> [[nodiscard]] virtual <span class="keywordtype">double</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition_abstract.html#ad0fcf2e51cca02c4224241828335db1a">getElectronAbundance</a>() const noexcept = 0;</div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span></div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition_abstract.html#a752af872347c612bf3b43b1711c2cfc0"> 143</a></span> [[nodiscard]] virtual std::vector&lt;<span class="keywordtype">double</span>&gt; <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition_abstract.html#a752af872347c612bf3b43b1711c2cfc0">getMassFractionVector</a>() const noexcept = 0;</div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno"> 144</span></div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition_abstract.html#a83343286d738d101635b2a7f5b7d96ef"> 149</a></span> [[nodiscard]] virtual std::vector&lt;<span class="keywordtype">double</span>&gt; <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition_abstract.html#a83343286d738d101635b2a7f5b7d96ef">getNumberFractionVector</a>() const noexcept = 0;</div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno"> 150</span></div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition_abstract.html#a657c12d36b2f44e44c32e86d5296c063"> 155</a></span> [[nodiscard]] virtual std::vector&lt;<span class="keywordtype">double</span>&gt; <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition_abstract.html#a657c12d36b2f44e44c32e86d5296c063">getMolarAbundanceVector</a>() const noexcept = 0;</div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno"> 156</span></div>
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition_abstract.html#aebf28eab9c902a285589fe2ab7f3060f"> 162</a></span> [[nodiscard]] virtual <span class="keywordtype">size_t</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition_abstract.html#aebf28eab9c902a285589fe2ab7f3060f">getSpeciesIndex</a>(const std::<span class="keywordtype">string</span>&amp; symbol) const = 0;</div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno"> 163</span></div>
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition_abstract.html#a5d04b801f152f7955b392710275105bc"> 169</a></span> [[nodiscard]] virtual <span class="keywordtype">size_t</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition_abstract.html#aebf28eab9c902a285589fe2ab7f3060f">getSpeciesIndex</a>(const <a class="code hl_namespace" href="namespacefourdst.html">fourdst</a>::<a class="code hl_namespace" href="namespacefourdst_1_1atomic.html">atomic</a>::Species&amp; species) const = 0;</div>
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno"> 170</span></div>
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition_abstract.html#a43138cbf3d399e8f278db742fe1b02a7"> 176</a></span> [[nodiscard]] virtual <a class="code hl_namespace" href="namespacefourdst_1_1atomic.html">atomic</a>::Species <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition_abstract.html#a43138cbf3d399e8f278db742fe1b02a7">getSpeciesAtIndex</a>(<span class="keywordtype">size_t</span> index) const = 0;</div>
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno"> 177</span> </div>
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition_abstract.html#a81d5a4da267e24662ae90c6a29f3d0a1"> 178</a></span> [[nodiscard]] virtual std::unique_ptr&lt;<a class="code hl_class" href="classfourdst_1_1composition_1_1_composition_abstract.html">CompositionAbstract</a>&gt; <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition_abstract.html#a81d5a4da267e24662ae90c6a29f3d0a1">clone</a>() const = 0;</div>
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno"> 179</span> </div>
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition_abstract.html#a643f2e1f843d8a6f81c9382278916fe5"> 180</a></span> [[nodiscard]] virtual <a class="code hl_typedef" href="classfourdst_1_1composition_1_1_composition_abstract.html#abd12f3a9a5b6217498ff19e25ee3ddb0">iterator</a> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition_abstract.html#a643f2e1f843d8a6f81c9382278916fe5">begin</a>() = 0;</div>
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition_abstract.html#a9f903ec8d0444c7ed9178c09de902176"> 181</a></span> [[nodiscard]] virtual <a class="code hl_typedef" href="classfourdst_1_1composition_1_1_composition_abstract.html#abd12f3a9a5b6217498ff19e25ee3ddb0">iterator</a> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition_abstract.html#a9f903ec8d0444c7ed9178c09de902176">end</a>() = 0;</div>
<div class="line"><a id="l00182" name="l00182"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition_abstract.html#a0a1845dab0dbf23399233cac7aeb05c1"> 182</a></span> [[nodiscard]] virtual <a class="code hl_typedef" href="classfourdst_1_1composition_1_1_composition_abstract.html#a0bb9772bc73d637950b6cf2e8e6afeb0">const_iterator</a> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition_abstract.html#a643f2e1f843d8a6f81c9382278916fe5">begin</a>() const = 0;</div>
<div class="line"><a id="l00183" name="l00183"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition_abstract.html#a9ac49da6e4df7bee8aa7974e8fec8181"> 183</a></span> [[nodiscard]] virtual <a class="code hl_typedef" href="classfourdst_1_1composition_1_1_composition_abstract.html#a0bb9772bc73d637950b6cf2e8e6afeb0">const_iterator</a> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition_abstract.html#a9f903ec8d0444c7ed9178c09de902176">end</a>() const = 0;</div>
<div class="line"><a id="l00184" name="l00184"></a><span class="lineno"> 184</span> </div>
<div class="line"><a id="l00185" name="l00185"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition_abstract.html#a2d5472a63e2dbfc94d7e4617b5660e23"> 185</a></span> [[nodiscard]] virtual std::<span class="keywordtype">size_t</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition_abstract.html#a2d5472a63e2dbfc94d7e4617b5660e23">hash</a>() const = 0;</div>
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno"> 186</span> };</div>
</div>
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno"> 187</span> </div>
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno"> 188</span> <span class="comment">// ReSharper disable once CppClassCanBeFinal</span></div>
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno"> 189</span>}</div>
<div class="ttc" id="aatomic_species_8h_html"><div class="ttname"><a href="atomic_species_8h.html">atomicSpecies.h</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_abstract_html"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition_abstract.html">fourdst::composition::CompositionAbstract</a></div><div class="ttdoc">Abstract base class for chemical composition representations.</div><div class="ttdef"><b>Definition</b> <a href="#l00036">composition_abstract.h:36</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_abstract_html_a0bb9772bc73d637950b6cf2e8e6afeb0"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition_abstract.html#a0bb9772bc73d637950b6cf2e8e6afeb0">fourdst::composition::CompositionAbstract::const_iterator</a></div><div class="ttdeci">detail::CompositionIterator&lt; true &gt; const_iterator</div><div class="ttdef"><b>Definition</b> <a href="#l00039">composition_abstract.h:39</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_abstract_html_a29613d8197cee96f764aeeaa3b7286f8"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition_abstract.html#a29613d8197cee96f764aeeaa3b7286f8">fourdst::composition::CompositionAbstract::getMolarAbundance</a></div><div class="ttdeci">virtual double getMolarAbundance(const std::string &amp;symbol) const =0</div><div class="ttdoc">Get the molar abundance for a given symbol.</div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_abstract_html_a2d5472a63e2dbfc94d7e4617b5660e23"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition_abstract.html#a2d5472a63e2dbfc94d7e4617b5660e23">fourdst::composition::CompositionAbstract::hash</a></div><div class="ttdeci">virtual std::size_t hash() const =0</div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_abstract_html_a2e6c4d27d2b295b6be87c6964cac1e1e"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition_abstract.html#a2e6c4d27d2b295b6be87c6964cac1e1e">fourdst::composition::CompositionAbstract::contains</a></div><div class="ttdeci">virtual bool contains(const fourdst::atomic::Species &amp;species) const noexcept=0</div><div class="ttdoc">Check if the composition contains the given species.</div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_abstract_html_a3e3248162611754ca4c54b9979f6664d"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition_abstract.html#a3e3248162611754ca4c54b9979f6664d">fourdst::composition::CompositionAbstract::getMassFraction</a></div><div class="ttdeci">virtual std::unordered_map&lt; fourdst::atomic::Species, double &gt; getMassFraction() const noexcept=0</div><div class="ttdoc">Get the mass fraction for all registered symbols.</div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_abstract_html_a43138cbf3d399e8f278db742fe1b02a7"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition_abstract.html#a43138cbf3d399e8f278db742fe1b02a7">fourdst::composition::CompositionAbstract::getSpeciesAtIndex</a></div><div class="ttdeci">virtual atomic::Species getSpeciesAtIndex(size_t index) const =0</div><div class="ttdoc">Get the species at a given index.</div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_abstract_html_a643f2e1f843d8a6f81c9382278916fe5"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition_abstract.html#a643f2e1f843d8a6f81c9382278916fe5">fourdst::composition::CompositionAbstract::begin</a></div><div class="ttdeci">virtual iterator begin()=0</div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_abstract_html_a657c12d36b2f44e44c32e86d5296c063"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition_abstract.html#a657c12d36b2f44e44c32e86d5296c063">fourdst::composition::CompositionAbstract::getMolarAbundanceVector</a></div><div class="ttdeci">virtual std::vector&lt; double &gt; getMolarAbundanceVector() const noexcept=0</div><div class="ttdoc">Get the molar abundance as a vector.</div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_abstract_html_a65bae043ffbf4514b2593ccb63c6e265"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition_abstract.html#a65bae043ffbf4514b2593ccb63c6e265">fourdst::composition::CompositionAbstract::getNumberFraction</a></div><div class="ttdeci">virtual std::unordered_map&lt; fourdst::atomic::Species, double &gt; getNumberFraction() const noexcept=0</div><div class="ttdoc">Get the number fraction for all registered symbols.</div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_abstract_html_a6fe83824aefb045d8a5399e8ac9852f9"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition_abstract.html#a6fe83824aefb045d8a5399e8ac9852f9">fourdst::composition::CompositionAbstract::contains</a></div><div class="ttdeci">virtual bool contains(const std::string &amp;symbol) const =0</div><div class="ttdoc">Check if the composition contains the given species.</div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_abstract_html_a752af872347c612bf3b43b1711c2cfc0"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition_abstract.html#a752af872347c612bf3b43b1711c2cfc0">fourdst::composition::CompositionAbstract::getMassFractionVector</a></div><div class="ttdeci">virtual std::vector&lt; double &gt; getMassFractionVector() const noexcept=0</div><div class="ttdoc">Get the mass fraction as a vector.</div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_abstract_html_a81d5a4da267e24662ae90c6a29f3d0a1"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition_abstract.html#a81d5a4da267e24662ae90c6a29f3d0a1">fourdst::composition::CompositionAbstract::clone</a></div><div class="ttdeci">virtual std::unique_ptr&lt; CompositionAbstract &gt; clone() const =0</div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_abstract_html_a83343286d738d101635b2a7f5b7d96ef"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition_abstract.html#a83343286d738d101635b2a7f5b7d96ef">fourdst::composition::CompositionAbstract::getNumberFractionVector</a></div><div class="ttdeci">virtual std::vector&lt; double &gt; getNumberFractionVector() const noexcept=0</div><div class="ttdoc">Get the number fraction as a vector.</div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_abstract_html_a83ff77f3f390bb66c978e157d9bb6394"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition_abstract.html#a83ff77f3f390bb66c978e157d9bb6394">fourdst::composition::CompositionAbstract::~CompositionAbstract</a></div><div class="ttdeci">virtual ~CompositionAbstract()=default</div><div class="ttdoc">Virtual destructor.</div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_abstract_html_a94c2cadeae32ab19cee42fc1670c4c6c"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition_abstract.html#a94c2cadeae32ab19cee42fc1670c4c6c">fourdst::composition::CompositionAbstract::getRegisteredSymbols</a></div><div class="ttdeci">virtual std::set&lt; std::string &gt; getRegisteredSymbols() const noexcept=0</div><div class="ttdoc">Get all registered chemical symbols in the composition.</div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_abstract_html_a9f903ec8d0444c7ed9178c09de902176"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition_abstract.html#a9f903ec8d0444c7ed9178c09de902176">fourdst::composition::CompositionAbstract::end</a></div><div class="ttdeci">virtual iterator end()=0</div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_abstract_html_abd12f3a9a5b6217498ff19e25ee3ddb0"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition_abstract.html#abd12f3a9a5b6217498ff19e25ee3ddb0">fourdst::composition::CompositionAbstract::iterator</a></div><div class="ttdeci">detail::CompositionIterator&lt; false &gt; iterator</div><div class="ttdef"><b>Definition</b> <a href="#l00038">composition_abstract.h:38</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_abstract_html_ad0fcf2e51cca02c4224241828335db1a"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition_abstract.html#ad0fcf2e51cca02c4224241828335db1a">fourdst::composition::CompositionAbstract::getElectronAbundance</a></div><div class="ttdeci">virtual double getElectronAbundance() const noexcept=0</div><div class="ttdoc">Get the electron abundance of the composition.</div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_abstract_html_ad17ae8649860ef4f7a949e7c9143c0ec"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition_abstract.html#ad17ae8649860ef4f7a949e7c9143c0ec">fourdst::composition::CompositionAbstract::getRegisteredSpecies</a></div><div class="ttdeci">virtual const std::vector&lt; atomic::Species &gt; &amp; getRegisteredSpecies() const noexcept=0</div><div class="ttdoc">Get all registered atomic species in the composition.</div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_abstract_html_aebf28eab9c902a285589fe2ab7f3060f"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition_abstract.html#aebf28eab9c902a285589fe2ab7f3060f">fourdst::composition::CompositionAbstract::getSpeciesIndex</a></div><div class="ttdeci">virtual size_t getSpeciesIndex(const std::string &amp;symbol) const =0</div><div class="ttdoc">Get the index of a species by symbol.</div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_abstract_html_af7ec2eaa16a0c78d19728e32469cec06"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition_abstract.html#af7ec2eaa16a0c78d19728e32469cec06">fourdst::composition::CompositionAbstract::size</a></div><div class="ttdeci">virtual size_t size() const noexcept=0</div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_abstract_html_afedcef16ed403b95ce7f1e6756aa46e8"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition_abstract.html#afedcef16ed403b95ce7f1e6756aa46e8">fourdst::composition::CompositionAbstract::getMeanParticleMass</a></div><div class="ttdeci">virtual double getMeanParticleMass() const noexcept=0</div><div class="ttdoc">Get the mean particle mass of the composition.</div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1detail_1_1_composition_iterator_html"><div class="ttname"><a href="classfourdst_1_1composition_1_1detail_1_1_composition_iterator.html">fourdst::composition::detail::CompositionIterator</a></div><div class="ttdef"><b>Definition</b> <a href="composition__abstract__iterator_8h_source.html#l00013">composition_abstract_iterator.h:13</a></div></div>
<div class="ttc" id="acomposition__abstract__iterator_8h_html"><div class="ttname"><a href="composition__abstract__iterator_8h.html">composition_abstract_iterator.h</a></div></div>
<div class="ttc" id="anamespacefourdst_1_1atomic_html"><div class="ttname"><a href="namespacefourdst_1_1atomic.html">fourdst::atomic</a></div><div class="ttdoc">Contains canonical information about atomic species and elements used by 4D-STAR.</div></div>
<div class="ttc" id="anamespacefourdst_1_1composition_html"><div class="ttname"><a href="namespacefourdst_1_1composition.html">fourdst::composition</a></div><div class="ttdoc">Utilities and types for representing and manipulating chemical compositions.</div></div>
<div class="ttc" id="anamespacefourdst_html"><div class="ttname"><a href="namespacefourdst.html">fourdst</a></div></div>
<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#l00052">atomicSpecies.h:52</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_425afc2e69e55565110382214454a15b.html">composition</a></li><li class="navelem"><a class="el" href="dir_cb6fc2f7165eff3b2362b2440dfaea8e.html">include</a></li><li class="navelem"><a class="el" href="dir_3c9efac6790a3720e63e1a08c00d11f2.html">fourdst</a></li><li class="navelem"><a class="el" href="dir_f0fdd83dd0cb4aa6fd6a832374ae4f05.html">composition</a></li><li class="navelem"><a class="el" href="composition__abstract_8h.html">composition_abstract.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 View Git Blame Copy Permalink