tboudreaux/libcomposition
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(docs): rebuilt docs

Browse Source
This commit is contained in:
Emily Boudreaux
2026-06-12 10:49:27 -04:00
parent 997c845b3d
commit 30da87c74c
387 changed files with 6889 additions and 8739 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/latex/annotated.tex
View File

@@ -2,9 +2,11 @@
Here are the classes, structs, unions and interfaces with brief descriptions\+:\begin{DoxyCompactList}
\item\contentsline{section}{\mbox{\hyperlink{structfourdst_1_1composition_1_1detail_1_1_composition_iterator_1_1_arrow_proxy}{fourdst\+::composition\+::detail\+::\+Composition\+Iterator$<$ Is\+Const $>$\+::\+Arrow\+Proxy}} }{\pageref{structfourdst_1_1composition_1_1detail_1_1_composition_iterator_1_1_arrow_proxy}}{}
\item\contentsline{section}{\mbox{\hyperlink{structfourdst_1_1composition_1_1_canonical_composition}{fourdst\+::composition\+::\+Canonical\+Composition}} \\*Represents the canonical (X, Y, Z) composition of stellar material }{\pageref{structfourdst_1_1composition_1_1_canonical_composition}}{}
\item\contentsline{section}{\mbox{\hyperlink{classfourdst_1_1composition_1_1io_1_1_chemical_file_parser}{fourdst\+::composition\+::io\+::\+Chemical\+File\+Parser}} \\*Parser for the tagged flat-\/text chemical composition data format }{\pageref{classfourdst_1_1composition_1_1io_1_1_chemical_file_parser}}{}
\item\contentsline{section}{\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition}{fourdst\+::composition\+::\+Composition}} \\*Manages a collection of chemical species and their abundances }{\pageref{classfourdst_1_1composition_1_1_composition}}{}
\item\contentsline{section}{\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_abstract}{fourdst\+::composition\+::\+Composition\+Abstract}} \\*Abstract base class for chemical composition representations }{\pageref{classfourdst_1_1composition_1_1_composition_abstract}}{}
\item\contentsline{section}{\mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_1_1_composition_cache}{fourdst\+::composition\+::\+Composition\+::\+Composition\+Cache}} \\*Caches computed properties of the composition to avoid redundant calculations }{\pageref{structfourdst_1_1composition_1_1_composition_1_1_composition_cache}}{}
\item\contentsline{section}{\mbox{\hyperlink{structfourdst_1_1composition_1_1io_1_1_composition_data}{fourdst\+::composition\+::io\+::\+Composition\+Data}} }{\pageref{structfourdst_1_1composition_1_1io_1_1_composition_data}}{}
\item\contentsline{section}{\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition_decorator}{fourdst\+::composition\+::\+Composition\+Decorator}} }{\pageref{classfourdst_1_1composition_1_1_composition_decorator}}{}
\item\contentsline{section}{\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error}{fourdst\+::composition\+::exceptions\+::\+Composition\+Error}} \\*Base class for exceptions related to composition objects }{\pageref{classfourdst_1_1composition_1_1exceptions_1_1_composition_error}}{}
\item\contentsline{section}{\mbox{\hyperlink{structfourdst_1_1composition_1_1utils_1_1_composition_hash}{fourdst\+::composition\+::utils\+::\+Composition\+Hash}} }{\pageref{structfourdst_1_1composition_1_1utils_1_1_composition_hash}}{}
@@ -13,6 +15,7 @@ Here are the classes, structs, unions and interfaces with brief descriptions\+:\
\item\contentsline{section}{\mbox{\hyperlink{structstd_1_1hash_3_01fourdst_1_1composition_1_1_composition_01_4}{std\+::hash$<$ fourdst\+::composition\+::\+Composition $>$}} }{\pageref{structstd_1_1hash_3_01fourdst_1_1composition_1_1_composition_01_4}}{}
\item\contentsline{section}{\mbox{\hyperlink{structstd_1_1hash_3_01fourdst_1_1composition_1_1_composition_abstract_01_4}{std\+::hash$<$ fourdst\+::composition\+::\+Composition\+Abstract $>$}} }{\pageref{structstd_1_1hash_3_01fourdst_1_1composition_1_1_composition_abstract_01_4}}{}
\item\contentsline{section}{\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_composition_error}{fourdst\+::composition\+::exceptions\+::\+Invalid\+Composition\+Error}} \\*Exception thrown when a composition is in an invalid or inconsistent state }{\pageref{classfourdst_1_1composition_1_1exceptions_1_1_invalid_composition_error}}{}
\item\contentsline{section}{\mbox{\hyperlink{structfourdst_1_1composition_1_1io_1_1_isotopic_percentage}{fourdst\+::composition\+::io\+::\+Isotopic\+Percentage}} }{\pageref{structfourdst_1_1composition_1_1io_1_1_isotopic_percentage}}{}
\item\contentsline{section}{\mbox{\hyperlink{classfourdst_1_1composition_1_1_masked_composition}{fourdst\+::composition\+::\+Masked\+Composition}} }{\pageref{classfourdst_1_1composition_1_1_masked_composition}}{}
\item\contentsline{section}{\mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{fourdst\+::atomic\+::\+Species}} \\*Represents an atomic species (isotope) with its fundamental physical properties }{\pageref{structfourdst_1_1atomic_1_1_species}}{}
\item\contentsline{section}{\mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_species_error}{fourdst\+::composition\+::exceptions\+::\+Species\+Error}} \\*Base class for exceptions related to atomic species }{\pageref{classfourdst_1_1composition_1_1exceptions_1_1_species_error}}{}

3
docs/latex/atomic_species_8h.tex
View File

