\doxysection{fourdst\+::composition\+::Composition\+Decorator Class Reference}
\hypertarget{classfourdst_1_1composition_1_1_composition_decorator}{}\label{classfourdst_1_1composition_1_1_composition_decorator}\index{fourdst::composition::CompositionDecorator@{fourdst::composition::CompositionDecorator}}


{\ttfamily \#include $<$composition\+\_\+decorator\+\_\+abstract.\+h$>$}



Inheritance diagram for fourdst\+::composition\+::Composition\+Decorator\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=200pt]{classfourdst_1_1composition_1_1_composition_decorator__inherit__graph}
\end{center}
\end{figure}


Collaboration diagram for fourdst\+::composition\+::Composition\+Decorator\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{classfourdst_1_1composition_1_1_composition_decorator__coll__graph}
\end{center}
\end{figure}
\doxysubsubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_decorator_a115e0c194a3dffddc558e0305cc56677}{Composition\+Decorator}} (std\+::unique\+\_\+ptr$<$ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_abstract}{Composition\+Abstract}} $>$ decorator)
\item 
bool \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_decorator_a811e91b7cc08f19b8c92de43fdb91401}{contains}} (const \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{atomic\+::\+Species}} \&species) const noexcept override
\begin{DoxyCompactList}\small\item\em Check if the composition contains the given species. \end{DoxyCompactList}\item 
bool \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_decorator_af40ce87fce6fc0fae837bf8f31fec274}{contains}} (const std\+::string \&symbol) const override
\begin{DoxyCompactList}\small\item\em Check if the composition contains the given species. \end{DoxyCompactList}\item 
size\+\_\+t \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_decorator_af70b703b6b946d959cdd5cd15e853a9d}{size}} () const noexcept override
\item 
std\+::set$<$ std\+::string $>$ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_decorator_a85acea9a107432dfefcbfffe4c3c7c62}{get\+Registered\+Symbols}} () const noexcept override
\begin{DoxyCompactList}\small\item\em Get all registered chemical symbols in the composition. \end{DoxyCompactList}\item 
const std\+::vector$<$ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{atomic\+::\+Species}} $>$ \& \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_decorator_a0cdc50a57e09bf8461839d08eb4ae212}{get\+Registered\+Species}} () const noexcept override
\begin{DoxyCompactList}\small\item\em Get all registered atomic species in the composition. \end{DoxyCompactList}\item 
std\+::unordered\+\_\+map$<$ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{atomic\+::\+Species}}, double $>$ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_decorator_a8c1a4cd69465ef5b65bea547ed919ca5}{get\+Mass\+Fraction}} () const noexcept override
\begin{DoxyCompactList}\small\item\em Get the mass fraction for all registered symbols. \end{DoxyCompactList}\item 
std\+::unordered\+\_\+map$<$ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{atomic\+::\+Species}}, double $>$ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_decorator_a66724877d66017bac3dc3cc784dda57c}{get\+Number\+Fraction}} () const noexcept override
\begin{DoxyCompactList}\small\item\em Get the number fraction for all registered symbols. \end{DoxyCompactList}\item 
double \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_decorator_a52591cb38ab7712fc459eeb48b9d2eaf}{get\+Mass\+Fraction}} (const std\+::string \&symbol) const override
\begin{DoxyCompactList}\small\item\em Get the mass fraction for a given symbol. \end{DoxyCompactList}\item 
double \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_decorator_a12a5cdb232ce4ce30980a016d20b4a43}{get\+Mass\+Fraction}} (const \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{atomic\+::\+Species}} \&species) const override
\begin{DoxyCompactList}\small\item\em Get the mass fraction for a given species. \end{DoxyCompactList}\item 
double \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_decorator_a0ff3454e625043c76131a1206d9293c6}{get\+Number\+Fraction}} (const std\+::string \&symbol) const override
\begin{DoxyCompactList}\small\item\em Get the number fraction for a given symbol. \end{DoxyCompactList}\item 
double \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_decorator_a92c3d23d632f242e8b5526b343617f67}{get\+Number\+Fraction}} (const \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{atomic\+::\+Species}} \&species) const override
\begin{DoxyCompactList}\small\item\em Get the number fraction for a given species. \end{DoxyCompactList}\item 
double \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_decorator_a0c46d440cafd9ae2d04589ece5fd41fb}{get\+Molar\+Abundance}} (const std\+::string \&symbol) const override
\begin{DoxyCompactList}\small\item\em Get the molar abundance for a given symbol. \end{DoxyCompactList}\item 
double \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_decorator_a57a1cc37e96234477b21866881fbdbaa}{get\+Molar\+Abundance}} (const \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{atomic\+::\+Species}} \&species) const override
\begin{DoxyCompactList}\small\item\em Get the molar abundance for a given species. \end{DoxyCompactList}\item 
double \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_decorator_a3b8f0f8fd75888d001177deff39f7405}{get\+Mean\+Particle\+Mass}} () const noexcept override
\begin{DoxyCompactList}\small\item\em Get the mean particle mass of the composition. \end{DoxyCompactList}\item 
double \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_decorator_a39f1df55aff6650c653e62c0e9a2cc5e}{get\+Electron\+Abundance}} () const noexcept override
\begin{DoxyCompactList}\small\item\em Get the electron abundance of the composition. \end{DoxyCompactList}\item 
std\+::vector$<$ double $>$ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_decorator_a4d2795fa73ec3f5185232d4cca5684a6}{get\+Mass\+Fraction\+Vector}} () const noexcept override
\begin{DoxyCompactList}\small\item\em Get the mass fraction as a vector. \end{DoxyCompactList}\item 
std\+::vector$<$ double $>$ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_decorator_a72ffd49c3b3e7f3f22ed28ceb2169cb5}{get\+Number\+Fraction\+Vector}} () const noexcept override
\begin{DoxyCompactList}\small\item\em Get the number fraction as a vector. \end{DoxyCompactList}\item 
std\+::vector$<$ double $>$ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_decorator_a80e528239b4a197985e6993c8b6dab48}{get\+Molar\+Abundance\+Vector}} () const noexcept override
\begin{DoxyCompactList}\small\item\em Get the molar abundance as a vector. \end{DoxyCompactList}\item 
size\+\_\+t \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_decorator_a9b7e6388d9a73c05ddd34660bde43867}{get\+Species\+Index}} (const std\+::string \&symbol) const override
\begin{DoxyCompactList}\small\item\em Get the index of a species by symbol. \end{DoxyCompactList}\item 
size\+\_\+t \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_decorator_ab02b459d8ce7f36a0a1c6058c013a75c}{get\+Species\+Index}} (const \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{atomic\+::\+Species}} \&species) const override
\begin{DoxyCompactList}\small\item\em Get the index of a species. \end{DoxyCompactList}\item 
\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{atomic\+::\+Species}} \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_decorator_a996066b4bf67e415eb2dd3ea7aed68bd}{get\+Species\+At\+Index}} (const size\+\_\+t index) const override
\begin{DoxyCompactList}\small\item\em Get the species at a given index. \end{DoxyCompactList}\item 
\mbox{\hyperlink{classfourdst_1_1composition_1_1detail_1_1_composition_iterator}{detail\+::\+Composition\+Iterator}}$<$ false $>$ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_decorator_a34e7e9fd25cd4037ba359bc7a7236929}{begin}} () override
\item 
\mbox{\hyperlink{classfourdst_1_1composition_1_1detail_1_1_composition_iterator}{detail\+::\+Composition\+Iterator}}$<$ false $>$ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_decorator_aaf47cdfcb7feb3991d6e151bbf2521ff}{end}} () override
\item 
\mbox{\hyperlink{classfourdst_1_1composition_1_1detail_1_1_composition_iterator}{detail\+::\+Composition\+Iterator}}$<$ true $>$ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_decorator_a125e06aaf1edfd035d7d102792a120d5}{begin}} () const override
\item 
\mbox{\hyperlink{classfourdst_1_1composition_1_1detail_1_1_composition_iterator}{detail\+::\+Composition\+Iterator}}$<$ true $>$ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_decorator_a56d0561c510efa577dc9a295174827ec}{end}} () const override
\end{DoxyCompactItemize}
\doxysubsection*{Public Member Functions inherited from \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_abstract}{fourdst\+::composition\+::\+Composition\+Abstract}}}
\begin{DoxyCompactItemize}
\item 
virtual \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_abstract_a83ff77f3f390bb66c978e157d9bb6394}{\texorpdfstring{$\sim$}{\string~}\+Composition\+Abstract}} ()=default
\begin{DoxyCompactList}\small\item\em Virtual destructor. \end{DoxyCompactList}\item 
virtual std\+::unique\+\_\+ptr$<$ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_abstract}{Composition\+Abstract}} $>$ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_abstract_a81d5a4da267e24662ae90c6a29f3d0a1}{clone}} () const =0
\item 
virtual std\+::size\+\_\+t \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_abstract_a2d5472a63e2dbfc94d7e4617b5660e23}{hash}} () const =0
\end{DoxyCompactItemize}
\doxysubsubsection*{Protected Attributes}
\begin{DoxyCompactItemize}
\item 
std\+::unique\+\_\+ptr$<$ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_abstract}{Composition\+Abstract}} $>$ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_decorator_a785a5aeddcc68ce3a5b688d956c4d505}{m\+\_\+base\+\_\+composition}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Additional Inherited Members}
\doxysubsection*{Public Types inherited from \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_abstract}{fourdst\+::composition\+::\+Composition\+Abstract}}}
\begin{DoxyCompactItemize}
\item 
using \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_abstract_abd12f3a9a5b6217498ff19e25ee3ddb0}{iterator}} = \mbox{\hyperlink{classfourdst_1_1composition_1_1detail_1_1_composition_iterator}{detail\+::\+Composition\+Iterator}}$<$false$>$
\item 
using \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_abstract_a0bb9772bc73d637950b6cf2e8e6afeb0}{const\+\_\+iterator}} = \mbox{\hyperlink{classfourdst_1_1composition_1_1detail_1_1_composition_iterator}{detail\+::\+Composition\+Iterator}}$<$true$>$
\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}


