71 lines
1.8 KiB
Groff
71 lines
1.8 KiB
Groff
|
|
.TH "serif::solver::preconditioner::strategies::gravity" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
||
|
|
.ad l
|
||
|
|
.nh
|
||
|
|
.SH NAME
|
||
|
|
serif::solver::preconditioner::strategies::gravity
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.br
|
||
|
|
.PP
|
||
|
|
.SS "Classes"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "struct \fBApproximateLDU\fP"
|
||
|
|
.br
|
||
|
|
.RI "Apply the signed mass/Schur factorization once\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "struct \fBBlockDiagonal\fP"
|
||
|
|
.br
|
||
|
|
.RI "Independently invert mass and the positive potential Schur operator\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "struct \fBConsistentSchurLDU\fP"
|
||
|
|
.br
|
||
|
|
.RI "Refine potential against B R Bᵀ with fixed work; positive relaxation does not guarantee contraction\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "struct \fBLowerTriangular\fP"
|
||
|
|
.br
|
||
|
|
.RI "Recover gravity gradient before correcting the potential residual\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "struct \fBUpperTriangular\fP"
|
||
|
|
.br
|
||
|
|
.RI "Recover potential before correcting the gravity-gradient residual\&. "
|
||
|
|
.in -1c
|
||
|
|
.SS "Concepts"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "concept \fBPolicy\fP"
|
||
|
|
.br
|
||
|
|
.RI "Restrict mixed-gravity preparation to the supported signed factorizations\&. "
|
||
|
|
.in -1c
|
||
|
|
.SS "Enumerations"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "enum class \fBFactorization\fP { \fBblock_diagonal\fP, \fBlower_triangular\fP, \fBupper_triangular\fP, \fBapproximate_ldu\fP, \fBconsistent_schur_ldu\fP }"
|
||
|
|
.br
|
||
|
|
.RI "The five signed approximations to the mixed gravity-gradient and potential equations\&. "
|
||
|
|
.in -1c
|
||
|
|
.SH "Enumeration Type Documentation"
|
||
|
|
.PP
|
||
|
|
.SS "enum class \fBserif::solver::preconditioner::strategies::gravity::Factorization\fP\fR [strong]\fP"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
The five signed approximations to the mixed gravity-gradient and potential equations\&.
|
||
|
|
.PP
|
||
|
|
\fBEnumerator\fP
|
||
|
|
.in +1c
|
||
|
|
.TP
|
||
|
|
\f(BIblock_diagonal \fP
|
||
|
|
.TP
|
||
|
|
\f(BIlower_triangular \fP
|
||
|
|
.TP
|
||
|
|
\f(BIupper_triangular \fP
|
||
|
|
.TP
|
||
|
|
\f(BIapproximate_ldu \fP
|
||
|
|
.TP
|
||
|
|
\f(BIconsistent_schur_ldu \fP
|
||
|
|
.SH "Author"
|
||
|
|
.PP
|
||
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|