docs(docs): built docs

Note for now much of the docs is LLM written. This was done to save time and focus on code development. The docs have been LOOSLEY reviewed. However, the code itself has been either fully written by hand or fully reviewed. Therefore, the docs should at the moment be seen as a loose resource rather than authoratiative (and this is on top of the general ability for docs to drift)
This commit is contained in:
2026-11-09 14:09:44 -05:00
parent d9c4919477
commit 6b57738330
32596 changed files with 4155414 additions and 0 deletions

View File

@@ -0,0 +1,56 @@
\doxysection{serif\+::dimensions\+::Opacity Struct Reference}
\hypertarget{structserif_1_1dimensions_1_1_opacity}{}\label{structserif_1_1dimensions_1_1_opacity}\index{serif::dimensions::Opacity@{serif::dimensions::Opacity}}
Dimension of \doxylink{structserif_1_1dimensions_1_1_opacity}{Opacity}.
{\ttfamily \#include $<$dimensions.\+hpp$>$}
Inheritance diagram for serif\+::dimensions\+::Opacity\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=176pt]{structserif_1_1dimensions_1_1_opacity__inherit__graph}
\end{center}
\end{figure}
Collaboration diagram for serif\+::dimensions\+::Opacity\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=294pt]{structserif_1_1dimensions_1_1_opacity__coll__graph}
\end{center}
\end{figure}
\doxysubsubsection*{Static Public Attributes}
\begin{DoxyCompactItemize}
\item
static constexpr std\+::string\+\_\+view \mbox{\hyperlink{structserif_1_1dimensions_1_1_opacity_aef17391180e20786f46cc2015608d084}{identifier}} = "{}opacity"{}
\end{DoxyCompactItemize}
\doxysubsection{Detailed Description}
Dimension of \doxylink{structserif_1_1dimensions_1_1_opacity}{Opacity}.
\begin{DoxyNote}{Note}
we are not currently using this in the code since we are still using a polytropic eos. However, when we actually get to using this we will likely want to break this out into more specific and meaningful opacity dimensions (RMO, per unit wavelength, etc...)
\end{DoxyNote}
\doxysubsection{Member Data Documentation}
\Hypertarget{structserif_1_1dimensions_1_1_opacity_aef17391180e20786f46cc2015608d084}\index{serif::dimensions::Opacity@{serif::dimensions::Opacity}!identifier@{identifier}}
\index{identifier@{identifier}!serif::dimensions::Opacity@{serif::dimensions::Opacity}}
\doxysubsubsection{\texorpdfstring{identifier}{identifier}}
{\footnotesize\ttfamily \label{structserif_1_1dimensions_1_1_opacity_aef17391180e20786f46cc2015608d084}
std\+::string\+\_\+view serif\+::dimensions\+::\+Opacity\+::identifier = "{}opacity"{}\hspace{0.3cm}{\ttfamily [static]}, {\ttfamily [constexpr]}}
The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize}
\item
src/include/serif/dimensions/\mbox{\hyperlink{dimensions_8hpp}{dimensions.\+hpp}}\end{DoxyCompactItemize}