BMI_interface_C.h

Go to the documentation of this file.

#ifdef SKIP
#if !defined(BMI_INTERFACE_C_H_INCLUDED)
#define BMI_INTERFACE_C_H_INCLUDED
#include "IrmResult.h"
#include "irm_dll_export.h"
 
#if defined(__cplusplus)
extern "C" {
#endif  
    IRM_DLL_EXPORT IRM_RESULT BMI_AddOutputVars(int id, char* option, char* def);
    IRM_DLL_EXPORT int        BMI_Create(int nxyz, int nthreads);
    //IRM_DLL_EXPORT int        BMI_Create_default();
    IRM_DLL_EXPORT IRM_RESULT BMI_Destroy(int id);
    IRM_DLL_EXPORT IRM_RESULT BMI_Finalize(int id);
    IRM_DLL_EXPORT IRM_RESULT BMI_GetComponentName(int id, char* component_name, int l);
    IRM_DLL_EXPORT double     BMI_GetCurrentTime(int id);
    IRM_DLL_EXPORT double     BMI_GetEndTime(int id);
    IRM_DLL_EXPORT int        BMI_GetGridRank(int id, int grid);
    IRM_DLL_EXPORT int        BMI_GetGridSize(int id, int grid);
    IRM_DLL_EXPORT IRM_RESULT BMI_GetGridType(int id, int grid, char* str, int l);
    IRM_DLL_EXPORT int        BMI_GetInputItemCount(int id);
    //IRM_DLL_EXPORT int        BMI_GetInputVarNamesSize(int id);
    IRM_DLL_EXPORT IRM_RESULT BMI_GetInputVarName(int id, int i, char* name, int l);
    //IRM_DLL_EXPORT int        BMI_GetNames(int id, const char* type, char* dest);
    //IRM_DLL_EXPORT int        BMI_GetNamesSize(int id, const char* type, int* dest);
    IRM_DLL_EXPORT int        BMI_GetOutputItemCount(int id);
    //IRM_DLL_EXPORT int        BMI_GetOutputVarNamesSize(int id);
    IRM_DLL_EXPORT IRM_RESULT BMI_GetOutputVarName(int id, int i, char* name, int l);
    IRM_DLL_EXPORT int        BMI_GetPointableItemCount(int id);
    //IRM_DLL_EXPORT int        BMI_GetPointableVarNamesSize(int id);
    IRM_DLL_EXPORT IRM_RESULT BMI_GetPointableVarName(int id, int i, char* name, int l);
    IRM_DLL_EXPORT double     BMI_GetStartTime(int id);
    IRM_DLL_EXPORT double     BMI_GetTime(int id);
    IRM_DLL_EXPORT double     BMI_GetTimeStep(int id);
    IRM_DLL_EXPORT IRM_RESULT BMI_GetTimeUnits(int id, char* units, int l);
    // GetValue
    IRM_DLL_EXPORT IRM_RESULT BMI_GetValueInt(int id, char* var, int* dest);
    IRM_DLL_EXPORT IRM_RESULT BMI_GetValueDouble(int id, char* var, double* dest);
    IRM_DLL_EXPORT IRM_RESULT BMI_GetValueChar(int id, char* var, char* dest, int l);
    // GetValuePtr
    //IRM_DLL_EXPORT IRM_RESULT BMI_GetValuePtrInt(int id, char* var, int** dest);
    //IRM_DLL_EXPORT IRM_RESULT BMI_GetValuePtrDouble(int id, char* var, double** dest);
    //IRM_DLL_EXPORT IRM_RESULT BMI_GetValuePtrChar(int id, char* var, char** dest);
    IRM_DLL_EXPORT void* BMI_GetValuePtr(int id, char* var);
    IRM_DLL_EXPORT int        BMI_GetVarGrid(int id, char* var);
    IRM_DLL_EXPORT int        BMI_GetVarItemsize(int id, char* name);
    IRM_DLL_EXPORT int        BMI_GetVarNbytes(int id, char* name);
    IRM_DLL_EXPORT IRM_RESULT BMI_GetVarType(int id, char* name, char* vtype, int l);
    IRM_DLL_EXPORT IRM_RESULT BMI_GetVarUnits(int id, char* name, char* units, int l);
    IRM_DLL_EXPORT IRM_RESULT BMI_Initialize(int id, char* config_file);
    //
    // SetValue methods
    //
    IRM_DLL_EXPORT IRM_RESULT BMI_SetValueChar(int id, char* name, const char* src);
    IRM_DLL_EXPORT IRM_RESULT BMI_SetValueDouble(int id, char* name, double src);
    IRM_DLL_EXPORT IRM_RESULT BMI_SetValueDoubleArray(int id, char* name, double* src);
    IRM_DLL_EXPORT IRM_RESULT BMI_SetValueInt(int id, char* name, int src);
#ifdef SKIP
    IRM_DLL_EXPORT IRM_RESULT BMI_SetValueIntArray(int id, char* name, int* src);
#endif
    IRM_DLL_EXPORT IRM_RESULT BMI_Update(int id);
    IRM_DLL_EXPORT IRM_RESULT BMI_UpdateUntil(int id, double end_time);
    IRM_DLL_EXPORT void BMI_GetValueAtIndices(int id, char* name, void* dest, int* inds, int count);
    IRM_DLL_EXPORT void BMI_SetValueAtIndices(int id, char* name, int* inds, int count, void* src);
    IRM_DLL_EXPORT void BMI_GetGridShape(int id, const int grid, int* shape);
    IRM_DLL_EXPORT void BMI_GetGridSpacing(int id, const int grid, double* spacing);
    IRM_DLL_EXPORT void BMI_GetGridOrigin(int id, const int grid, double* origin);
    IRM_DLL_EXPORT void BMI_GetGridX(int id, const int grid, double* x);
    IRM_DLL_EXPORT void BMI_GetGridY(int id, const int grid, double* y);
    IRM_DLL_EXPORT void BMI_GetGridZ(int id, const int grid, double* z);
    IRM_DLL_EXPORT int BMI_GetGridNodeCount(int id, const int grid);
    IRM_DLL_EXPORT int BMI_GetGridEdgeCount(int id, const int grid);
    IRM_DLL_EXPORT int BMI_GetGridFaceCount(int id, const int grid);
    IRM_DLL_EXPORT void BMI_GetGridEdgeNodes(int id, const int grid, int* edge_nodes);
    IRM_DLL_EXPORT void BMI_GetGridFaceEdges(int id, const int grid, int* face_edges);
    IRM_DLL_EXPORT void BMI_GetGridFaceNodes(int id, const int grid, int* face_nodes);
    IRM_DLL_EXPORT void BMI_GetGridNodesPerFace(int id, const int grid, int* nodes_per_face);
#endif // SKIP
#if defined(__cplusplus)
}
 
#endif // BMI_INTERFACE_C_H_INCLUDED
 
#endif // SKIP