moab
mhdf.h File Reference
#include <H5Ipublic.h>

Go to the source code of this file.

Classes

struct  struct_mhdf_Status
 Struct used to return error status. More...
struct  mhdf_EntDesc
struct  mhdf_TagDesc
struct  mhdf_ElemDesc
struct  mhdf_FileDesc

Defines

#define MHDF_MESSAGE_BUFFER_LEN   160
#define mhdf_EDGE_TYPE_NAME   "Edge"
 Name to use for edge element.
#define mhdf_TRI_TYPE_NAME   "Tri"
 Name to use for triangle element.
#define mhdf_QUAD_TYPE_NAME   "Quad"
 Name to use for quadrilateral element.
#define mhdf_POLYGON_TYPE_NAME   "Polygon"
 Name to use for general polygon element.
#define mhdf_TET_TYPE_NAME   "Tet"
 Name to use for tetrahedral element.
#define mhdf_PYRAMID_TYPE_NAME   "Pyramid"
 Name to use for quad-based pyramid element.
#define mhdf_PRISM_TYPE_NAME   "Prism"
 Name to use for triangular prism element.
#define mdhf_KNIFE_TYPE_NAME   "Knife"
 Name to use for knife element.
#define mdhf_HEX_TYPE_NAME   "Hex"
 Name to use for quad-sided hexahedral element.
#define mhdf_POLYHEDRON_TYPE_NAME   "Polyhedron"
 Name to use for general polyhedron specified as a arbitrary-length list of faces.
#define mhdf_SEPTAHEDRON_TYPE_NAME   "Septahedron"
 Name to use for hexagonal-based pyramid.
#define MHDF_INDEX_TYPE   H5T_NATIVE_LONG
#define mhdf_SET_OWNER_BIT   0x1
 Make entities in set aware of owning set (MOAB-specific?)
#define mhdf_SET_UNIQUE_BIT   0x2
 Set cannot contain duplicates.
#define mhdf_SET_ORDER_BIT   0x4
 Set order is preserved.
#define mhdf_SET_RANGE_BIT   0x8
 The bit specifying set storage format.
#define mhdf_DENSE_TYPE   2
 Was dense tag data in mesh database.
#define mhdf_SPARSE_TYPE   1
 Was sparse tag data in mesh database.
#define mhdf_BIT_TYPE   0
 Was bit-field tag data in mesh database.
#define mhdf_MESH_TYPE   3
 Unused.

Typedefs

typedef struct struct_mhdf_Status mhdf_Status
 Struct used to return error status.
typedef long mhdf_index_t
 Type used when creating index tables.
typedef void * mhdf_FileHandle
 Opaque handle to an open file.

Enumerations

enum  mhdf_TagDataType {
  mhdf_OPAQUE = 0, mhdf_INTEGER, mhdf_FLOAT, mhdf_BITFIELD,
  mhdf_BOOLEAN, mhdf_ENTITY_ID
}
 Enum for tag data type class. More...

Functions

int mhdf_isError (mhdf_Status const *)
 Return 1 if passed status object indicates an error. Zero otherwise.
const char * mhdf_message (mhdf_Status const *)
 Get the error message given a status object.
const char * mhdf_node_type_handle (void)
 Get an mhdf_ElemHandle object for the node data.
const char * mhdf_set_type_handle (void)
 Return a special element group handle used to specify the set group.
mhdf_FileHandle mhdf_createFile (const char *filename, int overwrite, const char **elem_type_list, size_t elem_type_list_len, hid_t id_type, mhdf_Status *status)
 Create a new file.
mhdf_FileHandle mhdf_openFile (const char *filename, int writable, unsigned long *max_id, hid_t id_type, mhdf_Status *status)
 Open an existing file.
mhdf_FileHandle mhdf_openFileWithOpt (const char *filename, int writable, unsigned long *max_id, hid_t id_type, hid_t options, mhdf_Status *status)
 Open an existing file with options.
int mhdf_countOpenHandles (mhdf_FileHandle h)
 Get number of open HDF5 objects from file.
