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,98 @@
\doxysection{serif\+::solver\+::Newton Struct Reference}
\hypertarget{structserif_1_1solver_1_1_newton}{}\label{structserif_1_1solver_1_1_newton}\index{serif::solver::Newton@{serif::solver::Newton}}
Accuracy and work limits for finding one equilibrium star.
{\ttfamily \#include $<$options.\+hpp$>$}
Collaboration diagram for serif\+::solver\+::Newton\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=188pt]{structserif_1_1solver_1_1_newton__coll__graph}
\end{center}
\end{figure}
\doxysubsubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item
void \mbox{\hyperlink{structserif_1_1solver_1_1_newton_a4123b39d2ef3dfdd9e5ca8d8fef43892}{validate}} () const
\begin{DoxyCompactList}\small\item\em Check tolerances and budgets before evaluating any candidate. \end{DoxyCompactList}\item
double \mbox{\hyperlink{structserif_1_1solver_1_1_newton_a3b45548b6d188740685d4c38c4c1feda}{convergence\+\_\+threshold}} (double initial\+\_\+norm) const
\begin{DoxyCompactList}\small\item\em Freeze the convergence threshold from this solve\textquotesingle{}s initial residual. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsubsection*{Public Attributes}
\begin{DoxyCompactItemize}
\item
double \mbox{\hyperlink{structserif_1_1solver_1_1_newton_a0f0f39dd50491d41a52256f9f6d7a397}{relative\+\_\+tolerance}} \{1.\+0e-\/8\}
\item
double \mbox{\hyperlink{structserif_1_1solver_1_1_newton_ad898cfc3de115a418fc6782e31bb53fa}{absolute\+\_\+tolerance}} \{0.\+0\}
\item
int \mbox{\hyperlink{structserif_1_1solver_1_1_newton_a673a168331c73603a181f66f23487759}{maximum\+\_\+iterations}} \{50\}
\item
\mbox{\hyperlink{structserif_1_1solver_1_1linear_1_1_control}{linear\+::\+Control}} \mbox{\hyperlink{structserif_1_1solver_1_1_newton_ad7ad5d765234464e957ba660aa0253ff}{linear\+\_\+solve}} \{.\mbox{\hyperlink{structserif_1_1solver_1_1_newton_a0f0f39dd50491d41a52256f9f6d7a397}{relative\+\_\+tolerance}} = 0.\+03, .\mbox{\hyperlink{structserif_1_1solver_1_1_newton_a673a168331c73603a181f66f23487759}{maximum\+\_\+iterations}} = 200\}
\end{DoxyCompactItemize}
\doxysubsection{Detailed Description}
Accuracy and work limits for finding one equilibrium star.
\doxysubsection{Member Function Documentation}
\Hypertarget{structserif_1_1solver_1_1_newton_a3b45548b6d188740685d4c38c4c1feda}\index{serif::solver::Newton@{serif::solver::Newton}!convergence\_threshold@{convergence\_threshold}}
\index{convergence\_threshold@{convergence\_threshold}!serif::solver::Newton@{serif::solver::Newton}}
\doxysubsubsection{\texorpdfstring{convergence\_threshold()}{convergence\_threshold()}}
{\footnotesize\ttfamily \label{structserif_1_1solver_1_1_newton_a3b45548b6d188740685d4c38c4c1feda}
double serif\+::solver\+::\+Newton\+::convergence\+\_\+threshold (\begin{DoxyParamCaption}\item[{double}]{initial\+\_\+norm}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [nodiscard]}}
Freeze the convergence threshold from this solve\textquotesingle{}s initial residual.
\Hypertarget{structserif_1_1solver_1_1_newton_a4123b39d2ef3dfdd9e5ca8d8fef43892}\index{serif::solver::Newton@{serif::solver::Newton}!validate@{validate}}
\index{validate@{validate}!serif::solver::Newton@{serif::solver::Newton}}
\doxysubsubsection{\texorpdfstring{validate()}{validate()}}
{\footnotesize\ttfamily \label{structserif_1_1solver_1_1_newton_a4123b39d2ef3dfdd9e5ca8d8fef43892}
void serif\+::solver\+::\+Newton\+::validate (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption}) const}
Check tolerances and budgets before evaluating any candidate.
\doxysubsection{Member Data Documentation}
\Hypertarget{structserif_1_1solver_1_1_newton_ad898cfc3de115a418fc6782e31bb53fa}\index{serif::solver::Newton@{serif::solver::Newton}!absolute\_tolerance@{absolute\_tolerance}}
\index{absolute\_tolerance@{absolute\_tolerance}!serif::solver::Newton@{serif::solver::Newton}}
\doxysubsubsection{\texorpdfstring{absolute\_tolerance}{absolute\_tolerance}}
{\footnotesize\ttfamily \label{structserif_1_1solver_1_1_newton_ad898cfc3de115a418fc6782e31bb53fa}
double serif\+::solver\+::\+Newton\+::absolute\+\_\+tolerance \{0.\+0\}}
\Hypertarget{structserif_1_1solver_1_1_newton_ad7ad5d765234464e957ba660aa0253ff}\index{serif::solver::Newton@{serif::solver::Newton}!linear\_solve@{linear\_solve}}
\index{linear\_solve@{linear\_solve}!serif::solver::Newton@{serif::solver::Newton}}
\doxysubsubsection{\texorpdfstring{linear\_solve}{linear\_solve}}
{\footnotesize\ttfamily \label{structserif_1_1solver_1_1_newton_ad7ad5d765234464e957ba660aa0253ff}
\mbox{\hyperlink{structserif_1_1solver_1_1linear_1_1_control}{linear\+::\+Control}} serif\+::solver\+::\+Newton\+::linear\+\_\+solve \{.\mbox{\hyperlink{structserif_1_1solver_1_1_newton_a0f0f39dd50491d41a52256f9f6d7a397}{relative\+\_\+tolerance}} = 0.\+03, .\mbox{\hyperlink{structserif_1_1solver_1_1_newton_a673a168331c73603a181f66f23487759}{maximum\+\_\+iterations}} = 200\}}
\Hypertarget{structserif_1_1solver_1_1_newton_a673a168331c73603a181f66f23487759}\index{serif::solver::Newton@{serif::solver::Newton}!maximum\_iterations@{maximum\_iterations}}
\index{maximum\_iterations@{maximum\_iterations}!serif::solver::Newton@{serif::solver::Newton}}
\doxysubsubsection{\texorpdfstring{maximum\_iterations}{maximum\_iterations}}
{\footnotesize\ttfamily \label{structserif_1_1solver_1_1_newton_a673a168331c73603a181f66f23487759}
int serif\+::solver\+::\+Newton\+::maximum\+\_\+iterations \{50\}}
\Hypertarget{structserif_1_1solver_1_1_newton_a0f0f39dd50491d41a52256f9f6d7a397}\index{serif::solver::Newton@{serif::solver::Newton}!relative\_tolerance@{relative\_tolerance}}
\index{relative\_tolerance@{relative\_tolerance}!serif::solver::Newton@{serif::solver::Newton}}
\doxysubsubsection{\texorpdfstring{relative\_tolerance}{relative\_tolerance}}
{\footnotesize\ttfamily \label{structserif_1_1solver_1_1_newton_a0f0f39dd50491d41a52256f9f6d7a397}
double serif\+::solver\+::\+Newton\+::relative\+\_\+tolerance \{1.\+0e-\/8\}}
The documentation for this struct was generated from the following files\+:\begin{DoxyCompactItemize}
\item
src/include/serif/solver/nonlinear/\mbox{\hyperlink{solver_2nonlinear_2options_8hpp}{options.\+hpp}}\item
src/lib/serif/solver/nonlinear/\mbox{\hyperlink{options_8cpp}{options.\+cpp}}\end{DoxyCompactItemize}