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{src/include/serif/solver/nonlinear/options.hpp File Reference}
\hypertarget{solver_2nonlinear_2options_8hpp}{}\label{solver_2nonlinear_2options_8hpp}\index{src/include/serif/solver/nonlinear/options.hpp@{src/include/serif/solver/nonlinear/options.hpp}}
{\ttfamily \#include $<$cmath$>$}\newline
{\ttfamily \#include $<$span$>$}\newline
{\ttfamily \#include $<$optional$>$}\newline
{\ttfamily \#include $<$string$>$}\newline
{\ttfamily \#include $<$tuple$>$}\newline
{\ttfamily \#include $<$utility$>$}\newline
{\ttfamily \#include "{}serif/solver/linear/linear.\+hpp"{}}\newline
Include dependency graph for options.\+hpp\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{solver_2nonlinear_2options_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]{solver_2nonlinear_2options_8hpp__dep__incl}
\end{center}
\end{figure}
\doxysubsubsection*{Classes}
\begin{DoxyCompactItemize}
\item
struct \mbox{\hyperlink{structserif_1_1solver_1_1_newton}{serif\+::solver\+::\+Newton}}
\begin{DoxyCompactList}\small\item\em Accuracy and work limits for finding one equilibrium star. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structserif_1_1solver_1_1_backtracking}{serif\+::solver\+::\+Backtracking}}
\begin{DoxyCompactList}\small\item\em Shorten a \doxylink{structserif_1_1solver_1_1_newton}{Newton} step until the complete residual merit decreases sufficiently. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structserif_1_1solver_1_1_metric_evaluation}{serif\+::solver\+::\+Metric\+Evaluation}}
\begin{DoxyCompactList}\small\item\em Separate the convergence norm from the line-\/search merit for custom metrics. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structserif_1_1solver_1_1_normalized_residual_metric}{serif\+::solver\+::\+Normalized\+Residual\+Metric}}
\begin{DoxyCompactList}\small\item\em Use the Euclidean norm of SERiF\textquotesingle{}s normalized residual and half its square. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structserif_1_1solver_1_1_direction_assessment}{serif\+::solver\+::\+Direction\+Assessment}}
\begin{DoxyCompactList}\small\item\em A modified direction must report whether it is usable and any measured merit slope. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structserif_1_1solver_1_1_trial_assessment}{serif\+::solver\+::\+Trial\+Assessment}}
\begin{DoxyCompactList}\small\item\em A numerical policy explicitly accepts its work or explains why this candidate must be rejected. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structserif_1_1solver_1_1_standard_newton}{serif\+::solver\+::\+Standard\+Newton}}
\begin{DoxyCompactList}\small\item\em Ordinary \doxylink{structserif_1_1solver_1_1_newton}{Newton} supplies every strategy phase; custom policies may replace individual phases explicitly. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structserif_1_1solver_1_1_solver_options}{serif\+::solver\+::\+Solver\+Options$<$ Metric, Strategies, Linear\+Solver $>$}}
\begin{DoxyCompactList}\small\item\em Select numerical policies while keeping equilibrium physics in the model. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsubsection*{Namespaces}
\begin{DoxyCompactItemize}
\item
namespace \mbox{\hyperlink{namespaceserif}{serif}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1solver}{serif\+::solver}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Functions}
\begin{DoxyCompactItemize}
\item
double \mbox{\hyperlink{namespaceserif_1_1solver_a4ae15221b9aded0dc3ec787898984462}{serif\+::solver\+::next\+\_\+backtracking\+\_\+step}} (double rejected\+\_\+step, double accepted\+\_\+determinant, double rejected\+\_\+determinant, bool inverted, const \mbox{\hyperlink{structserif_1_1solver_1_1_backtracking}{Backtracking}} \&options) noexcept
\begin{DoxyCompactList}\small\item\em Skip only existing backtracking rungs when an inverted trial gives a finite boundary estimate. \end{DoxyCompactList}\end{DoxyCompactItemize}