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)
50 lines
2.5 KiB
Groff
50 lines
2.5 KiB
Groff
.TH "serif::solver::linear::backend::mfem" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::solver::linear::backend::mfem
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.SS "Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "\fBReport\fP \fBsolve\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 \fBsolve\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 "Function Documentation"
|
|
.PP
|
|
.SS "template<typename Backend>
|
|
.br
|
|
requires (!std::same_as<std::remove_cvref_t<Backend>, \fBFGMRES\fP>)\fBReport\fP serif::solver::linear::backend::mfem::solve (const Backend & backend, const ::mfem::Operator & operation, ::mfem::Solver & inverse, \fBpreconditioner::ApplicationContract\fP contract, const ::mfem::Vector & rhs, ::mfem::Vector & correction, \fBControl\fP control)\fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Custom linear solvers implement the same checked-result contract as the built-in solver\&.
|
|
.SS "\fBReport\fP serif::solver::linear::backend::mfem::solve (\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 = \fR{}\fP)\fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Solve a serial linear system and independently verify the resulting correction\&.
|
|
.PP
|
|
\fBParameters\fP
|
|
.RS 4
|
|
\fIcorrection\fP On entry, a finite initial guess; on return, the final attempted correction\&. A reused guess is discarded if its true defect exceeds the right-hand-side norm\&. Convergence remains relative to that right-hand side, including when the backend takes zero iterations\&.
|
|
.RE
|
|
.PP
|
|
\fBNote\fP
|
|
.RS 4
|
|
The caller retains the matching operator and inverse owners throughout this call\&. Numerical failure is reported as data; invalid dimensions, stale inverses, and callback errors propagate\&.
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|