.TH "serif::equations::gravity_contributions::GradientValue" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::equations::gravity_contributions::GradientValue \- The point wise contribution to the gravity-gradient relation\&. Note that these contributions are just the point-wise field values\&. 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 field value\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fR#include <mixed_gravity\&.hpp>\fP
.PP
Inherits \fBserif::equations::Contribution< Operand< Gradient > >\fP\&.
.SS "Public Types"

.in +1c
.ti -1c
.RI "using \fBOperands\fP = \fButils::types::TypeList\fP<\fBOperand\fP<\fBGradient\fP>>"
.br
.RI "This equation only depends on the gradient field\&. "
.in -1c

Public Types inherited from \fBserif::equations::Contribution< Operand< Gradient > >\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 "Evaluate the gravity-gradient relation at a given point\&. Fundamentally all this this is doing is returning the gradient of the gravitational potential since to satisfy the gravity-gradient relation that should be zero\&. The derivative of the residual with respect to the gradient along each axis is then just the identity matrix\&. "
.ti -1c
.RI "static int \fBadditional_order\fP (\fBOperand\fP< \fBGradient\fP >, int)"
.br
.RI "Return the additional order of the gravity-gradient relation with respect to the gradient operand\&. "
.in -1c
.SH "Detailed Description"
.PP 
The point wise contribution to the gravity-gradient relation\&. Note that these contributions are just the point-wise field values\&. 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 field value\&. 

\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::GradientValue::Operands\fP = \fButils::types::TypeList\fP<\fBOperand\fP<\fBGradient\fP>>"

.PP
This equation only depends on the gradient field\&. 
.SH "Member Function Documentation"
.PP 
.SS "static int serif::equations::gravity_contributions::GradientValue::additional_order (\fBOperand\fP< \fBGradient\fP > , int )\fR [inline]\fP, \fR [static]\fP"

.PP
Return the additional order of the gravity-gradient relation with respect to the gradient operand\&. 
.PP
\fBParameters\fP
.RS 4
\fIoperand-type\fP The type of the operand being evaluated, which must be the gradient 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 gravity-gradient relation with respect to the gradient operand, which is always 0\&. 
.RE
.PP

.SS "static \fBPointLinearization\fP< \fBOperands\fP, \fBdiscretization::forms::VectorValue\fP > serif::equations::gravity_contributions::GradientValue::evaluate (const \fBEquationPoint\fP< \fBOperands\fP > & point)\fR [inline]\fP, \fR [static]\fP"

.PP
Evaluate the gravity-gradient relation at a given point\&. Fundamentally all this this is doing is returning the gradient of the gravitational potential since to satisfy the gravity-gradient relation that should be zero\&. The derivative of the residual with respect to the gradient along each axis is then just the identity matrix\&. 
.PP
\fBParameters\fP
.RS 4
\fIpoint\fP The point at which to evaluate the gravity-gradient relation\&. 
.RE
.PP
\fBReturns\fP
.RS 4
A \fBPointLinearization\fP object containing the residual and field derivatives for the gravity-gradient relation at the given point\&. 
.RE
.PP


.SH "Author"
.PP 
Generated automatically by Doxygen for SERiF from the source code\&.