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,51 @@
\doxysection{src/include/serif/utils/serialize/solver.hpp File Reference}
\hypertarget{utils_2serialize_2solver_8hpp}{}\label{utils_2serialize_2solver_8hpp}\index{src/include/serif/utils/serialize/solver.hpp@{src/include/serif/utils/serialize/solver.hpp}}
{\ttfamily \#include "{}serif/utils/serialize/model.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/utils/serialize/numerics.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/solver/nonlinear/result.\+hpp"{}}\newline
Include dependency graph for solver.\+hpp\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{utils_2serialize_2solver_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=234pt]{utils_2serialize_2solver_8hpp__dep__incl}
\end{center}
\end{figure}
\doxysubsubsection*{Classes}
\begin{DoxyCompactItemize}
\item
struct \mbox{\hyperlink{structserif_1_1utils_1_1serialize_1_1_serializer_3_01solver_1_1linear_1_1_status_01_4}{serif\+::utils\+::serialize\+::\+Serializer$<$ solver\+::linear\+::\+Status $>$}}
\begin{DoxyCompactList}\small\item\em Preserve stable termination names independently of enum storage or declaration order. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structserif_1_1utils_1_1serialize_1_1_serializer_3_01solver_1_1_solve_status_01_4}{serif\+::utils\+::serialize\+::\+Serializer$<$ solver\+::\+Solve\+Status $>$}}
\begin{DoxyCompactList}\small\item\em Preserve stable termination names independently of enum storage or declaration order. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structserif_1_1utils_1_1serialize_1_1_serializer_3_01solver_1_1_metric_evaluation_01_4}{serif\+::utils\+::serialize\+::\+Serializer$<$ solver\+::\+Metric\+Evaluation $>$}}
\begin{DoxyCompactList}\small\item\em Store bounded numerical history as named data, without runtime operators or graph caches. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structserif_1_1utils_1_1serialize_1_1_serializer_3_01solver_1_1linear_1_1_report_01_4}{serif\+::utils\+::serialize\+::\+Serializer$<$ solver\+::linear\+::\+Report $>$}}
\begin{DoxyCompactList}\small\item\em Store bounded numerical history as named data, without runtime operators or graph caches. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structserif_1_1utils_1_1serialize_1_1_serializer_3_01geometry_1_1deformation_1_1_geometry_step_limit_01_4}{serif\+::utils\+::serialize\+::\+Serializer$<$ geometry\+::deformation\+::\+Geometry\+Step\+Limit $>$}}
\begin{DoxyCompactList}\small\item\em Store bounded numerical history as named data, without runtime operators or graph caches. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structserif_1_1utils_1_1serialize_1_1_serializer_3_01solver_1_1_solve_diagnostics_01_4}{serif\+::utils\+::serialize\+::\+Serializer$<$ solver\+::\+Solve\+Diagnostics $>$}}
\begin{DoxyCompactList}\small\item\em Store bounded numerical history as named data, without runtime operators or graph caches. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structserif_1_1utils_1_1serialize_1_1_serializer_3_01solver_1_1_newton_progress_01_4}{serif\+::utils\+::serialize\+::\+Serializer$<$ solver\+::\+Newton\+Progress $>$}}
\begin{DoxyCompactList}\small\item\em Store bounded numerical history as named data, without runtime operators or graph caches. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structserif_1_1utils_1_1serialize_1_1_serializer_3_01solver_1_1_newton_checkpoint_3_01_state_01_4_01_4}{serif\+::utils\+::serialize\+::\+Serializer$<$ solver\+::\+Newton\+Checkpoint$<$ State $>$ $>$}}
\begin{DoxyCompactList}\small\item\em Save a portable accepted physical state together with its complete supported Newton history. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structserif_1_1utils_1_1serialize_1_1_serializer_3_01solver_1_1_solve_result_3_01_state_00_01_system_00_01_model_01_4_01_4}{serif\+::utils\+::serialize\+::\+Serializer$<$ solver\+::\+Solve\+Result$<$ State, System, Model $>$ $>$}}
\begin{DoxyCompactList}\small\item\em Export scientific results and supported restart data without pretending frozen operators are persistent. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsubsection*{Namespaces}
\begin{DoxyCompactItemize}
\item
namespace \mbox{\hyperlink{namespaceserif}{serif}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1utils}{serif\+::utils}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1utils_1_1serialize}{serif\+::utils\+::serialize}}
\end{DoxyCompactItemize}