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)
53 lines
1.4 KiB
Groff
53 lines
1.4 KiB
Groff
.TH "serif::equations::EquationPoint< OperandsT >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::equations::EquationPoint< OperandsT > \- A struct to represent the values of operands at a given point in space\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <point\&.hpp>\fP
|
|
.SS "Public Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "\fBOperandValues\fP< OperandsT > \fBfields\fP"
|
|
.br
|
|
.RI "The values of the operands at the given point in space\&. "
|
|
.ti -1c
|
|
.RI "std::array< double, 3 > \fBposition\fP {}"
|
|
.br
|
|
.RI "The physical position of the point in space, which is a 3D vector\&. "
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
|
|
.SS "template<typename OperandsT>
|
|
.br
|
|
struct serif::equations::EquationPoint< OperandsT >"A struct to represent the values of operands at a given point in space\&.
|
|
|
|
|
|
.PP
|
|
\fBTemplate Parameters\fP
|
|
.RS 4
|
|
\fIOperandsT\fP The list of operands to store values for, which must be a TypeList of valid operands\&.
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "template<typename OperandsT> \fBOperandValues\fP<OperandsT> \fBserif::equations::EquationPoint\fP< OperandsT >::fields"
|
|
|
|
.PP
|
|
The values of the operands at the given point in space\&.
|
|
.SS "template<typename OperandsT> std::array<double, 3> \fBserif::equations::EquationPoint\fP< OperandsT >::position {}"
|
|
|
|
.PP
|
|
The physical position of the point in space, which is a 3D vector\&.
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|