70 lines
2.4 KiB
Groff
70 lines
2.4 KiB
Groff
|
|
.TH "serif::equations::PrimalPoissonBalance::PotentialFlux" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
||
|
|
.ad l
|
||
|
|
.nh
|
||
|
|
.SH NAME
|
||
|
|
serif::equations::PrimalPoissonBalance::PotentialFlux \- Integrate grad(v) dot grad(Phi) throughout the star and vacuum\&.
|
||
|
|
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.br
|
||
|
|
.PP
|
||
|
|
.PP
|
||
|
|
\fR#include <primal_gravity\&.hpp>\fP
|
||
|
|
.PP
|
||
|
|
Inherits \fBserif::equations::Contribution< PotentialGradient >\fP\&.
|
||
|
|
.SS "Public Types"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "using \fBOperands\fP = \fButils::types::TypeList\fP<\fBPotentialGradient\fP>"
|
||
|
|
.br
|
||
|
|
.in -1c
|
||
|
|
|
||
|
|
Public Types inherited from \fBserif::equations::Contribution< PotentialGradient >\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 "Static Public Member Functions"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "static \fBPointLinearization\fP< \fBOperands\fP, \fBdiscretization::forms::VectorValue\fP > \fBevaluate\fP (const \fBEquationPoint\fP< \fBOperands\fP > &point)"
|
||
|
|
.br
|
||
|
|
.RI "The potential flux and its derivative are grad(Phi) and identity\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "static int \fBadditional_order\fP (\fBPotentialGradient\fP, int)"
|
||
|
|
.br
|
||
|
|
.RI "A linear flux introduces no additional coefficient degree\&. "
|
||
|
|
.in -1c
|
||
|
|
.SH "Detailed Description"
|
||
|
|
.PP
|
||
|
|
Integrate grad(v) dot grad(Phi) throughout the star and vacuum\&.
|
||
|
|
.SH "Member Typedef Documentation"
|
||
|
|
.PP
|
||
|
|
.SS "using \fBserif::equations::PrimalPoissonBalance::PotentialFlux::Operands\fP = \fButils::types::TypeList\fP<\fBPotentialGradient\fP>"
|
||
|
|
|
||
|
|
.SH "Member Function Documentation"
|
||
|
|
.PP
|
||
|
|
.SS "static int serif::equations::PrimalPoissonBalance::PotentialFlux::additional_order (\fBPotentialGradient\fP , int )\fR [inline]\fP, \fR [static]\fP, \fR [nodiscard]\fP"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
A linear flux introduces no additional coefficient degree\&.
|
||
|
|
.SS "static \fBPointLinearization\fP< \fBOperands\fP, \fBdiscretization::forms::VectorValue\fP > serif::equations::PrimalPoissonBalance::PotentialFlux::evaluate (const \fBEquationPoint\fP< \fBOperands\fP > & point)\fR [inline]\fP, \fR [static]\fP, \fR [nodiscard]\fP"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
The potential flux and its derivative are grad(Phi) and identity\&.
|
||
|
|
|
||
|
|
.SH "Author"
|
||
|
|
.PP
|
||
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|