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

74 lines
3.8 KiB
Groff
Raw Normal View History

.TH "serif::solver::preconditioner::detail" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::solver::preconditioner::detail
.SH SYNOPSIS
.br
.PP
.SS "Classes"
.in +1c
.ti -1c
.RI "struct \fBPrimalCoordinates\fP"
.br
.RI "Separate the primal fields from scalar constraints and optional shape coordinates\&. "
.ti -1c
.RI "struct \fBPrimalCoordinates< utils::dependencies::KeyList< Coordinates\&.\&.\&. >, Shape >\fP"
.br
.in -1c
.SS "Typedefs"
.in +1c
.ti -1c
.RI "using \fBPrimalFields\fP = \fButils::dependencies::KeyList\fP<\fBdiscretization::blocks::density::mass\fP, \fBdiscretization::blocks::gravity::potential\fP>"
.br
.ti -1c
.RI "template<typename Layout> using \fBPrimalValues\fP = \fBPrimalCoordinates\fP<typename std::remove_cvref_t<Layout>::Values, \fBdiscretization::blocks::surface_deformation::coefficients\fP>"
.br
.ti -1c
.RI "template<typename Layout> using \fBPrimalRows\fP = \fBPrimalCoordinates\fP<typename std::remove_cvref_t<Layout>::Residuals, \fBdiscretization::blocks::surface_deformation::shape_equilibrium\fP>"
.br
.in -1c
.SS "Functions"
.in +1c
.ti -1c
.RI "template<typename Row, typename Field, typename Strategy> auto \fBpreconditioner_computations\fP (const \fBBlockPreconditioner\fP< Row, Field, Strategy > &choice)"
.br
.RI "Declare recursive recipe expansion before its composed overloads are defined\&. "
.ti -1c
.RI "template<typename First, typename Second, typename Policy> auto \fBpreconditioner_computations\fP (const \fBCoupledPreconditioner\fP< First, Second, Policy > &choice)"
.br
.RI "Declare the composed recipe overload for recursive graph expansion\&. "
.ti -1c
.RI "template<typename Fields, typename Constraints> auto \fBpreconditioner_computations\fP (const \fBBorderedPreconditioner\fP< Fields, Constraints > &choice)"
.br
.RI "Declare the composed recipe overload for recursive graph expansion\&. "
.in -1c
.SH "Typedef Documentation"
.PP
.SS "using \fBserif::solver::preconditioner::detail::PrimalFields\fP = \fButils::dependencies::KeyList\fP<\fBdiscretization::blocks::density::mass\fP, \fBdiscretization::blocks::gravity::potential\fP>"
.SS "template<typename Layout> using \fBserif::solver::preconditioner::detail::PrimalRows\fP = \fBPrimalCoordinates\fP<typename std::remove_cvref_t<Layout>::Residuals, \fBdiscretization::blocks::surface_deformation::shape_equilibrium\fP>"
.SS "template<typename Layout> using \fBserif::solver::preconditioner::detail::PrimalValues\fP = \fBPrimalCoordinates\fP<typename std::remove_cvref_t<Layout>::Values, \fBdiscretization::blocks::surface_deformation::coefficients\fP>"
.SH "Function Documentation"
.PP
.SS "template<typename Row, typename Field, typename Strategy> auto serif::solver::preconditioner::detail::preconditioner_computations (const \fBBlockPreconditioner\fP< Row, Field, Strategy > & choice)\fR [nodiscard]\fP"
.PP
Declare recursive recipe expansion before its composed overloads are defined\&. Assemble exactly the physical representation required by the leaf inverse strategy\&.
.SS "template<typename Fields, typename Constraints> auto serif::solver::preconditioner::detail::preconditioner_computations (const \fBBorderedPreconditioner\fP< Fields, Constraints > & choice)\fR [nodiscard]\fP"
.PP
Declare the composed recipe overload for recursive graph expansion\&. The constraint stage depends explicitly on its field inverse, so changing that inverse refreshes Schur setup\&.
.SS "template<typename First, typename Second, typename Policy> auto serif::solver::preconditioner::detail::preconditioner_computations (const \fBCoupledPreconditioner\fP< First, Second, Policy > & choice)\fR [nodiscard]\fP"
.PP
Declare the composed recipe overload for recursive graph expansion\&. The first and second physical branches meet only in their declared coupling computation\&.
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.