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,71 @@
.TH "src/include/serif/utils/serialize/solver.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/utils/serialize/solver.hpp
.SH SYNOPSIS
.br
.PP
\fR#include 'serif/utils/serialize/model\&.hpp'\fP
.br
\fR#include 'serif/utils/serialize/numerics\&.hpp'\fP
.br
\fR#include 'serif/solver/nonlinear/result\&.hpp'\fP
.br
.SS "Classes"
.in +1c
.ti -1c
.RI "struct \fBserif::utils::serialize::Serializer< solver::linear::Status >\fP"
.br
.RI "Preserve stable termination names independently of enum storage or declaration order\&. "
.ti -1c
.RI "struct \fBserif::utils::serialize::Serializer< solver::SolveStatus >\fP"
.br
.RI "Preserve stable termination names independently of enum storage or declaration order\&. "
.ti -1c
.RI "struct \fBserif::utils::serialize::Serializer< solver::MetricEvaluation >\fP"
.br
.RI "Store bounded numerical history as named data, without runtime operators or graph caches\&. "
.ti -1c
.RI "struct \fBserif::utils::serialize::Serializer< solver::linear::Report >\fP"
.br
.RI "Store bounded numerical history as named data, without runtime operators or graph caches\&. "
.ti -1c
.RI "struct \fBserif::utils::serialize::Serializer< geometry::deformation::GeometryStepLimit >\fP"
.br
.RI "Store bounded numerical history as named data, without runtime operators or graph caches\&. "
.ti -1c
.RI "struct \fBserif::utils::serialize::Serializer< solver::SolveDiagnostics >\fP"
.br
.RI "Store bounded numerical history as named data, without runtime operators or graph caches\&. "
.ti -1c
.RI "struct \fBserif::utils::serialize::Serializer< solver::NewtonProgress >\fP"
.br
.RI "Store bounded numerical history as named data, without runtime operators or graph caches\&. "
.ti -1c
.RI "struct \fBserif::utils::serialize::Serializer< solver::NewtonCheckpoint< State > >\fP"
.br
.RI "Save a portable accepted physical state together with its complete supported Newton history\&. "
.ti -1c
.RI "struct \fBserif::utils::serialize::Serializer< solver::SolveResult< State, System, Model > >\fP"
.br
.RI "Export scientific results and supported restart data without pretending frozen operators are persistent\&. "
.in -1c
.SS "Namespaces"
.in +1c
.ti -1c
.RI "namespace \fBserif\fP"
.br
.ti -1c
.RI "namespace \fBserif::utils\fP"
.br
.ti -1c
.RI "namespace \fBserif::utils::serialize\fP"
.br
.in -1c
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.