Struct keeps handle to entity in the field. More...

#include <src/multi_indices/EntsMultiIndices.hpp>

Inheritance diagram for MoFEM::FieldEntity:

Collaboration diagram for MoFEM::FieldEntity:

Public Types
typedef interface_Field< Field >	interface_type_Field

typedef interface_RefEntity< RefEntity >	interface_type_RefEntity

Public Member Functions
	FieldEntity (const boost::shared_ptr< Field > &field_ptr, const boost::shared_ptr< RefEntity > &ref_ent_ptr, boost::shared_ptr< double *const > &&field_data_adaptor_ptr, boost::shared_ptr< const int > &&t_max_order_ptr)

virtual	~FieldEntity ()=default

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

int	getNbDofsOnEnt () const
	Get number of active DOFs on entity. More...

boost::shared_ptr< FieldData *const > &	getEntFieldDataPtr () const
	Get shared ptr to vector adaptor pointing to the field tag data on entity. More...

VectorAdaptor	getEntFieldData () const
	Get vector of DOFs active values on entity. More...

int	getOrderNbDofs (ApproximationOrder order) const
	Get number of DOFs on entity for given order of approximation. More...

int	getOrderNbDofsDiff (ApproximationOrder order) const
	Get difference of number of DOFs between order and order-1. More...

const ApproximationOrder *	getMaxOrderPtr () const
	Get pinter to Tag keeping approximation order. More...

ApproximationOrder	getMaxOrder () const
	Get order set to the entity (Allocated tag size for such number) More...

const UId &	getGlobalUniqueId () const
	Get global unique id. More...

UId	getGlobalUniqueIdCalculate () const
	Calculate global UId. More...

boost::shared_ptr< RefEntity > &	getRefEntityPtr ()
	Get pointer to RefEntity. More...

boost::shared_ptr< Field > &	getFieldPtr () const
	Get pointer to Field data structure associated with this entity. More...

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

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

	interface_Field (const interface_Field< Field > &interface)

virtual	~interface_Field ()

EntityHandle	getMeshset () const

int	getCoordSysId () const

int	getCoordSysDim (const int d=0) const
	Get dimension of general two-point tensor MoFEM::CoordSys::getDim. More...

MoFEMErrorCode	get_E_Base (const double m[]) const

MoFEMErrorCode	get_E_DualBase (const double m[]) const

MoFEMErrorCode	get_e_Base (const double m[]) const

MoFEMErrorCode	get_e_DualBase (const double m[]) const

EntityHandle	getCoordSysMeshSet () const

std::string	getCoordSysName () const

boost::string_ref	getCoordSysNameRef () const

const BitFieldId &	getId () const

boost::string_ref	getNameRef () const

std::string	getName () const

FieldSpace	getSpace () const

FieldApproximationBase	getApproxBase () const

FieldCoefficientsNumber	getNbOfCoeffs () const

unsigned int	getBitNumber () const

boost::shared_ptr< Field > &	getFieldPtr () const

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

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

	interface_RefEntity (const interface_RefEntity< RefEntity > &interface)

virtual	~interface_RefEntity ()

boost::shared_ptr< BasicEntityData > &	getBasicDataPtr ()

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

EntityHandle	getRefEnt () const

EntityType	getParentEntType () const

EntityHandle	getParentEnt () const

BitRefLevel *	getBitRefLevelPtr () const

const BitRefLevel &	getBitRefLevel () const

unsigned long int	getBitRefLevelULong () const

EntityType	getEntType () const

EntityID	getEntId () const

EntityHandle	getOwnerEnt () const

EntityHandle &	getOwnerEnt ()

int	getOwnerProc () const

int &	getOwnerProc ()

int	getPartProc () const

int &	getPartProc ()

unsigned char	getPStatus () const

int *	getSharingProcsPtr () const

EntityHandle *	getSharingHandlersPtr () const

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

Static Public Member Functions
static boost::shared_ptr< FieldData *const >	makeSharedFieldDataAdaptorPtr (const boost::shared_ptr< Field > &field_ptr, const boost::shared_ptr< RefEntity > &ref_ent_ptr)
	Return shared pointer to entity field data vector adaptor. More...

static UId	getGlobalUniqueIdCalculate (const int owner_proc, const char bit_number, const EntityHandle moab_owner_handle, const bool true_if_distributed_mesh)
	Calculate UId for field entity. More...

