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)
55 lines
2.0 KiB
Groff
55 lines
2.0 KiB
Groff
.TH "serif::discretization::forms::Operation" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::discretization::forms::Operation \- The \fBOperation\fP struct defines a set of operations that can be applied to terms in the context of a form\&. These operations include value, gradient, divergence, curl, and normal trace\&. Similar to the statement I made at the top of \fBforms\&.hpp\fP, if you are a developer looking to extend the mathematical capabilities of SERiF this is a place you should be looking early on\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <operands\&.hpp>\fP
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "struct \fBCurl\fP"
|
|
.br
|
|
.RI "\fBOperation\fP tag for evaluating a curl\&. "
|
|
.ti -1c
|
|
.RI "struct \fBDivergence\fP"
|
|
.br
|
|
.RI "\fBOperation\fP tag for evaluating a divergence\&. "
|
|
.ti -1c
|
|
.RI "struct \fBGradient\fP"
|
|
.br
|
|
.RI "\fBOperation\fP tag for evaluating a gradient\&. "
|
|
.ti -1c
|
|
.RI "struct \fBNormalTrace\fP"
|
|
.br
|
|
.RI "\fBOperation\fP tag for evaluating the normal flux along a boundary\&. "
|
|
.ti -1c
|
|
.RI "struct \fBValue\fP"
|
|
.br
|
|
.RI "\fBOperation\fP tag for evaluating a value\&. "
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
The \fBOperation\fP struct defines a set of operations that can be applied to terms in the context of a form\&. These operations include value, gradient, divergence, curl, and normal trace\&. Similar to the statement I made at the top of \fBforms\&.hpp\fP, if you are a developer looking to extend the mathematical capabilities of SERiF this is a place you should be looking early on\&.
|
|
|
|
|
|
.PP
|
|
\fBNote\fP
|
|
.RS 4
|
|
\fBNormalTrace\fP I find also to be somewhat confusing\&. Like many parts of the vocab at this level of SERiF this originates from finite element analysis (though I am sure they got it from somewhere else), this just means the normal fluxes along a boundary\&.
|
|
|
|
.PP
|
|
If you extend this struct you should also extend \fBIsOperation\fP (just below it in the file)
|
|
.RE
|
|
.PP
|
|
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|