version 0.4.1
Public Types | Static Public Attributes | List of all members
Ikarus::FETraits< BH, useRef, useFlat > Struct Template Reference

Traits for handling finite elements. More...

#include <ikarus/finiteelements/fetraits.hh>

Public Types

using BasisHandler = BH
 Type of the basis of the finite element. More...
 
using FlatBasis = typename BasisHandler::FlatBasis
 Type of the flat basis. More...
 
using UntouchedBasis = typename BasisHandler::UntouchedBasis
 Type of the untouched basis. More...
 
using Basis = std::conditional_t< useFlat, FlatBasis, UntouchedBasis >
 Type of the basis version. More...
 
using LocalView = typename Basis::LocalView
 Type of the local view. More...
 
using GridView = typename Basis::GridView
 Type of the grid view. More...
 
using Element = typename LocalView::Element
 Type of the grid element. More...
 
using Geometry = typename Element::Geometry
 Type of the element geometry. More...
 
using GlobalIndex = typename LocalView::MultiIndex
 Type of the global index. More...
 
using ctype = double
 Type used for coordinates. More...
 
using GlobalCoordinates = Eigen::Matrix< ctype, worlddim, 1 >
 Type of the coordinate. More...
 
using ParameterSpaceType = Eigen::Matrix< ctype, mydim, 1 >
 Type of the ParameterSpace coordinate. More...
 
template<typename ScalarType = ctype>
using VectorType = std::conditional_t< useEigenRef, Eigen::Ref< Eigen::VectorX< ScalarType > >, Eigen::VectorX< ScalarType > & >
 Type of the vector passed to calculateVector. More...
 
template<typename ScalarType = ctype>
using MatrixType = std::conditional_t< useEigenRef, Eigen::Ref< Eigen::MatrixX< ScalarType > >, Eigen::MatrixX< ScalarType > & >
 Type of the matrix passed to calculateMatrix. More...
 

Static Public Attributes

static constexpr bool useFlatBasis = useFlat
 A bool to indicate if the provided basishandler should hand out the flat basis. More...
 
static constexpr int worlddim = Geometry::coorddimension
 Dimension of the world space. More...
 
static constexpr int mydim = Element::mydimension
 Dimension of the geometry. More...
 
static constexpr int dimension = Element::dimension
 Dimension of the grid. More...
 
static constexpr bool useEigenRef = useRef
 Bool indicating whether the raw Eigen types should be used or wrapped with Eigen::Ref<..>. (Needed for Python bindings) More...
 

Detailed Description

template<typename BH, bool useRef = false, bool useFlat = true>
struct Ikarus::FETraits< BH, useRef, useFlat >
Template Parameters
BHThe basis handler type for the finite element.
useFlatA boolean indicating if the type of the underlying basis is of the flat or the untouched version.
useRefBoolean indicating whether to use Eigen::Ref for VectorType and MatrixType.

Member Typedef Documentation

◆ Basis

template<typename BH , bool useRef = false, bool useFlat = true>
using Ikarus::FETraits< BH, useRef, useFlat >::Basis = std::conditional_t<useFlat, FlatBasis, UntouchedBasis>

◆ BasisHandler

template<typename BH , bool useRef = false, bool useFlat = true>
using Ikarus::FETraits< BH, useRef, useFlat >::BasisHandler = BH

◆ ctype

template<typename BH , bool useRef = false, bool useFlat = true>
using Ikarus::FETraits< BH, useRef, useFlat >::ctype = double

◆ Element

template<typename BH , bool useRef = false, bool useFlat = true>
using Ikarus::FETraits< BH, useRef, useFlat >::Element = typename LocalView::Element

◆ FlatBasis

template<typename BH , bool useRef = false, bool useFlat = true>
using Ikarus::FETraits< BH, useRef, useFlat >::FlatBasis = typename BasisHandler::FlatBasis

◆ Geometry

template<typename BH , bool useRef = false, bool useFlat = true>
using Ikarus::FETraits< BH, useRef, useFlat >::Geometry = typename Element::Geometry

◆ GlobalCoordinates

template<typename BH , bool useRef = false, bool useFlat = true>
using Ikarus::FETraits< BH, useRef, useFlat >::GlobalCoordinates = Eigen::Matrix<ctype, worlddim, 1>

◆ GlobalIndex

template<typename BH , bool useRef = false, bool useFlat = true>
using Ikarus::FETraits< BH, useRef, useFlat >::GlobalIndex = typename LocalView::MultiIndex

◆ GridView

template<typename BH , bool useRef = false, bool useFlat = true>
using Ikarus::FETraits< BH, useRef, useFlat >::GridView = typename Basis::GridView

◆ LocalView

template<typename BH , bool useRef = false, bool useFlat = true>
using Ikarus::FETraits< BH, useRef, useFlat >::LocalView = typename Basis::LocalView

◆ MatrixType

template<typename BH , bool useRef = false, bool useFlat = true>
template<typename ScalarType = ctype>
using Ikarus::FETraits< BH, useRef, useFlat >::MatrixType = std::conditional_t<useEigenRef, Eigen::Ref<Eigen::MatrixX<ScalarType> >, Eigen::MatrixX<ScalarType>&>

◆ ParameterSpaceType

template<typename BH , bool useRef = false, bool useFlat = true>
using Ikarus::FETraits< BH, useRef, useFlat >::ParameterSpaceType = Eigen::Matrix<ctype, mydim, 1>

◆ UntouchedBasis

template<typename BH , bool useRef = false, bool useFlat = true>
using Ikarus::FETraits< BH, useRef, useFlat >::UntouchedBasis = typename BasisHandler::UntouchedBasis

◆ VectorType

template<typename BH , bool useRef = false, bool useFlat = true>
template<typename ScalarType = ctype>
using Ikarus::FETraits< BH, useRef, useFlat >::VectorType = std::conditional_t<useEigenRef, Eigen::Ref<Eigen::VectorX<ScalarType> >, Eigen::VectorX<ScalarType>&>

Member Data Documentation

◆ dimension

template<typename BH , bool useRef = false, bool useFlat = true>
constexpr int Ikarus::FETraits< BH, useRef, useFlat >::dimension = Element::dimension
staticconstexpr

◆ mydim

template<typename BH , bool useRef = false, bool useFlat = true>
constexpr int Ikarus::FETraits< BH, useRef, useFlat >::mydim = Element::mydimension
staticconstexpr

◆ useEigenRef

template<typename BH , bool useRef = false, bool useFlat = true>
constexpr bool Ikarus::FETraits< BH, useRef, useFlat >::useEigenRef = useRef
staticconstexpr

◆ useFlatBasis

template<typename BH , bool useRef = false, bool useFlat = true>
constexpr bool Ikarus::FETraits< BH, useRef, useFlat >::useFlatBasis = useFlat
staticconstexpr

◆ worlddim

template<typename BH , bool useRef = false, bool useFlat = true>
constexpr int Ikarus::FETraits< BH, useRef, useFlat >::worlddim = Geometry::coorddimension
staticconstexpr
The documentation for this struct was generated from the following file: