1: #pragma once

  3: #include <petscviewer.h>

  5: /* MANSEC = Viewer */

  7: #if defined(PETSC_HAVE_HDF5)
  8:   #include <hdf5.h>
  9:   #if !defined(H5_VERSION_GE)
 10:     /* H5_VERSION_GE was introduced in HDF5 1.8.7, we support >= 1.8.0 */
 11:     /* So beware this will automatically 0 for HDF5 1.8.0 - 1.8.6 */
 12:     #define H5_VERSION_GE(a, b, c) 0
 13:   #endif

 15:   // HDF5 1.13.0 switched from hsize_t being typedef'd to unsigned long long to being uint64_t and introduced the
 16:   // PRIuHSIZE macro for printing. Definition of PRIuHSIZE actually precedes the change of typedef in the Git history,
 17:   // though there was never a release with the old definitions. Nonetheless, the logic here will work any commit.
 18:   #if !defined(PRIuHSIZE)
 19:     #define PRIuHSIZE "llu"
 20:   #endif

 22: PETSC_EXTERN PetscErrorCode PetscViewerHDF5GetFileId(PetscViewer, hid_t *);

 24:   /* On 32-bit systems HDF5 is limited by size of integer, because hsize_t is defined as size_t */
 25:   #define PETSC_HDF5_INT_MAX (~(hsize_t)0)

 27:   /* As per https://portal.hdfgroup.org/display/HDF5/Chunking+in+HDF5, max. chunk size is 4GB */
 28:   #define PETSC_HDF5_MAX_CHUNKSIZE 2147483647

 30: /*@C
 31:   PetscHDF5IntCast - Safely cast a nonnegative `PetscInt` to an HDF5 `hsize_t`, raising an error on overflow or negative input

 33:   Not Collective; No Fortran Support

 35:   Input Parameter:
 36: . a - the `PetscInt` value to convert

 38:   Output Parameter:
 39: . b - on output, the value as an `hsize_t`

 41:   Level: developer

 43:   Note:
 44:   Used internally by PETSc's HDF5 viewer routines when computing dataset dimensions and offsets.

 46: .seealso: `PetscViewerHDF5`, `PetscIntCast()`, `PetscMPIIntCast()`
 47: @*/
 48: static inline PetscErrorCode PetscHDF5IntCast(PetscInt a, hsize_t *b)
 49: {
 50:   PetscFunctionBegin;
 51:   PetscCheck(a >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Cannot convert negative size");
 52:   #if defined(PETSC_USE_64BIT_INDICES) && (H5_SIZEOF_HSIZE_T == 4)
 53:   PetscCheck(a >= PETSC_HDF5_INT_MAX, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Array too long for HDF5");
 54:   #endif
 55:   *b = (hsize_t)(a);
 56:   PetscFunctionReturn(PETSC_SUCCESS);
 57: }
 58: PETSC_EXTERN PetscErrorCode PetscDataTypeToHDF5DataType(PetscDataType, hid_t *);
 59: PETSC_EXTERN PetscErrorCode PetscHDF5DataTypeToPetscDataType(hid_t, PetscDataType *);
 60: PETSC_EXTERN PetscErrorCode PetscViewerHDF5OpenGroup(PetscViewer, const char[], hid_t *, hid_t *);
 61: #endif /* defined(PETSC_HAVE_HDF5) */

 63: static inline PetscErrorCode PetscViewerHDF5PathIsRelative(const char path[], PetscBool emptyIsRelative, PetscBool *has) PeNS
 64: {
 65:   size_t len;

 67:   PetscFunctionBegin;
 68:   *has = emptyIsRelative;
 69:   PetscCall(PetscStrlen(path, &len));
 70:   if (len) *has = (PetscBool)(path[0] != '/');
 71:   PetscFunctionReturn(PETSC_SUCCESS);
 72: }

 74: PETSC_EXTERN PetscErrorCode PetscViewerHDF5HasDataset(PetscViewer, const char[], PetscBool *);
 75: PETSC_EXTERN PetscErrorCode PetscViewerHDF5HasObject(PetscViewer, PetscObject, PetscBool *);
 76: PETSC_EXTERN PetscErrorCode PetscViewerHDF5ReadAttribute(PetscViewer, const char[], const char[], PetscDataType, const void *, void *);
 77: PETSC_EXTERN PetscErrorCode PetscViewerHDF5WriteAttribute(PetscViewer, const char[], const char[], PetscDataType, const void *);
 78: PETSC_EXTERN PetscErrorCode PetscViewerHDF5HasAttribute(PetscViewer, const char[], const char[], PetscBool *);
 79: PETSC_EXTERN PetscErrorCode PetscViewerHDF5ReadObjectAttribute(PetscViewer, PetscObject, const char[], PetscDataType, void *, void *);
 80: PETSC_EXTERN PetscErrorCode PetscViewerHDF5WriteObjectAttribute(PetscViewer, PetscObject, const char[], PetscDataType, const void *);
 81: PETSC_EXTERN PetscErrorCode PetscViewerHDF5HasObjectAttribute(PetscViewer, PetscObject, const char[], PetscBool *);

 83: PETSC_EXTERN PetscErrorCode PetscViewerHDF5Open(MPI_Comm, const char[], PetscFileMode, PetscViewer *);
 84: PETSC_EXTERN PetscErrorCode PetscViewerHDF5PushGroup(PetscViewer, const char[]);
 85: PETSC_EXTERN PetscErrorCode PetscViewerHDF5PopGroup(PetscViewer);
 86: PETSC_EXTERN PetscErrorCode PetscViewerHDF5GetGroup(PetscViewer, const char[], const char *[]);
 87: PETSC_EXTERN PetscErrorCode PetscViewerHDF5HasGroup(PetscViewer, const char[], PetscBool *);
 88: PETSC_EXTERN PetscErrorCode PetscViewerHDF5WriteGroup(PetscViewer, const char[]);

 90: PETSC_EXTERN PetscErrorCode PetscViewerHDF5SetDefaultTimestepping(PetscViewer, PetscBool);
 91: PETSC_EXTERN PetscErrorCode PetscViewerHDF5GetDefaultTimestepping(PetscViewer, PetscBool *);
 92: PETSC_EXTERN PetscErrorCode PetscViewerHDF5PushTimestepping(PetscViewer);
 93: PETSC_EXTERN PetscErrorCode PetscViewerHDF5PopTimestepping(PetscViewer);
 94: PETSC_EXTERN PetscErrorCode PetscViewerHDF5IsTimestepping(PetscViewer, PetscBool *);
 95: PETSC_EXTERN PetscErrorCode PetscViewerHDF5IncrementTimestep(PetscViewer);
 96: PETSC_EXTERN PetscErrorCode PetscViewerHDF5SetTimestep(PetscViewer, PetscInt);
 97: PETSC_EXTERN PetscErrorCode PetscViewerHDF5GetTimestep(PetscViewer, PetscInt *);

 99: PETSC_EXTERN PetscErrorCode PetscViewerHDF5SetBaseDimension2(PetscViewer, PetscBool);
100: PETSC_EXTERN PetscErrorCode PetscViewerHDF5GetBaseDimension2(PetscViewer, PetscBool *);

102: PETSC_EXTERN PetscErrorCode PetscViewerHDF5SetSPOutput(PetscViewer, PetscBool);
103: PETSC_EXTERN PetscErrorCode PetscViewerHDF5GetSPOutput(PetscViewer, PetscBool *);

105: PETSC_EXTERN PetscErrorCode PetscViewerHDF5SetCollective(PetscViewer, PetscBool);
106: PETSC_EXTERN PetscErrorCode PetscViewerHDF5GetCollective(PetscViewer, PetscBool *);

108: PETSC_EXTERN PetscErrorCode PetscViewerHDF5SetCompress(PetscViewer, PetscBool);
109: PETSC_EXTERN PetscErrorCode PetscViewerHDF5GetCompress(PetscViewer, PetscBool *);