62 lines
2.7 KiB
Groff
62 lines
2.7 KiB
Groff
|
.TH "serif::discretization::functional_space::DiscreteFunctionalSpace< Space, Order, R >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
||
|
|
.ad l
|
||
|
|
.nh
|
||
|
|
.SH NAME
|
||
|
|
serif::discretization::functional_space::DiscreteFunctionalSpace< Space, Order, R > \- Compile-time descriptor for a discrete functional space\&. The difference between a FunctionalSpace and a discrete functional space is that a discrete functional space carries some additional information which is needed to actually construct a finite element space (e\&.g\&. polynomial order, and rank)\&. Once you have a discrete functional space you have, for MFEM at least, enough information to fully define a finite element space\&.
|
||
|
|
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.br
|
||
|
|
.PP
|
||
|
|
.PP
|
||
|
|
\fR#include <space\&.hpp>\fP
|
||
|
|
.SS "Public Types"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "using \fBrank\fP = \fBRank\fP<R>"
|
||
|
|
.br
|
||
|
|
.in -1c
|
||
|
|
.SS "Static Public Attributes"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "static constexpr \fBSpaceDescriptor\fP \fBfunctional_space\fP = Space"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "static constexpr int \fBorder\fP = Order"
|
||
|
|
.br
|
||
|
|
.in -1c
|
||
|
|
.SH "Detailed Description"
|
||
|
|
.PP
|
||
|
|
|
||
|
|
.SS "template<\fBSpaceDescriptor\fP Space, int Order, std::size_t R>
|
||
|
|
.br
|
||
|
|
struct serif::discretization::functional_space::DiscreteFunctionalSpace< Space, Order, R >"Compile-time descriptor for a discrete functional space\&. The difference between a FunctionalSpace and a discrete functional space is that a discrete functional space carries some additional information which is needed to actually construct a finite element space (e\&.g\&. polynomial order, and rank)\&. Once you have a discrete functional space you have, for MFEM at least, enough information to fully define a finite element space\&.
|
||
|
|
|
||
|
|
|
||
|
|
.PP
|
||
|
|
\fBTemplate Parameters\fP
|
||
|
|
.RS 4
|
||
|
|
\fISpace\fP The functional space descriptor (e\&.g\&. L2, H1, H(div), H(curl))\&.
|
||
|
|
.br
|
||
|
|
\fIOrder\fP The order of the finite element family (e\&.g\&. 0 for P0, 1 for P1, etc\&.)\&.
|
||
|
|
.br
|
||
|
|
\fIR\fP The rank of the functional space (e\&.g\&. 0 for scalar, 1 for vector, 2 for tensor)\&.
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
|
||
|
|
.SH "Member Typedef Documentation"
|
||
|
|
.PP
|
||
|
|
.SS "template<\fBSpaceDescriptor\fP Space, int Order, std::size_t R> using \fBserif::discretization::functional_space::DiscreteFunctionalSpace\fP< Space, Order, R >::rank = \fBRank\fP<R>"
|
||
|
|
|
||
|
|
.SH "Member Data Documentation"
|
||
|
|
.PP
|
||
|
|
.SS "template<\fBSpaceDescriptor\fP Space, int Order, std::size_t R> \fBSpaceDescriptor\fP \fBserif::discretization::functional_space::DiscreteFunctionalSpace\fP< Space, Order, R >::functional_space = Space\fR [static]\fP, \fR [constexpr]\fP"
|
||
|
|
|
||
|
|
.SS "template<\fBSpaceDescriptor\fP Space, int Order, std::size_t R> int \fBserif::discretization::functional_space::DiscreteFunctionalSpace\fP< Space, Order, R >::order = Order\fR [static]\fP, \fR [constexpr]\fP"
|
||
|
|
|
||
|
|
|
||
|
|
.SH "Author"
|
||
|
|
.PP
|
||
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|