Definition at line \mbox{\hyperlink{composition__decorator__abstract_8h_source_l00016}{16}} of file \mbox{\hyperlink{composition__decorator__abstract_8h_source}{composition\+\_\+decorator\+\_\+abstract.\+h}}.



\doxysubsection{Constructor \& Destructor Documentation}
\Hypertarget{classfourdst_1_1composition_1_1_composition_decorator_a115e0c194a3dffddc558e0305cc56677}\index{fourdst::composition::CompositionDecorator@{fourdst::composition::CompositionDecorator}!CompositionDecorator@{CompositionDecorator}}
\index{CompositionDecorator@{CompositionDecorator}!fourdst::composition::CompositionDecorator@{fourdst::composition::CompositionDecorator}}
\doxysubsubsection{\texorpdfstring{CompositionDecorator()}{CompositionDecorator()}}
{\footnotesize\ttfamily \label{classfourdst_1_1composition_1_1_composition_decorator_a115e0c194a3dffddc558e0305cc56677} 
fourdst\+::composition\+::\+Composition\+Decorator\+::\+Composition\+Decorator (\begin{DoxyParamCaption}\item[{std\+::unique\+\_\+ptr$<$ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_abstract}{Composition\+Abstract}} $>$}]{decorator}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [explicit]}}



Definition at line \mbox{\hyperlink{composition__decorator__abstract_8h_source_l00018}{18}} of file \mbox{\hyperlink{composition__decorator__abstract_8h_source}{composition\+\_\+decorator\+\_\+abstract.\+h}}.



\doxysubsection{Member Function Documentation}
\Hypertarget{classfourdst_1_1composition_1_1_composition_decorator_a125e06aaf1edfd035d7d102792a120d5}\index{fourdst::composition::CompositionDecorator@{fourdst::composition::CompositionDecorator}!begin@{begin}}
\index{begin@{begin}!fourdst::composition::CompositionDecorator@{fourdst::composition::CompositionDecorator}}
\doxysubsubsection{\texorpdfstring{begin()}{begin()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily \label{classfourdst_1_1composition_1_1_composition_decorator_a125e06aaf1edfd035d7d102792a120d5} 
\mbox{\hyperlink{classfourdst_1_1composition_1_1detail_1_1_composition_iterator}{detail\+::\+Composition\+Iterator}}$<$ true $>$ fourdst\+::composition\+::\+Composition\+Decorator\+::begin (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [nodiscard]}, {\ttfamily [override]}, {\ttfamily [virtual]}}



Implements \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_abstract_a0a1845dab0dbf23399233cac7aeb05c1}{fourdst\+::composition\+::\+Composition\+Abstract}}.



Reimplemented in \mbox{\hyperlink{classfourdst_1_1composition_1_1_masked_composition_a047dae84149b92be5849c4294cd481de}{fourdst\+::composition\+::\+Masked\+Composition}}.



Definition at line \mbox{\hyperlink{composition__decorator__abstract_8h_source_l00044}{44}} of file \mbox{\hyperlink{composition__decorator__abstract_8h_source}{composition\+\_\+decorator\+\_\+abstract.\+h}}.

\Hypertarget{classfourdst_1_1composition_1_1_composition_decorator_a34e7e9fd25cd4037ba359bc7a7236929}\index{fourdst::composition::CompositionDecorator@{fourdst::composition::CompositionDecorator}!begin@{begin}}
\index{begin@{begin}!fourdst::composition::CompositionDecorator@{fourdst::composition::CompositionDecorator}}
\doxysubsubsection{\texorpdfstring{begin()}{begin()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily \label{classfourdst_1_1composition_1_1_composition_decorator_a34e7e9fd25cd4037ba359bc7a7236929} 
\mbox{\hyperlink{classfourdst_1_1composition_1_1detail_1_1_composition_iterator}{detail\+::\+Composition\+Iterator}}$<$ false $>$ fourdst\+::composition\+::\+Composition\+Decorator\+::begin (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [nodiscard]}, {\ttfamily [override]}, {\ttfamily [virtual]}}



Implements \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_abstract_a643f2e1f843d8a6f81c9382278916fe5}{fourdst\+::composition\+::\+Composition\+Abstract}}.