static UId	getGlobalUniqueIdCalculate_Low_Proc (const int owner_proc)

static UId	getGlobalUniqueIdCalculate_Hi_Proc (const int owner_proc)

Public Attributes
UId	globalUId
	Global unique id for this entity. More...

Public Attributes inherited from MoFEM::interface_Field< Field >
boost::shared_ptr< Field >	sFieldPtr

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

Private Attributes
boost::shared_ptr< const ApproximationOrder >	tagMaxOrderPtr

boost::shared_ptr< FieldData *const >	fieldDataAdaptorPtr

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

Detailed Description

Struct keeps handle to entity in the field.

Definition at line 568 of file EntsMultiIndices.hpp.

Member Typedef Documentation

◆ interface_type_Field

typedef interface_Field<Field> MoFEM::FieldEntity::interface_type_Field

Definition at line 571 of file EntsMultiIndices.hpp.

◆ interface_type_RefEntity

typedef interface_RefEntity<RefEntity> MoFEM::FieldEntity::interface_type_RefEntity

Definition at line 572 of file EntsMultiIndices.hpp.

Constructor & Destructor Documentation

◆ FieldEntity()

MoFEM::FieldEntity::FieldEntity	(	const boost::shared_ptr< Field > &	field_ptr,
		const boost::shared_ptr< RefEntity > &	ref_ent_ptr,
		boost::shared_ptr< double *const > &&	field_data_adaptor_ptr,
		boost::shared_ptr< const int > &&	t_max_order_ptr
	)

Definition at line 148 of file EntsMultiIndices.cpp.

     : interface_Field<Field>(field_ptr), interface_RefEntity<RefEntity>(
                                              ref_ent_ptr),
       tagMaxOrderPtr(t_max_order_ptr),
       fieldDataAdaptorPtr(field_data_adaptor_ptr) {
   globalUId = getGlobalUniqueIdCalculate();
 
   if (PetscUnlikely(!fieldDataAdaptorPtr))
     THROW_MESSAGE("Pointer to field data adaptor not set");
 
   if (PetscUnlikely(!tagMaxOrderPtr))
     THROW_MESSAGE("Pointer to max order not set");
 }

◆ ~FieldEntity()

virtual MoFEM::FieldEntity::~FieldEntity ( )

virtualdefault

Member Function Documentation

◆ getDofOrderMap()

std::array<int, MAX_DOFS_ON_ENTITY>& MoFEM::FieldEntity::getDofOrderMap ( ) const

get hash-map relating dof index on entity with its order

DOFs of given field are indexed on entity of the same type, same space, approximation base and number of coefficients, are sorted in the way.

Definition at line 735 of file EntsMultiIndices.hpp.

                                                                    {
     return getFieldPtr()->getDofOrderMap(getEntType());
   }

◆ getEnt()

EntityHandle MoFEM::FieldEntity::getEnt ( ) const

Get entity handle.

Returns: EntityHandle

Definition at line 586 of file EntsMultiIndices.hpp.

586 { return getRefEnt(); }

MoFEM::interface_RefEntity< RefEntity >::getRefEnt

EntityHandle getRefEnt() const

Definition: EntsMultiIndices.hpp:353

◆ getEntFieldData()

VectorAdaptor MoFEM::FieldEntity::getEntFieldData ( ) const

Get vector of DOFs active values on entity.

Returns: Vector of DOFs values

Definition at line 619 of file EntsMultiIndices.hpp.

                                                {
     return getVectorAdaptor(*fieldDataAdaptorPtr, getNbDofsOnEnt());
   }

◆ getEntFieldDataPtr()

boost::shared_ptr<FieldData *const>& MoFEM::FieldEntity::getEntFieldDataPtr ( ) const

Get shared ptr to vector adaptor pointing to the field tag data on entity.

Returns: boost::shared_ptr<VectorAdaptor>&

Definition at line 611 of file EntsMultiIndices.hpp.

                                                                        {
     return fieldDataAdaptorPtr;
   }

◆ getFieldPtr()

boost::shared_ptr<Field>& MoFEM::FieldEntity::getFieldPtr ( ) const

Get pointer to Field data structure associated with this entity.

Definition at line 721 of file EntsMultiIndices.hpp.

                                                      {
     return this->sFieldPtr;
   }

◆ getGlobalUniqueId()

const UId& MoFEM::FieldEntity::getGlobalUniqueId ( ) const

