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)
57 lines
1.6 KiB
Groff
57 lines
1.6 KiB
Groff
.TH "serif::equations::TestOperandTraits< T, typename >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::equations::TestOperandTraits< T, typename > \- A helper struct to extract the test operand type from a contribution or equation\&. This is used to determine the test type of an equation or contribution\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <contributions\&.hpp>\fP
|
|
.SS "Public Types"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "using \fBtype\fP = \fBdiscretization::forms::Operand\fP<typename T::Test>"
|
|
.br
|
|
.RI "The default test operand type is the operand of the test type of the contribution or equation\&. "
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
|
|
.SS "template<typename T, typename = void>
|
|
.br
|
|
struct serif::equations::TestOperandTraits< T, typename >"A helper struct to extract the test operand type from a contribution or equation\&. This is used to determine the test type of an equation or contribution\&.
|
|
|
|
|
|
.PP
|
|
\fBNote\fP
|
|
.RS 4
|
|
The default void template parameter helps us to use SFINAE to detect if the type has a TestOperand member type\&.
|
|
.RE
|
|
.PP
|
|
\fBTodo\fP
|
|
.RS 4
|
|
Can we replace SFINAE here with requires or concepts?
|
|
.RE
|
|
.PP
|
|
|
|
.PP
|
|
\fBTemplate Parameters\fP
|
|
.RS 4
|
|
\fIT\fP The type to extract the test operand from
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Member Typedef Documentation"
|
|
.PP
|
|
.SS "template<typename T, typename = void> using \fBserif::equations::TestOperandTraits\fP< T, typename >::type = \fBdiscretization::forms::Operand\fP<typename T::Test>"
|
|
|
|
.PP
|
|
The default test operand type is the operand of the test type of the contribution or equation\&.
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|