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)
79 lines
2.9 KiB
Groff
79 lines
2.9 KiB
Groff
.TH "serif::discretization::forms::source< TrialT, TestT >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::discretization::forms::source< TrialT, TestT > \- The source form represents the source term in the discretization framework\&. It takes a trial term and a test term as template parameters and defines the operand types for the source operation\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <forms\&.hpp>\fP
|
|
.PP
|
|
Inherits \fBserif::discretization::forms::form\fP\&.
|
|
.SS "Public Types"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "using \fBtrial_type\fP = TrialT"
|
|
.br
|
|
.RI "The trial term type for the source form\&. "
|
|
.ti -1c
|
|
.RI "using \fBtest_type\fP = TestT"
|
|
.br
|
|
.RI "The test term type for the source form\&. "
|
|
.ti -1c
|
|
.RI "using \fBoperand_types\fP = \fButils::types::TypeList\fP<\fBOperand\fP<TrialT>, \fBOperand\fP<TestT>>"
|
|
.br
|
|
.RI "Type list of operand types for the source form, used for compile-time reflection and iteration over the operands\&. "
|
|
.in -1c
|
|
.SS "Static Public Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "static constexpr std::string_view \fBname\fP = \fBmeta::template_name\fP<\fBsource\fP>()"
|
|
.br
|
|
.RI "Compile time reflected name of the form\&. "
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
|
|
.SS "template<blocks::Term TrialT, blocks::Term TestT>
|
|
.br
|
|
struct serif::discretization::forms::source< TrialT, TestT >"The source form represents the source term in the discretization framework\&. It takes a trial term and a test term as template parameters and defines the operand types for the source operation\&.
|
|
|
|
|
|
.PP
|
|
\fBTemplate Parameters\fP
|
|
.RS 4
|
|
\fITrialT\fP The trial term type\&.
|
|
.br
|
|
\fITestT\fP The test term type\&.
|
|
.RE
|
|
.PP
|
|
There is a similar story here to the mass matrix, though this is much closer to what we expect in physics for a source term\&.
|
|
.SH "Member Typedef Documentation"
|
|
.PP
|
|
.SS "template<blocks::Term TrialT, blocks::Term TestT> using \fBserif::discretization::forms::source\fP< TrialT, TestT >::operand_types = \fButils::types::TypeList\fP<\fBOperand\fP<TrialT>, \fBOperand\fP<TestT>>"
|
|
|
|
.PP
|
|
Type list of operand types for the source form, used for compile-time reflection and iteration over the operands\&.
|
|
.SS "template<blocks::Term TrialT, blocks::Term TestT> using \fBserif::discretization::forms::source\fP< TrialT, TestT >::test_type = TestT"
|
|
|
|
.PP
|
|
The test term type for the source form\&.
|
|
.SS "template<blocks::Term TrialT, blocks::Term TestT> using \fBserif::discretization::forms::source\fP< TrialT, TestT >::trial_type = TrialT"
|
|
|
|
.PP
|
|
The trial term type for the source form\&.
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "template<blocks::Term TrialT, blocks::Term TestT> std::string_view \fBserif::discretization::forms::source\fP< TrialT, TestT >::name = \fBmeta::template_name\fP<\fBsource\fP>()\fR [static]\fP, \fR [constexpr]\fP"
|
|
|
|
.PP
|
|
Compile time reflected name of the form\&.
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|