2025-07-24 09:35:52 -04:00
\doxysection { fourdst\+ ::composition\+ ::Composition\+ Entry Struct Reference}
\hypertarget { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry} { } \label { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry} \index { fourdst::composition::CompositionEntry@{ fourdst::composition::CompositionEntry} }
Represents a single entry (an isotope) within a composition.
{ \ttfamily \# include $ < $ composition.\+ h$ > $ }
\doxysubsubsection * { Public Member Functions}
\begin { DoxyCompactItemize}
\item
\mbox { \hyperlink { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a1cccb94c150dd1dcde860f55fbeaf2bd} { Composition\+ Entry} } ()
\begin { DoxyCompactList} \small \item \em Default constructor. Initializes a default entry (H-\/ 1), but in an uninitialized state. \end { DoxyCompactList} \item
\mbox { \hyperlink { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ af27b09bb4e1ee357bb657146feb6039e} { Composition\+ Entry} } (const std\+ ::string \& \mbox { \hyperlink { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a50d18b4c27611fa9314dd756af54c2f0} { symbol} } , bool mass\+ Frac\+ Mode=true)
\begin { DoxyCompactList} \small \item \em Constructs a \doxylink { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry} { Composition\+ Entry} for a given symbol and abundance mode. \end { DoxyCompactList} \item
\mbox { \hyperlink { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a38f3e109b2952c1f0e7444d7fb9e93a0} { Composition\+ Entry} } (const \mbox { \hyperlink { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry} { Composition\+ Entry} } \& entry)
\begin { DoxyCompactList} \small \item \em Copy constructor. \end { DoxyCompactList} \item
void \mbox { \hyperlink { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a5885a0e33687bceb15b225a00163e9d3} { set\+ Species} } (const std\+ ::string \& \mbox { \hyperlink { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a50d18b4c27611fa9314dd756af54c2f0} { symbol} } )
\begin { DoxyCompactList} \small \item \em Sets the species for the composition entry. This can only be done once. \end { DoxyCompactList} \item
std\+ ::string \mbox { \hyperlink { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a50d18b4c27611fa9314dd756af54c2f0} { symbol} } () const
\begin { DoxyCompactList} \small \item \em Gets the chemical symbol of the species. \end { DoxyCompactList} \item
double \mbox { \hyperlink { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a66cb086719d7f654869bd7b0cee87ffc} { mass\+ \_ \+ fraction} } () const
\begin { DoxyCompactList} \small \item \em Gets the mass fraction of the species. \end { DoxyCompactList} \item
double \mbox { \hyperlink { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a2d55492d285068d4a64db5602dfb1c78} { number\+ \_ \+ fraction} } () const
\begin { DoxyCompactList} \small \item \em Gets the number fraction of the species. \end { DoxyCompactList} \item
2025-10-12 10:22:43 -04:00
double \mbox { \hyperlink { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ aed91b28f66ed3e0937905c174712c3ca} { number\+ \_ \+ fraction} } (double total\+ Moles\+ Per\+ Mass) const
2025-07-24 09:35:52 -04:00
\begin { DoxyCompactList} \small \item \em Gets the number fraction, converting from mass fraction if necessary. \end { DoxyCompactList} \item
double \mbox { \hyperlink { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ ab6619d23e111905d1e3ab16ee822d96c} { rel\+ \_ \+ abundance} } () const
\begin { DoxyCompactList} \small \item \em Gets the relative abundance of the species. \end { DoxyCompactList} \item
2025-10-12 10:22:43 -04:00
\mbox { \hyperlink { structfourdst_ 1_ 1atomic_ 1_ 1_ species} { atomic\+ ::\+ Species} } \mbox { \hyperlink { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ af49920b1168be92d517aea03a308fee1} { isotope} } () const
2025-07-24 09:35:52 -04:00
\begin { DoxyCompactList} \small \item \em Gets the isotope data for the species. \end { DoxyCompactList} \item
bool \mbox { \hyperlink { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a14f12b8b0178df2e32e2023bd4564ddc} { get\+ Mass\+ Frac\+ Mode} } () const
\begin { DoxyCompactList} \small \item \em Gets the mode of the composition entry. \end { DoxyCompactList} \item
void \mbox { \hyperlink { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a4d6df43e098e7e2e2d94ff7fb76cb4c2} { set\+ Mass\+ Fraction} } (double \mbox { \hyperlink { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a66cb086719d7f654869bd7b0cee87ffc} { mass\+ \_ \+ fraction} } )
\begin { DoxyCompactList} \small \item \em Sets the mass fraction of the species. \end { DoxyCompactList} \item
void \mbox { \hyperlink { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a9ec47cf4b3399128d3836c1b24b031b0} { set\+ Number\+ Fraction} } (double \mbox { \hyperlink { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a2d55492d285068d4a64db5602dfb1c78} { number\+ \_ \+ fraction} } )
\begin { DoxyCompactList} \small \item \em Sets the number fraction of the species. \end { DoxyCompactList} \item
bool \mbox { \hyperlink { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a3fb3f63a4e5675c6fefb662a8e3e7aa3} { set\+ Mass\+ Frac\+ Mode} } (double mean\+ Molar\+ Mass)
\begin { DoxyCompactList} \small \item \em Switches the mode to mass fraction mode. \end { DoxyCompactList} \item
2025-10-12 10:22:43 -04:00
bool \mbox { \hyperlink { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a00332551f5b2f0d7f10b12a091e21fa8} { set\+ Number\+ Frac\+ Mode} } (double total\+ Moles\+ Per\+ Mass)
2025-07-24 09:35:52 -04:00
\begin { DoxyCompactList} \small \item \em Switches the mode to number fraction mode. \end { DoxyCompactList} \end { DoxyCompactItemize}
\doxysubsubsection * { Public Attributes}
\begin { DoxyCompactItemize}
\item
std\+ ::string \mbox { \hyperlink { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ ac273debdba6a1b3ac0f11698c399d38e} { m\+ \_ \+ symbol} }
\begin { DoxyCompactList} \small \item \em The chemical symbol of the species (e.\+ g., "{ } \+ H-\/ 1"{ } , "{ } \+ Fe-\/ 56"{ } ). \end { DoxyCompactList} \item
\mbox { \hyperlink { structfourdst_ 1_ 1atomic_ 1_ 1_ species} { atomic\+ ::\+ Species} } \mbox { \hyperlink { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a79039cbdc76b4401eb2ce44b85467503} { m\+ \_ \+ isotope} }
\begin { DoxyCompactList} \small \item \em The { \ttfamily \doxylink { structfourdst_ 1_ 1atomic_ 1_ 1_ species} { atomic\+ ::\+ Species} } object containing detailed isotope data. \end { DoxyCompactList} \item
bool \mbox { \hyperlink { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a1e860519bea86793413ed67c76d18c8b} { m\+ \_ \+ mass\+ Frac\+ Mode} } = true
\begin { DoxyCompactList} \small \item \em The mode of the composition entry. True if mass fraction, false if number fraction. \end { DoxyCompactList} \item
double \mbox { \hyperlink { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ adc20165bf94e18eea3458003025579ac} { m\+ \_ \+ mass\+ Fraction} } = 0.\+ 0
\begin { DoxyCompactList} \small \item \em The mass fraction of the species. Valid only if { \ttfamily m\+ \_ \+ mass\+ Frac\+ Mode} is true. \end { DoxyCompactList} \item
double \mbox { \hyperlink { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a2b5e245f7dabb11076efdbe1ed516d9f} { m\+ \_ \+ number\+ Fraction} } = 0.\+ 0
\begin { DoxyCompactList} \small \item \em The number fraction (mole fraction) of the species. Valid only if { \ttfamily m\+ \_ \+ mass\+ Frac\+ Mode} is false. \end { DoxyCompactList} \item
double \mbox { \hyperlink { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a0498d707d8ea78be39283786c10657ef} { m\+ \_ \+ rel\+ Abundance} } = 0.\+ 0
\begin { DoxyCompactList} \small \item \em The relative abundance, used internally for conversions. For mass fraction mode, this is X\+ \_ \+ i / A\+ \_ \+ i; for number fraction mode, it\textquotesingle { } s n\+ \_ \+ i \texorpdfstring { $ \ast $ } { *} A\+ \_ \+ i. \end { DoxyCompactList} \item
2025-10-12 10:22:43 -04:00
double \mbox { \hyperlink { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ acd41be41f03c819521bab28ea0d8bed2} { m\+ \_ \+ moles\+ Per\+ Mass} } = 0.\+ 0
\item
double \mbox { \hyperlink { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a3b056b6b923016d271f034333c96d039} { m\+ \_ \+ cached\+ Number\+ Fraction} } = 0.\+ 0
\begin { DoxyCompactList} \small \item \em Cached number fraction for conversions when in mass fraction mode. \end { DoxyCompactList} \item
2025-07-24 09:35:52 -04:00
bool \mbox { \hyperlink { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a391e899874cd7ef299a3ae1f64c016d2} { m\+ \_ \+ initialized} } = false
\begin { DoxyCompactList} \small \item \em True if the composition entry has been initialized with a valid species. \end { DoxyCompactList} \end { DoxyCompactItemize}
\doxysubsubsection * { Friends}
\begin { DoxyCompactItemize}
\item
std\+ ::ostream \& \mbox { \hyperlink { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ ae7a6a113fc5914248eff5629716d6eb2} { operator$ < $ $ < $ } } (std\+ ::ostream \& os, const \mbox { \hyperlink { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry} { Composition\+ Entry} } \& entry)
\begin { DoxyCompactList} \small \item \em Overloaded output stream operator for \doxylink { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry} { Composition\+ Entry} . \end { DoxyCompactList} \end { DoxyCompactItemize}
\doxysubsection { Detailed Description}
Represents a single entry (an isotope) within a composition.
This struct holds the properties of one component, including its symbol, the corresponding { \ttfamily \doxylink { structfourdst_ 1_ 1atomic_ 1_ 1_ species} { atomic\+ ::\+ Species} } object, and its abundance (either as a mass fraction or number fraction). It manages the state and conversions for that single entry.
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8h_ source_ l00084} { 84} } of file \mbox { \hyperlink { composition_ 8h_ source} { composition.\+ h} } .
2025-07-24 09:35:52 -04:00
\doxysubsection { Constructor \& Destructor Documentation}
\Hypertarget { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a1cccb94c150dd1dcde860f55fbeaf2bd} \index { fourdst::composition::CompositionEntry@{ fourdst::composition::CompositionEntry} !CompositionEntry@{ CompositionEntry} }
\index { CompositionEntry@{ CompositionEntry} !fourdst::composition::CompositionEntry@{ fourdst::composition::CompositionEntry} }
\doxysubsubsection { \texorpdfstring { CompositionEntry()} { CompositionEntry()} \hspace { 0.1cm} { \footnotesize \ttfamily [1/3]} }
{ \footnotesize \ttfamily \label { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a1cccb94c150dd1dcde860f55fbeaf2bd}
fourdst\+ ::composition\+ ::\+ Composition\+ Entry\+ ::\+ Composition\+ Entry (\begin { DoxyParamCaption} { } { } \end { DoxyParamCaption} )}
Default constructor. Initializes a default entry (H-\/ 1), but in an uninitialized state.
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00069} { 69} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ af27b09bb4e1ee357bb657146feb6039e} \index { fourdst::composition::CompositionEntry@{ fourdst::composition::CompositionEntry} !CompositionEntry@{ CompositionEntry} }
\index { CompositionEntry@{ CompositionEntry} !fourdst::composition::CompositionEntry@{ fourdst::composition::CompositionEntry} }
\doxysubsubsection { \texorpdfstring { CompositionEntry()} { CompositionEntry()} \hspace { 0.1cm} { \footnotesize \ttfamily [2/3]} }
{ \footnotesize \ttfamily \label { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ af27b09bb4e1ee357bb657146feb6039e}
fourdst\+ ::composition\+ ::\+ Composition\+ Entry\+ ::\+ Composition\+ Entry (\begin { DoxyParamCaption} \item [{const std\+::string \&}] { symbol} { , } \item [{bool}] { mass\+ Frac\+ Mode} { = { \ttfamily true} } \end { DoxyParamCaption} )\hspace { 0.3cm} { \ttfamily [explicit]} }
Constructs a \doxylink { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry} { Composition\+ Entry} for a given symbol and abundance mode.
\begin { DoxyParams} { Parameters}
{ \em symbol} & The chemical symbol of the species (e.\+ g., "{ } \+ He-\/ 4"{ } ). \\
\hline
{ \em mass\+ Frac\+ Mode} & True to operate in mass fraction mode, false for number fraction mode. \\
\hline
\end { DoxyParams}
\begin { DoxyExceptions} { Exceptions}
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ invalid_ species_ symbol_ error} { exceptions\+ ::\+ Invalid\+ Species\+ Symbol\+ Error} } & if the symbol does not exist in the atomic species database. \\
\hline
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ entry_ already_ initialized_ error} { exceptions\+ ::\+ Entry\+ Already\+ Initialized\+ Error} } & if set\+ Species is called on an already initialized entry. \\
\hline
\end { DoxyExceptions}
\begin { DoxyParagraph} { Usage Example\+ :}
\begin { DoxyCode} { 0}
\DoxyCodeLine { \mbox { \hyperlink { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a1cccb94c150dd1dcde860f55fbeaf2bd} { CompositionEntry} } \ entry(\textcolor { stringliteral} { "{ } H-\/ 1"{ } } ,\ \textcolor { keyword} { true} );\ \textcolor { comment} { //\ Entry\ for\ H-\/ 1\ in\ mass\ fraction\ mode.} }
\end { DoxyCode}
\end { DoxyParagraph}
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00074} { 74} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a38f3e109b2952c1f0e7444d7fb9e93a0} \index { fourdst::composition::CompositionEntry@{ fourdst::composition::CompositionEntry} !CompositionEntry@{ CompositionEntry} }
\index { CompositionEntry@{ CompositionEntry} !fourdst::composition::CompositionEntry@{ fourdst::composition::CompositionEntry} }
\doxysubsubsection { \texorpdfstring { CompositionEntry()} { CompositionEntry()} \hspace { 0.1cm} { \footnotesize \ttfamily [3/3]} }
{ \footnotesize \ttfamily \label { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a38f3e109b2952c1f0e7444d7fb9e93a0}
2025-10-12 10:22:43 -04:00
fourdst\+ ::composition\+ ::\+ Composition\+ Entry\+ ::\+ Composition\+ Entry (\begin { DoxyParamCaption} \item [{const \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry}{Composition\+Entry}} \&}] { entry} { } \end { DoxyParamCaption} )\hspace { 0.3cm} { \ttfamily [default]} }
2025-07-24 09:35:52 -04:00
Copy constructor.
\begin { DoxyParams} { Parameters}
{ \em entry} & The \doxylink { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry} { Composition\+ Entry} to copy. \\
\hline
\end { DoxyParams}
\doxysubsection { Member Function Documentation}
\Hypertarget { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a14f12b8b0178df2e32e2023bd4564ddc} \index { fourdst::composition::CompositionEntry@{ fourdst::composition::CompositionEntry} !getMassFracMode@{ getMassFracMode} }
\index { getMassFracMode@{ getMassFracMode} !fourdst::composition::CompositionEntry@{ fourdst::composition::CompositionEntry} }
\doxysubsubsection { \texorpdfstring { getMassFracMode()} { getMassFracMode()} }
{ \footnotesize \ttfamily \label { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a14f12b8b0178df2e32e2023bd4564ddc}
bool fourdst\+ ::composition\+ ::\+ Composition\+ Entry\+ ::get\+ Mass\+ Frac\+ Mode (\begin { DoxyParamCaption} { } { } \end { DoxyParamCaption} ) const\hspace { 0.3cm} { \ttfamily [nodiscard]} }
Gets the mode of the composition entry.
\begin { DoxyReturn} { Returns}
True if in mass fraction mode, false if in number fraction mode.
\end { DoxyReturn}
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00183} { 183} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
2025-07-24 09:35:52 -04:00
2025-10-12 10:22:43 -04:00
\Hypertarget { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ af49920b1168be92d517aea03a308fee1} \index { fourdst::composition::CompositionEntry@{ fourdst::composition::CompositionEntry} !isotope@{ isotope} }
2025-07-24 09:35:52 -04:00
\index { isotope@{ isotope} !fourdst::composition::CompositionEntry@{ fourdst::composition::CompositionEntry} }
\doxysubsubsection { \texorpdfstring { isotope()} { isotope()} }
2025-10-12 10:22:43 -04:00
{ \footnotesize \ttfamily \label { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ af49920b1168be92d517aea03a308fee1}
\mbox { \hyperlink { structfourdst_ 1_ 1atomic_ 1_ 1_ species} { atomic\+ ::\+ Species} } fourdst\+ ::composition\+ ::\+ Composition\+ Entry\+ ::isotope (\begin { DoxyParamCaption} { } { } \end { DoxyParamCaption} ) const\hspace { 0.3cm} { \ttfamily [nodiscard]} }
2025-07-24 09:35:52 -04:00
Gets the isotope data for the species.
\begin { DoxyReturn} { Returns}
A const reference to the { \ttfamily \doxylink { structfourdst_ 1_ 1atomic_ 1_ 1_ species} { atomic\+ ::\+ Species} } object.
\end { DoxyReturn}
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00130} { 130} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a66cb086719d7f654869bd7b0cee87ffc} \index { fourdst::composition::CompositionEntry@{ fourdst::composition::CompositionEntry} !mass\_ fraction@{ mass\_ fraction} }
\index { mass\_ fraction@{ mass\_ fraction} !fourdst::composition::CompositionEntry@{ fourdst::composition::CompositionEntry} }
2025-10-12 10:22:43 -04:00
\doxysubsubsection { \texorpdfstring { mass\_ fraction()} { mass\_ fraction()} }
2025-07-24 09:35:52 -04:00
{ \footnotesize \ttfamily \label { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a66cb086719d7f654869bd7b0cee87ffc}
double fourdst\+ ::composition\+ ::\+ Composition\+ Entry\+ ::mass\+ \_ \+ fraction (\begin { DoxyParamCaption} { } { } \end { DoxyParamCaption} ) const\hspace { 0.3cm} { \ttfamily [nodiscard]} }
Gets the mass fraction of the species.
\begin { DoxyPrecond} { Precondition}
The entry must be in mass fraction mode.
\end { DoxyPrecond}
\begin { DoxyReturn} { Returns}
The mass fraction of the species.
\end { DoxyReturn}
\begin { DoxyExceptions} { Exceptions}
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ composition_ mode_ error} { exceptions\+ ::\+ Composition\+ Mode\+ Error} } & if the entry is in number fraction mode. \\
\hline
\end { DoxyExceptions}
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00102} { 102} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a2d55492d285068d4a64db5602dfb1c78} \index { fourdst::composition::CompositionEntry@{ fourdst::composition::CompositionEntry} !number\_ fraction@{ number\_ fraction} }
\index { number\_ fraction@{ number\_ fraction} !fourdst::composition::CompositionEntry@{ fourdst::composition::CompositionEntry} }
\doxysubsubsection { \texorpdfstring { number\_ fraction()} { number\_ fraction()} \hspace { 0.1cm} { \footnotesize \ttfamily [1/2]} }
{ \footnotesize \ttfamily \label { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a2d55492d285068d4a64db5602dfb1c78}
double fourdst\+ ::composition\+ ::\+ Composition\+ Entry\+ ::number\+ \_ \+ fraction (\begin { DoxyParamCaption} { } { } \end { DoxyParamCaption} ) const\hspace { 0.3cm} { \ttfamily [nodiscard]} }
Gets the number fraction of the species.
\begin { DoxyPrecond} { Precondition}
The entry must be in number fraction mode.
\end { DoxyPrecond}
\begin { DoxyReturn} { Returns}
The number fraction of the species.
\end { DoxyReturn}
\begin { DoxyExceptions} { Exceptions}
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ composition_ mode_ error} { exceptions\+ ::\+ Composition\+ Mode\+ Error} } & if the entry is in mass fraction mode. \\
\hline
\end { DoxyExceptions}
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00110} { 110} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
2025-07-24 09:35:52 -04:00
2025-10-12 10:22:43 -04:00
\Hypertarget { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ aed91b28f66ed3e0937905c174712c3ca} \index { fourdst::composition::CompositionEntry@{ fourdst::composition::CompositionEntry} !number\_ fraction@{ number\_ fraction} }
2025-07-24 09:35:52 -04:00
\index { number\_ fraction@{ number\_ fraction} !fourdst::composition::CompositionEntry@{ fourdst::composition::CompositionEntry} }
\doxysubsubsection { \texorpdfstring { number\_ fraction()} { number\_ fraction()} \hspace { 0.1cm} { \footnotesize \ttfamily [2/2]} }
2025-10-12 10:22:43 -04:00
{ \footnotesize \ttfamily \label { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ aed91b28f66ed3e0937905c174712c3ca}
double fourdst\+ ::composition\+ ::\+ Composition\+ Entry\+ ::number\+ \_ \+ fraction (\begin { DoxyParamCaption} \item [{double}] { total\+ Moles\+ Per\+ Mass} { } \end { DoxyParamCaption} ) const\hspace { 0.3cm} { \ttfamily [nodiscard]} }
2025-07-24 09:35:52 -04:00
Gets the number fraction, converting from mass fraction if necessary.
\begin { DoxyParams} { Parameters}
2025-10-12 10:22:43 -04:00
{ \em total\+ Moles\+ Per\+ Mass} & The total moles per unit mass (specific number density) of the entire composition. \\
2025-07-24 09:35:52 -04:00
\hline
\end { DoxyParams}
\begin { DoxyReturn} { Returns}
The number fraction of the species.
\end { DoxyReturn}
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00118} { 118} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ ab6619d23e111905d1e3ab16ee822d96c} \index { fourdst::composition::CompositionEntry@{ fourdst::composition::CompositionEntry} !rel\_ abundance@{ rel\_ abundance} }
\index { rel\_ abundance@{ rel\_ abundance} !fourdst::composition::CompositionEntry@{ fourdst::composition::CompositionEntry} }
\doxysubsubsection { \texorpdfstring { rel\_ abundance()} { rel\_ abundance()} }
{ \footnotesize \ttfamily \label { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ ab6619d23e111905d1e3ab16ee822d96c}
double fourdst\+ ::composition\+ ::\+ Composition\+ Entry\+ ::rel\+ \_ \+ abundance (\begin { DoxyParamCaption} { } { } \end { DoxyParamCaption} ) const\hspace { 0.3cm} { \ttfamily [nodiscard]} }
Gets the relative abundance of the species.
\begin { DoxyReturn} { Returns}
The relative abundance.
\end { DoxyReturn}
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00126} { 126} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a3fb3f63a4e5675c6fefb662a8e3e7aa3} \index { fourdst::composition::CompositionEntry@{ fourdst::composition::CompositionEntry} !setMassFracMode@{ setMassFracMode} }
\index { setMassFracMode@{ setMassFracMode} !fourdst::composition::CompositionEntry@{ fourdst::composition::CompositionEntry} }
\doxysubsubsection { \texorpdfstring { setMassFracMode()} { setMassFracMode()} }
{ \footnotesize \ttfamily \label { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a3fb3f63a4e5675c6fefb662a8e3e7aa3}
bool fourdst\+ ::composition\+ ::\+ Composition\+ Entry\+ ::set\+ Mass\+ Frac\+ Mode (\begin { DoxyParamCaption} \item [{double}] { mean\+ Molar\+ Mass} { } \end { DoxyParamCaption} )}
Switches the mode to mass fraction mode.
\begin { DoxyParams} { Parameters}
{ \em mean\+ Molar\+ Mass} & The mean molar mass of the composition, required for conversion. \\
\hline
\end { DoxyParams}
\begin { DoxyReturn} { Returns}
True if the mode was successfully set, false otherwise.
\end { DoxyReturn}
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00159} { 159} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a4d6df43e098e7e2e2d94ff7fb76cb4c2} \index { fourdst::composition::CompositionEntry@{ fourdst::composition::CompositionEntry} !setMassFraction@{ setMassFraction} }
\index { setMassFraction@{ setMassFraction} !fourdst::composition::CompositionEntry@{ fourdst::composition::CompositionEntry} }
\doxysubsubsection { \texorpdfstring { setMassFraction()} { setMassFraction()} }
{ \footnotesize \ttfamily \label { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a4d6df43e098e7e2e2d94ff7fb76cb4c2}
void fourdst\+ ::composition\+ ::\+ Composition\+ Entry\+ ::set\+ Mass\+ Fraction (\begin { DoxyParamCaption} \item [{double}] { mass\+ \_ \+ fraction} { } \end { DoxyParamCaption} )}
Sets the mass fraction of the species.
\begin { DoxyParams} { Parameters}
{ \em mass\+ \_ \+ fraction} & The mass fraction to set. Must be in \mbox { [} 0, 1\mbox { ]} . \\
\hline
\end { DoxyParams}
\begin { DoxyPrecond} { Precondition}
The entry must be in mass fraction mode.
\end { DoxyPrecond}
\begin { DoxyExceptions} { Exceptions}
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ composition_ mode_ error} { exceptions\+ ::\+ Composition\+ Mode\+ Error} } & if the entry is in number fraction mode. \\
\hline
\end { DoxyExceptions}
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00134} { 134} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
2025-07-24 09:35:52 -04:00
2025-10-12 10:22:43 -04:00
\Hypertarget { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a00332551f5b2f0d7f10b12a091e21fa8} \index { fourdst::composition::CompositionEntry@{ fourdst::composition::CompositionEntry} !setNumberFracMode@{ setNumberFracMode} }
2025-07-24 09:35:52 -04:00
\index { setNumberFracMode@{ setNumberFracMode} !fourdst::composition::CompositionEntry@{ fourdst::composition::CompositionEntry} }
\doxysubsubsection { \texorpdfstring { setNumberFracMode()} { setNumberFracMode()} }
2025-10-12 10:22:43 -04:00
{ \footnotesize \ttfamily \label { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a00332551f5b2f0d7f10b12a091e21fa8}
bool fourdst\+ ::composition\+ ::\+ Composition\+ Entry\+ ::set\+ Number\+ Frac\+ Mode (\begin { DoxyParamCaption} \item [{double}] { total\+ Moles\+ Per\+ Mass} { } \end { DoxyParamCaption} )}
2025-07-24 09:35:52 -04:00
Switches the mode to number fraction mode.
\begin { DoxyParams} { Parameters}
2025-10-12 10:22:43 -04:00
{ \em total\+ Moles\+ Per\+ Mass} & The total moles per unit mass (specific number density) of the composition. \\
2025-07-24 09:35:52 -04:00
\hline
\end { DoxyParams}
\begin { DoxyReturn} { Returns}
True if the mode was successfully set, false otherwise.
\end { DoxyReturn}
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00171} { 171} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a9ec47cf4b3399128d3836c1b24b031b0} \index { fourdst::composition::CompositionEntry@{ fourdst::composition::CompositionEntry} !setNumberFraction@{ setNumberFraction} }
\index { setNumberFraction@{ setNumberFraction} !fourdst::composition::CompositionEntry@{ fourdst::composition::CompositionEntry} }
\doxysubsubsection { \texorpdfstring { setNumberFraction()} { setNumberFraction()} }
{ \footnotesize \ttfamily \label { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a9ec47cf4b3399128d3836c1b24b031b0}
void fourdst\+ ::composition\+ ::\+ Composition\+ Entry\+ ::set\+ Number\+ Fraction (\begin { DoxyParamCaption} \item [{double}] { number\+ \_ \+ fraction} { } \end { DoxyParamCaption} )}
Sets the number fraction of the species.
\begin { DoxyParams} { Parameters}
{ \em number\+ \_ \+ fraction} & The number fraction to set. Must be in \mbox { [} 0, 1\mbox { ]} . \\
\hline
\end { DoxyParams}
\begin { DoxyPrecond} { Precondition}
The entry must be in number fraction mode.
\end { DoxyPrecond}
\begin { DoxyExceptions} { Exceptions}
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ composition_ mode_ error} { exceptions\+ ::\+ Composition\+ Mode\+ Error} } & if the entry is in mass fraction mode. \\
\hline
\end { DoxyExceptions}
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00148} { 148} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a5885a0e33687bceb15b225a00163e9d3} \index { fourdst::composition::CompositionEntry@{ fourdst::composition::CompositionEntry} !setSpecies@{ setSpecies} }
\index { setSpecies@{ setSpecies} !fourdst::composition::CompositionEntry@{ fourdst::composition::CompositionEntry} }
\doxysubsubsection { \texorpdfstring { setSpecies()} { setSpecies()} }
{ \footnotesize \ttfamily \label { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a5885a0e33687bceb15b225a00163e9d3}
void fourdst\+ ::composition\+ ::\+ Composition\+ Entry\+ ::set\+ Species (\begin { DoxyParamCaption} \item [{const std\+::string \&}] { symbol} { } \end { DoxyParamCaption} )}
Sets the species for the composition entry. This can only be done once.
\begin { DoxyParams} { Parameters}
{ \em symbol} & The chemical symbol of the species. \\
\hline
\end { DoxyParams}
\begin { DoxyExceptions} { Exceptions}
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ entry_ already_ initialized_ error} { exceptions\+ ::\+ Entry\+ Already\+ Initialized\+ Error} } & if the entry has already been initialized. \\
\hline
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ invalid_ species_ symbol_ error} { exceptions\+ ::\+ Invalid\+ Species\+ Symbol\+ Error} } & if the symbol is not found in the atomic species database. \\
\hline
\end { DoxyExceptions}
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00086} { 86} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a50d18b4c27611fa9314dd756af54c2f0} \index { fourdst::composition::CompositionEntry@{ fourdst::composition::CompositionEntry} !symbol@{ symbol} }
\index { symbol@{ symbol} !fourdst::composition::CompositionEntry@{ fourdst::composition::CompositionEntry} }
\doxysubsubsection { \texorpdfstring { symbol()} { symbol()} }
{ \footnotesize \ttfamily \label { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a50d18b4c27611fa9314dd756af54c2f0}
std\+ ::string fourdst\+ ::composition\+ ::\+ Composition\+ Entry\+ ::symbol (\begin { DoxyParamCaption} { } { } \end { DoxyParamCaption} ) const\hspace { 0.3cm} { \ttfamily [nodiscard]} }
Gets the chemical symbol of the species.
\begin { DoxyReturn} { Returns}
The chemical symbol.
\end { DoxyReturn}
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00098} { 98} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
2025-07-24 09:35:52 -04:00
\doxysubsection { Friends And Related Symbol Documentation}
\Hypertarget { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ ae7a6a113fc5914248eff5629716d6eb2} \index { fourdst::composition::CompositionEntry@{ fourdst::composition::CompositionEntry} !operator$ < $ $ < $ @{ operator$ < $ $ < $ } }
\index { operator$ < $ $ < $ @{ operator$ < $ $ < $ } !fourdst::composition::CompositionEntry@{ fourdst::composition::CompositionEntry} }
\doxysubsubsection { \texorpdfstring { operator$ < $ $ < $ } { operator<<} }
{ \footnotesize \ttfamily \label { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ ae7a6a113fc5914248eff5629716d6eb2}
std\+ ::ostream \& operator$ < $ $ < $ (\begin { DoxyParamCaption} \item [{std\+::ostream \&}] { os} { , } \item [{const \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry}{Composition\+Entry}} \&}] { entry} { } \end { DoxyParamCaption} )\hspace { 0.3cm} { \ttfamily [friend]} }
Overloaded output stream operator for \doxylink { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry} { Composition\+ Entry} .
\begin { DoxyParams} { Parameters}
{ \em os} & The output stream. \\
\hline
{ \em entry} & The \doxylink { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry} { Composition\+ Entry} to output. \\
\hline
\end { DoxyParams}
\begin { DoxyReturn} { Returns}
The output stream.
\end { DoxyReturn}
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l01070} { 1070} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
2025-07-24 09:35:52 -04:00
\doxysubsection { Member Data Documentation}
2025-10-12 10:22:43 -04:00
\Hypertarget { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a3b056b6b923016d271f034333c96d039} \index { fourdst::composition::CompositionEntry@{ fourdst::composition::CompositionEntry} !m\_ cachedNumberFraction@{ m\_ cachedNumberFraction} }
\index { m\_ cachedNumberFraction@{ m\_ cachedNumberFraction} !fourdst::composition::CompositionEntry@{ fourdst::composition::CompositionEntry} }
\doxysubsubsection { \texorpdfstring { m\_ cachedNumberFraction} { m\_ cachedNumberFraction} }
{ \footnotesize \ttfamily \label { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a3b056b6b923016d271f034333c96d039}
double fourdst\+ ::composition\+ ::\+ Composition\+ Entry\+ ::m\+ \_ \+ cached\+ Number\+ Fraction = 0.\+ 0}
Cached number fraction for conversions when in mass fraction mode.
Definition at line \mbox { \hyperlink { composition_ 8h_ source_ l00093} { 93} } of file \mbox { \hyperlink { composition_ 8h_ source} { composition.\+ h} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a391e899874cd7ef299a3ae1f64c016d2} \index { fourdst::composition::CompositionEntry@{ fourdst::composition::CompositionEntry} !m\_ initialized@{ m\_ initialized} }
\index { m\_ initialized@{ m\_ initialized} !fourdst::composition::CompositionEntry@{ fourdst::composition::CompositionEntry} }
\doxysubsubsection { \texorpdfstring { m\_ initialized} { m\_ initialized} }
{ \footnotesize \ttfamily \label { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a391e899874cd7ef299a3ae1f64c016d2}
bool fourdst\+ ::composition\+ ::\+ Composition\+ Entry\+ ::m\+ \_ \+ initialized = false}
True if the composition entry has been initialized with a valid species.
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8h_ source_ l00096} { 96} } of file \mbox { \hyperlink { composition_ 8h_ source} { composition.\+ h} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a79039cbdc76b4401eb2ce44b85467503} \index { fourdst::composition::CompositionEntry@{ fourdst::composition::CompositionEntry} !m\_ isotope@{ m\_ isotope} }
\index { m\_ isotope@{ m\_ isotope} !fourdst::composition::CompositionEntry@{ fourdst::composition::CompositionEntry} }
\doxysubsubsection { \texorpdfstring { m\_ isotope} { m\_ isotope} }
{ \footnotesize \ttfamily \label { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a79039cbdc76b4401eb2ce44b85467503}
\mbox { \hyperlink { structfourdst_ 1_ 1atomic_ 1_ 1_ species} { atomic\+ ::\+ Species} } fourdst\+ ::composition\+ ::\+ Composition\+ Entry\+ ::m\+ \_ \+ isotope}
The { \ttfamily \doxylink { structfourdst_ 1_ 1atomic_ 1_ 1_ species} { atomic\+ ::\+ Species} } object containing detailed isotope data.
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8h_ source_ l00086} { 86} } of file \mbox { \hyperlink { composition_ 8h_ source} { composition.\+ h} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a1e860519bea86793413ed67c76d18c8b} \index { fourdst::composition::CompositionEntry@{ fourdst::composition::CompositionEntry} !m\_ massFracMode@{ m\_ massFracMode} }
\index { m\_ massFracMode@{ m\_ massFracMode} !fourdst::composition::CompositionEntry@{ fourdst::composition::CompositionEntry} }
\doxysubsubsection { \texorpdfstring { m\_ massFracMode} { m\_ massFracMode} }
{ \footnotesize \ttfamily \label { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a1e860519bea86793413ed67c76d18c8b}
bool fourdst\+ ::composition\+ ::\+ Composition\+ Entry\+ ::m\+ \_ \+ mass\+ Frac\+ Mode = true}
The mode of the composition entry. True if mass fraction, false if number fraction.
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8h_ source_ l00087} { 87} } of file \mbox { \hyperlink { composition_ 8h_ source} { composition.\+ h} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ adc20165bf94e18eea3458003025579ac} \index { fourdst::composition::CompositionEntry@{ fourdst::composition::CompositionEntry} !m\_ massFraction@{ m\_ massFraction} }
\index { m\_ massFraction@{ m\_ massFraction} !fourdst::composition::CompositionEntry@{ fourdst::composition::CompositionEntry} }
\doxysubsubsection { \texorpdfstring { m\_ massFraction} { m\_ massFraction} }
{ \footnotesize \ttfamily \label { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ adc20165bf94e18eea3458003025579ac}
double fourdst\+ ::composition\+ ::\+ Composition\+ Entry\+ ::m\+ \_ \+ mass\+ Fraction = 0.\+ 0}
The mass fraction of the species. Valid only if { \ttfamily m\+ \_ \+ mass\+ Frac\+ Mode} is true.
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8h_ source_ l00089} { 89} } of file \mbox { \hyperlink { composition_ 8h_ source} { composition.\+ h} } .
\Hypertarget { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ acd41be41f03c819521bab28ea0d8bed2} \index { fourdst::composition::CompositionEntry@{ fourdst::composition::CompositionEntry} !m\_ molesPerMass@{ m\_ molesPerMass} }
\index { m\_ molesPerMass@{ m\_ molesPerMass} !fourdst::composition::CompositionEntry@{ fourdst::composition::CompositionEntry} }
\doxysubsubsection { \texorpdfstring { m\_ molesPerMass} { m\_ molesPerMass} }
{ \footnotesize \ttfamily \label { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ acd41be41f03c819521bab28ea0d8bed2}
double fourdst\+ ::composition\+ ::\+ Composition\+ Entry\+ ::m\+ \_ \+ moles\+ Per\+ Mass = 0.\+ 0}
Definition at line \mbox { \hyperlink { composition_ 8h_ source_ l00092} { 92} } of file \mbox { \hyperlink { composition_ 8h_ source} { composition.\+ h} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a2b5e245f7dabb11076efdbe1ed516d9f} \index { fourdst::composition::CompositionEntry@{ fourdst::composition::CompositionEntry} !m\_ numberFraction@{ m\_ numberFraction} }
\index { m\_ numberFraction@{ m\_ numberFraction} !fourdst::composition::CompositionEntry@{ fourdst::composition::CompositionEntry} }
\doxysubsubsection { \texorpdfstring { m\_ numberFraction} { m\_ numberFraction} }
{ \footnotesize \ttfamily \label { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a2b5e245f7dabb11076efdbe1ed516d9f}
double fourdst\+ ::composition\+ ::\+ Composition\+ Entry\+ ::m\+ \_ \+ number\+ Fraction = 0.\+ 0}
The number fraction (mole fraction) of the species. Valid only if { \ttfamily m\+ \_ \+ mass\+ Frac\+ Mode} is false.
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8h_ source_ l00090} { 90} } of file \mbox { \hyperlink { composition_ 8h_ source} { composition.\+ h} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a0498d707d8ea78be39283786c10657ef} \index { fourdst::composition::CompositionEntry@{ fourdst::composition::CompositionEntry} !m\_ relAbundance@{ m\_ relAbundance} }
\index { m\_ relAbundance@{ m\_ relAbundance} !fourdst::composition::CompositionEntry@{ fourdst::composition::CompositionEntry} }
\doxysubsubsection { \texorpdfstring { m\_ relAbundance} { m\_ relAbundance} }
{ \footnotesize \ttfamily \label { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ a0498d707d8ea78be39283786c10657ef}
double fourdst\+ ::composition\+ ::\+ Composition\+ Entry\+ ::m\+ \_ \+ rel\+ Abundance = 0.\+ 0}
The relative abundance, used internally for conversions. For mass fraction mode, this is X\+ \_ \+ i / A\+ \_ \+ i; for number fraction mode, it\textquotesingle { } s n\+ \_ \+ i \texorpdfstring { $ \ast $ } { *} A\+ \_ \+ i.
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8h_ source_ l00091} { 91} } of file \mbox { \hyperlink { composition_ 8h_ source} { composition.\+ h} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ ac273debdba6a1b3ac0f11698c399d38e} \index { fourdst::composition::CompositionEntry@{ fourdst::composition::CompositionEntry} !m\_ symbol@{ m\_ symbol} }
\index { m\_ symbol@{ m\_ symbol} !fourdst::composition::CompositionEntry@{ fourdst::composition::CompositionEntry} }
\doxysubsubsection { \texorpdfstring { m\_ symbol} { m\_ symbol} }
{ \footnotesize \ttfamily \label { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry_ ac273debdba6a1b3ac0f11698c399d38e}
std\+ ::string fourdst\+ ::composition\+ ::\+ Composition\+ Entry\+ ::m\+ \_ \+ symbol}
The chemical symbol of the species (e.\+ g., "{ } \+ H-\/ 1"{ } , "{ } \+ Fe-\/ 56"{ } ).
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8h_ source_ l00085} { 85} } of file \mbox { \hyperlink { composition_ 8h_ source} { composition.\+ h} } .
2025-07-24 09:35:52 -04:00
The documentation for this struct was generated from the following files\+ :\begin { DoxyCompactItemize}
\item
src/composition/include/fourdst/composition/\mbox { \hyperlink { composition_ 8h} { composition.\+ h} } \item
src/composition/lib/\mbox { \hyperlink { composition_ 8cpp} { composition.\+ cpp} } \end { DoxyCompactItemize}