Reimplemented in \mbox{\hyperlink{classfourdst_1_1composition_1_1_masked_composition_aa01637b823d0127736cdc767284eb28d}{fourdst\+::composition\+::\+Masked\+Composition}}.



Definition at line \mbox{\hyperlink{composition__decorator__abstract_8h_source_l00041}{41}} of file \mbox{\hyperlink{composition__decorator__abstract_8h_source}{composition\+\_\+decorator\+\_\+abstract.\+h}}.

\Hypertarget{classfourdst_1_1composition_1_1_composition_decorator_a811e91b7cc08f19b8c92de43fdb91401}\index{fourdst::composition::CompositionDecorator@{fourdst::composition::CompositionDecorator}!contains@{contains}}
\index{contains@{contains}!fourdst::composition::CompositionDecorator@{fourdst::composition::CompositionDecorator}}
\doxysubsubsection{\texorpdfstring{contains()}{contains()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily \label{classfourdst_1_1composition_1_1_composition_decorator_a811e91b7cc08f19b8c92de43fdb91401} 
bool fourdst\+::composition\+::\+Composition\+Decorator\+::contains (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{atomic\+::\+Species}} \&}]{species}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [nodiscard]}, {\ttfamily [override]}, {\ttfamily [virtual]}, {\ttfamily [noexcept]}}



Check if the composition contains the given species. 


\begin{DoxyParams}{Parameters}
{\em species} & The atomic species to check. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
True if the species is contained, false otherwise. 
\end{DoxyReturn}


Implements \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_abstract_a2e6c4d27d2b295b6be87c6964cac1e1e}{fourdst\+::composition\+::\+Composition\+Abstract}}.



Reimplemented in \mbox{\hyperlink{classfourdst_1_1composition_1_1_masked_composition_a045cfdf1e771895df872a6da61c53966}{fourdst\+::composition\+::\+Masked\+Composition}}.



Definition at line \mbox{\hyperlink{composition__decorator__abstract_8h_source_l00019}{19}} of file \mbox{\hyperlink{composition__decorator__abstract_8h_source}{composition\+\_\+decorator\+\_\+abstract.\+h}}.

\Hypertarget{classfourdst_1_1composition_1_1_composition_decorator_af40ce87fce6fc0fae837bf8f31fec274}\index{fourdst::composition::CompositionDecorator@{fourdst::composition::CompositionDecorator}!contains@{contains}}
\index{contains@{contains}!fourdst::composition::CompositionDecorator@{fourdst::composition::CompositionDecorator}}
\doxysubsubsection{\texorpdfstring{contains()}{contains()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily \label{classfourdst_1_1composition_1_1_composition_decorator_af40ce87fce6fc0fae837bf8f31fec274} 
bool fourdst\+::composition\+::\+Composition\+Decorator\+::contains (\begin{DoxyParamCaption}\item[{const std\+::string \&}]{symbol}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [nodiscard]}, {\ttfamily [override]}, {\ttfamily [virtual]}}



Check if the composition contains the given species. 


\begin{DoxyParams}{Parameters}
{\em symbol} & The symbol of the atomic species to check. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
True if the species is contained, false otherwise. 
\end{DoxyReturn}


Implements \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_abstract_a6fe83824aefb045d8a5399e8ac9852f9}{fourdst\+::composition\+::\+Composition\+Abstract}}.



Reimplemented in \mbox{\hyperlink{classfourdst_1_1composition_1_1_masked_composition_a83b73b24715d8a0fc29811653bb7c9a6}{fourdst\+::composition\+::\+Masked\+Composition}}.



Definition at line \mbox{\hyperlink{composition__decorator__abstract_8h_source_l00020}{20}} of file \mbox{\hyperlink{composition__decorator__abstract_8h_source}{composition\+\_\+decorator\+\_\+abstract.\+h}}.

\Hypertarget{classfourdst_1_1composition_1_1_composition_decorator_a56d0561c510efa577dc9a295174827ec}\index{fourdst::composition::CompositionDecorator@{fourdst::composition::CompositionDecorator}!end@{end}}
\index{end@{end}!fourdst::composition::CompositionDecorator@{fourdst::composition::CompositionDecorator}}
\doxysubsubsection{\texorpdfstring{end()}{end()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily \label{classfourdst_1_1composition_1_1_composition_decorator_a56d0561c510efa577dc9a295174827ec} 
\mbox{\hyperlink{classfourdst_1_1composition_1_1detail_1_1_composition_iterator}{detail\+::\+Composition\+Iterator}}$<$ true $>$ fourdst\+::composition\+::\+Composition\+Decorator\+::end (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [nodiscard]}, {\ttfamily [override]}, {\ttfamily [virtual]}}



Implements \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_abstract_a9ac49da6e4df7bee8aa7974e8fec8181}{fourdst\+::composition\+::\+Composition\+Abstract}}.



Reimplemented in \mbox{\hyperlink{classfourdst_1_1composition_1_1_masked_composition_a272b2164c1ad6efab7e86ed26efcbb96}{fourdst\+::composition\+::\+Masked\+Composition}}.



Definition at line \mbox{\hyperlink{composition__decorator__abstract_8h_source_l00045}{45}} of file \mbox{\hyperlink{composition__decorator__abstract_8h_source}{composition\+\_\+decorator\+\_\+abstract.\+h}}.

\Hypertarget{classfourdst_1_1composition_1_1_composition_decorator_aaf47cdfcb7feb3991d6e151bbf2521ff}\index{fourdst::composition::CompositionDecorator@{fourdst::composition::CompositionDecorator}!end@{end}}
\index{end@{end}!fourdst::composition::CompositionDecorator@{fourdst::composition::CompositionDecorator}}
\doxysubsubsection{\texorpdfstring{end()}{end()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily \label{classfourdst_1_1composition_1_1_composition_decorator_aaf47cdfcb7feb3991d6e151bbf2521ff} 
\mbox{\hyperlink{classfourdst_1_1composition_1_1detail_1_1_composition_iterator}{detail\+::\+Composition\+Iterator}}$<$ false $>$ fourdst\+::composition\+::\+Composition\+Decorator\+::end (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [nodiscard]}, {\ttfamily [override]}, {\ttfamily [virtual]}}



Implements \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_abstract_a9f903ec8d0444c7ed9178c09de902176}{fourdst\+::composition\+::\+Composition\+Abstract}}.



Reimplemented in \mbox{\hyperlink{classfourdst_1_1composition_1_1_masked_composition_aae6a6799ee6877064728bd880348420d}{fourdst\+::composition\+::\+Masked\+Composition}}.



Definition at line \mbox{\hyperlink{composition__decorator__abstract_8h_source_l00042}{42}} of file \mbox{\hyperlink{composition__decorator__abstract_8h_source}{composition\+\_\+decorator\+\_\+abstract.\+h}}.

