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)
107 lines
4.6 KiB
Groff
107 lines
4.6 KiB
Groff
.TH "serif::equations::gravity_contributions::PotentialValue" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::equations::gravity_contributions::PotentialValue \- The point wise contribution to the Poisson balance equation\&. Note that these contributions are just the point-wise potential values\&. You can get to this by going through the weak form derivation\&. The derivative is just one since the residual is just the variable\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <mixed_gravity\&.hpp>\fP
|
|
.PP
|
|
Inherits \fBserif::equations::Contribution< Operand< Gradient, Divergence > >\fP\&.
|
|
.SS "Public Types"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "using \fBOperands\fP = \fButils::types::TypeList\fP<\fBOperand\fP<\fBPotential\fP>>"
|
|
.br
|
|
.RI "This equation only depends on the potential field\&. "
|
|
.in -1c
|
|
|
|
Public Types inherited from \fBserif::equations::Contribution< Operand< Gradient, Divergence > >\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 > \fBevaluate\fP (const \fBEquationPoint\fP< \fBOperands\fP > &point)"
|
|
.br
|
|
.RI "Evaluate the Poisson balance equation at a given point\&. Fundamentally all this this is doing is returning the gravitational potential since to satisfy the Poisson balance equation that should be zero\&. The derivative of the residual with respect to the potential is then just one\&. "
|
|
.ti -1c
|
|
.RI "static int \fBadditional_order\fP (\fBOperand\fP< \fBPotential\fP >, int)"
|
|
.br
|
|
.RI "Return the additional order of the Poisson balance equation with respect to the potential operand\&. The contribution is linear in potential so the additional order is always 0\&. "
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
The point wise contribution to the Poisson balance equation\&. Note that these contributions are just the point-wise potential values\&. You can get to this by going through the weak form derivation\&. The derivative is just one since the residual is just the variable\&.
|
|
|
|
\fBEquation\fP \fBContributions\fP
|
|
.PD 0
|
|
.IP "\(bu" 2
|
|
Residuals to the gravity-gradient relation row of the system\&.
|
|
.PP
|
|
|
|
.SH "Member Typedef Documentation"
|
|
.PP
|
|
.SS "using \fBserif::equations::gravity_contributions::PotentialValue::Operands\fP = \fButils::types::TypeList\fP<\fBOperand\fP<\fBPotential\fP>>"
|
|
|
|
.PP
|
|
This equation only depends on the potential field\&.
|
|
.SH "Member Function Documentation"
|
|
.PP
|
|
.SS "static int serif::equations::gravity_contributions::PotentialValue::additional_order (\fBOperand\fP< \fBPotential\fP > , int )\fR [inline]\fP, \fR [static]\fP"
|
|
|
|
.PP
|
|
Return the additional order of the Poisson balance equation with respect to the potential operand\&. The contribution is linear in potential so the additional order is always 0\&.
|
|
.PP
|
|
\fBParameters\fP
|
|
.RS 4
|
|
\fIoperand-type\fP The type of the operand being evaluated, which must be the potential operand\&.
|
|
.br
|
|
\fIposition-order\fP The order of the position being evaluated, which is not used in this implementation\&.
|
|
.RE
|
|
.PP
|
|
\fBReturns\fP
|
|
.RS 4
|
|
The additional order of the Poisson balance equation with respect to the potential operand, which is always 0\&.
|
|
.RE
|
|
.PP
|
|
|
|
.SS "static \fBPointLinearization\fP< \fBOperands\fP > serif::equations::gravity_contributions::PotentialValue::evaluate (const \fBEquationPoint\fP< \fBOperands\fP > & point)\fR [inline]\fP, \fR [static]\fP"
|
|
|
|
.PP
|
|
Evaluate the Poisson balance equation at a given point\&. Fundamentally all this this is doing is returning the gravitational potential since to satisfy the Poisson balance equation that should be zero\&. The derivative of the residual with respect to the potential is then just one\&. When you go through the weak form derivation and the integration by parts you find that the point wise contribution to the gravity gradient row of the system is the divergence of the test function times the potential\&. $ \left(\nabla \cdot v\right) \phi $\&. The derivative is then trivially one\&.
|
|
|
|
.PP
|
|
\fBParameters\fP
|
|
.RS 4
|
|
\fIpoint\fP The point at which to evaluate the Poisson balance equation\&.
|
|
.RE
|
|
.PP
|
|
\fBReturns\fP
|
|
.RS 4
|
|
A \fBPointLinearization\fP object containing the residual and field derivatives for the Poisson balance equation at the given point\&.
|
|
.RE
|
|
.PP
|
|
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|