Sierra Toolkit Version of the Day
stk::mesh::Entity Class Reference

A fundamental unit within the discretization of a problem domain, including but not limited to nodes, edges, sides, and elements. More...

#include <Entity.hpp>

List of all members.

Public Member Functions

EntityModificationLog log_query () const
 Query the current state of the entity log.
EntityRank entity_rank () const
 The rank of this entity.
EntityId identifier () const
 Identifier for this entity which is globally unique for a given entity type.
const EntityKeykey () const
 The globally unique key ( entity type + identifier ) of this entity.
Bucketbucket () const
 The bucket which holds this mesh entity's field data.
Bucketbucket_ptr () const
unsigned bucket_ordinal () const
 The ordinal for this entity within its bucket.
size_t synchronized_count () const
 The mesh bulk data synchronized_count when this entity's part membership was most recently modified.
PairIterRelation relations () const
 All Entity relations for which this entity is a member. The relations are ordered from lowest entity-rank to highest entity-rank.
PairIterRelation relations (EntityRank type) const
 Entity relations for which this entity is a member, the other entity is of a given type.
PairIterRelation node_relations () const
unsigned owner_rank () const
 Parallel processor rank of the processor which owns this entity.
PairIterEntityComm sharing () const
 Parallel processes which share this entity.
PairIterEntityComm comm () const
 Complete communicaiton list for this entity.
PairIterEntityComm comm (const Ghosting &sub) const
 Subset communicaiton list for this entity.
void compress_relation_capacity ()

Detailed Description

A fundamental unit within the discretization of a problem domain, including but not limited to nodes, edges, sides, and elements.

Entities are distributed among parallel processors. A given entity may reside on more than one processor; however, it is owned by exactly one of the processors on which it resides.

Note that an Entity's state comprises:

  • existence - Whether this entity has been created and is not destroyed
  • owner - The rank of the owning process
  • part-membership - The set of parts this entity belongs to
  • relations - Relationships between other Entities When any of the above changes, the Entity's log state may change

Definition at line 120 of file Entity.hpp.


Member Function Documentation

size_t stk::mesh::Entity::synchronized_count ( ) const [inline]

The mesh bulk data synchronized_count when this entity's part membership was most recently modified.

If ( mesh.synchronized_state() == false && mesh.synchronized_count() == entity.synchronized_count() ) then entity was modified during this modification phase.

Definition at line 154 of file Entity.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines