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)
95 lines
3.1 KiB
Groff
95 lines
3.1 KiB
Groff
.TH "serif::equations::PrimalPoissonBalance::DensitySource" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::equations::PrimalPoissonBalance::DensitySource \- Integrate +4 pi G v rho only where matter is supported\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <primal_gravity\&.hpp>\fP
|
|
.PP
|
|
Inherits \fBserif::equations::Contribution< discretization::forms::Operand< Test >, discretization::domain::StellarDomains >\fP\&.
|
|
.SS "Public Types"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "using \fBOperands\fP = \fButils::types::TypeList\fP<\fBdiscretization::forms::Operand\fP<\fBDensity\fP>>"
|
|
.br
|
|
.in -1c
|
|
|
|
Public Types inherited from \fBserif::equations::Contribution< discretization::forms::Operand< Test >, discretization::domain::StellarDomains >\fP
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "using \fBTest\fP"
|
|
.br
|
|
.RI "The test type of the contribution\&. "
|
|
.ti -1c
|
|
.RI "using \fBTestOperand\fP"
|
|
.br
|
|
.RI "The operand type of the contribution (associating a test function and a term) "
|
|
.ti -1c
|
|
.RI "using \fBSupport\fP"
|
|
.br
|
|
.RI "The domain support of the contribution (which then boils down to the dofs which are supported by the term on that test function) "
|
|
.in -1c
|
|
.SS "Public Member Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "\fBDensitySource\fP (const double coefficient)"
|
|
.br
|
|
.RI "Store the already validated source coefficient\&. "
|
|
.ti -1c
|
|
.RI "\fBPointLinearization\fP< \fBOperands\fP > \fBevaluate\fP (const \fBEquationPoint\fP< \fBOperands\fP > &point) const"
|
|
.br
|
|
.RI "Return the source with the positive sign of the primal weak form\&. "
|
|
.in -1c
|
|
.SS "Static Public Member Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "static int \fBadditional_order\fP (\fBdiscretization::forms::Operand\fP< \fBDensity\fP >, int)"
|
|
.br
|
|
.RI "The source is linear in density\&. "
|
|
.in -1c
|
|
.SS "Public Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "double \fBfour_pi_G\fP"
|
|
.br
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
Integrate +4 pi G v rho only where matter is supported\&.
|
|
.SH "Member Typedef Documentation"
|
|
.PP
|
|
.SS "using \fBserif::equations::PrimalPoissonBalance::DensitySource::Operands\fP = \fButils::types::TypeList\fP<\fBdiscretization::forms::Operand\fP<\fBDensity\fP>>"
|
|
|
|
.SH "Constructor & Destructor Documentation"
|
|
.PP
|
|
.SS "serif::equations::PrimalPoissonBalance::DensitySource::DensitySource (const double coefficient)\fR [inline]\fP, \fR [explicit]\fP"
|
|
|
|
.PP
|
|
Store the already validated source coefficient\&.
|
|
.SH "Member Function Documentation"
|
|
.PP
|
|
.SS "static int serif::equations::PrimalPoissonBalance::DensitySource::additional_order (\fBdiscretization::forms::Operand\fP< \fBDensity\fP > , int )\fR [inline]\fP, \fR [static]\fP, \fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
The source is linear in density\&.
|
|
.SS "\fBPointLinearization\fP< \fBOperands\fP > serif::equations::PrimalPoissonBalance::DensitySource::evaluate (const \fBEquationPoint\fP< \fBOperands\fP > & point) const\fR [inline]\fP, \fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Return the source with the positive sign of the primal weak form\&.
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "double serif::equations::PrimalPoissonBalance::DensitySource::four_pi_G"
|
|
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|