struct mhdf_FileDescmhdf_getFileSummary (mhdf_FileHandle file_handle, hid_t file_id_type, mhdf_Status *status)
 Get summary of data tables contained within file.
void mhdf_fixFileDesc (struct mhdf_FileDesc *copy_ptr, const struct mhdf_FileDesc *orig_addr)
 Fix nested pointers for copied/moved FileDesc struct.
void mhdf_getElemName (mhdf_FileHandle file_handle, unsigned int type_index, char *buffer, size_t buffer_size, mhdf_Status *status)
 Given an element type Id, get the name. Fails if buffer is not of sufficient size.
void mhdf_closeFile (mhdf_FileHandle handle, mhdf_Status *status)
 Close the file.
int mhdf_checkOpenHandles (mhdf_FileHandle handle, mhdf_Status *status)
 Check for open handles in file.
void mhdf_closeData (mhdf_FileHandle file, hid_t handle, mhdf_Status *status)
 Common close function for all data handle types.
void mhdf_getNextStartId (mhdf_FileHandle file, mhdf_index_t *start_id_out, mhdf_Status *status)
 Get start ID that will be assigned to next created dataset.
void mhdf_writeHistory (mhdf_FileHandle file, const char **strings, int num_strings, mhdf_Status *status)
 Write the file history as a list of strings.
char ** mhdf_readHistory (mhdf_FileHandle file, int *num_records_out, mhdf_Status *status)
 Read the file history as a list of strings.
int mhdf_haveNodes (mhdf_FileHandle file_handle, mhdf_Status *status)
hid_t mhdf_createNodeCoords (mhdf_FileHandle file_handle, int dimension, long num_nodes, long *first_node_id_out, mhdf_Status *status)
 Create new table for node coordinate data.
hid_t mhdf_openNodeCoords (mhdf_FileHandle file_handle, long *num_nodes_out, int *dimension_out, long *first_node_id_out, mhdf_Status *status)
 Open table containing node coordinate data.
hid_t mhdf_openNodeCoordsSimple (mhdf_FileHandle file_handle, mhdf_Status *status)
void mhdf_writeNodeCoords (hid_t data_handle, long offset, long count, const double *coords, mhdf_Status *status)
 Write node coordinate data.
void mhdf_writeNodeCoordsWithOpt (hid_t data_handle, long offset, long count, const double *coords, hid_t write_prop, mhdf_Status *status)
void mhdf_writeNodeCoord (hid_t data_handle, long offset, long count, int dimension, const double *coords, mhdf_Status *status)
 Write node coordinate data.
void mhdf_writeNodeCoordWithOpt (hid_t data_handle, long offset, long count, int dimension, const double *coords, hid_t write_prop, mhdf_Status *status)
void mhdf_readNodeCoords (hid_t data_handle, long offset, long count, double *coordinates, mhdf_Status *status)
 Read node coordinate data.
void mhdf_readNodeCoordsWithOpt (hid_t data_handle, long offset, long count, double *coordinates, hid_t read_prop, mhdf_Status *status)
void mhdf_readNodeCoord (hid_t data_handle, long offset, long count, int dimension, double *coords, mhdf_Status *status)
 Read node coordinate data.
void mhdf_readNodeCoordWithOpt (hid_t data_handle, long offset, long count, int dimension, double *coords, hid_t read_prop, mhdf_Status *status)
void mhdf_addElement (mhdf_FileHandle file_handle, const char *elem_handle, unsigned int named_elem_type, mhdf_Status *status)
 Add a new table of element data to the file.
char ** mhdf_getElemHandles (mhdf_FileHandle file_handle, unsigned int *count_out, mhdf_Status *status)
 Get the list of element groups in the file.
void mhdf_getElemTypeName (mhdf_FileHandle file_handle, const char *elem_handle, char *buffer, size_t buf_len, mhdf_Status *status)
 Get the element type name for a given element group handle.
