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,83 @@
\doxysection{src/include/serif/solver/continuation/family.hpp File Reference}
\hypertarget{family_8hpp}{}\label{family_8hpp}\index{src/include/serif/solver/continuation/family.hpp@{src/include/serif/solver/continuation/family.hpp}}
{\ttfamily \#include $<$algorithm$>$}\newline
{\ttfamily \#include $<$cmath$>$}\newline
{\ttfamily \#include $<$functional$>$}\newline
{\ttfamily \#include $<$limits$>$}\newline
{\ttfamily \#include $<$optional$>$}\newline
{\ttfamily \#include $<$tuple$>$}\newline
{\ttfamily \#include $<$utility$>$}\newline
{\ttfamily \#include $<$vector$>$}\newline
{\ttfamily \#include "{}serif/solver/continuation/parameters.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/model/stellar\+\_\+model.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/utils/error/errors.\+hpp"{}}\newline
Include dependency graph for family.\+hpp\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{family_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]{family_8hpp__dep__incl}
\end{center}
\end{figure}
\doxysubsubsection*{Classes}
\begin{DoxyCompactItemize}
\item
struct \mbox{\hyperlink{structserif_1_1solver_1_1continuation_1_1_parameter_law}{serif\+::solver\+::continuation\+::\+Parameter\+Law$<$ Output, Dependencies, Function $>$}}
\item
struct \mbox{\hyperlink{structserif_1_1solver_1_1continuation_1_1detail_1_1_contained_3_01_parameter_list_3_01_parameterad20030d35747949989b5cceaad3ac98}{serif\+::solver\+::continuation\+::detail\+::\+Contained$<$ Parameter\+List$<$ Parameters... $>$, Superset $>$}}
\item
struct \mbox{\hyperlink{structserif_1_1solver_1_1continuation_1_1detail_1_1_family_traits_3_01_parameter_list_3_01_seleca84d4a2e97805079c11da47f93a933f9}{serif\+::solver\+::continuation\+::detail\+::\+Family\+Traits$<$ Parameter\+List$<$ Selected... $>$, std\+::tuple$<$ Laws... $>$ $>$}}
\item
struct \mbox{\hyperlink{structserif_1_1solver_1_1continuation_1_1detail_1_1_all_identified_3_01utils_1_1types_1_1_type_l25fb8683eeff2665fdc6fb6dfdadefac}{serif\+::solver\+::continuation\+::detail\+::\+All\+Identified$<$ utils\+::types\+::\+Type\+List$<$ Specifications... $>$ $>$}}
\item
struct \mbox{\hyperlink{structserif_1_1solver_1_1continuation_1_1detail_1_1_copy_equations}{serif\+::solver\+::continuation\+::detail\+::\+Copy\+Equations}}
\item
class \mbox{\hyperlink{classserif_1_1solver_1_1continuation_1_1_bound_family_3_01_model_00_01_parameter_list_3_01_selec59bdc15c834ea037ddf5937bdf68e98f}{serif\+::solver\+::continuation\+::\+Bound\+Family$<$ Model, Parameter\+List$<$ Selected... $>$, std\+::tuple$<$ Laws... $>$, Equation\+Factory $>$}}
\begin{DoxyCompactList}\small\item\em Own target physics and construct fresh family members without a mesh, evaluator, or mutable solve context. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structserif_1_1solver_1_1continuation_1_1_bound_family_3_01_model_00_01_parameter_list_3_01_sele82c3c82160605e9d9f82731d5217d9d6}{serif\+::solver\+::continuation\+::\+Bound\+Family$<$ Model, Parameter\+List$<$ Selected... $>$, std\+::tuple$<$ Laws... $>$, Equation\+Factory $>$\+::\+Values}}
\item
class \mbox{\hyperlink{classserif_1_1solver_1_1continuation_1_1_family}{serif\+::solver\+::continuation\+::\+Family$<$ Selected, Laws $>$}}
\begin{DoxyCompactList}\small\item\em Own a reusable physical family definition before selecting a target model. \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_1continuation}{serif\+::solver\+::continuation}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1solver_1_1continuation_1_1detail}{serif\+::solver\+::continuation\+::detail}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Concepts}
\begin{DoxyCompactItemize}
\item
concept \mbox{\hyperlink{conceptserif_1_1solver_1_1continuation_1_1detail_1_1_law_definition}{serif\+::solver\+::continuation\+::detail\+::\+Law\+Definition}}
\item
concept \mbox{\hyperlink{conceptserif_1_1solver_1_1continuation_1_1detail_1_1_bindable_family}{serif\+::solver\+::continuation\+::detail\+::\+Bindable\+Family}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Functions}
\begin{DoxyCompactItemize}
\item
{\footnotesize template$<$Physical\+Parameter... Parameters$>$ }\\constexpr auto \mbox{\hyperlink{namespaceserif_1_1solver_1_1continuation_a94545ae3cf626e6588d86471528374aa}{serif\+::solver\+::continuation\+::depends\+\_\+on}} (Parameters...) noexcept
\begin{DoxyCompactList}\small\item\em Name only independent physical inputs to a dependent law. \end{DoxyCompactList}\item
{\footnotesize template$<$typename Function$>$ }\\bool \mbox{\hyperlink{namespaceserif_1_1solver_1_1continuation_1_1detail_ab8ea0ff2be2d8ea3a909962a87e25482}{serif\+::solver\+::continuation\+::detail\+::callable\+\_\+valid}} (const Function \&value)
\begin{DoxyCompactList}\small\item\em Reject null callable pointers even when a public aggregate bypasses its factory. \end{DoxyCompactList}\item
bool \mbox{\hyperlink{namespaceserif_1_1solver_1_1continuation_1_1detail_adf610de8c5f0b0e7e5c077065f2cc564}{serif\+::solver\+::continuation\+::detail\+::values\+\_\+agree}} (double first, double second) noexcept
\begin{DoxyCompactList}\small\item\em Compare independently evaluated physical laws without an absolute unit-\/dependent tolerance. \end{DoxyCompactList}\item
{\footnotesize template$<$typename Law, typename Model$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1solver_1_1continuation_1_1detail_acdca66277c7359b90443cc02ffe3cf52}{serif\+::solver\+::continuation\+::detail\+::bind\+\_\+law}} (Law \&\&value, const Model \&target)
\begin{DoxyCompactList}\small\item\em Bind target-\/dependent laws once, owning all resulting captures. \end{DoxyCompactList}\item
{\footnotesize template$<$Physical\+Parameter Output, Physical\+Parameter... Inputs, typename Function$>$ \newline
requires utils\+::dependencies\+::\+Is\+Key\+List$<$\mbox{\hyperlink{namespaceserif_1_1solver_1_1continuation_af4abf5dbb21b2d1032b766c80c2138d4}{Parameter\+List}}$<$Inputs...$>$$>$ \&\& std\+::invocable$<$const std\+::remove\+\_\+cvref\+\_\+t$<$Function$>$\&, typename Inputs\+::\+Value...$>$ \&\& std\+::same\+\_\+as$<$std\+::remove\+\_\+cvref\+\_\+t$<$std\+::invoke\+\_\+result\+\_\+t$<$const std\+::remove\+\_\+cvref\+\_\+t$<$Function$>$\&, typename Inputs\+::\+Value...$>$$>$, typename Output\+::\+Value$>$}\\auto \mbox{\hyperlink{namespaceserif_1_1solver_1_1continuation_a6f421e0cf94425828a241416a97e6290}{serif\+::solver\+::continuation\+::law}} (Output, \mbox{\hyperlink{namespaceserif_1_1solver_1_1continuation_af4abf5dbb21b2d1032b766c80c2138d4}{Parameter\+List}}$<$ Inputs... $>$, Function \&\&function)
\begin{DoxyCompactList}\small\item\em Own a typed law, including move-\/only captures; its inputs are selected coordinates rather than other laws. \end{DoxyCompactList}\item
{\footnotesize template$<$Physical\+Parameter... Parameters$>$ \newline
requires (sizeof...(Parameters) $>$ 0) \&\& utils\+::dependencies\+::\+Is\+Key\+List$<$\mbox{\hyperlink{namespaceserif_1_1solver_1_1continuation_af4abf5dbb21b2d1032b766c80c2138d4}{Parameter\+List}}$<$Parameters...$>$$>$}\\auto \mbox{\hyperlink{namespaceserif_1_1solver_1_1continuation_ae6b0f634b5c0bda27b5b2f9e816c3ff2}{serif\+::solver\+::continuation\+::in}} (Parameters...)
\begin{DoxyCompactList}\small\item\em Select independent physical coordinates with duplicate detection at compile time. \end{DoxyCompactList}\end{DoxyCompactItemize}