58 lines
1.8 KiB
Groff
58 lines
1.8 KiB
Groff
|
.TH "src/include/serif/backend/mfem/solver/linear/solve.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
||
|
|
.ad l
|
||
|
|
.nh
|
||
|
|
.SH NAME
|
||
|
|
src/include/serif/backend/mfem/solver/linear/solve.hpp
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.br
|
||
|
|
.PP
|
||
|
|
\fR#include <concepts>\fP
|
||
|
|
.br
|
||
|
|
\fR#include <type_traits>\fP
|
||
|
|
.br
|
||
|
|
\fR#include 'mfem/linalg/operator\&.hpp'\fP
|
||
|
|
.br
|
||
|
|
\fR#include 'mfem/linalg/vector\&.hpp'\fP
|
||
|
|
.br
|
||
|
|
\fR#include 'serif/solver/linear/linear\&.hpp'\fP
|
||
|
|
.br
|
||
|
|
\fR#include 'serif/solver/preconditioner/contract\&.hpp'\fP
|
||
|
|
.br
|
||
|
|
|
||
|
|
.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
|
||
|
|
.ti -1c
|
||
|
|
.RI "namespace \fBserif::solver::linear::backend\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "namespace \fBserif::solver::linear::backend::mfem\fP"
|
||
|
|
.br
|
||
|
|
.in -1c
|
||
|
|
.SS "Functions"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "\fBReport\fP \fBserif::solver::linear::backend::mfem::solve\fP (\fBFGMRES\fP options, const ::mfem::Operator &operation, ::mfem::Solver &preconditioner, \fBpreconditioner::ApplicationContract\fP contract, const ::mfem::Vector &right_hand_side, ::mfem::Vector &correction, \fBControl\fP control={})"
|
||
|
|
.br
|
||
|
|
.RI "Solve a serial linear system and independently verify the resulting correction\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "template<typename Backend>
|
||
|
|
.br
|
||
|
|
requires (!std::same_as<std::remove_cvref_t<Backend>, \fBFGMRES\fP>)\fBReport\fP \fBserif::solver::linear::backend::mfem::solve\fP (const Backend &backend, const ::mfem::Operator &operation, ::mfem::Solver &inverse, \fBpreconditioner::ApplicationContract\fP contract, const ::mfem::Vector &rhs, ::mfem::Vector &correction, \fBControl\fP control)"
|
||
|
|
.br
|
||
|
|
.RI "Custom linear solvers implement the same checked-result contract as the built-in solver\&. "
|
||
|
|
.in -1c
|
||
|
|
.SH "Author"
|
||
|
|
.PP
|
||
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|