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

52 lines
1.4 KiB
Groff
Raw Normal View History

.TH "src/include/serif/solver/linear/linear.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/solver/linear/linear.hpp
.SH SYNOPSIS
.br
.PP
\fR#include <cstdint>\fP
.br
.SS "Classes"
.in +1c
.ti -1c
.RI "struct \fBserif::solver::linear::Control\fP"
.br
.RI "Accuracy is measured against the current right-hand side, independently of the initial guess\&. "
.ti -1c
.RI "struct \fBserif::solver::linear::FGMRES\fP"
.br
.RI "Flexible GMRES accepts both fixed linear inverses and variable inner preconditioners\&. "
.ti -1c
.RI "struct \fBserif::solver::linear::Report\fP"
.br
.RI "Bounded diagnostics from one solve, including an independently evaluated true residual\&. "
.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::linear\fP"
.br
.in -1c
.SS "Enumerations"
.in +1c
.ti -1c
.RI "enum class \fBserif::solver::linear::Status\fP { \fBserif::solver::linear::converged\fP, \fBserif::solver::linear::maximum_iterations\fP, \fBserif::solver::linear::breakdown\fP, \fBserif::solver::linear::non_finite\fP, \fBserif::solver::linear::backend_failure\fP }"
.br
.RI "Numerical termination of a checked Krylov solve\&. Invalid configuration remains a programming error\&. "
.in -1c
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.