\Hypertarget{classfourdst_1_1composition_1_1_composition_decorator_a39f1df55aff6650c653e62c0e9a2cc5e}\index{fourdst::composition::CompositionDecorator@{fourdst::composition::CompositionDecorator}!getElectronAbundance@{getElectronAbundance}}
\index{getElectronAbundance@{getElectronAbundance}!fourdst::composition::CompositionDecorator@{fourdst::composition::CompositionDecorator}}
\doxysubsubsection{\texorpdfstring{getElectronAbundance()}{getElectronAbundance()}}
{\footnotesize\ttfamily \label{classfourdst_1_1composition_1_1_composition_decorator_a39f1df55aff6650c653e62c0e9a2cc5e} 
double fourdst\+::composition\+::\+Composition\+Decorator\+::get\+Electron\+Abundance (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [nodiscard]}, {\ttfamily [override]}, {\ttfamily [virtual]}, {\ttfamily [noexcept]}}



Get the electron abundance of the composition. 

\begin{DoxyReturn}{Returns}
The electron abundance. 
\end{DoxyReturn}


Implements \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_abstract_ad0fcf2e51cca02c4224241828335db1a}{fourdst\+::composition\+::\+Composition\+Abstract}}.



Reimplemented in \mbox{\hyperlink{classfourdst_1_1composition_1_1_masked_composition_a38fc871469f94b3c07ba18a00548085d}{fourdst\+::composition\+::\+Masked\+Composition}}.



Definition at line \mbox{\hyperlink{composition__decorator__abstract_8h_source_l00033}{33}} of file \mbox{\hyperlink{composition__decorator__abstract_8h_source}{composition\+\_\+decorator\+\_\+abstract.\+h}}.

\Hypertarget{classfourdst_1_1composition_1_1_composition_decorator_a8c1a4cd69465ef5b65bea547ed919ca5}\index{fourdst::composition::CompositionDecorator@{fourdst::composition::CompositionDecorator}!getMassFraction@{getMassFraction}}
\index{getMassFraction@{getMassFraction}!fourdst::composition::CompositionDecorator@{fourdst::composition::CompositionDecorator}}
\doxysubsubsection{\texorpdfstring{getMassFraction()}{getMassFraction()}\hspace{0.1cm}{\footnotesize\ttfamily [1/3]}}
{\footnotesize\ttfamily \label{classfourdst_1_1composition_1_1_composition_decorator_a8c1a4cd69465ef5b65bea547ed919ca5} 
std\+::unordered\+\_\+map$<$ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{atomic\+::\+Species}}, double $>$ fourdst\+::composition\+::\+Composition\+Decorator\+::get\+Mass\+Fraction (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [nodiscard]}, {\ttfamily [override]}, {\ttfamily [virtual]}, {\ttfamily [noexcept]}}



Get the mass fraction for all registered symbols. 

\begin{DoxyReturn}{Returns}
An unordered map from symbol to mass fraction. 
\end{DoxyReturn}


Implements \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_abstract_a3e3248162611754ca4c54b9979f6664d}{fourdst\+::composition\+::\+Composition\+Abstract}}.



Reimplemented in \mbox{\hyperlink{classfourdst_1_1composition_1_1_masked_composition_a2383b69a4b1dbe1c7be01bb826b06c07}{fourdst\+::composition\+::\+Masked\+Composition}}.



Definition at line \mbox{\hyperlink{composition__decorator__abstract_8h_source_l00024}{24}} of file \mbox{\hyperlink{composition__decorator__abstract_8h_source}{composition\+\_\+decorator\+\_\+abstract.\+h}}.

\Hypertarget{classfourdst_1_1composition_1_1_composition_decorator_a12a5cdb232ce4ce30980a016d20b4a43}\index{fourdst::composition::CompositionDecorator@{fourdst::composition::CompositionDecorator}!getMassFraction@{getMassFraction}}
\index{getMassFraction@{getMassFraction}!fourdst::composition::CompositionDecorator@{fourdst::composition::CompositionDecorator}}
\doxysubsubsection{\texorpdfstring{getMassFraction()}{getMassFraction()}\hspace{0.1cm}{\footnotesize\ttfamily [2/3]}}
{\footnotesize\ttfamily \label{classfourdst_1_1composition_1_1_composition_decorator_a12a5cdb232ce4ce30980a016d20b4a43} 
double fourdst\+::composition\+::\+Composition\+Decorator\+::get\+Mass\+Fraction (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{atomic\+::\+Species}} \&}]{species}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [nodiscard]}, {\ttfamily [override]}, {\ttfamily [virtual]}}



Get the mass fraction for a given species. 


\begin{DoxyParams}{Parameters}
{\em species} & The atomic species. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
The mass fraction for the species. 
\end{DoxyReturn}


Implements \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_abstract_a0396f17ba252d053c0126323a76e9142}{fourdst\+::composition\+::\+Composition\+Abstract}}.



Reimplemented in \mbox{\hyperlink{classfourdst_1_1composition_1_1_masked_composition_a81cab92e09924db1804e9b943611648a}{fourdst\+::composition\+::\+Masked\+Composition}}.



Definition at line \mbox{\hyperlink{composition__decorator__abstract_8h_source_l00027}{27}} of file \mbox{\hyperlink{composition__decorator__abstract_8h_source}{composition\+\_\+decorator\+\_\+abstract.\+h}}.

\Hypertarget{classfourdst_1_1composition_1_1_composition_decorator_a52591cb38ab7712fc459eeb48b9d2eaf}\index{fourdst::composition::CompositionDecorator@{fourdst::composition::CompositionDecorator}!getMassFraction@{getMassFraction}}
\index{getMassFraction@{getMassFraction}!fourdst::composition::CompositionDecorator@{fourdst::composition::CompositionDecorator}}
\doxysubsubsection{\texorpdfstring{getMassFraction()}{getMassFraction()}\hspace{0.1cm}{\footnotesize\ttfamily [3/3]}}
{\footnotesize\ttfamily \label{classfourdst_1_1composition_1_1_composition_decorator_a52591cb38ab7712fc459eeb48b9d2eaf} 
double fourdst\+::composition\+::\+Composition\+Decorator\+::get\+Mass\+Fraction (\begin{DoxyParamCaption}\item[{const std\+::string \&}]{symbol}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [nodiscard]}, {\ttfamily [override]}, {\ttfamily [virtual]}}



Get the mass fraction for a given symbol. 


\begin{DoxyParams}{Parameters}
{\em symbol} & The chemical symbol. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
The mass fraction for the symbol. 
\end{DoxyReturn}


Implements \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_abstract_a0ebe22344f785e5db693e04b9b598a5a}{fourdst\+::composition\+::\+Composition\+Abstract}}.



Reimplemented in \mbox{\hyperlink{classfourdst_1_1composition_1_1_masked_composition_ab2a8d9eb543eb712f9a0bbabcc94383a}{fourdst\+::composition\+::\+Masked\+Composition}}.