@@ -6,8 +6,7 @@
{\ttfamily \#include $<$optional$>$}\newline
{\ttfamily \#include $<$limits$>$}\newline
{\ttfamily \#include $<$stdexcept$>$}\newline
Include dependency graph for atomic\+Species.\+h\+:
\nopagebreak
Include dependency graph for atomic\+Species.\+h\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode

2
docs/latex/atomic_species_8h__dep__incl.md5
View File

@@ -1 +1 @@
f7e3291ca3e982fdf4fe0132ff7a7d02
26b3d6b8d4e18c1828771683a1d3bf6c

BIN
docs/latex/atomic_species_8h__dep__incl.pdf
View File

Binary file not shown.

6
docs/latex/classfourdst_1_1composition_1_1_composition.tex
View File

@@ -11,8 +11,7 @@ Manages a collection of chemical species and their abundances.
Inheritance diagram for fourdst\+::composition\+::Composition\+:
\nopagebreak
Inheritance diagram for fourdst\+::composition\+::Composition\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
@@ -21,8 +20,7 @@ Inheritance diagram for fourdst\+::composition\+::Composition\+:
\end{figure}
Collaboration diagram for fourdst\+::composition\+::Composition\+:
\nopagebreak
Collaboration diagram for fourdst\+::composition\+::Composition\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode

3
docs/latex/classfourdst_1_1composition_1_1_composition_abstract.tex
View File

@@ -11,8 +11,7 @@ Abstract base class for chemical composition representations.
Inheritance diagram for fourdst\+::composition\+::Composition\+Abstract\+:
\nopagebreak
Inheritance diagram for fourdst\+::composition\+::Composition\+Abstract\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode

6
docs/latex/classfourdst_1_1composition_1_1_composition_decorator.tex
View File

@@ -6,8 +6,7 @@
Inheritance diagram for fourdst\+::composition\+::Composition\+Decorator\+:
\nopagebreak
Inheritance diagram for fourdst\+::composition\+::Composition\+Decorator\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
@@ -16,8 +15,7 @@ Inheritance diagram for fourdst\+::composition\+::Composition\+Decorator\+:
\end{figure}
Collaboration diagram for fourdst\+::composition\+::Composition\+Decorator\+:
\nopagebreak
Collaboration diagram for fourdst\+::composition\+::Composition\+Decorator\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode

6
docs/latex/classfourdst_1_1composition_1_1_masked_composition.tex
View File

@@ -6,8 +6,7 @@
Inheritance diagram for fourdst\+::composition\+::Masked\+Composition\+:
\nopagebreak
Inheritance diagram for fourdst\+::composition\+::Masked\+Composition\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
@@ -16,8 +15,7 @@ Inheritance diagram for fourdst\+::composition\+::Masked\+Composition\+:
\end{figure}
Collaboration diagram for fourdst\+::composition\+::Masked\+Composition\+:
\nopagebreak
Collaboration diagram for fourdst\+::composition\+::Masked\+Composition\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode

3
docs/latex/classfourdst_1_1composition_1_1detail_1_1_composition_iterator.tex
View File

@@ -6,8 +6,7 @@
Collaboration diagram for fourdst\+::composition\+::detail\+::Composition\+Iterator\texorpdfstring{$<$}{<} Is\+Const \texorpdfstring{$>$}{>}\+:
\nopagebreak
Collaboration diagram for fourdst\+::composition\+::detail\+::Composition\+Iterator\texorpdfstring{$<$}{<} Is\+Const \texorpdfstring{$>$}{>}\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode

2
docs/latex/composition_8cpp.tex
View File

@@ -14,7 +14,7 @@
{\ttfamily \#include "{}fourdst/composition/composition.\+h"{}}\newline
{\ttfamily \#include $<$numeric$>$}\newline
{\ttfamily \#include "{}fourdst/composition/utils/composition\+\_\+hash.\+h"{}}\newline
{\ttfamily \#include "{}fourdst/composition/utils.\+h"{}}\newline
{\ttfamily \#include "{}../include/fourdst/composition/utils/utils.\+h"{}}\newline
{\ttfamily \#include "{}fourdst/composition/exceptions/exceptions\+\_\+composition.\+h"{}}\newline
Include dependency graph for composition.\+cpp\+:
\nopagebreak

2
docs/latex/composition_8cpp__incl.md5
View File

@@ -1 +1 @@
84462bd63880fdb5708bf1f29f5e1bf4
96a60c4cc4eb244a44f2c720ae2fe7f3

BIN
docs/latex/composition_8cpp__incl.pdf
View File

Binary file not shown.

2
docs/latex/composition_8cpp_source.tex
View File

@@ -42,7 +42,7 @@
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00038}00038\ \textcolor{preprocessor}{\#include\ <numeric>}}
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00039}00039\ }
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00040}00040\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{composition__hash_8h}{fourdst/composition/utils/composition\_hash.h}}"{}}}
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00041}00041\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{utils_8h}{fourdst/composition/utils.h}}"{}}}
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00041}00041\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{utils_8h}{../include/fourdst/composition/utils/utils.h}}"{}}}
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00042}00042\ }
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00043}00043\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{exceptions__composition_8h}{fourdst/composition/exceptions/exceptions\_composition.h}}"{}}}
\DoxyCodeLine{\Hypertarget{composition_8cpp_source_l00044}00044\ }

3
docs/latex/composition_8h.tex
View File

