MGIS 3.1.0
Loading...
Searching...
No Matches
mgis::function::BasicLinearQuadratureSpace< N > Struct Template Reference

a minimal implementation of a linear quadrature space More...

#include </home/runner/work/MFrontGenericInterfaceSupport/MFrontGenericInterfaceSupport/include/MGIS/Function/BasicLinearQuadratureSpace.hxx>

Classes

struct  DummyCellWorkspace
 an empty cell workspace, as the cells of this space do not require any information to be accessed More...

Public Member Functions

constexpr BasicLinearQuadratureSpace (const size_type) MGIS_NOEXCEPT
 constructor
constexpr BasicLinearQuadratureSpace (BasicLinearQuadratureSpace &&) noexcept
 move constructor
constexpr BasicLinearQuadratureSpace (const BasicLinearQuadratureSpace &) MGIS_NOEXCEPT
 copy constructor
constexpr size_type size () const MGIS_NOEXCEPT
constexpr size_type getNumberOfCells () const MGIS_NOEXCEPT
constexpr size_type getNumberOfQuadraturePoints (const size_type) const MGIS_NOEXCEPT
 return the number of quadrature points of a given cell
constexpr DummyCellWorkspace getCellWorkspace (const size_type) const MGIS_NOEXCEPT
 return the workspace of a given cell
constexpr size_type getQuadraturePointOffset (const size_type, const size_type) const MGIS_NOEXCEPT
 return the offset of a given quadrature point in the space
constexpr ~BasicLinearQuadratureSpace () noexcept
 destructor

Detailed Description

template<size_type N>
requires (N > 0)
struct mgis::function::BasicLinearQuadratureSpace< N >

a minimal implementation of a linear quadrature space

The elements of such a space are the quadrature points of all the cells of the space. Given the index e of a cell and the index i of one of its quadrature points, the offset of the corresponding element is e * N + i, which is why no workspace is required to access the cells of the space.

Template Parameters
Nnumber of integration points per cell, which must be greater than zero

Constructor & Destructor Documentation

◆ BasicLinearQuadratureSpace()

template<size_type N>
requires (N > 0)
mgis::function::BasicLinearQuadratureSpace< N >::BasicLinearQuadratureSpace ( const size_type n)
constexpr

constructor

Parameters
[in]nnumber of cells of the space

Member Function Documentation

◆ getCellWorkspace()

template<size_type N>
requires (N > 0)
BasicLinearQuadratureSpace< N >::DummyCellWorkspace mgis::function::BasicLinearQuadratureSpace< N >::getCellWorkspace ( const size_type ) const
nodiscardconstexpr

return the workspace of a given cell

Parameters
[in]ecell index
Returns
the workspace of the cell of index e, which is always an empty DummyCellWorkspace
an empty workspace: the quadrature points of a cell of this space are located from the index of this cell only

◆ getNumberOfCells()

template<size_type N>
requires (N > 0)
size_type mgis::function::BasicLinearQuadratureSpace< N >::getNumberOfCells ( ) const
nodiscardconstexpr
Returns
the number of cells in the quadrature space

◆ getNumberOfQuadraturePoints()

template<size_type N>
requires (N > 0)
size_type mgis::function::BasicLinearQuadratureSpace< N >::getNumberOfQuadraturePoints ( const size_type ) const
nodiscardconstexpr

return the number of quadrature points of a given cell

Parameters
[in]ecell index
Returns
the number of quadrature points of the given cell, which does not depend on the cell index e and is always N
the number of quadrature points of the considered cell, which does not depend on the cell since all the cells have N quadrature points

◆ getQuadraturePointOffset()

template<size_type N>
requires (N > 0)
size_type mgis::function::BasicLinearQuadratureSpace< N >::getQuadraturePointOffset ( const size_type e,
const size_type i ) const
nodiscardconstexpr

return the offset of a given quadrature point in the space

Parameters
[in]ecell index
[in]iquadrature point index of the cell of index e
Returns
the offset in the space of the quadrature point of index i of the cell of index e, that is e * N + i
the offset of the quadrature point: the cells are stored one after the other and all have N quadrature points

◆ size()

template<size_type N>
requires (N > 0)
size_type mgis::function::BasicLinearQuadratureSpace< N >::size ( ) const
nodiscardconstexpr
Returns
the number of quadrature points of the space, i.e. the number of cells multiplied by N
the total number of quadrature points of the space, which is the number of cells multiplied by the number of quadrature points per cell

The documentation for this struct was generated from the following files: