MoFEM::RefEntityTmp< 0 > Struct Reference

Struct keeps handle to refined handle. More...

#include <src/multi_indices/RefEntsMultiIndices.hpp>

Inheritance diagram for MoFEM::RefEntityTmp< 0 >:

Collaboration diagram for MoFEM::RefEntityTmp< 0 >:

Public Member Functions
	RefEntityTmp (const boost::shared_ptr< BasicEntityData > &basic_data_ptr, const EntityHandle ent)
	RefEntityTmp (const boost::shared_ptr< BasicEntityData > &basic_data_ptr, const EntityHandle ent, EntityHandle *ent_parent_tag_ptr)
virtual	~RefEntityTmp ()=default
virtual const boost::shared_ptr< BasicEntityData >	getBasicDataPtr () const
	Get pointer to basic data struture. More...
int	getSideNumber () const
boost::shared_ptr< SideNumber >	getSideNumberPtr () const
	Get the Side number. More...
EntityHandle	getEnt () const
	Get the entity handle. 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
	Owner handle on this or other processors. More...
int	getOwnerProc () const
int	getPartProc () const
	Get processor. More...
int *	getPartProcPtr () const
	Get pointer to partition tag. More...
unsigned char	getPStatus () const
	get pstatus This tag stores various aspects of parallel status in bits; see also define following, to be used in bit mask operations. If an entity is not shared with any other processors, the pstatus is 0, otherwise it's > 0 More...
int *	getSharingProcsPtr () const
	get shared processors More...
EntityHandle *	getSharingHandlersPtr () const
	get sharid entity handlers More...
EntityHandle *	getParentEntPtr () const
	Get pointer to parent entity tag. More...
BitRefLevel *	getBitRefLevelPtr () const
	Get pointer to bit ref level tag. More...
EntityType	getParentEntType () const
	Get patent entity. More...
EntityHandle	getParentEnt () const
	Get parent entity, i.e. entity form one refinement level up. More...
const BitRefLevel &	getBitRefLevel () const
	Get entity ref bit refinement signature. More...
unsigned long int	getBitRefLevelULong () const
	Get entity ref bit refinement as ulong. More...

Static Public Member Functions
static EntityHandle	getOwnerEnt (const EntityHandle ent, boost::shared_ptr< BasicEntityData > basic_ent_data)
static int	getOwnerProc (const EntityHandle ent, boost::shared_ptr< BasicEntityData > basic_ent_data)
static int	getPartProc (const EntityHandle ent, const Tag th, const boost::shared_ptr< BasicEntityData > &basic_ptr)
static MoFEMErrorCode	getParentEnt (Interface &moab, Range ents, std::vector< EntityHandle > vec_patent_ent)
static MoFEMErrorCode	getBitRefLevel (Interface &moab, Range ents, std::vector< BitRefLevel > &vec_bit_ref_level)
static MoFEMErrorCode	getBitRefLevel (Interface &moab, Range ents, std::vector< const BitRefLevel * > &vec_ptr_bit_ref_level)

Public Attributes
EntityHandle	ent

Static Public Attributes
static boost::weak_ptr< BasicEntityData >	basicDataPtr

Private Member Functions
const boost::shared_ptr< RefElement >	getRefElementPtr () const
	Get the pointer to reference element. More...

Private Attributes
EntityHandle *	entParentTagPtr
	Tag ptr to parent entity handle. More...

Static Private Attributes
static boost::weak_ptr< RefElement >	refElementPtr

Friends
struct	EntFiniteElement
struct	NumeredEntFiniteElement
std::ostream &	operator<< (std::ostream &os, const RefEntityTmp &e)

Detailed Description

Struct keeps handle to refined handle.

Todo:

th_RefType "_RefType" is set as two integers, need to be fixed, it is waste of space.

Definition at line 144 of file RefEntsMultiIndices.hpp.

Constructor & Destructor Documentation

RefEntityTmp() [1/2]

MoFEM::RefEntityTmp< 0 >::RefEntityTmp	(	const boost::shared_ptr< BasicEntityData > &	basic_data_ptr,
		const EntityHandle	ent
	)

Definition at line 25 of file RefEntsMultiIndices.cpp.

    : ent(ent) {
  entParentTagPtr = static_cast<EntityHandle *>(get_tag_ptr(
      basic_data_ptr->moab, basic_data_ptr->th_RefParentHandle, ent, NULL));
}

