253 lines
13 KiB
HTML
253 lines
13 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::CanonicalComposition 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"> 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&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_canonical_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_canonical_composition-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">fourdst::composition::CanonicalComposition Struct Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Represents the canonical (X, Y, Z) composition of stellar material.
|
|
<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:abe5b01574242f8eaabd00c3d653291f7" id="r_abe5b01574242f8eaabd00c3d653291f7"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="#abe5b01574242f8eaabd00c3d653291f7">X</a> = 0.0</td></tr>
|
|
<tr class="memdesc:abe5b01574242f8eaabd00c3d653291f7"><td class="mdescLeft"> </td><td class="mdescRight">Mass fraction of Hydrogen. <br /></td></tr>
|
|
<tr class="separator:abe5b01574242f8eaabd00c3d653291f7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a93927bfccc5d2b3906565d092ed4f7f4" id="r_a93927bfccc5d2b3906565d092ed4f7f4"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="#a93927bfccc5d2b3906565d092ed4f7f4">Y</a> = 0.0</td></tr>
|
|
<tr class="memdesc:a93927bfccc5d2b3906565d092ed4f7f4"><td class="mdescLeft"> </td><td class="mdescRight">Mass fraction of Helium. <br /></td></tr>
|
|
<tr class="separator:a93927bfccc5d2b3906565d092ed4f7f4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae1981f5ddd36abd17a4a69fa1f43de18" id="r_ae1981f5ddd36abd17a4a69fa1f43de18"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="#ae1981f5ddd36abd17a4a69fa1f43de18">Z</a> = 0.0</td></tr>
|
|
<tr class="memdesc:ae1981f5ddd36abd17a4a69fa1f43de18"><td class="mdescLeft"> </td><td class="mdescRight">Mass fraction of Metals. <br /></td></tr>
|
|
<tr class="separator:ae1981f5ddd36abd17a4a69fa1f43de18"><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:a6e447cb601af6bcbd09e290aef759672" id="r_a6e447cb601af6bcbd09e290aef759672"><td class="memItemLeft" align="right" valign="top">std::ostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a6e447cb601af6bcbd09e290aef759672">operator<<</a> (std::ostream &os, const <a class="el" href="structfourdst_1_1composition_1_1_canonical_composition.html">CanonicalComposition</a> &composition)</td></tr>
|
|
<tr class="memdesc:a6e447cb601af6bcbd09e290aef759672"><td class="mdescLeft"> </td><td class="mdescRight">Overloads the stream insertion operator for easy printing. <br /></td></tr>
|
|
<tr class="separator:a6e447cb601af6bcbd09e290aef759672"><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 the canonical (X, Y, Z) composition of stellar material. </p>
|
|
<p>This is a standard astrophysical representation where:</p><ul>
|
|
<li>X is the total mass fraction of all hydrogen isotopes.</li>
|
|
<li>Y is the total mass fraction of all helium isotopes.</li>
|
|
<li>Z is the total mass fraction of all other elements (metals). By definition, X + Y + Z should sum to 1.0. </li>
|
|
</ul>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="composition_8h_source.html#l00044">44</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="a6e447cb601af6bcbd09e290aef759672" name="a6e447cb601af6bcbd09e290aef759672"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6e447cb601af6bcbd09e290aef759672">◆ </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_canonical_composition.html">CanonicalComposition</a> &</td> <td class="paramname"><span class="paramname"><em>composition</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>Overloads the stream insertion operator for easy printing. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">os</td><td>The output stream. </td></tr>
|
|
<tr><td class="paramname">composition</td><td>The <a class="el" href="structfourdst_1_1composition_1_1_canonical_composition.html" title="Represents the canonical (X, Y, Z) composition of stellar material.">CanonicalComposition</a> object to print. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The output stream. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="composition_8h_source.html#l00055">55</a> of file <a class="el" href="composition_8h_source.html">composition.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="abe5b01574242f8eaabd00c3d653291f7" name="abe5b01574242f8eaabd00c3d653291f7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abe5b01574242f8eaabd00c3d653291f7">◆ </a></span>X</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">double fourdst::composition::CanonicalComposition::X = 0.0</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Mass fraction of Hydrogen. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="composition_8h_source.html#l00045">45</a> of file <a class="el" href="composition_8h_source.html">composition.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a93927bfccc5d2b3906565d092ed4f7f4" name="a93927bfccc5d2b3906565d092ed4f7f4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a93927bfccc5d2b3906565d092ed4f7f4">◆ </a></span>Y</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">double fourdst::composition::CanonicalComposition::Y = 0.0</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Mass fraction of Helium. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="composition_8h_source.html#l00046">46</a> of file <a class="el" href="composition_8h_source.html">composition.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae1981f5ddd36abd17a4a69fa1f43de18" name="ae1981f5ddd36abd17a4a69fa1f43de18"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae1981f5ddd36abd17a4a69fa1f43de18">◆ </a></span>Z</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">double fourdst::composition::CanonicalComposition::Z = 0.0</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Mass fraction of Metals. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="composition_8h_source.html#l00047">47</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_canonical_composition.html">CanonicalComposition</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>
|