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)
58 lines
1.9 KiB
Groff
58 lines
1.9 KiB
Groff
.TH "src/include/serif/solver/preconditioner/recipes/gravity.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/solver/preconditioner/recipes/gravity.hpp
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include <utility>\fP
|
|
.br
|
|
\fR#include 'serif/discretization/blocks/fields\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/solver/preconditioner/recipes/block\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/solver/preconditioner/strategies/inverse/chebyshev\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/solver/preconditioner/strategies/inverse/fixed_amg\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/solver/preconditioner/strategies/gravity/factorization\&.hpp'\fP
|
|
.br
|
|
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "struct \fBserif::solver::preconditioner::GravityPreconditioner< Gradient, Potential, MassStrategy, SchurStrategy, Policy >\fP"
|
|
.br
|
|
.RI "Approximate the mixed gravity-gradient and potential equations with explicitly selected child inverses\&. "
|
|
.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
|
|
.in -1c
|
|
.SS "Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "template<typename Gradient = discretization::blocks::gravity::gradient, typename Potential = discretization::blocks::gravity::potential, typename MassStrategy, typename SchurStrategy, strategies::gravity::Policy Policy = strategies::gravity::ApproximateLDU> auto \fBserif::solver::preconditioner::make_gravity_preconditioner\fP (MassStrategy mass, SchurStrategy potential, Policy factorization={})"
|
|
.br
|
|
.RI "Select advanced gravity numerics without encoding a particular equation-of-state model\&. "
|
|
.ti -1c
|
|
.RI "auto \fBserif::solver::preconditioner::make_gravity_preconditioner\fP ()"
|
|
.br
|
|
.RI "Preserve MeanField's stellar default: fifth-order mass polynomial, three AMG cycles, and gravity LDU\&. "
|
|
.in -1c
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|