#include <fei_DofMapper.hpp>

Public Member Functions
	DofMapper ()
	~DofMapper ()
void	setFieldSize (LocalOrdinal field, LocalOrdinal field_size)

Detailed Description

template<class LocalOrdinal, class GlobalOrdinal, class DofOrder = less_rank_id_field<LocalOrdinal, GlobalOrdinal>>
class fei::DofMapper< LocalOrdinal, GlobalOrdinal, DofOrder >

A mapping from mesh-degrees-of-freedom (dofs) to equation-numbers.

Mesh-dofs are represented by fei::Dof, see fei_Dof.hpp for details.

Equation numbers are also called global indices. They are globally-unique and zero-based.

A 'dof' may correspond to multiple global-indices if the dof's field has multiple scalar components, e.g. a vector field such as velocity in 3D.

The index returned by getGlobalIndex is the eqn-number for the first component of the dof's field.
The return-value of getDof is a pair<Dof,component> where component indicates which component of the dof's field corresponds to the input global-index.

Fields are assumed to be scalar fields (have 1 component) unless a field-size is set using the setFieldSize method.

Definition at line 42 of file fei_DofMapper.hpp.

Constructor & Destructor Documentation

◆ DofMapper()

template<class LocalOrdinal, class GlobalOrdinal, class DofOrder = less_rank_id_field<LocalOrdinal, GlobalOrdinal>>

fei::DofMapper< LocalOrdinal, GlobalOrdinal, DofOrder >::DofMapper ( )

inline

constructor

Definition at line 45 of file fei_DofMapper.hpp.

◆ ~DofMapper()

template<class LocalOrdinal, class GlobalOrdinal, class DofOrder = less_rank_id_field<LocalOrdinal, GlobalOrdinal>>

fei::DofMapper< LocalOrdinal, GlobalOrdinal, DofOrder >::~DofMapper ( )

inline

destructor

Definition at line 49 of file fei_DofMapper.hpp.

Member Function Documentation

◆ setFieldSize()

template<class LocalOrdinal, class GlobalOrdinal, class DofOrder>

void fei::DofMapper< LocalOrdinal, GlobalOrdinal, DofOrder >::setFieldSize	(	LocalOrdinal	field,
		LocalOrdinal	field_size )

Set the specified field to have the specified field_size. 'field' is added to the internal field map if not already present. If 'field' is already present, its field_size is reset to the new value.

Definition at line 124 of file fei_DofMapper.hpp.

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