version 0.3.7
Ikarus::ScalarFieldFE< Basis_ > Class Template Reference

ScalarFieldFE class, a class for Single-DOF elements using a scalar basis. More...

#include <ikarus/finiteelements/febases/scalarfe.hh>

Public Types

using Basis = Basis_
 Type of the root basis. More...
 
using LocalView = typename Basis::LocalView
 Type of the local view. More...
 
using GlobalIndex = typename LocalView::MultiIndex
 Type of the global index. More...
 
using GridElement = typename LocalView::Element
 Type of the grid element. More...
 
using Traits = FETraits< GridElement >
 Type of the traits. More...
 

Public Member Functions

 ScalarFieldFE (const Basis &basis, const typename LocalView::Element &element)
 Constructor for the ScalarFieldFE class. More...
 
int size () const
 Get the size of the finite element. More...
 
void globalFlatIndices (std::vector< GlobalIndex > &globalIndices) const
 Get the global flat indices of the finite element. More...
 
const GridElement & gridElement () const
 Get the entity associated with the finite element. More...
 
const LocalView & localView () const
 Get the local view of the finite element. More...
 
LocalView & localView ()
 Get the local view of the finite element. More...
 

Static Public Attributes

static constexpr int worlddim = Traits::worlddim
 Dimension of the world space. More...
 

Detailed Description

template<typename Basis_>
class Ikarus::ScalarFieldFE< Basis_ >
Template Parameters
Basis_Type of the scalar basis.

Member Typedef Documentation

◆ Basis

template<typename Basis_ >
using Ikarus::ScalarFieldFE< Basis_ >::Basis = Basis_

◆ GlobalIndex

template<typename Basis_ >
using Ikarus::ScalarFieldFE< Basis_ >::GlobalIndex = typename LocalView::MultiIndex

◆ GridElement

template<typename Basis_ >
using Ikarus::ScalarFieldFE< Basis_ >::GridElement = typename LocalView::Element

◆ LocalView

template<typename Basis_ >
using Ikarus::ScalarFieldFE< Basis_ >::LocalView = typename Basis::LocalView

◆ Traits

template<typename Basis_ >
using Ikarus::ScalarFieldFE< Basis_ >::Traits = FETraits<GridElement>

Constructor & Destructor Documentation

◆ ScalarFieldFE()

template<typename Basis_ >
Ikarus::ScalarFieldFE< Basis_ >::ScalarFieldFE ( const Basis &  basis,
const typename LocalView::Element &  element 
)
inlineexplicit
Parameters
basisThe scalar basis.
elementThe local element.

Member Function Documentation

◆ globalFlatIndices()

template<typename Basis_ >
void Ikarus::ScalarFieldFE< Basis_ >::globalFlatIndices ( std::vector< GlobalIndex > &  globalIndices) const
inline
Parameters
globalIndicesVector to store global flat indices.

◆ gridElement()

template<typename Basis_ >
const GridElement & Ikarus::ScalarFieldFE< Basis_ >::gridElement ( ) const
inline
Returns
The entity associated with the finite element.

◆ localView() [1/2]

template<typename Basis_ >
LocalView & Ikarus::ScalarFieldFE< Basis_ >::localView ( )
inline
Returns
The local view of the finite element.

◆ localView() [2/2]

template<typename Basis_ >
const LocalView & Ikarus::ScalarFieldFE< Basis_ >::localView ( ) const
inline
Returns
The local view of the finite element.

◆ size()

template<typename Basis_ >
int Ikarus::ScalarFieldFE< Basis_ >::size ( ) const
inline
Returns
The size of the finite element.

Member Data Documentation

◆ worlddim

template<typename Basis_ >
constexpr int Ikarus::ScalarFieldFE< Basis_ >::worlddim = Traits::worlddim
staticconstexpr

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