xref: /petsc/src/sys/classes/viewer/impls/hdf5/hdf5v.c (revision bd7fcbe194d0de62439dd9312ba3e8320c4095b7)
1af0996ceSBarry Smith #include <petsc/private/viewerimpl.h>    /*I   "petscsys.h"   I*/
2d70abbfaSBarry Smith #include <petscviewerhdf5.h>    /*I   "petscviewerhdf5.h"   I*/
3ded06c3fSVaclav Hapla #if (H5_VERS_MAJOR * 10000 + H5_VERS_MINOR * 100 + H5_VERS_RELEASE < 10800)
4ded06c3fSVaclav Hapla #error "PETSc needs HDF5 version >= 1.8.0"
5ded06c3fSVaclav Hapla #endif
65c6c1daeSBarry Smith 
7bb286ee1SVaclav Hapla static PetscErrorCode PetscViewerHDF5Traverse_Internal(PetscViewer, const char[], PetscBool, PetscBool*, H5O_type_t*);
806db490cSVaclav Hapla static PetscErrorCode PetscViewerHDF5HasAttribute_Internal(PetscViewer, const char[], const char[], PetscBool*);
906db490cSVaclav Hapla 
105c6c1daeSBarry Smith typedef struct GroupList {
115c6c1daeSBarry Smith   const char       *name;
125c6c1daeSBarry Smith   struct GroupList *next;
135c6c1daeSBarry Smith } GroupList;
145c6c1daeSBarry Smith 
155c6c1daeSBarry Smith typedef struct {
165c6c1daeSBarry Smith   char          *filename;
175c6c1daeSBarry Smith   PetscFileMode btype;
185c6c1daeSBarry Smith   hid_t         file_id;
195c6c1daeSBarry Smith   PetscInt      timestep;
205c6c1daeSBarry Smith   GroupList     *groups;
2182ea9b62SBarry Smith   PetscBool     basedimension2;  /* save vectors and DMDA vectors with a dimension of at least 2 even if the bs/dof is 1 */
229a0502c6SHåkon Strandenes   PetscBool     spoutput;  /* write data in single precision even if PETSc is compiled with double precision PetscReal */
23058bd781SVaclav Hapla   char          *mataij_iname;
24058bd781SVaclav Hapla   char          *mataij_jname;
25058bd781SVaclav Hapla   char          *mataij_aname;
26058bd781SVaclav Hapla   char          *mataij_cname;
27b723ab35SVaclav Hapla   PetscBool     mataij_names_set;
285c6c1daeSBarry Smith } PetscViewer_HDF5;
295c6c1daeSBarry Smith 
30eb5a92b4SVaclav Hapla struct _n_HDF5ReadCtx {
31eb5a92b4SVaclav Hapla   hid_t file, group, dataset, dataspace, plist;
32eb5a92b4SVaclav Hapla   PetscInt timestep;
3309dabeb0SVaclav Hapla   PetscBool complexVal, dim2, horizontal;
34eb5a92b4SVaclav Hapla };
35eb5a92b4SVaclav Hapla typedef struct _n_HDF5ReadCtx* HDF5ReadCtx;
36eb5a92b4SVaclav Hapla 
376c132bc1SVaclav Hapla static PetscErrorCode PetscViewerHDF5GetAbsolutePath_Internal(PetscViewer viewer, const char objname[], char **fullpath)
386c132bc1SVaclav Hapla {
396c132bc1SVaclav Hapla   const char *group;
406c132bc1SVaclav Hapla   char buf[PETSC_MAX_PATH_LEN]="";
416c132bc1SVaclav Hapla   PetscErrorCode ierr;
426c132bc1SVaclav Hapla 
436c132bc1SVaclav Hapla   PetscFunctionBegin;
446c132bc1SVaclav Hapla   ierr = PetscViewerHDF5GetGroup(viewer, &group);CHKERRQ(ierr);
456c132bc1SVaclav Hapla   ierr = PetscStrcat(buf, group);CHKERRQ(ierr);
466c132bc1SVaclav Hapla   ierr = PetscStrcat(buf, "/");CHKERRQ(ierr);
476c132bc1SVaclav Hapla   ierr = PetscStrcat(buf, objname);CHKERRQ(ierr);
486c132bc1SVaclav Hapla   ierr = PetscStrallocpy(buf, fullpath);CHKERRQ(ierr);
496c132bc1SVaclav Hapla   PetscFunctionReturn(0);
506c132bc1SVaclav Hapla }
516c132bc1SVaclav Hapla 
52577e0e04SVaclav Hapla static PetscErrorCode PetscViewerHDF5CheckNamedObject_Internal(PetscViewer viewer, PetscObject obj)
53577e0e04SVaclav Hapla {
54577e0e04SVaclav Hapla   PetscBool has;
55577e0e04SVaclav Hapla   const char *group;
56577e0e04SVaclav Hapla   PetscErrorCode ierr;
57577e0e04SVaclav Hapla 
58577e0e04SVaclav Hapla   PetscFunctionBegin;
59577e0e04SVaclav Hapla   if (!obj->name) SETERRQ(PetscObjectComm((PetscObject)viewer), PETSC_ERR_ARG_WRONG, "Object must be named");
60577e0e04SVaclav Hapla   ierr = PetscViewerHDF5HasObject(viewer, obj, &has);CHKERRQ(ierr);
61577e0e04SVaclav Hapla   if (!has) {
62577e0e04SVaclav Hapla     ierr = PetscViewerHDF5GetGroup(viewer, &group);CHKERRQ(ierr);
63577e0e04SVaclav Hapla     SETERRQ2(PetscObjectComm((PetscObject)viewer), PETSC_ERR_FILE_UNEXPECTED, "Object (dataset) %s not stored in group %s", obj->name, group);
64577e0e04SVaclav Hapla   }
65577e0e04SVaclav Hapla   PetscFunctionReturn(0);
66577e0e04SVaclav Hapla }
67577e0e04SVaclav Hapla 
684416b707SBarry Smith static PetscErrorCode PetscViewerSetFromOptions_HDF5(PetscOptionItems *PetscOptionsObject,PetscViewer v)
6982ea9b62SBarry Smith {
7082ea9b62SBarry Smith   PetscErrorCode   ierr;
7182ea9b62SBarry Smith   PetscViewer_HDF5 *hdf5 = (PetscViewer_HDF5*)v->data;
7282ea9b62SBarry Smith 
7382ea9b62SBarry Smith   PetscFunctionBegin;
7482ea9b62SBarry Smith   ierr = PetscOptionsHead(PetscOptionsObject,"HDF5 PetscViewer Options");CHKERRQ(ierr);
7582ea9b62SBarry Smith   ierr = PetscOptionsBool("-viewer_hdf5_base_dimension2","1d Vectors get 2 dimensions in HDF5","PetscViewerHDF5SetBaseDimension2",hdf5->basedimension2,&hdf5->basedimension2,NULL);CHKERRQ(ierr);
769a0502c6SHåkon Strandenes   ierr = PetscOptionsBool("-viewer_hdf5_sp_output","Force data to be written in single precision","PetscViewerHDF5SetSPOutput",hdf5->spoutput,&hdf5->spoutput,NULL);CHKERRQ(ierr);
7782ea9b62SBarry Smith   ierr = PetscOptionsTail();CHKERRQ(ierr);
7882ea9b62SBarry Smith   PetscFunctionReturn(0);
7982ea9b62SBarry Smith }
8082ea9b62SBarry Smith 
815c6c1daeSBarry Smith static PetscErrorCode PetscViewerFileClose_HDF5(PetscViewer viewer)
825c6c1daeSBarry Smith {
835c6c1daeSBarry Smith   PetscViewer_HDF5 *hdf5 = (PetscViewer_HDF5*)viewer->data;
845c6c1daeSBarry Smith   PetscErrorCode   ierr;
855c6c1daeSBarry Smith 
865c6c1daeSBarry Smith   PetscFunctionBegin;
875c6c1daeSBarry Smith   ierr = PetscFree(hdf5->filename);CHKERRQ(ierr);
88729ab6d9SBarry Smith   if (hdf5->file_id) PetscStackCallHDF5(H5Fclose,(hdf5->file_id));
895c6c1daeSBarry Smith   PetscFunctionReturn(0);
905c6c1daeSBarry Smith }
915c6c1daeSBarry Smith 
929b1403beSVaclav Hapla static PetscErrorCode PetscViewerDestroy_HDF5(PetscViewer viewer)
935c6c1daeSBarry Smith {
945c6c1daeSBarry Smith   PetscViewer_HDF5 *hdf5 = (PetscViewer_HDF5*) viewer->data;
955c6c1daeSBarry Smith   PetscErrorCode   ierr;
965c6c1daeSBarry Smith 
975c6c1daeSBarry Smith   PetscFunctionBegin;
985c6c1daeSBarry Smith   ierr = PetscViewerFileClose_HDF5(viewer);CHKERRQ(ierr);
995c6c1daeSBarry Smith   while (hdf5->groups) {
1005c6c1daeSBarry Smith     GroupList *tmp = hdf5->groups->next;
1015c6c1daeSBarry Smith 
1025c6c1daeSBarry Smith     ierr         = PetscFree(hdf5->groups->name);CHKERRQ(ierr);
1035c6c1daeSBarry Smith     ierr         = PetscFree(hdf5->groups);CHKERRQ(ierr);
1045c6c1daeSBarry Smith     hdf5->groups = tmp;
1055c6c1daeSBarry Smith   }
10661912a0cSVaclav Hapla   ierr = PetscFree(hdf5->mataij_iname);CHKERRQ(ierr);
10761912a0cSVaclav Hapla   ierr = PetscFree(hdf5->mataij_jname);CHKERRQ(ierr);
10861912a0cSVaclav Hapla   ierr = PetscFree(hdf5->mataij_aname);CHKERRQ(ierr);
10961912a0cSVaclav Hapla   ierr = PetscFree(hdf5->mataij_cname);CHKERRQ(ierr);
1105c6c1daeSBarry Smith   ierr = PetscFree(hdf5);CHKERRQ(ierr);
1110b062f91SJed Brown   ierr = PetscObjectComposeFunction((PetscObject)viewer,"PetscViewerFileSetName_C",NULL);CHKERRQ(ierr);
112d1232d7fSToby Isaac   ierr = PetscObjectComposeFunction((PetscObject)viewer,"PetscViewerFileGetName_C",NULL);CHKERRQ(ierr);
1130b062f91SJed Brown   ierr = PetscObjectComposeFunction((PetscObject)viewer,"PetscViewerFileSetMode_C",NULL);CHKERRQ(ierr);
114058bd781SVaclav Hapla   ierr = PetscObjectComposeFunction((PetscObject)viewer,"PetscViewerHDF5SetBaseDimension2_C",NULL);CHKERRQ(ierr);
115058bd781SVaclav Hapla   ierr = PetscObjectComposeFunction((PetscObject)viewer,"PetscViewerHDF5SetSPOutput_C",NULL);CHKERRQ(ierr);
116058bd781SVaclav Hapla   ierr = PetscObjectComposeFunction((PetscObject)viewer,"PetscViewerHDF5SetAIJNames_C",NULL);CHKERRQ(ierr);
117058bd781SVaclav Hapla   ierr = PetscObjectComposeFunction((PetscObject)viewer,"PetscViewerHDF5GetAIJNames_C",NULL);CHKERRQ(ierr);
1185c6c1daeSBarry Smith   PetscFunctionReturn(0);
1195c6c1daeSBarry Smith }
1205c6c1daeSBarry Smith 
1219b1403beSVaclav Hapla static PetscErrorCode  PetscViewerFileSetMode_HDF5(PetscViewer viewer, PetscFileMode type)
1225c6c1daeSBarry Smith {
1235c6c1daeSBarry Smith   PetscViewer_HDF5 *hdf5 = (PetscViewer_HDF5*) viewer->data;
1245c6c1daeSBarry Smith 
1255c6c1daeSBarry Smith   PetscFunctionBegin;
1265c6c1daeSBarry Smith   hdf5->btype = type;
1275c6c1daeSBarry Smith   PetscFunctionReturn(0);
1285c6c1daeSBarry Smith }
1295c6c1daeSBarry Smith 
1300b62783dSVaclav Hapla static PetscErrorCode  PetscViewerFileGetMode_HDF5(PetscViewer viewer, PetscFileMode *type)
1310b62783dSVaclav Hapla {
1320b62783dSVaclav Hapla   PetscViewer_HDF5 *hdf5 = (PetscViewer_HDF5*) viewer->data;
1330b62783dSVaclav Hapla 
1340b62783dSVaclav Hapla   PetscFunctionBegin;
1350b62783dSVaclav Hapla   *type = hdf5->btype;
1360b62783dSVaclav Hapla   PetscFunctionReturn(0);
1370b62783dSVaclav Hapla }
1380b62783dSVaclav Hapla 
1399b1403beSVaclav Hapla static PetscErrorCode  PetscViewerHDF5SetBaseDimension2_HDF5(PetscViewer viewer, PetscBool flg)
14082ea9b62SBarry Smith {
14182ea9b62SBarry Smith   PetscViewer_HDF5 *hdf5 = (PetscViewer_HDF5*) viewer->data;
14282ea9b62SBarry Smith 
14382ea9b62SBarry Smith   PetscFunctionBegin;
14482ea9b62SBarry Smith   hdf5->basedimension2 = flg;
14582ea9b62SBarry Smith   PetscFunctionReturn(0);
14682ea9b62SBarry Smith }
14782ea9b62SBarry Smith 
148df863907SAlex Fikl /*@
14982ea9b62SBarry Smith      PetscViewerHDF5SetBaseDimension2 - Vectors of 1 dimension (i.e. bs/dof is 1) will be saved in the HDF5 file with a
15082ea9b62SBarry Smith        dimension of 2.
15182ea9b62SBarry Smith 
15282ea9b62SBarry Smith     Logically Collective on PetscViewer
15382ea9b62SBarry Smith 
15482ea9b62SBarry Smith   Input Parameters:
15582ea9b62SBarry Smith +  viewer - the PetscViewer; if it is not hdf5 then this command is ignored
15682ea9b62SBarry Smith -  flg - if PETSC_TRUE the vector will always have at least a dimension of 2 even if that first dimension is of size 1
15782ea9b62SBarry Smith 
15882ea9b62SBarry Smith   Options Database:
15982ea9b62SBarry Smith .  -viewer_hdf5_base_dimension2 - turns on (true) or off (false) using a dimension of 2 in the HDF5 file even if the bs/dof of the vector is 1
16082ea9b62SBarry Smith 
16182ea9b62SBarry Smith 
16295452b02SPatrick Sanan   Notes:
16395452b02SPatrick Sanan     Setting this option allegedly makes code that reads the HDF5 in easier since they do not have a "special case" of a bs/dof
16482ea9b62SBarry Smith          of one when the dimension is lower. Others think the option is crazy.
16582ea9b62SBarry Smith 
16682ea9b62SBarry Smith   Level: intermediate
16782ea9b62SBarry Smith 
16882ea9b62SBarry Smith .seealso: PetscViewerFileSetMode(), PetscViewerCreate(), PetscViewerSetType(), PetscViewerBinaryOpen()
16982ea9b62SBarry Smith 
17082ea9b62SBarry Smith @*/
17182ea9b62SBarry Smith PetscErrorCode PetscViewerHDF5SetBaseDimension2(PetscViewer viewer,PetscBool flg)
17282ea9b62SBarry Smith {
17382ea9b62SBarry Smith   PetscErrorCode ierr;
17482ea9b62SBarry Smith 
17582ea9b62SBarry Smith   PetscFunctionBegin;
17682ea9b62SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
17782ea9b62SBarry Smith   ierr = PetscTryMethod(viewer,"PetscViewerHDF5SetBaseDimension2_C",(PetscViewer,PetscBool),(viewer,flg));CHKERRQ(ierr);
17882ea9b62SBarry Smith   PetscFunctionReturn(0);
17982ea9b62SBarry Smith }
18082ea9b62SBarry Smith 
181df863907SAlex Fikl /*@
18282ea9b62SBarry Smith      PetscViewerHDF5GetBaseDimension2 - Vectors of 1 dimension (i.e. bs/dof is 1) will be saved in the HDF5 file with a
18382ea9b62SBarry Smith        dimension of 2.
18482ea9b62SBarry Smith 
18582ea9b62SBarry Smith     Logically Collective on PetscViewer
18682ea9b62SBarry Smith 
18782ea9b62SBarry Smith   Input Parameter:
18882ea9b62SBarry Smith .  viewer - the PetscViewer, must be of type HDF5
18982ea9b62SBarry Smith 
19082ea9b62SBarry Smith   Output Parameter:
19182ea9b62SBarry Smith .  flg - if PETSC_TRUE the vector will always have at least a dimension of 2 even if that first dimension is of size 1
19282ea9b62SBarry Smith 
19395452b02SPatrick Sanan   Notes:
19495452b02SPatrick Sanan     Setting this option allegedly makes code that reads the HDF5 in easier since they do not have a "special case" of a bs/dof
19582ea9b62SBarry Smith          of one when the dimension is lower. Others think the option is crazy.
19682ea9b62SBarry Smith 
19782ea9b62SBarry Smith   Level: intermediate
19882ea9b62SBarry Smith 
19982ea9b62SBarry Smith .seealso: PetscViewerFileSetMode(), PetscViewerCreate(), PetscViewerSetType(), PetscViewerBinaryOpen()
20082ea9b62SBarry Smith 
20182ea9b62SBarry Smith @*/
20282ea9b62SBarry Smith PetscErrorCode PetscViewerHDF5GetBaseDimension2(PetscViewer viewer,PetscBool *flg)
20382ea9b62SBarry Smith {
20482ea9b62SBarry Smith   PetscViewer_HDF5 *hdf5 = (PetscViewer_HDF5*) viewer->data;
20582ea9b62SBarry Smith 
20682ea9b62SBarry Smith   PetscFunctionBegin;
20782ea9b62SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
20882ea9b62SBarry Smith   *flg = hdf5->basedimension2;
20982ea9b62SBarry Smith   PetscFunctionReturn(0);
21082ea9b62SBarry Smith }
21182ea9b62SBarry Smith 
2129b1403beSVaclav Hapla static PetscErrorCode  PetscViewerHDF5SetSPOutput_HDF5(PetscViewer viewer, PetscBool flg)
2139a0502c6SHåkon Strandenes {
2149a0502c6SHåkon Strandenes   PetscViewer_HDF5 *hdf5 = (PetscViewer_HDF5*) viewer->data;
2159a0502c6SHåkon Strandenes 
2169a0502c6SHåkon Strandenes   PetscFunctionBegin;
2179a0502c6SHåkon Strandenes   hdf5->spoutput = flg;
2189a0502c6SHåkon Strandenes   PetscFunctionReturn(0);
2199a0502c6SHåkon Strandenes }
2209a0502c6SHåkon Strandenes 
221df863907SAlex Fikl /*@
2229a0502c6SHåkon Strandenes      PetscViewerHDF5SetSPOutput - Data is written to disk in single precision even if PETSc is
2239a0502c6SHåkon Strandenes        compiled with double precision PetscReal.
2249a0502c6SHåkon Strandenes 
2259a0502c6SHåkon Strandenes     Logically Collective on PetscViewer
2269a0502c6SHåkon Strandenes 
2279a0502c6SHåkon Strandenes   Input Parameters:
2289a0502c6SHåkon Strandenes +  viewer - the PetscViewer; if it is not hdf5 then this command is ignored
2299a0502c6SHåkon Strandenes -  flg - if PETSC_TRUE the data will be written to disk with single precision
2309a0502c6SHåkon Strandenes 
2319a0502c6SHåkon Strandenes   Options Database:
2329a0502c6SHåkon Strandenes .  -viewer_hdf5_sp_output - turns on (true) or off (false) output in single precision
2339a0502c6SHåkon Strandenes 
2349a0502c6SHåkon Strandenes 
23595452b02SPatrick Sanan   Notes:
23695452b02SPatrick Sanan     Setting this option does not make any difference if PETSc is compiled with single precision
2379a0502c6SHåkon Strandenes          in the first place. It does not affect reading datasets (HDF5 handle this internally).
2389a0502c6SHåkon Strandenes 
2399a0502c6SHåkon Strandenes   Level: intermediate
2409a0502c6SHåkon Strandenes 
2419a0502c6SHåkon Strandenes .seealso: PetscViewerFileSetMode(), PetscViewerCreate(), PetscViewerSetType(), PetscViewerBinaryOpen(),
2429a0502c6SHåkon Strandenes           PetscReal
2439a0502c6SHåkon Strandenes 
2449a0502c6SHåkon Strandenes @*/
2459a0502c6SHåkon Strandenes PetscErrorCode PetscViewerHDF5SetSPOutput(PetscViewer viewer,PetscBool flg)
2469a0502c6SHåkon Strandenes {
2479a0502c6SHåkon Strandenes   PetscErrorCode ierr;
2489a0502c6SHåkon Strandenes 
2499a0502c6SHåkon Strandenes   PetscFunctionBegin;
2509a0502c6SHåkon Strandenes   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
2519a0502c6SHåkon Strandenes   ierr = PetscTryMethod(viewer,"PetscViewerHDF5SetSPOutput_C",(PetscViewer,PetscBool),(viewer,flg));CHKERRQ(ierr);
2529a0502c6SHåkon Strandenes   PetscFunctionReturn(0);
2539a0502c6SHåkon Strandenes }
2549a0502c6SHåkon Strandenes 
255df863907SAlex Fikl /*@
2569a0502c6SHåkon Strandenes      PetscViewerHDF5GetSPOutput - Data is written to disk in single precision even if PETSc is
2579a0502c6SHåkon Strandenes        compiled with double precision PetscReal.
2589a0502c6SHåkon Strandenes 
2599a0502c6SHåkon Strandenes     Logically Collective on PetscViewer
2609a0502c6SHåkon Strandenes 
2619a0502c6SHåkon Strandenes   Input Parameter:
2629a0502c6SHåkon Strandenes .  viewer - the PetscViewer, must be of type HDF5
2639a0502c6SHåkon Strandenes 
2649a0502c6SHåkon Strandenes   Output Parameter:
2659a0502c6SHåkon Strandenes .  flg - if PETSC_TRUE the data will be written to disk with single precision
2669a0502c6SHåkon Strandenes 
26795452b02SPatrick Sanan   Notes:
26895452b02SPatrick Sanan     Setting this option does not make any difference if PETSc is compiled with single precision
2699a0502c6SHåkon Strandenes          in the first place. It does not affect reading datasets (HDF5 handle this internally).
2709a0502c6SHåkon Strandenes 
2719a0502c6SHåkon Strandenes   Level: intermediate
2729a0502c6SHåkon Strandenes 
2739a0502c6SHåkon Strandenes .seealso: PetscViewerFileSetMode(), PetscViewerCreate(), PetscViewerSetType(), PetscViewerBinaryOpen(),
2749a0502c6SHåkon Strandenes           PetscReal
2759a0502c6SHåkon Strandenes 
2769a0502c6SHåkon Strandenes @*/
2779a0502c6SHåkon Strandenes PetscErrorCode PetscViewerHDF5GetSPOutput(PetscViewer viewer,PetscBool *flg)
2789a0502c6SHåkon Strandenes {
2799a0502c6SHåkon Strandenes   PetscViewer_HDF5 *hdf5 = (PetscViewer_HDF5*) viewer->data;
2809a0502c6SHåkon Strandenes 
2819a0502c6SHåkon Strandenes   PetscFunctionBegin;
2829a0502c6SHåkon Strandenes   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
2839a0502c6SHåkon Strandenes   *flg = hdf5->spoutput;
2849a0502c6SHåkon Strandenes   PetscFunctionReturn(0);
2859a0502c6SHåkon Strandenes }
2869a0502c6SHåkon Strandenes 
2879b1403beSVaclav Hapla static PetscErrorCode  PetscViewerFileSetName_HDF5(PetscViewer viewer, const char name[])
2885c6c1daeSBarry Smith {
2895c6c1daeSBarry Smith   PetscViewer_HDF5 *hdf5 = (PetscViewer_HDF5*) viewer->data;
2905c6c1daeSBarry Smith #if defined(PETSC_HAVE_H5PSET_FAPL_MPIO)
2915c6c1daeSBarry Smith   MPI_Info          info = MPI_INFO_NULL;
2925c6c1daeSBarry Smith #endif
2935c6c1daeSBarry Smith   hid_t             plist_id;
2945c6c1daeSBarry Smith   PetscErrorCode    ierr;
2955c6c1daeSBarry Smith 
2965c6c1daeSBarry Smith   PetscFunctionBegin;
297f683cc58SToby Isaac   if (hdf5->file_id) PetscStackCallHDF5(H5Fclose,(hdf5->file_id));
298f683cc58SToby Isaac   if (hdf5->filename) {ierr = PetscFree(hdf5->filename);CHKERRQ(ierr);}
2995c6c1daeSBarry Smith   ierr = PetscStrallocpy(name, &hdf5->filename);CHKERRQ(ierr);
3005c6c1daeSBarry Smith   /* Set up file access property list with parallel I/O access */
301729ab6d9SBarry Smith   PetscStackCallHDF5Return(plist_id,H5Pcreate,(H5P_FILE_ACCESS));
3025c6c1daeSBarry Smith #if defined(PETSC_HAVE_H5PSET_FAPL_MPIO)
303729ab6d9SBarry Smith   PetscStackCallHDF5(H5Pset_fapl_mpio,(plist_id, PetscObjectComm((PetscObject)viewer), info));
3045c6c1daeSBarry Smith #endif
3055c6c1daeSBarry Smith   /* Create or open the file collectively */
3065c6c1daeSBarry Smith   switch (hdf5->btype) {
3075c6c1daeSBarry Smith   case FILE_MODE_READ:
308729ab6d9SBarry Smith     PetscStackCallHDF5Return(hdf5->file_id,H5Fopen,(name, H5F_ACC_RDONLY, plist_id));
3095c6c1daeSBarry Smith     break;
3105c6c1daeSBarry Smith   case FILE_MODE_APPEND:
311729ab6d9SBarry Smith     PetscStackCallHDF5Return(hdf5->file_id,H5Fopen,(name, H5F_ACC_RDWR, plist_id));
3125c6c1daeSBarry Smith     break;
3135c6c1daeSBarry Smith   case FILE_MODE_WRITE:
314729ab6d9SBarry Smith     PetscStackCallHDF5Return(hdf5->file_id,H5Fcreate,(name, H5F_ACC_TRUNC, H5P_DEFAULT, plist_id));
3155c6c1daeSBarry Smith     break;
3165c6c1daeSBarry Smith   default:
3175c6c1daeSBarry Smith     SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER, "Must call PetscViewerFileSetMode() before PetscViewerFileSetName()");
3185c6c1daeSBarry Smith   }
3195c6c1daeSBarry Smith   if (hdf5->file_id < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_LIB, "H5Fcreate failed for %s", name);
320729ab6d9SBarry Smith   PetscStackCallHDF5(H5Pclose,(plist_id));
3215c6c1daeSBarry Smith   PetscFunctionReturn(0);
3225c6c1daeSBarry Smith }
3235c6c1daeSBarry Smith 
324d1232d7fSToby Isaac static PetscErrorCode PetscViewerFileGetName_HDF5(PetscViewer viewer,const char **name)
325d1232d7fSToby Isaac {
326d1232d7fSToby Isaac   PetscViewer_HDF5 *vhdf5 = (PetscViewer_HDF5*)viewer->data;
327d1232d7fSToby Isaac 
328d1232d7fSToby Isaac   PetscFunctionBegin;
329d1232d7fSToby Isaac   *name = vhdf5->filename;
330d1232d7fSToby Isaac   PetscFunctionReturn(0);
331d1232d7fSToby Isaac }
332d1232d7fSToby Isaac 
3339b1403beSVaclav Hapla static PetscErrorCode  PetscViewerHDF5SetAIJNames_HDF5(PetscViewer viewer, const char iname[], const char jname[], const char aname[], const char cname[])
334058bd781SVaclav Hapla {
335058bd781SVaclav Hapla   PetscViewer_HDF5 *hdf5 = (PetscViewer_HDF5*) viewer->data;
336058bd781SVaclav Hapla   PetscErrorCode ierr;
337058bd781SVaclav Hapla 
338058bd781SVaclav Hapla   PetscFunctionBegin;
339058bd781SVaclav Hapla   ierr = PetscFree(hdf5->mataij_iname);CHKERRQ(ierr);
340058bd781SVaclav Hapla   ierr = PetscFree(hdf5->mataij_jname);CHKERRQ(ierr);
341058bd781SVaclav Hapla   ierr = PetscFree(hdf5->mataij_aname);CHKERRQ(ierr);
342058bd781SVaclav Hapla   ierr = PetscFree(hdf5->mataij_cname);CHKERRQ(ierr);
343058bd781SVaclav Hapla   ierr = PetscStrallocpy(iname,&hdf5->mataij_iname);CHKERRQ(ierr);
344058bd781SVaclav Hapla   ierr = PetscStrallocpy(jname,&hdf5->mataij_jname);CHKERRQ(ierr);
345058bd781SVaclav Hapla   ierr = PetscStrallocpy(aname,&hdf5->mataij_aname);CHKERRQ(ierr);
346058bd781SVaclav Hapla   ierr = PetscStrallocpy(cname,&hdf5->mataij_cname);CHKERRQ(ierr);
347b723ab35SVaclav Hapla   hdf5->mataij_names_set = PETSC_TRUE;
348058bd781SVaclav Hapla   PetscFunctionReturn(0);
349058bd781SVaclav Hapla }
350058bd781SVaclav Hapla 
351058bd781SVaclav Hapla /*@C
352058bd781SVaclav Hapla   PetscViewerHDF5SetAIJNames - Set the names of the datasets representing the three AIJ (CRS) arrays and the name of the attribute storing the number of columns within the HDF5 file.
353058bd781SVaclav Hapla 
354058bd781SVaclav Hapla   Collective on PetscViewer
355058bd781SVaclav Hapla 
356058bd781SVaclav Hapla   Input Parameters:
357058bd781SVaclav Hapla +  viewer - the PetscViewer; either ASCII or binary
358058bd781SVaclav Hapla .  iname - name of dataset i representing row pointers; that is i[0] = 0, i[row] = i[row-1] + number of elements in that row of the matrix
359058bd781SVaclav Hapla .  jname - name of dataset j representing column indices
360058bd781SVaclav Hapla .  aname - name of dataset a representing matrix values
361058bd781SVaclav Hapla -  cname - name of attribute stoting column count
362058bd781SVaclav Hapla 
363058bd781SVaclav Hapla   Level: advanced
364058bd781SVaclav Hapla 
365058bd781SVaclav Hapla   Notes:
366*bd7fcbe1SVaclav Hapla   Current defaults are (iname, jname, aname, cname) = ("jc", "ir", "data", "MATLAB_sparse") so that MAT files can be readily loaded.
367058bd781SVaclav Hapla 
368058bd781SVaclav Hapla .seealso: MatLoad(), PetscViewerCreate(), PetscViewerSetType(), PETSCVIEWERHDF5, PetscViewerHDF5GetAIJNames()
369058bd781SVaclav Hapla @*/
370*bd7fcbe1SVaclav Hapla /* TODO Once corresponding MatView is implemented, add this:
371*bd7fcbe1SVaclav Hapla   Current defaults are (iname, jname, aname, cname) = ("i", "j", "a", "ncols").
372*bd7fcbe1SVaclav Hapla   For PetscViewerFormat PETSC_VIEWER_HDF5_MAT they are ("jc", "ir", "data", "MATLAB_sparse") so that MAT files can be loaded.
373*bd7fcbe1SVaclav Hapla */
374058bd781SVaclav Hapla PetscErrorCode  PetscViewerHDF5SetAIJNames(PetscViewer viewer, const char iname[], const char jname[], const char aname[], const char cname[])
375058bd781SVaclav Hapla {
376058bd781SVaclav Hapla   PetscErrorCode ierr;
377058bd781SVaclav Hapla 
378058bd781SVaclav Hapla   PetscFunctionBegin;
379058bd781SVaclav Hapla   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
380058bd781SVaclav Hapla   PetscValidCharPointer(iname,2);
381058bd781SVaclav Hapla   PetscValidCharPointer(jname,3);
382058bd781SVaclav Hapla   PetscValidCharPointer(aname,4);
383058bd781SVaclav Hapla   PetscValidCharPointer(cname,5);
384058bd781SVaclav Hapla   ierr = PetscTryMethod(viewer,"PetscViewerHDF5SetAIJNames_C",(PetscViewer,const char[],const char[],const char[],const char[]),(viewer,iname,jname,aname,cname));CHKERRQ(ierr);
385058bd781SVaclav Hapla   PetscFunctionReturn(0);
386058bd781SVaclav Hapla }
387058bd781SVaclav Hapla 
3889b1403beSVaclav Hapla static PetscErrorCode  PetscViewerHDF5GetAIJNames_HDF5(PetscViewer viewer, const char *iname[], const char *jname[], const char *aname[], const char *cname[])
389058bd781SVaclav Hapla {
390058bd781SVaclav Hapla   PetscViewer_HDF5 *hdf5 = (PetscViewer_HDF5*) viewer->data;
391058bd781SVaclav Hapla 
392058bd781SVaclav Hapla   PetscFunctionBegin;
393058bd781SVaclav Hapla   *iname = hdf5->mataij_iname;
394058bd781SVaclav Hapla   *jname = hdf5->mataij_jname;
395058bd781SVaclav Hapla   *aname = hdf5->mataij_aname;
396058bd781SVaclav Hapla   *cname = hdf5->mataij_cname;
397058bd781SVaclav Hapla   PetscFunctionReturn(0);
398058bd781SVaclav Hapla }
399058bd781SVaclav Hapla 
400058bd781SVaclav Hapla /*@C
401058bd781SVaclav Hapla   PetscViewerHDF5GetAIJNames - Get the names of the datasets representing the three AIJ (CRS) arrays and the name of the attribute storing the number of columns within the HDF5 file.
402058bd781SVaclav Hapla 
403058bd781SVaclav Hapla   Collective on PetscViewer
404058bd781SVaclav Hapla 
405058bd781SVaclav Hapla   Input Parameters:
406058bd781SVaclav Hapla .  viewer - the PetscViewer; either ASCII or binary
407058bd781SVaclav Hapla 
408058bd781SVaclav Hapla   Output Parameters:
409058bd781SVaclav Hapla +  iname - name of dataset i representing row pointers; that is i[0] = 0, i[row] = i[row-1] + number of elements in that row of the matrix
410058bd781SVaclav Hapla .  jname - name of dataset j representing column indices
411058bd781SVaclav Hapla .  aname - name of dataset a representing matrix values
412058bd781SVaclav Hapla -  cname - name of attribute stoting column count
413058bd781SVaclav Hapla 
414058bd781SVaclav Hapla   Level: advanced
415058bd781SVaclav Hapla 
416058bd781SVaclav Hapla   Notes:
417*bd7fcbe1SVaclav Hapla   Current defaults are (iname, jname, aname, cname) = ("jc", "ir", "data", "MATLAB_sparse") so that MAT files can be readily loaded.
418058bd781SVaclav Hapla 
419058bd781SVaclav Hapla .seealso: MatLoad(), PetscViewerCreate(), PetscViewerSetType(), PETSCVIEWERHDF5, PetscViewerHDF5SetAIJNames()
420058bd781SVaclav Hapla @*/
421*bd7fcbe1SVaclav Hapla /* TODO Once corresponding MatView is implemented, add this:
422*bd7fcbe1SVaclav Hapla   Current defaults are (iname, jname, aname, cname) = ("i", "j", "a", "ncols").
423*bd7fcbe1SVaclav Hapla   For PetscViewerFormat PETSC_VIEWER_HDF5_MAT they are ("jc", "ir", "data", "MATLAB_sparse") so that MAT files can be loaded.
424*bd7fcbe1SVaclav Hapla */
425058bd781SVaclav Hapla PetscErrorCode  PetscViewerHDF5GetAIJNames(PetscViewer viewer, const char *iname[], const char *jname[], const char *aname[], const char *cname[])
426058bd781SVaclav Hapla {
427058bd781SVaclav Hapla   PetscErrorCode ierr;
428058bd781SVaclav Hapla 
429058bd781SVaclav Hapla   PetscFunctionBegin;
430058bd781SVaclav Hapla   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
431058bd781SVaclav Hapla   PetscValidPointer(iname,2);
432058bd781SVaclav Hapla   PetscValidPointer(jname,3);
433058bd781SVaclav Hapla   PetscValidPointer(aname,4);
434058bd781SVaclav Hapla   PetscValidPointer(cname,5);
435058bd781SVaclav Hapla   ierr = PetscUseMethod(viewer,"PetscViewerHDF5GetAIJNames_C",(PetscViewer,const char*[],const char*[],const char*[],const char*[]),(viewer,iname,jname,aname,cname));CHKERRQ(ierr);
436058bd781SVaclav Hapla   PetscFunctionReturn(0);
437058bd781SVaclav Hapla }
438058bd781SVaclav Hapla 
439b723ab35SVaclav Hapla static PetscErrorCode PetscViewerSetUp_HDF5(PetscViewer viewer)
440b723ab35SVaclav Hapla {
441b723ab35SVaclav Hapla   PetscViewer_HDF5 *hdf5 = (PetscViewer_HDF5*) viewer->data;
442b723ab35SVaclav Hapla   PetscErrorCode   ierr;
443b723ab35SVaclav Hapla 
444b723ab35SVaclav Hapla   PetscFunctionBegin;
445b723ab35SVaclav Hapla   if (!hdf5->mataij_names_set) {
446*bd7fcbe1SVaclav Hapla /* TODO Once corresponding MatView is implemented, uncomment */
447*bd7fcbe1SVaclav Hapla #if 0
448cbb4c999SVaclav Hapla     if (viewer->format == PETSC_VIEWER_HDF5_MAT) {
449*bd7fcbe1SVaclav Hapla #endif
450b723ab35SVaclav Hapla       ierr = PetscViewerHDF5SetAIJNames_HDF5(viewer,"jc","ir","data","MATLAB_sparse");CHKERRQ(ierr);
451*bd7fcbe1SVaclav Hapla #if 0
452cbb4c999SVaclav Hapla     } else {
453cbb4c999SVaclav Hapla       ierr = PetscViewerHDF5SetAIJNames_HDF5(viewer,"i","j","a","ncols");CHKERRQ(ierr);
454cbb4c999SVaclav Hapla     }
455*bd7fcbe1SVaclav Hapla #endif
456b723ab35SVaclav Hapla   }
457b723ab35SVaclav Hapla   PetscFunctionReturn(0);
458b723ab35SVaclav Hapla }
459b723ab35SVaclav Hapla 
4608556b5ebSBarry Smith /*MC
4618556b5ebSBarry Smith    PETSCVIEWERHDF5 - A viewer that writes to an HDF5 file
4628556b5ebSBarry Smith 
4638556b5ebSBarry Smith 
4648556b5ebSBarry Smith .seealso:  PetscViewerHDF5Open(), PetscViewerStringSPrintf(), PetscViewerSocketOpen(), PetscViewerDrawOpen(), PETSCVIEWERSOCKET,
4658556b5ebSBarry Smith            PetscViewerCreate(), PetscViewerASCIIOpen(), PetscViewerBinaryOpen(), PETSCVIEWERBINARY, PETSCVIEWERDRAW, PETSCVIEWERSTRING,
4668556b5ebSBarry Smith            PetscViewerMatlabOpen(), VecView(), DMView(), PetscViewerMatlabPutArray(), PETSCVIEWERASCII, PETSCVIEWERMATLAB,
4678556b5ebSBarry Smith            PetscViewerFileSetName(), PetscViewerFileSetMode(), PetscViewerFormat, PetscViewerType, PetscViewerSetType()
4688556b5ebSBarry Smith 
4691b266c99SBarry Smith   Level: beginner
4708556b5ebSBarry Smith M*/
471d1232d7fSToby Isaac 
4728cc058d9SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerCreate_HDF5(PetscViewer v)
4735c6c1daeSBarry Smith {
4745c6c1daeSBarry Smith   PetscViewer_HDF5 *hdf5;
4755c6c1daeSBarry Smith   PetscErrorCode   ierr;
4765c6c1daeSBarry Smith 
4775c6c1daeSBarry Smith   PetscFunctionBegin;
478b00a9115SJed Brown   ierr = PetscNewLog(v,&hdf5);CHKERRQ(ierr);
4795c6c1daeSBarry Smith 
4805c6c1daeSBarry Smith   v->data                = (void*) hdf5;
4815c6c1daeSBarry Smith   v->ops->destroy        = PetscViewerDestroy_HDF5;
48282ea9b62SBarry Smith   v->ops->setfromoptions = PetscViewerSetFromOptions_HDF5;
483b723ab35SVaclav Hapla   v->ops->setup          = PetscViewerSetUp_HDF5;
4845c6c1daeSBarry Smith   v->ops->flush          = 0;
4855c6c1daeSBarry Smith   hdf5->btype            = (PetscFileMode) -1;
4865c6c1daeSBarry Smith   hdf5->filename         = 0;
4875c6c1daeSBarry Smith   hdf5->timestep         = -1;
4880298fd71SBarry Smith   hdf5->groups           = NULL;
4895c6c1daeSBarry Smith 
490b723ab35SVaclav Hapla   hdf5->mataij_iname     = NULL;
491b723ab35SVaclav Hapla   hdf5->mataij_jname     = NULL;
492b723ab35SVaclav Hapla   hdf5->mataij_aname     = NULL;
493b723ab35SVaclav Hapla   hdf5->mataij_cname     = NULL;
494b723ab35SVaclav Hapla   hdf5->mataij_names_set = PETSC_FALSE;
495058bd781SVaclav Hapla 
4960b062f91SJed Brown   ierr = PetscObjectComposeFunction((PetscObject)v,"PetscViewerFileSetName_C",PetscViewerFileSetName_HDF5);CHKERRQ(ierr);
497d1232d7fSToby Isaac   ierr = PetscObjectComposeFunction((PetscObject)v,"PetscViewerFileGetName_C",PetscViewerFileGetName_HDF5);CHKERRQ(ierr);
4980b062f91SJed Brown   ierr = PetscObjectComposeFunction((PetscObject)v,"PetscViewerFileSetMode_C",PetscViewerFileSetMode_HDF5);CHKERRQ(ierr);
4990b62783dSVaclav Hapla   ierr = PetscObjectComposeFunction((PetscObject)v,"PetscViewerFileGetMode_C",PetscViewerFileGetMode_HDF5);CHKERRQ(ierr);
50082ea9b62SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)v,"PetscViewerHDF5SetBaseDimension2_C",PetscViewerHDF5SetBaseDimension2_HDF5);CHKERRQ(ierr);
5019a0502c6SHåkon Strandenes   ierr = PetscObjectComposeFunction((PetscObject)v,"PetscViewerHDF5SetSPOutput_C",PetscViewerHDF5SetSPOutput_HDF5);CHKERRQ(ierr);
502058bd781SVaclav Hapla   ierr = PetscObjectComposeFunction((PetscObject)v,"PetscViewerHDF5SetAIJNames_C",PetscViewerHDF5SetAIJNames_HDF5);CHKERRQ(ierr);
503058bd781SVaclav Hapla   ierr = PetscObjectComposeFunction((PetscObject)v,"PetscViewerHDF5GetAIJNames_C",PetscViewerHDF5GetAIJNames_HDF5);CHKERRQ(ierr);
5045c6c1daeSBarry Smith   PetscFunctionReturn(0);
5055c6c1daeSBarry Smith }
5065c6c1daeSBarry Smith 
5075c6c1daeSBarry Smith /*@C
5085c6c1daeSBarry Smith    PetscViewerHDF5Open - Opens a file for HDF5 input/output.
5095c6c1daeSBarry Smith 
5105c6c1daeSBarry Smith    Collective on MPI_Comm
5115c6c1daeSBarry Smith 
5125c6c1daeSBarry Smith    Input Parameters:
5135c6c1daeSBarry Smith +  comm - MPI communicator
5145c6c1daeSBarry Smith .  name - name of file
5155c6c1daeSBarry Smith -  type - type of file
5165c6c1daeSBarry Smith $    FILE_MODE_WRITE - create new file for binary output
5175c6c1daeSBarry Smith $    FILE_MODE_READ - open existing file for binary input
5185c6c1daeSBarry Smith $    FILE_MODE_APPEND - open existing file for binary output
5195c6c1daeSBarry Smith 
5205c6c1daeSBarry Smith    Output Parameter:
5215c6c1daeSBarry Smith .  hdf5v - PetscViewer for HDF5 input/output to use with the specified file
5225c6c1daeSBarry Smith 
52382ea9b62SBarry Smith   Options Database:
52482ea9b62SBarry Smith .  -viewer_hdf5_base_dimension2 - turns on (true) or off (false) using a dimension of 2 in the HDF5 file even if the bs/dof of the vector is 1
5259a0502c6SHåkon Strandenes .  -viewer_hdf5_sp_output - forces (if true) the viewer to write data in single precision independent on the precision of PetscReal
52682ea9b62SBarry Smith 
5275c6c1daeSBarry Smith    Level: beginner
5285c6c1daeSBarry Smith 
5295c6c1daeSBarry Smith    Note:
5305c6c1daeSBarry Smith    This PetscViewer should be destroyed with PetscViewerDestroy().
5315c6c1daeSBarry Smith 
5325c6c1daeSBarry Smith    Concepts: HDF5 files
5335c6c1daeSBarry Smith    Concepts: PetscViewerHDF5^creating
5345c6c1daeSBarry Smith 
5356a9046bcSBarry Smith .seealso: PetscViewerASCIIOpen(), PetscViewerPushFormat(), PetscViewerDestroy(), PetscViewerHDF5SetBaseDimension2(),
5369a0502c6SHåkon Strandenes           PetscViewerHDF5SetSPOutput(), PetscViewerHDF5GetBaseDimension2(), VecView(), MatView(), VecLoad(),
537a56f64adSBarry Smith           MatLoad(), PetscFileMode, PetscViewer, PetscViewerSetType(), PetscViewerFileSetMode(), PetscViewerFileSetName()
5385c6c1daeSBarry Smith @*/
5395c6c1daeSBarry Smith PetscErrorCode  PetscViewerHDF5Open(MPI_Comm comm, const char name[], PetscFileMode type, PetscViewer *hdf5v)
5405c6c1daeSBarry Smith {
5415c6c1daeSBarry Smith   PetscErrorCode ierr;
5425c6c1daeSBarry Smith 
5435c6c1daeSBarry Smith   PetscFunctionBegin;
5445c6c1daeSBarry Smith   ierr = PetscViewerCreate(comm, hdf5v);CHKERRQ(ierr);
5455c6c1daeSBarry Smith   ierr = PetscViewerSetType(*hdf5v, PETSCVIEWERHDF5);CHKERRQ(ierr);
5465c6c1daeSBarry Smith   ierr = PetscViewerFileSetMode(*hdf5v, type);CHKERRQ(ierr);
5475c6c1daeSBarry Smith   ierr = PetscViewerFileSetName(*hdf5v, name);CHKERRQ(ierr);
5485c6c1daeSBarry Smith   PetscFunctionReturn(0);
5495c6c1daeSBarry Smith }
5505c6c1daeSBarry Smith 
5515c6c1daeSBarry Smith /*@C
5525c6c1daeSBarry Smith   PetscViewerHDF5GetFileId - Retrieve the file id, this file ID then can be used in direct HDF5 calls
5535c6c1daeSBarry Smith 
5545c6c1daeSBarry Smith   Not collective
5555c6c1daeSBarry Smith 
5565c6c1daeSBarry Smith   Input Parameter:
5575c6c1daeSBarry Smith . viewer - the PetscViewer
5585c6c1daeSBarry Smith 
5595c6c1daeSBarry Smith   Output Parameter:
5605c6c1daeSBarry Smith . file_id - The file id
5615c6c1daeSBarry Smith 
5625c6c1daeSBarry Smith   Level: intermediate
5635c6c1daeSBarry Smith 
5645c6c1daeSBarry Smith .seealso: PetscViewerHDF5Open()
5655c6c1daeSBarry Smith @*/
5665c6c1daeSBarry Smith PetscErrorCode  PetscViewerHDF5GetFileId(PetscViewer viewer, hid_t *file_id)
5675c6c1daeSBarry Smith {
5685c6c1daeSBarry Smith   PetscViewer_HDF5 *hdf5 = (PetscViewer_HDF5*) viewer->data;
5695c6c1daeSBarry Smith 
5705c6c1daeSBarry Smith   PetscFunctionBegin;
5715c6c1daeSBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
5725c6c1daeSBarry Smith   if (file_id) *file_id = hdf5->file_id;
5735c6c1daeSBarry Smith   PetscFunctionReturn(0);
5745c6c1daeSBarry Smith }
5755c6c1daeSBarry Smith 
5765c6c1daeSBarry Smith /*@C
5775c6c1daeSBarry Smith   PetscViewerHDF5PushGroup - Set the current HDF5 group for output
5785c6c1daeSBarry Smith 
5795c6c1daeSBarry Smith   Not collective
5805c6c1daeSBarry Smith 
5815c6c1daeSBarry Smith   Input Parameters:
5825c6c1daeSBarry Smith + viewer - the PetscViewer
5835c6c1daeSBarry Smith - name - The group name
5845c6c1daeSBarry Smith 
5855c6c1daeSBarry Smith   Level: intermediate
5865c6c1daeSBarry Smith 
587874270d9SVaclav Hapla .seealso: PetscViewerHDF5Open(),PetscViewerHDF5PopGroup(),PetscViewerHDF5GetGroup(),PetscViewerHDF5OpenGroup()
5885c6c1daeSBarry Smith @*/
5895c6c1daeSBarry Smith PetscErrorCode  PetscViewerHDF5PushGroup(PetscViewer viewer, const char *name)
5905c6c1daeSBarry Smith {
5915c6c1daeSBarry Smith   PetscViewer_HDF5 *hdf5 = (PetscViewer_HDF5*) viewer->data;
5925c6c1daeSBarry Smith   GroupList        *groupNode;
5935c6c1daeSBarry Smith   PetscErrorCode   ierr;
5945c6c1daeSBarry Smith 
5955c6c1daeSBarry Smith   PetscFunctionBegin;
5965c6c1daeSBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
5975c6c1daeSBarry Smith   PetscValidCharPointer(name,2);
59895dccacaSBarry Smith   ierr = PetscNew(&groupNode);CHKERRQ(ierr);
5995c6c1daeSBarry Smith   ierr = PetscStrallocpy(name, (char**) &groupNode->name);CHKERRQ(ierr);
600a297a907SKarl Rupp 
6015c6c1daeSBarry Smith   groupNode->next = hdf5->groups;
6025c6c1daeSBarry Smith   hdf5->groups    = groupNode;
6035c6c1daeSBarry Smith   PetscFunctionReturn(0);
6045c6c1daeSBarry Smith }
6055c6c1daeSBarry Smith 
6063ef9c667SSatish Balay /*@
6075c6c1daeSBarry Smith   PetscViewerHDF5PopGroup - Return the current HDF5 group for output to the previous value
6085c6c1daeSBarry Smith 
6095c6c1daeSBarry Smith   Not collective
6105c6c1daeSBarry Smith 
6115c6c1daeSBarry Smith   Input Parameter:
6125c6c1daeSBarry Smith . viewer - the PetscViewer
6135c6c1daeSBarry Smith 
6145c6c1daeSBarry Smith   Level: intermediate
6155c6c1daeSBarry Smith 
616874270d9SVaclav Hapla .seealso: PetscViewerHDF5Open(),PetscViewerHDF5PushGroup(),PetscViewerHDF5GetGroup(),PetscViewerHDF5OpenGroup()
6175c6c1daeSBarry Smith @*/
6185c6c1daeSBarry Smith PetscErrorCode  PetscViewerHDF5PopGroup(PetscViewer viewer)
6195c6c1daeSBarry Smith {
6205c6c1daeSBarry Smith   PetscViewer_HDF5 *hdf5 = (PetscViewer_HDF5*) viewer->data;
6215c6c1daeSBarry Smith   GroupList        *groupNode;
6225c6c1daeSBarry Smith   PetscErrorCode   ierr;
6235c6c1daeSBarry Smith 
6245c6c1daeSBarry Smith   PetscFunctionBegin;
6255c6c1daeSBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
62682f516ccSBarry Smith   if (!hdf5->groups) SETERRQ(PetscObjectComm((PetscObject)viewer), PETSC_ERR_ARG_WRONGSTATE, "HDF5 group stack is empty, cannot pop");
6275c6c1daeSBarry Smith   groupNode    = hdf5->groups;
6285c6c1daeSBarry Smith   hdf5->groups = hdf5->groups->next;
6295c6c1daeSBarry Smith   ierr         = PetscFree(groupNode->name);CHKERRQ(ierr);
6305c6c1daeSBarry Smith   ierr         = PetscFree(groupNode);CHKERRQ(ierr);
6315c6c1daeSBarry Smith   PetscFunctionReturn(0);
6325c6c1daeSBarry Smith }
6335c6c1daeSBarry Smith 
6345c6c1daeSBarry Smith /*@C
635874270d9SVaclav Hapla   PetscViewerHDF5GetGroup - Get the current HDF5 group name (full path), set with PetscViewerHDF5PushGroup()/PetscViewerHDF5PopGroup().
636874270d9SVaclav Hapla   If none has been assigned, returns NULL.
6375c6c1daeSBarry Smith 
6385c6c1daeSBarry Smith   Not collective
6395c6c1daeSBarry Smith 
6405c6c1daeSBarry Smith   Input Parameter:
6415c6c1daeSBarry Smith . viewer - the PetscViewer
6425c6c1daeSBarry Smith 
6435c6c1daeSBarry Smith   Output Parameter:
6445c6c1daeSBarry Smith . name - The group name
6455c6c1daeSBarry Smith 
6465c6c1daeSBarry Smith   Level: intermediate
6475c6c1daeSBarry Smith 
648874270d9SVaclav Hapla .seealso: PetscViewerHDF5Open(),PetscViewerHDF5PushGroup(),PetscViewerHDF5PopGroup(),PetscViewerHDF5OpenGroup()
6495c6c1daeSBarry Smith @*/
6505c6c1daeSBarry Smith PetscErrorCode  PetscViewerHDF5GetGroup(PetscViewer viewer, const char **name)
6515c6c1daeSBarry Smith {
6525c6c1daeSBarry Smith   PetscViewer_HDF5 *hdf5 = (PetscViewer_HDF5 *) viewer->data;
6535c6c1daeSBarry Smith 
6545c6c1daeSBarry Smith   PetscFunctionBegin;
6555c6c1daeSBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
656c959eef4SJed Brown   PetscValidPointer(name,2);
657a297a907SKarl Rupp   if (hdf5->groups) *name = hdf5->groups->name;
6580298fd71SBarry Smith   else *name = NULL;
6595c6c1daeSBarry Smith   PetscFunctionReturn(0);
6605c6c1daeSBarry Smith }
6615c6c1daeSBarry Smith 
6628c557b5aSVaclav Hapla /*@
663874270d9SVaclav Hapla   PetscViewerHDF5OpenGroup - Open the HDF5 group with the name (full path) returned by PetscViewerHDF5GetGroup(),
664874270d9SVaclav Hapla   and return this group's ID and file ID.
665874270d9SVaclav Hapla   If PetscViewerHDF5GetGroup() yields NULL, then group ID is file ID.
666874270d9SVaclav Hapla 
667874270d9SVaclav Hapla   Not collective
668874270d9SVaclav Hapla 
669874270d9SVaclav Hapla   Input Parameter:
670874270d9SVaclav Hapla . viewer - the PetscViewer
671874270d9SVaclav Hapla 
672874270d9SVaclav Hapla   Output Parameter:
673874270d9SVaclav Hapla + fileId - The HDF5 file ID
674874270d9SVaclav Hapla - groupId - The HDF5 group ID
675874270d9SVaclav Hapla 
676e74616beSVaclav Hapla   Notes:
677e74616beSVaclav Hapla   If the viewer is writable, the group is created if it doesn't exist yet.
678e74616beSVaclav Hapla 
679874270d9SVaclav Hapla   Level: intermediate
680874270d9SVaclav Hapla 
681874270d9SVaclav Hapla .seealso: PetscViewerHDF5Open(),PetscViewerHDF5PushGroup(),PetscViewerHDF5PopGroup(),PetscViewerHDF5GetGroup()
682874270d9SVaclav Hapla @*/
68354dbf706SVaclav Hapla PetscErrorCode PetscViewerHDF5OpenGroup(PetscViewer viewer, hid_t *fileId, hid_t *groupId)
68454dbf706SVaclav Hapla {
68590e03537SVaclav Hapla   hid_t          file_id;
68690e03537SVaclav Hapla   H5O_type_t     type;
68754dbf706SVaclav Hapla   const char     *groupName = NULL;
688e74616beSVaclav Hapla   PetscBool      create;
68954dbf706SVaclav Hapla   PetscErrorCode ierr;
69054dbf706SVaclav Hapla 
69154dbf706SVaclav Hapla   PetscFunctionBegin;
692e74616beSVaclav Hapla   ierr = PetscViewerWritable(viewer, &create);CHKERRQ(ierr);
69354dbf706SVaclav Hapla   ierr = PetscViewerHDF5GetFileId(viewer, &file_id);CHKERRQ(ierr);
69454dbf706SVaclav Hapla   ierr = PetscViewerHDF5GetGroup(viewer, &groupName);CHKERRQ(ierr);
695e74616beSVaclav Hapla   ierr = PetscViewerHDF5Traverse_Internal(viewer, groupName, create, NULL, &type);CHKERRQ(ierr);
69690e03537SVaclav Hapla   if (type != H5O_TYPE_GROUP) SETERRQ1(PetscObjectComm((PetscObject)viewer), PETSC_ERR_FILE_UNEXPECTED, "Path %s resolves to something which is not a group", groupName);
69790e03537SVaclav Hapla   PetscStackCallHDF5Return(*groupId,H5Gopen2,(file_id, groupName ? groupName : "/", H5P_DEFAULT));
69854dbf706SVaclav Hapla   *fileId  = file_id;
69954dbf706SVaclav Hapla   PetscFunctionReturn(0);
70054dbf706SVaclav Hapla }
70154dbf706SVaclav Hapla 
7023ef9c667SSatish Balay /*@
7035c6c1daeSBarry Smith   PetscViewerHDF5IncrementTimestep - Increments the current timestep for the HDF5 output. Fields are stacked in time.
7045c6c1daeSBarry Smith 
7055c6c1daeSBarry Smith   Not collective
7065c6c1daeSBarry Smith 
7075c6c1daeSBarry Smith   Input Parameter:
7085c6c1daeSBarry Smith . viewer - the PetscViewer
7095c6c1daeSBarry Smith 
7105c6c1daeSBarry Smith   Level: intermediate
7115c6c1daeSBarry Smith 
7125c6c1daeSBarry Smith .seealso: PetscViewerHDF5Open(), PetscViewerHDF5SetTimestep(), PetscViewerHDF5GetTimestep()
7135c6c1daeSBarry Smith @*/
7145c6c1daeSBarry Smith PetscErrorCode PetscViewerHDF5IncrementTimestep(PetscViewer viewer)
7155c6c1daeSBarry Smith {
7165c6c1daeSBarry Smith   PetscViewer_HDF5 *hdf5 = (PetscViewer_HDF5*) viewer->data;
7175c6c1daeSBarry Smith 
7185c6c1daeSBarry Smith   PetscFunctionBegin;
7195c6c1daeSBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
7205c6c1daeSBarry Smith   ++hdf5->timestep;
7215c6c1daeSBarry Smith   PetscFunctionReturn(0);
7225c6c1daeSBarry Smith }
7235c6c1daeSBarry Smith 
7243ef9c667SSatish Balay /*@
7255c6c1daeSBarry Smith   PetscViewerHDF5SetTimestep - Set the current timestep for the HDF5 output. Fields are stacked in time. A timestep
7265c6c1daeSBarry Smith   of -1 disables blocking with timesteps.
7275c6c1daeSBarry Smith 
7285c6c1daeSBarry Smith   Not collective
7295c6c1daeSBarry Smith 
7305c6c1daeSBarry Smith   Input Parameters:
7315c6c1daeSBarry Smith + viewer - the PetscViewer
7325c6c1daeSBarry Smith - timestep - The timestep number
7335c6c1daeSBarry Smith 
7345c6c1daeSBarry Smith   Level: intermediate
7355c6c1daeSBarry Smith 
7365c6c1daeSBarry Smith .seealso: PetscViewerHDF5Open(), PetscViewerHDF5IncrementTimestep(), PetscViewerHDF5GetTimestep()
7375c6c1daeSBarry Smith @*/
7385c6c1daeSBarry Smith PetscErrorCode  PetscViewerHDF5SetTimestep(PetscViewer viewer, PetscInt timestep)
7395c6c1daeSBarry Smith {
7405c6c1daeSBarry Smith   PetscViewer_HDF5 *hdf5 = (PetscViewer_HDF5*) viewer->data;
7415c6c1daeSBarry Smith 
7425c6c1daeSBarry Smith   PetscFunctionBegin;
7435c6c1daeSBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
7445c6c1daeSBarry Smith   hdf5->timestep = timestep;
7455c6c1daeSBarry Smith   PetscFunctionReturn(0);
7465c6c1daeSBarry Smith }
7475c6c1daeSBarry Smith 
7483ef9c667SSatish Balay /*@
7495c6c1daeSBarry Smith   PetscViewerHDF5GetTimestep - Get the current timestep for the HDF5 output. Fields are stacked in time.
7505c6c1daeSBarry Smith 
7515c6c1daeSBarry Smith   Not collective
7525c6c1daeSBarry Smith 
7535c6c1daeSBarry Smith   Input Parameter:
7545c6c1daeSBarry Smith . viewer - the PetscViewer
7555c6c1daeSBarry Smith 
7565c6c1daeSBarry Smith   Output Parameter:
7575c6c1daeSBarry Smith . timestep - The timestep number
7585c6c1daeSBarry Smith 
7595c6c1daeSBarry Smith   Level: intermediate
7605c6c1daeSBarry Smith 
7615c6c1daeSBarry Smith .seealso: PetscViewerHDF5Open(), PetscViewerHDF5IncrementTimestep(), PetscViewerHDF5SetTimestep()
7625c6c1daeSBarry Smith @*/
7635c6c1daeSBarry Smith PetscErrorCode  PetscViewerHDF5GetTimestep(PetscViewer viewer, PetscInt *timestep)
7645c6c1daeSBarry Smith {
7655c6c1daeSBarry Smith   PetscViewer_HDF5 *hdf5 = (PetscViewer_HDF5*) viewer->data;
7665c6c1daeSBarry Smith 
7675c6c1daeSBarry Smith   PetscFunctionBegin;
7685c6c1daeSBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
7695c6c1daeSBarry Smith   PetscValidPointer(timestep,2);
7705c6c1daeSBarry Smith   *timestep = hdf5->timestep;
7715c6c1daeSBarry Smith   PetscFunctionReturn(0);
7725c6c1daeSBarry Smith }
7735c6c1daeSBarry Smith 
77436bce6e8SMatthew G. Knepley /*@C
77536bce6e8SMatthew G. Knepley   PetscDataTypeToHDF5DataType - Converts the PETSc name of a datatype to its HDF5 name.
77636bce6e8SMatthew G. Knepley 
77736bce6e8SMatthew G. Knepley   Not collective
77836bce6e8SMatthew G. Knepley 
77936bce6e8SMatthew G. Knepley   Input Parameter:
78036bce6e8SMatthew G. Knepley . ptype - the PETSc datatype name (for example PETSC_DOUBLE)
78136bce6e8SMatthew G. Knepley 
78236bce6e8SMatthew G. Knepley   Output Parameter:
78336bce6e8SMatthew G. Knepley . mtype - the MPI datatype (for example MPI_DOUBLE, ...)
78436bce6e8SMatthew G. Knepley 
78536bce6e8SMatthew G. Knepley   Level: advanced
78636bce6e8SMatthew G. Knepley 
78736bce6e8SMatthew G. Knepley .seealso: PetscDataType, PetscHDF5DataTypeToPetscDataType()
78836bce6e8SMatthew G. Knepley @*/
78936bce6e8SMatthew G. Knepley PetscErrorCode PetscDataTypeToHDF5DataType(PetscDataType ptype, hid_t *htype)
79036bce6e8SMatthew G. Knepley {
79136bce6e8SMatthew G. Knepley   PetscFunctionBegin;
79236bce6e8SMatthew G. Knepley   if (ptype == PETSC_INT)
79336bce6e8SMatthew G. Knepley #if defined(PETSC_USE_64BIT_INDICES)
79436bce6e8SMatthew G. Knepley                                        *htype = H5T_NATIVE_LLONG;
79536bce6e8SMatthew G. Knepley #else
79636bce6e8SMatthew G. Knepley                                        *htype = H5T_NATIVE_INT;
79736bce6e8SMatthew G. Knepley #endif
79836bce6e8SMatthew G. Knepley   else if (ptype == PETSC_DOUBLE)      *htype = H5T_NATIVE_DOUBLE;
79936bce6e8SMatthew G. Knepley   else if (ptype == PETSC_LONG)        *htype = H5T_NATIVE_LONG;
80036bce6e8SMatthew G. Knepley   else if (ptype == PETSC_SHORT)       *htype = H5T_NATIVE_SHORT;
80136bce6e8SMatthew G. Knepley   else if (ptype == PETSC_ENUM)        *htype = H5T_NATIVE_DOUBLE;
802de3ba262SVaclav Hapla   else if (ptype == PETSC_BOOL)        *htype = H5T_NATIVE_INT;
80336bce6e8SMatthew G. Knepley   else if (ptype == PETSC_FLOAT)       *htype = H5T_NATIVE_FLOAT;
80436bce6e8SMatthew G. Knepley   else if (ptype == PETSC_CHAR)        *htype = H5T_NATIVE_CHAR;
80536bce6e8SMatthew G. Knepley   else if (ptype == PETSC_BIT_LOGICAL) *htype = H5T_NATIVE_UCHAR;
8067e97c476SMatthew G. Knepley   else if (ptype == PETSC_STRING)      *htype = H5Tcopy(H5T_C_S1);
80736bce6e8SMatthew G. Knepley   else SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Unsupported PETSc datatype");
80836bce6e8SMatthew G. Knepley   PetscFunctionReturn(0);
80936bce6e8SMatthew G. Knepley }
81036bce6e8SMatthew G. Knepley 
81136bce6e8SMatthew G. Knepley /*@C
81236bce6e8SMatthew G. Knepley   PetscHDF5DataTypeToPetscDataType - Finds the PETSc name of a datatype from its HDF5 name
81336bce6e8SMatthew G. Knepley 
81436bce6e8SMatthew G. Knepley   Not collective
81536bce6e8SMatthew G. Knepley 
81636bce6e8SMatthew G. Knepley   Input Parameter:
81736bce6e8SMatthew G. Knepley . htype - the HDF5 datatype (for example H5T_NATIVE_DOUBLE, ...)
81836bce6e8SMatthew G. Knepley 
81936bce6e8SMatthew G. Knepley   Output Parameter:
82036bce6e8SMatthew G. Knepley . ptype - the PETSc datatype name (for example PETSC_DOUBLE)
82136bce6e8SMatthew G. Knepley 
82236bce6e8SMatthew G. Knepley   Level: advanced
82336bce6e8SMatthew G. Knepley 
82436bce6e8SMatthew G. Knepley .seealso: PetscDataType, PetscHDF5DataTypeToPetscDataType()
82536bce6e8SMatthew G. Knepley @*/
82636bce6e8SMatthew G. Knepley PetscErrorCode PetscHDF5DataTypeToPetscDataType(hid_t htype, PetscDataType *ptype)
82736bce6e8SMatthew G. Knepley {
82836bce6e8SMatthew G. Knepley   PetscFunctionBegin;
82936bce6e8SMatthew G. Knepley #if defined(PETSC_USE_64BIT_INDICES)
83036bce6e8SMatthew G. Knepley   if      (htype == H5T_NATIVE_INT)    *ptype = PETSC_LONG;
83136bce6e8SMatthew G. Knepley   else if (htype == H5T_NATIVE_LLONG)  *ptype = PETSC_INT;
83236bce6e8SMatthew G. Knepley #else
83336bce6e8SMatthew G. Knepley   if      (htype == H5T_NATIVE_INT)    *ptype = PETSC_INT;
83436bce6e8SMatthew G. Knepley #endif
83536bce6e8SMatthew G. Knepley   else if (htype == H5T_NATIVE_DOUBLE) *ptype = PETSC_DOUBLE;
83636bce6e8SMatthew G. Knepley   else if (htype == H5T_NATIVE_LONG)   *ptype = PETSC_LONG;
83736bce6e8SMatthew G. Knepley   else if (htype == H5T_NATIVE_SHORT)  *ptype = PETSC_SHORT;
83836bce6e8SMatthew G. Knepley   else if (htype == H5T_NATIVE_FLOAT)  *ptype = PETSC_FLOAT;
83936bce6e8SMatthew G. Knepley   else if (htype == H5T_NATIVE_CHAR)   *ptype = PETSC_CHAR;
84036bce6e8SMatthew G. Knepley   else if (htype == H5T_NATIVE_UCHAR)  *ptype = PETSC_CHAR;
8417e97c476SMatthew G. Knepley   else if (htype == H5T_C_S1)          *ptype = PETSC_STRING;
84236bce6e8SMatthew G. Knepley   else SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Unsupported HDF5 datatype");
84336bce6e8SMatthew G. Knepley   PetscFunctionReturn(0);
84436bce6e8SMatthew G. Knepley }
84536bce6e8SMatthew G. Knepley 
846df863907SAlex Fikl /*@C
847b8ee85a1SVaclav Hapla  PetscViewerHDF5WriteAttribute - Write an attribute
84836bce6e8SMatthew G. Knepley 
84936bce6e8SMatthew G. Knepley   Input Parameters:
85036bce6e8SMatthew G. Knepley + viewer - The HDF5 viewer
85157d22f7dSVaclav Hapla . dataset - The parent dataset name, relative to the current group. NULL means a group-wise attribute.
85236bce6e8SMatthew G. Knepley . name   - The attribute name
85336bce6e8SMatthew G. Knepley . datatype - The attribute type
85436bce6e8SMatthew G. Knepley - value    - The attribute value
85536bce6e8SMatthew G. Knepley 
85636bce6e8SMatthew G. Knepley   Level: advanced
85736bce6e8SMatthew G. Knepley 
858577e0e04SVaclav Hapla .seealso: PetscViewerHDF5Open(), PetscViewerHDF5WriteObjectAttribute(), PetscViewerHDF5ReadAttribute(), PetscViewerHDF5HasAttribute(), PetscViewerHDF5PushGroup(),PetscViewerHDF5PopGroup(),PetscViewerHDF5GetGroup()
85936bce6e8SMatthew G. Knepley @*/
86057d22f7dSVaclav Hapla PetscErrorCode PetscViewerHDF5WriteAttribute(PetscViewer viewer, const char dataset[], const char name[], PetscDataType datatype, const void *value)
86136bce6e8SMatthew G. Knepley {
86257d22f7dSVaclav Hapla   char           *parent;
86360568592SMatthew G. Knepley   hid_t          h5, dataspace, obj, attribute, dtype;
864080f144cSVaclav Hapla   PetscBool      has;
86536bce6e8SMatthew G. Knepley   PetscErrorCode ierr;
86636bce6e8SMatthew G. Knepley 
86736bce6e8SMatthew G. Knepley   PetscFunctionBegin;
8685cdeb108SMatthew G. Knepley   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
86957d22f7dSVaclav Hapla   if (dataset) PetscValidCharPointer(dataset, 2);
870c57a1a9aSVaclav Hapla   PetscValidCharPointer(name, 3);
871b7e81f0fSVaclav Hapla   PetscValidPointer(value, 5);
87257d22f7dSVaclav Hapla   ierr = PetscViewerHDF5GetAbsolutePath_Internal(viewer, dataset, &parent);CHKERRQ(ierr);
873bb286ee1SVaclav Hapla   ierr = PetscViewerHDF5Traverse_Internal(viewer, parent, PETSC_TRUE, NULL, NULL);CHKERRQ(ierr);
874b67695ecSVaclav Hapla   ierr = PetscViewerHDF5HasAttribute_Internal(viewer, parent, name, &has);CHKERRQ(ierr);
87536bce6e8SMatthew G. Knepley   ierr = PetscDataTypeToHDF5DataType(datatype, &dtype);CHKERRQ(ierr);
8767e97c476SMatthew G. Knepley   if (datatype == PETSC_STRING) {
8777e97c476SMatthew G. Knepley     size_t len;
8787e97c476SMatthew G. Knepley     ierr = PetscStrlen((const char *) value, &len);CHKERRQ(ierr);
879729ab6d9SBarry Smith     PetscStackCallHDF5(H5Tset_size,(dtype, len+1));
8807e97c476SMatthew G. Knepley   }
88136bce6e8SMatthew G. Knepley   ierr = PetscViewerHDF5GetFileId(viewer, &h5);CHKERRQ(ierr);
882729ab6d9SBarry Smith   PetscStackCallHDF5Return(dataspace,H5Screate,(H5S_SCALAR));
88360568592SMatthew G. Knepley   PetscStackCallHDF5Return(obj,H5Oopen,(h5, parent, H5P_DEFAULT));
884080f144cSVaclav Hapla   if (has) {
885080f144cSVaclav Hapla     PetscStackCallHDF5Return(attribute,H5Aopen_name,(obj, name));
886080f144cSVaclav Hapla   } else {
88760568592SMatthew G. Knepley     PetscStackCallHDF5Return(attribute,H5Acreate2,(obj, name, dtype, dataspace, H5P_DEFAULT, H5P_DEFAULT));
888080f144cSVaclav Hapla   }
889729ab6d9SBarry Smith   PetscStackCallHDF5(H5Awrite,(attribute, dtype, value));
890729ab6d9SBarry Smith   if (datatype == PETSC_STRING) PetscStackCallHDF5(H5Tclose,(dtype));
891729ab6d9SBarry Smith   PetscStackCallHDF5(H5Aclose,(attribute));
89260568592SMatthew G. Knepley   PetscStackCallHDF5(H5Oclose,(obj));
893729ab6d9SBarry Smith   PetscStackCallHDF5(H5Sclose,(dataspace));
89457d22f7dSVaclav Hapla   ierr = PetscFree(parent);CHKERRQ(ierr);
89536bce6e8SMatthew G. Knepley   PetscFunctionReturn(0);
89636bce6e8SMatthew G. Knepley }
89736bce6e8SMatthew G. Knepley 
898df863907SAlex Fikl /*@C
899577e0e04SVaclav Hapla  PetscViewerHDF5WriteObjectAttribute - Write an attribute to the dataset matching the given PetscObject by name
900577e0e04SVaclav Hapla 
901577e0e04SVaclav Hapla   Input Parameters:
902577e0e04SVaclav Hapla + viewer   - The HDF5 viewer
903577e0e04SVaclav Hapla . obj      - The object whose name is used to lookup the parent dataset, relative to the current group.
904577e0e04SVaclav Hapla . name     - The attribute name
905577e0e04SVaclav Hapla . datatype - The attribute type
906577e0e04SVaclav Hapla - value    - The attribute value
907577e0e04SVaclav Hapla 
908577e0e04SVaclav Hapla   Notes:
909577e0e04SVaclav Hapla   This fails if current_group/object_name doesn't resolve to a dataset (the path doesn't exist or is not a dataset).
910577e0e04SVaclav Hapla   You might want to check first if it does using PetscViewerHDF5HasObject().
911577e0e04SVaclav Hapla 
912577e0e04SVaclav Hapla   Level: advanced
913577e0e04SVaclav Hapla 
914577e0e04SVaclav Hapla .seealso: PetscViewerHDF5Open(), PetscViewerHDF5WriteAttribute(), PetscViewerHDF5ReadObjectAttribute(), PetscViewerHDF5HasObjectAttribute(), PetscViewerHDF5HasObject(), PetscViewerHDF5PushGroup(),PetscViewerHDF5PopGroup(),PetscViewerHDF5GetGroup()
915577e0e04SVaclav Hapla @*/
916577e0e04SVaclav Hapla PetscErrorCode PetscViewerHDF5WriteObjectAttribute(PetscViewer viewer, PetscObject obj, const char name[], PetscDataType datatype, const void *value)
917577e0e04SVaclav Hapla {
918577e0e04SVaclav Hapla   PetscErrorCode ierr;
919577e0e04SVaclav Hapla 
920577e0e04SVaclav Hapla   PetscFunctionBegin;
921577e0e04SVaclav Hapla   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
922577e0e04SVaclav Hapla   PetscValidHeader(obj,2);
923577e0e04SVaclav Hapla   PetscValidCharPointer(name,3);
924b7e81f0fSVaclav Hapla   PetscValidPointer(value,5);
925577e0e04SVaclav Hapla   ierr = PetscViewerHDF5CheckNamedObject_Internal(viewer, obj);CHKERRQ(ierr);
926577e0e04SVaclav Hapla   ierr = PetscViewerHDF5WriteAttribute(viewer, obj->name, name, datatype, value);CHKERRQ(ierr);
927577e0e04SVaclav Hapla   PetscFunctionReturn(0);
928577e0e04SVaclav Hapla }
929577e0e04SVaclav Hapla 
930577e0e04SVaclav Hapla /*@C
931b8ee85a1SVaclav Hapla  PetscViewerHDF5ReadAttribute - Read an attribute
932ad0c61feSMatthew G. Knepley 
933ad0c61feSMatthew G. Knepley   Input Parameters:
934ad0c61feSMatthew G. Knepley + viewer - The HDF5 viewer
93557d22f7dSVaclav Hapla . dataset - The parent dataset name, relative to the current group. NULL means a group-wise attribute.
936ad0c61feSMatthew G. Knepley . name   - The attribute name
937ad0c61feSMatthew G. Knepley - datatype - The attribute type
938ad0c61feSMatthew G. Knepley 
939ad0c61feSMatthew G. Knepley   Output Parameter:
940ad0c61feSMatthew G. Knepley . value    - The attribute value
941ad0c61feSMatthew G. Knepley 
942ad0c61feSMatthew G. Knepley   Level: advanced
943ad0c61feSMatthew G. Knepley 
944577e0e04SVaclav Hapla .seealso: PetscViewerHDF5Open(), PetscViewerHDF5ReadObjectAttribute(), PetscViewerHDF5WriteAttribute(), PetscViewerHDF5HasAttribute(), PetscViewerHDF5HasObject(), PetscViewerHDF5PushGroup(),PetscViewerHDF5PopGroup(),PetscViewerHDF5GetGroup()
945ad0c61feSMatthew G. Knepley @*/
94657d22f7dSVaclav Hapla PetscErrorCode PetscViewerHDF5ReadAttribute(PetscViewer viewer, const char dataset[], const char name[], PetscDataType datatype, void *value)
947ad0c61feSMatthew G. Knepley {
94857d22f7dSVaclav Hapla   char           *parent;
949f0b58479SMatthew G. Knepley   hid_t          h5, obj, attribute, atype, dtype;
950969748fdSVaclav Hapla   PetscBool      has;
951ad0c61feSMatthew G. Knepley   PetscErrorCode ierr;
952ad0c61feSMatthew G. Knepley 
953ad0c61feSMatthew G. Knepley   PetscFunctionBegin;
9545cdeb108SMatthew G. Knepley   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
95557d22f7dSVaclav Hapla   if (dataset) PetscValidCharPointer(dataset, 2);
956c57a1a9aSVaclav Hapla   PetscValidCharPointer(name, 3);
957b7e81f0fSVaclav Hapla   PetscValidPointer(value, 5);
95857d22f7dSVaclav Hapla   ierr = PetscViewerHDF5GetAbsolutePath_Internal(viewer, dataset, &parent);CHKERRQ(ierr);
959969748fdSVaclav Hapla   ierr = PetscViewerHDF5Traverse_Internal(viewer, parent, PETSC_FALSE, &has, NULL);CHKERRQ(ierr);
960969748fdSVaclav Hapla   if (has) {ierr = PetscViewerHDF5HasAttribute_Internal(viewer, parent, name, &has);CHKERRQ(ierr);}
961969748fdSVaclav Hapla   if (!has) SETERRQ2(PetscObjectComm((PetscObject)viewer), PETSC_ERR_FILE_UNEXPECTED, "Attribute %s/%s does not exist", parent, name);
962ad0c61feSMatthew G. Knepley   ierr = PetscDataTypeToHDF5DataType(datatype, &dtype);CHKERRQ(ierr);
963ad0c61feSMatthew G. Knepley   ierr = PetscViewerHDF5GetFileId(viewer, &h5);CHKERRQ(ierr);
96460568592SMatthew G. Knepley   PetscStackCallHDF5Return(obj,H5Oopen,(h5, parent, H5P_DEFAULT));
96560568592SMatthew G. Knepley   PetscStackCallHDF5Return(attribute,H5Aopen_name,(obj, name));
966f0b58479SMatthew G. Knepley   if (datatype == PETSC_STRING) {
967f0b58479SMatthew G. Knepley     size_t len;
968e90c5075SMarek Pecha     PetscStackCallHDF5Return(atype,H5Aget_type,(attribute));
96915b861d2SVaclav Hapla     PetscStackCall("H5Tget_size",len = H5Tget_size(atype));
970f0b58479SMatthew G. Knepley     PetscStackCallHDF5(H5Tclose,(atype));
971f0b58479SMatthew G. Knepley     ierr = PetscMalloc((len+1) * sizeof(char *), &value);CHKERRQ(ierr);
972f0b58479SMatthew G. Knepley   }
97370efba33SBarry Smith   PetscStackCallHDF5(H5Aread,(attribute, dtype, value));
974729ab6d9SBarry Smith   PetscStackCallHDF5(H5Aclose,(attribute));
975e90c5075SMarek Pecha   /* H5Oclose can be used to close groups, datasets, or committed datatypes */
976e90c5075SMarek Pecha   PetscStackCallHDF5(H5Oclose,(obj));
97757d22f7dSVaclav Hapla   ierr = PetscFree(parent);CHKERRQ(ierr);
978ad0c61feSMatthew G. Knepley   PetscFunctionReturn(0);
979ad0c61feSMatthew G. Knepley }
980ad0c61feSMatthew G. Knepley 
981577e0e04SVaclav Hapla /*@C
982577e0e04SVaclav Hapla  PetscViewerHDF5ReadObjectAttribute - Read an attribute from the dataset matching the given PetscObject by name
983577e0e04SVaclav Hapla 
984577e0e04SVaclav Hapla   Input Parameters:
985577e0e04SVaclav Hapla + viewer   - The HDF5 viewer
986577e0e04SVaclav Hapla . obj      - The object whose name is used to lookup the parent dataset, relative to the current group.
987577e0e04SVaclav Hapla . name     - The attribute name
988577e0e04SVaclav Hapla - datatype - The attribute type
989577e0e04SVaclav Hapla 
990577e0e04SVaclav Hapla   Output Parameter:
991577e0e04SVaclav Hapla . value    - The attribute value
992577e0e04SVaclav Hapla 
993577e0e04SVaclav Hapla   Notes:
994577e0e04SVaclav Hapla   This fails if current_group/object_name doesn't resolve to a dataset (the path doesn't exist or is not a dataset).
995577e0e04SVaclav Hapla   You might want to check first if it does using PetscViewerHDF5HasObject().
996577e0e04SVaclav Hapla 
997577e0e04SVaclav Hapla   Level: advanced
998577e0e04SVaclav Hapla 
999577e0e04SVaclav Hapla .seealso: PetscViewerHDF5Open(), PetscViewerHDF5ReadAttribute() PetscViewerHDF5WriteObjectAttribute(), PetscViewerHDF5HasObjectAttribute(), PetscViewerHDF5PushGroup(),PetscViewerHDF5PopGroup(),PetscViewerHDF5GetGroup()
1000577e0e04SVaclav Hapla @*/
1001577e0e04SVaclav Hapla PetscErrorCode PetscViewerHDF5ReadObjectAttribute(PetscViewer viewer, PetscObject obj, const char name[], PetscDataType datatype, void *value)
1002577e0e04SVaclav Hapla {
1003577e0e04SVaclav Hapla   PetscErrorCode ierr;
1004577e0e04SVaclav Hapla 
1005577e0e04SVaclav Hapla   PetscFunctionBegin;
1006577e0e04SVaclav Hapla   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
1007577e0e04SVaclav Hapla   PetscValidHeader(obj,2);
1008577e0e04SVaclav Hapla   PetscValidCharPointer(name,3);
1009b7e81f0fSVaclav Hapla   PetscValidPointer(value, 5);
1010577e0e04SVaclav Hapla   ierr = PetscViewerHDF5CheckNamedObject_Internal(viewer, obj);CHKERRQ(ierr);
1011577e0e04SVaclav Hapla   ierr = PetscViewerHDF5ReadAttribute(viewer, obj->name, name, datatype, value);CHKERRQ(ierr);
1012577e0e04SVaclav Hapla   PetscFunctionReturn(0);
1013577e0e04SVaclav Hapla }
1014577e0e04SVaclav Hapla 
1015a75c3fd4SVaclav Hapla PETSC_STATIC_INLINE PetscErrorCode PetscViewerHDF5Traverse_Inner_Internal(hid_t h5, const char name[], PetscBool createGroup, PetscBool *exists_)
1016a75c3fd4SVaclav Hapla {
1017a75c3fd4SVaclav Hapla   htri_t exists;
1018a75c3fd4SVaclav Hapla   hid_t group;
1019a75c3fd4SVaclav Hapla 
1020a75c3fd4SVaclav Hapla   PetscFunctionBegin;
1021a75c3fd4SVaclav Hapla   PetscStackCallHDF5Return(exists,H5Lexists,(h5, name, H5P_DEFAULT));
1022a75c3fd4SVaclav Hapla   if (exists) PetscStackCallHDF5Return(exists,H5Oexists_by_name,(h5, name, H5P_DEFAULT));
1023a75c3fd4SVaclav Hapla   if (!exists && createGroup) {
1024a75c3fd4SVaclav Hapla     PetscStackCallHDF5Return(group,H5Gcreate2,(h5, name, H5P_DEFAULT, H5P_DEFAULT, H5P_DEFAULT));
1025a75c3fd4SVaclav Hapla     PetscStackCallHDF5(H5Gclose,(group));
1026a75c3fd4SVaclav Hapla     exists = PETSC_TRUE;
1027a75c3fd4SVaclav Hapla   }
1028a75c3fd4SVaclav Hapla   *exists_ = (PetscBool) exists;
1029a75c3fd4SVaclav Hapla   PetscFunctionReturn(0);
1030a75c3fd4SVaclav Hapla }
1031a75c3fd4SVaclav Hapla 
1032bb286ee1SVaclav Hapla static PetscErrorCode PetscViewerHDF5Traverse_Internal(PetscViewer viewer, const char name[], PetscBool createGroup, PetscBool *has, H5O_type_t *otype)
10335cdeb108SMatthew G. Knepley {
103490e03537SVaclav Hapla   const char     rootGroupName[] = "/";
10355cdeb108SMatthew G. Knepley   hid_t          h5;
1036e5bf9ebcSVaclav Hapla   PetscBool      exists=PETSC_FALSE;
103715b861d2SVaclav Hapla   PetscInt       i;
103815b861d2SVaclav Hapla   int            n;
103985688ae2SVaclav Hapla   char           **hierarchy;
104085688ae2SVaclav Hapla   char           buf[PETSC_MAX_PATH_LEN]="";
10415cdeb108SMatthew G. Knepley   PetscErrorCode ierr;
10425cdeb108SMatthew G. Knepley 
10435cdeb108SMatthew G. Knepley   PetscFunctionBegin;
10445cdeb108SMatthew G. Knepley   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
104590e03537SVaclav Hapla   if (name) PetscValidCharPointer(name, 2);
104690e03537SVaclav Hapla   else name = rootGroupName;
1047ccd66a83SVaclav Hapla   if (has) {
104856cc0592SVaclav Hapla     PetscValidIntPointer(has, 3);
10495cdeb108SMatthew G. Knepley     *has = PETSC_FALSE;
1050ccd66a83SVaclav Hapla   }
1051ccd66a83SVaclav Hapla   if (otype) {
1052ccd66a83SVaclav Hapla     PetscValidIntPointer(otype, 4);
105356cc0592SVaclav Hapla     *otype = H5O_TYPE_UNKNOWN;
1054ccd66a83SVaclav Hapla   }
1055c0cd0301SJed Brown   ierr = PetscViewerHDF5GetFileId(viewer, &h5);CHKERRQ(ierr);
105685688ae2SVaclav Hapla 
105785688ae2SVaclav Hapla   /*
105885688ae2SVaclav Hapla      Unfortunately, H5Oexists_by_name() fails if any object in hierarchy is missing.
105985688ae2SVaclav Hapla      Hence, each of them needs to be tested separately:
106085688ae2SVaclav Hapla      1) whether it's a valid link
106185688ae2SVaclav Hapla      2) whether this link resolves to an object
106285688ae2SVaclav Hapla      See H5Oexists_by_name() documentation.
106385688ae2SVaclav Hapla   */
106485688ae2SVaclav Hapla   ierr = PetscStrToArray(name,'/',&n,&hierarchy);CHKERRQ(ierr);
106585688ae2SVaclav Hapla   if (!n) {
106685688ae2SVaclav Hapla     /*  Assume group "/" always exists in accordance with HDF5 >= 1.10.0. See H5Lexists() documentation. */
1067ccd66a83SVaclav Hapla     if (has)   *has   = PETSC_TRUE;
1068ccd66a83SVaclav Hapla     if (otype) *otype = H5O_TYPE_GROUP;
106985688ae2SVaclav Hapla     ierr = PetscStrToArrayDestroy(n,hierarchy);CHKERRQ(ierr);
107085688ae2SVaclav Hapla     PetscFunctionReturn(0);
107185688ae2SVaclav Hapla   }
107285688ae2SVaclav Hapla   for (i=0; i<n; i++) {
107385688ae2SVaclav Hapla     ierr = PetscStrcat(buf,"/");CHKERRQ(ierr);
107485688ae2SVaclav Hapla     ierr = PetscStrcat(buf,hierarchy[i]);CHKERRQ(ierr);
1075a75c3fd4SVaclav Hapla     ierr = PetscViewerHDF5Traverse_Inner_Internal(h5, buf, createGroup, &exists);CHKERRQ(ierr);
1076a75c3fd4SVaclav Hapla     if (!exists) break;
107785688ae2SVaclav Hapla   }
107885688ae2SVaclav Hapla   ierr = PetscStrToArrayDestroy(n,hierarchy);CHKERRQ(ierr);
107985688ae2SVaclav Hapla 
108085688ae2SVaclav Hapla   /* If the object exists, get its type */
1081ccd66a83SVaclav Hapla   if (exists && otype) {
10825cdeb108SMatthew G. Knepley     H5O_info_t info;
10835cdeb108SMatthew G. Knepley 
108476276748SVaclav Hapla     /* We could use H5Iget_type() here but that would require opening the object. This way we only need its name. */
108504633f7fSVaclav Hapla     PetscStackCallHDF5(H5Oget_info_by_name,(h5, name, &info, H5P_DEFAULT));
108656cc0592SVaclav Hapla     *otype = info.type;
10875cdeb108SMatthew G. Knepley   }
1088ccd66a83SVaclav Hapla   if (has) *has = exists;
10895cdeb108SMatthew G. Knepley   PetscFunctionReturn(0);
10905cdeb108SMatthew G. Knepley }
10915cdeb108SMatthew G. Knepley 
1092ecce1506SVaclav Hapla /*@
10930a9f38efSVaclav Hapla  PetscViewerHDF5HasGroup - Check whether the current (pushed) group exists in the HDF5 file
10940a9f38efSVaclav Hapla 
10950a9f38efSVaclav Hapla   Input Parameters:
10960a9f38efSVaclav Hapla . viewer - The HDF5 viewer
10970a9f38efSVaclav Hapla 
10980a9f38efSVaclav Hapla   Output Parameter:
10990a9f38efSVaclav Hapla . has    - Flag for group existence
11000a9f38efSVaclav Hapla 
11010a9f38efSVaclav Hapla   Notes:
11020a9f38efSVaclav Hapla   If the path exists but is not a group, this returns PETSC_FALSE as well.
11030a9f38efSVaclav Hapla 
11040a9f38efSVaclav Hapla   Level: advanced
11050a9f38efSVaclav Hapla 
11060a9f38efSVaclav Hapla .seealso: PetscViewerHDF5Open(), PetscViewerHDF5PushGroup(), PetscViewerHDF5PopGroup(), PetscViewerHDF5OpenGroup()
11070a9f38efSVaclav Hapla @*/
11080a9f38efSVaclav Hapla PetscErrorCode PetscViewerHDF5HasGroup(PetscViewer viewer, PetscBool *has)
11090a9f38efSVaclav Hapla {
11100a9f38efSVaclav Hapla   H5O_type_t type;
11110a9f38efSVaclav Hapla   const char *name;
11120a9f38efSVaclav Hapla   PetscErrorCode ierr;
11130a9f38efSVaclav Hapla 
11140a9f38efSVaclav Hapla   PetscFunctionBegin;
11150a9f38efSVaclav Hapla   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
11160a9f38efSVaclav Hapla   PetscValidIntPointer(has,2);
11170a9f38efSVaclav Hapla   ierr = PetscViewerHDF5GetGroup(viewer, &name);CHKERRQ(ierr);
11180a9f38efSVaclav Hapla   ierr = PetscViewerHDF5Traverse_Internal(viewer, name, PETSC_FALSE, has, &type);CHKERRQ(ierr);
11190a9f38efSVaclav Hapla   *has = (type == H5O_TYPE_GROUP) ? PETSC_TRUE : PETSC_FALSE;
11200a9f38efSVaclav Hapla   PetscFunctionReturn(0);
11210a9f38efSVaclav Hapla }
11220a9f38efSVaclav Hapla 
11230a9f38efSVaclav Hapla /*@
1124e3f143f7SVaclav Hapla  PetscViewerHDF5HasObject - Check whether a dataset with the same name as given object exists in the HDF5 file under current group
1125ecce1506SVaclav Hapla 
1126ecce1506SVaclav Hapla   Input Parameters:
1127ecce1506SVaclav Hapla + viewer - The HDF5 viewer
1128ecce1506SVaclav Hapla - obj    - The named object
1129ecce1506SVaclav Hapla 
1130ecce1506SVaclav Hapla   Output Parameter:
1131ecce1506SVaclav Hapla . has    - Flag for dataset existence; PETSC_FALSE for unnamed object
1132ecce1506SVaclav Hapla 
1133e3f143f7SVaclav Hapla   Notes:
1134e3f143f7SVaclav Hapla   If the path exists but is not a dataset, this returns PETSC_FALSE as well.
1135e3f143f7SVaclav Hapla 
1136ecce1506SVaclav Hapla   Level: advanced
1137ecce1506SVaclav Hapla 
1138e3f143f7SVaclav Hapla .seealso: PetscViewerHDF5Open(), PetscViewerHDF5HasAttribute(), PetscViewerHDF5PushGroup(),PetscViewerHDF5PopGroup(),PetscViewerHDF5GetGroup()
1139ecce1506SVaclav Hapla @*/
1140ecce1506SVaclav Hapla PetscErrorCode PetscViewerHDF5HasObject(PetscViewer viewer, PetscObject obj, PetscBool *has)
1141ecce1506SVaclav Hapla {
114256cc0592SVaclav Hapla   H5O_type_t type;
11436c132bc1SVaclav Hapla   char *path;
1144ecce1506SVaclav Hapla   PetscErrorCode ierr;
1145ecce1506SVaclav Hapla 
1146ecce1506SVaclav Hapla   PetscFunctionBegin;
1147c57a1a9aSVaclav Hapla   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
1148c57a1a9aSVaclav Hapla   PetscValidHeader(obj,2);
1149c57a1a9aSVaclav Hapla   PetscValidIntPointer(has,3);
1150ecce1506SVaclav Hapla   *has = PETSC_FALSE;
1151e3f143f7SVaclav Hapla   if (!obj->name) PetscFunctionReturn(0);
11526c132bc1SVaclav Hapla   ierr = PetscViewerHDF5GetAbsolutePath_Internal(viewer, obj->name, &path);CHKERRQ(ierr);
11536c132bc1SVaclav Hapla   ierr = PetscViewerHDF5Traverse_Internal(viewer, path, PETSC_FALSE, has, &type);CHKERRQ(ierr);
115456cc0592SVaclav Hapla   *has = (type == H5O_TYPE_DATASET) ? PETSC_TRUE : PETSC_FALSE;
11556c132bc1SVaclav Hapla   ierr = PetscFree(path);CHKERRQ(ierr);
1156ecce1506SVaclav Hapla   PetscFunctionReturn(0);
1157ecce1506SVaclav Hapla }
1158ecce1506SVaclav Hapla 
1159df863907SAlex Fikl /*@C
1160ece83b6cSVaclav Hapla  PetscViewerHDF5HasAttribute - Check whether an attribute exists
1161e7bdbf8eSMatthew G. Knepley 
1162e7bdbf8eSMatthew G. Knepley   Input Parameters:
1163e7bdbf8eSMatthew G. Knepley + viewer - The HDF5 viewer
116410e69e8fSVaclav Hapla . dataset - The parent dataset name, relative to the current group. NULL means a group-wise attribute.
1165e7bdbf8eSMatthew G. Knepley - name   - The attribute name
1166e7bdbf8eSMatthew G. Knepley 
1167e7bdbf8eSMatthew G. Knepley   Output Parameter:
1168e7bdbf8eSMatthew G. Knepley . has    - Flag for attribute existence
1169e7bdbf8eSMatthew G. Knepley 
1170e7bdbf8eSMatthew G. Knepley   Level: advanced
1171e7bdbf8eSMatthew G. Knepley 
1172577e0e04SVaclav Hapla .seealso: PetscViewerHDF5Open(), PetscViewerHDF5HasObjectAttribute(), PetscViewerHDF5WriteAttribute(), PetscViewerHDF5ReadAttribute(), PetscViewerHDF5PushGroup(),PetscViewerHDF5PopGroup(),PetscViewerHDF5GetGroup()
1173e7bdbf8eSMatthew G. Knepley @*/
117410e69e8fSVaclav Hapla PetscErrorCode PetscViewerHDF5HasAttribute(PetscViewer viewer, const char dataset[], const char name[], PetscBool *has)
1175e7bdbf8eSMatthew G. Knepley {
117610e69e8fSVaclav Hapla   char           *parent;
1177e7bdbf8eSMatthew G. Knepley   PetscErrorCode ierr;
1178e7bdbf8eSMatthew G. Knepley 
1179e7bdbf8eSMatthew G. Knepley   PetscFunctionBegin;
11805cdeb108SMatthew G. Knepley   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
118110e69e8fSVaclav Hapla   if (dataset) PetscValidCharPointer(dataset,2);
1182c57a1a9aSVaclav Hapla   PetscValidCharPointer(name,3);
1183c57a1a9aSVaclav Hapla   PetscValidIntPointer(has,4);
118410e69e8fSVaclav Hapla   ierr = PetscViewerHDF5GetAbsolutePath_Internal(viewer, dataset, &parent);CHKERRQ(ierr);
1185bb286ee1SVaclav Hapla   ierr = PetscViewerHDF5Traverse_Internal(viewer, parent, PETSC_FALSE, has, NULL);CHKERRQ(ierr);
118610e69e8fSVaclav Hapla   if (*has) {ierr = PetscViewerHDF5HasAttribute_Internal(viewer, parent, name, has);CHKERRQ(ierr);}
118710e69e8fSVaclav Hapla   ierr = PetscFree(parent);CHKERRQ(ierr);
118806db490cSVaclav Hapla   PetscFunctionReturn(0);
118906db490cSVaclav Hapla }
119006db490cSVaclav Hapla 
1191577e0e04SVaclav Hapla /*@C
1192577e0e04SVaclav Hapla  PetscViewerHDF5HasObjectAttribute - Check whether an attribute is attached to the dataset matching the given PetscObject by name
1193577e0e04SVaclav Hapla 
1194577e0e04SVaclav Hapla   Input Parameters:
1195577e0e04SVaclav Hapla + viewer - The HDF5 viewer
1196577e0e04SVaclav Hapla . obj    - The object whose name is used to lookup the parent dataset, relative to the current group.
1197577e0e04SVaclav Hapla - name   - The attribute name
1198577e0e04SVaclav Hapla 
1199577e0e04SVaclav Hapla   Output Parameter:
1200577e0e04SVaclav Hapla . has    - Flag for attribute existence
1201577e0e04SVaclav Hapla 
1202577e0e04SVaclav Hapla   Notes:
1203577e0e04SVaclav Hapla   This fails if current_group/object_name doesn't resolve to a dataset (the path doesn't exist or is not a dataset).
1204577e0e04SVaclav Hapla   You might want to check first if it does using PetscViewerHDF5HasObject().
1205577e0e04SVaclav Hapla 
1206577e0e04SVaclav Hapla   Level: advanced
1207577e0e04SVaclav Hapla 
1208577e0e04SVaclav Hapla .seealso: PetscViewerHDF5Open(), PetscViewerHDF5HasAttribute(), PetscViewerHDF5WriteObjectAttribute(), PetscViewerHDF5ReadObjectAttribute(), PetscViewerHDF5HasObject(), PetscViewerHDF5PushGroup(),PetscViewerHDF5PopGroup(),PetscViewerHDF5GetGroup()
1209577e0e04SVaclav Hapla @*/
1210577e0e04SVaclav Hapla PetscErrorCode PetscViewerHDF5HasObjectAttribute(PetscViewer viewer, PetscObject obj, const char name[], PetscBool *has)
1211577e0e04SVaclav Hapla {
1212577e0e04SVaclav Hapla   PetscErrorCode ierr;
1213577e0e04SVaclav Hapla 
1214577e0e04SVaclav Hapla   PetscFunctionBegin;
1215577e0e04SVaclav Hapla   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
1216577e0e04SVaclav Hapla   PetscValidHeader(obj,2);
1217577e0e04SVaclav Hapla   PetscValidCharPointer(name,3);
1218577e0e04SVaclav Hapla   PetscValidIntPointer(has,4);
1219577e0e04SVaclav Hapla   ierr = PetscViewerHDF5CheckNamedObject_Internal(viewer, obj);CHKERRQ(ierr);
1220577e0e04SVaclav Hapla   ierr = PetscViewerHDF5HasAttribute(viewer, obj->name, name, has);CHKERRQ(ierr);
1221577e0e04SVaclav Hapla   PetscFunctionReturn(0);
1222577e0e04SVaclav Hapla }
1223577e0e04SVaclav Hapla 
122406db490cSVaclav Hapla static PetscErrorCode PetscViewerHDF5HasAttribute_Internal(PetscViewer viewer, const char parent[], const char name[], PetscBool *has)
122506db490cSVaclav Hapla {
122606db490cSVaclav Hapla   hid_t          h5;
122706db490cSVaclav Hapla   htri_t         hhas;
122806db490cSVaclav Hapla   PetscErrorCode ierr;
122906db490cSVaclav Hapla 
123006db490cSVaclav Hapla   PetscFunctionBegin;
123106db490cSVaclav Hapla   ierr = PetscViewerHDF5GetFileId(viewer, &h5);CHKERRQ(ierr);
12322f936e54SVaclav Hapla   PetscStackCallHDF5Return(hhas,H5Aexists_by_name,(h5, parent, name, H5P_DEFAULT));
12335cdeb108SMatthew G. Knepley   *has = hhas ? PETSC_TRUE : PETSC_FALSE;
1234e7bdbf8eSMatthew G. Knepley   PetscFunctionReturn(0);
1235e7bdbf8eSMatthew G. Knepley }
1236e7bdbf8eSMatthew G. Knepley 
1237eb5a92b4SVaclav Hapla static PetscErrorCode PetscViewerHDF5ReadInitialize_Private(PetscViewer viewer, const char name[], HDF5ReadCtx *ctx)
1238a5e1feadSVaclav Hapla {
1239fbd37863SVaclav Hapla   HDF5ReadCtx    h=NULL;
1240a5e1feadSVaclav Hapla   PetscErrorCode ierr;
1241a5e1feadSVaclav Hapla 
1242a5e1feadSVaclav Hapla   PetscFunctionBegin;
124369a06e7bSVaclav Hapla   ierr = PetscNew(&h);CHKERRQ(ierr);
124469a06e7bSVaclav Hapla   ierr = PetscViewerHDF5OpenGroup(viewer, &h->file, &h->group);CHKERRQ(ierr);
124569a06e7bSVaclav Hapla   PetscStackCallHDF5Return(h->dataset,H5Dopen2,(h->group, name, H5P_DEFAULT));
124669a06e7bSVaclav Hapla   PetscStackCallHDF5Return(h->dataspace,H5Dget_space,(h->dataset));
12479568d583SVaclav Hapla   ierr = PetscViewerHDF5GetTimestep(viewer, &h->timestep);CHKERRQ(ierr);
1248adb363a2SVaclav Hapla   ierr = PetscViewerHDF5HasAttribute(viewer,name,"complex",&h->complexVal);CHKERRQ(ierr);
1249aa54fc5aSVaclav Hapla   if (h->complexVal) {ierr = PetscViewerHDF5ReadAttribute(viewer,name,"complex",PETSC_BOOL,&h->complexVal);CHKERRQ(ierr);}
125009dabeb0SVaclav Hapla   /* MATLAB stores column vectors horizontally */
1251adb363a2SVaclav Hapla   ierr = PetscViewerHDF5HasAttribute(viewer,name,"MATLAB_class",&h->horizontal);CHKERRQ(ierr);
1252b8ef406cSVaclav Hapla   /* Create property list for collective dataset read */
1253b8ef406cSVaclav Hapla   PetscStackCallHDF5Return(h->plist,H5Pcreate,(H5P_DATASET_XFER));
1254b8ef406cSVaclav Hapla #if defined(PETSC_HAVE_H5PSET_FAPL_MPIO)
1255b8ef406cSVaclav Hapla   PetscStackCallHDF5(H5Pset_dxpl_mpio,(h->plist, H5FD_MPIO_COLLECTIVE));
1256b8ef406cSVaclav Hapla #endif
1257b8ef406cSVaclav Hapla   /* To write dataset independently use H5Pset_dxpl_mpio(plist_id, H5FD_MPIO_INDEPENDENT) */
125869a06e7bSVaclav Hapla   *ctx = h;
125969a06e7bSVaclav Hapla   PetscFunctionReturn(0);
126069a06e7bSVaclav Hapla }
126169a06e7bSVaclav Hapla 
1262eb5a92b4SVaclav Hapla static PetscErrorCode PetscViewerHDF5ReadFinalize_Private(PetscViewer viewer, HDF5ReadCtx *ctx)
126369a06e7bSVaclav Hapla {
126469a06e7bSVaclav Hapla   HDF5ReadCtx    h;
126569a06e7bSVaclav Hapla   PetscErrorCode ierr;
126669a06e7bSVaclav Hapla 
126769a06e7bSVaclav Hapla   PetscFunctionBegin;
126869a06e7bSVaclav Hapla   h = *ctx;
1269b8ef406cSVaclav Hapla   PetscStackCallHDF5(H5Pclose,(h->plist));
127090e03537SVaclav Hapla   PetscStackCallHDF5(H5Gclose,(h->group));
127169a06e7bSVaclav Hapla   PetscStackCallHDF5(H5Sclose,(h->dataspace));
127269a06e7bSVaclav Hapla   PetscStackCallHDF5(H5Dclose,(h->dataset));
127369a06e7bSVaclav Hapla   ierr = PetscFree(*ctx);CHKERRQ(ierr);
127469a06e7bSVaclav Hapla   PetscFunctionReturn(0);
127569a06e7bSVaclav Hapla }
127669a06e7bSVaclav Hapla 
1277eb5a92b4SVaclav Hapla static PetscErrorCode PetscViewerHDF5ReadSizes_Private(PetscViewer viewer, HDF5ReadCtx ctx, PetscLayout *map_)
127869a06e7bSVaclav Hapla {
127969a06e7bSVaclav Hapla   int            rdim, dim;
128069a06e7bSVaclav Hapla   hsize_t        dims[4];
128109dabeb0SVaclav Hapla   PetscInt       bsInd, lenInd, bs, len, N;
12828374c777SVaclav Hapla   PetscLayout    map;
12838374c777SVaclav Hapla   PetscErrorCode ierr;
128469a06e7bSVaclav Hapla 
128569a06e7bSVaclav Hapla   PetscFunctionBegin;
12868374c777SVaclav Hapla   if (!(*map_)) {
12878374c777SVaclav Hapla     ierr = PetscLayoutCreate(PetscObjectComm((PetscObject)viewer),map_);CHKERRQ(ierr);
12888374c777SVaclav Hapla   }
12898374c777SVaclav Hapla   map = *map_;
12909787f08bSVaclav Hapla   /* calculate expected number of dimensions */
1291a5e1feadSVaclav Hapla   dim = 0;
12929568d583SVaclav Hapla   if (ctx->timestep >= 0) ++dim;
1293a5e1feadSVaclav Hapla   ++dim; /* length in blocks */
12949568d583SVaclav Hapla   if (ctx->complexVal) ++dim;
12959787f08bSVaclav Hapla   /* get actual number of dimensions in dataset */
129669a06e7bSVaclav Hapla   PetscStackCallHDF5Return(rdim,H5Sget_simple_extent_dims,(ctx->dataspace, dims, NULL));
12979787f08bSVaclav Hapla   /* calculate expected dimension indices */
12989787f08bSVaclav Hapla   lenInd = 0;
12999568d583SVaclav Hapla   if (ctx->timestep >= 0) ++lenInd;
13009787f08bSVaclav Hapla   bsInd = lenInd + 1;
13019568d583SVaclav Hapla   ctx->dim2 = PETSC_FALSE;
13029787f08bSVaclav Hapla   if (rdim == dim) {
130345e21b7fSVaclav Hapla     bs = 1; /* support vectors stored as 1D array */
13049787f08bSVaclav Hapla   } else if (rdim == dim+1) {
130545e21b7fSVaclav Hapla     bs = (PetscInt) dims[bsInd];
13069568d583SVaclav Hapla     if (bs == 1) ctx->dim2 = PETSC_TRUE; /* vector with blocksize of 1, still stored as 2D array */
1307a5e1feadSVaclav Hapla   } else {
1308b54f1188SVaclav Hapla     SETERRQ2(PetscObjectComm((PetscObject)viewer), PETSC_ERR_FILE_UNEXPECTED, "Number of dimensions %d not %d as expected", rdim, dim);
1309a5e1feadSVaclav Hapla   }
131009dabeb0SVaclav Hapla   len = dims[lenInd];
131109dabeb0SVaclav Hapla   if (ctx->horizontal) {
1312b54f1188SVaclav Hapla     if (len != 1) SETERRQ(PetscObjectComm((PetscObject)viewer), PETSC_ERR_SUP, "Cannot have horizontal array with number of rows > 1. In case of MATLAB MAT-file, vectors must be saved as column vectors.");
131309dabeb0SVaclav Hapla     len = bs;
131409dabeb0SVaclav Hapla     bs = 1;
131509dabeb0SVaclav Hapla   }
131609dabeb0SVaclav Hapla   N = (PetscInt) len*bs;
13178374c777SVaclav Hapla 
13188374c777SVaclav Hapla   /* Set Vec sizes,blocksize,and type if not already set */
13198374c777SVaclav Hapla   if (map->bs < 0) {
132045e21b7fSVaclav Hapla     ierr = PetscLayoutSetBlockSize(map, bs);CHKERRQ(ierr);
132145e21b7fSVaclav Hapla   } else if (map->bs != bs) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_FILE_UNEXPECTED, "Block size of array in file is %D, not %D as expected",bs,map->bs);
13228374c777SVaclav Hapla   if (map->N < 0) {
132345e21b7fSVaclav Hapla     ierr = PetscLayoutSetSize(map, N);CHKERRQ(ierr);
1324b54f1188SVaclav Hapla   } else if (map->N != N) SETERRQ2(PetscObjectComm((PetscObject)viewer),PETSC_ERR_FILE_UNEXPECTED, "Global size of array in file is %D, not %D as expected",N,map->N);
132569a06e7bSVaclav Hapla   PetscFunctionReturn(0);
132669a06e7bSVaclav Hapla }
132769a06e7bSVaclav Hapla 
1328eb5a92b4SVaclav Hapla static PetscErrorCode PetscViewerHDF5ReadSelectHyperslab_Private(PetscViewer viewer, HDF5ReadCtx ctx, PetscLayout map, hid_t *memspace)
132916f6402dSVaclav Hapla {
133016f6402dSVaclav Hapla   hsize_t        count[4], offset[4];
133116f6402dSVaclav Hapla   int            dim;
133216f6402dSVaclav Hapla   PetscInt       bs, n, low;
133316f6402dSVaclav Hapla   PetscErrorCode ierr;
133416f6402dSVaclav Hapla 
133516f6402dSVaclav Hapla   PetscFunctionBegin;
133616f6402dSVaclav Hapla   /* Compute local size and ownership range */
133716f6402dSVaclav Hapla   ierr = PetscLayoutSetUp(map);CHKERRQ(ierr);
133816f6402dSVaclav Hapla   ierr = PetscLayoutGetBlockSize(map, &bs);CHKERRQ(ierr);
133916f6402dSVaclav Hapla   ierr = PetscLayoutGetLocalSize(map, &n);CHKERRQ(ierr);
134016f6402dSVaclav Hapla   ierr = PetscLayoutGetRange(map, &low, NULL);CHKERRQ(ierr);
134116f6402dSVaclav Hapla 
134216f6402dSVaclav Hapla   /* Each process defines a dataset and reads it from the hyperslab in the file */
134316f6402dSVaclav Hapla   dim  = 0;
134416f6402dSVaclav Hapla   if (ctx->timestep >= 0) {
134516f6402dSVaclav Hapla     count[dim]  = 1;
134616f6402dSVaclav Hapla     offset[dim] = ctx->timestep;
134716f6402dSVaclav Hapla     ++dim;
134816f6402dSVaclav Hapla   }
134909dabeb0SVaclav Hapla   if (ctx->horizontal) {
135009dabeb0SVaclav Hapla     count[dim]  = 1;
135109dabeb0SVaclav Hapla     offset[dim] = 0;
135209dabeb0SVaclav Hapla     ++dim;
135309dabeb0SVaclav Hapla   }
135416f6402dSVaclav Hapla   {
135516f6402dSVaclav Hapla     ierr = PetscHDF5IntCast(n/bs, &count[dim]);CHKERRQ(ierr);
135616f6402dSVaclav Hapla     ierr = PetscHDF5IntCast(low/bs, &offset[dim]);CHKERRQ(ierr);
135716f6402dSVaclav Hapla     ++dim;
135816f6402dSVaclav Hapla   }
135916f6402dSVaclav Hapla   if (bs > 1 || ctx->dim2) {
136009dabeb0SVaclav Hapla     if (PetscUnlikely(ctx->horizontal)) SETERRQ(PETSC_COMM_SELF, PETSC_ERR_SUP, "cannot have horizontal array with blocksize > 1");
136116f6402dSVaclav Hapla     count[dim]  = bs;
136216f6402dSVaclav Hapla     offset[dim] = 0;
136316f6402dSVaclav Hapla     ++dim;
136416f6402dSVaclav Hapla   }
136516f6402dSVaclav Hapla   if (ctx->complexVal) {
136616f6402dSVaclav Hapla     count[dim]  = 2;
136716f6402dSVaclav Hapla     offset[dim] = 0;
136816f6402dSVaclav Hapla     ++dim;
136916f6402dSVaclav Hapla   }
137016f6402dSVaclav Hapla   PetscStackCallHDF5Return(*memspace,H5Screate_simple,(dim, count, NULL));
137116f6402dSVaclav Hapla   PetscStackCallHDF5(H5Sselect_hyperslab,(ctx->dataspace, H5S_SELECT_SET, offset, NULL, count, NULL));
137216f6402dSVaclav Hapla   PetscFunctionReturn(0);
137316f6402dSVaclav Hapla }
137416f6402dSVaclav Hapla 
1375eb5a92b4SVaclav Hapla static PetscErrorCode PetscViewerHDF5ReadArray_Private(PetscViewer viewer, HDF5ReadCtx h, hid_t datatype, hid_t memspace, void *arr)
1376ef2d82ceSVaclav Hapla {
1377ef2d82ceSVaclav Hapla   PetscFunctionBegin;
1378ef2d82ceSVaclav Hapla   PetscStackCallHDF5(H5Dread,(h->dataset, datatype, memspace, h->dataspace, h->plist, arr));
1379ef2d82ceSVaclav Hapla   PetscFunctionReturn(0);
1380ef2d82ceSVaclav Hapla }
1381ef2d82ceSVaclav Hapla 
1382dad982a8SVaclav Hapla PetscErrorCode PetscViewerHDF5Load(PetscViewer viewer, const char *name, PetscLayout map, hid_t datatype, void **newarr)
1383a25c73c6SVaclav Hapla {
1384fbd37863SVaclav Hapla   HDF5ReadCtx     h=NULL;
1385fbd37863SVaclav Hapla   hid_t           memspace=0;
1386a25c73c6SVaclav Hapla   size_t          unitsize;
1387a25c73c6SVaclav Hapla   void            *arr;
1388a25c73c6SVaclav Hapla   PetscErrorCode  ierr;
1389a25c73c6SVaclav Hapla 
1390a25c73c6SVaclav Hapla   PetscFunctionBegin;
1391eb5a92b4SVaclav Hapla   ierr = PetscViewerHDF5ReadInitialize_Private(viewer, name, &h);CHKERRQ(ierr);
13925a89fdf4SVaclav Hapla #if defined(PETSC_USE_COMPLEX)
13935a89fdf4SVaclav Hapla   if (!h->complexVal) {
1394c76551afSVaclav Hapla     H5T_class_t clazz = H5Tget_class(datatype);
1395c76551afSVaclav Hapla     if (clazz == H5T_FLOAT) SETERRQ(PetscObjectComm((PetscObject)viewer),PETSC_ERR_SUP,"File contains real numbers but PETSc is configured for complex. The conversion is not yet implemented. Configure with --with-scalar-type=real.");
13965a89fdf4SVaclav Hapla   }
13975a89fdf4SVaclav Hapla #else
13985a89fdf4SVaclav Hapla   if (h->complexVal) SETERRQ(PetscObjectComm((PetscObject)viewer),PETSC_ERR_SUP,"File contains complex numbers but PETSc not configured for them. Configure with --with-scalar-type=complex.");
13995a89fdf4SVaclav Hapla #endif
1400e9e90110SVaclav Hapla 
1401e9e90110SVaclav Hapla   ierr = PetscViewerHDF5ReadSizes_Private(viewer, h, &map);CHKERRQ(ierr);
1402e9e90110SVaclav Hapla   ierr = PetscLayoutSetUp(map);CHKERRQ(ierr);
1403e9e90110SVaclav Hapla   ierr = PetscViewerHDF5ReadSelectHyperslab_Private(viewer, h, map, &memspace);CHKERRQ(ierr);
1404e9e90110SVaclav Hapla 
14054fc17bcdSVaclav Hapla   unitsize = H5Tget_size(datatype);
14064fc17bcdSVaclav Hapla   if (h->complexVal) unitsize *= 2;
1407dff35581SVaclav Hapla   if (unitsize <= 0 || unitsize > PetscMax(sizeof(PetscInt),sizeof(PetscScalar))) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_LIB,"Sanity check failed: HDF5 function H5Tget_size(datatype) returned suspicious value %D",unitsize);
14084fc17bcdSVaclav Hapla   ierr = PetscMalloc(map->n*unitsize, &arr);CHKERRQ(ierr);
14094fc17bcdSVaclav Hapla 
1410eb5a92b4SVaclav Hapla   ierr = PetscViewerHDF5ReadArray_Private(viewer, h, datatype, memspace, arr);CHKERRQ(ierr);
1411a25c73c6SVaclav Hapla   PetscStackCallHDF5(H5Sclose,(memspace));
1412eb5a92b4SVaclav Hapla   ierr = PetscViewerHDF5ReadFinalize_Private(viewer, &h);CHKERRQ(ierr);
1413a25c73c6SVaclav Hapla   *newarr = arr;
1414a25c73c6SVaclav Hapla   PetscFunctionReturn(0);
1415a25c73c6SVaclav Hapla }
1416a25c73c6SVaclav Hapla 
1417c1aaad9cSVaclav Hapla /*@C
1418c1aaad9cSVaclav Hapla  PetscViewerHDF5ReadSizes - Read block size and global size of a vector (Vec or IS) stored in an HDF5 file.
1419c1aaad9cSVaclav Hapla 
1420c1aaad9cSVaclav Hapla   Input Parameters:
1421c1aaad9cSVaclav Hapla + viewer - The HDF5 viewer
1422c1aaad9cSVaclav Hapla - name   - The vector name
1423c1aaad9cSVaclav Hapla 
1424c1aaad9cSVaclav Hapla   Output Parameter:
1425c1aaad9cSVaclav Hapla + bs     - block size
1426c1aaad9cSVaclav Hapla - N      - global size
1427c1aaad9cSVaclav Hapla 
1428c1aaad9cSVaclav Hapla   Note:
1429c1aaad9cSVaclav Hapla   A vector is stored as an HDF5 dataspace with 1-4 dimensions in this order:
1430c1aaad9cSVaclav Hapla   1) # timesteps (optional), 2) # blocks, 3) # elements per block (optional), 4) real and imaginary part (only for complex).
1431c1aaad9cSVaclav Hapla 
1432c1aaad9cSVaclav Hapla   A vectors can be stored as a 2D dataspace even if its blocksize is 1; see PetscViewerHDF5SetBaseDimension2().
1433c1aaad9cSVaclav Hapla 
1434c1aaad9cSVaclav Hapla   Level: advanced
1435c1aaad9cSVaclav Hapla 
1436c1aaad9cSVaclav Hapla .seealso: PetscViewerHDF5Open(), VecLoad(), ISLoad(), VecGetSize(), ISGetSize(), PetscViewerHDF5SetBaseDimension2()
1437c1aaad9cSVaclav Hapla @*/
143869a06e7bSVaclav Hapla PetscErrorCode PetscViewerHDF5ReadSizes(PetscViewer viewer, const char name[], PetscInt *bs, PetscInt *N)
143969a06e7bSVaclav Hapla {
1440fbd37863SVaclav Hapla   HDF5ReadCtx    h=NULL;
14418374c777SVaclav Hapla   PetscLayout    map=NULL;
144269a06e7bSVaclav Hapla   PetscErrorCode ierr;
144369a06e7bSVaclav Hapla 
144469a06e7bSVaclav Hapla   PetscFunctionBegin;
1445c1aaad9cSVaclav Hapla   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
1446eb5a92b4SVaclav Hapla   ierr = PetscViewerHDF5ReadInitialize_Private(viewer, name, &h);CHKERRQ(ierr);
1447eb5a92b4SVaclav Hapla   ierr = PetscViewerHDF5ReadSizes_Private(viewer, h, &map);CHKERRQ(ierr);
1448eb5a92b4SVaclav Hapla   ierr = PetscViewerHDF5ReadFinalize_Private(viewer, &h);CHKERRQ(ierr);
14498374c777SVaclav Hapla   if (bs) *bs = map->bs;
14508374c777SVaclav Hapla   if (N) *N = map->N;
14518374c777SVaclav Hapla   ierr = PetscLayoutDestroy(&map);CHKERRQ(ierr);
1452a5e1feadSVaclav Hapla   PetscFunctionReturn(0);
1453a5e1feadSVaclav Hapla }
1454a5e1feadSVaclav Hapla 
1455a75e6a4aSMatthew G. Knepley /*
1456a75e6a4aSMatthew G. Knepley   The variable Petsc_Viewer_HDF5_keyval is used to indicate an MPI attribute that
1457a75e6a4aSMatthew G. Knepley   is attached to a communicator, in this case the attribute is a PetscViewer.
1458a75e6a4aSMatthew G. Knepley */
1459d4c7638eSBarry Smith PetscMPIInt Petsc_Viewer_HDF5_keyval = MPI_KEYVAL_INVALID;
1460a75e6a4aSMatthew G. Knepley 
1461a75e6a4aSMatthew G. Knepley /*@C
1462a75e6a4aSMatthew G. Knepley   PETSC_VIEWER_HDF5_ - Creates an HDF5 PetscViewer shared by all processors in a communicator.
1463a75e6a4aSMatthew G. Knepley 
1464a75e6a4aSMatthew G. Knepley   Collective on MPI_Comm
1465a75e6a4aSMatthew G. Knepley 
1466a75e6a4aSMatthew G. Knepley   Input Parameter:
1467a75e6a4aSMatthew G. Knepley . comm - the MPI communicator to share the HDF5 PetscViewer
1468a75e6a4aSMatthew G. Knepley 
1469a75e6a4aSMatthew G. Knepley   Level: intermediate
1470a75e6a4aSMatthew G. Knepley 
1471a75e6a4aSMatthew G. Knepley   Options Database Keys:
1472a75e6a4aSMatthew G. Knepley . -viewer_hdf5_filename <name>
1473a75e6a4aSMatthew G. Knepley 
1474a75e6a4aSMatthew G. Knepley   Environmental variables:
1475a75e6a4aSMatthew G. Knepley . PETSC_VIEWER_HDF5_FILENAME
1476a75e6a4aSMatthew G. Knepley 
1477a75e6a4aSMatthew G. Knepley   Notes:
1478a75e6a4aSMatthew G. Knepley   Unlike almost all other PETSc routines, PETSC_VIEWER_HDF5_ does not return
1479a75e6a4aSMatthew G. Knepley   an error code.  The HDF5 PetscViewer is usually used in the form
1480a75e6a4aSMatthew G. Knepley $       XXXView(XXX object, PETSC_VIEWER_HDF5_(comm));
1481a75e6a4aSMatthew G. Knepley 
1482a75e6a4aSMatthew G. Knepley .seealso: PetscViewerHDF5Open(), PetscViewerCreate(), PetscViewerDestroy()
1483a75e6a4aSMatthew G. Knepley @*/
1484a75e6a4aSMatthew G. Knepley PetscViewer PETSC_VIEWER_HDF5_(MPI_Comm comm)
1485a75e6a4aSMatthew G. Knepley {
1486a75e6a4aSMatthew G. Knepley   PetscErrorCode ierr;
1487a75e6a4aSMatthew G. Knepley   PetscBool      flg;
1488a75e6a4aSMatthew G. Knepley   PetscViewer    viewer;
1489a75e6a4aSMatthew G. Knepley   char           fname[PETSC_MAX_PATH_LEN];
1490a75e6a4aSMatthew G. Knepley   MPI_Comm       ncomm;
1491a75e6a4aSMatthew G. Knepley 
1492a75e6a4aSMatthew G. Knepley   PetscFunctionBegin;
1493a75e6a4aSMatthew G. Knepley   ierr = PetscCommDuplicate(comm,&ncomm,NULL);if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_HDF5_",__FILE__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");PetscFunctionReturn(0);}
1494a75e6a4aSMatthew G. Knepley   if (Petsc_Viewer_HDF5_keyval == MPI_KEYVAL_INVALID) {
149512801b39SBarry Smith     ierr = MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,MPI_COMM_NULL_DELETE_FN,&Petsc_Viewer_HDF5_keyval,0);
1496a75e6a4aSMatthew G. Knepley     if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_HDF5_",__FILE__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");PetscFunctionReturn(0);}
1497a75e6a4aSMatthew G. Knepley   }
149847435625SJed Brown   ierr = MPI_Comm_get_attr(ncomm,Petsc_Viewer_HDF5_keyval,(void**)&viewer,(int*)&flg);
1499a75e6a4aSMatthew G. Knepley   if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_HDF5_",__FILE__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");PetscFunctionReturn(0);}
1500a75e6a4aSMatthew G. Knepley   if (!flg) { /* PetscViewer not yet created */
1501a75e6a4aSMatthew G. Knepley     ierr = PetscOptionsGetenv(ncomm,"PETSC_VIEWER_HDF5_FILENAME",fname,PETSC_MAX_PATH_LEN,&flg);
1502a75e6a4aSMatthew G. Knepley     if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_HDF5_",__FILE__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");PetscFunctionReturn(0);}
1503a75e6a4aSMatthew G. Knepley     if (!flg) {
1504a75e6a4aSMatthew G. Knepley       ierr = PetscStrcpy(fname,"output.h5");
1505a75e6a4aSMatthew G. Knepley       if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_HDF5_",__FILE__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");PetscFunctionReturn(0);}
1506a75e6a4aSMatthew G. Knepley     }
1507a75e6a4aSMatthew G. Knepley     ierr = PetscViewerHDF5Open(ncomm,fname,FILE_MODE_WRITE,&viewer);
1508a75e6a4aSMatthew G. Knepley     if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_HDF5_",__FILE__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");PetscFunctionReturn(0);}
1509a75e6a4aSMatthew G. Knepley     ierr = PetscObjectRegisterDestroy((PetscObject)viewer);
1510a75e6a4aSMatthew G. Knepley     if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_HDF5_",__FILE__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");PetscFunctionReturn(0);}
151147435625SJed Brown     ierr = MPI_Comm_set_attr(ncomm,Petsc_Viewer_HDF5_keyval,(void*)viewer);
1512a75e6a4aSMatthew G. Knepley     if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_HDF5_",__FILE__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");PetscFunctionReturn(0);}
1513a75e6a4aSMatthew G. Knepley   }
1514a75e6a4aSMatthew G. Knepley   ierr = PetscCommDestroy(&ncomm);
1515a75e6a4aSMatthew G. Knepley   if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_HDF5_",__FILE__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");PetscFunctionReturn(0);}
1516a75e6a4aSMatthew G. Knepley   PetscFunctionReturn(viewer);
1517a75e6a4aSMatthew G. Knepley }
1518