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,69 @@
.TH "src/include/serif/solver/preconditioner/strategies/surface/calibrated_mass.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/solver/preconditioner/strategies/surface/calibrated_mass.hpp
.SH SYNOPSIS
.br
.PP
\fR#include <expected>\fP
.br
\fR#include 'serif/solver/preconditioner/failure\&.hpp'\fP
.br
\fR#include 'serif/solver/preconditioner/strategies/inverse/diagonal_regularization\&.hpp'\fP
.br
.SS "Classes"
.in +1c
.ti -1c
.RI "struct \fBserif::solver::preconditioner::strategies::surface::CalibratedSurfaceMass\fP"
.br
.RI "Calibrate a signed multiple of the native reference mass diagonal with bounded deterministic probes\&. "
.ti -1c
.RI "struct \fBserif::solver::preconditioner::strategies::surface::SurfaceMassFit\fP"
.br
.RI "Retain the scalar least-squares evidence and the signed surrogate and inverse multipliers\&. "
.in -1c
.SS "Namespaces"
.in +1c
.ti -1c
.RI "namespace \fBserif\fP"
.br
.ti -1c
.RI "namespace \fBserif::solver\fP"
.br
.ti -1c
.RI "namespace \fBserif::solver::preconditioner\fP"
.br
.ti -1c
.RI "namespace \fBserif::solver::preconditioner::strategies\fP"
.br
.ti -1c
.RI "namespace \fBserif::solver::preconditioner::strategies::surface\fP"
.br
.in -1c
.SS "Enumerations"
.in +1c
.ti -1c
.RI "enum class \fBserif::solver::preconditioner::strategies::surface::CalibrationTarget\fP { \fBserif::solver::preconditioner::strategies::surface::surface_jacobian\fP, \fBserif::solver::preconditioner::strategies::surface::material_schur\fP }"
.br
.RI "Choose the physical shape response, with or without approximate material relaxation\&. "
.ti -1c
.RI "enum class \fBserif::solver::preconditioner::strategies::surface::CalibrationObjective\fP { \fBserif::solver::preconditioner::strategies::surface::operator_action\fP, \fBserif::solver::preconditioner::strategies::surface::right_preconditioned_action\fP }"
.br
.RI "Fit the shape operator itself, or its action after applying the reference mass inverse\&. "
.in -1c
.SS "Functions"
.in +1c
.ti -1c
.RI "std::expected< \fBSurfaceMassFit\fP, \fBFailure\fP > \fBserif::solver::preconditioner::strategies::surface::try_fit_surface_mass\fP (double numerator, double denominator, \fBCalibrationObjective\fP objective)"
.br
.RI "Solve either scalar calibration objective without discarding the physical sign\&. "
.in -1c
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.