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

66 lines
2.6 KiB
Groff
Raw Normal View History

.TH "serif::solver::preconditioner::CoupledPreconditioner< First, Second, Policy >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::solver::preconditioner::CoupledPreconditioner< First, Second, Policy > \- Compose physical subsystem descriptions without creating an additional preparation owner\&.
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <coupled\&.hpp>\fP
.SS "Public Types"
.in +1c
.ti -1c
.RI "using \fBRows\fP = \fButils::dependencies::CombinedKeyList\fP<typename First::Rows, typename Second::Rows>"
.br
.ti -1c
.RI "using \fBValues\fP = \fButils::dependencies::CombinedKeyList\fP<typename First::Values, typename Second::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 "First \fBfirst\fP"
.br
.ti -1c
.RI "Second \fBsecond\fP"
.br
.ti -1c
.RI "Policy \fBcoupling\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
.SS "template<typename First, typename Second, typename Policy>
.br
requires DisjointSubsystems<First, Second>
.br
struct serif::solver::preconditioner::CoupledPreconditioner< First, Second, Policy >"Compose physical subsystem descriptions without creating an additional preparation owner\&.
.SH "Member Typedef Documentation"
.PP
.SS "template<typename First, typename Second, typename Policy> using \fBserif::solver::preconditioner::CoupledPreconditioner\fP< First, Second, Policy >::Result = \fBkeys::Inverse\fP<\fBRows\fP, \fBValues\fP>"
.SS "template<typename First, typename Second, typename Policy> using \fBserif::solver::preconditioner::CoupledPreconditioner\fP< First, Second, Policy >::Rows = \fButils::dependencies::CombinedKeyList\fP<typename First::Rows, typename Second::Rows>"
.SS "template<typename First, typename Second, typename Policy> using \fBserif::solver::preconditioner::CoupledPreconditioner\fP< First, Second, Policy >::Values = \fButils::dependencies::CombinedKeyList\fP<typename First::Values, typename Second::Values>"
.SH "Member Data Documentation"
.PP
.SS "template<typename First, typename Second, typename Policy> Policy \fBserif::solver::preconditioner::CoupledPreconditioner\fP< First, Second, Policy >::coupling"
.SS "template<typename First, typename Second, typename Policy> First \fBserif::solver::preconditioner::CoupledPreconditioner\fP< First, Second, Policy >::first"
.SS "template<typename First, typename Second, typename Policy> Second \fBserif::solver::preconditioner::CoupledPreconditioner\fP< First, Second, Policy >::second"
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.