74 lines
2.8 KiB
Groff
74 lines
2.8 KiB
Groff
|
|
.TH "serif::equations::gravity_contributions::GradientDivergence" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
||
|
|
.ad l
|
||
|
|
.nh
|
||
|
|
.SH NAME
|
||
|
|
serif::equations::gravity_contributions::GradientDivergence \- The point wise contribution to the Poisson balance equation\&. Note that these contributions are just the point-wise divergence of the gradient field\&. You can get to this by going through the weak form derivation\&. The derivative is just the identity matrix since the residual is just the divergence of the gradient field\&.
|
||
|
|
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.br
|
||
|
|
.PP
|
||
|
|
.PP
|
||
|
|
\fR#include <mixed_gravity\&.hpp>\fP
|
||
|
|
.PP
|
||
|
|
Inherits \fBserif::equations::Contribution< Operand< Potential > >\fP\&.
|
||
|
|
.SS "Public Types"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "using \fBOperands\fP = \fButils::types::TypeList\fP<\fBOperand\fP<\fBGradient\fP, \fBDivergence\fP>>"
|
||
|
|
.br
|
||
|
|
.in -1c
|
||
|
|
|
||
|
|
Public Types inherited from \fBserif::equations::Contribution< Operand< Potential > >\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 "\fBPointLinearization\fP< \fBOperands\fP > \fBevaluate\fP (const \fBEquationPoint\fP< \fBOperands\fP > &point) const"
|
||
|
|
.br
|
||
|
|
.RI "Poisson's volume row contains + q div(g)\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "int \fBadditional_order\fP (\fBOperand\fP< \fBGradient\fP, \fBDivergence\fP >, int) const"
|
||
|
|
.br
|
||
|
|
.in -1c
|
||
|
|
.SH "Detailed Description"
|
||
|
|
.PP
|
||
|
|
The point wise contribution to the Poisson balance equation\&. Note that these contributions are just the point-wise divergence of the gradient field\&. You can get to this by going through the weak form derivation\&. The derivative is just the identity matrix since the residual is just the divergence of the gradient field\&.
|
||
|
|
|
||
|
|
\fBEquation\fP \fBContributions\fP
|
||
|
|
.PD 0
|
||
|
|
.IP "\(bu" 2
|
||
|
|
Residuals to the gravitational potential row of the system\&.
|
||
|
|
.PP
|
||
|
|
|
||
|
|
.SH "Member Typedef Documentation"
|
||
|
|
.PP
|
||
|
|
.SS "using \fBserif::equations::gravity_contributions::GradientDivergence::Operands\fP = \fButils::types::TypeList\fP<\fBOperand\fP<\fBGradient\fP, \fBDivergence\fP>>"
|
||
|
|
|
||
|
|
.SH "Member Function Documentation"
|
||
|
|
.PP
|
||
|
|
.SS "int serif::equations::gravity_contributions::GradientDivergence::additional_order (\fBOperand\fP< \fBGradient\fP, \fBDivergence\fP > , int ) const\fR [inline]\fP"
|
||
|
|
|
||
|
|
.SS "\fBPointLinearization\fP< \fBOperands\fP > serif::equations::gravity_contributions::GradientDivergence::evaluate (const \fBEquationPoint\fP< \fBOperands\fP > & point) const\fR [inline]\fP"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
Poisson's volume row contains + q div(g)\&.
|
||
|
|
|
||
|
|
.SH "Author"
|
||
|
|
.PP
|
||
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|