int mhdf_isPolyElement (mhdf_FileHandle file_handle, const char *elem_handle, mhdf_Status *status)
 Check if an element group contains polygon or polyhedron.
hid_t mhdf_createConnectivity (mhdf_FileHandle file_handle, const char *elem_handle, int num_nodes_per_elem, long num_elements, long *first_elem_id_out, mhdf_Status *status)
 Create connectivity table for an element group.
hid_t mhdf_openConnectivity (mhdf_FileHandle file_handle, const char *elem_handle, int *num_nodes_per_elem_out, long *num_elements_out, long *first_elem_id_out, mhdf_Status *status)
 Open connectivity table for an element group.
hid_t mhdf_openConnectivitySimple (mhdf_FileHandle file_handle, const char *elem_handle, mhdf_Status *status)
void mhdf_writeConnectivity (hid_t data_handle, long offset, long count, hid_t hdf_integer_type, const void *node_id_list, mhdf_Status *status)
 Write element coordinate data.
void mhdf_writeConnectivityWithOpt (hid_t data_handle, long offset, long count, hid_t hdf_integer_type, const void *node_id_list, hid_t write_prop, mhdf_Status *status)
void mhdf_readConnectivity (hid_t data_handle, long offset, long count, hid_t hdf_integer_type, void *node_id_list, mhdf_Status *status)
 Read element coordinate data.
void mhdf_readConnectivityWithOpt (hid_t data_handle, long offset, long count, hid_t hdf_integer_type, void *node_id_list, hid_t read_prop, mhdf_Status *status)
void mhdf_createPolyConnectivity (mhdf_FileHandle file_handle, const char *elem_handle, long num_poly, long data_list_length, long *first_id_out, hid_t idx_and_id_handles_out[2], mhdf_Status *status)
 Create a new table for polygon or polyhedron connectivity data.
void mhdf_openPolyConnectivity (mhdf_FileHandle file_handle, const char *elem_handle, long *num_poly_out, long *data_list_length_out, long *first_id_out, hid_t idx_and_id_handles_out[2], mhdf_Status *status)
 Open a table of polygon or polyhedron connectivity data.
void mhdf_writePolyConnIndices (hid_t poly_handle, long offset, long count, hid_t hdf_integer_type, const void *index_list, mhdf_Status *status)
 Write polygon or polyhedron index data.
void mhdf_writePolyConnIndicesWithOpt (hid_t poly_handle, long offset, long count, hid_t hdf_integer_type, const void *index_list, hid_t write_prop, mhdf_Status *status)
void mhdf_writePolyConnIDs (hid_t poly_handle, long offset, long count, hid_t hdf_integer_type, const void *id_list, mhdf_Status *status)
 Write polygon or polyhedron connectivity data.
void mhdf_writePolyConnIDsWithOpt (hid_t poly_handle, long offset, long count, hid_t hdf_integer_type, const void *id_list, hid_t write_prop, mhdf_Status *status)
void mhdf_readPolyConnIndices (hid_t poly_handle, long offset, long count, hid_t hdf_integer_type, void *index_list, mhdf_Status *status)
 Read polygon or polyhedron index data.
void mhdf_readPolyConnIndicesWithOpt (hid_t poly_handle, long offset, long count, hid_t hdf_integer_type, void *index_list, hid_t read_prop, mhdf_Status *status)
void mhdf_readPolyConnIDs (hid_t poly_handle, long offset, long count, hid_t hdf_integer_type, void *id_list, mhdf_Status *status)
 Read polygon or polyhedron connectivity data.
void mhdf_readPolyConnIDsWithOpt (hid_t poly_handle, long offset, long count, hid_t hdf_integer_type, void *id_list, hid_t read_prop, mhdf_Status *status)
hid_t mhdf_createAdjacency (mhdf_FileHandle file_handle, const char *elem_handle, long adj_list_size, mhdf_Status *status)
 Create adjacency data table for nodes, elements, polys, etc.
int mhdf_haveAdjacency (mhdf_FileHandle file, const char *elem_handle, mhdf_Status *status)
 Check if adjacency data is present in the file for the specified element group.