Definition at line \mbox{\hyperlink{composition__decorator__abstract_8h_source_l00026}{26}} of file \mbox{\hyperlink{composition__decorator__abstract_8h_source}{composition\+\_\+decorator\+\_\+abstract.\+h}}.

\Hypertarget{classfourdst_1_1composition_1_1_composition_decorator_a4d2795fa73ec3f5185232d4cca5684a6}\index{fourdst::composition::CompositionDecorator@{fourdst::composition::CompositionDecorator}!getMassFractionVector@{getMassFractionVector}}
\index{getMassFractionVector@{getMassFractionVector}!fourdst::composition::CompositionDecorator@{fourdst::composition::CompositionDecorator}}
\doxysubsubsection{\texorpdfstring{getMassFractionVector()}{getMassFractionVector()}}
{\footnotesize\ttfamily \label{classfourdst_1_1composition_1_1_composition_decorator_a4d2795fa73ec3f5185232d4cca5684a6} 
std\+::vector$<$ double $>$ fourdst\+::composition\+::\+Composition\+Decorator\+::get\+Mass\+Fraction\+Vector (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [nodiscard]}, {\ttfamily [override]}, {\ttfamily [virtual]}, {\ttfamily [noexcept]}}



Get the mass fraction as a vector. 

\begin{DoxyReturn}{Returns}
A vector of mass fractions for all species. 
\end{DoxyReturn}


Implements \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_abstract_a752af872347c612bf3b43b1711c2cfc0}{fourdst\+::composition\+::\+Composition\+Abstract}}.



Reimplemented in \mbox{\hyperlink{classfourdst_1_1composition_1_1_masked_composition_a7655d278224486e762d22d0501187f58}{fourdst\+::composition\+::\+Masked\+Composition}}.



Definition at line \mbox{\hyperlink{composition__decorator__abstract_8h_source_l00034}{34}} of file \mbox{\hyperlink{composition__decorator__abstract_8h_source}{composition\+\_\+decorator\+\_\+abstract.\+h}}.

\Hypertarget{classfourdst_1_1composition_1_1_composition_decorator_a3b8f0f8fd75888d001177deff39f7405}\index{fourdst::composition::CompositionDecorator@{fourdst::composition::CompositionDecorator}!getMeanParticleMass@{getMeanParticleMass}}
\index{getMeanParticleMass@{getMeanParticleMass}!fourdst::composition::CompositionDecorator@{fourdst::composition::CompositionDecorator}}
\doxysubsubsection{\texorpdfstring{getMeanParticleMass()}{getMeanParticleMass()}}
{\footnotesize\ttfamily \label{classfourdst_1_1composition_1_1_composition_decorator_a3b8f0f8fd75888d001177deff39f7405} 
double fourdst\+::composition\+::\+Composition\+Decorator\+::get\+Mean\+Particle\+Mass (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [nodiscard]}, {\ttfamily [override]}, {\ttfamily [virtual]}, {\ttfamily [noexcept]}}



Get the mean particle mass of the composition. 

\begin{DoxyReturn}{Returns}
The mean particle mass. 
\end{DoxyReturn}


Implements \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_abstract_afedcef16ed403b95ce7f1e6756aa46e8}{fourdst\+::composition\+::\+Composition\+Abstract}}.



Reimplemented in \mbox{\hyperlink{classfourdst_1_1composition_1_1_masked_composition_a3f50005318f2aa7bf7c3cd5b1d2aef7a}{fourdst\+::composition\+::\+Masked\+Composition}}.



Definition at line \mbox{\hyperlink{composition__decorator__abstract_8h_source_l00032}{32}} of file \mbox{\hyperlink{composition__decorator__abstract_8h_source}{composition\+\_\+decorator\+\_\+abstract.\+h}}.

\Hypertarget{classfourdst_1_1composition_1_1_composition_decorator_a57a1cc37e96234477b21866881fbdbaa}\index{fourdst::composition::CompositionDecorator@{fourdst::composition::CompositionDecorator}!getMolarAbundance@{getMolarAbundance}}
\index{getMolarAbundance@{getMolarAbundance}!fourdst::composition::CompositionDecorator@{fourdst::composition::CompositionDecorator}}
\doxysubsubsection{\texorpdfstring{getMolarAbundance()}{getMolarAbundance()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily \label{classfourdst_1_1composition_1_1_composition_decorator_a57a1cc37e96234477b21866881fbdbaa} 
double fourdst\+::composition\+::\+Composition\+Decorator\+::get\+Molar\+Abundance (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{atomic\+::\+Species}} \&}]{species}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [nodiscard]}, {\ttfamily [override]}, {\ttfamily [virtual]}}



Get the molar abundance for a given species. 


\begin{DoxyParams}{Parameters}
{\em species} & The atomic species. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
The molar abundance for the species. 
\end{DoxyReturn}


Implements \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_abstract_adf861bd58e80025b021af2949b41d126}{fourdst\+::composition\+::\+Composition\+Abstract}}.



Reimplemented in \mbox{\hyperlink{classfourdst_1_1composition_1_1_masked_composition_a9766e12e53e504aab985e46dc4e0d6d6}{fourdst\+::composition\+::\+Masked\+Composition}}.



Definition at line \mbox{\hyperlink{composition__decorator__abstract_8h_source_l00031}{31}} of file \mbox{\hyperlink{composition__decorator__abstract_8h_source}{composition\+\_\+decorator\+\_\+abstract.\+h}}.

\Hypertarget{classfourdst_1_1composition_1_1_composition_decorator_a0c46d440cafd9ae2d04589ece5fd41fb}\index{fourdst::composition::CompositionDecorator@{fourdst::composition::CompositionDecorator}!getMolarAbundance@{getMolarAbundance}}
\index{getMolarAbundance@{getMolarAbundance}!fourdst::composition::CompositionDecorator@{fourdst::composition::CompositionDecorator}}
\doxysubsubsection{\texorpdfstring{getMolarAbundance()}{getMolarAbundance()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily \label{classfourdst_1_1composition_1_1_composition_decorator_a0c46d440cafd9ae2d04589ece5fd41fb} 
double fourdst\+::composition\+::\+Composition\+Decorator\+::get\+Molar\+Abundance (\begin{DoxyParamCaption}\item[{const std\+::string \&}]{symbol}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [nodiscard]}, {\ttfamily [override]}, {\ttfamily [virtual]}}



Get the molar abundance for a given symbol. 


\begin{DoxyParams}{Parameters}
{\em symbol} & The chemical symbol. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
The molar abundance for the symbol. 
\end{DoxyReturn}


Implements \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_abstract_a29613d8197cee96f764aeeaa3b7286f8}{fourdst\+::composition\+::\+Composition\+Abstract}}.



Reimplemented in \mbox{\hyperlink{classfourdst_1_1composition_1_1_masked_composition_a3064af4fb0b59dce5b484d5657d25506}{fourdst\+::composition\+::\+Masked\+Composition}}.



