Files
MeanField_SERiF/docs/man/man3/serif_equations_gravity_contributions_DensitySource.3

81 lines
2.5 KiB
Groff
Raw Normal View History

.TH "serif::equations::gravity_contributions::DensitySource" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::equations::gravity_contributions::DensitySource
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <mixed_gravity\&.hpp>\fP
.PP
Inherits \fBserif::equations::Contribution< Operand< Potential >, discretization::domain::StellarDomains >\fP\&.
.SS "Public Types"
.in +1c
.ti -1c
.RI "using \fBOperands\fP = \fButils::types::TypeList\fP<\fBOperand\fP<\fBDensity\fP>>"
.br
.in -1c
Public Types inherited from \fBserif::equations::Contribution< Operand< Potential >, 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 (double coefficient)"
.br
.ti -1c
.RI "\fBPointLinearization\fP< \fBOperands\fP > \fBevaluate\fP (const \fBEquationPoint\fP< \fBOperands\fP > &point) const"
.br
.RI "Only stellar elements contribute -4 pi G q rho to the Poisson volume row\&. "
.ti -1c
.RI "int \fBadditional_order\fP (\fBOperand\fP< \fBDensity\fP >, int) const"
.br
.in -1c
.SS "Public Attributes"
.in +1c
.ti -1c
.RI "double \fBfour_pi_G\fP"
.br
.in -1c
.SH "Member Typedef Documentation"
.PP
.SS "using \fBserif::equations::gravity_contributions::DensitySource::Operands\fP = \fButils::types::TypeList\fP<\fBOperand\fP<\fBDensity\fP>>"
.SH "Constructor & Destructor Documentation"
.PP
.SS "serif::equations::gravity_contributions::DensitySource::DensitySource (double coefficient)\fR [inline]\fP, \fR [explicit]\fP"
.SH "Member Function Documentation"
.PP
.SS "int serif::equations::gravity_contributions::DensitySource::additional_order (\fBOperand\fP< \fBDensity\fP > , int ) const\fR [inline]\fP"
.SS "\fBPointLinearization\fP< \fBOperands\fP > serif::equations::gravity_contributions::DensitySource::evaluate (const \fBEquationPoint\fP< \fBOperands\fP > & point) const\fR [inline]\fP"
.PP
Only stellar elements contribute -4 pi G q rho to the Poisson volume row\&.
.SH "Member Data Documentation"
.PP
.SS "double serif::equations::gravity_contributions::DensitySource::four_pi_G"
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.