keeps information about DOF on the entity More...

#include <src/multi_indices/DofsMultiIndices.hpp>

Inheritance diagram for MoFEM::DofEntity:

Collaboration diagram for MoFEM::DofEntity:

Public Types
using	interface_type_Field = interface_FieldImpl< FieldEntity, FieldEntity >

using	interface_type_FieldEntity = interface_FieldEntity< FieldEntity >

using	interface_type_RefEntity = interface_RefEntity< FieldEntity >

Public Types inherited from MoFEM::interface_FieldImpl< FieldEntity, FieldEntity >
using	interface_type_RefEntity = interface_RefEntity< FieldEntity >

Public Member Functions
virtual	~DofEntity ()=default

	DofEntity (const boost::shared_ptr< FieldEntity > &entity_ptr, const ApproximationOrder dof_order, const FieldCoefficientsNumber dof_rank, const DofIdx dof)

DofIdx	getEntDofIdx () const

FieldData &	getFieldData () const

const UId &	getEntLocalUniqueId () const

const UId	getEntGlobalUniqueId () const

UId	getLocalUniqueId () const

UId	getGlobalUniqueId () const

ShortId	getNonNonuniqueShortId () const
	get short uid it is unique in combination with entity handle More...

EntityHandle	getEnt () const

ApproximationOrder	getDofOrder () const

FieldCoefficientsNumber	getDofCoeffIdx () const

char	getActive () const

Public Member Functions inherited from MoFEM::interface_FieldEntity< FieldEntity >
	interface_FieldEntity (const boost::shared_ptr< FieldEntity > &sptr)

int	getNbDofsOnEnt () const

VectorAdaptor	getEntFieldData () const

int	getOrderNbDofs (ApproximationOrder order) const

int	getOrderNbDofsDiff (ApproximationOrder order) const

ApproximationOrder	getMaxOrder () const

UId	getGlobalUniqueId () const

UId &	getLocalUniqueId () const

boost::shared_ptr< RefEntity > &	getRefEntityPtr () const

boost::shared_ptr< FieldEntity > &	getFieldEntityPtr () const

const std::array< int, MAX_DOFS_ON_ENTITY > &	getDofOrderMap () const
	get hash-map relating dof index on entity with its order More...

boost::shared_ptr< S >	getSharedStoragePtr () const

boost::weak_ptr< EntityStorage > &	getWeakStoragePtr () const

Public Member Functions inherited from MoFEM::interface_Field< FieldEntity, FieldEntity >
	interface_Field (const boost::shared_ptr< FieldEntity > &field_ptr, const boost::shared_ptr< FieldEntity > &ref_ents_ptr)

EntityHandle	getMeshset () const

int	getCoordSysDim (const int d=0) const

const BitFieldId &	getId () const

boost::string_ref	getNameRef () const

std::string	getName () const

FieldSpace	getSpace () const

FieldApproximationBase	getApproxBase () const

FieldCoefficientsNumber	getNbOfCoeffs () const

FieldBitNumber	getBitNumber () const

std::array< ApproximationOrder, MAX_DOFS_ON_ENTITY > &	getDofOrderMap (const EntityType type) const
	get hash-map relating dof index on entity with its order More...

const Field *	getFieldRawPtr () const

FieldOrderTable &	getFieldOrderTable ()

Public Member Functions inherited from MoFEM::interface_FieldImpl< FieldEntity, FieldEntity >
	interface_FieldImpl (const boost::shared_ptr< FieldEntity > &field_ptr, const boost::shared_ptr< FieldEntity > &ref_ents_ptr)

virtual	~interface_FieldImpl ()=default

Public Member Functions inherited from MoFEM::interface_RefEntity< FieldEntity >
	interface_RefEntity (const boost::shared_ptr< FieldEntity > &sptr)

	interface_RefEntity (const interface_RefEntity< FieldEntity > &interface)

virtual	~interface_RefEntity ()=default

int	getSideNumber () const

boost::shared_ptr< SideNumber >	getSideNumberPtr () const
	Get the Side number. More...

const boost::shared_ptr< BasicEntityData >	getBasicDataPtr () const
	Get pointer to basic data struture. More...

EntityHandle	getEnt () const
	Get the entity handle. More...

EntityType	getParentEntType () const
	Get patent entity. More...

EntityHandle	getParentEnt () const

BitRefLevel *	getBitRefLevelPtr () const
	Get pointer to bit ref level tag. More...