hid_t mhdf_openAdjacency (mhdf_FileHandle file_handle, const char *elem_handle, long *adj_list_size, mhdf_Status *status)
 Open adjacency data table for nodes, elements, polys, etc.
void mhdf_writeAdjacency (hid_t data_handle, long offset, long count, hid_t hdf_integer_type, const void *adj_list_data, mhdf_Status *status)
 Write node/element adjacency data.
void mhdf_writeAdjacencyWithOpt (hid_t data_handle, long offset, long count, hid_t hdf_integer_type, const void *adj_list_data, hid_t write_prop, mhdf_Status *status)
void mhdf_readAdjacency (hid_t data_handle, long offset, long count, hid_t hdf_integer_type, void *adj_list_data_out, mhdf_Status *status)
 Read node/element adjacency data.
void mhdf_readAdjacencyWithOpt (hid_t data_handle, long offset, long count, hid_t hdf_integer_type, void *adj_list_data_out, hid_t read_prop, mhdf_Status *status)
hid_t mhdf_createSetMeta (mhdf_FileHandle file_handle, long num_sets, long *first_set_id_out, mhdf_Status *status)
 Create table holding list of meshsets and their properties.
int mhdf_haveSets (mhdf_FileHandle file, int *have_set_data_out, int *have_set_child_out, int *have_set_parents_out, mhdf_Status *status)
 Check if file contains any sets.
hid_t mhdf_openSetMeta (mhdf_FileHandle file_handle, long *num_sets_out, long *first_set_id_out, mhdf_Status *status)
 Open table holding list of meshsets and their properties.
hid_t mhdf_openSetMetaSimple (mhdf_FileHandle file_handle, mhdf_Status *status)
void mhdf_readSetMeta (hid_t data_handle, long offset, long count, hid_t hdf_integer_type, void *set_desc_data, mhdf_Status *status)
 Read list of sets and meta-information about sets.
void mhdf_readSetMetaWithOpt (hid_t data_handle, long offset, long count, hid_t hdf_integer_type, void *set_desc_data, hid_t read_prop, mhdf_Status *status)
void mhdf_readSetFlags (hid_t data_handle, long offset, long count, hid_t hdf_integer_type, void *set_flag_data, mhdf_Status *status)
 Read only the flags portion of the set description table.
void mhdf_readSetFlagsWithOpt (hid_t data_handle, long offset, long count, hid_t hdf_integer_type, void *set_flag_data, hid_t read_prop, mhdf_Status *status)
void mhdf_readSetContentEndIndices (hid_t data_handle, long offset, long count, hid_t hdf_integer_type, void *end_indices_out, mhdf_Status *status)
 Read only the content end indices portion of the set description table.
void mhdf_readSetContentEndIndicesWithOpt (hid_t data_handle, long offset, long count, hid_t hdf_integer_type, void *end_indices_out, hid_t read_prop, mhdf_Status *status)
void mhdf_readSetChildEndIndices (hid_t data_handle, long offset, long count, hid_t hdf_integer_type, void *end_indices_out, mhdf_Status *status)
 Read only the child end indices portion of the set description table.
void mhdf_readSetChildEndIndicesWithOpt (hid_t data_handle, long offset, long count, hid_t hdf_integer_type, void *end_indices_out, hid_t read_prop, mhdf_Status *status)
void mhdf_readSetParentEndIndices (hid_t data_handle, long offset, long count, hid_t hdf_integer_type, void *end_indices_out, mhdf_Status *status)
 Read only the parent end indices portion of the set description table.
void mhdf_readSetParentEndIndicesWithOpt (hid_t data_handle, long offset, long count, hid_t hdf_integer_type, void *end_indices_out, hid_t read_prop, mhdf_Status *status)
void mhdf_writeSetMeta (hid_t data_handle, long offset, long count, hid_t hdf_integer_type, const void *set_desc_data, mhdf_Status *status)
 Write list of sets and meta-information about sets.
