moab
Types.hpp File Reference

Go to the source code of this file.

Types and names

MOAB, a Mesh-Oriented datABase, is a software component for creating, storing and accessing finite element mesh data.

Copyright 2004 Sandia Corporation. Under the terms of Contract DE-AC04-94AL85000 with Sandia Coroporation, the U.S. Government retains certain rights in this software.

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. Types used in the MOAB interface

enum  ErrorCode {
  MB_SUCCESS = 0, MB_INDEX_OUT_OF_RANGE, MB_TYPE_OUT_OF_RANGE, MB_MEMORY_ALLOCATION_FAILED,
  MB_ENTITY_NOT_FOUND, MB_MULTIPLE_ENTITIES_FOUND, MB_TAG_NOT_FOUND, MB_FILE_DOES_NOT_EXIST,
  MB_FILE_WRITE_ERROR, MB_NOT_IMPLEMENTED, MB_ALREADY_ALLOCATED, MB_VARIABLE_DATA_LENGTH,
  MB_INVALID_SIZE, MB_UNSUPPORTED_OPERATION, MB_UNHANDLED_OPTION, MB_STRUCTURED_MESH,
  MB_FAILURE
}
enum  Constants { MB_VARIABLE_LENGTH = -1 }
enum  TagType {
  MB_TAG_BIT = 0, MB_TAG_SPARSE = 1<<0, MB_TAG_DENSE = 1<<1, MB_TAG_MESH = 1<<2,
  MB_TAG_BYTES = 1<<3, MB_TAG_VARLEN = 1<<4, MB_TAG_CREAT = 1<<5, MB_TAG_EXCL = 1<<6,
  MB_TAG_STORE = 1<<7, MB_TAG_ANY = 1<<8, MB_TAG_NOOPQ = 1<<9, MB_TAG_DFTOK = 1<<10
}
enum  DataType {
  kScalar, kVector, kVertex, kCell,
  kInternalFace, kBoundaryFace, kBoundaryData, kBoundaryFaceData,
  kCellType, MB_TYPE_OPAQUE = 0, MB_TYPE_INTEGER = 1, MB_TYPE_DOUBLE = 2,
  MB_TYPE_BIT = 3, MB_TYPE_HANDLE = 4, MB_MAX_DATA_TYPE = MB_TYPE_HANDLE
}
enum  EntitySetProperty { MESHSET_TRACK_OWNER = 0x1, MESHSET_SET = 0x2, MESHSET_ORDERED = 0x4 }
enum  SenseType { SENSE_INVALID = -2, SENSE_REVERSE = -1, SENSE_BOTH = 0, SENSE_FORWARD = 1 }
typedef struct TagInfo * Tag

Typedef Documentation

typedef struct TagInfo* Tag

MOAB error codes

Examples:
TestExodusII.cpp.

Definition at line 101 of file Types.hpp.


Enumeration Type Documentation

enum Constants

Misc. integer constants, declared in enum for portability

Enumerator:
MB_VARIABLE_LENGTH 

Length value for variable-length tags

Definition at line 57 of file Types.hpp.

               {
  MB_VARIABLE_LENGTH = -1 
};
enum DataType

Specify data type for tags.

Enumerator:
kScalar 
kVector 
kVertex 
kCell 
kInternalFace 
kBoundaryFace 
kBoundaryData 
kBoundaryFaceData 
kCellType 
MB_TYPE_OPAQUE 

byte array

MB_TYPE_INTEGER 

native 'int' type

MB_TYPE_DOUBLE 

native 'double' type

MB_TYPE_BIT 

mandatory type for tags with MB_TAG_BIT storage

MB_TYPE_HANDLE 

EntityHandle

MB_MAX_DATA_TYPE 

Definition at line 79 of file Types.hpp.

Meshset options: properties for meshset creation. Values are bit flags that may be combined with a bitwise OR (|)

Enumerator:
MESHSET_TRACK_OWNER 

create entity to meshset adjacencies

MESHSET_SET 

set contents are unique

MESHSET_ORDERED 

order of set contents is preserved

Definition at line 107 of file Types.hpp.

enum ErrorCode

MOAB error codes

Enumerator:
MB_SUCCESS 
MB_INDEX_OUT_OF_RANGE 
MB_TYPE_OUT_OF_RANGE 
MB_MEMORY_ALLOCATION_FAILED 
MB_ENTITY_NOT_FOUND 
MB_MULTIPLE_ENTITIES_FOUND 
MB_TAG_NOT_FOUND 
MB_FILE_DOES_NOT_EXIST 
MB_FILE_WRITE_ERROR 
MB_NOT_IMPLEMENTED 
MB_ALREADY_ALLOCATED 
MB_VARIABLE_DATA_LENGTH 
MB_INVALID_SIZE 
MB_UNSUPPORTED_OPERATION 
MB_UNHANDLED_OPTION 
MB_STRUCTURED_MESH 
MB_FAILURE 
Examples:
LoadPartial.cpp, and TestExodusII.cpp.

Definition at line 34 of file Types.hpp.

enum SenseType

MOAB error codes

Enumerator:
SENSE_INVALID 

default, invalid, not defined

SENSE_REVERSE 

reversed

SENSE_BOTH 

both senses valid

SENSE_FORWARD 

forward

Definition at line 113 of file Types.hpp.

enum TagType

Specify storage type for tags. See MOAB users guide for more information.

Enumerator:
MB_TAG_BIT 

Tag size specified in bits, tag value is 8 bits or less

MB_TAG_SPARSE 

Storage optimized for tags on a few entities

MB_TAG_DENSE 

Storage optimized for tags on most entities of a type

MB_TAG_MESH 

Storage for tags on no entities, only the root set/whole mesh.

MB_TAG_BYTES 

Size is in number of bytes rather than number of values of DataType

MB_TAG_VARLEN 

Create variable-length tag

MB_TAG_CREAT 

Create tag if it does not already exist

MB_TAG_EXCL 

Fail if TAG_CREATE and tag already exists

MB_TAG_STORE 

Fail if tag exists and has different storage type

MB_TAG_ANY 

Do not fail if size, type, or default value do not match.

MB_TAG_NOOPQ 

Do not accept MB_TYPE_OPAQUE as a match for any type.

MB_TAG_DFTOK 

Do not fail for mismatched default values MB_TAG_CNVRT = 1<<11, Convert storage type if it does not match

Definition at line 62 of file Types.hpp.

             {
    MB_TAG_BIT   = 0,    
  MB_TAG_SPARSE= 1<<0, 
  MB_TAG_DENSE = 1<<1, 
  MB_TAG_MESH  = 1<<2, 
  MB_TAG_BYTES = 1<<3, 
  MB_TAG_VARLEN= 1<<4, 
  MB_TAG_CREAT = 1<<5, 
  MB_TAG_EXCL  = 1<<6, 
  MB_TAG_STORE = 1<<7, 
  MB_TAG_ANY   = 1<<8, 
  MB_TAG_NOOPQ = 1<<9, 
  MB_TAG_DFTOK = 1<<10 
};
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines