FEAT 3
Finite Element Analysis Toolbox
Loading...
Searching...
No Matches
FEAT::Space::DofMappingBase< Space_ > Class Template Reference

Mapping from mesh cells to Dof that have support on them. More...

#include <dof_mapping_base.hpp>

Inheritance diagram for FEAT::Space::DofMappingBase< Space_ >:
FEAT::Space::DofMappingIdentity< Space_, dofs_per_cell_ > FEAT::Space::DofMappingIdentity< Space_, dofs_per_cell_ > FEAT::Space::DofMappingSingleEntity< Space_, codim_, dofs_per_cell_ > FEAT::Space::DofMappingUniform< Space_, DofTraits_, DofTag_ > FEAT::Space::DofMappingSingleEntity< Space_, 0, dofs_per_cell_ >

Public Types

typedef SpaceType::ShapeType ShapeType
 shape typedef More...
 
typedef Space_ SpaceType
 space typedef More...
 

Public Member Functions

void finish ()
 Releases the dof-mapping from the current cell. More...
 
Index get_current_cell_index () const
 Returns the current cell-index. More...
 
Index get_index (int local_dof_idx) const
 Returns the mapped dof index. More...
 
Index get_num_global_dofs () const
 Return the number of global dofs. More...
 
int get_num_local_dofs () const
 Returns the number of local dofs. More...
 
void prepare (Index cell_index)
 Prepares the dof-mapping for a given cell. More...
 

Protected Member Functions

 DofMappingBase (const SpaceType &space)
 constructor More...
 

Protected Attributes

Index _cell_index
 currently active cell index More...
 
const SpaceType_space
 space reference More...
 

Detailed Description

template<typename Space_>
class FEAT::Space::DofMappingBase< Space_ >

Mapping from mesh cells to Dof that have support on them.

This class acts as a base-class and interface documentation for Finite Element Dof mapping implementations.

In FEAT, every FE basis function is associated with a mesh entity of a certain shape dimension, i.e. vertices, facets or cells. The DofMapping maps a mesh cell (meaning only the highest-dimensional entities of a mesh) to a set of basis functions with nonempty support on the closure of the cell. It does, however, not contain any information about which entities of that cell are associated with which basis function. This is done by the DofAssignment.

See also
DofAssignmentBase
Template Parameters
Space_The finite element space that this Dof mapping is used by.
Author
Peter Zajac

Definition at line 34 of file dof_mapping_base.hpp.

Member Typedef Documentation

◆ ShapeType

template<typename Space_ >
typedef SpaceType::ShapeType FEAT::Space::DofMappingBase< Space_ >::ShapeType

shape typedef

Definition at line 40 of file dof_mapping_base.hpp.

◆ SpaceType

template<typename Space_ >
typedef Space_ FEAT::Space::DofMappingBase< Space_ >::SpaceType

space typedef

Definition at line 38 of file dof_mapping_base.hpp.

Constructor & Destructor Documentation

◆ DofMappingBase()

template<typename Space_ >
FEAT::Space::DofMappingBase< Space_ >::DofMappingBase ( const SpaceType space)
inlineexplicitprotected

constructor

Definition at line 49 of file dof_mapping_base.hpp.

Member Function Documentation

◆ finish()

template<typename Space_ >
void FEAT::Space::DofMappingBase< Space_ >::finish ( )
inline

Releases the dof-mapping from the current cell.

Definition at line 71 of file dof_mapping_base.hpp.

References FEAT::Space::DofMappingBase< Space_ >::_cell_index.

◆ get_current_cell_index()

template<typename Space_ >
Index FEAT::Space::DofMappingBase< Space_ >::get_current_cell_index ( ) const
inline

Returns the current cell-index.

Definition at line 80 of file dof_mapping_base.hpp.

References FEAT::Space::DofMappingBase< Space_ >::_cell_index.

◆ get_index()

template<typename Space_ >
Index FEAT::Space::DofMappingBase< Space_ >::get_index ( int  local_dof_idx) const

Returns the mapped dof index.

Parameters
[in]local_dof_idxThe index of the local dof whose mapped index is to be returned.
Returns
The mapped dof index.

◆ get_num_global_dofs()

template<typename Space_ >
Index FEAT::Space::DofMappingBase< Space_ >::get_num_global_dofs ( ) const

Return the number of global dofs.

Returns
The total number of global degress of freedom for the finite element space.

◆ get_num_local_dofs()

template<typename Space_ >
int FEAT::Space::DofMappingBase< Space_ >::get_num_local_dofs ( ) const

Returns the number of local dofs.

Returns
The total number of local degrees of freedom for the currently active cell.

◆ prepare()

template<typename Space_ >
void FEAT::Space::DofMappingBase< Space_ >::prepare ( Index  cell_index)
inline

Prepares the dof-mapping for a given cell.

Parameters
[in]cell_indexThe index of the cell that is to be used by the dof-mapping.

Definition at line 63 of file dof_mapping_base.hpp.

References FEAT::Space::DofMappingBase< Space_ >::_cell_index.

Referenced by FEAT::Space::DofMappingUniform< Space_, DofTraits_, DofTag_ >::prepare().

Member Data Documentation

◆ _cell_index

◆ _space


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