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)
87 lines
2.9 KiB
Groff
87 lines
2.9 KiB
Groff
.TH "serif::solver::preconditioner::Solver" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::solver::preconditioner::Solver \- Expose one accepted inverse to MFEM while binding it to exactly its accepted physical Jacobian\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <solver\&.hpp>\fP
|
|
.PP
|
|
Inherits mfem::Solver\&.
|
|
.SS "Public Member Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "\fBSolver\fP (Inverse inverse, \fBOperatorHandle\fP jacobian)"
|
|
.br
|
|
.RI "Retain the inverse and its matching Jacobian; all numerical setup must already have succeeded\&. "
|
|
.ti -1c
|
|
.RI "void \fBSetOperator\fP (const ::mfem::Operator &jacobian) override"
|
|
.br
|
|
.RI "Refuse an unrelated or newer Jacobian instead of silently reusing stale numerical factors\&. "
|
|
.ti -1c
|
|
.RI "void \fBMult\fP (const ::mfem::Vector &input, ::mfem::Vector &output) const override"
|
|
.br
|
|
.RI "Apply from a zero initial guess, independently of the destination's prior contents\&. "
|
|
.ti -1c
|
|
.RI "\fBApplicationContract\fP \fBcontract\fP () const noexcept"
|
|
.br
|
|
.RI "Report whether a fixed outer Krylov method may use this inverse\&. "
|
|
.in -1c
|
|
.SS "Private Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "Inverse \fBm_inverse\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "\fBOperatorHandle\fP \fBm_jacobian\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "mutable::mfem::Vector \fBm_input\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "mutable::mfem::Vector \fBm_output\fP"
|
|
.br
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
Expose one accepted inverse to MFEM while binding it to exactly its accepted physical Jacobian\&.
|
|
.SH "Constructor & Destructor Documentation"
|
|
.PP
|
|
.SS "serif::solver::preconditioner::backend::mfem::Solver::Solver (Inverse inverse, \fBOperatorHandle\fP jacobian)"
|
|
|
|
.PP
|
|
Retain the inverse and its matching Jacobian; all numerical setup must already have succeeded\&.
|
|
.SH "Member Function Documentation"
|
|
.PP
|
|
.SS "\fBApplicationContract\fP serif::solver::preconditioner::backend::mfem::Solver::contract () const\fR [nodiscard]\fP, \fR [noexcept]\fP"
|
|
|
|
.PP
|
|
Report whether a fixed outer Krylov method may use this inverse\&.
|
|
.SS "void serif::solver::preconditioner::backend::mfem::Solver::Mult (const ::mfem::Vector & input, ::mfem::Vector & output) const\fR [override]\fP"
|
|
|
|
.PP
|
|
Apply from a zero initial guess, independently of the destination's prior contents\&.
|
|
.SS "void serif::solver::preconditioner::backend::mfem::Solver::SetOperator (const ::mfem::Operator & jacobian)\fR [override]\fP"
|
|
|
|
.PP
|
|
Refuse an unrelated or newer Jacobian instead of silently reusing stale numerical factors\&.
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "mutable::mfem::Vector serif::solver::preconditioner::backend::mfem::Solver::m_input\fR [private]\fP"
|
|
|
|
.SS "Inverse serif::solver::preconditioner::backend::mfem::Solver::m_inverse\fR [private]\fP"
|
|
|
|
.SS "\fBOperatorHandle\fP serif::solver::preconditioner::backend::mfem::Solver::m_jacobian\fR [private]\fP"
|
|
|
|
.SS "mutable::mfem::Vector serif::solver::preconditioner::backend::mfem::Solver::m_output\fR [private]\fP"
|
|
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|