Definition at line \mbox{\hyperlink{composition__decorator__abstract_8h_source_l00030}{30}} of file \mbox{\hyperlink{composition__decorator__abstract_8h_source}{composition\+\_\+decorator\+\_\+abstract.\+h}}.

\Hypertarget{classfourdst_1_1composition_1_1_composition_decorator_a80e528239b4a197985e6993c8b6dab48}\index{fourdst::composition::CompositionDecorator@{fourdst::composition::CompositionDecorator}!getMolarAbundanceVector@{getMolarAbundanceVector}}
\index{getMolarAbundanceVector@{getMolarAbundanceVector}!fourdst::composition::CompositionDecorator@{fourdst::composition::CompositionDecorator}}
\doxysubsubsection{\texorpdfstring{getMolarAbundanceVector()}{getMolarAbundanceVector()}}
{\footnotesize\ttfamily \label{classfourdst_1_1composition_1_1_composition_decorator_a80e528239b4a197985e6993c8b6dab48} 
std\+::vector$<$ double $>$ fourdst\+::composition\+::\+Composition\+Decorator\+::get\+Molar\+Abundance\+Vector (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [nodiscard]}, {\ttfamily [override]}, {\ttfamily [virtual]}, {\ttfamily [noexcept]}}



Get the molar abundance as a vector. 

\begin{DoxyReturn}{Returns}
A vector of molar abundances for all species. 
\end{DoxyReturn}


Implements \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_abstract_a657c12d36b2f44e44c32e86d5296c063}{fourdst\+::composition\+::\+Composition\+Abstract}}.



Reimplemented in \mbox{\hyperlink{classfourdst_1_1composition_1_1_masked_composition_ac2f827bedae5405ebab7108b2e4397c5}{fourdst\+::composition\+::\+Masked\+Composition}}.



Definition at line \mbox{\hyperlink{composition__decorator__abstract_8h_source_l00036}{36}} of file \mbox{\hyperlink{composition__decorator__abstract_8h_source}{composition\+\_\+decorator\+\_\+abstract.\+h}}.

\Hypertarget{classfourdst_1_1composition_1_1_composition_decorator_a66724877d66017bac3dc3cc784dda57c}\index{fourdst::composition::CompositionDecorator@{fourdst::composition::CompositionDecorator}!getNumberFraction@{getNumberFraction}}
\index{getNumberFraction@{getNumberFraction}!fourdst::composition::CompositionDecorator@{fourdst::composition::CompositionDecorator}}
\doxysubsubsection{\texorpdfstring{getNumberFraction()}{getNumberFraction()}\hspace{0.1cm}{\footnotesize\ttfamily [1/3]}}
{\footnotesize\ttfamily \label{classfourdst_1_1composition_1_1_composition_decorator_a66724877d66017bac3dc3cc784dda57c} 
std\+::unordered\+\_\+map$<$ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{atomic\+::\+Species}}, double $>$ fourdst\+::composition\+::\+Composition\+Decorator\+::get\+Number\+Fraction (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [nodiscard]}, {\ttfamily [override]}, {\ttfamily [virtual]}, {\ttfamily [noexcept]}}



Get the number fraction for all registered symbols. 

\begin{DoxyReturn}{Returns}
An unordered map from symbol to number fraction. 
\end{DoxyReturn}


Implements \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_abstract_a65bae043ffbf4514b2593ccb63c6e265}{fourdst\+::composition\+::\+Composition\+Abstract}}.



Reimplemented in \mbox{\hyperlink{classfourdst_1_1composition_1_1_masked_composition_a2c299c44f385b65202ed0d475402562a}{fourdst\+::composition\+::\+Masked\+Composition}}.



Definition at line \mbox{\hyperlink{composition__decorator__abstract_8h_source_l00025}{25}} of file \mbox{\hyperlink{composition__decorator__abstract_8h_source}{composition\+\_\+decorator\+\_\+abstract.\+h}}.

\Hypertarget{classfourdst_1_1composition_1_1_composition_decorator_a92c3d23d632f242e8b5526b343617f67}\index{fourdst::composition::CompositionDecorator@{fourdst::composition::CompositionDecorator}!getNumberFraction@{getNumberFraction}}
\index{getNumberFraction@{getNumberFraction}!fourdst::composition::CompositionDecorator@{fourdst::composition::CompositionDecorator}}
\doxysubsubsection{\texorpdfstring{getNumberFraction()}{getNumberFraction()}\hspace{0.1cm}{\footnotesize\ttfamily [2/3]}}
{\footnotesize\ttfamily \label{classfourdst_1_1composition_1_1_composition_decorator_a92c3d23d632f242e8b5526b343617f67} 
double fourdst\+::composition\+::\+Composition\+Decorator\+::get\+Number\+Fraction (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{atomic\+::\+Species}} \&}]{species}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [nodiscard]}, {\ttfamily [override]}, {\ttfamily [virtual]}}



Get the number fraction for a given species. 


\begin{DoxyParams}{Parameters}
{\em species} & The atomic species. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
The number fraction for the species. 
\end{DoxyReturn}


Implements \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_abstract_a71b351d6e69cf0d7e7c43409e1b13c4c}{fourdst\+::composition\+::\+Composition\+Abstract}}.



Reimplemented in \mbox{\hyperlink{classfourdst_1_1composition_1_1_masked_composition_a7cbb41a5b9e8d49c85bcbc821c3ff47e}{fourdst\+::composition\+::\+Masked\+Composition}}.



Definition at line \mbox{\hyperlink{composition__decorator__abstract_8h_source_l00029}{29}} of file \mbox{\hyperlink{composition__decorator__abstract_8h_source}{composition\+\_\+decorator\+\_\+abstract.\+h}}.

\Hypertarget{classfourdst_1_1composition_1_1_composition_decorator_a0ff3454e625043c76131a1206d9293c6}\index{fourdst::composition::CompositionDecorator@{fourdst::composition::CompositionDecorator}!getNumberFraction@{getNumberFraction}}
\index{getNumberFraction@{getNumberFraction}!fourdst::composition::CompositionDecorator@{fourdst::composition::CompositionDecorator}}
\doxysubsubsection{\texorpdfstring{getNumberFraction()}{getNumberFraction()}\hspace{0.1cm}{\footnotesize\ttfamily [3/3]}}
{\footnotesize\ttfamily \label{classfourdst_1_1composition_1_1_composition_decorator_a0ff3454e625043c76131a1206d9293c6} 
double fourdst\+::composition\+::\+Composition\+Decorator\+::get\+Number\+Fraction (\begin{DoxyParamCaption}\item[{const std\+::string \&}]{symbol}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [nodiscard]}, {\ttfamily [override]}, {\ttfamily [virtual]}}



Get the number fraction for a given symbol. 


\begin{DoxyParams}{Parameters}
{\em symbol} & The chemical symbol. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
The number fraction for the symbol. 
\end{DoxyReturn}


Implements \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_abstract_af490daa6942717605093b4fca3e676b8}{fourdst\+::composition\+::\+Composition\+Abstract}}.