void mhdf_writeSetMetaWithOpt (hid_t data_handle, long offset, long count, hid_t hdf_integer_type, const void *set_desc_data, hid_t write_prop, mhdf_Status *status)
hid_t mhdf_createSetData (mhdf_FileHandle file_handle, long data_list_size, mhdf_Status *status)
 Create file object to hold list of meshset contents.
hid_t mhdf_openSetData (mhdf_FileHandle file_handle, long *data_list_size_out, mhdf_Status *status)
 Open the file object for the meshset contents.
void mhdf_writeSetData (hid_t set_handle, long offset, long count, hid_t hdf_integer_type, const void *set_data, mhdf_Status *status)
 Write set contents.
void mhdf_writeSetDataWithOpt (hid_t set_handle, long offset, long count, hid_t hdf_integer_type, const void *set_data, hid_t write_prop, mhdf_Status *status)
void mhdf_readSetData (hid_t set_handle, long offset, long count, hid_t hdf_integer_type, void *set_data, mhdf_Status *status)
 Read set contents.
void mhdf_readSetDataWithOpt (hid_t set_handle, long offset, long count, hid_t hdf_integer_type, void *set_data, hid_t read_prop, mhdf_Status *status)
hid_t mhdf_createSetChildren (mhdf_FileHandle file_handle, long child_list_size, mhdf_Status *status)
 Create file object for storing the set child list.
hid_t mhdf_openSetChildren (mhdf_FileHandle file_handle, long *child_list_size, mhdf_Status *status)
 Open the file object containing the set child list.
hid_t mhdf_createSetParents (mhdf_FileHandle file_handle, long parent_list_size, mhdf_Status *status)
 Create file object for storing the set parent list.
hid_t mhdf_openSetParents (mhdf_FileHandle file_handle, long *parent_list_size, mhdf_Status *status)
 Open the file object containing the set parent list.
void mhdf_writeSetParentsChildren (hid_t data_handle, long offset, long count, hid_t hdf_integer_type, const void *id_list, mhdf_Status *status)
 Write set parent/child list.
void mhdf_writeSetParentsChildrenWithOpt (hid_t data_handle, long offset, long count, hid_t hdf_integer_type, const void *id_list, hid_t write_prop, mhdf_Status *status)
void mhdf_readSetParentsChildren (hid_t data_handle, long offset, long count, hid_t hdf_integer_type, void *id_list, mhdf_Status *status)
 Read set parent/child list.
void mhdf_readSetParentsChildrenWithOpt (hid_t data_handle, long offset, long count, hid_t hdf_integer_type, void *id_list, hid_t read_prop, mhdf_Status *status)
hid_t mhdf_getNativeType (hid_t input_type, int size, mhdf_Status *status)
 Make type native-endian.
void mhdf_createTag (mhdf_FileHandle file_handle, const char *tag_name, enum mhdf_TagDataType tag_type, int size, int storage, const void *default_value, const void *global_value, hid_t hdf_type, hid_t mhdf_base_type, mhdf_Status *status)
 Add a tag to the file.
hid_t mhdf_getTagDataType (mhdf_FileHandle file_handle, const char *tag_name, mhdf_Status *status)
 Get handle to HDF5 type object for tag data.
void mhdf_createVarLenTag (mhdf_FileHandle file_handle, const char *tag_name, enum mhdf_TagDataType tag_type, int storage, const void *default_value, int default_value_length, const void *global_value, int global_value_length, hid_t hdf_type, hid_t hdf_base_type, mhdf_Status *status)
 Add variable-length tag to file.
int mhdf_getNumberTags (mhdf_FileHandle file_handle, mhdf_Status *status)
 Get the number of tags in the file.
char ** mhdf_getTagNames (mhdf_FileHandle file_handle, int *num_names_out, mhdf_Status *status)
 Get the name for each tag defined in the file.
void mhdf_getTagInfo (mhdf_FileHandle file_handle, const char *tag_name, enum mhdf_TagDataType *class_out, int *size_out, int *tstt_storage_out, int *have_default_out, int *have_global_out, int *have_sparse_out, mhdf_Status *status)
 Get the description of a specified tag.