RefEntityTmp() [2/2]

MoFEM::RefEntityTmp< 0 >::RefEntityTmp	(	const boost::shared_ptr< BasicEntityData > &	basic_data_ptr,
		const EntityHandle	ent,
		EntityHandle *	ent_parent_tag_ptr
	)

Definition at line 33 of file RefEntsMultiIndices.cpp.

    : ent(ent), entParentTagPtr(ent_parent_tag_ptr) {}

~RefEntityTmp()

virtual MoFEM::RefEntityTmp< 0 >::~RefEntityTmp ( )

virtualdefault

Member Function Documentation

getBasicDataPtr()

virtual const boost::shared_ptr< BasicEntityData > MoFEM::RefEntityTmp< 0 >::getBasicDataPtr ( ) const

inlinevirtual

Get pointer to basic data struture.

Returns

const boost::shared_ptr<BasicEntityData>

Reimplemented in MoFEM::RefEntityTmp<-1 >.

Definition at line 159 of file RefEntsMultiIndices.hpp.

                                                                         {
    if (auto ptr = basicDataPtr.lock())
      return ptr;
    else
      return nullptr;
  }

getBitRefLevel() [1/3]

const BitRefLevel & MoFEM::RefEntityTmp< 0 >::getBitRefLevel ( ) const

inline

Get entity ref bit refinement signature.

Definition at line 501 of file RefEntsMultiIndices.hpp.

                                                   {
    return *getBitRefLevelPtr();
  }

getBitRefLevel() [2/3]

static MoFEMErrorCode MoFEM::RefEntityTmp< 0 >::getBitRefLevel ( Interface &  moab, Range  ents, std::vector< BitRefLevel > &  vec_bit_ref_level  )

inlinestatic

Definition at line 438 of file RefEntsMultiIndices.hpp.

                                                            {
    MoFEMFunctionBegin;
    Tag th_ref_bit_level;
    CHKERR moab.tag_get_handle("_RefBitLevel", th_ref_bit_level);
    vec_bit_ref_level.resize(ents.size());
    CHKERR moab.tag_get_data(th_ref_bit_level, ents,
                             &*vec_bit_ref_level.begin());
    MoFEMFunctionReturn(0);
  }

getBitRefLevel() [3/3]

static MoFEMErrorCode MoFEM::RefEntityTmp< 0 >::getBitRefLevel ( Interface &  moab, Range  ents, std::vector< const BitRefLevel * > &  vec_ptr_bit_ref_level  )

inlinestatic

Definition at line 450 of file RefEntsMultiIndices.hpp.

                                                                        {
    MoFEMFunctionBegin;
    Tag th_ref_bit_level;
    CHKERR moab.tag_get_handle("_RefBitLevel", th_ref_bit_level);
    vec_ptr_bit_ref_level.resize(ents.size());
    CHKERR moab.tag_get_by_ptr(
        th_ref_bit_level, ents,
        reinterpret_cast<const void **>(&*vec_ptr_bit_ref_level.begin()));
    MoFEMFunctionReturn(0);
  }

getBitRefLevelPtr()

BitRefLevel * MoFEM::RefEntityTmp< 0 >::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 483 of file RefEntsMultiIndices.hpp.

                                         {
    return static_cast<BitRefLevel *>(
        get_tag_ptr(this->getBasicDataPtr()->moab,
                    this->getBasicDataPtr()->th_RefBitLevel, this->ent, NULL));
  }

getBitRefLevelULong()

unsigned long int MoFEM::RefEntityTmp< 0 >::getBitRefLevelULong ( ) const

inline

Get entity ref bit refinement as ulong.

Definition at line 507 of file RefEntsMultiIndices.hpp.

                                                       {
    return getBitRefLevel().to_ulong();
  }

getEnt()

EntityHandle MoFEM::RefEntityTmp< 0 >::getEnt ( ) const

inline

Get the entity handle.

Returns

EntityHandle

Definition at line 180 of file RefEntsMultiIndices.hpp.

{ return this->ent; }

getEntDimension()

int MoFEM::RefEntityTmp< 0 >::getEntDimension ( ) const

inline

Get the Ent Dimension.

Returns

int

Definition at line 193 of file RefEntsMultiIndices.hpp.

                                     {
    return moab::CN::Dimension(getEntType());
  }

getEntId()

EntityID MoFEM::RefEntityTmp< 0 >::getEntId ( ) const

inline

get entity id

