MoFEM::interface_RefEntity< T > Struct Template Reference

interface to RefEntity More...

#include <src/multi_indices/FieldMultiIndices.hpp>

Inheritance diagram for MoFEM::interface_RefEntity< T >:

Collaboration diagram for MoFEM::interface_RefEntity< T >:

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< 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< T > &	getRefEntityPtr () const

Public Attributes
boost::shared_ptr< T >	sPtr

Detailed Description

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

interface to RefEntity

Definition at line 19 of file FieldMultiIndices.hpp.

Constructor & Destructor Documentation

interface_RefEntity() [1/2]

template<typename T >

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

inline

Definition at line 574 of file RefEntsMultiIndices.hpp.

: sPtr(sptr) {}

interface_RefEntity() [2/2]

template<typename T >

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

inline

Definition at line 576 of file RefEntsMultiIndices.hpp.

      : 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

inline

Get pointer to basic data struture.

Returns

const boost::shared_ptr<BasicEntityData>

Definition at line 596 of file RefEntsMultiIndices.hpp.

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

getBitRefLevel()

template<typename T >

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

inline

Definition at line 629 of file RefEntsMultiIndices.hpp.

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

getBitRefLevelPtr()

template<typename T >

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

inline

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 622 of file RefEntsMultiIndices.hpp.

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

getBitRefLevelULong()

template<typename T >

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

inline

Get entity ref bit refinement as ulong.

Definition at line 636 of file RefEntsMultiIndices.hpp.

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

getEnt()

template<typename T >

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

inline

Get the entity handle.

Returns

EntityHandle

Definition at line 603 of file RefEntsMultiIndices.hpp.

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

getEntDimension()

template<typename T >

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

inline

Get the Ent Dimension.

Returns

int

Definition at line 648 of file RefEntsMultiIndices.hpp.

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

getEntId()

template<typename T >

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

inline

get entity id

Definition at line 660 of file RefEntsMultiIndices.hpp.

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

getEntType()

template<typename T >

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

inline

Get entity type.

Definition at line 643 of file RefEntsMultiIndices.hpp.

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

getEntTypeName()

template<typename T >

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

inline

Get the Ent Type Name.

Returns

const char*

Definition at line 653 of file RefEntsMultiIndices.hpp.

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

getOwnerEnt() [1/2]

template<typename T >

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

inline

Definition at line 670 of file RefEntsMultiIndices.hpp.

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

getOwnerEnt() [2/2]

template<typename T >

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

inline

Definition at line 665 of file RefEntsMultiIndices.hpp.

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

getOwnerProc()

template<typename T >

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

inline

Definition at line 675 of file RefEntsMultiIndices.hpp.

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

getParentEnt()

template<typename T >

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

inline

Definition at line 615 of file RefEntsMultiIndices.hpp.

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

getParentEntType()

template<typename T >

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

inline

Get patent entity.

Definition at line 608 of file RefEntsMultiIndices.hpp.

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

getPartProc()

template<typename T >

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

inline

Definition at line 680 of file RefEntsMultiIndices.hpp.

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

getPartProcPtr()

template<typename T >

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

inline

Get pointer to partition tag.

Returns

int*

Definition at line 685 of file RefEntsMultiIndices.hpp.

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

getPStatus()

template<typename T >

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

inline

Definition at line 690 of file RefEntsMultiIndices.hpp.

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

getRefEntityPtr()

template<typename T >

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

inline

Definition at line 709 of file RefEntsMultiIndices.hpp.

{ return this->sPtr; }

getSharingHandlersPtr()

template<typename T >

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

inline

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 702 of file RefEntsMultiIndices.hpp.

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

getSharingProcsPtr()

template<typename T >

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

inline

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 695 of file RefEntsMultiIndices.hpp.

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

getSideNumber()

template<typename T >

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

inline

Definition at line 584 of file RefEntsMultiIndices.hpp.

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

getSideNumberPtr()

template<typename T >

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

inline

Get the Side number.

Returns

int

Definition at line 589 of file RefEntsMultiIndices.hpp.

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

Member Data Documentation

sPtr

template<typename T >

boost::shared_ptr<T> MoFEM::interface_RefEntity< T >::sPtr

mutable

Definition at line 711 of file RefEntsMultiIndices.hpp.

---

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

• src/multi_indices/FieldMultiIndices.hpp
• src/multi_indices/RefEntsMultiIndices.hpp