Files
MeanField_SERiF/docs/man/man3/serif_solver_linear.3

80 lines
2.1 KiB
Groff
Raw Permalink Normal View History

.TH "serif::solver::linear" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::solver::linear
.SH SYNOPSIS
.br
.PP
.SS "Namespaces"
.in +1c
.ti -1c
.RI "namespace \fBbackend\fP"
.br
.in -1c
.SS "Classes"
.in +1c
.ti -1c
.RI "class \fBApplicationFailure\fP"
.br
.RI "Bridge a failed checked inner solve through MFEM's void operator-application interface\&. Only this numerical failure is intercepted by the checked backend\&. Dimension, ownership, and other callback errors retain their original exception types and reach the library's caller\&. "
.ti -1c
.RI "struct \fBControl\fP"
.br
.RI "Accuracy is measured against the current right-hand side, independently of the initial guess\&. "
.ti -1c
.RI "struct \fBFGMRES\fP"
.br
.RI "Flexible GMRES accepts both fixed linear inverses and variable inner preconditioners\&. "
.ti -1c
.RI "struct \fBReport\fP"
.br
.RI "Bounded diagnostics from one solve, including an independently evaluated true residual\&. "
.in -1c
.SS "Typedefs"
.in +1c
.ti -1c
.RI "using \fBNonFiniteApplication\fP = \fButils::errors::NonFiniteValue\fP"
.br
.RI "Stop Krylov before a nonfinite application reaches MFEM internal arithmetic assertions\&. "
.in -1c
.SS "Enumerations"
.in +1c
.ti -1c
.RI "enum class \fBStatus\fP { \fBconverged\fP, \fBmaximum_iterations\fP, \fBbreakdown\fP, \fBnon_finite\fP, \fBbackend_failure\fP }"
.br
.RI "Numerical termination of a checked Krylov solve\&. Invalid configuration remains a programming error\&. "
.in -1c
.SH "Typedef Documentation"
.PP
.SS "using \fBserif::solver::linear::NonFiniteApplication\fP = \fButils::errors::NonFiniteValue\fP"
.PP
Stop Krylov before a nonfinite application reaches MFEM internal arithmetic assertions\&.
.SH "Enumeration Type Documentation"
.PP
.SS "enum class \fBserif::solver::linear::Status\fP\fR [strong]\fP"
.PP
Numerical termination of a checked Krylov solve\&. Invalid configuration remains a programming error\&.
.PP
\fBEnumerator\fP
.in +1c
.TP
\f(BIconverged \fP
.TP
\f(BImaximum_iterations \fP
.TP
\f(BIbreakdown \fP
.TP
\f(BInon_finite \fP
.TP
\f(BIbackend_failure \fP
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.