Definition at line 208 of file RefEntsMultiIndices.hpp.

                                   {
    return (EntityID)(this->ent & MB_ID_MASK);
  };

getEntType()

EntityType MoFEM::RefEntityTmp< 0 >::getEntType ( ) const

inline

Get entity type.

Definition at line 184 of file RefEntsMultiIndices.hpp.

                                       {
    return (EntityType)((this->ent & MB_TYPE_MASK) >> MB_ID_WIDTH);
  }

getEntTypeName()

const char * MoFEM::RefEntityTmp< 0 >::getEntTypeName ( ) const

inline

Get the Ent Type Name.

Returns

const char*

Definition at line 202 of file RefEntsMultiIndices.hpp.

                                            {
    return moab::CN::EntityTypeName(getEntType());
  }

getOwnerEnt() [1/2]

EntityHandle MoFEM::RefEntityTmp< 0 >::getOwnerEnt ( ) const

inline

Owner handle on this or other processors.

Definition at line 245 of file RefEntsMultiIndices.hpp.

                                          {
    return getOwnerEnt(this->ent, this->getBasicDataPtr());
  }

getOwnerEnt() [2/2]

static EntityHandle MoFEM::RefEntityTmp< 0 >::getOwnerEnt ( const EntityHandle  ent, boost::shared_ptr< BasicEntityData >  basic_ent_data  )

inlinestatic

Definition at line 213 of file RefEntsMultiIndices.hpp.

                                                               {
    auto *pcomm =
        ParallelComm::get_pcomm(&basic_ent_data->moab, basic_ent_data->pcommID);
 
    auto get_owner_ent = [&](auto tag) {
      if (auto owner_ent_ptr = static_cast<EntityHandle *>(
              MoFEM::get_tag_ptr(basic_ent_data->moab, tag, ent, NULL))) {
        return owner_ent_ptr[0];
      } else {
        return ent;
      }
    };
 
    if (auto pstat_ptr = static_cast<unsigned char *>(MoFEM::get_tag_ptr(
            basic_ent_data->moab, pcomm->pstatus_tag(), ent, NULL))) {
      if (!(*pstat_ptr & PSTATUS_NOT_OWNED)) {
        return ent;
      } else if (*pstat_ptr & PSTATUS_MULTISHARED) {
        return get_owner_ent(pcomm->sharedhs_tag());
      } else if (*pstat_ptr & PSTATUS_SHARED) {
        return get_owner_ent(pcomm->sharedh_tag());
      } else {
        return ent;
      }
    } else {
      return ent;
    }
  }

getOwnerProc() [1/2]

int MoFEM::RefEntityTmp< 0 >::getOwnerProc ( ) const

inline

Definition at line 280 of file RefEntsMultiIndices.hpp.

                                  {
    return getOwnerProc(this->ent, this->getBasicDataPtr());
  }

getOwnerProc() [2/2]

static int MoFEM::RefEntityTmp< 0 >::getOwnerProc ( const EntityHandle  ent, boost::shared_ptr< BasicEntityData >  basic_ent_data  )

inlinestatic

Definition at line 250 of file RefEntsMultiIndices.hpp.

                                                                {
    auto *pcomm =
        ParallelComm::get_pcomm(&basic_ent_data->moab, basic_ent_data->pcommID);
 
    auto get_owner_proc = [&](auto tag) {
      if (auto owner_proc = static_cast<int *>(
              MoFEM::get_tag_ptr(basic_ent_data->moab, tag, ent, NULL))) {
        return owner_proc[0];
      } else {
        return 0;
      }
    };
 
    if (auto pstat_ptr = static_cast<unsigned char *>(MoFEM::get_tag_ptr(
            basic_ent_data->moab, pcomm->pstatus_tag(), ent, NULL))) {
      if (!(*pstat_ptr & PSTATUS_NOT_OWNED)) {
        return pcomm->rank();
      } else if (*pstat_ptr & PSTATUS_MULTISHARED) {
        return get_owner_proc(pcomm->sharedps_tag());
      } else if (*pstat_ptr & PSTATUS_SHARED) {
        return get_owner_proc(pcomm->sharedp_tag());
      } else {
        return 0;
      }
    } else {
      return 0;
    }
  }

getParentEnt() [1/2]

EntityHandle MoFEM::RefEntityTmp< 0 >::getParentEnt ( ) const

inline

Get parent entity, i.e. entity form one refinement level up.

