HyperHDG
Static Public Member Functions | List of all members
Hypercube< dimT > Struct Template Reference

Helper class containing numbers and functions related to hypercubes. More...

#include <hypercube.hxx>

Static Public Member Functions

static constexpr unsigned int n_faces ()
 Number of faces of the hypercube. More...
 
static constexpr unsigned int n_vertices ()
 Number of vertices of the hypercube. More...
 
static constexpr unsigned int pow (unsigned int base)
 Return n to the power dim. More...
 
static std::array< unsigned int, std::max(dimT, 1U)> index_decompose (unsigned int index, const unsigned int range)
 Decompose global index of tensorial structure with respect to its dimensions. More...
 
template<typename point_t , typename array_t >
static constexpr point_t tensorial_pt (__attribute__((unused)) const unsigned int index, const array_t &points)
 Generate tensorial point whose entries are elements of an array. More...
 

Detailed Description

template<unsigned int dimT>
struct Hypercube< dimT >

Helper class containing numbers and functions related to hypercubes.


Template Parameters
dimUnsigned integer indicating the dimension of the considered hypercube.
Authors
Guido Kanschat, Heidelberg University, 2019–2020.
Andreas Rupp, Heidelberg University, 2019–2020.

Member Function Documentation

◆ index_decompose()

template<unsigned int dimT>
static std::array<unsigned int, std::max(dimT, 1U)> Hypercube< dimT >::index_decompose ( unsigned int  index,
const unsigned int  range 
)
inlinestatic

Decompose global index of tensorial structure with respect to its dimensions.


Parameters
indexLocal tensorial index (e.g. of the shape function or point).
rangeRange (maximum, excluded) of the 1D indices.
Return values
decompositionArray consisting of respective one-dimensional indices.

◆ n_faces()

template<unsigned int dimT>
static constexpr unsigned int Hypercube< dimT >::n_faces ( )
inlinestaticconstexpr

Number of faces of the hypercube.


◆ n_vertices()

template<unsigned int dimT>
static constexpr unsigned int Hypercube< dimT >::n_vertices ( )
inlinestaticconstexpr

Number of vertices of the hypercube.


◆ pow()

template<unsigned int dimT>
static constexpr unsigned int Hypercube< dimT >::pow ( unsigned int  base)
inlinestaticconstexpr

Return n to the power dim.


◆ tensorial_pt()

template<unsigned int dimT>
template<typename point_t , typename array_t >
static constexpr point_t Hypercube< dimT >::tensorial_pt ( __attribute__((unused)) const unsigned int  index,
const array_t &  points 
)
inlinestaticconstexpr

Generate tensorial point whose entries are elements of an array.


Parameters
indexLocal tensorial index (e.g. of the shape function or point).
pointsArray of possible values of point components.
Return values
pointTensorial point of given index.
Here is the call graph for this function:

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