#
libsff

Home | Modules | Examples

# /home/pinky2/mattijs/OpenFOAM/OpenFOAM-1.0/applications/utilities/mesh/conversion/ccm24ToFoam/libccmio/libccmio/ccmio.h File Reference

Go to the source code of this file.

## Basic functions

CCMIOError | CCMIOOpenFile (CCMIOError *err, const char *file, CCMIOIOType mode, CCMIOID *root)
| Opens an CCMIO file.
CCMIOError | CCMIOCloseFile (CCMIOError *err, CCMIOID root)
| Opens an CCMIO file.
CCMIOError | CCMIOGetVersion (CCMIOError *err, CCMIONode root, int *version)
| Returns the version number of the file.
CCMIOError | CCMIOSetVersion (CCMIOError *err, CCMIONode root, int version)
| Sets the version number of the file.
CCMIOError | CCMIOGetTitle (CCMIOError *err, CCMIONode root, char **title)
| Returns the title of the file.
CCMIOError | CCMIOSetTitle (CCMIOError *err, CCMIONode root, const char *title)
| Sets the title of the file.

## Functions for Optional Nodes

CCMIOError | CCMIOWriteOpti (CCMIOError *err, CCMIOID parent, const char *name, int value)
| Creates a child node of parent with given name and scalar value.
CCMIOError | CCMIOWriteOptf (CCMIOError *err, CCMIOID parent, const char *name, float value)
| Creates a child node of parent with given name and scalar value.
CCMIOError | CCMIOWriteOptd (CCMIOError *err, CCMIOID parent, const char *name, double value)
| Creates a child node of parent with given name and scalar value.
CCMIOError | CCMIOWriteOptstr (CCMIOError *err, CCMIOID parent, const char *name, const char *value)
| Creates a child node of parent with given name and string value.
CCMIOError | CCMIOReadOpti (CCMIOError *err, CCMIOID parent, const char *name, int *value)
| Creates a child node of parent with given name and scalar value.
CCMIOError | CCMIOReadOptf (CCMIOError *err, CCMIOID parent, const char *name, float *value)
| Creates a child node of parent with given name and scalar value.
CCMIOError | CCMIOReadOptd (CCMIOError *err, CCMIOID parent, const char *name, double *value)
| Creates a child node of parent with given name and scalar value.
CCMIOError | CCMIOReadOptstr (CCMIOError *err, CCMIOID parent, const char *name, int *size, char *value)
| Creates a child node of parent with given name and scalar value.
CCMIOError | CCMIOReadOpt1i (CCMIOError *err, CCMIOID parent, const char *name, int *data, unsigned int start, unsigned int end)
| Reads a one-dimensional array from the child node of 'parent' with name 'name' into 'data'.
CCMIOError | CCMIOReadOpt1f (CCMIOError *err, CCMIOID parent, const char *name, float *data, unsigned int start, unsigned int end)
| Reads a one-dimensional array from the child node of 'parent' with name 'name' into 'data'.
CCMIOError | CCMIOReadOpt1d (CCMIOError *err, CCMIOID parent, const char *name, double *data, unsigned int start, unsigned int end)
| Reads a one-dimensional array from the child node of 'parent' with name 'name' into 'data'.
CCMIOError | CCMIOReadOpt2i (CCMIOError *err, CCMIOID parent, const char *name, int *data, unsigned int start, unsigned int end)
| Reads a two-dimensional array from the child node of 'parent' with name 'name' into 'data'.
CCMIOError | CCMIOReadOpt2f (CCMIOError *err, CCMIOID parent, const char *name, float *data, unsigned int start, unsigned int end)
| Reads a two-dimensional array from the child node of 'parent' with name 'name' into 'data'.
CCMIOError | CCMIOReadOpt2d (CCMIOError *err, CCMIOID parent, const char *name, double *data, unsigned int start, unsigned int end)
| Reads a two-dimensional array from the child node of 'parent' with name 'name' into 'data'.
CCMIOError | CCMIOReadOpt3i (CCMIOError *err, CCMIOID parent, const char *name, int *data, unsigned int start, unsigned int end)
| Reads a three-dimensional array from the child node of 'parent' with name 'name' into 'data'.
CCMIOError | CCMIOReadOpt3f (CCMIOError *err, CCMIOID parent, const char *name, float *data, unsigned int start, unsigned int end)
| Reads a three-dimensional array from the child node of 'parent' with name 'name' into 'data'.
CCMIOError | CCMIOReadOpt3d (CCMIOError *err, CCMIOID parent, const char *name, double *data, unsigned int start, unsigned int end)
| Reads a three-dimensional array from the child node of 'parent' with name 'name' into 'data'.
CCMIOError | CCMIOWriteOpt1i (CCMIOError *err, CCMIOID parent, const char *name, int n, const int *data, unsigned int start, unsigned int end)
| Writes a one-dimensional array to a child node of 'parent' with name 'name'.
CCMIOError | CCMIOWriteOpt1f (CCMIOError *err, CCMIOID parent, const char *name, int n, const float *data, unsigned int start, unsigned int end)
| Writes a one-dimensional array to a child node of 'parent' with name 'name'.
CCMIOError | CCMIOWriteOpt1d (CCMIOError *err, CCMIOID parent, const char *name, int n, const double *data, unsigned int start, unsigned int end)
| Writes a one-dimensional array to a child node of 'parent' with name 'name'.
CCMIOError | CCMIOWriteOpt2i (CCMIOError *err, CCMIOID parent, const char *name, int x, int y, const int *data, unsigned int start, unsigned int end)
| Writes a two-dimensional array to a child node of 'parent' with name 'name'.
CCMIOError | CCMIOWriteOpt2f (CCMIOError *err, CCMIOID parent, const char *name, int x, int y, const float *data, unsigned int start, unsigned int end)
| Writes a two-dimensional array to a child node of 'parent' with name 'name'.
CCMIOError | CCMIOWriteOpt2d (CCMIOError *err, CCMIOID parent, const char *name, int x, int y, const double *data, unsigned int start, unsigned int end)
| Writes a two-dimensional array to a child node of 'parent' with name 'name'.
CCMIOError | CCMIOWriteOpt3i (CCMIOError *err, CCMIOID parent, const char *name, int x, int y, int z, const int *data, unsigned int start, unsigned int end)
| Writes a three-dimensional array to a child node of 'parent' with name 'name'.
CCMIOError | CCMIOWriteOpt3f (CCMIOError *err, CCMIOID parent, const char *name, int x, int y, int z, const float *data, unsigned int start, unsigned int end)
| Writes a three-dimensional array to a child node of 'parent' with name 'name'.
CCMIOError | CCMIOWriteOpt3d (CCMIOError *err, CCMIOID parent, const char *name, int x, int y, int z, const double *data, unsigned int start, unsigned int end)
| Writes a three-dimensional array to a child node of 'parent' with name 'name'.
CCMIOError | CCMIOGetOptInfo (CCMIOError *err, CCMIOID parent, const char *name, CCMIODataType *type, unsigned int *x, unsigned int *y, unsigned int *z)
| Returns information about the optional node.