void mhdf_getTagValues (mhdf_FileHandle file_handle, const char *tag_name, hid_t output_data_type, void *default_value, void *global_value, mhdf_Status *status)
 Get the default and global values of the tag.
int mhdf_haveDenseTag (mhdf_FileHandle file_handle, const char *tag_name, const char *elem_group, mhdf_Status *status)
 Check if the file contains dense tag data for the specified tag and element group.
hid_t mhdf_createDenseTagData (mhdf_FileHandle file_handle, const char *tag_name, const char *elem_group, long num_values, mhdf_Status *status)
 Create an object to hold dense tag values for a given element group.
hid_t mhdf_openDenseTagData (mhdf_FileHandle file_handle, const char *tag_name, const char *elem_group, long *num_values_out, mhdf_Status *status)
 Open the object containing dense tag values for a given element group.
void mhdf_createSparseTagData (mhdf_FileHandle file_handle, const char *tag_name, long num_values, hid_t entities_and_values_out[2], mhdf_Status *status)
 Create file objects to store sparse tag data.
void mhdf_createVarLenTagData (mhdf_FileHandle file_handle, const char *tag_name, long num_entities, long num_values, hid_t entities_and_values_out[3], mhdf_Status *status)
 Create file objects to store (sparse) variable-length tag data.
void mhdf_openSparseTagData (mhdf_FileHandle file_handle, const char *tag_name, long *num_entity_out, long *num_values_out, hid_t entities_and_values_out[3], mhdf_Status *status)
 Create file objects to read sparse tag data.
void mhdf_writeSparseTagEntities (hid_t id_handle, long offset, long count, hid_t hdf_integer_type, const void *id_list, mhdf_Status *status)
 Write Global ID list for sparse tag data.
void mhdf_writeSparseTagEntitiesWithOpt (hid_t id_handle, long offset, long count, hid_t hdf_integer_type, const void *id_list, hid_t write_prop, mhdf_Status *status)
void mhdf_writeTagValues (hid_t value_handle, long offset, long count, hid_t hdf_tag_data_type, const void *tag_data, mhdf_Status *status)
 Write tag values.
void mhdf_writeTagValuesWithOpt (hid_t value_handle, long offset, long count, hid_t hdf_tag_data_type, const void *tag_data, hid_t write_prop, mhdf_Status *status)
void mhdf_writeSparseTagIndices (hid_t tag_handle, long offset, long count, hid_t hdf_integer_type, const void *end_indices, mhdf_Status *status)
 Write sparse tag end indices for variable-length tag data.
void mhdf_writeSparseTagIndicesWithOpt (hid_t tag_handle, long offset, long count, hid_t hdf_integer_type, const void *end_indices, hid_t write_prop, mhdf_Status *status)
void mhdf_readSparseTagEntities (hid_t id_handle, long offset, long count, hid_t hdf_integer_type, void *id_list, mhdf_Status *status)
 Read Global ID list for sparse tag data.
void mhdf_readSparseTagEntitiesWithOpt (hid_t id_handle, long offset, long count, hid_t hdf_integer_type, void *id_list, hid_t read_prop, mhdf_Status *status)
void mhdf_readTagValues (hid_t value_handle, long offset, long count, hid_t hdf_type, void *memory, mhdf_Status *status)
 Read tag values.
void mhdf_readTagValuesWithOpt (hid_t value_handle, long offset, long count, hid_t hdf_type, void *memory, hid_t read_prop, mhdf_Status *status)
void mhdf_readSparseTagIndices (hid_t tag_handle, long offset, long count, hid_t hdf_integer_type, void *end_indices, mhdf_Status *status)
 Read sparse tag end indices for variable-length tag data.
void mhdf_readSparseTagIndicesWithOpt (hid_t tag_handle, long offset, long count, hid_t hdf_integer_type, void *end_indices, hid_t read_prop, mhdf_Status *status)
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines