217 lines
11 KiB
HTML
217 lines
11 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: fourdst::composition::GlobalComposition Struct 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"> 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&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&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&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&dn=expat.txt MIT */
|
|
$(function(){initNavTree('structfourdst_1_1composition_1_1_global_composition.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-attribs">Public Attributes</a> |
|
|
<a href="#friends">Friends</a> |
|
|
<a href="structfourdst_1_1composition_1_1_global_composition-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">fourdst::composition::GlobalComposition Struct Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Represents global properties of a finalized composition.
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="composition_8h_source.html">composition.h</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
|
|
Public Attributes</h2></td></tr>
|
|
<tr class="memitem:a0df6ecfe28d13cbffd0abcbfec9aee41" id="r_a0df6ecfe28d13cbffd0abcbfec9aee41"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="#a0df6ecfe28d13cbffd0abcbfec9aee41">specificNumberDensity</a></td></tr>
|
|
<tr class="memdesc:a0df6ecfe28d13cbffd0abcbfec9aee41"><td class="mdescLeft"> </td><td class="mdescRight">The specific number density (moles per unit mass, sum of X_i/M_i), where X_i is mass fraction and M_i is molar mass. Units: mol/g. <br /></td></tr>
|
|
<tr class="separator:a0df6ecfe28d13cbffd0abcbfec9aee41"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9c35810d965841a755da9ce4644a2f1b" id="r_a9c35810d965841a755da9ce4644a2f1b"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="#a9c35810d965841a755da9ce4644a2f1b">meanParticleMass</a></td></tr>
|
|
<tr class="memdesc:a9c35810d965841a755da9ce4644a2f1b"><td class="mdescLeft"> </td><td class="mdescRight">The mean mass per particle (inverse of specific number density). Units: g/mol. <br /></td></tr>
|
|
<tr class="separator:a9c35810d965841a755da9ce4644a2f1b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a>
|
|
Friends</h2></td></tr>
|
|
<tr class="memitem:a3c072a749c3648607771ac9105181f26" id="r_a3c072a749c3648607771ac9105181f26"><td class="memItemLeft" align="right" valign="top">std::ostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a3c072a749c3648607771ac9105181f26">operator<<</a> (std::ostream &os, const <a class="el" href="structfourdst_1_1composition_1_1_global_composition.html">GlobalComposition</a> &comp)</td></tr>
|
|
<tr class="separator:a3c072a749c3648607771ac9105181f26"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Represents global properties of a finalized composition. </p>
|
|
<p>This struct holds derived quantities that describe the entire composition, such as mean particle mass. It is typically returned by <code><a class="el" href="classfourdst_1_1composition_1_1_composition.html" title="Manages a collection of chemical species and their abundances.">Composition</a></code> methods after the composition has been finalized and is intended for internal or advanced use. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="composition_8h_source.html#l00069">69</a> of file <a class="el" href="composition_8h_source.html">composition.h</a>.</p>
|
|
</div><h2 class="groupheader">Friends And Related Symbol Documentation</h2>
|
|
<a id="a3c072a749c3648607771ac9105181f26" name="a3c072a749c3648607771ac9105181f26"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3c072a749c3648607771ac9105181f26">◆ </a></span>operator<<</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::ostream & operator<< </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::ostream &</td> <td class="paramname"><span class="paramname"><em>os</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="structfourdst_1_1composition_1_1_global_composition.html">GlobalComposition</a> &</td> <td class="paramname"><span class="paramname"><em>comp</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel friend">friend</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="composition_8cpp_source.html#l00925">925</a> of file <a class="el" href="composition_8cpp_source.html">composition.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="a9c35810d965841a755da9ce4644a2f1b" name="a9c35810d965841a755da9ce4644a2f1b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9c35810d965841a755da9ce4644a2f1b">◆ </a></span>meanParticleMass</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">double fourdst::composition::GlobalComposition::meanParticleMass</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The mean mass per particle (inverse of specific number density). Units: g/mol. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="composition_8h_source.html#l00071">71</a> of file <a class="el" href="composition_8h_source.html">composition.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0df6ecfe28d13cbffd0abcbfec9aee41" name="a0df6ecfe28d13cbffd0abcbfec9aee41"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0df6ecfe28d13cbffd0abcbfec9aee41">◆ </a></span>specificNumberDensity</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">double fourdst::composition::GlobalComposition::specificNumberDensity</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The specific number density (moles per unit mass, sum of X_i/M_i), where X_i is mass fraction and M_i is molar mass. Units: mol/g. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="composition_8h_source.html#l00070">70</a> of file <a class="el" href="composition_8h_source.html">composition.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this struct was generated from the following file:<ul>
|
|
<li>src/composition/include/fourdst/composition/<a class="el" href="composition_8h_source.html">composition.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="namespacefourdst.html">fourdst</a></li><li class="navelem"><a class="el" href="namespacefourdst_1_1composition.html">composition</a></li><li class="navelem"><a class="el" href="structfourdst_1_1composition_1_1_global_composition.html">GlobalComposition</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>
|