const BitRefLevel &	getBitRefLevel () const

unsigned long int	getBitRefLevelULong () const
	Get entity ref bit refinement as ulong. More...

EntityType	getEntType () const
	Get entity type. More...

int	getEntDimension () const
	Get the Ent Dimension. More...

const char *	getEntTypeName () const
	Get the Ent Type Name. More...

EntityID	getEntId () const
	get entity id More...

EntityHandle	getOwnerEnt () const

EntityHandle &	getOwnerEnt ()

int	getOwnerProc () const

int	getPartProc () const

int *	getPartProcPtr () const
	Get pointer to partition tag. More...

unsigned char	getPStatus () const

int *	getSharingProcsPtr () const
	get shared processors More...

EntityHandle *	getSharingHandlersPtr () const
	get sharid entity handlers More...

boost::shared_ptr< FieldEntity > &	getRefEntityPtr () const

Static Public Member Functions
static ShortId	getNonNonuniqueShortId (const DofIdx dof, const boost::shared_ptr< FieldEntity > &ent_ptr)

static UId	getUniqueIdCalculate (const DofIdx dof, UId ent_uid)

static UId	getLocalUniqueIdCalculate (const DofIdx dof, const boost::shared_ptr< FieldEntity > &ent_ptr)

static UId	getLoFieldEntityUId (const FieldBitNumber bit, const EntityHandle ent)

static UId	getHiFieldEntityUId (const FieldBitNumber bit, const EntityHandle ent)

static UId	getGlobalUniqueIdCalculate (const DofIdx dof, const boost::shared_ptr< FieldEntity > &ent_ptr)
	Calculate UId for DOF. More...

Private Attributes
DofIdx	dof

Friends
struct	DofEntity_active_change

std::ostream &	operator<< (std::ostream &os, const DofEntity &e)

Additional Inherited Members
Public Attributes inherited from MoFEM::interface_RefEntity< FieldEntity >
boost::shared_ptr< FieldEntity >	sPtr

Detailed Description

keeps information about DOF on the entity

Definition at line 16 of file DofsMultiIndices.hpp.

Member Typedef Documentation

◆ interface_type_Field

using MoFEM::DofEntity::interface_type_Field = interface_FieldImpl<FieldEntity, FieldEntity>

Definition at line 20 of file DofsMultiIndices.hpp.

◆ interface_type_FieldEntity

using MoFEM::DofEntity::interface_type_FieldEntity = interface_FieldEntity<FieldEntity>

Definition at line 21 of file DofsMultiIndices.hpp.

◆ interface_type_RefEntity

using MoFEM::DofEntity::interface_type_RefEntity = interface_RefEntity<FieldEntity>

Definition at line 22 of file DofsMultiIndices.hpp.

Constructor & Destructor Documentation

◆ ~DofEntity()

virtual MoFEM::DofEntity::~DofEntity ( )

virtualdefault

◆ DofEntity()

MoFEM::DofEntity::DofEntity	(	const boost::shared_ptr< FieldEntity > &	entity_ptr,
		const ApproximationOrder	dof_order,
		const FieldCoefficientsNumber	dof_rank,
		const DofIdx	dof
	)

Definition at line 10 of file DofsMultiIndices.cpp.

     : interface_FieldEntity<FieldEntity>(entity_ptr), dof(dof) {
  
 #ifndef NDEBUG
   if (PetscUnlikely(!entity_ptr))
     THROW_MESSAGE("FieldEntity pointer not initialized");
   if (PetscUnlikely(!sPtr))
     THROW_MESSAGE("FieldEntity pointer not initialized");
   if (PetscUnlikely(!getFieldEntityPtr()))
     THROW_MESSAGE("FieldEntity pointer not initialized");
   // verify dof order
   if (PetscUnlikely(dof_order != getDofOrderMap()[dof])) {
     THROW_MESSAGE(
         "Inconsistent DOF order with order set before for entity " +
         boost::lexical_cast<std::string>(*entity_ptr) + "\n" + "dof->" +
         boost::lexical_cast<std::string>(dof) + " dof_order->" +
         boost::lexical_cast<std::string>(dof_order) +
         " != " + boost::lexical_cast<std::string>(getDofOrderMap()[dof]) +
         "<-getDofOrderMap()[dof]");
   }
  
   // verify dof rank
   if (PetscUnlikely(dof_rank != dof % getNbOfCoeffs()))
     THROW_MESSAGE("Inconsistent DOFs rank with index of DOF on entity");
 #endif
 }

