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)
78 lines
2.3 KiB
Groff
78 lines
2.3 KiB
Groff
.TH "src/lib/serif/backend/mfem/solver/preconditioner/coupling.cpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/lib/serif/backend/mfem/solver/preconditioner/coupling.cpp
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include 'serif/utils/error/nonfinite\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/backend/mfem/solver/preconditioner/coupling\&.hpp'\fP
|
|
.br
|
|
\fR#include <cmath>\fP
|
|
.br
|
|
\fR#include <limits>\fP
|
|
.br
|
|
\fR#include <utility>\fP
|
|
.br
|
|
\fR#include <vector>\fP
|
|
.br
|
|
\fR#include 'mfem/linalg/vector\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/utils/error/errors\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/backend/mfem/solver/preconditioner/inverse/validation\&.hpp'\fP
|
|
.br
|
|
\fR#include 'coupling_internal\&.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::preconditioner\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::solver::preconditioner::backend\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::solver::preconditioner::backend::mfem\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Enumerations"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "enum class \fBserif::solver::preconditioner::backend::mfem::CouplingOrder\fP "
|
|
.br
|
|
.RI "Choose how the two groups of physical unknowns respond to each other's corrections\&. "
|
|
.ti -1c
|
|
.RI "enum class \fBserif::solver::preconditioner::backend::mfem::SERiFErrorCode\fP "
|
|
.br
|
|
.in -1c
|
|
.SS "Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "std::expected< \fBInverse\fP, \fBFailure\fP > \fBserif::solver::preconditioner::backend::mfem::try_coupled_inverse\fP (\fBInverse\fP first, \fBInverse\fP second, \fBTwoBlockCouplings\fP couplings, \fBCouplingOrder\fP order)"
|
|
.br
|
|
.ti -1c
|
|
.RI "std::expected< \fBOperatorHandle\fP, \fBFailure\fP > \fBserif::solver::preconditioner::backend::mfem::try_schur_operator\fP (\fBOperatorHandle\fP retained_diagonal, \fBInverse\fP eliminated, \fBTwoBlockCouplings\fP couplings)"
|
|
.br
|
|
.RI "Form the retained Jacobian minus its response through a fixed linear eliminated inverse\&. "
|
|
.ti -1c
|
|
.RI "template<\fButils::errors::SERiFErrorCode\fP Code, typename\&.\&.\&. Arguments> std::unexpected< \fBFailure\fP > \fBserif::solver::preconditioner::backend::mfem::failure\fP (const std::string_view message, Arguments\&.\&.\&. arguments)"
|
|
.br
|
|
.RI "Keep preparation failures typed while using the common SERiF diagnostic formatter\&. "
|
|
.in -1c
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|