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)
69 lines
1.6 KiB
Groff
69 lines
1.6 KiB
Groff
.TH "serif::equations::PoissonBalance" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::equations::PoissonBalance
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <mixed_gravity\&.hpp>\fP
|
|
.SS "Public Types"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "using \fBTest\fP = \fBdiscretization::blocks::gravity::potential\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "using \fBResidualQuantity\fP = \fBdimensions::InverseTimeSquared\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Public Member Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "\fBPoissonBalance\fP (double four_pi_G)"
|
|
.br
|
|
.ti -1c
|
|
.RI "auto \fBcontributions\fP () const"
|
|
.br
|
|
.in -1c
|
|
.SS "Static Public Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "static constexpr std::string_view \fBname\fP = 'Poisson balance'"
|
|
.br
|
|
.in -1c
|
|
.SS "Private Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "double \fBm_four_pi_G\fP"
|
|
.br
|
|
.in -1c
|
|
.SH "Member Typedef Documentation"
|
|
.PP
|
|
.SS "using \fBserif::equations::PoissonBalance::ResidualQuantity\fP = \fBdimensions::InverseTimeSquared\fP"
|
|
|
|
.SS "using \fBserif::equations::PoissonBalance::Test\fP = \fBdiscretization::blocks::gravity::potential\fP"
|
|
|
|
.SH "Constructor & Destructor Documentation"
|
|
.PP
|
|
.SS "serif::equations::PoissonBalance::PoissonBalance (double four_pi_G)\fR [inline]\fP, \fR [explicit]\fP"
|
|
|
|
.SH "Member Function Documentation"
|
|
.PP
|
|
.SS "auto serif::equations::PoissonBalance::contributions () const\fR [inline]\fP"
|
|
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "double serif::equations::PoissonBalance::m_four_pi_G\fR [private]\fP"
|
|
|
|
.SS "std::string_view serif::equations::PoissonBalance::name = 'Poisson balance'\fR [static]\fP, \fR [constexpr]\fP"
|
|
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|