Member Function Documentation

◆ getActive()

char MoFEM::DofEntity::getActive ( ) const

inline

Returns: return true if dof us active

Definition at line 136 of file DofsMultiIndices.hpp.

136 { return dof < 0 ? 0 : 1; }

◆ getDofCoeffIdx()

FieldCoefficientsNumber MoFEM::DofEntity::getDofCoeffIdx ( ) const

inline

Returns: get dof coefficient index

Definition at line 131 of file DofsMultiIndices.hpp.

                                                         {
     return getEntDofIdx() % getNbOfCoeffs();
   }

◆ getDofOrder()

ApproximationOrder MoFEM::DofEntity::getDofOrder ( ) const

inline

Returns: get dof approximation order

Definition at line 126 of file DofsMultiIndices.hpp.

                                                 {
     return getDofOrderMap()[getEntDofIdx()];
   }

◆ getEnt()

EntityHandle MoFEM::DofEntity::getEnt ( ) const

inline

Returns: get dof entity handle

Definition at line 123 of file DofsMultiIndices.hpp.

123 { return this->sPtr->getEnt(); }

◆ getEntDofIdx()

DofIdx MoFEM::DofEntity::getEntDofIdx ( ) const

inline

Returns: get dof index on entity

Definition at line 36 of file DofsMultiIndices.hpp.

36 { return std::abs(dof); }

◆ getEntGlobalUniqueId()

const UId MoFEM::DofEntity::getEntGlobalUniqueId ( ) const

inline

Returns: get entity unique dof id

Definition at line 50 of file DofsMultiIndices.hpp.

                                                 {
     return this->sPtr->getGlobalUniqueId();
   }

◆ getEntLocalUniqueId()

const UId& MoFEM::DofEntity::getEntLocalUniqueId ( ) const

inline

Returns: get entity unique dof id

Definition at line 45 of file DofsMultiIndices.hpp.

                                                 {
     return this->sPtr->getLocalUniqueId();
   }

◆ getFieldData()

FieldData& MoFEM::DofEntity::getFieldData ( ) const

inline

Returns: get field data on dof

Definition at line 39 of file DofsMultiIndices.hpp.

                                          {
     return const_cast<FieldData &>(
         (*this->sPtr->getEntFieldDataPtr())[getEntDofIdx()]);
   }

◆ getGlobalUniqueId()

UId MoFEM::DofEntity::getGlobalUniqueId ( ) const

inline

Returns: get unique dof id

Definition at line 99 of file DofsMultiIndices.hpp.

                                        {
     return getUniqueIdCalculate(std::abs(dof), this->sPtr->getGlobalUniqueId());
   }

◆ getGlobalUniqueIdCalculate()

static UId MoFEM::DofEntity::getGlobalUniqueIdCalculate	(	const DofIdx	dof,
		const boost::shared_ptr< FieldEntity > &	ent_ptr
	)

inlinestatic

Calculate UId for DOF.

UId is constructed such that all DOFs are ordered by processor, entity, field and dof index on entity, On entity dofs index is constructed such that coefficient number and dofs increase with dofs index on entity.

Parameters

dof	dof index on entity
ent_ptr	pointer to field entity

Returns: UId

Definition at line 93 of file DofsMultiIndices.hpp.

                                                                           {
     return getUniqueIdCalculate(dof, ent_ptr->getGlobalUniqueId());
   }

◆ getHiFieldEntityUId()

static UId MoFEM::DofEntity::getHiFieldEntityUId	(	const FieldBitNumber	bit,
		const EntityHandle	ent
	)

inlinestatic

Definition at line 75 of file DofsMultiIndices.hpp.

                                                                 {
     return FieldEntity::getHiFieldEntityUId(
         FieldEntity::getLocalUniqueIdCalculate(bit, ent));
   }

◆ getLocalUniqueId()

UId MoFEM::DofEntity::getLocalUniqueId ( ) const

inline

Returns: get unique dof id

Definition at line 65 of file DofsMultiIndices.hpp.

                                       {
     return getUniqueIdCalculate(std::abs(dof), this->sPtr->getLocalUniqueId());
   }

◆ getLocalUniqueIdCalculate()

