fei::Dof< LocalOrdinal, GlobalOrdinal > Class Template Reference

#include <fei_Dof.hpp>

Public Member Functions
	Dof (LocalOrdinal rank, GlobalOrdinal id, LocalOrdinal field)
	~Dof ()
LocalOrdinal	rank () const
GlobalOrdinal	id () const
LocalOrdinal	field () const

Private Attributes
LocalOrdinal	m_rank
GlobalOrdinal	m_id
LocalOrdinal	m_field

Detailed Description

template<class LocalOrdinal, class GlobalOrdinal>
class fei::Dof< LocalOrdinal, GlobalOrdinal >

Dof - mesh-degree-of-freedom.

A mesh-dof is the triple (rank, id, field).

• Rank is an integer type used to label different 'kinds' of mesh-dofs, e.g. node vs face, etc.
• Id identifies a particular instance of a rank, e.g., node 97.
• Field is an integer type used to label solution fields such as temperature or displacement, etc.

Thus if the user chooses to give nodes a rank of 0 and the temperature field a label of 4, then the temperature at node 97 can be represented as the dof (0, 97, 4).

Notes:

1. The Dof class is templated on the two integer types LocalOrdinal and GlobalOrdinal. Ranks and Fields have type LocalOrdinal, while ids have type GlobalOrdinal. The distinction is somewhat arbitrary, but the assumption is that there may be billions (or more?) ids, but probably far fewer distinct ranks or fields. So in extreme cases a user may wish to use a different type (larger) for ids than for the rank or field.

Definition at line 40 of file fei_Dof.hpp.

Constructor & Destructor Documentation

template<class LocalOrdinal, class GlobalOrdinal>

fei::Dof< LocalOrdinal, GlobalOrdinal >::Dof ( LocalOrdinal  rank, GlobalOrdinal  id, LocalOrdinal  field  )

inline

constructor

Definition at line 43 of file fei_Dof.hpp.

template<class LocalOrdinal, class GlobalOrdinal>

fei::Dof< LocalOrdinal, GlobalOrdinal >::~Dof ( )

inline

destructor

Definition at line 47 of file fei_Dof.hpp.

Member Function Documentation

template<class LocalOrdinal, class GlobalOrdinal>

LocalOrdinal fei::Dof< LocalOrdinal, GlobalOrdinal >::rank ( ) const

inline

Definition at line 49 of file fei_Dof.hpp.

References fei::Dof< LocalOrdinal, GlobalOrdinal >::m_rank.

Referenced by fei::less_rank_id_field< LocalOrdinal, GlobalOrdinal >::operator()(), and fei::less_field_rank_id< LocalOrdinal, GlobalOrdinal >::operator()().

template<class LocalOrdinal, class GlobalOrdinal>

GlobalOrdinal fei::Dof< LocalOrdinal, GlobalOrdinal >::id ( ) const

inline

Definition at line 50 of file fei_Dof.hpp.

References fei::Dof< LocalOrdinal, GlobalOrdinal >::m_id.

Referenced by fei::less_rank_id_field< LocalOrdinal, GlobalOrdinal >::operator()(), and fei::less_field_rank_id< LocalOrdinal, GlobalOrdinal >::operator()().

template<class LocalOrdinal, class GlobalOrdinal>

LocalOrdinal fei::Dof< LocalOrdinal, GlobalOrdinal >::field ( ) const

inline

Definition at line 51 of file fei_Dof.hpp.

References fei::Dof< LocalOrdinal, GlobalOrdinal >::m_field.

Referenced by fei::less_rank_id_field< LocalOrdinal, GlobalOrdinal >::operator()(), and fei::less_field_rank_id< LocalOrdinal, GlobalOrdinal >::operator()().

Member Data Documentation

template<class LocalOrdinal, class GlobalOrdinal>

LocalOrdinal fei::Dof< LocalOrdinal, GlobalOrdinal >::m_rank

private

Definition at line 54 of file fei_Dof.hpp.

Referenced by fei::Dof< LocalOrdinal, GlobalOrdinal >::rank().

template<class LocalOrdinal, class GlobalOrdinal>

GlobalOrdinal fei::Dof< LocalOrdinal, GlobalOrdinal >::m_id

private

Definition at line 55 of file fei_Dof.hpp.

Referenced by fei::Dof< LocalOrdinal, GlobalOrdinal >::id().

template<class LocalOrdinal, class GlobalOrdinal>

LocalOrdinal fei::Dof< LocalOrdinal, GlobalOrdinal >::m_field

private

Definition at line 56 of file fei_Dof.hpp.

Referenced by fei::Dof< LocalOrdinal, GlobalOrdinal >::field().

---

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

• fei_Dof.hpp