Files
MeanField_SERiF/docs/man/man3/serif_solver_preconditioner_BorderedPreconditioner.3

61 lines
2.4 KiB
Groff
Raw Permalink Normal View History

.TH "serif::solver::preconditioner::BorderedPreconditioner< Fields, Constraints >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::solver::preconditioner::BorderedPreconditioner< Fields, Constraints > \- Correct a physical field inverse through its dense constraint Schur system\&.
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <bordered\&.hpp>\fP
.SS "Public Types"
.in +1c
.ti -1c
.RI "using \fBRows\fP = \fButils::dependencies::CombinedKeyList\fP<typename Fields::Rows, typename Constraints::Rows>"
.br
.ti -1c
.RI "using \fBValues\fP = \fButils::dependencies::CombinedKeyList\fP<typename Fields::Values, typename Constraints::Values>"
.br
.ti -1c
.RI "using \fBResult\fP = \fBkeys::Inverse\fP<\fBRows\fP, \fBValues\fP>"
.br
.in -1c
.SS "Public Attributes"
.in +1c
.ti -1c
.RI "Fields \fBfields\fP"
.br
.ti -1c
.RI "\fBstrategies::inverse::DenseDirect\fP \fBconstraint_inverse\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
.SS "template<typename Fields, typename Constraints>
.br
requires DisjointSubsystems<Fields, Constraints>
.br
struct serif::solver::preconditioner::BorderedPreconditioner< Fields, Constraints >"Correct a physical field inverse through its dense constraint Schur system\&.
.SH "Member Typedef Documentation"
.PP
.SS "template<typename Fields, typename Constraints> using \fBserif::solver::preconditioner::BorderedPreconditioner\fP< Fields, Constraints >::Result = \fBkeys::Inverse\fP<\fBRows\fP, \fBValues\fP>"
.SS "template<typename Fields, typename Constraints> using \fBserif::solver::preconditioner::BorderedPreconditioner\fP< Fields, Constraints >::Rows = \fButils::dependencies::CombinedKeyList\fP<typename Fields::Rows, typename Constraints::Rows>"
.SS "template<typename Fields, typename Constraints> using \fBserif::solver::preconditioner::BorderedPreconditioner\fP< Fields, Constraints >::Values = \fButils::dependencies::CombinedKeyList\fP<typename Fields::Values, typename Constraints::Values>"
.SH "Member Data Documentation"
.PP
.SS "template<typename Fields, typename Constraints> \fBstrategies::inverse::DenseDirect\fP \fBserif::solver::preconditioner::BorderedPreconditioner\fP< Fields, Constraints >::constraint_inverse"
.SS "template<typename Fields, typename Constraints> Fields \fBserif::solver::preconditioner::BorderedPreconditioner\fP< Fields, Constraints >::fields"
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.