Definition at line 497 of file RefEntsMultiIndices.hpp.

{ return *(getParentEntPtr()); }

getParentEnt() [2/2]

static MoFEMErrorCode MoFEM::RefEntityTmp< 0 >::getParentEnt ( Interface &  moab, Range  ents, std::vector< EntityHandle >  vec_patent_ent  )

static

getParentEntPtr()

EntityHandle * MoFEM::RefEntityTmp< 0 >::getParentEntPtr ( ) const

inline

Get pointer to parent entity tag.

Each refined entity has his parent. Such information is stored on tags. This function get pinter to tag.

Returns

Pointer to tag on entity

Definition at line 470 of file RefEntsMultiIndices.hpp.

{ return entParentTagPtr; }

getParentEntType()

EntityType MoFEM::RefEntityTmp< 0 >::getParentEntType ( ) const

inline

Get patent entity.

Definition at line 491 of file RefEntsMultiIndices.hpp.

                                             {
    return (EntityType)((getParentEnt() & MB_TYPE_MASK) >> MB_ID_WIDTH);
  }

getPartProc() [1/2]

int MoFEM::RefEntityTmp< 0 >::getPartProc ( ) const

inline

Get processor.

Definition at line 296 of file RefEntsMultiIndices.hpp.

                                 {
    if (PetscUnlikely(getEntType() == MBENTITYSET)) {
      return getPartProc(ent, this->getBasicDataPtr()->th_MeshsetPart,
                         this->getBasicDataPtr());
    } else {
      auto *pcomm = ParallelComm::get_pcomm(&this->getBasicDataPtr()->moab,
                                            this->getBasicDataPtr()->pcommID);
      return getPartProc(ent, pcomm->partition_tag(), this->getBasicDataPtr());
    }
  }

getPartProc() [2/2]

static int MoFEM::RefEntityTmp< 0 >::getPartProc ( const EntityHandle  ent, const Tag  th, const boost::shared_ptr< BasicEntityData > &  basic_ptr  )

inlinestatic

Definition at line 285 of file RefEntsMultiIndices.hpp.

                                                                 {
    if (auto part_ptr = static_cast<int *>(
            MoFEM::get_tag_ptr(basic_ptr->moab, th, ent, NULL))) {
      return *part_ptr >= 0 ? *part_ptr : 0;
    } else
      return 0;
  };

getPartProcPtr()

int * MoFEM::RefEntityTmp< 0 >::getPartProcPtr ( ) const

inline

Get pointer to partition tag.

Returns

int*

Definition at line 312 of file RefEntsMultiIndices.hpp.

                                     {
    if (PetscUnlikely(getEntType() == MBENTITYSET)) {
      return static_cast<int *>(MoFEM::get_tag_ptr(
          this->getBasicDataPtr()->moab,
          this->getBasicDataPtr()->th_MeshsetPart, ent, NULL));
    } else {
      auto *pcomm = ParallelComm::get_pcomm(&this->getBasicDataPtr()->moab,
                                            this->getBasicDataPtr()->pcommID);
      return static_cast<int *>(MoFEM::get_tag_ptr(
          this->getBasicDataPtr()->moab, pcomm->partition_tag(), ent, NULL));
    }
  }

getPStatus()

unsigned char MoFEM::RefEntityTmp< 0 >::getPStatus ( ) const

inline

get pstatus This tag stores various aspects of parallel status in bits; see also define following, to be used in bit mask operations. If an entity is not shared with any other processors, the pstatus is 0, otherwise it's > 0

bit 0: !owned (0=owned, 1=not owned) bit 1: shared (0=not shared, 1=shared) bit 2: multishared (shared by > 2 procs; 0=not shared, 1=shared) bit 3: interface (0=not interface, 1=interface) bit 4: ghost (0=not ghost, 1=ghost)

Definition at line 338 of file RefEntsMultiIndices.hpp.

                                          {
    auto *pcomm = ParallelComm::get_pcomm(&this->getBasicDataPtr()->moab,
                                          this->getBasicDataPtr()->pcommID);
    if (auto pstat_ptr = static_cast<unsigned char *>(MoFEM::get_tag_ptr(
            this->getBasicDataPtr()->moab, pcomm->pstatus_tag(), ent, NULL))) {
      return *pstat_ptr;
    } else {
      return 0;
    }
  }

getRefElementPtr()

const boost::shared_ptr< RefElement > MoFEM::RefEntityTmp< 0 >::getRefElementPtr ( ) const

