Sierra Toolkit
Version of the Day
|
Field base class with an anonymous data type and anonymous multi-dimension. More...
#include <FieldBase.hpp>
Public Types | |
typedef FieldRestriction | Restriction |
typedef FieldRestrictionVector | RestrictionVector |
A fields' restrictions are maintained in a std::vector. | |
Public Member Functions | |
MetaData & | mesh_meta_data () const |
The meta data manager that owns this field. | |
unsigned | mesh_meta_data_ordinal () const |
Internally generated ordinal of this field that is unique within the owning meta data manager. | |
const std::string & | name () const |
Application-defined text name of this field. | |
template<class Type > | |
bool | type_is () const |
Query if the type is Type. | |
const DataTraits & | data_traits () const |
Return the data traits for this field's type. | |
unsigned | number_of_states () const |
Number of states of this field. | |
FieldState | state () const |
FieldState of this field. | |
unsigned | rank () const |
Multi-dimensional array rank of this field, which is zero for a scalar field. | |
const shards::ArrayDimTag *const * | dimension_tags () const |
Multi-dimensional array dimension tags of this field. | |
unsigned | max_size (EntityRank entity_rank) const |
Maximum field data allocation size declared for this field for the given entity rank. | |
template<class A > | |
const A * | attribute () const |
Query attribute that has been attached to this field. | |
const RestrictionVector & | restrictions () const |
Vector of field restriction which is volatile until the owning meta data manager is committed. | |
const RestrictionVector & | selector_restrictions () const |
const Restriction & | restriction (unsigned entity_rank, const Part &part) const |
Query a field restriction, result is volatile until the owning meta data manager is committed. | |
FieldBase * | field_state (FieldState fstate) const |
const void * | get_initial_value () const |
void * | get_initial_value () |
unsigned | get_initial_value_num_bytes () const |
Friends | |
class | ::stk_classic::mesh::MetaData |
class | ::stk_classic::mesh::impl::FieldRepository |
class | ::stk_classic::mesh::impl::FieldBaseImpl |
class | ::stk_classic::mesh::UnitTestFieldImpl |
Allow the unit test driver access. | |
Field base class with an anonymous data type and anonymous multi-dimension.
This class is the base class for all Fields. It defines the member-function API for Field objects. Note that the entire Field API is much broader than what's defined in this class. See Field.hpp for more.
Definition at line 53 of file FieldBase.hpp.