Reimplemented in \mbox{\hyperlink{classfourdst_1_1composition_1_1_masked_composition_af4f65f7cad735494aa5010cf0832f23b}{fourdst\+::composition\+::\+Masked\+Composition}}.



Definition at line \mbox{\hyperlink{composition__decorator__abstract_8h_source_l00028}{28}} of file \mbox{\hyperlink{composition__decorator__abstract_8h_source}{composition\+\_\+decorator\+\_\+abstract.\+h}}.

\Hypertarget{classfourdst_1_1composition_1_1_composition_decorator_a72ffd49c3b3e7f3f22ed28ceb2169cb5}\index{fourdst::composition::CompositionDecorator@{fourdst::composition::CompositionDecorator}!getNumberFractionVector@{getNumberFractionVector}}
\index{getNumberFractionVector@{getNumberFractionVector}!fourdst::composition::CompositionDecorator@{fourdst::composition::CompositionDecorator}}
\doxysubsubsection{\texorpdfstring{getNumberFractionVector()}{getNumberFractionVector()}}
{\footnotesize\ttfamily \label{classfourdst_1_1composition_1_1_composition_decorator_a72ffd49c3b3e7f3f22ed28ceb2169cb5} 
std\+::vector$<$ double $>$ fourdst\+::composition\+::\+Composition\+Decorator\+::get\+Number\+Fraction\+Vector (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [nodiscard]}, {\ttfamily [override]}, {\ttfamily [virtual]}, {\ttfamily [noexcept]}}



Get the number fraction as a vector. 

\begin{DoxyReturn}{Returns}
A vector of number fractions for all species. 
\end{DoxyReturn}


Implements \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_abstract_a83343286d738d101635b2a7f5b7d96ef}{fourdst\+::composition\+::\+Composition\+Abstract}}.



Reimplemented in \mbox{\hyperlink{classfourdst_1_1composition_1_1_masked_composition_ad28b1f5c98bd25378c24c732d74deab4}{fourdst\+::composition\+::\+Masked\+Composition}}.



Definition at line \mbox{\hyperlink{composition__decorator__abstract_8h_source_l00035}{35}} of file \mbox{\hyperlink{composition__decorator__abstract_8h_source}{composition\+\_\+decorator\+\_\+abstract.\+h}}.

\Hypertarget{classfourdst_1_1composition_1_1_composition_decorator_a0cdc50a57e09bf8461839d08eb4ae212}\index{fourdst::composition::CompositionDecorator@{fourdst::composition::CompositionDecorator}!getRegisteredSpecies@{getRegisteredSpecies}}
\index{getRegisteredSpecies@{getRegisteredSpecies}!fourdst::composition::CompositionDecorator@{fourdst::composition::CompositionDecorator}}
\doxysubsubsection{\texorpdfstring{getRegisteredSpecies()}{getRegisteredSpecies()}}
{\footnotesize\ttfamily \label{classfourdst_1_1composition_1_1_composition_decorator_a0cdc50a57e09bf8461839d08eb4ae212} 
const std\+::vector$<$ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{atomic\+::\+Species}} $>$ \& fourdst\+::composition\+::\+Composition\+Decorator\+::get\+Registered\+Species (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [nodiscard]}, {\ttfamily [override]}, {\ttfamily [virtual]}, {\ttfamily [noexcept]}}



Get all registered atomic species in the composition. 

\begin{DoxyReturn}{Returns}
A set of registered atomic species. 
\end{DoxyReturn}


Implements \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_abstract_ad17ae8649860ef4f7a949e7c9143c0ec}{fourdst\+::composition\+::\+Composition\+Abstract}}.



Reimplemented in \mbox{\hyperlink{classfourdst_1_1composition_1_1_masked_composition_a44fddc3b8d34b76114afafbdc9b0ec6d}{fourdst\+::composition\+::\+Masked\+Composition}}.



Definition at line \mbox{\hyperlink{composition__decorator__abstract_8h_source_l00023}{23}} of file \mbox{\hyperlink{composition__decorator__abstract_8h_source}{composition\+\_\+decorator\+\_\+abstract.\+h}}.

\Hypertarget{classfourdst_1_1composition_1_1_composition_decorator_a85acea9a107432dfefcbfffe4c3c7c62}\index{fourdst::composition::CompositionDecorator@{fourdst::composition::CompositionDecorator}!getRegisteredSymbols@{getRegisteredSymbols}}
\index{getRegisteredSymbols@{getRegisteredSymbols}!fourdst::composition::CompositionDecorator@{fourdst::composition::CompositionDecorator}}
\doxysubsubsection{\texorpdfstring{getRegisteredSymbols()}{getRegisteredSymbols()}}
{\footnotesize\ttfamily \label{classfourdst_1_1composition_1_1_composition_decorator_a85acea9a107432dfefcbfffe4c3c7c62} 
std\+::set$<$ std\+::string $>$ fourdst\+::composition\+::\+Composition\+Decorator\+::get\+Registered\+Symbols (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [nodiscard]}, {\ttfamily [override]}, {\ttfamily [virtual]}, {\ttfamily [noexcept]}}



Get all registered chemical symbols in the composition. 

\begin{DoxyReturn}{Returns}
A set of registered chemical symbols. 
\end{DoxyReturn}


Implements \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_abstract_a94c2cadeae32ab19cee42fc1670c4c6c}{fourdst\+::composition\+::\+Composition\+Abstract}}.



Reimplemented in \mbox{\hyperlink{classfourdst_1_1composition_1_1_masked_composition_a9b33507e9820b7fd55209d3624388077}{fourdst\+::composition\+::\+Masked\+Composition}}.



Definition at line \mbox{\hyperlink{composition__decorator__abstract_8h_source_l00022}{22}} of file \mbox{\hyperlink{composition__decorator__abstract_8h_source}{composition\+\_\+decorator\+\_\+abstract.\+h}}.

\Hypertarget{classfourdst_1_1composition_1_1_composition_decorator_a996066b4bf67e415eb2dd3ea7aed68bd}\index{fourdst::composition::CompositionDecorator@{fourdst::composition::CompositionDecorator}!getSpeciesAtIndex@{getSpeciesAtIndex}}
\index{getSpeciesAtIndex@{getSpeciesAtIndex}!fourdst::composition::CompositionDecorator@{fourdst::composition::CompositionDecorator}}
\doxysubsubsection{\texorpdfstring{getSpeciesAtIndex()}{getSpeciesAtIndex()}}
{\footnotesize\ttfamily \label{classfourdst_1_1composition_1_1_composition_decorator_a996066b4bf67e415eb2dd3ea7aed68bd} 
\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{atomic\+::\+Species}} fourdst\+::composition\+::\+Composition\+Decorator\+::get\+Species\+At\+Index (\begin{DoxyParamCaption}\item[{const size\+\_\+t}]{index}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [nodiscard]}, {\ttfamily [override]}, {\ttfamily [virtual]}}



Get the species at a given index. 


\begin{DoxyParams}{Parameters}
{\em index} & The index of the species. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
The atomic species at the specified index. 
\end{DoxyReturn}


