MGIS 3.1.0
Loading...
Searching...
No Matches
SpaceConcept.hxx File Reference

File which defines the concept a space must satisfy and the helpers used to query the index types and the workspaces of a space. More...

#include <concepts>
#include <type_traits>
#include "MGIS/Config.hxx"

Classes

struct  mgis::function::SpaceTraits< SpaceType >
 a quadrature traits class defining the main properties of a space More...
struct  mgis::function::internals::UndefinedTypeSelector
 helper metafunction returning an undefined type, used as fallback when a space does not expose the queried type More...
struct  mgis::function::internals::ElementIndexTypeSelector< hasElementIndexType, Space >
 metafunction used to return the element_index_type type alias of SpaceTraits<Space> if it is defined, UndefinedTypeSelector::Undefined otherwise More...
struct  mgis::function::internals::ElementIndexTypeSelector< true, Space >
 specialization used when the space exposes an element_index_type type alias More...
struct  mgis::function::internals::ElementWorkspaceSelector< hasElementWorkspace, Space >
 metafunction used to return the ElementWorkspace type of SpaceTraits<Space> if it is defined, UndefinedTypeSelector::Undefined otherwise More...
struct  mgis::function::internals::ElementWorkspaceSelector< true, Space >
 specialization used when the space exposes an ElementWorkspace type More...
struct  mgis::function::internals::CellIndexTypeSelector< hasCellIndexType, Space >
 metafunction used to return the cell_index_type type alias of SpaceTraits<Space> if it is defined, UndefinedTypeSelector::Undefined otherwise More...
struct  mgis::function::internals::CellIndexTypeSelector< true, Space >
 specialization used when the space exposes a cell_index_type type alias More...
struct  mgis::function::internals::QuadraturePointIndexTypeSelector< hasQuadraturePointIndexType, Space >
 metafunction used to return the quadrature_point_index_type type alias of SpaceTraits<Space> if it is defined, UndefinedTypeSelector::Undefined otherwise More...
struct  mgis::function::internals::QuadraturePointIndexTypeSelector< true, Space >
 specialization used when the space exposes a quadrature_point_index_type type alias More...
struct  mgis::function::internals::CellWorkspaceSelector< hasCellWorkspace, Space >
 metafunction used to return the CellWorkspace type of SpaceTraits<Space> if it is defined, UndefinedTypeSelector::Undefined otherwise More...
struct  mgis::function::internals::CellWorkspaceSelector< true, Space >
 specialization used when the space exposes a CellWorkspace type More...

Namespaces

namespace  mgis
 the namespace mgis encloses all the MGIS project.

Concepts

concept  mgis::function::internals::same_decay_type
 concept satisfied if the given types are the same once std::decay_t is applied
concept  mgis::function::SpaceConcept
 a concept describing a space
concept  mgis::function::ElementSpaceConcept
 a concept describing a space where values can be addressed by an element index
concept  mgis::function::LinearElementSpaceConcept
 a concept describing a space where all the elements are stored from 0 to getSpaceSize(s) - 1
concept  mgis::function::QuadratureSpaceConcept
 a concept describing a quadrature space where values can be addressed given the cell index and the index of the integration points
concept  mgis::function::LinearQuadratureSpaceConcept
 a concept describing a quadrature space where all the cells are stored from 0 to getNumberOfCells(s) - 1 and the offset of a quadrature point can be computed from the index of its cell and its own index
concept  mgis::function::FunctionalSpaceConcept
 a concept describing a space where values can be addressed either by an element index or by a cell index and a quadrature point index
concept  mgis::function::LinearFunctionalSpaceConcept
 a concept describing a space which matches both the FunctionalSpaceConcept concept and either the LinearElementSpaceConcept concept or the LinearQuadratureSpaceConcept concept

Typedefs

template<SpaceConcept SpaceType>
using mgis::function::element_index
 a simple alias giving the type of the index of an element of a space
template<SpaceConcept SpaceType>
using mgis::function::element_workspace
 a simple alias giving the type of the workspace associated with an element of a space
