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

docs(docs): added robust docs

Browse Source
This commit is contained in:
Emily Boudreaux
2025-07-24 09:35:52 -04:00
parent 1905e642ab
commit 9f5ef7fd6a
452 changed files with 578689 additions and 218 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
docs/latex/composition_8h.tex Normal file
View File

@@ -0,0 +1,27 @@
\doxysection{src/composition/include/fourdst/composition/composition.h File Reference}
\hypertarget{composition_8h}{}\label{composition_8h}\index{src/composition/include/fourdst/composition/composition.h@{src/composition/include/fourdst/composition/composition.h}}
{\ttfamily \#include $<$string$>$}\newline
{\ttfamily \#include $<$unordered\+\_\+map$>$}\newline
{\ttfamily \#include $<$set$>$}\newline
{\ttfamily \#include $<$utility$>$}\newline
{\ttfamily \#include "{}fourdst/config/config.\+h"{}}\newline
{\ttfamily \#include "{}fourdst/logging/logging.\+h"{}}\newline
{\ttfamily \#include "{}fourdst/composition/atomic\+Species.\+h"{}}\newline
\doxysubsubsection*{Classes}
\begin{DoxyCompactItemize}
\item
struct \mbox{\hyperlink{structfourdst_1_1composition_1_1_canonical_composition}{fourdst\+::composition\+::\+Canonical\+Composition}}
\begin{DoxyCompactList}\small\item\em Represents the canonical (X, Y, Z) composition of stellar material. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structfourdst_1_1composition_1_1_global_composition}{fourdst\+::composition\+::\+Global\+Composition}}
\begin{DoxyCompactList}\small\item\em Represents global properties of a finalized composition. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structfourdst_1_1composition_1_1_composition_entry}{fourdst\+::composition\+::\+Composition\+Entry}}
\begin{DoxyCompactList}\small\item\em Represents a single entry (an isotope) within a composition. \end{DoxyCompactList}\item
class \mbox{\hyperlink{classfourdst_1_1composition_1_1_composition}{fourdst\+::composition\+::\+Composition}}
\begin{DoxyCompactList}\small\item\em Manages a collection of chemical species and their abundances. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsubsection*{Namespaces}
\begin{DoxyCompactItemize}
\item
namespace \mbox{\hyperlink{namespacefourdst}{fourdst}}
\item
namespace \mbox{\hyperlink{namespacefourdst_1_1composition}{fourdst\+::composition}}
\end{DoxyCompactItemize}