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,49 @@
\doxysection{src/include/serif/solver/normalization/scales.hpp File Reference}
\hypertarget{scales_8hpp}{}\label{scales_8hpp}\index{src/include/serif/solver/normalization/scales.hpp@{src/include/serif/solver/normalization/scales.hpp}}
{\ttfamily \#include $<$cmath$>$}\newline
{\ttfamily \#include $<$concepts$>$}\newline
{\ttfamily \#include $<$expected$>$}\newline
{\ttfamily \#include $<$string$>$}\newline
{\ttfamily \#include "{}serif/dimensions/dimensions.\+hpp"{}}\newline
Include dependency graph for scales.\+hpp\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{scales_8hpp__incl}
\end{center}
\end{figure}
This graph shows which files directly or indirectly include this file\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{scales_8hpp__dep__incl}
\end{center}
\end{figure}
\doxysubsubsection*{Classes}
\begin{DoxyCompactItemize}
\item
struct \mbox{\hyperlink{structserif_1_1solver_1_1normalization_1_1_stellar_reference_scales}{serif\+::solver\+::normalization\+::\+Stellar\+Reference\+Scales}}
\begin{DoxyCompactList}\small\item\em Fixed reference scales used throughout a solve, independent of its candidate state. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsubsection*{Namespaces}
\begin{DoxyCompactItemize}
\item
namespace \mbox{\hyperlink{namespaceserif}{serif}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1solver}{serif\+::solver}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1solver_1_1normalization}{serif\+::solver\+::normalization}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Concepts}
\begin{DoxyCompactItemize}
\item
concept \mbox{\hyperlink{conceptserif_1_1solver_1_1normalization_1_1_stellar_scale_quantity}{serif\+::solver\+::normalization\+::\+Stellar\+Scale\+Quantity}}
\begin{DoxyCompactList}\small\item\em Quantities whose characteristic scales follow from reference mass, radius, and G alone. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsubsection*{Functions}
\begin{DoxyCompactItemize}
\item
std\+::expected$<$ \mbox{\hyperlink{structserif_1_1solver_1_1normalization_1_1_stellar_reference_scales}{Stellar\+Reference\+Scales}}, std\+::string $>$ \mbox{\hyperlink{namespaceserif_1_1solver_1_1normalization_ae1f83b0a78860b4a776e9aeca1641e87}{serif\+::solver\+::normalization\+::prepare\+\_\+stellar\+\_\+reference\+\_\+scales}} (\mbox{\hyperlink{classserif_1_1dimensions_1_1_quantity_value}{dimensions\+::\+Quantity\+Value}}$<$ \mbox{\hyperlink{structserif_1_1dimensions_1_1_mass}{dimensions\+::\+Mass}} $>$ mass, \mbox{\hyperlink{classserif_1_1dimensions_1_1_quantity_value}{dimensions\+::\+Quantity\+Value}}$<$ \mbox{\hyperlink{structserif_1_1dimensions_1_1_length}{dimensions\+::\+Length}} $>$ radius, \mbox{\hyperlink{classserif_1_1dimensions_1_1_quantity_value}{dimensions\+::\+Quantity\+Value}}$<$ \mbox{\hyperlink{structserif_1_1dimensions_1_1_gravitational_constant}{dimensions\+::\+Gravitational\+Constant}} $>$ gravitational\+\_\+constant=\mbox{\hyperlink{classserif_1_1dimensions_1_1_quantity_value}{dimensions\+::\+Quantity\+Value}}$<$ \mbox{\hyperlink{structserif_1_1dimensions_1_1_gravitational_constant}{dimensions\+::\+Gravitational\+Constant}} $>$\{1.\+0\})
\begin{DoxyCompactList}\small\item\em Derive gravitational stellar scales from a finite, positive reference mass, radius, and G. \end{DoxyCompactList}\item
{\footnotesize template$<$Stellar\+Scale\+Quantity Quantity$>$ }\\\mbox{\hyperlink{classserif_1_1dimensions_1_1_quantity_value}{dimensions\+::\+Quantity\+Value}}$<$ Quantity $>$ \mbox{\hyperlink{namespaceserif_1_1solver_1_1normalization_a74d0b96b4c77b8bb83c994bb15152cf8}{serif\+::solver\+::normalization\+::characteristic\+\_\+scale}} (const \mbox{\hyperlink{structserif_1_1solver_1_1normalization_1_1_stellar_reference_scales}{Stellar\+Reference\+Scales}} \&scales, Quantity)
\begin{DoxyCompactList}\small\item\em Select a typed scale; temperature and other unrelated quantities require an explicit prescription. \end{DoxyCompactList}\end{DoxyCompactItemize}