docs(docs): added robust docs
This commit is contained in:
42
docs/latex/Makefile
Normal file
42
docs/latex/Makefile
Normal file
@@ -0,0 +1,42 @@
|
||||
LATEX_CMD?=pdflatex
|
||||
MKIDX_CMD?=makeindex
|
||||
BIBTEX_CMD?=bibtex
|
||||
LATEX_COUNT?=8
|
||||
MANUAL_FILE?=refman
|
||||
|
||||
all: $(MANUAL_FILE).pdf
|
||||
|
||||
pdf: $(MANUAL_FILE).pdf
|
||||
|
||||
$(MANUAL_FILE).pdf: clean $(MANUAL_FILE).tex
|
||||
$(LATEX_CMD) $(MANUAL_FILE) || \
|
||||
if [ $$? != 0 ] ; then \
|
||||
\echo "Please consult $(MANUAL_FILE).log to see the error messages" ; \
|
||||
false; \
|
||||
fi
|
||||
$(MKIDX_CMD) $(MANUAL_FILE).idx
|
||||
$(LATEX_CMD) $(MANUAL_FILE) || \
|
||||
if [ $$? != 0 ] ; then \
|
||||
\echo "Please consult $(MANUAL_FILE).log to see the error messages" ; \
|
||||
false; \
|
||||
fi
|
||||
latex_count=$(LATEX_COUNT) ; \
|
||||
while grep -E -s 'Rerun (LaTeX|to get cross-references right|to get bibliographical references right)' $(MANUAL_FILE).log && [ $$latex_count -gt 0 ] ;\
|
||||
do \
|
||||
echo "Rerunning latex...." ;\
|
||||
$(LATEX_CMD) $(MANUAL_FILE) || \
|
||||
if [ $$? != 0 ] ; then \
|
||||
\echo "Please consult $(MANUAL_FILE).log to see the error messages" ; \
|
||||
false; \
|
||||
fi; \
|
||||
latex_count=`expr $$latex_count - 1` ;\
|
||||
done
|
||||
$(MKIDX_CMD) $(MANUAL_FILE).idx
|
||||
$(LATEX_CMD) $(MANUAL_FILE) || \
|
||||
if [ $$? != 0 ] ; then \
|
||||
\echo "Please consult $(MANUAL_FILE).log to see the error messages" ; \
|
||||
false; \
|
||||
fi
|
||||
|
||||
clean:
|
||||
rm -f *.ps *.dvi *.aux *.toc *.idx *.ind *.ilg *.log *.out *.brf *.blg *.bbl $(MANUAL_FILE).pdf
|
||||
20
docs/latex/annotated.tex
Normal file
20
docs/latex/annotated.tex
Normal file
@@ -0,0 +1,20 @@
|
||||
\doxysection{Class List}
|
||||
Here are the classes, structs, unions and interfaces with brief descriptions\+:\begin{DoxyCompactList}
|
||||
\item\contentsline{section}{\mbox{\hyperlink{structfourdst_1_1composition_1_1_canonical_composition}{fourdst\+::composition\+::\+Canonical\+Composition}} \\*Represents the canonical (X, Y, Z) composition of stellar material }{\pageref{structfourdst_1_1composition_1_1_canonical_composition}}{}
|
||||
\item\contentsline{section}{\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition}{fourdst\+::composition\+::\+Composition}} \\*Manages a collection of chemical species and their abundances }{\pageref{classfourdst_1_1composition_1_1_composition}}{}
|
||||
\item\contentsline{section}{\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry}{fourdst\+::composition\+::\+Composition\+Entry}} \\*Represents a single entry (an isotope) within a composition }{\pageref{structfourdst_1_1composition_1_1_composition_entry}}{}
|
||||
\item\contentsline{section}{\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error}{fourdst\+::composition\+::exceptions\+::\+Composition\+Entry\+Error}} \\*Base class for exceptions related to individual entries within a composition }{\pageref{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error}}{}
|
||||
\item\contentsline{section}{\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error}{fourdst\+::composition\+::exceptions\+::\+Composition\+Error}} \\*Base class for exceptions related to composition objects }{\pageref{classfourdst_1_1composition_1_1exceptions_1_1_composition_error}}{}
|
||||
\item\contentsline{section}{\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_mode_error}{fourdst\+::composition\+::exceptions\+::\+Composition\+Mode\+Error}} \\*Exception thrown due to a conflict in composition modes at the entry level }{\pageref{classfourdst_1_1composition_1_1exceptions_1_1_composition_mode_error}}{}
|
||||
\item\contentsline{section}{\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_not_finalized_error}{fourdst\+::composition\+::exceptions\+::\+Composition\+Not\+Finalized\+Error}} \\*Exception thrown when an operation is attempted on a composition that has not been finalized }{\pageref{classfourdst_1_1composition_1_1exceptions_1_1_composition_not_finalized_error}}{}
|
||||
\item\contentsline{section}{\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_entry_already_initialized_error}{fourdst\+::composition\+::exceptions\+::\+Entry\+Already\+Initialized\+Error}} \\*Exception thrown when attempting to initialize a composition entry that has already been initialized }{\pageref{classfourdst_1_1composition_1_1exceptions_1_1_entry_already_initialized_error}}{}
|
||||
\item\contentsline{section}{\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_failed_to_finalize_composition_error}{fourdst\+::composition\+::exceptions\+::\+Failed\+To\+Finalize\+Composition\+Error}} \\*Exception thrown when the finalization process of a composition fails }{\pageref{classfourdst_1_1composition_1_1exceptions_1_1_failed_to_finalize_composition_error}}{}
|
||||
\item\contentsline{section}{\mbox{\hyperlink{structfourdst_1_1composition_1_1_global_composition}{fourdst\+::composition\+::\+Global\+Composition}} \\*Represents global properties of a finalized composition }{\pageref{structfourdst_1_1composition_1_1_global_composition}}{}
|
||||
\item\contentsline{section}{\mbox{\hyperlink{structstd_1_1hash_3_01fourdst_1_1atomic_1_1_species_01_4}{std\+::hash$<$ fourdst\+::atomic\+::\+Species $>$}} \\*Specialization of {\ttfamily std\+::hash} for {\ttfamily \doxylink{structfourdst_1_1atomic_1_1_species}{fourdst\+::atomic\+::\+Species}} }{\pageref{structstd_1_1hash_3_01fourdst_1_1atomic_1_1_species_01_4}}{}
|
||||
\item\contentsline{section}{\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_composition_error}{fourdst\+::composition\+::exceptions\+::\+Invalid\+Composition\+Error}} \\*Exception thrown when a composition is in an invalid or inconsistent state }{\pageref{classfourdst_1_1composition_1_1exceptions_1_1_invalid_composition_error}}{}
|
||||
\item\contentsline{section}{\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_mixing_mode}{fourdst\+::composition\+::exceptions\+::\+Invalid\+Mixing\+Mode}} \\*Exception thrown for an invalid or unsupported mixing mode }{\pageref{classfourdst_1_1composition_1_1exceptions_1_1_invalid_mixing_mode}}{}
|
||||
\item\contentsline{section}{\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_species_symbol_error}{fourdst\+::composition\+::exceptions\+::\+Invalid\+Species\+Symbol\+Error}} \\*Exception thrown for an invalid chemical species symbol in a composition entry }{\pageref{classfourdst_1_1composition_1_1exceptions_1_1_invalid_species_symbol_error}}{}
|
||||
\item\contentsline{section}{\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_symbol_error}{fourdst\+::composition\+::exceptions\+::\+Invalid\+Symbol\+Error}} \\*Exception thrown when a symbol used in a composition is invalid }{\pageref{classfourdst_1_1composition_1_1exceptions_1_1_invalid_symbol_error}}{}
|
||||
\item\contentsline{section}{\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{fourdst\+::atomic\+::\+Species}} \\*Represents an atomic species (isotope) with its fundamental physical properties }{\pageref{structfourdst_1_1atomic_1_1_species}}{}
|
||||
\item\contentsline{section}{\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_unregistered_symbol_error}{fourdst\+::composition\+::exceptions\+::\+Unregistered\+Symbol\+Error}} \\*Exception thrown when a symbol is used that has not been registered }{\pageref{classfourdst_1_1composition_1_1exceptions_1_1_unregistered_symbol_error}}{}
|
||||
\end{DoxyCompactList}
|
||||
33
docs/latex/atomic_species_8h.tex
Normal file
33
docs/latex/atomic_species_8h.tex
Normal file
@@ -0,0 +1,33 @@
|
||||
\doxysection{src/composition/include/fourdst/composition/atomic\+Species.h File Reference}
|
||||
\hypertarget{atomic_species_8h}{}\label{atomic_species_8h}\index{src/composition/include/fourdst/composition/atomicSpecies.h@{src/composition/include/fourdst/composition/atomicSpecies.h}}
|
||||
{\ttfamily \#include $<$string\+\_\+view$>$}\newline
|
||||
{\ttfamily \#include $<$string$>$}\newline
|
||||
{\ttfamily \#include $<$iostream$>$}\newline
|
||||
{\ttfamily \#include $<$limits$>$}\newline
|
||||
\doxysubsubsection*{Classes}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
struct \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{fourdst\+::atomic\+::\+Species}}
|
||||
\begin{DoxyCompactList}\small\item\em Represents an atomic species (isotope) with its fundamental physical properties. \end{DoxyCompactList}\item
|
||||
struct \mbox{\hyperlink{structstd_1_1hash_3_01fourdst_1_1atomic_1_1_species_01_4}{std\+::hash$<$ fourdst\+::atomic\+::\+Species $>$}}
|
||||
\begin{DoxyCompactList}\small\item\em Specialization of {\ttfamily std\+::hash} for {\ttfamily \doxylink{structfourdst_1_1atomic_1_1_species}{fourdst\+::atomic\+::\+Species}}. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
\doxysubsubsection*{Namespaces}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
namespace \mbox{\hyperlink{namespacefourdst_1_1atomic}{fourdst\+::atomic}}
|
||||
\begin{DoxyCompactList}\small\item\em Contains classes and functions related to atomic data, such as properties of atomic species. \end{DoxyCompactList}\item
|
||||
namespace \mbox{\hyperlink{namespacefourdst}{fourdst}}
|
||||
\end{DoxyCompactItemize}
|
||||
\doxysubsubsection*{Functions}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
double \mbox{\hyperlink{namespacefourdst_1_1atomic_ada037e2130ddb6174ff7934cda49c2ba}{fourdst\+::atomic\+::convert\+\_\+jpi\+\_\+to\+\_\+double}} (const std\+::string \&jpi\+\_\+string)
|
||||
\begin{DoxyCompactList}\small\item\em Converts a spin-\/parity string (JPI string) to a double-\/precision floating-\/point number. \end{DoxyCompactList}\item
|
||||
bool \mbox{\hyperlink{namespacefourdst_1_1atomic_a277fa6e5107f1358e204c807146deeb4}{fourdst\+::atomic\+::operator==}} (const \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{Species}} \&lhs, const \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{Species}} \&rhs)
|
||||
\begin{DoxyCompactList}\small\item\em Equality operator for \doxylink{structfourdst_1_1atomic_1_1_species}{Species}. Compares based on name. \end{DoxyCompactList}\item
|
||||
bool \mbox{\hyperlink{namespacefourdst_1_1atomic_a2b6c699988f0748a0627f447863240ad}{fourdst\+::atomic\+::operator!=}} (const \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{Species}} \&lhs, const \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{Species}} \&rhs)
|
||||
\begin{DoxyCompactList}\small\item\em Inequality operator for \doxylink{structfourdst_1_1atomic_1_1_species}{Species}. Compares based on name. \end{DoxyCompactList}\item
|
||||
bool \mbox{\hyperlink{namespacefourdst_1_1atomic_a34d001fa83e2bac9f8ebd96285d8821a}{fourdst\+::atomic\+::operator$<$}} (const \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{Species}} \&lhs, const \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{Species}} \&rhs)
|
||||
\begin{DoxyCompactList}\small\item\em Less-\/than operator for \doxylink{structfourdst_1_1atomic_1_1_species}{Species}. Compares based on atomic mass. \end{DoxyCompactList}\item
|
||||
bool \mbox{\hyperlink{namespacefourdst_1_1atomic_a289c90cf53fd83e6808768b0befa2c00}{fourdst\+::atomic\+::operator$>$}} (const \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{Species}} \&lhs, const \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{Species}} \&rhs)
|
||||
\begin{DoxyCompactList}\small\item\em Greater-\/than operator for \doxylink{structfourdst_1_1atomic_1_1_species}{Species}. Compares based on atomic mass. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
229
docs/latex/atomic_species_8h_source.tex
Normal file
229
docs/latex/atomic_species_8h_source.tex
Normal file
@@ -0,0 +1,229 @@
|
||||
\doxysection{atomic\+Species.\+h}
|
||||
\hypertarget{atomic_species_8h_source}{}\label{atomic_species_8h_source}\index{src/composition/include/fourdst/composition/atomicSpecies.h@{src/composition/include/fourdst/composition/atomicSpecies.h}}
|
||||
\mbox{\hyperlink{atomic_species_8h}{Go to the documentation of this file.}}
|
||||
\begin{DoxyCode}{0}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00001}00001\ \textcolor{preprocessor}{\#pragma\ once}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00002}00002\ \textcolor{preprocessor}{\#include\ <string\_view>}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00003}00003\ \textcolor{preprocessor}{\#include\ <string>}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00004}00004\ \textcolor{preprocessor}{\#include\ <iostream>}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00005}00005\ \textcolor{preprocessor}{\#include\ <limits>}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00006}00006\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00011}00011\ \textcolor{keyword}{namespace\ }\mbox{\hyperlink{namespacefourdst_1_1atomic}{fourdst::atomic}}\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00017}00017\ \ \ \ \ \textcolor{keyword}{inline}\ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{namespacefourdst_1_1atomic_ada037e2130ddb6174ff7934cda49c2ba}{convert\_jpi\_to\_double}}(\textcolor{keyword}{const}\ std::string\&\ jpi\_string);}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00018}00018\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00048}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{00048}}\ \ \ \ \ \textcolor{keyword}{struct\ }\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a3756508a18b57a60f68f1b0cf58d303c}{Species}}\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00049}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a4f782752e18e8972c66ee7168a06279d}{00049}}\ \ \ \ \ \ \ \ \ std::string\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a4f782752e18e8972c66ee7168a06279d}{m\_name}};\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00050}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a704e9d164033a89d610685c494fd53eb}{00050}}\ \ \ \ \ \ \ \ \ std::string\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a704e9d164033a89d610685c494fd53eb}{m\_el}};\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00051}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a50d5e1c96be4884ccfebde1eec79b6e8}{00051}}\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{int}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a50d5e1c96be4884ccfebde1eec79b6e8}{m\_nz}};\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00052}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a8f0a4eb006c924bc006bb9eb6d3907ac}{00052}}\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{int}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a8f0a4eb006c924bc006bb9eb6d3907ac}{m\_n}};\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00053}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_aae24c637c169f9f5eca03b6dcf8329e0}{00053}}\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{int}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_aae24c637c169f9f5eca03b6dcf8329e0}{m\_z}};\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00054}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a6e7c5ab92da7ab867018da87a14ef3ef}{00054}}\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{int}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a6e7c5ab92da7ab867018da87a14ef3ef}{m\_a}};\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00055}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_acbb5b36d6892ee09e95d774eda235d3c}{00055}}\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_acbb5b36d6892ee09e95d774eda235d3c}{m\_bindingEnergy}};\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00056}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_abe9c5f69d657383e17dd49b41b7e4e15}{00056}}\ \ \ \ \ \ \ \ \ std::string\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_abe9c5f69d657383e17dd49b41b7e4e15}{m\_betaCode}};\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00057}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a0fc7e4b41662fe0a726dd962e9dbae9e}{00057}}\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a0fc7e4b41662fe0a726dd962e9dbae9e}{m\_betaDecayEnergy}};\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00058}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_af76d148ab7be629601a389f5758238ee}{00058}}\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_af76d148ab7be629601a389f5758238ee}{m\_halfLife\_s}};\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00059}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a874bc48272e4f091817bc25a72eebc2d}{00059}}\ \ \ \ \ \ \ \ \ std::string\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a874bc48272e4f091817bc25a72eebc2d}{m\_spinParity}};\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00060}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a545093f4fd3d9ad490a5bea84e950d35}{00060}}\ \ \ \ \ \ \ \ \ std::string\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a545093f4fd3d9ad490a5bea84e950d35}{m\_decayModes}};\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00061}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_ab3e057d426e0d8dbf0134f92fda1c322}{00061}}\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_ab3e057d426e0d8dbf0134f92fda1c322}{m\_atomicMass}};\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00062}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a4c6aa98435227f8257b93311a19c4adf}{00062}}\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a4c6aa98435227f8257b93311a19c4adf}{m\_atomicMassUnc}};\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00063}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_af1d73b936b428aaa29b37c119e3426e7}{00063}}\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_af1d73b936b428aaa29b37c119e3426e7}{m\_spin}}\ =\ 0.0;\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00064}00064\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00085}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a3756508a18b57a60f68f1b0cf58d303c}{00085}}\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a3756508a18b57a60f68f1b0cf58d303c}{Species}}(}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00086}00086\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keyword}{const}\ std::string\_view\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a1fcc01fc978b34ba2531117f10be6741}{name}},}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00087}00087\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keyword}{const}\ std::string\_view\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a326c260a1b53deafcd04c21b2787f6c4}{el}},}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00088}00088\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keyword}{const}\ \textcolor{keywordtype}{int}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_aa5e452accca3a9b4937867044617a032}{nz}},}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00089}00089\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keyword}{const}\ \textcolor{keywordtype}{int}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a957734e413f07adf1d570885c480768d}{n}},}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00090}00090\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keyword}{const}\ \textcolor{keywordtype}{int}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a1d50917a60a1adb2c9912193f214fab0}{z}},}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00091}00091\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keyword}{const}\ \textcolor{keywordtype}{int}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_adc960c98d6e6051940d0a5c0d9a1183d}{a}},}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00092}00092\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keyword}{const}\ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_abeef75170cabef39fdaa6362780ddfc8}{bindingEnergy}},}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00093}00093\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keyword}{const}\ std::string\_view\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a57391049d534ffd1a4b4d6ed63d65ffc}{betaCode}},}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00094}00094\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keyword}{const}\ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a7d0e8a3b3d30fa56bdcc59577fa9ff73}{betaDecayEnergy}},}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00095}00095\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keyword}{const}\ \textcolor{keywordtype}{double}\ halfLife\_s,}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00096}00096\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keyword}{const}\ std::string\_view\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_afcdd2f750d8cf206e3bcc507d57dabb1}{spinParity}},}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00097}00097\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keyword}{const}\ std::string\_view\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_aad5094dfc8317db36468356bbc4a3e2f}{decayModes}},}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00098}00098\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keyword}{const}\ \textcolor{keywordtype}{double}\ atomicMass,}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00099}00099\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keyword}{const}\ \textcolor{keywordtype}{double}\ atomicMassUnc}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00100}00100\ \ \ \ \ \ \ \ \ )\ :}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00101}00101\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a4f782752e18e8972c66ee7168a06279d}{m\_name}}(\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a1fcc01fc978b34ba2531117f10be6741}{name}}),}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00102}00102\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a704e9d164033a89d610685c494fd53eb}{m\_el}}(\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a326c260a1b53deafcd04c21b2787f6c4}{el}}),}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00103}00103\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a50d5e1c96be4884ccfebde1eec79b6e8}{m\_nz}}(\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_aa5e452accca3a9b4937867044617a032}{nz}}),}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00104}00104\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a8f0a4eb006c924bc006bb9eb6d3907ac}{m\_n}}(\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a957734e413f07adf1d570885c480768d}{n}}),}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00105}00105\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_aae24c637c169f9f5eca03b6dcf8329e0}{m\_z}}(\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a1d50917a60a1adb2c9912193f214fab0}{z}}),}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00106}00106\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a6e7c5ab92da7ab867018da87a14ef3ef}{m\_a}}(\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_adc960c98d6e6051940d0a5c0d9a1183d}{a}}),}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00107}00107\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_acbb5b36d6892ee09e95d774eda235d3c}{m\_bindingEnergy}}(\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_abeef75170cabef39fdaa6362780ddfc8}{bindingEnergy}}),}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00108}00108\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_abe9c5f69d657383e17dd49b41b7e4e15}{m\_betaCode}}(\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a57391049d534ffd1a4b4d6ed63d65ffc}{betaCode}}),}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00109}00109\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a0fc7e4b41662fe0a726dd962e9dbae9e}{m\_betaDecayEnergy}}(\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a7d0e8a3b3d30fa56bdcc59577fa9ff73}{betaDecayEnergy}}),}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00110}00110\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_af76d148ab7be629601a389f5758238ee}{m\_halfLife\_s}}(halfLife\_s),}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00111}00111\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a874bc48272e4f091817bc25a72eebc2d}{m\_spinParity}}(\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_afcdd2f750d8cf206e3bcc507d57dabb1}{spinParity}}),}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00112}00112\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a545093f4fd3d9ad490a5bea84e950d35}{m\_decayModes}}(\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_aad5094dfc8317db36468356bbc4a3e2f}{decayModes}}),}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00113}00113\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_ab3e057d426e0d8dbf0134f92fda1c322}{m\_atomicMass}}(atomicMass),}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00114}00114\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a4c6aa98435227f8257b93311a19c4adf}{m\_atomicMassUnc}}(atomicMassUnc)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00115}00115\ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_af1d73b936b428aaa29b37c119e3426e7}{m\_spin}}\ =\ \mbox{\hyperlink{namespacefourdst_1_1atomic_ada037e2130ddb6174ff7934cda49c2ba}{convert\_jpi\_to\_double}}(\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a874bc48272e4f091817bc25a72eebc2d}{m\_spinParity}});}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00116}00116\ \ \ \ \ \ \ \ \ \};}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00117}00117\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00123}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a873551c1ffbdcd6867ab0d1ed34ead0b}{00123}}\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a873551c1ffbdcd6867ab0d1ed34ead0b}{Species}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a3756508a18b57a60f68f1b0cf58d303c}{Species}}\&\ \mbox{\hyperlink{namespacefourdst_1_1atomic_a3f619cc8f8b2cd718a4082c6adb0de90}{species}})\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00124}00124\ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a4f782752e18e8972c66ee7168a06279d}{m\_name}}\ =\ \mbox{\hyperlink{namespacefourdst_1_1atomic_a3f619cc8f8b2cd718a4082c6adb0de90}{species}}.m\_name;}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00125}00125\ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a704e9d164033a89d610685c494fd53eb}{m\_el}}\ =\ \mbox{\hyperlink{namespacefourdst_1_1atomic_a3f619cc8f8b2cd718a4082c6adb0de90}{species}}.m\_el;}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00126}00126\ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a50d5e1c96be4884ccfebde1eec79b6e8}{m\_nz}}\ =\ \mbox{\hyperlink{namespacefourdst_1_1atomic_a3f619cc8f8b2cd718a4082c6adb0de90}{species}}.m\_nz;}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00127}00127\ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a8f0a4eb006c924bc006bb9eb6d3907ac}{m\_n}}\ =\ \mbox{\hyperlink{namespacefourdst_1_1atomic_a3f619cc8f8b2cd718a4082c6adb0de90}{species}}.m\_n;}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00128}00128\ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_aae24c637c169f9f5eca03b6dcf8329e0}{m\_z}}\ =\ \mbox{\hyperlink{namespacefourdst_1_1atomic_a3f619cc8f8b2cd718a4082c6adb0de90}{species}}.m\_z;}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00129}00129\ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a6e7c5ab92da7ab867018da87a14ef3ef}{m\_a}}\ =\ \mbox{\hyperlink{namespacefourdst_1_1atomic_a3f619cc8f8b2cd718a4082c6adb0de90}{species}}.m\_a;}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00130}00130\ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_acbb5b36d6892ee09e95d774eda235d3c}{m\_bindingEnergy}}\ =\ \mbox{\hyperlink{namespacefourdst_1_1atomic_a3f619cc8f8b2cd718a4082c6adb0de90}{species}}.m\_bindingEnergy;}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00131}00131\ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_abe9c5f69d657383e17dd49b41b7e4e15}{m\_betaCode}}\ =\ \mbox{\hyperlink{namespacefourdst_1_1atomic_a3f619cc8f8b2cd718a4082c6adb0de90}{species}}.m\_betaCode;}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00132}00132\ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a0fc7e4b41662fe0a726dd962e9dbae9e}{m\_betaDecayEnergy}}\ =\ \mbox{\hyperlink{namespacefourdst_1_1atomic_a3f619cc8f8b2cd718a4082c6adb0de90}{species}}.m\_betaDecayEnergy;}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00133}00133\ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_af76d148ab7be629601a389f5758238ee}{m\_halfLife\_s}}\ =\ \mbox{\hyperlink{namespacefourdst_1_1atomic_a3f619cc8f8b2cd718a4082c6adb0de90}{species}}.m\_halfLife\_s;}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00134}00134\ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a874bc48272e4f091817bc25a72eebc2d}{m\_spinParity}}\ =\ \mbox{\hyperlink{namespacefourdst_1_1atomic_a3f619cc8f8b2cd718a4082c6adb0de90}{species}}.m\_spinParity;}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00135}00135\ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a545093f4fd3d9ad490a5bea84e950d35}{m\_decayModes}}\ =\ \mbox{\hyperlink{namespacefourdst_1_1atomic_a3f619cc8f8b2cd718a4082c6adb0de90}{species}}.m\_decayModes;}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00136}00136\ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_ab3e057d426e0d8dbf0134f92fda1c322}{m\_atomicMass}}\ =\ \mbox{\hyperlink{namespacefourdst_1_1atomic_a3f619cc8f8b2cd718a4082c6adb0de90}{species}}.m\_atomicMass;}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00137}00137\ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a4c6aa98435227f8257b93311a19c4adf}{m\_atomicMassUnc}}\ =\ \mbox{\hyperlink{namespacefourdst_1_1atomic_a3f619cc8f8b2cd718a4082c6adb0de90}{species}}.m\_atomicMassUnc;}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00138}00138\ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_af1d73b936b428aaa29b37c119e3426e7}{m\_spin}}\ =\ \mbox{\hyperlink{namespacefourdst_1_1atomic_ada037e2130ddb6174ff7934cda49c2ba}{convert\_jpi\_to\_double}}(\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a874bc48272e4f091817bc25a72eebc2d}{m\_spinParity}});}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00139}00139\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00140}00140\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00141}00141\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00146}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_af5bdcc90ddafddfc027f94a98972eca3}{00146}}\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_af5bdcc90ddafddfc027f94a98972eca3}{mass}}()\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00147}00147\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_ab3e057d426e0d8dbf0134f92fda1c322}{m\_atomicMass}};}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00148}00148\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00149}00149\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00154}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_ac041c089469dc8d36548805c81492aca}{00154}}\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_ac041c089469dc8d36548805c81492aca}{massUnc}}()\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00155}00155\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a4c6aa98435227f8257b93311a19c4adf}{m\_atomicMassUnc}};}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00156}00156\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00157}00157\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00162}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a34c4bb95e3c3e29087bc242d83aeefa1}{00162}}\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a34c4bb95e3c3e29087bc242d83aeefa1}{halfLife}}()\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00163}00163\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_af76d148ab7be629601a389f5758238ee}{m\_halfLife\_s}};}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00164}00164\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00165}00165\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00170}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_afcdd2f750d8cf206e3bcc507d57dabb1}{00170}}\ \ \ \ \ \ \ \ \ [[nodiscard]]\ std::string\_view\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_afcdd2f750d8cf206e3bcc507d57dabb1}{spinParity}}()\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00171}00171\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a874bc48272e4f091817bc25a72eebc2d}{m\_spinParity}};}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00172}00172\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00173}00173\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00178}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_aad5094dfc8317db36468356bbc4a3e2f}{00178}}\ \ \ \ \ \ \ \ \ [[nodiscard]]\ std::string\_view\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_aad5094dfc8317db36468356bbc4a3e2f}{decayModes}}()\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00179}00179\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a545093f4fd3d9ad490a5bea84e950d35}{m\_decayModes}};}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00180}00180\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00181}00181\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00186}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_abeef75170cabef39fdaa6362780ddfc8}{00186}}\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_abeef75170cabef39fdaa6362780ddfc8}{bindingEnergy}}()\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00187}00187\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_acbb5b36d6892ee09e95d774eda235d3c}{m\_bindingEnergy}};}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00188}00188\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00189}00189\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00194}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a7d0e8a3b3d30fa56bdcc59577fa9ff73}{00194}}\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a7d0e8a3b3d30fa56bdcc59577fa9ff73}{betaDecayEnergy}}()\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00195}00195\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a0fc7e4b41662fe0a726dd962e9dbae9e}{m\_betaDecayEnergy}};}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00196}00196\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00197}00197\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00202}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a57391049d534ffd1a4b4d6ed63d65ffc}{00202}}\ \ \ \ \ \ \ \ \ [[nodiscard]]\ std::string\_view\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a57391049d534ffd1a4b4d6ed63d65ffc}{betaCode}}()\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00203}00203\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_abe9c5f69d657383e17dd49b41b7e4e15}{m\_betaCode}};}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00204}00204\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00205}00205\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00210}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a1fcc01fc978b34ba2531117f10be6741}{00210}}\ \ \ \ \ \ \ \ \ [[nodiscard]]\ std::string\_view\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a1fcc01fc978b34ba2531117f10be6741}{name}}()\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00211}00211\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a4f782752e18e8972c66ee7168a06279d}{m\_name}};}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00212}00212\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00213}00213\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00218}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a326c260a1b53deafcd04c21b2787f6c4}{00218}}\ \ \ \ \ \ \ \ \ [[nodiscard]]\ std::string\_view\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a326c260a1b53deafcd04c21b2787f6c4}{el}}()\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00219}00219\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a704e9d164033a89d610685c494fd53eb}{m\_el}};}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00220}00220\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00221}00221\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00226}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_aa5e452accca3a9b4937867044617a032}{00226}}\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{int}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_aa5e452accca3a9b4937867044617a032}{nz}}()\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00227}00227\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a50d5e1c96be4884ccfebde1eec79b6e8}{m\_nz}};}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00228}00228\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00229}00229\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00234}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a957734e413f07adf1d570885c480768d}{00234}}\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{int}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a957734e413f07adf1d570885c480768d}{n}}()\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00235}00235\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a8f0a4eb006c924bc006bb9eb6d3907ac}{m\_n}};}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00236}00236\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00237}00237\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00242}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a1d50917a60a1adb2c9912193f214fab0}{00242}}\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{int}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a1d50917a60a1adb2c9912193f214fab0}{z}}()\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00243}00243\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_aae24c637c169f9f5eca03b6dcf8329e0}{m\_z}};}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00244}00244\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00245}00245\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00250}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_adc960c98d6e6051940d0a5c0d9a1183d}{00250}}\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{int}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_adc960c98d6e6051940d0a5c0d9a1183d}{a}}()\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00251}00251\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a6e7c5ab92da7ab867018da87a14ef3ef}{m\_a}};}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00252}00252\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00253}00253\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00258}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a0e5d73c7c629cb08f254f2bc41f6ac4b}{00258}}\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a0e5d73c7c629cb08f254f2bc41f6ac4b}{spin}}()\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00259}00259\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_af1d73b936b428aaa29b37c119e3426e7}{m\_spin}};}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00260}00260\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00261}00261\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00268}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_ad431f09aba3c2d8bafde06a459636965}{00268}}\ \ \ \ \ \ \ \ \ \textcolor{keyword}{friend}\ std::ostream\&\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_ad431f09aba3c2d8bafde06a459636965}{operator<<}}(std::ostream\&\ os,\ \textcolor{keyword}{const}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a3756508a18b57a60f68f1b0cf58d303c}{Species}}\&\ \mbox{\hyperlink{namespacefourdst_1_1atomic_a3f619cc8f8b2cd718a4082c6adb0de90}{species}})\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00269}00269\ \ \ \ \ \ \ \ \ \ \ \ \ os\ <<\ \mbox{\hyperlink{namespacefourdst_1_1atomic_a3f619cc8f8b2cd718a4082c6adb0de90}{species}}.m\_name;}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00270}00270\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ os;}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00271}00271\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00272}00272\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00273}00273\ \ \ \ \ \ \ \ \ \textcolor{keyword}{friend}\ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a7864aa6e0ab9a953d657faf56cc921a1}{operator==}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{Species}}\&\ lhs,\ \textcolor{keyword}{const}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{Species}}\&\ rhs);}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00274}00274\ \ \ \ \ \ \ \ \ \textcolor{keyword}{friend}\ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_ae1cc99d92a460877ec5bc28f13424c04}{operator!=}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{Species}}\&\ lhs,\ \textcolor{keyword}{const}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{Species}}\&\ rhs);}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00275}00275\ \ \ \ \ \ \ \ \ \textcolor{keyword}{friend}\ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_afc74eacd01f350dc20e2c7ec6a35c49b}{operator<}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{Species}}\&\ lhs,\ \textcolor{keyword}{const}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{Species}}\&\ rhs);}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00276}00276\ \ \ \ \ \ \ \ \ \textcolor{keyword}{friend}\ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_ab9503c9331c5746c283faa68a6ef3ef9}{operator>}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{Species}}\&\ lhs,\ \textcolor{keyword}{const}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{Species}}\&\ rhs);}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00277}00277\ \ \ \ \ \};}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00284}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a7864aa6e0ab9a953d657faf56cc921a1}{00284}}\ \ \ \ \ \textcolor{keyword}{inline}\ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{namespacefourdst_1_1atomic_a277fa6e5107f1358e204c807146deeb4}{operator==}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a3756508a18b57a60f68f1b0cf58d303c}{Species}}\&\ lhs,\ \textcolor{keyword}{const}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a3756508a18b57a60f68f1b0cf58d303c}{Species}}\&\ rhs)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00285}00285\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ (lhs.\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a4f782752e18e8972c66ee7168a06279d}{m\_name}}\ ==\ rhs.\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a4f782752e18e8972c66ee7168a06279d}{m\_name}});}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00286}00286\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00293}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_ae1cc99d92a460877ec5bc28f13424c04}{00293}}\ \ \ \ \ \textcolor{keyword}{inline}\ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{namespacefourdst_1_1atomic_a2b6c699988f0748a0627f447863240ad}{operator!=}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a3756508a18b57a60f68f1b0cf58d303c}{Species}}\&\ lhs,\ \textcolor{keyword}{const}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a3756508a18b57a60f68f1b0cf58d303c}{Species}}\&\ rhs)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00294}00294\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ (lhs.\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a4f782752e18e8972c66ee7168a06279d}{m\_name}}\ !=\ rhs.\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a4f782752e18e8972c66ee7168a06279d}{m\_name}});}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00295}00295\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00302}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_afc74eacd01f350dc20e2c7ec6a35c49b}{00302}}\ \ \ \ \ \textcolor{keyword}{inline}\ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{namespacefourdst_1_1atomic_a34d001fa83e2bac9f8ebd96285d8821a}{operator<}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a3756508a18b57a60f68f1b0cf58d303c}{Species}}\&\ lhs,\ \textcolor{keyword}{const}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a3756508a18b57a60f68f1b0cf58d303c}{Species}}\&\ rhs)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00303}00303\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ (lhs.\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_ab3e057d426e0d8dbf0134f92fda1c322}{m\_atomicMass}}\ <\ rhs.\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_ab3e057d426e0d8dbf0134f92fda1c322}{m\_atomicMass}});}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00304}00304\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00311}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_ab9503c9331c5746c283faa68a6ef3ef9}{00311}}\ \ \ \ \ \textcolor{keyword}{inline}\ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{namespacefourdst_1_1atomic_a289c90cf53fd83e6808768b0befa2c00}{operator>}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a3756508a18b57a60f68f1b0cf58d303c}{Species}}\&\ lhs,\ \textcolor{keyword}{const}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a3756508a18b57a60f68f1b0cf58d303c}{Species}}\&\ rhs)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00312}00312\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ (lhs.\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_ab3e057d426e0d8dbf0134f92fda1c322}{m\_atomicMass}}\ >\ rhs.\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_ab3e057d426e0d8dbf0134f92fda1c322}{m\_atomicMass}});}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00313}00313\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00314}00314\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00345}\mbox{\hyperlink{namespacefourdst_1_1atomic_ada037e2130ddb6174ff7934cda49c2ba}{00345}}\ \ \ \ \ \textcolor{keyword}{inline}\ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{namespacefourdst_1_1atomic_ada037e2130ddb6174ff7934cda49c2ba}{convert\_jpi\_to\_double}}(\textcolor{keyword}{const}\ std::string\&\ jpi\_string)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00346}00346\ \ \ \ \ \ \ \ \ std::string\ s\ =\ jpi\_string;}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00347}00347\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00348}00348\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (s.empty())\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00349}00349\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ std::numeric\_limits<double>::quiet\_NaN();}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00350}00350\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00351}00351\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00352}00352\ \ \ \ \ \ \ \ \ std::erase\_if(s,\ [](\textcolor{keyword}{const}\ \textcolor{keywordtype}{char}\ c)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00353}00353\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ c\ ==\ \textcolor{charliteral}{'('}\ ||\ c\ ==\ \textcolor{charliteral}{')'}\ ||\ c\ ==\ \textcolor{charliteral}{'*'}\ ||\ c\ ==\ \textcolor{charliteral}{'\#'};}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00354}00354\ \ \ \ \ \ \ \ \ \});}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00355}00355\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00356}00356\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (s\ ==\ \textcolor{stringliteral}{"{}+"{}}\ ||\ s\ ==\ \textcolor{stringliteral}{"{}-\/"{}})\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00357}00357\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ 0.0;}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00358}00358\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00359}00359\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00360}00360\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (\textcolor{keyword}{const}\ \textcolor{keywordtype}{size\_t}\ comma\_pos\ =\ s.find(\textcolor{charliteral}{','});\ comma\_pos\ !=\ std::string::npos)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00361}00361\ \ \ \ \ \ \ \ \ \ \ \ \ s\ =\ s.substr(0,\ comma\_pos);}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00362}00362\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00363}00363\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00364}00364\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (!s.empty()\ \&\&\ (s.back()\ ==\ \textcolor{charliteral}{'+'}\ ||\ s.back()\ ==\ \textcolor{charliteral}{'-\/'}))\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00365}00365\ \ \ \ \ \ \ \ \ \ \ \ \ s.pop\_back();}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00366}00366\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00367}00367\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00368}00368\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (s.empty())\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00369}00369\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ std::numeric\_limits<double>::quiet\_NaN();}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00370}00370\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00371}00371\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00372}00372\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{try}\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00373}00373\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (\textcolor{keywordtype}{size\_t}\ slash\_pos\ =\ s.find(\textcolor{charliteral}{'/'});\ slash\_pos\ !=\ std::string::npos)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00374}00374\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (slash\_pos\ ==\ 0)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00375}00375\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ s\ =\ \textcolor{stringliteral}{"{}1"{}}\ +\ s;}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00376}00376\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ slash\_pos\ =\ 1;}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00377}00377\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00378}00378\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keyword}{const}\ std::string\ numerator\_str\ =\ s.substr(0,\ slash\_pos);}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00379}00379\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keyword}{const}\ std::string\ denominator\_str\ =\ s.substr(slash\_pos\ +\ 1);}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00380}00380\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (denominator\_str.empty())\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00381}00381\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ std::numeric\_limits<double>::quiet\_NaN();}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00382}00382\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00383}00383\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keyword}{const}\ \textcolor{keywordtype}{double}\ numerator\ =\ std::stod(numerator\_str);}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00384}00384\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keyword}{const}\ \textcolor{keywordtype}{double}\ denominator\ =\ std::stod(denominator\_str);}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00385}00385\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (denominator\ ==\ 0.0)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00386}00386\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ std::numeric\_limits<double>::quiet\_NaN();}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00387}00387\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00388}00388\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ numerator\ /\ denominator;}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00389}00389\ \ \ \ \ \ \ \ \ \ \ \ \ \}\ \textcolor{keywordflow}{else}\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00390}00390\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ std::stod(s);}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00391}00391\ \ \ \ \ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00392}00392\ \ \ \ \ \ \ \ \ \}\ \textcolor{keywordflow}{catch}\ (\textcolor{keyword}{const}\ std::invalid\_argument\&)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00393}00393\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ std::numeric\_limits<double>::quiet\_NaN();}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00394}00394\ \ \ \ \ \ \ \ \ \}\ \textcolor{keywordflow}{catch}\ (\textcolor{keyword}{const}\ std::out\_of\_range\&)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00395}00395\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ std::numeric\_limits<double>::quiet\_NaN();}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00396}00396\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00397}00397\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00398}00398\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00399}00399\ \}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00400}00400\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00424}00424\ \textcolor{keyword}{template}<>}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00425}\mbox{\hyperlink{structstd_1_1hash_3_01fourdst_1_1atomic_1_1_species_01_4}{00425}}\ \textcolor{keyword}{struct\ }std::hash<\mbox{\hyperlink{namespacefourdst}{fourdst}}::atomic::Species>\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00431}\mbox{\hyperlink{structstd_1_1hash_3_01fourdst_1_1atomic_1_1_species_01_4_afa44fa4cf54e7f6283d6e2ce93c63b6a}{00431}}\ \ \ \ \ \textcolor{keywordtype}{size\_t}\ \mbox{\hyperlink{structstd_1_1hash_3_01fourdst_1_1atomic_1_1_species_01_4_afa44fa4cf54e7f6283d6e2ce93c63b6a}{operator()}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{fourdst::atomic::Species}}\&\ s)\ \textcolor{keyword}{const}\ \textcolor{keyword}{noexcept}\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00432}00432\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ std::hash<std::string>()(s.m\_name);}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00433}00433\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00434}00434\ \};\ \textcolor{comment}{//\ namespace\ std}}
|
||||
|
||||
\end{DoxyCode}
|
||||
1788
docs/latex/classfourdst_1_1composition_1_1_composition.tex
Normal file
1788
docs/latex/classfourdst_1_1composition_1_1_composition.tex
Normal file
File diff suppressed because it is too large
Load Diff
Binary file not shown.
@@ -0,0 +1,102 @@
|
||||
\doxysection{fourdst\+::composition\+::exceptions\+::Composition\+Entry\+Error Class Reference}
|
||||
\hypertarget{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error}{}\label{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error}\index{fourdst::composition::exceptions::CompositionEntryError@{fourdst::composition::exceptions::CompositionEntryError}}
|
||||
|
||||
|
||||
Base class for exceptions related to individual entries within a composition.
|
||||
|
||||
|
||||
|
||||
|
||||
{\ttfamily \#include $<$exceptions\+\_\+composition.\+h$>$}
|
||||
|
||||
Inheritance diagram for fourdst\+::composition\+::exceptions\+::Composition\+Entry\+Error\+:\begin{figure}[H]
|
||||
\begin{center}
|
||||
\leavevmode
|
||||
\includegraphics[height=1.555556cm]{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error}
|
||||
\end{center}
|
||||
\end{figure}
|
||||
\doxysubsubsection*{Public Member Functions}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error_af5ea3395201839d670bdcfc61b19abb1}{Composition\+Entry\+Error}} (const std\+::string \&message)
|
||||
\begin{DoxyCompactList}\small\item\em Constructs a \doxylink{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error}{Composition\+Entry\+Error} with an error message. \end{DoxyCompactList}\item
|
||||
const char \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error_aeba45905c6dc1a47ec1ad3f978f94e57}{what}} () const noexcept override
|
||||
\begin{DoxyCompactList}\small\item\em Returns the error message. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
\doxysubsubsection*{Protected Attributes}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
std\+::string \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error_a41208f0821385ed6f168c66f5863a79d}{m\+\_\+message}}
|
||||
\begin{DoxyCompactList}\small\item\em The error message. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
|
||||
|
||||
\doxysubsection{Detailed Description}
|
||||
Base class for exceptions related to individual entries within a composition.
|
||||
|
||||
This exception is thrown for errors specific to a single component or entry in a composition, such as an invalid species symbol or duplicate initialization.
|
||||
|
||||
Definition at line \mbox{\hyperlink{exceptions__composition_8h_source_l00044}{44}} of file \mbox{\hyperlink{exceptions__composition_8h_source}{exceptions\+\_\+composition.\+h}}.
|
||||
|
||||
|
||||
|
||||
\doxysubsection{Constructor \& Destructor Documentation}
|
||||
\Hypertarget{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error_af5ea3395201839d670bdcfc61b19abb1}\index{fourdst::composition::exceptions::CompositionEntryError@{fourdst::composition::exceptions::CompositionEntryError}!CompositionEntryError@{CompositionEntryError}}
|
||||
\index{CompositionEntryError@{CompositionEntryError}!fourdst::composition::exceptions::CompositionEntryError@{fourdst::composition::exceptions::CompositionEntryError}}
|
||||
\doxysubsubsection{\texorpdfstring{CompositionEntryError()}{CompositionEntryError()}}
|
||||
{\footnotesize\ttfamily \label{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error_af5ea3395201839d670bdcfc61b19abb1}
|
||||
fourdst\+::composition\+::exceptions\+::\+Composition\+Entry\+Error\+::\+Composition\+Entry\+Error (\begin{DoxyParamCaption}\item[{const std\+::string \&}]{message}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [explicit]}}
|
||||
|
||||
|
||||
|
||||
Constructs a \doxylink{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error}{Composition\+Entry\+Error} with an error message.
|
||||
|
||||
|
||||
\begin{DoxyParams}{Parameters}
|
||||
{\em message} & The error message. \\
|
||||
\hline
|
||||
\end{DoxyParams}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{exceptions__composition_8h_source_l00055}{55}} of file \mbox{\hyperlink{exceptions__composition_8h_source}{exceptions\+\_\+composition.\+h}}.
|
||||
|
||||
|
||||
|
||||
\doxysubsection{Member Function Documentation}
|
||||
\Hypertarget{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error_aeba45905c6dc1a47ec1ad3f978f94e57}\index{fourdst::composition::exceptions::CompositionEntryError@{fourdst::composition::exceptions::CompositionEntryError}!what@{what}}
|
||||
\index{what@{what}!fourdst::composition::exceptions::CompositionEntryError@{fourdst::composition::exceptions::CompositionEntryError}}
|
||||
\doxysubsubsection{\texorpdfstring{what()}{what()}}
|
||||
{\footnotesize\ttfamily \label{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error_aeba45905c6dc1a47ec1ad3f978f94e57}
|
||||
const char \texorpdfstring{$\ast$}{*} fourdst\+::composition\+::exceptions\+::\+Composition\+Entry\+Error\+::what (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [override]}, {\ttfamily [noexcept]}}
|
||||
|
||||
|
||||
|
||||
Returns the error message.
|
||||
|
||||
\begin{DoxyReturn}{Returns}
|
||||
A C-\/style string containing the error message.
|
||||
\end{DoxyReturn}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{exceptions__composition_8h_source_l00062}{62}} of file \mbox{\hyperlink{exceptions__composition_8h_source}{exceptions\+\_\+composition.\+h}}.
|
||||
|
||||
|
||||
|
||||
\doxysubsection{Member Data Documentation}
|
||||
\Hypertarget{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error_a41208f0821385ed6f168c66f5863a79d}\index{fourdst::composition::exceptions::CompositionEntryError@{fourdst::composition::exceptions::CompositionEntryError}!m\_message@{m\_message}}
|
||||
\index{m\_message@{m\_message}!fourdst::composition::exceptions::CompositionEntryError@{fourdst::composition::exceptions::CompositionEntryError}}
|
||||
\doxysubsubsection{\texorpdfstring{m\_message}{m\_message}}
|
||||
{\footnotesize\ttfamily \label{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error_a41208f0821385ed6f168c66f5863a79d}
|
||||
std\+::string fourdst\+::composition\+::exceptions\+::\+Composition\+Entry\+Error\+::m\+\_\+message\hspace{0.3cm}{\ttfamily [protected]}}
|
||||
|
||||
|
||||
|
||||
The error message.
|
||||
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{exceptions__composition_8h_source_l00049}{49}} of file \mbox{\hyperlink{exceptions__composition_8h_source}{exceptions\+\_\+composition.\+h}}.
|
||||
|
||||
|
||||
|
||||
The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
|
||||
\item
|
||||
src/composition/include/fourdst/composition/exceptions/\mbox{\hyperlink{exceptions__composition_8h}{exceptions\+\_\+composition.\+h}}\end{DoxyCompactItemize}
|
||||
Binary file not shown.
@@ -0,0 +1,102 @@
|
||||
\doxysection{fourdst\+::composition\+::exceptions\+::Composition\+Error Class Reference}
|
||||
\hypertarget{classfourdst_1_1composition_1_1exceptions_1_1_composition_error}{}\label{classfourdst_1_1composition_1_1exceptions_1_1_composition_error}\index{fourdst::composition::exceptions::CompositionError@{fourdst::composition::exceptions::CompositionError}}
|
||||
|
||||
|
||||
Base class for exceptions related to composition objects.
|
||||
|
||||
|
||||
|
||||
|
||||
{\ttfamily \#include $<$exceptions\+\_\+composition.\+h$>$}
|
||||
|
||||
Inheritance diagram for fourdst\+::composition\+::exceptions\+::Composition\+Error\+:\begin{figure}[H]
|
||||
\begin{center}
|
||||
\leavevmode
|
||||
\includegraphics[height=0.710660cm]{classfourdst_1_1composition_1_1exceptions_1_1_composition_error}
|
||||
\end{center}
|
||||
\end{figure}
|
||||
\doxysubsubsection*{Public Member Functions}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error_aef0cd13a4d1eb60b6d75ca5480e9146c}{Composition\+Error}} (const std\+::string \&message)
|
||||
\begin{DoxyCompactList}\small\item\em Constructs a \doxylink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error}{Composition\+Error} with an error message. \end{DoxyCompactList}\item
|
||||
const char \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error_ae44ceddb19da8a8cda7ee150b6826d08}{what}} () const noexcept override
|
||||
\begin{DoxyCompactList}\small\item\em Returns the error message. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
\doxysubsubsection*{Protected Attributes}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
std\+::string \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error_a4cd69d727a162f90045cd6d4aaf95440}{m\+\_\+message}}
|
||||
\begin{DoxyCompactList}\small\item\em The error message. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
|
||||
|
||||
\doxysubsection{Detailed Description}
|
||||
Base class for exceptions related to composition objects.
|
||||
|
||||
This exception is thrown when an error occurs at the composition level, such as invalid configuration or state.
|
||||
|
||||
Definition at line \mbox{\hyperlink{exceptions__composition_8h_source_l00014}{14}} of file \mbox{\hyperlink{exceptions__composition_8h_source}{exceptions\+\_\+composition.\+h}}.
|
||||
|
||||
|
||||
|
||||
\doxysubsection{Constructor \& Destructor Documentation}
|
||||
\Hypertarget{classfourdst_1_1composition_1_1exceptions_1_1_composition_error_aef0cd13a4d1eb60b6d75ca5480e9146c}\index{fourdst::composition::exceptions::CompositionError@{fourdst::composition::exceptions::CompositionError}!CompositionError@{CompositionError}}
|
||||
\index{CompositionError@{CompositionError}!fourdst::composition::exceptions::CompositionError@{fourdst::composition::exceptions::CompositionError}}
|
||||
\doxysubsubsection{\texorpdfstring{CompositionError()}{CompositionError()}}
|
||||
{\footnotesize\ttfamily \label{classfourdst_1_1composition_1_1exceptions_1_1_composition_error_aef0cd13a4d1eb60b6d75ca5480e9146c}
|
||||
fourdst\+::composition\+::exceptions\+::\+Composition\+Error\+::\+Composition\+Error (\begin{DoxyParamCaption}\item[{const std\+::string \&}]{message}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [explicit]}}
|
||||
|
||||
|
||||
|
||||
Constructs a \doxylink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error}{Composition\+Error} with an error message.
|
||||
|
||||
|
||||
\begin{DoxyParams}{Parameters}
|
||||
{\em message} & The error message. \\
|
||||
\hline
|
||||
\end{DoxyParams}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{exceptions__composition_8h_source_l00025}{25}} of file \mbox{\hyperlink{exceptions__composition_8h_source}{exceptions\+\_\+composition.\+h}}.
|
||||
|
||||
|
||||
|
||||
\doxysubsection{Member Function Documentation}
|
||||
\Hypertarget{classfourdst_1_1composition_1_1exceptions_1_1_composition_error_ae44ceddb19da8a8cda7ee150b6826d08}\index{fourdst::composition::exceptions::CompositionError@{fourdst::composition::exceptions::CompositionError}!what@{what}}
|
||||
\index{what@{what}!fourdst::composition::exceptions::CompositionError@{fourdst::composition::exceptions::CompositionError}}
|
||||
\doxysubsubsection{\texorpdfstring{what()}{what()}}
|
||||
{\footnotesize\ttfamily \label{classfourdst_1_1composition_1_1exceptions_1_1_composition_error_ae44ceddb19da8a8cda7ee150b6826d08}
|
||||
const char \texorpdfstring{$\ast$}{*} fourdst\+::composition\+::exceptions\+::\+Composition\+Error\+::what (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [override]}, {\ttfamily [noexcept]}}
|
||||
|
||||
|
||||
|
||||
Returns the error message.
|
||||
|
||||
\begin{DoxyReturn}{Returns}
|
||||
A C-\/style string containing the error message.
|
||||
\end{DoxyReturn}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{exceptions__composition_8h_source_l00032}{32}} of file \mbox{\hyperlink{exceptions__composition_8h_source}{exceptions\+\_\+composition.\+h}}.
|
||||
|
||||
|
||||
|
||||
\doxysubsection{Member Data Documentation}
|
||||
\Hypertarget{classfourdst_1_1composition_1_1exceptions_1_1_composition_error_a4cd69d727a162f90045cd6d4aaf95440}\index{fourdst::composition::exceptions::CompositionError@{fourdst::composition::exceptions::CompositionError}!m\_message@{m\_message}}
|
||||
\index{m\_message@{m\_message}!fourdst::composition::exceptions::CompositionError@{fourdst::composition::exceptions::CompositionError}}
|
||||
\doxysubsubsection{\texorpdfstring{m\_message}{m\_message}}
|
||||
{\footnotesize\ttfamily \label{classfourdst_1_1composition_1_1exceptions_1_1_composition_error_a4cd69d727a162f90045cd6d4aaf95440}
|
||||
std\+::string fourdst\+::composition\+::exceptions\+::\+Composition\+Error\+::m\+\_\+message\hspace{0.3cm}{\ttfamily [protected]}}
|
||||
|
||||
|
||||
|
||||
The error message.
|
||||
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{exceptions__composition_8h_source_l00019}{19}} of file \mbox{\hyperlink{exceptions__composition_8h_source}{exceptions\+\_\+composition.\+h}}.
|
||||
|
||||
|
||||
|
||||
The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
|
||||
\item
|
||||
src/composition/include/fourdst/composition/exceptions/\mbox{\hyperlink{exceptions__composition_8h}{exceptions\+\_\+composition.\+h}}\end{DoxyCompactItemize}
|
||||
Binary file not shown.
@@ -0,0 +1,71 @@
|
||||
\doxysection{fourdst\+::composition\+::exceptions\+::Composition\+Mode\+Error Class Reference}
|
||||
\hypertarget{classfourdst_1_1composition_1_1exceptions_1_1_composition_mode_error}{}\label{classfourdst_1_1composition_1_1exceptions_1_1_composition_mode_error}\index{fourdst::composition::exceptions::CompositionModeError@{fourdst::composition::exceptions::CompositionModeError}}
|
||||
|
||||
|
||||
Exception thrown due to a conflict in composition modes at the entry level.
|
||||
|
||||
|
||||
|
||||
|
||||
{\ttfamily \#include $<$exceptions\+\_\+composition.\+h$>$}
|
||||
|
||||
Inheritance diagram for fourdst\+::composition\+::exceptions\+::Composition\+Mode\+Error\+:\begin{figure}[H]
|
||||
\begin{center}
|
||||
\leavevmode
|
||||
\includegraphics[height=3.000000cm]{classfourdst_1_1composition_1_1exceptions_1_1_composition_mode_error}
|
||||
\end{center}
|
||||
\end{figure}
|
||||
\doxysubsubsection*{Private Member Functions}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_mode_error_af5ea3395201839d670bdcfc61b19abb1}{Composition\+Entry\+Error}} (const std\+::string \&message)
|
||||
\begin{DoxyCompactList}\small\item\em Constructs a \doxylink{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error}{Composition\+Entry\+Error} with an error message. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
\doxysubsubsection*{Additional Inherited Members}
|
||||
\doxysubsection*{Public Member Functions inherited from \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error}{fourdst\+::composition\+::exceptions\+::\+Composition\+Entry\+Error}}}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error_af5ea3395201839d670bdcfc61b19abb1}{Composition\+Entry\+Error}} (const std\+::string \&message)
|
||||
\begin{DoxyCompactList}\small\item\em Constructs a \doxylink{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error}{Composition\+Entry\+Error} with an error message. \end{DoxyCompactList}\item
|
||||
const char \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error_aeba45905c6dc1a47ec1ad3f978f94e57}{what}} () const noexcept override
|
||||
\begin{DoxyCompactList}\small\item\em Returns the error message. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
\doxysubsection*{Protected Attributes inherited from \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error}{fourdst\+::composition\+::exceptions\+::\+Composition\+Entry\+Error}}}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
std\+::string \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error_a41208f0821385ed6f168c66f5863a79d}{m\+\_\+message}}
|
||||
\begin{DoxyCompactList}\small\item\em The error message. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
|
||||
|
||||
\doxysubsection{Detailed Description}
|
||||
Exception thrown due to a conflict in composition modes at the entry level.
|
||||
|
||||
This may occur if an entry\textquotesingle{}s configuration is incompatible with the overall composition\textquotesingle{}s mode.
|
||||
|
||||
Definition at line \mbox{\hyperlink{exceptions__composition_8h_source_l00145}{145}} of file \mbox{\hyperlink{exceptions__composition_8h_source}{exceptions\+\_\+composition.\+h}}.
|
||||
|
||||
|
||||
|
||||
\doxysubsection{Member Function Documentation}
|
||||
\Hypertarget{classfourdst_1_1composition_1_1exceptions_1_1_composition_mode_error_af5ea3395201839d670bdcfc61b19abb1}\index{fourdst::composition::exceptions::CompositionModeError@{fourdst::composition::exceptions::CompositionModeError}!CompositionEntryError@{CompositionEntryError}}
|
||||
\index{CompositionEntryError@{CompositionEntryError}!fourdst::composition::exceptions::CompositionModeError@{fourdst::composition::exceptions::CompositionModeError}}
|
||||
\doxysubsubsection{\texorpdfstring{CompositionEntryError()}{CompositionEntryError()}}
|
||||
{\footnotesize\ttfamily \label{classfourdst_1_1composition_1_1exceptions_1_1_composition_mode_error_af5ea3395201839d670bdcfc61b19abb1}
|
||||
fourdst\+::composition\+::exceptions\+::\+Composition\+Entry\+Error\+::\+Composition\+Entry\+Error (\begin{DoxyParamCaption}\item[{const std\+::string \&}]{message}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [explicit]}, {\ttfamily [private]}}
|
||||
|
||||
|
||||
|
||||
Constructs a \doxylink{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error}{Composition\+Entry\+Error} with an error message.
|
||||
|
||||
|
||||
\begin{DoxyParams}{Parameters}
|
||||
{\em message} & The error message. \\
|
||||
\hline
|
||||
\end{DoxyParams}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{exceptions__composition_8h_source_l00055}{55}} of file \mbox{\hyperlink{exceptions__composition_8h_source}{exceptions\+\_\+composition.\+h}}.
|
||||
|
||||
|
||||
|
||||
The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
|
||||
\item
|
||||
src/composition/include/fourdst/composition/exceptions/\mbox{\hyperlink{exceptions__composition_8h}{exceptions\+\_\+composition.\+h}}\end{DoxyCompactItemize}
|
||||
Binary file not shown.
@@ -0,0 +1,71 @@
|
||||
\doxysection{fourdst\+::composition\+::exceptions\+::Composition\+Not\+Finalized\+Error Class Reference}
|
||||
\hypertarget{classfourdst_1_1composition_1_1exceptions_1_1_composition_not_finalized_error}{}\label{classfourdst_1_1composition_1_1exceptions_1_1_composition_not_finalized_error}\index{fourdst::composition::exceptions::CompositionNotFinalizedError@{fourdst::composition::exceptions::CompositionNotFinalizedError}}
|
||||
|
||||
|
||||
Exception thrown when an operation is attempted on a composition that has not been finalized.
|
||||
|
||||
|
||||
|
||||
|
||||
{\ttfamily \#include $<$exceptions\+\_\+composition.\+h$>$}
|
||||
|
||||
Inheritance diagram for fourdst\+::composition\+::exceptions\+::Composition\+Not\+Finalized\+Error\+:\begin{figure}[H]
|
||||
\begin{center}
|
||||
\leavevmode
|
||||
\includegraphics[height=3.000000cm]{classfourdst_1_1composition_1_1exceptions_1_1_composition_not_finalized_error}
|
||||
\end{center}
|
||||
\end{figure}
|
||||
\doxysubsubsection*{Private Member Functions}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_not_finalized_error_aef0cd13a4d1eb60b6d75ca5480e9146c}{Composition\+Error}} (const std\+::string \&message)
|
||||
\begin{DoxyCompactList}\small\item\em Constructs a \doxylink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error}{Composition\+Error} with an error message. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
\doxysubsubsection*{Additional Inherited Members}
|
||||
\doxysubsection*{Public Member Functions inherited from \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error}{fourdst\+::composition\+::exceptions\+::\+Composition\+Error}}}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error_aef0cd13a4d1eb60b6d75ca5480e9146c}{Composition\+Error}} (const std\+::string \&message)
|
||||
\begin{DoxyCompactList}\small\item\em Constructs a \doxylink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error}{Composition\+Error} with an error message. \end{DoxyCompactList}\item
|
||||
const char \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error_ae44ceddb19da8a8cda7ee150b6826d08}{what}} () const noexcept override
|
||||
\begin{DoxyCompactList}\small\item\em Returns the error message. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
\doxysubsection*{Protected Attributes inherited from \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error}{fourdst\+::composition\+::exceptions\+::\+Composition\+Error}}}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
std\+::string \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error_a4cd69d727a162f90045cd6d4aaf95440}{m\+\_\+message}}
|
||||
\begin{DoxyCompactList}\small\item\em The error message. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
|
||||
|
||||
\doxysubsection{Detailed Description}
|
||||
Exception thrown when an operation is attempted on a composition that has not been finalized.
|
||||
|
||||
Certain operations require the composition to be in a "{}finalized"{} state. This error indicates that such an operation was called prematurely.
|
||||
|
||||
Definition at line \mbox{\hyperlink{exceptions__composition_8h_source_l00074}{74}} of file \mbox{\hyperlink{exceptions__composition_8h_source}{exceptions\+\_\+composition.\+h}}.
|
||||
|
||||
|
||||
|
||||
\doxysubsection{Member Function Documentation}
|
||||
\Hypertarget{classfourdst_1_1composition_1_1exceptions_1_1_composition_not_finalized_error_aef0cd13a4d1eb60b6d75ca5480e9146c}\index{fourdst::composition::exceptions::CompositionNotFinalizedError@{fourdst::composition::exceptions::CompositionNotFinalizedError}!CompositionError@{CompositionError}}
|
||||
\index{CompositionError@{CompositionError}!fourdst::composition::exceptions::CompositionNotFinalizedError@{fourdst::composition::exceptions::CompositionNotFinalizedError}}
|
||||
\doxysubsubsection{\texorpdfstring{CompositionError()}{CompositionError()}}
|
||||
{\footnotesize\ttfamily \label{classfourdst_1_1composition_1_1exceptions_1_1_composition_not_finalized_error_aef0cd13a4d1eb60b6d75ca5480e9146c}
|
||||
fourdst\+::composition\+::exceptions\+::\+Composition\+Error\+::\+Composition\+Error (\begin{DoxyParamCaption}\item[{const std\+::string \&}]{message}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [explicit]}, {\ttfamily [private]}}
|
||||
|
||||
|
||||
|
||||
Constructs a \doxylink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error}{Composition\+Error} with an error message.
|
||||
|
||||
|
||||
\begin{DoxyParams}{Parameters}
|
||||
{\em message} & The error message. \\
|
||||
\hline
|
||||
\end{DoxyParams}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{exceptions__composition_8h_source_l00025}{25}} of file \mbox{\hyperlink{exceptions__composition_8h_source}{exceptions\+\_\+composition.\+h}}.
|
||||
|
||||
|
||||
|
||||
The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
|
||||
\item
|
||||
src/composition/include/fourdst/composition/exceptions/\mbox{\hyperlink{exceptions__composition_8h}{exceptions\+\_\+composition.\+h}}\end{DoxyCompactItemize}
|
||||
Binary file not shown.
@@ -0,0 +1,69 @@
|
||||
\doxysection{fourdst\+::composition\+::exceptions\+::Entry\+Already\+Initialized\+Error Class Reference}
|
||||
\hypertarget{classfourdst_1_1composition_1_1exceptions_1_1_entry_already_initialized_error}{}\label{classfourdst_1_1composition_1_1exceptions_1_1_entry_already_initialized_error}\index{fourdst::composition::exceptions::EntryAlreadyInitializedError@{fourdst::composition::exceptions::EntryAlreadyInitializedError}}
|
||||
|
||||
|
||||
Exception thrown when attempting to initialize a composition entry that has already been initialized.
|
||||
|
||||
|
||||
|
||||
|
||||
{\ttfamily \#include $<$exceptions\+\_\+composition.\+h$>$}
|
||||
|
||||
Inheritance diagram for fourdst\+::composition\+::exceptions\+::Entry\+Already\+Initialized\+Error\+:\begin{figure}[H]
|
||||
\begin{center}
|
||||
\leavevmode
|
||||
\includegraphics[height=3.000000cm]{classfourdst_1_1composition_1_1exceptions_1_1_entry_already_initialized_error}
|
||||
\end{center}
|
||||
\end{figure}
|
||||
\doxysubsubsection*{Private Member Functions}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_entry_already_initialized_error_af5ea3395201839d670bdcfc61b19abb1}{Composition\+Entry\+Error}} (const std\+::string \&message)
|
||||
\begin{DoxyCompactList}\small\item\em Constructs a \doxylink{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error}{Composition\+Entry\+Error} with an error message. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
\doxysubsubsection*{Additional Inherited Members}
|
||||
\doxysubsection*{Public Member Functions inherited from \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error}{fourdst\+::composition\+::exceptions\+::\+Composition\+Entry\+Error}}}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error_af5ea3395201839d670bdcfc61b19abb1}{Composition\+Entry\+Error}} (const std\+::string \&message)
|
||||
\begin{DoxyCompactList}\small\item\em Constructs a \doxylink{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error}{Composition\+Entry\+Error} with an error message. \end{DoxyCompactList}\item
|
||||
const char \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error_aeba45905c6dc1a47ec1ad3f978f94e57}{what}} () const noexcept override
|
||||
\begin{DoxyCompactList}\small\item\em Returns the error message. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
\doxysubsection*{Protected Attributes inherited from \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error}{fourdst\+::composition\+::exceptions\+::\+Composition\+Entry\+Error}}}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
std\+::string \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error_a41208f0821385ed6f168c66f5863a79d}{m\+\_\+message}}
|
||||
\begin{DoxyCompactList}\small\item\em The error message. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
|
||||
|
||||
\doxysubsection{Detailed Description}
|
||||
Exception thrown when attempting to initialize a composition entry that has already been initialized.
|
||||
|
||||
Definition at line \mbox{\hyperlink{exceptions__composition_8h_source_l00135}{135}} of file \mbox{\hyperlink{exceptions__composition_8h_source}{exceptions\+\_\+composition.\+h}}.
|
||||
|
||||
|
||||
|
||||
\doxysubsection{Member Function Documentation}
|
||||
\Hypertarget{classfourdst_1_1composition_1_1exceptions_1_1_entry_already_initialized_error_af5ea3395201839d670bdcfc61b19abb1}\index{fourdst::composition::exceptions::EntryAlreadyInitializedError@{fourdst::composition::exceptions::EntryAlreadyInitializedError}!CompositionEntryError@{CompositionEntryError}}
|
||||
\index{CompositionEntryError@{CompositionEntryError}!fourdst::composition::exceptions::EntryAlreadyInitializedError@{fourdst::composition::exceptions::EntryAlreadyInitializedError}}
|
||||
\doxysubsubsection{\texorpdfstring{CompositionEntryError()}{CompositionEntryError()}}
|
||||
{\footnotesize\ttfamily \label{classfourdst_1_1composition_1_1exceptions_1_1_entry_already_initialized_error_af5ea3395201839d670bdcfc61b19abb1}
|
||||
fourdst\+::composition\+::exceptions\+::\+Composition\+Entry\+Error\+::\+Composition\+Entry\+Error (\begin{DoxyParamCaption}\item[{const std\+::string \&}]{message}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [explicit]}, {\ttfamily [private]}}
|
||||
|
||||
|
||||
|
||||
Constructs a \doxylink{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error}{Composition\+Entry\+Error} with an error message.
|
||||
|
||||
|
||||
\begin{DoxyParams}{Parameters}
|
||||
{\em message} & The error message. \\
|
||||
\hline
|
||||
\end{DoxyParams}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{exceptions__composition_8h_source_l00055}{55}} of file \mbox{\hyperlink{exceptions__composition_8h_source}{exceptions\+\_\+composition.\+h}}.
|
||||
|
||||
|
||||
|
||||
The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
|
||||
\item
|
||||
src/composition/include/fourdst/composition/exceptions/\mbox{\hyperlink{exceptions__composition_8h}{exceptions\+\_\+composition.\+h}}\end{DoxyCompactItemize}
|
||||
Binary file not shown.
@@ -0,0 +1,69 @@
|
||||
\doxysection{fourdst\+::composition\+::exceptions\+::Failed\+To\+Finalize\+Composition\+Error Class Reference}
|
||||
\hypertarget{classfourdst_1_1composition_1_1exceptions_1_1_failed_to_finalize_composition_error}{}\label{classfourdst_1_1composition_1_1exceptions_1_1_failed_to_finalize_composition_error}\index{fourdst::composition::exceptions::FailedToFinalizeCompositionError@{fourdst::composition::exceptions::FailedToFinalizeCompositionError}}
|
||||
|
||||
|
||||
Exception thrown when the finalization process of a composition fails.
|
||||
|
||||
|
||||
|
||||
|
||||
{\ttfamily \#include $<$exceptions\+\_\+composition.\+h$>$}
|
||||
|
||||
Inheritance diagram for fourdst\+::composition\+::exceptions\+::Failed\+To\+Finalize\+Composition\+Error\+:\begin{figure}[H]
|
||||
\begin{center}
|
||||
\leavevmode
|
||||
\includegraphics[height=3.000000cm]{classfourdst_1_1composition_1_1exceptions_1_1_failed_to_finalize_composition_error}
|
||||
\end{center}
|
||||
\end{figure}
|
||||
\doxysubsubsection*{Private Member Functions}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_failed_to_finalize_composition_error_aef0cd13a4d1eb60b6d75ca5480e9146c}{Composition\+Error}} (const std\+::string \&message)
|
||||
\begin{DoxyCompactList}\small\item\em Constructs a \doxylink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error}{Composition\+Error} with an error message. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
\doxysubsubsection*{Additional Inherited Members}
|
||||
\doxysubsection*{Public Member Functions inherited from \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error}{fourdst\+::composition\+::exceptions\+::\+Composition\+Error}}}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error_aef0cd13a4d1eb60b6d75ca5480e9146c}{Composition\+Error}} (const std\+::string \&message)
|
||||
\begin{DoxyCompactList}\small\item\em Constructs a \doxylink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error}{Composition\+Error} with an error message. \end{DoxyCompactList}\item
|
||||
const char \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error_ae44ceddb19da8a8cda7ee150b6826d08}{what}} () const noexcept override
|
||||
\begin{DoxyCompactList}\small\item\em Returns the error message. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
\doxysubsection*{Protected Attributes inherited from \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error}{fourdst\+::composition\+::exceptions\+::\+Composition\+Error}}}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
std\+::string \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error_a4cd69d727a162f90045cd6d4aaf95440}{m\+\_\+message}}
|
||||
\begin{DoxyCompactList}\small\item\em The error message. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
|
||||
|
||||
\doxysubsection{Detailed Description}
|
||||
Exception thrown when the finalization process of a composition fails.
|
||||
|
||||
Definition at line \mbox{\hyperlink{exceptions__composition_8h_source_l00119}{119}} of file \mbox{\hyperlink{exceptions__composition_8h_source}{exceptions\+\_\+composition.\+h}}.
|
||||
|
||||
|
||||
|
||||
\doxysubsection{Member Function Documentation}
|
||||
\Hypertarget{classfourdst_1_1composition_1_1exceptions_1_1_failed_to_finalize_composition_error_aef0cd13a4d1eb60b6d75ca5480e9146c}\index{fourdst::composition::exceptions::FailedToFinalizeCompositionError@{fourdst::composition::exceptions::FailedToFinalizeCompositionError}!CompositionError@{CompositionError}}
|
||||
\index{CompositionError@{CompositionError}!fourdst::composition::exceptions::FailedToFinalizeCompositionError@{fourdst::composition::exceptions::FailedToFinalizeCompositionError}}
|
||||
\doxysubsubsection{\texorpdfstring{CompositionError()}{CompositionError()}}
|
||||
{\footnotesize\ttfamily \label{classfourdst_1_1composition_1_1exceptions_1_1_failed_to_finalize_composition_error_aef0cd13a4d1eb60b6d75ca5480e9146c}
|
||||
fourdst\+::composition\+::exceptions\+::\+Composition\+Error\+::\+Composition\+Error (\begin{DoxyParamCaption}\item[{const std\+::string \&}]{message}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [explicit]}, {\ttfamily [private]}}
|
||||
|
||||
|
||||
|
||||
Constructs a \doxylink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error}{Composition\+Error} with an error message.
|
||||
|
||||
|
||||
\begin{DoxyParams}{Parameters}
|
||||
{\em message} & The error message. \\
|
||||
\hline
|
||||
\end{DoxyParams}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{exceptions__composition_8h_source_l00025}{25}} of file \mbox{\hyperlink{exceptions__composition_8h_source}{exceptions\+\_\+composition.\+h}}.
|
||||
|
||||
|
||||
|
||||
The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
|
||||
\item
|
||||
src/composition/include/fourdst/composition/exceptions/\mbox{\hyperlink{exceptions__composition_8h}{exceptions\+\_\+composition.\+h}}\end{DoxyCompactItemize}
|
||||
Binary file not shown.
@@ -0,0 +1,69 @@
|
||||
\doxysection{fourdst\+::composition\+::exceptions\+::Invalid\+Composition\+Error Class Reference}
|
||||
\hypertarget{classfourdst_1_1composition_1_1exceptions_1_1_invalid_composition_error}{}\label{classfourdst_1_1composition_1_1exceptions_1_1_invalid_composition_error}\index{fourdst::composition::exceptions::InvalidCompositionError@{fourdst::composition::exceptions::InvalidCompositionError}}
|
||||
|
||||
|
||||
Exception thrown when a composition is in an invalid or inconsistent state.
|
||||
|
||||
|
||||
|
||||
|
||||
{\ttfamily \#include $<$exceptions\+\_\+composition.\+h$>$}
|
||||
|
||||
Inheritance diagram for fourdst\+::composition\+::exceptions\+::Invalid\+Composition\+Error\+:\begin{figure}[H]
|
||||
\begin{center}
|
||||
\leavevmode
|
||||
\includegraphics[height=3.000000cm]{classfourdst_1_1composition_1_1exceptions_1_1_invalid_composition_error}
|
||||
\end{center}
|
||||
\end{figure}
|
||||
\doxysubsubsection*{Private Member Functions}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_composition_error_aef0cd13a4d1eb60b6d75ca5480e9146c}{Composition\+Error}} (const std\+::string \&message)
|
||||
\begin{DoxyCompactList}\small\item\em Constructs a \doxylink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error}{Composition\+Error} with an error message. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
\doxysubsubsection*{Additional Inherited Members}
|
||||
\doxysubsection*{Public Member Functions inherited from \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error}{fourdst\+::composition\+::exceptions\+::\+Composition\+Error}}}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error_aef0cd13a4d1eb60b6d75ca5480e9146c}{Composition\+Error}} (const std\+::string \&message)
|
||||
\begin{DoxyCompactList}\small\item\em Constructs a \doxylink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error}{Composition\+Error} with an error message. \end{DoxyCompactList}\item
|
||||
const char \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error_ae44ceddb19da8a8cda7ee150b6826d08}{what}} () const noexcept override
|
||||
\begin{DoxyCompactList}\small\item\em Returns the error message. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
\doxysubsection*{Protected Attributes inherited from \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error}{fourdst\+::composition\+::exceptions\+::\+Composition\+Error}}}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
std\+::string \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error_a4cd69d727a162f90045cd6d4aaf95440}{m\+\_\+message}}
|
||||
\begin{DoxyCompactList}\small\item\em The error message. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
|
||||
|
||||
\doxysubsection{Detailed Description}
|
||||
Exception thrown when a composition is in an invalid or inconsistent state.
|
||||
|
||||
Definition at line \mbox{\hyperlink{exceptions__composition_8h_source_l00082}{82}} of file \mbox{\hyperlink{exceptions__composition_8h_source}{exceptions\+\_\+composition.\+h}}.
|
||||
|
||||
|
||||
|
||||
\doxysubsection{Member Function Documentation}
|
||||
\Hypertarget{classfourdst_1_1composition_1_1exceptions_1_1_invalid_composition_error_aef0cd13a4d1eb60b6d75ca5480e9146c}\index{fourdst::composition::exceptions::InvalidCompositionError@{fourdst::composition::exceptions::InvalidCompositionError}!CompositionError@{CompositionError}}
|
||||
\index{CompositionError@{CompositionError}!fourdst::composition::exceptions::InvalidCompositionError@{fourdst::composition::exceptions::InvalidCompositionError}}
|
||||
\doxysubsubsection{\texorpdfstring{CompositionError()}{CompositionError()}}
|
||||
{\footnotesize\ttfamily \label{classfourdst_1_1composition_1_1exceptions_1_1_invalid_composition_error_aef0cd13a4d1eb60b6d75ca5480e9146c}
|
||||
fourdst\+::composition\+::exceptions\+::\+Composition\+Error\+::\+Composition\+Error (\begin{DoxyParamCaption}\item[{const std\+::string \&}]{message}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [explicit]}, {\ttfamily [private]}}
|
||||
|
||||
|
||||
|
||||
Constructs a \doxylink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error}{Composition\+Error} with an error message.
|
||||
|
||||
|
||||
\begin{DoxyParams}{Parameters}
|
||||
{\em message} & The error message. \\
|
||||
\hline
|
||||
\end{DoxyParams}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{exceptions__composition_8h_source_l00025}{25}} of file \mbox{\hyperlink{exceptions__composition_8h_source}{exceptions\+\_\+composition.\+h}}.
|
||||
|
||||
|
||||
|
||||
The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
|
||||
\item
|
||||
src/composition/include/fourdst/composition/exceptions/\mbox{\hyperlink{exceptions__composition_8h}{exceptions\+\_\+composition.\+h}}\end{DoxyCompactItemize}
|
||||
Binary file not shown.
@@ -0,0 +1,71 @@
|
||||
\doxysection{fourdst\+::composition\+::exceptions\+::Invalid\+Mixing\+Mode Class Reference}
|
||||
\hypertarget{classfourdst_1_1composition_1_1exceptions_1_1_invalid_mixing_mode}{}\label{classfourdst_1_1composition_1_1exceptions_1_1_invalid_mixing_mode}\index{fourdst::composition::exceptions::InvalidMixingMode@{fourdst::composition::exceptions::InvalidMixingMode}}
|
||||
|
||||
|
||||
Exception thrown for an invalid or unsupported mixing mode.
|
||||
|
||||
|
||||
|
||||
|
||||
{\ttfamily \#include $<$exceptions\+\_\+composition.\+h$>$}
|
||||
|
||||
Inheritance diagram for fourdst\+::composition\+::exceptions\+::Invalid\+Mixing\+Mode\+:\begin{figure}[H]
|
||||
\begin{center}
|
||||
\leavevmode
|
||||
\includegraphics[height=3.000000cm]{classfourdst_1_1composition_1_1exceptions_1_1_invalid_mixing_mode}
|
||||
\end{center}
|
||||
\end{figure}
|
||||
\doxysubsubsection*{Private Member Functions}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_mixing_mode_aef0cd13a4d1eb60b6d75ca5480e9146c}{Composition\+Error}} (const std\+::string \&message)
|
||||
\begin{DoxyCompactList}\small\item\em Constructs a \doxylink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error}{Composition\+Error} with an error message. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
\doxysubsubsection*{Additional Inherited Members}
|
||||
\doxysubsection*{Public Member Functions inherited from \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error}{fourdst\+::composition\+::exceptions\+::\+Composition\+Error}}}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error_aef0cd13a4d1eb60b6d75ca5480e9146c}{Composition\+Error}} (const std\+::string \&message)
|
||||
\begin{DoxyCompactList}\small\item\em Constructs a \doxylink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error}{Composition\+Error} with an error message. \end{DoxyCompactList}\item
|
||||
const char \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error_ae44ceddb19da8a8cda7ee150b6826d08}{what}} () const noexcept override
|
||||
\begin{DoxyCompactList}\small\item\em Returns the error message. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
\doxysubsection*{Protected Attributes inherited from \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error}{fourdst\+::composition\+::exceptions\+::\+Composition\+Error}}}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
std\+::string \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error_a4cd69d727a162f90045cd6d4aaf95440}{m\+\_\+message}}
|
||||
\begin{DoxyCompactList}\small\item\em The error message. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
|
||||
|
||||
\doxysubsection{Detailed Description}
|
||||
Exception thrown for an invalid or unsupported mixing mode.
|
||||
|
||||
Compositions can be defined with different mixing modes (e.\+g., by mass, by mole). This error is thrown if an invalid mode is specified.
|
||||
|
||||
Definition at line \mbox{\hyperlink{exceptions__composition_8h_source_l00093}{93}} of file \mbox{\hyperlink{exceptions__composition_8h_source}{exceptions\+\_\+composition.\+h}}.
|
||||
|
||||
|
||||
|
||||
\doxysubsection{Member Function Documentation}
|
||||
\Hypertarget{classfourdst_1_1composition_1_1exceptions_1_1_invalid_mixing_mode_aef0cd13a4d1eb60b6d75ca5480e9146c}\index{fourdst::composition::exceptions::InvalidMixingMode@{fourdst::composition::exceptions::InvalidMixingMode}!CompositionError@{CompositionError}}
|
||||
\index{CompositionError@{CompositionError}!fourdst::composition::exceptions::InvalidMixingMode@{fourdst::composition::exceptions::InvalidMixingMode}}
|
||||
\doxysubsubsection{\texorpdfstring{CompositionError()}{CompositionError()}}
|
||||
{\footnotesize\ttfamily \label{classfourdst_1_1composition_1_1exceptions_1_1_invalid_mixing_mode_aef0cd13a4d1eb60b6d75ca5480e9146c}
|
||||
fourdst\+::composition\+::exceptions\+::\+Composition\+Error\+::\+Composition\+Error (\begin{DoxyParamCaption}\item[{const std\+::string \&}]{message}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [explicit]}, {\ttfamily [private]}}
|
||||
|
||||
|
||||
|
||||
Constructs a \doxylink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error}{Composition\+Error} with an error message.
|
||||
|
||||
|
||||
\begin{DoxyParams}{Parameters}
|
||||
{\em message} & The error message. \\
|
||||
\hline
|
||||
\end{DoxyParams}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{exceptions__composition_8h_source_l00025}{25}} of file \mbox{\hyperlink{exceptions__composition_8h_source}{exceptions\+\_\+composition.\+h}}.
|
||||
|
||||
|
||||
|
||||
The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
|
||||
\item
|
||||
src/composition/include/fourdst/composition/exceptions/\mbox{\hyperlink{exceptions__composition_8h}{exceptions\+\_\+composition.\+h}}\end{DoxyCompactItemize}
|
||||
Binary file not shown.
@@ -0,0 +1,69 @@
|
||||
\doxysection{fourdst\+::composition\+::exceptions\+::Invalid\+Species\+Symbol\+Error Class Reference}
|
||||
\hypertarget{classfourdst_1_1composition_1_1exceptions_1_1_invalid_species_symbol_error}{}\label{classfourdst_1_1composition_1_1exceptions_1_1_invalid_species_symbol_error}\index{fourdst::composition::exceptions::InvalidSpeciesSymbolError@{fourdst::composition::exceptions::InvalidSpeciesSymbolError}}
|
||||
|
||||
|
||||
Exception thrown for an invalid chemical species symbol in a composition entry.
|
||||
|
||||
|
||||
|
||||
|
||||
{\ttfamily \#include $<$exceptions\+\_\+composition.\+h$>$}
|
||||
|
||||
Inheritance diagram for fourdst\+::composition\+::exceptions\+::Invalid\+Species\+Symbol\+Error\+:\begin{figure}[H]
|
||||
\begin{center}
|
||||
\leavevmode
|
||||
\includegraphics[height=3.000000cm]{classfourdst_1_1composition_1_1exceptions_1_1_invalid_species_symbol_error}
|
||||
\end{center}
|
||||
\end{figure}
|
||||
\doxysubsubsection*{Private Member Functions}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_species_symbol_error_af5ea3395201839d670bdcfc61b19abb1}{Composition\+Entry\+Error}} (const std\+::string \&message)
|
||||
\begin{DoxyCompactList}\small\item\em Constructs a \doxylink{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error}{Composition\+Entry\+Error} with an error message. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
\doxysubsubsection*{Additional Inherited Members}
|
||||
\doxysubsection*{Public Member Functions inherited from \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error}{fourdst\+::composition\+::exceptions\+::\+Composition\+Entry\+Error}}}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error_af5ea3395201839d670bdcfc61b19abb1}{Composition\+Entry\+Error}} (const std\+::string \&message)
|
||||
\begin{DoxyCompactList}\small\item\em Constructs a \doxylink{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error}{Composition\+Entry\+Error} with an error message. \end{DoxyCompactList}\item
|
||||
const char \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error_aeba45905c6dc1a47ec1ad3f978f94e57}{what}} () const noexcept override
|
||||
\begin{DoxyCompactList}\small\item\em Returns the error message. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
\doxysubsection*{Protected Attributes inherited from \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error}{fourdst\+::composition\+::exceptions\+::\+Composition\+Entry\+Error}}}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
std\+::string \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error_a41208f0821385ed6f168c66f5863a79d}{m\+\_\+message}}
|
||||
\begin{DoxyCompactList}\small\item\em The error message. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
|
||||
|
||||
\doxysubsection{Detailed Description}
|
||||
Exception thrown for an invalid chemical species symbol in a composition entry.
|
||||
|
||||
Definition at line \mbox{\hyperlink{exceptions__composition_8h_source_l00127}{127}} of file \mbox{\hyperlink{exceptions__composition_8h_source}{exceptions\+\_\+composition.\+h}}.
|
||||
|
||||
|
||||
|
||||
\doxysubsection{Member Function Documentation}
|
||||
\Hypertarget{classfourdst_1_1composition_1_1exceptions_1_1_invalid_species_symbol_error_af5ea3395201839d670bdcfc61b19abb1}\index{fourdst::composition::exceptions::InvalidSpeciesSymbolError@{fourdst::composition::exceptions::InvalidSpeciesSymbolError}!CompositionEntryError@{CompositionEntryError}}
|
||||
\index{CompositionEntryError@{CompositionEntryError}!fourdst::composition::exceptions::InvalidSpeciesSymbolError@{fourdst::composition::exceptions::InvalidSpeciesSymbolError}}
|
||||
\doxysubsubsection{\texorpdfstring{CompositionEntryError()}{CompositionEntryError()}}
|
||||
{\footnotesize\ttfamily \label{classfourdst_1_1composition_1_1exceptions_1_1_invalid_species_symbol_error_af5ea3395201839d670bdcfc61b19abb1}
|
||||
fourdst\+::composition\+::exceptions\+::\+Composition\+Entry\+Error\+::\+Composition\+Entry\+Error (\begin{DoxyParamCaption}\item[{const std\+::string \&}]{message}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [explicit]}, {\ttfamily [private]}}
|
||||
|
||||
|
||||
|
||||
Constructs a \doxylink{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error}{Composition\+Entry\+Error} with an error message.
|
||||
|
||||
|
||||
\begin{DoxyParams}{Parameters}
|
||||
{\em message} & The error message. \\
|
||||
\hline
|
||||
\end{DoxyParams}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{exceptions__composition_8h_source_l00055}{55}} of file \mbox{\hyperlink{exceptions__composition_8h_source}{exceptions\+\_\+composition.\+h}}.
|
||||
|
||||
|
||||
|
||||
The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
|
||||
\item
|
||||
src/composition/include/fourdst/composition/exceptions/\mbox{\hyperlink{exceptions__composition_8h}{exceptions\+\_\+composition.\+h}}\end{DoxyCompactItemize}
|
||||
Binary file not shown.
@@ -0,0 +1,69 @@
|
||||
\doxysection{fourdst\+::composition\+::exceptions\+::Invalid\+Symbol\+Error Class Reference}
|
||||
\hypertarget{classfourdst_1_1composition_1_1exceptions_1_1_invalid_symbol_error}{}\label{classfourdst_1_1composition_1_1exceptions_1_1_invalid_symbol_error}\index{fourdst::composition::exceptions::InvalidSymbolError@{fourdst::composition::exceptions::InvalidSymbolError}}
|
||||
|
||||
|
||||
Exception thrown when a symbol used in a composition is invalid.
|
||||
|
||||
|
||||
|
||||
|
||||
{\ttfamily \#include $<$exceptions\+\_\+composition.\+h$>$}
|
||||
|
||||
Inheritance diagram for fourdst\+::composition\+::exceptions\+::Invalid\+Symbol\+Error\+:\begin{figure}[H]
|
||||
\begin{center}
|
||||
\leavevmode
|
||||
\includegraphics[height=3.000000cm]{classfourdst_1_1composition_1_1exceptions_1_1_invalid_symbol_error}
|
||||
\end{center}
|
||||
\end{figure}
|
||||
\doxysubsubsection*{Private Member Functions}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_symbol_error_aef0cd13a4d1eb60b6d75ca5480e9146c}{Composition\+Error}} (const std\+::string \&message)
|
||||
\begin{DoxyCompactList}\small\item\em Constructs a \doxylink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error}{Composition\+Error} with an error message. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
\doxysubsubsection*{Additional Inherited Members}
|
||||
\doxysubsection*{Public Member Functions inherited from \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error}{fourdst\+::composition\+::exceptions\+::\+Composition\+Error}}}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error_aef0cd13a4d1eb60b6d75ca5480e9146c}{Composition\+Error}} (const std\+::string \&message)
|
||||
\begin{DoxyCompactList}\small\item\em Constructs a \doxylink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error}{Composition\+Error} with an error message. \end{DoxyCompactList}\item
|
||||
const char \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error_ae44ceddb19da8a8cda7ee150b6826d08}{what}} () const noexcept override
|
||||
\begin{DoxyCompactList}\small\item\em Returns the error message. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
\doxysubsection*{Protected Attributes inherited from \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error}{fourdst\+::composition\+::exceptions\+::\+Composition\+Error}}}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
std\+::string \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error_a4cd69d727a162f90045cd6d4aaf95440}{m\+\_\+message}}
|
||||
\begin{DoxyCompactList}\small\item\em The error message. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
|
||||
|
||||
\doxysubsection{Detailed Description}
|
||||
Exception thrown when a symbol used in a composition is invalid.
|
||||
|
||||
Definition at line \mbox{\hyperlink{exceptions__composition_8h_source_l00101}{101}} of file \mbox{\hyperlink{exceptions__composition_8h_source}{exceptions\+\_\+composition.\+h}}.
|
||||
|
||||
|
||||
|
||||
\doxysubsection{Member Function Documentation}
|
||||
\Hypertarget{classfourdst_1_1composition_1_1exceptions_1_1_invalid_symbol_error_aef0cd13a4d1eb60b6d75ca5480e9146c}\index{fourdst::composition::exceptions::InvalidSymbolError@{fourdst::composition::exceptions::InvalidSymbolError}!CompositionError@{CompositionError}}
|
||||
\index{CompositionError@{CompositionError}!fourdst::composition::exceptions::InvalidSymbolError@{fourdst::composition::exceptions::InvalidSymbolError}}
|
||||
\doxysubsubsection{\texorpdfstring{CompositionError()}{CompositionError()}}
|
||||
{\footnotesize\ttfamily \label{classfourdst_1_1composition_1_1exceptions_1_1_invalid_symbol_error_aef0cd13a4d1eb60b6d75ca5480e9146c}
|
||||
fourdst\+::composition\+::exceptions\+::\+Composition\+Error\+::\+Composition\+Error (\begin{DoxyParamCaption}\item[{const std\+::string \&}]{message}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [explicit]}, {\ttfamily [private]}}
|
||||
|
||||
|
||||
|
||||
Constructs a \doxylink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error}{Composition\+Error} with an error message.
|
||||
|
||||
|
||||
\begin{DoxyParams}{Parameters}
|
||||
{\em message} & The error message. \\
|
||||
\hline
|
||||
\end{DoxyParams}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{exceptions__composition_8h_source_l00025}{25}} of file \mbox{\hyperlink{exceptions__composition_8h_source}{exceptions\+\_\+composition.\+h}}.
|
||||
|
||||
|
||||
|
||||
The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
|
||||
\item
|
||||
src/composition/include/fourdst/composition/exceptions/\mbox{\hyperlink{exceptions__composition_8h}{exceptions\+\_\+composition.\+h}}\end{DoxyCompactItemize}
|
||||
Binary file not shown.
@@ -0,0 +1,71 @@
|
||||
\doxysection{fourdst\+::composition\+::exceptions\+::Unregistered\+Symbol\+Error Class Reference}
|
||||
\hypertarget{classfourdst_1_1composition_1_1exceptions_1_1_unregistered_symbol_error}{}\label{classfourdst_1_1composition_1_1exceptions_1_1_unregistered_symbol_error}\index{fourdst::composition::exceptions::UnregisteredSymbolError@{fourdst::composition::exceptions::UnregisteredSymbolError}}
|
||||
|
||||
|
||||
Exception thrown when a symbol is used that has not been registered.
|
||||
|
||||
|
||||
|
||||
|
||||
{\ttfamily \#include $<$exceptions\+\_\+composition.\+h$>$}
|
||||
|
||||
Inheritance diagram for fourdst\+::composition\+::exceptions\+::Unregistered\+Symbol\+Error\+:\begin{figure}[H]
|
||||
\begin{center}
|
||||
\leavevmode
|
||||
\includegraphics[height=3.000000cm]{classfourdst_1_1composition_1_1exceptions_1_1_unregistered_symbol_error}
|
||||
\end{center}
|
||||
\end{figure}
|
||||
\doxysubsubsection*{Private Member Functions}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_unregistered_symbol_error_aef0cd13a4d1eb60b6d75ca5480e9146c}{Composition\+Error}} (const std\+::string \&message)
|
||||
\begin{DoxyCompactList}\small\item\em Constructs a \doxylink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error}{Composition\+Error} with an error message. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
\doxysubsubsection*{Additional Inherited Members}
|
||||
\doxysubsection*{Public Member Functions inherited from \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error}{fourdst\+::composition\+::exceptions\+::\+Composition\+Error}}}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error_aef0cd13a4d1eb60b6d75ca5480e9146c}{Composition\+Error}} (const std\+::string \&message)
|
||||
\begin{DoxyCompactList}\small\item\em Constructs a \doxylink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error}{Composition\+Error} with an error message. \end{DoxyCompactList}\item
|
||||
const char \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error_ae44ceddb19da8a8cda7ee150b6826d08}{what}} () const noexcept override
|
||||
\begin{DoxyCompactList}\small\item\em Returns the error message. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
\doxysubsection*{Protected Attributes inherited from \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error}{fourdst\+::composition\+::exceptions\+::\+Composition\+Error}}}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
std\+::string \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error_a4cd69d727a162f90045cd6d4aaf95440}{m\+\_\+message}}
|
||||
\begin{DoxyCompactList}\small\item\em The error message. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
|
||||
|
||||
\doxysubsection{Detailed Description}
|
||||
Exception thrown when a symbol is used that has not been registered.
|
||||
|
||||
This typically occurs when a chemical species is used that is not known to the system.
|
||||
|
||||
Definition at line \mbox{\hyperlink{exceptions__composition_8h_source_l00111}{111}} of file \mbox{\hyperlink{exceptions__composition_8h_source}{exceptions\+\_\+composition.\+h}}.
|
||||
|
||||
|
||||
|
||||
\doxysubsection{Member Function Documentation}
|
||||
\Hypertarget{classfourdst_1_1composition_1_1exceptions_1_1_unregistered_symbol_error_aef0cd13a4d1eb60b6d75ca5480e9146c}\index{fourdst::composition::exceptions::UnregisteredSymbolError@{fourdst::composition::exceptions::UnregisteredSymbolError}!CompositionError@{CompositionError}}
|
||||
\index{CompositionError@{CompositionError}!fourdst::composition::exceptions::UnregisteredSymbolError@{fourdst::composition::exceptions::UnregisteredSymbolError}}
|
||||
\doxysubsubsection{\texorpdfstring{CompositionError()}{CompositionError()}}
|
||||
{\footnotesize\ttfamily \label{classfourdst_1_1composition_1_1exceptions_1_1_unregistered_symbol_error_aef0cd13a4d1eb60b6d75ca5480e9146c}
|
||||
fourdst\+::composition\+::exceptions\+::\+Composition\+Error\+::\+Composition\+Error (\begin{DoxyParamCaption}\item[{const std\+::string \&}]{message}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [explicit]}, {\ttfamily [private]}}
|
||||
|
||||
|
||||
|
||||
Constructs a \doxylink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error}{Composition\+Error} with an error message.
|
||||
|
||||
|
||||
\begin{DoxyParams}{Parameters}
|
||||
{\em message} & The error message. \\
|
||||
\hline
|
||||
\end{DoxyParams}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{exceptions__composition_8h_source_l00025}{25}} of file \mbox{\hyperlink{exceptions__composition_8h_source}{exceptions\+\_\+composition.\+h}}.
|
||||
|
||||
|
||||
|
||||
The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
|
||||
\item
|
||||
src/composition/include/fourdst/composition/exceptions/\mbox{\hyperlink{exceptions__composition_8h}{exceptions\+\_\+composition.\+h}}\end{DoxyCompactItemize}
|
||||
29
docs/latex/composition_8cpp.tex
Normal file
29
docs/latex/composition_8cpp.tex
Normal file
@@ -0,0 +1,29 @@
|
||||
\doxysection{src/composition/lib/composition.cpp File Reference}
|
||||
\hypertarget{composition_8cpp}{}\label{composition_8cpp}\index{src/composition/lib/composition.cpp@{src/composition/lib/composition.cpp}}
|
||||
{\ttfamily \#include "{}quill/\+Log\+Macros.\+h"{}}\newline
|
||||
{\ttfamily \#include $<$stdexcept$>$}\newline
|
||||
{\ttfamily \#include $<$unordered\+\_\+map$>$}\newline
|
||||
{\ttfamily \#include $<$vector$>$}\newline
|
||||
{\ttfamily \#include $<$array$>$}\newline
|
||||
{\ttfamily \#include $<$ranges$>$}\newline
|
||||
{\ttfamily \#include $<$utility$>$}\newline
|
||||
{\ttfamily \#include "{}fourdst/composition/atomic\+Species.\+h"{}}\newline
|
||||
{\ttfamily \#include "{}fourdst/composition/species.\+h"{}}\newline
|
||||
{\ttfamily \#include "{}fourdst/composition/composition.\+h"{}}\newline
|
||||
{\ttfamily \#include "{}fourdst/composition/exceptions/exceptions\+\_\+composition.\+h"{}}\newline
|
||||
\doxysubsubsection*{Namespaces}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
namespace \mbox{\hyperlink{namespacefourdst}{fourdst}}
|
||||
\item
|
||||
namespace \mbox{\hyperlink{namespacefourdst_1_1composition}{fourdst\+::composition}}
|
||||
\end{DoxyCompactItemize}
|
||||
\doxysubsubsection*{Functions}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
std\+::ostream \& \mbox{\hyperlink{namespacefourdst_1_1composition_a8468dde1b148c0583b8a9f85b8d0ce9a}{fourdst\+::composition\+::operator$<$$<$}} (std\+::ostream \&os, const \mbox{\hyperlink{structfourdst_1_1composition_1_1_global_composition}{Global\+Composition}} \&comp)
|
||||
\item
|
||||
std\+::ostream \& \mbox{\hyperlink{namespacefourdst_1_1composition_a676f771864958c4db4ed2a82cc0e85dd}{fourdst\+::composition\+::operator$<$$<$}} (std\+::ostream \&os, const \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry}{Composition\+Entry}} \&entry)
|
||||
\item
|
||||
std\+::ostream \& \mbox{\hyperlink{namespacefourdst_1_1composition_a5e8ccc2bd9e91eebcd3ef5fe470163a1}{fourdst\+::composition\+::operator$<$$<$}} (std\+::ostream \&os, const \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition}{Composition}} \&composition)
|
||||
\end{DoxyCompactItemize}
|
||||
790
docs/latex/composition_8cpp_source.tex
Normal file
790
docs/latex/composition_8cpp_source.tex
Normal file
@@ -0,0 +1,790 @@
|
||||
\doxysection{composition.\+cpp}
|
||||
\hypertarget{composition_8cpp_source}{}\label{composition_8cpp_source}\index{src/composition/lib/composition.cpp@{src/composition/lib/composition.cpp}}
|
||||
\mbox{\hyperlink{composition_8cpp}{Go to the documentation of this file.}}
|
||||
\begin{DoxyCode}{0}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00001}00001\ \textcolor{comment}{/*\ ***********************************************************************}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00002}00002\ \textcolor{comment}{//}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00003}00003\ \textcolor{comment}{//\ \ \ Copyright\ (C)\ 2025\ -\/-\/\ The\ 4D-\/STAR\ Collaboration}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00004}00004\ \textcolor{comment}{//\ \ \ File\ Author:\ Emily\ Boudreaux}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00005}00005\ \textcolor{comment}{//\ \ \ Last\ Modified:\ March\ 26,\ 2025}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00006}00006\ \textcolor{comment}{//}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00007}00007\ \textcolor{comment}{//\ \ \ 4DSSE\ is\ free\ software;\ you\ can\ use\ it\ and/or\ modify}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00008}00008\ \textcolor{comment}{//\ \ \ it\ under\ the\ terms\ and\ restrictions\ the\ GNU\ General\ Library\ Public}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00009}00009\ \textcolor{comment}{//\ \ \ License\ version\ 3\ (GPLv3)\ as\ published\ by\ the\ Free\ Software\ Foundation.}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00010}00010\ \textcolor{comment}{//}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00011}00011\ \textcolor{comment}{//\ \ \ 4DSSE\ is\ distributed\ in\ the\ hope\ that\ it\ will\ be\ useful,}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00012}00012\ \textcolor{comment}{//\ \ \ but\ WITHOUT\ ANY\ WARRANTY;\ without\ even\ the\ implied\ warranty\ of}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00013}00013\ \textcolor{comment}{//\ \ \ MERCHANTABILITY\ or\ FITNESS\ FOR\ A\ PARTICULAR\ PURPOSE.}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00014}00014\ \textcolor{comment}{//\ \ \ See\ the\ GNU\ Library\ General\ Public\ License\ for\ more\ details.}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00015}00015\ \textcolor{comment}{//}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00016}00016\ \textcolor{comment}{//\ \ \ You\ should\ have\ received\ a\ copy\ of\ the\ GNU\ Library\ General\ Public\ License}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00017}00017\ \textcolor{comment}{//\ \ \ along\ with\ this\ software;\ if\ not,\ write\ to\ the\ Free\ Software}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00018}00018\ \textcolor{comment}{//\ \ \ Foundation,\ Inc.,\ 59\ Temple\ Place,\ Suite\ 330,\ Boston,\ MA\ 02111-\/1307\ USA}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00019}00019\ \textcolor{comment}{//}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00020}00020\ \textcolor{comment}{//\ ***********************************************************************\ */}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00021}00021\ \textcolor{preprocessor}{\#include\ "{}quill/LogMacros.h"{}}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00022}00022\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00023}00023\ \textcolor{preprocessor}{\#include\ <stdexcept>}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00024}00024\ \textcolor{preprocessor}{\#include\ <unordered\_map>}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00025}00025\ \textcolor{preprocessor}{\#include\ <vector>}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00026}00026\ \textcolor{preprocessor}{\#include\ <array>}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00027}00027\ \textcolor{preprocessor}{\#include\ <ranges>}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00028}00028\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00029}00029\ \textcolor{preprocessor}{\#include\ <utility>}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00030}00030\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00031}00031\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{atomic_species_8h}{fourdst/composition/atomicSpecies.h}}"{}}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00032}00032\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{species_8h}{fourdst/composition/species.h}}"{}}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00033}00033\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{composition_8h}{fourdst/composition/composition.h}}"{}}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00034}00034\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{exceptions__composition_8h}{fourdst/composition/exceptions/exceptions\_composition.h}}"{}}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00035}00035\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00036}00036\ \textcolor{keyword}{namespace\ }\mbox{\hyperlink{namespacefourdst_1_1composition}{fourdst::composition}}\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00037}00037\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00038}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a1cccb94c150dd1dcde860f55fbeaf2bd}{00038}}\ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a1cccb94c150dd1dcde860f55fbeaf2bd}{CompositionEntry::CompositionEntry}}()\ :}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00039}00039\ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_ac273debdba6a1b3ac0f11698c399d38e}{m\_symbol}}(\textcolor{stringliteral}{"{}H-\/1"{}}),}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00040}00040\ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a79039cbdc76b4401eb2ce44b85467503}{m\_isotope}}(\mbox{\hyperlink{namespacefourdst}{fourdst}}::\mbox{\hyperlink{namespacefourdst_1_1atomic}{atomic}}::species.at(\textcolor{stringliteral}{"{}H-\/1"{}})),}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00041}00041\ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a391e899874cd7ef299a3ae1f64c016d2}{m\_initialized}}(false)\ \{\}\ \textcolor{comment}{//\ Note:\ Default\ entry\ is\ uninitialized,\ must\ be\ explicitly\ set.}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00042}00042\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00043}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_af27b09bb4e1ee357bb657146feb6039e}{00043}}\ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a1cccb94c150dd1dcde860f55fbeaf2bd}{CompositionEntry::CompositionEntry}}(\textcolor{keyword}{const}\ std::string\&\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a50d18b4c27611fa9314dd756af54c2f0}{symbol}},\ \textcolor{keyword}{const}\ \textcolor{keywordtype}{bool}\ massFracMode)\ :\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_ac273debdba6a1b3ac0f11698c399d38e}{m\_symbol}}(\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a50d18b4c27611fa9314dd756af54c2f0}{symbol}}),\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a79039cbdc76b4401eb2ce44b85467503}{m\_isotope}}(\mbox{\hyperlink{namespacefourdst}{fourdst}}::\mbox{\hyperlink{namespacefourdst_1_1atomic}{atomic}}::species.at(\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a50d18b4c27611fa9314dd756af54c2f0}{symbol}})),\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a1e860519bea86793413ed67c76d18c8b}{m\_massFracMode}}(massFracMode)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00044}00044\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a5885a0e33687bceb15b225a00163e9d3}{setSpecies}}(\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a50d18b4c27611fa9314dd756af54c2f0}{symbol}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00045}00045\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00046}00046\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00047}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a38f3e109b2952c1f0e7444d7fb9e93a0}{00047}}\ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a1cccb94c150dd1dcde860f55fbeaf2bd}{CompositionEntry::CompositionEntry}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a1cccb94c150dd1dcde860f55fbeaf2bd}{CompositionEntry}}\&\ entry)\ :}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00048}00048\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_ac273debdba6a1b3ac0f11698c399d38e}{m\_symbol}}(entry.\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_ac273debdba6a1b3ac0f11698c399d38e}{m\_symbol}}),}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00049}00049\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a79039cbdc76b4401eb2ce44b85467503}{m\_isotope}}(entry.\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a79039cbdc76b4401eb2ce44b85467503}{m\_isotope}}),}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00050}00050\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a1e860519bea86793413ed67c76d18c8b}{m\_massFracMode}}(entry.\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a1e860519bea86793413ed67c76d18c8b}{m\_massFracMode}}),}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00051}00051\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_adc20165bf94e18eea3458003025579ac}{m\_massFraction}}(entry.\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_adc20165bf94e18eea3458003025579ac}{m\_massFraction}}),}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00052}00052\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a2b5e245f7dabb11076efdbe1ed516d9f}{m\_numberFraction}}(entry.\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a2b5e245f7dabb11076efdbe1ed516d9f}{m\_numberFraction}}),}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00053}00053\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a0498d707d8ea78be39283786c10657ef}{m\_relAbundance}}(entry.\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a0498d707d8ea78be39283786c10657ef}{m\_relAbundance}}),}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00054}00054\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a391e899874cd7ef299a3ae1f64c016d2}{m\_initialized}}(entry.\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a391e899874cd7ef299a3ae1f64c016d2}{m\_initialized}})\ \{\}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00055}00055\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00056}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a5885a0e33687bceb15b225a00163e9d3}{00056}}\ \ \ \ \ \textcolor{keywordtype}{void}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a5885a0e33687bceb15b225a00163e9d3}{CompositionEntry::setSpecies}}(\textcolor{keyword}{const}\ std::string\&\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a50d18b4c27611fa9314dd756af54c2f0}{symbol}})\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00057}00057\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a391e899874cd7ef299a3ae1f64c016d2}{m\_initialized}})\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00058}00058\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{throw}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_entry_already_initialized_error}{exceptions::EntryAlreadyInitializedError}}(\textcolor{stringliteral}{"{}Composition\ entry\ is\ already\ initialized."{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00059}00059\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00060}00060\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (!\mbox{\hyperlink{namespacefourdst_1_1atomic_a3f619cc8f8b2cd718a4082c6adb0de90}{fourdst::atomic::species}}.contains(\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a50d18b4c27611fa9314dd756af54c2f0}{symbol}}))\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00061}00061\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{throw}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_species_symbol_error}{exceptions::InvalidSpeciesSymbolError}}(\textcolor{stringliteral}{"{}Invalid\ symbol."{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00062}00062\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00063}00063\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_ac273debdba6a1b3ac0f11698c399d38e}{m\_symbol}}\ =\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a50d18b4c27611fa9314dd756af54c2f0}{symbol}};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00064}00064\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a79039cbdc76b4401eb2ce44b85467503}{m\_isotope}}\ =\ \mbox{\hyperlink{namespacefourdst_1_1atomic_a3f619cc8f8b2cd718a4082c6adb0de90}{fourdst::atomic::species}}.at(\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a50d18b4c27611fa9314dd756af54c2f0}{symbol}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00065}00065\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a391e899874cd7ef299a3ae1f64c016d2}{m\_initialized}}\ =\ \textcolor{keyword}{true};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00066}00066\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00067}00067\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00068}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a50d18b4c27611fa9314dd756af54c2f0}{00068}}\ \ \ \ \ std::string\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a50d18b4c27611fa9314dd756af54c2f0}{CompositionEntry::symbol}}()\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00069}00069\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_ac273debdba6a1b3ac0f11698c399d38e}{m\_symbol}};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00070}00070\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00071}00071\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00072}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a66cb086719d7f654869bd7b0cee87ffc}{00072}}\ \ \ \ \ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a66cb086719d7f654869bd7b0cee87ffc}{CompositionEntry::mass\_fraction}}()\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00073}00073\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (!\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a1e860519bea86793413ed67c76d18c8b}{m\_massFracMode}})\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00074}00074\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{throw}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_mode_error}{exceptions::CompositionModeError}}(\textcolor{stringliteral}{"{}Composition\ entry\ is\ in\ number\ fraction\ mode."{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00075}00075\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00076}00076\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_adc20165bf94e18eea3458003025579ac}{m\_massFraction}};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00077}00077\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00078}00078\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00079}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a27b0ae0f7ef9469d515c4c7b6ec8dc22}{00079}}\ \ \ \ \ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a66cb086719d7f654869bd7b0cee87ffc}{CompositionEntry::mass\_fraction}}(\textcolor{keyword}{const}\ \textcolor{keywordtype}{double}\ meanMolarMass)\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00080}00080\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a1e860519bea86793413ed67c76d18c8b}{m\_massFracMode}})\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00081}00081\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_adc20165bf94e18eea3458003025579ac}{m\_massFraction}};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00082}00082\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00083}00083\ \ \ \ \ \ \ \ \ \textcolor{comment}{//\ Convert\ from\ number\ fraction\ to\ mass\ fraction\ using:\ X\_i\ =\ n\_i\ *\ A\_i\ /\ <A>}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00084}00084\ \ \ \ \ \ \ \ \ \textcolor{comment}{//\ where\ m\_relAbundance\ is\ n\_i\ *\ A\_i\ and\ meanMolarMass\ is\ <A>.}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00085}00085\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a0498d707d8ea78be39283786c10657ef}{m\_relAbundance}}\ /\ meanMolarMass;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00086}00086\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00087}00087\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00088}00088\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00089}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a2d55492d285068d4a64db5602dfb1c78}{00089}}\ \ \ \ \ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a2d55492d285068d4a64db5602dfb1c78}{CompositionEntry::number\_fraction}}()\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00090}00090\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a1e860519bea86793413ed67c76d18c8b}{m\_massFracMode}})\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00091}00091\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{throw}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_mode_error}{exceptions::CompositionModeError}}(\textcolor{stringliteral}{"{}Composition\ entry\ is\ in\ mass\ fraction\ mode."{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00092}00092\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00093}00093\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a2b5e245f7dabb11076efdbe1ed516d9f}{m\_numberFraction}};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00094}00094\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00095}00095\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00096}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_ab96d976b53f3828237525005b904a39c}{00096}}\ \ \ \ \ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a2d55492d285068d4a64db5602dfb1c78}{CompositionEntry::number\_fraction}}(\textcolor{keyword}{const}\ \textcolor{keywordtype}{double}\ totalMoles)\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00097}00097\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a1e860519bea86793413ed67c76d18c8b}{m\_massFracMode}})\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00098}00098\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{comment}{//\ Convert\ from\ mass\ fraction\ to\ number\ fraction\ using:\ n\_i\ =\ (X\_i\ /\ A\_i)\ /\ sum(X\_j\ /\ A\_j)}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00099}00099\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{comment}{//\ where\ m\_relAbundance\ is\ X\_i\ /\ A\_i\ and\ totalMoles\ is\ sum(X\_j\ /\ A\_j).}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00100}00100\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a0498d707d8ea78be39283786c10657ef}{m\_relAbundance}}\ /\ totalMoles;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00101}00101\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00102}00102\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a2b5e245f7dabb11076efdbe1ed516d9f}{m\_numberFraction}};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00103}00103\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00104}00104\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00105}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_ab6619d23e111905d1e3ab16ee822d96c}{00105}}\ \ \ \ \ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_ab6619d23e111905d1e3ab16ee822d96c}{CompositionEntry::rel\_abundance}}()\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00106}00106\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a0498d707d8ea78be39283786c10657ef}{m\_relAbundance}};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00107}00107\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00108}00108\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00109}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_af4f8d292d18755670a914072e2260dfb}{00109}}\ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{fourdst::atomic::Species}}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_af4f8d292d18755670a914072e2260dfb}{CompositionEntry::isotope}}()\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00110}00110\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a79039cbdc76b4401eb2ce44b85467503}{m\_isotope}};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00111}00111\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00112}00112\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00113}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a4d6df43e098e7e2e2d94ff7fb76cb4c2}{00113}}\ \ \ \ \ \textcolor{keywordtype}{void}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a4d6df43e098e7e2e2d94ff7fb76cb4c2}{CompositionEntry::setMassFraction}}(\textcolor{keyword}{const}\ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a66cb086719d7f654869bd7b0cee87ffc}{mass\_fraction}})\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00114}00114\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (!\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a1e860519bea86793413ed67c76d18c8b}{m\_massFracMode}})\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00115}00115\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{throw}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_mode_error}{exceptions::CompositionModeError}}(\textcolor{stringliteral}{"{}Composition\ entry\ is\ in\ number\ fraction\ mode."{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00116}00116\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00117}00117\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_adc20165bf94e18eea3458003025579ac}{m\_massFraction}}\ =\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a66cb086719d7f654869bd7b0cee87ffc}{mass\_fraction}};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00118}00118\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a0498d707d8ea78be39283786c10657ef}{m\_relAbundance}}\ =\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_adc20165bf94e18eea3458003025579ac}{m\_massFraction}}\ /\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a79039cbdc76b4401eb2ce44b85467503}{m\_isotope}}.mass();}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00119}00119\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00120}00120\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00121}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a9ec47cf4b3399128d3836c1b24b031b0}{00121}}\ \ \ \ \ \textcolor{keywordtype}{void}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a9ec47cf4b3399128d3836c1b24b031b0}{CompositionEntry::setNumberFraction}}(\textcolor{keyword}{const}\ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a2d55492d285068d4a64db5602dfb1c78}{number\_fraction}})\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00122}00122\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a1e860519bea86793413ed67c76d18c8b}{m\_massFracMode}})\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00123}00123\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{throw}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_mode_error}{exceptions::CompositionModeError}}(\textcolor{stringliteral}{"{}Composition\ entry\ is\ in\ mass\ fraction\ mode."{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00124}00124\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00125}00125\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a2b5e245f7dabb11076efdbe1ed516d9f}{m\_numberFraction}}\ =\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a2d55492d285068d4a64db5602dfb1c78}{number\_fraction}};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00126}00126\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a0498d707d8ea78be39283786c10657ef}{m\_relAbundance}}\ =\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a2b5e245f7dabb11076efdbe1ed516d9f}{m\_numberFraction}}\ *\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a79039cbdc76b4401eb2ce44b85467503}{m\_isotope}}.mass();}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00127}00127\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00128}00128\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00129}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a3fb3f63a4e5675c6fefb662a8e3e7aa3}{00129}}\ \ \ \ \ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a3fb3f63a4e5675c6fefb662a8e3e7aa3}{CompositionEntry::setMassFracMode}}(\textcolor{keyword}{const}\ \textcolor{keywordtype}{double}\ meanParticleMass)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00130}00130\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a1e860519bea86793413ed67c76d18c8b}{m\_massFracMode}})\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00131}00131\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \textcolor{keyword}{false};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00132}00132\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00133}00133\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a1e860519bea86793413ed67c76d18c8b}{m\_massFracMode}}\ =\ \textcolor{keyword}{true};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00134}00134\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_adc20165bf94e18eea3458003025579ac}{m\_massFraction}}\ =\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a0498d707d8ea78be39283786c10657ef}{m\_relAbundance}}\ /\ meanParticleMass;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00135}00135\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \textcolor{keyword}{true};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00136}00136\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00137}00137\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00138}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a743042d1998875851150d789817f5473}{00138}}\ \ \ \ \ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a743042d1998875851150d789817f5473}{CompositionEntry::setNumberFracMode}}(\textcolor{keyword}{const}\ \textcolor{keywordtype}{double}\ specificNumberDensity)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00139}00139\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (!\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a1e860519bea86793413ed67c76d18c8b}{m\_massFracMode}})\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00140}00140\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \textcolor{keyword}{false};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00141}00141\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00142}00142\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a1e860519bea86793413ed67c76d18c8b}{m\_massFracMode}}\ =\ \textcolor{keyword}{false};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00143}00143\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a2b5e245f7dabb11076efdbe1ed516d9f}{m\_numberFraction}}\ =\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a0498d707d8ea78be39283786c10657ef}{m\_relAbundance}}\ /\ specificNumberDensity;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00144}00144\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \textcolor{keyword}{true};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00145}00145\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00146}00146\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00147}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a14f12b8b0178df2e32e2023bd4564ddc}{00147}}\ \ \ \ \ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a14f12b8b0178df2e32e2023bd4564ddc}{CompositionEntry::getMassFracMode}}()\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00148}00148\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a1e860519bea86793413ed67c76d18c8b}{m\_massFracMode}};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00149}00149\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00150}00150\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00151}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ae3cc2099efd7db8eec3d9af2294b75fa}{00151}}\ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a23b83b76ee025f6fc009184ee19bba88}{Composition::Composition}}(\textcolor{keyword}{const}\ std::vector<std::string>\&\ symbols)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00152}00152\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{for}\ (\textcolor{keyword}{const}\ \textcolor{keyword}{auto}\&\ symbol\ :\ symbols)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00153}00153\ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a1bc2e64f87c12befdc2bc767e7405661}{registerSymbol}}(symbol);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00154}00154\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00155}00155\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00156}00156\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00157}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a2d6fbe5c8142b358641bbe7ffde51053}{00157}}\ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a23b83b76ee025f6fc009184ee19bba88}{Composition::Composition}}(\textcolor{keyword}{const}\ std::set<std::string>\&\ symbols)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00158}00158\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{for}\ (\textcolor{keyword}{const}\ \textcolor{keyword}{auto}\&\ symbol\ :\ symbols)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00159}00159\ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a1bc2e64f87c12befdc2bc767e7405661}{registerSymbol}}(symbol);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00160}00160\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00161}00161\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00162}00162\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00163}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_af4d4cc5875cba931a91faee13f55594e}{00163}}\ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a23b83b76ee025f6fc009184ee19bba88}{Composition::Composition}}(\textcolor{keyword}{const}\ std::vector<std::string>\&\ symbols,\ \textcolor{keyword}{const}\ std::vector<double>\&\ fractions,\ \textcolor{keyword}{const}\ \textcolor{keywordtype}{bool}\ massFracMode)\ :\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a671f1ee8be00f4ff8c1d94fabb382380}{m\_massFracMode}}(massFracMode)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00164}00164\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (symbols.size()\ !=\ fractions.size())\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00165}00165\ \ \ \ \ \ \ \ \ \ \ \ \ LOG\_CRITICAL(m\_logger,\ \textcolor{stringliteral}{"{}The\ number\ of\ symbols\ and\ fractions\ must\ be\ equal\ (got\ \{\}\ symbols\ and\ \{\}\ fractions)."{}},\ symbols.size(),\ fractions.size());}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00166}00166\ \ \ \ \ \ \ \ \ \ \ \ \ throw\ exceptions::InvalidCompositionError(\textcolor{stringliteral}{"{}The\ number\ of\ symbols\ and\ fractions\ must\ be\ equal.\ Got\ "{}}\ +\ std::to\_string(symbols.size())\ +\ \textcolor{stringliteral}{"{}\ symbols\ and\ "{}}\ +\ std::to\_string(fractions.size())\ +\ \textcolor{stringliteral}{"{}\ fractions."{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00167}00167\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00168}00168\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00169}00169\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a86982685c34db4a8f079ddafc25c594e}{validateComposition}}(fractions);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00170}00170\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00171}00171\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{for}\ (\textcolor{keyword}{const}\ \textcolor{keyword}{auto}\ \&symbol\ :\ symbols)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00172}00172\ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a1bc2e64f87c12befdc2bc767e7405661}{registerSymbol}}(symbol);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00173}00173\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00174}00174\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00175}00175\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{for}\ (\textcolor{keywordtype}{size\_t}\ i\ =\ 0;\ i\ <\ symbols.size();\ ++i)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00176}00176\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a671f1ee8be00f4ff8c1d94fabb382380}{m\_massFracMode}})\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00177}00177\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a493224656aa3ade68389250720ef09af}{setMassFraction}}(symbols[i],\ fractions[i]);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00178}00178\ \ \ \ \ \ \ \ \ \ \ \ \ \}\ \textcolor{keywordflow}{else}\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00179}00179\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a7d4d748f3ee25e68751fb143717ed080}{setNumberFraction}}(symbols[i],\ fractions[i]);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00180}00180\ \ \ \ \ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00181}00181\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00182}00182\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a72d063a74a9d2197065884a2cea57a14}{finalize}}();}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00183}00183\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00184}00184\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00185}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a21369a80378d4c90438a34f0e4a275ca}{00185}}\ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a23b83b76ee025f6fc009184ee19bba88}{Composition::Composition}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a23b83b76ee025f6fc009184ee19bba88}{Composition}}\ \&\mbox{\hyperlink{namespacefourdst_1_1composition}{composition}})\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00186}00186\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa00cbc0933d8a22bb900ac21a338e5ac}{m\_finalized}}\ =\ \mbox{\hyperlink{namespacefourdst_1_1composition}{composition}}.m\_finalized;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00187}00187\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_addae4484da7d5072ab66a721dbe04ced}{m\_specificNumberDensity}}\ =\ \mbox{\hyperlink{namespacefourdst_1_1composition}{composition}}.m\_specificNumberDensity;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00188}00188\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a4a36c8d22ce61023e7bea1d9417577d4}{m\_meanParticleMass}}\ =\ \mbox{\hyperlink{namespacefourdst_1_1composition}{composition}}.m\_meanParticleMass;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00189}00189\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a671f1ee8be00f4ff8c1d94fabb382380}{m\_massFracMode}}\ =\ \mbox{\hyperlink{namespacefourdst_1_1composition}{composition}}.m\_massFracMode;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00190}00190\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a39bfcb7d81d723cbd9d021abd533b4d6}{m\_registeredSymbols}}\ =\ \mbox{\hyperlink{namespacefourdst_1_1composition}{composition}}.m\_registeredSymbols;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00191}00191\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa7f2753b10e85ae3bbf0c3d600a973db}{m\_compositions}}\ =\ \mbox{\hyperlink{namespacefourdst_1_1composition}{composition}}.m\_compositions;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00192}00192\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00193}00193\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00194}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a4ec1e23cfecef764cb831171fed62fc2}{00194}}\ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a23b83b76ee025f6fc009184ee19bba88}{Composition}}\&\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a4ec1e23cfecef764cb831171fed62fc2}{Composition::operator=}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a23b83b76ee025f6fc009184ee19bba88}{Composition}}\ \&other)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00195}00195\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (\textcolor{keyword}{this}\ !=\ \&other)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00196}00196\ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa00cbc0933d8a22bb900ac21a338e5ac}{m\_finalized}}\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ =\ other.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa00cbc0933d8a22bb900ac21a338e5ac}{m\_finalized}};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00197}00197\ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_addae4484da7d5072ab66a721dbe04ced}{m\_specificNumberDensity}}\ \ \ =\ other.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_addae4484da7d5072ab66a721dbe04ced}{m\_specificNumberDensity}};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00198}00198\ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a4a36c8d22ce61023e7bea1d9417577d4}{m\_meanParticleMass}}\ \ \ \ \ \ \ \ =\ other.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a4a36c8d22ce61023e7bea1d9417577d4}{m\_meanParticleMass}};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00199}00199\ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a671f1ee8be00f4ff8c1d94fabb382380}{m\_massFracMode}}\ \ \ \ \ \ \ \ \ \ \ \ =\ other.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a671f1ee8be00f4ff8c1d94fabb382380}{m\_massFracMode}};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00200}00200\ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a39bfcb7d81d723cbd9d021abd533b4d6}{m\_registeredSymbols}}\ \ \ \ \ \ \ =\ other.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a39bfcb7d81d723cbd9d021abd533b4d6}{m\_registeredSymbols}};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00201}00201\ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa7f2753b10e85ae3bbf0c3d600a973db}{m\_compositions}}\ \ \ \ \ \ \ \ \ \ \ \ =\ other.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa7f2753b10e85ae3bbf0c3d600a973db}{m\_compositions}};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00202}00202\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{comment}{//\ note:\ m\_config\ remains\ bound\ to\ the\ same\ singleton,\ so\ we\ skip\ it}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00203}00203\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00204}00204\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ *\textcolor{keyword}{this};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00205}00205\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00206}00206\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00207}00207\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00208}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a1bc2e64f87c12befdc2bc767e7405661}{00208}}\ \ \ \ \ \textcolor{keywordtype}{void}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a1bc2e64f87c12befdc2bc767e7405661}{Composition::registerSymbol}}(\textcolor{keyword}{const}\ std::string\&\ symbol,\ \textcolor{keywordtype}{bool}\ massFracMode)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00209}00209\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (!\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a8fdac26e6298008aaeaa5b15f7fe244f}{isValidSymbol}}(symbol))\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00210}00210\ \ \ \ \ \ \ \ \ \ \ \ \ LOG\_ERROR(\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ab6c66f35e1fb05dd24aacaf90e115c5e}{m\_logger}},\ \textcolor{stringliteral}{"{}Invalid\ symbol:\ \{\}"{}},\ symbol);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00211}00211\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{throw}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_symbol_error}{exceptions::InvalidSymbolError}}(\textcolor{stringliteral}{"{}Invalid\ symbol:\ "{}}\ +\ symbol);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00212}00212\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00213}00213\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00214}00214\ \ \ \ \ \ \ \ \ \textcolor{comment}{//\ If\ no\ symbols\ have\ been\ registered\ allow\ mode\ to\ be\ set}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00215}00215\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a39bfcb7d81d723cbd9d021abd533b4d6}{m\_registeredSymbols}}.empty())\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00216}00216\ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a671f1ee8be00f4ff8c1d94fabb382380}{m\_massFracMode}}\ =\ massFracMode;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00217}00217\ \ \ \ \ \ \ \ \ \}\ \textcolor{keywordflow}{else}\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00218}00218\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a671f1ee8be00f4ff8c1d94fabb382380}{m\_massFracMode}}\ !=\ massFracMode)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00219}00219\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ LOG\_ERROR(\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ab6c66f35e1fb05dd24aacaf90e115c5e}{m\_logger}},\ \textcolor{stringliteral}{"{}Composition\ is\ in\ mass\ fraction\ mode.\ Cannot\ register\ symbol\ (\{\})\ in\ number\ fraction\ mode."{}},\ symbol);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00220}00220\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{throw}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_mode_error}{exceptions::CompositionModeError}}(\textcolor{stringliteral}{"{}Composition\ is\ in\ mass\ fraction\ mode.\ Cannot\ register\ symbol\ ("{}}\ +\ symbol\ +\ \textcolor{stringliteral}{"{})\ in\ number\ fraction\ mode."{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00221}00221\ \ \ \ \ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00222}00222\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00223}00223\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00224}00224\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a39bfcb7d81d723cbd9d021abd533b4d6}{m\_registeredSymbols}}.contains(symbol))\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00225}00225\ \ \ \ \ \ \ \ \ \ \ \ \ LOG\_WARNING(\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ab6c66f35e1fb05dd24aacaf90e115c5e}{m\_logger}},\ \textcolor{stringliteral}{"{}Symbol\ \{\}\ is\ already\ registered."{}},\ symbol);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00226}00226\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00227}00227\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00228}00228\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00229}00229\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a39bfcb7d81d723cbd9d021abd533b4d6}{m\_registeredSymbols}}.insert(symbol);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00230}00230\ \ \ \ \ \ \ \ \ \textcolor{keyword}{const}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry}{CompositionEntry}}\ entry(symbol,\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a671f1ee8be00f4ff8c1d94fabb382380}{m\_massFracMode}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00231}00231\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa7f2753b10e85ae3bbf0c3d600a973db}{m\_compositions}}[symbol]\ =\ entry;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00232}00232\ \ \ \ \ \ \ \ \ LOG\_TRACE\_L3(\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ab6c66f35e1fb05dd24aacaf90e115c5e}{m\_logger}},\ \textcolor{stringliteral}{"{}Registered\ symbol:\ \{\}"{}},\ symbol);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00233}00233\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00234}00234\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00235}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a9b422156600823276a9606bfa07ad4db}{00235}}\ \ \ \ \ \textcolor{keywordtype}{void}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a1bc2e64f87c12befdc2bc767e7405661}{Composition::registerSymbol}}(\textcolor{keyword}{const}\ std::vector<std::string>\&\ symbols,\ \textcolor{keywordtype}{bool}\ massFracMode)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00236}00236\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{for}\ (\textcolor{keyword}{const}\ \textcolor{keyword}{auto}\&\ symbol\ :\ symbols)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00237}00237\ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a1bc2e64f87c12befdc2bc767e7405661}{registerSymbol}}(symbol,\ massFracMode);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00238}00238\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00239}00239\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00240}00240\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00241}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a4ce00f73cc133bb1bac2b030b93ab480}{00241}}\ \ \ \ \ \textcolor{keywordtype}{void}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a4ce00f73cc133bb1bac2b030b93ab480}{Composition::registerSpecies}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{fourdst::atomic::Species}}\ \&species,\ \textcolor{keywordtype}{bool}\ massFracMode)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00242}00242\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a1bc2e64f87c12befdc2bc767e7405661}{registerSymbol}}(std::string(species.\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a1fcc01fc978b34ba2531117f10be6741}{name}}()));}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00243}00243\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00244}00244\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00245}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a057f2bf2e86bcc3c649c0ddf18cf3826}{00245}}\ \ \ \ \ \textcolor{keywordtype}{void}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a4ce00f73cc133bb1bac2b030b93ab480}{Composition::registerSpecies}}(\textcolor{keyword}{const}\ std::vector<fourdst::atomic::Species>\ \&species,\ \textcolor{keywordtype}{bool}\ massFracMode)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00246}00246\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{for}\ (\textcolor{keyword}{const}\ \textcolor{keyword}{auto}\&\ s\ :\ species)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00247}00247\ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a4ce00f73cc133bb1bac2b030b93ab480}{registerSpecies}}(s,\ massFracMode);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00248}00248\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00249}00249\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00250}00250\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00251}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a84c7b72c2aee46b94492d404855dd3e0}{00251}}\ \ \ \ \ std::set<std::string>\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a84c7b72c2aee46b94492d404855dd3e0}{Composition::getRegisteredSymbols}}()\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00252}00252\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a39bfcb7d81d723cbd9d021abd533b4d6}{m\_registeredSymbols}};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00253}00253\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00254}00254\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00255}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a3dee7b5e1f54920de9eab99f95a516ec}{00255}}\ \ \ \ \ std::set<fourdst::atomic::Species>\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a3dee7b5e1f54920de9eab99f95a516ec}{Composition::getRegisteredSpecies}}()\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00256}00256\ \ \ \ \ \ \ \ \ std::set<fourdst::atomic::Species>\ result;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00257}00257\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{for}\ (\textcolor{keyword}{const}\ \textcolor{keyword}{auto}\&\ entry\ :\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa7f2753b10e85ae3bbf0c3d600a973db}{m\_compositions}}\ |\ std::views::values)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00258}00258\ \ \ \ \ \ \ \ \ \ \ \ \ result.insert(entry.isotope());}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00259}00259\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00260}00260\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ result;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00261}00261\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00262}00262\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00263}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a86982685c34db4a8f079ddafc25c594e}{00263}}\ \ \ \ \ \textcolor{keywordtype}{void}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a86982685c34db4a8f079ddafc25c594e}{Composition::validateComposition}}(\textcolor{keyword}{const}\ std::vector<double>\&\ fractions)\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00264}00264\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (!\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_addf03ba8b988970d341884d487aa94d5}{isValidComposition}}(fractions))\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00265}00265\ \ \ \ \ \ \ \ \ \ \ \ \ LOG\_ERROR(\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ab6c66f35e1fb05dd24aacaf90e115c5e}{m\_logger}},\ \textcolor{stringliteral}{"{}Invalid\ composition."{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00266}00266\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{throw}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_composition_error}{exceptions::InvalidCompositionError}}(\textcolor{stringliteral}{"{}Invalid\ composition."{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00267}00267\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00268}00268\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00269}00269\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00270}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_addf03ba8b988970d341884d487aa94d5}{00270}}\ \ \ \ \ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_addf03ba8b988970d341884d487aa94d5}{Composition::isValidComposition}}(\textcolor{keyword}{const}\ std::vector<double>\&\ fractions)\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00271}00271\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{double}\ sum\ =\ 0.0;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00272}00272\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{for}\ (\textcolor{keyword}{const}\ \textcolor{keyword}{auto}\&\ fraction\ :\ fractions)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00273}00273\ \ \ \ \ \ \ \ \ \ \ \ \ sum\ +=\ fraction;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00274}00274\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00275}00275\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (sum\ <\ 0.999999\ ||\ sum\ >\ 1.000001)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00276}00276\ \ \ \ \ \ \ \ \ \ \ \ \ LOG\_ERROR(\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ab6c66f35e1fb05dd24aacaf90e115c5e}{m\_logger}},\ \textcolor{stringliteral}{"{}The\ sum\ of\ fractions\ must\ be\ equal\ to\ 1\ (expected\ 1,\ got\ \{\})."{}},\ sum);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00277}00277\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \textcolor{keyword}{false};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00278}00278\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00279}00279\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00280}00280\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \textcolor{keyword}{true};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00281}00281\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00282}00282\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00283}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a8fdac26e6298008aaeaa5b15f7fe244f}{00283}}\ \ \ \ \ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a8fdac26e6298008aaeaa5b15f7fe244f}{Composition::isValidSymbol}}(\textcolor{keyword}{const}\ std::string\&\ symbol)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00284}00284\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{namespacefourdst_1_1atomic_a3f619cc8f8b2cd718a4082c6adb0de90}{fourdst::atomic::species}}.contains(symbol);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00285}00285\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00286}00286\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00287}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a493224656aa3ade68389250720ef09af}{00287}}\ \ \ \ \ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a493224656aa3ade68389250720ef09af}{Composition::setMassFraction}}(\textcolor{keyword}{const}\ std::string\&\ symbol,\ \textcolor{keyword}{const}\ \textcolor{keywordtype}{double}\&\ mass\_fraction)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00288}00288\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (!\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a39bfcb7d81d723cbd9d021abd533b4d6}{m\_registeredSymbols}}.contains(symbol))\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00289}00289\ \ \ \ \ \ \ \ \ \ \ \ \ LOG\_ERROR(\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ab6c66f35e1fb05dd24aacaf90e115c5e}{m\_logger}},\ \textcolor{stringliteral}{"{}Symbol\ \{\}\ is\ not\ registered."{}},\ symbol);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00290}00290\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{throw}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_unregistered_symbol_error}{exceptions::UnregisteredSymbolError}}(\textcolor{stringliteral}{"{}Symbol\ ("{}}\ +\ symbol\ +\ \textcolor{stringliteral}{"{})\ is\ not\ registered."{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00291}00291\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00292}00292\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00293}00293\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (!\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a671f1ee8be00f4ff8c1d94fabb382380}{m\_massFracMode}})\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00294}00294\ \ \ \ \ \ \ \ \ \ \ \ \ LOG\_ERROR(\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ab6c66f35e1fb05dd24aacaf90e115c5e}{m\_logger}},\ \textcolor{stringliteral}{"{}Composition\ is\ in\ number\ fraction\ mode."{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00295}00295\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{throw}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_mode_error}{exceptions::CompositionModeError}}(\textcolor{stringliteral}{"{}Composition\ is\ in\ number\ fraction\ mode."{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00296}00296\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00297}00297\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00298}00298\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (mass\_fraction\ <\ 0.0\ ||\ mass\_fraction\ >\ 1.0)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00299}00299\ \ \ \ \ \ \ \ \ \ \ \ \ LOG\_ERROR(\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ab6c66f35e1fb05dd24aacaf90e115c5e}{m\_logger}},\ \textcolor{stringliteral}{"{}Mass\ fraction\ must\ be\ between\ 0\ and\ 1\ for\ symbol\ \{\}.\ Currently\ it\ is\ \{\}."{}},\ symbol,\ mass\_fraction);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00300}00300\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{throw}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_composition_error}{exceptions::InvalidCompositionError}}(\textcolor{stringliteral}{"{}Mass\ fraction\ must\ be\ between\ 0\ and\ 1\ for\ symbol\ "{}}\ +\ symbol\ +\ \textcolor{stringliteral}{"{}.\ Currently\ it\ is\ "{}}\ +\ std::to\_string(mass\_fraction)\ +\ \textcolor{stringliteral}{"{}."{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00301}00301\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00302}00302\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00303}00303\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa00cbc0933d8a22bb900ac21a338e5ac}{m\_finalized}}\ =\ \textcolor{keyword}{false};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00304}00304\ \ \ \ \ \ \ \ \ \textcolor{keyword}{const}\ \textcolor{keywordtype}{double}\ old\_mass\_fraction\ =\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa7f2753b10e85ae3bbf0c3d600a973db}{m\_compositions}}.at(symbol).mass\_fraction();}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00305}00305\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa7f2753b10e85ae3bbf0c3d600a973db}{m\_compositions}}.at(symbol).setMassFraction(mass\_fraction);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00306}00306\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00307}00307\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ old\_mass\_fraction;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00308}00308\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00309}00309\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00310}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a66ce1012c12b0a83629eb09d451b68e3}{00310}}\ \ \ \ \ std::vector<double>\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a493224656aa3ade68389250720ef09af}{Composition::setMassFraction}}(\textcolor{keyword}{const}\ std::vector<std::string>\&\ symbols,\ \textcolor{keyword}{const}\ std::vector<double>\&\ mass\_fractions)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00311}00311\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (symbols.size()\ !=\ mass\_fractions.size())\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00312}00312\ \ \ \ \ \ \ \ \ \ \ \ \ LOG\_ERROR(\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ab6c66f35e1fb05dd24aacaf90e115c5e}{m\_logger}},\ \textcolor{stringliteral}{"{}The\ number\ of\ symbols\ and\ mass\ fractions\ must\ be\ equal\ (currently\ \{\}\ symbols\ and\ \{\}\ mass\ fractions)."{}},\ symbols.size(),\ mass\_fractions.size());}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00313}00313\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{throw}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_composition_error}{exceptions::InvalidCompositionError}}(\textcolor{stringliteral}{"{}The\ number\ of\ symbols\ and\ mass\ fractions\ must\ be\ equal\ (currently\ "{}}\ +\ std::to\_string(symbols.size())\ +\ \textcolor{stringliteral}{"{}\ symbols\ and\ "{}}\ +\ std::to\_string(mass\_fractions.size())\ +\ \textcolor{stringliteral}{"{}\ mass\ fractions)."{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00314}00314\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00315}00315\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00316}00316\ \ \ \ \ \ \ \ \ std::vector<double>\ old\_mass\_fractions;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00317}00317\ \ \ \ \ \ \ \ \ old\_mass\_fractions.reserve(symbols.size());}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00318}00318\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{for}\ (\textcolor{keywordtype}{size\_t}\ i\ =\ 0;\ i\ <\ symbols.size();\ ++i)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00319}00319\ \ \ \ \ \ \ \ \ \ \ \ \ old\_mass\_fractions.push\_back(\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a493224656aa3ade68389250720ef09af}{setMassFraction}}(symbols[i],\ mass\_fractions[i]));}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00320}00320\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00321}00321\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ old\_mass\_fractions;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00322}00322\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00323}00323\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00324}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa6c94269a5d16349c98860f3015b734a}{00324}}\ \ \ \ \ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a493224656aa3ade68389250720ef09af}{Composition::setMassFraction}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{fourdst::atomic::Species}}\ \&species,\ \textcolor{keyword}{const}\ \textcolor{keywordtype}{double}\ \&mass\_fraction)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00325}00325\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a493224656aa3ade68389250720ef09af}{setMassFraction}}(std::string(species.\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a1fcc01fc978b34ba2531117f10be6741}{name}}()),\ mass\_fraction);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00326}00326\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00327}00327\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00328}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_abbae020d46c74708a7974c1ca755bb62}{00328}}\ \ \ \ \ std::vector<double>\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a493224656aa3ade68389250720ef09af}{Composition::setMassFraction}}(\textcolor{keyword}{const}\ std::vector<fourdst::atomic::Species>\ \&species,}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00329}00329\ \ \ \ \ \ \ \ \ \textcolor{keyword}{const}\ std::vector<double>\ \&mass\_fractions)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00330}00330\ \ \ \ \ \ \ \ \ std::vector<double>\ old\_mass\_fractions;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00331}00331\ \ \ \ \ \ \ \ \ old\_mass\_fractions.reserve(species.size());}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00332}00332\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{for}\ (\textcolor{keyword}{const}\ \textcolor{keyword}{auto}\&\ spec\ :\ species)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00333}00333\ \ \ \ \ \ \ \ \ \ \ \ \ old\_mass\_fractions.push\_back(\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a493224656aa3ade68389250720ef09af}{setMassFraction}}(spec,\ mass\_fractions[\&spec\ -\/\ \&species[0]]));}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00334}00334\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00335}00335\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ old\_mass\_fractions;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00336}00336\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00337}00337\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00338}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a7d4d748f3ee25e68751fb143717ed080}{00338}}\ \ \ \ \ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a7d4d748f3ee25e68751fb143717ed080}{Composition::setNumberFraction}}(\textcolor{keyword}{const}\ std::string\&\ symbol,\ \textcolor{keyword}{const}\ \textcolor{keywordtype}{double}\&\ number\_fraction)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00339}00339\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (!\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a39bfcb7d81d723cbd9d021abd533b4d6}{m\_registeredSymbols}}.contains(symbol))\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00340}00340\ \ \ \ \ \ \ \ \ \ \ \ \ LOG\_ERROR(\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ab6c66f35e1fb05dd24aacaf90e115c5e}{m\_logger}},\ \textcolor{stringliteral}{"{}Symbol\ \{\}\ is\ not\ registered."{}},\ symbol);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00341}00341\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{throw}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_unregistered_symbol_error}{exceptions::UnregisteredSymbolError}}(\textcolor{stringliteral}{"{}Symbol\ ("{}}\ +\ symbol\ +\ \textcolor{stringliteral}{"{})\ is\ not\ registered."{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00342}00342\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00343}00343\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00344}00344\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a671f1ee8be00f4ff8c1d94fabb382380}{m\_massFracMode}})\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00345}00345\ \ \ \ \ \ \ \ \ \ \ \ \ LOG\_ERROR(\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ab6c66f35e1fb05dd24aacaf90e115c5e}{m\_logger}},\ \textcolor{stringliteral}{"{}Composition\ is\ in\ mass\ fraction\ mode,\ should\ be\ in\ number\ fraction\ mode\ to\ call\ setNumberFraction.\ Hint:\ The\ mode\ can\ be\ switched\ by\ first\ finalizing\ and\ then\ calling\ setCompositionMode(false)."{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00346}00346\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{throw}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_mode_error}{exceptions::CompositionModeError}}(\textcolor{stringliteral}{"{}Composition\ is\ in\ mass\ fraction\ mode,\ should\ be\ in\ number\ fraction\ mode\ to\ call\ setNumberFraction.\ Hint:\ The\ mode\ can\ be\ switched\ by\ first\ finalizing\ and\ then\ calling\ setCompositionMode(false)."{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00347}00347\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00348}00348\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00349}00349\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (number\_fraction\ <\ 0.0\ ||\ number\_fraction\ >\ 1.0)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00350}00350\ \ \ \ \ \ \ \ \ \ \ \ \ LOG\_ERROR(\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ab6c66f35e1fb05dd24aacaf90e115c5e}{m\_logger}},\ \textcolor{stringliteral}{"{}Number\ fraction\ must\ be\ between\ 0\ and\ 1\ for\ symbol\ \{\}.\ Currently\ it\ is\ \{\}."{}},\ symbol,\ number\_fraction);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00351}00351\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{throw}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_composition_error}{exceptions::InvalidCompositionError}}(\textcolor{stringliteral}{"{}Number\ fraction\ must\ be\ between\ 0\ and\ 1\ for\ symbol\ "{}}\ +\ symbol\ +\ \textcolor{stringliteral}{"{}.\ Currently\ it\ is\ "{}}\ +\ std::to\_string(number\_fraction)\ +\ \textcolor{stringliteral}{"{}."{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00352}00352\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00353}00353\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00354}00354\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa00cbc0933d8a22bb900ac21a338e5ac}{m\_finalized}}\ =\ \textcolor{keyword}{false};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00355}00355\ \ \ \ \ \ \ \ \ \textcolor{keyword}{const}\ \textcolor{keywordtype}{double}\ old\_number\_fraction\ =\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa7f2753b10e85ae3bbf0c3d600a973db}{m\_compositions}}.at(symbol).number\_fraction();}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00356}00356\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa7f2753b10e85ae3bbf0c3d600a973db}{m\_compositions}}.at(symbol).setNumberFraction(number\_fraction);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00357}00357\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00358}00358\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ old\_number\_fraction;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00359}00359\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00360}00360\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00361}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a48014a0a725ebd91ad1193c063b5b26f}{00361}}\ \ \ \ \ std::vector<double>\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a7d4d748f3ee25e68751fb143717ed080}{Composition::setNumberFraction}}(\textcolor{keyword}{const}\ std::vector<std::string>\&\ symbols,\ \textcolor{keyword}{const}\ std::vector<double>\&\ number\_fractions)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00362}00362\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (symbols.size()\ !=\ number\_fractions.size())\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00363}00363\ \ \ \ \ \ \ \ \ \ \ \ \ LOG\_ERROR(\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ab6c66f35e1fb05dd24aacaf90e115c5e}{m\_logger}},\ \textcolor{stringliteral}{"{}The\ number\ of\ symbols\ and\ number\ fractions\ must\ be\ equal.\ (Currently\ \{\}\ symbols\ and\ \{\}\ number\ fractions)."{}},\ symbols.size(),\ number\_fractions.size());}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00364}00364\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{throw}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_composition_error}{exceptions::InvalidCompositionError}}(\textcolor{stringliteral}{"{}The\ number\ of\ symbols\ and\ number\ fractions\ must\ be\ equal.\ (Currently\ "{}}\ +\ std::to\_string(symbols.size())\ +\ \textcolor{stringliteral}{"{}\ symbols\ and\ "{}}\ +\ std::to\_string(number\_fractions.size())\ +\ \textcolor{stringliteral}{"{}\ number\ fractions)."{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00365}00365\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00366}00366\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00367}00367\ \ \ \ \ \ \ \ \ std::vector<double>\ old\_number\_fractions;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00368}00368\ \ \ \ \ \ \ \ \ old\_number\_fractions.reserve(symbols.size());}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00369}00369\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{for}\ (\textcolor{keywordtype}{size\_t}\ i\ =\ 0;\ i\ <\ symbols.size();\ ++i)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00370}00370\ \ \ \ \ \ \ \ \ \ \ \ \ old\_number\_fractions.push\_back(\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a7d4d748f3ee25e68751fb143717ed080}{setNumberFraction}}(symbols[i],\ number\_fractions[i]));}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00371}00371\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00372}00372\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ old\_number\_fractions;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00373}00373\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00374}00374\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00375}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aaa822bb48a948d101fef759ffbefe31b}{00375}}\ \ \ \ \ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a7d4d748f3ee25e68751fb143717ed080}{Composition::setNumberFraction}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{fourdst::atomic::Species}}\ \&species,\ \textcolor{keyword}{const}\ \textcolor{keywordtype}{double}\ \&number\_fraction)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00376}00376\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a7d4d748f3ee25e68751fb143717ed080}{setNumberFraction}}(std::string(species.\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a1fcc01fc978b34ba2531117f10be6741}{name}}()),\ number\_fraction);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00377}00377\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00378}00378\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00379}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_adc068778a1ef33cad67f5ca028b49bb8}{00379}}\ \ \ \ \ std::vector<double>\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a7d4d748f3ee25e68751fb143717ed080}{Composition::setNumberFraction}}(\textcolor{keyword}{const}\ std::vector<fourdst::atomic::Species>\ \&species,}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00380}00380\ \ \ \ \ \ \ \ \ \textcolor{keyword}{const}\ std::vector<double>\ \&number\_fractions)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00381}00381\ \ \ \ \ \ \ \ \ std::vector<double>\ old\_number\_fractions;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00382}00382\ \ \ \ \ \ \ \ \ old\_number\_fractions.reserve(species.size());}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00383}00383\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{for}\ (\textcolor{keyword}{const}\ \textcolor{keyword}{auto}\&\ spec\ :\ species)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00384}00384\ \ \ \ \ \ \ \ \ \ \ \ \ old\_number\_fractions.push\_back(\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a7d4d748f3ee25e68751fb143717ed080}{setNumberFraction}}(spec,\ number\_fractions[\&spec\ -\/\ \&species[0]]));}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00385}00385\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00386}00386\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ old\_number\_fractions;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00387}00387\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00388}00388\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00389}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a72d063a74a9d2197065884a2cea57a14}{00389}}\ \ \ \ \ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a72d063a74a9d2197065884a2cea57a14}{Composition::finalize}}(\textcolor{keyword}{const}\ \textcolor{keywordtype}{bool}\ norm)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00390}00390\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{bool}\ finalized\ =\ \textcolor{keyword}{false};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00391}00391\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a671f1ee8be00f4ff8c1d94fabb382380}{m\_massFracMode}})\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00392}00392\ \ \ \ \ \ \ \ \ \ \ \ \ finalized\ =\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a869dbae3db9d09c57b2df56a813a55fb}{finalizeMassFracMode}}(norm);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00393}00393\ \ \ \ \ \ \ \ \ \}\ \textcolor{keywordflow}{else}\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00394}00394\ \ \ \ \ \ \ \ \ \ \ \ \ finalized\ =\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a461ab4e9cb5975cf865db5f16f03ddfe}{finalizeNumberFracMode}}(norm);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00395}00395\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00396}00396\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (finalized)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00397}00397\ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa00cbc0933d8a22bb900ac21a338e5ac}{m\_finalized}}\ =\ \textcolor{keyword}{true};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00398}00398\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00399}00399\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ finalized;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00400}00400\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00401}00401\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00402}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a869dbae3db9d09c57b2df56a813a55fb}{00402}}\ \ \ \ \ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a869dbae3db9d09c57b2df56a813a55fb}{Composition::finalizeMassFracMode}}(\textcolor{keywordtype}{bool}\ norm)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00403}00403\ \ \ \ \ \ \ \ \ std::vector<double>\ mass\_fractions;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00404}00404\ \ \ \ \ \ \ \ \ mass\_fractions.reserve(\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa7f2753b10e85ae3bbf0c3d600a973db}{m\_compositions}}.size());}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00405}00405\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{for}\ (\textcolor{keyword}{const}\ \textcolor{keyword}{auto}\ \&entry:\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa7f2753b10e85ae3bbf0c3d600a973db}{m\_compositions}}\ |\ std::views::values)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00406}00406\ \ \ \ \ \ \ \ \ \ \ \ \ mass\_fractions.push\_back(entry.mass\_fraction());}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00407}00407\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00408}00408\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (norm)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00409}00409\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{double}\ sum\ =\ 0.0;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00410}00410\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{for}\ (\textcolor{keyword}{const}\ \textcolor{keyword}{auto}\&\ mass\_fraction\ :\ mass\_fractions)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00411}00411\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ sum\ +=\ mass\_fraction;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00412}00412\ \ \ \ \ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00413}00413\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{for}\ (\textcolor{keywordtype}{double}\ \&\ mass\_fraction\ :\ mass\_fractions)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00414}00414\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ mass\_fraction\ /=\ sum;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00415}00415\ \ \ \ \ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00416}00416\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{for}\ (\textcolor{keyword}{auto}\&\ [symbol,\ entry]\ :\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa7f2753b10e85ae3bbf0c3d600a973db}{m\_compositions}})\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00417}00417\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a493224656aa3ade68389250720ef09af}{setMassFraction}}(symbol,\ entry.mass\_fraction()\ /\ sum);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00418}00418\ \ \ \ \ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00419}00419\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00420}00420\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{try}\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00421}00421\ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a86982685c34db4a8f079ddafc25c594e}{validateComposition}}(mass\_fractions);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00422}00422\ \ \ \ \ \ \ \ \ \}\ \textcolor{keywordflow}{catch}\ ([[maybe\_unused]]\ \textcolor{keyword}{const}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_composition_error}{exceptions::InvalidCompositionError}}\&\ e)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00423}00423\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{double}\ massSum\ =\ 0.0;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00424}00424\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{for}\ (\textcolor{keyword}{const}\ \textcolor{keyword}{auto}\ \&entry:\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa7f2753b10e85ae3bbf0c3d600a973db}{m\_compositions}}\ |\ std::views::values)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00425}00425\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ massSum\ +=\ entry.mass\_fraction();}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00426}00426\ \ \ \ \ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00427}00427\ \ \ \ \ \ \ \ \ \ \ \ \ LOG\_ERROR(\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ab6c66f35e1fb05dd24aacaf90e115c5e}{m\_logger}},\ \textcolor{stringliteral}{"{}Composition\ is\ invalid\ (Total\ mass\ \{\})."{}},\ massSum);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00428}00428\ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa00cbc0933d8a22bb900ac21a338e5ac}{m\_finalized}}\ =\ \textcolor{keyword}{false};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00429}00429\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \textcolor{keyword}{false};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00430}00430\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00431}00431\ \ \ \ \ \ \ \ \ \textcolor{comment}{//\ After\ validation,\ calculate\ the\ specific\ number\ density\ (total\ moles\ per\ unit\ mass).}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00432}00432\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{for}\ (\textcolor{keyword}{const}\ \textcolor{keyword}{auto}\ \&entry:\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa7f2753b10e85ae3bbf0c3d600a973db}{m\_compositions}}\ |\ std::views::values)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00433}00433\ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_addae4484da7d5072ab66a721dbe04ced}{m\_specificNumberDensity}}\ +=\ entry.rel\_abundance();}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00434}00434\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00435}00435\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a4a36c8d22ce61023e7bea1d9417577d4}{m\_meanParticleMass}}\ =\ 1.0/\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_addae4484da7d5072ab66a721dbe04ced}{m\_specificNumberDensity}};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00436}00436\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \textcolor{keyword}{true};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00437}00437\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00438}00438\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00439}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a461ab4e9cb5975cf865db5f16f03ddfe}{00439}}\ \ \ \ \ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a461ab4e9cb5975cf865db5f16f03ddfe}{Composition::finalizeNumberFracMode}}(\textcolor{keywordtype}{bool}\ norm)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00440}00440\ \ \ \ \ \ \ \ \ std::vector<double>\ number\_fractions;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00441}00441\ \ \ \ \ \ \ \ \ number\_fractions.reserve(\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa7f2753b10e85ae3bbf0c3d600a973db}{m\_compositions}}.size());}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00442}00442\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{for}\ (\textcolor{keyword}{const}\ \textcolor{keyword}{auto}\ \&entry:\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa7f2753b10e85ae3bbf0c3d600a973db}{m\_compositions}}\ |\ std::views::values)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00443}00443\ \ \ \ \ \ \ \ \ \ \ \ \ number\_fractions.push\_back(entry.number\_fraction());}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00444}00444\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00445}00445\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (norm)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00446}00446\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{double}\ sum\ =\ 0.0;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00447}00447\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{for}\ (\textcolor{keyword}{const}\ \textcolor{keyword}{auto}\&\ number\_fraction\ :\ number\_fractions)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00448}00448\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ sum\ +=\ number\_fraction;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00449}00449\ \ \ \ \ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00450}00450\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{for}\ (\textcolor{keyword}{auto}\&\ [symbol,\ entry]\ :\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa7f2753b10e85ae3bbf0c3d600a973db}{m\_compositions}})\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00451}00451\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a7d4d748f3ee25e68751fb143717ed080}{setNumberFraction}}(symbol,\ entry.number\_fraction()\ /\ sum);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00452}00452\ \ \ \ \ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00453}00453\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00454}00454\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{try}\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00455}00455\ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a86982685c34db4a8f079ddafc25c594e}{validateComposition}}(number\_fractions);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00456}00456\ \ \ \ \ \ \ \ \ \}\ \textcolor{keywordflow}{catch}\ ([[maybe\_unused]]\ \textcolor{keyword}{const}\ std::runtime\_error\&\ e)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00457}00457\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{double}\ numberSum\ =\ 0.0;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00458}00458\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{for}\ (\textcolor{keyword}{const}\ \textcolor{keyword}{auto}\ \&entry:\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa7f2753b10e85ae3bbf0c3d600a973db}{m\_compositions}}\ |\ std::views::values)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00459}00459\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ numberSum\ +=\ entry.number\_fraction();}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00460}00460\ \ \ \ \ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00461}00461\ \ \ \ \ \ \ \ \ \ \ \ \ LOG\_ERROR(\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ab6c66f35e1fb05dd24aacaf90e115c5e}{m\_logger}},\ \textcolor{stringliteral}{"{}Composition\ is\ invalid\ (Total\ number\ \{\})."{}},\ numberSum);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00462}00462\ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa00cbc0933d8a22bb900ac21a338e5ac}{m\_finalized}}\ =\ \textcolor{keyword}{false};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00463}00463\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \textcolor{keyword}{false};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00464}00464\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00465}00465\ \ \ \ \ \ \ \ \ \textcolor{comment}{//\ After\ validation,\ calculate\ the\ mean\ particle\ mass.}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00466}00466\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{for}\ (\textcolor{keyword}{const}\ \textcolor{keyword}{auto}\ \&entry:\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa7f2753b10e85ae3bbf0c3d600a973db}{m\_compositions}}\ |\ std::views::values)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00467}00467\ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a4a36c8d22ce61023e7bea1d9417577d4}{m\_meanParticleMass}}\ +=\ entry.rel\_abundance();}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00468}00468\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00469}00469\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_addae4484da7d5072ab66a721dbe04ced}{m\_specificNumberDensity}}\ =\ 1.0/\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a4a36c8d22ce61023e7bea1d9417577d4}{m\_meanParticleMass}};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00470}00470\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \textcolor{keyword}{true};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00471}00471\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00472}00472\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00473}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a3aead72892606725a4149a5f65bd31ec}{00473}}\ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a23b83b76ee025f6fc009184ee19bba88}{Composition}}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a3aead72892606725a4149a5f65bd31ec}{Composition::mix}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a23b83b76ee025f6fc009184ee19bba88}{Composition}}\&\ other,\ \textcolor{keyword}{const}\ \textcolor{keywordtype}{double}\ fraction)\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00474}00474\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (!\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa00cbc0933d8a22bb900ac21a338e5ac}{m\_finalized}}\ ||\ !other.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa00cbc0933d8a22bb900ac21a338e5ac}{m\_finalized}})\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00475}00475\ \ \ \ \ \ \ \ \ \ \ \ \ LOG\_ERROR(\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ab6c66f35e1fb05dd24aacaf90e115c5e}{m\_logger}},\ \textcolor{stringliteral}{"{}Compositions\ have\ not\ both\ been\ finalized.\ Hint:\ Consider\ running\ .finalize()\ on\ both\ compositions\ before\ mixing."{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00476}00476\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{throw}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_not_finalized_error}{exceptions::CompositionNotFinalizedError}}(\textcolor{stringliteral}{"{}Compositions\ have\ not\ been\ finalized\ (Hint:\ Consider\ running\ .finalize()\ on\ both\ compositions\ before\ mixing)."{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00477}00477\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00478}00478\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00479}00479\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (fraction\ <\ 0.0\ ||\ fraction\ >\ 1.0)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00480}00480\ \ \ \ \ \ \ \ \ \ \ \ \ LOG\_ERROR(\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ab6c66f35e1fb05dd24aacaf90e115c5e}{m\_logger}},\ \textcolor{stringliteral}{"{}Mixing\ fraction\ must\ be\ between\ 0\ and\ 1.\ Currently\ it\ is\ \{\}."{}},\ fraction);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00481}00481\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{throw}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_composition_error}{exceptions::InvalidCompositionError}}(\textcolor{stringliteral}{"{}Mixing\ fraction\ must\ be\ between\ 0\ and\ 1.\ Currently\ it\ is\ "{}}\ +\ std::to\_string(fraction)\ +\ \textcolor{stringliteral}{"{}."{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00482}00482\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00483}00483\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00484}00484\ \ \ \ \ \ \ \ \ std::set<std::string>\ mixedSymbols\ =\ other.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a84c7b72c2aee46b94492d404855dd3e0}{getRegisteredSymbols}}();}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00485}00485\ \ \ \ \ \ \ \ \ \textcolor{comment}{//\ Get\ the\ union\ of\ the\ two\ sets\ of\ symbols\ to\ ensure\ all\ species\ are\ included\ in\ the\ new\ composition.}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00486}00486\ \ \ \ \ \ \ \ \ mixedSymbols.insert(\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a39bfcb7d81d723cbd9d021abd533b4d6}{m\_registeredSymbols}}.begin(),\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a39bfcb7d81d723cbd9d021abd533b4d6}{m\_registeredSymbols}}.end());}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00487}00487\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00488}00488\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a23b83b76ee025f6fc009184ee19bba88}{Composition}}\ mixedComposition(mixedSymbols);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00489}00489\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{for}\ (\textcolor{keyword}{const}\ \textcolor{keyword}{auto}\&\ symbol\ :\ mixedSymbols)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00490}00490\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{double}\ otherMassFrac\ =\ 0.0;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00491}00491\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00492}00492\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keyword}{const}\ \textcolor{keywordtype}{double}\ thisMassFrac\ =\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a72a368f27094b03fdd9896844e075c94}{hasSymbol}}(symbol)\ ?\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ad20bd541dd7c45274a2e586e6a0519a7}{getMassFraction}}(symbol)\ :\ 0.0;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00493}00493\ \ \ \ \ \ \ \ \ \ \ \ \ otherMassFrac\ =\ other.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a72a368f27094b03fdd9896844e075c94}{hasSymbol}}(symbol)\ ?\ other.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ad20bd541dd7c45274a2e586e6a0519a7}{getMassFraction}}(symbol)\ :\ 0.0;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00494}00494\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00495}00495\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{comment}{//\ The\ mixing\ formula\ is\ a\ linear\ interpolation\ of\ mass\ fractions.}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00496}00496\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{double}\ massFraction\ =\ fraction\ *\ thisMassFrac\ +\ otherMassFrac\ *\ (1-\/fraction);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00497}00497\ \ \ \ \ \ \ \ \ \ \ \ \ mixedComposition.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a493224656aa3ade68389250720ef09af}{setMassFraction}}(symbol,\ massFraction);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00498}00498\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00499}00499\ \ \ \ \ \ \ \ \ mixedComposition.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a72d063a74a9d2197065884a2cea57a14}{finalize}}();}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00500}00500\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ mixedComposition;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00501}00501\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00502}00502\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00503}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a7f6a6edf02b55eeecf147c3f1f7f55e7}{00503}}\ \ \ \ \ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ad20bd541dd7c45274a2e586e6a0519a7}{Composition::getMassFraction}}(\textcolor{keyword}{const}\ std::string\&\ symbol)\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00504}00504\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (!\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa00cbc0933d8a22bb900ac21a338e5ac}{m\_finalized}})\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00505}00505\ \ \ \ \ \ \ \ \ \ \ \ \ LOG\_ERROR(\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ab6c66f35e1fb05dd24aacaf90e115c5e}{m\_logger}},\ \textcolor{stringliteral}{"{}Composition\ has\ not\ been\ finalized.\ Hint:\ Consider\ running\ .finalize()."{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00506}00506\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{throw}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_not_finalized_error}{exceptions::CompositionNotFinalizedError}}(\textcolor{stringliteral}{"{}Composition\ has\ not\ been\ finalized.\ Hint:\ Consider\ running\ .finalize()."{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00507}00507\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00508}00508\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (!\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa7f2753b10e85ae3bbf0c3d600a973db}{m\_compositions}}.contains(symbol))\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00509}00509\ \ \ \ \ \ \ \ \ \ \ \ \ LOG\_ERROR(\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ab6c66f35e1fb05dd24aacaf90e115c5e}{m\_logger}},\ \textcolor{stringliteral}{"{}Symbol\ \{\}\ is\ not\ in\ the\ composition."{}},\ symbol);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00510}00510\ \ \ \ \ \ \ \ \ \ \ \ \ std::string\ currentSymbols;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00511}00511\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{size\_t}\ count\ =\ 0;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00512}00512\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{for}\ (\textcolor{keyword}{const}\ \textcolor{keyword}{auto}\&\ sym\ :\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa7f2753b10e85ae3bbf0c3d600a973db}{m\_compositions}}\ |\ std::views::keys)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00513}00513\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ currentSymbols\ +=\ sym;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00514}00514\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (count\ <\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa7f2753b10e85ae3bbf0c3d600a973db}{m\_compositions}}.size()\ -\/\ 2)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00515}00515\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ currentSymbols\ +=\ \textcolor{stringliteral}{"{},\ "{}};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00516}00516\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \}\ \textcolor{keywordflow}{else}\ \textcolor{keywordflow}{if}\ (count\ ==\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa7f2753b10e85ae3bbf0c3d600a973db}{m\_compositions}}.size()\ -\/\ 2)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00517}00517\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ currentSymbols\ +=\ \textcolor{stringliteral}{"{},\ and\ "{}};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00518}00518\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00519}00519\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ count++;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00520}00520\ \ \ \ \ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00521}00521\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{throw}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_unregistered_symbol_error}{exceptions::UnregisteredSymbolError}}(\textcolor{stringliteral}{"{}Symbol("{}}\ +\ symbol\ +\ \textcolor{stringliteral}{"{})\ is\ not\ in\ the\ current\ composition.\ Current\ composition\ has\ symbols:\ "{}}\ +\ currentSymbols\ +\ \textcolor{stringliteral}{"{}."{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00522}00522\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00523}00523\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a671f1ee8be00f4ff8c1d94fabb382380}{m\_massFracMode}})\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00524}00524\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa7f2753b10e85ae3bbf0c3d600a973db}{m\_compositions}}.at(symbol).mass\_fraction();}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00525}00525\ \ \ \ \ \ \ \ \ \}\ \textcolor{keywordflow}{else}\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00526}00526\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa7f2753b10e85ae3bbf0c3d600a973db}{m\_compositions}}.at(symbol).mass\_fraction(\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a4a36c8d22ce61023e7bea1d9417577d4}{m\_meanParticleMass}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00527}00527\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00528}00528\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00529}00529\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00530}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa3ba0c742872384cff3ed03789c0a17d}{00530}}\ \ \ \ \ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ad20bd541dd7c45274a2e586e6a0519a7}{Composition::getMassFraction}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{fourdst::atomic::Species}}\ \&species)\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00531}00531\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ad20bd541dd7c45274a2e586e6a0519a7}{getMassFraction}}(std::string(species.\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a1fcc01fc978b34ba2531117f10be6741}{name}}()));}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00532}00532\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00533}00533\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00534}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ad20bd541dd7c45274a2e586e6a0519a7}{00534}}\ \ \ \ \ std::unordered\_map<std::string,\ double>\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ad20bd541dd7c45274a2e586e6a0519a7}{Composition::getMassFraction}}()\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00535}00535\ \ \ \ \ \ \ \ \ std::unordered\_map<std::string,\ double>\ mass\_fractions;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00536}00536\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{for}\ (\textcolor{keyword}{const}\ \textcolor{keyword}{auto}\ \&symbol:\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa7f2753b10e85ae3bbf0c3d600a973db}{m\_compositions}}\ |\ std::views::keys)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00537}00537\ \ \ \ \ \ \ \ \ \ \ \ \ mass\_fractions[symbol]\ =\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ad20bd541dd7c45274a2e586e6a0519a7}{getMassFraction}}(symbol);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00538}00538\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00539}00539\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ mass\_fractions;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00540}00540\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00541}00541\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00542}00542\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00543}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a84fea38bc1c005e483910285f6800e15}{00543}}\ \ \ \ \ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a7731df9b30f8c8f13231f7e1a17b105c}{Composition::getNumberFraction}}(\textcolor{keyword}{const}\ std::string\&\ symbol)\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00544}00544\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (!\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa00cbc0933d8a22bb900ac21a338e5ac}{m\_finalized}})\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00545}00545\ \ \ \ \ \ \ \ \ \ \ \ \ LOG\_ERROR(\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ab6c66f35e1fb05dd24aacaf90e115c5e}{m\_logger}},\ \textcolor{stringliteral}{"{}Composition\ has\ not\ been\ finalized.\ Hint:\ Consider\ running\ .finalize()."{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00546}00546\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{throw}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_not_finalized_error}{exceptions::CompositionNotFinalizedError}}(\textcolor{stringliteral}{"{}Composition\ has\ not\ been\ finalized.\ Hint:\ Consider\ running\ .finalize()."{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00547}00547\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00548}00548\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (!\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa7f2753b10e85ae3bbf0c3d600a973db}{m\_compositions}}.contains(symbol))\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00549}00549\ \ \ \ \ \ \ \ \ \ \ \ \ LOG\_ERROR(\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ab6c66f35e1fb05dd24aacaf90e115c5e}{m\_logger}},\ \textcolor{stringliteral}{"{}Symbol\ \{\}\ is\ not\ in\ the\ composition."{}},\ symbol);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00550}00550\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{throw}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_not_finalized_error}{exceptions::CompositionNotFinalizedError}}(\textcolor{stringliteral}{"{}Symbol\ "{}}\ +\ symbol\ +\ \textcolor{stringliteral}{"{}\ is\ not\ in\ the\ composition."{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00551}00551\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00552}00552\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (!\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a671f1ee8be00f4ff8c1d94fabb382380}{m\_massFracMode}})\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00553}00553\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa7f2753b10e85ae3bbf0c3d600a973db}{m\_compositions}}.at(symbol).number\_fraction();}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00554}00554\ \ \ \ \ \ \ \ \ \}\ \textcolor{keywordflow}{else}\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00555}00555\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa7f2753b10e85ae3bbf0c3d600a973db}{m\_compositions}}.at(symbol).number\_fraction(\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_addae4484da7d5072ab66a721dbe04ced}{m\_specificNumberDensity}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00556}00556\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00557}00557\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00558}00558\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00559}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa0ce4143a267e96ab7967538c76acdc3}{00559}}\ \ \ \ \ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a7731df9b30f8c8f13231f7e1a17b105c}{Composition::getNumberFraction}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{fourdst::atomic::Species}}\ \&species)\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00560}00560\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a7731df9b30f8c8f13231f7e1a17b105c}{getNumberFraction}}(std::string(species.\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a1fcc01fc978b34ba2531117f10be6741}{name}}()));}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00561}00561\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00562}00562\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00563}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a7731df9b30f8c8f13231f7e1a17b105c}{00563}}\ \ \ \ \ std::unordered\_map<std::string,\ double>\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a7731df9b30f8c8f13231f7e1a17b105c}{Composition::getNumberFraction}}()\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00564}00564\ \ \ \ \ \ \ \ \ std::unordered\_map<std::string,\ double>\ number\_fractions;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00565}00565\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{for}\ (\textcolor{keyword}{const}\ \textcolor{keyword}{auto}\ \&symbol:\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa7f2753b10e85ae3bbf0c3d600a973db}{m\_compositions}}\ |\ std::views::keys)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00566}00566\ \ \ \ \ \ \ \ \ \ \ \ \ number\_fractions[symbol]\ =\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a7731df9b30f8c8f13231f7e1a17b105c}{getNumberFraction}}(symbol);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00567}00567\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00568}00568\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ number\_fractions;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00569}00569\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00570}00570\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00571}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a67a2ed844f3aee3d9cc1a3cb996eb56f}{00571}}\ \ \ \ \ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a67a2ed844f3aee3d9cc1a3cb996eb56f}{Composition::getMolarAbundance}}(\textcolor{keyword}{const}\ std::string\ \&symbol)\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00572}00572\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (!\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa00cbc0933d8a22bb900ac21a338e5ac}{m\_finalized}})\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00573}00573\ \ \ \ \ \ \ \ \ \ \ \ \ LOG\_ERROR(\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ab6c66f35e1fb05dd24aacaf90e115c5e}{m\_logger}},\ \textcolor{stringliteral}{"{}Composition\ has\ not\ been\ finalized.\ Hint:\ Consider\ running\ .finalize()."{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00574}00574\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{throw}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_not_finalized_error}{exceptions::CompositionNotFinalizedError}}(\textcolor{stringliteral}{"{}Composition\ has\ not\ been\ finalized.\ Hint:\ Consider\ running\ .finalize()."{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00575}00575\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00576}00576\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (!\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa7f2753b10e85ae3bbf0c3d600a973db}{m\_compositions}}.contains(symbol))\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00577}00577\ \ \ \ \ \ \ \ \ \ \ \ \ LOG\_ERROR(\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ab6c66f35e1fb05dd24aacaf90e115c5e}{m\_logger}},\ \textcolor{stringliteral}{"{}Symbol\ \{\}\ is\ not\ in\ the\ composition."{}},\ symbol);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00578}00578\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{throw}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_unregistered_symbol_error}{exceptions::UnregisteredSymbolError}}(\textcolor{stringliteral}{"{}Symbol\ "{}}\ +\ symbol\ +\ \textcolor{stringliteral}{"{}\ is\ not\ in\ the\ composition."{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00579}00579\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00580}00580\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ad20bd541dd7c45274a2e586e6a0519a7}{getMassFraction}}(symbol)\ /\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa7f2753b10e85ae3bbf0c3d600a973db}{m\_compositions}}.at(symbol).isotope().mass();}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00581}00581\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00582}00582\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00583}00583\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00584}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a84d6552e2b762fabb7bddf68b05c4022}{00584}}\ \ \ \ \ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a67a2ed844f3aee3d9cc1a3cb996eb56f}{Composition::getMolarAbundance}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{fourdst::atomic::Species}}\ \&species)\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00585}00585\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a67a2ed844f3aee3d9cc1a3cb996eb56f}{getMolarAbundance}}(std::string(species.\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a1fcc01fc978b34ba2531117f10be6741}{name}}()));}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00586}00586\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00587}00587\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00588}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a092d3536b04167ea2e6e3a3b1446c377}{00588}}\ \ \ \ \ std::pair<CompositionEntry,\ GlobalComposition>\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a1138c86f7ccd39594601c2ec63ad89e9}{Composition::getComposition}}(\textcolor{keyword}{const}\ std::string\&\ symbol)\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00589}00589\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (!\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa00cbc0933d8a22bb900ac21a338e5ac}{m\_finalized}})\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00590}00590\ \ \ \ \ \ \ \ \ \ \ \ \ LOG\_ERROR(\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ab6c66f35e1fb05dd24aacaf90e115c5e}{m\_logger}},\ \textcolor{stringliteral}{"{}Composition\ has\ not\ been\ finalized.\ Hint:\ Consider\ running\ .finalize()."{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00591}00591\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{throw}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_not_finalized_error}{exceptions::CompositionNotFinalizedError}}(\textcolor{stringliteral}{"{}Composition\ has\ not\ been\ finalized.\ Hint:\ Consider\ running\ .finalize()."{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00592}00592\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00593}00593\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (!\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa7f2753b10e85ae3bbf0c3d600a973db}{m\_compositions}}.contains(symbol))\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00594}00594\ \ \ \ \ \ \ \ \ \ \ \ \ LOG\_ERROR(\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ab6c66f35e1fb05dd24aacaf90e115c5e}{m\_logger}},\ \textcolor{stringliteral}{"{}Symbol\ \{\}\ is\ not\ in\ the\ composition."{}},\ symbol);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00595}00595\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{throw}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_unregistered_symbol_error}{exceptions::UnregisteredSymbolError}}(\textcolor{stringliteral}{"{}Symbol\ "{}}\ +\ symbol\ +\ \textcolor{stringliteral}{"{}\ is\ not\ in\ the\ composition."{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00596}00596\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00597}00597\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \{\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa7f2753b10e85ae3bbf0c3d600a973db}{m\_compositions}}.at(symbol),\ \{\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_addae4484da7d5072ab66a721dbe04ced}{m\_specificNumberDensity}},\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a4a36c8d22ce61023e7bea1d9417577d4}{m\_meanParticleMass}}\}\};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00598}00598\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00599}00599\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00600}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_afe5f1086027044c84ff35a366b2e8e2d}{00600}}\ \ \ \ \ std::pair<CompositionEntry,\ GlobalComposition>\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a1138c86f7ccd39594601c2ec63ad89e9}{Composition::getComposition}}(}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00601}00601\ \ \ \ \ \ \ \ \ \textcolor{keyword}{const}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{fourdst::atomic::Species}}\ \&species)\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00602}00602\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a1138c86f7ccd39594601c2ec63ad89e9}{getComposition}}(std::string(species.\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a1fcc01fc978b34ba2531117f10be6741}{name}}()));}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00603}00603\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00604}00604\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00605}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a1138c86f7ccd39594601c2ec63ad89e9}{00605}}\ \ \ \ \ std::pair<std::unordered\_map<std::string,\ CompositionEntry>,\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_global_composition}{GlobalComposition}}>\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a1138c86f7ccd39594601c2ec63ad89e9}{Composition::getComposition}}()\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00606}00606\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (!\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa00cbc0933d8a22bb900ac21a338e5ac}{m\_finalized}})\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00607}00607\ \ \ \ \ \ \ \ \ \ \ \ \ LOG\_ERROR(\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ab6c66f35e1fb05dd24aacaf90e115c5e}{m\_logger}},\ \textcolor{stringliteral}{"{}Composition\ has\ not\ been\ finalized.\ Hint:\ Consider\ running\ .finalize()."{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00608}00608\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{throw}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_not_finalized_error}{exceptions::CompositionNotFinalizedError}}(\textcolor{stringliteral}{"{}Composition\ has\ not\ been\ finalized.\ Hint:\ Consider\ running\ .finalize()."{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00609}00609\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00610}00610\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \{\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa7f2753b10e85ae3bbf0c3d600a973db}{m\_compositions}},\ \{\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_addae4484da7d5072ab66a721dbe04ced}{m\_specificNumberDensity}},\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a4a36c8d22ce61023e7bea1d9417577d4}{m\_meanParticleMass}}\}\};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00611}00611\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00612}00612\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00613}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a66401fed7054172e9b1a2687e5cc8eff}{00613}}\ \ \ \ \ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a66401fed7054172e9b1a2687e5cc8eff}{Composition::getMeanParticleMass}}()\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00614}00614\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (!\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa00cbc0933d8a22bb900ac21a338e5ac}{m\_finalized}})\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00615}00615\ \ \ \ \ \ \ \ \ \ \ \ \ LOG\_ERROR(\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ab6c66f35e1fb05dd24aacaf90e115c5e}{m\_logger}},\ \textcolor{stringliteral}{"{}Composition\ has\ not\ been\ finalized.\ Hint:\ Consider\ running\ .finalize()."{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00616}00616\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{throw}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_not_finalized_error}{exceptions::CompositionNotFinalizedError}}(\textcolor{stringliteral}{"{}Composition\ has\ not\ been\ finalized.\ Hint:\ Consider\ running\ .finalize()."{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00617}00617\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00618}00618\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a4a36c8d22ce61023e7bea1d9417577d4}{m\_meanParticleMass}};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00619}00619\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00620}00620\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00621}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a98199f435cb553f5cf4f8e520fdb8a7a}{00621}}\ \ \ \ \ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a98199f435cb553f5cf4f8e520fdb8a7a}{Composition::getMeanAtomicNumber}}()\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00622}00622\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (!\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa00cbc0933d8a22bb900ac21a338e5ac}{m\_finalized}})\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00623}00623\ \ \ \ \ \ \ \ \ \ \ \ \ LOG\_ERROR(\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ab6c66f35e1fb05dd24aacaf90e115c5e}{m\_logger}},\ \textcolor{stringliteral}{"{}Composition\ must\ be\ finalized\ before\ getting\ the\ mean\ atomic\ mass\ number.\ Hint:\ Consider\ running\ .finalize()."{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00624}00624\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{throw}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_not_finalized_error}{exceptions::CompositionNotFinalizedError}}(\textcolor{stringliteral}{"{}Composition\ not\ finalized.\ Cannot\ retrieve\ mean\ atomic\ mass\ number.\ Hint:\ Consider\ running\ .finalize()."{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00625}00625\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00626}00626\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00627}00627\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{double}\ zSum\ =\ 0.0;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00628}00628\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00629}00629\ \ \ \ \ \ \ \ \ \textcolor{comment}{//\ Loop\ through\ all\ registered\ species\ in\ the\ composition.}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00630}00630\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{for}\ (\textcolor{keyword}{const}\ \textcolor{keyword}{auto}\ \&val:\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa7f2753b10e85ae3bbf0c3d600a973db}{m\_compositions}}\ |\ std::views::values)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00631}00631\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{comment}{//\ Sum\ of\ (X\_i\ *\ Z\_i\ /\ A\_i)}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00632}00632\ \ \ \ \ \ \ \ \ \ \ \ \ zSum\ +=\ (val.mass\_fraction()\ *\ val.m\_isotope.z())/val.m\_isotope.a();}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00633}00633\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00634}00634\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00635}00635\ \ \ \ \ \ \ \ \ \textcolor{comment}{//\ Calculate\ mean\ atomic\ number\ <Z>\ =\ <A>\ *\ sum(X\_i\ *\ Z\_i\ /\ A\_i)}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00636}00636\ \ \ \ \ \ \ \ \ \textcolor{keyword}{const}\ \textcolor{keywordtype}{double}\ mean\_A\ =\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a4a36c8d22ce61023e7bea1d9417577d4}{m\_meanParticleMass}}\ *\ zSum;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00637}00637\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ mean\_A;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00638}00638\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00639}00639\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00640}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a17635cd21744c7cf86cb1eb75152c816}{00640}}\ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a23b83b76ee025f6fc009184ee19bba88}{Composition}}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a17635cd21744c7cf86cb1eb75152c816}{Composition::subset}}(\textcolor{keyword}{const}\ std::vector<std::string>\&\ symbols,\ \textcolor{keyword}{const}\ std::string\&\ method)\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00641}00641\ \ \ \ \ \ \ \ \ \textcolor{keyword}{const}\ std::array<std::string,\ 2>\ methods\ =\ \{\textcolor{stringliteral}{"{}norm"{}},\ \textcolor{stringliteral}{"{}none"{}}\};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00642}00642\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00643}00643\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (std::ranges::find(methods,\ method)\ ==\ methods.end())\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00644}00644\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keyword}{const}\ std::string\ errorMessage\ =\ \textcolor{stringliteral}{"{}Invalid\ method:\ "{}}\ +\ method\ +\ \textcolor{stringliteral}{"{}.\ Valid\ methods\ are\ 'norm'\ and\ 'none'."{}};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00645}00645\ \ \ \ \ \ \ \ \ \ \ \ \ LOG\_ERROR(\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ab6c66f35e1fb05dd24aacaf90e115c5e}{m\_logger}},\ \textcolor{stringliteral}{"{}Invalid\ method:\ \{\}.\ Valid\ methods\ are\ norm\ and\ none."{}},\ method);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00646}00646\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{throw}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_mixing_mode}{exceptions::InvalidMixingMode}}(errorMessage);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00647}00647\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00648}00648\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00649}00649\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a23b83b76ee025f6fc009184ee19bba88}{Composition}}\ subsetComposition;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00650}00650\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{for}\ (\textcolor{keyword}{const}\ \textcolor{keyword}{auto}\&\ symbol\ :\ symbols)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00651}00651\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (!\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa7f2753b10e85ae3bbf0c3d600a973db}{m\_compositions}}.contains(symbol))\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00652}00652\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ LOG\_ERROR(\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ab6c66f35e1fb05dd24aacaf90e115c5e}{m\_logger}},\ \textcolor{stringliteral}{"{}Symbol\ \{\}\ is\ not\ in\ the\ composition."{}},\ symbol);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00653}00653\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{throw}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_unregistered_symbol_error}{exceptions::UnregisteredSymbolError}}(\textcolor{stringliteral}{"{}Symbol\ "{}}\ +\ symbol\ +\ \textcolor{stringliteral}{"{}\ is\ not\ in\ the\ composition."{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00654}00654\ \ \ \ \ \ \ \ \ \ \ \ \ \}\ \textcolor{keywordflow}{else}\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00655}00655\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ subsetComposition.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a1bc2e64f87c12befdc2bc767e7405661}{registerSymbol}}(symbol);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00656}00656\ \ \ \ \ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00657}00657\ \ \ \ \ \ \ \ \ \ \ \ \ subsetComposition.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a493224656aa3ade68389250720ef09af}{setMassFraction}}(symbol,\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa7f2753b10e85ae3bbf0c3d600a973db}{m\_compositions}}.at(symbol).mass\_fraction());}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00658}00658\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00659}00659\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (method\ ==\ \textcolor{stringliteral}{"{}norm"{}})\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00660}00660\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keyword}{const}\ \textcolor{keywordtype}{bool}\ isNorm\ =\ subsetComposition.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a72d063a74a9d2197065884a2cea57a14}{finalize}}(\textcolor{keyword}{true});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00661}00661\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (!isNorm)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00662}00662\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ LOG\_ERROR(\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ab6c66f35e1fb05dd24aacaf90e115c5e}{m\_logger}},\ \textcolor{stringliteral}{"{}Subset\ composition\ is\ invalid.\ (Unable\ to\ finalize\ with\ normalization)."{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00663}00663\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{throw}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_failed_to_finalize_composition_error}{exceptions::FailedToFinalizeCompositionError}}(\textcolor{stringliteral}{"{}Subset\ composition\ is\ invalid.\ (Unable\ to\ finalize\ with\ normalization)."{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00664}00664\ \ \ \ \ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00665}00665\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00666}00666\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ subsetComposition;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00667}00667\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00668}00668\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00669}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a0af981ed1074b26c237cf6cf35f82c9e}{00669}}\ \ \ \ \ \textcolor{keywordtype}{void}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a0af981ed1074b26c237cf6cf35f82c9e}{Composition::setCompositionMode}}(\textcolor{keyword}{const}\ \textcolor{keywordtype}{bool}\ massFracMode)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00670}00670\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (!\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa00cbc0933d8a22bb900ac21a338e5ac}{m\_finalized}})\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00671}00671\ \ \ \ \ \ \ \ \ \ \ \ \ LOG\_ERROR(\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ab6c66f35e1fb05dd24aacaf90e115c5e}{m\_logger}},\ \textcolor{stringliteral}{"{}Composition\ has\ not\ been\ finalized.\ Mode\ cannot\ be\ set\ unless\ composition\ is\ finalized.\ Hint:\ Consider\ running\ .finalize()."{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00672}00672\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{throw}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_not_finalized_error}{exceptions::CompositionNotFinalizedError}}(\textcolor{stringliteral}{"{}Composition\ has\ not\ been\ finalized.\ Mode\ cannot\ be\ set\ unless\ composition\ is\ finalized.\ Hint:\ Consider\ running\ .finalize()."{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00673}00673\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00674}00674\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00675}00675\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{bool}\ okay\ =\ \textcolor{keyword}{true};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00676}00676\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{for}\ (\textcolor{keyword}{auto}\ \&entry:\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa7f2753b10e85ae3bbf0c3d600a973db}{m\_compositions}}\ |\ std::views::values)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00677}00677\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (massFracMode)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00678}00678\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ okay\ =\ entry.setMassFracMode(\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a4a36c8d22ce61023e7bea1d9417577d4}{m\_meanParticleMass}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00679}00679\ \ \ \ \ \ \ \ \ \ \ \ \ \}\ \textcolor{keywordflow}{else}\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00680}00680\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ okay\ =\ entry.setNumberFracMode(\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_addae4484da7d5072ab66a721dbe04ced}{m\_specificNumberDensity}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00681}00681\ \ \ \ \ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00682}00682\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (!okay)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00683}00683\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ LOG\_ERROR(\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ab6c66f35e1fb05dd24aacaf90e115c5e}{m\_logger}},\ \textcolor{stringliteral}{"{}Composition\ mode\ could\ not\ be\ set\ due\ to\ some\ unknown\ error."{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00684}00684\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{throw}\ std::runtime\_error(\textcolor{stringliteral}{"{}Composition\ mode\ could\ not\ be\ set\ due\ to\ an\ unknown\ error."{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00685}00685\ \ \ \ \ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00686}00686\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00687}00687\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a671f1ee8be00f4ff8c1d94fabb382380}{m\_massFracMode}}\ =\ massFracMode;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00688}00688\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00689}00689\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00690}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ac75dbc8377556c835455991c7c7fe206}{00690}}\ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1composition_1_1_canonical_composition}{CanonicalComposition}}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ac75dbc8377556c835455991c7c7fe206}{Composition::getCanonicalComposition}}(\textcolor{keywordtype}{bool}\ harsh)\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00691}00691\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (!\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa00cbc0933d8a22bb900ac21a338e5ac}{m\_finalized}})\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00692}00692\ \ \ \ \ \ \ \ \ \ \ \ \ LOG\_ERROR(\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ab6c66f35e1fb05dd24aacaf90e115c5e}{m\_logger}},\ \textcolor{stringliteral}{"{}Composition\ has\ not\ been\ finalized.\ Hint:\ Consider\ running\ .finalize()."{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00693}00693\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{throw}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_not_finalized_error}{exceptions::CompositionNotFinalizedError}}(\textcolor{stringliteral}{"{}Composition\ has\ not\ been\ finalized.\ Hint:\ Consider\ running\ .finalize()."{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00694}00694\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00695}00695\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1composition_1_1_canonical_composition}{CanonicalComposition}}\ canonicalComposition;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00696}00696\ \ \ \ \ \ \ \ \ \textcolor{keyword}{const}\ std::array<std::string,\ 7>\ canonicalH\ =\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00697}00697\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{stringliteral}{"{}H-\/1"{}},\ \textcolor{stringliteral}{"{}H-\/2"{}},\ \textcolor{stringliteral}{"{}H-\/3"{}},\ \textcolor{stringliteral}{"{}H-\/4"{}},\ \textcolor{stringliteral}{"{}H-\/5"{}},\ \textcolor{stringliteral}{"{}H-\/6"{}},\ \textcolor{stringliteral}{"{}H-\/7"{}}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00698}00698\ \ \ \ \ \ \ \ \ \};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00699}00699\ \ \ \ \ \ \ \ \ \textcolor{keyword}{const}\ std::array<std::string,\ 8>\ canonicalHe\ =\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00700}00700\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{stringliteral}{"{}He-\/3"{}},\ \textcolor{stringliteral}{"{}He-\/4"{}},\ \textcolor{stringliteral}{"{}He-\/5"{}},\ \textcolor{stringliteral}{"{}He-\/6"{}},\ \textcolor{stringliteral}{"{}He-\/7"{}},\ \textcolor{stringliteral}{"{}He-\/8"{}},\ \textcolor{stringliteral}{"{}He-\/9"{}},\ \textcolor{stringliteral}{"{}He-\/10"{}}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00701}00701\ \ \ \ \ \ \ \ \ \};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00702}00702\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{for}\ (\textcolor{keyword}{const}\ \textcolor{keyword}{auto}\&\ symbol\ :\ canonicalH)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00703}00703\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a72a368f27094b03fdd9896844e075c94}{hasSymbol}}(symbol))\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00704}00704\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ canonicalComposition.\mbox{\hyperlink{structfourdst_1_1composition_1_1_canonical_composition_abe5b01574242f8eaabd00c3d653291f7}{X}}\ +=\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ad20bd541dd7c45274a2e586e6a0519a7}{getMassFraction}}(symbol);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00705}00705\ \ \ \ \ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00706}00706\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00707}00707\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{for}\ (\textcolor{keyword}{const}\ \textcolor{keyword}{auto}\&\ symbol\ :\ canonicalHe)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00708}00708\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a72a368f27094b03fdd9896844e075c94}{hasSymbol}}(symbol))\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00709}00709\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ canonicalComposition.\mbox{\hyperlink{structfourdst_1_1composition_1_1_canonical_composition_a93927bfccc5d2b3906565d092ed4f7f4}{Y}}\ +=\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ad20bd541dd7c45274a2e586e6a0519a7}{getMassFraction}}(symbol);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00710}00710\ \ \ \ \ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00711}00711\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00712}00712\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00713}00713\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{for}\ (\textcolor{keyword}{const}\ \textcolor{keyword}{auto}\&\ symbol\ :\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a84c7b72c2aee46b94492d404855dd3e0}{getRegisteredSymbols}}())\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00714}00714\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keyword}{const}\ \textcolor{keywordtype}{bool}\ isHSymbol\ =\ std::ranges::find(canonicalH,\ symbol)\ !=\ std::end(canonicalH);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00715}00715\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keyword}{const}\ \textcolor{keywordtype}{bool}\ isHeSymbol\ =\ std::ranges::find(canonicalHe,\ symbol)\ !=\ std::end(canonicalHe);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00716}00716\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00717}00717\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (isHSymbol\ ||\ isHeSymbol)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00718}00718\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{continue};\ \textcolor{comment}{//\ Skip\ canonical\ H\ and\ He\ symbols}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00719}00719\ \ \ \ \ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00720}00720\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00721}00721\ \ \ \ \ \ \ \ \ \ \ \ \ canonicalComposition.\mbox{\hyperlink{structfourdst_1_1composition_1_1_canonical_composition_ae1981f5ddd36abd17a4a69fa1f43de18}{Z}}\ +=\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ad20bd541dd7c45274a2e586e6a0519a7}{getMassFraction}}(symbol);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00722}00722\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00723}00723\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00724}00724\ \ \ \ \ \ \ \ \ \textcolor{keyword}{const}\ \textcolor{keywordtype}{double}\ Z\ =\ 1.0\ -\/\ (canonicalComposition.\mbox{\hyperlink{structfourdst_1_1composition_1_1_canonical_composition_abe5b01574242f8eaabd00c3d653291f7}{X}}\ +\ canonicalComposition.\mbox{\hyperlink{structfourdst_1_1composition_1_1_canonical_composition_a93927bfccc5d2b3906565d092ed4f7f4}{Y}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00725}00725\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (std::abs(Z\ -\/\ canonicalComposition.\mbox{\hyperlink{structfourdst_1_1composition_1_1_canonical_composition_ae1981f5ddd36abd17a4a69fa1f43de18}{Z}})\ >\ 1e-\/6)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00726}00726\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (!harsh)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00727}00727\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ LOG\_WARNING(\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ab6c66f35e1fb05dd24aacaf90e115c5e}{m\_logger}},\ \textcolor{stringliteral}{"{}Validation\ composition\ Z\ (X-\/Y\ =\ \{\})\ is\ different\ than\ canonical\ composition\ Z\ (\{\})\ (∑a\_i\ where\ a\_i\ !=\ H/He)."{}},\ Z,\ canonicalComposition.\mbox{\hyperlink{structfourdst_1_1composition_1_1_canonical_composition_ae1981f5ddd36abd17a4a69fa1f43de18}{Z}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00728}00728\ \ \ \ \ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00729}00729\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{else}\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00730}00730\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ LOG\_ERROR(\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ab6c66f35e1fb05dd24aacaf90e115c5e}{m\_logger}},\ \textcolor{stringliteral}{"{}Validation\ composition\ Z\ (X-\/Y\ =\ \{\})\ is\ different\ than\ canonical\ composition\ Z\ (\{\})\ (∑a\_i\ where\ a\_i\ !=\ H/He)."{}},\ Z,\ canonicalComposition.\mbox{\hyperlink{structfourdst_1_1composition_1_1_canonical_composition_ae1981f5ddd36abd17a4a69fa1f43de18}{Z}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00731}00731\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{throw}\ std::runtime\_error(\textcolor{stringliteral}{"{}Validation\ composition\ Z\ (X-\/Y\ =\ "{}}\ +\ std::to\_string(Z)\ +\ \textcolor{stringliteral}{"{})\ is\ different\ than\ canonical\ composition\ Z\ ("{}}\ +\ std::to\_string(canonicalComposition.\mbox{\hyperlink{structfourdst_1_1composition_1_1_canonical_composition_ae1981f5ddd36abd17a4a69fa1f43de18}{Z}})\ +\ \textcolor{stringliteral}{"{})\ (∑a\_i\ where\ a\_i\ !=\ H/He)."{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00732}00732\ \ \ \ \ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00733}00733\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00734}00734\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ canonicalComposition;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00735}00735\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00736}00736\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00737}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a72a368f27094b03fdd9896844e075c94}{00737}}\ \ \ \ \ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a72a368f27094b03fdd9896844e075c94}{Composition::hasSymbol}}(\textcolor{keyword}{const}\ std::string\&\ symbol)\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00738}00738\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa7f2753b10e85ae3bbf0c3d600a973db}{m\_compositions}}.contains(symbol);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00739}00739\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00740}00740\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00741}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_acb08478f7032ecc13cb02283a18187e9}{00741}}\ \ \ \ \ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_acb08478f7032ecc13cb02283a18187e9}{Composition::contains}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{fourdst::atomic::Species}}\ \&isotope)\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00742}00742\ \ \ \ \ \ \ \ \ \textcolor{comment}{//\ Check\ if\ the\ isotope's\ symbol\ is\ in\ the\ composition}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00743}00743\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (!\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa00cbc0933d8a22bb900ac21a338e5ac}{m\_finalized}})\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00744}00744\ \ \ \ \ \ \ \ \ \ \ \ \ LOG\_ERROR(\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ab6c66f35e1fb05dd24aacaf90e115c5e}{m\_logger}},\ \textcolor{stringliteral}{"{}Composition\ has\ not\ been\ finalized.\ Hint:\ Consider\ running\ .finalize()."{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00745}00745\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{throw}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_not_finalized_error}{exceptions::CompositionNotFinalizedError}}(\textcolor{stringliteral}{"{}Composition\ has\ not\ been\ finalized.\ Hint:\ Consider\ running\ .finalize()."{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00746}00746\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00747}00747\ \ \ \ \ \ \ \ \ \textcolor{keyword}{const}\ \textcolor{keyword}{auto}\ symbol\ =\ \textcolor{keyword}{static\_cast<}std::string\textcolor{keyword}{>}(isotope.\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a1fcc01fc978b34ba2531117f10be6741}{name}}());}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00748}00748\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa7f2753b10e85ae3bbf0c3d600a973db}{m\_compositions}}.contains(symbol))\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00749}00749\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \textcolor{keyword}{true};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00750}00750\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00751}00751\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \textcolor{keyword}{false};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00752}00752\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00753}00753\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00755}00755\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00756}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a24a3bdeb8e8e55b54ecdee6dcb0d9561}{00756}}\ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a23b83b76ee025f6fc009184ee19bba88}{Composition}}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a24a3bdeb8e8e55b54ecdee6dcb0d9561}{Composition::operator+}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a23b83b76ee025f6fc009184ee19bba88}{Composition}}\&\ other)\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00757}00757\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a3aead72892606725a4149a5f65bd31ec}{mix}}(other,\ 0.5);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00758}00758\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00759}00759\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00760}\mbox{\hyperlink{structfourdst_1_1composition_1_1_global_composition_a3c072a749c3648607771ac9105181f26}{00760}}\ \ \ \ \ std::ostream\&\ \mbox{\hyperlink{namespacefourdst_1_1composition_a8468dde1b148c0583b8a9f85b8d0ce9a}{operator<<}}(std::ostream\&\ os,\ \textcolor{keyword}{const}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_global_composition}{GlobalComposition}}\&\ comp)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00761}00761\ \ \ \ \ \ \ \ \ os\ <<\ \textcolor{stringliteral}{"{}Global\ Composition:\ \(\backslash\)n"{}};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00762}00762\ \ \ \ \ \ \ \ \ os\ <<\ \textcolor{stringliteral}{"{}\(\backslash\)tSpecific\ Number\ Density:\ "{}}\ <<\ comp.\mbox{\hyperlink{structfourdst_1_1composition_1_1_global_composition_a0df6ecfe28d13cbffd0abcbfec9aee41}{specificNumberDensity}}\ <<\ \textcolor{stringliteral}{"{}\(\backslash\)n"{}};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00763}00763\ \ \ \ \ \ \ \ \ os\ <<\ \textcolor{stringliteral}{"{}\(\backslash\)tMean\ Particle\ Mass:\ "{}}\ <<\ comp.\mbox{\hyperlink{structfourdst_1_1composition_1_1_global_composition_a9c35810d965841a755da9ce4644a2f1b}{meanParticleMass}}\ <<\ \textcolor{stringliteral}{"{}\(\backslash\)n"{}};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00764}00764\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ os;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00765}00765\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00766}00766\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00767}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_ae7a6a113fc5914248eff5629716d6eb2}{00767}}\ \ \ \ \ std::ostream\&\ \mbox{\hyperlink{namespacefourdst_1_1composition_a8468dde1b148c0583b8a9f85b8d0ce9a}{operator<<}}(std::ostream\&\ os,\ \textcolor{keyword}{const}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a1cccb94c150dd1dcde860f55fbeaf2bd}{CompositionEntry}}\&\ entry)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00768}00768\ \ \ \ \ \ \ \ \ os\ <<\ \textcolor{stringliteral}{"{}<"{}}\ <<\ entry.\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_ac273debdba6a1b3ac0f11698c399d38e}{m\_symbol}}\ <<\ \textcolor{stringliteral}{"{}\ :\ m\_frac\ =\ "{}}\ <<\ entry.\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a66cb086719d7f654869bd7b0cee87ffc}{mass\_fraction}}()\ <<\ \textcolor{stringliteral}{"{}>"{}};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00769}00769\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ os;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00770}00770\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00771}00771\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00772}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a36c2525d21cd932065bb2bb30bc57fb4}{00772}}\ \ \ \ \ std::ostream\&\ \mbox{\hyperlink{namespacefourdst_1_1composition_a8468dde1b148c0583b8a9f85b8d0ce9a}{operator<<}}(std::ostream\&\ os,\ \textcolor{keyword}{const}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a23b83b76ee025f6fc009184ee19bba88}{Composition}}\&\ \mbox{\hyperlink{namespacefourdst_1_1composition}{composition}})\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00773}00773\ \ \ \ \ \ \ \ \ os\ <<\ \textcolor{stringliteral}{"{}Composition(finalized:\ "{}}\ <<\ (\mbox{\hyperlink{namespacefourdst_1_1composition}{composition}}.m\_finalized\ ?\ \textcolor{stringliteral}{"{}true"{}}\ :\ \textcolor{stringliteral}{"{}false"{}})\ <<\ \textcolor{stringliteral}{"{},\ "{}}\ ;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00774}00774\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{size\_t}\ count\ =\ 0;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00775}00775\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{for}\ (\textcolor{keyword}{const}\ \textcolor{keyword}{auto}\ \&entry:\ \mbox{\hyperlink{namespacefourdst_1_1composition}{composition}}.m\_compositions\ |\ std::views::values)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00776}00776\ \ \ \ \ \ \ \ \ \ \ \ \ os\ <<\ entry;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00777}00777\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (count\ <\ \mbox{\hyperlink{namespacefourdst_1_1composition}{composition}}.m\_compositions.size()\ -\/\ 1)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00778}00778\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ os\ <<\ \textcolor{stringliteral}{"{},\ "{}};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00779}00779\ \ \ \ \ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00780}00780\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00781}00781\ \ \ \ \ \ \ \ \ os\ <<\ \textcolor{stringliteral}{"{})"{}};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00782}00782\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ os;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00783}00783\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00784}00784\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00785}00785\ \}\ \textcolor{comment}{//\ namespace\ fourdst::composition}}
|
||||
|
||||
\end{DoxyCode}
|
||||
27
docs/latex/composition_8h.tex
Normal file
27
docs/latex/composition_8h.tex
Normal file
@@ -0,0 +1,27 @@
|
||||
\doxysection{src/composition/include/fourdst/composition/composition.h File Reference}
|
||||
\hypertarget{composition_8h}{}\label{composition_8h}\index{src/composition/include/fourdst/composition/composition.h@{src/composition/include/fourdst/composition/composition.h}}
|
||||
{\ttfamily \#include $<$string$>$}\newline
|
||||
{\ttfamily \#include $<$unordered\+\_\+map$>$}\newline
|
||||
{\ttfamily \#include $<$set$>$}\newline
|
||||
{\ttfamily \#include $<$utility$>$}\newline
|
||||
{\ttfamily \#include "{}fourdst/config/config.\+h"{}}\newline
|
||||
{\ttfamily \#include "{}fourdst/logging/logging.\+h"{}}\newline
|
||||
{\ttfamily \#include "{}fourdst/composition/atomic\+Species.\+h"{}}\newline
|
||||
\doxysubsubsection*{Classes}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
struct \mbox{\hyperlink{structfourdst_1_1composition_1_1_canonical_composition}{fourdst\+::composition\+::\+Canonical\+Composition}}
|
||||
\begin{DoxyCompactList}\small\item\em Represents the canonical (X, Y, Z) composition of stellar material. \end{DoxyCompactList}\item
|
||||
struct \mbox{\hyperlink{structfourdst_1_1composition_1_1_global_composition}{fourdst\+::composition\+::\+Global\+Composition}}
|
||||
\begin{DoxyCompactList}\small\item\em Represents global properties of a finalized composition. \end{DoxyCompactList}\item
|
||||
struct \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry}{fourdst\+::composition\+::\+Composition\+Entry}}
|
||||
\begin{DoxyCompactList}\small\item\em Represents a single entry (an isotope) within a composition. \end{DoxyCompactList}\item
|
||||
class \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition}{fourdst\+::composition\+::\+Composition}}
|
||||
\begin{DoxyCompactList}\small\item\em Manages a collection of chemical species and their abundances. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
\doxysubsubsection*{Namespaces}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
namespace \mbox{\hyperlink{namespacefourdst}{fourdst}}
|
||||
\item
|
||||
namespace \mbox{\hyperlink{namespacefourdst_1_1composition}{fourdst\+::composition}}
|
||||
\end{DoxyCompactItemize}
|
||||
238
docs/latex/composition_8h_source.tex
Normal file
238
docs/latex/composition_8h_source.tex
Normal file
@@ -0,0 +1,238 @@
|
||||
\doxysection{composition.\+h}
|
||||
\hypertarget{composition_8h_source}{}\label{composition_8h_source}\index{src/composition/include/fourdst/composition/composition.h@{src/composition/include/fourdst/composition/composition.h}}
|
||||
\mbox{\hyperlink{composition_8h}{Go to the documentation of this file.}}
|
||||
\begin{DoxyCode}{0}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00001}00001\ \textcolor{comment}{/*\ ***********************************************************************}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00002}00002\ \textcolor{comment}{//}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00003}00003\ \textcolor{comment}{//\ \ \ Copyright\ (C)\ 2025\ -\/-\/\ The\ 4D-\/STAR\ Collaboration}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00004}00004\ \textcolor{comment}{//\ \ \ File\ Author:\ Emily\ Boudreaux}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00005}00005\ \textcolor{comment}{//\ \ \ Last\ Modified:\ March\ 26,\ 2025}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00006}00006\ \textcolor{comment}{//}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00007}00007\ \textcolor{comment}{//\ \ \ 4DSSE\ is\ free\ software;\ you\ can\ use\ it\ and/or\ modify}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00008}00008\ \textcolor{comment}{//\ \ \ it\ under\ the\ terms\ and\ restrictions\ the\ GNU\ General\ Library\ Public}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00009}00009\ \textcolor{comment}{//\ \ \ License\ version\ 3\ (GPLv3)\ as\ published\ by\ the\ Free\ Software\ Foundation.}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00010}00010\ \textcolor{comment}{//}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00011}00011\ \textcolor{comment}{//\ \ \ 4DSSE\ is\ distributed\ in\ the\ hope\ that\ it\ will\ be\ useful,}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00012}00012\ \textcolor{comment}{//\ \ \ but\ WITHOUT\ ANY\ WARRANTY;\ without\ even\ the\ implied\ warranty\ of}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00013}00013\ \textcolor{comment}{//\ \ \ MERCHANTABILITY\ or\ FITNESS\ FOR\ A\ PARTICULAR\ PURPOSE.}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00014}00014\ \textcolor{comment}{//\ \ \ See\ the\ GNU\ Library\ General\ Public\ License\ for\ more\ details.}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00015}00015\ \textcolor{comment}{//}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00016}00016\ \textcolor{comment}{//\ \ \ You\ should\ have\ received\ a\ copy\ of\ the\ GNU\ Library\ General\ Public\ License}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00017}00017\ \textcolor{comment}{//\ \ \ along\ with\ this\ software;\ if\ not,\ write\ to\ the\ Free\ Software}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00018}00018\ \textcolor{comment}{//\ \ \ Foundation,\ Inc.,\ 59\ Temple\ Place,\ Suite\ 330,\ Boston,\ MA\ 02111-\/1307\ USA}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00019}00019\ \textcolor{comment}{//}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00020}00020\ \textcolor{comment}{//\ ***********************************************************************\ */}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00021}00021\ \textcolor{preprocessor}{\#pragma\ once}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00022}00022\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00023}00023\ \textcolor{preprocessor}{\#include\ <string>}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00024}00024\ \textcolor{preprocessor}{\#include\ <unordered\_map>}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00025}00025\ \textcolor{preprocessor}{\#include\ <set>}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00026}00026\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00027}00027\ \textcolor{preprocessor}{\#include\ <utility>}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00028}00028\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00029}00029\ \textcolor{preprocessor}{\#include\ "{}fourdst/config/config.h"{}}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00030}00030\ \textcolor{preprocessor}{\#include\ "{}fourdst/logging/logging.h"{}}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00031}00031\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{atomic_species_8h}{fourdst/composition/atomicSpecies.h}}"{}}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00032}00032\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00033}\mbox{\hyperlink{namespacefourdst_1_1composition}{00033}}\ \textcolor{keyword}{namespace\ }\mbox{\hyperlink{namespacefourdst_1_1composition}{fourdst::composition}}\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00043}\mbox{\hyperlink{structfourdst_1_1composition_1_1_canonical_composition}{00043}}\ \ \ \ \ \textcolor{keyword}{struct\ }\mbox{\hyperlink{structfourdst_1_1composition_1_1_canonical_composition}{CanonicalComposition}}\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00044}\mbox{\hyperlink{structfourdst_1_1composition_1_1_canonical_composition_abe5b01574242f8eaabd00c3d653291f7}{00044}}\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_canonical_composition_abe5b01574242f8eaabd00c3d653291f7}{X}}\ =\ 0.0;\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00045}\mbox{\hyperlink{structfourdst_1_1composition_1_1_canonical_composition_a93927bfccc5d2b3906565d092ed4f7f4}{00045}}\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_canonical_composition_a93927bfccc5d2b3906565d092ed4f7f4}{Y}}\ =\ 0.0;\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00046}\mbox{\hyperlink{structfourdst_1_1composition_1_1_canonical_composition_ae1981f5ddd36abd17a4a69fa1f43de18}{00046}}\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_canonical_composition_ae1981f5ddd36abd17a4a69fa1f43de18}{Z}}\ =\ 0.0;\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00047}00047\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00054}\mbox{\hyperlink{structfourdst_1_1composition_1_1_canonical_composition_a6e447cb601af6bcbd09e290aef759672}{00054}}\ \ \ \ \ \ \ \ \ \textcolor{keyword}{friend}\ std::ostream\&\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_canonical_composition_a6e447cb601af6bcbd09e290aef759672}{operator<<}}(std::ostream\&\ os,\ \textcolor{keyword}{const}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_canonical_composition}{CanonicalComposition}}\&\ \mbox{\hyperlink{namespacefourdst_1_1composition}{composition}})\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00055}00055\ \ \ \ \ \ \ \ \ \ \ \ \ os\ <<\ \textcolor{stringliteral}{"{}<CanonicalComposition:\ "{}}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00056}00056\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ <<\ \textcolor{stringliteral}{"{}X\ =\ "{}}\ <<\ \mbox{\hyperlink{namespacefourdst_1_1composition}{composition}}.X\ <<\ \textcolor{stringliteral}{"{},\ "{}}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00057}00057\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ <<\ \textcolor{stringliteral}{"{}Y\ =\ "{}}\ <<\ \mbox{\hyperlink{namespacefourdst_1_1composition}{composition}}.Y\ <<\ \textcolor{stringliteral}{"{},\ "{}}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00058}00058\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ <<\ \textcolor{stringliteral}{"{}Z\ =\ "{}}\ <<\ \mbox{\hyperlink{namespacefourdst_1_1composition}{composition}}.Z\ <<\ \textcolor{stringliteral}{"{}>"{}};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00059}00059\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ os;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00060}00060\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00061}00061\ \ \ \ \ \};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00062}00062\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00069}\mbox{\hyperlink{structfourdst_1_1composition_1_1_global_composition}{00069}}\ \ \ \ \ \textcolor{keyword}{struct\ }\mbox{\hyperlink{structfourdst_1_1composition_1_1_global_composition}{GlobalComposition}}\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00070}\mbox{\hyperlink{structfourdst_1_1composition_1_1_global_composition_a0df6ecfe28d13cbffd0abcbfec9aee41}{00070}}\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_global_composition_a0df6ecfe28d13cbffd0abcbfec9aee41}{specificNumberDensity}};\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00071}\mbox{\hyperlink{structfourdst_1_1composition_1_1_global_composition_a9c35810d965841a755da9ce4644a2f1b}{00071}}\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_global_composition_a9c35810d965841a755da9ce4644a2f1b}{meanParticleMass}};\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00072}00072\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00073}00073\ \ \ \ \ \ \ \ \ \textcolor{comment}{//\ Overload\ the\ output\ stream\ operator\ for\ GlobalComposition}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00074}00074\ \ \ \ \ \ \ \ \ \textcolor{keyword}{friend}\ std::ostream\&\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_global_composition_a3c072a749c3648607771ac9105181f26}{operator<<}}(std::ostream\&\ os,\ \textcolor{keyword}{const}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_global_composition}{GlobalComposition}}\&\ comp);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00075}00075\ \ \ \ \ \};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00076}00076\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00083}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry}{00083}}\ \ \ \ \ \textcolor{keyword}{struct\ }\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a1cccb94c150dd1dcde860f55fbeaf2bd}{CompositionEntry}}\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00084}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_ac273debdba6a1b3ac0f11698c399d38e}{00084}}\ \ \ \ \ \ \ \ \ std::string\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_ac273debdba6a1b3ac0f11698c399d38e}{m\_symbol}};\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00085}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a79039cbdc76b4401eb2ce44b85467503}{00085}}\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{atomic::Species}}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a79039cbdc76b4401eb2ce44b85467503}{m\_isotope}};\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00086}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a1e860519bea86793413ed67c76d18c8b}{00086}}\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a1e860519bea86793413ed67c76d18c8b}{m\_massFracMode}}\ =\ \textcolor{keyword}{true};\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00087}00087\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00088}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_adc20165bf94e18eea3458003025579ac}{00088}}\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_adc20165bf94e18eea3458003025579ac}{m\_massFraction}}\ =\ 0.0;\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00089}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a2b5e245f7dabb11076efdbe1ed516d9f}{00089}}\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a2b5e245f7dabb11076efdbe1ed516d9f}{m\_numberFraction}}\ =\ 0.0;\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00090}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a0498d707d8ea78be39283786c10657ef}{00090}}\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a0498d707d8ea78be39283786c10657ef}{m\_relAbundance}}\ =\ 0.0;\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00091}00091\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00092}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a391e899874cd7ef299a3ae1f64c016d2}{00092}}\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a391e899874cd7ef299a3ae1f64c016d2}{m\_initialized}}\ =\ \textcolor{keyword}{false};\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00093}00093\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00097}00097\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a1cccb94c150dd1dcde860f55fbeaf2bd}{CompositionEntry}}();}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00098}00098\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00110}00110\ \ \ \ \ \ \ \ \ \textcolor{keyword}{explicit}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a1cccb94c150dd1dcde860f55fbeaf2bd}{CompositionEntry}}(\textcolor{keyword}{const}\ std::string\&\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a50d18b4c27611fa9314dd756af54c2f0}{symbol}},\ \textcolor{keywordtype}{bool}\ massFracMode=\textcolor{keyword}{true});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00111}00111\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00116}00116\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a1cccb94c150dd1dcde860f55fbeaf2bd}{CompositionEntry}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a1cccb94c150dd1dcde860f55fbeaf2bd}{CompositionEntry}}\&\ entry);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00117}00117\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00124}00124\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{void}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a5885a0e33687bceb15b225a00163e9d3}{setSpecies}}(\textcolor{keyword}{const}\ std::string\&\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a50d18b4c27611fa9314dd756af54c2f0}{symbol}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00125}00125\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00130}00130\ \ \ \ \ \ \ \ \ [[nodiscard]]\ std::string\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a50d18b4c27611fa9314dd756af54c2f0}{symbol}}()\ \textcolor{keyword}{const};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00131}00131\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00138}00138\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a66cb086719d7f654869bd7b0cee87ffc}{mass\_fraction}}()\ \textcolor{keyword}{const};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00139}00139\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00145}00145\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a66cb086719d7f654869bd7b0cee87ffc}{mass\_fraction}}(\textcolor{keywordtype}{double}\ meanMolarMass)\ \textcolor{keyword}{const};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00146}00146\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00153}00153\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a2d55492d285068d4a64db5602dfb1c78}{number\_fraction}}()\ \textcolor{keyword}{const};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00154}00154\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00160}00160\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a2d55492d285068d4a64db5602dfb1c78}{number\_fraction}}(\textcolor{keywordtype}{double}\ totalMoles)\ \textcolor{keyword}{const};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00161}00161\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00166}00166\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_ab6619d23e111905d1e3ab16ee822d96c}{rel\_abundance}}()\ \textcolor{keyword}{const};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00167}00167\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00172}00172\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{atomic::Species}}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_af4f8d292d18755670a914072e2260dfb}{isotope}}()\ \textcolor{keyword}{const};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00173}00173\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00178}00178\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a14f12b8b0178df2e32e2023bd4564ddc}{getMassFracMode}}()\ \textcolor{keyword}{const};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00179}00179\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00186}00186\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{void}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a4d6df43e098e7e2e2d94ff7fb76cb4c2}{setMassFraction}}(\textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a66cb086719d7f654869bd7b0cee87ffc}{mass\_fraction}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00187}00187\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00194}00194\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{void}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a9ec47cf4b3399128d3836c1b24b031b0}{setNumberFraction}}(\textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a2d55492d285068d4a64db5602dfb1c78}{number\_fraction}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00195}00195\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00201}00201\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a3fb3f63a4e5675c6fefb662a8e3e7aa3}{setMassFracMode}}(\textcolor{keywordtype}{double}\ meanMolarMass);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00202}00202\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00208}00208\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a743042d1998875851150d789817f5473}{setNumberFracMode}}(\textcolor{keywordtype}{double}\ totalMoles);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00209}00209\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00216}00216\ \ \ \ \ \ \ \ \ \textcolor{keyword}{friend}\ std::ostream\&\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_ae7a6a113fc5914248eff5629716d6eb2}{operator<<}}(std::ostream\&\ os,\ \textcolor{keyword}{const}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a1cccb94c150dd1dcde860f55fbeaf2bd}{CompositionEntry}}\&\ entry);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00217}00217\ \ \ \ \ \};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00218}00218\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00258}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition}{00258}}\ \ \ \ \ \textcolor{keyword}{class\ }\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a23b83b76ee025f6fc009184ee19bba88}{Composition}}\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00259}00259\ \ \ \ \ \textcolor{keyword}{private}:}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00260}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a8a8096863464338bc6e3c5124407dca4}{00260}}\ \ \ \ \ \ \ \ \ fourdst::config::Config\&\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a8a8096863464338bc6e3c5124407dca4}{m\_config}}\ =\ fourdst::config::Config::getInstance();}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00261}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a695d37ec6cde63d86a20df1e9f26af19}{00261}}\ \ \ \ \ \ \ \ \ fourdst::logging::LogManager\&\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a695d37ec6cde63d86a20df1e9f26af19}{m\_logManager}}\ =\ fourdst::logging::LogManager::getInstance();}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00262}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ab6c66f35e1fb05dd24aacaf90e115c5e}{00262}}\ \ \ \ \ \ \ \ \ quill::Logger*\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ab6c66f35e1fb05dd24aacaf90e115c5e}{m\_logger}}\ =\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a695d37ec6cde63d86a20df1e9f26af19}{m\_logManager}}.getLogger(\textcolor{stringliteral}{"{}log"{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00263}00263\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00264}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa00cbc0933d8a22bb900ac21a338e5ac}{00264}}\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa00cbc0933d8a22bb900ac21a338e5ac}{m\_finalized}}\ =\ \textcolor{keyword}{false};\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00265}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_addae4484da7d5072ab66a721dbe04ced}{00265}}\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_addae4484da7d5072ab66a721dbe04ced}{m\_specificNumberDensity}}\ =\ 0.0;\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00266}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a4a36c8d22ce61023e7bea1d9417577d4}{00266}}\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a4a36c8d22ce61023e7bea1d9417577d4}{m\_meanParticleMass}}\ =\ 0.0;\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00267}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a671f1ee8be00f4ff8c1d94fabb382380}{00267}}\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a671f1ee8be00f4ff8c1d94fabb382380}{m\_massFracMode}}\ =\ \textcolor{keyword}{true};\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00268}00268\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00269}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a39bfcb7d81d723cbd9d021abd533b4d6}{00269}}\ \ \ \ \ \ \ \ \ std::set<std::string>\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a39bfcb7d81d723cbd9d021abd533b4d6}{m\_registeredSymbols}};\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00270}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa7f2753b10e85ae3bbf0c3d600a973db}{00270}}\ \ \ \ \ \ \ \ \ std::unordered\_map<std::string,\ CompositionEntry>\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa7f2753b10e85ae3bbf0c3d600a973db}{m\_compositions}};\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00271}00271\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00277}00277\ \ \ \ \ \ \ \ \ \textcolor{keyword}{static}\ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a8fdac26e6298008aaeaa5b15f7fe244f}{isValidSymbol}}(\textcolor{keyword}{const}\ std::string\&\ symbol);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00278}00278\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00284}00284\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_addf03ba8b988970d341884d487aa94d5}{isValidComposition}}(\textcolor{keyword}{const}\ std::vector<double>\&\ fractions)\ \textcolor{keyword}{const};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00285}00285\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00291}00291\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{void}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a86982685c34db4a8f079ddafc25c594e}{validateComposition}}(\textcolor{keyword}{const}\ std::vector<double>\&\ fractions)\ \textcolor{keyword}{const};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00292}00292\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00298}00298\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a869dbae3db9d09c57b2df56a813a55fb}{finalizeMassFracMode}}(\textcolor{keywordtype}{bool}\ norm);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00299}00299\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00305}00305\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a461ab4e9cb5975cf865db5f16f03ddfe}{finalizeNumberFracMode}}(\textcolor{keywordtype}{bool}\ norm);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00306}00306\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00307}00307\ \ \ \ \ \textcolor{keyword}{public}:}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00311}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a23b83b76ee025f6fc009184ee19bba88}{00311}}\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a23b83b76ee025f6fc009184ee19bba88}{Composition}}()\ =\ \textcolor{keywordflow}{default};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00312}00312\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00316}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa3ff8ece122a9fad1252061148566749}{00316}}\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa3ff8ece122a9fad1252061148566749}{\string~Composition}}()\ =\ \textcolor{keywordflow}{default};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00317}00317\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00327}00327\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a72d063a74a9d2197065884a2cea57a14}{finalize}}(\textcolor{keywordtype}{bool}\ norm=\textcolor{keyword}{false});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00328}00328\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00342}00342\ \ \ \ \ \ \ \ \ \textcolor{keyword}{explicit}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a23b83b76ee025f6fc009184ee19bba88}{Composition}}(\textcolor{keyword}{const}\ std::vector<std::string>\&\ symbols);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00343}00343\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00354}00354\ \ \ \ \ \ \ \ \ \textcolor{keyword}{explicit}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a23b83b76ee025f6fc009184ee19bba88}{Composition}}(\textcolor{keyword}{const}\ std::set<std::string>\&\ symbols);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00355}00355\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00373}00373\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a23b83b76ee025f6fc009184ee19bba88}{Composition}}(\textcolor{keyword}{const}\ std::vector<std::string>\&\ symbols,\ \textcolor{keyword}{const}\ std::vector<double>\&\ fractions,\ \textcolor{keywordtype}{bool}\ massFracMode=\textcolor{keyword}{true});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00374}00374\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00379}00379\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a23b83b76ee025f6fc009184ee19bba88}{Composition}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a23b83b76ee025f6fc009184ee19bba88}{Composition}}\&\ \mbox{\hyperlink{namespacefourdst_1_1composition}{composition}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00380}00380\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00386}00386\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a23b83b76ee025f6fc009184ee19bba88}{Composition}}\&\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a4ec1e23cfecef764cb831171fed62fc2}{operator=}}(\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a23b83b76ee025f6fc009184ee19bba88}{Composition}}\ \textcolor{keyword}{const}\&\ other);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00387}00387\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00402}00402\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{void}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a1bc2e64f87c12befdc2bc767e7405661}{registerSymbol}}(\textcolor{keyword}{const}\ std::string\&\ symbol,\ \textcolor{keywordtype}{bool}\ massFracMode=\textcolor{keyword}{true});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00403}00403\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00417}00417\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{void}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a1bc2e64f87c12befdc2bc767e7405661}{registerSymbol}}(\textcolor{keyword}{const}\ std::vector<std::string>\&\ symbols,\ \textcolor{keywordtype}{bool}\ massFracMode=\textcolor{keyword}{true});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00418}00418\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00432}00432\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{void}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a4ce00f73cc133bb1bac2b030b93ab480}{registerSpecies}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{fourdst::atomic::Species}}\&\ species,\ \textcolor{keywordtype}{bool}\ massFracMode=\textcolor{keyword}{true});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00433}00433\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00434}00434\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00449}00449\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{void}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a4ce00f73cc133bb1bac2b030b93ab480}{registerSpecies}}(\textcolor{keyword}{const}\ std::vector<fourdst::atomic::Species>\&\ species,\ \textcolor{keywordtype}{bool}\ massFracMode=\textcolor{keyword}{true});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00450}00450\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00451}00451\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00456}00456\ \ \ \ \ \ \ \ \ [[nodiscard]]\ std::set<std::string>\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a84c7b72c2aee46b94492d404855dd3e0}{getRegisteredSymbols}}()\ \textcolor{keyword}{const};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00457}00457\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00462}00462\ \ \ \ \ \ \ \ \ [[nodiscard]]\ std::set<fourdst::atomic::Species>\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a3dee7b5e1f54920de9eab99f95a516ec}{getRegisteredSpecies}}()\ \textcolor{keyword}{const};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00463}00463\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00480}00480\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a493224656aa3ade68389250720ef09af}{setMassFraction}}(\textcolor{keyword}{const}\ std::string\&\ symbol,\ \textcolor{keyword}{const}\ \textcolor{keywordtype}{double}\&\ mass\_fraction);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00481}00481\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00491}00491\ \ \ \ \ \ \ \ \ std::vector<double>\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a493224656aa3ade68389250720ef09af}{setMassFraction}}(\textcolor{keyword}{const}\ std::vector<std::string>\&\ symbols,\ \textcolor{keyword}{const}\ std::vector<double>\&\ mass\_fractions);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00492}00492\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00502}00502\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a493224656aa3ade68389250720ef09af}{setMassFraction}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{fourdst::atomic::Species}}\&\ species,\ \textcolor{keyword}{const}\ \textcolor{keywordtype}{double}\&\ mass\_fraction);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00503}00503\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00511}00511\ \ \ \ \ \ \ \ \ std::vector<double>\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a493224656aa3ade68389250720ef09af}{setMassFraction}}(\textcolor{keyword}{const}\ std::vector<fourdst::atomic::Species>\&\ species,\ \textcolor{keyword}{const}\ std::vector<double>\&\ mass\_fractions);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00512}00512\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00523}00523\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a7d4d748f3ee25e68751fb143717ed080}{setNumberFraction}}(\textcolor{keyword}{const}\ std::string\&\ symbol,\ \textcolor{keyword}{const}\ \textcolor{keywordtype}{double}\&\ number\_fraction);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00524}00524\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00533}00533\ \ \ \ \ \ \ \ \ std::vector<double>\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a7d4d748f3ee25e68751fb143717ed080}{setNumberFraction}}(\textcolor{keyword}{const}\ std::vector<std::string>\&\ symbols,\ \textcolor{keyword}{const}\ std::vector<double>\&\ number\_fractions);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00534}00534\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00544}00544\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a7d4d748f3ee25e68751fb143717ed080}{setNumberFraction}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{fourdst::atomic::Species}}\&\ species,\ \textcolor{keyword}{const}\ \textcolor{keywordtype}{double}\&\ number\_fraction);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00545}00545\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00553}00553\ \ \ \ \ \ \ \ \ std::vector<double>\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a7d4d748f3ee25e68751fb143717ed080}{setNumberFraction}}(\textcolor{keyword}{const}\ std::vector<fourdst::atomic::Species>\&\ species,\ \textcolor{keyword}{const}\ std::vector<double>\&\ number\_fractions);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00554}00554\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00567}00567\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a23b83b76ee025f6fc009184ee19bba88}{Composition}}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a3aead72892606725a4149a5f65bd31ec}{mix}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a23b83b76ee025f6fc009184ee19bba88}{Composition}}\&\ other,\ \textcolor{keywordtype}{double}\ fraction)\ \textcolor{keyword}{const};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00568}00568\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00575}00575\ \ \ \ \ \ \ \ \ [[nodiscard]]\ std::unordered\_map<std::string,\ double>\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ad20bd541dd7c45274a2e586e6a0519a7}{getMassFraction}}()\ \textcolor{keyword}{const};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00576}00576\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00585}00585\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ad20bd541dd7c45274a2e586e6a0519a7}{getMassFraction}}(\textcolor{keyword}{const}\ std::string\&\ symbol)\ \textcolor{keyword}{const};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00586}00586\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00595}00595\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ad20bd541dd7c45274a2e586e6a0519a7}{getMassFraction}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{fourdst::atomic::Species}}\&\ species)\ \textcolor{keyword}{const};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00596}00596\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00605}00605\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a7731df9b30f8c8f13231f7e1a17b105c}{getNumberFraction}}(\textcolor{keyword}{const}\ std::string\&\ symbol)\ \textcolor{keyword}{const};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00606}00606\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00615}00615\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a7731df9b30f8c8f13231f7e1a17b105c}{getNumberFraction}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{fourdst::atomic::Species}}\&\ species)\ \textcolor{keyword}{const};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00616}00616\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00623}00623\ \ \ \ \ \ \ \ \ [[nodiscard]]\ std::unordered\_map<std::string,\ double>\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a7731df9b30f8c8f13231f7e1a17b105c}{getNumberFraction}}()\ \textcolor{keyword}{const};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00624}00624\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00633}00633\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a67a2ed844f3aee3d9cc1a3cb996eb56f}{getMolarAbundance}}(\textcolor{keyword}{const}\ std::string\&\ symbol)\ \textcolor{keyword}{const};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00634}00634\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00643}00643\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a67a2ed844f3aee3d9cc1a3cb996eb56f}{getMolarAbundance}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{fourdst::atomic::Species}}\&\ species)\ \textcolor{keyword}{const};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00644}00644\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00653}00653\ \ \ \ \ \ \ \ \ [[nodiscard]]\ std::pair<CompositionEntry,\ GlobalComposition>\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a1138c86f7ccd39594601c2ec63ad89e9}{getComposition}}(\textcolor{keyword}{const}\ std::string\&\ symbol)\ \textcolor{keyword}{const};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00654}00654\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00663}00663\ \ \ \ \ \ \ \ \ [[nodiscard]]\ std::pair<CompositionEntry,\ GlobalComposition>\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a1138c86f7ccd39594601c2ec63ad89e9}{getComposition}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{fourdst::atomic::Species}}\&\ species)\ \textcolor{keyword}{const};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00664}00664\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00671}00671\ \ \ \ \ \ \ \ \ [[nodiscard]]\ std::pair<std::unordered\_map<std::string,\ CompositionEntry>,\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_global_composition}{GlobalComposition}}>\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a1138c86f7ccd39594601c2ec63ad89e9}{getComposition}}()\ \textcolor{keyword}{const};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00672}00672\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00679}00679\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a66401fed7054172e9b1a2687e5cc8eff}{getMeanParticleMass}}()\ \textcolor{keyword}{const};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00680}00680\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00687}00687\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a98199f435cb553f5cf4f8e520fdb8a7a}{getMeanAtomicNumber}}()\ \textcolor{keyword}{const};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00688}00688\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00698}00698\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a23b83b76ee025f6fc009184ee19bba88}{Composition}}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a17635cd21744c7cf86cb1eb75152c816}{subset}}(\textcolor{keyword}{const}\ std::vector<std::string>\&\ symbols,\ \textcolor{keyword}{const}\ std::string\&\ method=\textcolor{stringliteral}{"{}norm"{}})\ \textcolor{keyword}{const};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00699}00699\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00705}00705\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a72a368f27094b03fdd9896844e075c94}{hasSymbol}}(\textcolor{keyword}{const}\ std::string\&\ symbol)\ \textcolor{keyword}{const};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00706}00706\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00714}00714\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_acb08478f7032ecc13cb02283a18187e9}{contains}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{fourdst::atomic::Species}}\&\ isotope)\ \textcolor{keyword}{const};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00715}00715\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00724}00724\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{void}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a0af981ed1074b26c237cf6cf35f82c9e}{setCompositionMode}}(\textcolor{keywordtype}{bool}\ massFracMode);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00725}00725\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00735}00735\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_canonical_composition}{CanonicalComposition}}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ac75dbc8377556c835455991c7c7fe206}{getCanonicalComposition}}(\textcolor{keywordtype}{bool}\ harsh=\textcolor{keyword}{false})\ \textcolor{keyword}{const};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00736}00736\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00743}00743\ \ \ \ \ \ \ \ \ \textcolor{keyword}{friend}\ std::ostream\&\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a36c2525d21cd932065bb2bb30bc57fb4}{operator<<}}(std::ostream\&\ os,\ \textcolor{keyword}{const}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a23b83b76ee025f6fc009184ee19bba88}{Composition}}\&\ \mbox{\hyperlink{namespacefourdst_1_1composition}{composition}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00744}00744\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00753}00753\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a23b83b76ee025f6fc009184ee19bba88}{Composition}}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a24a3bdeb8e8e55b54ecdee6dcb0d9561}{operator+}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a23b83b76ee025f6fc009184ee19bba88}{Composition}}\&\ other)\ \textcolor{keyword}{const};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00754}00754\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00759}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ab1701644ff1c83c220dc04eb58d1621b}{00759}}\ \ \ \ \ \ \ \ \ \textcolor{keyword}{auto}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ab1701644ff1c83c220dc04eb58d1621b}{begin}}()\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00760}00760\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa7f2753b10e85ae3bbf0c3d600a973db}{m\_compositions}}.begin();}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00761}00761\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00762}00762\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00767}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_adf41a833e8b704daf4f581fca5c8cb9b}{00767}}\ \ \ \ \ \ \ \ \ \textcolor{keyword}{auto}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_adf41a833e8b704daf4f581fca5c8cb9b}{begin}}()\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00768}00768\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa7f2753b10e85ae3bbf0c3d600a973db}{m\_compositions}}.cbegin();}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00769}00769\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00770}00770\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00775}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_adeaf6f1213e78cb1fe8a8317f0a8adc2}{00775}}\ \ \ \ \ \ \ \ \ \textcolor{keyword}{auto}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_adeaf6f1213e78cb1fe8a8317f0a8adc2}{end}}()\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00776}00776\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa7f2753b10e85ae3bbf0c3d600a973db}{m\_compositions}}.end();}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00777}00777\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00778}00778\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00783}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aed2f5676f8f742199f01e4d1e9664bdd}{00783}}\ \ \ \ \ \ \ \ \ \textcolor{keyword}{auto}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aed2f5676f8f742199f01e4d1e9664bdd}{end}}()\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00784}00784\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa7f2753b10e85ae3bbf0c3d600a973db}{m\_compositions}}.cend();}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00785}00785\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00786}00786\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00787}00787\ \ \ \ \ \};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00788}00788\ \};\ \textcolor{comment}{//\ namespace\ fourdst::composition}}
|
||||
|
||||
\end{DoxyCode}
|
||||
7
docs/latex/dir_3c9efac6790a3720e63e1a08c00d11f2.tex
Normal file
7
docs/latex/dir_3c9efac6790a3720e63e1a08c00d11f2.tex
Normal file
@@ -0,0 +1,7 @@
|
||||
\doxysection{src/composition/include/fourdst Directory Reference}
|
||||
\hypertarget{dir_3c9efac6790a3720e63e1a08c00d11f2}{}\label{dir_3c9efac6790a3720e63e1a08c00d11f2}\index{src/composition/include/fourdst Directory Reference@{src/composition/include/fourdst Directory Reference}}
|
||||
\doxysubsubsection*{Directories}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
directory \mbox{\hyperlink{dir_f0fdd83dd0cb4aa6fd6a832374ae4f05}{composition}}
|
||||
\end{DoxyCompactItemize}
|
||||
9
docs/latex/dir_425afc2e69e55565110382214454a15b.tex
Normal file
9
docs/latex/dir_425afc2e69e55565110382214454a15b.tex
Normal file
@@ -0,0 +1,9 @@
|
||||
\doxysection{src/composition Directory Reference}
|
||||
\hypertarget{dir_425afc2e69e55565110382214454a15b}{}\label{dir_425afc2e69e55565110382214454a15b}\index{src/composition Directory Reference@{src/composition Directory Reference}}
|
||||
\doxysubsubsection*{Directories}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
directory \mbox{\hyperlink{dir_cb6fc2f7165eff3b2362b2440dfaea8e}{include}}
|
||||
\item
|
||||
directory \mbox{\hyperlink{dir_e22a97de167fe22ecd13733f7a34b9f0}{lib}}
|
||||
\end{DoxyCompactItemize}
|
||||
7
docs/latex/dir_49e56c817e5e54854c35e136979f97ca.tex
Normal file
7
docs/latex/dir_49e56c817e5e54854c35e136979f97ca.tex
Normal file
@@ -0,0 +1,7 @@
|
||||
\doxysection{docs Directory Reference}
|
||||
\hypertarget{dir_49e56c817e5e54854c35e136979f97ca}{}\label{dir_49e56c817e5e54854c35e136979f97ca}\index{docs Directory Reference@{docs Directory Reference}}
|
||||
\doxysubsubsection*{Directories}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
directory \mbox{\hyperlink{dir_c34d5e8363cf0aa3fabc4f3fad3412a4}{static}}
|
||||
\end{DoxyCompactItemize}
|
||||
7
docs/latex/dir_68267d1309a1af8e8297ef4c3efbcdba.tex
Normal file
7
docs/latex/dir_68267d1309a1af8e8297ef4c3efbcdba.tex
Normal file
@@ -0,0 +1,7 @@
|
||||
\doxysection{src Directory Reference}
|
||||
\hypertarget{dir_68267d1309a1af8e8297ef4c3efbcdba}{}\label{dir_68267d1309a1af8e8297ef4c3efbcdba}\index{src Directory Reference@{src Directory Reference}}
|
||||
\doxysubsubsection*{Directories}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
directory \mbox{\hyperlink{dir_425afc2e69e55565110382214454a15b}{composition}}
|
||||
\end{DoxyCompactItemize}
|
||||
7
docs/latex/dir_88aa30610c51652b536406602eb05405.tex
Normal file
7
docs/latex/dir_88aa30610c51652b536406602eb05405.tex
Normal file
@@ -0,0 +1,7 @@
|
||||
\doxysection{src/composition/include/fourdst/composition/exceptions Directory Reference}
|
||||
\hypertarget{dir_88aa30610c51652b536406602eb05405}{}\label{dir_88aa30610c51652b536406602eb05405}\index{src/composition/include/fourdst/composition/exceptions Directory Reference@{src/composition/include/fourdst/composition/exceptions Directory Reference}}
|
||||
\doxysubsubsection*{Files}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
file \mbox{\hyperlink{exceptions__composition_8h}{exceptions\+\_\+composition.\+h}}
|
||||
\end{DoxyCompactItemize}
|
||||
2
docs/latex/dir_c34d5e8363cf0aa3fabc4f3fad3412a4.tex
Normal file
2
docs/latex/dir_c34d5e8363cf0aa3fabc4f3fad3412a4.tex
Normal file
@@ -0,0 +1,2 @@
|
||||
\doxysection{docs/static Directory Reference}
|
||||
\hypertarget{dir_c34d5e8363cf0aa3fabc4f3fad3412a4}{}\label{dir_c34d5e8363cf0aa3fabc4f3fad3412a4}\index{docs/static Directory Reference@{docs/static Directory Reference}}
|
||||
7
docs/latex/dir_cb6fc2f7165eff3b2362b2440dfaea8e.tex
Normal file
7
docs/latex/dir_cb6fc2f7165eff3b2362b2440dfaea8e.tex
Normal file
@@ -0,0 +1,7 @@
|
||||
\doxysection{src/composition/include Directory Reference}
|
||||
\hypertarget{dir_cb6fc2f7165eff3b2362b2440dfaea8e}{}\label{dir_cb6fc2f7165eff3b2362b2440dfaea8e}\index{src/composition/include Directory Reference@{src/composition/include Directory Reference}}
|
||||
\doxysubsubsection*{Directories}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
directory \mbox{\hyperlink{dir_3c9efac6790a3720e63e1a08c00d11f2}{fourdst}}
|
||||
\end{DoxyCompactItemize}
|
||||
7
docs/latex/dir_e22a97de167fe22ecd13733f7a34b9f0.tex
Normal file
7
docs/latex/dir_e22a97de167fe22ecd13733f7a34b9f0.tex
Normal file
@@ -0,0 +1,7 @@
|
||||
\doxysection{src/composition/lib Directory Reference}
|
||||
\hypertarget{dir_e22a97de167fe22ecd13733f7a34b9f0}{}\label{dir_e22a97de167fe22ecd13733f7a34b9f0}\index{src/composition/lib Directory Reference@{src/composition/lib Directory Reference}}
|
||||
\doxysubsubsection*{Files}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
file \mbox{\hyperlink{composition_8cpp}{composition.\+cpp}}
|
||||
\end{DoxyCompactItemize}
|
||||
16
docs/latex/dir_f0fdd83dd0cb4aa6fd6a832374ae4f05.tex
Normal file
16
docs/latex/dir_f0fdd83dd0cb4aa6fd6a832374ae4f05.tex
Normal file
@@ -0,0 +1,16 @@
|
||||
\doxysection{src/composition/include/fourdst/composition Directory Reference}
|
||||
\hypertarget{dir_f0fdd83dd0cb4aa6fd6a832374ae4f05}{}\label{dir_f0fdd83dd0cb4aa6fd6a832374ae4f05}\index{src/composition/include/fourdst/composition Directory Reference@{src/composition/include/fourdst/composition Directory Reference}}
|
||||
\doxysubsubsection*{Directories}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
directory \mbox{\hyperlink{dir_88aa30610c51652b536406602eb05405}{exceptions}}
|
||||
\end{DoxyCompactItemize}
|
||||
\doxysubsubsection*{Files}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
file \mbox{\hyperlink{atomic_species_8h}{atomic\+Species.\+h}}
|
||||
\item
|
||||
file \mbox{\hyperlink{composition_8h}{composition.\+h}}
|
||||
\item
|
||||
file \mbox{\hyperlink{species_8h}{species.\+h}}
|
||||
\end{DoxyCompactItemize}
|
||||
714
docs/latex/doxygen.sty
Normal file
714
docs/latex/doxygen.sty
Normal file
@@ -0,0 +1,714 @@
|
||||
\NeedsTeXFormat{LaTeX2e}
|
||||
\ProvidesPackage{doxygen}
|
||||
|
||||
% Packages used by this style file
|
||||
\RequirePackage{alltt}
|
||||
%%\RequirePackage{array} %% moved to refman.tex due to workaround for LaTex 2019 version and unmaintained tabu package
|
||||
\RequirePackage{calc}
|
||||
\RequirePackage{float}
|
||||
%%\RequirePackage{ifthen} %% moved to refman.tex due to workaround for LaTex 2019 version and unmaintained tabu package
|
||||
\RequirePackage{verbatim}
|
||||
\RequirePackage[table]{xcolor}
|
||||
\RequirePackage{longtable_doxygen}
|
||||
\RequirePackage{tabu_doxygen}
|
||||
\RequirePackage{fancyvrb}
|
||||
\RequirePackage{tabularx}
|
||||
\RequirePackage{multicol}
|
||||
\RequirePackage{multirow}
|
||||
\RequirePackage{hanging}
|
||||
\RequirePackage{ifpdf}
|
||||
\RequirePackage{adjustbox}
|
||||
\RequirePackage{amssymb}
|
||||
\RequirePackage{stackengine}
|
||||
\RequirePackage{enumitem}
|
||||
\RequirePackage{alphalph}
|
||||
\RequirePackage[normalem]{ulem} % for strikeout, but don't modify emphasis
|
||||
|
||||
%---------- Internal commands used in this style file ----------------
|
||||
|
||||
\newcommand{\ensurespace}[1]{%
|
||||
\begingroup%
|
||||
\setlength{\dimen@}{#1}%
|
||||
\vskip\z@\@plus\dimen@%
|
||||
\penalty -100\vskip\z@\@plus -\dimen@%
|
||||
\vskip\dimen@%
|
||||
\penalty 9999%
|
||||
\vskip -\dimen@%
|
||||
\vskip\z@skip% hide the previous |\vskip| from |\addvspace|
|
||||
\endgroup%
|
||||
}
|
||||
|
||||
\newcommand{\DoxyHorRuler}[1]{%
|
||||
\setlength{\parskip}{0ex plus 0ex minus 0ex}%
|
||||
\ifthenelse{#1=0}%
|
||||
{%
|
||||
\hrule%
|
||||
}%
|
||||
{%
|
||||
\hrulefilll%
|
||||
}%
|
||||
}
|
||||
\newcommand{\DoxyLabelFont}{}
|
||||
\newcommand{\entrylabel}[1]{%
|
||||
{%
|
||||
\parbox[b]{\labelwidth-4pt}{%
|
||||
\makebox[0pt][l]{\DoxyLabelFont#1}%
|
||||
\vspace{1.5\baselineskip}%
|
||||
}%
|
||||
}%
|
||||
}
|
||||
|
||||
\newenvironment{DoxyDesc}[1]{%
|
||||
\ensurespace{4\baselineskip}%
|
||||
\begin{list}{}{%
|
||||
\settowidth{\labelwidth}{20pt}%
|
||||
%\setlength{\parsep}{0pt}%
|
||||
\setlength{\itemsep}{0pt}%
|
||||
\setlength{\leftmargin}{\labelwidth+\labelsep}%
|
||||
\renewcommand{\makelabel}{\entrylabel}%
|
||||
}%
|
||||
\item[#1]%
|
||||
}{%
|
||||
\end{list}%
|
||||
}
|
||||
|
||||
\newsavebox{\xrefbox}
|
||||
\newlength{\xreflength}
|
||||
\newcommand{\xreflabel}[1]{%
|
||||
\sbox{\xrefbox}{#1}%
|
||||
\setlength{\xreflength}{\wd\xrefbox}%
|
||||
\ifthenelse{\xreflength>\labelwidth}{%
|
||||
\begin{minipage}{\textwidth}%
|
||||
\setlength{\parindent}{0pt}%
|
||||
\hangindent=15pt\bfseries #1\vspace{1.2\itemsep}%
|
||||
\end{minipage}%
|
||||
}{%
|
||||
\parbox[b]{\labelwidth}{\makebox[0pt][l]{\textbf{#1}}}%
|
||||
}%
|
||||
}
|
||||
|
||||
%---------- Commands used by doxygen LaTeX output generator ----------
|
||||
|
||||
% Used by <pre> ... </pre>
|
||||
\newenvironment{DoxyPre}{%
|
||||
\small%
|
||||
\begin{alltt}%
|
||||
}{%
|
||||
\end{alltt}%
|
||||
\normalsize%
|
||||
}
|
||||
% Necessary for redefining not defined characters, i.e. "Replacement Character" in tex output.
|
||||
\newlength{\CodeWidthChar}
|
||||
\newlength{\CodeHeightChar}
|
||||
\settowidth{\CodeWidthChar}{?}
|
||||
\settoheight{\CodeHeightChar}{?}
|
||||
% Necessary for hanging indent
|
||||
\newlength{\DoxyCodeWidth}
|
||||
|
||||
\newcommand\DoxyCodeLine[1]{
|
||||
\ifthenelse{\equal{\detokenize{#1}}{}}
|
||||
{
|
||||
\vspace*{\baselineskip}
|
||||
}
|
||||
{
|
||||
\hangpara{\DoxyCodeWidth}{1}{#1}\par
|
||||
}
|
||||
}
|
||||
|
||||
\newcommand\NiceSpace{%
|
||||
\discretionary{}{\kern\fontdimen2\font}{\kern\fontdimen2\font}%
|
||||
}
|
||||
|
||||
% Used by @code ... @endcode
|
||||
\newenvironment{DoxyCode}[1]{%
|
||||
\par%
|
||||
\vspace{2pt}%
|
||||
\scriptsize%
|
||||
\normalfont\ttfamily%
|
||||
\rightskip0pt plus 1fil%
|
||||
\settowidth{\DoxyCodeWidth}{000000}%
|
||||
\settowidth{\CodeWidthChar}{?}%
|
||||
\settoheight{\CodeHeightChar}{?}%
|
||||
\setlength{\parskip}{0ex plus 0ex minus 0ex}%
|
||||
\ifthenelse{\equal{#1}{0}}%
|
||||
{%
|
||||
{\lccode`~32 \lowercase{\global\let~}\NiceSpace}\obeyspaces%
|
||||
}%
|
||||
{%
|
||||
{\lccode`~32 \lowercase{\global\let~}}\obeyspaces%
|
||||
}%
|
||||
\vspace{2pt}%
|
||||
}{%
|
||||
\normalfont%
|
||||
\normalsize%
|
||||
\settowidth{\CodeWidthChar}{?}%
|
||||
\settoheight{\CodeHeightChar}{?}%
|
||||
}
|
||||
|
||||
% Redefining not defined characters, i.e. "Replacement Character" in tex output.
|
||||
\def\ucr{\adjustbox{width=\CodeWidthChar,height=\CodeHeightChar}{\stackinset{c}{}{c}{-.2pt}{%
|
||||
\textcolor{white}{\sffamily\bfseries\small ?}}{%
|
||||
\rotatebox{45}{$\blacksquare$}}}}
|
||||
|
||||
% Used by @example, @include, @includelineno and @dontinclude
|
||||
\newenvironment{DoxyCodeInclude}[1]{%
|
||||
\DoxyCode{#1}%
|
||||
}{%
|
||||
\endDoxyCode%
|
||||
}
|
||||
|
||||
% Used by @verbatim ... @endverbatim
|
||||
\newenvironment{DoxyVerb}{%
|
||||
\par%
|
||||
\footnotesize%
|
||||
\verbatim%
|
||||
}{%
|
||||
\endverbatim%
|
||||
\normalsize%
|
||||
}
|
||||
|
||||
% Used by @verbinclude
|
||||
\newenvironment{DoxyVerbInclude}{%
|
||||
\DoxyVerb%
|
||||
}{%
|
||||
\endDoxyVerb%
|
||||
}
|
||||
|
||||
% Used by numbered lists (using '-#' or <ol> ... </ol>)
|
||||
\setlistdepth{12}
|
||||
\newlist{DoxyEnumerate}{enumerate}{12}
|
||||
\setlist[DoxyEnumerate,1]{label=\arabic*.}
|
||||
\setlist[DoxyEnumerate,2]{label=(\enumalphalphcnt*)}
|
||||
\setlist[DoxyEnumerate,3]{label=\roman*.}
|
||||
\setlist[DoxyEnumerate,4]{label=\enumAlphAlphcnt*.}
|
||||
\setlist[DoxyEnumerate,5]{label=\arabic*.}
|
||||
\setlist[DoxyEnumerate,6]{label=(\enumalphalphcnt*)}
|
||||
\setlist[DoxyEnumerate,7]{label=\roman*.}
|
||||
\setlist[DoxyEnumerate,8]{label=\enumAlphAlphcnt*.}
|
||||
\setlist[DoxyEnumerate,9]{label=\arabic*.}
|
||||
\setlist[DoxyEnumerate,10]{label=(\enumalphalphcnt*)}
|
||||
\setlist[DoxyEnumerate,11]{label=\roman*.}
|
||||
\setlist[DoxyEnumerate,12]{label=\enumAlphAlphcnt*.}
|
||||
|
||||
% Used by bullet lists (using '-', @li, @arg, or <ul> ... </ul>)
|
||||
\setlistdepth{12}
|
||||
\newlist{DoxyItemize}{itemize}{12}
|
||||
\setlist[DoxyItemize]{label=\textperiodcentered}
|
||||
|
||||
\setlist[DoxyItemize,1]{label=\textbullet}
|
||||
\setlist[DoxyItemize,2]{label=\normalfont\bfseries \textendash}
|
||||
\setlist[DoxyItemize,3]{label=\textasteriskcentered}
|
||||
\setlist[DoxyItemize,4]{label=\textperiodcentered}
|
||||
|
||||
% Used for check boxes
|
||||
\newcommand{\DoxyUnchecked}{$\square$}
|
||||
\newcommand{\DoxyChecked}{\rlap{\raisebox{0.3ex}{\hspace{0.4ex}\tiny \checkmark}}$\square$}
|
||||
|
||||
% Used by description lists (using <dl> ... </dl>)
|
||||
\newenvironment{DoxyDescription}{%
|
||||
\description%
|
||||
}{%
|
||||
\enddescription%
|
||||
}
|
||||
|
||||
% Used by @image, @dotfile, @dot ... @enddot, and @msc ... @endmsc
|
||||
% (only if caption is specified)
|
||||
\newenvironment{DoxyImage}{%
|
||||
\begin{figure}[H]%
|
||||
\centering%
|
||||
}{%
|
||||
\end{figure}%
|
||||
}
|
||||
|
||||
% Used by @image, @dotfile, @dot ... @enddot, and @msc ... @endmsc
|
||||
% (only if no caption is specified)
|
||||
\newenvironment{DoxyImageNoCaption}{%
|
||||
\begin{center}%
|
||||
}{%
|
||||
\end{center}%
|
||||
}
|
||||
|
||||
% Used by @image
|
||||
% (only if inline is specified)
|
||||
\newenvironment{DoxyInlineImage}{%
|
||||
}{%
|
||||
}
|
||||
|
||||
% Used by @attention
|
||||
\newenvironment{DoxyAttention}[1]{%
|
||||
\begin{DoxyDesc}{#1}%
|
||||
}{%
|
||||
\end{DoxyDesc}%
|
||||
}
|
||||
|
||||
% Used by @important
|
||||
\newenvironment{DoxyImportant}[1]{%
|
||||
\begin{DoxyDesc}{#1}%
|
||||
}{%
|
||||
\end{DoxyDesc}%
|
||||
}
|
||||
|
||||
% Used by @author and @authors
|
||||
\newenvironment{DoxyAuthor}[1]{%
|
||||
\begin{DoxyDesc}{#1}%
|
||||
}{%
|
||||
\end{DoxyDesc}%
|
||||
}
|
||||
|
||||
% Used by @date
|
||||
\newenvironment{DoxyDate}[1]{%
|
||||
\begin{DoxyDesc}{#1}%
|
||||
}{%
|
||||
\end{DoxyDesc}%
|
||||
}
|
||||
|
||||
% Used by @invariant
|
||||
\newenvironment{DoxyInvariant}[1]{%
|
||||
\begin{DoxyDesc}{#1}%
|
||||
}{%
|
||||
\end{DoxyDesc}%
|
||||
}
|
||||
|
||||
% Used by @note
|
||||
\newenvironment{DoxyNote}[1]{%
|
||||
\begin{DoxyDesc}{#1}%
|
||||
}{%
|
||||
\end{DoxyDesc}%
|
||||
}
|
||||
|
||||
% Used by @post
|
||||
\newenvironment{DoxyPostcond}[1]{%
|
||||
\begin{DoxyDesc}{#1}%
|
||||
}{%
|
||||
\end{DoxyDesc}%
|
||||
}
|
||||
|
||||
% Used by @pre
|
||||
\newenvironment{DoxyPrecond}[1]{%
|
||||
\begin{DoxyDesc}{#1}%
|
||||
}{%
|
||||
\end{DoxyDesc}%
|
||||
}
|
||||
|
||||
% Used by @copyright
|
||||
\newenvironment{DoxyCopyright}[1]{%
|
||||
\begin{DoxyDesc}{#1}%
|
||||
}{%
|
||||
\end{DoxyDesc}%
|
||||
}
|
||||
|
||||
% Used by @remark
|
||||
\newenvironment{DoxyRemark}[1]{%
|
||||
\begin{DoxyDesc}{#1}%
|
||||
}{%
|
||||
\end{DoxyDesc}%
|
||||
}
|
||||
|
||||
% Used by @return and @returns
|
||||
\newenvironment{DoxyReturn}[1]{%
|
||||
\begin{DoxyDesc}{#1}%
|
||||
}{%
|
||||
\end{DoxyDesc}%
|
||||
}
|
||||
|
||||
% Used by @since
|
||||
\newenvironment{DoxySince}[1]{%
|
||||
\begin{DoxyDesc}{#1}%
|
||||
}{%
|
||||
\end{DoxyDesc}%
|
||||
}
|
||||
|
||||
% Used by @see
|
||||
\newenvironment{DoxySeeAlso}[1]{%
|
||||
\begin{DoxyDesc}{#1}%
|
||||
}{%
|
||||
\end{DoxyDesc}%
|
||||
}
|
||||
|
||||
% Used by @version
|
||||
\newenvironment{DoxyVersion}[1]{%
|
||||
\begin{DoxyDesc}{#1}%
|
||||
}{%
|
||||
\end{DoxyDesc}%
|
||||
}
|
||||
|
||||
% Used by @warning
|
||||
\newenvironment{DoxyWarning}[1]{%
|
||||
\begin{DoxyDesc}{#1}%
|
||||
}{%
|
||||
\end{DoxyDesc}%
|
||||
}
|
||||
|
||||
% Used by @par and @paragraph
|
||||
\newenvironment{DoxyParagraph}[1]{%
|
||||
\begin{DoxyDesc}{#1}%
|
||||
}{%
|
||||
\end{DoxyDesc}%
|
||||
}
|
||||
|
||||
% Used by parameter lists
|
||||
\newenvironment{DoxyParams}[2][]{%
|
||||
\tabulinesep=1mm%
|
||||
\par%
|
||||
\ifthenelse{\equal{#1}{}}%
|
||||
{\begin{longtabu*}spread 0pt [l]{|X[-1,l]|X[-1,l]|}}% name + description
|
||||
{\ifthenelse{\equal{#1}{1}}%
|
||||
{\begin{longtabu*}spread 0pt [l]{|X[-1,l]|X[-1,l]|X[-1,l]|}}% in/out + name + desc
|
||||
{\begin{longtabu*}spread 0pt [l]{|X[-1,l]|X[-1,l]|X[-1,l]|X[-1,l]|}}% in/out + type + name + desc
|
||||
}
|
||||
\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #2}\\[1ex]%
|
||||
\hline%
|
||||
\endfirsthead%
|
||||
\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #2}\\[1ex]%
|
||||
\hline%
|
||||
\endhead%
|
||||
}{%
|
||||
\end{longtabu*}%
|
||||
\vspace{6pt}%
|
||||
}
|
||||
|
||||
% Used for fields of simple structs
|
||||
\newenvironment{DoxyFields}[1]{%
|
||||
\tabulinesep=1mm%
|
||||
\par%
|
||||
\begin{longtabu*}spread 0pt [l]{|X[-1,r]|X[-1,l]|X[-1,l]|}%
|
||||
\multicolumn{3}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]%
|
||||
\hline%
|
||||
\endfirsthead%
|
||||
\multicolumn{3}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]%
|
||||
\hline%
|
||||
\endhead%
|
||||
}{%
|
||||
\end{longtabu*}%
|
||||
\vspace{6pt}%
|
||||
}
|
||||
|
||||
% Used for fields simple class style enums
|
||||
\newenvironment{DoxyEnumFields}[2][]{%
|
||||
\tabulinesep=1mm%
|
||||
\par%
|
||||
\ifthenelse{\equal{#1}{2}}%
|
||||
{\begin{longtabu*}spread 0pt [l]{|X[-1,r]|X[-1,l]|}}%
|
||||
{\begin{longtabu*}spread 0pt [l]{|X[-1,l]|X[-1,r]|X[-1,l]|}}% with init value
|
||||
\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #2}\\[1ex]%
|
||||
\hline%
|
||||
\endfirsthead%
|
||||
\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #2}\\[1ex]%
|
||||
\hline%
|
||||
\endhead%
|
||||
}{%
|
||||
\end{longtabu*}%
|
||||
\vspace{6pt}%
|
||||
}
|
||||
|
||||
% Used for parameters within a detailed function description
|
||||
\newenvironment{DoxyParamCaption}{%
|
||||
\renewcommand{\item}[3][]{\\ \hspace*{2.0cm} ##1 {\em ##2}##3}%
|
||||
}{%
|
||||
}
|
||||
|
||||
% Used by return value lists
|
||||
\newenvironment{DoxyRetVals}[1]{%
|
||||
\tabulinesep=1mm%
|
||||
\par%
|
||||
\begin{longtabu*}spread 0pt [l]{|X[-1,r]|X[-1,l]|}%
|
||||
\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]%
|
||||
\hline%
|
||||
\endfirsthead%
|
||||
\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]%
|
||||
\hline%
|
||||
\endhead%
|
||||
}{%
|
||||
\end{longtabu*}%
|
||||
\vspace{6pt}%
|
||||
}
|
||||
|
||||
% Used by exception lists
|
||||
\newenvironment{DoxyExceptions}[1]{%
|
||||
\tabulinesep=1mm%
|
||||
\par%
|
||||
\begin{longtabu*}spread 0pt [l]{|X[-1,r]|X[-1,l]|}%
|
||||
\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]%
|
||||
\hline%
|
||||
\endfirsthead%
|
||||
\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]%
|
||||
\hline%
|
||||
\endhead%
|
||||
}{%
|
||||
\end{longtabu*}%
|
||||
\vspace{6pt}%
|
||||
}
|
||||
|
||||
% Used by template parameter lists
|
||||
\newenvironment{DoxyTemplParams}[1]{%
|
||||
\tabulinesep=1mm%
|
||||
\par%
|
||||
\begin{longtabu*}spread 0pt [l]{|X[-1,r]|X[-1,l]|}%
|
||||
\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]%
|
||||
\hline%
|
||||
\endfirsthead%
|
||||
\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]%
|
||||
\hline%
|
||||
\endhead%
|
||||
}{%
|
||||
\end{longtabu*}%
|
||||
\vspace{6pt}%
|
||||
}
|
||||
|
||||
% Used for member lists
|
||||
\newenvironment{DoxyCompactItemize}{%
|
||||
\begin{itemize}%
|
||||
\setlength{\itemsep}{-3pt}%
|
||||
\setlength{\parsep}{0pt}%
|
||||
\setlength{\topsep}{0pt}%
|
||||
\setlength{\partopsep}{0pt}%
|
||||
}{%
|
||||
\end{itemize}%
|
||||
}
|
||||
|
||||
% Used for member descriptions
|
||||
\newenvironment{DoxyCompactList}{%
|
||||
\begin{list}{}{%
|
||||
\setlength{\leftmargin}{0.5cm}%
|
||||
\setlength{\itemsep}{0pt}%
|
||||
\setlength{\parsep}{0pt}%
|
||||
\setlength{\topsep}{0pt}%
|
||||
\renewcommand{\makelabel}{\hfill}%
|
||||
}%
|
||||
}{%
|
||||
\end{list}%
|
||||
}
|
||||
|
||||
% Used for reference lists (@bug, @deprecated, @todo, etc.)
|
||||
\newenvironment{DoxyRefList}{%
|
||||
\begin{list}{}{%
|
||||
\setlength{\labelwidth}{10pt}%
|
||||
\setlength{\leftmargin}{\labelwidth}%
|
||||
\addtolength{\leftmargin}{\labelsep}%
|
||||
\renewcommand{\makelabel}{\xreflabel}%
|
||||
}%
|
||||
}{%
|
||||
\end{list}%
|
||||
}
|
||||
|
||||
% Used by @bug, @deprecated, @todo, etc.
|
||||
\newenvironment{DoxyRefDesc}[1]{%
|
||||
\begin{list}{}{%
|
||||
\renewcommand\makelabel[1]{\textbf{##1}}%
|
||||
\settowidth\labelwidth{\makelabel{#1}}%
|
||||
\setlength\leftmargin{\labelwidth+\labelsep}%
|
||||
}%
|
||||
}{%
|
||||
\end{list}%
|
||||
}
|
||||
|
||||
% Used by parameter lists and simple sections
|
||||
\newenvironment{Desc}
|
||||
{\begin{list}{}{%
|
||||
\settowidth{\labelwidth}{20pt}%
|
||||
\setlength{\parsep}{0pt}%
|
||||
\setlength{\itemsep}{0pt}%
|
||||
\setlength{\leftmargin}{\labelwidth+\labelsep}%
|
||||
\renewcommand{\makelabel}{\entrylabel}%
|
||||
}
|
||||
}{%
|
||||
\end{list}%
|
||||
}
|
||||
|
||||
% Used by tables
|
||||
\newcommand{\PBS}[1]{\let\temp=\\#1\let\\=\temp}%
|
||||
\newenvironment{TabularC}[1]%
|
||||
{\tabulinesep=1mm
|
||||
\begin{longtabu*}spread 0pt [c]{*#1{|X[-1]}|}}%
|
||||
{\end{longtabu*}\par}%
|
||||
|
||||
\newenvironment{TabularNC}[1]%
|
||||
{\begin{tabu}spread 0pt [l]{*#1{|X[-1]}|}}%
|
||||
{\end{tabu}\par}%
|
||||
|
||||
% Used for member group headers
|
||||
\newenvironment{Indent}{%
|
||||
\begin{list}{}{%
|
||||
\setlength{\leftmargin}{0.5cm}%
|
||||
}%
|
||||
\item[]\ignorespaces%
|
||||
}{%
|
||||
\unskip%
|
||||
\end{list}%
|
||||
}
|
||||
|
||||
% Used when hyperlinks are turned on
|
||||
\newcommand{\doxylink}[2]{%
|
||||
\mbox{\hyperlink{#1}{#2}}%
|
||||
}
|
||||
|
||||
% Used when hyperlinks are turned on
|
||||
% Third argument is the SectionType, see the doxygen internal
|
||||
% documentation for the values (relevant: Page ... Subsubsection).
|
||||
\newcommand{\doxysectlink}[3]{%
|
||||
\mbox{\hyperlink{#1}{#2}}%
|
||||
}
|
||||
% Used when hyperlinks are turned off
|
||||
\newcommand{\doxyref}[3]{%
|
||||
\textbf{#1} (\textnormal{#2}\,\pageref{#3})%
|
||||
}
|
||||
|
||||
% Used when hyperlinks are turned off
|
||||
% Fourth argument is the SectionType, see the doxygen internal
|
||||
% documentation for the values (relevant: Page ... Subsubsection).
|
||||
\newcommand{\doxysectref}[4]{%
|
||||
\textbf{#1} (\textnormal{#2}\,\pageref{#3})%
|
||||
}
|
||||
|
||||
% Used to link to a table when hyperlinks are turned on
|
||||
\newcommand{\doxytablelink}[2]{%
|
||||
\ref{#1}%
|
||||
}
|
||||
|
||||
% Used to link to a table when hyperlinks are turned off
|
||||
\newcommand{\doxytableref}[3]{%
|
||||
\ref{#3}%
|
||||
}
|
||||
|
||||
% Used by @addindex
|
||||
\newcommand{\lcurly}{\{}
|
||||
\newcommand{\rcurly}{\}}
|
||||
|
||||
% Colors used for syntax highlighting
|
||||
\definecolor{comment}{rgb}{0.5,0.0,0.0}
|
||||
\definecolor{keyword}{rgb}{0.0,0.5,0.0}
|
||||
\definecolor{keywordtype}{rgb}{0.38,0.25,0.125}
|
||||
\definecolor{keywordflow}{rgb}{0.88,0.5,0.0}
|
||||
\definecolor{preprocessor}{rgb}{0.5,0.38,0.125}
|
||||
\definecolor{stringliteral}{rgb}{0.0,0.125,0.25}
|
||||
\definecolor{charliteral}{rgb}{0.0,0.5,0.5}
|
||||
\definecolor{xmlcdata}{rgb}{0.0,0.0,0.0}
|
||||
\definecolor{vhdldigit}{rgb}{1.0,0.0,1.0}
|
||||
\definecolor{vhdlkeyword}{rgb}{0.43,0.0,0.43}
|
||||
\definecolor{vhdllogic}{rgb}{1.0,0.0,0.0}
|
||||
\definecolor{vhdlchar}{rgb}{0.0,0.0,0.0}
|
||||
|
||||
% Color used for table heading
|
||||
\newcommand{\tableheadbgcolor}{lightgray}%
|
||||
|
||||
% Version of hypertarget with correct landing location
|
||||
\newcommand{\Hypertarget}[1]{\Hy@raisedlink{\hypertarget{#1}{}}}
|
||||
|
||||
% possibility to have sections etc. be within the margins
|
||||
% unfortunately had to copy part of book.cls and add \raggedright
|
||||
\makeatletter
|
||||
\newcounter{subsubsubsection}[subsubsection]
|
||||
\newcounter{subsubsubsubsection}[subsubsubsection]
|
||||
\newcounter{subsubsubsubsubsection}[subsubsubsubsection]
|
||||
\newcounter{subsubsubsubsubsubsection}[subsubsubsubsubsection]
|
||||
\renewcommand{\thesubsubsubsection}{\thesubsubsection.\arabic{subsubsubsection}}
|
||||
\renewcommand{\thesubsubsubsubsection}{\thesubsubsubsection.\arabic{subsubsubsubsection}}
|
||||
\renewcommand{\thesubsubsubsubsubsection}{\thesubsubsubsubsection.\arabic{subsubsubsubsubsection}}
|
||||
\renewcommand{\thesubsubsubsubsubsubsection}{\thesubsubsubsubsubsection.\arabic{subsubsubsubsubsubsection}}
|
||||
\newcommand{\subsubsubsectionmark}[1]{}
|
||||
\newcommand{\subsubsubsubsectionmark}[1]{}
|
||||
\newcommand{\subsubsubsubsubsectionmark}[1]{}
|
||||
\newcommand{\subsubsubsubsubsubsectionmark}[1]{}
|
||||
\def\toclevel@subsubsubsection{4}
|
||||
\def\toclevel@subsubsubsubsection{5}
|
||||
\def\toclevel@subsubsubsubsubsection{6}
|
||||
\def\toclevel@subsubsubsubsubsubsection{7}
|
||||
\def\toclevel@paragraph{8}
|
||||
\def\toclevel@subparagraph{9}
|
||||
|
||||
\newcommand\doxysection{\@startsection {section}{1}{\z@}%
|
||||
{-3.5ex \@plus -1ex \@minus -.2ex}%
|
||||
{2.3ex \@plus.2ex}%
|
||||
{\raggedright\normalfont\Large\bfseries}}
|
||||
\newcommand\doxysubsection{\@startsection{subsection}{2}{\z@}%
|
||||
{-3.25ex\@plus -1ex \@minus -.2ex}%
|
||||
{1.5ex \@plus .2ex}%
|
||||
{\raggedright\normalfont\large\bfseries}}
|
||||
\newcommand\doxysubsubsection{\@startsection{subsubsection}{3}{\z@}%
|
||||
{-3.25ex\@plus -1ex \@minus -.2ex}%
|
||||
{1.5ex \@plus .2ex}%
|
||||
{\raggedright\normalfont\normalsize\bfseries}}
|
||||
\newcommand\doxysubsubsubsection{\@startsection{subsubsubsection}{4}{\z@}%
|
||||
{-3.25ex\@plus -1ex \@minus -.2ex}%
|
||||
{1.5ex \@plus .2ex}%
|
||||
{\raggedright\normalfont\normalsize\bfseries}}
|
||||
\newcommand\doxysubsubsubsubsection{\@startsection{subsubsubsubsection}{5}{\z@}%
|
||||
{-3.25ex\@plus -1ex \@minus -.2ex}%
|
||||
{1.5ex \@plus .2ex}%
|
||||
{\raggedright\normalfont\normalsize\bfseries}}
|
||||
\newcommand\doxysubsubsubsubsubsection{\@startsection{subsubsubsubsubsection}{6}{\z@}%
|
||||
{-3.25ex\@plus -1ex \@minus -.2ex}%
|
||||
{1.5ex \@plus .2ex}%
|
||||
{\raggedright\normalfont\normalsize\bfseries}}
|
||||
\newcommand\doxysubsubsubsubsubsubsection{\@startsection{subsubsubsubsubsubsection}{7}{\z@}%
|
||||
{-3.25ex\@plus -1ex \@minus -.2ex}%
|
||||
{1.5ex \@plus .2ex}%
|
||||
{\raggedright\normalfont\normalsize\bfseries}}
|
||||
\newcommand\doxyparagraph{\@startsection{paragraph}{8}{\z@}%
|
||||
{-3.25ex\@plus -1ex \@minus -.2ex}%
|
||||
{1.5ex \@plus .2ex}%
|
||||
{\raggedright\normalfont\normalsize\bfseries}}
|
||||
\newcommand\doxysubparagraph{\@startsection{subparagraph}{9}{\parindent}%
|
||||
{-3.25ex\@plus -1ex \@minus -.2ex}%
|
||||
{1.5ex \@plus .2ex}%
|
||||
{\raggedright\normalfont\normalsize\bfseries}}
|
||||
|
||||
\newcommand\l@subsubsubsection{\@dottedtocline{4}{10.0em}{7.8em}}
|
||||
\newcommand\l@subsubsubsubsection{\@dottedtocline{5}{13.0em}{9.4em}}
|
||||
\newcommand\l@subsubsubsubsubsection{\@dottedtocline{6}{15.0em}{11em}}
|
||||
\newcommand\l@subsubsubsubsubsubsection{\@dottedtocline{7}{18.0em}{12.6em}}
|
||||
\renewcommand\l@paragraph{\@dottedtocline{8}{21.0em}{14.2em}}
|
||||
\renewcommand\l@subparagraph{\@dottedtocline{9}{24.0em}{15.8em}}
|
||||
\makeatother
|
||||
% the sectsty doesn't look to be maintained but gives, in our case, some warning like:
|
||||
% LaTeX Warning: Command \underline has changed.
|
||||
% Check if current package is valid.
|
||||
% unfortunately had to copy the relevant part
|
||||
\newcommand*{\doxypartfont} [1]
|
||||
{\gdef\SS@partnumberfont{\SS@sectid{0}\SS@nopart\SS@makeulinepartchap#1}
|
||||
\gdef\SS@parttitlefont{\SS@sectid{0}\SS@titlepart\SS@makeulinepartchap#1}}
|
||||
\newcommand*{\doxychapterfont} [1]
|
||||
{\gdef\SS@chapnumfont{\SS@sectid{1}\SS@nopart\SS@makeulinepartchap#1}
|
||||
\gdef\SS@chaptitlefont{\SS@sectid{1}\SS@titlepart\SS@makeulinepartchap#1}}
|
||||
\newcommand*{\doxysectionfont} [1]
|
||||
{\gdef\SS@sectfont{\SS@sectid{2}\SS@rr\SS@makeulinesect#1}}
|
||||
\newcommand*{\doxysubsectionfont} [1]
|
||||
{\gdef\SS@subsectfont{\SS@sectid{3}\SS@rr\SS@makeulinesect#1}}
|
||||
\newcommand*{\doxysubsubsectionfont} [1]
|
||||
{\gdef\SS@subsubsectfont{\SS@sectid{4}\SS@rr\SS@makeulinesect#1}}
|
||||
\newcommand*{\doxyparagraphfont} [1]
|
||||
{\gdef\SS@parafont{\SS@sectid{5}\SS@rr\SS@makeulinesect#1}}
|
||||
\newcommand*{\doxysubparagraphfont} [1]
|
||||
{\gdef\SS@subparafont{\SS@sectid{6}\SS@rr\SS@makeulinesect#1}}
|
||||
\newcommand*{\doxyminisecfont} [1]
|
||||
{\gdef\SS@minisecfont{\SS@sectid{7}\SS@rr\SS@makeulinepartchap#1}}
|
||||
\newcommand*{\doxyallsectionsfont} [1] {\doxypartfont{#1}%
|
||||
\doxychapterfont{#1}%
|
||||
\doxysectionfont{#1}%
|
||||
\doxysubsectionfont{#1}%
|
||||
\doxysubsubsectionfont{#1}%
|
||||
\doxyparagraphfont{#1}%
|
||||
\doxysubparagraphfont{#1}%
|
||||
\doxyminisecfont{#1}}%
|
||||
% Define caption that is also suitable in a table
|
||||
% for usage with hyperlinks
|
||||
\makeatletter
|
||||
\def\doxyfigcaption{%
|
||||
\H@refstepcounter{figure}%
|
||||
\@dblarg{\@caption{figure}}}
|
||||
|
||||
% for usage without hyperlinks
|
||||
\def\doxyfigcaptionnolink{%
|
||||
\refstepcounter{figure}%
|
||||
\@dblarg{\@caption{figure}}}
|
||||
\makeatother
|
||||
|
||||
% Define alpha enumarative names for counters > 26
|
||||
\makeatletter
|
||||
\def\enumalphalphcnt#1{\expandafter\@enumalphalphcnt\csname c@#1\endcsname}
|
||||
\def\@enumalphalphcnt#1{\alphalph{#1}}
|
||||
\def\enumAlphAlphcnt#1{\expandafter\@enumAlphAlphcnt\csname c@#1\endcsname}
|
||||
\def\@enumAlphAlphcnt#1{\AlphAlph{#1}}
|
||||
\makeatother
|
||||
\AddEnumerateCounter{\enumalphalphcnt}{\@enumalphalphcnt}{aa}
|
||||
\AddEnumerateCounter{\enumAlphAlphcnt}{\@enumAlphAlphcnt}{AA}
|
||||
2178
docs/latex/etoc_doxygen.sty
Normal file
2178
docs/latex/etoc_doxygen.sty
Normal file
File diff suppressed because it is too large
Load Diff
38
docs/latex/exceptions__composition_8h.tex
Normal file
38
docs/latex/exceptions__composition_8h.tex
Normal file
@@ -0,0 +1,38 @@
|
||||
\doxysection{src/composition/include/fourdst/composition/exceptions/exceptions\+\_\+composition.h File Reference}
|
||||
\hypertarget{exceptions__composition_8h}{}\label{exceptions__composition_8h}\index{src/composition/include/fourdst/composition/exceptions/exceptions\_composition.h@{src/composition/include/fourdst/composition/exceptions/exceptions\_composition.h}}
|
||||
{\ttfamily \#include $<$exception$>$}\newline
|
||||
{\ttfamily \#include $<$string$>$}\newline
|
||||
\doxysubsubsection*{Classes}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
class \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error}{fourdst\+::composition\+::exceptions\+::\+Composition\+Error}}
|
||||
\begin{DoxyCompactList}\small\item\em Base class for exceptions related to composition objects. \end{DoxyCompactList}\item
|
||||
class \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error}{fourdst\+::composition\+::exceptions\+::\+Composition\+Entry\+Error}}
|
||||
\begin{DoxyCompactList}\small\item\em Base class for exceptions related to individual entries within a composition. \end{DoxyCompactList}\item
|
||||
class \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_not_finalized_error}{fourdst\+::composition\+::exceptions\+::\+Composition\+Not\+Finalized\+Error}}
|
||||
\begin{DoxyCompactList}\small\item\em Exception thrown when an operation is attempted on a composition that has not been finalized. \end{DoxyCompactList}\item
|
||||
class \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_composition_error}{fourdst\+::composition\+::exceptions\+::\+Invalid\+Composition\+Error}}
|
||||
\begin{DoxyCompactList}\small\item\em Exception thrown when a composition is in an invalid or inconsistent state. \end{DoxyCompactList}\item
|
||||
class \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_mixing_mode}{fourdst\+::composition\+::exceptions\+::\+Invalid\+Mixing\+Mode}}
|
||||
\begin{DoxyCompactList}\small\item\em Exception thrown for an invalid or unsupported mixing mode. \end{DoxyCompactList}\item
|
||||
class \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_symbol_error}{fourdst\+::composition\+::exceptions\+::\+Invalid\+Symbol\+Error}}
|
||||
\begin{DoxyCompactList}\small\item\em Exception thrown when a symbol used in a composition is invalid. \end{DoxyCompactList}\item
|
||||
class \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_unregistered_symbol_error}{fourdst\+::composition\+::exceptions\+::\+Unregistered\+Symbol\+Error}}
|
||||
\begin{DoxyCompactList}\small\item\em Exception thrown when a symbol is used that has not been registered. \end{DoxyCompactList}\item
|
||||
class \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_failed_to_finalize_composition_error}{fourdst\+::composition\+::exceptions\+::\+Failed\+To\+Finalize\+Composition\+Error}}
|
||||
\begin{DoxyCompactList}\small\item\em Exception thrown when the finalization process of a composition fails. \end{DoxyCompactList}\item
|
||||
class \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_species_symbol_error}{fourdst\+::composition\+::exceptions\+::\+Invalid\+Species\+Symbol\+Error}}
|
||||
\begin{DoxyCompactList}\small\item\em Exception thrown for an invalid chemical species symbol in a composition entry. \end{DoxyCompactList}\item
|
||||
class \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_entry_already_initialized_error}{fourdst\+::composition\+::exceptions\+::\+Entry\+Already\+Initialized\+Error}}
|
||||
\begin{DoxyCompactList}\small\item\em Exception thrown when attempting to initialize a composition entry that has already been initialized. \end{DoxyCompactList}\item
|
||||
class \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_mode_error}{fourdst\+::composition\+::exceptions\+::\+Composition\+Mode\+Error}}
|
||||
\begin{DoxyCompactList}\small\item\em Exception thrown due to a conflict in composition modes at the entry level. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
\doxysubsubsection*{Namespaces}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
namespace \mbox{\hyperlink{namespacefourdst}{fourdst}}
|
||||
\item
|
||||
namespace \mbox{\hyperlink{namespacefourdst_1_1composition}{fourdst\+::composition}}
|
||||
\item
|
||||
namespace \mbox{\hyperlink{namespacefourdst_1_1composition_1_1exceptions}{fourdst\+::composition\+::exceptions}}
|
||||
\end{DoxyCompactItemize}
|
||||
73
docs/latex/exceptions__composition_8h_source.tex
Normal file
73
docs/latex/exceptions__composition_8h_source.tex
Normal file
@@ -0,0 +1,73 @@
|
||||
\doxysection{exceptions\+\_\+composition.\+h}
|
||||
\hypertarget{exceptions__composition_8h_source}{}\label{exceptions__composition_8h_source}\index{src/composition/include/fourdst/composition/exceptions/exceptions\_composition.h@{src/composition/include/fourdst/composition/exceptions/exceptions\_composition.h}}
|
||||
\mbox{\hyperlink{exceptions__composition_8h}{Go to the documentation of this file.}}
|
||||
\begin{DoxyCode}{0}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00001}00001\ \textcolor{preprocessor}{\#pragma\ once}}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00002}00002\ }
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00003}00003\ \textcolor{preprocessor}{\#include\ <exception>}}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00004}00004\ \textcolor{preprocessor}{\#include\ <string>}}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00005}00005\ }
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00006}\mbox{\hyperlink{namespacefourdst_1_1composition_1_1exceptions}{00006}}\ \textcolor{keyword}{namespace\ }\mbox{\hyperlink{namespacefourdst_1_1composition_1_1exceptions}{fourdst::composition::exceptions}}\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00014}\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error}{00014}}\ \ \ \ \ \textcolor{keyword}{class\ }\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error_aef0cd13a4d1eb60b6d75ca5480e9146c}{CompositionError}}\ :\ \textcolor{keyword}{public}\ std::exception\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00015}00015\ \ \ \ \ \textcolor{keyword}{protected}:}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00019}\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error_a4cd69d727a162f90045cd6d4aaf95440}{00019}}\ \ \ \ \ \ \ \ \ std::string\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error_a4cd69d727a162f90045cd6d4aaf95440}{m\_message}};}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00020}00020\ \ \ \ \ \textcolor{keyword}{public}:}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00025}\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error_aef0cd13a4d1eb60b6d75ca5480e9146c}{00025}}\ \ \ \ \ \ \ \ \ \textcolor{keyword}{explicit}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error_aef0cd13a4d1eb60b6d75ca5480e9146c}{CompositionError}}(\textcolor{keyword}{const}\ std::string\&\ message)}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00026}00026\ \ \ \ \ \ \ \ \ \ \ \ \ :\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error_a4cd69d727a162f90045cd6d4aaf95440}{m\_message}}(std::move(message))\ \{\}}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00027}00027\ }
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00032}\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error_ae44ceddb19da8a8cda7ee150b6826d08}{00032}}\ \ \ \ \ \ \ \ \ \textcolor{keyword}{const}\ \textcolor{keywordtype}{char}*\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error_ae44ceddb19da8a8cda7ee150b6826d08}{what}}()\ const\ noexcept\textcolor{keyword}{\ override}\{}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00033}00033\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error_a4cd69d727a162f90045cd6d4aaf95440}{m\_message}}.c\_str();}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00034}00034\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00035}00035\ \ \ \ \ \};}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00036}00036\ }
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00044}\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error}{00044}}\ \ \ \ \ \textcolor{keyword}{class\ }\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error_af5ea3395201839d670bdcfc61b19abb1}{CompositionEntryError}}\ :\ \textcolor{keyword}{public}\ std::exception\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00045}00045\ \ \ \ \ \textcolor{keyword}{protected}:}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00049}\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error_a41208f0821385ed6f168c66f5863a79d}{00049}}\ \ \ \ \ \ \ \ \ std::string\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error_a41208f0821385ed6f168c66f5863a79d}{m\_message}};}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00050}00050\ \ \ \ \ \textcolor{keyword}{public}:}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00055}\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error_af5ea3395201839d670bdcfc61b19abb1}{00055}}\ \ \ \ \ \ \ \ \ \textcolor{keyword}{explicit}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error_af5ea3395201839d670bdcfc61b19abb1}{CompositionEntryError}}(\textcolor{keyword}{const}\ std::string\&\ message)}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00056}00056\ \ \ \ \ \ \ \ \ \ \ \ \ :\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error_a41208f0821385ed6f168c66f5863a79d}{m\_message}}(std::move(message))\ \{\}}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00057}00057\ }
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00062}\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error_aeba45905c6dc1a47ec1ad3f978f94e57}{00062}}\ \ \ \ \ \ \ \ \ \textcolor{keyword}{const}\ \textcolor{keywordtype}{char}*\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error_aeba45905c6dc1a47ec1ad3f978f94e57}{what}}()\ const\ noexcept\textcolor{keyword}{\ override\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00063}00063\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error_a41208f0821385ed6f168c66f5863a79d}{m\_message}}.c\_str();}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00064}00064\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00065}00065\ \ \ \ \ \};}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00066}00066\ }
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00074}\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_not_finalized_error}{00074}}\ \ \ \ \ \textcolor{keyword}{class\ }\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_not_finalized_error}{CompositionNotFinalizedError}}\ final\ :\ \textcolor{keyword}{public}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_not_finalized_error_aef0cd13a4d1eb60b6d75ca5480e9146c}{CompositionError}}\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00075}00075\ \ \ \ \ \ \ \ \ \textcolor{keyword}{using\ }\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error_aef0cd13a4d1eb60b6d75ca5480e9146c}{CompositionError::CompositionError}};}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00076}00076\ \ \ \ \ \};}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00077}00077\ }
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00082}\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_composition_error}{00082}}\ \ \ \ \ \textcolor{keyword}{class\ }\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_composition_error}{InvalidCompositionError}}\ final\ :\ \textcolor{keyword}{public}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_composition_error_aef0cd13a4d1eb60b6d75ca5480e9146c}{CompositionError}}\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00083}00083\ \ \ \ \ \ \ \ \ \textcolor{keyword}{using\ }\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error_aef0cd13a4d1eb60b6d75ca5480e9146c}{CompositionError::CompositionError}};}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00084}00084\ \ \ \ \ \};}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00085}00085\ }
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00093}\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_mixing_mode}{00093}}\ \ \ \ \ \textcolor{keyword}{class\ }\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_mixing_mode}{InvalidMixingMode}}\ final\ :\ \textcolor{keyword}{public}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_mixing_mode_aef0cd13a4d1eb60b6d75ca5480e9146c}{CompositionError}}\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00094}00094\ \ \ \ \ \ \ \ \ \textcolor{keyword}{using\ }\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error_aef0cd13a4d1eb60b6d75ca5480e9146c}{CompositionError::CompositionError}};}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00095}00095\ \ \ \ \ \};}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00096}00096\ }
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00101}\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_symbol_error}{00101}}\ \ \ \ \ \textcolor{keyword}{class\ }\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_symbol_error}{InvalidSymbolError}}\ final\ :\ \textcolor{keyword}{public}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_symbol_error_aef0cd13a4d1eb60b6d75ca5480e9146c}{CompositionError}}\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00102}00102\ \ \ \ \ \ \ \ \ \textcolor{keyword}{using\ }\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error_aef0cd13a4d1eb60b6d75ca5480e9146c}{CompositionError::CompositionError}};}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00103}00103\ \ \ \ \ \};}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00104}00104\ }
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00111}\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_unregistered_symbol_error}{00111}}\ \ \ \ \ \textcolor{keyword}{class\ }\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_unregistered_symbol_error}{UnregisteredSymbolError}}\ final\ :\ \textcolor{keyword}{public}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_unregistered_symbol_error_aef0cd13a4d1eb60b6d75ca5480e9146c}{CompositionError}}\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00112}00112\ \ \ \ \ \ \ \ \ \textcolor{keyword}{using\ }\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error_aef0cd13a4d1eb60b6d75ca5480e9146c}{CompositionError::CompositionError}};}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00113}00113\ \ \ \ \ \};}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00114}00114\ }
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00119}\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_failed_to_finalize_composition_error}{00119}}\ \ \ \ \ \textcolor{keyword}{class\ }\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_failed_to_finalize_composition_error}{FailedToFinalizeCompositionError}}\ final\ :\ \textcolor{keyword}{public}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_failed_to_finalize_composition_error_aef0cd13a4d1eb60b6d75ca5480e9146c}{CompositionError}}\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00120}00120\ \ \ \ \ \ \ \ \ \textcolor{keyword}{using\ }\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error_aef0cd13a4d1eb60b6d75ca5480e9146c}{CompositionError::CompositionError}};}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00121}00121\ \ \ \ \ \};}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00122}00122\ }
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00127}\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_species_symbol_error}{00127}}\ \ \ \ \ \textcolor{keyword}{class\ }\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_species_symbol_error}{InvalidSpeciesSymbolError}}\ final\ :\ \textcolor{keyword}{public}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_species_symbol_error_af5ea3395201839d670bdcfc61b19abb1}{CompositionEntryError}}\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00128}00128\ \ \ \ \ \ \ \ \ \textcolor{keyword}{using\ }\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error_af5ea3395201839d670bdcfc61b19abb1}{CompositionEntryError::CompositionEntryError}};}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00129}00129\ \ \ \ \ \};}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00130}00130\ }
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00135}\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_entry_already_initialized_error}{00135}}\ \ \ \ \ \textcolor{keyword}{class\ }\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_entry_already_initialized_error}{EntryAlreadyInitializedError}}\ final\ :\ \textcolor{keyword}{public}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_entry_already_initialized_error_af5ea3395201839d670bdcfc61b19abb1}{CompositionEntryError}}\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00136}00136\ \ \ \ \ \ \ \ \ \textcolor{keyword}{using\ }\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error_af5ea3395201839d670bdcfc61b19abb1}{CompositionEntryError::CompositionEntryError}};}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00137}00137\ \ \ \ \ \};}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00138}00138\ }
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00145}\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_mode_error}{00145}}\ \ \ \ \ \textcolor{keyword}{class\ }\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_mode_error}{CompositionModeError}}\ final\ :\ \textcolor{keyword}{public}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_mode_error_af5ea3395201839d670bdcfc61b19abb1}{CompositionEntryError}}\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00146}00146\ \ \ \ \ \ \ \ \ \textcolor{keyword}{using\ }\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error_af5ea3395201839d670bdcfc61b19abb1}{CompositionEntryError::CompositionEntryError}};}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00147}00147\ \ \ \ \ \};}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00148}00148\ }
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00149}00149\ \}}
|
||||
|
||||
\end{DoxyCode}
|
||||
8
docs/latex/files.tex
Normal file
8
docs/latex/files.tex
Normal file
@@ -0,0 +1,8 @@
|
||||
\doxysection{File List}
|
||||
Here is a list of all files with brief descriptions\+:\begin{DoxyCompactList}
|
||||
\item\contentsline{section}{src/composition/include/fourdst/composition/\mbox{\hyperlink{atomic_species_8h}{atomic\+Species.\+h}} }{\pageref{atomic_species_8h}}{}
|
||||
\item\contentsline{section}{src/composition/include/fourdst/composition/\mbox{\hyperlink{composition_8h}{composition.\+h}} }{\pageref{composition_8h}}{}
|
||||
\item\contentsline{section}{src/composition/include/fourdst/composition/\mbox{\hyperlink{species_8h}{species.\+h}} }{\pageref{species_8h}}{}
|
||||
\item\contentsline{section}{src/composition/include/fourdst/composition/exceptions/\mbox{\hyperlink{exceptions__composition_8h}{exceptions\+\_\+composition.\+h}} }{\pageref{exceptions__composition_8h}}{}
|
||||
\item\contentsline{section}{src/composition/lib/\mbox{\hyperlink{composition_8cpp}{composition.\+cpp}} }{\pageref{composition_8cpp}}{}
|
||||
\end{DoxyCompactList}
|
||||
26
docs/latex/hierarchy.tex
Normal file
26
docs/latex/hierarchy.tex
Normal file
@@ -0,0 +1,26 @@
|
||||
\doxysection{Class Hierarchy}
|
||||
This inheritance list is sorted roughly, but not completely, alphabetically\+:\begin{DoxyCompactList}
|
||||
\item \contentsline{section}{fourdst\+::composition\+::Canonical\+Composition}{\pageref{structfourdst_1_1composition_1_1_canonical_composition}}{}
|
||||
\item \contentsline{section}{fourdst\+::composition\+::Composition}{\pageref{classfourdst_1_1composition_1_1_composition}}{}
|
||||
\item \contentsline{section}{fourdst\+::composition\+::Composition\+Entry}{\pageref{structfourdst_1_1composition_1_1_composition_entry}}{}
|
||||
\item std\+::exception\begin{DoxyCompactList}
|
||||
\item \contentsline{section}{fourdst\+::composition\+::exceptions\+::Composition\+Entry\+Error}{\pageref{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error}}{}
|
||||
\begin{DoxyCompactList}
|
||||
\item \contentsline{section}{fourdst\+::composition\+::exceptions\+::Composition\+Mode\+Error}{\pageref{classfourdst_1_1composition_1_1exceptions_1_1_composition_mode_error}}{}
|
||||
\item \contentsline{section}{fourdst\+::composition\+::exceptions\+::Entry\+Already\+Initialized\+Error}{\pageref{classfourdst_1_1composition_1_1exceptions_1_1_entry_already_initialized_error}}{}
|
||||
\item \contentsline{section}{fourdst\+::composition\+::exceptions\+::Invalid\+Species\+Symbol\+Error}{\pageref{classfourdst_1_1composition_1_1exceptions_1_1_invalid_species_symbol_error}}{}
|
||||
\end{DoxyCompactList}
|
||||
\item \contentsline{section}{fourdst\+::composition\+::exceptions\+::Composition\+Error}{\pageref{classfourdst_1_1composition_1_1exceptions_1_1_composition_error}}{}
|
||||
\begin{DoxyCompactList}
|
||||
\item \contentsline{section}{fourdst\+::composition\+::exceptions\+::Composition\+Not\+Finalized\+Error}{\pageref{classfourdst_1_1composition_1_1exceptions_1_1_composition_not_finalized_error}}{}
|
||||
\item \contentsline{section}{fourdst\+::composition\+::exceptions\+::Failed\+To\+Finalize\+Composition\+Error}{\pageref{classfourdst_1_1composition_1_1exceptions_1_1_failed_to_finalize_composition_error}}{}
|
||||
\item \contentsline{section}{fourdst\+::composition\+::exceptions\+::Invalid\+Composition\+Error}{\pageref{classfourdst_1_1composition_1_1exceptions_1_1_invalid_composition_error}}{}
|
||||
\item \contentsline{section}{fourdst\+::composition\+::exceptions\+::Invalid\+Mixing\+Mode}{\pageref{classfourdst_1_1composition_1_1exceptions_1_1_invalid_mixing_mode}}{}
|
||||
\item \contentsline{section}{fourdst\+::composition\+::exceptions\+::Invalid\+Symbol\+Error}{\pageref{classfourdst_1_1composition_1_1exceptions_1_1_invalid_symbol_error}}{}
|
||||
\item \contentsline{section}{fourdst\+::composition\+::exceptions\+::Unregistered\+Symbol\+Error}{\pageref{classfourdst_1_1composition_1_1exceptions_1_1_unregistered_symbol_error}}{}
|
||||
\end{DoxyCompactList}
|
||||
\end{DoxyCompactList}
|
||||
\item \contentsline{section}{fourdst\+::composition\+::Global\+Composition}{\pageref{structfourdst_1_1composition_1_1_global_composition}}{}
|
||||
\item \contentsline{section}{std\+::hash\texorpdfstring{$<$}{<} fourdst\+::atomic\+::Species \texorpdfstring{$>$}{>}}{\pageref{structstd_1_1hash_3_01fourdst_1_1atomic_1_1_species_01_4}}{}
|
||||
\item \contentsline{section}{fourdst\+::atomic\+::Species}{\pageref{structfourdst_1_1atomic_1_1_species}}{}
|
||||
\end{DoxyCompactList}
|
||||
238
docs/latex/index.tex
Normal file
238
docs/latex/index.tex
Normal file
@@ -0,0 +1,238 @@
|
||||
\chapter{libcomposition\+: A Modern C++ Library for Chemical Compositions}
|
||||
\hypertarget{index}{}\label{index}\index{libcomposition: A Modern C++ Library for Chemical Compositions@{libcomposition: A Modern C++ Library for Chemical Compositions}}
|
||||
\hypertarget{index_intro_sec}{}\doxysection{\texorpdfstring{Introduction}{Introduction}}\label{index_intro_sec}
|
||||
{\ttfamily libcomposition} is a modern C++23 library designed for the creation, manipulation, and analysis of chemical compositions, with a focus on astrophysical applications. It provides a robust and user-\/friendly interface for handling material compositions defined by mass or number fractions.\hypertarget{index_autotoc_md0}{}\doxysubsubsection{\texorpdfstring{Key Features}{Key Features}}\label{index_autotoc_md0}
|
||||
|
||||
\begin{DoxyItemize}
|
||||
\item {\bfseries{Dual-\/\+Mode Operation}}\+: Natively supports compositions defined by {\bfseries{mass fraction}} or {\bfseries{number fraction}}.
|
||||
\item {\bfseries{Rich Atomic Database}}\+: Includes a comprehensive, header-\/only database of isotopic properties (mass, half-\/life, spin, etc.) generated from the AME2020 and NUBASE2020 evaluations.
|
||||
\item {\bfseries{Type Safety and Error Handling}}\+: Utilizes a clear exception hierarchy to report errors, such as using an unregistered isotope or accessing data from a non-\/validated composition.
|
||||
\item {\bfseries{Powerful Functionality}}\+: Core features include mixing, subsetting, and on-\/the-\/fly conversion between mass and number fractions.
|
||||
\item {\bfseries{Easy Integration}}\+: Designed for seamless integration with other projects using the Meson build system and {\ttfamily pkg-\/config}.
|
||||
\end{DoxyItemize}
|
||||
|
||||
\DoxyHorRuler{0}
|
||||
\hypertarget{index_install_sec}{}\doxysection{\texorpdfstring{Installation}{Installation}}\label{index_install_sec}
|
||||
{\ttfamily libcomposition} uses the Meson build system. A C++23 compatible compiler is required.\hypertarget{index_autotoc_md2}{}\doxysubsubsection{\texorpdfstring{Build Steps}{Build Steps}}\label{index_autotoc_md2}
|
||||
{\bfseries{Setup the build directory\+:}}
|
||||
|
||||
The first step is to use meson to set up an out of source build. Note that this means that you can have multiple builds configured and cleanly seperated!
|
||||
|
||||
|
||||
\begin{DoxyCode}{0}
|
||||
\DoxyCodeLine{meson\ setup\ builddir}
|
||||
|
||||
\end{DoxyCode}
|
||||
|
||||
|
||||
{\bfseries{Compile the library\+:}}
|
||||
|
||||
meson by default uses ninja to compile so it should be very fast; however, gcc is very slow when compiling the species database so that migth take some time (clang tends to be very fast for this).
|
||||
|
||||
|
||||
\begin{DoxyCode}{0}
|
||||
\DoxyCodeLine{meson\ compile\ -\/C\ builddir}
|
||||
|
||||
\end{DoxyCode}
|
||||
|
||||
|
||||
{\bfseries{Install the library\+:}}
|
||||
|
||||
This will also install a pkg-\/config file!
|
||||
|
||||
|
||||
\begin{DoxyCode}{0}
|
||||
\DoxyCodeLine{sudo\ meson\ install\ -\/C\ builddir}
|
||||
|
||||
\end{DoxyCode}
|
||||
\hypertarget{index_autotoc_md3}{}\doxysubsubsection{\texorpdfstring{Build Options}{Build Options}}\label{index_autotoc_md3}
|
||||
You can enable the generation of a {\ttfamily pkg-\/config} file during the setup step, which simplifies linking the library in other projects. by default this is true; it can be useful to disable this when using some build system orgestrator (such as meson-\/python).
|
||||
|
||||
|
||||
\begin{DoxyCode}{0}
|
||||
\DoxyCodeLine{\#\ Enable\ pkg-\/config\ file\ generation}
|
||||
\DoxyCodeLine{meson\ setup\ builddir\ -\/Dpkg-\/config=true}
|
||||
|
||||
\end{DoxyCode}
|
||||
|
||||
|
||||
\DoxyHorRuler{0}
|
||||
\hypertarget{index_usage_sec}{}\doxysection{\texorpdfstring{Usage}{Usage}}\label{index_usage_sec}
|
||||
\hypertarget{index_autotoc_md5}{}\doxysubsubsection{\texorpdfstring{Linking with pkg-\/config}{Linking with pkg-\/config}}\label{index_autotoc_md5}
|
||||
If you installed {\ttfamily libcomposition} with the {\ttfamily pkg-\/config} option enabled, you can get the necessary compiler and linker flags easily\+:
|
||||
|
||||
|
||||
\begin{DoxyCode}{0}
|
||||
\DoxyCodeLine{\#\ Get\ compiler\ flags\ (include\ paths)}
|
||||
\DoxyCodeLine{pkg-\/config\ -\/-\/cflags\ fourdst\_composition}
|
||||
\DoxyCodeLine{}
|
||||
\DoxyCodeLine{\#\ Get\ linker\ flags\ (library\ paths\ and\ names)}
|
||||
\DoxyCodeLine{pkg-\/config\ -\/-\/libs\ fourdst\_composition}
|
||||
|
||||
\end{DoxyCode}
|
||||
|
||||
|
||||
{\bfseries{Example compilation command\+:}}
|
||||
\begin{DoxyCode}{0}
|
||||
\DoxyCodeLine{g++\ my\_app.cpp\ \$(pkg-\/config\ -\/-\/cflags\ -\/-\/libs\ fourdst\_composition)\ -\/o\ my\_app}
|
||||
|
||||
\end{DoxyCode}
|
||||
\hypertarget{index_autotoc_md6}{}\doxysubsubsection{\texorpdfstring{C++ Usage Examples}{C++ Usage Examples}}\label{index_autotoc_md6}
|
||||
\hypertarget{index_autotoc_md7}{}\doxysubsubsubsection{\texorpdfstring{1. Basic Mass Fraction Composition}{1. Basic Mass Fraction Composition}}\label{index_autotoc_md7}
|
||||
The most common use case is defining a composition by mass fractions (X, Y, Z).
|
||||
|
||||
|
||||
\begin{DoxyCode}{0}
|
||||
\DoxyCodeLine{\textcolor{preprocessor}{\#include\ <iostream>}}
|
||||
\DoxyCodeLine{\textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{composition_8h}{fourdst/composition/composition.h}}"{}}}
|
||||
\DoxyCodeLine{}
|
||||
\DoxyCodeLine{\textcolor{keywordtype}{int}\ main()\ \{}
|
||||
\DoxyCodeLine{\ \ \ \ \textcolor{comment}{//\ 1.\ Create\ a\ composition\ object}}
|
||||
\DoxyCodeLine{\ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition}{fourdst::composition::Composition}}\ comp;}
|
||||
\DoxyCodeLine{}
|
||||
\DoxyCodeLine{\ \ \ \ \textcolor{comment}{//\ 2.\ Register\ the\ symbols\ you\ want\ to\ use}}
|
||||
\DoxyCodeLine{\ \ \ \ comp.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a1bc2e64f87c12befdc2bc767e7405661}{registerSymbol}}(\textcolor{stringliteral}{"{}H-\/1"{}});}
|
||||
\DoxyCodeLine{\ \ \ \ comp.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a1bc2e64f87c12befdc2bc767e7405661}{registerSymbol}}(\textcolor{stringliteral}{"{}He-\/4"{}});}
|
||||
\DoxyCodeLine{}
|
||||
\DoxyCodeLine{\ \ \ \ \textcolor{comment}{//\ 3.\ Set\ their\ mass\ fractions}}
|
||||
\DoxyCodeLine{\ \ \ \ comp.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a493224656aa3ade68389250720ef09af}{setMassFraction}}(\textcolor{stringliteral}{"{}H-\/1"{}},\ 0.75);}
|
||||
\DoxyCodeLine{\ \ \ \ comp.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a493224656aa3ade68389250720ef09af}{setMassFraction}}(\textcolor{stringliteral}{"{}He-\/4"{}},\ 0.25);}
|
||||
\DoxyCodeLine{}
|
||||
\DoxyCodeLine{\ \ \ \ \textcolor{comment}{//\ 4.\ Finalize\ the\ composition\ to\ validate\ it\ and\ compute\ global\ properties}}
|
||||
\DoxyCodeLine{\ \ \ \ \textcolor{keywordflow}{if}\ (comp.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a72d063a74a9d2197065884a2cea57a14}{finalize}}())\ \{}
|
||||
\DoxyCodeLine{\ \ \ \ \ \ \ \ std::cout\ <<\ \textcolor{stringliteral}{"{}Composition\ finalized\ successfully!"{}}\ <<\ std::endl;}
|
||||
\DoxyCodeLine{\ \ \ \ \ \ \ \ std::cout\ <<\ \textcolor{stringliteral}{"{}H-\/1\ Mass\ Fraction:\ "{}}\ <<\ comp.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ad20bd541dd7c45274a2e586e6a0519a7}{getMassFraction}}(\textcolor{stringliteral}{"{}H-\/1"{}})\ <<\ std::endl;}
|
||||
\DoxyCodeLine{\ \ \ \ \ \ \ \ std::cout\ <<\ \textcolor{stringliteral}{"{}Mean\ Particle\ Mass:\ "{}}\ <<\ comp.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a66401fed7054172e9b1a2687e5cc8eff}{getMeanParticleMass}}()\ <<\ \textcolor{stringliteral}{"{}\ g/mol"{}}\ <<\ std::endl;}
|
||||
\DoxyCodeLine{\ \ \ \ \}\ \textcolor{keywordflow}{else}\ \{}
|
||||
\DoxyCodeLine{\ \ \ \ \ \ \ \ std::cerr\ <<\ \textcolor{stringliteral}{"{}Failed\ to\ finalize\ composition."{}}\ <<\ std::endl;}
|
||||
\DoxyCodeLine{\ \ \ \ \}}
|
||||
\DoxyCodeLine{}
|
||||
\DoxyCodeLine{\ \ \ \ \textcolor{keywordflow}{return}\ 0;}
|
||||
\DoxyCodeLine{\}}
|
||||
|
||||
\end{DoxyCode}
|
||||
\hypertarget{index_autotoc_md8}{}\doxysubsubsubsection{\texorpdfstring{2. Number Fraction Composition and Mode Switching}{2. Number Fraction Composition and Mode Switching}}\label{index_autotoc_md8}
|
||||
The library can also work with number (mole) fractions and switch between modes.
|
||||
|
||||
|
||||
\begin{DoxyCode}{0}
|
||||
\DoxyCodeLine{\textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{composition_8h}{fourdst/composition/composition.h}}"{}}}
|
||||
\DoxyCodeLine{\textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{exceptions__composition_8h}{fourdst/composition/exceptions/exceptions\_composition.h}}"{}}}
|
||||
\DoxyCodeLine{}
|
||||
\DoxyCodeLine{\textcolor{keywordtype}{void}\ number\_fraction\_example()\ \{}
|
||||
\DoxyCodeLine{\ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition}{fourdst::composition::Composition}}\ comp;}
|
||||
\DoxyCodeLine{}
|
||||
\DoxyCodeLine{\ \ \ \ \textcolor{comment}{//\ Register\ symbols\ in\ number\ fraction\ mode}}
|
||||
\DoxyCodeLine{\ \ \ \ comp.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a1bc2e64f87c12befdc2bc767e7405661}{registerSymbol}}(\textcolor{stringliteral}{"{}H-\/1"{}},\ \textcolor{keyword}{false});\ \textcolor{comment}{//\ massFracMode\ =\ false}}
|
||||
\DoxyCodeLine{\ \ \ \ comp.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a1bc2e64f87c12befdc2bc767e7405661}{registerSymbol}}(\textcolor{stringliteral}{"{}He-\/4"{}},\ \textcolor{keyword}{false});}
|
||||
\DoxyCodeLine{}
|
||||
\DoxyCodeLine{\ \ \ \ comp.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a7d4d748f3ee25e68751fb143717ed080}{setNumberFraction}}(\textcolor{stringliteral}{"{}H-\/1"{}},\ 0.9);}
|
||||
\DoxyCodeLine{\ \ \ \ comp.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a7d4d748f3ee25e68751fb143717ed080}{setNumberFraction}}(\textcolor{stringliteral}{"{}He-\/4"{}},\ 0.1);}
|
||||
\DoxyCodeLine{}
|
||||
\DoxyCodeLine{\ \ \ \ \textcolor{keywordflow}{if}\ (comp.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a72d063a74a9d2197065884a2cea57a14}{finalize}}())\ \{}
|
||||
\DoxyCodeLine{\ \ \ \ \ \ \ \ \textcolor{comment}{//\ We\ can\ get\ number\ fractions\ directly}}
|
||||
\DoxyCodeLine{\ \ \ \ \ \ \ \ std::cout\ <<\ \textcolor{stringliteral}{"{}He-\/4\ Number\ Fraction:\ "{}}\ <<\ comp.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a84fea38bc1c005e483910285f6800e15}{getNumberFraction}}(\textcolor{stringliteral}{"{}He-\/4"{}})\ <<\ std::endl;}
|
||||
\DoxyCodeLine{}
|
||||
\DoxyCodeLine{\ \ \ \ \ \ \ \ \textcolor{comment}{//\ Or\ get\ the\ equivalent\ mass\ fraction}}
|
||||
\DoxyCodeLine{\ \ \ \ \ \ \ \ std::cout\ <<\ \textcolor{stringliteral}{"{}He-\/4\ Mass\ Fraction:\ "{}}\ <<\ comp.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ad20bd541dd7c45274a2e586e6a0519a7}{getMassFraction}}(\textcolor{stringliteral}{"{}He-\/4"{}})\ <<\ std::endl;}
|
||||
\DoxyCodeLine{}
|
||||
\DoxyCodeLine{\ \ \ \ \ \ \ \ \textcolor{comment}{//\ Switch\ the\ entire\ composition\ to\ mass\ fraction\ mode}}
|
||||
\DoxyCodeLine{\ \ \ \ \ \ \ \ comp.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a0af981ed1074b26c237cf6cf35f82c9e}{setCompositionMode}}(\textcolor{keyword}{true});\ \textcolor{comment}{//\ true\ for\ mass\ fraction\ mode}}
|
||||
\DoxyCodeLine{}
|
||||
\DoxyCodeLine{\ \ \ \ \ \ \ \ \textcolor{comment}{//\ Now,\ getting\ the\ mass\ fraction\ is\ a\ direct\ lookup}}
|
||||
\DoxyCodeLine{\ \ \ \ \ \ \ \ std::cout\ <<\ \textcolor{stringliteral}{"{}He-\/4\ Mass\ Fraction\ (after\ mode\ switch):\ "{}}\ <<\ comp.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ad20bd541dd7c45274a2e586e6a0519a7}{getMassFraction}}(\textcolor{stringliteral}{"{}He-\/4"{}})\ <<\ std::endl;}
|
||||
\DoxyCodeLine{\ \ \ \ \}}
|
||||
\DoxyCodeLine{\}}
|
||||
|
||||
\end{DoxyCode}
|
||||
\hypertarget{index_autotoc_md9}{}\doxysubsubsubsection{\texorpdfstring{3. Mixing Two Compositions}{3. Mixing Two Compositions}}\label{index_autotoc_md9}
|
||||
You can easily mix two compositions. The library handles the union of all species.
|
||||
|
||||
|
||||
\begin{DoxyCode}{0}
|
||||
\DoxyCodeLine{\textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{composition_8h}{fourdst/composition/composition.h}}"{}}}
|
||||
\DoxyCodeLine{}
|
||||
\DoxyCodeLine{\textcolor{keywordtype}{void}\ mixing\_example()\ \{}
|
||||
\DoxyCodeLine{\ \ \ \ \textcolor{comment}{//\ Composition\ 1:\ Pure\ Hydrogen}}
|
||||
\DoxyCodeLine{\ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition}{fourdst::composition::Composition}}\ comp1(\{\textcolor{stringliteral}{"{}H-\/1"{}}\},\ \{1.0\});}
|
||||
\DoxyCodeLine{}
|
||||
\DoxyCodeLine{\ \ \ \ \textcolor{comment}{//\ Composition\ 2:\ Pure\ Helium}}
|
||||
\DoxyCodeLine{\ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition}{fourdst::composition::Composition}}\ comp2(\{\textcolor{stringliteral}{"{}He-\/4"{}}\},\ \{1.0\});}
|
||||
\DoxyCodeLine{}
|
||||
\DoxyCodeLine{\ \ \ \ \textcolor{comment}{//\ Mix\ them\ with\ a\ 50/50\ ratio\ using\ the\ '+'\ operator}}
|
||||
\DoxyCodeLine{\ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition}{fourdst::composition::Composition}}\ mixed\ =\ comp1\ +\ comp2;}
|
||||
\DoxyCodeLine{}
|
||||
\DoxyCodeLine{\ \ \ \ \textcolor{comment}{//\ Mix\ them\ with\ a\ 75/25\ ratio\ using\ the\ mix()\ method}}
|
||||
\DoxyCodeLine{\ \ \ \ \textcolor{comment}{//\ 0.75\ of\ comp1,\ 0.25\ of\ comp2}}
|
||||
\DoxyCodeLine{\ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition}{fourdst::composition::Composition}}\ mixed2\ =\ comp1.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a3aead72892606725a4149a5f65bd31ec}{mix}}(comp2,\ 0.75);}
|
||||
\DoxyCodeLine{}
|
||||
\DoxyCodeLine{\ \ \ \ std::cout\ <<\ \textcolor{stringliteral}{"{}50/50\ Mix\ H-\/1:\ "{}}\ <<\ mixed.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ad20bd541dd7c45274a2e586e6a0519a7}{getMassFraction}}(\textcolor{stringliteral}{"{}H-\/1"{}})\ <<\ std::endl;\ \ \ \textcolor{comment}{//\ -\/>\ 0.5}}
|
||||
\DoxyCodeLine{\ \ \ \ std::cout\ <<\ \textcolor{stringliteral}{"{}75/25\ Mix\ H-\/1:\ "{}}\ <<\ mixed2.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ad20bd541dd7c45274a2e586e6a0519a7}{getMassFraction}}(\textcolor{stringliteral}{"{}H-\/1"{}})\ <<\ std::endl;\ \ \textcolor{comment}{//\ -\/>\ 0.75}}
|
||||
\DoxyCodeLine{\}}
|
||||
|
||||
\end{DoxyCode}
|
||||
\hypertarget{index_autotoc_md10}{}\doxysubsubsubsection{\texorpdfstring{4. Error Handling}{4. Error Handling}}\label{index_autotoc_md10}
|
||||
The library uses exceptions to report errors. Always wrap calls in a {\ttfamily try-\/catch} block for robust code.
|
||||
|
||||
|
||||
\begin{DoxyCode}{0}
|
||||
\DoxyCodeLine{\textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{composition_8h}{fourdst/composition/composition.h}}"{}}}
|
||||
\DoxyCodeLine{\textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{exceptions__composition_8h}{fourdst/composition/exceptions/exceptions\_composition.h}}"{}}}
|
||||
\DoxyCodeLine{}
|
||||
\DoxyCodeLine{\textcolor{keywordtype}{void}\ error\_example()\ \{}
|
||||
\DoxyCodeLine{\ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition}{fourdst::composition::Composition}}\ comp;}
|
||||
\DoxyCodeLine{\ \ \ \ comp.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a1bc2e64f87c12befdc2bc767e7405661}{registerSymbol}}(\textcolor{stringliteral}{"{}H-\/1"{}});}
|
||||
\DoxyCodeLine{\ \ \ \ comp.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a493224656aa3ade68389250720ef09af}{setMassFraction}}(\textcolor{stringliteral}{"{}H-\/1"{}},\ 1.0);}
|
||||
\DoxyCodeLine{}
|
||||
\DoxyCodeLine{\ \ \ \ \textcolor{keywordflow}{try}\ \{}
|
||||
\DoxyCodeLine{\ \ \ \ \ \ \ \ \textcolor{comment}{//\ This\ will\ throw,\ because\ the\ composition\ is\ not\ finalized\ yet.}}
|
||||
\DoxyCodeLine{\ \ \ \ \ \ \ \ \textcolor{keywordtype}{double}\ mass\ =\ comp.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ad20bd541dd7c45274a2e586e6a0519a7}{getMassFraction}}(\textcolor{stringliteral}{"{}H-\/1"{}});}
|
||||
\DoxyCodeLine{\ \ \ \ \}\ \textcolor{keywordflow}{catch}\ (\textcolor{keyword}{const}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_not_finalized_error}{fourdst::composition::exceptions::CompositionNotFinalizedError}}\&\ e)\ \{}
|
||||
\DoxyCodeLine{\ \ \ \ \ \ \ \ std::cerr\ <<\ \textcolor{stringliteral}{"{}Caught\ expected\ error:\ "{}}\ <<\ e.\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error_ae44ceddb19da8a8cda7ee150b6826d08}{what}}()\ <<\ std::endl;}
|
||||
\DoxyCodeLine{\ \ \ \ \}}
|
||||
\DoxyCodeLine{}
|
||||
\DoxyCodeLine{\ \ \ \ \textcolor{keywordflow}{try}\ \{}
|
||||
\DoxyCodeLine{\ \ \ \ \ \ \ \ \textcolor{comment}{//\ This\ will\ throw,\ because\ "{}Li-\/6"{}\ was\ never\ registered.}}
|
||||
\DoxyCodeLine{\ \ \ \ \ \ \ \ comp.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a493224656aa3ade68389250720ef09af}{setMassFraction}}(\textcolor{stringliteral}{"{}Li-\/6"{}},\ 0.1);}
|
||||
\DoxyCodeLine{\ \ \ \ \}\ \textcolor{keywordflow}{catch}\ (\textcolor{keyword}{const}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_unregistered_symbol_error}{fourdst::composition::exceptions::UnregisteredSymbolError}}\&\ e)\ \{}
|
||||
\DoxyCodeLine{\ \ \ \ \ \ \ \ std::cerr\ <<\ \textcolor{stringliteral}{"{}Caught\ expected\ error:\ "{}}\ <<\ e.\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error_ae44ceddb19da8a8cda7ee150b6826d08}{what}}()\ <<\ std::endl;}
|
||||
\DoxyCodeLine{\ \ \ \ \}}
|
||||
\DoxyCodeLine{\}}
|
||||
|
||||
\end{DoxyCode}
|
||||
\hypertarget{index_autotoc_md11}{}\doxysubsubsubsection{\texorpdfstring{5. Accessing Atomic Data}{5. Accessing Atomic Data}}\label{index_autotoc_md11}
|
||||
You can directly access the static database of all known species.
|
||||
|
||||
|
||||
\begin{DoxyCode}{0}
|
||||
\DoxyCodeLine{\textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{species_8h}{fourdst/composition/species.h}}"{}}\ \textcolor{comment}{//\ Provides\ static\ instances\ like\ H\_1}}
|
||||
\DoxyCodeLine{\textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{atomic_species_8h}{fourdst/composition/atomicSpecies.h}}"{}}\ \textcolor{comment}{//\ Provides\ the\ main\ 'species'\ map}}
|
||||
\DoxyCodeLine{}
|
||||
\DoxyCodeLine{\textcolor{keywordtype}{void}\ data\_example()\ \{}
|
||||
\DoxyCodeLine{\ \ \ \ \textcolor{comment}{//\ Access\ via\ the\ map}}
|
||||
\DoxyCodeLine{\ \ \ \ \textcolor{keyword}{const}\ \textcolor{keyword}{auto}\&\ fe56\ =\ \mbox{\hyperlink{namespacefourdst_1_1atomic_a3f619cc8f8b2cd718a4082c6adb0de90}{fourdst::atomic::species}}.at(\textcolor{stringliteral}{"{}Fe-\/56"{}});}
|
||||
\DoxyCodeLine{\ \ \ \ std::cout\ <<\ \textcolor{stringliteral}{"{}Fe-\/56\ mass:\ "{}}\ <<\ fe56-\/>mass()\ <<\ std::endl;}
|
||||
\DoxyCodeLine{}
|
||||
\DoxyCodeLine{\ \ \ \ \textcolor{comment}{//\ Access\ via\ the\ static\ instance}}
|
||||
\DoxyCodeLine{\ \ \ \ std::cout\ <<\ \textcolor{stringliteral}{"{}H-\/1\ spin:\ "{}}\ <<\ \mbox{\hyperlink{namespacefourdst_1_1atomic_a6766bc834fd656df51bdcf22f7d97877}{fourdst::atomic::H\_1}}.spin()\ <<\ std::endl;}
|
||||
\DoxyCodeLine{\ \ \ \ std::cout\ <<\ \textcolor{stringliteral}{"{}F-\/18\ half-\/life:\ "{}}\ <<\ \mbox{\hyperlink{namespacefourdst_1_1atomic_a3c09ded079905f8c355f9ea87b6b191f}{fourdst::atomic::F\_18}}.halfLife()\ <<\ \textcolor{stringliteral}{"{}\ s"{}}\ <<\ std::endl;}
|
||||
\DoxyCodeLine{\}}
|
||||
|
||||
\end{DoxyCode}
|
||||
|
||||
|
||||
\DoxyHorRuler{0}
|
||||
\hypertarget{index_test_sec}{}\doxysection{\texorpdfstring{Testing}{Testing}}\label{index_test_sec}
|
||||
{\ttfamily libcomposition} is tested using the Google\+Test framework. The test suite provides high coverage of the library\textquotesingle{}s functionality.\hypertarget{index_autotoc_md13}{}\doxysubsubsection{\texorpdfstring{Test Coverage Includes\+:}{Test Coverage Includes\+:}}\label{index_autotoc_md13}
|
||||
|
||||
\begin{DoxyItemize}
|
||||
\item {\bfseries{Atomic Data Validation}}\+: Spot checks on isotopic properties (mass, half-\/life, spin) for a wide range of elements to ensure the underlying data files are parsed and represented correctly.
|
||||
\item {\bfseries{Core {\ttfamily Composition} Workflow}}\+: Verification of object construction, symbol registration (for both valid and invalid symbols), and the complete workflow of setting and getting both mass and number fractions.
|
||||
\item {\bfseries{Finalization Logic}}\+: Ensures that {\ttfamily finalize()} is a required step before querying data. Tests the validation logic for compositions that sum to 1.\+0 and the auto-\/normalization feature ({\ttfamily finalize(true)}).
|
||||
\item {\bfseries{Advanced Features}}\+: Dedicated tests for {\ttfamily mix()}, {\ttfamily subset()}, {\ttfamily set\+Composition\+Mode()}, and the calculation of derived quantities like {\ttfamily get\+Molar\+Abundance()} and {\ttfamily get\+Mean\+Atomic\+Number()}.
|
||||
\item {\bfseries{Exception Handling}}\+: Confirms that invalid operations (e.\+g., using an unregistered symbol, mixing un-\/finalized compositions) correctly throw exceptions from the {\ttfamily \doxylink{namespacefourdst_1_1composition_1_1exceptions}{fourdst\+::composition\+::exceptions}} hierarchy.
|
||||
\end{DoxyItemize}
|
||||
|
||||
\DoxyHorRuler{0}
|
||||
\hypertarget{index_api_sec}{}\doxysection{\texorpdfstring{API Reference}{API Reference}}\label{index_api_sec}
|
||||
For a complete list of all classes, methods, and functions, please see the \texorpdfstring{$\ast$}{*}\texorpdfstring{$\ast$}{*}\href{namespaces.html}{\texttt{ Namespaces}}\texorpdfstring{$\ast$}{*}\texorpdfstring{$\ast$}{*} and \texorpdfstring{$\ast$}{*}\texorpdfstring{$\ast$}{*}\href{annotated.html}{\texttt{ Classes}}\texorpdfstring{$\ast$}{*}\texorpdfstring{$\ast$}{*} sections of this documentation.
|
||||
459
docs/latex/longtable_doxygen.sty
Normal file
459
docs/latex/longtable_doxygen.sty
Normal file
@@ -0,0 +1,459 @@
|
||||
%%
|
||||
%% This is file `longtable.sty',
|
||||
%% generated with the docstrip utility.
|
||||
%%
|
||||
%% The original source files were:
|
||||
%%
|
||||
%% longtable.dtx (with options: `package')
|
||||
%%
|
||||
%% This is a generated file.
|
||||
%%
|
||||
%% The source is maintained by the LaTeX Project team and bug
|
||||
%% reports for it can be opened at http://latex-project.org/bugs.html
|
||||
%% (but please observe conditions on bug reports sent to that address!)
|
||||
%%
|
||||
%% Copyright 1993-2016
|
||||
%% The LaTeX3 Project and any individual authors listed elsewhere
|
||||
%% in this file.
|
||||
%%
|
||||
%% This file was generated from file(s) of the Standard LaTeX `Tools Bundle'.
|
||||
%% --------------------------------------------------------------------------
|
||||
%%
|
||||
%% It may be distributed and/or modified under the
|
||||
%% conditions of the LaTeX Project Public License, either version 1.3c
|
||||
%% of this license or (at your option) any later version.
|
||||
%% The latest version of this license is in
|
||||
%% http://www.latex-project.org/lppl.txt
|
||||
%% and version 1.3c or later is part of all distributions of LaTeX
|
||||
%% version 2005/12/01 or later.
|
||||
%%
|
||||
%% This file may only be distributed together with a copy of the LaTeX
|
||||
%% `Tools Bundle'. You may however distribute the LaTeX `Tools Bundle'
|
||||
%% without such generated files.
|
||||
%%
|
||||
%% The list of all files belonging to the LaTeX `Tools Bundle' is
|
||||
%% given in the file `manifest.txt'.
|
||||
%%
|
||||
%% File: longtable.dtx Copyright (C) 1990-2001 David Carlisle
|
||||
\NeedsTeXFormat{LaTeX2e}[1995/06/01]
|
||||
\ProvidesPackage{longtable_doxygen}
|
||||
[2014/10/28 v4.11 Multi-page Table package (DPC) - frozen version for doxygen]
|
||||
\def\LT@err{\PackageError{longtable}}
|
||||
\def\LT@warn{\PackageWarning{longtable}}
|
||||
\def\LT@final@warn{%
|
||||
\AtEndDocument{%
|
||||
\LT@warn{Table \@width s have changed. Rerun LaTeX.\@gobbletwo}}%
|
||||
\global\let\LT@final@warn\relax}
|
||||
\DeclareOption{errorshow}{%
|
||||
\def\LT@warn{\PackageInfo{longtable}}}
|
||||
\DeclareOption{pausing}{%
|
||||
\def\LT@warn#1{%
|
||||
\LT@err{#1}{This is not really an error}}}
|
||||
\DeclareOption{set}{}
|
||||
\DeclareOption{final}{}
|
||||
\ProcessOptions
|
||||
\newskip\LTleft \LTleft=\fill
|
||||
\newskip\LTright \LTright=\fill
|
||||
\newskip\LTpre \LTpre=\bigskipamount
|
||||
\newskip\LTpost \LTpost=\bigskipamount
|
||||
\newcount\LTchunksize \LTchunksize=20
|
||||
\let\c@LTchunksize\LTchunksize
|
||||
\newdimen\LTcapwidth \LTcapwidth=4in
|
||||
\newbox\LT@head
|
||||
\newbox\LT@firsthead
|
||||
\newbox\LT@foot
|
||||
\newbox\LT@lastfoot
|
||||
\newcount\LT@cols
|
||||
\newcount\LT@rows
|
||||
\newcounter{LT@tables}
|
||||
\newcounter{LT@chunks}[LT@tables]
|
||||
\ifx\c@table\undefined
|
||||
\newcounter{table}
|
||||
\def\fnum@table{\tablename~\thetable}
|
||||
\fi
|
||||
\ifx\tablename\undefined
|
||||
\def\tablename{Table}
|
||||
\fi
|
||||
\newtoks\LT@p@ftn
|
||||
\mathchardef\LT@end@pen=30000
|
||||
\def\longtable{%
|
||||
\par
|
||||
\ifx\multicols\@undefined
|
||||
\else
|
||||
\ifnum\col@number>\@ne
|
||||
\@twocolumntrue
|
||||
\fi
|
||||
\fi
|
||||
\if@twocolumn
|
||||
\LT@err{longtable not in 1-column mode}\@ehc
|
||||
\fi
|
||||
\begingroup
|
||||
\@ifnextchar[\LT@array{\LT@array[x]}}
|
||||
\def\LT@array[#1]#2{%
|
||||
\refstepcounter{table}\stepcounter{LT@tables}%
|
||||
\if l#1%
|
||||
\LTleft\z@ \LTright\fill
|
||||
\else\if r#1%
|
||||
\LTleft\fill \LTright\z@
|
||||
\else\if c#1%
|
||||
\LTleft\fill \LTright\fill
|
||||
\fi\fi\fi
|
||||
\let\LT@mcol\multicolumn
|
||||
\let\LT@@tabarray\@tabarray
|
||||
\let\LT@@hl\hline
|
||||
\def\@tabarray{%
|
||||
\let\hline\LT@@hl
|
||||
\LT@@tabarray}%
|
||||
\let\\\LT@tabularcr\let\tabularnewline\\%
|
||||
\def\newpage{\noalign{\break}}%
|
||||
\def\pagebreak{\noalign{\ifnum`}=0\fi\@testopt{\LT@no@pgbk-}4}%
|
||||
\def\nopagebreak{\noalign{\ifnum`}=0\fi\@testopt\LT@no@pgbk4}%
|
||||
\let\hline\LT@hline \let\kill\LT@kill\let\caption\LT@caption
|
||||
\@tempdima\ht\strutbox
|
||||
\let\@endpbox\LT@endpbox
|
||||
\ifx\extrarowheight\@undefined
|
||||
\let\@acol\@tabacol
|
||||
\let\@classz\@tabclassz \let\@classiv\@tabclassiv
|
||||
\def\@startpbox{\vtop\LT@startpbox}%
|
||||
\let\@@startpbox\@startpbox
|
||||
\let\@@endpbox\@endpbox
|
||||
\let\LT@LL@FM@cr\@tabularcr
|
||||
\else
|
||||
\advance\@tempdima\extrarowheight
|
||||
\col@sep\tabcolsep
|
||||
\let\@startpbox\LT@startpbox\let\LT@LL@FM@cr\@arraycr
|
||||
\fi
|
||||
\setbox\@arstrutbox\hbox{\vrule
|
||||
\@height \arraystretch \@tempdima
|
||||
\@depth \arraystretch \dp \strutbox
|
||||
\@width \z@}%
|
||||
\let\@sharp##\let\protect\relax
|
||||
\begingroup
|
||||
\@mkpream{#2}%
|
||||
\xdef\LT@bchunk{%
|
||||
\global\advance\c@LT@chunks\@ne
|
||||
\global\LT@rows\z@\setbox\z@\vbox\bgroup
|
||||
\LT@setprevdepth
|
||||
\tabskip\LTleft \noexpand\halign to\hsize\bgroup
|
||||
\tabskip\z@ \@arstrut \@preamble \tabskip\LTright \cr}%
|
||||
\endgroup
|
||||
\expandafter\LT@nofcols\LT@bchunk&\LT@nofcols
|
||||
\LT@make@row
|
||||
\m@th\let\par\@empty
|
||||
\everycr{}\lineskip\z@\baselineskip\z@
|
||||
\LT@bchunk}
|
||||
\def\LT@no@pgbk#1[#2]{\penalty #1\@getpen{#2}\ifnum`{=0\fi}}
|
||||
\def\LT@start{%
|
||||
\let\LT@start\endgraf
|
||||
\endgraf\penalty\z@\vskip\LTpre
|
||||
\dimen@\pagetotal
|
||||
\advance\dimen@ \ht\ifvoid\LT@firsthead\LT@head\else\LT@firsthead\fi
|
||||
\advance\dimen@ \dp\ifvoid\LT@firsthead\LT@head\else\LT@firsthead\fi
|
||||
\advance\dimen@ \ht\LT@foot
|
||||
\dimen@ii\vfuzz
|
||||
\vfuzz\maxdimen
|
||||
\setbox\tw@\copy\z@
|
||||
\setbox\tw@\vsplit\tw@ to \ht\@arstrutbox
|
||||
\setbox\tw@\vbox{\unvbox\tw@}%
|
||||
\vfuzz\dimen@ii
|
||||
\advance\dimen@ \ht
|
||||
\ifdim\ht\@arstrutbox>\ht\tw@\@arstrutbox\else\tw@\fi
|
||||
\advance\dimen@\dp
|
||||
\ifdim\dp\@arstrutbox>\dp\tw@\@arstrutbox\else\tw@\fi
|
||||
\advance\dimen@ -\pagegoal
|
||||
\ifdim \dimen@>\z@\vfil\break\fi
|
||||
\global\@colroom\@colht
|
||||
\ifvoid\LT@foot\else
|
||||
\global\advance\vsize-\ht\LT@foot
|
||||
\global\advance\@colroom-\ht\LT@foot
|
||||
\dimen@\pagegoal\advance\dimen@-\ht\LT@foot\pagegoal\dimen@
|
||||
\maxdepth\z@
|
||||
\fi
|
||||
\ifvoid\LT@firsthead\copy\LT@head\else\box\LT@firsthead\fi\nobreak
|
||||
\output{\LT@output}}
|
||||
\def\endlongtable{%
|
||||
\crcr
|
||||
\noalign{%
|
||||
\let\LT@entry\LT@entry@chop
|
||||
\xdef\LT@save@row{\LT@save@row}}%
|
||||
\LT@echunk
|
||||
\LT@start
|
||||
\unvbox\z@
|
||||
\LT@get@widths
|
||||
\if@filesw
|
||||
{\let\LT@entry\LT@entry@write\immediate\write\@auxout{%
|
||||
\gdef\expandafter\noexpand
|
||||
\csname LT@\romannumeral\c@LT@tables\endcsname
|
||||
{\LT@save@row}}}%
|
||||
\fi
|
||||
\ifx\LT@save@row\LT@@save@row
|
||||
\else
|
||||
\LT@warn{Column \@width s have changed\MessageBreak
|
||||
in table \thetable}%
|
||||
\LT@final@warn
|
||||
\fi
|
||||
\endgraf\penalty -\LT@end@pen
|
||||
\ifvoid\LT@foot\else
|
||||
\global\advance\vsize\ht\LT@foot
|
||||
\global\advance\@colroom\ht\LT@foot
|
||||
\dimen@\pagegoal\advance\dimen@\ht\LT@foot\pagegoal\dimen@
|
||||
\fi
|
||||
\endgroup
|
||||
\global\@mparbottom\z@
|
||||
\endgraf\penalty\z@\addvspace\LTpost
|
||||
\ifvoid\footins\else\insert\footins{}\fi}
|
||||
\def\LT@nofcols#1&{%
|
||||
\futurelet\@let@token\LT@n@fcols}
|
||||
\def\LT@n@fcols{%
|
||||
\advance\LT@cols\@ne
|
||||
\ifx\@let@token\LT@nofcols
|
||||
\expandafter\@gobble
|
||||
\else
|
||||
\expandafter\LT@nofcols
|
||||
\fi}
|
||||
\def\LT@tabularcr{%
|
||||
\relax\iffalse{\fi\ifnum0=`}\fi
|
||||
\@ifstar
|
||||
{\def\crcr{\LT@crcr\noalign{\nobreak}}\let\cr\crcr
|
||||
\LT@t@bularcr}%
|
||||
{\LT@t@bularcr}}
|
||||
\let\LT@crcr\crcr
|
||||
\let\LT@setprevdepth\relax
|
||||
\def\LT@t@bularcr{%
|
||||
\global\advance\LT@rows\@ne
|
||||
\ifnum\LT@rows=\LTchunksize
|
||||
\gdef\LT@setprevdepth{%
|
||||
\prevdepth\z@\global
|
||||
\global\let\LT@setprevdepth\relax}%
|
||||
\expandafter\LT@xtabularcr
|
||||
\else
|
||||
\ifnum0=`{}\fi
|
||||
\expandafter\LT@LL@FM@cr
|
||||
\fi}
|
||||
\def\LT@xtabularcr{%
|
||||
\@ifnextchar[\LT@argtabularcr\LT@ntabularcr}
|
||||
\def\LT@ntabularcr{%
|
||||
\ifnum0=`{}\fi
|
||||
\LT@echunk
|
||||
\LT@start
|
||||
\unvbox\z@
|
||||
\LT@get@widths
|
||||
\LT@bchunk}
|
||||
\def\LT@argtabularcr[#1]{%
|
||||
\ifnum0=`{}\fi
|
||||
\ifdim #1>\z@
|
||||
\unskip\@xargarraycr{#1}%
|
||||
\else
|
||||
\@yargarraycr{#1}%
|
||||
\fi
|
||||
\LT@echunk
|
||||
\LT@start
|
||||
\unvbox\z@
|
||||
\LT@get@widths
|
||||
\LT@bchunk}
|
||||
\def\LT@echunk{%
|
||||
\crcr\LT@save@row\cr\egroup
|
||||
\global\setbox\@ne\lastbox
|
||||
\unskip
|
||||
\egroup}
|
||||
\def\LT@entry#1#2{%
|
||||
\ifhmode\@firstofone{&}\fi\omit
|
||||
\ifnum#1=\c@LT@chunks
|
||||
\else
|
||||
\kern#2\relax
|
||||
\fi}
|
||||
\def\LT@entry@chop#1#2{%
|
||||
\noexpand\LT@entry
|
||||
{\ifnum#1>\c@LT@chunks
|
||||
1}{0pt%
|
||||
\else
|
||||
#1}{#2%
|
||||
\fi}}
|
||||
\def\LT@entry@write{%
|
||||
\noexpand\LT@entry^^J%
|
||||
\@spaces}
|
||||
\def\LT@kill{%
|
||||
\LT@echunk
|
||||
\LT@get@widths
|
||||
\expandafter\LT@rebox\LT@bchunk}
|
||||
\def\LT@rebox#1\bgroup{%
|
||||
#1\bgroup
|
||||
\unvbox\z@
|
||||
\unskip
|
||||
\setbox\z@\lastbox}
|
||||
\def\LT@blank@row{%
|
||||
\xdef\LT@save@row{\expandafter\LT@build@blank
|
||||
\romannumeral\number\LT@cols 001 }}
|
||||
\def\LT@build@blank#1{%
|
||||
\if#1m%
|
||||
\noexpand\LT@entry{1}{0pt}%
|
||||
\expandafter\LT@build@blank
|
||||
\fi}
|
||||
\def\LT@make@row{%
|
||||
\global\expandafter\let\expandafter\LT@save@row
|
||||
\csname LT@\romannumeral\c@LT@tables\endcsname
|
||||
\ifx\LT@save@row\relax
|
||||
\LT@blank@row
|
||||
\else
|
||||
{\let\LT@entry\or
|
||||
\if!%
|
||||
\ifcase\expandafter\expandafter\expandafter\LT@cols
|
||||
\expandafter\@gobble\LT@save@row
|
||||
\or
|
||||
\else
|
||||
\relax
|
||||
\fi
|
||||
!%
|
||||
\else
|
||||
\aftergroup\LT@blank@row
|
||||
\fi}%
|
||||
\fi}
|
||||
\let\setlongtables\relax
|
||||
\def\LT@get@widths{%
|
||||
\setbox\tw@\hbox{%
|
||||
\unhbox\@ne
|
||||
\let\LT@old@row\LT@save@row
|
||||
\global\let\LT@save@row\@empty
|
||||
\count@\LT@cols
|
||||
\loop
|
||||
\unskip
|
||||
\setbox\tw@\lastbox
|
||||
\ifhbox\tw@
|
||||
\LT@def@row
|
||||
\advance\count@\m@ne
|
||||
\repeat}%
|
||||
\ifx\LT@@save@row\@undefined
|
||||
\let\LT@@save@row\LT@save@row
|
||||
\fi}
|
||||
\def\LT@def@row{%
|
||||
\let\LT@entry\or
|
||||
\edef\@tempa{%
|
||||
\ifcase\expandafter\count@\LT@old@row
|
||||
\else
|
||||
{1}{0pt}%
|
||||
\fi}%
|
||||
\let\LT@entry\relax
|
||||
\xdef\LT@save@row{%
|
||||
\LT@entry
|
||||
\expandafter\LT@max@sel\@tempa
|
||||
\LT@save@row}}
|
||||
\def\LT@max@sel#1#2{%
|
||||
{\ifdim#2=\wd\tw@
|
||||
#1%
|
||||
\else
|
||||
\number\c@LT@chunks
|
||||
\fi}%
|
||||
{\the\wd\tw@}}
|
||||
\def\LT@hline{%
|
||||
\noalign{\ifnum0=`}\fi
|
||||
\penalty\@M
|
||||
\futurelet\@let@token\LT@@hline}
|
||||
\def\LT@@hline{%
|
||||
\ifx\@let@token\hline
|
||||
\global\let\@gtempa\@gobble
|
||||
\gdef\LT@sep{\penalty-\@medpenalty\vskip\doublerulesep}%
|
||||
\else
|
||||
\global\let\@gtempa\@empty
|
||||
\gdef\LT@sep{\penalty-\@lowpenalty\vskip-\arrayrulewidth}%
|
||||
\fi
|
||||
\ifnum0=`{\fi}%
|
||||
\multispan\LT@cols
|
||||
\unskip\leaders\hrule\@height\arrayrulewidth\hfill\cr
|
||||
\noalign{\LT@sep}%
|
||||
\multispan\LT@cols
|
||||
\unskip\leaders\hrule\@height\arrayrulewidth\hfill\cr
|
||||
\noalign{\penalty\@M}%
|
||||
\@gtempa}
|
||||
\def\LT@caption{%
|
||||
\noalign\bgroup
|
||||
\@ifnextchar[{\egroup\LT@c@ption\@firstofone}\LT@capti@n}
|
||||
\def\LT@c@ption#1[#2]#3{%
|
||||
\LT@makecaption#1\fnum@table{#3}%
|
||||
\def\@tempa{#2}%
|
||||
\ifx\@tempa\@empty\else
|
||||
{\let\\\space
|
||||
\addcontentsline{lot}{table}{\protect\numberline{\thetable}{#2}}}%
|
||||
\fi}
|
||||
\def\LT@capti@n{%
|
||||
\@ifstar
|
||||
{\egroup\LT@c@ption\@gobble[]}%
|
||||
{\egroup\@xdblarg{\LT@c@ption\@firstofone}}}
|
||||
\def\LT@makecaption#1#2#3{%
|
||||
\LT@mcol\LT@cols c{\hbox to\z@{\hss\parbox[t]\LTcapwidth{%
|
||||
\sbox\@tempboxa{#1{#2: }#3}%
|
||||
\ifdim\wd\@tempboxa>\hsize
|
||||
#1{#2: }#3%
|
||||
\else
|
||||
\hbox to\hsize{\hfil\box\@tempboxa\hfil}%
|
||||
\fi
|
||||
\endgraf\vskip\baselineskip}%
|
||||
\hss}}}
|
||||
\def\LT@output{%
|
||||
\ifnum\outputpenalty <-\@Mi
|
||||
\ifnum\outputpenalty > -\LT@end@pen
|
||||
\LT@err{floats and marginpars not allowed in a longtable}\@ehc
|
||||
\else
|
||||
\setbox\z@\vbox{\unvbox\@cclv}%
|
||||
\ifdim \ht\LT@lastfoot>\ht\LT@foot
|
||||
\dimen@\pagegoal
|
||||
\advance\dimen@\ht\LT@foot
|
||||
\advance\dimen@-\ht\LT@lastfoot
|
||||
\ifdim\dimen@<\ht\z@
|
||||
\setbox\@cclv\vbox{\unvbox\z@\copy\LT@foot\vss}%
|
||||
\@makecol
|
||||
\@outputpage
|
||||
\global\vsize\@colroom
|
||||
\setbox\z@\vbox{\box\LT@head}%
|
||||
\fi
|
||||
\fi
|
||||
\unvbox\z@\ifvoid\LT@lastfoot\copy\LT@foot\else\box\LT@lastfoot\fi
|
||||
\fi
|
||||
\else
|
||||
\setbox\@cclv\vbox{\unvbox\@cclv\copy\LT@foot\vss}%
|
||||
\@makecol
|
||||
\@outputpage
|
||||
\global\vsize\@colroom
|
||||
\copy\LT@head\nobreak
|
||||
\fi}
|
||||
\def\LT@end@hd@ft#1{%
|
||||
\LT@echunk
|
||||
\ifx\LT@start\endgraf
|
||||
\LT@err
|
||||
{Longtable head or foot not at start of table}%
|
||||
{Increase LTchunksize}%
|
||||
\fi
|
||||
\setbox#1\box\z@
|
||||
\LT@get@widths
|
||||
\LT@bchunk}
|
||||
\def\endfirsthead{\LT@end@hd@ft\LT@firsthead}
|
||||
\def\endhead{\LT@end@hd@ft\LT@head}
|
||||
\def\endfoot{\LT@end@hd@ft\LT@foot}
|
||||
\def\endlastfoot{\LT@end@hd@ft\LT@lastfoot}
|
||||
\def\LT@startpbox#1{%
|
||||
\bgroup
|
||||
\let\@footnotetext\LT@p@ftntext
|
||||
\setlength\hsize{#1}%
|
||||
\@arrayparboxrestore
|
||||
\vrule \@height \ht\@arstrutbox \@width \z@}
|
||||
\def\LT@endpbox{%
|
||||
\@finalstrut\@arstrutbox
|
||||
\egroup
|
||||
\the\LT@p@ftn
|
||||
\global\LT@p@ftn{}%
|
||||
\hfil}
|
||||
%% added \long to prevent:
|
||||
% LaTeX Warning: Command \LT@p@ftntext has changed.
|
||||
%
|
||||
% from the original repository (https://github.com/latex3/latex2e/blob/develop/required/tools/longtable.dtx):
|
||||
% \changes{v4.15}{2021/03/28}
|
||||
% {make long for gh/364}
|
||||
% Inside the `p' column, just save up the footnote text in a token
|
||||
% register.
|
||||
\long\def\LT@p@ftntext#1{%
|
||||
\edef\@tempa{\the\LT@p@ftn\noexpand\footnotetext[\the\c@footnote]}%
|
||||
\global\LT@p@ftn\expandafter{\@tempa{#1}}}%
|
||||
|
||||
\@namedef{ver@longtable.sty}{2014/10/28 v4.11 Multi-page Table package (DPC) - frozen version for doxygen}
|
||||
\endinput
|
||||
%%
|
||||
%% End of file `longtable.sty'.
|
||||
2
docs/latex/mainpage_8md.tex
Normal file
2
docs/latex/mainpage_8md.tex
Normal file
@@ -0,0 +1,2 @@
|
||||
\doxysection{docs/static/mainpage.md File Reference}
|
||||
\hypertarget{mainpage_8md}{}\label{mainpage_8md}\index{docs/static/mainpage.md@{docs/static/mainpage.md}}
|
||||
9
docs/latex/namespacefourdst.tex
Normal file
9
docs/latex/namespacefourdst.tex
Normal file
@@ -0,0 +1,9 @@
|
||||
\doxysection{fourdst Namespace Reference}
|
||||
\hypertarget{namespacefourdst}{}\label{namespacefourdst}\index{fourdst@{fourdst}}
|
||||
\doxysubsubsection*{Namespaces}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
namespace \mbox{\hyperlink{namespacefourdst_1_1atomic}{atomic}}
|
||||
\begin{DoxyCompactList}\small\item\em Contains classes and functions related to atomic data, such as properties of atomic species. \end{DoxyCompactList}\item
|
||||
namespace \mbox{\hyperlink{namespacefourdst_1_1composition}{composition}}
|
||||
\end{DoxyCompactItemize}
|
||||
28663
docs/latex/namespacefourdst_1_1atomic.tex
Normal file
28663
docs/latex/namespacefourdst_1_1atomic.tex
Normal file
File diff suppressed because it is too large
Load Diff
80
docs/latex/namespacefourdst_1_1composition.tex
Normal file
80
docs/latex/namespacefourdst_1_1composition.tex
Normal file
@@ -0,0 +1,80 @@
|
||||
\doxysection{fourdst\+::composition Namespace Reference}
|
||||
\hypertarget{namespacefourdst_1_1composition}{}\label{namespacefourdst_1_1composition}\index{fourdst::composition@{fourdst::composition}}
|
||||
\doxysubsubsection*{Namespaces}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
namespace \mbox{\hyperlink{namespacefourdst_1_1composition_1_1exceptions}{exceptions}}
|
||||
\end{DoxyCompactItemize}
|
||||
\doxysubsubsection*{Classes}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
struct \mbox{\hyperlink{structfourdst_1_1composition_1_1_canonical_composition}{Canonical\+Composition}}
|
||||
\begin{DoxyCompactList}\small\item\em Represents the canonical (X, Y, Z) composition of stellar material. \end{DoxyCompactList}\item
|
||||
class \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition}{Composition}}
|
||||
\begin{DoxyCompactList}\small\item\em Manages a collection of chemical species and their abundances. \end{DoxyCompactList}\item
|
||||
struct \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry}{Composition\+Entry}}
|
||||
\begin{DoxyCompactList}\small\item\em Represents a single entry (an isotope) within a composition. \end{DoxyCompactList}\item
|
||||
struct \mbox{\hyperlink{structfourdst_1_1composition_1_1_global_composition}{Global\+Composition}}
|
||||
\begin{DoxyCompactList}\small\item\em Represents global properties of a finalized composition. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
\doxysubsubsection*{Functions}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
std\+::ostream \& \mbox{\hyperlink{namespacefourdst_1_1composition_a8468dde1b148c0583b8a9f85b8d0ce9a}{operator$<$$<$}} (std\+::ostream \&os, const \mbox{\hyperlink{structfourdst_1_1composition_1_1_global_composition}{Global\+Composition}} \&comp)
|
||||
\item
|
||||
std\+::ostream \& \mbox{\hyperlink{namespacefourdst_1_1composition_a676f771864958c4db4ed2a82cc0e85dd}{operator$<$$<$}} (std\+::ostream \&os, const \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry}{Composition\+Entry}} \&entry)
|
||||
\item
|
||||
std\+::ostream \& \mbox{\hyperlink{namespacefourdst_1_1composition_a5e8ccc2bd9e91eebcd3ef5fe470163a1}{operator$<$$<$}} (std\+::ostream \&os, const \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition}{Composition}} \&composition)
|
||||
\end{DoxyCompactItemize}
|
||||
|
||||
|
||||
\doxysubsection{Function Documentation}
|
||||
\Hypertarget{namespacefourdst_1_1composition_a5e8ccc2bd9e91eebcd3ef5fe470163a1}\index{fourdst::composition@{fourdst::composition}!operator$<$$<$@{operator$<$$<$}}
|
||||
\index{operator$<$$<$@{operator$<$$<$}!fourdst::composition@{fourdst::composition}}
|
||||
\doxysubsubsection{\texorpdfstring{operator$<$$<$()}{operator<<()}\hspace{0.1cm}{\footnotesize\ttfamily [1/3]}}
|
||||
{\footnotesize\ttfamily \label{namespacefourdst_1_1composition_a5e8ccc2bd9e91eebcd3ef5fe470163a1}
|
||||
std\+::ostream \& fourdst\+::composition\+::operator$<$$<$ (\begin{DoxyParamCaption}\item[{std\+::ostream \&}]{os}{, }\item[{const \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition}{Composition}} \&}]{composition}{}\end{DoxyParamCaption})}
|
||||
|
||||
|
||||
\begin{DoxyParams}{Parameters}
|
||||
{\em os} & The output stream. \\
|
||||
\hline
|
||||
{\em composition} & The \doxylink{classfourdst_1_1composition_1_1_composition}{Composition} to output. \\
|
||||
\hline
|
||||
\end{DoxyParams}
|
||||
\begin{DoxyReturn}{Returns}
|
||||
The output stream.
|
||||
\end{DoxyReturn}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{composition_8cpp_source_l00772}{772}} of file \mbox{\hyperlink{composition_8cpp_source}{composition.\+cpp}}.
|
||||
|
||||
\Hypertarget{namespacefourdst_1_1composition_a676f771864958c4db4ed2a82cc0e85dd}\index{fourdst::composition@{fourdst::composition}!operator$<$$<$@{operator$<$$<$}}
|
||||
\index{operator$<$$<$@{operator$<$$<$}!fourdst::composition@{fourdst::composition}}
|
||||
\doxysubsubsection{\texorpdfstring{operator$<$$<$()}{operator<<()}\hspace{0.1cm}{\footnotesize\ttfamily [2/3]}}
|
||||
{\footnotesize\ttfamily \label{namespacefourdst_1_1composition_a676f771864958c4db4ed2a82cc0e85dd}
|
||||
std\+::ostream \& fourdst\+::composition\+::operator$<$$<$ (\begin{DoxyParamCaption}\item[{std\+::ostream \&}]{os}{, }\item[{const \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry}{Composition\+Entry}} \&}]{entry}{}\end{DoxyParamCaption})}
|
||||
|
||||
|
||||
\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}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{composition_8cpp_source_l00767}{767}} of file \mbox{\hyperlink{composition_8cpp_source}{composition.\+cpp}}.
|
||||
|
||||
\Hypertarget{namespacefourdst_1_1composition_a8468dde1b148c0583b8a9f85b8d0ce9a}\index{fourdst::composition@{fourdst::composition}!operator$<$$<$@{operator$<$$<$}}
|
||||
\index{operator$<$$<$@{operator$<$$<$}!fourdst::composition@{fourdst::composition}}
|
||||
\doxysubsubsection{\texorpdfstring{operator$<$$<$()}{operator<<()}\hspace{0.1cm}{\footnotesize\ttfamily [3/3]}}
|
||||
{\footnotesize\ttfamily \label{namespacefourdst_1_1composition_a8468dde1b148c0583b8a9f85b8d0ce9a}
|
||||
std\+::ostream \& fourdst\+::composition\+::operator$<$$<$ (\begin{DoxyParamCaption}\item[{std\+::ostream \&}]{os}{, }\item[{const \mbox{\hyperlink{structfourdst_1_1composition_1_1_global_composition}{Global\+Composition}} \&}]{comp}{}\end{DoxyParamCaption})}
|
||||
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{composition_8cpp_source_l00760}{760}} of file \mbox{\hyperlink{composition_8cpp_source}{composition.\+cpp}}.
|
||||
|
||||
27
docs/latex/namespacefourdst_1_1composition_1_1exceptions.tex
Normal file
27
docs/latex/namespacefourdst_1_1composition_1_1exceptions.tex
Normal file
@@ -0,0 +1,27 @@
|
||||
\doxysection{fourdst\+::composition\+::exceptions Namespace Reference}
|
||||
\hypertarget{namespacefourdst_1_1composition_1_1exceptions}{}\label{namespacefourdst_1_1composition_1_1exceptions}\index{fourdst::composition::exceptions@{fourdst::composition::exceptions}}
|
||||
\doxysubsubsection*{Classes}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
class \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error}{Composition\+Entry\+Error}}
|
||||
\begin{DoxyCompactList}\small\item\em Base class for exceptions related to individual entries within a composition. \end{DoxyCompactList}\item
|
||||
class \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error}{Composition\+Error}}
|
||||
\begin{DoxyCompactList}\small\item\em Base class for exceptions related to composition objects. \end{DoxyCompactList}\item
|
||||
class \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_mode_error}{Composition\+Mode\+Error}}
|
||||
\begin{DoxyCompactList}\small\item\em Exception thrown due to a conflict in composition modes at the entry level. \end{DoxyCompactList}\item
|
||||
class \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_not_finalized_error}{Composition\+Not\+Finalized\+Error}}
|
||||
\begin{DoxyCompactList}\small\item\em Exception thrown when an operation is attempted on a composition that has not been finalized. \end{DoxyCompactList}\item
|
||||
class \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_entry_already_initialized_error}{Entry\+Already\+Initialized\+Error}}
|
||||
\begin{DoxyCompactList}\small\item\em Exception thrown when attempting to initialize a composition entry that has already been initialized. \end{DoxyCompactList}\item
|
||||
class \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_failed_to_finalize_composition_error}{Failed\+To\+Finalize\+Composition\+Error}}
|
||||
\begin{DoxyCompactList}\small\item\em Exception thrown when the finalization process of a composition fails. \end{DoxyCompactList}\item
|
||||
class \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_composition_error}{Invalid\+Composition\+Error}}
|
||||
\begin{DoxyCompactList}\small\item\em Exception thrown when a composition is in an invalid or inconsistent state. \end{DoxyCompactList}\item
|
||||
class \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_mixing_mode}{Invalid\+Mixing\+Mode}}
|
||||
\begin{DoxyCompactList}\small\item\em Exception thrown for an invalid or unsupported mixing mode. \end{DoxyCompactList}\item
|
||||
class \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_species_symbol_error}{Invalid\+Species\+Symbol\+Error}}
|
||||
\begin{DoxyCompactList}\small\item\em Exception thrown for an invalid chemical species symbol in a composition entry. \end{DoxyCompactList}\item
|
||||
class \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_symbol_error}{Invalid\+Symbol\+Error}}
|
||||
\begin{DoxyCompactList}\small\item\em Exception thrown when a symbol used in a composition is invalid. \end{DoxyCompactList}\item
|
||||
class \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_unregistered_symbol_error}{Unregistered\+Symbol\+Error}}
|
||||
\begin{DoxyCompactList}\small\item\em Exception thrown when a symbol is used that has not been registered. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
7
docs/latex/namespaces.tex
Normal file
7
docs/latex/namespaces.tex
Normal file
@@ -0,0 +1,7 @@
|
||||
\doxysection{Namespace List}
|
||||
Here is a list of all namespaces with brief descriptions\+:\begin{DoxyCompactList}
|
||||
\item\contentsline{section}{\mbox{\hyperlink{namespacefourdst}{fourdst}} }{\pageref{namespacefourdst}}{}
|
||||
\item\contentsline{section}{\mbox{\hyperlink{namespacefourdst_1_1atomic}{fourdst\+::atomic}} \\*Contains classes and functions related to atomic data, such as properties of atomic species }{\pageref{namespacefourdst_1_1atomic}}{}
|
||||
\item\contentsline{section}{\mbox{\hyperlink{namespacefourdst_1_1composition}{fourdst\+::composition}} }{\pageref{namespacefourdst_1_1composition}}{}
|
||||
\item\contentsline{section}{\mbox{\hyperlink{namespacefourdst_1_1composition_1_1exceptions}{fourdst\+::composition\+::exceptions}} }{\pageref{namespacefourdst_1_1composition_1_1exceptions}}{}
|
||||
\end{DoxyCompactList}
|
||||
289
docs/latex/refman.tex
Normal file
289
docs/latex/refman.tex
Normal file
@@ -0,0 +1,289 @@
|
||||
% Handle batch mode
|
||||
% to overcome problems with too many open files
|
||||
\let\mypdfximage\pdfximage\def\pdfximage{\immediate\mypdfximage}
|
||||
\RequirePackage{iftex}
|
||||
\ifLuaTeX
|
||||
\directlua{pdf.setminorversion(7)}
|
||||
\fi
|
||||
\ifXeTeX
|
||||
\special{pdf:minorversion 7}
|
||||
\fi
|
||||
\ifPDFTeX
|
||||
\pdfminorversion=7
|
||||
\fi
|
||||
% Set document class depending on configuration
|
||||
\documentclass[twoside]{book}
|
||||
%% moved from doxygen.sty due to workaround for LaTex 2019 version and unmaintained tabu package
|
||||
\usepackage{ifthen}
|
||||
\ifx\requestedLaTeXdate\undefined
|
||||
\usepackage{array}
|
||||
\else
|
||||
\usepackage{array}[=2016-10-06]
|
||||
\fi
|
||||
%%
|
||||
% Packages required by doxygen
|
||||
\makeatletter
|
||||
\providecommand\IfFormatAtLeastTF{\@ifl@t@r\fmtversion}
|
||||
% suppress package identification of infwarerr as it contains the word "warning"
|
||||
\let\@@protected@wlog\protected@wlog
|
||||
\def\protected@wlog#1{\wlog{package info suppressed}}
|
||||
\RequirePackage{infwarerr}
|
||||
\let\protected@wlog\@@protected@wlog
|
||||
\makeatother
|
||||
\IfFormatAtLeastTF{2016/01/01}{}{\usepackage{fixltx2e}} % for \textsubscript
|
||||
\ifPDFTeX
|
||||
\IfFormatAtLeastTF{2015/01/01}{\pdfsuppresswarningpagegroup=1}{}
|
||||
\fi
|
||||
\usepackage{doxygen}
|
||||
\usepackage{graphicx}
|
||||
\iftutex
|
||||
\usepackage{fontspec}
|
||||
\defaultfontfeatures{Ligatures={TeX}}
|
||||
\usepackage{unicode-math}
|
||||
\else
|
||||
\usepackage[utf8]{inputenc}
|
||||
\fi
|
||||
\usepackage{makeidx}
|
||||
\PassOptionsToPackage{warn}{textcomp}
|
||||
\usepackage{textcomp}
|
||||
\usepackage[nointegrals]{wasysym}
|
||||
\usepackage{ifxetex}
|
||||
% NLS support packages
|
||||
% Define default fonts
|
||||
% Font selection
|
||||
\iftutex
|
||||
\else
|
||||
\usepackage[T1]{fontenc}
|
||||
\fi
|
||||
% set main and monospaced font
|
||||
\usepackage[scaled=.90]{helvet}
|
||||
\usepackage{courier}
|
||||
\renewcommand{\familydefault}{\sfdefault}
|
||||
\doxyallsectionsfont{%
|
||||
\fontseries{bc}\selectfont%
|
||||
\color{darkgray}%
|
||||
}
|
||||
\renewcommand{\DoxyLabelFont}{%
|
||||
\fontseries{bc}\selectfont%
|
||||
\color{darkgray}%
|
||||
}
|
||||
\newcommand{\+}{\discretionary{\mbox{\scriptsize$\hookleftarrow$}}{}{}}
|
||||
% Arguments of doxygenemoji:
|
||||
% 1) ':<text>:' form of the emoji, already LaTeX-escaped
|
||||
% 2) file with the name of the emoji without the .png extension
|
||||
% in case image exist use this otherwise use the ':<text>:' form
|
||||
\newcommand{\doxygenemoji}[2]{%
|
||||
\IfFileExists{./#2.png}{\raisebox{-0.1em}{\includegraphics[height=0.9em]{./#2.png}}}{#1}%
|
||||
}
|
||||
% Page & text layout
|
||||
\usepackage{geometry}
|
||||
\geometry{%
|
||||
a4paper,%
|
||||
top=2.5cm,%
|
||||
bottom=2.5cm,%
|
||||
left=2.5cm,%
|
||||
right=2.5cm%
|
||||
}
|
||||
\usepackage{changepage}
|
||||
% Allow a bit of overflow to go unnoticed by other means
|
||||
\tolerance=750
|
||||
\hfuzz=15pt
|
||||
\hbadness=750
|
||||
\setlength{\emergencystretch}{15pt}
|
||||
\setlength{\parindent}{0cm}
|
||||
\newcommand{\doxynormalparskip}{\setlength{\parskip}{3ex plus 2ex minus 2ex}}
|
||||
\newcommand{\doxytocparskip}{\setlength{\parskip}{1ex plus 0ex minus 0ex}}
|
||||
\doxynormalparskip
|
||||
% Redefine paragraph/subparagraph environments, using sectsty fonts
|
||||
\makeatletter
|
||||
\renewcommand{\paragraph}{%
|
||||
\@startsection{paragraph}{4}{0ex}{-1.0ex}{1.0ex}{%
|
||||
\normalfont\normalsize\bfseries\SS@parafont%
|
||||
}%
|
||||
}
|
||||
\renewcommand{\subparagraph}{%
|
||||
\@startsection{subparagraph}{5}{0ex}{-1.0ex}{1.0ex}{%
|
||||
\normalfont\normalsize\bfseries\SS@subparafont%
|
||||
}%
|
||||
}
|
||||
\makeatother
|
||||
\makeatletter
|
||||
\newcommand\hrulefilll{\leavevmode\leaders\hrule\hskip 0pt plus 1filll\kern\z@}
|
||||
\makeatother
|
||||
% Headers & footers
|
||||
\usepackage{fancyhdr}
|
||||
\pagestyle{fancyplain}
|
||||
\renewcommand{\footrulewidth}{0.4pt}
|
||||
\fancypagestyle{fancyplain}{
|
||||
\fancyhf{}
|
||||
\fancyhead[LE, RO]{\bfseries\thepage}
|
||||
\fancyhead[LO]{\bfseries\rightmark}
|
||||
\fancyhead[RE]{\bfseries\leftmark}
|
||||
\fancyfoot[LO, RE]{\bfseries\scriptsize Generated by Doxygen }
|
||||
}
|
||||
\fancypagestyle{plain}{
|
||||
\fancyhf{}
|
||||
\fancyfoot[LO, RE]{\bfseries\scriptsize Generated by Doxygen }
|
||||
\renewcommand{\headrulewidth}{0pt}
|
||||
}
|
||||
\pagestyle{fancyplain}
|
||||
\renewcommand{\chaptermark}[1]{%
|
||||
\markboth{#1}{}%
|
||||
}
|
||||
\renewcommand{\sectionmark}[1]{%
|
||||
\markright{\thesection\ #1}%
|
||||
}
|
||||
% ToC, LoF, LoT, bibliography, and index
|
||||
% Indices & bibliography
|
||||
\usepackage[numbers]{natbib}
|
||||
\usepackage[titles]{tocloft}
|
||||
\setcounter{tocdepth}{3}
|
||||
\setcounter{secnumdepth}{5}
|
||||
% creating indexes
|
||||
\makeindex
|
||||
\ifPDFTeX
|
||||
\usepackage{newunicodechar}
|
||||
\makeatletter
|
||||
\def\doxynewunicodechar#1#2{%
|
||||
\@tempswafalse
|
||||
\edef\nuc@tempa{\detokenize{#1}}%
|
||||
\if\relax\nuc@tempa\relax
|
||||
\nuc@emptyargerr
|
||||
\else
|
||||
\edef\@tempb{\expandafter\@car\nuc@tempa\@nil}%
|
||||
\nuc@check
|
||||
\if@tempswa
|
||||
\@namedef{u8:\nuc@tempa}{#2}%
|
||||
\fi
|
||||
\fi
|
||||
}
|
||||
\makeatother
|
||||
\doxynewunicodechar{⁻}{${}^{-}$}% Superscript minus
|
||||
\doxynewunicodechar{²}{${}^{2}$}% Superscript two
|
||||
\doxynewunicodechar{³}{${}^{3}$}% Superscript three
|
||||
\fi
|
||||
% Hyperlinks
|
||||
% Hyperlinks (required, but should be loaded last)
|
||||
\ifPDFTeX
|
||||
\usepackage[pdftex,pagebackref=true]{hyperref}
|
||||
\else
|
||||
\ifXeTeX
|
||||
\usepackage[xetex,pagebackref=true]{hyperref}
|
||||
\else
|
||||
\ifLuaTeX
|
||||
\usepackage[luatex,pagebackref=true]{hyperref}
|
||||
\else
|
||||
\usepackage[ps2pdf,pagebackref=true]{hyperref}
|
||||
\fi
|
||||
\fi
|
||||
\fi
|
||||
\hypersetup{%
|
||||
colorlinks=true,%
|
||||
linkcolor=blue,%
|
||||
citecolor=blue,%
|
||||
unicode,%
|
||||
pdftitle={fourdst\+::libcomposition},%
|
||||
pdfsubject={Robust atomic species information library}%
|
||||
}
|
||||
% Custom commands used by the header
|
||||
% Custom commands
|
||||
\newcommand{\clearemptydoublepage}{%
|
||||
\newpage{\pagestyle{empty}\cleardoublepage}%
|
||||
}
|
||||
% caption style definition
|
||||
\usepackage{caption}
|
||||
\captionsetup{labelsep=space,justification=centering,font={bf},singlelinecheck=off,skip=4pt,position=top}
|
||||
% in page table of contents
|
||||
\IfFormatAtLeastTF{2023/05/01}{\usepackage[deeplevels]{etoc}}{\usepackage[deeplevels]{etoc_doxygen}}
|
||||
\etocsettocstyle{\doxytocparskip}{\doxynormalparskip}
|
||||
\etocsetlevel{subsubsubsection}{4}
|
||||
\etocsetlevel{subsubsubsubsection}{5}
|
||||
\etocsetlevel{subsubsubsubsubsection}{6}
|
||||
\etocsetlevel{subsubsubsubsubsubsection}{7}
|
||||
\etocsetlevel{paragraph}{8}
|
||||
\etocsetlevel{subparagraph}{9}
|
||||
% prevent numbers overlap the titles in toc
|
||||
\renewcommand{\numberline}[1]{#1~}
|
||||
% End of preamble, now comes the document contents
|
||||
%===== C O N T E N T S =====
|
||||
\begin{document}
|
||||
\raggedbottom
|
||||
% Titlepage & ToC
|
||||
% To avoid duplicate page anchors due to reuse of same numbers for
|
||||
% the index (be it as roman numbers)
|
||||
\hypersetup{pageanchor=false,
|
||||
bookmarksnumbered=true,
|
||||
pdfencoding=unicode
|
||||
}
|
||||
\pagenumbering{alph}
|
||||
\begin{titlepage}
|
||||
\vspace*{7cm}
|
||||
\begin{center}%
|
||||
{\Large fourdst\+::libcomposition}\\
|
||||
[1ex]\large v1.\+5.\+2 \\
|
||||
\vspace*{1cm}
|
||||
{\large Generated by Doxygen 1.13.2}\\
|
||||
\end{center}
|
||||
\end{titlepage}
|
||||
\clearemptydoublepage
|
||||
\pagenumbering{roman}
|
||||
\tableofcontents
|
||||
\clearemptydoublepage
|
||||
\pagenumbering{arabic}
|
||||
% re-enable anchors again
|
||||
\hypersetup{pageanchor=true}
|
||||
%--- Begin generated contents ---
|
||||
\input{index}
|
||||
\chapter{Namespace Index}
|
||||
\input{namespaces}
|
||||
\chapter{Hierarchical Index}
|
||||
\input{hierarchy}
|
||||
\chapter{Class Index}
|
||||
\input{annotated}
|
||||
\chapter{File Index}
|
||||
\input{files}
|
||||
\chapter{Namespace Documentation}
|
||||
\input{namespacefourdst}
|
||||
\input{namespacefourdst_1_1atomic}
|
||||
\input{namespacefourdst_1_1composition}
|
||||
\input{namespacefourdst_1_1composition_1_1exceptions}
|
||||
\chapter{Class Documentation}
|
||||
\input{structfourdst_1_1composition_1_1_canonical_composition}
|
||||
\input{classfourdst_1_1composition_1_1_composition}
|
||||
\input{structfourdst_1_1composition_1_1_composition_entry}
|
||||
\input{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error}
|
||||
\input{classfourdst_1_1composition_1_1exceptions_1_1_composition_error}
|
||||
\input{classfourdst_1_1composition_1_1exceptions_1_1_composition_mode_error}
|
||||
\input{classfourdst_1_1composition_1_1exceptions_1_1_composition_not_finalized_error}
|
||||
\input{classfourdst_1_1composition_1_1exceptions_1_1_entry_already_initialized_error}
|
||||
\input{classfourdst_1_1composition_1_1exceptions_1_1_failed_to_finalize_composition_error}
|
||||
\input{structfourdst_1_1composition_1_1_global_composition}
|
||||
\input{structstd_1_1hash_3_01fourdst_1_1atomic_1_1_species_01_4}
|
||||
\input{classfourdst_1_1composition_1_1exceptions_1_1_invalid_composition_error}
|
||||
\input{classfourdst_1_1composition_1_1exceptions_1_1_invalid_mixing_mode}
|
||||
\input{classfourdst_1_1composition_1_1exceptions_1_1_invalid_species_symbol_error}
|
||||
\input{classfourdst_1_1composition_1_1exceptions_1_1_invalid_symbol_error}
|
||||
\input{structfourdst_1_1atomic_1_1_species}
|
||||
\input{classfourdst_1_1composition_1_1exceptions_1_1_unregistered_symbol_error}
|
||||
\chapter{File Documentation}
|
||||
\input{mainpage_8md}
|
||||
\input{atomic_species_8h}
|
||||
\input{atomic_species_8h_source}
|
||||
\input{composition_8h}
|
||||
\input{composition_8h_source}
|
||||
\input{exceptions__composition_8h}
|
||||
\input{exceptions__composition_8h_source}
|
||||
\input{species_8h}
|
||||
\input{species_8h_source}
|
||||
\input{composition_8cpp}
|
||||
\input{composition_8cpp_source}
|
||||
%--- End generated contents ---
|
||||
% Index
|
||||
\backmatter
|
||||
\newpage
|
||||
\phantomsection
|
||||
\clearemptydoublepage
|
||||
\addcontentsline{toc}{chapter}{\indexname}
|
||||
\printindex
|
||||
% Required for some languages (in combination with latexdocumentpre from the header)
|
||||
\end{document}
|
||||
49840
docs/latex/species_8h.tex
Normal file
49840
docs/latex/species_8h.tex
Normal file
File diff suppressed because it is too large
Load Diff
17820
docs/latex/species_8h_source.tex
Normal file
17820
docs/latex/species_8h_source.tex
Normal file
File diff suppressed because it is too large
Load Diff
802
docs/latex/structfourdst_1_1atomic_1_1_species.tex
Normal file
802
docs/latex/structfourdst_1_1atomic_1_1_species.tex
Normal file
@@ -0,0 +1,802 @@
|
||||
\doxysection{fourdst\+::atomic\+::Species Struct Reference}
|
||||
\hypertarget{structfourdst_1_1atomic_1_1_species}{}\label{structfourdst_1_1atomic_1_1_species}\index{fourdst::atomic::Species@{fourdst::atomic::Species}}
|
||||
|
||||
|
||||
Represents an atomic species (isotope) with its fundamental physical properties.
|
||||
|
||||
|
||||
|
||||
|
||||
{\ttfamily \#include $<$atomic\+Species.\+h$>$}
|
||||
|
||||
\doxysubsubsection*{Public Member Functions}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a3756508a18b57a60f68f1b0cf58d303c}{Species}} (const std\+::string\+\_\+view \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a1fcc01fc978b34ba2531117f10be6741}{name}}, const std\+::string\+\_\+view \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a326c260a1b53deafcd04c21b2787f6c4}{el}}, const int \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_aa5e452accca3a9b4937867044617a032}{nz}}, const int \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a957734e413f07adf1d570885c480768d}{n}}, const int \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a1d50917a60a1adb2c9912193f214fab0}{z}}, const int \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_adc960c98d6e6051940d0a5c0d9a1183d}{a}}, const double \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_abeef75170cabef39fdaa6362780ddfc8}{binding\+Energy}}, const std\+::string\+\_\+view \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a57391049d534ffd1a4b4d6ed63d65ffc}{beta\+Code}}, const double \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a7d0e8a3b3d30fa56bdcc59577fa9ff73}{beta\+Decay\+Energy}}, const double half\+Life\+\_\+s, const std\+::string\+\_\+view \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_afcdd2f750d8cf206e3bcc507d57dabb1}{spin\+Parity}}, const std\+::string\+\_\+view \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_aad5094dfc8317db36468356bbc4a3e2f}{decay\+Modes}}, const double atomic\+Mass, const double atomic\+Mass\+Unc)
|
||||
\begin{DoxyCompactList}\small\item\em Constructs a \doxylink{structfourdst_1_1atomic_1_1_species}{Species} object with detailed properties. \end{DoxyCompactList}\item
|
||||
\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a873551c1ffbdcd6867ab0d1ed34ead0b}{Species}} (const \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{Species}} \&\mbox{\hyperlink{namespacefourdst_1_1atomic_a3f619cc8f8b2cd718a4082c6adb0de90}{species}})
|
||||
\begin{DoxyCompactList}\small\item\em Copy constructor for \doxylink{structfourdst_1_1atomic_1_1_species}{Species}. \end{DoxyCompactList}\item
|
||||
double \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_af5bdcc90ddafddfc027f94a98972eca3}{mass}} () const
|
||||
\begin{DoxyCompactList}\small\item\em Gets the atomic mass of the species. \end{DoxyCompactList}\item
|
||||
double \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_ac041c089469dc8d36548805c81492aca}{mass\+Unc}} () const
|
||||
\begin{DoxyCompactList}\small\item\em Gets the uncertainty in the atomic mass. \end{DoxyCompactList}\item
|
||||
double \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a34c4bb95e3c3e29087bc242d83aeefa1}{half\+Life}} () const
|
||||
\begin{DoxyCompactList}\small\item\em Gets the half-\/life of the species. \end{DoxyCompactList}\item
|
||||
std\+::string\+\_\+view \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_afcdd2f750d8cf206e3bcc507d57dabb1}{spin\+Parity}} () const
|
||||
\begin{DoxyCompactList}\small\item\em Gets the spin and parity as a string. \end{DoxyCompactList}\item
|
||||
std\+::string\+\_\+view \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_aad5094dfc8317db36468356bbc4a3e2f}{decay\+Modes}} () const
|
||||
\begin{DoxyCompactList}\small\item\em Gets the decay modes as a string. \end{DoxyCompactList}\item
|
||||
double \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_abeef75170cabef39fdaa6362780ddfc8}{binding\+Energy}} () const
|
||||
\begin{DoxyCompactList}\small\item\em Gets the binding energy of the species. \end{DoxyCompactList}\item
|
||||
double \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a7d0e8a3b3d30fa56bdcc59577fa9ff73}{beta\+Decay\+Energy}} () const
|
||||
\begin{DoxyCompactList}\small\item\em Gets the beta decay energy of the species. \end{DoxyCompactList}\item
|
||||
std\+::string\+\_\+view \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a57391049d534ffd1a4b4d6ed63d65ffc}{beta\+Code}} () const
|
||||
\begin{DoxyCompactList}\small\item\em Gets the beta decay code. \end{DoxyCompactList}\item
|
||||
std\+::string\+\_\+view \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a1fcc01fc978b34ba2531117f10be6741}{name}} () const
|
||||
\begin{DoxyCompactList}\small\item\em Gets the name of the species. \end{DoxyCompactList}\item
|
||||
std\+::string\+\_\+view \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a326c260a1b53deafcd04c21b2787f6c4}{el}} () const
|
||||
\begin{DoxyCompactList}\small\item\em Gets the element symbol of the species. \end{DoxyCompactList}\item
|
||||
int \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_aa5e452accca3a9b4937867044617a032}{nz}} () const
|
||||
\begin{DoxyCompactList}\small\item\em Gets the NZ identifier of the species. \end{DoxyCompactList}\item
|
||||
int \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a957734e413f07adf1d570885c480768d}{n}} () const
|
||||
\begin{DoxyCompactList}\small\item\em Gets the number of neutrons. \end{DoxyCompactList}\item
|
||||
int \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a1d50917a60a1adb2c9912193f214fab0}{z}} () const
|
||||
\begin{DoxyCompactList}\small\item\em Gets the atomic number (number of protons). \end{DoxyCompactList}\item
|
||||
int \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_adc960c98d6e6051940d0a5c0d9a1183d}{a}} () const
|
||||
\begin{DoxyCompactList}\small\item\em Gets the mass number. \end{DoxyCompactList}\item
|
||||
double \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a0e5d73c7c629cb08f254f2bc41f6ac4b}{spin}} () const
|
||||
\begin{DoxyCompactList}\small\item\em Gets the nuclear spin as a numeric value. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
\doxysubsubsection*{Public Attributes}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
std\+::string \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a4f782752e18e8972c66ee7168a06279d}{m\+\_\+name}}
|
||||
\begin{DoxyCompactList}\small\item\em Name of the species (e.\+g., "{}\+Fe56"{}). \end{DoxyCompactList}\item
|
||||
std\+::string \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a704e9d164033a89d610685c494fd53eb}{m\+\_\+el}}
|
||||
\begin{DoxyCompactList}\small\item\em Element symbol (e.\+g., "{}\+Fe"{}). \end{DoxyCompactList}\item
|
||||
int \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a50d5e1c96be4884ccfebde1eec79b6e8}{m\+\_\+nz}}
|
||||
\begin{DoxyCompactList}\small\item\em NZ identifier, typically 1000\texorpdfstring{$\ast$}{*}Z + A. \end{DoxyCompactList}\item
|
||||
int \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a8f0a4eb006c924bc006bb9eb6d3907ac}{m\+\_\+n}}
|
||||
\begin{DoxyCompactList}\small\item\em Number of neutrons. \end{DoxyCompactList}\item
|
||||
int \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_aae24c637c169f9f5eca03b6dcf8329e0}{m\+\_\+z}}
|
||||
\begin{DoxyCompactList}\small\item\em Atomic number (number of protons). \end{DoxyCompactList}\item
|
||||
int \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a6e7c5ab92da7ab867018da87a14ef3ef}{m\+\_\+a}}
|
||||
\begin{DoxyCompactList}\small\item\em Mass number (N + Z). \end{DoxyCompactList}\item
|
||||
double \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_acbb5b36d6892ee09e95d774eda235d3c}{m\+\_\+binding\+Energy}}
|
||||
\begin{DoxyCompactList}\small\item\em Binding energy in keV. \end{DoxyCompactList}\item
|
||||
std\+::string \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_abe9c5f69d657383e17dd49b41b7e4e15}{m\+\_\+beta\+Code}}
|
||||
\begin{DoxyCompactList}\small\item\em Beta decay code. \end{DoxyCompactList}\item
|
||||
double \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a0fc7e4b41662fe0a726dd962e9dbae9e}{m\+\_\+beta\+Decay\+Energy}}
|
||||
\begin{DoxyCompactList}\small\item\em Beta decay energy in keV. \end{DoxyCompactList}\item
|
||||
double \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_af76d148ab7be629601a389f5758238ee}{m\+\_\+half\+Life\+\_\+s}}
|
||||
\begin{DoxyCompactList}\small\item\em Half-\/life in seconds. A value of -\/1.\+0 typically indicates stability. \end{DoxyCompactList}\item
|
||||
std\+::string \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a874bc48272e4f091817bc25a72eebc2d}{m\+\_\+spin\+Parity}}
|
||||
\begin{DoxyCompactList}\small\item\em Spin and parity as a string (e.\+g., "{}1/2-\/"{}). \end{DoxyCompactList}\item
|
||||
std\+::string \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a545093f4fd3d9ad490a5bea84e950d35}{m\+\_\+decay\+Modes}}
|
||||
\begin{DoxyCompactList}\small\item\em Decay modes as a string. \end{DoxyCompactList}\item
|
||||
double \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_ab3e057d426e0d8dbf0134f92fda1c322}{m\+\_\+atomic\+Mass}}
|
||||
\begin{DoxyCompactList}\small\item\em Atomic mass in atomic mass units (u). \end{DoxyCompactList}\item
|
||||
double \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a4c6aa98435227f8257b93311a19c4adf}{m\+\_\+atomic\+Mass\+Unc}}
|
||||
\begin{DoxyCompactList}\small\item\em Uncertainty in the atomic mass. \end{DoxyCompactList}\item
|
||||
double \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_af1d73b936b428aaa29b37c119e3426e7}{m\+\_\+spin}} = 0.\+0
|
||||
\begin{DoxyCompactList}\small\item\em Nuclear spin as a double, derived from m\+\_\+spin\+Parity. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
\doxysubsubsection*{Friends}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
std\+::ostream \& \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_ad431f09aba3c2d8bafde06a459636965}{operator$<$$<$}} (std\+::ostream \&os, const \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{Species}} \&\mbox{\hyperlink{namespacefourdst_1_1atomic_a3f619cc8f8b2cd718a4082c6adb0de90}{species}})
|
||||
\begin{DoxyCompactList}\small\item\em Overloads the stream insertion operator for easy printing of a \doxylink{structfourdst_1_1atomic_1_1_species}{Species} object. \end{DoxyCompactList}\item
|
||||
bool \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a7864aa6e0ab9a953d657faf56cc921a1}{operator==}} (const \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{Species}} \&lhs, const \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{Species}} \&rhs)
|
||||
\begin{DoxyCompactList}\small\item\em Equality operator for \doxylink{structfourdst_1_1atomic_1_1_species}{Species}. Compares based on name. \end{DoxyCompactList}\item
|
||||
bool \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_ae1cc99d92a460877ec5bc28f13424c04}{operator!=}} (const \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{Species}} \&lhs, const \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{Species}} \&rhs)
|
||||
\begin{DoxyCompactList}\small\item\em Inequality operator for \doxylink{structfourdst_1_1atomic_1_1_species}{Species}. Compares based on name. \end{DoxyCompactList}\item
|
||||
bool \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_afc74eacd01f350dc20e2c7ec6a35c49b}{operator$<$}} (const \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{Species}} \&lhs, const \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{Species}} \&rhs)
|
||||
\begin{DoxyCompactList}\small\item\em Less-\/than operator for \doxylink{structfourdst_1_1atomic_1_1_species}{Species}. Compares based on atomic mass. \end{DoxyCompactList}\item
|
||||
bool \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_ab9503c9331c5746c283faa68a6ef3ef9}{operator$>$}} (const \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{Species}} \&lhs, const \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{Species}} \&rhs)
|
||||
\begin{DoxyCompactList}\small\item\em Greater-\/than operator for \doxylink{structfourdst_1_1atomic_1_1_species}{Species}. Compares based on atomic mass. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
|
||||
|
||||
\doxysubsection{Detailed Description}
|
||||
Represents an atomic species (isotope) with its fundamental physical properties.
|
||||
|
||||
This struct holds data parsed from nuclear data libraries, such as atomic mass, half-\/life, and spin. It is a fundamental data structure for representing the components of a material composition.
|
||||
|
||||
\begin{DoxyNote}{Note}
|
||||
This struct is designed to be lightweight and is primarily a data container.
|
||||
\end{DoxyNote}
|
||||
\begin{DoxyParagraph}{Usage Example}
|
||||
|
||||
\begin{DoxyCode}{0}
|
||||
\DoxyCodeLine{\textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{atomic_species_8h}{fourdst/composition/atomicSpecies.h}}"{}}}
|
||||
\DoxyCodeLine{\textcolor{preprocessor}{\#include\ <iostream>}}
|
||||
\DoxyCodeLine{}
|
||||
\DoxyCodeLine{\textcolor{keywordtype}{int}\ main()\ \{}
|
||||
\DoxyCodeLine{\ \ \ \ \textcolor{comment}{//\ Create\ a\ species\ for\ Deuterium\ (H-\/2)}}
|
||||
\DoxyCodeLine{\ \ \ \ fourdst::atomic::Species\ deuterium(}
|
||||
\DoxyCodeLine{\ \ \ \ \ \ \ \ \textcolor{stringliteral}{"{}H2"{}},\ \textcolor{stringliteral}{"{}H"{}},\ 1002,\ 1,\ 1,\ 2,\ 2224.52,\ \textcolor{stringliteral}{"{}"{}},\ 0.0,\ -\/1.0,\ \textcolor{stringliteral}{"{}1+"{}},\ \textcolor{stringliteral}{"{}"{}},\ 2.0141017781,\ 4.0e-\/11}
|
||||
\DoxyCodeLine{\ \ \ \ );}
|
||||
\DoxyCodeLine{}
|
||||
\DoxyCodeLine{\ \ \ \ std::cout\ <<\ \textcolor{stringliteral}{"{}Species:\ "{}}\ <<\ deuterium.name()\ <<\ std::endl;}
|
||||
\DoxyCodeLine{\ \ \ \ std::cout\ <<\ \textcolor{stringliteral}{"{}Atomic\ Mass:\ "{}}\ <<\ deuterium.mass()\ <<\ \textcolor{stringliteral}{"{}\ u"{}}\ <<\ std::endl;}
|
||||
\DoxyCodeLine{\ \ \ \ std::cout\ <<\ \textcolor{stringliteral}{"{}Spin:\ "{}}\ <<\ deuterium.spin()\ <<\ std::endl;}
|
||||
\DoxyCodeLine{}
|
||||
\DoxyCodeLine{\ \ \ \ \textcolor{keywordflow}{return}\ 0;}
|
||||
\DoxyCodeLine{\}}
|
||||
|
||||
\end{DoxyCode}
|
||||
|
||||
\end{DoxyParagraph}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00048}{48}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
|
||||
|
||||
|
||||
\doxysubsection{Constructor \& Destructor Documentation}
|
||||
\Hypertarget{structfourdst_1_1atomic_1_1_species_a3756508a18b57a60f68f1b0cf58d303c}\index{fourdst::atomic::Species@{fourdst::atomic::Species}!Species@{Species}}
|
||||
\index{Species@{Species}!fourdst::atomic::Species@{fourdst::atomic::Species}}
|
||||
\doxysubsubsection{\texorpdfstring{Species()}{Species()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
|
||||
{\footnotesize\ttfamily \label{structfourdst_1_1atomic_1_1_species_a3756508a18b57a60f68f1b0cf58d303c}
|
||||
fourdst\+::atomic\+::\+Species\+::\+Species (\begin{DoxyParamCaption}\item[{const std\+::string\+\_\+view}]{name}{, }\item[{const std\+::string\+\_\+view}]{el}{, }\item[{const int}]{nz}{, }\item[{const int}]{n}{, }\item[{const int}]{z}{, }\item[{const int}]{a}{, }\item[{const double}]{binding\+Energy}{, }\item[{const std\+::string\+\_\+view}]{beta\+Code}{, }\item[{const double}]{beta\+Decay\+Energy}{, }\item[{const double}]{half\+Life\+\_\+s}{, }\item[{const std\+::string\+\_\+view}]{spin\+Parity}{, }\item[{const std\+::string\+\_\+view}]{decay\+Modes}{, }\item[{const double}]{atomic\+Mass}{, }\item[{const double}]{atomic\+Mass\+Unc}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
||||
|
||||
|
||||
|
||||
Constructs a \doxylink{structfourdst_1_1atomic_1_1_species}{Species} object with detailed properties.
|
||||
|
||||
|
||||
\begin{DoxyParams}{Parameters}
|
||||
{\em name} & Name of the species. \\
|
||||
\hline
|
||||
{\em el} & Element symbol. \\
|
||||
\hline
|
||||
{\em nz} & NZ identifier. \\
|
||||
\hline
|
||||
{\em n} & Number of neutrons. \\
|
||||
\hline
|
||||
{\em z} & Atomic number. \\
|
||||
\hline
|
||||
{\em a} & Mass number. \\
|
||||
\hline
|
||||
{\em binding\+Energy} & Binding energy. \\
|
||||
\hline
|
||||
{\em beta\+Code} & Beta decay code. \\
|
||||
\hline
|
||||
{\em beta\+Decay\+Energy} & Beta decay energy. \\
|
||||
\hline
|
||||
{\em half\+Life\+\_\+s} & Half-\/life in seconds. \\
|
||||
\hline
|
||||
{\em spin\+Parity} & Spin and parity string. \\
|
||||
\hline
|
||||
{\em decay\+Modes} & Decay modes string. \\
|
||||
\hline
|
||||
{\em atomic\+Mass} & Atomic mass. \\
|
||||
\hline
|
||||
{\em atomic\+Mass\+Unc} & Atomic mass uncertainty.\\
|
||||
\hline
|
||||
\end{DoxyParams}
|
||||
\begin{DoxyPostcond}{Postcondition}
|
||||
The {\ttfamily m\+\_\+spin} member is initialized by parsing {\ttfamily m\+\_\+spin\+Parity} using {\ttfamily convert\+\_\+jpi\+\_\+to\+\_\+double}.
|
||||
\end{DoxyPostcond}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00085}{85}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
|
||||
\Hypertarget{structfourdst_1_1atomic_1_1_species_a873551c1ffbdcd6867ab0d1ed34ead0b}\index{fourdst::atomic::Species@{fourdst::atomic::Species}!Species@{Species}}
|
||||
\index{Species@{Species}!fourdst::atomic::Species@{fourdst::atomic::Species}}
|
||||
\doxysubsubsection{\texorpdfstring{Species()}{Species()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
|
||||
{\footnotesize\ttfamily \label{structfourdst_1_1atomic_1_1_species_a873551c1ffbdcd6867ab0d1ed34ead0b}
|
||||
fourdst\+::atomic\+::\+Species\+::\+Species (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{Species}} \&}]{species}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
||||
|
||||
|
||||
|
||||
Copy constructor for \doxylink{structfourdst_1_1atomic_1_1_species}{Species}.
|
||||
|
||||
|
||||
\begin{DoxyParams}{Parameters}
|
||||
{\em species} & The \doxylink{structfourdst_1_1atomic_1_1_species}{Species} object to copy. \\
|
||||
\hline
|
||||
\end{DoxyParams}
|
||||
\begin{DoxyPostcond}{Postcondition}
|
||||
A new \doxylink{structfourdst_1_1atomic_1_1_species}{Species} object is created as a deep copy of {\ttfamily species}. The {\ttfamily m\+\_\+spin} member is re-\/calculated.
|
||||
\end{DoxyPostcond}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00123}{123}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
|
||||
|
||||
|
||||
\doxysubsection{Member Function Documentation}
|
||||
\Hypertarget{structfourdst_1_1atomic_1_1_species_adc960c98d6e6051940d0a5c0d9a1183d}\index{fourdst::atomic::Species@{fourdst::atomic::Species}!a@{a}}
|
||||
\index{a@{a}!fourdst::atomic::Species@{fourdst::atomic::Species}}
|
||||
\doxysubsubsection{\texorpdfstring{a()}{a()}}
|
||||
{\footnotesize\ttfamily \label{structfourdst_1_1atomic_1_1_species_adc960c98d6e6051940d0a5c0d9a1183d}
|
||||
int fourdst\+::atomic\+::\+Species\+::a (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [nodiscard]}}
|
||||
|
||||
|
||||
|
||||
Gets the mass number.
|
||||
|
||||
\begin{DoxyReturn}{Returns}
|
||||
The mass number (A = N + Z).
|
||||
\end{DoxyReturn}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00250}{250}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
|
||||
\Hypertarget{structfourdst_1_1atomic_1_1_species_a57391049d534ffd1a4b4d6ed63d65ffc}\index{fourdst::atomic::Species@{fourdst::atomic::Species}!betaCode@{betaCode}}
|
||||
\index{betaCode@{betaCode}!fourdst::atomic::Species@{fourdst::atomic::Species}}
|
||||
\doxysubsubsection{\texorpdfstring{betaCode()}{betaCode()}}
|
||||
{\footnotesize\ttfamily \label{structfourdst_1_1atomic_1_1_species_a57391049d534ffd1a4b4d6ed63d65ffc}
|
||||
std\+::string\+\_\+view fourdst\+::atomic\+::\+Species\+::beta\+Code (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [nodiscard]}}
|
||||
|
||||
|
||||
|
||||
Gets the beta decay code.
|
||||
|
||||
\begin{DoxyReturn}{Returns}
|
||||
A string\+\_\+view of the beta decay code.
|
||||
\end{DoxyReturn}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00202}{202}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
|
||||
\Hypertarget{structfourdst_1_1atomic_1_1_species_a7d0e8a3b3d30fa56bdcc59577fa9ff73}\index{fourdst::atomic::Species@{fourdst::atomic::Species}!betaDecayEnergy@{betaDecayEnergy}}
|
||||
\index{betaDecayEnergy@{betaDecayEnergy}!fourdst::atomic::Species@{fourdst::atomic::Species}}
|
||||
\doxysubsubsection{\texorpdfstring{betaDecayEnergy()}{betaDecayEnergy()}}
|
||||
{\footnotesize\ttfamily \label{structfourdst_1_1atomic_1_1_species_a7d0e8a3b3d30fa56bdcc59577fa9ff73}
|
||||
double fourdst\+::atomic\+::\+Species\+::beta\+Decay\+Energy (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [nodiscard]}}
|
||||
|
||||
|
||||
|
||||
Gets the beta decay energy of the species.
|
||||
|
||||
\begin{DoxyReturn}{Returns}
|
||||
The beta decay energy in keV.
|
||||
\end{DoxyReturn}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00194}{194}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
|
||||
\Hypertarget{structfourdst_1_1atomic_1_1_species_abeef75170cabef39fdaa6362780ddfc8}\index{fourdst::atomic::Species@{fourdst::atomic::Species}!bindingEnergy@{bindingEnergy}}
|
||||
\index{bindingEnergy@{bindingEnergy}!fourdst::atomic::Species@{fourdst::atomic::Species}}
|
||||
\doxysubsubsection{\texorpdfstring{bindingEnergy()}{bindingEnergy()}}
|
||||
{\footnotesize\ttfamily \label{structfourdst_1_1atomic_1_1_species_abeef75170cabef39fdaa6362780ddfc8}
|
||||
double fourdst\+::atomic\+::\+Species\+::binding\+Energy (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [nodiscard]}}
|
||||
|
||||
|
||||
|
||||
Gets the binding energy of the species.
|
||||
|
||||
\begin{DoxyReturn}{Returns}
|
||||
The binding energy in keV.
|
||||
\end{DoxyReturn}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00186}{186}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
|
||||
\Hypertarget{structfourdst_1_1atomic_1_1_species_aad5094dfc8317db36468356bbc4a3e2f}\index{fourdst::atomic::Species@{fourdst::atomic::Species}!decayModes@{decayModes}}
|
||||
\index{decayModes@{decayModes}!fourdst::atomic::Species@{fourdst::atomic::Species}}
|
||||
\doxysubsubsection{\texorpdfstring{decayModes()}{decayModes()}}
|
||||
{\footnotesize\ttfamily \label{structfourdst_1_1atomic_1_1_species_aad5094dfc8317db36468356bbc4a3e2f}
|
||||
std\+::string\+\_\+view fourdst\+::atomic\+::\+Species\+::decay\+Modes (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [nodiscard]}}
|
||||
|
||||
|
||||
|
||||
Gets the decay modes as a string.
|
||||
|
||||
\begin{DoxyReturn}{Returns}
|
||||
A string\+\_\+view of the decay modes.
|
||||
\end{DoxyReturn}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00178}{178}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
|
||||
\Hypertarget{structfourdst_1_1atomic_1_1_species_a326c260a1b53deafcd04c21b2787f6c4}\index{fourdst::atomic::Species@{fourdst::atomic::Species}!el@{el}}
|
||||
\index{el@{el}!fourdst::atomic::Species@{fourdst::atomic::Species}}
|
||||
\doxysubsubsection{\texorpdfstring{el()}{el()}}
|
||||
{\footnotesize\ttfamily \label{structfourdst_1_1atomic_1_1_species_a326c260a1b53deafcd04c21b2787f6c4}
|
||||
std\+::string\+\_\+view fourdst\+::atomic\+::\+Species\+::el (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [nodiscard]}}
|
||||
|
||||
|
||||
|
||||
Gets the element symbol of the species.
|
||||
|
||||
\begin{DoxyReturn}{Returns}
|
||||
A string\+\_\+view of the element symbol (e.\+g., "{}\+Fe"{}).
|
||||
\end{DoxyReturn}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00218}{218}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
|
||||
\Hypertarget{structfourdst_1_1atomic_1_1_species_a34c4bb95e3c3e29087bc242d83aeefa1}\index{fourdst::atomic::Species@{fourdst::atomic::Species}!halfLife@{halfLife}}
|
||||
\index{halfLife@{halfLife}!fourdst::atomic::Species@{fourdst::atomic::Species}}
|
||||
\doxysubsubsection{\texorpdfstring{halfLife()}{halfLife()}}
|
||||
{\footnotesize\ttfamily \label{structfourdst_1_1atomic_1_1_species_a34c4bb95e3c3e29087bc242d83aeefa1}
|
||||
double fourdst\+::atomic\+::\+Species\+::half\+Life (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [nodiscard]}}
|
||||
|
||||
|
||||
|
||||
Gets the half-\/life of the species.
|
||||
|
||||
\begin{DoxyReturn}{Returns}
|
||||
The half-\/life in seconds.
|
||||
\end{DoxyReturn}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00162}{162}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
|
||||
\Hypertarget{structfourdst_1_1atomic_1_1_species_af5bdcc90ddafddfc027f94a98972eca3}\index{fourdst::atomic::Species@{fourdst::atomic::Species}!mass@{mass}}
|
||||
\index{mass@{mass}!fourdst::atomic::Species@{fourdst::atomic::Species}}
|
||||
\doxysubsubsection{\texorpdfstring{mass()}{mass()}}
|
||||
{\footnotesize\ttfamily \label{structfourdst_1_1atomic_1_1_species_af5bdcc90ddafddfc027f94a98972eca3}
|
||||
double fourdst\+::atomic\+::\+Species\+::mass (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [nodiscard]}}
|
||||
|
||||
|
||||
|
||||
Gets the atomic mass of the species.
|
||||
|
||||
\begin{DoxyReturn}{Returns}
|
||||
The atomic mass in atomic mass units (u).
|
||||
\end{DoxyReturn}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00146}{146}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
|
||||
\Hypertarget{structfourdst_1_1atomic_1_1_species_ac041c089469dc8d36548805c81492aca}\index{fourdst::atomic::Species@{fourdst::atomic::Species}!massUnc@{massUnc}}
|
||||
\index{massUnc@{massUnc}!fourdst::atomic::Species@{fourdst::atomic::Species}}
|
||||
\doxysubsubsection{\texorpdfstring{massUnc()}{massUnc()}}
|
||||
{\footnotesize\ttfamily \label{structfourdst_1_1atomic_1_1_species_ac041c089469dc8d36548805c81492aca}
|
||||
double fourdst\+::atomic\+::\+Species\+::mass\+Unc (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [nodiscard]}}
|
||||
|
||||
|
||||
|
||||
Gets the uncertainty in the atomic mass.
|
||||
|
||||
\begin{DoxyReturn}{Returns}
|
||||
The atomic mass uncertainty.
|
||||
\end{DoxyReturn}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00154}{154}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
|
||||
\Hypertarget{structfourdst_1_1atomic_1_1_species_a957734e413f07adf1d570885c480768d}\index{fourdst::atomic::Species@{fourdst::atomic::Species}!n@{n}}
|
||||
\index{n@{n}!fourdst::atomic::Species@{fourdst::atomic::Species}}
|
||||
\doxysubsubsection{\texorpdfstring{n()}{n()}}
|
||||
{\footnotesize\ttfamily \label{structfourdst_1_1atomic_1_1_species_a957734e413f07adf1d570885c480768d}
|
||||
int fourdst\+::atomic\+::\+Species\+::n (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [nodiscard]}}
|
||||
|
||||
|
||||
|
||||
Gets the number of neutrons.
|
||||
|
||||
\begin{DoxyReturn}{Returns}
|
||||
The number of neutrons (N).
|
||||
\end{DoxyReturn}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00234}{234}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
|
||||
\Hypertarget{structfourdst_1_1atomic_1_1_species_a1fcc01fc978b34ba2531117f10be6741}\index{fourdst::atomic::Species@{fourdst::atomic::Species}!name@{name}}
|
||||
\index{name@{name}!fourdst::atomic::Species@{fourdst::atomic::Species}}
|
||||
\doxysubsubsection{\texorpdfstring{name()}{name()}}
|
||||
{\footnotesize\ttfamily \label{structfourdst_1_1atomic_1_1_species_a1fcc01fc978b34ba2531117f10be6741}
|
||||
std\+::string\+\_\+view fourdst\+::atomic\+::\+Species\+::name (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [nodiscard]}}
|
||||
|
||||
|
||||
|
||||
Gets the name of the species.
|
||||
|
||||
\begin{DoxyReturn}{Returns}
|
||||
A string\+\_\+view of the species name (e.\+g., "{}\+Fe56"{}).
|
||||
\end{DoxyReturn}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00210}{210}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
|
||||
\Hypertarget{structfourdst_1_1atomic_1_1_species_aa5e452accca3a9b4937867044617a032}\index{fourdst::atomic::Species@{fourdst::atomic::Species}!nz@{nz}}
|
||||
\index{nz@{nz}!fourdst::atomic::Species@{fourdst::atomic::Species}}
|
||||
\doxysubsubsection{\texorpdfstring{nz()}{nz()}}
|
||||
{\footnotesize\ttfamily \label{structfourdst_1_1atomic_1_1_species_aa5e452accca3a9b4937867044617a032}
|
||||
int fourdst\+::atomic\+::\+Species\+::nz (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [nodiscard]}}
|
||||
|
||||
|
||||
|
||||
Gets the NZ identifier of the species.
|
||||
|
||||
\begin{DoxyReturn}{Returns}
|
||||
The NZ identifier (1000\texorpdfstring{$\ast$}{*}Z + A).
|
||||
\end{DoxyReturn}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00226}{226}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
|
||||
\Hypertarget{structfourdst_1_1atomic_1_1_species_a0e5d73c7c629cb08f254f2bc41f6ac4b}\index{fourdst::atomic::Species@{fourdst::atomic::Species}!spin@{spin}}
|
||||
\index{spin@{spin}!fourdst::atomic::Species@{fourdst::atomic::Species}}
|
||||
\doxysubsubsection{\texorpdfstring{spin()}{spin()}}
|
||||
{\footnotesize\ttfamily \label{structfourdst_1_1atomic_1_1_species_a0e5d73c7c629cb08f254f2bc41f6ac4b}
|
||||
double fourdst\+::atomic\+::\+Species\+::spin (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [nodiscard]}}
|
||||
|
||||
|
||||
|
||||
Gets the nuclear spin as a numeric value.
|
||||
|
||||
\begin{DoxyReturn}{Returns}
|
||||
The spin as a double.
|
||||
\end{DoxyReturn}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00258}{258}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
|
||||
\Hypertarget{structfourdst_1_1atomic_1_1_species_afcdd2f750d8cf206e3bcc507d57dabb1}\index{fourdst::atomic::Species@{fourdst::atomic::Species}!spinParity@{spinParity}}
|
||||
\index{spinParity@{spinParity}!fourdst::atomic::Species@{fourdst::atomic::Species}}
|
||||
\doxysubsubsection{\texorpdfstring{spinParity()}{spinParity()}}
|
||||
{\footnotesize\ttfamily \label{structfourdst_1_1atomic_1_1_species_afcdd2f750d8cf206e3bcc507d57dabb1}
|
||||
std\+::string\+\_\+view fourdst\+::atomic\+::\+Species\+::spin\+Parity (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [nodiscard]}}
|
||||
|
||||
|
||||
|
||||
Gets the spin and parity as a string.
|
||||
|
||||
\begin{DoxyReturn}{Returns}
|
||||
A string\+\_\+view of the spin and parity (e.\+g., "{}1/2+"{}).
|
||||
\end{DoxyReturn}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00170}{170}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
|
||||
\Hypertarget{structfourdst_1_1atomic_1_1_species_a1d50917a60a1adb2c9912193f214fab0}\index{fourdst::atomic::Species@{fourdst::atomic::Species}!z@{z}}
|
||||
\index{z@{z}!fourdst::atomic::Species@{fourdst::atomic::Species}}
|
||||
\doxysubsubsection{\texorpdfstring{z()}{z()}}
|
||||
{\footnotesize\ttfamily \label{structfourdst_1_1atomic_1_1_species_a1d50917a60a1adb2c9912193f214fab0}
|
||||
int fourdst\+::atomic\+::\+Species\+::z (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [nodiscard]}}
|
||||
|
||||
|
||||
|
||||
Gets the atomic number (number of protons).
|
||||
|
||||
\begin{DoxyReturn}{Returns}
|
||||
The atomic number (Z).
|
||||
\end{DoxyReturn}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00242}{242}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
|
||||
|
||||
|
||||
\doxysubsection{Friends And Related Symbol Documentation}
|
||||
\Hypertarget{structfourdst_1_1atomic_1_1_species_ae1cc99d92a460877ec5bc28f13424c04}\index{fourdst::atomic::Species@{fourdst::atomic::Species}!operator"!=@{operator"!=}}
|
||||
\index{operator"!=@{operator"!=}!fourdst::atomic::Species@{fourdst::atomic::Species}}
|
||||
\doxysubsubsection{\texorpdfstring{operator"!=}{operator!=}}
|
||||
{\footnotesize\ttfamily \label{structfourdst_1_1atomic_1_1_species_ae1cc99d92a460877ec5bc28f13424c04}
|
||||
bool operator!= (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{Species}} \&}]{lhs}{, }\item[{const \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{Species}} \&}]{rhs}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [friend]}}
|
||||
|
||||
|
||||
|
||||
Inequality operator for \doxylink{structfourdst_1_1atomic_1_1_species}{Species}. Compares based on name.
|
||||
|
||||
|
||||
\begin{DoxyParams}{Parameters}
|
||||
{\em lhs} & The left-\/hand side \doxylink{structfourdst_1_1atomic_1_1_species}{Species}. \\
|
||||
\hline
|
||||
{\em rhs} & The right-\/hand side \doxylink{structfourdst_1_1atomic_1_1_species}{Species}. \\
|
||||
\hline
|
||||
\end{DoxyParams}
|
||||
\begin{DoxyReturn}{Returns}
|
||||
{\ttfamily true} if the names are different, {\ttfamily false} otherwise.
|
||||
\end{DoxyReturn}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00293}{293}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
|
||||
\Hypertarget{structfourdst_1_1atomic_1_1_species_afc74eacd01f350dc20e2c7ec6a35c49b}\index{fourdst::atomic::Species@{fourdst::atomic::Species}!operator$<$@{operator$<$}}
|
||||
\index{operator$<$@{operator$<$}!fourdst::atomic::Species@{fourdst::atomic::Species}}
|
||||
\doxysubsubsection{\texorpdfstring{operator$<$}{operator<}}
|
||||
{\footnotesize\ttfamily \label{structfourdst_1_1atomic_1_1_species_afc74eacd01f350dc20e2c7ec6a35c49b}
|
||||
bool operator$<$ (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{Species}} \&}]{lhs}{, }\item[{const \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{Species}} \&}]{rhs}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [friend]}}
|
||||
|
||||
|
||||
|
||||
Less-\/than operator for \doxylink{structfourdst_1_1atomic_1_1_species}{Species}. Compares based on atomic mass.
|
||||
|
||||
|
||||
\begin{DoxyParams}{Parameters}
|
||||
{\em lhs} & The left-\/hand side \doxylink{structfourdst_1_1atomic_1_1_species}{Species}. \\
|
||||
\hline
|
||||
{\em rhs} & The right-\/hand side \doxylink{structfourdst_1_1atomic_1_1_species}{Species}. \\
|
||||
\hline
|
||||
\end{DoxyParams}
|
||||
\begin{DoxyReturn}{Returns}
|
||||
{\ttfamily true} if lhs atomic mass is less than rhs atomic mass, {\ttfamily false} otherwise.
|
||||
\end{DoxyReturn}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00302}{302}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
|
||||
\Hypertarget{structfourdst_1_1atomic_1_1_species_ad431f09aba3c2d8bafde06a459636965}\index{fourdst::atomic::Species@{fourdst::atomic::Species}!operator$<$$<$@{operator$<$$<$}}
|
||||
\index{operator$<$$<$@{operator$<$$<$}!fourdst::atomic::Species@{fourdst::atomic::Species}}
|
||||
\doxysubsubsection{\texorpdfstring{operator$<$$<$}{operator<<}}
|
||||
{\footnotesize\ttfamily \label{structfourdst_1_1atomic_1_1_species_ad431f09aba3c2d8bafde06a459636965}
|
||||
std\+::ostream \& operator$<$$<$ (\begin{DoxyParamCaption}\item[{std\+::ostream \&}]{os}{, }\item[{const \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{Species}} \&}]{species}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [friend]}}
|
||||
|
||||
|
||||
|
||||
Overloads the stream insertion operator for easy printing of a \doxylink{structfourdst_1_1atomic_1_1_species}{Species} object.
|
||||
|
||||
|
||||
\begin{DoxyParams}{Parameters}
|
||||
{\em os} & The output stream. \\
|
||||
\hline
|
||||
{\em species} & The \doxylink{structfourdst_1_1atomic_1_1_species}{Species} object to print. \\
|
||||
\hline
|
||||
\end{DoxyParams}
|
||||
\begin{DoxyReturn}{Returns}
|
||||
The output stream with the species name.
|
||||
\end{DoxyReturn}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00268}{268}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
|
||||
\Hypertarget{structfourdst_1_1atomic_1_1_species_a7864aa6e0ab9a953d657faf56cc921a1}\index{fourdst::atomic::Species@{fourdst::atomic::Species}!operator==@{operator==}}
|
||||
\index{operator==@{operator==}!fourdst::atomic::Species@{fourdst::atomic::Species}}
|
||||
\doxysubsubsection{\texorpdfstring{operator==}{operator==}}
|
||||
{\footnotesize\ttfamily \label{structfourdst_1_1atomic_1_1_species_a7864aa6e0ab9a953d657faf56cc921a1}
|
||||
bool operator== (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{Species}} \&}]{lhs}{, }\item[{const \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{Species}} \&}]{rhs}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [friend]}}
|
||||
|
||||
|
||||
|
||||
Equality operator for \doxylink{structfourdst_1_1atomic_1_1_species}{Species}. Compares based on name.
|
||||
|
||||
|
||||
\begin{DoxyParams}{Parameters}
|
||||
{\em lhs} & The left-\/hand side \doxylink{structfourdst_1_1atomic_1_1_species}{Species}. \\
|
||||
\hline
|
||||
{\em rhs} & The right-\/hand side \doxylink{structfourdst_1_1atomic_1_1_species}{Species}. \\
|
||||
\hline
|
||||
\end{DoxyParams}
|
||||
\begin{DoxyReturn}{Returns}
|
||||
{\ttfamily true} if the names are identical, {\ttfamily false} otherwise.
|
||||
\end{DoxyReturn}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00284}{284}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
|
||||
\Hypertarget{structfourdst_1_1atomic_1_1_species_ab9503c9331c5746c283faa68a6ef3ef9}\index{fourdst::atomic::Species@{fourdst::atomic::Species}!operator$>$@{operator$>$}}
|
||||
\index{operator$>$@{operator$>$}!fourdst::atomic::Species@{fourdst::atomic::Species}}
|
||||
\doxysubsubsection{\texorpdfstring{operator$>$}{operator>}}
|
||||
{\footnotesize\ttfamily \label{structfourdst_1_1atomic_1_1_species_ab9503c9331c5746c283faa68a6ef3ef9}
|
||||
bool operator$>$ (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{Species}} \&}]{lhs}{, }\item[{const \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{Species}} \&}]{rhs}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [friend]}}
|
||||
|
||||
|
||||
|
||||
Greater-\/than operator for \doxylink{structfourdst_1_1atomic_1_1_species}{Species}. Compares based on atomic mass.
|
||||
|
||||
|
||||
\begin{DoxyParams}{Parameters}
|
||||
{\em lhs} & The left-\/hand side \doxylink{structfourdst_1_1atomic_1_1_species}{Species}. \\
|
||||
\hline
|
||||
{\em rhs} & The right-\/hand side \doxylink{structfourdst_1_1atomic_1_1_species}{Species}. \\
|
||||
\hline
|
||||
\end{DoxyParams}
|
||||
\begin{DoxyReturn}{Returns}
|
||||
{\ttfamily true} if lhs atomic mass is greater than rhs atomic mass, {\ttfamily false} otherwise.
|
||||
\end{DoxyReturn}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00311}{311}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
|
||||
|
||||
|
||||
\doxysubsection{Member Data Documentation}
|
||||
\Hypertarget{structfourdst_1_1atomic_1_1_species_a6e7c5ab92da7ab867018da87a14ef3ef}\index{fourdst::atomic::Species@{fourdst::atomic::Species}!m\_a@{m\_a}}
|
||||
\index{m\_a@{m\_a}!fourdst::atomic::Species@{fourdst::atomic::Species}}
|
||||
\doxysubsubsection{\texorpdfstring{m\_a}{m\_a}}
|
||||
{\footnotesize\ttfamily \label{structfourdst_1_1atomic_1_1_species_a6e7c5ab92da7ab867018da87a14ef3ef}
|
||||
int fourdst\+::atomic\+::\+Species\+::m\+\_\+a}
|
||||
|
||||
|
||||
|
||||
Mass number (N + Z).
|
||||
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00054}{54}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
|
||||
\Hypertarget{structfourdst_1_1atomic_1_1_species_ab3e057d426e0d8dbf0134f92fda1c322}\index{fourdst::atomic::Species@{fourdst::atomic::Species}!m\_atomicMass@{m\_atomicMass}}
|
||||
\index{m\_atomicMass@{m\_atomicMass}!fourdst::atomic::Species@{fourdst::atomic::Species}}
|
||||
\doxysubsubsection{\texorpdfstring{m\_atomicMass}{m\_atomicMass}}
|
||||
{\footnotesize\ttfamily \label{structfourdst_1_1atomic_1_1_species_ab3e057d426e0d8dbf0134f92fda1c322}
|
||||
double fourdst\+::atomic\+::\+Species\+::m\+\_\+atomic\+Mass}
|
||||
|
||||
|
||||
|
||||
Atomic mass in atomic mass units (u).
|
||||
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00061}{61}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
|
||||
\Hypertarget{structfourdst_1_1atomic_1_1_species_a4c6aa98435227f8257b93311a19c4adf}\index{fourdst::atomic::Species@{fourdst::atomic::Species}!m\_atomicMassUnc@{m\_atomicMassUnc}}
|
||||
\index{m\_atomicMassUnc@{m\_atomicMassUnc}!fourdst::atomic::Species@{fourdst::atomic::Species}}
|
||||
\doxysubsubsection{\texorpdfstring{m\_atomicMassUnc}{m\_atomicMassUnc}}
|
||||
{\footnotesize\ttfamily \label{structfourdst_1_1atomic_1_1_species_a4c6aa98435227f8257b93311a19c4adf}
|
||||
double fourdst\+::atomic\+::\+Species\+::m\+\_\+atomic\+Mass\+Unc}
|
||||
|
||||
|
||||
|
||||
Uncertainty in the atomic mass.
|
||||
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00062}{62}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
|
||||
\Hypertarget{structfourdst_1_1atomic_1_1_species_abe9c5f69d657383e17dd49b41b7e4e15}\index{fourdst::atomic::Species@{fourdst::atomic::Species}!m\_betaCode@{m\_betaCode}}
|
||||
\index{m\_betaCode@{m\_betaCode}!fourdst::atomic::Species@{fourdst::atomic::Species}}
|
||||
\doxysubsubsection{\texorpdfstring{m\_betaCode}{m\_betaCode}}
|
||||
{\footnotesize\ttfamily \label{structfourdst_1_1atomic_1_1_species_abe9c5f69d657383e17dd49b41b7e4e15}
|
||||
std\+::string fourdst\+::atomic\+::\+Species\+::m\+\_\+beta\+Code}
|
||||
|
||||
|
||||
|
||||
Beta decay code.
|
||||
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00056}{56}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
|
||||
\Hypertarget{structfourdst_1_1atomic_1_1_species_a0fc7e4b41662fe0a726dd962e9dbae9e}\index{fourdst::atomic::Species@{fourdst::atomic::Species}!m\_betaDecayEnergy@{m\_betaDecayEnergy}}
|
||||
\index{m\_betaDecayEnergy@{m\_betaDecayEnergy}!fourdst::atomic::Species@{fourdst::atomic::Species}}
|
||||
\doxysubsubsection{\texorpdfstring{m\_betaDecayEnergy}{m\_betaDecayEnergy}}
|
||||
{\footnotesize\ttfamily \label{structfourdst_1_1atomic_1_1_species_a0fc7e4b41662fe0a726dd962e9dbae9e}
|
||||
double fourdst\+::atomic\+::\+Species\+::m\+\_\+beta\+Decay\+Energy}
|
||||
|
||||
|
||||
|
||||
Beta decay energy in keV.
|
||||
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00057}{57}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
|
||||
\Hypertarget{structfourdst_1_1atomic_1_1_species_acbb5b36d6892ee09e95d774eda235d3c}\index{fourdst::atomic::Species@{fourdst::atomic::Species}!m\_bindingEnergy@{m\_bindingEnergy}}
|
||||
\index{m\_bindingEnergy@{m\_bindingEnergy}!fourdst::atomic::Species@{fourdst::atomic::Species}}
|
||||
\doxysubsubsection{\texorpdfstring{m\_bindingEnergy}{m\_bindingEnergy}}
|
||||
{\footnotesize\ttfamily \label{structfourdst_1_1atomic_1_1_species_acbb5b36d6892ee09e95d774eda235d3c}
|
||||
double fourdst\+::atomic\+::\+Species\+::m\+\_\+binding\+Energy}
|
||||
|
||||
|
||||
|
||||
Binding energy in keV.
|
||||
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00055}{55}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
|
||||
\Hypertarget{structfourdst_1_1atomic_1_1_species_a545093f4fd3d9ad490a5bea84e950d35}\index{fourdst::atomic::Species@{fourdst::atomic::Species}!m\_decayModes@{m\_decayModes}}
|
||||
\index{m\_decayModes@{m\_decayModes}!fourdst::atomic::Species@{fourdst::atomic::Species}}
|
||||
\doxysubsubsection{\texorpdfstring{m\_decayModes}{m\_decayModes}}
|
||||
{\footnotesize\ttfamily \label{structfourdst_1_1atomic_1_1_species_a545093f4fd3d9ad490a5bea84e950d35}
|
||||
std\+::string fourdst\+::atomic\+::\+Species\+::m\+\_\+decay\+Modes}
|
||||
|
||||
|
||||
|
||||
Decay modes as a string.
|
||||
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00060}{60}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
|
||||
\Hypertarget{structfourdst_1_1atomic_1_1_species_a704e9d164033a89d610685c494fd53eb}\index{fourdst::atomic::Species@{fourdst::atomic::Species}!m\_el@{m\_el}}
|
||||
\index{m\_el@{m\_el}!fourdst::atomic::Species@{fourdst::atomic::Species}}
|
||||
\doxysubsubsection{\texorpdfstring{m\_el}{m\_el}}
|
||||
{\footnotesize\ttfamily \label{structfourdst_1_1atomic_1_1_species_a704e9d164033a89d610685c494fd53eb}
|
||||
std\+::string fourdst\+::atomic\+::\+Species\+::m\+\_\+el}
|
||||
|
||||
|
||||
|
||||
Element symbol (e.\+g., "{}\+Fe"{}).
|
||||
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00050}{50}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
|
||||
\Hypertarget{structfourdst_1_1atomic_1_1_species_af76d148ab7be629601a389f5758238ee}\index{fourdst::atomic::Species@{fourdst::atomic::Species}!m\_halfLife\_s@{m\_halfLife\_s}}
|
||||
\index{m\_halfLife\_s@{m\_halfLife\_s}!fourdst::atomic::Species@{fourdst::atomic::Species}}
|
||||
\doxysubsubsection{\texorpdfstring{m\_halfLife\_s}{m\_halfLife\_s}}
|
||||
{\footnotesize\ttfamily \label{structfourdst_1_1atomic_1_1_species_af76d148ab7be629601a389f5758238ee}
|
||||
double fourdst\+::atomic\+::\+Species\+::m\+\_\+half\+Life\+\_\+s}
|
||||
|
||||
|
||||
|
||||
Half-\/life in seconds. A value of -\/1.\+0 typically indicates stability.
|
||||
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00058}{58}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
|
||||
\Hypertarget{structfourdst_1_1atomic_1_1_species_a8f0a4eb006c924bc006bb9eb6d3907ac}\index{fourdst::atomic::Species@{fourdst::atomic::Species}!m\_n@{m\_n}}
|
||||
\index{m\_n@{m\_n}!fourdst::atomic::Species@{fourdst::atomic::Species}}
|
||||
\doxysubsubsection{\texorpdfstring{m\_n}{m\_n}}
|
||||
{\footnotesize\ttfamily \label{structfourdst_1_1atomic_1_1_species_a8f0a4eb006c924bc006bb9eb6d3907ac}
|
||||
int fourdst\+::atomic\+::\+Species\+::m\+\_\+n}
|
||||
|
||||
|
||||
|
||||
Number of neutrons.
|
||||
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00052}{52}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
|
||||
\Hypertarget{structfourdst_1_1atomic_1_1_species_a4f782752e18e8972c66ee7168a06279d}\index{fourdst::atomic::Species@{fourdst::atomic::Species}!m\_name@{m\_name}}
|
||||
\index{m\_name@{m\_name}!fourdst::atomic::Species@{fourdst::atomic::Species}}
|
||||
\doxysubsubsection{\texorpdfstring{m\_name}{m\_name}}
|
||||
{\footnotesize\ttfamily \label{structfourdst_1_1atomic_1_1_species_a4f782752e18e8972c66ee7168a06279d}
|
||||
std\+::string fourdst\+::atomic\+::\+Species\+::m\+\_\+name}
|
||||
|
||||
|
||||
|
||||
Name of the species (e.\+g., "{}\+Fe56"{}).
|
||||
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00049}{49}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
|
||||
\Hypertarget{structfourdst_1_1atomic_1_1_species_a50d5e1c96be4884ccfebde1eec79b6e8}\index{fourdst::atomic::Species@{fourdst::atomic::Species}!m\_nz@{m\_nz}}
|
||||
\index{m\_nz@{m\_nz}!fourdst::atomic::Species@{fourdst::atomic::Species}}
|
||||
\doxysubsubsection{\texorpdfstring{m\_nz}{m\_nz}}
|
||||
{\footnotesize\ttfamily \label{structfourdst_1_1atomic_1_1_species_a50d5e1c96be4884ccfebde1eec79b6e8}
|
||||
int fourdst\+::atomic\+::\+Species\+::m\+\_\+nz}
|
||||
|
||||
|
||||
|
||||
NZ identifier, typically 1000\texorpdfstring{$\ast$}{*}Z + A.
|
||||
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00051}{51}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
|
||||
\Hypertarget{structfourdst_1_1atomic_1_1_species_af1d73b936b428aaa29b37c119e3426e7}\index{fourdst::atomic::Species@{fourdst::atomic::Species}!m\_spin@{m\_spin}}
|
||||
\index{m\_spin@{m\_spin}!fourdst::atomic::Species@{fourdst::atomic::Species}}
|
||||
\doxysubsubsection{\texorpdfstring{m\_spin}{m\_spin}}
|
||||
{\footnotesize\ttfamily \label{structfourdst_1_1atomic_1_1_species_af1d73b936b428aaa29b37c119e3426e7}
|
||||
double fourdst\+::atomic\+::\+Species\+::m\+\_\+spin = 0.\+0}
|
||||
|
||||
|
||||
|
||||
Nuclear spin as a double, derived from m\+\_\+spin\+Parity.
|
||||
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00063}{63}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
|
||||
\Hypertarget{structfourdst_1_1atomic_1_1_species_a874bc48272e4f091817bc25a72eebc2d}\index{fourdst::atomic::Species@{fourdst::atomic::Species}!m\_spinParity@{m\_spinParity}}
|
||||
\index{m\_spinParity@{m\_spinParity}!fourdst::atomic::Species@{fourdst::atomic::Species}}
|
||||
\doxysubsubsection{\texorpdfstring{m\_spinParity}{m\_spinParity}}
|
||||
{\footnotesize\ttfamily \label{structfourdst_1_1atomic_1_1_species_a874bc48272e4f091817bc25a72eebc2d}
|
||||
std\+::string fourdst\+::atomic\+::\+Species\+::m\+\_\+spin\+Parity}
|
||||
|
||||
|
||||
|
||||
Spin and parity as a string (e.\+g., "{}1/2-\/"{}).
|
||||
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00059}{59}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
|
||||
\Hypertarget{structfourdst_1_1atomic_1_1_species_aae24c637c169f9f5eca03b6dcf8329e0}\index{fourdst::atomic::Species@{fourdst::atomic::Species}!m\_z@{m\_z}}
|
||||
\index{m\_z@{m\_z}!fourdst::atomic::Species@{fourdst::atomic::Species}}
|
||||
\doxysubsubsection{\texorpdfstring{m\_z}{m\_z}}
|
||||
{\footnotesize\ttfamily \label{structfourdst_1_1atomic_1_1_species_aae24c637c169f9f5eca03b6dcf8329e0}
|
||||
int fourdst\+::atomic\+::\+Species\+::m\+\_\+z}
|
||||
|
||||
|
||||
|
||||
Atomic number (number of protons).
|
||||
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00053}{53}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
|
||||
|
||||
|
||||
The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize}
|
||||
\item
|
||||
src/composition/include/fourdst/composition/\mbox{\hyperlink{atomic_species_8h}{atomic\+Species.\+h}}\end{DoxyCompactItemize}
|
||||
@@ -0,0 +1,116 @@
|
||||
\doxysection{fourdst\+::composition\+::Canonical\+Composition Struct Reference}
|
||||
\hypertarget{structfourdst_1_1composition_1_1_canonical_composition}{}\label{structfourdst_1_1composition_1_1_canonical_composition}\index{fourdst::composition::CanonicalComposition@{fourdst::composition::CanonicalComposition}}
|
||||
|
||||
|
||||
Represents the canonical (X, Y, Z) composition of stellar material.
|
||||
|
||||
|
||||
|
||||
|
||||
{\ttfamily \#include $<$composition.\+h$>$}
|
||||
|
||||
\doxysubsubsection*{Public Attributes}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
double \mbox{\hyperlink{structfourdst_1_1composition_1_1_canonical_composition_abe5b01574242f8eaabd00c3d653291f7}{X}} = 0.\+0
|
||||
\begin{DoxyCompactList}\small\item\em Mass fraction of Hydrogen. \end{DoxyCompactList}\item
|
||||
double \mbox{\hyperlink{structfourdst_1_1composition_1_1_canonical_composition_a93927bfccc5d2b3906565d092ed4f7f4}{Y}} = 0.\+0
|
||||
\begin{DoxyCompactList}\small\item\em Mass fraction of Helium. \end{DoxyCompactList}\item
|
||||
double \mbox{\hyperlink{structfourdst_1_1composition_1_1_canonical_composition_ae1981f5ddd36abd17a4a69fa1f43de18}{Z}} = 0.\+0
|
||||
\begin{DoxyCompactList}\small\item\em Mass fraction of Metals. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
\doxysubsubsection*{Friends}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
std\+::ostream \& \mbox{\hyperlink{structfourdst_1_1composition_1_1_canonical_composition_a6e447cb601af6bcbd09e290aef759672}{operator$<$$<$}} (std\+::ostream \&os, const \mbox{\hyperlink{structfourdst_1_1composition_1_1_canonical_composition}{Canonical\+Composition}} \&composition)
|
||||
\begin{DoxyCompactList}\small\item\em Overloads the stream insertion operator for easy printing. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
|
||||
|
||||
\doxysubsection{Detailed Description}
|
||||
Represents the canonical (X, Y, Z) composition of stellar material.
|
||||
|
||||
This is a standard astrophysical representation where\+:
|
||||
\begin{DoxyItemize}
|
||||
\item X is the total mass fraction of all hydrogen isotopes.
|
||||
\item Y is the total mass fraction of all helium isotopes.
|
||||
\item Z is the total mass fraction of all other elements (metals). By definition, X + Y + Z should sum to 1.\+0.
|
||||
\end{DoxyItemize}
|
||||
|
||||
Definition at line \mbox{\hyperlink{composition_8h_source_l00043}{43}} of file \mbox{\hyperlink{composition_8h_source}{composition.\+h}}.
|
||||
|
||||
|
||||
|
||||
\doxysubsection{Friends And Related Symbol Documentation}
|
||||
\Hypertarget{structfourdst_1_1composition_1_1_canonical_composition_a6e447cb601af6bcbd09e290aef759672}\index{fourdst::composition::CanonicalComposition@{fourdst::composition::CanonicalComposition}!operator$<$$<$@{operator$<$$<$}}
|
||||
\index{operator$<$$<$@{operator$<$$<$}!fourdst::composition::CanonicalComposition@{fourdst::composition::CanonicalComposition}}
|
||||
\doxysubsubsection{\texorpdfstring{operator$<$$<$}{operator<<}}
|
||||
{\footnotesize\ttfamily \label{structfourdst_1_1composition_1_1_canonical_composition_a6e447cb601af6bcbd09e290aef759672}
|
||||
std\+::ostream \& operator$<$$<$ (\begin{DoxyParamCaption}\item[{std\+::ostream \&}]{os}{, }\item[{const \mbox{\hyperlink{structfourdst_1_1composition_1_1_canonical_composition}{Canonical\+Composition}} \&}]{composition}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [friend]}}
|
||||
|
||||
|
||||
|
||||
Overloads the stream insertion operator for easy printing.
|
||||
|
||||
|
||||
\begin{DoxyParams}{Parameters}
|
||||
{\em os} & The output stream. \\
|
||||
\hline
|
||||
{\em composition} & The \doxylink{structfourdst_1_1composition_1_1_canonical_composition}{Canonical\+Composition} object to print. \\
|
||||
\hline
|
||||
\end{DoxyParams}
|
||||
\begin{DoxyReturn}{Returns}
|
||||
The output stream.
|
||||
\end{DoxyReturn}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{composition_8h_source_l00054}{54}} of file \mbox{\hyperlink{composition_8h_source}{composition.\+h}}.
|
||||
|
||||
|
||||
|
||||
\doxysubsection{Member Data Documentation}
|
||||
\Hypertarget{structfourdst_1_1composition_1_1_canonical_composition_abe5b01574242f8eaabd00c3d653291f7}\index{fourdst::composition::CanonicalComposition@{fourdst::composition::CanonicalComposition}!X@{X}}
|
||||
\index{X@{X}!fourdst::composition::CanonicalComposition@{fourdst::composition::CanonicalComposition}}
|
||||
\doxysubsubsection{\texorpdfstring{X}{X}}
|
||||
{\footnotesize\ttfamily \label{structfourdst_1_1composition_1_1_canonical_composition_abe5b01574242f8eaabd00c3d653291f7}
|
||||
double fourdst\+::composition\+::\+Canonical\+Composition\+::X = 0.\+0}
|
||||
|
||||
|
||||
|
||||
Mass fraction of Hydrogen.
|
||||
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{composition_8h_source_l00044}{44}} of file \mbox{\hyperlink{composition_8h_source}{composition.\+h}}.
|
||||
|
||||
\Hypertarget{structfourdst_1_1composition_1_1_canonical_composition_a93927bfccc5d2b3906565d092ed4f7f4}\index{fourdst::composition::CanonicalComposition@{fourdst::composition::CanonicalComposition}!Y@{Y}}
|
||||
\index{Y@{Y}!fourdst::composition::CanonicalComposition@{fourdst::composition::CanonicalComposition}}
|
||||
\doxysubsubsection{\texorpdfstring{Y}{Y}}
|
||||
{\footnotesize\ttfamily \label{structfourdst_1_1composition_1_1_canonical_composition_a93927bfccc5d2b3906565d092ed4f7f4}
|
||||
double fourdst\+::composition\+::\+Canonical\+Composition\+::Y = 0.\+0}
|
||||
|
||||
|
||||
|
||||
Mass fraction of Helium.
|
||||
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{composition_8h_source_l00045}{45}} of file \mbox{\hyperlink{composition_8h_source}{composition.\+h}}.
|
||||
|
||||
\Hypertarget{structfourdst_1_1composition_1_1_canonical_composition_ae1981f5ddd36abd17a4a69fa1f43de18}\index{fourdst::composition::CanonicalComposition@{fourdst::composition::CanonicalComposition}!Z@{Z}}
|
||||
\index{Z@{Z}!fourdst::composition::CanonicalComposition@{fourdst::composition::CanonicalComposition}}
|
||||
\doxysubsubsection{\texorpdfstring{Z}{Z}}
|
||||
{\footnotesize\ttfamily \label{structfourdst_1_1composition_1_1_canonical_composition_ae1981f5ddd36abd17a4a69fa1f43de18}
|
||||
double fourdst\+::composition\+::\+Canonical\+Composition\+::Z = 0.\+0}
|
||||
|
||||
|
||||
|
||||
Mass fraction of Metals.
|
||||
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{composition_8h_source_l00046}{46}} of file \mbox{\hyperlink{composition_8h_source}{composition.\+h}}.
|
||||
|
||||
|
||||
|
||||
The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize}
|
||||
\item
|
||||
src/composition/include/fourdst/composition/\mbox{\hyperlink{composition_8h}{composition.\+h}}\end{DoxyCompactItemize}
|
||||
@@ -0,0 +1,572 @@
|
||||
\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_a27b0ae0f7ef9469d515c4c7b6ec8dc22}{mass\+\_\+fraction}} (double mean\+Molar\+Mass) const
|
||||
\begin{DoxyCompactList}\small\item\em Gets the mass fraction, converting from number fraction if necessary. \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
|
||||
double \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_ab96d976b53f3828237525005b904a39c}{number\+\_\+fraction}} (double total\+Moles) const
|
||||
\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
|
||||
\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{atomic\+::\+Species}} \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_af4f8d292d18755670a914072e2260dfb}{isotope}} () const
|
||||
\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
|
||||
bool \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a743042d1998875851150d789817f5473}{set\+Number\+Frac\+Mode}} (double total\+Moles)
|
||||
\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
|
||||
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.
|
||||
|
||||
Definition at line \mbox{\hyperlink{composition_8h_source_l00083}{83}} of file \mbox{\hyperlink{composition_8h_source}{composition.\+h}}.
|
||||
|
||||
|
||||
|
||||
\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.
|
||||
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{composition_8cpp_source_l00038}{38}} of file \mbox{\hyperlink{composition_8cpp_source}{composition.\+cpp}}.
|
||||
|
||||
\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}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{composition_8cpp_source_l00043}{43}} of file \mbox{\hyperlink{composition_8cpp_source}{composition.\+cpp}}.
|
||||
|
||||
\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}
|
||||
fourdst\+::composition\+::\+Composition\+Entry\+::\+Composition\+Entry (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry}{Composition\+Entry}} \&}]{entry}{}\end{DoxyParamCaption})}
|
||||
|
||||
|
||||
|
||||
Copy constructor.
|
||||
|
||||
|
||||
\begin{DoxyParams}{Parameters}
|
||||
{\em entry} & The \doxylink{structfourdst_1_1composition_1_1_composition_entry}{Composition\+Entry} to copy. \\
|
||||
\hline
|
||||
\end{DoxyParams}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{composition_8cpp_source_l00047}{47}} of file \mbox{\hyperlink{composition_8cpp_source}{composition.\+cpp}}.
|
||||
|
||||
|
||||
|
||||
\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}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{composition_8cpp_source_l00147}{147}} of file \mbox{\hyperlink{composition_8cpp_source}{composition.\+cpp}}.
|
||||
|
||||
\Hypertarget{structfourdst_1_1composition_1_1_composition_entry_af4f8d292d18755670a914072e2260dfb}\index{fourdst::composition::CompositionEntry@{fourdst::composition::CompositionEntry}!isotope@{isotope}}
|
||||
\index{isotope@{isotope}!fourdst::composition::CompositionEntry@{fourdst::composition::CompositionEntry}}
|
||||
\doxysubsubsection{\texorpdfstring{isotope()}{isotope()}}
|
||||
{\footnotesize\ttfamily \label{structfourdst_1_1composition_1_1_composition_entry_af4f8d292d18755670a914072e2260dfb}
|
||||
\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{fourdst\+::atomic\+::\+Species}} fourdst\+::composition\+::\+Composition\+Entry\+::isotope (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [nodiscard]}}
|
||||
|
||||
|
||||
|
||||
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}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{composition_8cpp_source_l00109}{109}} of file \mbox{\hyperlink{composition_8cpp_source}{composition.\+cpp}}.
|
||||
|
||||
\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}}
|
||||
\doxysubsubsection{\texorpdfstring{mass\_fraction()}{mass\_fraction()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
|
||||
{\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}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{composition_8cpp_source_l00072}{72}} of file \mbox{\hyperlink{composition_8cpp_source}{composition.\+cpp}}.
|
||||
|
||||
\Hypertarget{structfourdst_1_1composition_1_1_composition_entry_a27b0ae0f7ef9469d515c4c7b6ec8dc22}\index{fourdst::composition::CompositionEntry@{fourdst::composition::CompositionEntry}!mass\_fraction@{mass\_fraction}}
|
||||
\index{mass\_fraction@{mass\_fraction}!fourdst::composition::CompositionEntry@{fourdst::composition::CompositionEntry}}
|
||||
\doxysubsubsection{\texorpdfstring{mass\_fraction()}{mass\_fraction()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
|
||||
{\footnotesize\ttfamily \label{structfourdst_1_1composition_1_1_composition_entry_a27b0ae0f7ef9469d515c4c7b6ec8dc22}
|
||||
double fourdst\+::composition\+::\+Composition\+Entry\+::mass\+\_\+fraction (\begin{DoxyParamCaption}\item[{double}]{mean\+Molar\+Mass}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [nodiscard]}}
|
||||
|
||||
|
||||
|
||||
Gets the mass fraction, converting from number fraction if necessary.
|
||||
|
||||
|
||||
\begin{DoxyParams}{Parameters}
|
||||
{\em mean\+Molar\+Mass} & The mean molar mass of the entire composition, required for conversion. \\
|
||||
\hline
|
||||
\end{DoxyParams}
|
||||
\begin{DoxyReturn}{Returns}
|
||||
The mass fraction of the species.
|
||||
\end{DoxyReturn}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{composition_8cpp_source_l00079}{79}} of file \mbox{\hyperlink{composition_8cpp_source}{composition.\+cpp}}.
|
||||
|
||||
\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}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{composition_8cpp_source_l00089}{89}} of file \mbox{\hyperlink{composition_8cpp_source}{composition.\+cpp}}.
|
||||
|
||||
\Hypertarget{structfourdst_1_1composition_1_1_composition_entry_ab96d976b53f3828237525005b904a39c}\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 [2/2]}}
|
||||
{\footnotesize\ttfamily \label{structfourdst_1_1composition_1_1_composition_entry_ab96d976b53f3828237525005b904a39c}
|
||||
double fourdst\+::composition\+::\+Composition\+Entry\+::number\+\_\+fraction (\begin{DoxyParamCaption}\item[{double}]{total\+Moles}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [nodiscard]}}
|
||||
|
||||
|
||||
|
||||
Gets the number fraction, converting from mass fraction if necessary.
|
||||
|
||||
|
||||
\begin{DoxyParams}{Parameters}
|
||||
{\em total\+Moles} & The total moles per unit mass (specific number density) of the entire composition. \\
|
||||
\hline
|
||||
\end{DoxyParams}
|
||||
\begin{DoxyReturn}{Returns}
|
||||
The number fraction of the species.
|
||||
\end{DoxyReturn}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{composition_8cpp_source_l00096}{96}} of file \mbox{\hyperlink{composition_8cpp_source}{composition.\+cpp}}.
|
||||
|
||||
\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}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{composition_8cpp_source_l00105}{105}} of file \mbox{\hyperlink{composition_8cpp_source}{composition.\+cpp}}.
|
||||
|
||||
\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}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{composition_8cpp_source_l00129}{129}} of file \mbox{\hyperlink{composition_8cpp_source}{composition.\+cpp}}.
|
||||
|
||||
\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}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{composition_8cpp_source_l00113}{113}} of file \mbox{\hyperlink{composition_8cpp_source}{composition.\+cpp}}.
|
||||
|
||||
\Hypertarget{structfourdst_1_1composition_1_1_composition_entry_a743042d1998875851150d789817f5473}\index{fourdst::composition::CompositionEntry@{fourdst::composition::CompositionEntry}!setNumberFracMode@{setNumberFracMode}}
|
||||
\index{setNumberFracMode@{setNumberFracMode}!fourdst::composition::CompositionEntry@{fourdst::composition::CompositionEntry}}
|
||||
\doxysubsubsection{\texorpdfstring{setNumberFracMode()}{setNumberFracMode()}}
|
||||
{\footnotesize\ttfamily \label{structfourdst_1_1composition_1_1_composition_entry_a743042d1998875851150d789817f5473}
|
||||
bool fourdst\+::composition\+::\+Composition\+Entry\+::set\+Number\+Frac\+Mode (\begin{DoxyParamCaption}\item[{double}]{total\+Moles}{}\end{DoxyParamCaption})}
|
||||
|
||||
|
||||
|
||||
Switches the mode to number fraction mode.
|
||||
|
||||
|
||||
\begin{DoxyParams}{Parameters}
|
||||
{\em total\+Moles} & The total moles per unit mass (specific number density) of the composition. \\
|
||||
\hline
|
||||
\end{DoxyParams}
|
||||
\begin{DoxyReturn}{Returns}
|
||||
True if the mode was successfully set, false otherwise.
|
||||
\end{DoxyReturn}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{composition_8cpp_source_l00138}{138}} of file \mbox{\hyperlink{composition_8cpp_source}{composition.\+cpp}}.
|
||||
|
||||
\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}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{composition_8cpp_source_l00121}{121}} of file \mbox{\hyperlink{composition_8cpp_source}{composition.\+cpp}}.
|
||||
|
||||
\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}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{composition_8cpp_source_l00056}{56}} of file \mbox{\hyperlink{composition_8cpp_source}{composition.\+cpp}}.
|
||||
|
||||
\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}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{composition_8cpp_source_l00068}{68}} of file \mbox{\hyperlink{composition_8cpp_source}{composition.\+cpp}}.
|
||||
|
||||
|
||||
|
||||
\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}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{composition_8cpp_source_l00767}{767}} of file \mbox{\hyperlink{composition_8cpp_source}{composition.\+cpp}}.
|
||||
|
||||
|
||||
|
||||
\doxysubsection{Member Data Documentation}
|
||||
\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.
|
||||
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{composition_8h_source_l00092}{92}} of file \mbox{\hyperlink{composition_8h_source}{composition.\+h}}.
|
||||
|
||||
\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.
|
||||
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{composition_8h_source_l00085}{85}} of file \mbox{\hyperlink{composition_8h_source}{composition.\+h}}.
|
||||
|
||||
\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.
|
||||
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{composition_8h_source_l00086}{86}} of file \mbox{\hyperlink{composition_8h_source}{composition.\+h}}.
|
||||
|
||||
\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.
|
||||
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{composition_8h_source_l00088}{88}} of file \mbox{\hyperlink{composition_8h_source}{composition.\+h}}.
|
||||
|
||||
\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.
|
||||
|
||||
|
||||
|
||||
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_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.
|
||||
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{composition_8h_source_l00090}{90}} of file \mbox{\hyperlink{composition_8h_source}{composition.\+h}}.
|
||||
|
||||
\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"{}).
|
||||
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{composition_8h_source_l00084}{84}} of file \mbox{\hyperlink{composition_8h_source}{composition.\+h}}.
|
||||
|
||||
|
||||
|
||||
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}
|
||||
@@ -0,0 +1,81 @@
|
||||
\doxysection{fourdst\+::composition\+::Global\+Composition Struct Reference}
|
||||
\hypertarget{structfourdst_1_1composition_1_1_global_composition}{}\label{structfourdst_1_1composition_1_1_global_composition}\index{fourdst::composition::GlobalComposition@{fourdst::composition::GlobalComposition}}
|
||||
|
||||
|
||||
Represents global properties of a finalized composition.
|
||||
|
||||
|
||||
|
||||
|
||||
{\ttfamily \#include $<$composition.\+h$>$}
|
||||
|
||||
\doxysubsubsection*{Public Attributes}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
double \mbox{\hyperlink{structfourdst_1_1composition_1_1_global_composition_a0df6ecfe28d13cbffd0abcbfec9aee41}{specific\+Number\+Density}}
|
||||
\begin{DoxyCompactList}\small\item\em The specific number density (moles per unit mass, sum of X\+\_\+i/\+M\+\_\+i), where X\+\_\+i is mass fraction and M\+\_\+i is molar mass. Units\+: mol/g. \end{DoxyCompactList}\item
|
||||
double \mbox{\hyperlink{structfourdst_1_1composition_1_1_global_composition_a9c35810d965841a755da9ce4644a2f1b}{mean\+Particle\+Mass}}
|
||||
\begin{DoxyCompactList}\small\item\em The mean mass per particle (inverse of specific number density). Units\+: g/mol. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
\doxysubsubsection*{Friends}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
std\+::ostream \& \mbox{\hyperlink{structfourdst_1_1composition_1_1_global_composition_a3c072a749c3648607771ac9105181f26}{operator$<$$<$}} (std\+::ostream \&os, const \mbox{\hyperlink{structfourdst_1_1composition_1_1_global_composition}{Global\+Composition}} \&comp)
|
||||
\end{DoxyCompactItemize}
|
||||
|
||||
|
||||
\doxysubsection{Detailed Description}
|
||||
Represents global properties of a finalized composition.
|
||||
|
||||
This struct holds derived quantities that describe the entire composition, such as mean particle mass. It is typically returned by {\ttfamily \doxylink{classfourdst_1_1composition_1_1_composition}{Composition}} methods after the composition has been finalized and is intended for internal or advanced use.
|
||||
|
||||
Definition at line \mbox{\hyperlink{composition_8h_source_l00069}{69}} of file \mbox{\hyperlink{composition_8h_source}{composition.\+h}}.
|
||||
|
||||
|
||||
|
||||
\doxysubsection{Friends And Related Symbol Documentation}
|
||||
\Hypertarget{structfourdst_1_1composition_1_1_global_composition_a3c072a749c3648607771ac9105181f26}\index{fourdst::composition::GlobalComposition@{fourdst::composition::GlobalComposition}!operator$<$$<$@{operator$<$$<$}}
|
||||
\index{operator$<$$<$@{operator$<$$<$}!fourdst::composition::GlobalComposition@{fourdst::composition::GlobalComposition}}
|
||||
\doxysubsubsection{\texorpdfstring{operator$<$$<$}{operator<<}}
|
||||
{\footnotesize\ttfamily \label{structfourdst_1_1composition_1_1_global_composition_a3c072a749c3648607771ac9105181f26}
|
||||
std\+::ostream \& operator$<$$<$ (\begin{DoxyParamCaption}\item[{std\+::ostream \&}]{os}{, }\item[{const \mbox{\hyperlink{structfourdst_1_1composition_1_1_global_composition}{Global\+Composition}} \&}]{comp}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [friend]}}
|
||||
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{composition_8cpp_source_l00760}{760}} of file \mbox{\hyperlink{composition_8cpp_source}{composition.\+cpp}}.
|
||||
|
||||
|
||||
|
||||
\doxysubsection{Member Data Documentation}
|
||||
\Hypertarget{structfourdst_1_1composition_1_1_global_composition_a9c35810d965841a755da9ce4644a2f1b}\index{fourdst::composition::GlobalComposition@{fourdst::composition::GlobalComposition}!meanParticleMass@{meanParticleMass}}
|
||||
\index{meanParticleMass@{meanParticleMass}!fourdst::composition::GlobalComposition@{fourdst::composition::GlobalComposition}}
|
||||
\doxysubsubsection{\texorpdfstring{meanParticleMass}{meanParticleMass}}
|
||||
{\footnotesize\ttfamily \label{structfourdst_1_1composition_1_1_global_composition_a9c35810d965841a755da9ce4644a2f1b}
|
||||
double fourdst\+::composition\+::\+Global\+Composition\+::mean\+Particle\+Mass}
|
||||
|
||||
|
||||
|
||||
The mean mass per particle (inverse of specific number density). Units\+: g/mol.
|
||||
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{composition_8h_source_l00071}{71}} of file \mbox{\hyperlink{composition_8h_source}{composition.\+h}}.
|
||||
|
||||
\Hypertarget{structfourdst_1_1composition_1_1_global_composition_a0df6ecfe28d13cbffd0abcbfec9aee41}\index{fourdst::composition::GlobalComposition@{fourdst::composition::GlobalComposition}!specificNumberDensity@{specificNumberDensity}}
|
||||
\index{specificNumberDensity@{specificNumberDensity}!fourdst::composition::GlobalComposition@{fourdst::composition::GlobalComposition}}
|
||||
\doxysubsubsection{\texorpdfstring{specificNumberDensity}{specificNumberDensity}}
|
||||
{\footnotesize\ttfamily \label{structfourdst_1_1composition_1_1_global_composition_a0df6ecfe28d13cbffd0abcbfec9aee41}
|
||||
double fourdst\+::composition\+::\+Global\+Composition\+::specific\+Number\+Density}
|
||||
|
||||
|
||||
|
||||
The specific number density (moles per unit mass, sum of X\+\_\+i/\+M\+\_\+i), where X\+\_\+i is mass fraction and M\+\_\+i is molar mass. Units\+: mol/g.
|
||||
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{composition_8h_source_l00070}{70}} of file \mbox{\hyperlink{composition_8h_source}{composition.\+h}}.
|
||||
|
||||
|
||||
|
||||
The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize}
|
||||
\item
|
||||
src/composition/include/fourdst/composition/\mbox{\hyperlink{composition_8h}{composition.\+h}}\end{DoxyCompactItemize}
|
||||
@@ -0,0 +1,74 @@
|
||||
\doxysection{std\+::hash\texorpdfstring{$<$}{<} fourdst\+::atomic\+::Species \texorpdfstring{$>$}{>} Struct Reference}
|
||||
\hypertarget{structstd_1_1hash_3_01fourdst_1_1atomic_1_1_species_01_4}{}\label{structstd_1_1hash_3_01fourdst_1_1atomic_1_1_species_01_4}\index{std::hash$<$ fourdst::atomic::Species $>$@{std::hash$<$ fourdst::atomic::Species $>$}}
|
||||
|
||||
|
||||
Specialization of {\ttfamily std\+::hash} for {\ttfamily \doxylink{structfourdst_1_1atomic_1_1_species}{fourdst\+::atomic\+::\+Species}}.
|
||||
|
||||
|
||||
|
||||
|
||||
{\ttfamily \#include $<$atomic\+Species.\+h$>$}
|
||||
|
||||
\doxysubsubsection*{Public Member Functions}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
size\+\_\+t \mbox{\hyperlink{structstd_1_1hash_3_01fourdst_1_1atomic_1_1_species_01_4_afa44fa4cf54e7f6283d6e2ce93c63b6a}{operator()}} (const \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{fourdst\+::atomic\+::\+Species}} \&s) const noexcept
|
||||
\begin{DoxyCompactList}\small\item\em Computes the hash for a Species object. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
|
||||
|
||||
\doxysubsection{Detailed Description}
|
||||
Specialization of {\ttfamily std\+::hash} for {\ttfamily \doxylink{structfourdst_1_1atomic_1_1_species}{fourdst\+::atomic\+::\+Species}}.
|
||||
|
||||
This allows {\ttfamily \doxylink{structfourdst_1_1atomic_1_1_species}{fourdst\+::atomic\+::\+Species}} objects to be used as keys in unordered associative containers like {\ttfamily std\+::unordered\+\_\+map} and {\ttfamily std\+::unordered\+\_\+set}. The hash is computed based on the species\textquotesingle{} name ({\ttfamily m\+\_\+name}), as it is expected to be a unique identifier for each species.
|
||||
|
||||
\begin{DoxyParagraph}{Usage Example}
|
||||
|
||||
\begin{DoxyCode}{0}
|
||||
\DoxyCodeLine{\textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{atomic_species_8h}{fourdst/composition/atomicSpecies.h}}"{}}}
|
||||
\DoxyCodeLine{\textcolor{preprocessor}{\#include\ <unordered\_map>}}
|
||||
\DoxyCodeLine{\textcolor{preprocessor}{\#include\ <string>}}
|
||||
\DoxyCodeLine{}
|
||||
\DoxyCodeLine{\textcolor{keywordtype}{int}\ main()\ \{}
|
||||
\DoxyCodeLine{\ \ \ \ std::unordered\_map<fourdst::atomic::Species,\ double>\ abundance;}
|
||||
\DoxyCodeLine{\ \ \ \ fourdst::atomic::Species\ h1(\textcolor{stringliteral}{"{}H1"{}},\ ...);}
|
||||
\DoxyCodeLine{\ \ \ \ abundance[h1]\ =\ 0.999;}
|
||||
\DoxyCodeLine{\ \ \ \ \textcolor{keywordflow}{return}\ 0;}
|
||||
\DoxyCodeLine{\}}
|
||||
|
||||
\end{DoxyCode}
|
||||
|
||||
\end{DoxyParagraph}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00425}{425}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
|
||||
|
||||
|
||||
\doxysubsection{Member Function Documentation}
|
||||
\Hypertarget{structstd_1_1hash_3_01fourdst_1_1atomic_1_1_species_01_4_afa44fa4cf54e7f6283d6e2ce93c63b6a}\index{std::hash$<$ fourdst::atomic::Species $>$@{std::hash$<$ fourdst::atomic::Species $>$}!operator()@{operator()}}
|
||||
\index{operator()@{operator()}!std::hash$<$ fourdst::atomic::Species $>$@{std::hash$<$ fourdst::atomic::Species $>$}}
|
||||
\doxysubsubsection{\texorpdfstring{operator()()}{operator()()}}
|
||||
{\footnotesize\ttfamily \label{structstd_1_1hash_3_01fourdst_1_1atomic_1_1_species_01_4_afa44fa4cf54e7f6283d6e2ce93c63b6a}
|
||||
size\+\_\+t std\+::hash$<$ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{fourdst\+::atomic\+::\+Species}} $>$\+::operator() (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{fourdst\+::atomic\+::\+Species}} \&}]{s}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [noexcept]}}
|
||||
|
||||
|
||||
|
||||
Computes the hash for a Species object.
|
||||
|
||||
|
||||
\begin{DoxyParams}{Parameters}
|
||||
{\em s} & The Species object to hash. \\
|
||||
\hline
|
||||
\end{DoxyParams}
|
||||
\begin{DoxyReturn}{Returns}
|
||||
The hash value of the species\textquotesingle{} name.
|
||||
\end{DoxyReturn}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00431}{431}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
|
||||
|
||||
|
||||
The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize}
|
||||
\item
|
||||
src/composition/include/fourdst/composition/\mbox{\hyperlink{atomic_species_8h}{atomic\+Species.\+h}}\end{DoxyCompactItemize}
|
||||
2557
docs/latex/tabu_doxygen.sty
Normal file
2557
docs/latex/tabu_doxygen.sty
Normal file
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user