SERiF v0.0.1a
Stellar Evolution and Rotation in Four Dimensions
Loading...
Searching...
No Matches
serif::equations::gravity_contributions::GradientValue Class Reference

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. More...

#include <mixed_gravity.hpp>

Inheritance diagram for serif::equations::gravity_contributions::GradientValue:
[legend]
Collaboration diagram for serif::equations::gravity_contributions::GradientValue:
[legend]

Public Types

using Operands = utils::types::TypeList<Operand<Gradient>>
 This equation only depends on the gradient field.
 
- Public Types inherited from serif::equations::Contribution< Operand< Gradient > >
using Test
 The test type of the contribution.
 
using TestOperand
 The operand type of the contribution (associating a test function and a term)
 
using Support
 The domain support of the contribution (which then boils down to the dofs which are supported by the term on that test function)
 

Static Public Member Functions

static PointLinearization< Operands, discretization::forms::VectorValue > evaluate (const EquationPoint< Operands > &point)
 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.
 
static int additional_order (Operand< Gradient >, int)
 Return the additional order of the gravity-gradient relation with respect to the gradient operand.
 

Detailed Description

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.

Equation Contributions
  • Residuals to the gravity-gradient relation row of the system.

Member Typedef Documentation

◆ Operands

Member Function Documentation

◆ additional_order()

static int serif::equations::gravity_contributions::GradientValue::additional_order ( Operand< Gradient > ,
int  )
inlinestatic

Return the additional order of the gravity-gradient relation with respect to the gradient operand.

Parameters
operand-typeThe type of the operand being evaluated, which must be the gradient operand.
position-orderThe order of the position being evaluated, which is not used in this implementation.
Returns
The additional order of the gravity-gradient relation with respect to the gradient operand, which is always 0.

◆ evaluate()

static PointLinearization< Operands, discretization::forms::VectorValue > serif::equations::gravity_contributions::GradientValue::evaluate ( const EquationPoint< Operands > & point)
inlinestatic

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.

Parameters
pointThe point at which to evaluate the gravity-gradient relation.
Returns
A PointLinearization object containing the residual and field derivatives for the gravity-gradient relation at the given point.

The documentation for this class was generated from the following file: