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

A container for the field data of a homogeneous collection of entities. More...

#include <Bucket.hpp>

List of all members.

Public Types

typedef
boost::indirect_iterator
< Entity *const * > 
iterator

Public Member Functions

iterator begin () const
 Beginning of the bucket.
iterator end () const
 End of the bucket.
size_t size () const
 Number of entities associated with this bucket.
size_t capacity () const
 Capacity of this bucket.
Entityoperator[] (size_t i) const
 Query the i^th entity.
unsigned field_data_size (const FieldBase &field) const
 Query the size of this field data specified by FieldBase.
const
FieldBase::Restriction::size_type * 
field_data_stride (const FieldBase &field) const
 Query the stride of this field data specified by FieldBase.
unsigned char * field_data_location (const FieldBase &field, const Entity &entity) const
 Query the location of this field data specified by FieldBase and Entity.
unsigned char * field_data_location (const FieldBase &field, unsigned ordinal) const
 Query the location of this field data specified by FieldBase and Entity-bucket-ordinal.
unsigned char * fast_field_data_location (const FieldBase &field, unsigned ordinal) const
 Query the location of this field data specified by FieldBase and Entity-bucket-ordinal This method should only be called if the caller knows that the field exists on the bucket. In an attempt to improve performance, this method skips the if-test that is normally done.
unsigned char * field_data_location (const FieldBase &field) const
 Query the location of this field data specified by FieldBase.
template<class field_type >
FieldTraits< field_type >
::data_type * 
field_data (const field_type &field, const Entity &entity) const
 Query the location of this field data specified by FieldBase and Entity.
BulkDatamesh () const
 The bulk data manager that owns this bucket.
unsigned entity_rank () const
 Type of entities in this bucket.
void supersets (PartVector &) const
 This bucket is a subset of these parts.
void supersets (OrdinalVector &) const
bool member (const Part &) const
 Bucket is a subset of the given part.
bool member_all (const PartVector &) const
 Bucket is a subset of all of the given parts.
bool member_all (const OrdinalVector &) const
bool member_any (const PartVector &) const
 Bucket is a subset of any of the given parts.
bool member_any (const OrdinalVector &) const
std::pair< const unsigned
*, const unsigned * > 
superset_part_ordinals () const
bool equivalent (const Bucket &b) const
 Equivalent buckets have the same parts.
unsigned allocation_size () const
 The allocation size, in bytes, of this bucket.
bool assert_correct () const
 A method to assist in unit testing - accesses private data as necessary.

Friends

class impl::BucketRepository
class impl::BucketImpl
class ::stk::mesh::BulkData

Detailed Description

A container for the field data of a homogeneous collection of entities.

The entities are homogeneous in that they are of the same entity type and are members of the same of parts.

Definition at line 94 of file Bucket.hpp.


Member Function Documentation

std::pair<const unsigned *, const unsigned *> stk::mesh::Bucket::superset_part_ordinals ( ) const [inline]

Query bucket's supersets' ordinals.

Definition at line 188 of file Bucket.hpp.


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