keeps information about indexed dofs for the finite element More...

#include "src/multi_indices/DofsMultiIndices.hpp"

Inheritance diagram for MoFEM::FEDofEntity:

Collaboration diagram for MoFEM::FEDofEntity:

Public Member Functions
	FEDofEntity ()=delete

Public Member Functions inherited from MoFEM::DofEntity
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

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

boost::shared_ptr< S >	getSharedStoragePtr () const
	Get the Weak Storage pointer.

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

Public Member Functions inherited from MoFEM::interface_Field< FIELD, REFENT >
	interface_Field (const boost::shared_ptr< FIELD > &field_ptr, const boost::shared_ptr< REFENT > &ref_ents_ptr)
	Constructor.

EntityHandle	getMeshset () const
	Get field meshset handle.

int	getCoordSysDim (const int d=0) const
	Get coordinate system dimension.

const BitFieldId &	getId () const
	Get field ID.

boost::string_ref	getNameRef () const
	Get field name reference.

std::string	getName () const
	Get field name.

FieldSpace	getSpace () const
	Get approximation space.

FieldApproximationBase	getApproxBase () const
	Get approximation basis.

FieldContinuity	getContinuity () const
	Get space continuity.

auto	getContinuityName () const
	Get space continuity name.

FieldCoefficientsNumber	getNbOfCoeffs () const
	Get number of coefficients per DOF.

FieldBitNumber	getBitNumber () const
	Get bit number for field ID.

std::array< ApproximationOrder, MAX_DOFS_ON_ENTITY > &	getDofOrderMap (const EntityType type) const
	Get DOF order mapping for entity type.

const Field *	getFieldRawPtr () const
	Get raw field pointer.

FieldOrderTable &	getFieldOrderTable ()
	Get field order table.

auto &	getDofSideMap ()
	Get DOF side mapping for broken spaces.

Public Member Functions inherited from MoFEM::interface_FieldImpl< FIELD, REFENT >
	interface_FieldImpl (const boost::shared_ptr< FIELD > &field_ptr, const boost::shared_ptr< REFENT > &ref_ents_ptr)
	Constructor with field and reference entity pointers.

virtual	~interface_FieldImpl ()=default
	Virtual destructor.

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

	interface_RefEntity (const interface_RefEntity< REFENT > &interface)

virtual	~interface_RefEntity ()=default

int	getSideNumber () const

boost::shared_ptr< SideNumber >	getSideNumberPtr () const

const boost::shared_ptr< BasicEntityData >	getBasicDataPtr () const

EntityHandle	getEnt () const

EntityType	getParentEntType () const

EntityHandle	getParentEnt () const

BitRefLevel *	getBitRefLevelPtr () const

const BitRefLevel &	getBitRefLevel () const

unsigned long int	getBitRefLevelULong () const

EntityType	getEntType () const

int	getEntDimension () const

const char *	getEntTypeName () const

EntityID	getEntId () const

EntityHandle	getOwnerEnt () const

EntityHandle &	getOwnerEnt ()

int	getOwnerProc () const

int	getPartProc () const

int *	getPartProcPtr () const

unsigned char	getPStatus () const

int *	getSharingProcsPtr () const

EntityHandle *	getSharingHandlersPtr () const

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

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

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

Additional Inherited Members
Public Types inherited from MoFEM::DofEntity
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< FIELD, REFENT >
using	interface_type_RefEntity = interface_RefEntity< REFENT >

Static Public Member Functions inherited from MoFEM::DofEntity
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.

Public Attributes inherited from MoFEM::interface_RefEntity< REFENT >
boost::shared_ptr< REFENT >	sPtr

Detailed Description

keeps information about indexed dofs for the finite element

Definition at line 267 of file DofsMultiIndices.hpp.

Constructor & Destructor Documentation

◆ FEDofEntity()

MoFEM::FEDofEntity::FEDofEntity ( )

delete

Member Function Documentation

◆ DofEntity()

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

private

Definition at line 31 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
}

Friends And Related Symbol Documentation

◆ operator<<

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

friend

Definition at line 84 of file DofsMultiIndices.cpp.

                                                             {
  os << "local dof FiniteElement idx "
     << "side_number " << static_cast<int>(e.getSideNumberPtr()->side_number)
     << " "
     << "sense " << static_cast<int>(e.getSideNumberPtr()->sense) << " "
     << *e.getFieldEntityPtr();
  return os;
}

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

src/multi_indices/DofsMultiIndices.hpp

Public Member Functions

Private Member Functions

Friends