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

69 lines
3.2 KiB
Groff
Raw Normal View History

.TH "serif::solver::preconditioner::SurfacePreconditioner< Field, Row, Strategy, Backend >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::solver::preconditioner::SurfacePreconditioner< Field, Row, Strategy, Backend > \- Declare shape physics separately from the positive H1 matrix inverse used when that strategy needs one\&.
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <surface\&.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
.ti -1c
.RI "using \fBSurfaceStrategy\fP = Strategy"
.br
.ti -1c
.RI "using \fBInverseStrategy\fP = Backend"
.br
.in -1c
.SS "Public Attributes"
.in +1c
.ti -1c
.RI "Strategy \fBsurface\fP"
.br
.ti -1c
.RI "Backend \fBinverse\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
.SS "template<typename Field, typename Row, \fBSurfaceStrategy\fP Strategy, typename Backend = strategies::inverse::FixedAMG>
.br
struct serif::solver::preconditioner::SurfacePreconditioner< Field, Row, Strategy, Backend >"Declare shape physics separately from the positive H1 matrix inverse used when that strategy needs one\&.
.SH "Member Typedef Documentation"
.PP
.SS "template<typename Field, typename Row, \fBSurfaceStrategy\fP Strategy, typename Backend = strategies::inverse::FixedAMG> using \fBserif::solver::preconditioner::SurfacePreconditioner\fP< Field, Row, Strategy, Backend >::InverseStrategy = Backend"
.SS "template<typename Field, typename Row, \fBSurfaceStrategy\fP Strategy, typename Backend = strategies::inverse::FixedAMG> using \fBserif::solver::preconditioner::SurfacePreconditioner\fP< Field, Row, Strategy, Backend >::Result = \fBkeys::Inverse\fP<\fBRows\fP, \fBValues\fP>"
.SS "template<typename Field, typename Row, \fBSurfaceStrategy\fP Strategy, typename Backend = strategies::inverse::FixedAMG> using \fBserif::solver::preconditioner::SurfacePreconditioner\fP< Field, Row, Strategy, Backend >::Rows = \fButils::dependencies::KeyList\fP<Row>"
.SS "template<typename Field, typename Row, \fBSurfaceStrategy\fP Strategy, typename Backend = strategies::inverse::FixedAMG> using \fBserif::solver::preconditioner::SurfacePreconditioner\fP< Field, Row, Strategy, Backend >::SurfaceStrategy = Strategy"
.SS "template<typename Field, typename Row, \fBSurfaceStrategy\fP Strategy, typename Backend = strategies::inverse::FixedAMG> using \fBserif::solver::preconditioner::SurfacePreconditioner\fP< Field, Row, Strategy, Backend >::Values = \fButils::dependencies::KeyList\fP<Field>"
.SH "Member Data Documentation"
.PP
.SS "template<typename Field, typename Row, \fBSurfaceStrategy\fP Strategy, typename Backend = strategies::inverse::FixedAMG> Backend \fBserif::solver::preconditioner::SurfacePreconditioner\fP< Field, Row, Strategy, Backend >::inverse"
.SS "template<typename Field, typename Row, \fBSurfaceStrategy\fP Strategy, typename Backend = strategies::inverse::FixedAMG> Strategy \fBserif::solver::preconditioner::SurfacePreconditioner\fP< Field, Row, Strategy, Backend >::surface"
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.