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)
34 lines
1.3 KiB
Groff
34 lines
1.3 KiB
Groff
.TH "serif::discretization::forms::ValueComponents< ValueT >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::discretization::forms::ValueComponents< ValueT > \- Helper variable template to determine the number of components in the value type of an operand\&. This is a convenience variable that allows you to easily access the number of components in the value type of an operand without having to explicitly use the \fBOperandResult\fP struct\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.SH "Detailed Description"
|
|
.PP
|
|
|
|
.SS "template<typename ValueT>
|
|
.br
|
|
struct serif::discretization::forms::ValueComponents< ValueT >"Helper variable template to determine the number of components in the value type of an operand\&. This is a convenience variable that allows you to easily access the number of components in the value type of an operand without having to explicitly use the \fBOperandResult\fP struct\&.
|
|
|
|
|
|
.PP
|
|
\fBTemplate Parameters\fP
|
|
.RS 4
|
|
\fIOperandT\fP The operand type to determine the number of components for\&.
|
|
.RE
|
|
.PP
|
|
\fBTodo\fP
|
|
.RS 4
|
|
This introduces an assumption of three-dimensionality, we say "this is either a scalar or a tensor of dimension 3"\&. We should probably relax this assumption\&.
|
|
.RE
|
|
.PP
|
|
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|