tboudreaux/libcomposition
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added more docs

Browse Source
This commit is contained in:
Emily Boudreaux
2026-05-18 10:04:49 -04:00
parent 1a5bd2b32c
commit 9299514307
239 changed files with 16557 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

939
docs/html/class_composition_abstract.html Normal file
View File

@@ -0,0 +1,939 @@
<!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: CompositionAbstract Class Reference</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.0.1</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('class_composition_abstract.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="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_composition_abstract-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">CompositionAbstract Class Reference<span class="mlabels"><span class="mlabel abstract">abstract</span></span></div></div>
</div><!--header-->
<div class="contents">
<p>Abstract base class for chemical composition representations.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="composition__abstract_8h_source.html">composition_abstract.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for CompositionAbstract:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="class_composition_abstract__inherit__graph.svg" width="155" height="126"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aaae3d6215b7433cb9871664852a95d1b" id="r_aaae3d6215b7433cb9871664852a95d1b"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aaae3d6215b7433cb9871664852a95d1b">~CompositionAbstract</a> ()=default</td></tr>
<tr class="memdesc:aaae3d6215b7433cb9871664852a95d1b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Virtual destructor. <br /></td></tr>
<tr class="separator:aaae3d6215b7433cb9871664852a95d1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af42050fabc3c888d77f0fc98f08bc80a" id="r_af42050fabc3c888d77f0fc98f08bc80a"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af42050fabc3c888d77f0fc98f08bc80a">contains</a> (const <a class="el" href="structfourdst_1_1atomic_1_1_species.html">fourdst::atomic::Species</a> &amp;species) const noexcept=0</td></tr>
<tr class="memdesc:af42050fabc3c888d77f0fc98f08bc80a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if the composition contains the given species. <br /></td></tr>
<tr class="separator:af42050fabc3c888d77f0fc98f08bc80a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aebd1997d8b3a59356f587c234b290796" id="r_aebd1997d8b3a59356f587c234b290796"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aebd1997d8b3a59356f587c234b290796">contains</a> (const std::string &amp;symbol) const =0</td></tr>
<tr class="memdesc:aebd1997d8b3a59356f587c234b290796"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if the composition contains the given species. <br /></td></tr>
<tr class="separator:aebd1997d8b3a59356f587c234b290796"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a230f58ef18a9816c1d13c287eaf3ba05" id="r_a230f58ef18a9816c1d13c287eaf3ba05"><td class="memItemLeft" align="right" valign="top">virtual size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a230f58ef18a9816c1d13c287eaf3ba05">size</a> () const noexcept=0</td></tr>
<tr class="separator:a230f58ef18a9816c1d13c287eaf3ba05"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5a4362dc0d77659b75d528a0e884ed7b" id="r_a5a4362dc0d77659b75d528a0e884ed7b"><td class="memItemLeft" align="right" valign="top">virtual std::set&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5a4362dc0d77659b75d528a0e884ed7b">getRegisteredSymbols</a> () const noexcept=0</td></tr>
<tr class="memdesc:a5a4362dc0d77659b75d528a0e884ed7b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get all registered chemical symbols in the composition. <br /></td></tr>
<tr class="separator:a5a4362dc0d77659b75d528a0e884ed7b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae6e7152d69fc5f5a128f8cb2cfce1587" id="r_ae6e7152d69fc5f5a128f8cb2cfce1587"><td class="memItemLeft" align="right" valign="top">virtual const std::set&lt; <a class="el" href="structfourdst_1_1atomic_1_1_species.html">fourdst::atomic::Species</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae6e7152d69fc5f5a128f8cb2cfce1587">getRegisteredSpecies</a> () const noexcept=0</td></tr>
<tr class="memdesc:ae6e7152d69fc5f5a128f8cb2cfce1587"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get all registered atomic species in the composition. <br /></td></tr>
<tr class="separator:ae6e7152d69fc5f5a128f8cb2cfce1587"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afb72c61da511b7963382804a0e87a54a" id="r_afb72c61da511b7963382804a0e87a54a"><td class="memItemLeft" align="right" valign="top">virtual std::unordered_map&lt; <a class="el" href="structfourdst_1_1atomic_1_1_species.html">fourdst::atomic::Species</a>, double &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#afb72c61da511b7963382804a0e87a54a">getMassFraction</a> () const noexcept=0</td></tr>
<tr class="memdesc:afb72c61da511b7963382804a0e87a54a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the mass fraction for all registered symbols. <br /></td></tr>
<tr class="separator:afb72c61da511b7963382804a0e87a54a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a506ef92e69f99ad02598c8d178df1c31" id="r_a506ef92e69f99ad02598c8d178df1c31"><td class="memItemLeft" align="right" valign="top">virtual std::unordered_map&lt; <a class="el" href="structfourdst_1_1atomic_1_1_species.html">fourdst::atomic::Species</a>, double &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a506ef92e69f99ad02598c8d178df1c31">getNumberFraction</a> () const noexcept=0</td></tr>
<tr class="memdesc:a506ef92e69f99ad02598c8d178df1c31"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the number fraction for all registered symbols. <br /></td></tr>
<tr class="separator:a506ef92e69f99ad02598c8d178df1c31"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae0044d30efddccacc9fe7c8e58003066" id="r_ae0044d30efddccacc9fe7c8e58003066"><td class="memItemLeft" align="right" valign="top">virtual double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae0044d30efddccacc9fe7c8e58003066">getMassFraction</a> (const std::string &amp;symbol) const =0</td></tr>
<tr class="memdesc:ae0044d30efddccacc9fe7c8e58003066"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the mass fraction for a given symbol. <br /></td></tr>
<tr class="separator:ae0044d30efddccacc9fe7c8e58003066"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a401e8298ed93b7963624e8a17eb17b55" id="r_a401e8298ed93b7963624e8a17eb17b55"><td class="memItemLeft" align="right" valign="top">virtual double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a401e8298ed93b7963624e8a17eb17b55">getMassFraction</a> (const <a class="el" href="structfourdst_1_1atomic_1_1_species.html">fourdst::atomic::Species</a> &amp;species) const =0</td></tr>
<tr class="memdesc:a401e8298ed93b7963624e8a17eb17b55"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the mass fraction for a given species. <br /></td></tr>
<tr class="separator:a401e8298ed93b7963624e8a17eb17b55"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae6026b1335230c6dfbd897ec8dfda295" id="r_ae6026b1335230c6dfbd897ec8dfda295"><td class="memItemLeft" align="right" valign="top">virtual double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae6026b1335230c6dfbd897ec8dfda295">getNumberFraction</a> (const std::string &amp;symbol) const =0</td></tr>
<tr class="memdesc:ae6026b1335230c6dfbd897ec8dfda295"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the number fraction for a given symbol. <br /></td></tr>
<tr class="separator:ae6026b1335230c6dfbd897ec8dfda295"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a27d1d91203adb736454aa9b9936fc8c3" id="r_a27d1d91203adb736454aa9b9936fc8c3"><td class="memItemLeft" align="right" valign="top">virtual double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a27d1d91203adb736454aa9b9936fc8c3">getNumberFraction</a> (const <a class="el" href="structfourdst_1_1atomic_1_1_species.html">fourdst::atomic::Species</a> &amp;species) const =0</td></tr>
<tr class="memdesc:a27d1d91203adb736454aa9b9936fc8c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the number fraction for a given species. <br /></td></tr>
<tr class="separator:a27d1d91203adb736454aa9b9936fc8c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a71fb459bf4375af2fe33c8a7c0747ce0" id="r_a71fb459bf4375af2fe33c8a7c0747ce0"><td class="memItemLeft" align="right" valign="top">virtual double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a71fb459bf4375af2fe33c8a7c0747ce0">getMolarAbundance</a> (const std::string &amp;symbol) const =0</td></tr>
<tr class="memdesc:a71fb459bf4375af2fe33c8a7c0747ce0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the molar abundance for a given symbol. <br /></td></tr>
<tr class="separator:a71fb459bf4375af2fe33c8a7c0747ce0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4cfc9e37370caae275c0f801b700e37b" id="r_a4cfc9e37370caae275c0f801b700e37b"><td class="memItemLeft" align="right" valign="top">virtual double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4cfc9e37370caae275c0f801b700e37b">getMolarAbundance</a> (const <a class="el" href="structfourdst_1_1atomic_1_1_species.html">fourdst::atomic::Species</a> &amp;species) const =0</td></tr>
<tr class="memdesc:a4cfc9e37370caae275c0f801b700e37b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the molar abundance for a given species. <br /></td></tr>
<tr class="separator:a4cfc9e37370caae275c0f801b700e37b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a85bf97a30ecadd0750bece4442f4deff" id="r_a85bf97a30ecadd0750bece4442f4deff"><td class="memItemLeft" align="right" valign="top">virtual double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a85bf97a30ecadd0750bece4442f4deff">getMeanParticleMass</a> () const noexcept=0</td></tr>
<tr class="memdesc:a85bf97a30ecadd0750bece4442f4deff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the mean particle mass of the composition. <br /></td></tr>
<tr class="separator:a85bf97a30ecadd0750bece4442f4deff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a86b60205094ed72435ee84abf9498e21" id="r_a86b60205094ed72435ee84abf9498e21"><td class="memItemLeft" align="right" valign="top">virtual double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a86b60205094ed72435ee84abf9498e21">getElectronAbundance</a> () const noexcept=0</td></tr>
<tr class="memdesc:a86b60205094ed72435ee84abf9498e21"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the electron abundance of the composition. <br /></td></tr>
<tr class="separator:a86b60205094ed72435ee84abf9498e21"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a82583ffa3c08297cda6c3957a6a7dbc6" id="r_a82583ffa3c08297cda6c3957a6a7dbc6"><td class="memItemLeft" align="right" valign="top">virtual std::vector&lt; double &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a82583ffa3c08297cda6c3957a6a7dbc6">getMassFractionVector</a> () const noexcept=0</td></tr>
<tr class="memdesc:a82583ffa3c08297cda6c3957a6a7dbc6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the mass fraction as a vector. <br /></td></tr>
<tr class="separator:a82583ffa3c08297cda6c3957a6a7dbc6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a883ea47508557952b9f15432bf0be376" id="r_a883ea47508557952b9f15432bf0be376"><td class="memItemLeft" align="right" valign="top">virtual std::vector&lt; double &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a883ea47508557952b9f15432bf0be376">getNumberFractionVector</a> () const noexcept=0</td></tr>
<tr class="memdesc:a883ea47508557952b9f15432bf0be376"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the number fraction as a vector. <br /></td></tr>
<tr class="separator:a883ea47508557952b9f15432bf0be376"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1ad7a33d17db32b2c9ce0a30cd6628f9" id="r_a1ad7a33d17db32b2c9ce0a30cd6628f9"><td class="memItemLeft" align="right" valign="top">virtual std::vector&lt; double &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1ad7a33d17db32b2c9ce0a30cd6628f9">getMolarAbundanceVector</a> () const noexcept=0</td></tr>
<tr class="memdesc:a1ad7a33d17db32b2c9ce0a30cd6628f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the molar abundance as a vector. <br /></td></tr>
<tr class="separator:a1ad7a33d17db32b2c9ce0a30cd6628f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1e5195debe590960aa064289733958ba" id="r_a1e5195debe590960aa064289733958ba"><td class="memItemLeft" align="right" valign="top">virtual size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1e5195debe590960aa064289733958ba">getSpeciesIndex</a> (const std::string &amp;symbol) const =0</td></tr>
<tr class="memdesc:a1e5195debe590960aa064289733958ba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the index of a species by symbol. <br /></td></tr>
<tr class="separator:a1e5195debe590960aa064289733958ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab41311a8c20a9556d087a604da735767" id="r_ab41311a8c20a9556d087a604da735767"><td class="memItemLeft" align="right" valign="top">virtual size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab41311a8c20a9556d087a604da735767">getSpeciesIndex</a> (const <a class="el" href="structfourdst_1_1atomic_1_1_species.html">fourdst::atomic::Species</a> &amp;species) const =0</td></tr>
<tr class="memdesc:ab41311a8c20a9556d087a604da735767"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the index of a species. <br /></td></tr>
<tr class="separator:ab41311a8c20a9556d087a604da735767"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaee3651c1672b2763181e966e4525ba6" id="r_aaee3651c1672b2763181e966e4525ba6"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="structfourdst_1_1atomic_1_1_species.html">fourdst::atomic::Species</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aaee3651c1672b2763181e966e4525ba6">getSpeciesAtIndex</a> (size_t index) const =0</td></tr>
<tr class="memdesc:aaee3651c1672b2763181e966e4525ba6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the species at a given index. <br /></td></tr>
<tr class="separator:aaee3651c1672b2763181e966e4525ba6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Abstract base class for chemical composition representations. </p>
<p>The purpose of this class is to define a standard interface for all composition types. Children of this class are responsible for implementing the setter methods, but any object that is a child of <a class="el" href="class_composition_abstract.html" title="Abstract base class for chemical composition representations.">CompositionAbstract</a> will always have these getter methods.</p>
<p>This ensures that all derived composition classes provide a consistent API for querying composition properties, regardless of how the data is set or stored.</p>
<dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line"><span class="keyword">class </span>MyComposition : <span class="keyword">public</span> <a class="code hl_class" href="class_composition_abstract.html">CompositionAbstract</a> {</div>
<div class="line"> <span class="comment">// ...implement all pure virtual methods...</span></div>
<div class="line">};</div>
<div class="line"> </div>
<div class="line">MyComposition comp;</div>
<div class="line"><span class="keywordflow">if</span> (comp.hasSymbol(<span class="stringliteral">&quot;H&quot;</span>)) {</div>
<div class="line"> <span class="keywordtype">double</span> mf = comp.getMassFraction(<span class="stringliteral">&quot;H&quot;</span>);</div>
<div class="line">}</div>
<div class="line">std::set&lt;std::string&gt; symbols = comp.getRegisteredSymbols();</div>
<div class="ttc" id="aclass_composition_abstract_html"><div class="ttname"><a href="class_composition_abstract.html">CompositionAbstract</a></div><div class="ttdoc">Abstract base class for chemical composition representations.</div><div class="ttdef"><b>Definition</b> <a href="composition__abstract_8h_source.html#l00033">composition_abstract.h:33</a></div></div>
</div><!-- fragment --> </dd></dl>
<p class="definition">Definition at line <a class="el" href="composition__abstract_8h_source.html#l00033">33</a> of file <a class="el" href="composition__abstract_8h_source.html">composition_abstract.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="aaae3d6215b7433cb9871664852a95d1b" name="aaae3d6215b7433cb9871664852a95d1b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaae3d6215b7433cb9871664852a95d1b">&#9670;&#160;</a></span>~CompositionAbstract()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual CompositionAbstract::~CompositionAbstract </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel virtual">virtual</span><span class="mlabel default">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Virtual destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="af42050fabc3c888d77f0fc98f08bc80a" name="af42050fabc3c888d77f0fc98f08bc80a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af42050fabc3c888d77f0fc98f08bc80a">&#9670;&#160;</a></span>contains() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool CompositionAbstract::contains </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structfourdst_1_1atomic_1_1_species.html">fourdst::atomic::Species</a> &amp;</td> <td class="paramname"><span class="paramname"><em>species</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel pure-virtual">pure virtual</span><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if the composition contains the given species. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">species</td><td>The atomic species to check. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if the species is contained, false otherwise. </dd></dl>
<p>Implemented in <a class="el" href="classfourdst_1_1composition_1_1_composition.html#a194f715788e7921bd611579440de2ecd">fourdst::composition::Composition</a>.</p>
</div>
</div>
<a id="aebd1997d8b3a59356f587c234b290796" name="aebd1997d8b3a59356f587c234b290796"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aebd1997d8b3a59356f587c234b290796">&#9670;&#160;</a></span>contains() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool CompositionAbstract::contains </td>
<td>(</td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>symbol</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel pure-virtual">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if the composition contains the given species. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">symbol</td><td>The symbol of the atomic species to check. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if the species is contained, false otherwise. </dd></dl>
<p>Implemented in <a class="el" href="classfourdst_1_1composition_1_1_composition.html#ac3bfb56a2587215a59894e76d4867ede">fourdst::composition::Composition</a>.</p>
</div>
</div>
<a id="a86b60205094ed72435ee84abf9498e21" name="a86b60205094ed72435ee84abf9498e21"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a86b60205094ed72435ee84abf9498e21">&#9670;&#160;</a></span>getElectronAbundance()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual double CompositionAbstract::getElectronAbundance </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel pure-virtual">pure virtual</span><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the electron abundance of the composition. </p>
<dl class="section return"><dt>Returns</dt><dd>The electron abundance. </dd></dl>
<p>Implemented in <a class="el" href="classfourdst_1_1composition_1_1_composition.html#a90fc71d1fe03017ee4c7a1cac69d24fb">fourdst::composition::Composition</a>.</p>
</div>
</div>
<a id="afb72c61da511b7963382804a0e87a54a" name="afb72c61da511b7963382804a0e87a54a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afb72c61da511b7963382804a0e87a54a">&#9670;&#160;</a></span>getMassFraction() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::unordered_map&lt; <a class="el" href="structfourdst_1_1atomic_1_1_species.html">fourdst::atomic::Species</a>, double &gt; CompositionAbstract::getMassFraction </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel pure-virtual">pure virtual</span><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the mass fraction for all registered symbols. </p>
<dl class="section return"><dt>Returns</dt><dd>An unordered map from symbol to mass fraction. </dd></dl>
<p>Implemented in <a class="el" href="classfourdst_1_1composition_1_1_composition.html#a9ea2b673341fdc67afeb0f0517a54c8c">fourdst::composition::Composition</a>.</p>
</div>
</div>
<a id="a401e8298ed93b7963624e8a17eb17b55" name="a401e8298ed93b7963624e8a17eb17b55"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a401e8298ed93b7963624e8a17eb17b55">&#9670;&#160;</a></span>getMassFraction() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual double CompositionAbstract::getMassFraction </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structfourdst_1_1atomic_1_1_species.html">fourdst::atomic::Species</a> &amp;</td> <td class="paramname"><span class="paramname"><em>species</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel pure-virtual">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the mass fraction for a given species. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">species</td><td>The atomic species. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The mass fraction for the species. </dd></dl>
<p>Implemented in <a class="el" href="classfourdst_1_1composition_1_1_composition.html#ae8fe4e7158f8317bf29b5cd0c65a9524">fourdst::composition::Composition</a>.</p>
</div>
</div>
<a id="ae0044d30efddccacc9fe7c8e58003066" name="ae0044d30efddccacc9fe7c8e58003066"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae0044d30efddccacc9fe7c8e58003066">&#9670;&#160;</a></span>getMassFraction() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual double CompositionAbstract::getMassFraction </td>
<td>(</td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>symbol</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel pure-virtual">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the mass fraction for a given symbol. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">symbol</td><td>The chemical symbol. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The mass fraction for the symbol. </dd></dl>
<p>Implemented in <a class="el" href="classfourdst_1_1composition_1_1_composition.html#ae5d8d21632fca2b35b0898f2b205cd10">fourdst::composition::Composition</a>.</p>
</div>
</div>
<a id="a82583ffa3c08297cda6c3957a6a7dbc6" name="a82583ffa3c08297cda6c3957a6a7dbc6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a82583ffa3c08297cda6c3957a6a7dbc6">&#9670;&#160;</a></span>getMassFractionVector()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::vector&lt; double &gt; CompositionAbstract::getMassFractionVector </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel pure-virtual">pure virtual</span><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the mass fraction as a vector. </p>
<dl class="section return"><dt>Returns</dt><dd>A vector of mass fractions for all species. </dd></dl>
<p>Implemented in <a class="el" href="classfourdst_1_1composition_1_1_composition.html#af4f44aaf8b7e0d63872a70b5e2131369">fourdst::composition::Composition</a>.</p>
</div>
</div>
<a id="a85bf97a30ecadd0750bece4442f4deff" name="a85bf97a30ecadd0750bece4442f4deff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a85bf97a30ecadd0750bece4442f4deff">&#9670;&#160;</a></span>getMeanParticleMass()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual double CompositionAbstract::getMeanParticleMass </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel pure-virtual">pure virtual</span><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the mean particle mass of the composition. </p>
<dl class="section return"><dt>Returns</dt><dd>The mean particle mass. </dd></dl>
<p>Implemented in <a class="el" href="classfourdst_1_1composition_1_1_composition.html#afbbb5e51ad5ae5c0fa6bc0094195aecd">fourdst::composition::Composition</a>.</p>
</div>
</div>
<a id="a4cfc9e37370caae275c0f801b700e37b" name="a4cfc9e37370caae275c0f801b700e37b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4cfc9e37370caae275c0f801b700e37b">&#9670;&#160;</a></span>getMolarAbundance() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual double CompositionAbstract::getMolarAbundance </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structfourdst_1_1atomic_1_1_species.html">fourdst::atomic::Species</a> &amp;</td> <td class="paramname"><span class="paramname"><em>species</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel pure-virtual">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the molar abundance for a given species. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">species</td><td>The atomic species. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The molar abundance for the species. </dd></dl>
<p>Implemented in <a class="el" href="classfourdst_1_1composition_1_1_composition.html#a78a43e9e77a9c1b0f27c50b9feb52449">fourdst::composition::Composition</a>.</p>
</div>
</div>
<a id="a71fb459bf4375af2fe33c8a7c0747ce0" name="a71fb459bf4375af2fe33c8a7c0747ce0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a71fb459bf4375af2fe33c8a7c0747ce0">&#9670;&#160;</a></span>getMolarAbundance() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual double CompositionAbstract::getMolarAbundance </td>
<td>(</td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>symbol</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel pure-virtual">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the molar abundance for a given symbol. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">symbol</td><td>The chemical symbol. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The molar abundance for the symbol. </dd></dl>
<p>Implemented in <a class="el" href="classfourdst_1_1composition_1_1_composition.html#add67a92d73e3a57a2bbdb52bc9ca3bfe">fourdst::composition::Composition</a>.</p>
</div>
</div>
<a id="a1ad7a33d17db32b2c9ce0a30cd6628f9" name="a1ad7a33d17db32b2c9ce0a30cd6628f9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1ad7a33d17db32b2c9ce0a30cd6628f9">&#9670;&#160;</a></span>getMolarAbundanceVector()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::vector&lt; double &gt; CompositionAbstract::getMolarAbundanceVector </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel pure-virtual">pure virtual</span><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the molar abundance as a vector. </p>
<dl class="section return"><dt>Returns</dt><dd>A vector of molar abundances for all species. </dd></dl>
<p>Implemented in <a class="el" href="classfourdst_1_1composition_1_1_composition.html#abcb391f5fca2b636127e48e681e4c3ee">fourdst::composition::Composition</a>.</p>
</div>
</div>
<a id="a506ef92e69f99ad02598c8d178df1c31" name="a506ef92e69f99ad02598c8d178df1c31"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a506ef92e69f99ad02598c8d178df1c31">&#9670;&#160;</a></span>getNumberFraction() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::unordered_map&lt; <a class="el" href="structfourdst_1_1atomic_1_1_species.html">fourdst::atomic::Species</a>, double &gt; CompositionAbstract::getNumberFraction </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel pure-virtual">pure virtual</span><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the number fraction for all registered symbols. </p>
<dl class="section return"><dt>Returns</dt><dd>An unordered map from symbol to number fraction. </dd></dl>
<p>Implemented in <a class="el" href="classfourdst_1_1composition_1_1_composition.html#a1f87ed64a1be9a6091c852131d24e476">fourdst::composition::Composition</a>.</p>
</div>
</div>
<a id="a27d1d91203adb736454aa9b9936fc8c3" name="a27d1d91203adb736454aa9b9936fc8c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a27d1d91203adb736454aa9b9936fc8c3">&#9670;&#160;</a></span>getNumberFraction() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual double CompositionAbstract::getNumberFraction </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structfourdst_1_1atomic_1_1_species.html">fourdst::atomic::Species</a> &amp;</td> <td class="paramname"><span class="paramname"><em>species</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel pure-virtual">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the number fraction for a given species. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">species</td><td>The atomic species. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number fraction for the species. </dd></dl>
<p>Implemented in <a class="el" href="classfourdst_1_1composition_1_1_composition.html#a1aa79993925f16ba3c30a376aa39161b">fourdst::composition::Composition</a>.</p>
</div>
</div>
<a id="ae6026b1335230c6dfbd897ec8dfda295" name="ae6026b1335230c6dfbd897ec8dfda295"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae6026b1335230c6dfbd897ec8dfda295">&#9670;&#160;</a></span>getNumberFraction() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual double CompositionAbstract::getNumberFraction </td>
<td>(</td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>symbol</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel pure-virtual">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the number fraction for a given symbol. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">symbol</td><td>The chemical symbol. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number fraction for the symbol. </dd></dl>
<p>Implemented in <a class="el" href="classfourdst_1_1composition_1_1_composition.html#a34f71d4d8f0297c576fd62fabd490305">fourdst::composition::Composition</a>.</p>
</div>
</div>
<a id="a883ea47508557952b9f15432bf0be376" name="a883ea47508557952b9f15432bf0be376"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a883ea47508557952b9f15432bf0be376">&#9670;&#160;</a></span>getNumberFractionVector()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::vector&lt; double &gt; CompositionAbstract::getNumberFractionVector </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel pure-virtual">pure virtual</span><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the number fraction as a vector. </p>
<dl class="section return"><dt>Returns</dt><dd>A vector of number fractions for all species. </dd></dl>
<p>Implemented in <a class="el" href="classfourdst_1_1composition_1_1_composition.html#ae4f72972cf4d1ff422d0790080e11473">fourdst::composition::Composition</a>.</p>
</div>
</div>
<a id="ae6e7152d69fc5f5a128f8cb2cfce1587" name="ae6e7152d69fc5f5a128f8cb2cfce1587"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae6e7152d69fc5f5a128f8cb2cfce1587">&#9670;&#160;</a></span>getRegisteredSpecies()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const std::set&lt; <a class="el" href="structfourdst_1_1atomic_1_1_species.html">fourdst::atomic::Species</a> &gt; &amp; CompositionAbstract::getRegisteredSpecies </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel pure-virtual">pure virtual</span><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get all registered atomic species in the composition. </p>
<dl class="section return"><dt>Returns</dt><dd>A set of registered atomic species. </dd></dl>
<p>Implemented in <a class="el" href="classfourdst_1_1composition_1_1_composition.html#a33db253ca50431b5166d43412ff18f71">fourdst::composition::Composition</a>.</p>
</div>
</div>
<a id="a5a4362dc0d77659b75d528a0e884ed7b" name="a5a4362dc0d77659b75d528a0e884ed7b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5a4362dc0d77659b75d528a0e884ed7b">&#9670;&#160;</a></span>getRegisteredSymbols()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::set&lt; std::string &gt; CompositionAbstract::getRegisteredSymbols </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel pure-virtual">pure virtual</span><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get all registered chemical symbols in the composition. </p>
<dl class="section return"><dt>Returns</dt><dd>A set of registered chemical symbols. </dd></dl>
<p>Implemented in <a class="el" href="classfourdst_1_1composition_1_1_composition.html#a3ae885c28580ae15be8c16614bef3b0e">fourdst::composition::Composition</a>.</p>
</div>
</div>
<a id="aaee3651c1672b2763181e966e4525ba6" name="aaee3651c1672b2763181e966e4525ba6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaee3651c1672b2763181e966e4525ba6">&#9670;&#160;</a></span>getSpeciesAtIndex()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structfourdst_1_1atomic_1_1_species.html">fourdst::atomic::Species</a> CompositionAbstract::getSpeciesAtIndex </td>
<td>(</td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>index</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel pure-virtual">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the species at a given index. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">index</td><td>The index of the species. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The atomic species at the specified index. </dd></dl>
<p>Implemented in <a class="el" href="classfourdst_1_1composition_1_1_composition.html#ae4f854ded38f5e6fcd157a74a57cbf0c">fourdst::composition::Composition</a>.</p>
</div>
</div>
<a id="ab41311a8c20a9556d087a604da735767" name="ab41311a8c20a9556d087a604da735767"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab41311a8c20a9556d087a604da735767">&#9670;&#160;</a></span>getSpeciesIndex() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual size_t CompositionAbstract::getSpeciesIndex </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structfourdst_1_1atomic_1_1_species.html">fourdst::atomic::Species</a> &amp;</td> <td class="paramname"><span class="paramname"><em>species</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel pure-virtual">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the index of a species. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">species</td><td>The atomic species. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The index of the species. </dd></dl>
<p>Implemented in <a class="el" href="classfourdst_1_1composition_1_1_composition.html#a3d220b42fa06d7d3a43944ee2b8f6a5f">fourdst::composition::Composition</a>.</p>
</div>
</div>
<a id="a1e5195debe590960aa064289733958ba" name="a1e5195debe590960aa064289733958ba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1e5195debe590960aa064289733958ba">&#9670;&#160;</a></span>getSpeciesIndex() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual size_t CompositionAbstract::getSpeciesIndex </td>
<td>(</td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>symbol</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel pure-virtual">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the index of a species by symbol. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">symbol</td><td>The chemical symbol. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The index of the species. </dd></dl>
<p>Implemented in <a class="el" href="classfourdst_1_1composition_1_1_composition.html#a0d94f62402bb90b5d12679faeaa8c5d7">fourdst::composition::Composition</a>.</p>
</div>
</div>
<a id="a230f58ef18a9816c1d13c287eaf3ba05" name="a230f58ef18a9816c1d13c287eaf3ba05"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a230f58ef18a9816c1d13c287eaf3ba05">&#9670;&#160;</a></span>size()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual size_t CompositionAbstract::size </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel pure-virtual">pure virtual</span><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="classfourdst_1_1composition_1_1_composition.html#a9d177d36b728442bcbd8cb66712c7c75">fourdst::composition::Composition</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/composition/include/fourdst/composition/<a class="el" href="composition__abstract_8h_source.html">composition_abstract.h</a></li>
</ul>
</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="class_composition_abstract.html">CompositionAbstract</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>