.TH "src/include/serif/discretization/functional_space/space.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/discretization/functional_space/space.hpp \- This file defines the functional space types used in the discretization framework, including compile-time descriptors and runtime descriptors\&.  

.SH SYNOPSIS
.br
.PP
\fR#include <type_traits>\fP
.br
\fR#include <format>\fP
.br
\fR#include 'serif/meta/enums\&.hpp'\fP
.br

.SS "Classes"

.in +1c
.ti -1c
.RI "struct \fBserif::discretization::functional_space::Rank< R >\fP"
.br
.RI "Compile-time descriptor for the rank of a functional space\&. "
.ti -1c
.RI "struct \fBserif::discretization::functional_space::SpaceDescriptor\fP"
.br
.RI "Compile-time descriptor for a functional space\&. This struct is used to describe the family, continuity, trace, and mapping of a functional space at compile time\&. "
.ti -1c
.RI "struct \fBserif::discretization::functional_space::DiscreteFunctionalSpace< Space, Order, R >\fP"
.br
.RI "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\&. "
.ti -1c
.RI "struct \fBstd::formatter< serif::discretization::functional_space::Rank< R > >\fP"
.br
.RI "Specialization of the std::formatter for the functional space types\&. This allows us to use std::format to format the functional space types as strings\&. "
.ti -1c
.RI "struct \fBstd::formatter< serif::discretization::functional_space::SpaceDescriptor >\fP"
.br
.RI "Specialization of the std::formatter for the SpaceDescriptor types\&. This allows us to use std::format to format the SpaceDescriptor types as strings\&. "
.ti -1c
.RI "struct \fBstd::formatter< serif::discretization::functional_space::DiscreteFunctionalSpace< Space, Order, R > >\fP"
.br
.RI "Specialization of the std::formatter for the DiscreteFunctionalSpace types\&. This allows us to use std::format to format the DiscreteFunctionalSpace types as strings\&. "
.ti -1c
.RI "struct \fBstd::formatter< serif::discretization::functional_space::Family >\fP"
.br
.RI "Specialization of the std::formatter for the Family enum\&. This allows us to use std::format to format the Family enum as strings\&. "
.ti -1c
.RI "struct \fBstd::formatter< serif::discretization::functional_space::Continuity >\fP"
.br
.RI "Specialization of the std::formatter for the Continuity enum\&. This allows us to use std::format to format the Continuity enum as strings\&. "
.ti -1c
.RI "struct \fBstd::formatter< serif::discretization::functional_space::Trace >\fP"
.br
.RI "Specialization of the std::formatter for the Trace enum\&. This allows us to use std::format to format the Trace enum as strings\&. "
.ti -1c
.RI "struct \fBstd::formatter< serif::discretization::functional_space::Mapping >\fP"
.br
.RI "Specialization of the std::formatter for the Mapping enum\&. This allows us to use std::format to format the Mapping enum as strings\&. "
.in -1c
.SS "Namespaces"

.in +1c
.ti -1c
.RI "namespace \fBserif\fP"
.br
.ti -1c
.RI "namespace \fBserif::discretization\fP"
.br
.ti -1c
.RI "namespace \fBserif::discretization::functional_space\fP"
.br
.in -1c
.SS "Enumerations"

.in +1c
.ti -1c
.RI "enum class \fBserif::discretization::functional_space::Family\fP { \fBserif::discretization::functional_space::l2\fP, \fBserif::discretization::functional_space::h1\fP, \fBserif::discretization::functional_space::hdiv\fP, \fBserif::discretization::functional_space::hcurl\fP }"
.br
.RI "Compile-time descriptor for the family, continuity, trace, and mapping of a functional space\&. "
.ti -1c
.RI "enum class \fBserif::discretization::functional_space::Continuity\fP { \fBserif::discretization::functional_space::discontinuous\fP, \fBserif::discretization::functional_space::continuous\fP, \fBserif::discretization::functional_space::normal_continuous\fP, \fBserif::discretization::functional_space::tangential_continuous\fP }"
.br
.RI "Compile-time descriptor for the continuity of a functional space\&. This enum is parallel to the \fBFamily\fP enum\&. "
.ti -1c
.RI "enum class \fBserif::discretization::functional_space::Trace\fP { \fBserif::discretization::functional_space::none\fP, \fBserif::discretization::functional_space::value\fP, \fBserif::discretization::functional_space::normal\fP, \fBserif::discretization::functional_space::tangential\fP }"
.br
.RI "Compile-time descriptor for the trace of a functional space\&. This enum is parallel to the \fBFamily\fP enum\&. "
.ti -1c
.RI "enum class \fBserif::discretization::functional_space::Mapping\fP { \fBserif::discretization::functional_space::identity\fP, \fBserif::discretization::functional_space::contravariant_piola\fP, \fBserif::discretization::functional_space::covariant_piola\fP }"
.br
.RI "Compile-time descriptor for the mapping of a functional space\&. This tells the DomainMapper which piola transformations to use when moving between reference and physical spaces\&. "
.in -1c
.SS "Variables"