Implements \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_abstract_a43138cbf3d399e8f278db742fe1b02a7}{fourdst\+::composition\+::\+Composition\+Abstract}}.



Reimplemented in \mbox{\hyperlink{classfourdst_1_1composition_1_1_masked_composition_acc9d3af0aad6c6209c9aefd94f86996b}{fourdst\+::composition\+::\+Masked\+Composition}}.



Definition at line \mbox{\hyperlink{composition__decorator__abstract_8h_source_l00039}{39}} of file \mbox{\hyperlink{composition__decorator__abstract_8h_source}{composition\+\_\+decorator\+\_\+abstract.\+h}}.

\Hypertarget{classfourdst_1_1composition_1_1_composition_decorator_ab02b459d8ce7f36a0a1c6058c013a75c}\index{fourdst::composition::CompositionDecorator@{fourdst::composition::CompositionDecorator}!getSpeciesIndex@{getSpeciesIndex}}
\index{getSpeciesIndex@{getSpeciesIndex}!fourdst::composition::CompositionDecorator@{fourdst::composition::CompositionDecorator}}
\doxysubsubsection{\texorpdfstring{getSpeciesIndex()}{getSpeciesIndex()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily \label{classfourdst_1_1composition_1_1_composition_decorator_ab02b459d8ce7f36a0a1c6058c013a75c} 
size\+\_\+t fourdst\+::composition\+::\+Composition\+Decorator\+::get\+Species\+Index (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{atomic\+::\+Species}} \&}]{species}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [nodiscard]}, {\ttfamily [override]}, {\ttfamily [virtual]}}



Get the index of a species. 


\begin{DoxyParams}{Parameters}
{\em species} & The atomic species. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
The index of the species. 
\end{DoxyReturn}


Implements \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_abstract_a5d04b801f152f7955b392710275105bc}{fourdst\+::composition\+::\+Composition\+Abstract}}.



Reimplemented in \mbox{\hyperlink{classfourdst_1_1composition_1_1_masked_composition_a395e5b14cd2a9f9d467fea25542f8ebd}{fourdst\+::composition\+::\+Masked\+Composition}}.



Definition at line \mbox{\hyperlink{composition__decorator__abstract_8h_source_l00038}{38}} of file \mbox{\hyperlink{composition__decorator__abstract_8h_source}{composition\+\_\+decorator\+\_\+abstract.\+h}}.

\Hypertarget{classfourdst_1_1composition_1_1_composition_decorator_a9b7e6388d9a73c05ddd34660bde43867}\index{fourdst::composition::CompositionDecorator@{fourdst::composition::CompositionDecorator}!getSpeciesIndex@{getSpeciesIndex}}
\index{getSpeciesIndex@{getSpeciesIndex}!fourdst::composition::CompositionDecorator@{fourdst::composition::CompositionDecorator}}
\doxysubsubsection{\texorpdfstring{getSpeciesIndex()}{getSpeciesIndex()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily \label{classfourdst_1_1composition_1_1_composition_decorator_a9b7e6388d9a73c05ddd34660bde43867} 
size\+\_\+t fourdst\+::composition\+::\+Composition\+Decorator\+::get\+Species\+Index (\begin{DoxyParamCaption}\item[{const std\+::string \&}]{symbol}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [nodiscard]}, {\ttfamily [override]}, {\ttfamily [virtual]}}



Get the index of a species by symbol. 


\begin{DoxyParams}{Parameters}
{\em symbol} & The chemical symbol. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
The index of the species. 
\end{DoxyReturn}


Implements \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_abstract_aebf28eab9c902a285589fe2ab7f3060f}{fourdst\+::composition\+::\+Composition\+Abstract}}.



Reimplemented in \mbox{\hyperlink{classfourdst_1_1composition_1_1_masked_composition_a7277650debc78e081963663557de73eb}{fourdst\+::composition\+::\+Masked\+Composition}}.



Definition at line \mbox{\hyperlink{composition__decorator__abstract_8h_source_l00037}{37}} of file \mbox{\hyperlink{composition__decorator__abstract_8h_source}{composition\+\_\+decorator\+\_\+abstract.\+h}}.

\Hypertarget{classfourdst_1_1composition_1_1_composition_decorator_af70b703b6b946d959cdd5cd15e853a9d}\index{fourdst::composition::CompositionDecorator@{fourdst::composition::CompositionDecorator}!size@{size}}
\index{size@{size}!fourdst::composition::CompositionDecorator@{fourdst::composition::CompositionDecorator}}
\doxysubsubsection{\texorpdfstring{size()}{size()}}
{\footnotesize\ttfamily \label{classfourdst_1_1composition_1_1_composition_decorator_af70b703b6b946d959cdd5cd15e853a9d} 
size\+\_\+t fourdst\+::composition\+::\+Composition\+Decorator\+::size (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [nodiscard]}, {\ttfamily [override]}, {\ttfamily [virtual]}, {\ttfamily [noexcept]}}



Implements \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_abstract_af7ec2eaa16a0c78d19728e32469cec06}{fourdst\+::composition\+::\+Composition\+Abstract}}.



Reimplemented in \mbox{\hyperlink{classfourdst_1_1composition_1_1_masked_composition_a6b6c7a9ad6293558ddc8834d22f4bc62}{fourdst\+::composition\+::\+Masked\+Composition}}.



Definition at line \mbox{\hyperlink{composition__decorator__abstract_8h_source_l00021}{21}} of file \mbox{\hyperlink{composition__decorator__abstract_8h_source}{composition\+\_\+decorator\+\_\+abstract.\+h}}.



\doxysubsection{Member Data Documentation}
\Hypertarget{classfourdst_1_1composition_1_1_composition_decorator_a785a5aeddcc68ce3a5b688d956c4d505}\index{fourdst::composition::CompositionDecorator@{fourdst::composition::CompositionDecorator}!m\_base\_composition@{m\_base\_composition}}
\index{m\_base\_composition@{m\_base\_composition}!fourdst::composition::CompositionDecorator@{fourdst::composition::CompositionDecorator}}
\doxysubsubsection{\texorpdfstring{m\_base\_composition}{m\_base\_composition}}
{\footnotesize\ttfamily \label{classfourdst_1_1composition_1_1_composition_decorator_a785a5aeddcc68ce3a5b688d956c4d505} 
std\+::unique\+\_\+ptr$<$\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_abstract}{Composition\+Abstract}}$>$ fourdst\+::composition\+::\+Composition\+Decorator\+::m\+\_\+base\+\_\+composition\hspace{0.3cm}{\ttfamily [protected]}}



Definition at line \mbox{\hyperlink{composition__decorator__abstract_8h_source_l00047}{47}} of file \mbox{\hyperlink{composition__decorator__abstract_8h_source}{composition\+\_\+decorator\+\_\+abstract.\+h}}.



The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
\item 
src/composition/include/fourdst/composition/decorators/\mbox{\hyperlink{composition__decorator__abstract_8h}{composition\+\_\+decorator\+\_\+abstract.\+h}}\end{DoxyCompactItemize}
