Files
MeanField_SERiF/docs/man/man3/regularization.hpp.3

58 lines
1.5 KiB
Groff
Raw Normal View History

.TH "src/include/serif/solver/preconditioner/backend/mfem/inverse/regularization.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/solver/preconditioner/backend/mfem/inverse/regularization.hpp
.SH SYNOPSIS
.br
.PP
\fR#include <expected>\fP
.br
\fR#include <span>\fP
.br
\fR#include <vector>\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::backend::mfem::RegularizedDiagonal\fP"
.br
.RI "Own a regularized signed diagonal separately from its reciprocal action\&. "
.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::backend\fP"
.br
.ti -1c
.RI "namespace \fBserif::solver::preconditioner::backend::mfem\fP"
.br
.in -1c
.SS "Functions"
.in +1c
.ti -1c
.RI "std::expected< \fBRegularizedDiagonal\fP, \fBFailure\fP > \fBserif::solver::preconditioner::backend::mfem::try_regularize_diagonal\fP (std::span< const double > diagonal, \fBstrategies::inverse::DiagonalRegularization\fP options={})"
.br
.RI "Floor small magnitudes relative to the largest original entry; exact zeros receive a positive floor\&. "
.in -1c
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.