Files
MeanField_SERiF/docs/man/man3/coupling.hpp.3

58 lines
1.7 KiB
Groff
Raw Normal View History

.TH "src/include/serif/backend/mfem/solver/preconditioner/coupling.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/backend/mfem/solver/preconditioner/coupling.hpp
.SH SYNOPSIS
.br
.PP
\fR#include <expected>\fP
.br
\fR#include 'serif/backend/mfem/solver/preconditioner/inverse\&.hpp'\fP
.br
\fR#include 'serif/solver/preconditioner/strategies/coupling/order\&.hpp'\fP
.br
.SS "Classes"
.in +1c
.ti -1c
.RI "struct \fBserif::solver::preconditioner::backend::mfem::TwoBlockCouplings\fP"
.br
.RI "The two Jacobian actions between independently ordered equation and unknown groups\&. "
.in -1c
.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 "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, \fBstrategies::coupling::CouplingOrder\fP order)"
.br
.RI "Compose two inverses with the requested treatment of their cross couplings\&. "
.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\&. "
.in -1c
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.