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)
54 lines
1.9 KiB
Groff
54 lines
1.9 KiB
Groff
.TH "serif::solver::preconditioner::BlockPreconditioner< Row, Field, Strategy >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::solver::preconditioner::BlockPreconditioner< Row, Field, Strategy > \- Select a physical equation/unknown pair and the numerical approximation to its inverse\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <block\&.hpp>\fP
|
|
.SS "Public Types"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "using \fBRows\fP = \fButils::dependencies::KeyList\fP<Row>"
|
|
.br
|
|
.ti -1c
|
|
.RI "using \fBValues\fP = \fButils::dependencies::KeyList\fP<Field>"
|
|
.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 "Strategy \fBinverse\fP"
|
|
.br
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
|
|
.SS "template<typename Row, typename Field, typename Strategy>
|
|
.br
|
|
struct serif::solver::preconditioner::BlockPreconditioner< Row, Field, Strategy >"Select a physical equation/unknown pair and the numerical approximation to its inverse\&.
|
|
.SH "Member Typedef Documentation"
|
|
.PP
|
|
.SS "template<typename Row, typename Field, typename Strategy> using \fBserif::solver::preconditioner::BlockPreconditioner\fP< Row, Field, Strategy >::Result = \fBkeys::Inverse\fP<\fBRows\fP, \fBValues\fP>"
|
|
|
|
.SS "template<typename Row, typename Field, typename Strategy> using \fBserif::solver::preconditioner::BlockPreconditioner\fP< Row, Field, Strategy >::Rows = \fButils::dependencies::KeyList\fP<Row>"
|
|
|
|
.SS "template<typename Row, typename Field, typename Strategy> using \fBserif::solver::preconditioner::BlockPreconditioner\fP< Row, Field, Strategy >::Values = \fButils::dependencies::KeyList\fP<Field>"
|
|
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "template<typename Row, typename Field, typename Strategy> Strategy \fBserif::solver::preconditioner::BlockPreconditioner\fP< Row, Field, Strategy >::inverse"
|
|
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|