Files
libcomposition/docs/html/functions_func.html

244 lines
18 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>fourdst::libcomposition: Class Members - Functions</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;v1.5.2</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('functions_func.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="contents">
<div class="textblock">Here is a list of all functions with links to the classes they belong to:</div>
<h3><a id="index_a" name="index_a"></a>- a -</h3><ul>
<li>a()&#160;:&#160;<a class="el" href="structfourdst_1_1atomic_1_1_species.html#adc960c98d6e6051940d0a5c0d9a1183d">fourdst::atomic::Species</a></li>
</ul>
<h3><a id="index_b" name="index_b"></a>- b -</h3><ul>
<li>begin()&#160;:&#160;<a class="el" href="classfourdst_1_1composition_1_1_composition.html#ab1701644ff1c83c220dc04eb58d1621b">fourdst::composition::Composition</a></li>
<li>betaCode()&#160;:&#160;<a class="el" href="structfourdst_1_1atomic_1_1_species.html#a57391049d534ffd1a4b4d6ed63d65ffc">fourdst::atomic::Species</a></li>
<li>betaDecayEnergy()&#160;:&#160;<a class="el" href="structfourdst_1_1atomic_1_1_species.html#a7d0e8a3b3d30fa56bdcc59577fa9ff73">fourdst::atomic::Species</a></li>
<li>bindingEnergy()&#160;:&#160;<a class="el" href="structfourdst_1_1atomic_1_1_species.html#abeef75170cabef39fdaa6362780ddfc8">fourdst::atomic::Species</a></li>
</ul>
<h3><a id="index_c" name="index_c"></a>- c -</h3><ul>
<li>Composition()&#160;:&#160;<a class="el" href="classfourdst_1_1composition_1_1_composition.html#a23b83b76ee025f6fc009184ee19bba88">fourdst::composition::Composition</a></li>
<li>CompositionEntry()&#160;:&#160;<a class="el" href="structfourdst_1_1composition_1_1_composition_entry.html#a1cccb94c150dd1dcde860f55fbeaf2bd">fourdst::composition::CompositionEntry</a></li>
<li>CompositionEntryError()&#160;:&#160;<a class="el" href="classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error.html#af5ea3395201839d670bdcfc61b19abb1">fourdst::composition::exceptions::CompositionEntryError</a>, <a class="el" href="classfourdst_1_1composition_1_1exceptions_1_1_composition_mode_error.html#af5ea3395201839d670bdcfc61b19abb1">fourdst::composition::exceptions::CompositionModeError</a>, <a class="el" href="classfourdst_1_1composition_1_1exceptions_1_1_entry_already_initialized_error.html#af5ea3395201839d670bdcfc61b19abb1">fourdst::composition::exceptions::EntryAlreadyInitializedError</a>, <a class="el" href="classfourdst_1_1composition_1_1exceptions_1_1_invalid_species_symbol_error.html#af5ea3395201839d670bdcfc61b19abb1">fourdst::composition::exceptions::InvalidSpeciesSymbolError</a></li>
<li>CompositionError()&#160;:&#160;<a class="el" href="classfourdst_1_1composition_1_1exceptions_1_1_composition_error.html#aef0cd13a4d1eb60b6d75ca5480e9146c">fourdst::composition::exceptions::CompositionError</a>, <a class="el" href="classfourdst_1_1composition_1_1exceptions_1_1_composition_not_finalized_error.html#aef0cd13a4d1eb60b6d75ca5480e9146c">fourdst::composition::exceptions::CompositionNotFinalizedError</a>, <a class="el" href="classfourdst_1_1composition_1_1exceptions_1_1_failed_to_finalize_composition_error.html#aef0cd13a4d1eb60b6d75ca5480e9146c">fourdst::composition::exceptions::FailedToFinalizeCompositionError</a>, <a class="el" href="classfourdst_1_1composition_1_1exceptions_1_1_invalid_composition_error.html#aef0cd13a4d1eb60b6d75ca5480e9146c">fourdst::composition::exceptions::InvalidCompositionError</a>, <a class="el" href="classfourdst_1_1composition_1_1exceptions_1_1_invalid_mixing_mode.html#aef0cd13a4d1eb60b6d75ca5480e9146c">fourdst::composition::exceptions::InvalidMixingMode</a>, <a class="el" href="classfourdst_1_1composition_1_1exceptions_1_1_invalid_symbol_error.html#aef0cd13a4d1eb60b6d75ca5480e9146c">fourdst::composition::exceptions::InvalidSymbolError</a>, <a class="el" href="classfourdst_1_1composition_1_1exceptions_1_1_unregistered_symbol_error.html#aef0cd13a4d1eb60b6d75ca5480e9146c">fourdst::composition::exceptions::UnregisteredSymbolError</a></li>
<li>contains()&#160;:&#160;<a class="el" href="classfourdst_1_1composition_1_1_composition.html#acb08478f7032ecc13cb02283a18187e9">fourdst::composition::Composition</a></li>
</ul>
<h3><a id="index_d" name="index_d"></a>- d -</h3><ul>
<li>decayModes()&#160;:&#160;<a class="el" href="structfourdst_1_1atomic_1_1_species.html#aad5094dfc8317db36468356bbc4a3e2f">fourdst::atomic::Species</a></li>
</ul>
<h3><a id="index_e" name="index_e"></a>- e -</h3><ul>
<li>el()&#160;:&#160;<a class="el" href="structfourdst_1_1atomic_1_1_species.html#a326c260a1b53deafcd04c21b2787f6c4">fourdst::atomic::Species</a></li>
<li>end()&#160;:&#160;<a class="el" href="classfourdst_1_1composition_1_1_composition.html#adeaf6f1213e78cb1fe8a8317f0a8adc2">fourdst::composition::Composition</a></li>
</ul>
<h3><a id="index_f" name="index_f"></a>- f -</h3><ul>
<li>finalize()&#160;:&#160;<a class="el" href="classfourdst_1_1composition_1_1_composition.html#a72d063a74a9d2197065884a2cea57a14">fourdst::composition::Composition</a></li>
<li>finalizeMassFracMode()&#160;:&#160;<a class="el" href="classfourdst_1_1composition_1_1_composition.html#a869dbae3db9d09c57b2df56a813a55fb">fourdst::composition::Composition</a></li>
<li>finalizeNumberFracMode()&#160;:&#160;<a class="el" href="classfourdst_1_1composition_1_1_composition.html#a461ab4e9cb5975cf865db5f16f03ddfe">fourdst::composition::Composition</a></li>
</ul>
<h3><a id="index_g" name="index_g"></a>- g -</h3><ul>
<li>getCanonicalComposition()&#160;:&#160;<a class="el" href="classfourdst_1_1composition_1_1_composition.html#ac75dbc8377556c835455991c7c7fe206">fourdst::composition::Composition</a></li>
<li>getComposition()&#160;:&#160;<a class="el" href="classfourdst_1_1composition_1_1_composition.html#a092d3536b04167ea2e6e3a3b1446c377">fourdst::composition::Composition</a></li>
<li>getMassFracMode()&#160;:&#160;<a class="el" href="structfourdst_1_1composition_1_1_composition_entry.html#a14f12b8b0178df2e32e2023bd4564ddc">fourdst::composition::CompositionEntry</a></li>
<li>getMassFraction()&#160;:&#160;<a class="el" href="classfourdst_1_1composition_1_1_composition.html#ad20bd541dd7c45274a2e586e6a0519a7">fourdst::composition::Composition</a></li>
<li>getMeanAtomicNumber()&#160;:&#160;<a class="el" href="classfourdst_1_1composition_1_1_composition.html#a98199f435cb553f5cf4f8e520fdb8a7a">fourdst::composition::Composition</a></li>
<li>getMeanParticleMass()&#160;:&#160;<a class="el" href="classfourdst_1_1composition_1_1_composition.html#a66401fed7054172e9b1a2687e5cc8eff">fourdst::composition::Composition</a></li>
<li>getMolarAbundance()&#160;:&#160;<a class="el" href="classfourdst_1_1composition_1_1_composition.html#a67a2ed844f3aee3d9cc1a3cb996eb56f">fourdst::composition::Composition</a></li>
<li>getNumberFraction()&#160;:&#160;<a class="el" href="classfourdst_1_1composition_1_1_composition.html#a84fea38bc1c005e483910285f6800e15">fourdst::composition::Composition</a></li>
<li>getRegisteredSpecies()&#160;:&#160;<a class="el" href="classfourdst_1_1composition_1_1_composition.html#a3dee7b5e1f54920de9eab99f95a516ec">fourdst::composition::Composition</a></li>
<li>getRegisteredSymbols()&#160;:&#160;<a class="el" href="classfourdst_1_1composition_1_1_composition.html#a84c7b72c2aee46b94492d404855dd3e0">fourdst::composition::Composition</a></li>
</ul>
<h3><a id="index_h" name="index_h"></a>- h -</h3><ul>
<li>halfLife()&#160;:&#160;<a class="el" href="structfourdst_1_1atomic_1_1_species.html#a34c4bb95e3c3e29087bc242d83aeefa1">fourdst::atomic::Species</a></li>
<li>hasSymbol()&#160;:&#160;<a class="el" href="classfourdst_1_1composition_1_1_composition.html#a72a368f27094b03fdd9896844e075c94">fourdst::composition::Composition</a></li>
</ul>
<h3><a id="index_i" name="index_i"></a>- i -</h3><ul>
<li>isotope()&#160;:&#160;<a class="el" href="structfourdst_1_1composition_1_1_composition_entry.html#af4f8d292d18755670a914072e2260dfb">fourdst::composition::CompositionEntry</a></li>
<li>isValidComposition()&#160;:&#160;<a class="el" href="classfourdst_1_1composition_1_1_composition.html#addf03ba8b988970d341884d487aa94d5">fourdst::composition::Composition</a></li>
<li>isValidSymbol()&#160;:&#160;<a class="el" href="classfourdst_1_1composition_1_1_composition.html#a8fdac26e6298008aaeaa5b15f7fe244f">fourdst::composition::Composition</a></li>
</ul>
<h3><a id="index_m" name="index_m"></a>- m -</h3><ul>
<li>mass()&#160;:&#160;<a class="el" href="structfourdst_1_1atomic_1_1_species.html#af5bdcc90ddafddfc027f94a98972eca3">fourdst::atomic::Species</a></li>
<li>mass_fraction()&#160;:&#160;<a class="el" href="structfourdst_1_1composition_1_1_composition_entry.html#a66cb086719d7f654869bd7b0cee87ffc">fourdst::composition::CompositionEntry</a></li>
<li>massUnc()&#160;:&#160;<a class="el" href="structfourdst_1_1atomic_1_1_species.html#ac041c089469dc8d36548805c81492aca">fourdst::atomic::Species</a></li>
<li>mix()&#160;:&#160;<a class="el" href="classfourdst_1_1composition_1_1_composition.html#a3aead72892606725a4149a5f65bd31ec">fourdst::composition::Composition</a></li>
</ul>
<h3><a id="index_n" name="index_n"></a>- n -</h3><ul>
<li>n()&#160;:&#160;<a class="el" href="structfourdst_1_1atomic_1_1_species.html#a957734e413f07adf1d570885c480768d">fourdst::atomic::Species</a></li>
<li>name()&#160;:&#160;<a class="el" href="structfourdst_1_1atomic_1_1_species.html#a1fcc01fc978b34ba2531117f10be6741">fourdst::atomic::Species</a></li>
<li>number_fraction()&#160;:&#160;<a class="el" href="structfourdst_1_1composition_1_1_composition_entry.html#a2d55492d285068d4a64db5602dfb1c78">fourdst::composition::CompositionEntry</a></li>
<li>nz()&#160;:&#160;<a class="el" href="structfourdst_1_1atomic_1_1_species.html#aa5e452accca3a9b4937867044617a032">fourdst::atomic::Species</a></li>
</ul>
<h3><a id="index_o" name="index_o"></a>- o -</h3><ul>
<li>operator()()&#160;:&#160;<a class="el" href="structstd_1_1hash_3_01fourdst_1_1atomic_1_1_species_01_4.html#afa44fa4cf54e7f6283d6e2ce93c63b6a">std::hash&lt; fourdst::atomic::Species &gt;</a></li>
<li>operator+()&#160;:&#160;<a class="el" href="classfourdst_1_1composition_1_1_composition.html#a24a3bdeb8e8e55b54ecdee6dcb0d9561">fourdst::composition::Composition</a></li>
<li>operator=()&#160;:&#160;<a class="el" href="classfourdst_1_1composition_1_1_composition.html#a4ec1e23cfecef764cb831171fed62fc2">fourdst::composition::Composition</a></li>
</ul>
<h3><a id="index_r" name="index_r"></a>- r -</h3><ul>
<li>registerSpecies()&#160;:&#160;<a class="el" href="classfourdst_1_1composition_1_1_composition.html#a4ce00f73cc133bb1bac2b030b93ab480">fourdst::composition::Composition</a></li>
<li>registerSymbol()&#160;:&#160;<a class="el" href="classfourdst_1_1composition_1_1_composition.html#a1bc2e64f87c12befdc2bc767e7405661">fourdst::composition::Composition</a></li>
<li>rel_abundance()&#160;:&#160;<a class="el" href="structfourdst_1_1composition_1_1_composition_entry.html#ab6619d23e111905d1e3ab16ee822d96c">fourdst::composition::CompositionEntry</a></li>
</ul>
<h3><a id="index_s" name="index_s"></a>- s -</h3><ul>
<li>setCompositionMode()&#160;:&#160;<a class="el" href="classfourdst_1_1composition_1_1_composition.html#a0af981ed1074b26c237cf6cf35f82c9e">fourdst::composition::Composition</a></li>
<li>setMassFracMode()&#160;:&#160;<a class="el" href="structfourdst_1_1composition_1_1_composition_entry.html#a3fb3f63a4e5675c6fefb662a8e3e7aa3">fourdst::composition::CompositionEntry</a></li>
<li>setMassFraction()&#160;:&#160;<a class="el" href="classfourdst_1_1composition_1_1_composition.html#a493224656aa3ade68389250720ef09af">fourdst::composition::Composition</a>, <a class="el" href="structfourdst_1_1composition_1_1_composition_entry.html#a4d6df43e098e7e2e2d94ff7fb76cb4c2">fourdst::composition::CompositionEntry</a></li>
<li>setNumberFracMode()&#160;:&#160;<a class="el" href="structfourdst_1_1composition_1_1_composition_entry.html#a743042d1998875851150d789817f5473">fourdst::composition::CompositionEntry</a></li>
<li>setNumberFraction()&#160;:&#160;<a class="el" href="classfourdst_1_1composition_1_1_composition.html#a7d4d748f3ee25e68751fb143717ed080">fourdst::composition::Composition</a>, <a class="el" href="structfourdst_1_1composition_1_1_composition_entry.html#a9ec47cf4b3399128d3836c1b24b031b0">fourdst::composition::CompositionEntry</a></li>
<li>setSpecies()&#160;:&#160;<a class="el" href="structfourdst_1_1composition_1_1_composition_entry.html#a5885a0e33687bceb15b225a00163e9d3">fourdst::composition::CompositionEntry</a></li>
<li>Species()&#160;:&#160;<a class="el" href="structfourdst_1_1atomic_1_1_species.html#a3756508a18b57a60f68f1b0cf58d303c">fourdst::atomic::Species</a></li>
<li>spin()&#160;:&#160;<a class="el" href="structfourdst_1_1atomic_1_1_species.html#a0e5d73c7c629cb08f254f2bc41f6ac4b">fourdst::atomic::Species</a></li>
<li>spinParity()&#160;:&#160;<a class="el" href="structfourdst_1_1atomic_1_1_species.html#afcdd2f750d8cf206e3bcc507d57dabb1">fourdst::atomic::Species</a></li>
<li>subset()&#160;:&#160;<a class="el" href="classfourdst_1_1composition_1_1_composition.html#a17635cd21744c7cf86cb1eb75152c816">fourdst::composition::Composition</a></li>
<li>symbol()&#160;:&#160;<a class="el" href="structfourdst_1_1composition_1_1_composition_entry.html#a50d18b4c27611fa9314dd756af54c2f0">fourdst::composition::CompositionEntry</a></li>
</ul>
<h3><a id="index_v" name="index_v"></a>- v -</h3><ul>
<li>validateComposition()&#160;:&#160;<a class="el" href="classfourdst_1_1composition_1_1_composition.html#a86982685c34db4a8f079ddafc25c594e">fourdst::composition::Composition</a></li>
</ul>
<h3><a id="index_w" name="index_w"></a>- w -</h3><ul>
<li>what()&#160;:&#160;<a class="el" href="classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error.html#aeba45905c6dc1a47ec1ad3f978f94e57">fourdst::composition::exceptions::CompositionEntryError</a>, <a class="el" href="classfourdst_1_1composition_1_1exceptions_1_1_composition_error.html#ae44ceddb19da8a8cda7ee150b6826d08">fourdst::composition::exceptions::CompositionError</a></li>
</ul>
<h3><a id="index_z" name="index_z"></a>- z -</h3><ul>
<li>z()&#160;:&#160;<a class="el" href="structfourdst_1_1atomic_1_1_species.html#a1d50917a60a1adb2c9912193f214fab0">fourdst::atomic::Species</a></li>
</ul>
<h3><a id="index__7E" name="index__7E"></a>- ~ -</h3><ul>
<li>~Composition()&#160;:&#160;<a class="el" href="classfourdst_1_1composition_1_1_composition.html#aa3ff8ece122a9fad1252061148566749">fourdst::composition::Composition</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="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>