Emily Boudreaux
6b57738330
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)
54 lines
4.4 KiB
TeX
54 lines
4.4 KiB
TeX
\doxysection{src/include/serif/model/normalization/reference.hpp File Reference}
|
||
\hypertarget{reference_8hpp}{}\label{reference_8hpp}\index{src/include/serif/model/normalization/reference.hpp@{src/include/serif/model/normalization/reference.hpp}}
|
||
{\ttfamily \#include $<$utility$>$}\newline
|
||
{\ttfamily \#include "{}serif/model/description.\+hpp"{}}\newline
|
||
{\ttfamily \#include "{}serif/solver/normalization/configuration.\+hpp"{}}\newline
|
||
Include dependency graph for reference.\+hpp\+:
|
||
\nopagebreak
|
||
\begin{figure}[H]
|
||
\begin{center}
|
||
\leavevmode
|
||
\includegraphics[width=350pt]{reference_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]{reference_8hpp__dep__incl}
|
||
\end{center}
|
||
\end{figure}
|
||
\doxysubsubsection*{Namespaces}
|
||
\begin{DoxyCompactItemize}
|
||
\item
|
||
namespace \mbox{\hyperlink{namespaceserif}{serif}}
|
||
\item
|
||
namespace \mbox{\hyperlink{namespaceserif_1_1model}{serif\+::model}}
|
||
\item
|
||
namespace \mbox{\hyperlink{namespaceserif_1_1model_1_1normalization}{serif\+::model\+::normalization}}
|
||
\item
|
||
namespace \mbox{\hyperlink{namespaceserif_1_1model_1_1normalization_1_1detail}{serif\+::model\+::normalization\+::detail}}
|
||
\end{DoxyCompactItemize}
|
||
\doxysubsubsection*{Concepts}
|
||
\begin{DoxyCompactItemize}
|
||
\item
|
||
concept \mbox{\hyperlink{conceptserif_1_1model_1_1normalization_1_1detail_1_1_reference_available}{serif\+::model\+::normalization\+::detail\+::\+Reference\+Available}}
|
||
\begin{DoxyCompactList}\small\item\em Explicit reference values take precedence over model defaults without changing physical prescriptions. \end{DoxyCompactList}\item
|
||
concept \mbox{\hyperlink{conceptserif_1_1model_1_1normalization_1_1_reference_resolvable}{serif\+::model\+::normalization\+::\+Reference\+Resolvable}}
|
||
\begin{DoxyCompactList}\small\item\em Check model-\/provided reference requirements before instantiating numerical preparation. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||
\doxysubsubsection*{Functions}
|
||
\begin{DoxyCompactItemize}
|
||
\item
|
||
{\footnotesize template$<$typename Specification, typename Source, typename Model$>$ \newline
|
||
requires Reference\+Available$<$Source, Model, Specification$>$}\\auto \mbox{\hyperlink{namespaceserif_1_1model_1_1normalization_1_1detail_a4c0c897486c2e9e5b4307759881cf885}{serif\+::model\+::normalization\+::detail\+::reference\+\_\+value}} (const Source \&source, const Model \&model)
|
||
\begin{DoxyCompactList}\small\item\em Resolve a typed reference source only when its model default is available. \end{DoxyCompactList}\item
|
||
{\footnotesize template$<$typename Mass, typename Density, Stellar\+Model\+Type Model$>$ \newline
|
||
requires detail\+::\+Reference\+Available$<$Mass, Model, \mbox{\hyperlink{classserif_1_1model_1_1_fixed_total_mass}{Fixed\+Total\+Mass}}$>$ \&\& std\+::same\+\_\+as$<$Density, \mbox{\hyperlink{namespaceserif_1_1dimensions_af7f8c68a704a7bf475c60dbad5f98d78}{dimensions\+::\+Density\+Value}}$>$}\\auto \mbox{\hyperlink{namespaceserif_1_1model_1_1normalization_aad8500244bb5debae8de93881311505c}{serif\+::model\+::normalization\+::resolve\+\_\+reference}} (const \mbox{\hyperlink{structserif_1_1solver_1_1normalization_1_1_lane_emden_approximation}{solver\+::normalization\+::\+Lane\+Emden\+Approximation}}$<$ Mass, Density $>$ \&scheme, const Model \&model)
|
||
\begin{DoxyCompactList}\small\item\em Resolve the Lane–\+Emden reference from explicit inputs or the model\textquotesingle{}s mass target; no model prescribes central density. \end{DoxyCompactList}\item
|
||
{\footnotesize template$<$solver\+::normalization\+::\+Reference\+Scheme Scheme, Stellar\+Model\+Type Model$>$ }\\Scheme \mbox{\hyperlink{namespaceserif_1_1model_1_1normalization_af1f75aeb12a566859ea4dbd2ed52cdc4}{serif\+::model\+::normalization\+::resolve\+\_\+reference}} (const Scheme \&scheme, const Model \&)
|
||
\begin{DoxyCompactList}\small\item\em Explicit or custom reference schemes need no model-\/specific defaults. \end{DoxyCompactList}\item
|
||
{\footnotesize template$<$typename Options, Stellar\+Model\+Type Model$>$ \newline
|
||
requires Reference\+Resolvable$<$Options, Model$>$}\\auto \mbox{\hyperlink{namespaceserif_1_1model_1_1normalization_a1ed5daad7a452214875d436c7ae8f289}{serif\+::model\+::normalization\+::resolve\+\_\+configuration}} (Options options, const Model \&model)
|
||
\begin{DoxyCompactList}\small\item\em Freeze resolved reference choices while retaining the deduced coordinate and plan types. \end{DoxyCompactList}\end{DoxyCompactItemize}
|