Files
MeanField_SERiF/docs/man/man3/serif_solver_preconditioner_strategies_surface.3
Emily Boudreaux 6b57738330 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)
2026-11-09 14:09:44 -05:00

101 lines
3.6 KiB
Groff

.TH "serif::solver::preconditioner::strategies::surface" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::solver::preconditioner::strategies::surface
.SH SYNOPSIS
.br
.PP
.SS "Classes"
.in +1c
.ti -1c
.RI "struct \fBCalibratedSurfaceMass\fP"
.br
.RI "Calibrate a signed multiple of the native reference mass diagonal with bounded deterministic probes\&. "
.ti -1c
.RI "struct \fBFittedSurfaceH1\fP"
.br
.RI "Fit a signed positive mass-plus-stiffness operator on a nodal stellar surface\&. "
.ti -1c
.RI "struct \fBReferenceSurfaceMass\fP"
.br
.RI "Use the native reference boundary mass without fitting candidate-dependent physical scales\&. "
.ti -1c
.RI "struct \fBSurfaceH1Fit\fP"
.br
.RI "Keep a positive backend operator while preserving the sign of the physical shape response\&. "
.ti -1c
.RI "struct \fBSurfaceH1Moments\fP"
.br
.RI "Accumulated inner products of mass, stiffness, and physical target actions\&. "
.ti -1c
.RI "struct \fBSurfaceMassFit\fP"
.br
.RI "Retain the scalar least-squares evidence and the signed surrogate and inverse multipliers\&. "
.in -1c
.SS "Enumerations"
.in +1c
.ti -1c
.RI "enum class \fBCalibrationTarget\fP { \fBsurface_jacobian\fP, \fBmaterial_schur\fP }"
.br
.RI "Choose the physical shape response, with or without approximate material relaxation\&. "
.ti -1c
.RI "enum class \fBCalibrationObjective\fP { \fBoperator_action\fP, \fBright_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 > \fBtry_fit_surface_mass\fP (double numerator, double denominator, \fBCalibrationObjective\fP objective)"
.br
.RI "Solve either scalar calibration objective without discarding the physical sign\&. "
.ti -1c
.RI "std::expected< \fBSurfaceH1Fit\fP, \fBFailure\fP > \fBtry_fit_surface_h1_coefficients\fP (const \fBSurfaceH1Moments\fP &moments, \fBFittedSurfaceH1\fP options={})"
.br
.RI "Solve the two signed constrained least-squares problems with positive mass and nonnegative stiffness\&. "
.in -1c
.SH "Enumeration Type Documentation"
.PP
.SS "enum class \fBserif::solver::preconditioner::strategies::surface::CalibrationObjective\fP\fR [strong]\fP"
.PP
Fit the shape operator itself, or its action after applying the reference mass inverse\&.
.PP
\fBEnumerator\fP
.in +1c
.TP
\f(BIoperator_action \fP
.TP
\f(BIright_preconditioned_action \fP
.SS "enum class \fBserif::solver::preconditioner::strategies::surface::CalibrationTarget\fP\fR [strong]\fP"
.PP
Choose the physical shape response, with or without approximate material relaxation\&.
.PP
\fBEnumerator\fP
.in +1c
.TP
\f(BIsurface_jacobian \fP
.TP
\f(BImaterial_schur \fP
.SH "Function Documentation"
.PP
.SS "std::expected< \fBSurfaceH1Fit\fP, \fBFailure\fP > serif::solver::preconditioner::strategies::surface::try_fit_surface_h1_coefficients (const \fBSurfaceH1Moments\fP & moments, \fBFittedSurfaceH1\fP options = \fR{}\fP)\fR [nodiscard]\fP"
.PP
Solve the two signed constrained least-squares problems with positive mass and nonnegative stiffness\&. Reject nonfinite moments before constructing the normalized Gram problem\&.
.PP
Compare a feasible positive backend operator against the signed physical target\&.
.SS "std::expected< \fBSurfaceMassFit\fP, \fBFailure\fP > serif::solver::preconditioner::strategies::surface::try_fit_surface_mass (double numerator, double denominator, \fBCalibrationObjective\fP objective)\fR [nodiscard]\fP"
.PP
Solve either scalar calibration objective without discarding the physical sign\&.
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.