v0.13.1
Public Member Functions | Public Attributes | List of all members
MoFEM::interface_RefEntity< T > Struct Template Reference

interface to RefEntity More...

#include <src/multi_indices/RefEntsMultiIndices.hpp>

Inheritance diagram for MoFEM::interface_RefEntity< T >:
[legend]

Public Member Functions

 interface_RefEntity (const boost::shared_ptr< T > &sptr)
 
 interface_RefEntity (const interface_RefEntity< T > &interface)
 
virtual ~interface_RefEntity ()=default
 
int getSideNumber () const
 
boost::shared_ptr< SideNumbergetSideNumberPtr () const
 Get the Side number. More...
 
const boost::shared_ptr< BasicEntityDatagetBasicDataPtr () 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
 
BitRefLevelgetBitRefLevelPtr () const
 Get pointer to bit ref level tag. More...
 
const BitRefLevelgetBitRefLevel () 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< T > & getRefEntityPtr () const
 

Public Attributes

boost::shared_ptr< TsPtr
 

Detailed Description

template<typename T>
struct MoFEM::interface_RefEntity< T >

interface to RefEntity

Definition at line 577 of file RefEntsMultiIndices.hpp.

Constructor & Destructor Documentation

◆ interface_RefEntity() [1/2]

template<typename T >
MoFEM::interface_RefEntity< T >::interface_RefEntity ( const boost::shared_ptr< T > &  sptr)

Definition at line 579 of file RefEntsMultiIndices.hpp.

579: sPtr(sptr) {}

◆ interface_RefEntity() [2/2]

template<typename T >
MoFEM::interface_RefEntity< T >::interface_RefEntity ( const interface_RefEntity< T > &  interface)

Definition at line 581 of file RefEntsMultiIndices.hpp.

582 : sPtr(interface.getRefEntityPtr()) {}

◆ ~interface_RefEntity()

template<typename T >
virtual MoFEM::interface_RefEntity< T >::~interface_RefEntity ( )
virtualdefault

Member Function Documentation

◆ getBasicDataPtr()

template<typename T >
const boost::shared_ptr< BasicEntityData > MoFEM::interface_RefEntity< T >::getBasicDataPtr ( ) const

Get pointer to basic data struture.

Returns
const boost::shared_ptr<BasicEntityData>

Definition at line 601 of file RefEntsMultiIndices.hpp.

601 {
602 return this->sPtr->getBasicDataPtr();
603 }

◆ getBitRefLevel()

template<typename T >
const BitRefLevel & MoFEM::interface_RefEntity< T >::getBitRefLevel ( ) const

Definition at line 634 of file RefEntsMultiIndices.hpp.

634 {
635 return this->sPtr->getBitRefLevel();
636 }

◆ getBitRefLevelPtr()

template<typename T >
BitRefLevel * MoFEM::interface_RefEntity< T >::getBitRefLevelPtr ( ) const

Get pointer to bit ref level tag.

Every entity belongs to some refinement level or levels. Each level is marked by bit set in BitRefLevel() (bitset) structure.

See Explaining mesh BitRefLevel for explanation.

Returns
Return pointer to tag.

Definition at line 627 of file RefEntsMultiIndices.hpp.

627 {
628 return this->sPtr->getBitRefLevelPtr();
629 }

◆ getBitRefLevelULong()

template<typename T >
unsigned long int MoFEM::interface_RefEntity< T >::getBitRefLevelULong ( ) const

Get entity ref bit refinement as ulong.

Definition at line 641 of file RefEntsMultiIndices.hpp.

641 {
642 return this->sPtr->getBitRefLevelULong();
643 }

◆ getEnt()

template<typename T >
EntityHandle MoFEM::interface_RefEntity< T >::getEnt ( ) const

Get the entity handle.

Returns
EntityHandle

Definition at line 608 of file RefEntsMultiIndices.hpp.

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

◆ getEntDimension()

template<typename T >
int MoFEM::interface_RefEntity< T >::getEntDimension ( ) const

Get the Ent Dimension.

Returns
int

Definition at line 653 of file RefEntsMultiIndices.hpp.

653{ return this->sPtr->getEntDimension(); }

◆ getEntId()

template<typename T >
EntityID MoFEM::interface_RefEntity< T >::getEntId ( ) const

get entity id

Definition at line 665 of file RefEntsMultiIndices.hpp.

665{ return this->sPtr->getEntId(); };

◆ getEntType()

template<typename T >
EntityType MoFEM::interface_RefEntity< T >::getEntType ( ) const

Get entity type.

Definition at line 648 of file RefEntsMultiIndices.hpp.

648{ return this->sPtr->getEntType(); };

◆ getEntTypeName()

template<typename T >
const char * MoFEM::interface_RefEntity< T >::getEntTypeName ( ) const

Get the Ent Type Name.

Returns
const char*

Definition at line 658 of file RefEntsMultiIndices.hpp.

658 {
659 return this->sPtr->getEntTypeName();
660 }

◆ getOwnerEnt() [1/2]

template<typename T >
EntityHandle & MoFEM::interface_RefEntity< T >::getOwnerEnt ( )

