Emily Boudreaux
6b57738330
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)
49 lines
1.1 KiB
Groff
49 lines
1.1 KiB
Groff
.TH "serif::solver::linear::FGMRES" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::solver::linear::FGMRES \- Flexible GMRES accepts both fixed linear inverses and variable inner preconditioners\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <linear\&.hpp>\fP
|
|
.SS "Public Member Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "void \fBvalidate\fP () const"
|
|
.br
|
|
.RI "Check the Krylov restart length and MFEM diagnostic verbosity\&. "
|
|
.in -1c
|
|
.SS "Public Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "int \fBrestart_length\fP {160}"
|
|
.br
|
|
.ti -1c
|
|
.RI "int \fBprint_level\fP {\-1}"
|
|
.br
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
Flexible GMRES accepts both fixed linear inverses and variable inner preconditioners\&.
|
|
.SH "Member Function Documentation"
|
|
.PP
|
|
.SS "void serif::solver::linear::FGMRES::validate () const"
|
|
|
|
.PP
|
|
Check the Krylov restart length and MFEM diagnostic verbosity\&.
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "int serif::solver::linear::FGMRES::print_level {\-1}"
|
|
|
|
.SS "int serif::solver::linear::FGMRES::restart_length {160}"
|
|
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|