template<SpaceConcept SpaceType>
using mgis::function::cell_index
 a simple alias giving the type of the index of a cell of a space
template<SpaceConcept SpaceType>
using mgis::function::quadrature_point_index
 a simple alias giving the type of the index of a quadrature point of a space
template<SpaceConcept SpaceType>
using mgis::function::cell_workspace
 a simple alias giving the type of the workspace associated with a cell of a space

Variables

template<SpaceConcept SpaceType>
constexpr bool mgis::function::hasElementWorkspace
 a simple meta function stating if SpaceType exposes an ElementWorkspace type
template<SpaceConcept SpaceType>
constexpr bool mgis::function::hasCellWorkspace
 a simple meta function stating if SpaceType exposes a CellWorkspace type

Detailed Description

File which defines the concept a space must satisfy and the helpers used to query the index types and the workspaces of a space.

Author
Thomas Helfer
Date
01/05/2025

Typedef Documentation

◆ cell_index

template<SpaceConcept SpaceType>
using mgis::function::cell_index
Initial value:
typename internals::
CellIndexTypeSelector<QuadratureSpaceConcept<SpaceType>, SpaceType>::type

a simple alias giving the type of the index of a cell of a space

Template Parameters
SpaceTypetype of the space considered
Note
this alias leads to an undefined type if SpaceType does not match the QuadratureSpaceConcept concept

◆ cell_workspace

template<SpaceConcept SpaceType>
using mgis::function::cell_workspace
Initial value:
SpaceType>::type
metafunction used to return the CellWorkspace type of SpaceTraits<Space> if it is defined,...
Definition SpaceConcept.hxx:188

a simple alias giving the type of the workspace associated with a cell of a space

Template Parameters
SpaceTypetype of the space considered
Note
this alias leads to an undefined type if SpaceType does not expose a CellWorkspace type

◆ element_index

template<SpaceConcept SpaceType>
using mgis::function::element_index
Initial value:
typename internals::
ElementIndexTypeSelector<ElementSpaceConcept<SpaceType>, SpaceType>::type

a simple alias giving the type of the index of an element of a space

Template Parameters
SpaceTypetype of the space considered
Note
this alias leads to an undefined type if SpaceType does not match the ElementSpaceConcept concept

◆ element_workspace

template<SpaceConcept SpaceType>
using mgis::function::element_workspace
Initial value:
typename internals::
ElementWorkspaceSelector<hasElementWorkspace<SpaceType>, SpaceType>::type

a simple alias giving the type of the workspace associated with an element of a space

Template Parameters
SpaceTypetype of the space considered
Note
this alias leads to an undefined type if SpaceType does not expose an ElementWorkspace type

◆ quadrature_point_index

template<SpaceConcept SpaceType>
using mgis::function::quadrature_point_index
Initial value:
SpaceType>::type
a concept describing a quadrature space where values can be addressed given the cell index and the in...
Definition SpaceConcept.hxx:297
metafunction used to return the quadrature_point_index_type type alias of SpaceTraits<Space> if it is...
Definition SpaceConcept.hxx:164

a simple alias giving the type of the index of a quadrature point of a space

Template Parameters
SpaceTypetype of the space considered
Note
this alias leads to an undefined type if SpaceType does not match the QuadratureSpaceConcept concept

Variable Documentation

◆ hasCellWorkspace

template<SpaceConcept SpaceType>
bool mgis::function::hasCellWorkspace
inlineconstexpr
Initial value:
= requires {
}
a quadrature traits class defining the main properties of a space
Definition SpaceConcept.hxx:56

a simple meta function stating if SpaceType exposes a CellWorkspace type

Template Parameters
SpaceTypetype of the space considered

◆ hasElementWorkspace

template<SpaceConcept SpaceType>
bool mgis::function::hasElementWorkspace
inlineconstexpr
Initial value:

a simple meta function stating if SpaceType exposes an ElementWorkspace type

Template Parameters
SpaceTypetype of the space considered