Definition at line 675 of file RefEntsMultiIndices.hpp.

675{ return this->sPtr->getOwnerEnt(); }

◆ getOwnerEnt() [2/2]

template<typename T >
EntityHandle MoFEM::interface_RefEntity< T >::getOwnerEnt ( ) const

Definition at line 670 of file RefEntsMultiIndices.hpp.

670{ return this->sPtr->getOwnerEnt(); }

◆ getOwnerProc()

template<typename T >
int MoFEM::interface_RefEntity< T >::getOwnerProc ( ) const

Definition at line 680 of file RefEntsMultiIndices.hpp.

680{ return this->sPtr->getOwnerProc(); }

◆ getParentEnt()

template<typename T >
EntityHandle MoFEM::interface_RefEntity< T >::getParentEnt ( ) const

Definition at line 620 of file RefEntsMultiIndices.hpp.

620 {
621 return this->sPtr->getParentEnt();
622 }

◆ getParentEntType()

template<typename T >
EntityType MoFEM::interface_RefEntity< T >::getParentEntType ( ) const

Get patent entity.

Definition at line 613 of file RefEntsMultiIndices.hpp.

613 {
614 return this->sPtr->getParentEntType();
615 };

◆ getPartProc()

template<typename T >
int MoFEM::interface_RefEntity< T >::getPartProc ( ) const

Definition at line 685 of file RefEntsMultiIndices.hpp.

685{ return this->sPtr->getPartProc(); }

◆ getPartProcPtr()

template<typename T >
int * MoFEM::interface_RefEntity< T >::getPartProcPtr ( ) const

Get pointer to partition tag.

Returns
int*

Definition at line 690 of file RefEntsMultiIndices.hpp.

690{ return this->sPtr->getPartProcPtr(); }

◆ getPStatus()

template<typename T >
unsigned char MoFEM::interface_RefEntity< T >::getPStatus ( ) const

Definition at line 695 of file RefEntsMultiIndices.hpp.

695{ return this->sPtr->getPStatus(); }

◆ getRefEntityPtr()

template<typename T >
boost::shared_ptr< T > & MoFEM::interface_RefEntity< T >::getRefEntityPtr ( ) const

Definition at line 714 of file RefEntsMultiIndices.hpp.

714{ return this->sPtr; }

◆ getSharingHandlersPtr()

template<typename T >
EntityHandle * MoFEM::interface_RefEntity< T >::getSharingHandlersPtr ( ) const

get sharid entity handlers

Returning list to shared entity handlers. Use it with getSharingProcsPtr()

DO NOT MODIFY LIST.

BasicEntity *ent_ptr = BasicEntity(moab,entity_handle);
for(int proc = 0; proc<MAX_SHARING_PROCS && -1 !=
ent_ptr->getSharingProcsPtr[proc]; proc++) {
if(ent_ptr->getSharingProcsPtr[proc] == -1) {
// End of the list
break;
}
int sharing_proc = ent_ptr->getSharingProcsPtr[proc];
EntityHandle sharing_ent = ent_ptr->getSharingHandlersPtr[proc];
if(!(ent_ptr->getPStatus()&PSTATUS_MULTISHARED)) {
break;
}
}

Definition at line 707 of file RefEntsMultiIndices.hpp.

707 {
708 return this->sPtr->getSharingHandlersPtr();
709 }

◆ getSharingProcsPtr()

template<typename T >
int * MoFEM::interface_RefEntity< T >::getSharingProcsPtr ( ) const

get shared processors

Returning list to shared processors. Lists end with -1. Returns NULL if not sharing processors.

DO NOT MODIFY LIST.

BasicEntity *ent_ptr = BasicEntity(moab,entity_handle);
for(int proc = 0; proc<MAX_SHARING_PROCS && -1 !=
ent_ptr->getSharingProcsPtr[proc]; proc++) {
if(ent_ptr->getSharingProcsPtr[proc] == -1) {
// End of the list
break;
}
int sharing_proc = ent_ptr->getSharingProcsPtr[proc];
EntityHandle sharing_ent = ent_ptr->getSharingHandlersPtr[proc];
if(!(ent_ptr->getPStatus()&PSTATUS_MULTISHARED)) {
break;
}
}

Definition at line 700 of file RefEntsMultiIndices.hpp.

700 {
701 return this->sPtr->getSharingProcsPtr();
702 }

◆ getSideNumber()

template<typename T >
int MoFEM::interface_RefEntity< T >::getSideNumber ( ) const

Definition at line 589 of file RefEntsMultiIndices.hpp.

589{ return this->sPtr->getSideNumber(); }

◆ getSideNumberPtr()

template<typename T >
boost::shared_ptr< SideNumber > MoFEM::interface_RefEntity< T >::getSideNumberPtr ( ) const

Get the Side number.

Returns
int

Definition at line 594 of file RefEntsMultiIndices.hpp.

594 {
595 return this->sPtr->getSideNumberPtr();
596 }

Member Data Documentation

◆ sPtr

template<typename T >
boost::shared_ptr<T> MoFEM::interface_RefEntity< T >::sPtr
mutable

Definition at line 716 of file RefEntsMultiIndices.hpp.


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