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)
63 lines
3.2 KiB
Groff
63 lines
3.2 KiB
Groff
.TH "serif::equations::PointLinearization< OperandsT, ResultT >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
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\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <point\&.hpp>\fP
|
|
.SS "Public Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "ResultT \fBresidual\fP {}"
|
|
.br
|
|
.RI "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\&. "
|
|
.ti -1c
|
|
.RI "\fBOperandValues\fP< OperandsT, ResultT > \fBfield_derivatives\fP"
|
|
.br
|
|
.RI "The local derivatives of the operands with respect to the test operand value, which are stored in an \fBOperandValues\fP struct\&. "
|
|
.ti -1c
|
|
.RI "\fBdiscretization::forms::PartialDerivative\fP< ResultT, \fBdiscretization::forms::VectorValue\fP > \fBposition_derivative\fP {}"
|
|
.br
|
|
.RI "The local derivative of the test operand value with respect to position, which is a 3D vector\&. "
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
|
|
.SS "template<typename OperandsT, typename ResultT = double>
|
|
.br
|
|
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\&.
|
|
|
|
|
|
.PP
|
|
\fBTemplate Parameters\fP
|
|
.RS 4
|
|
\fIOperandsT\fP The list of operands to store values for, which must be a TypeList of valid operands\&.
|
|
.br
|
|
\fIResultT\fP The type of the output with respect to which local derivatives are computed\&. If void, this struct stores operand values\&.
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "template<typename OperandsT, typename ResultT = double> \fBOperandValues\fP<OperandsT, ResultT> \fBserif::equations::PointLinearization\fP< OperandsT, ResultT >::field_derivatives"
|
|
|
|
.PP
|
|
The local derivatives of the operands with respect to the test operand value, which are stored in an \fBOperandValues\fP struct\&.
|
|
.SS "template<typename OperandsT, typename ResultT = double> \fBdiscretization::forms::PartialDerivative\fP<ResultT, \fBdiscretization::forms::VectorValue\fP> \fBserif::equations::PointLinearization\fP< OperandsT, ResultT >::position_derivative {}"
|
|
|
|
.PP
|
|
The local derivative of the test operand value with respect to position, which is a 3D vector\&.
|
|
.SS "template<typename OperandsT, typename ResultT = double> ResultT \fBserif::equations::PointLinearization\fP< OperandsT, ResultT >::residual {}"
|
|
|
|
.PP
|
|
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\&.
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|