docs(docs): rebuilt
This commit is contained in:
@@ -3,20 +3,12 @@ Here are the classes, structs, unions and interfaces with brief descriptions\+:\
|
||||
\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{class_composition_abstract}{Composition\+Abstract}} \\*Abstract base class for chemical composition representations }{\pageref{class_composition_abstract}}{}
|
||||
\item\contentsline{section}{\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache}{fourdst\+::composition\+::\+Composition\+::\+Composition\+Cache}} }{\pageref{structfourdst_1_1composition_1_1_composition_1_1_composition_cache}}{}
|
||||
\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{structfourdst_1_1composition_1_1_composition_1_1_composition_cache}{fourdst\+::composition\+::\+Composition\+::\+Composition\+Cache}} \\*Caches computed properties of the composition to avoid redundant calculations }{\pageref{structfourdst_1_1composition_1_1_composition_1_1_composition_cache}}{}
|
||||
\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_species_error}{fourdst\+::composition\+::exceptions\+::\+Species\+Error}} \\*Base class for exceptions related to atomic species }{\pageref{classfourdst_1_1composition_1_1exceptions_1_1_species_error}}{}
|
||||
\item\contentsline{section}{\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_unknown_symbol_error}{fourdst\+::composition\+::exceptions\+::\+Unknown\+Symbol\+Error}} \\*Exception thrown when an unknown symbol is encountered }{\pageref{classfourdst_1_1composition_1_1exceptions_1_1_unknown_symbol_error}}{}
|
||||
\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}
|
||||
|
||||
@@ -1,9 +1,23 @@
|
||||
\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}}
|
||||
\doxysection{src/composition/include/fourdst/atomic/atomic\+Species.h File Reference}
|
||||
\hypertarget{atomic_species_8h}{}\label{atomic_species_8h}\index{src/composition/include/fourdst/atomic/atomicSpecies.h@{src/composition/include/fourdst/atomic/atomicSpecies.h}}
|
||||
{\ttfamily \#include $<$string\+\_\+view$>$}\newline
|
||||
{\ttfamily \#include $<$string$>$}\newline
|
||||
{\ttfamily \#include $<$iostream$>$}\newline
|
||||
{\ttfamily \#include $<$optional$>$}\newline
|
||||
{\ttfamily \#include $<$limits$>$}\newline
|
||||
Include dependency graph for atomic\+Species.\+h\+:\nopagebreak
|
||||
\begin{figure}[H]
|
||||
\begin{center}
|
||||
\leavevmode
|
||||
\includegraphics[width=329pt]{atomic_species_8h__incl}
|
||||
\end{center}
|
||||
\end{figure}
|
||||
This graph shows which files directly or indirectly include this file\+:\nopagebreak
|
||||
\begin{figure}[H]
|
||||
\begin{center}
|
||||
\leavevmode
|
||||
\includegraphics[width=350pt]{atomic_species_8h__dep__incl}
|
||||
\end{center}
|
||||
\end{figure}
|
||||
\doxysubsubsection*{Classes}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
@@ -15,13 +29,13 @@ struct \mbox{\hyperlink{structstd_1_1hash_3_01fourdst_1_1atomic_1_1_species_01_4
|
||||
\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
|
||||
\begin{DoxyCompactList}\small\item\em Contains canonical information about atomic species and elements used by 4D-\/\+STAR. \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)
|
||||
double \mbox{\hyperlink{namespacefourdst_1_1atomic_ab8b3572582a3f80243ecce021b4782d1}{fourdst\+::atomic\+::convert\+\_\+jpi\+\_\+to\+\_\+double}} (const std\+::string \&jpi\+\_\+string) noexcept
|
||||
\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
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
\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}}
|
||||
\hypertarget{atomic_species_8h_source}{}\label{atomic_species_8h_source}\index{src/composition/include/fourdst/atomic/atomicSpecies.h@{src/composition/include/fourdst/atomic/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}}
|
||||
@@ -7,12 +7,12 @@
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00003}00003\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00004}00004\ \textcolor{preprocessor}{\#include\ <string\_view>}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00005}00005\ \textcolor{preprocessor}{\#include\ <string>}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00006}00006\ \textcolor{preprocessor}{\#include\ <iostream>}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00006}00006\ \textcolor{preprocessor}{\#include\ <optional>}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00007}00007\ \textcolor{preprocessor}{\#include\ <limits>}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00008}00008\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00009}00009\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00014}00014\ \textcolor{keyword}{namespace\ }\mbox{\hyperlink{namespacefourdst_1_1atomic}{fourdst::atomic}}\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00020}00020\ \ \ \ \ \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_l00020}00020\ \ \ \ \ \textcolor{keyword}{inline}\ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{namespacefourdst_1_1atomic_ab8b3572582a3f80243ecce021b4782d1}{convert\_jpi\_to\_double}}(\textcolor{keyword}{const}\ std::string\&\ jpi\_string)\ \textcolor{keyword}{noexcept};}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00021}00021\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00051}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{00051}}\ \ \ \ \ \textcolor{keyword}{struct\ }\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a3756508a18b57a60f68f1b0cf58d303c}{Species}}\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00052}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a4f782752e18e8972c66ee7168a06279d}{00052}}\ \ \ \ \ \ \ \ \ std::string\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a4f782752e18e8972c66ee7168a06279d}{m\_name}};\ }
|
||||
@@ -29,7 +29,7 @@
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00063}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a545093f4fd3d9ad490a5bea84e950d35}{00063}}\ \ \ \ \ \ \ \ \ std::string\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a545093f4fd3d9ad490a5bea84e950d35}{m\_decayModes}};\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00064}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_ab3e057d426e0d8dbf0134f92fda1c322}{00064}}\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_ab3e057d426e0d8dbf0134f92fda1c322}{m\_atomicMass}};\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00065}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a4c6aa98435227f8257b93311a19c4adf}{00065}}\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a4c6aa98435227f8257b93311a19c4adf}{m\_atomicMassUnc}};\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00066}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_af1d73b936b428aaa29b37c119e3426e7}{00066}}\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_af1d73b936b428aaa29b37c119e3426e7}{m\_spin}}\ =\ 0.0;\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00066}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a9dcfca3c5e28f6523bb1a10ede645048}{00066}}\ \ \ \ \ \ \ \ \ \textcolor{keyword}{mutable}\ std::optional<double>\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a9dcfca3c5e28f6523bb1a10ede645048}{m\_spin}}\ =\ std::nullopt;\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00067}00067\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00088}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a3756508a18b57a60f68f1b0cf58d303c}{00088}}\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a3756508a18b57a60f68f1b0cf58d303c}{Species}}(}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00089}00089\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keyword}{const}\ std::string\_view\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a1fcc01fc978b34ba2531117f10be6741}{name}},}
|
||||
@@ -60,87 +60,87 @@
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00114}00114\ \ \ \ \ \ \ \ \ \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_l00115}00115\ \ \ \ \ \ \ \ \ \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_l00116}00116\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_ab3e057d426e0d8dbf0134f92fda1c322}{m\_atomicMass}}(atomicMass),}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00117}00117\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a4c6aa98435227f8257b93311a19c4adf}{m\_atomicMassUnc}}(atomicMassUnc)\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00118}00118\ \ \ \ \ \ \ \ \ \ \ \ \ \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_l00119}00119\ \ \ \ \ \ \ \ \ \};}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00120}00120\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00126}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a873551c1ffbdcd6867ab0d1ed34ead0b}{00126}}\ \ \ \ \ \ \ \ \ \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_l00127}00127\ \ \ \ \ \ \ \ \ \ \ \ \ \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_l00128}00128\ \ \ \ \ \ \ \ \ \ \ \ \ \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_l00129}00129\ \ \ \ \ \ \ \ \ \ \ \ \ \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_l00130}00130\ \ \ \ \ \ \ \ \ \ \ \ \ \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_l00131}00131\ \ \ \ \ \ \ \ \ \ \ \ \ \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_l00132}00132\ \ \ \ \ \ \ \ \ \ \ \ \ \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_l00133}00133\ \ \ \ \ \ \ \ \ \ \ \ \ \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_l00134}00134\ \ \ \ \ \ \ \ \ \ \ \ \ \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_l00135}00135\ \ \ \ \ \ \ \ \ \ \ \ \ \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_l00136}00136\ \ \ \ \ \ \ \ \ \ \ \ \ \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_l00137}00137\ \ \ \ \ \ \ \ \ \ \ \ \ \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_l00138}00138\ \ \ \ \ \ \ \ \ \ \ \ \ \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_l00139}00139\ \ \ \ \ \ \ \ \ \ \ \ \ \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_l00140}00140\ \ \ \ \ \ \ \ \ \ \ \ \ \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_l00141}00141\ \ \ \ \ \ \ \ \ \ \ \ \ \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_l00142}00142\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00143}00143\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00144}00144\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00149}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_af5bdcc90ddafddfc027f94a98972eca3}{00149}}\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_af5bdcc90ddafddfc027f94a98972eca3}{mass}}()\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00150}00150\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_ab3e057d426e0d8dbf0134f92fda1c322}{m\_atomicMass}};}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00151}00151\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00152}00152\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00157}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_ac041c089469dc8d36548805c81492aca}{00157}}\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_ac041c089469dc8d36548805c81492aca}{massUnc}}()\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00158}00158\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a4c6aa98435227f8257b93311a19c4adf}{m\_atomicMassUnc}};}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00159}00159\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00160}00160\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00165}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a34c4bb95e3c3e29087bc242d83aeefa1}{00165}}\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a34c4bb95e3c3e29087bc242d83aeefa1}{halfLife}}()\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00166}00166\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_af76d148ab7be629601a389f5758238ee}{m\_halfLife\_s}};}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00167}00167\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00168}00168\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00173}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_afcdd2f750d8cf206e3bcc507d57dabb1}{00173}}\ \ \ \ \ \ \ \ \ [[nodiscard]]\ std::string\_view\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_afcdd2f750d8cf206e3bcc507d57dabb1}{spinParity}}()\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00174}00174\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a874bc48272e4f091817bc25a72eebc2d}{m\_spinParity}};}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00175}00175\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00176}00176\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00181}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_aad5094dfc8317db36468356bbc4a3e2f}{00181}}\ \ \ \ \ \ \ \ \ [[nodiscard]]\ std::string\_view\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_aad5094dfc8317db36468356bbc4a3e2f}{decayModes}}()\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00182}00182\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a545093f4fd3d9ad490a5bea84e950d35}{m\_decayModes}};}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00183}00183\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00184}00184\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00189}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_abeef75170cabef39fdaa6362780ddfc8}{00189}}\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_abeef75170cabef39fdaa6362780ddfc8}{bindingEnergy}}()\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00190}00190\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_acbb5b36d6892ee09e95d774eda235d3c}{m\_bindingEnergy}};}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00191}00191\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00192}00192\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00197}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a7d0e8a3b3d30fa56bdcc59577fa9ff73}{00197}}\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a7d0e8a3b3d30fa56bdcc59577fa9ff73}{betaDecayEnergy}}()\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00198}00198\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a0fc7e4b41662fe0a726dd962e9dbae9e}{m\_betaDecayEnergy}};}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00199}00199\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00200}00200\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00205}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a57391049d534ffd1a4b4d6ed63d65ffc}{00205}}\ \ \ \ \ \ \ \ \ [[nodiscard]]\ std::string\_view\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a57391049d534ffd1a4b4d6ed63d65ffc}{betaCode}}()\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00206}00206\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_abe9c5f69d657383e17dd49b41b7e4e15}{m\_betaCode}};}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00207}00207\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00208}00208\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00213}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a1fcc01fc978b34ba2531117f10be6741}{00213}}\ \ \ \ \ \ \ \ \ [[nodiscard]]\ std::string\_view\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a1fcc01fc978b34ba2531117f10be6741}{name}}()\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00214}00214\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a4f782752e18e8972c66ee7168a06279d}{m\_name}};}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00215}00215\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00216}00216\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00221}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a326c260a1b53deafcd04c21b2787f6c4}{00221}}\ \ \ \ \ \ \ \ \ [[nodiscard]]\ std::string\_view\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a326c260a1b53deafcd04c21b2787f6c4}{el}}()\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00222}00222\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a704e9d164033a89d610685c494fd53eb}{m\_el}};}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00223}00223\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00224}00224\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00229}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_aa5e452accca3a9b4937867044617a032}{00229}}\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{int}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_aa5e452accca3a9b4937867044617a032}{nz}}()\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00230}00230\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a50d5e1c96be4884ccfebde1eec79b6e8}{m\_nz}};}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00231}00231\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00232}00232\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00237}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a957734e413f07adf1d570885c480768d}{00237}}\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{int}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a957734e413f07adf1d570885c480768d}{n}}()\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00238}00238\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a8f0a4eb006c924bc006bb9eb6d3907ac}{m\_n}};}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00239}00239\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00240}00240\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00245}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a1d50917a60a1adb2c9912193f214fab0}{00245}}\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{int}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a1d50917a60a1adb2c9912193f214fab0}{z}}()\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00246}00246\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_aae24c637c169f9f5eca03b6dcf8329e0}{m\_z}};}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00247}00247\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00248}00248\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00253}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_adc960c98d6e6051940d0a5c0d9a1183d}{00253}}\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{int}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_adc960c98d6e6051940d0a5c0d9a1183d}{a}}()\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00254}00254\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a6e7c5ab92da7ab867018da87a14ef3ef}{m\_a}};}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00255}00255\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00256}00256\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00261}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a0e5d73c7c629cb08f254f2bc41f6ac4b}{00261}}\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a0e5d73c7c629cb08f254f2bc41f6ac4b}{spin}}()\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00262}00262\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_af1d73b936b428aaa29b37c119e3426e7}{m\_spin}};}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00117}00117\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a4c6aa98435227f8257b93311a19c4adf}{m\_atomicMassUnc}}(atomicMassUnc)\ \{\};}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00118}00118\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00124}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a873551c1ffbdcd6867ab0d1ed34ead0b}{00124}}\ \ \ \ \ \ \ \ \ \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_l00125}00125\ \ \ \ \ \ \ \ \ \ \ \ \ \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_l00126}00126\ \ \ \ \ \ \ \ \ \ \ \ \ \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_l00127}00127\ \ \ \ \ \ \ \ \ \ \ \ \ \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_l00128}00128\ \ \ \ \ \ \ \ \ \ \ \ \ \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_l00129}00129\ \ \ \ \ \ \ \ \ \ \ \ \ \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_l00130}00130\ \ \ \ \ \ \ \ \ \ \ \ \ \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_l00131}00131\ \ \ \ \ \ \ \ \ \ \ \ \ \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_l00132}00132\ \ \ \ \ \ \ \ \ \ \ \ \ \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_l00133}00133\ \ \ \ \ \ \ \ \ \ \ \ \ \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_l00134}00134\ \ \ \ \ \ \ \ \ \ \ \ \ \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_l00135}00135\ \ \ \ \ \ \ \ \ \ \ \ \ \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_l00136}00136\ \ \ \ \ \ \ \ \ \ \ \ \ \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_l00137}00137\ \ \ \ \ \ \ \ \ \ \ \ \ \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_l00138}00138\ \ \ \ \ \ \ \ \ \ \ \ \ \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_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}{if}\ (!\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a9dcfca3c5e28f6523bb1a10ede645048}{m\_spin}}.has\_value())\ \{\ \textcolor{comment}{//\ The\ spin\ calculation\ is\ very\ expensive,\ and\ we\ almost\ never\ need\ it\ so\ we\ only\ compute\ it\ the\ first\ time\ it\ is\ requested}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00260}00260\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a9dcfca3c5e28f6523bb1a10ede645048}{m\_spin}}\ =\ \mbox{\hyperlink{namespacefourdst_1_1atomic_ab8b3572582a3f80243ecce021b4782d1}{convert\_jpi\_to\_double}}(\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a874bc48272e4f091817bc25a72eebc2d}{m\_spinParity}});}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00261}00261\ \ \ \ \ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00262}00262\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a9dcfca3c5e28f6523bb1a10ede645048}{m\_spin}}.value();}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00263}00263\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00264}00264\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00271}\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_ad431f09aba3c2d8bafde06a459636965}{00271}}\ \ \ \ \ \ \ \ \ \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}})\ \{}
|
||||
@@ -166,7 +166,7 @@
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00315}00315\ \ \ \ \ \ \ \ \ \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_l00316}00316\ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00317}00317\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00348}\mbox{\hyperlink{namespacefourdst_1_1atomic_ada037e2130ddb6174ff7934cda49c2ba}{00348}}\ \ \ \ \ \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_l00348}\mbox{\hyperlink{namespacefourdst_1_1atomic_ab8b3572582a3f80243ecce021b4782d1}{00348}}\ \ \ \ \ \textcolor{keyword}{inline}\ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{namespacefourdst_1_1atomic_ab8b3572582a3f80243ecce021b4782d1}{convert\_jpi\_to\_double}}(\textcolor{keyword}{const}\ std::string\&\ jpi\_string)\ \textcolor{keyword}{noexcept}\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00349}00349\ \ \ \ \ \ \ \ \ std::string\ s\ =\ jpi\_string;}
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00350}00350\ }
|
||||
\DoxyCodeLine{\Hypertarget{atomic_species_8h_source_l00351}00351\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{if}\ (s.empty())\ \{}
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
Binary file not shown.
@@ -9,10 +9,22 @@ Base class for exceptions related to composition objects.
|
||||
|
||||
{\ttfamily \#include $<$exceptions\+\_\+composition.\+h$>$}
|
||||
|
||||
Inheritance diagram for fourdst\+::composition\+::exceptions\+::Composition\+Error\+:\begin{figure}[H]
|
||||
|
||||
|
||||
Inheritance diagram for fourdst\+::composition\+::exceptions\+::Composition\+Error\+:\nopagebreak
|
||||
\begin{figure}[H]
|
||||
\begin{center}
|
||||
\leavevmode
|
||||
\includegraphics[height=0.710660cm]{classfourdst_1_1composition_1_1exceptions_1_1_composition_error}
|
||||
\includegraphics[width=350pt]{classfourdst_1_1composition_1_1exceptions_1_1_composition_error__inherit__graph}
|
||||
\end{center}
|
||||
\end{figure}
|
||||
|
||||
|
||||
Collaboration diagram for fourdst\+::composition\+::exceptions\+::Composition\+Error\+:\nopagebreak
|
||||
\begin{figure}[H]
|
||||
\begin{center}
|
||||
\leavevmode
|
||||
\includegraphics[width=274pt]{classfourdst_1_1composition_1_1exceptions_1_1_composition_error__coll__graph}
|
||||
\end{center}
|
||||
\end{figure}
|
||||
\doxysubsubsection*{Public Member Functions}
|
||||
|
||||
Binary file not shown.
@@ -9,10 +9,22 @@ 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]
|
||||
|
||||
|
||||
Inheritance diagram for fourdst\+::composition\+::exceptions\+::Invalid\+Composition\+Error\+:\nopagebreak
|
||||
\begin{figure}[H]
|
||||
\begin{center}
|
||||
\leavevmode
|
||||
\includegraphics[height=3.000000cm]{classfourdst_1_1composition_1_1exceptions_1_1_invalid_composition_error}
|
||||
\includegraphics[width=239pt]{classfourdst_1_1composition_1_1exceptions_1_1_invalid_composition_error__inherit__graph}
|
||||
\end{center}
|
||||
\end{figure}
|
||||
|
||||
|
||||
Collaboration diagram for fourdst\+::composition\+::exceptions\+::Invalid\+Composition\+Error\+:\nopagebreak
|
||||
\begin{figure}[H]
|
||||
\begin{center}
|
||||
\leavevmode
|
||||
\includegraphics[width=277pt]{classfourdst_1_1composition_1_1exceptions_1_1_invalid_composition_error__coll__graph}
|
||||
\end{center}
|
||||
\end{figure}
|
||||
\doxysubsubsection*{Private Member Functions}
|
||||
@@ -38,7 +50,7 @@ std\+::string \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_com
|
||||
\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}}.
|
||||
Definition at line \mbox{\hyperlink{exceptions__composition_8h_source_l00041}{41}} of file \mbox{\hyperlink{exceptions__composition_8h_source}{exceptions\+\_\+composition.\+h}}.
|
||||
|
||||
|
||||
|
||||
|
||||
Binary file not shown.
@@ -9,10 +9,22 @@ 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]
|
||||
|
||||
|
||||
Inheritance diagram for fourdst\+::composition\+::exceptions\+::Unregistered\+Symbol\+Error\+:\nopagebreak
|
||||
\begin{figure}[H]
|
||||
\begin{center}
|
||||
\leavevmode
|
||||
\includegraphics[height=3.000000cm]{classfourdst_1_1composition_1_1exceptions_1_1_unregistered_symbol_error}
|
||||
\includegraphics[width=244pt]{classfourdst_1_1composition_1_1exceptions_1_1_unregistered_symbol_error__inherit__graph}
|
||||
\end{center}
|
||||
\end{figure}
|
||||
|
||||
|
||||
Collaboration diagram for fourdst\+::composition\+::exceptions\+::Unregistered\+Symbol\+Error\+:\nopagebreak
|
||||
\begin{figure}[H]
|
||||
\begin{center}
|
||||
\leavevmode
|
||||
\includegraphics[width=280pt]{classfourdst_1_1composition_1_1exceptions_1_1_unregistered_symbol_error__coll__graph}
|
||||
\end{center}
|
||||
\end{figure}
|
||||
\doxysubsubsection*{Private Member Functions}
|
||||
@@ -40,7 +52,7 @@ 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}}.
|
||||
Definition at line \mbox{\hyperlink{exceptions__composition_8h_source_l00051}{51}} of file \mbox{\hyperlink{exceptions__composition_8h_source}{exceptions\+\_\+composition.\+h}}.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -4,28 +4,31 @@
|
||||
{\ttfamily \#include $<$stdexcept$>$}\newline
|
||||
{\ttfamily \#include $<$unordered\+\_\+map$>$}\newline
|
||||
{\ttfamily \#include $<$vector$>$}\newline
|
||||
{\ttfamily \#include $<$array$>$}\newline
|
||||
{\ttfamily \#include $<$ranges$>$}\newline
|
||||
{\ttfamily \#include $<$algorithm$>$}\newline
|
||||
{\ttfamily \#include $<$set$>$}\newline
|
||||
{\ttfamily \#include $<$string$>$}\newline
|
||||
{\ttfamily \#include $<$utility$>$}\newline
|
||||
{\ttfamily \#include "{}fourdst/composition/atomic\+Species.\+h"{}}\newline
|
||||
{\ttfamily \#include "{}fourdst/composition/species.\+h"{}}\newline
|
||||
{\ttfamily \#include "{}fourdst/atomic/atomic\+Species.\+h"{}}\newline
|
||||
{\ttfamily \#include "{}fourdst/atomic/species.\+h"{}}\newline
|
||||
{\ttfamily \#include "{}fourdst/composition/composition.\+h"{}}\newline
|
||||
{\ttfamily \#include $<$numeric$>$}\newline
|
||||
{\ttfamily \#include "{}fourdst/composition/exceptions/exceptions\+\_\+composition.\+h"{}}\newline
|
||||
Include dependency graph for composition.\+cpp\+:\nopagebreak
|
||||
\begin{figure}[H]
|
||||
\begin{center}
|
||||
\leavevmode
|
||||
\includegraphics[width=350pt]{composition_8cpp__incl}
|
||||
\end{center}
|
||||
\end{figure}
|
||||
\doxysubsubsection*{Namespaces}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
namespace \mbox{\hyperlink{namespacefourdst}{fourdst}}
|
||||
\item
|
||||
namespace \mbox{\hyperlink{namespacefourdst_1_1composition}{fourdst\+::composition}}
|
||||
\end{DoxyCompactItemize}
|
||||
\begin{DoxyCompactList}\small\item\em Utilities and types for representing and manipulating chemical compositions. \end{DoxyCompactList}\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}
|
||||
\begin{DoxyCompactList}\small\item\em OVERLOADS. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -3,28 +3,38 @@
|
||||
{\ttfamily \#include $<$string$>$}\newline
|
||||
{\ttfamily \#include $<$unordered\+\_\+map$>$}\newline
|
||||
{\ttfamily \#include $<$set$>$}\newline
|
||||
{\ttfamily \#include $<$utility$>$}\newline
|
||||
{\ttfamily \#include $<$optional$>$}\newline
|
||||
{\ttfamily \#include "{}fourdst/config/config.\+h"{}}\newline
|
||||
{\ttfamily \#include "{}fourdst/logging/logging.\+h"{}}\newline
|
||||
{\ttfamily \#include "{}fourdst/composition/composition\+\_\+abstract.\+h"{}}\newline
|
||||
{\ttfamily \#include "{}fourdst/composition/atomic\+Species.\+h"{}}\newline
|
||||
{\ttfamily \#include "{}fourdst/atomic/atomic\+Species.\+h"{}}\newline
|
||||
Include dependency graph for composition.\+h\+:\nopagebreak
|
||||
\begin{figure}[H]
|
||||
\begin{center}
|
||||
\leavevmode
|
||||
\includegraphics[width=350pt]{composition_8h__incl}
|
||||
\end{center}
|
||||
\end{figure}
|
||||
This graph shows which files directly or indirectly include this file\+:\nopagebreak
|
||||
\begin{figure}[H]
|
||||
\begin{center}
|
||||
\leavevmode
|
||||
\includegraphics[width=350pt]{composition_8h__dep__incl}
|
||||
\end{center}
|
||||
\end{figure}
|
||||
\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}\item
|
||||
struct \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache}{fourdst\+::composition\+::\+Composition\+::\+Composition\+Cache}}
|
||||
\end{DoxyCompactItemize}
|
||||
\begin{DoxyCompactList}\small\item\em Caches computed properties of the composition to avoid redundant calculations. \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}
|
||||
\begin{DoxyCompactList}\small\item\em Utilities and types for representing and manipulating chemical compositions. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
|
||||
@@ -28,14 +28,14 @@
|
||||
\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_l00027}00027\ \textcolor{preprocessor}{\#include\ <optional>}}
|
||||
\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{composition__abstract_8h}{fourdst/composition/composition\_abstract.h}}"{}}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00032}00032\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{atomic_species_8h}{fourdst/composition/atomicSpecies.h}}"{}}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00032}00032\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{atomic_species_8h}{fourdst/atomic/atomicSpecies.h}}"{}}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00033}00033\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00034}\mbox{\hyperlink{namespacefourdst_1_1composition}{00034}}\ \textcolor{keyword}{namespace\ }\mbox{\hyperlink{namespacefourdst_1_1composition}{fourdst::composition}}\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00034}00034\ \textcolor{keyword}{namespace\ }\mbox{\hyperlink{namespacefourdst_1_1composition}{fourdst::composition}}\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00044}\mbox{\hyperlink{structfourdst_1_1composition_1_1_canonical_composition}{00044}}\ \ \ \ \ \textcolor{keyword}{struct\ }\mbox{\hyperlink{structfourdst_1_1composition_1_1_canonical_composition}{CanonicalComposition}}\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00045}\mbox{\hyperlink{structfourdst_1_1composition_1_1_canonical_composition_abe5b01574242f8eaabd00c3d653291f7}{00045}}\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_canonical_composition_abe5b01574242f8eaabd00c3d653291f7}{X}}\ =\ 0.0;\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00046}\mbox{\hyperlink{structfourdst_1_1composition_1_1_canonical_composition_a93927bfccc5d2b3906565d092ed4f7f4}{00046}}\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_canonical_composition_a93927bfccc5d2b3906565d092ed4f7f4}{Y}}\ =\ 0.0;\ }
|
||||
@@ -50,238 +50,171 @@
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00061}00061\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00062}00062\ \ \ \ \ \};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00063}00063\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00070}\mbox{\hyperlink{structfourdst_1_1composition_1_1_global_composition}{00070}}\ \ \ \ \ \textcolor{keyword}{struct\ }\mbox{\hyperlink{structfourdst_1_1composition_1_1_global_composition}{GlobalComposition}}\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00071}\mbox{\hyperlink{structfourdst_1_1composition_1_1_global_composition_a0df6ecfe28d13cbffd0abcbfec9aee41}{00071}}\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_global_composition_a0df6ecfe28d13cbffd0abcbfec9aee41}{specificNumberDensity}};\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00072}\mbox{\hyperlink{structfourdst_1_1composition_1_1_global_composition_a9c35810d965841a755da9ce4644a2f1b}{00072}}\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_global_composition_a9c35810d965841a755da9ce4644a2f1b}{meanParticleMass}};\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00073}00073\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00074}00074\ \ \ \ \ \ \ \ \ \textcolor{comment}{//\ Overload\ the\ output\ stream\ operator\ for\ GlobalComposition}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00075}00075\ \ \ \ \ \ \ \ \ \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_l00076}00076\ \ \ \ \ \};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00077}00077\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00084}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry}{00084}}\ \ \ \ \ \textcolor{keyword}{struct\ }\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a1cccb94c150dd1dcde860f55fbeaf2bd}{CompositionEntry}}\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00085}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_ac273debdba6a1b3ac0f11698c399d38e}{00085}}\ \ \ \ \ \ \ \ \ std::string\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_ac273debdba6a1b3ac0f11698c399d38e}{m\_symbol}};\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00086}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a79039cbdc76b4401eb2ce44b85467503}{00086}}\ \ \ \ \ \ \ \ \ \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_l00087}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a1e860519bea86793413ed67c76d18c8b}{00087}}\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a1e860519bea86793413ed67c76d18c8b}{m\_massFracMode}}\ =\ \textcolor{keyword}{true};\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00088}00088\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00089}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_adc20165bf94e18eea3458003025579ac}{00089}}\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_adc20165bf94e18eea3458003025579ac}{m\_massFraction}}\ =\ 0.0;\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00090}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a2b5e245f7dabb11076efdbe1ed516d9f}{00090}}\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a2b5e245f7dabb11076efdbe1ed516d9f}{m\_numberFraction}}\ =\ 0.0;\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00091}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a0498d707d8ea78be39283786c10657ef}{00091}}\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a0498d707d8ea78be39283786c10657ef}{m\_relAbundance}}\ =\ 0.0;\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00092}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_acd41be41f03c819521bab28ea0d8bed2}{00092}}\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_acd41be41f03c819521bab28ea0d8bed2}{m\_molesPerMass}}\ =\ 0.0;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00093}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a3b056b6b923016d271f034333c96d039}{00093}}\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a3b056b6b923016d271f034333c96d039}{m\_cachedNumberFraction}}\ =\ 0.0;\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00094}00094\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00095}00095\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00096}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a391e899874cd7ef299a3ae1f64c016d2}{00096}}\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a391e899874cd7ef299a3ae1f64c016d2}{m\_initialized}}\ =\ \textcolor{keyword}{false};\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00097}00097\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00101}00101\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a1cccb94c150dd1dcde860f55fbeaf2bd}{CompositionEntry}}();}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00102}00102\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00114}00114\ \ \ \ \ \ \ \ \ \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_l00115}00115\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00120}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a38f3e109b2952c1f0e7444d7fb9e93a0}{00120}}\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a38f3e109b2952c1f0e7444d7fb9e93a0}{CompositionEntry}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a1cccb94c150dd1dcde860f55fbeaf2bd}{CompositionEntry}}\&\ entry);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00121}00121\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00128}00128\ \ \ \ \ \ \ \ \ \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_l00129}00129\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00134}00134\ \ \ \ \ \ \ \ \ [[nodiscard]]\ std::string\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a50d18b4c27611fa9314dd756af54c2f0}{symbol}}()\ \textcolor{keyword}{const};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00135}00135\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00142}00142\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a66cb086719d7f654869bd7b0cee87ffc}{mass\_fraction}}()\ \textcolor{keyword}{const};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00143}00143\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00150}00150\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a2d55492d285068d4a64db5602dfb1c78}{number\_fraction}}()\ \textcolor{keyword}{const};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00096}00096\ \ \ \ \ \textcolor{comment}{//\ ReSharper\ disable\ once\ CppClassCanBeFinal}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00097}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition}{00097}}\ \ \ \ \ \textcolor{keyword}{class\ }\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a23b83b76ee025f6fc009184ee19bba88}{Composition}}\ :\ \textcolor{keyword}{public}\ \mbox{\hyperlink{class_composition_abstract}{CompositionAbstract}}\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00098}00098\ \ \ \ \ \textcolor{keyword}{private}:}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00106}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache}{00106}}\ \ \ \ \ \ \ \ \ \textcolor{keyword}{struct\ }\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache}{CompositionCache}}\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00107}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_a459e01b94eb0e78dd95bb6932a967f13}{00107}}\ \ \ \ \ \ \ \ \ \ \ \ \ std::optional<CanonicalComposition>\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_a459e01b94eb0e78dd95bb6932a967f13}{canonicalComp}};\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00108}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_add5ce97ae6a1796c5f6488bfa1555be6}{00108}}\ \ \ \ \ \ \ \ \ \ \ \ \ std::optional<std::vector<double>>\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_add5ce97ae6a1796c5f6488bfa1555be6}{massFractions}};\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00109}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_a41ce9d6b4a0f00030e3027b23c0269fb}{00109}}\ \ \ \ \ \ \ \ \ \ \ \ \ std::optional<std::vector<double>>\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_a41ce9d6b4a0f00030e3027b23c0269fb}{numberFractions}};\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00110}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_ab74c9cd92ba8aaf5f95c8ca5284206a6}{00110}}\ \ \ \ \ \ \ \ \ \ \ \ \ std::optional<std::vector<double>>\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_ab74c9cd92ba8aaf5f95c8ca5284206a6}{molarAbundances}};\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00111}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_a14761ff2df5423884330e423ec38e98c}{00111}}\ \ \ \ \ \ \ \ \ \ \ \ \ std::optional<std::vector<atomic::Species>>\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_a14761ff2df5423884330e423ec38e98c}{sortedSpecies}};\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00112}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_abe45010a5104562d3ebecc77393c04ce}{00112}}\ \ \ \ \ \ \ \ \ \ \ \ \ std::optional<std::vector<std::string>>\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_abe45010a5104562d3ebecc77393c04ce}{sortedSymbols}};\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00113}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_ae844e5a1d2b85c7cfee50157ccf189ce}{00113}}\ \ \ \ \ \ \ \ \ \ \ \ \ std::optional<double>\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_ae844e5a1d2b85c7cfee50157ccf189ce}{Ye}};\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00114}00114\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00118}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_ac8b576c3b48c4cedda6e9e2790072b0d}{00118}}\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{void}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_ac8b576c3b48c4cedda6e9e2790072b0d}{clear}}()\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00119}00119\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_a459e01b94eb0e78dd95bb6932a967f13}{canonicalComp}}\ =\ std::nullopt;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00120}00120\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_add5ce97ae6a1796c5f6488bfa1555be6}{massFractions}}\ =\ std::nullopt;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00121}00121\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_a41ce9d6b4a0f00030e3027b23c0269fb}{numberFractions}}\ =\ std::nullopt;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00122}00122\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_ab74c9cd92ba8aaf5f95c8ca5284206a6}{molarAbundances}}\ =\ std::nullopt;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00123}00123\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_abe45010a5104562d3ebecc77393c04ce}{sortedSymbols}}\ =\ std::nullopt;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00124}00124\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_a14761ff2df5423884330e423ec38e98c}{sortedSpecies}}\ =\ std::nullopt;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00125}00125\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_ae844e5a1d2b85c7cfee50157ccf189ce}{Ye}}\ =\ std::nullopt;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00126}00126\ \ \ \ \ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00127}00127\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00132}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_af291583560120bb53c4546a598666477}{00132}}\ \ \ \ \ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_af291583560120bb53c4546a598666477}{is\_clear}}()\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00133}00133\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ !\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_a459e01b94eb0e78dd95bb6932a967f13}{canonicalComp}}.has\_value()\ \&\&\ !\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_add5ce97ae6a1796c5f6488bfa1555be6}{massFractions}}.has\_value()\ \&\&}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00134}00134\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ !\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_a41ce9d6b4a0f00030e3027b23c0269fb}{numberFractions}}.has\_value()\ \&\&\ !\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_ab74c9cd92ba8aaf5f95c8ca5284206a6}{molarAbundances}}.has\_value()\ \&\&\ !\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_abe45010a5104562d3ebecc77393c04ce}{sortedSymbols}}.has\_value()\ \&\&}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00135}00135\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ !\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_ae844e5a1d2b85c7cfee50157ccf189ce}{Ye}}.has\_value()\ \&\&\ !\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_a14761ff2df5423884330e423ec38e98c}{sortedSpecies}}.has\_value();}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00136}00136\ \ \ \ \ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00137}00137\ \ \ \ \ \ \ \ \ \};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00138}00138\ \ \ \ \ \textcolor{keyword}{private}:}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00144}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a46a706f9e4c06a45b45ae3dffdde5e9e}{00144}}\ \ \ \ \ \ \ \ \ \textcolor{keyword}{static}\ quill::Logger*\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a46a706f9e4c06a45b45ae3dffdde5e9e}{getLogger}}()\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00145}00145\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keyword}{static}\ quill::Logger*\ logger\ =\ logging::LogManager::getInstance().getLogger(\textcolor{stringliteral}{"{}log"{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00146}00146\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ logger;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00147}00147\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00148}00148\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00149}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a452b0affb86dc971a96c80d01f4fcb2b}{00149}}\ \ \ \ \ \ \ \ \ std::set<atomic::Species>\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a452b0affb86dc971a96c80d01f4fcb2b}{m\_registeredSpecies}};\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00150}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa05a640e0ea80142682bf4ee30a93c7f}{00150}}\ \ \ \ \ \ \ \ \ std::map<atomic::Species,\ double>\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa05a640e0ea80142682bf4ee30a93c7f}{m\_molarAbundances}};\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00151}00151\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00157}00157\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a2d55492d285068d4a64db5602dfb1c78}{number\_fraction}}(\textcolor{keywordtype}{double}\ totalMolesPerMass)\ \textcolor{keyword}{const};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00158}00158\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00163}00163\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_ab6619d23e111905d1e3ab16ee822d96c}{rel\_abundance}}()\ \textcolor{keyword}{const};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00164}00164\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00169}00169\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{atomic::Species}}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_af49920b1168be92d517aea03a308fee1}{isotope}}()\ \textcolor{keyword}{const};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00170}00170\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00175}00175\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a14f12b8b0178df2e32e2023bd4564ddc}{getMassFracMode}}()\ \textcolor{keyword}{const};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00176}00176\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00183}00183\ \ \ \ \ \ \ \ \ \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_l00184}00184\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00191}00191\ \ \ \ \ \ \ \ \ \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_l00192}00192\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00198}00198\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a3fb3f63a4e5675c6fefb662a8e3e7aa3}{setMassFracMode}}(\textcolor{keywordtype}{double}\ meanMolarMass);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00199}00199\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00205}00205\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry_a00332551f5b2f0d7f10b12a091e21fa8}{setNumberFracMode}}(\textcolor{keywordtype}{double}\ totalMolesPerMass);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00206}00206\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00213}00213\ \ \ \ \ \ \ \ \ \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_l00214}00214\ \ \ \ \ \};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00215}00215\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00255}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition}{00255}}\ \ \ \ \ \textcolor{keyword}{class\ }\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a23b83b76ee025f6fc009184ee19bba88}{Composition}}\ :\ \textcolor{keyword}{public}\ \mbox{\hyperlink{class_composition_abstract}{CompositionAbstract}}\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00256}00256\ \ \ \ \ \textcolor{keyword}{private}:}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00257}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache}{00257}}\ \ \ \ \ \ \ \ \ \textcolor{keyword}{struct\ }\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache}{CompositionCache}}\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00258}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_a9a9dc0e4ec0d094e604569de9ce6c125}{00258}}\ \ \ \ \ \ \ \ \ \ \ \ \ std::optional<GlobalComposition>\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_a9a9dc0e4ec0d094e604569de9ce6c125}{globalComp}};\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00259}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_a459e01b94eb0e78dd95bb6932a967f13}{00259}}\ \ \ \ \ \ \ \ \ \ \ \ \ std::optional<CanonicalComposition>\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_a459e01b94eb0e78dd95bb6932a967f13}{canonicalComp}};\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00260}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_add5ce97ae6a1796c5f6488bfa1555be6}{00260}}\ \ \ \ \ \ \ \ \ \ \ \ \ std::optional<std::vector<double>>\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_add5ce97ae6a1796c5f6488bfa1555be6}{massFractions}};\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00261}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_a41ce9d6b4a0f00030e3027b23c0269fb}{00261}}\ \ \ \ \ \ \ \ \ \ \ \ \ std::optional<std::vector<double>>\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_a41ce9d6b4a0f00030e3027b23c0269fb}{numberFractions}};\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00262}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_ab74c9cd92ba8aaf5f95c8ca5284206a6}{00262}}\ \ \ \ \ \ \ \ \ \ \ \ \ std::optional<std::vector<double>>\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_ab74c9cd92ba8aaf5f95c8ca5284206a6}{molarAbundances}};\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00263}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_a14761ff2df5423884330e423ec38e98c}{00263}}\ \ \ \ \ \ \ \ \ \ \ \ \ std::optional<std::vector<atomic::Species>>\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_a14761ff2df5423884330e423ec38e98c}{sortedSpecies}};\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00264}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_abe45010a5104562d3ebecc77393c04ce}{00264}}\ \ \ \ \ \ \ \ \ \ \ \ \ std::optional<std::vector<std::string>>\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_abe45010a5104562d3ebecc77393c04ce}{sortedSymbols}};\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00265}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_ae844e5a1d2b85c7cfee50157ccf189ce}{00265}}\ \ \ \ \ \ \ \ \ \ \ \ \ std::optional<double>\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_ae844e5a1d2b85c7cfee50157ccf189ce}{Ye}};\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00266}00266\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00267}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_ac8b576c3b48c4cedda6e9e2790072b0d}{00267}}\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{void}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_ac8b576c3b48c4cedda6e9e2790072b0d}{clear}}()\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00268}00268\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_a9a9dc0e4ec0d094e604569de9ce6c125}{globalComp}}\ =\ std::nullopt;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00269}00269\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_a459e01b94eb0e78dd95bb6932a967f13}{canonicalComp}}\ =\ std::nullopt;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00270}00270\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_add5ce97ae6a1796c5f6488bfa1555be6}{massFractions}}\ =\ std::nullopt;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00271}00271\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_a41ce9d6b4a0f00030e3027b23c0269fb}{numberFractions}}\ =\ std::nullopt;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00272}00272\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_ab74c9cd92ba8aaf5f95c8ca5284206a6}{molarAbundances}}\ =\ std::nullopt;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00273}00273\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_abe45010a5104562d3ebecc77393c04ce}{sortedSymbols}}\ =\ std::nullopt;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00274}00274\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_a14761ff2df5423884330e423ec38e98c}{sortedSpecies}}\ =\ std::nullopt;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00275}00275\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_ae844e5a1d2b85c7cfee50157ccf189ce}{Ye}}\ =\ std::nullopt;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00276}00276\ \ \ \ \ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00277}00277\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00278}\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_af291583560120bb53c4546a598666477}{00278}}\ \ \ \ \ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_af291583560120bb53c4546a598666477}{is\_clear}}()\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00279}00279\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ !\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_a9a9dc0e4ec0d094e604569de9ce6c125}{globalComp}}.has\_value()\ \&\&\ !\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_a459e01b94eb0e78dd95bb6932a967f13}{canonicalComp}}.has\_value()\ \&\&\ !\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_add5ce97ae6a1796c5f6488bfa1555be6}{massFractions}}.has\_value()\ \&\&}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00280}00280\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ !\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_a41ce9d6b4a0f00030e3027b23c0269fb}{numberFractions}}.has\_value()\ \&\&\ !\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_ab74c9cd92ba8aaf5f95c8ca5284206a6}{molarAbundances}}.has\_value()\ \&\&\ !\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_abe45010a5104562d3ebecc77393c04ce}{sortedSymbols}}.has\_value()\ \&\&}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00281}00281\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ !\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_ae844e5a1d2b85c7cfee50157ccf189ce}{Ye}}.has\_value()\ \&\&\ !\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache_a14761ff2df5423884330e423ec38e98c}{sortedSpecies}}.has\_value();}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00282}00282\ \ \ \ \ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00283}00283\ \ \ \ \ \ \ \ \ \};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00284}00284\ \ \ \ \ \textcolor{keyword}{private}:}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00285}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a1f96b2c567364368ea5ee6f0826f3091}{00285}}\ \ \ \ \ \ \ \ \ config::Config\&\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a1f96b2c567364368ea5ee6f0826f3091}{m\_config}}\ =\ config::Config::getInstance();}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00286}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a40b2128948f01630cd2968488b450ce5}{00286}}\ \ \ \ \ \ \ \ \ logging::LogManager\&\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a40b2128948f01630cd2968488b450ce5}{m\_logManager}}\ =\ logging::LogManager::getInstance();}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00287}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ab6c66f35e1fb05dd24aacaf90e115c5e}{00287}}\ \ \ \ \ \ \ \ \ quill::Logger*\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ab6c66f35e1fb05dd24aacaf90e115c5e}{m\_logger}}\ =\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a40b2128948f01630cd2968488b450ce5}{m\_logManager}}.getLogger(\textcolor{stringliteral}{"{}log"{}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00288}00288\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00289}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa00cbc0933d8a22bb900ac21a338e5ac}{00289}}\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa00cbc0933d8a22bb900ac21a338e5ac}{m\_finalized}}\ =\ \textcolor{keyword}{false};\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00290}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_addae4484da7d5072ab66a721dbe04ced}{00290}}\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_addae4484da7d5072ab66a721dbe04ced}{m\_specificNumberDensity}}\ =\ 0.0;\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00291}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a4a36c8d22ce61023e7bea1d9417577d4}{00291}}\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a4a36c8d22ce61023e7bea1d9417577d4}{m\_meanParticleMass}}\ =\ 0.0;\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00292}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a671f1ee8be00f4ff8c1d94fabb382380}{00292}}\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a671f1ee8be00f4ff8c1d94fabb382380}{m\_massFracMode}}\ =\ \textcolor{keyword}{true};\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00293}00293\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00294}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a39bfcb7d81d723cbd9d021abd533b4d6}{00294}}\ \ \ \ \ \ \ \ \ std::set<std::string>\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a39bfcb7d81d723cbd9d021abd533b4d6}{m\_registeredSymbols}};\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00295}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa7f2753b10e85ae3bbf0c3d600a973db}{00295}}\ \ \ \ \ \ \ \ \ std::unordered\_map<std::string,\ CompositionEntry>\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa7f2753b10e85ae3bbf0c3d600a973db}{m\_compositions}};\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00296}00296\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00297}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a02cd9d9608da082a200fdfa86d14bf5d}{00297}}\ \ \ \ \ \ \ \ \ \textcolor{keyword}{mutable}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache}{CompositionCache}}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a02cd9d9608da082a200fdfa86d14bf5d}{m\_cache}};\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00298}00298\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00152}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a02cd9d9608da082a200fdfa86d14bf5d}{00152}}\ \ \ \ \ \ \ \ \ \textcolor{keyword}{mutable}\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache}{CompositionCache}}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a02cd9d9608da082a200fdfa86d14bf5d}{m\_cache}};\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00153}00153\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00154}00154\ \ \ \ \ \textcolor{keyword}{public}:}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00160}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a23b83b76ee025f6fc009184ee19bba88}{00160}}\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a23b83b76ee025f6fc009184ee19bba88}{Composition}}()\ =\ \textcolor{keywordflow}{default};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00161}00161\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00165}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a08c1d1fe9384c5255a6ba40e34b18315}{00165}}\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a08c1d1fe9384c5255a6ba40e34b18315}{\string~Composition}}()\ \textcolor{keyword}{override}\ =\ \textcolor{keywordflow}{default};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00166}00166\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00177}00177\ \ \ \ \ \ \ \ \ \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_l00178}00178\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00192}00192\ \ \ \ \ \ \ \ \ \textcolor{keyword}{explicit}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a23b83b76ee025f6fc009184ee19bba88}{Composition}}(\textcolor{keyword}{const}\ std::vector<atomic::Species>\&\ species);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00193}00193\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00204}00204\ \ \ \ \ \ \ \ \ \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_l00205}00205\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00219}00219\ \ \ \ \ \ \ \ \ \textcolor{keyword}{explicit}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a23b83b76ee025f6fc009184ee19bba88}{Composition}}(\textcolor{keyword}{const}\ std::set<atomic::Species>\&\ species);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00220}00220\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00236}00236\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a23b83b76ee025f6fc009184ee19bba88}{Composition}}(\textcolor{keyword}{const}\ std::vector<std::string>\&\ symbols,\ \textcolor{keyword}{const}\ std::vector<double>\&\ molarAbundances);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00237}00237\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00252}00252\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a23b83b76ee025f6fc009184ee19bba88}{Composition}}(\textcolor{keyword}{const}\ std::vector<atomic::Species>\&\ species,\ \textcolor{keyword}{const}\ std::vector<double>\&\ molarAbundances);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00253}00253\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00269}00269\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a23b83b76ee025f6fc009184ee19bba88}{Composition}}(\textcolor{keyword}{const}\ std::set<std::string>\&\ symbols,\ \textcolor{keyword}{const}\ std::vector<double>\&\ molarAbundances);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00270}00270\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00275}00275\ \ \ \ \ \ \ \ \ \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_l00276}00276\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00282}00282\ \ \ \ \ \ \ \ \ \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_l00283}00283\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00298}00298\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{void}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a3ab4dcda0bfd1a35b169bcc57fe66725}{registerSymbol}}(\textcolor{keyword}{const}\ std::string\&\ symbol);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00299}00299\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00305}00305\ \ \ \ \ \ \ \ \ \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_l00306}00306\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00312}00312\ \ \ \ \ \ \ \ \ [[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_l00313}00313\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00319}00319\ \ \ \ \ \ \ \ \ \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_l00320}00320\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00326}00326\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a869dbae3db9d09c57b2df56a813a55fb}{finalizeMassFracMode}}(\textcolor{keywordtype}{bool}\ norm);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00327}00327\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00333}00333\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a461ab4e9cb5975cf865db5f16f03ddfe}{finalizeNumberFracMode}}(\textcolor{keywordtype}{bool}\ norm);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00334}00334\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00335}00335\ \ \ \ \ \textcolor{keyword}{public}:}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00339}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a23b83b76ee025f6fc009184ee19bba88}{00339}}\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a23b83b76ee025f6fc009184ee19bba88}{Composition}}()\ =\ \textcolor{keywordflow}{default};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00314}00314\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{void}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a3ab4dcda0bfd1a35b169bcc57fe66725}{registerSymbol}}(\textcolor{keyword}{const}\ std::vector<std::string>\&\ symbols);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00315}00315\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00338}00338\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{void}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a392a34c19f45d6c936cc7030e6cfaf3f}{registerSpecies}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{atomic::Species}}\&\ species)\ \textcolor{keyword}{noexcept};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00339}00339\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00340}00340\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00344}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a08c1d1fe9384c5255a6ba40e34b18315}{00344}}\ \ \ \ \ \ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a08c1d1fe9384c5255a6ba40e34b18315}{\string~Composition}}()\ \textcolor{keyword}{override}\ =\ \textcolor{keywordflow}{default};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00345}00345\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00355}00355\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \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_l00356}00356\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00370}00370\ \ \ \ \ \ \ \ \ \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_l00371}00371\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00382}00382\ \ \ \ \ \ \ \ \ \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_l00383}00383\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00401}00401\ \ \ \ \ \ \ \ \ \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_l00402}00402\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00407}00407\ \ \ \ \ \ \ \ \ \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_l00408}00408\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00414}00414\ \ \ \ \ \ \ \ \ \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_l00415}00415\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00430}00430\ \ \ \ \ \ \ \ \ \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_l00431}00431\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00445}00445\ \ \ \ \ \ \ \ \ \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_l00446}00446\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00460}00460\ \ \ \ \ \ \ \ \ \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_l00461}00461\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00462}00462\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00477}00477\ \ \ \ \ \ \ \ \ \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_l00478}00478\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00479}00479\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00484}00484\ \ \ \ \ \ \ \ \ [[nodiscard]]\ std::set<std::string>\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a3f10f38878ba4be121d6d77a8b1f4d7a}{getRegisteredSymbols}}()\ \textcolor{keyword}{const\ override};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00485}00485\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00490}00490\ \ \ \ \ \ \ \ \ [[nodiscard]]\ std::set<fourdst::atomic::Species>\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_af61ebe73a8b5926eb23037bb078fa87a}{getRegisteredSpecies}}()\ \textcolor{keyword}{const\ override};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00360}00360\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{void}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a392a34c19f45d6c936cc7030e6cfaf3f}{registerSpecies}}(\textcolor{keyword}{const}\ std::vector<atomic::Species>\&\ species)\ \textcolor{keyword}{noexcept};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00361}00361\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00367}00367\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a194f715788e7921bd611579440de2ecd}{contains}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{atomic::Species}}\&\ species)\ \textcolor{keyword}{const}\ \textcolor{keyword}{noexcept}\ \textcolor{keyword}{override};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00368}00368\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00375}00375\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a194f715788e7921bd611579440de2ecd}{contains}}(\textcolor{keyword}{const}\ std::string\&\ symbol)\ \textcolor{keyword}{const\ override};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00376}00376\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00381}00381\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{size\_t}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a9d177d36b728442bcbd8cb66712c7c75}{size}}()\ const\ noexcept\ override;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00382}00382\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00399}00399\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{void}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a262d7133035d4e6f45daa81827abf5e7}{setMolarAbundance}}(}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00400}00400\ \ \ \ \ \ \ \ \ \ \ \ \ const\ std::\textcolor{keywordtype}{string}\&\ symbol,}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00401}00401\ \ \ \ \ \ \ \ \ \ \ \ \ const\ \textcolor{keywordtype}{double}\&\ molar\_abundance}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00402}00402\ \ \ \ \ \ \ \ \ );}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00403}00403\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00423}00423\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{void}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a262d7133035d4e6f45daa81827abf5e7}{setMolarAbundance}}(}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00424}00424\ \ \ \ \ \ \ \ \ \ \ \ \ const\ \mbox{\hyperlink{namespacefourdst_1_1atomic}{atomic}}::Species\&\ species,}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00425}00425\ \ \ \ \ \ \ \ \ \ \ \ \ const\ \textcolor{keywordtype}{double}\&\ molar\_abundance}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00426}00426\ \ \ \ \ \ \ \ \ );}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00427}00427\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00443}00443\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{void}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a262d7133035d4e6f45daa81827abf5e7}{setMolarAbundance}}(}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00444}00444\ \ \ \ \ \ \ \ \ \ \ \ \ const\ std::vector<std::\textcolor{keywordtype}{string}>\&\ symbols,}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00445}00445\ \ \ \ \ \ \ \ \ \ \ \ \ const\ std::vector<\textcolor{keywordtype}{double}>\&\ molar\_abundances}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00446}00446\ \ \ \ \ \ \ \ \ );}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00447}00447\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00466}00466\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{void}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a262d7133035d4e6f45daa81827abf5e7}{setMolarAbundance}}(}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00467}00467\ \ \ \ \ \ \ \ \ \ \ \ \ const\ std::vector<\mbox{\hyperlink{namespacefourdst_1_1atomic}{atomic}}::Species>\&\ species,}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00468}00468\ \ \ \ \ \ \ \ \ \ \ \ \ const\ std::vector<\textcolor{keywordtype}{double}>\&\ molar\_abundances}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00469}00469\ \ \ \ \ \ \ \ \ );}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00470}00470\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00487}00487\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{void}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a262d7133035d4e6f45daa81827abf5e7}{setMolarAbundance}}(}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00488}00488\ \ \ \ \ \ \ \ \ \ \ \ \ const\ std::set<std::\textcolor{keywordtype}{string}>\&\ symbols,}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00489}00489\ \ \ \ \ \ \ \ \ \ \ \ \ const\ std::vector<\textcolor{keywordtype}{double}>\&\ molar\_abundances}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00490}00490\ \ \ \ \ \ \ \ \ );}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00491}00491\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00508}00508\ \ \ \ \ \ \ \ \ \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_l00509}00509\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00519}00519\ \ \ \ \ \ \ \ \ 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_l00520}00520\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00530}00530\ \ \ \ \ \ \ \ \ \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_l00531}00531\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00539}00539\ \ \ \ \ \ \ \ \ 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_l00540}00540\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00551}00551\ \ \ \ \ \ \ \ \ \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_l00552}00552\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00561}00561\ \ \ \ \ \ \ \ \ 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_l00562}00562\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00572}00572\ \ \ \ \ \ \ \ \ \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_l00573}00573\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00581}00581\ \ \ \ \ \ \ \ \ 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_l00511}00511\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{void}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a262d7133035d4e6f45daa81827abf5e7}{setMolarAbundance}}(}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00512}00512\ \ \ \ \ \ \ \ \ \ \ \ \ const\ std::set<\mbox{\hyperlink{namespacefourdst_1_1atomic}{atomic}}::Species>\&\ species,}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00513}00513\ \ \ \ \ \ \ \ \ \ \ \ \ const\ std::vector<\textcolor{keywordtype}{double}>\&\ molar\_abundances}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00514}00514\ \ \ \ \ \ \ \ \ );}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00515}00515\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00524}00524\ \ \ \ \ \ \ \ \ [[nodiscard]]\ std::set<std::\textcolor{keywordtype}{string}>\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a3ae885c28580ae15be8c16614bef3b0e}{getRegisteredSymbols}}()\ const\ noexcept\ override;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00525}00525\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00534}00534\ \ \ \ \ \ \ \ \ [[nodiscard]]\ const\ std::set<\mbox{\hyperlink{namespacefourdst_1_1atomic}{atomic}}::Species>\ \&\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a33db253ca50431b5166d43412ff18f71}{getRegisteredSpecies}}()\ const\ noexcept\ override;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00535}00535\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00542}00542\ \ \ \ \ \ \ \ \ [[nodiscard]]\ std::unordered\_map<\mbox{\hyperlink{namespacefourdst_1_1atomic}{atomic}}::Species,\ \textcolor{keywordtype}{double}>\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a9ea2b673341fdc67afeb0f0517a54c8c}{getMassFraction}}()\ const\ noexcept\ override;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00543}00543\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00552}00552\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a9ea2b673341fdc67afeb0f0517a54c8c}{getMassFraction}}(const\ std::\textcolor{keywordtype}{string}\&\ symbol)\ const\ override;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00553}00553\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00571}00571\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a9ea2b673341fdc67afeb0f0517a54c8c}{getMassFraction}}(const\ \mbox{\hyperlink{namespacefourdst_1_1atomic}{atomic}}::Species\&\ species)\ const\ override;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00572}00572\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00581}00581\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a34f71d4d8f0297c576fd62fabd490305}{getNumberFraction}}(const\ std::\textcolor{keywordtype}{string}\&\ symbol)\ const\ override;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00582}00582\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00595}00595\ \ \ \ \ \ \ \ \ [[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_l00596}00596\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00603}00603\ \ \ \ \ \ \ \ \ [[nodiscard]]\ std::unordered\_map<std::string,\ double>\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aae07019ab6e02394e6ea353e0b98a417}{getMassFraction}}()\ \textcolor{keyword}{const\ override};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00604}00604\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00613}00613\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aae07019ab6e02394e6ea353e0b98a417}{getMassFraction}}(\textcolor{keyword}{const}\ std::string\&\ symbol)\ \textcolor{keyword}{const\ override};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00614}00614\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00623}00623\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aae07019ab6e02394e6ea353e0b98a417}{getMassFraction}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{fourdst::atomic::Species}}\&\ species)\ \textcolor{keyword}{const\ override};}
|
||||
\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_ae46fb8c3020dadd69080a7acd2054ea1}{getNumberFraction}}(\textcolor{keyword}{const}\ std::string\&\ symbol)\ \textcolor{keyword}{const\ override};}
|
||||
\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_ae46fb8c3020dadd69080a7acd2054ea1}{getNumberFraction}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{fourdst::atomic::Species}}\&\ species)\ \textcolor{keyword}{const\ override};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00644}00644\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00651}00651\ \ \ \ \ \ \ \ \ [[nodiscard]]\ std::unordered\_map<std::string,\ double>\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ae46fb8c3020dadd69080a7acd2054ea1}{getNumberFraction}}()\ \textcolor{keyword}{const\ override};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00652}00652\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00661}00661\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_add67a92d73e3a57a2bbdb52bc9ca3bfe}{getMolarAbundance}}(\textcolor{keyword}{const}\ std::string\&\ symbol)\ \textcolor{keyword}{const\ override};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00599}00599\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a34f71d4d8f0297c576fd62fabd490305}{getNumberFraction}}(const\ \mbox{\hyperlink{namespacefourdst_1_1atomic}{atomic}}::Species\&\ species)\ const\ override;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00600}00600\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00607}00607\ \ \ \ \ \ \ \ \ [[nodiscard]]\ std::unordered\_map<\mbox{\hyperlink{namespacefourdst_1_1atomic}{atomic}}::Species,\ \textcolor{keywordtype}{double}>\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a34f71d4d8f0297c576fd62fabd490305}{getNumberFraction}}()\ const\ noexcept\ override;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00608}00608\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00619}00619\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_add67a92d73e3a57a2bbdb52bc9ca3bfe}{getMolarAbundance}}(const\ std::\textcolor{keywordtype}{string}\&\ symbol)\ const\ override;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00620}00620\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00630}00630\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_add67a92d73e3a57a2bbdb52bc9ca3bfe}{getMolarAbundance}}(const\ \mbox{\hyperlink{namespacefourdst_1_1atomic}{atomic}}::Species\&\ species)\ const\ override;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00631}00631\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00645}00645\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_afbbb5e51ad5ae5c0fa6bc0094195aecd}{getMeanParticleMass}}()\ const\ noexcept\ override;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00646}00646\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00660}00660\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a90fc71d1fe03017ee4c7a1cac69d24fb}{getElectronAbundance}}()\ const\ noexcept\ override;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00661}00661\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00662}00662\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00671}00671\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_add67a92d73e3a57a2bbdb52bc9ca3bfe}{getMolarAbundance}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{fourdst::atomic::Species}}\&\ species)\ \textcolor{keyword}{const\ override};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00672}00672\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00681}00681\ \ \ \ \ \ \ \ \ [[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_l00682}00682\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00691}00691\ \ \ \ \ \ \ \ \ [[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_l00677}00677\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \mbox{\hyperlink{structfourdst_1_1composition_1_1_canonical_composition}{CanonicalComposition}}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aac5b214a3d1278e127422224cb9cee50}{getCanonicalComposition}}()\ const;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00678}00678\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00684}00684\ \ \ \ \ \ \ \ \ [[nodiscard]]\ std::vector<\textcolor{keywordtype}{double}>\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_af4f44aaf8b7e0d63872a70b5e2131369}{getMassFractionVector}}()\ const\ noexcept\ override;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00685}00685\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00691}00691\ \ \ \ \ \ \ \ \ [[nodiscard]]\ std::vector<\textcolor{keywordtype}{double}>\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ae4f72972cf4d1ff422d0790080e11473}{getNumberFractionVector}}()\ const\ noexcept\ override;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00692}00692\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00699}00699\ \ \ \ \ \ \ \ \ [[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_l00700}00700\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00707}00707\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a796386824d1358527fed7c6b537935d8}{getMeanParticleMass}}()\ \textcolor{keyword}{const\ override};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00708}00708\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00715}00715\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_af7dd8f7d69727acfacf1bf58c4083a27}{getMeanAtomicNumber}}()\ \textcolor{keyword}{const\ override};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00716}00716\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00723}00723\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{double}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a62dcfcf8f824d6af7903a9a9c3d5721e}{getElectronAbundance}}()\ \textcolor{keyword}{const\ override};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00724}00724\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00734}00734\ \ \ \ \ \ \ \ \ [[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_l00698}00698\ \ \ \ \ \ \ \ \ [[nodiscard]]\ std::vector<\textcolor{keywordtype}{double}>\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_abcb391f5fca2b636127e48e681e4c3ee}{getMolarAbundanceVector}}()\ const\ noexcept\ override;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00699}00699\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00708}00708\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{size\_t}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a0d94f62402bb90b5d12679faeaa8c5d7}{getSpeciesIndex}}(const\ std::\textcolor{keywordtype}{string}\&\ symbol)\ const\ override;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00709}00709\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00717}00717\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{size\_t}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a0d94f62402bb90b5d12679faeaa8c5d7}{getSpeciesIndex}}(const\ \mbox{\hyperlink{namespacefourdst_1_1atomic}{atomic}}::Species\&\ species)\ const\ override;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00718}00718\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00726}00726\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \mbox{\hyperlink{namespacefourdst_1_1atomic}{atomic}}::Species\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ae4f854ded38f5e6fcd157a74a57cbf0c}{getSpeciesAtIndex}}(\textcolor{keywordtype}{size\_t}\ index)\ const\ override;}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00727}00727\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00734}00734\ \ \ \ \ \ \ \ \ friend\ std::ostream\&\ operator<<(std::ostream\&\ os,\ const\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a23b83b76ee025f6fc009184ee19bba88}{Composition}}\&\ \mbox{\hyperlink{namespacefourdst_1_1composition}{composition}});}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00735}00735\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00741}00741\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ac01ae1967c266d8187bc6e104c8a0d19}{hasSymbol}}(\textcolor{keyword}{const}\ std::string\&\ symbol)\ \textcolor{keyword}{const\ override};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00742}00742\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00748}00748\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a55dfadad6cf5fb249356edad1733a813}{hasSpecies}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{fourdst::atomic::Species}}\ \&species)\ \textcolor{keyword}{const\ override};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00749}00749\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00757}00757\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a7efe2cd3a69b743bf2086941b6dfd965}{contains}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{atomic::Species}}\&\ isotope)\ \textcolor{keyword}{const\ override};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00758}00758\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00767}00767\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{void}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a0af981ed1074b26c237cf6cf35f82c9e}{setCompositionMode}}(\textcolor{keywordtype}{bool}\ massFracMode);}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00768}00768\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00778}00778\ \ \ \ \ \ \ \ \ [[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_l00779}00779\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00787}00787\ \ \ \ \ \ \ \ \ [[nodiscard]]\ std::vector<double>\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a85169b763138ab72047e43e07af978fb}{getMassFractionVector}}()\ \textcolor{keyword}{const\ override};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00788}00788\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00796}00796\ \ \ \ \ \ \ \ \ [[nodiscard]]\ std::vector<double>\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a49d2eba540f28324c6b7145a5b6cabfd}{getNumberFractionVector}}()\ \textcolor{keyword}{const\ override};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00797}00797\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00805}00805\ \ \ \ \ \ \ \ \ [[nodiscard]]\ std::vector<double>\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_abed665c07c42b40682da453576621399}{getMolarAbundanceVector}}()\ \textcolor{keyword}{const\ override};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00806}00806\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00817}00817\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{size\_t}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a0d94f62402bb90b5d12679faeaa8c5d7}{getSpeciesIndex}}(\textcolor{keyword}{const}\ std::string\&\ symbol)\ \textcolor{keyword}{const\ override};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00818}00818\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00829}00829\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{size\_t}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a0d94f62402bb90b5d12679faeaa8c5d7}{getSpeciesIndex}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{atomic::Species}}\&\ species)\ \textcolor{keyword}{const\ override};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00830}00830\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00840}00840\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{atomic::Species}}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ae4f854ded38f5e6fcd157a74a57cbf0c}{getSpeciesAtIndex}}(\textcolor{keywordtype}{size\_t}\ index)\ \textcolor{keyword}{const\ override};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00841}00841\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00848}00848\ \ \ \ \ \ \ \ \ \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_l00849}00849\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00858}00858\ \ \ \ \ \ \ \ \ \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_l00859}00859\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00864}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ab1701644ff1c83c220dc04eb58d1621b}{00864}}\ \ \ \ \ \ \ \ \ \textcolor{keyword}{auto}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ab1701644ff1c83c220dc04eb58d1621b}{begin}}()\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00865}00865\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa7f2753b10e85ae3bbf0c3d600a973db}{m\_compositions}}.begin();}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00866}00866\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00867}00867\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00872}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_adf41a833e8b704daf4f581fca5c8cb9b}{00872}}\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keyword}{auto}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_adf41a833e8b704daf4f581fca5c8cb9b}{begin}}()\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00873}00873\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa7f2753b10e85ae3bbf0c3d600a973db}{m\_compositions}}.cbegin();}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00874}00874\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00875}00875\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00880}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_adeaf6f1213e78cb1fe8a8317f0a8adc2}{00880}}\ \ \ \ \ \ \ \ \ \textcolor{keyword}{auto}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_adeaf6f1213e78cb1fe8a8317f0a8adc2}{end}}()\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00881}00881\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa7f2753b10e85ae3bbf0c3d600a973db}{m\_compositions}}.end();}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00882}00882\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00883}00883\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00888}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aed2f5676f8f742199f01e4d1e9664bdd}{00888}}\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keyword}{auto}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aed2f5676f8f742199f01e4d1e9664bdd}{end}}()\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00889}00889\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa7f2753b10e85ae3bbf0c3d600a973db}{m\_compositions}}.cend();}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00890}00890\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00891}00891\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00892}00892\ \ \ \ \ \};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00893}00893\ \};\ \textcolor{comment}{//\ namespace\ fourdst::composition}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00753}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ab1701644ff1c83c220dc04eb58d1621b}{00753}}\ \ \ \ \ \ \ \ \ auto\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_ab1701644ff1c83c220dc04eb58d1621b}{begin}}()\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00754}00754\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa05a640e0ea80142682bf4ee30a93c7f}{m\_molarAbundances}}.begin();}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00755}00755\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00756}00756\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00774}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_adf41a833e8b704daf4f581fca5c8cb9b}{00774}}\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keyword}{auto}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_adf41a833e8b704daf4f581fca5c8cb9b}{begin}}()\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00775}00775\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa05a640e0ea80142682bf4ee30a93c7f}{m\_molarAbundances}}.cbegin();}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00776}00776\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00777}00777\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00795}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_adeaf6f1213e78cb1fe8a8317f0a8adc2}{00795}}\ \ \ \ \ \ \ \ \ \textcolor{keyword}{auto}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_adeaf6f1213e78cb1fe8a8317f0a8adc2}{end}}()\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00796}00796\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa05a640e0ea80142682bf4ee30a93c7f}{m\_molarAbundances}}.end();}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00797}00797\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00798}00798\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00816}\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aed2f5676f8f742199f01e4d1e9664bdd}{00816}}\ \ \ \ \ \ \ \ \ [[nodiscard]]\ \textcolor{keyword}{auto}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aed2f5676f8f742199f01e4d1e9664bdd}{end}}()\textcolor{keyword}{\ const\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00817}00817\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aa05a640e0ea80142682bf4ee30a93c7f}{m\_molarAbundances}}.cend();}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00818}00818\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00819}00819\ }
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00820}00820\ \ \ \ \ \};}
|
||||
\DoxyCodeLine{\Hypertarget{composition_8h_source_l00821}00821\ \};\ \textcolor{comment}{//\ namespace\ fourdst::composition}}
|
||||
|
||||
\end{DoxyCode}
|
||||
|
||||
@@ -1,7 +1,16 @@
|
||||
\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}}
|
||||
Directory dependency graph for fourdst\+:\nopagebreak
|
||||
\begin{figure}[H]
|
||||
\begin{center}
|
||||
\leavevmode
|
||||
\includegraphics[width=260pt]{dir_3c9efac6790a3720e63e1a08c00d11f2_dep}
|
||||
\end{center}
|
||||
\end{figure}
|
||||
\doxysubsubsection*{Directories}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
directory \mbox{\hyperlink{dir_22f8ab1532b3f549185d596a293d3842}{atomic}}
|
||||
\item
|
||||
directory \mbox{\hyperlink{dir_f0fdd83dd0cb4aa6fd6a832374ae4f05}{composition}}
|
||||
\end{DoxyCompactItemize}
|
||||
|
||||
@@ -1,5 +1,12 @@
|
||||
\doxysection{src/composition Directory Reference}
|
||||
\hypertarget{dir_425afc2e69e55565110382214454a15b}{}\label{dir_425afc2e69e55565110382214454a15b}\index{src/composition Directory Reference@{src/composition Directory Reference}}
|
||||
Directory dependency graph for composition\+:\nopagebreak
|
||||
\begin{figure}[H]
|
||||
\begin{center}
|
||||
\leavevmode
|
||||
\includegraphics[width=243pt]{dir_425afc2e69e55565110382214454a15b_dep}
|
||||
\end{center}
|
||||
\end{figure}
|
||||
\doxysubsubsection*{Directories}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
|
||||
@@ -1,5 +1,12 @@
|
||||
\doxysection{src Directory Reference}
|
||||
\hypertarget{dir_68267d1309a1af8e8297ef4c3efbcdba}{}\label{dir_68267d1309a1af8e8297ef4c3efbcdba}\index{src Directory Reference@{src Directory Reference}}
|
||||
Directory dependency graph for src\+:\nopagebreak
|
||||
\begin{figure}[H]
|
||||
\begin{center}
|
||||
\leavevmode
|
||||
\includegraphics[width=228pt]{dir_68267d1309a1af8e8297ef4c3efbcdba_dep}
|
||||
\end{center}
|
||||
\end{figure}
|
||||
\doxysubsubsection*{Directories}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
|
||||
@@ -1,5 +1,12 @@
|
||||
\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}}
|
||||
Directory dependency graph for exceptions\+:\nopagebreak
|
||||
\begin{figure}[H]
|
||||
\begin{center}
|
||||
\leavevmode
|
||||
\includegraphics[width=176pt]{dir_88aa30610c51652b536406602eb05405_dep}
|
||||
\end{center}
|
||||
\end{figure}
|
||||
\doxysubsubsection*{Files}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
|
||||
@@ -1,2 +1,9 @@
|
||||
\doxysection{docs/static Directory Reference}
|
||||
\hypertarget{dir_c34d5e8363cf0aa3fabc4f3fad3412a4}{}\label{dir_c34d5e8363cf0aa3fabc4f3fad3412a4}\index{docs/static Directory Reference@{docs/static Directory Reference}}
|
||||
Directory dependency graph for static\+:\nopagebreak
|
||||
\begin{figure}[H]
|
||||
\begin{center}
|
||||
\leavevmode
|
||||
\includegraphics[width=152pt]{dir_c34d5e8363cf0aa3fabc4f3fad3412a4_dep}
|
||||
\end{center}
|
||||
\end{figure}
|
||||
|
||||
@@ -1,5 +1,12 @@
|
||||
\doxysection{src/composition/include Directory Reference}
|
||||
\hypertarget{dir_cb6fc2f7165eff3b2362b2440dfaea8e}{}\label{dir_cb6fc2f7165eff3b2362b2440dfaea8e}\index{src/composition/include Directory Reference@{src/composition/include Directory Reference}}
|
||||
Directory dependency graph for include\+:\nopagebreak
|
||||
\begin{figure}[H]
|
||||
\begin{center}
|
||||
\leavevmode
|
||||
\includegraphics[width=238pt]{dir_cb6fc2f7165eff3b2362b2440dfaea8e_dep}
|
||||
\end{center}
|
||||
\end{figure}
|
||||
\doxysubsubsection*{Directories}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
|
||||
@@ -1,7 +1,16 @@
|
||||
\doxysection{src/composition/lib Directory Reference}
|
||||
\hypertarget{dir_e22a97de167fe22ecd13733f7a34b9f0}{}\label{dir_e22a97de167fe22ecd13733f7a34b9f0}\index{src/composition/lib Directory Reference@{src/composition/lib Directory Reference}}
|
||||
Directory dependency graph for lib\+:\nopagebreak
|
||||
\begin{figure}[H]
|
||||
\begin{center}
|
||||
\leavevmode
|
||||
\includegraphics[width=164pt]{dir_e22a97de167fe22ecd13733f7a34b9f0_dep}
|
||||
\end{center}
|
||||
\end{figure}
|
||||
\doxysubsubsection*{Files}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
file \mbox{\hyperlink{composition_8cpp}{composition.\+cpp}}
|
||||
\item
|
||||
file \mbox{\hyperlink{utils_8cpp}{utils.\+cpp}}
|
||||
\end{DoxyCompactItemize}
|
||||
|
||||
@@ -1,5 +1,12 @@
|
||||
\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}}
|
||||
Directory dependency graph for composition\+:\nopagebreak
|
||||
\begin{figure}[H]
|
||||
\begin{center}
|
||||
\leavevmode
|
||||
\includegraphics[width=278pt]{dir_f0fdd83dd0cb4aa6fd6a832374ae4f05_dep}
|
||||
\end{center}
|
||||
\end{figure}
|
||||
\doxysubsubsection*{Directories}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
@@ -8,13 +15,9 @@ directory \mbox{\hyperlink{dir_88aa30610c51652b536406602eb05405}{exceptions}}
|
||||
\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{composition__abstract_8h}{composition\+\_\+abstract.\+h}}
|
||||
\item
|
||||
file \mbox{\hyperlink{elements_8h}{elements.\+h}}
|
||||
\begin{DoxyCompactList}\small\item\em Provides mappings between atomic numbers and element symbols for the periodic table. \end{DoxyCompactList}\item
|
||||
file \mbox{\hyperlink{species_8h}{species.\+h}}
|
||||
file \mbox{\hyperlink{utils_8h}{utils.\+h}}
|
||||
\end{DoxyCompactItemize}
|
||||
|
||||
@@ -2,37 +2,39 @@
|
||||
\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
|
||||
Include dependency graph for exceptions\+\_\+composition.\+h\+:\nopagebreak
|
||||
\begin{figure}[H]
|
||||
\begin{center}
|
||||
\leavevmode
|
||||
\includegraphics[width=235pt]{exceptions__composition_8h__incl}
|
||||
\end{center}
|
||||
\end{figure}
|
||||
This graph shows which files directly or indirectly include this file\+:\nopagebreak
|
||||
\begin{figure}[H]
|
||||
\begin{center}
|
||||
\leavevmode
|
||||
\includegraphics[width=294pt]{exceptions__composition_8h__dep__incl}
|
||||
\end{center}
|
||||
\end{figure}
|
||||
\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}
|
||||
class \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_species_error}{fourdst\+::composition\+::exceptions\+::\+Species\+Error}}
|
||||
\begin{DoxyCompactList}\small\item\em Base class for exceptions related to atomic species. \end{DoxyCompactList}\item
|
||||
class \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_unknown_symbol_error}{fourdst\+::composition\+::exceptions\+::\+Unknown\+Symbol\+Error}}
|
||||
\begin{DoxyCompactList}\small\item\em Exception thrown when an unknown symbol is encountered. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
\doxysubsubsection*{Namespaces}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
namespace \mbox{\hyperlink{namespacefourdst}{fourdst}}
|
||||
\item
|
||||
namespace \mbox{\hyperlink{namespacefourdst_1_1composition}{fourdst\+::composition}}
|
||||
\item
|
||||
\begin{DoxyCompactList}\small\item\em Utilities and types for representing and manipulating chemical compositions. \end{DoxyCompactList}\item
|
||||
namespace \mbox{\hyperlink{namespacefourdst_1_1composition_1_1exceptions}{fourdst\+::composition\+::exceptions}}
|
||||
\end{DoxyCompactItemize}
|
||||
|
||||
@@ -20,54 +20,30 @@
|
||||
\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\ \}}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00041}\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_composition_error}{00041}}\ \ \ \ \ \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_l00042}00042\ \ \ \ \ \ \ \ \ \textcolor{keyword}{using\ }\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error_aef0cd13a4d1eb60b6d75ca5480e9146c}{CompositionError::CompositionError}};}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00043}00043\ \ \ \ \ \};}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00044}00044\ }
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00051}\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_unregistered_symbol_error}{00051}}\ \ \ \ \ \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_l00052}00052\ \ \ \ \ \ \ \ \ \textcolor{keyword}{using\ }\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error_aef0cd13a4d1eb60b6d75ca5480e9146c}{CompositionError::CompositionError}};}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00053}00053\ \ \ \ \ \};}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00054}00054\ }
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00059}\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_species_error}{00059}}\ \ \ \ \ \textcolor{keyword}{class\ }\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_species_error_af67ed95557b2511ff5143c7064fc5813}{SpeciesError}}\ :\ \textcolor{keyword}{public}\ std::exception\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00060}00060\ \ \ \ \ \textcolor{keyword}{protected}:}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00061}\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_species_error_a07a424e42edd368e6fb5113655ab6d1e}{00061}}\ \ \ \ \ \ \ \ \ std::string\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_species_error_a07a424e42edd368e6fb5113655ab6d1e}{m\_message}};}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00062}00062\ \ \ \ \ \textcolor{keyword}{public}:}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00063}\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_species_error_af67ed95557b2511ff5143c7064fc5813}{00063}}\ \ \ \ \ \ \ \ \ \textcolor{keyword}{explicit}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_species_error_af67ed95557b2511ff5143c7064fc5813}{SpeciesError}}(\textcolor{keyword}{const}\ std::string\&\ message)}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00064}00064\ \ \ \ \ \ \ \ \ \ \ \ \ :\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_species_error_a07a424e42edd368e6fb5113655ab6d1e}{m\_message}}(std::move(message))\ \{\}}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00065}00065\ }
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00066}\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_species_error_af0c63f7e05d0c65157b960c654d09b67}{00066}}\ \ \ \ \ \ \ \ \ \textcolor{keyword}{const}\ \textcolor{keywordtype}{char}*\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_species_error_af0c63f7e05d0c65157b960c654d09b67}{what}}()\ const\ noexcept\textcolor{keyword}{\ override\ }\{}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00067}00067\ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_species_error_a07a424e42edd368e6fb5113655ab6d1e}{m\_message}}.c\_str();}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00068}00068\ \ \ \ \ \ \ \ \ \}}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00069}00069\ \ \ \ \ \};}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00070}00070\ }
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00077}\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_unknown_symbol_error}{00077}}\ \ \ \ \ \textcolor{keyword}{class\ }\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_unknown_symbol_error}{UnknownSymbolError}}\ final\ :\ \textcolor{keyword}{public}\ \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_unknown_symbol_error_af67ed95557b2511ff5143c7064fc5813}{SpeciesError}}\ \{}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00078}00078\ \ \ \ \ \ \ \ \ \textcolor{keyword}{using\ }\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_species_error_af67ed95557b2511ff5143c7064fc5813}{SpeciesError::SpeciesError}};}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00079}00079\ \ \ \ \ \};}
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00080}00080\ }
|
||||
\DoxyCodeLine{\Hypertarget{exceptions__composition_8h_source_l00081}00081\ \}}
|
||||
|
||||
\end{DoxyCode}
|
||||
|
||||
@@ -1,10 +1,12 @@
|
||||
\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/atomic/\mbox{\hyperlink{atomic_species_8h}{atomic\+Species.\+h}} }{\pageref{atomic_species_8h}}{}
|
||||
\item\contentsline{section}{src/composition/include/fourdst/atomic/\mbox{\hyperlink{elements_8h}{elements.\+h}} \\*Provides mappings between atomic numbers and element symbols for the periodic table }{\pageref{elements_8h}}{}
|
||||
\item\contentsline{section}{src/composition/include/fourdst/atomic/\mbox{\hyperlink{species_8h}{species.\+h}} }{\pageref{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{composition__abstract_8h}{composition\+\_\+abstract.\+h}} }{\pageref{composition__abstract_8h}}{}
|
||||
\item\contentsline{section}{src/composition/include/fourdst/composition/\mbox{\hyperlink{elements_8h}{elements.\+h}} \\*Provides mappings between atomic numbers and element symbols for the periodic table }{\pageref{elements_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/\mbox{\hyperlink{utils_8h}{utils.\+h}} }{\pageref{utils_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}}{}
|
||||
\item\contentsline{section}{src/composition/lib/\mbox{\hyperlink{utils_8cpp}{utils.\+cpp}} }{\pageref{utils_8cpp}}{}
|
||||
\end{DoxyCompactList}
|
||||
|
||||
@@ -6,25 +6,17 @@ This inheritance list is sorted roughly, but not completely, alphabetically\+:\b
|
||||
\item \contentsline{section}{fourdst\+::composition\+::Composition}{\pageref{classfourdst_1_1composition_1_1_composition}}{}
|
||||
\end{DoxyCompactList}
|
||||
\item \contentsline{section}{fourdst\+::composition\+::Composition\+::Composition\+Cache}{\pageref{structfourdst_1_1composition_1_1_composition_1_1_composition_cache}}{}
|
||||
\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}
|
||||
\item \contentsline{section}{fourdst\+::composition\+::exceptions\+::Species\+Error}{\pageref{classfourdst_1_1composition_1_1exceptions_1_1_species_error}}{}
|
||||
\begin{DoxyCompactList}
|
||||
\item \contentsline{section}{fourdst\+::composition\+::exceptions\+::Unknown\+Symbol\+Error}{\pageref{classfourdst_1_1composition_1_1exceptions_1_1_unknown_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}
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
\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}
|
||||
{\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_md10}{}\doxysubsubsection{\texorpdfstring{Key Features}{Key Features}}\label{index_autotoc_md10}
|
||||
|
||||
\begin{DoxyItemize}
|
||||
\item {\bfseries{Dual-\/\+Mode Operation}}\+: Natively supports compositions defined by {\bfseries{mass fraction}} or {\bfseries{number fraction}}.
|
||||
@@ -13,7 +13,7 @@
|
||||
|
||||
\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}
|
||||
{\ttfamily libcomposition} uses the Meson build system. A C++23 compatible compiler is required.\hypertarget{index_autotoc_md12}{}\doxysubsubsection{\texorpdfstring{Build Steps}{Build Steps}}\label{index_autotoc_md12}
|
||||
{\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!
|
||||
@@ -45,7 +45,7 @@ This will also install a pkg-\/config file!
|
||||
\DoxyCodeLine{sudo\ meson\ install\ -\/C\ builddir}
|
||||
|
||||
\end{DoxyCode}
|
||||
\hypertarget{index_autotoc_md3}{}\doxysubsubsection{\texorpdfstring{Build Options}{Build Options}}\label{index_autotoc_md3}
|
||||
\hypertarget{index_autotoc_md13}{}\doxysubsubsection{\texorpdfstring{Build Options}{Build Options}}\label{index_autotoc_md13}
|
||||
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).
|
||||
|
||||
|
||||
@@ -58,7 +58,7 @@ You can enable the generation of a {\ttfamily pkg-\/config} file during the setu
|
||||
|
||||
\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}
|
||||
\hypertarget{index_autotoc_md15}{}\doxysubsubsection{\texorpdfstring{Linking with pkg-\/config}{Linking with pkg-\/config}}\label{index_autotoc_md15}
|
||||
If you installed {\ttfamily libcomposition} with the {\ttfamily pkg-\/config} option enabled, you can get the necessary compiler and linker flags easily\+:
|
||||
|
||||
|
||||
@@ -77,8 +77,8 @@ If you installed {\ttfamily libcomposition} with the {\ttfamily pkg-\/config} op
|
||||
\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}
|
||||
\hypertarget{index_autotoc_md16}{}\doxysubsubsection{\texorpdfstring{C++ Usage Examples}{C++ Usage Examples}}\label{index_autotoc_md16}
|
||||
\hypertarget{index_autotoc_md17}{}\doxysubsubsubsection{\texorpdfstring{1. Basic Mass Fraction Composition}{1. Basic Mass Fraction Composition}}\label{index_autotoc_md17}
|
||||
The most common use case is defining a composition by mass fractions (X, Y, Z).
|
||||
|
||||
|
||||
@@ -91,18 +91,18 @@ The most common use case is defining a composition by mass fractions (X, Y, Z).
|
||||
\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{\ \ \ \ comp.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a3ab4dcda0bfd1a35b169bcc57fe66725}{registerSymbol}}(\textcolor{stringliteral}{"{}H-\/1"{}});}
|
||||
\DoxyCodeLine{\ \ \ \ comp.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a3ab4dcda0bfd1a35b169bcc57fe66725}{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{\ \ \ \ comp.setMassFraction(\textcolor{stringliteral}{"{}H-\/1"{}},\ 0.75);}
|
||||
\DoxyCodeLine{\ \ \ \ comp.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{\ \ \ \ \textcolor{keywordflow}{if}\ (comp.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_aae07019ab6e02394e6ea353e0b98a417}{getMassFraction}}(\textcolor{stringliteral}{"{}H-\/1"{}})\ <<\ std::endl;}
|
||||
\DoxyCodeLine{\ \ \ \ \ \ \ \ std::cout\ <<\ \textcolor{stringliteral}{"{}Mean\ Particle\ Mass:\ "{}}\ <<\ comp.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a796386824d1358527fed7c6b537935d8}{getMeanParticleMass}}()\ <<\ \textcolor{stringliteral}{"{}\ g/mol"{}}\ <<\ std::endl;}
|
||||
\DoxyCodeLine{\ \ \ \ \ \ \ \ std::cout\ <<\ \textcolor{stringliteral}{"{}H-\/1\ Mass\ Fraction:\ "{}}\ <<\ comp.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a9ea2b673341fdc67afeb0f0517a54c8c}{getMassFraction}}(\textcolor{stringliteral}{"{}H-\/1"{}})\ <<\ std::endl;}
|
||||
\DoxyCodeLine{\ \ \ \ \ \ \ \ std::cout\ <<\ \textcolor{stringliteral}{"{}Mean\ Particle\ Mass:\ "{}}\ <<\ comp.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_afbbb5e51ad5ae5c0fa6bc0094195aecd}{getMeanParticleMass}}()\ <<\ \textcolor{stringliteral}{"{}\ g/mol"{}}\ <<\ std::endl;}
|
||||
\DoxyCodeLine{\ \ \ \ \}\ \textcolor{keywordflow}{else}\ \{}
|
||||
\DoxyCodeLine{\ \ \ \ \ \ \ \ std::cerr\ <<\ \textcolor{stringliteral}{"{}Failed\ to\ finalize\ composition."{}}\ <<\ std::endl;}
|
||||
\DoxyCodeLine{\ \ \ \ \}}
|
||||
@@ -111,7 +111,7 @@ The most common use case is defining a composition by mass fractions (X, Y, Z).
|
||||
\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}
|
||||
\hypertarget{index_autotoc_md18}{}\doxysubsubsubsection{\texorpdfstring{2. Number Fraction Composition and Mode Switching}{2. Number Fraction Composition and Mode Switching}}\label{index_autotoc_md18}
|
||||
The library can also work with number (mole) fractions and switch between modes.
|
||||
|
||||
|
||||
@@ -123,29 +123,29 @@ The library can also work with number (mole) fractions and switch between modes.
|
||||
\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{\ \ \ \ comp.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a3ab4dcda0bfd1a35b169bcc57fe66725}{registerSymbol}}(\textcolor{stringliteral}{"{}H-\/1"{}},\ \textcolor{keyword}{false});\ \textcolor{comment}{//\ massFracMode\ =\ false}}
|
||||
\DoxyCodeLine{\ \ \ \ comp.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a3ab4dcda0bfd1a35b169bcc57fe66725}{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{\ \ \ \ comp.setNumberFraction(\textcolor{stringliteral}{"{}H-\/1"{}},\ 0.9);}
|
||||
\DoxyCodeLine{\ \ \ \ comp.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{keywordflow}{if}\ (comp.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_a34f71d4d8f0297c576fd62fabd490305}{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_aae07019ab6e02394e6ea353e0b98a417}{getMassFraction}}(\textcolor{stringliteral}{"{}He-\/4"{}})\ <<\ std::endl;}
|
||||
\DoxyCodeLine{\ \ \ \ \ \ \ \ std::cout\ <<\ \textcolor{stringliteral}{"{}He-\/4\ Mass\ Fraction:\ "{}}\ <<\ comp.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a9ea2b673341fdc67afeb0f0517a54c8c}{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{\ \ \ \ \ \ \ \ comp.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_aae07019ab6e02394e6ea353e0b98a417}{getMassFraction}}(\textcolor{stringliteral}{"{}He-\/4"{}})\ <<\ std::endl;}
|
||||
\DoxyCodeLine{\ \ \ \ \ \ \ \ std::cout\ <<\ \textcolor{stringliteral}{"{}He-\/4\ Mass\ Fraction\ (after\ mode\ switch):\ "{}}\ <<\ comp.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a9ea2b673341fdc67afeb0f0517a54c8c}{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}
|
||||
\hypertarget{index_autotoc_md19}{}\doxysubsubsubsection{\texorpdfstring{3. Mixing Two Compositions}{3. Mixing Two Compositions}}\label{index_autotoc_md19}
|
||||
You can easily mix two compositions. The library handles the union of all species.
|
||||
|
||||
|
||||
@@ -164,14 +164,14 @@ You can easily mix two compositions. The library handles the union of all specie
|
||||
\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{\ \ \ \ \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition}{fourdst::composition::Composition}}\ mixed2\ =\ comp1.mix(comp2,\ 0.75);}
|
||||
\DoxyCodeLine{}
|
||||
\DoxyCodeLine{\ \ \ \ std::cout\ <<\ \textcolor{stringliteral}{"{}50/50\ Mix\ H-\/1:\ "{}}\ <<\ mixed.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aae07019ab6e02394e6ea353e0b98a417}{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_aae07019ab6e02394e6ea353e0b98a417}{getMassFraction}}(\textcolor{stringliteral}{"{}H-\/1"{}})\ <<\ std::endl;\ \ \textcolor{comment}{//\ -\/>\ 0.75}}
|
||||
\DoxyCodeLine{\ \ \ \ std::cout\ <<\ \textcolor{stringliteral}{"{}50/50\ Mix\ H-\/1:\ "{}}\ <<\ mixed.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a9ea2b673341fdc67afeb0f0517a54c8c}{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_a9ea2b673341fdc67afeb0f0517a54c8c}{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}
|
||||
\hypertarget{index_autotoc_md20}{}\doxysubsubsubsection{\texorpdfstring{4. Error Handling}{4. Error Handling}}\label{index_autotoc_md20}
|
||||
The library uses exceptions to report errors. Always wrap calls in a {\ttfamily try-\/catch} block for robust code.
|
||||
|
||||
|
||||
@@ -181,32 +181,32 @@ The library uses exceptions to report errors. Always wrap calls in a {\ttfamily
|
||||
\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{\ \ \ \ comp.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a3ab4dcda0bfd1a35b169bcc57fe66725}{registerSymbol}}(\textcolor{stringliteral}{"{}H-\/1"{}});}
|
||||
\DoxyCodeLine{\ \ \ \ comp.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_aae07019ab6e02394e6ea353e0b98a417}{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{\ \ \ \ \ \ \ \ \textcolor{keywordtype}{double}\ mass\ =\ comp.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a9ea2b673341fdc67afeb0f0517a54c8c}{getMassFraction}}(\textcolor{stringliteral}{"{}H-\/1"{}});}
|
||||
\DoxyCodeLine{\ \ \ \ \}\ \textcolor{keywordflow}{catch}\ (\textcolor{keyword}{const}\ fourdst::composition::exceptions::CompositionNotFinalizedError\&\ e)\ \{}
|
||||
\DoxyCodeLine{\ \ \ \ \ \ \ \ std::cerr\ <<\ \textcolor{stringliteral}{"{}Caught\ expected\ error:\ "{}}\ <<\ e.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{\ \ \ \ \ \ \ \ comp.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}
|
||||
\hypertarget{index_autotoc_md21}{}\doxysubsubsubsection{\texorpdfstring{5. Accessing Atomic Data}{5. Accessing Atomic Data}}\label{index_autotoc_md21}
|
||||
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{\textcolor{preprocessor}{\#include\ "{}fourdst/composition/species.h"{}}\ \textcolor{comment}{//\ Provides\ static\ instances\ like\ H\_1}}
|
||||
\DoxyCodeLine{\textcolor{preprocessor}{\#include\ "{}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}}
|
||||
@@ -223,7 +223,7 @@ You can directly access the static database of all known species.
|
||||
|
||||
\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}
|
||||
{\ttfamily libcomposition} is tested using the Google\+Test framework. The test suite provides high coverage of the library\textquotesingle{}s functionality.\hypertarget{index_autotoc_md23}{}\doxysubsubsection{\texorpdfstring{Test Coverage Includes\+:}{Test Coverage Includes\+:}}\label{index_autotoc_md23}
|
||||
|
||||
\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.
|
||||
|
||||
@@ -4,6 +4,6 @@
|
||||
\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
|
||||
\begin{DoxyCompactList}\small\item\em Contains canonical information about atomic species and elements used by 4D-\/\+STAR. \end{DoxyCompactList}\item
|
||||
namespace \mbox{\hyperlink{namespacefourdst_1_1composition}{composition}}
|
||||
\end{DoxyCompactItemize}
|
||||
\begin{DoxyCompactList}\small\item\em Utilities and types for representing and manipulating chemical compositions. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
\hypertarget{namespacefourdst_1_1atomic}{}\label{namespacefourdst_1_1atomic}\index{fourdst::atomic@{fourdst::atomic}}
|
||||
|
||||
|
||||
Contains classes and functions related to atomic data, such as properties of atomic species.
|
||||
Contains canonical information about atomic species and elements used by 4D-\/\+STAR.
|
||||
|
||||
|
||||
\doxysubsubsection*{Classes}
|
||||
@@ -20,7 +20,7 @@ enum class \mbox{\hyperlink{namespacefourdst_1_1atomic_a6c728f75913c5bfb62f6dcf9
|
||||
\doxysubsubsection*{Functions}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
double \mbox{\hyperlink{namespacefourdst_1_1atomic_ada037e2130ddb6174ff7934cda49c2ba}{convert\+\_\+jpi\+\_\+to\+\_\+double}} (const std\+::string \&jpi\+\_\+string)
|
||||
double \mbox{\hyperlink{namespacefourdst_1_1atomic_ab8b3572582a3f80243ecce021b4782d1}{convert\+\_\+jpi\+\_\+to\+\_\+double}} (const std\+::string \&jpi\+\_\+string) noexcept
|
||||
\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}{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
|
||||
@@ -7160,7 +7160,96 @@ static const std\+::unordered\+\_\+map$<$ std\+::string, const \mbox{\hyperlink{
|
||||
|
||||
|
||||
\doxysubsection{Detailed Description}
|
||||
Contains classes and functions related to atomic data, such as properties of atomic species.
|
||||
Contains canonical information about atomic species and elements used by 4D-\/\+STAR.
|
||||
|
||||
Contains classes and functions related to atomic data, such as properties of atomic species.
|
||||
|
||||
The {\ttfamily \doxylink{namespacefourdst_1_1atomic}{fourdst\+::atomic}} namespace provides a comprehensive, compile-\/time-\/accessible database of predefined atomic isotopes (\doxylink{structfourdst_1_1atomic_1_1_species}{Species}) and helper utilities for working with them. \doxylink{structfourdst_1_1atomic_1_1_species}{Species} are available as strongly-\/typed constants following the pattern {\ttfamily \doxylink{namespacefourdst_1_1atomic_a6766bc834fd656df51bdcf22f7d97877}{fourdst\+::atomic\+::\+H\+\_\+1}}, {\ttfamily \doxylink{namespacefourdst_1_1atomic_ab665e3014e2a805624227350699f141a}{fourdst\+::atomic\+::\+He\+\_\+4}}, {\ttfamily \doxylink{namespacefourdst_1_1atomic_a21ab5363d81d491f5230e8d90a149f31}{fourdst\+::atomic\+::\+C\+\_\+12}}, etc.
|
||||
|
||||
Each atomic \doxylink{structfourdst_1_1atomic_1_1_species}{Species} object encapsulates detailed metadata about the isotope, including\+:
|
||||
\begin{DoxyItemize}
|
||||
\item Atomic number (Z)
|
||||
\item Mass number (A)
|
||||
\item Neutron number (N)
|
||||
\item Element symbol (e.\+g., "{}\+H"{} for Hydrogen)
|
||||
\item \doxylink{structfourdst_1_1atomic_1_1_species}{Species} symbol (e.\+g., "{}\+H-\/1"{} for Hydrogen-\/1)
|
||||
\item Atomic mass (in atomic mass units)
|
||||
\item Uncertainty in atomic mass (in atomic mass units)
|
||||
\item Half-\/life (seconds; a value of -\/1 or another sentinel indicates stability)
|
||||
\item Binding energy (in keV)
|
||||
\item Beta decay code (classification code from the atomic database)
|
||||
\item Beta decay energy (in keV)
|
||||
\item Spin parity string (e.\+g., "{}1/2+"{})
|
||||
\item Decay modes as a descriptive string
|
||||
\item Nuclear spin
|
||||
\end{DoxyItemize}
|
||||
|
||||
\doxylink{structfourdst_1_1atomic_1_1_species}{Species} instances are intended to be lightweight, immutable value objects providing easy accessors for these properties. They are the canonical representation of an isotope throughout the codebase and are safe to pass and store by value.\hypertarget{namespacefourdst_1_1atomic_autotoc_md0}{}\doxysubsubsection{\texorpdfstring{Species lookup}{Species lookup}}\label{namespacefourdst_1_1atomic_autotoc_md0}
|
||||
The namespace exposes a map lookup structure {\ttfamily \doxylink{namespacefourdst_1_1atomic_a3f619cc8f8b2cd718a4082c6adb0de90}{fourdst\+::atomic\+::species}} which maps the human-\/readable species symbol (e.\+g. "{}\+C-\/12"{}) to the corresponding {\ttfamily \doxylink{structfourdst_1_1atomic_1_1_species}{fourdst\+::atomic\+::\+Species}} object. This is useful for APIs that accept string symbols at runtime and need to resolve them to the strongly-\/typed species value.\hypertarget{namespacefourdst_1_1atomic_autotoc_md1}{}\doxysubsubsection{\texorpdfstring{Comparison semantics}{Comparison semantics}}\label{namespacefourdst_1_1atomic_autotoc_md1}
|
||||
Comparison operators for {\ttfamily \doxylink{structfourdst_1_1atomic_1_1_species}{Species}} are overloaded to provide sensible ordering and equality semantics\+:
|
||||
\begin{DoxyItemize}
|
||||
\item Equality ({\ttfamily ==}) and inequality ({\ttfamily !=}) evaluate true/false based on the species symbol — two species are equal only if they share the same species symbol (same isotope).
|
||||
\item Relational operators ({\ttfamily \texorpdfstring{$<$}{<}}, {\ttfamily \texorpdfstring{$>$}{>}}, {\ttfamily \texorpdfstring{$<$}{<}=}, {\ttfamily \texorpdfstring{$>$}{>}=}) are defined based on atomic mass. This provides a natural ordering from lightest to heaviest isotope which is convenient when creating sorted containers or deterministic vector representations.
|
||||
\end{DoxyItemize}\hypertarget{namespacefourdst_1_1atomic_autotoc_md2}{}\doxysubsubsection{\texorpdfstring{Stream output}{Stream output}}\label{namespacefourdst_1_1atomic_autotoc_md2}
|
||||
The stream insertion operator ({\ttfamily operator\texorpdfstring{$<$}{<}\texorpdfstring{$<$}{<}}) is overloaded for \doxylink{structfourdst_1_1atomic_1_1_species}{Species} objects and prints the species symbol (for example "{}\+C-\/12"{}) to output streams. This makes logging and test output concise and human-\/readable.\hypertarget{namespacefourdst_1_1atomic_autotoc_md3}{}\doxysubsubsection{\texorpdfstring{Typical usage}{Typical usage}}\label{namespacefourdst_1_1atomic_autotoc_md3}
|
||||
Example\+: Using predefined species directly
|
||||
\begin{DoxyCode}{0}
|
||||
\DoxyCodeLine{\textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{species_8h}{fourdst/atomic/species.h}}"{}}}
|
||||
\DoxyCodeLine{}
|
||||
\DoxyCodeLine{\textcolor{keyword}{using\ namespace\ }\mbox{\hyperlink{namespacefourdst_1_1atomic}{fourdst::atomic}};}
|
||||
\DoxyCodeLine{}
|
||||
\DoxyCodeLine{\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{Species}}\ s\ =\ \mbox{\hyperlink{namespacefourdst_1_1atomic_a6766bc834fd656df51bdcf22f7d97877}{H\_1}};\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{comment}{//\ Hydrogen-\/1\ species\ object}}
|
||||
\DoxyCodeLine{std::cout\ <<\ s\ <<\ std::endl;\ \ \ \textcolor{comment}{//\ prints\ "{}H-\/1"{}}}
|
||||
\DoxyCodeLine{}
|
||||
\DoxyCodeLine{\textcolor{keywordtype}{int}\ Z\ =\ s.getAtomicNumber();\ \ \ \textcolor{comment}{//\ atomic\ number\ (1\ for\ hydrogen)}}
|
||||
\DoxyCodeLine{\textcolor{keywordtype}{double}\ mass\ =\ s.getAtomicMass();}
|
||||
\DoxyCodeLine{\textcolor{keywordtype}{bool}\ isStable\ =\ (s.getHalfLife()\ <\ 0);}
|
||||
|
||||
\end{DoxyCode}
|
||||
|
||||
|
||||
Example\+: Resolving a runtime symbol to a \doxylink{structfourdst_1_1atomic_1_1_species}{Species}
|
||||
\begin{DoxyCode}{0}
|
||||
\DoxyCodeLine{\textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{species_8h}{fourdst/atomic/species.h}}"{}}}
|
||||
\DoxyCodeLine{}
|
||||
\DoxyCodeLine{std::string\ sym\ =\ \textcolor{stringliteral}{"{}C-\/12"{}};}
|
||||
\DoxyCodeLine{\textcolor{keyword}{auto}\ sp\ =\ \mbox{\hyperlink{namespacefourdst_1_1atomic_a3f619cc8f8b2cd718a4082c6adb0de90}{fourdst::atomic::species}}.at(sym);\ \textcolor{comment}{//\ throws\ if\ sym\ not\ found}}
|
||||
\DoxyCodeLine{\textcolor{comment}{//\ now\ sp\ is\ the\ canonical\ Species\ for\ Carbon-\/12}}
|
||||
|
||||
\end{DoxyCode}
|
||||
|
||||
|
||||
Example\+: Using \doxylink{structfourdst_1_1atomic_1_1_species}{Species} in sorted containers and compositions
|
||||
\begin{DoxyCode}{0}
|
||||
\DoxyCodeLine{\textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{composition_8h}{fourdst/composition/composition.h}}"{}}}
|
||||
\DoxyCodeLine{}
|
||||
\DoxyCodeLine{\textcolor{keyword}{using\ namespace\ }\mbox{\hyperlink{namespacefourdst_1_1atomic}{fourdst::atomic}};}
|
||||
\DoxyCodeLine{\textcolor{keyword}{using\ namespace\ }\mbox{\hyperlink{namespacefourdst_1_1composition}{fourdst::composition}};}
|
||||
\DoxyCodeLine{}
|
||||
\DoxyCodeLine{\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition}{Composition}}\ comp;}
|
||||
\DoxyCodeLine{comp.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a392a34c19f45d6c936cc7030e6cfaf3f}{registerSpecies}}(\mbox{\hyperlink{namespacefourdst_1_1atomic_a6766bc834fd656df51bdcf22f7d97877}{H\_1}});}
|
||||
\DoxyCodeLine{comp.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a392a34c19f45d6c936cc7030e6cfaf3f}{registerSpecies}}(\mbox{\hyperlink{namespacefourdst_1_1atomic_ab665e3014e2a805624227350699f141a}{He\_4}});}
|
||||
\DoxyCodeLine{comp.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a392a34c19f45d6c936cc7030e6cfaf3f}{registerSpecies}}(\mbox{\hyperlink{namespacefourdst_1_1atomic_a21ab5363d81d491f5230e8d90a149f31}{C\_12}});}
|
||||
\DoxyCodeLine{}
|
||||
\DoxyCodeLine{\textcolor{comment}{//\ Iteration\ and\ vector\ representations\ rely\ on\ species\ ordering\ by\ mass}}
|
||||
\DoxyCodeLine{\textcolor{keywordflow}{for}\ (\textcolor{keyword}{const}\ \textcolor{keyword}{auto}\ \&sp\ :\ comp.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a33db253ca50431b5166d43412ff18f71}{getRegisteredSpecies}}())\ \{}
|
||||
\DoxyCodeLine{\ \ \ \ std::cout\ <<\ sp\ <<\ \textcolor{stringliteral}{"{}\(\backslash\)n"{}};}
|
||||
\DoxyCodeLine{\}}
|
||||
|
||||
\end{DoxyCode}
|
||||
\hypertarget{namespacefourdst_1_1atomic_autotoc_md4}{}\doxysubsubsection{\texorpdfstring{Notes and recommendations}{Notes and recommendations}}\label{namespacefourdst_1_1atomic_autotoc_md4}
|
||||
|
||||
\begin{DoxyItemize}
|
||||
\item The species map ({\ttfamily \doxylink{namespacefourdst_1_1atomic_a3f619cc8f8b2cd718a4082c6adb0de90}{fourdst\+::atomic\+::species}}) is the canonical runtime symbol-\/to-\/species translation. Code that must accept user-\/provided symbols should use this map and handle potential exceptions (e.\+g. {\ttfamily std\+::out\+\_\+of\+\_\+range} or a library-\/specific exception) when a symbol is unknown.
|
||||
\item Because comparison operators are mass-\/based, using ordered containers (std\+::set, std\+::map) with \doxylink{structfourdst_1_1atomic_1_1_species}{Species} will order entries from lightest to heaviest by default.
|
||||
\item The printed representation of a \doxylink{structfourdst_1_1atomic_1_1_species}{Species} is the species symbol only. For more verbose output (mass, half-\/life, binding energy), use the individual accessors.
|
||||
\item Floating-\/point values (e.\+g., atomic mass) are provided as doubles. When comparing such values in tests, use an appropriate tolerance.
|
||||
\end{DoxyItemize}\hypertarget{namespacefourdst_1_1atomic_autotoc_md5}{}\doxysubsubsection{\texorpdfstring{See also}{See also}}\label{namespacefourdst_1_1atomic_autotoc_md5}
|
||||
|
||||
\begin{DoxyItemize}
|
||||
\item {\ttfamily \doxylink{species_8h}{fourdst/atomic/species.\+h}} — definitions of \doxylink{structfourdst_1_1atomic_1_1_species}{Species} constants and the {\ttfamily species} map.
|
||||
\item {\ttfamily \doxylink{composition_8h}{fourdst/composition/composition.\+h}} — Composition API which consumes \doxylink{structfourdst_1_1atomic_1_1_species}{Species} objects.
|
||||
\end{DoxyItemize}
|
||||
|
||||
\doxysubsection{Enumeration Type Documentation}
|
||||
\Hypertarget{namespacefourdst_1_1atomic_a6c728f75913c5bfb62f6dcf9dff294fe}\index{fourdst::atomic@{fourdst::atomic}!SpeciesErrorType@{SpeciesErrorType}}
|
||||
@@ -11372,11 +11461,11 @@ static const \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{Species}} fou
|
||||
{\footnotesize\ttfamily \label{namespacefourdst_1_1atomic_a179693c05bf6f8d2a03449458b570c3f}
|
||||
static const \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{Species}} fourdst\+::atomic\+::\+Co\+\_\+78 (\begin{DoxyParamCaption}\item[{"{}Co-\/78"{}}]{}{, }\item[{"{}Co"{}}]{}{, }\item[{24}]{}{, }\item[{51}]{}{, }\item[{27}]{}{, }\item[{78}]{}{, }\item[{7997.}]{0}{, }\item[{"{}B-\/"{}}]{}{, }\item[{19560.}]{0}{, }\item[{11.}]{0}{, }\item[{"{}"{}}]{}{, }\item[{"{}-\/ ?"{}}]{}{, }\item[{77.}]{983553}{, }\item[{751.}]{0}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}}
|
||||
|
||||
\Hypertarget{namespacefourdst_1_1atomic_ada037e2130ddb6174ff7934cda49c2ba}\index{fourdst::atomic@{fourdst::atomic}!convert\_jpi\_to\_double@{convert\_jpi\_to\_double}}
|
||||
\Hypertarget{namespacefourdst_1_1atomic_ab8b3572582a3f80243ecce021b4782d1}\index{fourdst::atomic@{fourdst::atomic}!convert\_jpi\_to\_double@{convert\_jpi\_to\_double}}
|
||||
\index{convert\_jpi\_to\_double@{convert\_jpi\_to\_double}!fourdst::atomic@{fourdst::atomic}}
|
||||
\doxysubsubsection{\texorpdfstring{convert\_jpi\_to\_double()}{convert\_jpi\_to\_double()}}
|
||||
{\footnotesize\ttfamily \label{namespacefourdst_1_1atomic_ada037e2130ddb6174ff7934cda49c2ba}
|
||||
double fourdst\+::atomic\+::convert\+\_\+jpi\+\_\+to\+\_\+double (\begin{DoxyParamCaption}\item[{const std\+::string \&}]{jpi\+\_\+string}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
||||
{\footnotesize\ttfamily \label{namespacefourdst_1_1atomic_ab8b3572582a3f80243ecce021b4782d1}
|
||||
double fourdst\+::atomic\+::convert\+\_\+jpi\+\_\+to\+\_\+double (\begin{DoxyParamCaption}\item[{const std\+::string \&}]{jpi\+\_\+string}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [noexcept]}}
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,5 +1,10 @@
|
||||
\doxysection{fourdst\+::composition Namespace Reference}
|
||||
\hypertarget{namespacefourdst_1_1composition}{}\label{namespacefourdst_1_1composition}\index{fourdst::composition@{fourdst::composition}}
|
||||
|
||||
|
||||
Utilities and types for representing and manipulating chemical compositions.
|
||||
|
||||
|
||||
\doxysubsubsection*{Namespaces}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
@@ -11,30 +16,212 @@ namespace \mbox{\hyperlink{namespacefourdst_1_1composition_1_1exceptions}{except
|
||||
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}
|
||||
\begin{DoxyCompactList}\small\item\em Manages a collection of chemical species and their abundances. \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
|
||||
\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition}{Composition}} \mbox{\hyperlink{namespacefourdst_1_1composition_aa90b1ef07d607c0c829bedccf381cf54}{build\+Composition\+From\+Mass\+Fractions}} (const std\+::vector$<$ std\+::string $>$ \&symbols, const std\+::vector$<$ double $>$ \&mass\+Fractions)
|
||||
\begin{DoxyCompactList}\small\item\em Build a \doxylink{classfourdst_1_1composition_1_1_composition}{Composition} object from symbols and their corresponding mass fractions. \end{DoxyCompactList}\item
|
||||
\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition}{Composition}} \mbox{\hyperlink{namespacefourdst_1_1composition_a39d4f84dfa85ddda3b9feb5dda1afc1e}{build\+Composition\+From\+Mass\+Fractions}} (const std\+::vector$<$ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{atomic\+::\+Species}} $>$ \&species, const std\+::vector$<$ double $>$ \&mass\+Fractions)
|
||||
\begin{DoxyCompactList}\small\item\em Build a \doxylink{classfourdst_1_1composition_1_1_composition}{Composition} object from species and their corresponding mass fractions. \end{DoxyCompactList}\item
|
||||
\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition}{Composition}} \mbox{\hyperlink{namespacefourdst_1_1composition_a2cb98194b465f646973ceba38d0e7d95}{build\+Composition\+From\+Mass\+Fractions}} (const std\+::set$<$ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{atomic\+::\+Species}} $>$ \&species, const std\+::vector$<$ double $>$ \&mass\+Fractions)
|
||||
\begin{DoxyCompactList}\small\item\em Build a \doxylink{classfourdst_1_1composition_1_1_composition}{Composition} object from species in a set and their corresponding mass fractions. \end{DoxyCompactList}\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}
|
||||
\begin{DoxyCompactList}\small\item\em OVERLOADS. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
|
||||
|
||||
\doxysubsection{Detailed Description}
|
||||
Utilities and types for representing and manipulating chemical compositions.
|
||||
|
||||
The composition module provides a small, but expressive, API for constructing and querying material compositions used throughout the 4D-\/\+STAR codebase. A \doxylink{classfourdst_1_1composition_1_1_composition}{Composition} represents a collection of atomic species together with their molar abundances. From these molar abundances the module can compute derived quantities such as mass fractions, number fractions, canonical (X, Y, Z) composition, mean particle mass, and the electron abundance (Y\+\_\+e).
|
||||
|
||||
Key concepts\+:
|
||||
\begin{DoxyItemize}
|
||||
\item Species and Symbols\+: Atomic isotopes are represented by the strongly-\/typed \doxylink{structfourdst_1_1atomic_1_1_species}{fourdst\+::atomic\+::\+Species} values (see {\ttfamily \doxylink{species_8h}{fourdst/atomic/species.\+h}}). Each species also has a human-\/readable string symbol (e.\+g. "{}\+H-\/1"{}, "{}\+He-\/4"{}) used by some constructors and convenience overloads.
|
||||
\item Molar abundances\+: The \doxylink{classfourdst_1_1composition_1_1_composition}{Composition} API accepts and stores molar abundances (absolute mole counts). Many derived quantities (mass fraction, number fraction, mean particle mass) are computed from these molar abundances.
|
||||
\item Canonical composition\+: A \doxylink{structfourdst_1_1composition_1_1_canonical_composition}{Canonical\+Composition} (X, Y, Z) is provided which groups mass fractions into hydrogen (X), helium (Y), and metals (Z). A lightweight struct {\ttfamily \doxylink{structfourdst_1_1composition_1_1_canonical_composition}{Canonical\+Composition}} holds these values and provides an ostream operator for easy logging and testing.
|
||||
\item Caching\+: The concrete \doxylink{classfourdst_1_1composition_1_1_composition}{Composition} implementation caches computed vectors and scalars to avoid repeated work. The cache is invalidated automatically when molar abundances or registered species are changed.
|
||||
\end{DoxyItemize}\hypertarget{namespacefourdst_1_1composition_autotoc_md6}{}\doxysubsubsection{\texorpdfstring{Main types and functions}{Main types and functions}}\label{namespacefourdst_1_1composition_autotoc_md6}
|
||||
|
||||
\begin{DoxyItemize}
|
||||
\item \doxylink{classfourdst_1_1composition_1_1_composition}{Composition}\+: The primary concrete class for building and interrogating compositions. It implements the \doxylink{class_composition_abstract}{Composition\+Abstract} interface and exposes methods to register symbols/species, set molar abundances, and query all commonly-\/needed derived quantities. Multiple constructors are provided for convenience (from vectors/sets of symbols or species, with optional molar-\/abundance initialization).
|
||||
|
||||
Important member functions include\+:
|
||||
\begin{DoxyItemize}
|
||||
\item register\+Symbol / register\+Species (single or many overloads)
|
||||
\item set\+Molar\+Abundance (many overloads accepting symbols or species)
|
||||
\item get\+Molar\+Abundance, get\+Mass\+Fraction, get\+Number\+Fraction (symbol and species overloads)
|
||||
\item get\+Mass\+Fraction\+Vector, get\+Number\+Fraction\+Vector, get\+Molar\+Abundance\+Vector
|
||||
\item get\+Mean\+Particle\+Mass, get\+Electron\+Abundance
|
||||
\item get\+Canonical\+Composition
|
||||
\item Iteration support (begin/end) which iterates species from lightest to heaviest because species ordering is defined by atomic mass.
|
||||
\end{DoxyItemize}
|
||||
\item \doxylink{class_composition_abstract}{Composition\+Abstract}\+: A compact abstract interface implemented by \doxylink{classfourdst_1_1composition_1_1_composition}{Composition} which guarantees the presence of all getter/query methods. This allows other components to accept composition-\/like objects without depending on the concrete implementation.
|
||||
\item Utilities (\doxylink{namespacefourdst_1_1composition_aa90b1ef07d607c0c829bedccf381cf54}{fourdst\+::composition\+::build\+Composition\+From\+Mass\+Fractions})\+: Convenience helpers exist to construct a \doxylink{classfourdst_1_1composition_1_1_composition}{Composition} from mass fractions (instead of molar abundances). Those helpers validate that the provided mass fractions sum to unity within a tight tolerance and convert them into the corresponding molar abundances before returning a populated \doxylink{classfourdst_1_1composition_1_1_composition}{Composition}.
|
||||
\item Exceptions (namespace \doxylink{namespacefourdst_1_1composition_1_1exceptions}{fourdst\+::composition\+::exceptions})\+: The module defines a small hierarchy of exceptions for error handling\+:
|
||||
\begin{DoxyItemize}
|
||||
\item Composition\+Error\+: Base class for composition-\/related errors.
|
||||
\item Invalid\+Composition\+Error\+: Thrown when the composition is inconsistent or when mass fractions fail validation.
|
||||
\item Unregistered\+Symbol\+Error\+: Thrown when an operation requires a symbol that hasn\textquotesingle{}t been registered on the \doxylink{classfourdst_1_1composition_1_1_composition}{Composition} object.
|
||||
\item Unknown\+Symbol\+Error\+: Thrown when a provided string symbol does not map to any known atomic species in the atomic species database.
|
||||
\end{DoxyItemize}
|
||||
\end{DoxyItemize}\hypertarget{namespacefourdst_1_1composition_autotoc_md7}{}\doxysubsubsection{\texorpdfstring{Usage examples}{Usage examples}}\label{namespacefourdst_1_1composition_autotoc_md7}
|
||||
Example 1 – basic construction and queries\+:
|
||||
\begin{DoxyCode}{0}
|
||||
\DoxyCodeLine{\textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{composition_8h}{fourdst/composition/composition.h}}"{}}}
|
||||
\DoxyCodeLine{}
|
||||
\DoxyCodeLine{\textcolor{keyword}{using\ namespace\ }\mbox{\hyperlink{namespacefourdst_1_1composition}{fourdst::composition}};}
|
||||
\DoxyCodeLine{}
|
||||
\DoxyCodeLine{\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition}{Composition}}\ comp;}
|
||||
\DoxyCodeLine{comp.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a3ab4dcda0bfd1a35b169bcc57fe66725}{registerSymbol}}(\textcolor{stringliteral}{"{}H-\/1"{}});}
|
||||
\DoxyCodeLine{comp.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a3ab4dcda0bfd1a35b169bcc57fe66725}{registerSymbol}}(\textcolor{stringliteral}{"{}He-\/4"{}});}
|
||||
\DoxyCodeLine{comp.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a262d7133035d4e6f45daa81827abf5e7}{setMolarAbundance}}(\textcolor{stringliteral}{"{}H-\/1"{}},\ 1.0);}
|
||||
\DoxyCodeLine{comp.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a262d7133035d4e6f45daa81827abf5e7}{setMolarAbundance}}(\textcolor{stringliteral}{"{}He-\/4"{}},\ 0.5);}
|
||||
\DoxyCodeLine{}
|
||||
\DoxyCodeLine{\textcolor{keywordtype}{double}\ X\_h1\ =\ comp.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_a9ea2b673341fdc67afeb0f0517a54c8c}{getMassFraction}}(\textcolor{stringliteral}{"{}H-\/1"{}});}
|
||||
\DoxyCodeLine{\textcolor{keywordtype}{double}\ meanA\ =\ comp.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_afbbb5e51ad5ae5c0fa6bc0094195aecd}{getMeanParticleMass}}();}
|
||||
\DoxyCodeLine{\mbox{\hyperlink{structfourdst_1_1composition_1_1_canonical_composition}{CanonicalComposition}}\ canon\ =\ comp.\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_aac5b214a3d1278e127422224cb9cee50}{getCanonicalComposition}}();}
|
||||
\DoxyCodeLine{std::cout\ <<\ canon\ <<\ std::endl;\ \textcolor{comment}{//\ prints\ X,\ Y,\ Z}}
|
||||
|
||||
\end{DoxyCode}
|
||||
|
||||
|
||||
Example 2 – constructing from mass fractions\+:
|
||||
\begin{DoxyCode}{0}
|
||||
\DoxyCodeLine{\textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{utils_8h}{fourdst/composition/utils.h}}"{}}}
|
||||
\DoxyCodeLine{}
|
||||
\DoxyCodeLine{std::vector<std::string>\ symbols\ =\ \{\textcolor{stringliteral}{"{}H-\/1"{}},\ \textcolor{stringliteral}{"{}He-\/4"{}},\ \textcolor{stringliteral}{"{}C-\/12"{}}\};}
|
||||
\DoxyCodeLine{std::vector<double>\ massFractions\ =\ \{0.70,\ 0.28,\ 0.02\};}
|
||||
\DoxyCodeLine{\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition}{Composition}}\ comp\ =\ \mbox{\hyperlink{namespacefourdst_1_1composition_aa90b1ef07d607c0c829bedccf381cf54}{buildCompositionFromMassFractions}}(symbols,\ massFractions);}
|
||||
|
||||
\end{DoxyCode}
|
||||
\hypertarget{namespacefourdst_1_1composition_autotoc_md8}{}\doxysubsubsection{\texorpdfstring{Notes and remarks}{Notes and remarks}}\label{namespacefourdst_1_1composition_autotoc_md8}
|
||||
|
||||
\begin{DoxyItemize}
|
||||
\item Molar abundances are the canonical input for the \doxylink{classfourdst_1_1composition_1_1_composition}{Composition} class. When passing mass fractions, use the {\ttfamily build\+Composition\+From\+Mass\+Fractions} helper which performs the safe conversion and validation.
|
||||
\item Many methods throw exceptions from the {\ttfamily \doxylink{namespacefourdst_1_1composition_1_1exceptions}{fourdst\+::composition\+::exceptions}} namespace on invalid usage (unknown symbols, unregistered species, or invalid abundance values). Callers should catch and handle these where appropriate.
|
||||
\item Floating point results (mass/number fractions, mean particle mass, Y\+\_\+e) are computed as doubles and may have small numerical round-\/off. Callers comparing values in tests should use an appropriate tolerance.
|
||||
\end{DoxyItemize}\hypertarget{namespacefourdst_1_1composition_autotoc_md9}{}\doxysubsubsection{\texorpdfstring{See also}{See also}}\label{namespacefourdst_1_1composition_autotoc_md9}
|
||||
|
||||
\begin{DoxyItemize}
|
||||
\item \doxylink{species_8h}{fourdst/atomic/species.\+h} — canonical atomic species definitions and symbols.
|
||||
\item \doxylink{composition_8h}{fourdst/composition/composition.\+h} — concrete \doxylink{classfourdst_1_1composition_1_1_composition}{Composition} implementation.
|
||||
\item \doxylink{composition__abstract_8h}{fourdst/composition/composition\+\_\+abstract.\+h} — abstract composition interface.
|
||||
\item \doxylink{utils_8h}{fourdst/composition/utils.\+h} — helpers for constructing compositions from mass fractions.
|
||||
\end{DoxyItemize}
|
||||
|
||||
\doxysubsection{Function Documentation}
|
||||
\Hypertarget{namespacefourdst_1_1composition_a2cb98194b465f646973ceba38d0e7d95}\index{fourdst::composition@{fourdst::composition}!buildCompositionFromMassFractions@{buildCompositionFromMassFractions}}
|
||||
\index{buildCompositionFromMassFractions@{buildCompositionFromMassFractions}!fourdst::composition@{fourdst::composition}}
|
||||
\doxysubsubsection{\texorpdfstring{buildCompositionFromMassFractions()}{buildCompositionFromMassFractions()}\hspace{0.1cm}{\footnotesize\ttfamily [1/3]}}
|
||||
{\footnotesize\ttfamily \label{namespacefourdst_1_1composition_a2cb98194b465f646973ceba38d0e7d95}
|
||||
\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition}{Composition}} fourdst\+::composition\+::build\+Composition\+From\+Mass\+Fractions (\begin{DoxyParamCaption}\item[{const std\+::set$<$ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{atomic\+::\+Species}} $>$ \&}]{species}{, }\item[{const std\+::vector$<$ double $>$ \&}]{mass\+Fractions}{}\end{DoxyParamCaption})}
|
||||
|
||||
|
||||
|
||||
Build a \doxylink{classfourdst_1_1composition_1_1_composition}{Composition} object from species in a set and their corresponding mass fractions.
|
||||
|
||||
|
||||
\begin{DoxyParams}{Parameters}
|
||||
{\em species} & The species to register. \\
|
||||
\hline
|
||||
{\em mass\+Fractions} & The corresponding mass fractions for each species. \\
|
||||
\hline
|
||||
\end{DoxyParams}
|
||||
\begin{DoxyReturn}{Returns}
|
||||
A \doxylink{classfourdst_1_1composition_1_1_composition}{Composition} object constructed from the provided species and mass fractions.
|
||||
\end{DoxyReturn}
|
||||
|
||||
\begin{DoxyExceptions}{Exceptions}
|
||||
{\em \doxylink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_composition_error}{exceptions\+::\+Invalid\+Composition\+Error}} & if the provided mass fractions do not sum to within one part in 10\texorpdfstring{$^\wedge$}{\string^}10 of 1.\+0. \\
|
||||
\hline
|
||||
{\em \doxylink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_composition_error}{exceptions\+::\+Invalid\+Composition\+Error}} & if the number of species does not match the number of mass fractions.\\
|
||||
\hline
|
||||
\end{DoxyExceptions}
|
||||
\begin{DoxyNote}{Note}
|
||||
This is the version of the function which the other overloads ultimately call.
|
||||
\end{DoxyNote}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{utils_8cpp_source_l00036}{36}} of file \mbox{\hyperlink{utils_8cpp_source}{utils.\+cpp}}.
|
||||
|
||||
\Hypertarget{namespacefourdst_1_1composition_a39d4f84dfa85ddda3b9feb5dda1afc1e}\index{fourdst::composition@{fourdst::composition}!buildCompositionFromMassFractions@{buildCompositionFromMassFractions}}
|
||||
\index{buildCompositionFromMassFractions@{buildCompositionFromMassFractions}!fourdst::composition@{fourdst::composition}}
|
||||
\doxysubsubsection{\texorpdfstring{buildCompositionFromMassFractions()}{buildCompositionFromMassFractions()}\hspace{0.1cm}{\footnotesize\ttfamily [2/3]}}
|
||||
{\footnotesize\ttfamily \label{namespacefourdst_1_1composition_a39d4f84dfa85ddda3b9feb5dda1afc1e}
|
||||
\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition}{Composition}} fourdst\+::composition\+::build\+Composition\+From\+Mass\+Fractions (\begin{DoxyParamCaption}\item[{const std\+::vector$<$ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{atomic\+::\+Species}} $>$ \&}]{species}{, }\item[{const std\+::vector$<$ double $>$ \&}]{mass\+Fractions}{}\end{DoxyParamCaption})}
|
||||
|
||||
|
||||
|
||||
Build a \doxylink{classfourdst_1_1composition_1_1_composition}{Composition} object from species and their corresponding mass fractions.
|
||||
|
||||
|
||||
\begin{DoxyParams}{Parameters}
|
||||
{\em species} & The species to register. \\
|
||||
\hline
|
||||
{\em mass\+Fractions} & The corresponding mass fractions for each species. \\
|
||||
\hline
|
||||
\end{DoxyParams}
|
||||
\begin{DoxyReturn}{Returns}
|
||||
A \doxylink{classfourdst_1_1composition_1_1_composition}{Composition} object constructed from the provided species and mass fractions.
|
||||
\end{DoxyReturn}
|
||||
|
||||
\begin{DoxyExceptions}{Exceptions}
|
||||
{\em \doxylink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_composition_error}{exceptions\+::\+Invalid\+Composition\+Error}} & if the provided mass fractions do not sum to within one part in 10\texorpdfstring{$^\wedge$}{\string^}10 of 1.\+0. \\
|
||||
\hline
|
||||
{\em \doxylink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_composition_error}{exceptions\+::\+Invalid\+Composition\+Error}} & if the number of species does not match the number of mass fractions. \\
|
||||
\hline
|
||||
\end{DoxyExceptions}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{utils_8cpp_source_l00070}{70}} of file \mbox{\hyperlink{utils_8cpp_source}{utils.\+cpp}}.
|
||||
|
||||
\Hypertarget{namespacefourdst_1_1composition_aa90b1ef07d607c0c829bedccf381cf54}\index{fourdst::composition@{fourdst::composition}!buildCompositionFromMassFractions@{buildCompositionFromMassFractions}}
|
||||
\index{buildCompositionFromMassFractions@{buildCompositionFromMassFractions}!fourdst::composition@{fourdst::composition}}
|
||||
\doxysubsubsection{\texorpdfstring{buildCompositionFromMassFractions()}{buildCompositionFromMassFractions()}\hspace{0.1cm}{\footnotesize\ttfamily [3/3]}}
|
||||
{\footnotesize\ttfamily \label{namespacefourdst_1_1composition_aa90b1ef07d607c0c829bedccf381cf54}
|
||||
\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition}{Composition}} fourdst\+::composition\+::build\+Composition\+From\+Mass\+Fractions (\begin{DoxyParamCaption}\item[{const std\+::vector$<$ std\+::string $>$ \&}]{symbols}{, }\item[{const std\+::vector$<$ double $>$ \&}]{mass\+Fractions}{}\end{DoxyParamCaption})}
|
||||
|
||||
|
||||
|
||||
Build a \doxylink{classfourdst_1_1composition_1_1_composition}{Composition} object from symbols and their corresponding mass fractions.
|
||||
|
||||
|
||||
\begin{DoxyParams}{Parameters}
|
||||
{\em symbols} & The symbols to register. \\
|
||||
\hline
|
||||
{\em mass\+Fractions} & The corresponding mass fractions for each symbol. \\
|
||||
\hline
|
||||
\end{DoxyParams}
|
||||
\begin{DoxyReturn}{Returns}
|
||||
A \doxylink{classfourdst_1_1composition_1_1_composition}{Composition} object constructed from the provided symbols and mass fractions.
|
||||
\end{DoxyReturn}
|
||||
|
||||
\begin{DoxyExceptions}{Exceptions}
|
||||
{\em \doxylink{classfourdst_1_1composition_1_1exceptions_1_1_unknown_symbol_error}{exceptions\+::\+Unknown\+Symbol\+Error}} & if any symbol is invalid. Symbols are invalid if they are not registered at compile time in the atomic species database ({\ttfamily \doxylink{species_8h}{fourdst/atomic/species.\+h}}). \\
|
||||
\hline
|
||||
{\em \doxylink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_composition_error}{exceptions\+::\+Invalid\+Composition\+Error}} & if the provided mass fractions do not sum to within one part in 10\texorpdfstring{$^\wedge$}{\string^}10 of 1.\+0. \\
|
||||
\hline
|
||||
{\em \doxylink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_composition_error}{exceptions\+::\+Invalid\+Composition\+Error}} & if the number of symbols does not match the number of mass fractions. \\
|
||||
\hline
|
||||
\end{DoxyExceptions}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{utils_8cpp_source_l00074}{74}} of file \mbox{\hyperlink{utils_8cpp_source}{utils.\+cpp}}.
|
||||
|
||||
\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]}}
|
||||
\doxysubsubsection{\texorpdfstring{operator$<$$<$()}{operator<<()}}
|
||||
{\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})}
|
||||
|
||||
|
||||
|
||||
OVERLOADS.
|
||||
|
||||
Overloaded output stream operator for \doxylink{classfourdst_1_1composition_1_1_composition}{Composition}.
|
||||
|
||||
|
||||
\begin{DoxyParams}{Parameters}
|
||||
{\em os} & The output stream. \\
|
||||
\hline
|
||||
@@ -46,35 +233,5 @@ The output stream.
|
||||
\end{DoxyReturn}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{composition_8cpp_source_l01078}{1078}} 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_l01070}{1070}} 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_l01060}{1060}} of file \mbox{\hyperlink{composition_8cpp_source}{composition.\+cpp}}.
|
||||
Definition at line \mbox{\hyperlink{composition_8cpp_source_l00593}{593}} of file \mbox{\hyperlink{composition_8cpp_source}{composition.\+cpp}}.
|
||||
|
||||
|
||||
@@ -3,25 +3,13 @@
|
||||
\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_species_error}{Species\+Error}}
|
||||
\begin{DoxyCompactList}\small\item\em Base class for exceptions related to atomic species. \end{DoxyCompactList}\item
|
||||
class \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_unknown_symbol_error}{Unknown\+Symbol\+Error}}
|
||||
\begin{DoxyCompactList}\small\item\em Exception thrown when an unknown symbol is encountered. \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}
|
||||
|
||||
@@ -1,7 +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_1atomic}{fourdst\+::atomic}} \\*Contains canonical information about atomic species and elements used by 4D-\/\+STAR }{\pageref{namespacefourdst_1_1atomic}}{}
|
||||
\item\contentsline{section}{\mbox{\hyperlink{namespacefourdst_1_1composition}{fourdst\+::composition}} \\*Utilities and types for representing and manipulating chemical compositions }{\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}
|
||||
|
||||
@@ -220,7 +220,7 @@
|
||||
\vspace*{7cm}
|
||||
\begin{center}%
|
||||
{\Large fourdst\+::libcomposition}\\
|
||||
[1ex]\large v1.\+9.\+0 \\
|
||||
[1ex]\large v2.\+0.\+0 \\
|
||||
\vspace*{1cm}
|
||||
{\large Generated by Doxygen 1.13.2}\\
|
||||
\end{center}
|
||||
@@ -252,37 +252,35 @@
|
||||
\input{classfourdst_1_1composition_1_1_composition}
|
||||
\input{class_composition_abstract}
|
||||
\input{structfourdst_1_1composition_1_1_composition_1_1_composition_cache}
|
||||
\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_species_error}
|
||||
\input{classfourdst_1_1composition_1_1exceptions_1_1_unknown_symbol_error}
|
||||
\input{classfourdst_1_1composition_1_1exceptions_1_1_unregistered_symbol_error}
|
||||
\chapter{File Documentation}
|
||||
\input{mainpage_8md}
|
||||
\input{atomic_8dox}
|
||||
\input{atomic_species_8h}
|
||||
\input{atomic_species_8h_source}
|
||||
\input{elements_8h}
|
||||
\input{elements_8h_source}
|
||||
\input{species_8h}
|
||||
\input{species_8h_source}
|
||||
\input{composition_8dox}
|
||||
\input{composition_8h}
|
||||
\input{composition_8h_source}
|
||||
\input{composition__abstract_8h}
|
||||
\input{composition__abstract_8h_source}
|
||||
\input{elements_8h}
|
||||
\input{elements_8h_source}
|
||||
\input{exceptions__composition_8h}
|
||||
\input{exceptions__composition_8h_source}
|
||||
\input{species_8h}
|
||||
\input{species_8h_source}
|
||||
\input{utils_8h}
|
||||
\input{utils_8h_source}
|
||||
\input{composition_8cpp}
|
||||
\input{composition_8cpp_source}
|
||||
\input{utils_8cpp}
|
||||
\input{utils_8cpp_source}
|
||||
%--- End generated contents ---
|
||||
% Index
|
||||
\backmatter
|
||||
|
||||
@@ -1,19 +1,33 @@
|
||||
\doxysection{src/composition/include/fourdst/composition/species.h File Reference}
|
||||
\hypertarget{species_8h}{}\label{species_8h}\index{src/composition/include/fourdst/composition/species.h@{src/composition/include/fourdst/composition/species.h}}
|
||||
\doxysection{src/composition/include/fourdst/atomic/species.h File Reference}
|
||||
\hypertarget{species_8h}{}\label{species_8h}\index{src/composition/include/fourdst/atomic/species.h@{src/composition/include/fourdst/atomic/species.h}}
|
||||
{\ttfamily \#include $<$unordered\+\_\+map$>$}\newline
|
||||
{\ttfamily \#include $<$string\+\_\+view$>$}\newline
|
||||
{\ttfamily \#include $<$string$>$}\newline
|
||||
{\ttfamily \#include $<$limits$>$}\newline
|
||||
{\ttfamily \#include "{}fourdst/composition/atomic\+Species.\+h"{}}\newline
|
||||
{\ttfamily \#include "{}fourdst/composition/elements.\+h"{}}\newline
|
||||
{\ttfamily \#include "{}fourdst/atomic/atomic\+Species.\+h"{}}\newline
|
||||
{\ttfamily \#include "{}elements.\+h"{}}\newline
|
||||
{\ttfamily \#include $<$expected$>$}\newline
|
||||
Include dependency graph for species.\+h\+:\nopagebreak
|
||||
\begin{figure}[H]
|
||||
\begin{center}
|
||||
\leavevmode
|
||||
\includegraphics[width=350pt]{species_8h__incl}
|
||||
\end{center}
|
||||
\end{figure}
|
||||
This graph shows which files directly or indirectly include this file\+:\nopagebreak
|
||||
\begin{figure}[H]
|
||||
\begin{center}
|
||||
\leavevmode
|
||||
\includegraphics[width=294pt]{species_8h__dep__incl}
|
||||
\end{center}
|
||||
\end{figure}
|
||||
\doxysubsubsection*{Namespaces}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
namespace \mbox{\hyperlink{namespacefourdst}{fourdst}}
|
||||
\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}\end{DoxyCompactItemize}
|
||||
\begin{DoxyCompactList}\small\item\em Contains canonical information about atomic species and elements used by 4D-\/\+STAR. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
\doxysubsubsection*{Enumerations}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
\doxysection{species.\+h}
|
||||
\hypertarget{species_8h_source}{}\label{species_8h_source}\index{src/composition/include/fourdst/composition/species.h@{src/composition/include/fourdst/composition/species.h}}
|
||||
\hypertarget{species_8h_source}{}\label{species_8h_source}\index{src/composition/include/fourdst/atomic/species.h@{src/composition/include/fourdst/atomic/species.h}}
|
||||
\mbox{\hyperlink{species_8h}{Go to the documentation of this file.}}
|
||||
\begin{DoxyCode}{0}
|
||||
\DoxyCodeLine{\Hypertarget{species_8h_source_l00001}00001\ \textcolor{preprocessor}{\#pragma\ once}}
|
||||
@@ -7,8 +7,8 @@
|
||||
\DoxyCodeLine{\Hypertarget{species_8h_source_l00003}00003\ \textcolor{preprocessor}{\#include\ <string\_view>}}
|
||||
\DoxyCodeLine{\Hypertarget{species_8h_source_l00004}00004\ \textcolor{preprocessor}{\#include\ <string>}}
|
||||
\DoxyCodeLine{\Hypertarget{species_8h_source_l00005}00005\ \textcolor{preprocessor}{\#include\ <limits>}\ \textcolor{comment}{//\ Required\ for\ std::numeric\_limits}}
|
||||
\DoxyCodeLine{\Hypertarget{species_8h_source_l00006}00006\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{atomic_species_8h}{fourdst/composition/atomicSpecies.h}}"{}}}
|
||||
\DoxyCodeLine{\Hypertarget{species_8h_source_l00007}00007\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{elements_8h}{fourdst/composition/elements.h}}"{}}}
|
||||
\DoxyCodeLine{\Hypertarget{species_8h_source_l00006}00006\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{atomic_species_8h}{fourdst/atomic/atomicSpecies.h}}"{}}}
|
||||
\DoxyCodeLine{\Hypertarget{species_8h_source_l00007}00007\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{elements_8h}{elements.h}}"{}}}
|
||||
\DoxyCodeLine{\Hypertarget{species_8h_source_l00008}00008\ }
|
||||
\DoxyCodeLine{\Hypertarget{species_8h_source_l00009}00009\ \textcolor{preprocessor}{\#include\ <expected>}\ \textcolor{comment}{//\ For\ std::expected}}
|
||||
\DoxyCodeLine{\Hypertarget{species_8h_source_l00010}00010\ }
|
||||
|
||||
@@ -9,6 +9,15 @@ Represents an atomic species (isotope) with its fundamental physical properties.
|
||||
|
||||
{\ttfamily \#include $<$atomic\+Species.\+h$>$}
|
||||
|
||||
|
||||
|
||||
Collaboration diagram for fourdst\+::atomic\+::Species\+:\nopagebreak
|
||||
\begin{figure}[H]
|
||||
\begin{center}
|
||||
\leavevmode
|
||||
\includegraphics[width=210pt]{structfourdst_1_1atomic_1_1_species__coll__graph}
|
||||
\end{center}
|
||||
\end{figure}
|
||||
\doxysubsubsection*{Public Member Functions}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
@@ -77,7 +86,7 @@ double \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_ab3e057d426e0d8dbf01
|
||||
\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
|
||||
std\+::optional$<$ double $>$ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species_a9dcfca3c5e28f6523bb1a10ede645048}{m\+\_\+spin}} = std\+::nullopt
|
||||
\begin{DoxyCompactList}\small\item\em Nuclear spin as a double, derived from m\+\_\+spin\+Parity. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
\doxysubsubsection*{Friends}
|
||||
\begin{DoxyCompactItemize}
|
||||
@@ -105,7 +114,7 @@ This struct is designed to be lightweight and is primarily a data container.
|
||||
\begin{DoxyParagraph}{Usage Example}
|
||||
|
||||
\begin{DoxyCode}{0}
|
||||
\DoxyCodeLine{\textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{atomic_species_8h}{fourdst/composition/atomicSpecies.h}}"{}}}
|
||||
\DoxyCodeLine{\textcolor{preprocessor}{\#include\ "{}fourdst/composition/atomicSpecies.h"{}}}
|
||||
\DoxyCodeLine{\textcolor{preprocessor}{\#include\ <iostream>}}
|
||||
\DoxyCodeLine{}
|
||||
\DoxyCodeLine{\textcolor{keywordtype}{int}\ main()\ \{}
|
||||
@@ -199,7 +208,7 @@ A new \doxylink{structfourdst_1_1atomic_1_1_species}{Species} object is created
|
||||
\end{DoxyPostcond}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00126}{126}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00124}{124}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
|
||||
|
||||
|
||||
@@ -219,7 +228,7 @@ The mass number (A = N + Z).
|
||||
\end{DoxyReturn}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00253}{253}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
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}}
|
||||
@@ -236,7 +245,7 @@ A string\+\_\+view of the beta decay code.
|
||||
\end{DoxyReturn}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00205}{205}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
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}}
|
||||
@@ -253,7 +262,7 @@ The beta decay energy in keV.
|
||||
\end{DoxyReturn}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00197}{197}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
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}}
|
||||
@@ -270,7 +279,7 @@ The binding energy in keV.
|
||||
\end{DoxyReturn}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00189}{189}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
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}}
|
||||
@@ -287,7 +296,7 @@ A string\+\_\+view of the decay modes.
|
||||
\end{DoxyReturn}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00181}{181}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
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}}
|
||||
@@ -304,7 +313,7 @@ A string\+\_\+view of the element symbol (e.\+g., "{}\+Fe"{}).
|
||||
\end{DoxyReturn}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00221}{221}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
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}}
|
||||
@@ -321,7 +330,7 @@ The half-\/life in seconds.
|
||||
\end{DoxyReturn}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00165}{165}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
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}}
|
||||
@@ -338,7 +347,7 @@ The atomic mass in atomic mass units (u).
|
||||
\end{DoxyReturn}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00149}{149}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
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}}
|
||||
@@ -355,7 +364,7 @@ The atomic mass uncertainty.
|
||||
\end{DoxyReturn}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00157}{157}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
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}}
|
||||
@@ -372,7 +381,7 @@ The number of neutrons (N).
|
||||
\end{DoxyReturn}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00237}{237}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
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}}
|
||||
@@ -389,7 +398,7 @@ A string\+\_\+view of the species name (e.\+g., "{}\+Fe56"{}).
|
||||
\end{DoxyReturn}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00213}{213}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
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}}
|
||||
@@ -406,7 +415,7 @@ The NZ identifier (1000\texorpdfstring{$\ast$}{*}Z + A).
|
||||
\end{DoxyReturn}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00229}{229}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
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}}
|
||||
@@ -423,7 +432,7 @@ The spin as a double.
|
||||
\end{DoxyReturn}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00261}{261}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
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}}
|
||||
@@ -440,7 +449,7 @@ A string\+\_\+view of the spin and parity (e.\+g., "{}1/2+"{}).
|
||||
\end{DoxyReturn}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00173}{173}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
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}}
|
||||
@@ -457,7 +466,7 @@ The atomic number (Z).
|
||||
\end{DoxyReturn}
|
||||
|
||||
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00245}{245}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00242}{242}} of file \mbox{\hyperlink{atomic_species_8h_source}{atomic\+Species.\+h}}.
|
||||
|
||||
|
||||
|
||||
@@ -753,11 +762,11 @@ NZ identifier, typically 1000\texorpdfstring{$\ast$}{*}Z + A.
|
||||
|
||||
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_af1d73b936b428aaa29b37c119e3426e7}\index{fourdst::atomic::Species@{fourdst::atomic::Species}!m\_spin@{m\_spin}}
|
||||
\Hypertarget{structfourdst_1_1atomic_1_1_species_a9dcfca3c5e28f6523bb1a10ede645048}\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}
|
||||
{\footnotesize\ttfamily \label{structfourdst_1_1atomic_1_1_species_a9dcfca3c5e28f6523bb1a10ede645048}
|
||||
std\+::optional$<$double$>$ fourdst\+::atomic\+::\+Species\+::m\+\_\+spin = std\+::nullopt\hspace{0.3cm}{\ttfamily [mutable]}}
|
||||
|
||||
|
||||
|
||||
@@ -799,4 +808,4 @@ Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00056}{56}} of fil
|
||||
|
||||
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}
|
||||
src/composition/include/fourdst/atomic/\mbox{\hyperlink{atomic_species_8h}{atomic\+Species.\+h}}\end{DoxyCompactItemize}
|
||||
|
||||
@@ -24,7 +24,7 @@ This allows {\ttfamily \doxylink{structfourdst_1_1atomic_1_1_species}{fourdst\+:
|
||||
\begin{DoxyParagraph}{Usage Example}
|
||||
|
||||
\begin{DoxyCode}{0}
|
||||
\DoxyCodeLine{\textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{atomic_species_8h}{fourdst/composition/atomicSpecies.h}}"{}}}
|
||||
\DoxyCodeLine{\textcolor{preprocessor}{\#include\ "{}fourdst/composition/atomicSpecies.h"{}}}
|
||||
\DoxyCodeLine{\textcolor{preprocessor}{\#include\ <unordered\_map>}}
|
||||
\DoxyCodeLine{\textcolor{preprocessor}{\#include\ <string>}}
|
||||
\DoxyCodeLine{}
|
||||
@@ -71,4 +71,4 @@ Definition at line \mbox{\hyperlink{atomic_species_8h_source_l00434}{434}} of fi
|
||||
|
||||
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}
|
||||
src/composition/include/fourdst/atomic/\mbox{\hyperlink{atomic_species_8h}{atomic\+Species.\+h}}\end{DoxyCompactItemize}
|
||||
|
||||
Reference in New Issue
Block a user