.in +1c
.ti -1c
.RI "static auto \fBserif::discretization::functional_space::Family2StringMap\fP = \fBmeta::enum_to_enum_string_map\fP<\fBFamily\fP>()"
.br
.RI "\fBMapping\fP from \fBFamily\fP enum values to their string representations\&. "
.ti -1c
.RI "static auto \fBserif::discretization::functional_space::String2FamilyMap\fP = \fBmeta::enum_to_string_enum_map\fP<\fBFamily\fP>()"
.br
.RI "\fBMapping\fP from string representations to \fBFamily\fP enum values\&. "
.ti -1c
.RI "static auto \fBserif::discretization::functional_space::Continuity2StringMap\fP = \fBmeta::enum_to_enum_string_map\fP<\fBContinuity\fP>()"
.br
.RI "\fBMapping\fP from \fBContinuity\fP enum values to their string representations\&. "
.ti -1c
.RI "static auto \fBserif::discretization::functional_space::String2ContinuityMap\fP = \fBmeta::enum_to_string_enum_map\fP<\fBContinuity\fP>()"
.br
.RI "\fBMapping\fP from string representations to \fBContinuity\fP enum values\&. "
.ti -1c
.RI "static auto \fBserif::discretization::functional_space::Trace2StringMap\fP = \fBmeta::enum_to_enum_string_map\fP<\fBTrace\fP>()"
.br
.RI "\fBMapping\fP from \fBTrace\fP enum values to their string representations\&. "
.ti -1c
.RI "static auto \fBserif::discretization::functional_space::String2TraceMap\fP = \fBmeta::enum_to_string_enum_map\fP<\fBTrace\fP>()"
.br
.RI "\fBMapping\fP from string representations to \fBTrace\fP enum values\&. "
.ti -1c
.RI "static auto \fBserif::discretization::functional_space::Mapping2StringMap\fP = \fBmeta::enum_to_enum_string_map\fP<\fBMapping\fP>()"
.br
.RI "\fBMapping\fP from \fBMapping\fP enum values to their string representations\&. "
.ti -1c
.RI "static auto \fBserif::discretization::functional_space::String2MappingMap\fP = \fBmeta::enum_to_string_enum_map\fP<\fBMapping\fP>()"
.br
.RI "\fBMapping\fP from string representations to \fBMapping\fP enum values\&. "
.ti -1c
.RI "static constexpr \fBSpaceDescriptor\fP \fBserif::discretization::functional_space::L2\fP"
.br
.RI "Compile-time descriptor for an L2 functional space\&. This is a convenience descriptor that allows you to easily create an L2 functional space descriptor without having to specify all the parameters\&. The specifications are\&. "
.ti -1c
.RI "static constexpr \fBSpaceDescriptor\fP \fBserif::discretization::functional_space::H1\fP"
.br
.RI "Compile-time descriptor for an H1 functional space\&. This is a convenience descriptor that allows you to easily create an H1 functional space descriptor without having to specify all the parameters\&. The specifications are\&. "
.ti -1c
.RI "static constexpr \fBSpaceDescriptor\fP \fBserif::discretization::functional_space::Hdiv\fP"
.br
.RI "Compile-time descriptor for an H(div) functional space\&. This is a convenience descriptor that allows you to easily create an H(div) functional space descriptor without having to specify all the parameters\&. The specifications are\&. "
.ti -1c
.RI "static constexpr \fBSpaceDescriptor\fP \fBserif::discretization::functional_space::Hcurl\fP"
.br
.RI "Compile-time descriptor for an H(curl) functional space\&. This is a convenience descriptor that allows you to easily create an H(curl) functional space descriptor without having to specify all the parameters\&. The specifications are\&. "
.in -1c
.SH "Detailed Description"
.PP 
This file defines the functional space types used in the discretization framework, including compile-time descriptors and runtime descriptors\&. 


.PP
\fBAuthor\fP
.RS 4
Emily M\&. Boudreaux 
.RE
.PP

.SH "Author"
.PP 
Generated automatically by Doxygen for SERiF from the source code\&.