2025-07-24 09:35:52 -04:00
\doxysection { fourdst\+ ::composition\+ ::Composition Class Reference}
\hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition} { } \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} }
Manages a collection of chemical species and their abundances.
{ \ttfamily \# include $ < $ composition.\+ h$ > $ }
2025-10-12 10:22:43 -04:00
Inheritance diagram for fourdst\+ ::composition\+ ::Composition\+ :\begin { figure} [H]
\begin { center}
\leavevmode
\includegraphics [height=2.000000cm] { classfourdst_ 1_ 1composition_ 1_ 1_ composition}
\end { center}
\end { figure}
\doxysubsubsection * { Classes}
\begin { DoxyCompactItemize}
\item
struct \mbox { \hyperlink { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ 1_ 1_ composition_ cache} { Composition\+ Cache} }
\end { DoxyCompactItemize}
2025-07-24 09:35:52 -04:00
\doxysubsubsection * { Public Member Functions}
\begin { DoxyCompactItemize}
\item
\mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a23b83b76ee025f6fc009184ee19bba88} { Composition} } ()=default
\begin { DoxyCompactList} \small \item \em Default constructor. \end { DoxyCompactList} \item
2025-10-12 10:22:43 -04:00
\mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a08c1d1fe9384c5255a6ba40e34b18315} { \texorpdfstring { $ \sim $ } { \string ~} \+ Composition} } () override=default
2025-07-24 09:35:52 -04:00
\begin { DoxyCompactList} \small \item \em Default destructor. \end { DoxyCompactList} \item
bool \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a72d063a74a9d2197065884a2cea57a14} { finalize} } (bool norm=false)
\begin { DoxyCompactList} \small \item \em Finalizes the composition, making it ready for querying. \end { DoxyCompactList} \item
\mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ ae3cc2099efd7db8eec3d9af2294b75fa} { Composition} } (const std\+ ::vector$ < $ std\+ ::string $ > $ \& symbols)
\begin { DoxyCompactList} \small \item \em Constructs a \doxylink { classfourdst_ 1_ 1composition_ 1_ 1_ composition} { Composition} and registers the given symbols. \end { DoxyCompactList} \item
\mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a2d6fbe5c8142b358641bbe7ffde51053} { Composition} } (const std\+ ::set$ < $ std\+ ::string $ > $ \& symbols)
\begin { DoxyCompactList} \small \item \em Constructs a \doxylink { classfourdst_ 1_ 1composition_ 1_ 1_ composition} { Composition} and registers the given symbols from a set. \end { DoxyCompactList} \item
\mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ af4d4cc5875cba931a91faee13f55594e} { Composition} } (const std\+ ::vector$ < $ std\+ ::string $ > $ \& symbols, const std\+ ::vector$ < $ double $ > $ \& fractions, bool mass\+ Frac\+ Mode=true)
\begin { DoxyCompactList} \small \item \em Constructs and finalizes a \doxylink { classfourdst_ 1_ 1composition_ 1_ 1_ composition} { Composition} with the given symbols and fractions. \end { DoxyCompactList} \item
\mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a21369a80378d4c90438a34f0e4a275ca} { Composition} } (const \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition} { Composition} } \& composition)
\begin { DoxyCompactList} \small \item \em Constructs a \doxylink { classfourdst_ 1_ 1composition_ 1_ 1_ composition} { Composition} from another \doxylink { classfourdst_ 1_ 1composition_ 1_ 1_ composition} { Composition} . \end { DoxyCompactList} \item
\mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition} { Composition} } \& \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a4ec1e23cfecef764cb831171fed62fc2} { operator=} } (\mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition} { Composition} } const \& other)
\begin { DoxyCompactList} \small \item \em Assignment operator. \end { DoxyCompactList} \item
void \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a1bc2e64f87c12befdc2bc767e7405661} { register\+ Symbol} } (const std\+ ::string \& symbol, bool mass\+ Frac\+ Mode=true)
\begin { DoxyCompactList} \small \item \em Registers a new symbol for inclusion in the composition. \end { DoxyCompactList} \item
void \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a9b422156600823276a9606bfa07ad4db} { register\+ Symbol} } (const std\+ ::vector$ < $ std\+ ::string $ > $ \& symbols, bool mass\+ Frac\+ Mode=true)
\begin { DoxyCompactList} \small \item \em Registers multiple new symbols. \end { DoxyCompactList} \item
void \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a4ce00f73cc133bb1bac2b030b93ab480} { register\+ Species} } (const \mbox { \hyperlink { structfourdst_ 1_ 1atomic_ 1_ 1_ species} { fourdst\+ ::atomic\+ ::\+ Species} } \& species, bool mass\+ Frac\+ Mode=true)
\begin { DoxyCompactList} \small \item \em Registers a new species by extracting its symbol. \end { DoxyCompactList} \item
void \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a057f2bf2e86bcc3c649c0ddf18cf3826} { register\+ Species} } (const std\+ ::vector$ < $ \mbox { \hyperlink { structfourdst_ 1_ 1atomic_ 1_ 1_ species} { fourdst\+ ::atomic\+ ::\+ Species} } $ > $ \& species, bool mass\+ Frac\+ Mode=true)
\begin { DoxyCompactList} \small \item \em Registers a vector of new species. \end { DoxyCompactList} \item
2025-10-12 10:22:43 -04:00
std\+ ::set$ < $ std\+ ::string $ > $ \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a3f10f38878ba4be121d6d77a8b1f4d7a} { get\+ Registered\+ Symbols} } () const override
2025-07-24 09:35:52 -04:00
\begin { DoxyCompactList} \small \item \em Gets the registered symbols. \end { DoxyCompactList} \item
2025-10-12 10:22:43 -04:00
std\+ ::set$ < $ \mbox { \hyperlink { structfourdst_ 1_ 1atomic_ 1_ 1_ species} { fourdst\+ ::atomic\+ ::\+ Species} } $ > $ \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ af61ebe73a8b5926eb23037bb078fa87a} { get\+ Registered\+ Species} } () const override
2025-07-24 09:35:52 -04:00
\begin { DoxyCompactList} \small \item \em Get a set of all species that are registered in the composition. \end { DoxyCompactList} \item
double \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a493224656aa3ade68389250720ef09af} { set\+ Mass\+ Fraction} } (const std\+ ::string \& symbol, const double \& mass\+ \_ \+ fraction)
\begin { DoxyCompactList} \small \item \em Sets the mass fraction for a given symbol. \end { DoxyCompactList} \item
std\+ ::vector$ < $ double $ > $ \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a66ce1012c12b0a83629eb09d451b68e3} { set\+ Mass\+ Fraction} } (const std\+ ::vector$ < $ std\+ ::string $ > $ \& symbols, const std\+ ::vector$ < $ double $ > $ \& mass\+ \_ \+ fractions)
\begin { DoxyCompactList} \small \item \em Sets the mass fraction for multiple symbols. \end { DoxyCompactList} \item
double \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ aa6c94269a5d16349c98860f3015b734a} { set\+ Mass\+ Fraction} } (const \mbox { \hyperlink { structfourdst_ 1_ 1atomic_ 1_ 1_ species} { fourdst\+ ::atomic\+ ::\+ Species} } \& species, const double \& mass\+ \_ \+ fraction)
\begin { DoxyCompactList} \small \item \em Sets the mass fraction for a given species. \end { DoxyCompactList} \item
std\+ ::vector$ < $ double $ > $ \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ abbae020d46c74708a7974c1ca755bb62} { set\+ Mass\+ Fraction} } (const std\+ ::vector$ < $ \mbox { \hyperlink { structfourdst_ 1_ 1atomic_ 1_ 1_ species} { fourdst\+ ::atomic\+ ::\+ Species} } $ > $ \& species, const std\+ ::vector$ < $ double $ > $ \& mass\+ \_ \+ fractions)
\begin { DoxyCompactList} \small \item \em Sets the mass fraction for multiple species. \end { DoxyCompactList} \item
double \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a7d4d748f3ee25e68751fb143717ed080} { set\+ Number\+ Fraction} } (const std\+ ::string \& symbol, const double \& number\+ \_ \+ fraction)
\begin { DoxyCompactList} \small \item \em Sets the number fraction for a given symbol. \end { DoxyCompactList} \item
std\+ ::vector$ < $ double $ > $ \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a48014a0a725ebd91ad1193c063b5b26f} { set\+ Number\+ Fraction} } (const std\+ ::vector$ < $ std\+ ::string $ > $ \& symbols, const std\+ ::vector$ < $ double $ > $ \& number\+ \_ \+ fractions)
\begin { DoxyCompactList} \small \item \em Sets the number fraction for multiple symbols. \end { DoxyCompactList} \item
double \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ aaa822bb48a948d101fef759ffbefe31b} { set\+ Number\+ Fraction} } (const \mbox { \hyperlink { structfourdst_ 1_ 1atomic_ 1_ 1_ species} { fourdst\+ ::atomic\+ ::\+ Species} } \& species, const double \& number\+ \_ \+ fraction)
\begin { DoxyCompactList} \small \item \em Sets the number fraction for a given species. \end { DoxyCompactList} \item
std\+ ::vector$ < $ double $ > $ \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ adc068778a1ef33cad67f5ca028b49bb8} { set\+ Number\+ Fraction} } (const std\+ ::vector$ < $ \mbox { \hyperlink { structfourdst_ 1_ 1atomic_ 1_ 1_ species} { fourdst\+ ::atomic\+ ::\+ Species} } $ > $ \& species, const std\+ ::vector$ < $ double $ > $ \& number\+ \_ \+ fractions)
\begin { DoxyCompactList} \small \item \em Sets the number fraction for multiple species. \end { DoxyCompactList} \item
\mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition} { Composition} } \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a3aead72892606725a4149a5f65bd31ec} { mix} } (const \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition} { Composition} } \& other, double fraction) const
\begin { DoxyCompactList} \small \item \em Mixes this composition with another to produce a new composition. \end { DoxyCompactList} \item
2025-10-12 10:22:43 -04:00
std\+ ::unordered\+ \_ \+ map$ < $ std\+ ::string, double $ > $ \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ aae07019ab6e02394e6ea353e0b98a417} { get\+ Mass\+ Fraction} } () const override
2025-07-24 09:35:52 -04:00
\begin { DoxyCompactList} \small \item \em Gets the mass fractions of all species in the composition. \end { DoxyCompactList} \item
2025-10-12 10:22:43 -04:00
double \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ ae5d8d21632fca2b35b0898f2b205cd10} { get\+ Mass\+ Fraction} } (const std\+ ::string \& symbol) const override
2025-07-24 09:35:52 -04:00
\begin { DoxyCompactList} \small \item \em Gets the mass fraction for a given symbol. \end { DoxyCompactList} \item
2025-10-12 10:22:43 -04:00
double \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ aeae9d6d3f742cd8b59b58abcb228a44d} { get\+ Mass\+ Fraction} } (const \mbox { \hyperlink { structfourdst_ 1_ 1atomic_ 1_ 1_ species} { fourdst\+ ::atomic\+ ::\+ Species} } \& species) const override
2025-07-24 09:35:52 -04:00
\begin { DoxyCompactList} \small \item \em Gets the mass fraction for a given isotope. \end { DoxyCompactList} \item
2025-10-12 10:22:43 -04:00
double \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a34f71d4d8f0297c576fd62fabd490305} { get\+ Number\+ Fraction} } (const std\+ ::string \& symbol) const override
2025-07-24 09:35:52 -04:00
\begin { DoxyCompactList} \small \item \em Gets the number fraction for a given symbol. \end { DoxyCompactList} \item
2025-10-12 10:22:43 -04:00
double \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a178d7393ee8b5d496925dcd901c03d23} { get\+ Number\+ Fraction} } (const \mbox { \hyperlink { structfourdst_ 1_ 1atomic_ 1_ 1_ species} { fourdst\+ ::atomic\+ ::\+ Species} } \& species) const override
2025-07-24 09:35:52 -04:00
\begin { DoxyCompactList} \small \item \em Gets the number fraction for a given isotope. \end { DoxyCompactList} \item
2025-10-12 10:22:43 -04:00
std\+ ::unordered\+ \_ \+ map$ < $ std\+ ::string, double $ > $ \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ ae46fb8c3020dadd69080a7acd2054ea1} { get\+ Number\+ Fraction} } () const override
2025-07-24 09:35:52 -04:00
\begin { DoxyCompactList} \small \item \em Gets the number fractions of all species in the composition. \end { DoxyCompactList} \item
2025-10-12 10:22:43 -04:00
double \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ add67a92d73e3a57a2bbdb52bc9ca3bfe} { get\+ Molar\+ Abundance} } (const std\+ ::string \& symbol) const override
2025-07-24 09:35:52 -04:00
\begin { DoxyCompactList} \small \item \em Gets the molar abundance (X\+ \_ \+ i / A\+ \_ \+ i) for a given symbol. \end { DoxyCompactList} \item
2025-10-12 10:22:43 -04:00
double \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a28c70279d36826e0e1026da3fa892ffc} { get\+ Molar\+ Abundance} } (const \mbox { \hyperlink { structfourdst_ 1_ 1atomic_ 1_ 1_ species} { fourdst\+ ::atomic\+ ::\+ Species} } \& species) const override
2025-07-24 09:35:52 -04:00
\begin { DoxyCompactList} \small \item \em Gets the molar abundance for a given isotope. \end { DoxyCompactList} \item
std\+ ::pair$ < $ \mbox { \hyperlink { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry} { Composition\+ Entry} } , \mbox { \hyperlink { structfourdst_ 1_ 1composition_ 1_ 1_ global_ composition} { Global\+ Composition} } $ > $ \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a092d3536b04167ea2e6e3a3b1446c377} { get\+ Composition} } (const std\+ ::string \& symbol) const
\begin { DoxyCompactList} \small \item \em Gets the composition entry and global composition data for a given symbol. \end { DoxyCompactList} \item
std\+ ::pair$ < $ \mbox { \hyperlink { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry} { Composition\+ Entry} } , \mbox { \hyperlink { structfourdst_ 1_ 1composition_ 1_ 1_ global_ composition} { Global\+ Composition} } $ > $ \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ afe5f1086027044c84ff35a366b2e8e2d} { get\+ Composition} } (const \mbox { \hyperlink { structfourdst_ 1_ 1atomic_ 1_ 1_ species} { fourdst\+ ::atomic\+ ::\+ Species} } \& species) const
\begin { DoxyCompactList} \small \item \em Gets the composition entry and global composition data for a given species. \end { DoxyCompactList} \item
std\+ ::pair$ < $ std\+ ::unordered\+ \_ \+ map$ < $ std\+ ::string, \mbox { \hyperlink { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry} { Composition\+ Entry} } $ > $ , \mbox { \hyperlink { structfourdst_ 1_ 1composition_ 1_ 1_ global_ composition} { Global\+ Composition} } $ > $ \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a1138c86f7ccd39594601c2ec63ad89e9} { get\+ Composition} } () const
\begin { DoxyCompactList} \small \item \em Gets all composition entries and the global composition data. \end { DoxyCompactList} \item
2025-10-12 10:22:43 -04:00
double \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a796386824d1358527fed7c6b537935d8} { get\+ Mean\+ Particle\+ Mass} } () const override
2025-07-24 09:35:52 -04:00
\begin { DoxyCompactList} \small \item \em Compute the mean particle mass of the composition. \end { DoxyCompactList} \item
2025-10-12 10:22:43 -04:00
double \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ af7dd8f7d69727acfacf1bf58c4083a27} { get\+ Mean\+ Atomic\+ Number} } () const override
2025-07-24 09:35:52 -04:00
\begin { DoxyCompactList} \small \item \em Compute the mean atomic number of the composition. \end { DoxyCompactList} \item
2025-10-12 10:22:43 -04:00
double \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a62dcfcf8f824d6af7903a9a9c3d5721e} { get\+ Electron\+ Abundance} } () const override
\begin { DoxyCompactList} \small \item \em Compute the electron abundance of the composition. \end { DoxyCompactList} \item
2025-07-24 09:35:52 -04:00
\mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition} { Composition} } \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a17635cd21744c7cf86cb1eb75152c816} { subset} } (const std\+ ::vector$ < $ std\+ ::string $ > $ \& symbols, const std\+ ::string \& method="{ } norm"{ } ) const
\begin { DoxyCompactList} \small \item \em Creates a new \doxylink { classfourdst_ 1_ 1composition_ 1_ 1_ composition} { Composition} object containing a subset of species from this one. \end { DoxyCompactList} \item
2025-10-12 10:22:43 -04:00
bool \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ ac01ae1967c266d8187bc6e104c8a0d19} { has\+ Symbol} } (const std\+ ::string \& symbol) const override
2025-07-24 09:35:52 -04:00
\begin { DoxyCompactList} \small \item \em Checks if a symbol is registered in the composition. \end { DoxyCompactList} \item
2025-10-12 10:22:43 -04:00
bool \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a55dfadad6cf5fb249356edad1733a813} { has\+ Species} } (const \mbox { \hyperlink { structfourdst_ 1_ 1atomic_ 1_ 1_ species} { fourdst\+ ::atomic\+ ::\+ Species} } \& species) const override
\begin { DoxyCompactList} \small \item \em Checks if a species is registered in the composition. \end { DoxyCompactList} \item
bool \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a7efe2cd3a69b743bf2086941b6dfd965} { contains} } (const \mbox { \hyperlink { structfourdst_ 1_ 1atomic_ 1_ 1_ species} { atomic\+ ::\+ Species} } \& isotope) const override
2025-07-24 09:35:52 -04:00
\begin { DoxyCompactList} \small \item \em Checks if a given isotope is present in the composition. \end { DoxyCompactList} \item
void \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a0af981ed1074b26c237cf6cf35f82c9e} { set\+ Composition\+ Mode} } (bool mass\+ Frac\+ Mode)
\begin { DoxyCompactList} \small \item \em Sets the composition mode (mass fraction vs. number fraction). \end { DoxyCompactList} \item
\mbox { \hyperlink { structfourdst_ 1_ 1composition_ 1_ 1_ canonical_ composition} { Canonical\+ Composition} } \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ ac75dbc8377556c835455991c7c7fe206} { get\+ Canonical\+ Composition} } (bool harsh=false) const
\begin { DoxyCompactList} \small \item \em Gets the current canonical composition (X, Y, Z). \end { DoxyCompactList} \item
2025-10-12 10:22:43 -04:00
std\+ ::vector$ < $ double $ > $ \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a85169b763138ab72047e43e07af978fb} { get\+ Mass\+ Fraction\+ Vector} } () const override
2025-09-16 11:24:28 -04:00
\begin { DoxyCompactList} \small \item \em Get a uniform vector representation of the mass fraction stored in the composition object sorted such that the lightest species is at index 0 and the heaviest is at the last index. \end { DoxyCompactList} \item
2025-10-12 10:22:43 -04:00
std\+ ::vector$ < $ double $ > $ \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a49d2eba540f28324c6b7145a5b6cabfd} { get\+ Number\+ Fraction\+ Vector} } () const override
2025-09-16 11:24:28 -04:00
\begin { DoxyCompactList} \small \item \em Get a uniform vector representation of the number fractions stored in the composition object sorted such that the lightest species is at index 0 and the heaviest is at the last index. \end { DoxyCompactList} \item
2025-10-12 10:22:43 -04:00
std\+ ::vector$ < $ double $ > $ \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ abed665c07c42b40682da453576621399} { get\+ Molar\+ Abundance\+ Vector} } () const override
2025-09-16 11:24:28 -04:00
\begin { DoxyCompactList} \small \item \em Get a uniform vector representation of the molar abundances stored in the composition object sorted such that the lightest species is at index 0 and the heaviest is at the last index. \end { DoxyCompactList} \item
2025-10-12 10:22:43 -04:00
size\+ \_ \+ t \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a0d94f62402bb90b5d12679faeaa8c5d7} { get\+ Species\+ Index} } (const std\+ ::string \& symbol) const override
2025-09-16 11:24:28 -04:00
\begin { DoxyCompactList} \small \item \em get the index in the sorted vector representation for a given symbol \end { DoxyCompactList} \item
2025-10-12 10:22:43 -04:00
size\+ \_ \+ t \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a3d220b42fa06d7d3a43944ee2b8f6a5f} { get\+ Species\+ Index} } (const \mbox { \hyperlink { structfourdst_ 1_ 1atomic_ 1_ 1_ species} { atomic\+ ::\+ Species} } \& species) const override
2025-09-16 11:24:28 -04:00
\begin { DoxyCompactList} \small \item \em get the index in the sorted vector representation for a given symbol \end { DoxyCompactList} \item
2025-10-12 10:22:43 -04:00
\mbox { \hyperlink { structfourdst_ 1_ 1atomic_ 1_ 1_ species} { atomic\+ ::\+ Species} } \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ ae4f854ded38f5e6fcd157a74a57cbf0c} { get\+ Species\+ At\+ Index} } (size\+ \_ \+ t index) const override
2025-09-16 11:24:28 -04:00
\begin { DoxyCompactList} \small \item \em Get the species at a given index in the sorted vector representation. \end { DoxyCompactList} \item
2025-07-24 09:35:52 -04:00
\mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition} { Composition} } \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a24a3bdeb8e8e55b54ecdee6dcb0d9561} { operator+} } (const \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition} { Composition} } \& other) const
\begin { DoxyCompactList} \small \item \em Overloads the + operator to mix two compositions with a 50/50 fraction. \end { DoxyCompactList} \item
auto \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ ab1701644ff1c83c220dc04eb58d1621b} { begin} } ()
\begin { DoxyCompactList} \small \item \em Returns an iterator to the beginning of the composition map. \end { DoxyCompactList} \item
auto \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ adf41a833e8b704daf4f581fca5c8cb9b} { begin} } () const
\begin { DoxyCompactList} \small \item \em Returns a const iterator to the beginning of the composition map. \end { DoxyCompactList} \item
auto \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ adeaf6f1213e78cb1fe8a8317f0a8adc2} { end} } ()
\begin { DoxyCompactList} \small \item \em Returns an iterator to the end of the composition map. \end { DoxyCompactList} \item
auto \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ aed2f5676f8f742199f01e4d1e9664bdd} { end} } () const
\begin { DoxyCompactList} \small \item \em Returns a const iterator to the end of the composition map. \end { DoxyCompactList} \end { DoxyCompactItemize}
2025-10-12 10:22:43 -04:00
\doxysubsection * { Public Member Functions inherited from \mbox { \hyperlink { class_ composition_ abstract} { Composition\+ Abstract} } }
\begin { DoxyCompactItemize}
\item
virtual \mbox { \hyperlink { class_ composition_ abstract_ aaae3d6215b7433cb9871664852a95d1b} { \texorpdfstring { $ \sim $ } { \string ~} \+ Composition\+ Abstract} } ()=default
\begin { DoxyCompactList} \small \item \em Virtual destructor. \end { DoxyCompactList} \end { DoxyCompactItemize}
2025-07-24 09:35:52 -04:00
\doxysubsubsection * { Private Member Functions}
\begin { DoxyCompactItemize}
\item
bool \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ addf03ba8b988970d341884d487aa94d5} { is\+ Valid\+ Composition} } (const std\+ ::vector$ < $ double $ > $ \& fractions) const
\begin { DoxyCompactList} \small \item \em Checks if the given fractions are valid (sum to \texorpdfstring { $ \sim $ } { \string ~} 1.0). \end { DoxyCompactList} \item
void \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a86982685c34db4a8f079ddafc25c594e} { validate\+ Composition} } (const std\+ ::vector$ < $ double $ > $ \& fractions) const
\begin { DoxyCompactList} \small \item \em Validates the given fractions, throwing an exception on failure. \end { DoxyCompactList} \item
bool \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a869dbae3db9d09c57b2df56a813a55fb} { finalize\+ Mass\+ Frac\+ Mode} } (bool norm)
\begin { DoxyCompactList} \small \item \em Finalizes the composition in mass fraction mode. \end { DoxyCompactList} \item
bool \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a461ab4e9cb5975cf865db5f16f03ddfe} { finalize\+ Number\+ Frac\+ Mode} } (bool norm)
\begin { DoxyCompactList} \small \item \em Finalizes the composition in number fraction mode. \end { DoxyCompactList} \end { DoxyCompactItemize}
\doxysubsubsection * { Static Private Member Functions}
\begin { DoxyCompactItemize}
\item
static bool \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a8fdac26e6298008aaeaa5b15f7fe244f} { is\+ Valid\+ Symbol} } (const std\+ ::string \& symbol)
\begin { DoxyCompactList} \small \item \em Checks if the given symbol is valid by checking against the global species database. \end { DoxyCompactList} \end { DoxyCompactItemize}
\doxysubsubsection * { Private Attributes}
\begin { DoxyCompactItemize}
\item
2025-10-12 10:22:43 -04:00
config\+ ::\+ Config \& \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a1f96b2c567364368ea5ee6f0826f3091} { m\+ \_ \+ config} } = config\+ ::\+ Config\+ ::get\+ Instance()
2025-07-24 09:35:52 -04:00
\item
2025-10-12 10:22:43 -04:00
logging\+ ::\+ Log\+ Manager \& \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a40b2128948f01630cd2968488b450ce5} { m\+ \_ \+ log\+ Manager} } = logging\+ ::\+ Log\+ Manager\+ ::get\+ Instance()
2025-07-24 09:35:52 -04:00
\item
quill\+ ::\+ Logger \texorpdfstring { $ \ast $ } { *} \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ ab6c66f35e1fb05dd24aacaf90e115c5e} { m\+ \_ \+ logger} } = m\+ \_ \+ log\+ Manager.\+ get\+ Logger("{ } log"{ } )
\item
bool \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ aa00cbc0933d8a22bb900ac21a338e5ac} { m\+ \_ \+ finalized} } = false
\begin { DoxyCompactList} \small \item \em True if the composition is finalized. \end { DoxyCompactList} \item
double \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ addae4484da7d5072ab66a721dbe04ced} { m\+ \_ \+ specific\+ Number\+ Density} } = 0.\+ 0
\begin { DoxyCompactList} \small \item \em The specific number density of the composition (\textbackslash { } sum\+ \_ \+ \{ i\} X\+ \_ \+ i m\+ \_ \+ i. Where X\+ \_ \+ i is the number fraction of the ith species and m\+ \_ \+ i is the mass of the ith species). \end { DoxyCompactList} \item
double \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a4a36c8d22ce61023e7bea1d9417577d4} { m\+ \_ \+ mean\+ Particle\+ Mass} } = 0.\+ 0
\begin { DoxyCompactList} \small \item \em The mean particle mass of the composition (\textbackslash { } sum\+ \_ \+ \{ i\} \textbackslash { } frac\{ n\+ \_ \+ i\} \{ m\+ \_ \+ i\} . where n\+ \_ \+ i is the number fraction of the ith species and m\+ \_ \+ i is the mass of the ith species). \end { DoxyCompactList} \item
bool \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a671f1ee8be00f4ff8c1d94fabb382380} { m\+ \_ \+ mass\+ Frac\+ Mode} } = true
\begin { DoxyCompactList} \small \item \em True if mass fraction mode, false if number fraction mode. \end { DoxyCompactList} \item
std\+ ::set$ < $ std\+ ::string $ > $ \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a39bfcb7d81d723cbd9d021abd533b4d6} { m\+ \_ \+ registered\+ Symbols} }
\begin { DoxyCompactList} \small \item \em The registered symbols. \end { DoxyCompactList} \item
std\+ ::unordered\+ \_ \+ map$ < $ std\+ ::string, \mbox { \hyperlink { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry} { Composition\+ Entry} } $ > $ \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ aa7f2753b10e85ae3bbf0c3d600a973db} { m\+ \_ \+ compositions} }
2025-10-12 10:22:43 -04:00
\begin { DoxyCompactList} \small \item \em The compositions. \end { DoxyCompactList} \item
\mbox { \hyperlink { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ 1_ 1_ composition_ cache} { Composition\+ Cache} } \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a02cd9d9608da082a200fdfa86d14bf5d} { m\+ \_ \+ cache} }
\begin { DoxyCompactList} \small \item \em Cache for computed properties to avoid redundant calculations. \end { DoxyCompactList} \end { DoxyCompactItemize}
2025-07-24 09:35:52 -04:00
\doxysubsubsection * { Friends}
\begin { DoxyCompactItemize}
\item
std\+ ::ostream \& \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a36c2525d21cd932065bb2bb30bc57fb4} { operator$ < $ $ < $ } } (std\+ ::ostream \& os, const \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition} { Composition} } \& composition)
\begin { DoxyCompactList} \small \item \em Overloaded output stream operator for \doxylink { classfourdst_ 1_ 1composition_ 1_ 1_ composition} { Composition} . \end { DoxyCompactList} \end { DoxyCompactItemize}
\doxysubsection { Detailed Description}
Manages a collection of chemical species and their abundances.
This class is a primary interface for defining and manipulating material compositions. It can operate in two modes\+ : mass fraction or number fraction.
{ \bfseries { Key Rules and Workflow\+ :} }
\begin { DoxyEnumerate}
\item { \bfseries { Registration\+ :} } Before setting an abundance for a species, its symbol (e.\+ g., "{ } \+ He-\/ 4"{ } ) must be registered using { \ttfamily \doxylink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a1bc2e64f87c12befdc2bc767e7405661} { register\+ Symbol()} } or { \ttfamily \doxylink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a4ce00f73cc133bb1bac2b030b93ab480} { register\+ Species()} } . All registered species must conform to the same abundance mode (mass or number fraction).
\item { \bfseries { Setting Abundances\+ :} } Use { \ttfamily \doxylink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a493224656aa3ade68389250720ef09af} { set\+ Mass\+ Fraction()} } or { \ttfamily \doxylink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a7d4d748f3ee25e68751fb143717ed080} { set\+ Number\+ Fraction()} } to define the composition.
2025-10-12 10:22:43 -04:00
\item { \bfseries { Finalization\+ :} } Before querying any compositional data (e.\+ g., { \ttfamily \doxylink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ aae07019ab6e02394e6ea353e0b98a417} { get\+ Mass\+ Fraction()} } , { \ttfamily \doxylink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a796386824d1358527fed7c6b537935d8} { get\+ Mean\+ Particle\+ Mass()} } ), the composition must be { \bfseries { finalized} } by calling { \ttfamily \doxylink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a72d063a74a9d2197065884a2cea57a14} { finalize()} } . This step validates the composition (abundances sum to \texorpdfstring { $ \sim $ } { \string ~} 1.0) and computes global properties.
2025-07-24 09:35:52 -04:00
\item { \bfseries { Modification\+ :} } Any modification to abundances after finalization will un-\/ finalize the composition, requiring another call to { \ttfamily \doxylink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a72d063a74a9d2197065884a2cea57a14} { finalize()} } before data can be retrieved again.
\item { \bfseries { Construction\+ :} } A pre-\/ finalized composition can be created by providing symbols and valid, normalized abundances to the constructor.
\end { DoxyEnumerate}
\begin { DoxyExceptions} { Exceptions}
{ \em This} & class throws various exceptions from { \ttfamily \doxylink { namespacefourdst_ 1_ 1composition_ 1_ 1exceptions} { fourdst\+ ::composition\+ ::exceptions} } for invalid operations, such as using unregistered symbols, providing invalid abundances, or accessing data from a non-\/ finalized composition.\\
\hline
\end { DoxyExceptions}
\begin { DoxyParagraph} { Mass Fraction Example\+ :}
\begin { DoxyCode} { 0}
\DoxyCodeLine { \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a23b83b76ee025f6fc009184ee19bba88} { Composition} } \ comp;}
\DoxyCodeLine { comp.registerSymbol(\textcolor { stringliteral} { "{ } H-\/ 1"{ } } );}
\DoxyCodeLine { comp.registerSymbol(\textcolor { stringliteral} { "{ } He-\/ 4"{ } } );}
\DoxyCodeLine { comp.setMassFraction(\textcolor { stringliteral} { "{ } H-\/ 1"{ } } ,\ 0.75);}
\DoxyCodeLine { comp.setMassFraction(\textcolor { stringliteral} { "{ } He-\/ 4"{ } } ,\ 0.25);}
\DoxyCodeLine { \textcolor { keywordflow} { if} \ (comp.finalize())\ \{ }
\DoxyCodeLine { \ \ \ \ \textcolor { keywordtype} { double} \ he\_ mass\_ frac\ =\ comp.getMassFraction(\textcolor { stringliteral} { "{ } He-\/ 4"{ } } );\ \textcolor { comment} { //\ Returns\ 0.25} }
\DoxyCodeLine { \} }
\end { DoxyCode}
\end { DoxyParagraph}
\begin { DoxyParagraph} { Number Fraction Example\+ :}
\begin { DoxyCode} { 0}
\DoxyCodeLine { \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a23b83b76ee025f6fc009184ee19bba88} { Composition} } \ comp;}
\DoxyCodeLine { comp.registerSymbol(\textcolor { stringliteral} { "{ } H-\/ 1"{ } } ,\ \textcolor { keyword} { false} );\ \textcolor { comment} { //\ Register\ in\ number\ fraction\ mode} }
\DoxyCodeLine { comp.registerSymbol(\textcolor { stringliteral} { "{ } He-\/ 4"{ } } ,\ \textcolor { keyword} { false} );}
\DoxyCodeLine { comp.setNumberFraction(\textcolor { stringliteral} { "{ } H-\/ 1"{ } } ,\ 0.9);}
\DoxyCodeLine { comp.setNumberFraction(\textcolor { stringliteral} { "{ } He-\/ 4"{ } } ,\ 0.1);}
\DoxyCodeLine { \textcolor { keywordflow} { if} \ (comp.finalize())\ \{ }
\DoxyCodeLine { \ \ \ \ \textcolor { keywordtype} { double} \ he\_ num\_ frac\ =\ comp.getNumberFraction(\textcolor { stringliteral} { "{ } He-\/ 4"{ } } );\ \textcolor { comment} { //\ Returns\ 0.1} }
\DoxyCodeLine { \} }
\end { DoxyCode}
\end { DoxyParagraph}
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8h_ source_ l00255} { 255} } of file \mbox { \hyperlink { composition_ 8h_ source} { composition.\+ h} } .
2025-07-24 09:35:52 -04:00
\doxysubsection { Constructor \& Destructor Documentation}
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a23b83b76ee025f6fc009184ee19bba88} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !Composition@{ Composition} }
\index { Composition@{ Composition} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { Composition()} { Composition()} \hspace { 0.1cm} { \footnotesize \ttfamily [1/5]} }
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a23b83b76ee025f6fc009184ee19bba88}
fourdst\+ ::composition\+ ::\+ Composition\+ ::\+ Composition (\begin { DoxyParamCaption} { } { } \end { DoxyParamCaption} )\hspace { 0.3cm} { \ttfamily [default]} }
Default constructor.
2025-10-12 10:22:43 -04:00
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a08c1d1fe9384c5255a6ba40e34b18315} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !````~Composition@{ \texorpdfstring { $ \sim $ } { \string ~} Composition} }
2025-07-24 09:35:52 -04:00
\index { ````~Composition@{ \texorpdfstring { $ \sim $ } { \string ~} Composition} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { \texorpdfstring { $ \sim $ } { \string ~} Composition()} { \string ~Composition()} }
2025-10-12 10:22:43 -04:00
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a08c1d1fe9384c5255a6ba40e34b18315}
fourdst\+ ::composition\+ ::\+ Composition\+ ::\texorpdfstring { $ \sim $ } { \string ~} \+ Composition (\begin { DoxyParamCaption} { } { } \end { DoxyParamCaption} )\hspace { 0.3cm} { \ttfamily [override]} , { \ttfamily [default]} }
2025-07-24 09:35:52 -04:00
Default destructor.
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ ae3cc2099efd7db8eec3d9af2294b75fa} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !Composition@{ Composition} }
\index { Composition@{ Composition} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { Composition()} { Composition()} \hspace { 0.1cm} { \footnotesize \ttfamily [2/5]} }
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ ae3cc2099efd7db8eec3d9af2294b75fa}
fourdst\+ ::composition\+ ::\+ Composition\+ ::\+ Composition (\begin { DoxyParamCaption} \item [{const std\+::vector$<$ std\+::string $>$ \&}] { symbols} { } \end { DoxyParamCaption} )\hspace { 0.3cm} { \ttfamily [explicit]} }
Constructs a \doxylink { classfourdst_ 1_ 1composition_ 1_ 1_ composition} { Composition} and registers the given symbols.
\begin { DoxyParams} { Parameters}
{ \em symbols} & The symbols to register. The composition will be in mass fraction mode by default. \\
\hline
\end { DoxyParams}
\begin { DoxyExceptions} { Exceptions}
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ invalid_ symbol_ error} { exceptions\+ ::\+ Invalid\+ Symbol\+ Error} } & if any symbol is invalid. \\
\hline
\end { DoxyExceptions}
\begin { DoxyParagraph} { Usage Example\+ :}
\begin { DoxyCode} { 0}
\DoxyCodeLine { std::vector<std::string>\ symbols\ =\ \{ \textcolor { stringliteral} { "{ } H-\/ 1"{ } } ,\ \textcolor { stringliteral} { "{ } O-\/ 16"{ } } \} ;}
\DoxyCodeLine { \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a23b83b76ee025f6fc009184ee19bba88} { Composition} } \ comp(symbols);}
\DoxyCodeLine { comp.setMassFraction(\textcolor { stringliteral} { "{ } H-\/ 1"{ } } ,\ 0.11);}
\DoxyCodeLine { comp.setMassFraction(\textcolor { stringliteral} { "{ } O-\/ 16"{ } } ,\ 0.89);}
\DoxyCodeLine { comp.finalize();}
\end { DoxyCode}
\end { DoxyParagraph}
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00187} { 187} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a2d6fbe5c8142b358641bbe7ffde51053} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !Composition@{ Composition} }
\index { Composition@{ Composition} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { Composition()} { Composition()} \hspace { 0.1cm} { \footnotesize \ttfamily [3/5]} }
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a2d6fbe5c8142b358641bbe7ffde51053}
fourdst\+ ::composition\+ ::\+ Composition\+ ::\+ Composition (\begin { DoxyParamCaption} \item [{const std\+::set$<$ std\+::string $>$ \&}] { symbols} { } \end { DoxyParamCaption} )\hspace { 0.3cm} { \ttfamily [explicit]} }
Constructs a \doxylink { classfourdst_ 1_ 1composition_ 1_ 1_ composition} { Composition} and registers the given symbols from a set.
\begin { DoxyParams} { Parameters}
{ \em symbols} & The symbols to register. The composition will be in mass fraction mode by default. \\
\hline
\end { DoxyParams}
\begin { DoxyExceptions} { Exceptions}
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ invalid_ symbol_ error} { exceptions\+ ::\+ Invalid\+ Symbol\+ Error} } & if any symbol is invalid. \\
\hline
\end { DoxyExceptions}
\begin { DoxyParagraph} { Usage Example\+ :}
\begin { DoxyCode} { 0}
\DoxyCodeLine { std::set<std::string>\ symbols\ =\ \{ \textcolor { stringliteral} { "{ } H-\/ 1"{ } } ,\ \textcolor { stringliteral} { "{ } O-\/ 16"{ } } \} ;}
\DoxyCodeLine { \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a23b83b76ee025f6fc009184ee19bba88} { Composition} } \ comp(symbols);}
\end { DoxyCode}
\end { DoxyParagraph}
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00195} { 195} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ af4d4cc5875cba931a91faee13f55594e} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !Composition@{ Composition} }
\index { Composition@{ Composition} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { Composition()} { Composition()} \hspace { 0.1cm} { \footnotesize \ttfamily [4/5]} }
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ af4d4cc5875cba931a91faee13f55594e}
fourdst\+ ::composition\+ ::\+ Composition\+ ::\+ Composition (\begin { DoxyParamCaption} \item [{const std\+::vector$<$ std\+::string $>$ \&}] { symbols} { , } \item [{const std\+::vector$<$ double $>$ \&}] { fractions} { , } \item [{bool}] { mass\+ Frac\+ Mode} { = { \ttfamily true} } \end { DoxyParamCaption} )}
Constructs and finalizes a \doxylink { classfourdst_ 1_ 1composition_ 1_ 1_ composition} { Composition} with the given symbols and fractions.
This constructor provides a convenient way to create a fully-\/ formed, finalized composition in one step. The provided fractions must be valid and sum to 1.\+ 0.
\begin { DoxyParams} { Parameters}
{ \em symbols} & The symbols to initialize the composition with. \\
\hline
{ \em fractions} & The fractions (mass or number) corresponding to the symbols. \\
\hline
{ \em mass\+ Frac\+ Mode} & True if { \ttfamily fractions} are mass fractions, false if they are number fractions. \mbox { [} Default\+ : true\mbox { ]} \\
\hline
\end { DoxyParams}
\begin { DoxyExceptions} { Exceptions}
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ invalid_ composition_ error} { exceptions\+ ::\+ Invalid\+ Composition\+ Error} } & if the number of symbols and fractions do not match, or if the fractions do not sum to \texorpdfstring { $ \sim $ } { \string ~} 1.0. \\
\hline
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ invalid_ symbol_ error} { exceptions\+ ::\+ Invalid\+ Symbol\+ Error} } & if any symbol is invalid. \\
\hline
\end { DoxyExceptions}
\begin { DoxyPostcond} { Postcondition}
The composition is immediately finalized.
\end { DoxyPostcond}
\begin { DoxyParagraph} { Usage Example\+ :}
\begin { DoxyCode} { 0}
\DoxyCodeLine { std::vector<std::string>\ symbols\ =\ \{ \textcolor { stringliteral} { "{ } H-\/ 1"{ } } ,\ \textcolor { stringliteral} { "{ } O-\/ 16"{ } } \} ;}
\DoxyCodeLine { std::vector<double>\ mass\_ fractions\ =\ \{ 0.1119,\ 0.8881\} ;}
\DoxyCodeLine { \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a23b83b76ee025f6fc009184ee19bba88} { Composition} } \ comp(symbols,\ mass\_ fractions);\ \textcolor { comment} { //\ Finalized\ on\ construction} }
\end { DoxyCode}
\end { DoxyParagraph}
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00203} { 203} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a21369a80378d4c90438a34f0e4a275ca} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !Composition@{ Composition} }
\index { Composition@{ Composition} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { Composition()} { Composition()} \hspace { 0.1cm} { \footnotesize \ttfamily [5/5]} }
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a21369a80378d4c90438a34f0e4a275ca}
fourdst\+ ::composition\+ ::\+ Composition\+ ::\+ Composition (\begin { DoxyParamCaption} \item [{const \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition}{Composition}} \&}] { composition} { } \end { DoxyParamCaption} )}
Constructs a \doxylink { classfourdst_ 1_ 1composition_ 1_ 1_ composition} { Composition} from another \doxylink { classfourdst_ 1_ 1composition_ 1_ 1_ composition} { Composition} .
\begin { DoxyParams} { Parameters}
{ \em composition} & The \doxylink { classfourdst_ 1_ 1composition_ 1_ 1_ composition} { Composition} to copy. \\
\hline
\end { DoxyParams}
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00234} { 234} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
2025-07-24 09:35:52 -04:00
\doxysubsection { Member Function Documentation}
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ ab1701644ff1c83c220dc04eb58d1621b} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !begin@{ begin} }
\index { begin@{ begin} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { begin()} { begin()} \hspace { 0.1cm} { \footnotesize \ttfamily [1/2]} }
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ ab1701644ff1c83c220dc04eb58d1621b}
auto fourdst\+ ::composition\+ ::\+ Composition\+ ::begin (\begin { DoxyParamCaption} { } { } \end { DoxyParamCaption} )\hspace { 0.3cm} { \ttfamily [inline]} }
Returns an iterator to the beginning of the composition map.
\begin { DoxyReturn} { Returns}
An iterator to the beginning.
\end { DoxyReturn}
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8h_ source_ l00864} { 864} } of file \mbox { \hyperlink { composition_ 8h_ source} { composition.\+ h} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ adf41a833e8b704daf4f581fca5c8cb9b} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !begin@{ begin} }
\index { begin@{ begin} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { begin()} { begin()} \hspace { 0.1cm} { \footnotesize \ttfamily [2/2]} }
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ adf41a833e8b704daf4f581fca5c8cb9b}
2025-09-16 11:24:28 -04:00
auto fourdst\+ ::composition\+ ::\+ Composition\+ ::begin (\begin { DoxyParamCaption} { } { } \end { DoxyParamCaption} ) const\hspace { 0.3cm} { \ttfamily [inline]} , { \ttfamily [nodiscard]} }
2025-07-24 09:35:52 -04:00
Returns a const iterator to the beginning of the composition map.
\begin { DoxyReturn} { Returns}
A const iterator to the beginning.
\end { DoxyReturn}
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8h_ source_ l00872} { 872} } of file \mbox { \hyperlink { composition_ 8h_ source} { composition.\+ h} } .
2025-07-24 09:35:52 -04:00
2025-10-12 10:22:43 -04:00
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a7efe2cd3a69b743bf2086941b6dfd965} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !contains@{ contains} }
2025-07-24 09:35:52 -04:00
\index { contains@{ contains} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { contains()} { contains()} }
2025-10-12 10:22:43 -04:00
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a7efe2cd3a69b743bf2086941b6dfd965}
bool fourdst\+ ::composition\+ ::\+ Composition\+ ::contains (\begin { DoxyParamCaption} \item [{const \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{atomic\+::\+Species}} \&}] { isotope} { } \end { DoxyParamCaption} ) const\hspace { 0.3cm} { \ttfamily [nodiscard]} , { \ttfamily [override]} , { \ttfamily [virtual]} }
2025-07-24 09:35:52 -04:00
Checks if a given isotope is present in the composition.
\begin { DoxyPrecond} { Precondition}
The composition must be finalized.
\end { DoxyPrecond}
\begin { DoxyParams} { Parameters}
{ \em isotope} & The isotope to check for. \\
\hline
\end { DoxyParams}
\begin { DoxyReturn} { Returns}
True if the isotope is in the composition, false otherwise.
\end { DoxyReturn}
\begin { DoxyExceptions} { Exceptions}
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ composition_ not_ finalized_ error} { exceptions\+ ::\+ Composition\+ Not\+ Finalized\+ Error} } & if the composition is not finalized. \\
\hline
\end { DoxyExceptions}
2025-10-12 10:22:43 -04:00
Implements \mbox { \hyperlink { class_ composition_ abstract_ a10778c866d515826cb1ba1d9e88f7d8f} { Composition\+ Abstract} } .
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l01038} { 1038} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ adeaf6f1213e78cb1fe8a8317f0a8adc2} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !end@{ end} }
\index { end@{ end} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { end()} { end()} \hspace { 0.1cm} { \footnotesize \ttfamily [1/2]} }
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ adeaf6f1213e78cb1fe8a8317f0a8adc2}
auto fourdst\+ ::composition\+ ::\+ Composition\+ ::end (\begin { DoxyParamCaption} { } { } \end { DoxyParamCaption} )\hspace { 0.3cm} { \ttfamily [inline]} }
Returns an iterator to the end of the composition map.
\begin { DoxyReturn} { Returns}
An iterator to the end.
\end { DoxyReturn}
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8h_ source_ l00880} { 880} } of file \mbox { \hyperlink { composition_ 8h_ source} { composition.\+ h} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ aed2f5676f8f742199f01e4d1e9664bdd} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !end@{ end} }
\index { end@{ end} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { end()} { end()} \hspace { 0.1cm} { \footnotesize \ttfamily [2/2]} }
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ aed2f5676f8f742199f01e4d1e9664bdd}
2025-09-16 11:24:28 -04:00
auto fourdst\+ ::composition\+ ::\+ Composition\+ ::end (\begin { DoxyParamCaption} { } { } \end { DoxyParamCaption} ) const\hspace { 0.3cm} { \ttfamily [inline]} , { \ttfamily [nodiscard]} }
2025-07-24 09:35:52 -04:00
Returns a const iterator to the end of the composition map.
\begin { DoxyReturn} { Returns}
A const iterator to the end.
\end { DoxyReturn}
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8h_ source_ l00888} { 888} } of file \mbox { \hyperlink { composition_ 8h_ source} { composition.\+ h} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a72d063a74a9d2197065884a2cea57a14} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !finalize@{ finalize} }
\index { finalize@{ finalize} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { finalize()} { finalize()} }
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a72d063a74a9d2197065884a2cea57a14}
2025-10-12 10:22:43 -04:00
bool fourdst\+ ::composition\+ ::\+ Composition\+ ::finalize (\begin { DoxyParamCaption} \item [{bool}] { norm} { = { \ttfamily false} } \end { DoxyParamCaption} )\hspace { 0.3cm} { \ttfamily [nodiscard]} }
2025-07-24 09:35:52 -04:00
Finalizes the composition, making it ready for querying.
This method checks if the sum of all fractions (mass or number) is approximately 1.\+ 0. It also computes global properties like mean particle mass. This { \bfseries { must} } be called before any { \ttfamily get...} method can be used.
\begin { DoxyParams} { Parameters}
{ \em norm} & If true, the composition will be normalized to sum to 1 before validation. \mbox { [} Default\+ : false\mbox { ]} \\
\hline
\end { DoxyParams}
\begin { DoxyReturn} { Returns}
True if the composition is valid and successfully finalized, false otherwise.
\end { DoxyReturn}
\begin { DoxyPostcond} { Postcondition}
If successful, { \ttfamily m\+ \_ \+ finalized} is true and global properties are computed.
\end { DoxyPostcond}
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00445} { 445} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a869dbae3db9d09c57b2df56a813a55fb} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !finalizeMassFracMode@{ finalizeMassFracMode} }
\index { finalizeMassFracMode@{ finalizeMassFracMode} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { finalizeMassFracMode()} { finalizeMassFracMode()} }
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a869dbae3db9d09c57b2df56a813a55fb}
bool fourdst\+ ::composition\+ ::\+ Composition\+ ::finalize\+ Mass\+ Frac\+ Mode (\begin { DoxyParamCaption} \item [{bool}] { norm} { } \end { DoxyParamCaption} )\hspace { 0.3cm} { \ttfamily [private]} }
Finalizes the composition in mass fraction mode.
\begin { DoxyParams} { Parameters}
{ \em norm} & If true, the composition will be normalized to sum to 1. \\
\hline
\end { DoxyParams}
\begin { DoxyReturn} { Returns}
True if the composition is successfully finalized, false otherwise.
\end { DoxyReturn}
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00453} { 453} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a461ab4e9cb5975cf865db5f16f03ddfe} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !finalizeNumberFracMode@{ finalizeNumberFracMode} }
\index { finalizeNumberFracMode@{ finalizeNumberFracMode} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { finalizeNumberFracMode()} { finalizeNumberFracMode()} }
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a461ab4e9cb5975cf865db5f16f03ddfe}
bool fourdst\+ ::composition\+ ::\+ Composition\+ ::finalize\+ Number\+ Frac\+ Mode (\begin { DoxyParamCaption} \item [{bool}] { norm} { } \end { DoxyParamCaption} )\hspace { 0.3cm} { \ttfamily [private]} }
Finalizes the composition in number fraction mode.
\begin { DoxyParams} { Parameters}
{ \em norm} & If true, the composition will be normalized to sum to 1. \\
\hline
\end { DoxyParams}
\begin { DoxyReturn} { Returns}
True if the composition is successfully finalized, false otherwise.
\end { DoxyReturn}
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00489} { 489} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ ac75dbc8377556c835455991c7c7fe206} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !getCanonicalComposition@{ getCanonicalComposition} }
\index { getCanonicalComposition@{ getCanonicalComposition} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { getCanonicalComposition()} { getCanonicalComposition()} }
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ ac75dbc8377556c835455991c7c7fe206}
\mbox { \hyperlink { structfourdst_ 1_ 1composition_ 1_ 1_ canonical_ composition} { Canonical\+ Composition} } fourdst\+ ::composition\+ ::\+ Composition\+ ::get\+ Canonical\+ Composition (\begin { DoxyParamCaption} \item [{bool}] { harsh} { = { \ttfamily false} } \end { DoxyParamCaption} ) const\hspace { 0.3cm} { \ttfamily [nodiscard]} }
Gets the current canonical composition (X, Y, Z).
Calculates the total mass fractions for H, He, and metals. \begin { DoxyPrecond} { Precondition}
The composition must be finalized.
\end { DoxyPrecond}
\begin { DoxyParams} { Parameters}
{ \em harsh} & If true, this will throw an error if { \ttfamily 1 -\/ (X + Y)} is not equal to the directly summed { \ttfamily Z} (within a tolerance). If false, it will only log a warning. \\
\hline
\end { DoxyParams}
\begin { DoxyReturn} { Returns}
The { \ttfamily \doxylink { structfourdst_ 1_ 1composition_ 1_ 1_ canonical_ composition} { Canonical\+ Composition} } struct.
\end { DoxyReturn}
\begin { DoxyExceptions} { Exceptions}
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ composition_ not_ finalized_ error} { exceptions\+ ::\+ Composition\+ Not\+ Finalized\+ Error} } & if the composition is not finalized. \\
\hline
{ \em std\+ ::runtime\+ \_ \+ error} & if { \ttfamily harsh} is true and the canonical composition is not self-\/ consistent. \\
\hline
\end { DoxyExceptions}
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00785} { 785} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a1138c86f7ccd39594601c2ec63ad89e9} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !getComposition@{ getComposition} }
\index { getComposition@{ getComposition} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { getComposition()} { getComposition()} \hspace { 0.1cm} { \footnotesize \ttfamily [1/3]} }
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a1138c86f7ccd39594601c2ec63ad89e9}
std\+ ::pair$ < $ std\+ ::unordered\+ \_ \+ map$ < $ std\+ ::string, \mbox { \hyperlink { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry} { Composition\+ Entry} } $ > $ , \mbox { \hyperlink { structfourdst_ 1_ 1composition_ 1_ 1_ global_ composition} { Global\+ Composition} } $ > $ fourdst\+ ::composition\+ ::\+ Composition\+ ::get\+ Composition (\begin { DoxyParamCaption} { } { } \end { DoxyParamCaption} ) const\hspace { 0.3cm} { \ttfamily [nodiscard]} }
Gets all composition entries and the global composition data.
\begin { DoxyPrecond} { Precondition}
The composition must be finalized.
\end { DoxyPrecond}
\begin { DoxyReturn} { Returns}
A pair containing an unordered map of all Composition\+ Entries and the \doxylink { structfourdst_ 1_ 1composition_ 1_ 1_ global_ composition} { Global\+ Composition} .
\end { DoxyReturn}
\begin { DoxyExceptions} { Exceptions}
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ composition_ not_ finalized_ error} { exceptions\+ ::\+ Composition\+ Not\+ Finalized\+ Error} } & if the composition is not finalized. \\
\hline
\end { DoxyExceptions}
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00682} { 682} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ afe5f1086027044c84ff35a366b2e8e2d} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !getComposition@{ getComposition} }
\index { getComposition@{ getComposition} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { getComposition()} { getComposition()} \hspace { 0.1cm} { \footnotesize \ttfamily [2/3]} }
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ afe5f1086027044c84ff35a366b2e8e2d}
std\+ ::pair$ < $ \mbox { \hyperlink { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry} { Composition\+ Entry} } , \mbox { \hyperlink { structfourdst_ 1_ 1composition_ 1_ 1_ global_ composition} { Global\+ Composition} } $ > $ fourdst\+ ::composition\+ ::\+ Composition\+ ::get\+ Composition (\begin { DoxyParamCaption} \item [{const \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{fourdst\+::atomic\+::\+Species}} \&}] { species} { } \end { DoxyParamCaption} ) const\hspace { 0.3cm} { \ttfamily [nodiscard]} }
Gets the composition entry and global composition data for a given species.
\begin { DoxyPrecond} { Precondition}
The composition must be finalized.
\end { DoxyPrecond}
\begin { DoxyParams} { Parameters}
{ \em species} & The species to get the composition for. \\
\hline
\end { DoxyParams}
\begin { DoxyReturn} { Returns}
A pair containing the \doxylink { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry} { Composition\+ Entry} and \doxylink { structfourdst_ 1_ 1composition_ 1_ 1_ global_ composition} { Global\+ Composition} for the given species.
\end { DoxyReturn}
\begin { DoxyExceptions} { Exceptions}
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ composition_ not_ finalized_ error} { exceptions\+ ::\+ Composition\+ Not\+ Finalized\+ Error} } & if the composition is not finalized. \\
\hline
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ unregistered_ symbol_ error} { exceptions\+ ::\+ Unregistered\+ Symbol\+ Error} } & if the species is not in the composition. \\
\hline
\end { DoxyExceptions}
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00676} { 676} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a092d3536b04167ea2e6e3a3b1446c377} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !getComposition@{ getComposition} }
\index { getComposition@{ getComposition} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { getComposition()} { getComposition()} \hspace { 0.1cm} { \footnotesize \ttfamily [3/3]} }
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a092d3536b04167ea2e6e3a3b1446c377}
std\+ ::pair$ < $ \mbox { \hyperlink { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry} { Composition\+ Entry} } , \mbox { \hyperlink { structfourdst_ 1_ 1composition_ 1_ 1_ global_ composition} { Global\+ Composition} } $ > $ fourdst\+ ::composition\+ ::\+ Composition\+ ::get\+ Composition (\begin { DoxyParamCaption} \item [{const std\+::string \&}] { symbol} { } \end { DoxyParamCaption} ) const\hspace { 0.3cm} { \ttfamily [nodiscard]} }
Gets the composition entry and global composition data for a given symbol.
\begin { DoxyPrecond} { Precondition}
The composition must be finalized.
\end { DoxyPrecond}
\begin { DoxyParams} { Parameters}
{ \em symbol} & The symbol to get the composition for. \\
\hline
\end { DoxyParams}
\begin { DoxyReturn} { Returns}
A pair containing the \doxylink { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry} { Composition\+ Entry} and \doxylink { structfourdst_ 1_ 1composition_ 1_ 1_ global_ composition} { Global\+ Composition} for the given symbol.
\end { DoxyReturn}
\begin { DoxyExceptions} { Exceptions}
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ composition_ not_ finalized_ error} { exceptions\+ ::\+ Composition\+ Not\+ Finalized\+ Error} } & if the composition is not finalized. \\
\hline
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ unregistered_ symbol_ error} { exceptions\+ ::\+ Unregistered\+ Symbol\+ Error} } & if the symbol is not in the composition. \\
\hline
\end { DoxyExceptions}
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00662} { 662} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
2025-07-24 09:35:52 -04:00
2025-10-12 10:22:43 -04:00
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a62dcfcf8f824d6af7903a9a9c3d5721e} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !getElectronAbundance@{ getElectronAbundance} }
\index { getElectronAbundance@{ getElectronAbundance} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { getElectronAbundance()} { getElectronAbundance()} }
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a62dcfcf8f824d6af7903a9a9c3d5721e}
double fourdst\+ ::composition\+ ::\+ Composition\+ ::get\+ Electron\+ Abundance (\begin { DoxyParamCaption} { } { } \end { DoxyParamCaption} ) const\hspace { 0.3cm} { \ttfamily [nodiscard]} , { \ttfamily [override]} , { \ttfamily [virtual]} }
Compute the electron abundance of the composition.
Ye is defined as the sum over all species of (Z\+ \_ \+ i \texorpdfstring { $ \ast $ } { *} X\+ \_ \+ i / A\+ \_ \+ i), where Z\+ \_ \+ i is the atomic number, X\+ \_ \+ i is the mass fraction, and A\+ \_ \+ i is the atomic mass of species i. \begin { DoxyReturn} { Returns}
Ye (electron abundance).
\end { DoxyReturn}
\begin { DoxyPrecond} { Precondition}
The composition must be finalized.
\end { DoxyPrecond}
Implements \mbox { \hyperlink { class_ composition_ abstract_ a25e0bfc7ef1861be6b80bc67bbed096f} { Composition\+ Abstract} } .
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00716} { 716} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ aae07019ab6e02394e6ea353e0b98a417} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !getMassFraction@{ getMassFraction} }
2025-07-24 09:35:52 -04:00
\index { getMassFraction@{ getMassFraction} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { getMassFraction()} { getMassFraction()} \hspace { 0.1cm} { \footnotesize \ttfamily [1/3]} }
2025-10-12 10:22:43 -04:00
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ aae07019ab6e02394e6ea353e0b98a417}
std\+ ::unordered\+ \_ \+ map$ < $ std\+ ::string, double $ > $ fourdst\+ ::composition\+ ::\+ Composition\+ ::get\+ Mass\+ Fraction (\begin { DoxyParamCaption} { } { } \end { DoxyParamCaption} ) const\hspace { 0.3cm} { \ttfamily [nodiscard]} , { \ttfamily [override]} , { \ttfamily [virtual]} }
2025-07-24 09:35:52 -04:00
Gets the mass fractions of all species in the composition.
\begin { DoxyPrecond} { Precondition}
The composition must be finalized.
\end { DoxyPrecond}
\begin { DoxyReturn} { Returns}
An unordered map of symbols to their mass fractions.
\end { DoxyReturn}
\begin { DoxyExceptions} { Exceptions}
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ composition_ not_ finalized_ error} { exceptions\+ ::\+ Composition\+ Not\+ Finalized\+ Error} } & if the composition is not finalized. \\
\hline
\end { DoxyExceptions}
2025-10-12 10:22:43 -04:00
Implements \mbox { \hyperlink { class_ composition_ abstract_ a9f45d416a557c77f71d6a0fccd405543} { Composition\+ Abstract} } .
2025-07-24 09:35:52 -04:00
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00601} { 601} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ aeae9d6d3f742cd8b59b58abcb228a44d} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !getMassFraction@{ getMassFraction} }
2025-07-24 09:35:52 -04:00
\index { getMassFraction@{ getMassFraction} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { getMassFraction()} { getMassFraction()} \hspace { 0.1cm} { \footnotesize \ttfamily [2/3]} }
2025-10-12 10:22:43 -04:00
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ aeae9d6d3f742cd8b59b58abcb228a44d}
double fourdst\+ ::composition\+ ::\+ Composition\+ ::get\+ Mass\+ Fraction (\begin { DoxyParamCaption} \item [{const \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{fourdst\+::atomic\+::\+Species}} \&}] { species} { } \end { DoxyParamCaption} ) const\hspace { 0.3cm} { \ttfamily [nodiscard]} , { \ttfamily [override]} , { \ttfamily [virtual]} }
2025-07-24 09:35:52 -04:00
Gets the mass fraction for a given isotope.
\begin { DoxyPrecond} { Precondition}
The composition must be finalized.
\end { DoxyPrecond}
\begin { DoxyParams} { Parameters}
{ \em species} & The isotope to get the mass fraction for. \\
\hline
\end { DoxyParams}
\begin { DoxyReturn} { Returns}
The mass fraction for the given isotope.
\end { DoxyReturn}
\begin { DoxyExceptions} { Exceptions}
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ composition_ not_ finalized_ error} { exceptions\+ ::\+ Composition\+ Not\+ Finalized\+ Error} } & if the composition is not finalized. \\
\hline
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ unregistered_ symbol_ error} { exceptions\+ ::\+ Unregistered\+ Symbol\+ Error} } & if the isotope is not registered in the composition. \\
\hline
\end { DoxyExceptions}
2025-10-12 10:22:43 -04:00
Implements \mbox { \hyperlink { class_ composition_ abstract_ a401e8298ed93b7963624e8a17eb17b55} { Composition\+ Abstract} } .
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00595} { 595} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
2025-07-24 09:35:52 -04:00
2025-10-12 10:22:43 -04:00
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ ae5d8d21632fca2b35b0898f2b205cd10} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !getMassFraction@{ getMassFraction} }
2025-07-24 09:35:52 -04:00
\index { getMassFraction@{ getMassFraction} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { getMassFraction()} { getMassFraction()} \hspace { 0.1cm} { \footnotesize \ttfamily [3/3]} }
2025-10-12 10:22:43 -04:00
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ ae5d8d21632fca2b35b0898f2b205cd10}
double fourdst\+ ::composition\+ ::\+ Composition\+ ::get\+ Mass\+ Fraction (\begin { DoxyParamCaption} \item [{const std\+::string \&}] { symbol} { } \end { DoxyParamCaption} ) const\hspace { 0.3cm} { \ttfamily [nodiscard]} , { \ttfamily [override]} , { \ttfamily [virtual]} }
2025-07-24 09:35:52 -04:00
Gets the mass fraction for a given symbol.
\begin { DoxyPrecond} { Precondition}
The composition must be finalized.
\end { DoxyPrecond}
\begin { DoxyParams} { Parameters}
{ \em symbol} & The symbol to get the mass fraction for. \\
\hline
\end { DoxyParams}
\begin { DoxyReturn} { Returns}
The mass fraction for the given symbol.
\end { DoxyReturn}
\begin { DoxyExceptions} { Exceptions}
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ composition_ not_ finalized_ error} { exceptions\+ ::\+ Composition\+ Not\+ Finalized\+ Error} } & if the composition is not finalized. \\
\hline
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ unregistered_ symbol_ error} { exceptions\+ ::\+ Unregistered\+ Symbol\+ Error} } & if the symbol is not in the composition. \\
\hline
\end { DoxyExceptions}
2025-10-12 10:22:43 -04:00
Implements \mbox { \hyperlink { class_ composition_ abstract_ ae0044d30efddccacc9fe7c8e58003066} { Composition\+ Abstract} } .
2025-09-16 11:24:28 -04:00
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00568} { 568} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a85169b763138ab72047e43e07af978fb} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !getMassFractionVector@{ getMassFractionVector} }
2025-09-16 11:24:28 -04:00
\index { getMassFractionVector@{ getMassFractionVector} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { getMassFractionVector()} { getMassFractionVector()} }
2025-10-12 10:22:43 -04:00
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a85169b763138ab72047e43e07af978fb}
std\+ ::vector$ < $ double $ > $ fourdst\+ ::composition\+ ::\+ Composition\+ ::get\+ Mass\+ Fraction\+ Vector (\begin { DoxyParamCaption} { } { } \end { DoxyParamCaption} ) const\hspace { 0.3cm} { \ttfamily [nodiscard]} , { \ttfamily [override]} , { \ttfamily [virtual]} }
2025-09-16 11:24:28 -04:00
Get a uniform vector representation of the mass fraction stored in the composition object sorted such that the lightest species is at index 0 and the heaviest is at the last index.
This is primarily useful for external libraries which need to ensure that vector representation uniformity is maintained \begin { DoxyReturn} { Returns}
the vector of mass fractions sorted by species mass (lightest to heaviest).
\end { DoxyReturn}
\begin { DoxyPrecond} { Precondition}
The composition must be finalized.
\end { DoxyPrecond}
\begin { DoxyExceptions} { Exceptions}
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ composition_ not_ finalized_ error} { exceptions\+ ::\+ Composition\+ Not\+ Finalized\+ Error} } & if the composition is not finalized. \\
\hline
\end { DoxyExceptions}
2025-10-12 10:22:43 -04:00
Implements \mbox { \hyperlink { class_ composition_ abstract_ a7e4ec98a256dbfd42d194fb4318d869a} { Composition\+ Abstract} } .
2025-07-24 09:35:52 -04:00
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00840} { 840} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ af7dd8f7d69727acfacf1bf58c4083a27} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !getMeanAtomicNumber@{ getMeanAtomicNumber} }
2025-07-24 09:35:52 -04:00
\index { getMeanAtomicNumber@{ getMeanAtomicNumber} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { getMeanAtomicNumber()} { getMeanAtomicNumber()} }
2025-10-12 10:22:43 -04:00
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ af7dd8f7d69727acfacf1bf58c4083a27}
double fourdst\+ ::composition\+ ::\+ Composition\+ ::get\+ Mean\+ Atomic\+ Number (\begin { DoxyParamCaption} { } { } \end { DoxyParamCaption} ) const\hspace { 0.3cm} { \ttfamily [nodiscard]} , { \ttfamily [override]} , { \ttfamily [virtual]} }
2025-07-24 09:35:52 -04:00
Compute the mean atomic number of the composition.
\begin { DoxyPrecond} { Precondition}
The composition must be finalized.
\end { DoxyPrecond}
\begin { DoxyReturn} { Returns}
Mean atomic number $ < $ \+ Z$ > $ .
\end { DoxyReturn}
\begin { DoxyExceptions} { Exceptions}
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ composition_ not_ finalized_ error} { exceptions\+ ::\+ Composition\+ Not\+ Finalized\+ Error} } & if the composition is not finalized. \\
\hline
\end { DoxyExceptions}
2025-10-12 10:22:43 -04:00
Implements \mbox { \hyperlink { class_ composition_ abstract_ ac2736dfc4a2fc0e94b875585f21e6cc4} { Composition\+ Abstract} } .
2025-07-24 09:35:52 -04:00
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00698} { 698} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a796386824d1358527fed7c6b537935d8} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !getMeanParticleMass@{ getMeanParticleMass} }
2025-07-24 09:35:52 -04:00
\index { getMeanParticleMass@{ getMeanParticleMass} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { getMeanParticleMass()} { getMeanParticleMass()} }
2025-10-12 10:22:43 -04:00
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a796386824d1358527fed7c6b537935d8}
double fourdst\+ ::composition\+ ::\+ Composition\+ ::get\+ Mean\+ Particle\+ Mass (\begin { DoxyParamCaption} { } { } \end { DoxyParamCaption} ) const\hspace { 0.3cm} { \ttfamily [nodiscard]} , { \ttfamily [override]} , { \ttfamily [virtual]} }
2025-07-24 09:35:52 -04:00
Compute the mean particle mass of the composition.
\begin { DoxyPrecond} { Precondition}
The composition must be finalized.
\end { DoxyPrecond}
\begin { DoxyReturn} { Returns}
Mean particle mass in atomic mass units (g/mol).
\end { DoxyReturn}
\begin { DoxyExceptions} { Exceptions}
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ composition_ not_ finalized_ error} { exceptions\+ ::\+ Composition\+ Not\+ Finalized\+ Error} } & if the composition is not finalized. \\
\hline
\end { DoxyExceptions}
2025-10-12 10:22:43 -04:00
Implements \mbox { \hyperlink { class_ composition_ abstract_ ac52886e3e6b2c7d0f79338d9e872cf3a} { Composition\+ Abstract} } .
2025-07-24 09:35:52 -04:00
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00690} { 690} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a28c70279d36826e0e1026da3fa892ffc} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !getMolarAbundance@{ getMolarAbundance} }
2025-07-24 09:35:52 -04:00
\index { getMolarAbundance@{ getMolarAbundance} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { getMolarAbundance()} { getMolarAbundance()} \hspace { 0.1cm} { \footnotesize \ttfamily [1/2]} }
2025-10-12 10:22:43 -04:00
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a28c70279d36826e0e1026da3fa892ffc}
double fourdst\+ ::composition\+ ::\+ Composition\+ ::get\+ Molar\+ Abundance (\begin { DoxyParamCaption} \item [{const \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{fourdst\+::atomic\+::\+Species}} \&}] { species} { } \end { DoxyParamCaption} ) const\hspace { 0.3cm} { \ttfamily [nodiscard]} , { \ttfamily [override]} , { \ttfamily [virtual]} }
2025-07-24 09:35:52 -04:00
Gets the molar abundance for a given isotope.
\begin { DoxyPrecond} { Precondition}
The composition must be finalized.
\end { DoxyPrecond}
\begin { DoxyParams} { Parameters}
{ \em species} & The isotope to get the molar abundance for. \\
\hline
\end { DoxyParams}
\begin { DoxyReturn} { Returns}
The molar abundance for the given isotope.
\end { DoxyReturn}
\begin { DoxyExceptions} { Exceptions}
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ composition_ not_ finalized_ error} { exceptions\+ ::\+ Composition\+ Not\+ Finalized\+ Error} } & if the composition is not finalized. \\
\hline
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ unregistered_ symbol_ error} { exceptions\+ ::\+ Unregistered\+ Symbol\+ Error} } & if the isotope is not registered in the composition. \\
\hline
\end { DoxyExceptions}
2025-10-12 10:22:43 -04:00
Implements \mbox { \hyperlink { class_ composition_ abstract_ a4cfc9e37370caae275c0f801b700e37b} { Composition\+ Abstract} } .
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00656} { 656} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
2025-07-24 09:35:52 -04:00
2025-10-12 10:22:43 -04:00
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ add67a92d73e3a57a2bbdb52bc9ca3bfe} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !getMolarAbundance@{ getMolarAbundance} }
2025-07-24 09:35:52 -04:00
\index { getMolarAbundance@{ getMolarAbundance} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { getMolarAbundance()} { getMolarAbundance()} \hspace { 0.1cm} { \footnotesize \ttfamily [2/2]} }
2025-10-12 10:22:43 -04:00
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ add67a92d73e3a57a2bbdb52bc9ca3bfe}
double fourdst\+ ::composition\+ ::\+ Composition\+ ::get\+ Molar\+ Abundance (\begin { DoxyParamCaption} \item [{const std\+::string \&}] { symbol} { } \end { DoxyParamCaption} ) const\hspace { 0.3cm} { \ttfamily [nodiscard]} , { \ttfamily [override]} , { \ttfamily [virtual]} }
2025-07-24 09:35:52 -04:00
Gets the molar abundance (X\+ \_ \+ i / A\+ \_ \+ i) for a given symbol.
\begin { DoxyPrecond} { Precondition}
The composition must be finalized.
\end { DoxyPrecond}
\begin { DoxyParams} { Parameters}
{ \em symbol} & The symbol to get the molar abundance for. \\
\hline
\end { DoxyParams}
\begin { DoxyReturn} { Returns}
The molar abundance for the given symbol.
\end { DoxyReturn}
\begin { DoxyExceptions} { Exceptions}
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ composition_ not_ finalized_ error} { exceptions\+ ::\+ Composition\+ Not\+ Finalized\+ Error} } & if the composition is not finalized. \\
\hline
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ unregistered_ symbol_ error} { exceptions\+ ::\+ Unregistered\+ Symbol\+ Error} } & if the symbol is not in the composition. \\
\hline
\end { DoxyExceptions}
2025-10-12 10:22:43 -04:00
Implements \mbox { \hyperlink { class_ composition_ abstract_ a71fb459bf4375af2fe33c8a7c0747ce0} { Composition\+ Abstract} } .
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00641} { 641} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
2025-09-16 11:24:28 -04:00
2025-10-12 10:22:43 -04:00
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ abed665c07c42b40682da453576621399} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !getMolarAbundanceVector@{ getMolarAbundanceVector} }
2025-09-16 11:24:28 -04:00
\index { getMolarAbundanceVector@{ getMolarAbundanceVector} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { getMolarAbundanceVector()} { getMolarAbundanceVector()} }
2025-10-12 10:22:43 -04:00
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ abed665c07c42b40682da453576621399}
std\+ ::vector$ < $ double $ > $ fourdst\+ ::composition\+ ::\+ Composition\+ ::get\+ Molar\+ Abundance\+ Vector (\begin { DoxyParamCaption} { } { } \end { DoxyParamCaption} ) const\hspace { 0.3cm} { \ttfamily [nodiscard]} , { \ttfamily [override]} , { \ttfamily [virtual]} }
2025-09-16 11:24:28 -04:00
Get a uniform vector representation of the molar abundances stored in the composition object sorted such that the lightest species is at index 0 and the heaviest is at the last index.
This is primarily useful for external libraries which need to ensure that vector representation uniformity is maintained \begin { DoxyReturn} { Returns}
the vector of molar abundances sorted by species mass (lightest to heaviest).
\end { DoxyReturn}
\begin { DoxyPrecond} { Precondition}
The composition must be finalized.
\end { DoxyPrecond}
\begin { DoxyExceptions} { Exceptions}
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ composition_ not_ finalized_ error} { exceptions\+ ::\+ Composition\+ Not\+ Finalized\+ Error} } & if the composition is not finalized. \\
\hline
\end { DoxyExceptions}
2025-10-12 10:22:43 -04:00
Implements \mbox { \hyperlink { class_ composition_ abstract_ a266ce894ebf533a62f63ad246fa21d96} { Composition\+ Abstract} } .
2025-07-24 09:35:52 -04:00
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00891} { 891} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ ae46fb8c3020dadd69080a7acd2054ea1} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !getNumberFraction@{ getNumberFraction} }
2025-07-24 09:35:52 -04:00
\index { getNumberFraction@{ getNumberFraction} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { getNumberFraction()} { getNumberFraction()} \hspace { 0.1cm} { \footnotesize \ttfamily [1/3]} }
2025-10-12 10:22:43 -04:00
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ ae46fb8c3020dadd69080a7acd2054ea1}
std\+ ::unordered\+ \_ \+ map$ < $ std\+ ::string, double $ > $ fourdst\+ ::composition\+ ::\+ Composition\+ ::get\+ Number\+ Fraction (\begin { DoxyParamCaption} { } { } \end { DoxyParamCaption} ) const\hspace { 0.3cm} { \ttfamily [nodiscard]} , { \ttfamily [override]} , { \ttfamily [virtual]} }
2025-07-24 09:35:52 -04:00
Gets the number fractions of all species in the composition.
\begin { DoxyPrecond} { Precondition}
The composition must be finalized.
\end { DoxyPrecond}
\begin { DoxyReturn} { Returns}
An unordered map of symbols to their number fractions.
\end { DoxyReturn}
\begin { DoxyExceptions} { Exceptions}
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ composition_ not_ finalized_ error} { exceptions\+ ::\+ Composition\+ Not\+ Finalized\+ Error} } & if the composition is not finalized. \\
\hline
\end { DoxyExceptions}
2025-10-12 10:22:43 -04:00
Implements \mbox { \hyperlink { class_ composition_ abstract_ ac1f2f30cdb2d1b9db76512c25c25618c} { Composition\+ Abstract} } .
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00633} { 633} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
2025-07-24 09:35:52 -04:00
2025-10-12 10:22:43 -04:00
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a178d7393ee8b5d496925dcd901c03d23} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !getNumberFraction@{ getNumberFraction} }
2025-07-24 09:35:52 -04:00
\index { getNumberFraction@{ getNumberFraction} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { getNumberFraction()} { getNumberFraction()} \hspace { 0.1cm} { \footnotesize \ttfamily [2/3]} }
2025-10-12 10:22:43 -04:00
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a178d7393ee8b5d496925dcd901c03d23}
double fourdst\+ ::composition\+ ::\+ Composition\+ ::get\+ Number\+ Fraction (\begin { DoxyParamCaption} \item [{const \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{fourdst\+::atomic\+::\+Species}} \&}] { species} { } \end { DoxyParamCaption} ) const\hspace { 0.3cm} { \ttfamily [nodiscard]} , { \ttfamily [override]} , { \ttfamily [virtual]} }
2025-07-24 09:35:52 -04:00
Gets the number fraction for a given isotope.
\begin { DoxyPrecond} { Precondition}
The composition must be finalized.
\end { DoxyPrecond}
\begin { DoxyParams} { Parameters}
{ \em species} & The isotope to get the number fraction for. \\
\hline
\end { DoxyParams}
\begin { DoxyReturn} { Returns}
The number fraction for the given isotope.
\end { DoxyReturn}
\begin { DoxyExceptions} { Exceptions}
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ composition_ not_ finalized_ error} { exceptions\+ ::\+ Composition\+ Not\+ Finalized\+ Error} } & if the composition is not finalized. \\
\hline
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ unregistered_ symbol_ error} { exceptions\+ ::\+ Unregistered\+ Symbol\+ Error} } & if the isotope is not registered in the composition. \\
\hline
\end { DoxyExceptions}
2025-10-12 10:22:43 -04:00
Implements \mbox { \hyperlink { class_ composition_ abstract_ a27d1d91203adb736454aa9b9936fc8c3} { Composition\+ Abstract} } .
2025-07-24 09:35:52 -04:00
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00627} { 627} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a34f71d4d8f0297c576fd62fabd490305} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !getNumberFraction@{ getNumberFraction} }
2025-07-24 09:35:52 -04:00
\index { getNumberFraction@{ getNumberFraction} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { getNumberFraction()} { getNumberFraction()} \hspace { 0.1cm} { \footnotesize \ttfamily [3/3]} }
2025-10-12 10:22:43 -04:00
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a34f71d4d8f0297c576fd62fabd490305}
double fourdst\+ ::composition\+ ::\+ Composition\+ ::get\+ Number\+ Fraction (\begin { DoxyParamCaption} \item [{const std\+::string \&}] { symbol} { } \end { DoxyParamCaption} ) const\hspace { 0.3cm} { \ttfamily [nodiscard]} , { \ttfamily [override]} , { \ttfamily [virtual]} }
2025-07-24 09:35:52 -04:00
Gets the number fraction for a given symbol.
\begin { DoxyPrecond} { Precondition}
The composition must be finalized.
\end { DoxyPrecond}
\begin { DoxyParams} { Parameters}
{ \em symbol} & The symbol to get the number fraction for. \\
\hline
\end { DoxyParams}
\begin { DoxyReturn} { Returns}
The number fraction for the given symbol.
\end { DoxyReturn}
\begin { DoxyExceptions} { Exceptions}
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ composition_ not_ finalized_ error} { exceptions\+ ::\+ Composition\+ Not\+ Finalized\+ Error} } & if the composition is not finalized. \\
\hline
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ unregistered_ symbol_ error} { exceptions\+ ::\+ Unregistered\+ Symbol\+ Error} } & if the symbol is not in the composition. \\
\hline
\end { DoxyExceptions}
2025-10-12 10:22:43 -04:00
Implements \mbox { \hyperlink { class_ composition_ abstract_ ae6026b1335230c6dfbd897ec8dfda295} { Composition\+ Abstract} } .
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00610} { 610} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
2025-09-16 11:24:28 -04:00
2025-10-12 10:22:43 -04:00
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a49d2eba540f28324c6b7145a5b6cabfd} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !getNumberFractionVector@{ getNumberFractionVector} }
2025-09-16 11:24:28 -04:00
\index { getNumberFractionVector@{ getNumberFractionVector} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { getNumberFractionVector()} { getNumberFractionVector()} }
2025-10-12 10:22:43 -04:00
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a49d2eba540f28324c6b7145a5b6cabfd}
std\+ ::vector$ < $ double $ > $ fourdst\+ ::composition\+ ::\+ Composition\+ ::get\+ Number\+ Fraction\+ Vector (\begin { DoxyParamCaption} { } { } \end { DoxyParamCaption} ) const\hspace { 0.3cm} { \ttfamily [nodiscard]} , { \ttfamily [override]} , { \ttfamily [virtual]} }
2025-09-16 11:24:28 -04:00
Get a uniform vector representation of the number fractions stored in the composition object sorted such that the lightest species is at index 0 and the heaviest is at the last index.
This is primarily useful for external libraries which need to ensure that vector representation uniformity is maintained \begin { DoxyReturn} { Returns}
the vector of number fractions sorted by species mass (lightest to heaviest).
\end { DoxyReturn}
\begin { DoxyPrecond} { Precondition}
The composition must be finalized.
\end { DoxyPrecond}
\begin { DoxyExceptions} { Exceptions}
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ composition_ not_ finalized_ error} { exceptions\+ ::\+ Composition\+ Not\+ Finalized\+ Error} } & if the composition is not finalized. \\
\hline
\end { DoxyExceptions}
2025-10-12 10:22:43 -04:00
Implements \mbox { \hyperlink { class_ composition_ abstract_ a221dadad44f913b7f364508f5138303f} { Composition\+ Abstract} } .
2025-07-24 09:35:52 -04:00
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00866} { 866} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ af61ebe73a8b5926eb23037bb078fa87a} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !getRegisteredSpecies@{ getRegisteredSpecies} }
2025-07-24 09:35:52 -04:00
\index { getRegisteredSpecies@{ getRegisteredSpecies} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { getRegisteredSpecies()} { getRegisteredSpecies()} }
2025-10-12 10:22:43 -04:00
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ af61ebe73a8b5926eb23037bb078fa87a}
std\+ ::set$ < $ \mbox { \hyperlink { structfourdst_ 1_ 1atomic_ 1_ 1_ species} { atomic\+ ::\+ Species} } $ > $ fourdst\+ ::composition\+ ::\+ Composition\+ ::get\+ Registered\+ Species (\begin { DoxyParamCaption} { } { } \end { DoxyParamCaption} ) const\hspace { 0.3cm} { \ttfamily [nodiscard]} , { \ttfamily [override]} , { \ttfamily [virtual]} }
2025-07-24 09:35:52 -04:00
Get a set of all species that are registered in the composition.
\begin { DoxyReturn} { Returns}
A set of { \ttfamily \doxylink { structfourdst_ 1_ 1atomic_ 1_ 1_ species} { atomic\+ ::\+ Species} } objects registered in the composition.
\end { DoxyReturn}
2025-10-12 10:22:43 -04:00
Implements \mbox { \hyperlink { class_ composition_ abstract_ a6bf81edc0d21d34dbb8badc4ebdc0e17} { Composition\+ Abstract} } .
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00313} { 313} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
2025-07-24 09:35:52 -04:00
2025-10-12 10:22:43 -04:00
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a3f10f38878ba4be121d6d77a8b1f4d7a} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !getRegisteredSymbols@{ getRegisteredSymbols} }
2025-07-24 09:35:52 -04:00
\index { getRegisteredSymbols@{ getRegisteredSymbols} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { getRegisteredSymbols()} { getRegisteredSymbols()} }
2025-10-12 10:22:43 -04:00
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a3f10f38878ba4be121d6d77a8b1f4d7a}
std\+ ::set$ < $ std\+ ::string $ > $ fourdst\+ ::composition\+ ::\+ Composition\+ ::get\+ Registered\+ Symbols (\begin { DoxyParamCaption} { } { } \end { DoxyParamCaption} ) const\hspace { 0.3cm} { \ttfamily [nodiscard]} , { \ttfamily [override]} , { \ttfamily [virtual]} }
2025-07-24 09:35:52 -04:00
Gets the registered symbols.
\begin { DoxyReturn} { Returns}
A set of registered symbols.
\end { DoxyReturn}
2025-10-12 10:22:43 -04:00
Implements \mbox { \hyperlink { class_ composition_ abstract_ a4834d6b6caf5acced57989680e87be03} { Composition\+ Abstract} } .
2025-09-16 11:24:28 -04:00
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00309} { 309} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ ae4f854ded38f5e6fcd157a74a57cbf0c} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !getSpeciesAtIndex@{ getSpeciesAtIndex} }
2025-09-16 11:24:28 -04:00
\index { getSpeciesAtIndex@{ getSpeciesAtIndex} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { getSpeciesAtIndex()} { getSpeciesAtIndex()} }
2025-10-12 10:22:43 -04:00
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ ae4f854ded38f5e6fcd157a74a57cbf0c}
\mbox { \hyperlink { structfourdst_ 1_ 1atomic_ 1_ 1_ species} { atomic\+ ::\+ Species} } fourdst\+ ::composition\+ ::\+ Composition\+ ::get\+ Species\+ At\+ Index (\begin { DoxyParamCaption} \item [{size\+\_\+t}] { index} { } \end { DoxyParamCaption} ) const\hspace { 0.3cm} { \ttfamily [nodiscard]} , { \ttfamily [override]} , { \ttfamily [virtual]} }
2025-09-16 11:24:28 -04:00
Get the species at a given index in the sorted vector representation.
This is primarily useful for external libraries which need to ensure that vector representation uniformity is maintained \begin { DoxyPrecond} { Precondition}
The composition must be finalized.
\end { DoxyPrecond}
\begin { DoxyParams} { Parameters}
{ \em index} & The index in the sorted vector representation for which to return the species. Must be in \mbox { [} 0, N-\/ 1\mbox { ]} where N is the number of registered species. \\
\hline
\end { DoxyParams}
\begin { DoxyExceptions} { Exceptions}
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ composition_ not_ finalized_ error} { exceptions\+ ::\+ Composition\+ Not\+ Finalized\+ Error} } & if the composition is not finalized. \\
\hline
{ \em std\+ ::out\+ \_ \+ of\+ \_ \+ range} & if the index is out of range. \\
\hline
\end { DoxyExceptions}
\begin { DoxyReturn} { Returns}
The species at the given index in the sorted vector representation.
\end { DoxyReturn}
2025-10-12 10:22:43 -04:00
Implements \mbox { \hyperlink { class_ composition_ abstract_ aaee3651c1672b2763181e966e4525ba6} { Composition\+ Abstract} } .
2025-09-16 11:24:28 -04:00
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00993} { 993} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a3d220b42fa06d7d3a43944ee2b8f6a5f} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !getSpeciesIndex@{ getSpeciesIndex} }
2025-09-16 11:24:28 -04:00
\index { getSpeciesIndex@{ getSpeciesIndex} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { getSpeciesIndex()} { getSpeciesIndex()} \hspace { 0.1cm} { \footnotesize \ttfamily [1/2]} }
2025-10-12 10:22:43 -04:00
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a3d220b42fa06d7d3a43944ee2b8f6a5f}
size\+ \_ \+ t fourdst\+ ::composition\+ ::\+ Composition\+ ::get\+ Species\+ Index (\begin { DoxyParamCaption} \item [{const \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{atomic\+::\+Species}} \&}] { species} { } \end { DoxyParamCaption} ) const\hspace { 0.3cm} { \ttfamily [nodiscard]} , { \ttfamily [override]} , { \ttfamily [virtual]} }
2025-09-16 11:24:28 -04:00
get the index in the sorted vector representation for a given symbol
This is primarily useful for external libraries which need to ensure that vector representation uniformity is maintained \begin { DoxyPrecond} { Precondition}
The composition must be finalized.
symbol must be registered in the composition
\end { DoxyPrecond}
\begin { DoxyParams} { Parameters}
2025-10-12 10:22:43 -04:00
{ \em species} & the species to look up the index for. Note that this is the index species data will be at if you were to call \doxylink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ abed665c07c42b40682da453576621399} { get\+ Molar\+ Abundance\+ Vector()} , \doxylink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a85169b763138ab72047e43e07af978fb} { get\+ Mass\+ Fraction\+ Vector()} , or \doxylink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a49d2eba540f28324c6b7145a5b6cabfd} { get\+ Number\+ Fraction\+ Vector()} \\
2025-09-16 11:24:28 -04:00
\hline
\end { DoxyParams}
\begin { DoxyExceptions} { Exceptions}
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ composition_ not_ finalized_ error} { exceptions\+ ::\+ Composition\+ Not\+ Finalized\+ Error} } & if the composition is not finalized. \\
\hline
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ unregistered_ symbol_ error} { exceptions\+ ::\+ Unregistered\+ Symbol\+ Error} } & if the symbol is not registered in the composition \\
\hline
\end { DoxyExceptions}
\begin { DoxyReturn} { Returns}
The index of the symbol in the sorted vector representation.
\end { DoxyReturn}
2025-10-12 10:22:43 -04:00
Implements \mbox { \hyperlink { class_ composition_ abstract_ ab41311a8c20a9556d087a604da735767} { Composition\+ Abstract} } .
2025-09-16 11:24:28 -04:00
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00955} { 955} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a0d94f62402bb90b5d12679faeaa8c5d7} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !getSpeciesIndex@{ getSpeciesIndex} }
2025-09-16 11:24:28 -04:00
\index { getSpeciesIndex@{ getSpeciesIndex} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { getSpeciesIndex()} { getSpeciesIndex()} \hspace { 0.1cm} { \footnotesize \ttfamily [2/2]} }
2025-10-12 10:22:43 -04:00
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a0d94f62402bb90b5d12679faeaa8c5d7}
size\+ \_ \+ t fourdst\+ ::composition\+ ::\+ Composition\+ ::get\+ Species\+ Index (\begin { DoxyParamCaption} \item [{const std\+::string \&}] { symbol} { } \end { DoxyParamCaption} ) const\hspace { 0.3cm} { \ttfamily [nodiscard]} , { \ttfamily [override]} , { \ttfamily [virtual]} }
2025-09-16 11:24:28 -04:00
get the index in the sorted vector representation for a given symbol
This is primarily useful for external libraries which need to ensure that vector representation uniformity is maintained \begin { DoxyPrecond} { Precondition}
The composition must be finalized.
symbol must be registered in the composition
\end { DoxyPrecond}
\begin { DoxyParams} { Parameters}
2025-10-12 10:22:43 -04:00
{ \em symbol} & the symbol to look up the index for. Note that this is the index species data will be at if you were to call \doxylink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ abed665c07c42b40682da453576621399} { get\+ Molar\+ Abundance\+ Vector()} , \doxylink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a85169b763138ab72047e43e07af978fb} { get\+ Mass\+ Fraction\+ Vector()} , or \doxylink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a49d2eba540f28324c6b7145a5b6cabfd} { get\+ Number\+ Fraction\+ Vector()} \\
2025-09-16 11:24:28 -04:00
\hline
\end { DoxyParams}
\begin { DoxyExceptions} { Exceptions}
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ composition_ not_ finalized_ error} { exceptions\+ ::\+ Composition\+ Not\+ Finalized\+ Error} } & if the composition is not finalized. \\
\hline
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ unregistered_ symbol_ error} { exceptions\+ ::\+ Unregistered\+ Symbol\+ Error} } & if the symbol is not registered in the composition \\
\hline
\end { DoxyExceptions}
\begin { DoxyReturn} { Returns}
The index of the symbol in the sorted vector representation.
\end { DoxyReturn}
2025-10-12 10:22:43 -04:00
Implements \mbox { \hyperlink { class_ composition_ abstract_ a1e5195debe590960aa064289733958ba} { Composition\+ Abstract} } .
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00917} { 917} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a55dfadad6cf5fb249356edad1733a813} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !hasSpecies@{ hasSpecies} }
\index { hasSpecies@{ hasSpecies} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { hasSpecies()} { hasSpecies()} }
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a55dfadad6cf5fb249356edad1733a813}
bool fourdst\+ ::composition\+ ::\+ Composition\+ ::has\+ Species (\begin { DoxyParamCaption} \item [{const \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{fourdst\+::atomic\+::\+Species}} \&}] { species} { } \end { DoxyParamCaption} ) const\hspace { 0.3cm} { \ttfamily [nodiscard]} , { \ttfamily [override]} , { \ttfamily [virtual]} }
Checks if a species is registered in the composition.
\begin { DoxyParams} { Parameters}
{ \em species} & The species to check. \\
\hline
\end { DoxyParams}
\begin { DoxyReturn} { Returns}
True if the species is registered, false otherwise.
\end { DoxyReturn}
Implements \mbox { \hyperlink { class_ composition_ abstract_ a7f66ab9ddc975b946f46f368f13eba1b} { Composition\+ Abstract} } .
2025-07-24 09:35:52 -04:00
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l01029} { 1029} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ ac01ae1967c266d8187bc6e104c8a0d19} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !hasSymbol@{ hasSymbol} }
2025-07-24 09:35:52 -04:00
\index { hasSymbol@{ hasSymbol} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { hasSymbol()} { hasSymbol()} }
2025-10-12 10:22:43 -04:00
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ ac01ae1967c266d8187bc6e104c8a0d19}
bool fourdst\+ ::composition\+ ::\+ Composition\+ ::has\+ Symbol (\begin { DoxyParamCaption} \item [{const std\+::string \&}] { symbol} { } \end { DoxyParamCaption} ) const\hspace { 0.3cm} { \ttfamily [nodiscard]} , { \ttfamily [override]} , { \ttfamily [virtual]} }
2025-07-24 09:35:52 -04:00
Checks if a symbol is registered in the composition.
\begin { DoxyParams} { Parameters}
{ \em symbol} & The symbol to check. \\
\hline
\end { DoxyParams}
\begin { DoxyReturn} { Returns}
True if the symbol is registered, false otherwise.
\end { DoxyReturn}
2025-10-12 10:22:43 -04:00
Implements \mbox { \hyperlink { class_ composition_ abstract_ a26a3d396a4c435dc3c20553dc5bad7df} { Composition\+ Abstract} } .
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l01023} { 1023} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ addf03ba8b988970d341884d487aa94d5} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !isValidComposition@{ isValidComposition} }
\index { isValidComposition@{ isValidComposition} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { isValidComposition()} { isValidComposition()} }
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ addf03ba8b988970d341884d487aa94d5}
bool fourdst\+ ::composition\+ ::\+ Composition\+ ::is\+ Valid\+ Composition (\begin { DoxyParamCaption} \item [{const std\+::vector$<$ double $>$ \&}] { fractions} { } \end { DoxyParamCaption} ) const\hspace { 0.3cm} { \ttfamily [nodiscard]} , { \ttfamily [private]} }
Checks if the given fractions are valid (sum to \texorpdfstring { $ \sim $ } { \string ~} 1.0).
\begin { DoxyParams} { Parameters}
{ \em fractions} & The fractions to check. \\
\hline
\end { DoxyParams}
\begin { DoxyReturn} { Returns}
True if the fractions are valid, false otherwise.
\end { DoxyReturn}
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00334} { 334} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a8fdac26e6298008aaeaa5b15f7fe244f} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !isValidSymbol@{ isValidSymbol} }
\index { isValidSymbol@{ isValidSymbol} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { isValidSymbol()} { isValidSymbol()} }
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a8fdac26e6298008aaeaa5b15f7fe244f}
bool fourdst\+ ::composition\+ ::\+ Composition\+ ::is\+ Valid\+ Symbol (\begin { DoxyParamCaption} \item [{const std\+::string \&}] { symbol} { } \end { DoxyParamCaption} )\hspace { 0.3cm} { \ttfamily [static]} , { \ttfamily [private]} }
Checks if the given symbol is valid by checking against the global species database.
\begin { DoxyParams} { Parameters}
{ \em symbol} & The symbol to check. \\
\hline
\end { DoxyParams}
\begin { DoxyReturn} { Returns}
True if the symbol is valid, false otherwise.
\end { DoxyReturn}
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00321} { 321} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a3aead72892606725a4149a5f65bd31ec} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !mix@{ mix} }
\index { mix@{ mix} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { mix()} { mix()} }
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a3aead72892606725a4149a5f65bd31ec}
\mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition} { Composition} } fourdst\+ ::composition\+ ::\+ Composition\+ ::mix (\begin { DoxyParamCaption} \item [{const \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition}{Composition}} \&}] { other} { , } \item [{double}] { fraction} { } \end { DoxyParamCaption} ) const\hspace { 0.3cm} { \ttfamily [nodiscard]} }
Mixes this composition with another to produce a new composition.
The mixing is performed linearly on the mass fractions. The formula for each species is\+ : { \ttfamily new\+ \_ \+ \+ X\+ \_ \+ i = fraction \texorpdfstring { $ \ast $ } { *} this\+ \_ \+ \+ X\+ \_ \+ i + (1 -\/ fraction) \texorpdfstring { $ \ast $ } { *} other\+ \_ \+ \+ X\+ \_ \+ i} . The resulting composition is automatically finalized.
\begin { DoxyParams} { Parameters}
{ \em other} & The other composition to mix with. \\
\hline
{ \em fraction} & The mixing fraction. A value of 1.\+ 0 means the new composition is 100\% { \ttfamily this} , 0.\+ 0 means 100\% { \ttfamily other} . \\
\hline
\end { DoxyParams}
\begin { DoxyReturn} { Returns}
A new, finalized { \ttfamily \doxylink { classfourdst_ 1_ 1composition_ 1_ 1_ composition} { Composition} } object representing the mixture.
\end { DoxyReturn}
\begin { DoxyPrecond} { Precondition}
Both { \ttfamily this} and { \ttfamily other} compositions must be finalized.
\end { DoxyPrecond}
\begin { DoxyExceptions} { Exceptions}
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ composition_ not_ finalized_ error} { exceptions\+ ::\+ Composition\+ Not\+ Finalized\+ Error} } & if either composition is not finalized. \\
\hline
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ invalid_ composition_ error} { exceptions\+ ::\+ Invalid\+ Composition\+ Error} } & if the fraction is not between 0 and 1. \\
\hline
\end { DoxyExceptions}
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00533} { 533} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a24a3bdeb8e8e55b54ecdee6dcb0d9561} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !operator+@{ operator+} }
\index { operator+@{ operator+} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { operator+()} { operator+()} }
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a24a3bdeb8e8e55b54ecdee6dcb0d9561}
\mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition} { Composition} } fourdst\+ ::composition\+ ::\+ Composition\+ ::operator+ (\begin { DoxyParamCaption} \item [{const \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition}{Composition}} \&}] { other} { } \end { DoxyParamCaption} ) const}
Overloads the + operator to mix two compositions with a 50/50 fraction.
OVERLOADS.
This is a convenience operator that calls { \ttfamily mix(other, 0.\+ 5)} .
\begin { DoxyParams} { Parameters}
{ \em other} & The other composition to mix with. \\
\hline
\end { DoxyParams}
\begin { DoxyReturn} { Returns}
The new, mixed composition.
\end { DoxyReturn}
\begin { DoxyPrecond} { Precondition}
Both compositions must be finalized.
\end { DoxyPrecond}
\begin { DoxyExceptions} { Exceptions}
{ \em See} & { \ttfamily \doxylink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a3aead72892606725a4149a5f65bd31ec} { mix()} } for exceptions. \\
\hline
\end { DoxyExceptions}
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l01054} { 1054} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a4ec1e23cfecef764cb831171fed62fc2} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !operator=@{ operator=} }
\index { operator=@{ operator=} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { operator=()} { operator=()} }
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a4ec1e23cfecef764cb831171fed62fc2}
\mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition} { Composition} } \& fourdst\+ ::composition\+ ::\+ Composition\+ ::operator= (\begin { DoxyParamCaption} \item [{\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition}{Composition}} const \&}] { other} { } \end { DoxyParamCaption} )}
Assignment operator.
\begin { DoxyParams} { Parameters}
{ \em other} & The \doxylink { classfourdst_ 1_ 1composition_ 1_ 1_ composition} { Composition} to assign from. \\
\hline
\end { DoxyParams}
\begin { DoxyReturn} { Returns}
A reference to this \doxylink { classfourdst_ 1_ 1composition_ 1_ 1_ composition} { Composition} .
\end { DoxyReturn}
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00243} { 243} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a4ce00f73cc133bb1bac2b030b93ab480} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !registerSpecies@{ registerSpecies} }
\index { registerSpecies@{ registerSpecies} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { registerSpecies()} { registerSpecies()} \hspace { 0.1cm} { \footnotesize \ttfamily [1/2]} }
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a4ce00f73cc133bb1bac2b030b93ab480}
void fourdst\+ ::composition\+ ::\+ Composition\+ ::register\+ Species (\begin { DoxyParamCaption} \item [{const \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{fourdst\+::atomic\+::\+Species}} \&}] { species} { , } \item [{bool}] { mass\+ Frac\+ Mode} { = { \ttfamily true} } \end { DoxyParamCaption} )}
Registers a new species by extracting its symbol.
\begin { DoxyParams} { Parameters}
{ \em species} & The species to register. \\
\hline
{ \em mass\+ Frac\+ Mode} & True for mass fraction mode, false for number fraction mode. \\
\hline
\end { DoxyParams}
\begin { DoxyExceptions} { Exceptions}
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ invalid_ symbol_ error} { exceptions\+ ::\+ Invalid\+ Symbol\+ Error} } & if the species\textquotesingle { } symbol is invalid. \\
\hline
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ composition_ mode_ error} { exceptions\+ ::\+ Composition\+ Mode\+ Error} } & if the mode conflicts. \\
\hline
\end { DoxyExceptions}
\begin { DoxyParagraph} { Usage Example\+ :}
\begin { DoxyCode} { 0}
\DoxyCodeLine { \textcolor { preprocessor} { \# include\ "{ } \mbox { \hyperlink { species_ 8h} { fourdst/composition/species.h} } "{ } } \ \textcolor { comment} { //\ Assuming\ species\ like\ H1\ are\ defined\ here} }
\DoxyCodeLine { \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a23b83b76ee025f6fc009184ee19bba88} { Composition} } \ comp;}
\DoxyCodeLine { comp.registerSpecies(\mbox { \hyperlink { namespacefourdst_ 1_ 1atomic_ a3f619cc8f8b2cd718a4082c6adb0de90} { fourdst::atomic::species} } .at(\textcolor { stringliteral} { "{ } H-\/ 1"{ } } ));}
\end { DoxyCode}
\end { DoxyParagraph}
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00293} { 293} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a057f2bf2e86bcc3c649c0ddf18cf3826} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !registerSpecies@{ registerSpecies} }
\index { registerSpecies@{ registerSpecies} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { registerSpecies()} { registerSpecies()} \hspace { 0.1cm} { \footnotesize \ttfamily [2/2]} }
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a057f2bf2e86bcc3c649c0ddf18cf3826}
void fourdst\+ ::composition\+ ::\+ Composition\+ ::register\+ Species (\begin { DoxyParamCaption} \item [{const std\+::vector$<$ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{fourdst\+::atomic\+::\+Species}} $>$ \&}] { species} { , } \item [{bool}] { mass\+ Frac\+ Mode} { = { \ttfamily true} } \end { DoxyParamCaption} )}
Registers a vector of new species.
\begin { DoxyParams} { Parameters}
{ \em species} & The vector of species to register. \\
\hline
{ \em mass\+ Frac\+ Mode} & True for mass fraction mode, false for number fraction mode. \\
\hline
\end { DoxyParams}
\begin { DoxyExceptions} { Exceptions}
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ invalid_ symbol_ error} { exceptions\+ ::\+ Invalid\+ Symbol\+ Error} } & if any species\textquotesingle { } symbol is invalid. \\
\hline
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ composition_ mode_ error} { exceptions\+ ::\+ Composition\+ Mode\+ Error} } & if the mode conflicts. \\
\hline
\end { DoxyExceptions}
\begin { DoxyParagraph} { Usage Example\+ :}
\begin { DoxyCode} { 0}
\DoxyCodeLine { \textcolor { preprocessor} { \# include\ "{ } \mbox { \hyperlink { species_ 8h} { fourdst/composition/species.h} } "{ } } }
\DoxyCodeLine { \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a23b83b76ee025f6fc009184ee19bba88} { Composition} } \ comp;}
\DoxyCodeLine { std::vector<fourdst::atomic::Species>\ my\_ species\ =\ \{ \ ...\ \} ;}
\DoxyCodeLine { comp.registerSpecies(my\_ species,\ \textcolor { keyword} { false} );\ \textcolor { comment} { //\ Number\ fraction\ mode} }
\end { DoxyCode}
\end { DoxyParagraph}
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00300} { 300} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a1bc2e64f87c12befdc2bc767e7405661} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !registerSymbol@{ registerSymbol} }
\index { registerSymbol@{ registerSymbol} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { registerSymbol()} { registerSymbol()} \hspace { 0.1cm} { \footnotesize \ttfamily [1/2]} }
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a1bc2e64f87c12befdc2bc767e7405661}
void fourdst\+ ::composition\+ ::\+ Composition\+ ::register\+ Symbol (\begin { DoxyParamCaption} \item [{const std\+::string \&}] { symbol} { , } \item [{bool}] { mass\+ Frac\+ Mode} { = { \ttfamily true} } \end { DoxyParamCaption} )}
Registers a new symbol for inclusion in the composition.
A symbol must be registered before its abundance can be set. The first registration sets the mode (mass/number fraction) for the entire composition.
\begin { DoxyParams} { Parameters}
{ \em symbol} & The symbol to register (e.\+ g., "{ } \+ Fe-\/ 56"{ } ). \\
\hline
{ \em mass\+ Frac\+ Mode} & True for mass fraction mode, false for number fraction mode. This is only effective for the first symbol registered. \\
\hline
\end { DoxyParams}
\begin { DoxyExceptions} { Exceptions}
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ invalid_ symbol_ error} { exceptions\+ ::\+ Invalid\+ Symbol\+ Error} } & if the symbol is not in the atomic species database. \\
\hline
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ composition_ mode_ error} { exceptions\+ ::\+ Composition\+ Mode\+ Error} } & if attempting to register with a mode that conflicts with the existing mode. \\
\hline
\end { DoxyExceptions}
\begin { DoxyParagraph} { Usage Example\+ :}
\begin { DoxyCode} { 0}
\DoxyCodeLine { \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a23b83b76ee025f6fc009184ee19bba88} { Composition} } \ comp;}
\DoxyCodeLine { comp.registerSymbol(\textcolor { stringliteral} { "{ } H-\/ 1"{ } } );\ \textcolor { comment} { //\ Now\ in\ mass\ fraction\ mode} }
\DoxyCodeLine { comp.registerSymbol(\textcolor { stringliteral} { "{ } He-\/ 4"{ } } );\ \textcolor { comment} { //\ Must\ also\ be\ mass\ fraction\ mode} }
\end { DoxyCode}
\end { DoxyParagraph}
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00255} { 255} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a9b422156600823276a9606bfa07ad4db} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !registerSymbol@{ registerSymbol} }
\index { registerSymbol@{ registerSymbol} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { registerSymbol()} { registerSymbol()} \hspace { 0.1cm} { \footnotesize \ttfamily [2/2]} }
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a9b422156600823276a9606bfa07ad4db}
void fourdst\+ ::composition\+ ::\+ Composition\+ ::register\+ Symbol (\begin { DoxyParamCaption} \item [{const std\+::vector$<$ std\+::string $>$ \&}] { symbols} { , } \item [{bool}] { mass\+ Frac\+ Mode} { = { \ttfamily true} } \end { DoxyParamCaption} )}
Registers multiple new symbols.
\begin { DoxyParams} { Parameters}
{ \em symbols} & The symbols to register. \\
\hline
{ \em mass\+ Frac\+ Mode} & True for mass fraction mode, false for number fraction mode. \\
\hline
\end { DoxyParams}
\begin { DoxyExceptions} { Exceptions}
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ invalid_ symbol_ error} { exceptions\+ ::\+ Invalid\+ Symbol\+ Error} } & if any symbol is invalid. \\
\hline
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ composition_ mode_ error} { exceptions\+ ::\+ Composition\+ Mode\+ Error} } & if the mode conflicts with an already set mode. \\
\hline
\end { DoxyExceptions}
\begin { DoxyParagraph} { Usage Example\+ :}
\begin { DoxyCode} { 0}
\DoxyCodeLine { std::vector<std::string>\ symbols\ =\ \{ \textcolor { stringliteral} { "{ } H-\/ 1"{ } } ,\ \textcolor { stringliteral} { "{ } O-\/ 16"{ } } \} ;}
\DoxyCodeLine { \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a23b83b76ee025f6fc009184ee19bba88} { Composition} } \ comp;}
\DoxyCodeLine { comp.registerSymbol(symbols);}
\end { DoxyCode}
\end { DoxyParagraph}
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00284} { 284} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a0af981ed1074b26c237cf6cf35f82c9e} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !setCompositionMode@{ setCompositionMode} }
\index { setCompositionMode@{ setCompositionMode} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { setCompositionMode()} { setCompositionMode()} }
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a0af981ed1074b26c237cf6cf35f82c9e}
void fourdst\+ ::composition\+ ::\+ Composition\+ ::set\+ Composition\+ Mode (\begin { DoxyParamCaption} \item [{bool}] { mass\+ Frac\+ Mode} { } \end { DoxyParamCaption} )}
Sets the composition mode (mass fraction vs. number fraction).
This function converts all entries in the composition to the specified mode. \begin { DoxyPrecond} { Precondition}
The composition must be finalized before the mode can be switched.
\end { DoxyPrecond}
\begin { DoxyParams} { Parameters}
{ \em mass\+ Frac\+ Mode} & True to switch to mass fraction mode, false for number fraction mode. \\
\hline
\end { DoxyParams}
\begin { DoxyExceptions} { Exceptions}
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ composition_ not_ finalized_ error} { exceptions\+ ::\+ Composition\+ Not\+ Finalized\+ Error} } & if the composition is not finalized. \\
\hline
{ \em std\+ ::runtime\+ \_ \+ error} & if the conversion fails for an unknown reason. \\
\hline
\end { DoxyExceptions}
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00762} { 762} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ aa6c94269a5d16349c98860f3015b734a} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !setMassFraction@{ setMassFraction} }
\index { setMassFraction@{ setMassFraction} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { setMassFraction()} { setMassFraction()} \hspace { 0.1cm} { \footnotesize \ttfamily [1/4]} }
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ aa6c94269a5d16349c98860f3015b734a}
double fourdst\+ ::composition\+ ::\+ Composition\+ ::set\+ Mass\+ Fraction (\begin { DoxyParamCaption} \item [{const \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{fourdst\+::atomic\+::\+Species}} \&}] { species} { , } \item [{const double \&}] { mass\+ \_ \+ fraction} { } \end { DoxyParamCaption} )}
Sets the mass fraction for a given species.
\begin { DoxyParams} { Parameters}
{ \em species} & The species to set the mass fraction for. \\
\hline
{ \em mass\+ \_ \+ fraction} & The mass fraction to set. \\
\hline
\end { DoxyParams}
\begin { DoxyReturn} { Returns}
The previous mass fraction that was set for the species.
\end { DoxyReturn}
\begin { DoxyExceptions} { Exceptions}
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ unregistered_ symbol_ error} { exceptions\+ ::\+ Unregistered\+ Symbol\+ Error} } & if the species is not registered. \\
\hline
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ composition_ mode_ error} { exceptions\+ ::\+ Composition\+ Mode\+ Error} } & if the composition is in number fraction mode. \\
\hline
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ invalid_ composition_ error} { exceptions\+ ::\+ Invalid\+ Composition\+ Error} } & if the mass fraction is not between 0 and 1. \\
\hline
\end { DoxyExceptions}
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00411} { 411} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a493224656aa3ade68389250720ef09af} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !setMassFraction@{ setMassFraction} }
\index { setMassFraction@{ setMassFraction} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { setMassFraction()} { setMassFraction()} \hspace { 0.1cm} { \footnotesize \ttfamily [2/4]} }
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a493224656aa3ade68389250720ef09af}
double fourdst\+ ::composition\+ ::\+ Composition\+ ::set\+ Mass\+ Fraction (\begin { DoxyParamCaption} \item [{const std\+::string \&}] { symbol} { , } \item [{const double \&}] { mass\+ \_ \+ fraction} { } \end { DoxyParamCaption} )}
Sets the mass fraction for a given symbol.
\begin { DoxyParams} { Parameters}
{ \em symbol} & The symbol to set the mass fraction for. \\
\hline
{ \em mass\+ \_ \+ fraction} & The mass fraction to set (must be in \mbox { [} 0, 1\mbox { ]} ). \\
\hline
\end { DoxyParams}
\begin { DoxyReturn} { Returns}
The previous mass fraction that was set for the symbol.
\end { DoxyReturn}
\begin { DoxyExceptions} { Exceptions}
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ unregistered_ symbol_ error} { exceptions\+ ::\+ Unregistered\+ Symbol\+ Error} } & if the symbol is not registered. \\
\hline
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ composition_ mode_ error} { exceptions\+ ::\+ Composition\+ Mode\+ Error} } & if the composition is in number fraction mode. \\
\hline
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ invalid_ composition_ error} { exceptions\+ ::\+ Invalid\+ Composition\+ Error} } & if the mass fraction is not between 0 and 1. \\
\hline
\end { DoxyExceptions}
\begin { DoxyPostcond} { Postcondition}
The composition is marked as not finalized.
\end { DoxyPostcond}
\begin { DoxyParagraph} { Usage Example\+ :}
\begin { DoxyCode} { 0}
\DoxyCodeLine { \mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a23b83b76ee025f6fc009184ee19bba88} { Composition} } \ comp;}
\DoxyCodeLine { comp.registerSymbol(\textcolor { stringliteral} { "{ } H-\/ 1"{ } } );}
\DoxyCodeLine { comp.setMassFraction(\textcolor { stringliteral} { "{ } H-\/ 1"{ } } ,\ 0.7);}
\end { DoxyCode}
\end { DoxyParagraph}
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00343} { 343} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ abbae020d46c74708a7974c1ca755bb62} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !setMassFraction@{ setMassFraction} }
\index { setMassFraction@{ setMassFraction} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { setMassFraction()} { setMassFraction()} \hspace { 0.1cm} { \footnotesize \ttfamily [3/4]} }
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ abbae020d46c74708a7974c1ca755bb62}
std\+ ::vector$ < $ double $ > $ fourdst\+ ::composition\+ ::\+ Composition\+ ::set\+ Mass\+ Fraction (\begin { DoxyParamCaption} \item [{const std\+::vector$<$ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{fourdst\+::atomic\+::\+Species}} $>$ \&}] { species} { , } \item [{const std\+::vector$<$ double $>$ \&}] { mass\+ \_ \+ fractions} { } \end { DoxyParamCaption} )}
Sets the mass fraction for multiple species.
\begin { DoxyParams} { Parameters}
{ \em species} & The vector of species to set the mass fractions for. \\
\hline
{ \em mass\+ \_ \+ fractions} & The vector of mass fractions corresponding to the species. \\
\hline
\end { DoxyParams}
\begin { DoxyReturn} { Returns}
A vector of the previous mass fractions that were set.
\end { DoxyReturn}
\begin { DoxyExceptions} { Exceptions}
{ \em See} & { \ttfamily set\+ Mass\+ Fraction(const std\+ ::vector\texorpdfstring { $ < $ } { <} std\+ ::string\texorpdfstring { $ > $ } { >} \& , const std\+ ::vector\texorpdfstring { $ < $ } { <} double\texorpdfstring { $ > $ } { >} \& )} for exceptions. \\
\hline
\end { DoxyExceptions}
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00418} { 418} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a66ce1012c12b0a83629eb09d451b68e3} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !setMassFraction@{ setMassFraction} }
\index { setMassFraction@{ setMassFraction} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { setMassFraction()} { setMassFraction()} \hspace { 0.1cm} { \footnotesize \ttfamily [4/4]} }
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a66ce1012c12b0a83629eb09d451b68e3}
std\+ ::vector$ < $ double $ > $ fourdst\+ ::composition\+ ::\+ Composition\+ ::set\+ Mass\+ Fraction (\begin { DoxyParamCaption} \item [{const std\+::vector$<$ std\+::string $>$ \&}] { symbols} { , } \item [{const std\+::vector$<$ double $>$ \&}] { mass\+ \_ \+ fractions} { } \end { DoxyParamCaption} )}
Sets the mass fraction for multiple symbols.
\begin { DoxyParams} { Parameters}
{ \em symbols} & The symbols to set the mass fractions for. \\
\hline
{ \em mass\+ \_ \+ fractions} & The mass fractions corresponding to the symbols. \\
\hline
\end { DoxyParams}
\begin { DoxyReturn} { Returns}
A vector of the previous mass fractions that were set.
\end { DoxyReturn}
\begin { DoxyExceptions} { Exceptions}
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ invalid_ composition_ error} { exceptions\+ ::\+ Invalid\+ Composition\+ Error} } & if symbol and fraction counts differ. \\
\hline
{ \em See} & { \ttfamily set\+ Mass\+ Fraction(const std\+ ::string\& , const double\& )} for other exceptions. \\
\hline
\end { DoxyExceptions}
\begin { DoxyPostcond} { Postcondition}
The composition is marked as not finalized.
\end { DoxyPostcond}
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00362} { 362} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ aaa822bb48a948d101fef759ffbefe31b} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !setNumberFraction@{ setNumberFraction} }
\index { setNumberFraction@{ setNumberFraction} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { setNumberFraction()} { setNumberFraction()} \hspace { 0.1cm} { \footnotesize \ttfamily [1/4]} }
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ aaa822bb48a948d101fef759ffbefe31b}
double fourdst\+ ::composition\+ ::\+ Composition\+ ::set\+ Number\+ Fraction (\begin { DoxyParamCaption} \item [{const \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{fourdst\+::atomic\+::\+Species}} \&}] { species} { , } \item [{const double \&}] { number\+ \_ \+ fraction} { } \end { DoxyParamCaption} )}
Sets the number fraction for a given species.
\begin { DoxyParams} { Parameters}
{ \em species} & The species to set the number fraction for. \\
\hline
{ \em number\+ \_ \+ fraction} & The number fraction to set for the species. \\
\hline
\end { DoxyParams}
\begin { DoxyReturn} { Returns}
The previous number fraction that was set for the species.
\end { DoxyReturn}
\begin { DoxyExceptions} { Exceptions}
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ unregistered_ symbol_ error} { exceptions\+ ::\+ Unregistered\+ Symbol\+ Error} } & if the species is not registered. \\
\hline
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ composition_ mode_ error} { exceptions\+ ::\+ Composition\+ Mode\+ Error} } & if the composition is in mass fraction mode. \\
\hline
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ invalid_ composition_ error} { exceptions\+ ::\+ Invalid\+ Composition\+ Error} } & if the number fraction is not between 0 and 1. \\
\hline
\end { DoxyExceptions}
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00428} { 428} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a7d4d748f3ee25e68751fb143717ed080} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !setNumberFraction@{ setNumberFraction} }
\index { setNumberFraction@{ setNumberFraction} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { setNumberFraction()} { setNumberFraction()} \hspace { 0.1cm} { \footnotesize \ttfamily [2/4]} }
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a7d4d748f3ee25e68751fb143717ed080}
double fourdst\+ ::composition\+ ::\+ Composition\+ ::set\+ Number\+ Fraction (\begin { DoxyParamCaption} \item [{const std\+::string \&}] { symbol} { , } \item [{const double \&}] { number\+ \_ \+ fraction} { } \end { DoxyParamCaption} )}
Sets the number fraction for a given symbol.
\begin { DoxyParams} { Parameters}
{ \em symbol} & The symbol to set the number fraction for. \\
\hline
{ \em number\+ \_ \+ fraction} & The number fraction to set (must be in \mbox { [} 0, 1\mbox { ]} ). \\
\hline
\end { DoxyParams}
\begin { DoxyReturn} { Returns}
The previous number fraction that was set.
\end { DoxyReturn}
\begin { DoxyExceptions} { Exceptions}
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ unregistered_ symbol_ error} { exceptions\+ ::\+ Unregistered\+ Symbol\+ Error} } & if the symbol is not registered. \\
\hline
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ composition_ mode_ error} { exceptions\+ ::\+ Composition\+ Mode\+ Error} } & if the composition is in mass fraction mode. \\
\hline
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ invalid_ composition_ error} { exceptions\+ ::\+ Invalid\+ Composition\+ Error} } & if the number fraction is not between 0 and 1. \\
\hline
\end { DoxyExceptions}
\begin { DoxyPostcond} { Postcondition}
The composition is marked as not finalized.
\end { DoxyPostcond}
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00374} { 374} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ adc068778a1ef33cad67f5ca028b49bb8} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !setNumberFraction@{ setNumberFraction} }
\index { setNumberFraction@{ setNumberFraction} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { setNumberFraction()} { setNumberFraction()} \hspace { 0.1cm} { \footnotesize \ttfamily [3/4]} }
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ adc068778a1ef33cad67f5ca028b49bb8}
std\+ ::vector$ < $ double $ > $ fourdst\+ ::composition\+ ::\+ Composition\+ ::set\+ Number\+ Fraction (\begin { DoxyParamCaption} \item [{const std\+::vector$<$ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{fourdst\+::atomic\+::\+Species}} $>$ \&}] { species} { , } \item [{const std\+::vector$<$ double $>$ \&}] { number\+ \_ \+ fractions} { } \end { DoxyParamCaption} )}
Sets the number fraction for multiple species.
\begin { DoxyParams} { Parameters}
{ \em species} & The vector of species to set the number fractions for. \\
\hline
{ \em number\+ \_ \+ fractions} & The vector of number fractions corresponding to the species. \\
\hline
\end { DoxyParams}
\begin { DoxyReturn} { Returns}
The vector of the previous number fractions that were set.
\end { DoxyReturn}
\begin { DoxyExceptions} { Exceptions}
{ \em See} & { \ttfamily set\+ Number\+ Fraction(const std\+ ::vector\texorpdfstring { $ < $ } { <} std\+ ::string\texorpdfstring { $ > $ } { >} \& , const std\+ ::vector\texorpdfstring { $ < $ } { <} double\texorpdfstring { $ > $ } { >} \& )} for exceptions. \\
\hline
\end { DoxyExceptions}
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00435} { 435} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a48014a0a725ebd91ad1193c063b5b26f} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !setNumberFraction@{ setNumberFraction} }
\index { setNumberFraction@{ setNumberFraction} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { setNumberFraction()} { setNumberFraction()} \hspace { 0.1cm} { \footnotesize \ttfamily [4/4]} }
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a48014a0a725ebd91ad1193c063b5b26f}
std\+ ::vector$ < $ double $ > $ fourdst\+ ::composition\+ ::\+ Composition\+ ::set\+ Number\+ Fraction (\begin { DoxyParamCaption} \item [{const std\+::vector$<$ std\+::string $>$ \&}] { symbols} { , } \item [{const std\+::vector$<$ double $>$ \&}] { number\+ \_ \+ fractions} { } \end { DoxyParamCaption} )}
Sets the number fraction for multiple symbols.
\begin { DoxyParams} { Parameters}
{ \em symbols} & The symbols to set the number fractions for. \\
\hline
{ \em number\+ \_ \+ fractions} & The number fractions corresponding to the symbols. \\
\hline
\end { DoxyParams}
\begin { DoxyReturn} { Returns}
A vector of the previous number fractions that were set.
\end { DoxyReturn}
\begin { DoxyExceptions} { Exceptions}
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ invalid_ composition_ error} { exceptions\+ ::\+ Invalid\+ Composition\+ Error} } & if symbol and fraction counts differ. \\
\hline
{ \em See} & { \ttfamily set\+ Number\+ Fraction(const std\+ ::string\& , const double\& )} for other exceptions. \\
\hline
\end { DoxyExceptions}
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00396} { 396} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a17635cd21744c7cf86cb1eb75152c816} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !subset@{ subset} }
\index { subset@{ subset} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { subset()} { subset()} }
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a17635cd21744c7cf86cb1eb75152c816}
\mbox { \hyperlink { classfourdst_ 1_ 1composition_ 1_ 1_ composition} { Composition} } fourdst\+ ::composition\+ ::\+ Composition\+ ::subset (\begin { DoxyParamCaption} \item [{const std\+::vector$<$ std\+::string $>$ \&}] { symbols} { , } \item [{const std\+::string \&}] { method} { = { \ttfamily "{ } norm"{ } } } \end { DoxyParamCaption} ) const\hspace { 0.3cm} { \ttfamily [nodiscard]} }
Creates a new \doxylink { classfourdst_ 1_ 1composition_ 1_ 1_ composition} { Composition} object containing a subset of species from this one.
\begin { DoxyParams} { Parameters}
{ \em symbols} & The symbols to include in the subset. \\
\hline
{ \em method} & The method for handling the abundances of the new subset. Can be "{ } norm"{ } (normalize abundances to sum to 1) or "{ } none"{ } (keep original abundances). \\
\hline
\end { DoxyParams}
\begin { DoxyReturn} { Returns}
A new { \ttfamily \doxylink { classfourdst_ 1_ 1composition_ 1_ 1_ composition} { Composition} } object containing the subset.
\end { DoxyReturn}
\begin { DoxyExceptions} { Exceptions}
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ unregistered_ symbol_ error} { exceptions\+ ::\+ Unregistered\+ Symbol\+ Error} } & if any requested symbol is not in the original composition. \\
\hline
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ invalid_ mixing_ mode} { exceptions\+ ::\+ Invalid\+ Mixing\+ Mode} } & if an invalid method is provided. \\
\hline
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ failed_ to_ finalize_ composition_ error} { exceptions\+ ::\+ Failed\+ To\+ Finalize\+ Composition\+ Error} } & if normalization fails. \\
\hline
\end { DoxyExceptions}
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00734} { 734} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a86982685c34db4a8f079ddafc25c594e} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !validateComposition@{ validateComposition} }
\index { validateComposition@{ validateComposition} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { validateComposition()} { validateComposition()} }
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a86982685c34db4a8f079ddafc25c594e}
void fourdst\+ ::composition\+ ::\+ Composition\+ ::validate\+ Composition (\begin { DoxyParamCaption} \item [{const std\+::vector$<$ double $>$ \&}] { fractions} { } \end { DoxyParamCaption} ) const\hspace { 0.3cm} { \ttfamily [private]} }
Validates the given fractions, throwing an exception on failure.
\begin { DoxyParams} { Parameters}
{ \em fractions} & The fractions to validate. \\
\hline
\end { DoxyParams}
\begin { DoxyExceptions} { Exceptions}
{ \em \doxylink { classfourdst_ 1_ 1composition_ 1_ 1exceptions_ 1_ 1_ invalid_ composition_ error} { exceptions\+ ::\+ Invalid\+ Composition\+ Error} } & if the fractions are invalid. \\
\hline
\end { DoxyExceptions}
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l00327} { 327} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
2025-07-24 09:35:52 -04:00
\doxysubsection { Friends And Related Symbol Documentation}
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a36c2525d21cd932065bb2bb30bc57fb4} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !operator$ < $ $ < $ @{ operator$ < $ $ < $ } }
\index { operator$ < $ $ < $ @{ operator$ < $ $ < $ } !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { operator$ < $ $ < $ } { operator<<} }
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a36c2525d21cd932065bb2bb30bc57fb4}
std\+ ::ostream \& operator$ < $ $ < $ (\begin { DoxyParamCaption} \item [{std\+::ostream \&}] { os} { , } \item [{const \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition}{Composition}} \&}] { composition} { } \end { DoxyParamCaption} )\hspace { 0.3cm} { \ttfamily [friend]} }
Overloaded output stream operator for \doxylink { classfourdst_ 1_ 1composition_ 1_ 1_ composition} { Composition} .
\begin { DoxyParams} { Parameters}
{ \em os} & The output stream. \\
\hline
{ \em composition} & The \doxylink { classfourdst_ 1_ 1composition_ 1_ 1_ composition} { Composition} to output. \\
\hline
\end { DoxyParams}
\begin { DoxyReturn} { Returns}
The output stream.
\end { DoxyReturn}
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8cpp_ source_ l01078} { 1078} } of file \mbox { \hyperlink { composition_ 8cpp_ source} { composition.\+ cpp} } .
2025-07-24 09:35:52 -04:00
\doxysubsection { Member Data Documentation}
2025-10-12 10:22:43 -04:00
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a02cd9d9608da082a200fdfa86d14bf5d} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !m\_ cache@{ m\_ cache} }
\index { m\_ cache@{ m\_ cache} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { m\_ cache} { m\_ cache} }
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a02cd9d9608da082a200fdfa86d14bf5d}
\mbox { \hyperlink { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ 1_ 1_ composition_ cache} { Composition\+ Cache} } fourdst\+ ::composition\+ ::\+ Composition\+ ::m\+ \_ \+ cache\hspace { 0.3cm} { \ttfamily [mutable]} , { \ttfamily [private]} }
Cache for computed properties to avoid redundant calculations.
Definition at line \mbox { \hyperlink { composition_ 8h_ source_ l00297} { 297} } of file \mbox { \hyperlink { composition_ 8h_ source} { composition.\+ h} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ aa7f2753b10e85ae3bbf0c3d600a973db} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !m\_ compositions@{ m\_ compositions} }
\index { m\_ compositions@{ m\_ compositions} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { m\_ compositions} { m\_ compositions} }
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ aa7f2753b10e85ae3bbf0c3d600a973db}
std\+ ::unordered\+ \_ \+ map$ < $ std\+ ::string, \mbox { \hyperlink { structfourdst_ 1_ 1composition_ 1_ 1_ composition_ entry} { Composition\+ Entry} } $ > $ fourdst\+ ::composition\+ ::\+ Composition\+ ::m\+ \_ \+ compositions\hspace { 0.3cm} { \ttfamily [private]} }
The compositions.
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8h_ source_ l00295} { 295} } of file \mbox { \hyperlink { composition_ 8h_ source} { composition.\+ h} } .
2025-07-24 09:35:52 -04:00
2025-10-12 10:22:43 -04:00
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a1f96b2c567364368ea5ee6f0826f3091} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !m\_ config@{ m\_ config} }
2025-07-24 09:35:52 -04:00
\index { m\_ config@{ m\_ config} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { m\_ config} { m\_ config} }
2025-10-12 10:22:43 -04:00
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a1f96b2c567364368ea5ee6f0826f3091}
config\+ ::\+ Config\& fourdst\+ ::composition\+ ::\+ Composition\+ ::m\+ \_ \+ config = config\+ ::\+ Config\+ ::get\+ Instance()\hspace { 0.3cm} { \ttfamily [private]} }
2025-07-24 09:35:52 -04:00
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8h_ source_ l00285} { 285} } of file \mbox { \hyperlink { composition_ 8h_ source} { composition.\+ h} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ aa00cbc0933d8a22bb900ac21a338e5ac} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !m\_ finalized@{ m\_ finalized} }
\index { m\_ finalized@{ m\_ finalized} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { m\_ finalized} { m\_ finalized} }
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ aa00cbc0933d8a22bb900ac21a338e5ac}
bool fourdst\+ ::composition\+ ::\+ Composition\+ ::m\+ \_ \+ finalized = false\hspace { 0.3cm} { \ttfamily [private]} }
True if the composition is finalized.
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8h_ source_ l00289} { 289} } of file \mbox { \hyperlink { composition_ 8h_ source} { composition.\+ h} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ ab6c66f35e1fb05dd24aacaf90e115c5e} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !m\_ logger@{ m\_ logger} }
\index { m\_ logger@{ m\_ logger} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { m\_ logger} { m\_ logger} }
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ ab6c66f35e1fb05dd24aacaf90e115c5e}
quill\+ ::\+ Logger\texorpdfstring { $ \ast $ } { *} fourdst\+ ::composition\+ ::\+ Composition\+ ::m\+ \_ \+ logger = m\+ \_ \+ log\+ Manager.\+ get\+ Logger("{ } log"{ } )\hspace { 0.3cm} { \ttfamily [private]} }
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8h_ source_ l00287} { 287} } of file \mbox { \hyperlink { composition_ 8h_ source} { composition.\+ h} } .
2025-07-24 09:35:52 -04:00
2025-10-12 10:22:43 -04:00
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a40b2128948f01630cd2968488b450ce5} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !m\_ logManager@{ m\_ logManager} }
2025-07-24 09:35:52 -04:00
\index { m\_ logManager@{ m\_ logManager} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { m\_ logManager} { m\_ logManager} }
2025-10-12 10:22:43 -04:00
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a40b2128948f01630cd2968488b450ce5}
logging\+ ::\+ Log\+ Manager\& fourdst\+ ::composition\+ ::\+ Composition\+ ::m\+ \_ \+ log\+ Manager = logging\+ ::\+ Log\+ Manager\+ ::get\+ Instance()\hspace { 0.3cm} { \ttfamily [private]} }
2025-07-24 09:35:52 -04:00
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8h_ source_ l00286} { 286} } of file \mbox { \hyperlink { composition_ 8h_ source} { composition.\+ h} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a671f1ee8be00f4ff8c1d94fabb382380} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !m\_ massFracMode@{ m\_ massFracMode} }
\index { m\_ massFracMode@{ m\_ massFracMode} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { m\_ massFracMode} { m\_ massFracMode} }
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a671f1ee8be00f4ff8c1d94fabb382380}
bool fourdst\+ ::composition\+ ::\+ Composition\+ ::m\+ \_ \+ mass\+ Frac\+ Mode = true\hspace { 0.3cm} { \ttfamily [private]} }
True if mass fraction mode, false if number fraction mode.
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8h_ source_ l00292} { 292} } of file \mbox { \hyperlink { composition_ 8h_ source} { composition.\+ h} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a4a36c8d22ce61023e7bea1d9417577d4} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !m\_ meanParticleMass@{ m\_ meanParticleMass} }
\index { m\_ meanParticleMass@{ m\_ meanParticleMass} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { m\_ meanParticleMass} { m\_ meanParticleMass} }
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a4a36c8d22ce61023e7bea1d9417577d4}
double fourdst\+ ::composition\+ ::\+ Composition\+ ::m\+ \_ \+ mean\+ Particle\+ Mass = 0.\+ 0\hspace { 0.3cm} { \ttfamily [private]} }
The mean particle mass of the composition (\textbackslash { } sum\+ \_ \+ \{ i\} \textbackslash { } frac\{ n\+ \_ \+ i\} \{ m\+ \_ \+ i\} . where n\+ \_ \+ i is the number fraction of the ith species and m\+ \_ \+ i is the mass of the ith species).
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8h_ source_ l00291} { 291} } of file \mbox { \hyperlink { composition_ 8h_ source} { composition.\+ h} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a39bfcb7d81d723cbd9d021abd533b4d6} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !m\_ registeredSymbols@{ m\_ registeredSymbols} }
\index { m\_ registeredSymbols@{ m\_ registeredSymbols} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { m\_ registeredSymbols} { m\_ registeredSymbols} }
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ a39bfcb7d81d723cbd9d021abd533b4d6}
std\+ ::set$ < $ std\+ ::string$ > $ fourdst\+ ::composition\+ ::\+ Composition\+ ::m\+ \_ \+ registered\+ Symbols\hspace { 0.3cm} { \ttfamily [private]} }
The registered symbols.
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8h_ source_ l00294} { 294} } of file \mbox { \hyperlink { composition_ 8h_ source} { composition.\+ h} } .
2025-07-24 09:35:52 -04:00
\Hypertarget { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ addae4484da7d5072ab66a721dbe04ced} \index { fourdst::composition::Composition@{ fourdst::composition::Composition} !m\_ specificNumberDensity@{ m\_ specificNumberDensity} }
\index { m\_ specificNumberDensity@{ m\_ specificNumberDensity} !fourdst::composition::Composition@{ fourdst::composition::Composition} }
\doxysubsubsection { \texorpdfstring { m\_ specificNumberDensity} { m\_ specificNumberDensity} }
{ \footnotesize \ttfamily \label { classfourdst_ 1_ 1composition_ 1_ 1_ composition_ addae4484da7d5072ab66a721dbe04ced}
double fourdst\+ ::composition\+ ::\+ Composition\+ ::m\+ \_ \+ specific\+ Number\+ Density = 0.\+ 0\hspace { 0.3cm} { \ttfamily [private]} }
The specific number density of the composition (\textbackslash { } sum\+ \_ \+ \{ i\} X\+ \_ \+ i m\+ \_ \+ i. Where X\+ \_ \+ i is the number fraction of the ith species and m\+ \_ \+ i is the mass of the ith species).
2025-10-12 10:22:43 -04:00
Definition at line \mbox { \hyperlink { composition_ 8h_ source_ l00290} { 290} } of file \mbox { \hyperlink { composition_ 8h_ source} { composition.\+ h} } .
2025-07-24 09:35:52 -04:00
The documentation for this class was generated from the following files\+ :\begin { DoxyCompactItemize}
\item
src/composition/include/fourdst/composition/\mbox { \hyperlink { composition_ 8h} { composition.\+ h} } \item
src/composition/lib/\mbox { \hyperlink { composition_ 8cpp} { composition.\+ cpp} } \end { DoxyCompactItemize}
