SERiF v0.0.1a
Stellar Evolution and Rotation in Four Dimensions
Loading...
Searching...
No Matches
serif::equations::PointLinearization< OperandsT, ResultT > Struct Template Reference

A struct to represent the linearization of a pointwise equation at a given point in space. This includes the residual and the local derivatives of the operands with respect to the test operand value, as well as the local derivative of the test operand value with respect to position. More...

#include <point.hpp>

Collaboration diagram for serif::equations::PointLinearization< OperandsT, ResultT >:
[legend]

Public Attributes

ResultT residual {}
 The residual of the pointwise equation at the given point in space, which is of type ResultT. Note the inner product of these with some operation on a test function will be integrated over the domain by the operator backend to produce the global residual.
 
OperandValues< OperandsT, ResultT > field_derivatives
 The local derivatives of the operands with respect to the test operand value, which are stored in an OperandValues struct.
 
discretization::forms::PartialDerivative< ResultT, discretization::forms::VectorValue > position_derivative {}
 The local derivative of the test operand value with respect to position, which is a 3D vector.
 

Detailed Description

template<typename OperandsT, typename ResultT = double>
struct serif::equations::PointLinearization< OperandsT, ResultT >

A struct to represent the linearization of a pointwise equation at a given point in space. This includes the residual and the local derivatives of the operands with respect to the test operand value, as well as the local derivative of the test operand value with respect to position.

Template Parameters
OperandsTThe list of operands to store values for, which must be a TypeList of valid operands.
ResultTThe type of the output with respect to which local derivatives are computed. If void, this struct stores operand values.

Member Data Documentation

◆ field_derivatives

template<typename OperandsT, typename ResultT = double>
OperandValues<OperandsT, ResultT> serif::equations::PointLinearization< OperandsT, ResultT >::field_derivatives

The local derivatives of the operands with respect to the test operand value, which are stored in an OperandValues struct.

◆ position_derivative

template<typename OperandsT, typename ResultT = double>
discretization::forms::PartialDerivative<ResultT, discretization::forms::VectorValue> serif::equations::PointLinearization< OperandsT, ResultT >::position_derivative {}

The local derivative of the test operand value with respect to position, which is a 3D vector.

◆ residual

template<typename OperandsT, typename ResultT = double>
ResultT serif::equations::PointLinearization< OperandsT, ResultT >::residual {}

The residual of the pointwise equation at the given point in space, which is of type ResultT. Note the inner product of these with some operation on a test function will be integrated over the domain by the operator backend to produce the global residual.


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