Get global unique id.

Returns: Global UId

Definition at line 661 of file EntsMultiIndices.hpp.

661 { return globalUId; }

MoFEM::FieldEntity::globalUId

UId globalUId

Global unique id for this entity.

Definition: EntsMultiIndices.hpp:573

◆ getGlobalUniqueIdCalculate() [1/2]

static UId MoFEM::FieldEntity::getGlobalUniqueIdCalculate	(	const int	owner_proc,
		const char	bit_number,
		const EntityHandle	moab_owner_handle,
		const bool	true_if_distributed_mesh
	)

static

Calculate UId for field entity.

UId is constructed such that all DOFs are ordered by processor, entity, field.

Parameters

owner_proc	owning processor
bit_number	field bit number
moab_owner_handle	entity handle on owning processor
true_if_distributed_mesh	if true UId is constructed for distributed meshes

Returns: UId

Definition at line 677 of file EntsMultiIndices.hpp.

                                                                   {
     // assert(bit_number < 32);
     // assert(owner_proc < 1024);
     constexpr int ent_shift = 8 * sizeof(EntityHandle);
     if (true_if_distributed_mesh)
       return (static_cast<UId>(moab_owner_handle) |
               static_cast<UId>(bit_number) << ent_shift |
               static_cast<UId>(owner_proc) << 5 + ent_shift)
              << 9;
     else
       return (static_cast<UId>(moab_owner_handle) | static_cast<UId>(bit_number)
                                                         << ent_shift)
              << 9;
   }

◆ getGlobalUniqueIdCalculate() [2/2]

UId MoFEM::FieldEntity::getGlobalUniqueIdCalculate ( ) const

Calculate global UId.

Returns: Global UId

Definition at line 707 of file EntsMultiIndices.hpp.

                                                 {
     return getGlobalUniqueIdCalculate(
         sPtr->owner_proc, getBitNumber(), sPtr->moab_owner_handle,
         getBasicDataPtr()->trueIfDistributedMesh());
   }

◆ getGlobalUniqueIdCalculate_Hi_Proc()

static UId MoFEM::FieldEntity::getGlobalUniqueIdCalculate_Hi_Proc ( const int owner_proc )

static

Definition at line 698 of file EntsMultiIndices.hpp.

                                                                              {
     return getGlobalUniqueIdCalculate(owner_proc, BITFIELDID_SIZE - 1,
                                       MBMAXTYPE, true);
   }

◆ getGlobalUniqueIdCalculate_Low_Proc()

static UId MoFEM::FieldEntity::getGlobalUniqueIdCalculate_Low_Proc ( const int owner_proc )

static

Definition at line 694 of file EntsMultiIndices.hpp.

                                                                               {
     return getGlobalUniqueIdCalculate(owner_proc, 0, 0, true);
   }

◆ getMaxOrder()

ApproximationOrder MoFEM::FieldEntity::getMaxOrder ( ) const

Get order set to the entity (Allocated tag size for such number)

Returns: Approximation order

Definition at line 653 of file EntsMultiIndices.hpp.

                                                 {
     return *tagMaxOrderPtr.get();
   }

◆ getMaxOrderPtr()

const ApproximationOrder* MoFEM::FieldEntity::getMaxOrderPtr ( ) const

Get pinter to Tag keeping approximation order.

Returns: Pointer to Tag

Definition at line 645 of file EntsMultiIndices.hpp.

                                                           {
     return tagMaxOrderPtr.get();
   }

◆ getNbDofsOnEnt()

int MoFEM::FieldEntity::getNbDofsOnEnt ( ) const

Get number of active DOFs on entity.

Returns: Number of DOFs

Definition at line 592 of file EntsMultiIndices.hpp.

                                     {
     return getOrderNbDofs(getMaxOrder()) * getNbOfCoeffs();
   }

◆ getOrderNbDofs()

int MoFEM::FieldEntity::getOrderNbDofs ( ApproximationOrder order ) const

Get number of DOFs on entity for given order of approximation.

Parameters

order Order of approximation

Returns: Number of DOFs

Definition at line 628 of file EntsMultiIndices.hpp.

                                                             {
     return (this->sFieldPtr->forderTable[getEntType()])(order);
   }

◆ getOrderNbDofsDiff()

int MoFEM::FieldEntity::getOrderNbDofsDiff ( ApproximationOrder order ) const