inlineprivate

Get the pointer to reference element.

Returns

const boost::shared_ptr<RefElement>

Definition at line 525 of file RefEntsMultiIndices.hpp.

                                                                    {
    if (auto ptr = refElementPtr.lock())
      return ptr;
    else
      return nullptr;
  }

getSharingHandlersPtr()

EntityHandle * MoFEM::RefEntityTmp< 0 >::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 415 of file RefEntsMultiIndices.hpp.

                                                     {
    EntityHandle *sharing_handlers_ptr = NULL;
    auto &moab = this->getBasicDataPtr()->moab;
    ParallelComm *pcomm =
        ParallelComm::get_pcomm(&moab, this->getBasicDataPtr()->pcommID);
    if (getPStatus() & PSTATUS_MULTISHARED) {
      // entity is multi shared
      rval = moab.tag_get_by_ptr(pcomm->sharedhs_tag(), &this->ent, 1,
                                 (const void **)&sharing_handlers_ptr);
      MOAB_THROW(rval);
    } else if (getPStatus() & PSTATUS_SHARED) {
      // shared
      rval = moab.tag_get_by_ptr(pcomm->sharedh_tag(), &this->ent, 1,
                                 (const void **)&sharing_handlers_ptr);
      MOAB_THROW(rval);
    }
    return sharing_handlers_ptr;
  }

getSharingProcsPtr()

int * MoFEM::RefEntityTmp< 0 >::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 373 of file RefEntsMultiIndices.hpp.

                                  {
    auto &moab = this->getBasicDataPtr()->moab;
    int *sharing_procs_ptr = NULL;
    ParallelComm *pcomm =
        ParallelComm::get_pcomm(&moab, this->getBasicDataPtr()->pcommID);
    if (getPStatus() & PSTATUS_MULTISHARED) {
      // entity is multi shared
      rval = moab.tag_get_by_ptr(pcomm->sharedps_tag(), &this->ent, 1,
                                 (const void **)&sharing_procs_ptr);
      MOAB_THROW(rval);
    } else if (getPStatus() & PSTATUS_SHARED) {
      // shared
      rval = moab.tag_get_by_ptr(pcomm->sharedp_tag(), &this->ent, 1,
                                 (const void **)&sharing_procs_ptr);
      MOAB_THROW(rval);
    }
    return sharing_procs_ptr;
  }

getSideNumber()

int MoFEM::RefEntityTmp< 0 >::getSideNumber

(

)

const

Definition at line 38 of file RefEntsMultiIndices.cpp.

                                         {
  return getRefElementPtr()->getSideNumberPtr(ent)->side_number;
}

getSideNumberPtr()

boost::shared_ptr< SideNumber > MoFEM::RefEntityTmp< 0 >::getSideNumberPtr

(

)

const

Get the Side number.

Returns

int

Definition at line 42 of file RefEntsMultiIndices.cpp.

                                                                    {
  return getRefElementPtr()->getSideNumberPtr(ent);
}

Friends And Related Function Documentation

EntFiniteElement

friend struct EntFiniteElement

friend

Definition at line 517 of file RefEntsMultiIndices.hpp.

NumeredEntFiniteElement

friend struct NumeredEntFiniteElement

friend

Definition at line 518 of file RefEntsMultiIndices.hpp.

operator<<

std::ostream & operator<< ( std::ostream &  os, const RefEntityTmp< 0 > &  e  )

friend

Member Data Documentation

basicDataPtr

boost::weak_ptr< BasicEntityData > MoFEM::RefEntityTmp< 0 >::basicDataPtr

static

Definition at line 514 of file RefEntsMultiIndices.hpp.

ent

EntityHandle MoFEM::RefEntityTmp< 0 >::ent

Definition at line 513 of file RefEntsMultiIndices.hpp.

entParentTagPtr

EntityHandle* MoFEM::RefEntityTmp< 0 >::entParentTagPtr

private

Tag ptr to parent entity handle.

Definition at line 533 of file RefEntsMultiIndices.hpp.

refElementPtr

boost::weak_ptr< RefElement > MoFEM::RefEntityTmp< 0 >::refElementPtr

staticprivate

Definition at line 532 of file RefEntsMultiIndices.hpp.

---

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

• src/multi_indices/RefEntsMultiIndices.hpp
• src/multi_indices/impl/RefEntsMultiIndices.cpp