static UId MoFEM::DofEntity::getLocalUniqueIdCalculate	(	const DofIdx	dof,
		const boost::shared_ptr< FieldEntity > &	ent_ptr
	)

inlinestatic

Definition at line 59 of file DofsMultiIndices.hpp.

                                                                          {
     return getUniqueIdCalculate(dof, ent_ptr->getLocalUniqueId());
   }

◆ getLoFieldEntityUId()

static UId MoFEM::DofEntity::getLoFieldEntityUId	(	const FieldBitNumber	bit,
		const EntityHandle	ent
	)

inlinestatic

Definition at line 69 of file DofsMultiIndices.hpp.

                                                                 {
     return FieldEntity::getLoFieldEntityUId(
         FieldEntity::getLocalUniqueIdCalculate(bit, ent));
   }

◆ getNonNonuniqueShortId() [1/2]

ShortId MoFEM::DofEntity::getNonNonuniqueShortId ( ) const

inline

get short uid it is unique in combination with entity handle

EntityHandle are controlled by MOAB, which is unique in MOAB instance. However two MOAB instances, can have attached different EntityHandles to the same entity.

Relation between MoAB EntityHandle can be handled by saving entity handle data into tag, see MB_TYPE_HANDLE. MOAB at time of file reading or creating new MOAB instance, substitute tag value by approbate entity handle.

ShortId is created to handle problems related to saving data series, and reading those data using different MoAB instances.

Definition at line 118 of file DofsMultiIndices.hpp.

                                                 {
     return getNonNonuniqueShortId(getEntDofIdx(), getFieldEntityPtr());
   }

◆ getNonNonuniqueShortId() [2/2]

static ShortId MoFEM::DofEntity::getNonNonuniqueShortId	(	const DofIdx	dof,
		const boost::shared_ptr< FieldEntity > &	ent_ptr
	)

inlinestatic

Definition at line 25 of file DofsMultiIndices.hpp.

                                                                       {
     return static_cast<ShortId>(dof) |
            (static_cast<ShortId>(ent_ptr->getBitNumber()) << 9);
   }

◆ getUniqueIdCalculate()

static UId MoFEM::DofEntity::getUniqueIdCalculate	(	const DofIdx	dof,
		UId	ent_uid
	)

inlinestatic

Examples: eigen_elastic.cpp, and heat_method.cpp.

Definition at line 54 of file DofsMultiIndices.hpp.

                                                                         {
     return ent_uid | dof;
   }

Friends And Related Function Documentation

◆ DofEntity_active_change

friend struct DofEntity_active_change

friend

Definition at line 143 of file DofsMultiIndices.hpp.

◆ operator<<

std::ostream& operator<<	(	std::ostream &	os,
		const DofEntity &	e
	)

friend

Definition at line 39 of file DofsMultiIndices.cpp.

                                                            {
   os << "dof_uid " << e.getLocalUniqueId() << " dof_order " << e.getDofOrder()
      << " dof_rank " << e.getDofCoeffIdx() << " dof " << e.getEntDofIdx()
      << " active " << (e.dof < 0 ? false : true) << " "
      << *e.getFieldEntityPtr();
   return os;
 }

Member Data Documentation

◆ dof

DofIdx MoFEM::DofEntity::dof

private

Definition at line 141 of file DofsMultiIndices.hpp.

The documentation for this struct was generated from the following files:

src/multi_indices/DofsMultiIndices.hpp
src/multi_indices/impl/DofsMultiIndices.cpp

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ interface_type_Field

◆ interface_type_FieldEntity

◆ interface_type_RefEntity

Constructor & Destructor Documentation

◆ ~DofEntity()

◆ DofEntity()

Member Function Documentation

◆ getActive()

◆ getDofCoeffIdx()

◆ getDofOrder()

◆ getEnt()

◆ getEntDofIdx()

◆ getEntGlobalUniqueId()

◆ getEntLocalUniqueId()

◆ getFieldData()

◆ getGlobalUniqueId()

◆ getGlobalUniqueIdCalculate()

◆ getHiFieldEntityUId()

◆ getLocalUniqueId()

◆ getLocalUniqueIdCalculate()

◆ getLoFieldEntityUId()

◆ getNonNonuniqueShortId() [1/2]

◆ getNonNonuniqueShortId() [2/2]

◆ getUniqueIdCalculate()

Friends And Related Function Documentation

◆ DofEntity_active_change

◆ operator<<

Member Data Documentation

◆ dof