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)
83 lines
3.1 KiB
Groff
83 lines
3.1 KiB
Groff
.TH "serif::discretization::blocks::SpatialTermTraits< TermT >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::discretization::blocks::SpatialTermTraits< TermT > \- Helper struct representing the traits of some spatial term type, including its functional space, support, family, order, and rank\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <traits\&.hpp>\fP
|
|
.SS "Public Types"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "using \fBFunctionalSpace\fP = TermT::FunctionalSpace"
|
|
.br
|
|
.RI "The functional space type associated with the term\&. e\&.g\&. 2nd order scalar H1 space\&. "
|
|
.ti -1c
|
|
.RI "using \fBSupport\fP = TermT::Support"
|
|
.br
|
|
.RI "The support type associated with the term\&. e\&.g\&. stellar domain\&. "
|
|
.in -1c
|
|
.SS "Static Public Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "static constexpr auto \fBfamily\fP = FunctionalSpace::functional_space\&.family"
|
|
.br
|
|
.RI "The family of the functional space associated with the term\&. e\&.g\&. H1, L2, etc\&. "
|
|
.ti -1c
|
|
.RI "static constexpr int \fBorder\fP = FunctionalSpace::order"
|
|
.br
|
|
.RI "The order of the functional space associated with the term\&. e\&.g\&. 1st order, 2nd order, etc\&. "
|
|
.ti -1c
|
|
.RI "static constexpr std::size_t \fBrank\fP = FunctionalSpace::rank::value"
|
|
.br
|
|
.RI "The rank of the functional space associated with the term\&. "
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
|
|
.SS "template<SpatialTerm TermT>
|
|
.br
|
|
struct serif::discretization::blocks::SpatialTermTraits< TermT >"Helper struct representing the traits of some spatial term type, including its functional space, support, family, order, and rank\&.
|
|
|
|
|
|
.PP
|
|
\fBTemplate Parameters\fP
|
|
.RS 4
|
|
\fITermT\fP The spatial term type from which to extract the functional space and support types\&.
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Member Typedef Documentation"
|
|
.PP
|
|
.SS "template<SpatialTerm TermT> using \fBserif::discretization::blocks::SpatialTermTraits\fP< TermT >::FunctionalSpace = TermT::FunctionalSpace"
|
|
|
|
.PP
|
|
The functional space type associated with the term\&. e\&.g\&. 2nd order scalar H1 space\&.
|
|
.SS "template<SpatialTerm TermT> using \fBserif::discretization::blocks::SpatialTermTraits\fP< TermT >::Support = TermT::Support"
|
|
|
|
.PP
|
|
The support type associated with the term\&. e\&.g\&. stellar domain\&.
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "template<SpatialTerm TermT> auto \fBserif::discretization::blocks::SpatialTermTraits\fP< TermT >::family = FunctionalSpace::functional_space\&.family\fR [static]\fP, \fR [constexpr]\fP"
|
|
|
|
.PP
|
|
The family of the functional space associated with the term\&. e\&.g\&. H1, L2, etc\&.
|
|
.SS "template<SpatialTerm TermT> int \fBserif::discretization::blocks::SpatialTermTraits\fP< TermT >::order = FunctionalSpace::order\fR [static]\fP, \fR [constexpr]\fP"
|
|
|
|
.PP
|
|
The order of the functional space associated with the term\&. e\&.g\&. 1st order, 2nd order, etc\&.
|
|
.SS "template<SpatialTerm TermT> std::size_t \fBserif::discretization::blocks::SpatialTermTraits\fP< TermT >::rank = FunctionalSpace::rank::value\fR [static]\fP, \fR [constexpr]\fP"
|
|
|
|
.PP
|
|
The rank of the functional space associated with the term\&.
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|