## Intermediate API

int | CCMIOIsValidEntity (CCMIOID entity)
| Returns TRUE if the entity is valid, FALSE otherwise.
int | CCMIOIsFromSameFile (CCMIOID entity1, CCMIOID entity2)
| Returns TRUE if the two entities are from the same file, FALSE otherwise.
CCMIOError | CCMIONewEntity (CCMIOError *err, CCMIOID parent, CCMIOEntity type, const char *description, CCMIOID *id)
| Creates a new entity.
CCMIOError | CCMIOGetEntity (CCMIOError *err, CCMIOID parent, CCMIOEntity type, int idVal, CCMIOID *id)
| Retrieves an entity.
CCMIOError | CCMIONewIndexedEntity (CCMIOError *err, CCMIOID parent, CCMIOEntity which, int idVal, const char *description, CCMIOID *id)
| Creates a new entity identified by an index number.
CCMIOError | CCMIOGetEntityIndex (CCMIOError *err, CCMIOID id, int *n)
| Returns the index (i.e.
CCMIOError | CCMIONewState (CCMIOError *err, CCMIOID root, const char *name, CCMIOID *problemDescription, const char *description, CCMIOID *state)
| Creates a new state.
CCMIOError | CCMIOGetState (CCMIOError *err, CCMIOID root, const char *name, CCMIOID *problemDescription, CCMIOID *state)
| Returns TRUE if the entity is valid, FALSE otherwise.
CCMIOError | CCMIOWriteState (CCMIOError *err, CCMIOID state, CCMIOID problemDescription, const char *description)
| Writes the problem description node to the state.
CCMIOError | CCMIONewField (CCMIOError *err, CCMIOID phase, const char *name, const char *shortName, CCMIODimensionality dim, CCMIOID *field)
| Returns TRUE if the entity is valid, FALSE otherwise.
CCMIOError | CCMIOGetField (CCMIOError *err, CCMIOID phase, const char *name, CCMIODimensionality *dim, CCMIOID *field)
| Retrieves a field entity.
CCMIOError | CCMIOReadField (CCMIOError *err, CCMIOID field, char *name, char *shortName, CCMIODimensionality *dim, CCMIODataType *datatype)
| Reads information about a field.
CCMIOError | CCMIODeleteEntity (CCMIOError *err, CCMIOID id)
| Deletes the entity and all of its children.
CCMIOError | CCMIONextEntity (CCMIOError *err, CCMIOID parent, CCMIOEntity type, int *i, CCMIOID *next)
| Returns TRUE if the entity is valid, FALSE otherwise.
CCMIOError | CCMIOEntitySize (CCMIOError *err, CCMIOID id, unsigned int *n, unsigned int *max)
| Returns the number of elements and the maximum element ID in the specified entity.
CCMIOError | CCMIOEntityName (CCMIOError *err, CCMIOID id, char *name)
| Gets the name of the entity.
CCMIOError | CCMIOEntityLabel (CCMIOError *err, CCMIOID id, unsigned int *size, char *label)
| Gets the label of the entity.
CCMIOError | CCMIOEntityDescription (CCMIOError *err, CCMIOID id, unsigned int *size, char *desc)
| Gets the description (if any) of the specified entity.
CCMIOError | CCMIOGetEntityNode (CCMIOError *err, CCMIOID id, CCMIONode *node)
| Returns the CCMIO node corresponding to this entity.
CCMIOError | CCMIOEntityDataType (CCMIOError *err, CCMIOID id, CCMIODataType *type)
| Returns the data type of the main data of the entity.
CCMIOError | CCMIOWriteMap (CCMIOError *err, CCMIOID id, unsigned int n, unsigned int max, int *data, unsigned int start, unsigned int end)
| Writes the map data.
CCMIOError | CCMIOReadMap (CCMIOError *err, CCMIOID id, int *data, unsigned int start, unsigned int end)
| Reads the map data.
CCMIOError | CCMIOReadVerticesf (CCMIOError *err, CCMIOID id, int *dims, float *scale, CCMIOID *mapID, float *vertices, unsigned int start, unsigned int end)
| Reads the vertex data.
CCMIOError | CCMIOReadVerticesd (CCMIOError *err, CCMIOID id, int *dims, float *scale, CCMIOID *mapID, double *vertices, unsigned int start, unsigned int end)
| Reads the vertex data.
CCMIOError | CCMIOWriteVerticesf (CCMIOError *err, CCMIOID id, int dims, float scale, CCMIOID mapID, const float *vertices, unsigned int start, unsigned int end)
| Writes the vertex data.
CCMIOError | CCMIOWriteVerticesd (CCMIOError *err, CCMIOID id, int dims, float scale, CCMIOID mapID, const double *vertices, unsigned int start, unsigned int end)
| Writes the vertex data.
CCMIOError | CCMIOReadCells (CCMIOError *err, CCMIOID id, CCMIOID *mapID, int *cellTypes, unsigned int start, unsigned int end)
| Reads the cell data.
CCMIOError | CCMIOWriteCells (CCMIOError *err, CCMIOID id, CCMIOID mapID, int *cellTypes, unsigned int start, unsigned int end)
| Writes the cell data.
CCMIOError | CCMIOReadFaces (CCMIOError *err, CCMIOID entity, CCMIOEntity which, CCMIOID *mapID, unsigned int *streamSize, int *vertexStream, unsigned int start, unsigned int end)
| Reads the face data.
CCMIOError | CCMIOWriteFaces (CCMIOError *err, CCMIOID entity, CCMIOEntity which, CCMIOID mapID, unsigned int streamSize, int *vertexStream, unsigned int start, unsigned int end)
| Writes the face data.
CCMIOError | CCMIOReadFaceCells (CCMIOError *err, CCMIOID entity, CCMIOEntity which, int *cells, unsigned int start, unsigned int end)
| Reads the faces' cell associations with the faces.
CCMIOError | CCMIOWriteFaceCells (CCMIOError *err, CCMIOID entity, CCMIOEntity which, CCMIOID mapID, int *cells, unsigned int start, unsigned int end)
| Writes the face data.
CCMIOError | CCMIOWriteProcessor (CCMIOError *err, CCMIOID processor, const char *verticesFile, CCMIOID *vertices, const char *topologyFile, CCMIOID *topology, const char *initialFieldFile, CCMIOID *initialField, const char *solutionFile, CCMIOID *solution)
| Writes the processor information.
CCMIOError | CCMIOReadProcessor (CCMIOError *err, CCMIOID processor, CCMIOID *vertices, CCMIOID *topology, CCMIOID *initialField, CCMIOID *solution)
| Reads the processor information.
CCMIOError | CCMIOClearProcessor (CCMIOError *err, CCMIOID state, CCMIOID processor, int clearVertices, int clearTopology, int clearInitialField, int clearSolution, int clearLagrangian)
| Clears the relevant information from the processor.
CCMIOError | CCMIOWriteLagrangianData (CCMIOError *err, CCMIOID lagrangian, const char *positionsFile, CCMIOID *positions, const char *solutionFile, CCMIOID *solution)
| Writes Lagrangian data.
CCMIOError | CCMIOReadLagrangianData (CCMIOError *err, CCMIOID lagrangian, CCMIOID *positions, CCMIOID *solution)
| Reads the Langrangian information.
CCMIOError | CCMIOWriteMultiDimensionalFieldData (CCMIOError *err, CCMIOID fieldID, CCMIOComponent component, CCMIOID componentField)
| Writes one component of a vector or tensor data field.
CCMIOError | CCMIOReadMultiDimensionalFieldData (CCMIOError *err, CCMIOID fieldID, CCMIOComponent component, CCMIOID *componentField)
| Gets the field ID of one component of a vector or tensor data field.
CCMIOError | CCMIOWriteFieldDataf (CCMIOError *err, CCMIOID fieldData, CCMIOID mapID, CCMIODataLocation loc, float *data, unsigned int start, unsigned int end)
| Writes scalar data for a field.
CCMIOError | CCMIOWriteFieldDatad (CCMIOError *err, CCMIOID fieldData, CCMIOID mapID, CCMIODataLocation loc, double *data, unsigned int start, unsigned int end)
| Writes the data for a field.
CCMIOError | CCMIOWriteFieldDatai (CCMIOError *err, CCMIOID fieldData, CCMIOID mapID, CCMIODataLocation loc, int *data, unsigned int start, unsigned int end)
| Writes the data for a field.
CCMIOError | CCMIOWriteConstantFieldDataf (CCMIOError *err, CCMIOID fieldData, CCMIOID mapID, CCMIODataLocation loc, float value)
| Writes data for a field that is constant.
CCMIOError | CCMIOWriteConstantFieldDatad (CCMIOError *err, CCMIOID fieldData, CCMIOID mapID, CCMIODataLocation loc, double value)
| Writes data for a field that is constant.
CCMIOError | CCMIOWriteConstantFieldDatai (CCMIOError *err, CCMIOID fieldData, CCMIOID mapID, CCMIODataLocation loc, int value)
| Writes data for a field that is constant.
CCMIOError | CCMIOReadFieldDataf (CCMIOError *err, CCMIOID fieldData, CCMIOID *mapID, CCMIODataLocation *loc, float *data, unsigned int start, unsigned int end)
| Reads scalar data from a field.
CCMIOError | CCMIOReadFieldDatad (CCMIOError *err, CCMIOID fieldData, CCMIOID *mapID, CCMIODataLocation *loc, double *data, unsigned int start, unsigned int end)
| Reads the data from a field.
CCMIOError | CCMIOReadFieldDatai (CCMIOError *err, CCMIOID fieldData, CCMIOID *mapID, CCMIODataLocation *loc, int *data, unsigned int start, unsigned int end)
| Reads the data from a field.
CCMIOError | CCMIOWriteRestartInfo (CCMIOError *err, CCMIOID restartInfo, const char *solverName, int iteration, float time, const char *timeUnits, float startAngle)
| Writes the solver restart entity.
CCMIOError | CCMIOReadRestartInfo (CCMIOError *err, CCMIOID restartInfo, char *solverName, int *iteration, float *time, char *timeUnits, float *startAngle)
| Reads the solver restart entity.