Files
MeanField_SERiF/docs/man/man3/default_preconditioners.hpp.3

85 lines
2.7 KiB
Groff
Raw Normal View History

.TH "src/include/serif/solver/preconditioner/default_preconditioners.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/solver/preconditioner/default_preconditioners.hpp
.SH SYNOPSIS
.br
.PP
\fR#include <concepts>\fP
.br
\fR#include <type_traits>\fP
.br
\fR#include 'serif/discretization/blocks/concepts\&.hpp'\fP
.br
\fR#include 'serif/discretization/blocks/fields\&.hpp'\fP
.br
\fR#include 'serif/discretization/blocks/system_layout\&.hpp'\fP
.br
\fR#include 'serif/solver/preconditioner/recipes/bordered\&.hpp'\fP
.br
\fR#include 'serif/solver/preconditioner/recipes/block\&.hpp'\fP
.br
\fR#include 'serif/solver/preconditioner/strategies/inverse/diagonal\&.hpp'\fP
.br
\fR#include 'serif/solver/preconditioner/strategies/inverse/fixed_amg\&.hpp'\fP
.br
\fR#include 'serif/solver/preconditioner/strategies/inverse/sparse_direct\&.hpp'\fP
.br
.SS "Classes"
.in +1c
.ti -1c
.RI "struct \fBserif::solver::preconditioner::detail::PrimalCoordinates< utils::dependencies::KeyList< Coordinates\&.\&.\&. >, Shape >\fP"
.br
.in -1c
.SS "Namespaces"
.in +1c
.ti -1c
.RI "namespace \fBserif\fP"
.br
.ti -1c
.RI "namespace \fBserif::solver\fP"
.br
.ti -1c
.RI "namespace \fBserif::solver::preconditioner\fP"
.br
.ti -1c
.RI "namespace \fBserif::solver::preconditioner::detail\fP"
.br
.in -1c
.SS "Concepts"
.in +1c
.ti -1c
.RI "concept \fBserif::solver::preconditioner::PrimalPreconditionerLayout\fP"
.br
.RI "Require density and potential fields with paired optional shape and scalar constraints\&. "
.in -1c
.SS "Typedefs"
.in +1c
.ti -1c
.RI "using \fBserif::solver::preconditioner::detail::PrimalFields\fP = \fButils::dependencies::KeyList\fP<\fBdiscretization::blocks::density::mass\fP, \fBdiscretization::blocks::gravity::potential\fP>"
.br
.ti -1c
.RI "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>"
.br
.ti -1c
.RI "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>"
.br
.in -1c
.SS "Functions"
.in +1c
.ti -1c
.RI "template<PrimalPreconditionerLayout Layout, typename PotentialInverse = strategies::inverse::FixedAMG> auto \fBserif::solver::preconditioner::make_primal_preconditioner\fP (const Layout &, PotentialInverse potential_inverse=\fBstrategies::inverse::FixedAMG\fP{\&.cycles=3})"
.br
.RI "Couple scalar density and potential responses, then correct every shape and global constraint together\&. "
.in -1c
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.