.TH "serif::equations::PrimalPoissonBalance" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::equations::PrimalPoissonBalance \- Solve Delta(Phi) = 4 pi G rho with one conforming scalar potential field\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fR#include <primal_gravity\&.hpp>\fP
.SS "Classes"

.in +1c
.ti -1c
.RI "struct \fBDensitySource\fP"
.br
.RI "Integrate +4 pi G v rho only where matter is supported\&. "
.ti -1c
.RI "struct \fBPotentialFlux\fP"
.br
.RI "Integrate grad(v) dot grad(Phi) throughout the star and vacuum\&. "
.in -1c
.SS "Public Types"

.in +1c
.ti -1c
.RI "using \fBTest\fP = \fBdiscretization::blocks::gravity::potential\fP"
.br
.ti -1c
.RI "using \fBDensity\fP = \fBdiscretization::blocks::density::mass\fP"
.br
.ti -1c
.RI "using \fBPotentialGradient\fP = \fBdiscretization::forms::Operand\fP<\fBTest\fP, \fBdiscretization::forms::Operation::Gradient\fP>"
.br
.ti -1c
.RI "using \fBResidualQuantity\fP = \fBdimensions::InverseTimeSquared\fP"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBPrimalPoissonBalance\fP (const double \fBfour_pi_G\fP)"
.br
.RI "Set positive finite 4 pi G; impose the zero trace at infinity separately\&. "
.ti -1c
.RI "auto \fBcontributions\fP () const"
.br
.RI "Publish the diffusion term and stellar source to the existing volume assembler\&. "
.ti -1c
.RI "double \fBfour_pi_G\fP () const noexcept"
.br
.RI "Inspect the physical source coefficient for serialization\&. "
.in -1c
.SS "Static Public Attributes"

.in +1c
.ti -1c
.RI "static constexpr std::string_view \fBname\fP = 'primal Poisson balance'"
.br
.in -1c
.SS "Private Attributes"

.in +1c
.ti -1c
.RI "double \fBm_four_pi_G\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
Solve Delta(Phi) = 4 pi G rho with one conforming scalar potential field\&. 
.SH "Member Typedef Documentation"
.PP 
.SS "using \fBserif::equations::PrimalPoissonBalance::Density\fP = \fBdiscretization::blocks::density::mass\fP"

.SS "using \fBserif::equations::PrimalPoissonBalance::PotentialGradient\fP = \fBdiscretization::forms::Operand\fP<\fBTest\fP, \fBdiscretization::forms::Operation::Gradient\fP>"

.SS "using \fBserif::equations::PrimalPoissonBalance::ResidualQuantity\fP = \fBdimensions::InverseTimeSquared\fP"

.SS "using \fBserif::equations::PrimalPoissonBalance::Test\fP = \fBdiscretization::blocks::gravity::potential\fP"

.SH "Constructor & Destructor Documentation"
.PP 
.SS "serif::equations::PrimalPoissonBalance::PrimalPoissonBalance (const double four_pi_G)\fR [inline]\fP, \fR [explicit]\fP"

.PP
Set positive finite 4 pi G; impose the zero trace at infinity separately\&. 
.SH "Member Function Documentation"
.PP 
.SS "auto serif::equations::PrimalPoissonBalance::contributions () const\fR [inline]\fP, \fR [nodiscard]\fP"

.PP
Publish the diffusion term and stellar source to the existing volume assembler\&. 
.SS "double serif::equations::PrimalPoissonBalance::four_pi_G () const\fR [inline]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"

.PP
Inspect the physical source coefficient for serialization\&. 
.SH "Member Data Documentation"
.PP 
.SS "double serif::equations::PrimalPoissonBalance::m_four_pi_G\fR [private]\fP"

.SS "std::string_view serif::equations::PrimalPoissonBalance::name = 'primal Poisson balance'\fR [static]\fP, \fR [constexpr]\fP"


.SH "Author"
.PP 
Generated automatically by Doxygen for SERiF from the source code\&.