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)
67 lines
1.9 KiB
Groff
67 lines
1.9 KiB
Groff
.TH "src/include/serif/equations/point.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/equations/point.hpp \- File containing the definitions of the EquationPoint and PointLinearization structs, which are used to represent the values and derivatives of operands at a given point in space\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include <array>\fP
|
|
.br
|
|
\fR#include <concepts>\fP
|
|
.br
|
|
\fR#include <cstddef>\fP
|
|
.br
|
|
\fR#include <tuple>\fP
|
|
.br
|
|
\fR#include <type_traits>\fP
|
|
.br
|
|
\fR#include 'serif/discretization/forms/value\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/utils/types/type_list\&.hpp'\fP
|
|
.br
|
|
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "struct \fBserif::equations::OperandValues< utils::types::TypeList< Operands\&.\&.\&. >, OutputT >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::equations::EquationPoint< OperandsT >\fP"
|
|
.br
|
|
.RI "A struct to represent the values of operands at a given point in space\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::equations::PointLinearization< OperandsT, ResultT >\fP"
|
|
.br
|
|
.RI "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\&. "
|
|
.in -1c
|
|
.SS "Namespaces"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "namespace \fBserif\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::equations\fP"
|
|
.br
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
File containing the definitions of the EquationPoint and PointLinearization structs, which are used to represent the values and derivatives of operands at a given point in space\&.
|
|
|
|
|
|
.PP
|
|
\fBAuthor\fP
|
|
.RS 4
|
|
Emily M\&. Boudreaux
|
|
.RE
|
|
.PP
|
|
|
|
.PP
|
|
Effectively every equation returns a PointLinearization from evaluate\&. Generally, you likely do not need to touch this file if you are trying to just add new physics\&.
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|