1d70abbfaSBarry Smith 26524c165SJacob Faibussowitsch #ifndef PETSCVIEWERHDF5_H 326bd1501SBarry Smith #define PETSCVIEWERHDF5_H 4d70abbfaSBarry Smith 5d70abbfaSBarry Smith #include <petscviewer.h> 6d70abbfaSBarry Smith 72c1a2d08SJed Brown #if defined(PETSC_HAVE_HDF5) 8d70abbfaSBarry Smith #include <hdf5.h> 9ee8b9732SVaclav Hapla #if !defined(H5_VERSION_GE) 10ee8b9732SVaclav Hapla /* H5_VERSION_GE was introduced in HDF5 1.8.7, we support >= 1.8.0 */ 11ee8b9732SVaclav Hapla /* So beware this will automatically 0 for HDF5 1.8.0 - 1.8.6 */ 12ee8b9732SVaclav Hapla #define H5_VERSION_GE(a, b, c) 0 13ee8b9732SVaclav Hapla #endif 14ee8b9732SVaclav Hapla 15d70abbfaSBarry Smith PETSC_EXTERN PetscErrorCode PetscViewerHDF5GetFileId(PetscViewer, hid_t *); 16d70abbfaSBarry Smith 17d70abbfaSBarry Smith /* On 32 bit systems HDF5 is limited by size of integer, because hsize_t is defined as size_t */ 1884ccb19eSJed Brown #define PETSC_HDF5_INT_MAX (~(hsize_t)0) 19d70abbfaSBarry Smith 2087de8cd9SSajid Ali /* As per https://portal.hdfgroup.org/display/HDF5/Chunking+in+HDF5, max. chunk size is 4GB */ 2187de8cd9SSajid Ali #define PETSC_HDF5_MAX_CHUNKSIZE 2147483647 2287de8cd9SSajid Ali 23d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode PetscViewerHDF5PathIsRelative(const char path[], PetscBool emptyIsRelative, PetscBool *has) 24d71ae5a4SJacob Faibussowitsch { 254302210dSVaclav Hapla size_t len; 264302210dSVaclav Hapla 274302210dSVaclav Hapla PetscFunctionBegin; 284302210dSVaclav Hapla *has = emptyIsRelative; 299566063dSJacob Faibussowitsch PetscCall(PetscStrlen(path, &len)); 305f80ce2aSJacob Faibussowitsch if (len) *has = (PetscBool)(path[0] != '/'); 31*3ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 324302210dSVaclav Hapla } 334302210dSVaclav Hapla 34d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode PetscHDF5IntCast(PetscInt a, hsize_t *b) 35d71ae5a4SJacob Faibussowitsch { 36d70abbfaSBarry Smith PetscFunctionBegin; 372c71b3e2SJacob Faibussowitsch PetscCheck(a >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Cannot convert negative size"); 3884ccb19eSJed Brown #if defined(PETSC_USE_64BIT_INDICES) && (H5_SIZEOF_HSIZE_T == 4) 392c71b3e2SJacob Faibussowitsch PetscCheck(a >= PETSC_HDF5_INT_MAX, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Array too long for HDF5"); 40d70abbfaSBarry Smith #endif 41d70abbfaSBarry Smith *b = (hsize_t)(a); 42*3ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 43d70abbfaSBarry Smith } 4436bce6e8SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscDataTypeToHDF5DataType(PetscDataType, hid_t *); 4536bce6e8SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscHDF5DataTypeToPetscDataType(hid_t, PetscDataType *); 462c1a2d08SJed Brown 4789e0ef10SVaclav Hapla PETSC_EXTERN PetscErrorCode PetscViewerHDF5HasDataset(PetscViewer, const char[], PetscBool *); 48ecce1506SVaclav Hapla PETSC_EXTERN PetscErrorCode PetscViewerHDF5HasObject(PetscViewer, PetscObject, PetscBool *); 49d70ec8faSVaclav Hapla PETSC_EXTERN PetscErrorCode PetscViewerHDF5ReadAttribute(PetscViewer, const char[], const char[], PetscDataType, const void *, void *); 5036bce6e8SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscViewerHDF5WriteAttribute(PetscViewer, const char[], const char[], PetscDataType, const void *); 51e7bdbf8eSMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscViewerHDF5HasAttribute(PetscViewer, const char[], const char[], PetscBool *); 52a2d6be1bSVaclav Hapla PETSC_EXTERN PetscErrorCode PetscViewerHDF5ReadObjectAttribute(PetscViewer, PetscObject, const char[], PetscDataType, void *, void *); 53577e0e04SVaclav Hapla PETSC_EXTERN PetscErrorCode PetscViewerHDF5WriteObjectAttribute(PetscViewer, PetscObject, const char[], PetscDataType, const void *); 54577e0e04SVaclav Hapla PETSC_EXTERN PetscErrorCode PetscViewerHDF5HasObjectAttribute(PetscViewer, PetscObject, const char[], PetscBool *); 55d70abbfaSBarry Smith 56d70abbfaSBarry Smith PETSC_EXTERN PetscErrorCode PetscViewerHDF5Open(MPI_Comm, const char[], PetscFileMode, PetscViewer *); 57be7aa430SVaclav Hapla PETSC_EXTERN PetscErrorCode PetscViewerHDF5PushGroup(PetscViewer, const char[]); 58d70abbfaSBarry Smith PETSC_EXTERN PetscErrorCode PetscViewerHDF5PopGroup(PetscViewer); 5977717648SVaclav Hapla PETSC_EXTERN PetscErrorCode PetscViewerHDF5GetGroup(PetscViewer, const char[], char *[]); 60535716cbSVaclav Hapla PETSC_EXTERN PetscErrorCode PetscViewerHDF5HasGroup(PetscViewer, const char[], PetscBool *); 613014b61aSVaclav Hapla PETSC_EXTERN PetscErrorCode PetscViewerHDF5OpenGroup(PetscViewer, const char[], hid_t *, hid_t *); 6263cb69f5SVaclav Hapla PETSC_EXTERN PetscErrorCode PetscViewerHDF5WriteGroup(PetscViewer, const char[]); 63d7dd068bSVaclav Hapla 6419a20e4cSMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscViewerHDF5SetDefaultTimestepping(PetscViewer, PetscBool); 6519a20e4cSMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscViewerHDF5GetDefaultTimestepping(PetscViewer, PetscBool *); 66d7dd068bSVaclav Hapla PETSC_EXTERN PetscErrorCode PetscViewerHDF5PushTimestepping(PetscViewer); 67d7dd068bSVaclav Hapla PETSC_EXTERN PetscErrorCode PetscViewerHDF5PopTimestepping(PetscViewer); 68d7dd068bSVaclav Hapla PETSC_EXTERN PetscErrorCode PetscViewerHDF5IsTimestepping(PetscViewer, PetscBool *); 69d70abbfaSBarry Smith PETSC_EXTERN PetscErrorCode PetscViewerHDF5IncrementTimestep(PetscViewer); 70d70abbfaSBarry Smith PETSC_EXTERN PetscErrorCode PetscViewerHDF5SetTimestep(PetscViewer, PetscInt); 71d70abbfaSBarry Smith PETSC_EXTERN PetscErrorCode PetscViewerHDF5GetTimestep(PetscViewer, PetscInt *); 72d70abbfaSBarry Smith 7382ea9b62SBarry Smith PETSC_EXTERN PetscErrorCode PetscViewerHDF5SetBaseDimension2(PetscViewer, PetscBool); 7482ea9b62SBarry Smith PETSC_EXTERN PetscErrorCode PetscViewerHDF5GetBaseDimension2(PetscViewer, PetscBool *); 7582ea9b62SBarry Smith 769a0502c6SHåkon Strandenes PETSC_EXTERN PetscErrorCode PetscViewerHDF5SetSPOutput(PetscViewer, PetscBool); 779a0502c6SHåkon Strandenes PETSC_EXTERN PetscErrorCode PetscViewerHDF5GetSPOutput(PetscViewer, PetscBool *); 78ee8b9732SVaclav Hapla 79ee8b9732SVaclav Hapla PETSC_EXTERN PetscErrorCode PetscViewerHDF5SetCollective(PetscViewer, PetscBool); 80ee8b9732SVaclav Hapla PETSC_EXTERN PetscErrorCode PetscViewerHDF5GetCollective(PetscViewer, PetscBool *); 817847244bSVaclav Hapla #endif /* defined(PETSC_HAVE_HDF5) */ 82d70abbfaSBarry Smith #endif 83