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)
48 lines
1.2 KiB
Groff
48 lines
1.2 KiB
Groff
.TH "serif::solver::preconditioner::keys" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::solver::preconditioner::keys
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "struct \fBDiagonal\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBInverse\fP"
|
|
.br
|
|
.RI "The inverse maps the selected equation residuals back to their physical unknowns\&. "
|
|
.ti -1c
|
|
.RI "struct \fBMatrix\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBPreconditioner\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Typedefs"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "using \fBLayout\fP = \fBdiscretization::blocks::keys::Layout\fP"
|
|
.br
|
|
.RI "Preconditioning consumes the same coordinate layout as every other numerical service\&. "
|
|
.ti -1c
|
|
.RI "template<typename Rows, typename Values> using \fBBlock\fP = \fBoperators::PhysicalBlock\fP<Rows, Values>"
|
|
.br
|
|
.in -1c
|
|
.SH "Typedef Documentation"
|
|
.PP
|
|
.SS "template<typename Rows, typename Values> using \fBserif::solver::preconditioner::keys::Block\fP = \fBoperators::PhysicalBlock\fP<Rows, Values>"
|
|
|
|
.SS "using \fBserif::solver::preconditioner::keys::Layout\fP = \fBdiscretization::blocks::keys::Layout\fP"
|
|
|
|
.PP
|
|
Preconditioning consumes the same coordinate layout as every other numerical service\&.
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|