Get difference of number of DOFs between order and order-1.

Parameters

order Approximation order

Returns: Difference number of DOFs

Definition at line 637 of file EntsMultiIndices.hpp.

                                                                 {
     return getOrderNbDofs(order) - getOrderNbDofs(order - 1);
   }

◆ getRefEntityPtr()

boost::shared_ptr<RefEntity>& MoFEM::FieldEntity::getRefEntityPtr ( )

Get pointer to RefEntity.

Definition at line 716 of file EntsMultiIndices.hpp.

716 { return this->sPtr; }

MoFEM::interface_RefEntity< RefEntity >::sPtr

boost::shared_ptr< RefEntity > sPtr

Definition: EntsMultiIndices.hpp:336

◆ makeSharedFieldDataAdaptorPtr()

boost::shared_ptr< FieldData *const > MoFEM::FieldEntity::makeSharedFieldDataAdaptorPtr	(	const boost::shared_ptr< Field > &	field_ptr,
		const boost::shared_ptr< RefEntity > &	ref_ent_ptr
	)

static

Return shared pointer to entity field data vector adaptor.

Returns: boost::shared_ptr<VectorAdaptor>

Definition at line 166 of file EntsMultiIndices.cpp.

                                                    {
   int size;
   double *ptr;
   switch (ref_ent_ptr->getEntType()) {
   case MBVERTEX:
     size = field_ptr->getNbOfCoeffs();
     ptr = static_cast<FieldData *>(
         MoFEM::get_tag_ptr(field_ptr->moab, field_ptr->th_FieldDataVerts,
                            ref_ent_ptr->ent, &size));
     break;
   default:
     ptr = static_cast<FieldData *>(MoFEM::get_tag_ptr(
         field_ptr->moab, field_ptr->th_FieldData, ref_ent_ptr->ent, &size));
   }
   return boost::make_shared<FieldData *const>(ptr);
 }

Friends And Related Function Documentation

◆ operator<<

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

friend

Definition at line 185 of file EntsMultiIndices.cpp.

                                                              {
   os << "ent_global_uid "
      << (UId)e.getGlobalUniqueId()
      // << " ent_local_uid " << (UId)e.get_local_unique_id()
      << " entity " << e.getEnt() << " type " << e.getEntType() << " pstatus "
      << std::bitset<8>(e.getPStatus()) << " owner handle " << e.getOwnerEnt()
      << " owner proc " << e.getOwnerProc() << " order " << e.getMaxOrder()
      << " " << *e.sFieldPtr;
   return os;
 }

Member Data Documentation

◆ fieldDataAdaptorPtr

boost::shared_ptr<FieldData *const> MoFEM::FieldEntity::fieldDataAdaptorPtr

mutableprivate

Definition at line 741 of file EntsMultiIndices.hpp.

◆ globalUId

UId MoFEM::FieldEntity::globalUId

Global unique id for this entity.

Definition at line 573 of file EntsMultiIndices.hpp.

◆ tagMaxOrderPtr

boost::shared_ptr<const ApproximationOrder> MoFEM::FieldEntity::tagMaxOrderPtr

mutableprivate

Definition at line 740 of file EntsMultiIndices.hpp.

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

src/multi_indices/EntsMultiIndices.hpp
src/multi_indices/impl/EntsMultiIndices.cpp

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ interface_type_Field

◆ interface_type_RefEntity

Constructor & Destructor Documentation

◆ FieldEntity()

◆ ~FieldEntity()

Member Function Documentation

◆ getDofOrderMap()

◆ getEnt()

◆ getEntFieldData()

◆ getEntFieldDataPtr()

◆ getFieldPtr()

◆ getGlobalUniqueId()

◆ getGlobalUniqueIdCalculate() [1/2]

◆ getGlobalUniqueIdCalculate() [2/2]

◆ getGlobalUniqueIdCalculate_Hi_Proc()

◆ getGlobalUniqueIdCalculate_Low_Proc()

◆ getMaxOrder()

◆ getMaxOrderPtr()

◆ getNbDofsOnEnt()

◆ getOrderNbDofs()

◆ getOrderNbDofsDiff()

◆ getRefEntityPtr()

◆ makeSharedFieldDataAdaptorPtr()

Friends And Related Function Documentation

◆ operator<<

Member Data Documentation

◆ fieldDataAdaptorPtr

◆ globalUId

◆ tagMaxOrderPtr