@@ -10,8 +10,7 @@
{\ttfamily \#include "{}fourdst/logging/logging.\+h"{}}\newline
{\ttfamily \#include "{}fourdst/composition/composition\+\_\+abstract.\+h"{}}\newline
{\ttfamily \#include "{}fourdst/atomic/atomic\+Species.\+h"{}}\newline
Include dependency graph for composition.\+h\+:
\nopagebreak
Include dependency graph for composition.\+h\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode

2
docs/latex/composition_8h__dep__incl.md5
View File

@@ -1 +1 @@
f753028be113c8a685bf27b27687f870
f3469afed578deb399fd8ce9c11b931b

BIN
docs/latex/composition_8h__dep__incl.pdf
View File

Binary file not shown.

3
docs/latex/composition__abstract_8h.tex
View File

@@ -7,8 +7,7 @@
{\ttfamily \#include $<$set$>$}\newline
{\ttfamily \#include $<$vector$>$}\newline
{\ttfamily \#include $<$memory$>$}\newline
Include dependency graph for composition\+\_\+abstract.\+h\+:
\nopagebreak
Include dependency graph for composition\+\_\+abstract.\+h\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode

2
docs/latex/composition__abstract_8h__dep__incl.md5
View File

@@ -1 +1 @@
7e971f717fe251142da29449cddc17be
a9c7ff290c1454319ae7ae8cd76d1094

BIN
docs/latex/composition__abstract_8h__dep__incl.pdf
View File

Binary file not shown.

3
docs/latex/composition__abstract__iterator_8h.tex
View File

@@ -5,8 +5,7 @@
{\ttfamily \#include $<$utility$>$}\newline
{\ttfamily \#include $<$compare$>$}\newline
{\ttfamily \#include "{}fourdst/atomic/atomic\+Species.\+h"{}}\newline
Include dependency graph for composition\+\_\+abstract\+\_\+iterator.\+h\+:
\nopagebreak
Include dependency graph for composition\+\_\+abstract\+\_\+iterator.\+h\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode

2
docs/latex/composition__abstract__iterator_8h__dep__incl.md5
View File

@@ -1 +1 @@
dfc927cd19d8a3bd6f76a876a37eaa96
037ff31974cd853e12ef8cdfc8a645c9

BIN
docs/latex/composition__abstract__iterator_8h__dep__incl.pdf
View File

Binary file not shown.

6
docs/latex/composition__decorator__abstract_8h.tex
View File

@@ -8,16 +8,14 @@
{\ttfamily \#include $<$unordered\+\_\+map$>$}\newline
{\ttfamily \#include $<$map$>$}\newline
{\ttfamily \#include $<$vector$>$}\newline
Include dependency graph for composition\+\_\+decorator\+\_\+abstract.\+h\+:
\nopagebreak
Include dependency graph for composition\+\_\+decorator\+\_\+abstract.\+h\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{composition__decorator__abstract_8h__incl}
\end{center}
\end{figure}
This graph shows which files directly or indirectly include this file\+:
\nopagebreak
This graph shows which files directly or indirectly include this file\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode

6
docs/latex/composition__hash_8h.tex
View File

@@ -6,16 +6,14 @@
{\ttfamily \#include "{}xxhash64.\+h"{}}\newline
{\ttfamily \#include "{}fourdst/composition/composition.\+h"{}}\newline
{\ttfamily \#include "{}fourdst/composition/composition\+\_\+abstract.\+h"{}}\newline
Include dependency graph for composition\+\_\+hash.\+h\+:
\nopagebreak
Include dependency graph for composition\+\_\+hash.\+h\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{composition__hash_8h__incl}
\end{center}
\end{figure}
This graph shows which files directly or indirectly include this file\+:
\nopagebreak
This graph shows which files directly or indirectly include this file\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode

3
docs/latex/composition__masked_8cpp.tex
View File

@@ -10,8 +10,7 @@
{\ttfamily \#include $<$set$>$}\newline
{\ttfamily \#include $<$unordered\+\_\+map$>$}\newline
{\ttfamily \#include "{}fourdst/composition/utils/composition\+\_\+hash.\+h"{}}\newline
Include dependency graph for composition\+\_\+masked.\+cpp\+:
\nopagebreak
Include dependency graph for composition\+\_\+masked.\+cpp\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode

6
docs/latex/composition__masked_8h.tex
View File

@@ -9,16 +9,14 @@
{\ttfamily \#include "{}fourdst/composition/decorators/composition\+\_\+decorator\+\_\+abstract.\+h"{}}\newline
{\ttfamily \#include "{}fourdst/composition/iterators/composition\+\_\+abstract\+\_\+iterator.\+h"{}}\newline
{\ttfamily \#include "{}fourdst/atomic/atomic\+Species.\+h"{}}\newline
Include dependency graph for composition\+\_\+masked.\+h\+:
\nopagebreak
Include dependency graph for composition\+\_\+masked.\+h\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{composition__masked_8h__incl}
\end{center}
\end{figure}
This graph shows which files directly or indirectly include this file\+:
\nopagebreak
This graph shows which files directly or indirectly include this file\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode

3
docs/latex/dir_3c9efac6790a3720e63e1a08c00d11f2.tex
View File

@@ -1,7 +1,6 @@
\doxysection{src/composition/include/fourdst Directory Reference}
\hypertarget{dir_3c9efac6790a3720e63e1a08c00d11f2}{}\label{dir_3c9efac6790a3720e63e1a08c00d11f2}\index{src/composition/include/fourdst Directory Reference@{src/composition/include/fourdst Directory Reference}}
Directory dependency graph for fourdst\+:
\nopagebreak
Directory dependency graph for fourdst\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode

2
docs/latex/dir_425afc2e69e55565110382214454a15b_dep.md5
View File

@@ -1 +1 @@
cbb0bc2de8bd6a92d31f340065597532
c93f657cd19f49aec9008b5793a30989

BIN
docs/latex/dir_425afc2e69e55565110382214454a15b_dep.pdf
View File

Binary file not shown.

2
docs/latex/dir_7b283a48d434145e2e38921d56a72d33_dep.md5
View File

@@ -1 +1 @@
c11a72866f2a413c20549d349c46527e
68de2cda7d2b1a7e86707246d04e7134

BIN
docs/latex/dir_7b283a48d434145e2e38921d56a72d33_dep.pdf
View File

Binary file not shown.

3
docs/latex/dir_a29dc6a716a1351df2c511dc254c58ac.tex
View File

@@ -1,7 +1,6 @@
\doxysection{src/composition/lib/decorators Directory Reference}
\hypertarget{dir_a29dc6a716a1351df2c511dc254c58ac}{}\label{dir_a29dc6a716a1351df2c511dc254c58ac}\index{src/composition/lib/decorators Directory Reference@{src/composition/lib/decorators Directory Reference}}
Directory dependency graph for decorators\+:
\nopagebreak
Directory dependency graph for decorators\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode

2
docs/latex/dir_d6630bab6c58db28bc1f1c304498b57d.tex
View File

@@ -12,4 +12,6 @@ Directory dependency graph for utils\+:
\begin{DoxyCompactItemize}
\item
file \mbox{\hyperlink{composition__hash_8h}{composition\+\_\+hash.\+h}}
\item
file \mbox{\hyperlink{utils_8h}{utils.\+h}}
\end{DoxyCompactItemize}

2
docs/latex/dir_d6630bab6c58db28bc1f1c304498b57d_dep.md5
View File

@@ -1 +1 @@
4c439b347201ef9ef9135443e1756826
13db7404c9687b2871a906fa8015c146

BIN
docs/latex/dir_d6630bab6c58db28bc1f1c304498b57d_dep.pdf
View File

Binary file not shown.

4
docs/latex/dir_e22a97de167fe22ecd13733f7a34b9f0.tex
View File

@@ -5,13 +5,15 @@ Directory dependency graph for lib\+:
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=236pt]{dir_e22a97de167fe22ecd13733f7a34b9f0_dep}
\includegraphics[width=282pt]{dir_e22a97de167fe22ecd13733f7a34b9f0_dep}
\end{center}
\end{figure}
\doxysubsubsection*{Directories}
\begin{DoxyCompactItemize}
\item
directory \mbox{\hyperlink{dir_a29dc6a716a1351df2c511dc254c58ac}{decorators}}
\item
directory \mbox{\hyperlink{dir_aeed3f99ef4282f6a3002893b78acac3}{io}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Files}
\begin{DoxyCompactItemize}

2
docs/latex/dir_e22a97de167fe22ecd13733f7a34b9f0_dep.md5
View File

@@ -1 +1 @@
9a92c71acd3dc73516c5d1732bef033b
b61d65f02895aaeaa7ff1f4ef1ed26c2

BIN
docs/latex/dir_e22a97de167fe22ecd13733f7a34b9f0_dep.pdf
View File

Binary file not shown.

4
docs/latex/dir_f0fdd83dd0cb4aa6fd6a832374ae4f05.tex
View File

@@ -15,6 +15,8 @@ directory \mbox{\hyperlink{dir_f6270720383943883918701d7c63cf1d}{decorators}}
\item
directory \mbox{\hyperlink{dir_88aa30610c51652b536406602eb05405}{exceptions}}
\item
directory \mbox{\hyperlink{dir_7a41be27ec6d2ed2efa19aa1e866bad1}{io}}
\item
directory \mbox{\hyperlink{dir_7b283a48d434145e2e38921d56a72d33}{iterators}}
\item
directory \mbox{\hyperlink{dir_d6630bab6c58db28bc1f1c304498b57d}{utils}}
@@ -25,6 +27,4 @@ directory \mbox{\hyperlink{dir_d6630bab6c58db28bc1f1c304498b57d}{utils}}
file \mbox{\hyperlink{composition_8h}{composition.\+h}}
\item
file \mbox{\hyperlink{composition__abstract_8h}{composition\+\_\+abstract.\+h}}
\item
file \mbox{\hyperlink{utils_8h}{utils.\+h}}
\end{DoxyCompactItemize}

2
docs/latex/dir_f0fdd83dd0cb4aa6fd6a832374ae4f05_dep.md5
View File

@@ -1 +1 @@
d026f11be29081deadc40174c9198ba0
f1874b10772e70dd52e1884910902ca9

BIN
docs/latex/dir_f0fdd83dd0cb4aa6fd6a832374ae4f05_dep.pdf
View File

Binary file not shown.

2
docs/latex/dir_f6270720383943883918701d7c63cf1d_dep.md5
View File

@@ -1 +1 @@
4eb03276b11cbdbe8a4c798b1bd826a6
fe5267c20fc95e52282de7e8a61d0e5f

BIN
docs/latex/dir_f6270720383943883918701d7c63cf1d_dep.pdf
View File

Binary file not shown.

2
docs/latex/elements_8h__dep__incl.md5
View File

@@ -1 +1 @@
4158811a72f8df9ae6ba17293fe63e2c
b2be1c9cf3dbeeb25cf942f9c9c659a1

BIN
docs/latex/elements_8h__dep__incl.pdf
View File

Binary file not shown.

6
docs/latex/exceptions__composition_8h.tex
View File

@@ -3,16 +3,14 @@
{\ttfamily \#include $<$exception$>$}\newline
{\ttfamily \#include $<$string$>$}\newline
{\ttfamily \#include $<$utility$>$}\newline
Include dependency graph for exceptions\+\_\+composition.\+h\+:
\nopagebreak
Include dependency graph for exceptions\+\_\+composition.\+h\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=254pt]{exceptions__composition_8h__incl}
\end{center}
\end{figure}
This graph shows which files directly or indirectly include this file\+:
\nopagebreak
This graph shows which files directly or indirectly include this file\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode

5
docs/latex/files.tex
View File

@@ -5,13 +5,16 @@ Here is a list of all files with brief descriptions\+:\begin{DoxyCompactList}
\item\contentsline{section}{src/composition/include/fourdst/atomic/\mbox{\hyperlink{species_8h}{species.\+h}} }{\pageref{species_8h}}{}
\item\contentsline{section}{src/composition/include/fourdst/composition/\mbox{\hyperlink{composition_8h}{composition.\+h}} }{\pageref{composition_8h}}{}
\item\contentsline{section}{src/composition/include/fourdst/composition/\mbox{\hyperlink{composition__abstract_8h}{composition\+\_\+abstract.\+h}} }{\pageref{composition__abstract_8h}}{}
\item\contentsline{section}{src/composition/include/fourdst/composition/\mbox{\hyperlink{utils_8h}{utils.\+h}} }{\pageref{utils_8h}}{}
\item\contentsline{section}{src/composition/include/fourdst/composition/decorators/\mbox{\hyperlink{composition__decorator__abstract_8h}{composition\+\_\+decorator\+\_\+abstract.\+h}} }{\pageref{composition__decorator__abstract_8h}}{}
\item\contentsline{section}{src/composition/include/fourdst/composition/decorators/\mbox{\hyperlink{composition__masked_8h}{composition\+\_\+masked.\+h}} }{\pageref{composition__masked_8h}}{}
\item\contentsline{section}{src/composition/include/fourdst/composition/exceptions/\mbox{\hyperlink{exceptions__composition_8h}{exceptions\+\_\+composition.\+h}} }{\pageref{exceptions__composition_8h}}{}
\item\contentsline{section}{src/composition/include/fourdst/composition/io/\mbox{\hyperlink{standard__compositions_8h}{standard\+\_\+compositions.\+h}} }{\pageref{standard__compositions_8h}}{}
\item\contentsline{section}{src/composition/include/fourdst/composition/io/\mbox{\hyperlink{_standard_metal_fractions_binary_8h}{Standard\+Metal\+Fractions\+Binary.\+h}} }{\pageref{_standard_metal_fractions_binary_8h}}{}
\item\contentsline{section}{src/composition/include/fourdst/composition/iterators/\mbox{\hyperlink{composition__abstract__iterator_8h}{composition\+\_\+abstract\+\_\+iterator.\+h}} }{\pageref{composition__abstract__iterator_8h}}{}
\item\contentsline{section}{src/composition/include/fourdst/composition/utils/\mbox{\hyperlink{composition__hash_8h}{composition\+\_\+hash.\+h}} }{\pageref{composition__hash_8h}}{}
\item\contentsline{section}{src/composition/include/fourdst/composition/utils/\mbox{\hyperlink{utils_8h}{utils.\+h}} }{\pageref{utils_8h}}{}
\item\contentsline{section}{src/composition/lib/\mbox{\hyperlink{composition_8cpp}{composition.\+cpp}} }{\pageref{composition_8cpp}}{}
\item\contentsline{section}{src/composition/lib/\mbox{\hyperlink{utils_8cpp}{utils.\+cpp}} }{\pageref{utils_8cpp}}{}
\item\contentsline{section}{src/composition/lib/decorators/\mbox{\hyperlink{composition__masked_8cpp}{composition\+\_\+masked.\+cpp}} }{\pageref{composition__masked_8cpp}}{}
\item\contentsline{section}{src/composition/lib/io/\mbox{\hyperlink{standard__compositions_8cpp}{standard\+\_\+compositions.\+cpp}} }{\pageref{standard__compositions_8cpp}}{}
\end{DoxyCompactList}

3
docs/latex/hierarchy.tex
View File

@@ -2,6 +2,7 @@
This inheritance list is sorted roughly, but not completely, alphabetically\+:\begin{DoxyCompactList}
\item \contentsline{section}{fourdst\+::composition\+::detail\+::Composition\+Iterator\texorpdfstring{$<$}{<} Is\+Const \texorpdfstring{$>$}{>}\+::Arrow\+Proxy}{\pageref{structfourdst_1_1composition_1_1detail_1_1_composition_iterator_1_1_arrow_proxy}}{}
\item \contentsline{section}{fourdst\+::composition\+::Canonical\+Composition}{\pageref{structfourdst_1_1composition_1_1_canonical_composition}}{}
\item \contentsline{section}{fourdst\+::composition\+::io\+::Chemical\+File\+Parser}{\pageref{classfourdst_1_1composition_1_1io_1_1_chemical_file_parser}}{}
\item \contentsline{section}{fourdst\+::composition\+::Composition\+Abstract}{\pageref{classfourdst_1_1composition_1_1_composition_abstract}}{}
\begin{DoxyCompactList}
\item \contentsline{section}{fourdst\+::composition\+::Composition}{\pageref{classfourdst_1_1composition_1_1_composition}}{}
@@ -11,6 +12,7 @@ This inheritance list is sorted roughly, but not completely, alphabetically\+:\b
\end{DoxyCompactList}
\end{DoxyCompactList}
\item \contentsline{section}{fourdst\+::composition\+::Composition\+::Composition\+Cache}{\pageref{structfourdst_1_1composition_1_1_composition_1_1_composition_cache}}{}
\item \contentsline{section}{fourdst\+::composition\+::io\+::Composition\+Data}{\pageref{structfourdst_1_1composition_1_1io_1_1_composition_data}}{}
\item \contentsline{section}{fourdst\+::composition\+::utils\+::Composition\+Hash}{\pageref{structfourdst_1_1composition_1_1utils_1_1_composition_hash}}{}
\item \contentsline{section}{fourdst\+::composition\+::detail\+::Composition\+Iterator\texorpdfstring{$<$}{<} Is\+Const \texorpdfstring{$>$}{>}}{\pageref{classfourdst_1_1composition_1_1detail_1_1_composition_iterator}}{}
\item std\+::exception\begin{DoxyCompactList}
@@ -27,5 +29,6 @@ This inheritance list is sorted roughly, but not completely, alphabetically\+:\b
\item \contentsline{section}{std\+::hash\texorpdfstring{$<$}{<} fourdst\+::atomic\+::Species \texorpdfstring{$>$}{>}}{\pageref{structstd_1_1hash_3_01fourdst_1_1atomic_1_1_species_01_4}}{}
\item \contentsline{section}{std\+::hash\texorpdfstring{$<$}{<} fourdst\+::composition\+::Composition \texorpdfstring{$>$}{>}}{\pageref{structstd_1_1hash_3_01fourdst_1_1composition_1_1_composition_01_4}}{}
\item \contentsline{section}{std\+::hash\texorpdfstring{$<$}{<} fourdst\+::composition\+::Composition\+Abstract \texorpdfstring{$>$}{>}}{\pageref{structstd_1_1hash_3_01fourdst_1_1composition_1_1_composition_abstract_01_4}}{}
\item \contentsline{section}{fourdst\+::composition\+::io\+::Isotopic\+Percentage}{\pageref{structfourdst_1_1composition_1_1io_1_1_isotopic_percentage}}{}
\item \contentsline{section}{fourdst\+::atomic\+::Species}{\pageref{structfourdst_1_1atomic_1_1_species}}{}
\end{DoxyCompactList}

2
docs/latex/index.tex
View File

@@ -115,7 +115,7 @@ Below are focused examples illustrating the current API. All examples assume hea
\begin{DoxyCode}{0}
\DoxyCodeLine{\textcolor{preprocessor}{\#include\ <iostream>}}
\DoxyCodeLine{\textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{utils_8h}{fourdst/composition/utils.h}}"{}}}
\DoxyCodeLine{\textcolor{preprocessor}{\#include\ "{}fourdst/composition/utils.h"{}}}
\DoxyCodeLine{}
\DoxyCodeLine{\textcolor{keywordtype}{int}\ main()\ \{}
\DoxyCodeLine{\ \ \ \ \textcolor{keyword}{using\ namespace\ }\mbox{\hyperlink{namespacefourdst_1_1composition}{fourdst::composition}};}

150
docs/latex/namespacefourdst_1_1composition.tex
View File

@@ -12,6 +12,8 @@ namespace \mbox{\hyperlink{namespacefourdst_1_1composition_1_1detail}{detail}}
\item
namespace \mbox{\hyperlink{namespacefourdst_1_1composition_1_1exceptions}{exceptions}}
\item
namespace \mbox{\hyperlink{namespacefourdst_1_1composition_1_1io}{io}}
\item
namespace \mbox{\hyperlink{namespacefourdst_1_1composition_1_1utils}{utils}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Classes}
@@ -32,6 +34,10 @@ class \mbox{\hyperlink{classfourdst_1_1composition_1_1_masked_composition}{Maske
\item
bool \mbox{\hyperlink{namespacefourdst_1_1composition_a06f5abc74104de40349e47ad367c402a}{operator==}} (const \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition}{Composition}} \&a, const \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition}{Composition}} \&b) noexcept
\item
\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition}{Composition}} \mbox{\hyperlink{namespacefourdst_1_1composition_a708d71303db2fa22c8871f3bfc3d11d4}{get\+\_\+composition\+\_\+record}} (const std\+::string \&metal\+\_\+fraction\+\_\+scheme, const std\+::string \&isotopic\+\_\+percentage\+\_\+scheme, double initial\+\_\+z, double initial\+\_\+y)
\begin{DoxyCompactList}\small\item\em Constructs a stellar {\ttfamily \doxylink{classfourdst_1_1composition_1_1_composition}{Composition}} from a named solar metal-\/fraction scheme and isotopic-\/percentage table, scaled to the supplied bulk hydrogen and helium mass fractions. \end{DoxyCompactList}\item
\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition}{Composition}} \mbox{\hyperlink{namespacefourdst_1_1composition_aad96edce7a144f1d73e62f622f3063de}{get\+\_\+composition\+\_\+record}} (\mbox{\hyperlink{namespacefourdst_1_1composition_1_1io_a2cd2f870d30e26ed92265cb2d74d40d3}{io\+::\+Solar\+Compositions}} metal\+\_\+fraction\+\_\+scheme, \mbox{\hyperlink{namespacefourdst_1_1composition_1_1io_aaaa91e1b71ac0285d0bcdbd5abf4f381}{io\+::\+Isotopic\+Percentages}} isotopic\+\_\+percentage\+\_\+scheme, double initial\+\_\+z, double initial\+\_\+y)
\begin{DoxyCompactList}\small\item\em Enum-\/based overload of {\ttfamily \doxylink{namespacefourdst_1_1composition_a708d71303db2fa22c8871f3bfc3d11d4}{get\+\_\+composition\+\_\+record()}}. \end{DoxyCompactList}\item
\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition}{Composition}} \mbox{\hyperlink{namespacefourdst_1_1composition_aa90b1ef07d607c0c829bedccf381cf54}{build\+Composition\+From\+Mass\+Fractions}} (const std\+::vector$<$ std\+::string $>$ \&symbols, const std\+::vector$<$ double $>$ \&mass\+Fractions)
\begin{DoxyCompactList}\small\item\em Build a \doxylink{classfourdst_1_1composition_1_1_composition}{Composition} object from symbols and their corresponding mass fractions. \end{DoxyCompactList}\item
\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition}{Composition}} \mbox{\hyperlink{namespacefourdst_1_1composition_a39d4f84dfa85ddda3b9feb5dda1afc1e}{build\+Composition\+From\+Mass\+Fractions}} (const std\+::vector$<$ \mbox{\hyperlink{structfourdst_1_1atomic_1_1_species}{atomic\+::\+Species}} $>$ \&species, const std\+::vector$<$ double $>$ \&mass\+Fractions)
@@ -110,7 +116,7 @@ Example 1 – basic construction and queries\+:
Example 2 – constructing from mass fractions\+:
\begin{DoxyCode}{0}
\DoxyCodeLine{\textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{utils_8h}{fourdst/composition/utils.h}}"{}}}
\DoxyCodeLine{\textcolor{preprocessor}{\#include\ "{}fourdst/composition/utils.h"{}}}
\DoxyCodeLine{}
\DoxyCodeLine{std::vector<std::string>\ symbols\ =\ \{\textcolor{stringliteral}{"{}H-\/1"{}},\ \textcolor{stringliteral}{"{}He-\/4"{}},\ \textcolor{stringliteral}{"{}C-\/12"{}}\};}
\DoxyCodeLine{std::vector<double>\ massFractions\ =\ \{0.70,\ 0.28,\ 0.02\};}
@@ -129,7 +135,7 @@ Example 2 – constructing from mass fractions\+:
\item \doxylink{species_8h}{fourdst/atomic/species.\+h} — canonical atomic species definitions and symbols.
\item \doxylink{composition_8h}{fourdst/composition/composition.\+h} — concrete \doxylink{classfourdst_1_1composition_1_1_composition}{Composition} implementation.
\item \doxylink{composition__abstract_8h}{fourdst/composition/composition\+\_\+abstract.\+h} — abstract composition interface.
\item \doxylink{utils_8h}{fourdst/composition/utils.\+h} — helpers for constructing compositions from mass fractions.
\item fourdst/composition/utils.\+h — helpers for constructing compositions from mass fractions.
\end{DoxyItemize}
\doxysubsection{Function Documentation}
@@ -339,6 +345,146 @@ A \doxylink{classfourdst_1_1composition_1_1_composition}{Composition} object con
Definition at line \mbox{\hyperlink{utils_8cpp_source_l00134}{134}} of file \mbox{\hyperlink{utils_8cpp_source}{utils.\+cpp}}.
\Hypertarget{namespacefourdst_1_1composition_a708d71303db2fa22c8871f3bfc3d11d4}\index{fourdst::composition@{fourdst::composition}!get\_composition\_record@{get\_composition\_record}}
\index{get\_composition\_record@{get\_composition\_record}!fourdst::composition@{fourdst::composition}}
\doxysubsubsection{\texorpdfstring{get\_composition\_record()}{get\_composition\_record()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily \label{namespacefourdst_1_1composition_a708d71303db2fa22c8871f3bfc3d11d4}
\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition}{Composition}} fourdst\+::composition\+::get\+\_\+composition\+\_\+record (\begin{DoxyParamCaption}\item[{const std\+::string \&}]{metal\+\_\+fraction\+\_\+scheme}{, }\item[{const std\+::string \&}]{isotopic\+\_\+percentage\+\_\+scheme}{, }\item[{double}]{initial\+\_\+z}{, }\item[{double}]{initial\+\_\+y}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [nodiscard]}}
Constructs a stellar {\ttfamily \doxylink{classfourdst_1_1composition_1_1_composition}{Composition}} from a named solar metal-\/fraction scheme and isotopic-\/percentage table, scaled to the supplied bulk hydrogen and helium mass fractions.
Available metal fraction schemes (extracted from MESA {\ttfamily chem\+\_\+def.\+f90})\+:
\begin{DoxyItemize}
\item {\ttfamily AG89} (Anders \& Grevesse 1989)
\item {\ttfamily GN93} (Grevesse \& Noels 1993)
\item {\ttfamily GS98} (Grevesse \& Sauval 1998)
\item {\ttfamily L03} (Lodders 2003)
\item {\ttfamily AGS05} (Asplund, Grevesse \& Sauval 2005)
\item {\ttfamily AGSS09} (Asplund et al. 2009)
\item {\ttfamily A09\+\_\+\+Przybilla}
\item {\ttfamily MB22\+\_\+photospheric}
\item {\ttfamily AAG21\+\_\+photospheric}
\item {\ttfamily L09} (Lodders 2009)
\end{DoxyItemize}
Available isotopic percentage schemes\+:
\begin{DoxyItemize}
\item {\ttfamily L03\+\_\+data} (Lodders 2003)
\item {\ttfamily L09\+\_\+data} (Lodders 2009)
\end{DoxyItemize}
{\bfseries{Algorithm\+:}}
\begin{DoxyEnumerate}
\item {\bfseries{Data loading}} — The embedded binary {\ttfamily Standard\+Metal\+Fractions} is copied into a {\ttfamily std\+::vector\texorpdfstring{$<$}{<}char\texorpdfstring{$>$}{>}} and parsed twice\+: once for {\ttfamily metal\+\_\+fraction\+\_\+scheme} and once for {\ttfamily isotopic\+\_\+percentage\+\_\+scheme}.
\item {\bfseries{Species list}} — The isotope table is iterated; any isotope whose element appears in the metals list or is {\ttfamily "{}\+H"{}} / {\ttfamily "{}\+He"{}} is looked up in the global {\ttfamily \doxylink{namespacefourdst_1_1atomic_a3f619cc8f8b2cd718a4082c6adb0de90}{atomic\+::species}} registry by {\ttfamily "{}$<$\+Element$>$-\/$<$\+A$>$"{}} and added to the list.
\item {\bfseries{H and He mass fractions}} — Four entries are prepended (H-\/1, H-\/2, He-\/3, He-\/4) using Anders \& Grevesse (1989) solar He3/\+He4 ratio\+:
\begin{DoxyItemize}
\item X(H-\/1) = clamp(1 -\/ Z -\/ Y, 0, 1)
\item X(H-\/2) = 0
\item X(He-\/3) = Y \texorpdfstring{$\ast$}{*} xsol\+\_\+\+He3 / (xsol\+\_\+\+He3 + xsol\+\_\+\+He4)
\item X(He-\/4) = Y \texorpdfstring{$\ast$}{*} xsol\+\_\+\+He4 / (xsol\+\_\+\+He3 + xsol\+\_\+\+He4) where xsol\+\_\+\+He3 = 2.\+9291e-\/5 and xsol\+\_\+\+He4 = 2.\+7521e-\/1.
\end{DoxyItemize}
\item {\bfseries{Atomic-\/weight weighting}} — When {\ttfamily Composition\+Data\+::requires\+\_\+atomic\+\_\+weight} is {\ttfamily true}, each metal\textquotesingle{}s number-\/fraction abundance is multiplied by the atomic mass of its most-\/abundant isotope (determined from the isotopic table).
\item {\bfseries{Normalisation}} — Metal fractions are summed and normalised to unity.
\item {\bfseries{Isotope distribution}} — Per-\/isotope mass fractions are computed as\+: X\+\_\+i = Z\+\_\+total \texorpdfstring{$\ast$}{*} f\+\_\+E \texorpdfstring{$\ast$}{*} (p\+\_\+i \texorpdfstring{$\ast$}{*} m\+\_\+i) / sum\+\_\+j(p\+\_\+j \texorpdfstring{$\ast$}{*} m\+\_\+j) where f\+\_\+E is the normalised metal fraction, p\+\_\+i the isotopic percentage (0-\/100 scale), and m\+\_\+i the isotope\textquotesingle{}s atomic mass.
\item {\bfseries{Renormalisation}} — Metal mass fractions are rescaled so their sum equals Z\+\_\+total exactly.
\item {\bfseries{Assembly}} — {\ttfamily build\+Composition\+From\+Mass\+Fractions(species, mass\+Fracs)} builds the final {\ttfamily \doxylink{classfourdst_1_1composition_1_1_composition}{Composition}} object.
\end{DoxyEnumerate}
\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}} & {\em metal\+\_\+fraction\+\_\+scheme} & Block tag of the desired solar metal composition (e.\+g., {\ttfamily "{}\+GS98"{}}, {\ttfamily "{}\+AGSS09"{}}). Case-\/sensitive; must match a {\ttfamily BEGIN}/{\ttfamily END} tag in the embedded data exactly. \\
\hline
\mbox{\texttt{ in}} & {\em isotopic\+\_\+percentage\+\_\+scheme} & Block tag of the isotopic percentage table (e.\+g., {\ttfamily "{}\+L03\+\_\+data"{}}, {\ttfamily "{}\+L09\+\_\+data"{}}). \\
\hline
\mbox{\texttt{ in}} & {\em initial\+\_\+z} & Total metal mass fraction Z (0 \texorpdfstring{$<$}{<}= Z \texorpdfstring{$<$}{<} 1). \\
\hline
\mbox{\texttt{ in}} & {\em initial\+\_\+y} & Total helium mass fraction Y (0 \texorpdfstring{$<$}{<}= Y \texorpdfstring{$<$}{<} 1, with X + Y + Z \texorpdfstring{$<$}{<}= 1 recommended). X(H-\/1) is clamped to \mbox{[}0, 1\mbox{]} if the constraint is violated.\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
{\ttfamily \doxylink{classfourdst_1_1composition_1_1_composition}{Composition}} Fully populated composition object with per-\/isotope mass fractions normalised to {\ttfamily initial\+\_\+z} and {\ttfamily initial\+\_\+y}.
\end{DoxyReturn}
\begin{DoxyExceptions}{Exceptions}
{\em std\+::out\+\_\+of\+\_\+range} & If a species name derived from the isotopic table is absent from {\ttfamily \doxylink{namespacefourdst_1_1atomic_a3f619cc8f8b2cd718a4082c6adb0de90}{atomic\+::species}}, or if either scheme tag is not present in the embedded data. \\
\hline
{\em std\+::invalid\+\_\+argument} & If numeric fields in the embedded data are malformed (propagated from {\ttfamily std\+::stod} / {\ttfamily std\+::stoi}).\\
\hline
\end{DoxyExceptions}
\begin{DoxyParagraph}{Examples}
\begin{DoxyCode}{0}
\DoxyCodeLine{\textcolor{comment}{//\ Grevesse\ \&\ Sauval\ (1998)\ at\ Z\ =\ 0.02,\ Y\ =\ 0.28}}
\DoxyCodeLine{\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition}{fourdst::composition::Composition}}\ comp\ =}
\DoxyCodeLine{\ \ \ \ \mbox{\hyperlink{namespacefourdst_1_1composition_a708d71303db2fa22c8871f3bfc3d11d4}{fourdst::composition::get\_composition\_record}}(\textcolor{stringliteral}{"{}GS98"{}},\ \textcolor{stringliteral}{"{}L03\_data"{}},\ 0.02,\ 0.28);}
\DoxyCodeLine{}
\DoxyCodeLine{\textcolor{keywordtype}{double}\ x\_h1\ =\ comp.massFraction(\textcolor{stringliteral}{"{}H-\/1"{}});}
\DoxyCodeLine{std::println(\textcolor{stringliteral}{"{}X(H-\/1)\ =\ \{:.6f\}"{}},\ x\_h1);\ \ \textcolor{comment}{//\ approx\ 0.70}}
\end{DoxyCode}
\end{DoxyParagraph}
Definition at line \mbox{\hyperlink{standard__compositions_8cpp_source_l00252}{252}} of file \mbox{\hyperlink{standard__compositions_8cpp_source}{standard\+\_\+compositions.\+cpp}}.
\Hypertarget{namespacefourdst_1_1composition_aad96edce7a144f1d73e62f622f3063de}\index{fourdst::composition@{fourdst::composition}!get\_composition\_record@{get\_composition\_record}}
\index{get\_composition\_record@{get\_composition\_record}!fourdst::composition@{fourdst::composition}}
\doxysubsubsection{\texorpdfstring{get\_composition\_record()}{get\_composition\_record()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily \label{namespacefourdst_1_1composition_aad96edce7a144f1d73e62f622f3063de}
\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition}{Composition}} fourdst\+::composition\+::get\+\_\+composition\+\_\+record (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{namespacefourdst_1_1composition_1_1io_a2cd2f870d30e26ed92265cb2d74d40d3}{io\+::\+Solar\+Compositions}}}]{metal\+\_\+fraction\+\_\+scheme}{, }\item[{\mbox{\hyperlink{namespacefourdst_1_1composition_1_1io_aaaa91e1b71ac0285d0bcdbd5abf4f381}{io\+::\+Isotopic\+Percentages}}}]{isotopic\+\_\+percentage\+\_\+scheme}{, }\item[{double}]{initial\+\_\+z}{, }\item[{double}]{initial\+\_\+y}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [nodiscard]}}
Enum-\/based overload of {\ttfamily \doxylink{namespacefourdst_1_1composition_a708d71303db2fa22c8871f3bfc3d11d4}{get\+\_\+composition\+\_\+record()}}.
Translates strongly-\/typed enum values to their canonical string representations via {\ttfamily Solar\+Compositions\+\_\+to\+\_\+string\+\_\+map} and {\ttfamily Isotopic\+Percentages\+\_\+to\+\_\+string\+\_\+map}, then delegates to the string-\/based overload. This overload is preferred as it prevents scheme name typos.
\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}} & {\em metal\+\_\+fraction\+\_\+scheme} & Enum identifying the desired solar metal composition (e.\+g., {\ttfamily Solar\+Compositions\+::\+GS98}). \\
\hline
\mbox{\texttt{ in}} & {\em isotopic\+\_\+percentage\+\_\+scheme} & Enum identifying the isotopic percentage table (e.\+g., {\ttfamily Isotopic\+Percentages\+::\+L03}). \\
\hline
\mbox{\texttt{ in}} & {\em initial\+\_\+z} & Total metal mass fraction Z (0 \texorpdfstring{$<$}{<}= Z \texorpdfstring{$<$}{<} 1). \\
\hline
\mbox{\texttt{ in}} & {\em initial\+\_\+y} & Total helium mass fraction Y (0 \texorpdfstring{$<$}{<}= Y \texorpdfstring{$<$}{<} 1).\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
{\ttfamily \doxylink{classfourdst_1_1composition_1_1_composition}{Composition}} Fully populated composition; see the string-\/based overload for the complete algorithm description.
\end{DoxyReturn}
\begin{DoxyExceptions}{Exceptions}
{\em std\+::out\+\_\+of\+\_\+range} & If the enum value is absent from its lookup map (should not occur with valid named enum members).\\
\hline
\end{DoxyExceptions}
\begin{DoxyParagraph}{Examples}
\begin{DoxyCode}{0}
\DoxyCodeLine{\textcolor{keyword}{using\ namespace\ }\mbox{\hyperlink{namespacefourdst_1_1composition}{fourdst::composition}};}
\DoxyCodeLine{\textcolor{keyword}{using\ namespace\ }\mbox{\hyperlink{namespacefourdst_1_1composition_1_1io}{fourdst::composition::io}};}
\DoxyCodeLine{}
\DoxyCodeLine{\textcolor{comment}{//\ Asplund\ et\ al.\ (2009)\ at\ proto-\/solar\ Z\ and\ Y}}
\DoxyCodeLine{\mbox{\hyperlink{classfourdst_1_1composition_1_1_composition}{Composition}}\ comp\ =\ \mbox{\hyperlink{namespacefourdst_1_1composition_a708d71303db2fa22c8871f3bfc3d11d4}{get\_composition\_record}}(}
\DoxyCodeLine{\ \ \ \ \mbox{\hyperlink{namespacefourdst_1_1composition_1_1io_a2cd2f870d30e26ed92265cb2d74d40d3a17c7e97c4d885537aac6da32b91d47ee}{SolarCompositions::AGSS09}},}
\DoxyCodeLine{\ \ \ \ \mbox{\hyperlink{namespacefourdst_1_1composition_1_1io_aaaa91e1b71ac0285d0bcdbd5abf4f381af205819a717ff6a23ec8e04854f3d9bb}{IsotopicPercentages::L09}},}
\DoxyCodeLine{\ \ \ \ 0.0134,\ 0.2485}
\DoxyCodeLine{);}
\DoxyCodeLine{}
\DoxyCodeLine{\textcolor{keywordtype}{double}\ x\_he4\ =\ comp.massFraction(\textcolor{stringliteral}{"{}He-\/4"{}});}
\DoxyCodeLine{std::println(\textcolor{stringliteral}{"{}X(He-\/4)\ =\ \{:.6f\}"{}},\ x\_he4);}
\end{DoxyCode}
\end{DoxyParagraph}
Definition at line \mbox{\hyperlink{standard__compositions_8cpp_source_l00390}{390}} of file \mbox{\hyperlink{standard__compositions_8cpp_source}{standard\+\_\+compositions.\+cpp}}.
\Hypertarget{namespacefourdst_1_1composition_adcc2e4ca25ab7b93983730fc78f4deea}\index{fourdst::composition@{fourdst::composition}!getSpecies@{getSpecies}}
\index{getSpecies@{getSpecies}!fourdst::composition@{fourdst::composition}}
\doxysubsubsection{\texorpdfstring{getSpecies()}{getSpecies()}}

1
docs/latex/namespaces.tex
View File

@@ -5,5 +5,6 @@ Here is a list of all namespaces with brief descriptions\+:\begin{DoxyCompactLis
\item\contentsline{section}{\mbox{\hyperlink{namespacefourdst_1_1composition}{fourdst\+::composition}} \\*Utilities and types for representing and manipulating chemical compositions }{\pageref{namespacefourdst_1_1composition}}{}
\item\contentsline{section}{\mbox{\hyperlink{namespacefourdst_1_1composition_1_1detail}{fourdst\+::composition\+::detail}} }{\pageref{namespacefourdst_1_1composition_1_1detail}}{}
\item\contentsline{section}{\mbox{\hyperlink{namespacefourdst_1_1composition_1_1exceptions}{fourdst\+::composition\+::exceptions}} }{\pageref{namespacefourdst_1_1composition_1_1exceptions}}{}
\item\contentsline{section}{\mbox{\hyperlink{namespacefourdst_1_1composition_1_1io}{fourdst\+::composition\+::io}} }{\pageref{namespacefourdst_1_1composition_1_1io}}{}
\item\contentsline{section}{\mbox{\hyperlink{namespacefourdst_1_1composition_1_1utils}{fourdst\+::composition\+::utils}} }{\pageref{namespacefourdst_1_1composition_1_1utils}}{}
\end{DoxyCompactList}

16
docs/latex/refman.tex
View File

@@ -220,7 +220,7 @@
\vspace*{7cm}
\begin{center}%
{\Large fourdst\+::libcomposition}\\
[1ex]\large v2.\+3.\+1 \\
[1ex]\large v2.\+4.\+9 \\
\vspace*{1cm}
{\large Generated by Doxygen 1.13.2}\\
\end{center}
@@ -250,15 +250,18 @@
\input{namespacefourdst_1_1composition}
\input{namespacefourdst_1_1composition_1_1detail}
\input{namespacefourdst_1_1composition_1_1exceptions}
\input{namespacefourdst_1_1composition_1_1io}
\input{namespacefourdst_1_1composition_1_1utils}
\chapter{Concept Documentation}
\input{conceptfourdst_1_1composition_1_1utils_1_1_composition_type}
\chapter{Class Documentation}
\input{structfourdst_1_1composition_1_1detail_1_1_composition_iterator_1_1_arrow_proxy}
\input{structfourdst_1_1composition_1_1_canonical_composition}
\input{classfourdst_1_1composition_1_1io_1_1_chemical_file_parser}
\input{classfourdst_1_1composition_1_1_composition}
\input{classfourdst_1_1composition_1_1_composition_abstract}
\input{structfourdst_1_1composition_1_1_composition_1_1_composition_cache}
\input{structfourdst_1_1composition_1_1io_1_1_composition_data}
\input{classfourdst_1_1composition_1_1_composition_decorator}
\input{classfourdst_1_1composition_1_1exceptions_1_1_composition_error}
\input{structfourdst_1_1composition_1_1utils_1_1_composition_hash}
@@ -267,6 +270,7 @@
\input{structstd_1_1hash_3_01fourdst_1_1composition_1_1_composition_01_4}
\input{structstd_1_1hash_3_01fourdst_1_1composition_1_1_composition_abstract_01_4}
\input{classfourdst_1_1composition_1_1exceptions_1_1_invalid_composition_error}
\input{structfourdst_1_1composition_1_1io_1_1_isotopic_percentage}
\input{classfourdst_1_1composition_1_1_masked_composition}
\input{structfourdst_1_1atomic_1_1_species}
\input{classfourdst_1_1composition_1_1exceptions_1_1_species_error}
@@ -292,16 +296,22 @@
\input{composition__masked_8h_source}
\input{exceptions__composition_8h}
\input{exceptions__composition_8h_source}
\input{standard__compositions_8h}
\input{standard__compositions_8h_source}
\input{_standard_metal_fractions_binary_8h}
\input{_standard_metal_fractions_binary_8h_source}
\input{composition__abstract__iterator_8h}
\input{composition__abstract__iterator_8h_source}
\input{utils_8h}
\input{utils_8h_source}
\input{composition__hash_8h}
\input{composition__hash_8h_source}
\input{utils_8h}
\input{utils_8h_source}
\input{composition_8cpp}
\input{composition_8cpp_source}
\input{composition__masked_8cpp}
\input{composition__masked_8cpp_source}
\input{standard__compositions_8cpp}
\input{standard__compositions_8cpp_source}
\input{utils_8cpp}
\input{utils_8cpp_source}
%--- End generated contents ---

3
docs/latex/species_8h.tex
View File

@@ -7,8 +7,7 @@
{\ttfamily \#include "{}fourdst/atomic/atomic\+Species.\+h"{}}\newline
{\ttfamily \#include "{}elements.\+h"{}}\newline
{\ttfamily \#include $<$expected$>$}\newline
Include dependency graph for species.\+h\+:
\nopagebreak
Include dependency graph for species.\+h\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode

2
docs/latex/species_8h__dep__incl.md5
View File

@@ -1 +1 @@
f05edddf61eb6037fea279ab93f10764
89d941b4c6335d870c26eee69980fa50

BIN
docs/latex/species_8h__dep__incl.pdf
View File

Binary file not shown.

3
docs/latex/structfourdst_1_1composition_1_1detail_1_1_composition_iterator_1_1_arrow_proxy.tex
View File

@@ -6,8 +6,7 @@
Collaboration diagram for fourdst\+::composition\+::detail\+::Composition\+Iterator\texorpdfstring{$<$}{<} Is\+Const \texorpdfstring{$>$}{>}\+::Arrow\+Proxy\+:
\nopagebreak
Collaboration diagram for fourdst\+::composition\+::detail\+::Composition\+Iterator\texorpdfstring{$<$}{<} Is\+Const \texorpdfstring{$>$}{>}\+::Arrow\+Proxy\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode

2
docs/latex/utils_8cpp.tex
View File

@@ -4,7 +4,7 @@
{\ttfamily \#include "{}fourdst/composition/exceptions/exceptions\+\_\+composition.\+h"{}}\newline
{\ttfamily \#include "{}fourdst/atomic/atomic\+Species.\+h"{}}\newline
{\ttfamily \#include "{}fourdst/atomic/species.\+h"{}}\newline
{\ttfamily \#include "{}fourdst/composition/utils.\+h"{}}\newline
{\ttfamily \#include "{}../include/fourdst/composition/utils/utils.\+h"{}}\newline
{\ttfamily \#include "{}fourdst/logging/logging.\+h"{}}\newline
{\ttfamily \#include $<$numeric$>$}\newline
{\ttfamily \#include $<$ranges$>$}\newline

2
docs/latex/utils_8cpp__incl.md5
View File

@@ -1 +1 @@
ca78127802f2e98eb3d002c6c6305e0c
8e0ffd609b65a55d7b4a325a71f4a167

BIN
docs/latex/utils_8cpp__incl.pdf
View File

Binary file not shown.

2
docs/latex/utils_8cpp_source.tex
View File

@@ -6,7 +6,7 @@
\DoxyCodeLine{\Hypertarget{utils_8cpp_source_l00002}00002\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{exceptions__composition_8h}{fourdst/composition/exceptions/exceptions\_composition.h}}"{}}}
\DoxyCodeLine{\Hypertarget{utils_8cpp_source_l00003}00003\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{atomic_species_8h}{fourdst/atomic/atomicSpecies.h}}"{}}}
\DoxyCodeLine{\Hypertarget{utils_8cpp_source_l00004}00004\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{species_8h}{fourdst/atomic/species.h}}"{}}}
\DoxyCodeLine{\Hypertarget{utils_8cpp_source_l00005}00005\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{utils_8h}{fourdst/composition/utils.h}}"{}}}
\DoxyCodeLine{\Hypertarget{utils_8cpp_source_l00005}00005\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{utils_8h}{../include/fourdst/composition/utils/utils.h}}"{}}}
\DoxyCodeLine{\Hypertarget{utils_8cpp_source_l00006}00006\ \textcolor{preprocessor}{\#include\ "{}fourdst/logging/logging.h"{}}}
\DoxyCodeLine{\Hypertarget{utils_8cpp_source_l00007}00007\ }
\DoxyCodeLine{\Hypertarget{utils_8cpp_source_l00008}00008\ \textcolor{preprocessor}{\#include\ <numeric>}}

6
docs/latex/utils_8h.tex
View File

@@ -1,5 +1,5 @@
\doxysection{src/composition/include/fourdst/composition/utils.h File Reference}
\hypertarget{utils_8h}{}\label{utils_8h}\index{src/composition/include/fourdst/composition/utils.h@{src/composition/include/fourdst/composition/utils.h}}
\doxysection{src/composition/include/fourdst/composition/utils/utils.h File Reference}
\hypertarget{utils_8h}{}\label{utils_8h}\index{src/composition/include/fourdst/composition/utils/utils.h@{src/composition/include/fourdst/composition/utils/utils.h}}
{\ttfamily \#include "{}fourdst/composition/composition.\+h"{}}\newline
{\ttfamily \#include "{}fourdst/atomic/atomic\+Species.\+h"{}}\newline
{\ttfamily \#include $<$vector$>$}\newline
@@ -18,7 +18,7 @@ This graph shows which files directly or indirectly include this file\+:
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=294pt]{utils_8h__dep__incl}
\includegraphics[width=350pt]{utils_8h__dep__incl}
\end{center}
\end{figure}
\doxysubsubsection*{Namespaces}

2
docs/latex/utils_8h__dep__incl.md5
View File

@@ -1 +1 @@
29d7a199f1d1a37e0b9640fdde5939c2
6647a26a0701afd027377a49d9d6ca27

BIN
docs/latex/utils_8h__dep__incl.pdf
View File

Binary file not shown.

2
docs/latex/utils_8h__incl.md5
View File

@@ -1 +1 @@
6e32a11e3343f3197f2af7e651739b8a
a8309239a8fd0afb022d51ca99c16748

BIN
docs/latex/utils_8h__incl.pdf
View File

Binary file not shown.

2
docs/latex/utils_8h_source.tex
View File

@@ -1,5 +1,5 @@
\doxysection{utils.\+h}
\hypertarget{utils_8h_source}{}\label{utils_8h_source}\index{src/composition/include/fourdst/composition/utils.h@{src/composition/include/fourdst/composition/utils.h}}
\hypertarget{utils_8h_source}{}\label{utils_8h_source}\index{src/composition/include/fourdst/composition/utils/utils.h@{src/composition/include/fourdst/composition/utils/utils.h}}
\mbox{\hyperlink{utils_8h}{Go to the documentation of this file.}}
\begin{DoxyCode}{0}
\DoxyCodeLine{\Hypertarget{utils_8h_source_l00001}00001\ \textcolor{preprocessor}{\#pragma\ once}}