117 lines
5.9 KiB
TeX
117 lines
5.9 KiB
TeX
\doxysection{fourdst\+::composition\+::Canonical\+Composition Struct Reference}
|
|
\hypertarget{structfourdst_1_1composition_1_1_canonical_composition}{}\label{structfourdst_1_1composition_1_1_canonical_composition}\index{fourdst::composition::CanonicalComposition@{fourdst::composition::CanonicalComposition}}
|
|
|
|
|
|
Represents the canonical (X, Y, Z) composition of stellar material.
|
|
|
|
|
|
|
|
|
|
{\ttfamily \#include $<$composition.\+h$>$}
|
|
|
|
\doxysubsubsection*{Public Attributes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
double \mbox{\hyperlink{structfourdst_1_1composition_1_1_canonical_composition_abe5b01574242f8eaabd00c3d653291f7}{X}} = 0.\+0
|
|
\begin{DoxyCompactList}\small\item\em Mass fraction of Hydrogen. \end{DoxyCompactList}\item
|
|
double \mbox{\hyperlink{structfourdst_1_1composition_1_1_canonical_composition_a93927bfccc5d2b3906565d092ed4f7f4}{Y}} = 0.\+0
|
|
\begin{DoxyCompactList}\small\item\em Mass fraction of Helium. \end{DoxyCompactList}\item
|
|
double \mbox{\hyperlink{structfourdst_1_1composition_1_1_canonical_composition_ae1981f5ddd36abd17a4a69fa1f43de18}{Z}} = 0.\+0
|
|
\begin{DoxyCompactList}\small\item\em Mass fraction of Metals. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Friends}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
std\+::ostream \& \mbox{\hyperlink{structfourdst_1_1composition_1_1_canonical_composition_a6e447cb601af6bcbd09e290aef759672}{operator$<$$<$}} (std\+::ostream \&os, const \mbox{\hyperlink{structfourdst_1_1composition_1_1_canonical_composition}{Canonical\+Composition}} \&composition)
|
|
\begin{DoxyCompactList}\small\item\em Overloads the stream insertion operator for easy printing. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
Represents the canonical (X, Y, Z) composition of stellar material.
|
|
|
|
This is a standard astrophysical representation where\+:
|
|
\begin{DoxyItemize}
|
|
\item X is the total mass fraction of all hydrogen isotopes.
|
|
\item Y is the total mass fraction of all helium isotopes.
|
|
\item Z is the total mass fraction of all other elements (metals). By definition, X + Y + Z should sum to 1.\+0.
|
|
\end{DoxyItemize}
|
|
|
|
Definition at line \mbox{\hyperlink{composition_8h_source_l00044}{44}} of file \mbox{\hyperlink{composition_8h_source}{composition.\+h}}.
|
|
|
|
|
|
|
|
\doxysubsection{Friends And Related Symbol Documentation}
|
|
\Hypertarget{structfourdst_1_1composition_1_1_canonical_composition_a6e447cb601af6bcbd09e290aef759672}\index{fourdst::composition::CanonicalComposition@{fourdst::composition::CanonicalComposition}!operator$<$$<$@{operator$<$$<$}}
|
|
\index{operator$<$$<$@{operator$<$$<$}!fourdst::composition::CanonicalComposition@{fourdst::composition::CanonicalComposition}}
|
|
\doxysubsubsection{\texorpdfstring{operator$<$$<$}{operator<<}}
|
|
{\footnotesize\ttfamily \label{structfourdst_1_1composition_1_1_canonical_composition_a6e447cb601af6bcbd09e290aef759672}
|
|
std\+::ostream \& operator$<$$<$ (\begin{DoxyParamCaption}\item[{std\+::ostream \&}]{os}{, }\item[{const \mbox{\hyperlink{structfourdst_1_1composition_1_1_canonical_composition}{Canonical\+Composition}} \&}]{composition}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [friend]}}
|
|
|
|
|
|
|
|
Overloads the stream insertion operator for easy printing.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em os} & The output stream. \\
|
|
\hline
|
|
{\em composition} & The \doxylink{structfourdst_1_1composition_1_1_canonical_composition}{Canonical\+Composition} object to print. \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\begin{DoxyReturn}{Returns}
|
|
The output stream.
|
|
\end{DoxyReturn}
|
|
|
|
|
|
Definition at line \mbox{\hyperlink{composition_8h_source_l00055}{55}} of file \mbox{\hyperlink{composition_8h_source}{composition.\+h}}.
|
|
|
|
|
|
|
|
\doxysubsection{Member Data Documentation}
|
|
\Hypertarget{structfourdst_1_1composition_1_1_canonical_composition_abe5b01574242f8eaabd00c3d653291f7}\index{fourdst::composition::CanonicalComposition@{fourdst::composition::CanonicalComposition}!X@{X}}
|
|
\index{X@{X}!fourdst::composition::CanonicalComposition@{fourdst::composition::CanonicalComposition}}
|
|
\doxysubsubsection{\texorpdfstring{X}{X}}
|
|
{\footnotesize\ttfamily \label{structfourdst_1_1composition_1_1_canonical_composition_abe5b01574242f8eaabd00c3d653291f7}
|
|
double fourdst\+::composition\+::\+Canonical\+Composition\+::X = 0.\+0}
|
|
|
|
|
|
|
|
Mass fraction of Hydrogen.
|
|
|
|
|
|
|
|
Definition at line \mbox{\hyperlink{composition_8h_source_l00045}{45}} of file \mbox{\hyperlink{composition_8h_source}{composition.\+h}}.
|
|
|
|
\Hypertarget{structfourdst_1_1composition_1_1_canonical_composition_a93927bfccc5d2b3906565d092ed4f7f4}\index{fourdst::composition::CanonicalComposition@{fourdst::composition::CanonicalComposition}!Y@{Y}}
|
|
\index{Y@{Y}!fourdst::composition::CanonicalComposition@{fourdst::composition::CanonicalComposition}}
|
|
\doxysubsubsection{\texorpdfstring{Y}{Y}}
|
|
{\footnotesize\ttfamily \label{structfourdst_1_1composition_1_1_canonical_composition_a93927bfccc5d2b3906565d092ed4f7f4}
|
|
double fourdst\+::composition\+::\+Canonical\+Composition\+::Y = 0.\+0}
|
|
|
|
|
|
|
|
Mass fraction of Helium.
|
|
|
|
|
|
|
|
Definition at line \mbox{\hyperlink{composition_8h_source_l00046}{46}} of file \mbox{\hyperlink{composition_8h_source}{composition.\+h}}.
|
|
|
|
\Hypertarget{structfourdst_1_1composition_1_1_canonical_composition_ae1981f5ddd36abd17a4a69fa1f43de18}\index{fourdst::composition::CanonicalComposition@{fourdst::composition::CanonicalComposition}!Z@{Z}}
|
|
\index{Z@{Z}!fourdst::composition::CanonicalComposition@{fourdst::composition::CanonicalComposition}}
|
|
\doxysubsubsection{\texorpdfstring{Z}{Z}}
|
|
{\footnotesize\ttfamily \label{structfourdst_1_1composition_1_1_canonical_composition_ae1981f5ddd36abd17a4a69fa1f43de18}
|
|
double fourdst\+::composition\+::\+Canonical\+Composition\+::Z = 0.\+0}
|
|
|
|
|
|
|
|
Mass fraction of Metals.
|
|
|
|
|
|
|
|
Definition at line \mbox{\hyperlink{composition_8h_source_l00047}{47}} of file \mbox{\hyperlink{composition_8h_source}{composition.\+h}}.
|
|
|
|
|
|
|
|
The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize}
|
|
\item
|
|
src/composition/include/fourdst/composition/\mbox{\hyperlink{composition_8h}{composition.\+h}}\end{DoxyCompactItemize}
|