xref: /petsc/src/sys/classes/viewer/impls/binary/binv.c (revision 78fbdcc8da47d2da69f91a746197bf2bceb22ad2)
15c6c1daeSBarry Smith 
2af0996ceSBarry Smith #include <petsc/private/viewerimpl.h>    /*I   "petscviewer.h"   I*/
35c6c1daeSBarry Smith #include <fcntl.h>
45c6c1daeSBarry Smith #if defined(PETSC_HAVE_UNISTD_H)
55c6c1daeSBarry Smith #include <unistd.h>
65c6c1daeSBarry Smith #endif
75c6c1daeSBarry Smith #if defined(PETSC_HAVE_IO_H)
85c6c1daeSBarry Smith #include <io.h>
95c6c1daeSBarry Smith #endif
105c6c1daeSBarry Smith 
115c6c1daeSBarry Smith typedef struct  {
125c6c1daeSBarry Smith   int           fdes;                 /* file descriptor, ignored if using MPI IO */
135c6c1daeSBarry Smith #if defined(PETSC_HAVE_MPIIO)
14bc196f7cSDave May   PetscBool     usempiio;
155c6c1daeSBarry Smith   MPI_File      mfdes;                /* ignored unless using MPI IO */
165c6c1daeSBarry Smith   MPI_Offset    moff;
175c6c1daeSBarry Smith #endif
185c6c1daeSBarry Smith   PetscFileMode btype;                /* read or write? */
195c6c1daeSBarry Smith   FILE          *fdes_info;           /* optional file containing info on binary file*/
205c6c1daeSBarry Smith   PetscBool     storecompressed;      /* gzip the write binary file when closing it*/
215c6c1daeSBarry Smith   char          *filename;
225c6c1daeSBarry Smith   PetscBool     skipinfo;             /* Don't create info file for writing; don't use for reading */
235c6c1daeSBarry Smith   PetscBool     skipoptions;          /* don't use PETSc options database when loading */
245c6c1daeSBarry Smith   PetscInt      flowcontrol;          /* allow only <flowcontrol> messages outstanding at a time while doing IO */
255c6c1daeSBarry Smith   PetscBool     skipheader;           /* don't write header, only raw data */
26a261c58fSBarry Smith   PetscBool     matlabheaderwritten;  /* if format is PETSC_VIEWER_BINARY_MATLAB has the MATLAB .info header been written yet */
27c98fd787SBarry Smith   PetscBool     setfromoptionscalled;
285c6c1daeSBarry Smith } PetscViewer_Binary;
295c6c1daeSBarry Smith 
3081f0254dSBarry Smith static PetscErrorCode PetscViewerGetSubViewer_Binary(PetscViewer viewer,MPI_Comm comm,PetscViewer *outviewer)
315c6c1daeSBarry Smith {
325c6c1daeSBarry Smith   int                rank;
335c6c1daeSBarry Smith   PetscErrorCode     ierr;
345c6c1daeSBarry Smith   PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data,*obinary;
355c6c1daeSBarry Smith 
365c6c1daeSBarry Smith   PetscFunctionBegin;
37c98fd787SBarry Smith   ierr = PetscViewerSetUp(viewer);CHKERRQ(ierr);
38ce94432eSBarry Smith   ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)viewer),&rank);CHKERRQ(ierr);
395c6c1daeSBarry Smith   if (!rank) {
405c6c1daeSBarry Smith     ierr    = PetscViewerCreate(PETSC_COMM_SELF,outviewer);CHKERRQ(ierr);
415c6c1daeSBarry Smith     ierr    = PetscViewerSetType(*outviewer,PETSCVIEWERBINARY);CHKERRQ(ierr);
425c6c1daeSBarry Smith     obinary = (PetscViewer_Binary*)(*outviewer)->data;
435c6c1daeSBarry Smith     ierr    = PetscMemcpy(obinary,vbinary,sizeof(PetscViewer_Binary));CHKERRQ(ierr);
443f08860eSBarry Smith   } SETERRQ(PetscObjectComm((PetscObject)viewer),PETSC_ERR_SUP,"Cannot get subcomm viewer for binary files or sockets unless SubViewer contains the rank 0 process");
455c6c1daeSBarry Smith   PetscFunctionReturn(0);
465c6c1daeSBarry Smith }
475c6c1daeSBarry Smith 
4881f0254dSBarry Smith static PetscErrorCode PetscViewerRestoreSubViewer_Binary(PetscViewer viewer,MPI_Comm comm,PetscViewer *outviewer)
495c6c1daeSBarry Smith {
505c6c1daeSBarry Smith   PetscErrorCode ierr;
515c6c1daeSBarry Smith   PetscErrorCode rank;
525c6c1daeSBarry Smith 
535c6c1daeSBarry Smith   PetscFunctionBegin;
54ce94432eSBarry Smith   ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)viewer),&rank);CHKERRQ(ierr);
555c6c1daeSBarry Smith   if (!rank) {
565c6c1daeSBarry Smith     ierr = PetscFree((*outviewer)->data);CHKERRQ(ierr);
575c6c1daeSBarry Smith     ierr = PetscHeaderDestroy(outviewer);CHKERRQ(ierr);
585c6c1daeSBarry Smith   }
595c6c1daeSBarry Smith   PetscFunctionReturn(0);
605c6c1daeSBarry Smith }
615c6c1daeSBarry Smith 
625c6c1daeSBarry Smith #if defined(PETSC_HAVE_MPIIO)
635c6c1daeSBarry Smith /*@C
645c6c1daeSBarry Smith     PetscViewerBinaryGetMPIIOOffset - Gets the current offset that should be passed to MPI_File_set_view()
655c6c1daeSBarry Smith 
665c6c1daeSBarry Smith     Not Collective
675c6c1daeSBarry Smith 
685c6c1daeSBarry Smith     Input Parameter:
695c6c1daeSBarry Smith .   viewer - PetscViewer context, obtained from PetscViewerBinaryOpen()
705c6c1daeSBarry Smith 
715c6c1daeSBarry Smith     Output Parameter:
725c6c1daeSBarry Smith .    off - the current offset
735c6c1daeSBarry Smith 
745c6c1daeSBarry Smith     Level: advanced
755c6c1daeSBarry Smith 
765c6c1daeSBarry Smith     Fortran Note:
775c6c1daeSBarry Smith     This routine is not supported in Fortran.
785c6c1daeSBarry Smith 
795c6c1daeSBarry Smith     Use PetscViewerBinaryAddMPIIOOffset() to increase this value after you have written a view.
805c6c1daeSBarry Smith 
815c6c1daeSBarry Smith   Concepts: file descriptor^getting
825c6c1daeSBarry Smith   Concepts: PetscViewerBinary^accessing file descriptor
835c6c1daeSBarry Smith 
8467918a83SBarry Smith .seealso: PetscViewerBinaryOpen(), PetscViewerBinaryGetInfoPointer(), PetscViewerBinaryGetUseMPIIO(), PetscViewerBinarySetUseMPIIO(), PetscViewerBinaryAddMPIIOOffset()
855c6c1daeSBarry Smith @*/
865c6c1daeSBarry Smith PetscErrorCode PetscViewerBinaryGetMPIIOOffset(PetscViewer viewer,MPI_Offset *off)
875c6c1daeSBarry Smith {
885c6c1daeSBarry Smith   PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data;
895c6c1daeSBarry Smith 
905c6c1daeSBarry Smith   PetscFunctionBegin;
915c6c1daeSBarry Smith   *off = vbinary->moff;
925c6c1daeSBarry Smith   PetscFunctionReturn(0);
935c6c1daeSBarry Smith }
945c6c1daeSBarry Smith 
955c6c1daeSBarry Smith /*@C
965c6c1daeSBarry Smith     PetscViewerBinaryAddMPIIOOffset - Adds to the current offset that should be passed to MPI_File_set_view()
975c6c1daeSBarry Smith 
985c6c1daeSBarry Smith     Not Collective
995c6c1daeSBarry Smith 
1005c6c1daeSBarry Smith     Input Parameters:
1015c6c1daeSBarry Smith +   viewer - PetscViewer context, obtained from PetscViewerBinaryOpen()
1025c6c1daeSBarry Smith -    off - the addition to the offset
1035c6c1daeSBarry Smith 
1045c6c1daeSBarry Smith     Level: advanced
1055c6c1daeSBarry Smith 
1065c6c1daeSBarry Smith     Fortran Note:
1075c6c1daeSBarry Smith     This routine is not supported in Fortran.
1085c6c1daeSBarry Smith 
1095c6c1daeSBarry Smith     Use PetscViewerBinaryGetMPIIOOffset() to get the value that you should pass to MPI_File_set_view()
1105c6c1daeSBarry Smith 
1115c6c1daeSBarry Smith   Concepts: file descriptor^getting
1125c6c1daeSBarry Smith   Concepts: PetscViewerBinary^accessing file descriptor
1135c6c1daeSBarry Smith 
11467918a83SBarry Smith .seealso: PetscViewerBinaryOpen(),PetscViewerBinaryGetInfoPointer(), PetscViewerBinaryGetUseMPIIO(), PetscViewerBinarySetUseMPIIO(), PetscViewerBinaryGetMPIIOOffset()
1155c6c1daeSBarry Smith @*/
1165c6c1daeSBarry Smith PetscErrorCode PetscViewerBinaryAddMPIIOOffset(PetscViewer viewer,MPI_Offset off)
1175c6c1daeSBarry Smith {
1185c6c1daeSBarry Smith   PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data;
1195c6c1daeSBarry Smith 
1205c6c1daeSBarry Smith   PetscFunctionBegin;
1215c6c1daeSBarry Smith   vbinary->moff += off;
1225c6c1daeSBarry Smith   PetscFunctionReturn(0);
1235c6c1daeSBarry Smith }
1245c6c1daeSBarry Smith 
1255c6c1daeSBarry Smith /*@C
1265c6c1daeSBarry Smith     PetscViewerBinaryGetMPIIODescriptor - Extracts the MPI IO file descriptor from a PetscViewer.
1275c6c1daeSBarry Smith 
1285c6c1daeSBarry Smith     Not Collective
1295c6c1daeSBarry Smith 
1305c6c1daeSBarry Smith     Input Parameter:
1315c6c1daeSBarry Smith .   viewer - PetscViewer context, obtained from PetscViewerBinaryOpen()
1325c6c1daeSBarry Smith 
1335c6c1daeSBarry Smith     Output Parameter:
1345c6c1daeSBarry Smith .   fdes - file descriptor
1355c6c1daeSBarry Smith 
1365c6c1daeSBarry Smith     Level: advanced
1375c6c1daeSBarry Smith 
1385c6c1daeSBarry Smith     Fortran Note:
1395c6c1daeSBarry Smith     This routine is not supported in Fortran.
1405c6c1daeSBarry Smith 
1415c6c1daeSBarry Smith   Concepts: file descriptor^getting
1425c6c1daeSBarry Smith   Concepts: PetscViewerBinary^accessing file descriptor
1435c6c1daeSBarry Smith 
14467918a83SBarry Smith .seealso: PetscViewerBinaryOpen(),PetscViewerBinaryGetInfoPointer(), PetscViewerBinaryGetUseMPIIO(), PetscViewerBinarySetUseMPIIO(), PetscViewerBinaryGetMPIIOOffset()
1455c6c1daeSBarry Smith @*/
1465c6c1daeSBarry Smith PetscErrorCode PetscViewerBinaryGetMPIIODescriptor(PetscViewer viewer,MPI_File *fdes)
1475c6c1daeSBarry Smith {
14803a1d59fSDave May   PetscErrorCode     ierr;
1495c6c1daeSBarry Smith   PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data;
1505c6c1daeSBarry Smith 
1515c6c1daeSBarry Smith   PetscFunctionBegin;
152c98fd787SBarry Smith   ierr = PetscViewerSetUp(viewer);CHKERRQ(ierr);
1535c6c1daeSBarry Smith   *fdes = vbinary->mfdes;
1545c6c1daeSBarry Smith   PetscFunctionReturn(0);
1555c6c1daeSBarry Smith }
1565c6c1daeSBarry Smith 
15781f0254dSBarry Smith static PetscErrorCode PetscViewerBinaryGetUseMPIIO_Binary(PetscViewer viewer,PetscBool  *flg)
158a8aae444SDave May {
159a8aae444SDave May   PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data;
160a8aae444SDave May 
161a8aae444SDave May   PetscFunctionBegin;
162bc196f7cSDave May   *flg = vbinary->usempiio;
163a8aae444SDave May   PetscFunctionReturn(0);
164a8aae444SDave May }
165a8aae444SDave May #endif
166a8aae444SDave May 
167a8aae444SDave May 
1685c6c1daeSBarry Smith /*@C
169bc196f7cSDave May     PetscViewerBinaryGetUseMPIIO - Returns PETSC_TRUE if the binary viewer uses MPI-IO.
1705c6c1daeSBarry Smith 
1715c6c1daeSBarry Smith     Not Collective
1725c6c1daeSBarry Smith 
1735c6c1daeSBarry Smith     Input Parameter:
1745c6c1daeSBarry Smith .   viewer - PetscViewer context, obtained from PetscViewerBinaryOpen()
1755c6c1daeSBarry Smith 
1765c6c1daeSBarry Smith     Output Parameter:
177bc196f7cSDave May -   flg - PETSC_TRUE if MPI-IO is being used
1785c6c1daeSBarry Smith 
1795c6c1daeSBarry Smith     Options Database:
1805c6c1daeSBarry Smith     -viewer_binary_mpiio : Flag for using MPI-IO
1815c6c1daeSBarry Smith 
1825c6c1daeSBarry Smith     Level: advanced
1835c6c1daeSBarry Smith 
184bc196f7cSDave May     Note:
185bc196f7cSDave May     If MPI-IO is not available, this function will always return PETSC_FALSE
186bc196f7cSDave May 
1875c6c1daeSBarry Smith     Fortran Note:
1885c6c1daeSBarry Smith     This routine is not supported in Fortran.
1895c6c1daeSBarry Smith 
1905c6c1daeSBarry Smith   Concepts: file descriptor^getting
1915c6c1daeSBarry Smith   Concepts: PetscViewerBinary^accessing file descriptor
1925c6c1daeSBarry Smith 
19367918a83SBarry Smith .seealso: PetscViewerBinaryOpen(), PetscViewerBinaryGetInfoPointer(), PetscViewerBinarySetUseMPIIO(), PetscViewerBinaryGetMPIIOOffset()
1945c6c1daeSBarry Smith @*/
195bc196f7cSDave May PetscErrorCode PetscViewerBinaryGetUseMPIIO(PetscViewer viewer,PetscBool *flg)
1965c6c1daeSBarry Smith {
197a8aae444SDave May   PetscErrorCode ierr;
1985c6c1daeSBarry Smith 
1995c6c1daeSBarry Smith   PetscFunctionBegin;
200a8aae444SDave May   *flg = PETSC_FALSE;
201bc196f7cSDave May   ierr = PetscTryMethod(viewer,"PetscViewerBinaryGetUseMPIIO_C",(PetscViewer,PetscBool*),(viewer,flg));CHKERRQ(ierr);
2025c6c1daeSBarry Smith   PetscFunctionReturn(0);
2035c6c1daeSBarry Smith }
2045c6c1daeSBarry Smith 
20581f0254dSBarry Smith static PetscErrorCode  PetscViewerBinaryGetFlowControl_Binary(PetscViewer viewer,PetscInt *fc)
2065c6c1daeSBarry Smith {
2075c6c1daeSBarry Smith   PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data;
2085c6c1daeSBarry Smith 
2095c6c1daeSBarry Smith   PetscFunctionBegin;
2105c6c1daeSBarry Smith   *fc = vbinary->flowcontrol;
2115c6c1daeSBarry Smith   PetscFunctionReturn(0);
2125c6c1daeSBarry Smith }
2135c6c1daeSBarry Smith 
2145c6c1daeSBarry Smith /*@C
2155c6c1daeSBarry Smith     PetscViewerBinaryGetFlowControl - Returns how many messages are allowed to outstanding at the same time during parallel IO reads/writes
2165c6c1daeSBarry Smith 
2175c6c1daeSBarry Smith     Not Collective
2185c6c1daeSBarry Smith 
2195c6c1daeSBarry Smith     Input Parameter:
2205c6c1daeSBarry Smith .   viewer - PetscViewer context, obtained from PetscViewerBinaryOpen()
2215c6c1daeSBarry Smith 
2225c6c1daeSBarry Smith     Output Parameter:
2235c6c1daeSBarry Smith .   fc - the number of messages
2245c6c1daeSBarry Smith 
2255c6c1daeSBarry Smith     Level: advanced
2265c6c1daeSBarry Smith 
2275c6c1daeSBarry Smith .seealso: PetscViewerBinaryOpen(),PetscViewerBinaryGetInfoPointer(), PetscViewerBinarySetFlowControl()
2285c6c1daeSBarry Smith 
2295c6c1daeSBarry Smith @*/
2305c6c1daeSBarry Smith PetscErrorCode PetscViewerBinaryGetFlowControl(PetscViewer viewer,PetscInt *fc)
2315c6c1daeSBarry Smith {
2325c6c1daeSBarry Smith   PetscErrorCode ierr;
2335c6c1daeSBarry Smith 
2345c6c1daeSBarry Smith   PetscFunctionBegin;
235163d334eSBarry Smith   ierr = PetscUseMethod(viewer,"PetscViewerBinaryGetFlowControl_C",(PetscViewer,PetscInt*),(viewer,fc));CHKERRQ(ierr);
2365c6c1daeSBarry Smith   PetscFunctionReturn(0);
2375c6c1daeSBarry Smith }
2385c6c1daeSBarry Smith 
23981f0254dSBarry Smith static PetscErrorCode PetscViewerBinarySetFlowControl_Binary(PetscViewer viewer,PetscInt fc)
2405c6c1daeSBarry Smith {
2415c6c1daeSBarry Smith   PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data;
2425c6c1daeSBarry Smith 
2435c6c1daeSBarry Smith   PetscFunctionBegin;
244ce94432eSBarry Smith   if (fc <= 1) SETERRQ1(PetscObjectComm((PetscObject)viewer),PETSC_ERR_ARG_OUTOFRANGE,"Flow control count must be greater than 1, %D was set",fc);
2455c6c1daeSBarry Smith   vbinary->flowcontrol = fc;
2465c6c1daeSBarry Smith   PetscFunctionReturn(0);
2475c6c1daeSBarry Smith }
2485c6c1daeSBarry Smith 
2495c6c1daeSBarry Smith /*@C
250639ff905SBarry Smith     PetscViewerBinarySetFlowControl - Sets how many messages are allowed to outstanding at the same time during parallel IO reads/writes
2515c6c1daeSBarry Smith 
2525c6c1daeSBarry Smith     Not Collective
2535c6c1daeSBarry Smith 
2545c6c1daeSBarry Smith     Input Parameter:
2555c6c1daeSBarry Smith +   viewer - PetscViewer context, obtained from PetscViewerBinaryOpen()
256639ff905SBarry Smith -   fc - the number of messages, defaults to 256 if this function was not called
2575c6c1daeSBarry Smith 
2585c6c1daeSBarry Smith     Level: advanced
2595c6c1daeSBarry Smith 
2605c6c1daeSBarry Smith .seealso: PetscViewerBinaryOpen(),PetscViewerBinaryGetInfoPointer(), PetscViewerBinaryGetFlowControl()
2615c6c1daeSBarry Smith 
2625c6c1daeSBarry Smith @*/
2635c6c1daeSBarry Smith PetscErrorCode  PetscViewerBinarySetFlowControl(PetscViewer viewer,PetscInt fc)
2645c6c1daeSBarry Smith {
2655c6c1daeSBarry Smith   PetscErrorCode ierr;
2665c6c1daeSBarry Smith 
2675c6c1daeSBarry Smith   PetscFunctionBegin;
2685c6c1daeSBarry Smith   ierr = PetscUseMethod(viewer,"PetscViewerBinarySetFlowControl_C",(PetscViewer,PetscInt),(viewer,fc));CHKERRQ(ierr);
2695c6c1daeSBarry Smith   PetscFunctionReturn(0);
2705c6c1daeSBarry Smith }
2715c6c1daeSBarry Smith 
2725c6c1daeSBarry Smith /*@C
2735c6c1daeSBarry Smith     PetscViewerBinaryGetDescriptor - Extracts the file descriptor from a PetscViewer.
2745c6c1daeSBarry Smith 
2755872f025SBarry Smith     Collective On PetscViewer
2765c6c1daeSBarry Smith 
2775c6c1daeSBarry Smith     Input Parameter:
2785c6c1daeSBarry Smith .   viewer - PetscViewer context, obtained from PetscViewerBinaryOpen()
2795c6c1daeSBarry Smith 
2805c6c1daeSBarry Smith     Output Parameter:
2815c6c1daeSBarry Smith .   fdes - file descriptor
2825c6c1daeSBarry Smith 
2835c6c1daeSBarry Smith     Level: advanced
2845c6c1daeSBarry Smith 
2855c6c1daeSBarry Smith     Notes:
2865c6c1daeSBarry Smith       For writable binary PetscViewers, the descriptor will only be valid for the
2875c6c1daeSBarry Smith     first processor in the communicator that shares the PetscViewer. For readable
2885c6c1daeSBarry Smith     files it will only be valid on nodes that have the file. If node 0 does not
2895c6c1daeSBarry Smith     have the file it generates an error even if another node does have the file.
2905c6c1daeSBarry Smith 
2915c6c1daeSBarry Smith     Fortran Note:
2925c6c1daeSBarry Smith     This routine is not supported in Fortran.
2935c6c1daeSBarry Smith 
2945872f025SBarry Smith     Developer Notes: This must be called on all processes because Dave May changed
2955872f025SBarry Smith     the source code that this may be trigger a PetscViewerSetUp() call if it was not previously triggered.
2965872f025SBarry Smith 
2975872f025SBarry Smith 
2985c6c1daeSBarry Smith   Concepts: file descriptor^getting
2995c6c1daeSBarry Smith   Concepts: PetscViewerBinary^accessing file descriptor
3005c6c1daeSBarry Smith 
3015c6c1daeSBarry Smith .seealso: PetscViewerBinaryOpen(),PetscViewerBinaryGetInfoPointer()
3025c6c1daeSBarry Smith @*/
3035c6c1daeSBarry Smith PetscErrorCode PetscViewerBinaryGetDescriptor(PetscViewer viewer,int *fdes)
3045c6c1daeSBarry Smith {
30503a1d59fSDave May   PetscErrorCode     ierr;
3065c6c1daeSBarry Smith   PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data;
3075c6c1daeSBarry Smith 
3085c6c1daeSBarry Smith   PetscFunctionBegin;
309c98fd787SBarry Smith   ierr = PetscViewerSetUp(viewer);CHKERRQ(ierr);
3105c6c1daeSBarry Smith   *fdes = vbinary->fdes;
3115c6c1daeSBarry Smith   PetscFunctionReturn(0);
3125c6c1daeSBarry Smith }
3135c6c1daeSBarry Smith 
3145c6c1daeSBarry Smith /*@
3155c6c1daeSBarry Smith     PetscViewerBinarySkipInfo - Binary file will not have .info file created with it
3165c6c1daeSBarry Smith 
3175c6c1daeSBarry Smith     Not Collective
3185c6c1daeSBarry Smith 
3195c6c1daeSBarry Smith     Input Paramter:
3205c6c1daeSBarry Smith .   viewer - PetscViewer context, obtained from PetscViewerCreate()
3215c6c1daeSBarry Smith 
3225c6c1daeSBarry Smith     Options Database Key:
3235c6c1daeSBarry Smith .   -viewer_binary_skip_info
3245c6c1daeSBarry Smith 
3255c6c1daeSBarry Smith     Level: advanced
3265c6c1daeSBarry Smith 
327a2d7db39SDave May     Notes: This must be called after PetscViewerSetType(). If you use PetscViewerBinaryOpen() then
3285c6c1daeSBarry Smith     you can only skip the info file with the -viewer_binary_skip_info flag. To use the function you must open the
329a2d7db39SDave May     viewer with PetscViewerCreate(), PetscViewerSetType(), PetscViewerBinarySkipInfo().
3305c6c1daeSBarry Smith 
3315c6c1daeSBarry Smith     The .info contains meta information about the data in the binary file, for example the block size if it was
3325c6c1daeSBarry Smith     set for a vector or matrix.
3335c6c1daeSBarry Smith 
3345c6c1daeSBarry Smith    Concepts: PetscViewerBinary^accessing info file
3355c6c1daeSBarry Smith 
3365c6c1daeSBarry Smith .seealso: PetscViewerBinaryOpen(), PetscViewerBinaryGetDescriptor(), PetscViewerBinarySetSkipOptions(),
337807ea322SDave May           PetscViewerBinaryGetSkipOptions(), PetscViewerBinaryGetSkipInfo()
3385c6c1daeSBarry Smith @*/
3395c6c1daeSBarry Smith PetscErrorCode PetscViewerBinarySkipInfo(PetscViewer viewer)
3405c6c1daeSBarry Smith {
3415c6c1daeSBarry Smith   PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data;
3425c6c1daeSBarry Smith 
3435c6c1daeSBarry Smith   PetscFunctionBegin;
3445c6c1daeSBarry Smith   vbinary->skipinfo = PETSC_TRUE;
3455c6c1daeSBarry Smith   PetscFunctionReturn(0);
3465c6c1daeSBarry Smith }
3475c6c1daeSBarry Smith 
34881f0254dSBarry Smith static PetscErrorCode PetscViewerBinarySetSkipInfo_Binary(PetscViewer viewer,PetscBool skip)
349807ea322SDave May {
350807ea322SDave May   PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data;
351807ea322SDave May 
352807ea322SDave May   PetscFunctionBegin;
353807ea322SDave May   vbinary->skipinfo = skip;
354807ea322SDave May   PetscFunctionReturn(0);
355807ea322SDave May }
356807ea322SDave May 
357807ea322SDave May /*@
358807ea322SDave May     PetscViewerBinarySetSkipInfo - Binary file will not have .info file created with it
359807ea322SDave May 
360807ea322SDave May     Not Collective
361807ea322SDave May 
362807ea322SDave May     Input Paramter:
363807ea322SDave May .   viewer - PetscViewer context, obtained from PetscViewerCreate()
364807ea322SDave May 
365807ea322SDave May     Options Database Key:
366807ea322SDave May .   -viewer_binary_skip_info
367807ea322SDave May 
368807ea322SDave May     Level: advanced
369807ea322SDave May 
370807ea322SDave May     Concepts: PetscViewerBinary^accessing info file
371807ea322SDave May 
372807ea322SDave May .seealso: PetscViewerBinaryOpen(), PetscViewerBinaryGetDescriptor(), PetscViewerBinarySetSkipOptions(),
373807ea322SDave May           PetscViewerBinaryGetSkipOptions(), PetscViewerBinaryGetSkipInfo()
374807ea322SDave May @*/
375807ea322SDave May PetscErrorCode PetscViewerBinarySetSkipInfo(PetscViewer viewer,PetscBool skip)
376807ea322SDave May {
377807ea322SDave May   PetscErrorCode ierr;
378807ea322SDave May 
379807ea322SDave May   PetscFunctionBegin;
380807ea322SDave May   ierr = PetscUseMethod(viewer,"PetscViewerBinarySetSkipInfo_C",(PetscViewer,PetscBool),(viewer,skip));CHKERRQ(ierr);
381807ea322SDave May   PetscFunctionReturn(0);
382807ea322SDave May }
383807ea322SDave May 
38481f0254dSBarry Smith static PetscErrorCode PetscViewerBinaryGetSkipInfo_Binary(PetscViewer viewer,PetscBool *skip)
385807ea322SDave May {
386807ea322SDave May   PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data;
387807ea322SDave May 
388807ea322SDave May   PetscFunctionBegin;
389807ea322SDave May   *skip  = vbinary->skipinfo;
390807ea322SDave May   PetscFunctionReturn(0);
391807ea322SDave May }
392807ea322SDave May 
393807ea322SDave May /*@
394807ea322SDave May     PetscViewerBinaryGetSkipInfo - check if viewer wrote a .info file
395807ea322SDave May 
396807ea322SDave May     Not Collective
397807ea322SDave May 
398807ea322SDave May     Input Parameter:
399807ea322SDave May .   viewer - PetscViewer context, obtained from PetscViewerBinaryOpen()
400807ea322SDave May 
401807ea322SDave May     Output Parameter:
402807ea322SDave May .   skip - PETSC_TRUE implies the .info file was not generated
403807ea322SDave May 
404807ea322SDave May     Level: advanced
405807ea322SDave May 
406807ea322SDave May     Notes: This must be called after PetscViewerSetType()
407807ea322SDave May 
408807ea322SDave May     Concepts: PetscViewerBinary^accessing info file
409807ea322SDave May 
410807ea322SDave May .seealso: PetscViewerBinaryOpen(), PetscViewerBinaryGetDescriptor(), PetscViewerBinarySkipInfo(),
411807ea322SDave May           PetscViewerBinarySetSkipOptions(), PetscViewerBinarySetSkipInfo()
412807ea322SDave May @*/
413807ea322SDave May PetscErrorCode PetscViewerBinaryGetSkipInfo(PetscViewer viewer,PetscBool *skip)
414807ea322SDave May {
415807ea322SDave May   PetscErrorCode ierr;
416807ea322SDave May 
417807ea322SDave May   PetscFunctionBegin;
418807ea322SDave May   ierr = PetscUseMethod(viewer,"PetscViewerBinaryGetSkipInfo_C",(PetscViewer,PetscBool*),(viewer,skip));CHKERRQ(ierr);
419807ea322SDave May   PetscFunctionReturn(0);
420807ea322SDave May }
421807ea322SDave May 
42281f0254dSBarry Smith static PetscErrorCode PetscViewerBinarySetSkipOptions_Binary(PetscViewer viewer,PetscBool skip)
423807ea322SDave May {
424807ea322SDave May   PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data;
425807ea322SDave May 
426807ea322SDave May   PetscFunctionBegin;
427807ea322SDave May   vbinary->skipoptions = skip;
428807ea322SDave May   PetscFunctionReturn(0);
429807ea322SDave May }
430807ea322SDave May 
4315c6c1daeSBarry Smith /*@
4325c6c1daeSBarry Smith     PetscViewerBinarySetSkipOptions - do not use the PETSc options database when loading objects
4335c6c1daeSBarry Smith 
4345c6c1daeSBarry Smith     Not Collective
4355c6c1daeSBarry Smith 
4365c6c1daeSBarry Smith     Input Parameters:
4375c6c1daeSBarry Smith +   viewer - PetscViewer context, obtained from PetscViewerBinaryOpen()
4385c6c1daeSBarry Smith -   skip - PETSC_TRUE means do not use
4395c6c1daeSBarry Smith 
4405c6c1daeSBarry Smith     Options Database Key:
4415c6c1daeSBarry Smith .   -viewer_binary_skip_options
4425c6c1daeSBarry Smith 
4435c6c1daeSBarry Smith     Level: advanced
4445c6c1daeSBarry Smith 
4455c6c1daeSBarry Smith     Notes: This must be called after PetscViewerSetType()
4465c6c1daeSBarry Smith 
4475c6c1daeSBarry Smith    Concepts: PetscViewerBinary^accessing info file
4485c6c1daeSBarry Smith 
4495c6c1daeSBarry Smith .seealso: PetscViewerBinaryOpen(), PetscViewerBinaryGetDescriptor(), PetscViewerBinarySkipInfo(),
4505c6c1daeSBarry Smith           PetscViewerBinaryGetSkipOptions()
4515c6c1daeSBarry Smith @*/
4525c6c1daeSBarry Smith PetscErrorCode PetscViewerBinarySetSkipOptions(PetscViewer viewer,PetscBool skip)
4535c6c1daeSBarry Smith {
454807ea322SDave May   PetscErrorCode ierr;
4555c6c1daeSBarry Smith 
4565c6c1daeSBarry Smith   PetscFunctionBegin;
457807ea322SDave May   ierr = PetscUseMethod(viewer,"PetscViewerBinarySetSkipOptions_C",(PetscViewer,PetscBool),(viewer,skip));CHKERRQ(ierr);
458807ea322SDave May   PetscFunctionReturn(0);
459807ea322SDave May }
460807ea322SDave May 
46181f0254dSBarry Smith static PetscErrorCode PetscViewerBinaryGetSkipOptions_Binary(PetscViewer viewer,PetscBool *skip)
462807ea322SDave May {
463807ea322SDave May   PetscViewer_Binary *vbinary;
464807ea322SDave May 
465807ea322SDave May   PetscFunctionBegin;
466807ea322SDave May   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
467807ea322SDave May   vbinary = (PetscViewer_Binary*)viewer->data;
468807ea322SDave May   *skip   = vbinary->skipoptions;
4695c6c1daeSBarry Smith   PetscFunctionReturn(0);
4705c6c1daeSBarry Smith }
4715c6c1daeSBarry Smith 
4725c6c1daeSBarry Smith /*@
4735c6c1daeSBarry Smith     PetscViewerBinaryGetSkipOptions - checks if viewer uses the PETSc options database when loading objects
4745c6c1daeSBarry Smith 
4755c6c1daeSBarry Smith     Not Collective
4765c6c1daeSBarry Smith 
4775c6c1daeSBarry Smith     Input Parameter:
4785c6c1daeSBarry Smith .   viewer - PetscViewer context, obtained from PetscViewerBinaryOpen()
4795c6c1daeSBarry Smith 
4805c6c1daeSBarry Smith     Output Parameter:
4815c6c1daeSBarry Smith .   skip - PETSC_TRUE means do not use
4825c6c1daeSBarry Smith 
4835c6c1daeSBarry Smith     Level: advanced
4845c6c1daeSBarry Smith 
4855c6c1daeSBarry Smith     Notes: This must be called after PetscViewerSetType()
4865c6c1daeSBarry Smith 
4875c6c1daeSBarry Smith    Concepts: PetscViewerBinary^accessing info file
4885c6c1daeSBarry Smith 
4895c6c1daeSBarry Smith .seealso: PetscViewerBinaryOpen(), PetscViewerBinaryGetDescriptor(), PetscViewerBinarySkipInfo(),
4905c6c1daeSBarry Smith           PetscViewerBinarySetSkipOptions()
4915c6c1daeSBarry Smith @*/
4925c6c1daeSBarry Smith PetscErrorCode PetscViewerBinaryGetSkipOptions(PetscViewer viewer,PetscBool *skip)
4935c6c1daeSBarry Smith {
494807ea322SDave May   PetscErrorCode ierr;
4955c6c1daeSBarry Smith 
4965c6c1daeSBarry Smith   PetscFunctionBegin;
497807ea322SDave May   ierr = PetscUseMethod(viewer,"PetscViewerBinaryGetSkipOptions_C",(PetscViewer,PetscBool*),(viewer,skip));CHKERRQ(ierr);
4985c6c1daeSBarry Smith   PetscFunctionReturn(0);
4995c6c1daeSBarry Smith }
5005c6c1daeSBarry Smith 
50181f0254dSBarry Smith static PetscErrorCode PetscViewerBinarySetSkipHeader_Binary(PetscViewer viewer,PetscBool skip)
5025c6c1daeSBarry Smith {
5035c6c1daeSBarry Smith   PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data;
5045c6c1daeSBarry Smith 
5055c6c1daeSBarry Smith   PetscFunctionBegin;
5065c6c1daeSBarry Smith   vbinary->skipheader = skip;
5075c6c1daeSBarry Smith   PetscFunctionReturn(0);
5085c6c1daeSBarry Smith }
5095c6c1daeSBarry Smith 
5105c6c1daeSBarry Smith /*@
5115c6c1daeSBarry Smith     PetscViewerBinarySetSkipHeader - do not write a header with size information on output, just raw data
5125c6c1daeSBarry Smith 
5135c6c1daeSBarry Smith     Not Collective
5145c6c1daeSBarry Smith 
5155c6c1daeSBarry Smith     Input Parameters:
5165c6c1daeSBarry Smith +   viewer - PetscViewer context, obtained from PetscViewerBinaryOpen()
5175c6c1daeSBarry Smith -   skip - PETSC_TRUE means do not write header
5185c6c1daeSBarry Smith 
5195c6c1daeSBarry Smith     Options Database Key:
5205c6c1daeSBarry Smith .   -viewer_binary_skip_header
5215c6c1daeSBarry Smith 
5225c6c1daeSBarry Smith     Level: advanced
5235c6c1daeSBarry Smith 
5245c6c1daeSBarry Smith     Notes: This must be called after PetscViewerSetType()
5255c6c1daeSBarry Smith 
5265c6c1daeSBarry Smith            Can ONLY be called on a binary viewer
5275c6c1daeSBarry Smith 
5285c6c1daeSBarry Smith .seealso: PetscViewerBinaryOpen(), PetscViewerBinaryGetDescriptor(), PetscViewerBinarySkipInfo(),
5295c6c1daeSBarry Smith           PetscViewerBinaryGetSkipHeader()
5305c6c1daeSBarry Smith @*/
5315c6c1daeSBarry Smith PetscErrorCode PetscViewerBinarySetSkipHeader(PetscViewer viewer,PetscBool skip)
5325c6c1daeSBarry Smith {
5335c6c1daeSBarry Smith   PetscErrorCode ierr;
5345c6c1daeSBarry Smith 
5355c6c1daeSBarry Smith   PetscFunctionBegin;
5365c6c1daeSBarry Smith   ierr = PetscUseMethod(viewer,"PetscViewerBinarySetSkipHeader_C",(PetscViewer,PetscBool),(viewer,skip));CHKERRQ(ierr);
5375c6c1daeSBarry Smith   PetscFunctionReturn(0);
5385c6c1daeSBarry Smith }
5395c6c1daeSBarry Smith 
54081f0254dSBarry Smith static PetscErrorCode PetscViewerBinaryGetSkipHeader_Binary(PetscViewer viewer,PetscBool  *skip)
5415c6c1daeSBarry Smith {
5425c6c1daeSBarry Smith   PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data;
5435c6c1daeSBarry Smith 
5445c6c1daeSBarry Smith   PetscFunctionBegin;
5455c6c1daeSBarry Smith   *skip = vbinary->skipheader;
5465c6c1daeSBarry Smith   PetscFunctionReturn(0);
5475c6c1daeSBarry Smith }
5485c6c1daeSBarry Smith 
5495c6c1daeSBarry Smith /*@
5505c6c1daeSBarry Smith     PetscViewerBinaryGetSkipHeader - checks whether to write a header with size information on output, or just raw data
5515c6c1daeSBarry Smith 
5525c6c1daeSBarry Smith     Not Collective
5535c6c1daeSBarry Smith 
5545c6c1daeSBarry Smith     Input Parameter:
5555c6c1daeSBarry Smith .   viewer - PetscViewer context, obtained from PetscViewerBinaryOpen()
5565c6c1daeSBarry Smith 
5575c6c1daeSBarry Smith     Output Parameter:
5585c6c1daeSBarry Smith .   skip - PETSC_TRUE means do not write header
5595c6c1daeSBarry Smith 
5605c6c1daeSBarry Smith     Level: advanced
5615c6c1daeSBarry Smith 
5625c6c1daeSBarry Smith     Notes: This must be called after PetscViewerSetType()
5635c6c1daeSBarry Smith 
5645c6c1daeSBarry Smith             Returns false for PETSCSOCKETVIEWER, you cannot skip the header for it.
5655c6c1daeSBarry Smith 
5665c6c1daeSBarry Smith .seealso: PetscViewerBinaryOpen(), PetscViewerBinaryGetDescriptor(), PetscViewerBinarySkipInfo(),
5675c6c1daeSBarry Smith           PetscViewerBinarySetSkipHeader()
5685c6c1daeSBarry Smith @*/
5695c6c1daeSBarry Smith PetscErrorCode PetscViewerBinaryGetSkipHeader(PetscViewer viewer,PetscBool  *skip)
5705c6c1daeSBarry Smith {
5715c6c1daeSBarry Smith   PetscErrorCode ierr;
5725c6c1daeSBarry Smith 
5735c6c1daeSBarry Smith   PetscFunctionBegin;
5745c6c1daeSBarry Smith   *skip = PETSC_FALSE;
575163d334eSBarry Smith   ierr  = PetscUseMethod(viewer,"PetscViewerBinaryGetSkipHeader_C",(PetscViewer,PetscBool*),(viewer,skip));CHKERRQ(ierr);
5765c6c1daeSBarry Smith   PetscFunctionReturn(0);
5775c6c1daeSBarry Smith }
5785c6c1daeSBarry Smith 
57981f0254dSBarry Smith static PetscErrorCode PetscViewerBinaryGetInfoPointer_Binary(PetscViewer viewer,FILE **file)
5805c6c1daeSBarry Smith {
581f3b211e4SSatish Balay   PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data;
582a261c58fSBarry Smith   PetscErrorCode     ierr;
583a261c58fSBarry Smith   MPI_Comm           comm;
5845c6c1daeSBarry Smith 
5855c6c1daeSBarry Smith   PetscFunctionBegin;
586c98fd787SBarry Smith   ierr = PetscViewerSetUp(viewer);CHKERRQ(ierr);
5875c6c1daeSBarry Smith   *file = vbinary->fdes_info;
588a261c58fSBarry Smith   if (viewer->format == PETSC_VIEWER_BINARY_MATLAB && !vbinary->matlabheaderwritten) {
589a261c58fSBarry Smith     vbinary->matlabheaderwritten = PETSC_TRUE;
590a261c58fSBarry Smith     ierr = PetscObjectGetComm((PetscObject)viewer,&comm);CHKERRQ(ierr);
591da88d4d4SJed Brown     ierr = PetscFPrintf(comm,*file,"#--- begin code written by PetscViewerBinary for MATLAB format ---#\n");CHKERRQ(ierr);
592da88d4d4SJed Brown     ierr = PetscFPrintf(comm,*file,"#$$ Set.filename = '%s';\n",vbinary->filename);CHKERRQ(ierr);
593da88d4d4SJed Brown     ierr = PetscFPrintf(comm,*file,"#$$ fd = PetscOpenFile(Set.filename);\n");CHKERRQ(ierr);
594da88d4d4SJed Brown     ierr = PetscFPrintf(comm,*file,"#--- end code written by PetscViewerBinary for MATLAB format ---#\n\n");CHKERRQ(ierr);
595a261c58fSBarry Smith   }
5965c6c1daeSBarry Smith   PetscFunctionReturn(0);
5975c6c1daeSBarry Smith }
5985c6c1daeSBarry Smith 
5995c6c1daeSBarry Smith /*@C
6005c6c1daeSBarry Smith     PetscViewerBinaryGetInfoPointer - Extracts the file pointer for the ASCII
6015c6c1daeSBarry Smith           info file associated with a binary file.
6025c6c1daeSBarry Smith 
6035c6c1daeSBarry Smith     Not Collective
6045c6c1daeSBarry Smith 
6055c6c1daeSBarry Smith     Input Parameter:
6065c6c1daeSBarry Smith .   viewer - PetscViewer context, obtained from PetscViewerBinaryOpen()
6075c6c1daeSBarry Smith 
6085c6c1daeSBarry Smith     Output Parameter:
6090298fd71SBarry Smith .   file - file pointer  Always returns NULL if not a binary viewer
6105c6c1daeSBarry Smith 
6115c6c1daeSBarry Smith     Level: advanced
6125c6c1daeSBarry Smith 
6135c6c1daeSBarry Smith     Notes:
6145c6c1daeSBarry Smith       For writable binary PetscViewers, the descriptor will only be valid for the
6155c6c1daeSBarry Smith     first processor in the communicator that shares the PetscViewer.
6165c6c1daeSBarry Smith 
6175c6c1daeSBarry Smith     Fortran Note:
6185c6c1daeSBarry Smith     This routine is not supported in Fortran.
6195c6c1daeSBarry Smith 
6205c6c1daeSBarry Smith   Concepts: PetscViewerBinary^accessing info file
6215c6c1daeSBarry Smith 
6225c6c1daeSBarry Smith .seealso: PetscViewerBinaryOpen(),PetscViewerBinaryGetDescriptor()
6235c6c1daeSBarry Smith @*/
6245c6c1daeSBarry Smith PetscErrorCode PetscViewerBinaryGetInfoPointer(PetscViewer viewer,FILE **file)
6255c6c1daeSBarry Smith {
6265c6c1daeSBarry Smith   PetscErrorCode ierr;
6275c6c1daeSBarry Smith 
6285c6c1daeSBarry Smith   PetscFunctionBegin;
6290298fd71SBarry Smith   *file = NULL;
6305c6c1daeSBarry Smith   ierr  = PetscTryMethod(viewer,"PetscViewerBinaryGetInfoPointer_C",(PetscViewer,FILE **),(viewer,file));CHKERRQ(ierr);
6315c6c1daeSBarry Smith   PetscFunctionReturn(0);
6325c6c1daeSBarry Smith }
6335c6c1daeSBarry Smith 
6345c6c1daeSBarry Smith static PetscErrorCode PetscViewerFileClose_Binary(PetscViewer v)
6355c6c1daeSBarry Smith {
6365c6c1daeSBarry Smith   PetscViewer_Binary *vbinary = (PetscViewer_Binary*)v->data;
6375c6c1daeSBarry Smith   PetscErrorCode     ierr;
6385c6c1daeSBarry Smith   PetscMPIInt        rank;
6395c6c1daeSBarry Smith   int                err;
6405c6c1daeSBarry Smith 
6415c6c1daeSBarry Smith   PetscFunctionBegin;
642ce94432eSBarry Smith   ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)v),&rank);CHKERRQ(ierr);
6435c6c1daeSBarry Smith   if ((!rank || vbinary->btype == FILE_MODE_READ) && vbinary->fdes) {
6445c6c1daeSBarry Smith     close(vbinary->fdes);
6455c6c1daeSBarry Smith     if (!rank && vbinary->storecompressed) {
6465c6c1daeSBarry Smith       char par[PETSC_MAX_PATH_LEN],buf[PETSC_MAX_PATH_LEN];
6475c6c1daeSBarry Smith       FILE *fp;
6485c6c1daeSBarry Smith       /* compress the file */
6495c6c1daeSBarry Smith       ierr = PetscStrcpy(par,"gzip -f ");CHKERRQ(ierr);
6505c6c1daeSBarry Smith       ierr = PetscStrcat(par,vbinary->filename);CHKERRQ(ierr);
6515c6c1daeSBarry Smith #if defined(PETSC_HAVE_POPEN)
6520298fd71SBarry Smith       ierr = PetscPOpen(PETSC_COMM_SELF,NULL,par,"r",&fp);CHKERRQ(ierr);
6535c6c1daeSBarry Smith       if (fgets(buf,1024,fp)) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_LIB,"Error from command %s\n%s",par,buf);
6540298fd71SBarry Smith       ierr = PetscPClose(PETSC_COMM_SELF,fp,NULL);CHKERRQ(ierr);
6555c6c1daeSBarry Smith #else
6565c6c1daeSBarry Smith       SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP_SYS,"Cannot run external programs on this machine");
6575c6c1daeSBarry Smith #endif
6585c6c1daeSBarry Smith     }
6595c6c1daeSBarry Smith   }
6605c6c1daeSBarry Smith   if (vbinary->fdes_info) {
6615c6c1daeSBarry Smith     err = fclose(vbinary->fdes_info);
6625c6c1daeSBarry Smith     if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
6635c6c1daeSBarry Smith   }
6645c6c1daeSBarry Smith   PetscFunctionReturn(0);
6655c6c1daeSBarry Smith }
6665c6c1daeSBarry Smith 
667e0385b85SDave May #if defined(PETSC_HAVE_MPIIO)
668e0385b85SDave May static PetscErrorCode PetscViewerFileClose_BinaryMPIIO(PetscViewer v)
669e0385b85SDave May {
670e0385b85SDave May   PetscViewer_Binary *vbinary = (PetscViewer_Binary*)v->data;
671e0385b85SDave May   int                err;
672e0385b85SDave May   PetscErrorCode     ierr;
673e0385b85SDave May 
674e0385b85SDave May   PetscFunctionBegin;
675e0385b85SDave May   if (vbinary->mfdes) {
676e0385b85SDave May     ierr = MPI_File_close(&vbinary->mfdes);CHKERRQ(ierr);
677e0385b85SDave May   }
678e0385b85SDave May   if (vbinary->fdes_info) {
679e0385b85SDave May     err = fclose(vbinary->fdes_info);
680e0385b85SDave May     if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
681e0385b85SDave May   }
682e0385b85SDave May   PetscFunctionReturn(0);
683e0385b85SDave May }
684e0385b85SDave May #endif
685e0385b85SDave May 
68681f0254dSBarry Smith static PetscErrorCode PetscViewerDestroy_Binary(PetscViewer v)
6875c6c1daeSBarry Smith {
6885c6c1daeSBarry Smith   PetscViewer_Binary *vbinary = (PetscViewer_Binary*)v->data;
6895c6c1daeSBarry Smith   PetscErrorCode     ierr;
6905c6c1daeSBarry Smith 
6915c6c1daeSBarry Smith   PetscFunctionBegin;
692a261c58fSBarry Smith   if (v->format == PETSC_VIEWER_BINARY_MATLAB) {
693a261c58fSBarry Smith     MPI_Comm comm;
694a261c58fSBarry Smith     FILE     *info;
695a261c58fSBarry Smith 
696a261c58fSBarry Smith     ierr = PetscObjectGetComm((PetscObject)v,&comm);CHKERRQ(ierr);
697a261c58fSBarry Smith     ierr = PetscViewerBinaryGetInfoPointer(v,&info);CHKERRQ(ierr);
698da88d4d4SJed Brown     ierr = PetscFPrintf(comm,info,"#--- begin code written by PetscViewerBinary for MATLAB format ---#\n");CHKERRQ(ierr);
699da88d4d4SJed Brown     ierr = PetscFPrintf(comm,info,"#$$ close(fd);\n");CHKERRQ(ierr);
700da88d4d4SJed Brown     ierr = PetscFPrintf(comm,info,"#--- end code written by PetscViewerBinary for MATLAB format ---#\n\n");CHKERRQ(ierr);
701a261c58fSBarry Smith   }
7025c6c1daeSBarry Smith #if defined(PETSC_HAVE_MPIIO)
703bc196f7cSDave May   if (vbinary->usempiio) {
704e0385b85SDave May     ierr = PetscViewerFileClose_BinaryMPIIO(v);CHKERRQ(ierr);
705e0385b85SDave May   } else {
706e0385b85SDave May #endif
707e0385b85SDave May     ierr = PetscViewerFileClose_Binary(v);CHKERRQ(ierr);
708e0385b85SDave May #if defined(PETSC_HAVE_MPIIO)
7095c6c1daeSBarry Smith   }
7105c6c1daeSBarry Smith #endif
7112259a519SDave May   if (vbinary->filename) { ierr = PetscFree(vbinary->filename);CHKERRQ(ierr); }
712e0385b85SDave May   ierr = PetscFree(vbinary);CHKERRQ(ierr);
713e0385b85SDave May   PetscFunctionReturn(0);
714e0385b85SDave May }
7155c6c1daeSBarry Smith 
7165c6c1daeSBarry Smith /*@C
7175c6c1daeSBarry Smith    PetscViewerBinaryOpen - Opens a file for binary input/output.
7185c6c1daeSBarry Smith 
7195c6c1daeSBarry Smith    Collective on MPI_Comm
7205c6c1daeSBarry Smith 
7215c6c1daeSBarry Smith    Input Parameters:
7225c6c1daeSBarry Smith +  comm - MPI communicator
7235c6c1daeSBarry Smith .  name - name of file
7245c6c1daeSBarry Smith -  type - type of file
7255c6c1daeSBarry Smith $    FILE_MODE_WRITE - create new file for binary output
7265c6c1daeSBarry Smith $    FILE_MODE_READ - open existing file for binary input
7275c6c1daeSBarry Smith $    FILE_MODE_APPEND - open existing file for binary output
7285c6c1daeSBarry Smith 
7295c6c1daeSBarry Smith    Output Parameter:
7305c6c1daeSBarry Smith .  binv - PetscViewer for binary input/output to use with the specified file
7315c6c1daeSBarry Smith 
7325c6c1daeSBarry Smith     Options Database Keys:
733a2d7db39SDave May +    -viewer_binary_filename <name>
734a2d7db39SDave May .    -viewer_binary_skip_info
7355c6c1daeSBarry Smith .    -viewer_binary_skip_options
736a2d7db39SDave May .    -viewer_binary_skip_header
737a2d7db39SDave May -    -viewer_binary_mpiio
7385c6c1daeSBarry Smith 
7395c6c1daeSBarry Smith    Level: beginner
7405c6c1daeSBarry Smith 
7415c6c1daeSBarry Smith    Note:
7425c6c1daeSBarry Smith    This PetscViewer should be destroyed with PetscViewerDestroy().
7435c6c1daeSBarry Smith 
7445c6c1daeSBarry Smith     For reading files, the filename may begin with ftp:// or http:// and/or
7455c6c1daeSBarry Smith     end with .gz; in this case file is brought over and uncompressed.
7465c6c1daeSBarry Smith 
7475c6c1daeSBarry Smith     For creating files, if the file name ends with .gz it is automatically
7485c6c1daeSBarry Smith     compressed when closed.
7495c6c1daeSBarry Smith 
7505c6c1daeSBarry Smith     For writing files it only opens the file on processor 0 in the communicator.
7515c6c1daeSBarry Smith     For readable files it opens the file on all nodes that have the file. If
7525c6c1daeSBarry Smith     node 0 does not have the file it generates an error even if other nodes
7535c6c1daeSBarry Smith     do have the file.
7545c6c1daeSBarry Smith 
7555c6c1daeSBarry Smith    Concepts: binary files
7565c6c1daeSBarry Smith    Concepts: PetscViewerBinary^creating
7575c6c1daeSBarry Smith    Concepts: gzip
7585c6c1daeSBarry Smith    Concepts: accessing remote file
7595c6c1daeSBarry Smith    Concepts: remote file
7605c6c1daeSBarry Smith 
7616a9046bcSBarry Smith .seealso: PetscViewerASCIIOpen(), PetscViewerPushFormat(), PetscViewerDestroy(),
7625c6c1daeSBarry Smith           VecView(), MatView(), VecLoad(), MatLoad(), PetscViewerBinaryGetDescriptor(),
76367918a83SBarry Smith           PetscViewerBinaryGetInfoPointer(), PetscFileMode, PetscViewer, PetscViewerBinaryRead(), PetscViewerBinarySetUseMPIIO(),
76467918a83SBarry Smith           PetscViewerBinaryGetUseMPIIO(), PetscViewerBinaryGetMPIIOOffset()
7655c6c1daeSBarry Smith @*/
7665c6c1daeSBarry Smith PetscErrorCode PetscViewerBinaryOpen(MPI_Comm comm,const char name[],PetscFileMode type,PetscViewer *binv)
7675c6c1daeSBarry Smith {
7685c6c1daeSBarry Smith   PetscErrorCode ierr;
7695c6c1daeSBarry Smith 
7705c6c1daeSBarry Smith   PetscFunctionBegin;
7715c6c1daeSBarry Smith   ierr = PetscViewerCreate(comm,binv);CHKERRQ(ierr);
7725c6c1daeSBarry Smith   ierr = PetscViewerSetType(*binv,PETSCVIEWERBINARY);CHKERRQ(ierr);
7735c6c1daeSBarry Smith   ierr = PetscViewerFileSetMode(*binv,type);CHKERRQ(ierr);
7745c6c1daeSBarry Smith   ierr = PetscViewerFileSetName(*binv,name);CHKERRQ(ierr);
77503a1d59fSDave May   ierr = PetscViewerSetFromOptions(*binv);CHKERRQ(ierr);
7765c6c1daeSBarry Smith   PetscFunctionReturn(0);
7775c6c1daeSBarry Smith }
7785c6c1daeSBarry Smith 
7795c6c1daeSBarry Smith #if defined(PETSC_HAVE_MPIIO)
780060da220SMatthew G. Knepley static PetscErrorCode PetscViewerBinaryWriteReadMPIIO(PetscViewer viewer,void *data,PetscInt num,PetscInt *count,PetscDataType dtype,PetscBool write)
7815c6c1daeSBarry Smith {
7825c6c1daeSBarry Smith   PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data;
7835c6c1daeSBarry Smith   PetscErrorCode     ierr;
7845c6c1daeSBarry Smith   MPI_Datatype       mdtype;
785e597bc1dSJed Brown   PetscMPIInt        cnt;
7865c6c1daeSBarry Smith   MPI_Status         status;
7875c6c1daeSBarry Smith   MPI_Aint           ul,dsize;
7885c6c1daeSBarry Smith 
7895c6c1daeSBarry Smith   PetscFunctionBegin;
790060da220SMatthew G. Knepley   ierr = PetscMPIIntCast(num,&cnt);CHKERRQ(ierr);
7915c6c1daeSBarry Smith   ierr = PetscDataTypeToMPIDataType(dtype,&mdtype);CHKERRQ(ierr);
7925c6c1daeSBarry Smith   ierr = MPI_File_set_view(vbinary->mfdes,vbinary->moff,mdtype,mdtype,(char*)"native",MPI_INFO_NULL);CHKERRQ(ierr);
7935c6c1daeSBarry Smith   if (write) {
7945c6c1daeSBarry Smith     ierr = MPIU_File_write_all(vbinary->mfdes,data,cnt,mdtype,&status);CHKERRQ(ierr);
7955c6c1daeSBarry Smith   } else {
7965c6c1daeSBarry Smith     ierr = MPIU_File_read_all(vbinary->mfdes,data,cnt,mdtype,&status);CHKERRQ(ierr);
7975c6c1daeSBarry Smith   }
7985c6c1daeSBarry Smith   ierr = MPI_Type_get_extent(mdtype,&ul,&dsize);CHKERRQ(ierr);
799a297a907SKarl Rupp 
8005c6c1daeSBarry Smith   vbinary->moff += dsize*cnt;
801060da220SMatthew G. Knepley   if (count) *count = num;
8025c6c1daeSBarry Smith   PetscFunctionReturn(0);
8035c6c1daeSBarry Smith }
8045c6c1daeSBarry Smith #endif
8055c6c1daeSBarry Smith 
8065c6c1daeSBarry Smith /*@C
8075c6c1daeSBarry Smith    PetscViewerBinaryRead - Reads from a binary file, all processors get the same result
8085c6c1daeSBarry Smith 
8095c6c1daeSBarry Smith    Collective on MPI_Comm
8105c6c1daeSBarry Smith 
8115c6c1daeSBarry Smith    Input Parameters:
8125c6c1daeSBarry Smith +  viewer - the binary viewer
813907376e6SBarry Smith .  data - location of the data to be written
814060da220SMatthew G. Knepley .  num - number of items of data to read
815907376e6SBarry Smith -  dtype - type of data to read
8165c6c1daeSBarry Smith 
817f8e4bde8SMatthew G. Knepley    Output Parameters:
8180780a867SBarry Smith .  count - number of items of data actually read, or NULL. Unless an error is generated this is always set to the input parameter num.
819f8e4bde8SMatthew G. Knepley 
8205c6c1daeSBarry Smith    Level: beginner
8215c6c1daeSBarry Smith 
8225c6c1daeSBarry Smith    Concepts: binary files
8235c6c1daeSBarry Smith 
8240780a867SBarry Smith    Developer Note: Since count is always set to num it is not clear what purpose the output argument count serves.
8250780a867SBarry Smith 
8266a9046bcSBarry Smith .seealso: PetscViewerASCIIOpen(), PetscViewerPushFormat(), PetscViewerDestroy(),
8275c6c1daeSBarry Smith           VecView(), MatView(), VecLoad(), MatLoad(), PetscViewerBinaryGetDescriptor(),
8285c6c1daeSBarry Smith           PetscViewerBinaryGetInfoPointer(), PetscFileMode, PetscViewer, PetscBinaryViewerRead()
8295c6c1daeSBarry Smith @*/
830060da220SMatthew G. Knepley PetscErrorCode PetscViewerBinaryRead(PetscViewer viewer,void *data,PetscInt num,PetscInt *count,PetscDataType dtype)
8315c6c1daeSBarry Smith {
8325c6c1daeSBarry Smith   PetscErrorCode     ierr;
8335c6c1daeSBarry Smith   PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data;
8345c6c1daeSBarry Smith 
835c98fd787SBarry Smith   ierr = PetscViewerSetUp(viewer);CHKERRQ(ierr);
8365c6c1daeSBarry Smith #if defined(PETSC_HAVE_MPIIO)
837bc196f7cSDave May   if (vbinary->usempiio) {
838060da220SMatthew G. Knepley     ierr = PetscViewerBinaryWriteReadMPIIO(viewer,data,num,count,dtype,PETSC_FALSE);CHKERRQ(ierr);
8395c6c1daeSBarry Smith   } else {
8405c6c1daeSBarry Smith #endif
841060da220SMatthew G. Knepley     ierr = PetscBinarySynchronizedRead(PetscObjectComm((PetscObject)viewer),vbinary->fdes,data,num,dtype);CHKERRQ(ierr);
8420780a867SBarry Smith     if (count) *count = num;
8435c6c1daeSBarry Smith #if defined(PETSC_HAVE_MPIIO)
8445c6c1daeSBarry Smith   }
8455c6c1daeSBarry Smith #endif
8465c6c1daeSBarry Smith   PetscFunctionReturn(0);
8475c6c1daeSBarry Smith }
8485c6c1daeSBarry Smith 
8495c6c1daeSBarry Smith /*@C
8505c6c1daeSBarry Smith    PetscViewerBinaryWrite - writes to a binary file, only from the first process
8515c6c1daeSBarry Smith 
8525c6c1daeSBarry Smith    Collective on MPI_Comm
8535c6c1daeSBarry Smith 
8545c6c1daeSBarry Smith    Input Parameters:
8555c6c1daeSBarry Smith +  viewer - the binary viewer
8565c6c1daeSBarry Smith .  data - location of data
8575824c9d0SPatrick Sanan .  count - number of items of data to write
8585824c9d0SPatrick Sanan .  dtype - type of data to write
8595c6c1daeSBarry Smith -  istemp - data may be overwritten
8605c6c1daeSBarry Smith 
8615c6c1daeSBarry Smith    Level: beginner
8625c6c1daeSBarry Smith 
8635c6c1daeSBarry Smith    Notes: because byte-swapping may be done on the values in data it cannot be declared const
8645c6c1daeSBarry Smith 
8655c6c1daeSBarry Smith    Concepts: binary files
8665c6c1daeSBarry Smith 
8676a9046bcSBarry Smith .seealso: PetscViewerASCIIOpen(), PetscViewerPushFormat(), PetscViewerDestroy(),
8685c6c1daeSBarry Smith           VecView(), MatView(), VecLoad(), MatLoad(), PetscViewerBinaryGetDescriptor(), PetscDataType
8695c6c1daeSBarry Smith           PetscViewerBinaryGetInfoPointer(), PetscFileMode, PetscViewer, PetscBinaryViewerRead()
8705c6c1daeSBarry Smith @*/
8715c6c1daeSBarry Smith PetscErrorCode PetscViewerBinaryWrite(PetscViewer viewer,void *data,PetscInt count,PetscDataType dtype,PetscBool istemp)
8725c6c1daeSBarry Smith {
8735c6c1daeSBarry Smith   PetscErrorCode     ierr;
8745c6c1daeSBarry Smith   PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data;
8755c6c1daeSBarry Smith 
8765c6c1daeSBarry Smith   PetscFunctionBegin;
877c98fd787SBarry Smith   ierr = PetscViewerSetUp(viewer);CHKERRQ(ierr);
8785c6c1daeSBarry Smith #if defined(PETSC_HAVE_MPIIO)
879bc196f7cSDave May   if (vbinary->usempiio) {
880060da220SMatthew G. Knepley     ierr = PetscViewerBinaryWriteReadMPIIO(viewer,data,count,NULL,dtype,PETSC_TRUE);CHKERRQ(ierr);
8815c6c1daeSBarry Smith   } else {
8825c6c1daeSBarry Smith #endif
883ce94432eSBarry Smith     ierr = PetscBinarySynchronizedWrite(PetscObjectComm((PetscObject)viewer),vbinary->fdes,data,count,dtype,istemp);CHKERRQ(ierr);
8845c6c1daeSBarry Smith #if defined(PETSC_HAVE_MPIIO)
8855c6c1daeSBarry Smith   }
8865c6c1daeSBarry Smith #endif
8875c6c1daeSBarry Smith   PetscFunctionReturn(0);
8885c6c1daeSBarry Smith }
8895c6c1daeSBarry Smith 
8905c6c1daeSBarry Smith /*@C
8915c6c1daeSBarry Smith    PetscViewerBinaryWriteStringArray - writes to a binary file, only from the first process an array of strings
8925c6c1daeSBarry Smith 
8935c6c1daeSBarry Smith    Collective on MPI_Comm
8945c6c1daeSBarry Smith 
8955c6c1daeSBarry Smith    Input Parameters:
8965c6c1daeSBarry Smith +  viewer - the binary viewer
8975c6c1daeSBarry Smith -  data - location of the array of strings
8985c6c1daeSBarry Smith 
8995c6c1daeSBarry Smith 
9005c6c1daeSBarry Smith    Level: intermediate
9015c6c1daeSBarry Smith 
9025c6c1daeSBarry Smith    Concepts: binary files
9035c6c1daeSBarry Smith 
9045c6c1daeSBarry Smith     Notes: array of strings is null terminated
9055c6c1daeSBarry Smith 
9066a9046bcSBarry Smith .seealso: PetscViewerASCIIOpen(), PetscViewerPushFormat(), PetscViewerDestroy(),
9075c6c1daeSBarry Smith           VecView(), MatView(), VecLoad(), MatLoad(), PetscViewerBinaryGetDescriptor(),
9085c6c1daeSBarry Smith           PetscViewerBinaryGetInfoPointer(), PetscFileMode, PetscViewer, PetscBinaryViewerRead()
9095c6c1daeSBarry Smith @*/
910*78fbdcc8SBarry Smith PetscErrorCode PetscViewerBinaryWriteStringArray(PetscViewer viewer,const char * const *data)
9115c6c1daeSBarry Smith {
9125c6c1daeSBarry Smith   PetscErrorCode ierr;
9135c6c1daeSBarry Smith   PetscInt       i,n = 0,*sizes;
9145c6c1daeSBarry Smith 
915c98fd787SBarry Smith   ierr = PetscViewerSetUp(viewer);CHKERRQ(ierr);
9165c6c1daeSBarry Smith   /* count number of strings */
9175c6c1daeSBarry Smith   while (data[n++]) ;
9185c6c1daeSBarry Smith   n--;
919854ce69bSBarry Smith   ierr     = PetscMalloc1(n+1,&sizes);CHKERRQ(ierr);
9205c6c1daeSBarry Smith   sizes[0] = n;
9215c6c1daeSBarry Smith   for (i=0; i<n; i++) {
9225c6c1daeSBarry Smith     size_t tmp;
9235c6c1daeSBarry Smith     ierr       = PetscStrlen(data[i],&tmp);CHKERRQ(ierr);
9245c6c1daeSBarry Smith     sizes[i+1] = tmp + 1;   /* size includes space for the null terminator */
9255c6c1daeSBarry Smith   }
9265c6c1daeSBarry Smith   ierr = PetscViewerBinaryWrite(viewer,sizes,n+1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr);
9275c6c1daeSBarry Smith   for (i=0; i<n; i++) {
928*78fbdcc8SBarry Smith     ierr = PetscViewerBinaryWrite(viewer,(void*)data[i],sizes[i+1],PETSC_CHAR,PETSC_FALSE);CHKERRQ(ierr);
9295c6c1daeSBarry Smith   }
9305c6c1daeSBarry Smith   ierr = PetscFree(sizes);CHKERRQ(ierr);
9315c6c1daeSBarry Smith   PetscFunctionReturn(0);
9325c6c1daeSBarry Smith }
9335c6c1daeSBarry Smith 
9345c6c1daeSBarry Smith /*@C
9355c6c1daeSBarry Smith    PetscViewerBinaryReadStringArray - reads a binary file an array of strings
9365c6c1daeSBarry Smith 
9375c6c1daeSBarry Smith    Collective on MPI_Comm
9385c6c1daeSBarry Smith 
9395c6c1daeSBarry Smith    Input Parameter:
9405c6c1daeSBarry Smith .  viewer - the binary viewer
9415c6c1daeSBarry Smith 
9425c6c1daeSBarry Smith    Output Parameter:
9435c6c1daeSBarry Smith .  data - location of the array of strings
9445c6c1daeSBarry Smith 
9455c6c1daeSBarry Smith    Level: intermediate
9465c6c1daeSBarry Smith 
9475c6c1daeSBarry Smith    Concepts: binary files
9485c6c1daeSBarry Smith 
9495c6c1daeSBarry Smith     Notes: array of strings is null terminated
9505c6c1daeSBarry Smith 
9516a9046bcSBarry Smith .seealso: PetscViewerASCIIOpen(), PetscViewerPushFormat(), PetscViewerDestroy(),
9525c6c1daeSBarry Smith           VecView(), MatView(), VecLoad(), MatLoad(), PetscViewerBinaryGetDescriptor(),
9535c6c1daeSBarry Smith           PetscViewerBinaryGetInfoPointer(), PetscFileMode, PetscViewer, PetscBinaryViewerRead()
9545c6c1daeSBarry Smith @*/
9555c6c1daeSBarry Smith PetscErrorCode PetscViewerBinaryReadStringArray(PetscViewer viewer,char ***data)
9565c6c1daeSBarry Smith {
9575c6c1daeSBarry Smith   PetscErrorCode ierr;
958060da220SMatthew G. Knepley   PetscInt       i,n,*sizes,N = 0;
9595c6c1daeSBarry Smith 
960c98fd787SBarry Smith   ierr = PetscViewerSetUp(viewer);CHKERRQ(ierr);
9615c6c1daeSBarry Smith   /* count number of strings */
962060da220SMatthew G. Knepley   ierr = PetscViewerBinaryRead(viewer,&n,1,NULL,PETSC_INT);CHKERRQ(ierr);
963785e854fSJed Brown   ierr = PetscMalloc1(n,&sizes);CHKERRQ(ierr);
964060da220SMatthew G. Knepley   ierr = PetscViewerBinaryRead(viewer,sizes,n,NULL,PETSC_INT);CHKERRQ(ierr);
965a297a907SKarl Rupp   for (i=0; i<n; i++) N += sizes[i];
966854ce69bSBarry Smith   ierr = PetscMalloc((n+1)*sizeof(char*) + N*sizeof(char),data);CHKERRQ(ierr);
9675c6c1daeSBarry Smith   (*data)[0] = (char*)((*data) + n + 1);
968a297a907SKarl Rupp   for (i=1; i<n; i++) (*data)[i] = (*data)[i-1] + sizes[i-1];
969060da220SMatthew G. Knepley   ierr = PetscViewerBinaryRead(viewer,(*data)[0],N,NULL,PETSC_CHAR);CHKERRQ(ierr);
970a297a907SKarl Rupp 
9715c6c1daeSBarry Smith   (*data)[n] = 0;
972a297a907SKarl Rupp 
9735c6c1daeSBarry Smith   ierr = PetscFree(sizes);CHKERRQ(ierr);
9745c6c1daeSBarry Smith   PetscFunctionReturn(0);
9755c6c1daeSBarry Smith }
9765c6c1daeSBarry Smith 
97781f0254dSBarry Smith static PetscErrorCode PetscViewerFileGetName_Binary(PetscViewer viewer,const char **name)
9785c6c1daeSBarry Smith {
9795c6c1daeSBarry Smith   PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data;
9805c6c1daeSBarry Smith 
9815c6c1daeSBarry Smith   PetscFunctionBegin;
9825c6c1daeSBarry Smith   *name = vbinary->filename;
9835c6c1daeSBarry Smith   PetscFunctionReturn(0);
9845c6c1daeSBarry Smith }
9855c6c1daeSBarry Smith 
9865c6c1daeSBarry Smith /*@C
9875c6c1daeSBarry Smith      PetscViewerFileGetMode - Gets the type of file to be open
9885c6c1daeSBarry Smith 
9895c6c1daeSBarry Smith     Not Collective
9905c6c1daeSBarry Smith 
9915c6c1daeSBarry Smith   Input Parameter:
992232ac771SBarry Smith .  viewer - the PetscViewer; must be a PETSCVIEWERBINARY, PETSCVIEWERMATLAB, PETSCVIEWERHDF5, or PETSCVIEWERASCII  PetscViewer
9935c6c1daeSBarry Smith 
9945c6c1daeSBarry Smith   Output Parameter:
9955c6c1daeSBarry Smith .  type - type of file
9965c6c1daeSBarry Smith $    FILE_MODE_WRITE - create new file for binary output
9975c6c1daeSBarry Smith $    FILE_MODE_READ - open existing file for binary input
9985c6c1daeSBarry Smith $    FILE_MODE_APPEND - open existing file for binary output
9995c6c1daeSBarry Smith 
10005c6c1daeSBarry Smith   Level: advanced
10015c6c1daeSBarry Smith 
10025c6c1daeSBarry Smith .seealso: PetscViewerFileSetMode(), PetscViewerCreate(), PetscViewerSetType(), PetscViewerBinaryOpen()
10035c6c1daeSBarry Smith 
10045c6c1daeSBarry Smith @*/
10055c6c1daeSBarry Smith PetscErrorCode PetscViewerFileGetMode(PetscViewer viewer,PetscFileMode *type)
10065c6c1daeSBarry Smith {
10075c6c1daeSBarry Smith   PetscErrorCode ierr;
10085c6c1daeSBarry Smith 
10095c6c1daeSBarry Smith   PetscFunctionBegin;
10105c6c1daeSBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
10115c6c1daeSBarry Smith   PetscValidPointer(type,2);
10125c6c1daeSBarry Smith   ierr = PetscUseMethod(viewer,"PetscViewerFileGetMode_C",(PetscViewer,PetscFileMode*),(viewer,type));CHKERRQ(ierr);
10135c6c1daeSBarry Smith   PetscFunctionReturn(0);
10145c6c1daeSBarry Smith }
10155c6c1daeSBarry Smith 
10165c6c1daeSBarry Smith /*@
1017bc196f7cSDave May     PetscViewerBinarySetUseMPIIO - Sets a binary viewer to use MPI-IO for reading/writing. Must be called
10185c6c1daeSBarry Smith         before PetscViewerFileSetName()
10195c6c1daeSBarry Smith 
10205c6c1daeSBarry Smith     Logically Collective on PetscViewer
10215c6c1daeSBarry Smith 
10225c6c1daeSBarry Smith     Input Parameters:
1023bc196f7cSDave May +   viewer - the PetscViewer; must be a binary
1024bc196f7cSDave May -   flg - PETSC_TRUE means MPI-IO will be used
10255c6c1daeSBarry Smith 
10265c6c1daeSBarry Smith     Options Database:
10275c6c1daeSBarry Smith     -viewer_binary_mpiio : Flag for using MPI-IO
10285c6c1daeSBarry Smith 
10295c6c1daeSBarry Smith     Level: advanced
10305c6c1daeSBarry Smith 
1031bc196f7cSDave May .seealso: PetscViewerFileSetMode(), PetscViewerCreate(), PetscViewerSetType(), PetscViewerBinaryOpen(),
1032bc196f7cSDave May           PetscViewerBinaryGetUseMPIIO()
10335c6c1daeSBarry Smith 
10345c6c1daeSBarry Smith @*/
1035bc196f7cSDave May PetscErrorCode PetscViewerBinarySetUseMPIIO(PetscViewer viewer,PetscBool flg)
10365c6c1daeSBarry Smith {
10375c6c1daeSBarry Smith   PetscErrorCode ierr;
10385c6c1daeSBarry Smith 
10395c6c1daeSBarry Smith   PetscFunctionBegin;
10405c6c1daeSBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
1041bc196f7cSDave May   ierr = PetscTryMethod(viewer,"PetscViewerBinarySetUseMPIIO_C",(PetscViewer,PetscBool),(viewer,flg));CHKERRQ(ierr);
10425c6c1daeSBarry Smith   PetscFunctionReturn(0);
10435c6c1daeSBarry Smith }
10445c6c1daeSBarry Smith 
10455c6c1daeSBarry Smith /*@C
10465c6c1daeSBarry Smith      PetscViewerFileSetMode - Sets the type of file to be open
10475c6c1daeSBarry Smith 
10485c6c1daeSBarry Smith     Logically Collective on PetscViewer
10495c6c1daeSBarry Smith 
10505c6c1daeSBarry Smith   Input Parameters:
1051232ac771SBarry Smith +  viewer - the PetscViewer; must be a a PETSCVIEWERBINARY, PETSCVIEWERMATLAB, PETSCVIEWERHDF5, or PETSCVIEWERASCII  PetscViewer
10525c6c1daeSBarry Smith -  type - type of file
10535c6c1daeSBarry Smith $    FILE_MODE_WRITE - create new file for binary output
10545c6c1daeSBarry Smith $    FILE_MODE_READ - open existing file for binary input
10555c6c1daeSBarry Smith $    FILE_MODE_APPEND - open existing file for binary output
10565c6c1daeSBarry Smith 
10575c6c1daeSBarry Smith   Level: advanced
10585c6c1daeSBarry Smith 
10595c6c1daeSBarry Smith .seealso: PetscViewerFileSetMode(), PetscViewerCreate(), PetscViewerSetType(), PetscViewerBinaryOpen()
10605c6c1daeSBarry Smith 
10615c6c1daeSBarry Smith @*/
10625c6c1daeSBarry Smith PetscErrorCode PetscViewerFileSetMode(PetscViewer viewer,PetscFileMode type)
10635c6c1daeSBarry Smith {
10645c6c1daeSBarry Smith   PetscErrorCode ierr;
10655c6c1daeSBarry Smith 
10665c6c1daeSBarry Smith   PetscFunctionBegin;
10675c6c1daeSBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
10685c6c1daeSBarry Smith   PetscValidLogicalCollectiveEnum(viewer,type,2);
10695c6c1daeSBarry Smith   ierr = PetscTryMethod(viewer,"PetscViewerFileSetMode_C",(PetscViewer,PetscFileMode),(viewer,type));CHKERRQ(ierr);
10705c6c1daeSBarry Smith   PetscFunctionReturn(0);
10715c6c1daeSBarry Smith }
10725c6c1daeSBarry Smith 
107381f0254dSBarry Smith static PetscErrorCode PetscViewerFileGetMode_Binary(PetscViewer viewer,PetscFileMode *type)
10745c6c1daeSBarry Smith {
10755c6c1daeSBarry Smith   PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data;
10765c6c1daeSBarry Smith 
10775c6c1daeSBarry Smith   PetscFunctionBegin;
10785c6c1daeSBarry Smith   *type = vbinary->btype;
10795c6c1daeSBarry Smith   PetscFunctionReturn(0);
10805c6c1daeSBarry Smith }
10815c6c1daeSBarry Smith 
108281f0254dSBarry Smith static PetscErrorCode PetscViewerFileSetMode_Binary(PetscViewer viewer,PetscFileMode type)
10835c6c1daeSBarry Smith {
10845c6c1daeSBarry Smith   PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data;
10855c6c1daeSBarry Smith 
10865c6c1daeSBarry Smith   PetscFunctionBegin;
10875c6c1daeSBarry Smith   vbinary->btype = type;
10885c6c1daeSBarry Smith   PetscFunctionReturn(0);
10895c6c1daeSBarry Smith }
10905c6c1daeSBarry Smith 
109181f0254dSBarry Smith static PetscErrorCode PetscViewerFileSetName_Binary(PetscViewer viewer,const char name[])
1092e0385b85SDave May {
1093e0385b85SDave May   PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data;
1094e0385b85SDave May   PetscErrorCode     ierr;
1095e0385b85SDave May 
1096e0385b85SDave May   PetscFunctionBegin;
1097c0e89164SDave May   if (vbinary->filename) { ierr = PetscFree(vbinary->filename);CHKERRQ(ierr); }
1098e0385b85SDave May   ierr = PetscStrallocpy(name,&vbinary->filename);CHKERRQ(ierr);
1099e0385b85SDave May   PetscFunctionReturn(0);
1100e0385b85SDave May }
11015c6c1daeSBarry Smith /*
11025c6c1daeSBarry Smith         Actually opens the file
11035c6c1daeSBarry Smith */
1104e0877f53SBarry Smith static PetscErrorCode PetscViewerFileSetUp_Binary(PetscViewer viewer)
11055c6c1daeSBarry Smith {
11065c6c1daeSBarry Smith   PetscMPIInt        rank;
11075c6c1daeSBarry Smith   PetscErrorCode     ierr;
11085c6c1daeSBarry Smith   size_t             len;
11095c6c1daeSBarry Smith   PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data;
11105c6c1daeSBarry Smith   const char         *fname;
11112259a519SDave May   char               bname[PETSC_MAX_PATH_LEN],*gz;
11125c6c1daeSBarry Smith   PetscBool          found;
11135c6c1daeSBarry Smith   PetscFileMode      type = vbinary->btype;
11145c6c1daeSBarry Smith 
11155c6c1daeSBarry Smith   PetscFunctionBegin;
1116e0385b85SDave May   if (type == (PetscFileMode) -1) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"Must call PetscViewerFileSetMode()");
11172259a519SDave May   if (!vbinary->filename) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"Must call PetscViewerFileSetName()");
11185c6c1daeSBarry Smith   ierr = PetscViewerFileClose_Binary(viewer);CHKERRQ(ierr);
11195c6c1daeSBarry Smith 
1120ce94432eSBarry Smith   ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)viewer),&rank);CHKERRQ(ierr);
11215c6c1daeSBarry Smith 
11225c6c1daeSBarry Smith   /* if ends in .gz strip that off and note user wants file compressed */
11235c6c1daeSBarry Smith   vbinary->storecompressed = PETSC_FALSE;
11245c6c1daeSBarry Smith   if (!rank && type == FILE_MODE_WRITE) {
11255c6c1daeSBarry Smith     /* remove .gz if it ends library name */
11265c6c1daeSBarry Smith     ierr = PetscStrstr(vbinary->filename,".gz",&gz);CHKERRQ(ierr);
11275c6c1daeSBarry Smith     if (gz) {
11285c6c1daeSBarry Smith       ierr = PetscStrlen(gz,&len);CHKERRQ(ierr);
11295c6c1daeSBarry Smith       if (len == 3) {
11305c6c1daeSBarry Smith         *gz = 0;
11315c6c1daeSBarry Smith         vbinary->storecompressed = PETSC_TRUE;
11325c6c1daeSBarry Smith       }
11335c6c1daeSBarry Smith     }
11345c6c1daeSBarry Smith   }
11355c6c1daeSBarry Smith 
11365c6c1daeSBarry Smith   /* only first processor opens file if writeable */
11375c6c1daeSBarry Smith   if (!rank || type == FILE_MODE_READ) {
11385c6c1daeSBarry Smith 
11395c6c1daeSBarry Smith     if (type == FILE_MODE_READ) {
11405c6c1daeSBarry Smith       /* possibly get the file from remote site or compressed file */
1141ce94432eSBarry Smith       ierr  = PetscFileRetrieve(PetscObjectComm((PetscObject)viewer),vbinary->filename,bname,PETSC_MAX_PATH_LEN,&found);CHKERRQ(ierr);
11425c6c1daeSBarry Smith       fname = bname;
11435c6c1daeSBarry Smith       if (!rank && !found) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot locate file: %s on node zero",vbinary->filename);
11445c6c1daeSBarry Smith       else if (!found) {
11455c6c1daeSBarry Smith         ierr  = PetscInfo(viewer,"Nonzero processor did not locate readonly file\n");CHKERRQ(ierr);
11465c6c1daeSBarry Smith         fname = 0;
11475c6c1daeSBarry Smith       }
1148a297a907SKarl Rupp     } else fname = vbinary->filename;
11495c6c1daeSBarry Smith 
11505c6c1daeSBarry Smith #if defined(PETSC_HAVE_O_BINARY)
11515c6c1daeSBarry Smith     if (type == FILE_MODE_WRITE) {
11525c6c1daeSBarry Smith       if ((vbinary->fdes = open(fname,O_WRONLY|O_CREAT|O_TRUNC|O_BINARY,0666)) == -1) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot create file %s for writing",fname);
11535c6c1daeSBarry Smith     } else if (type == FILE_MODE_READ && fname) {
11545c6c1daeSBarry Smith       if ((vbinary->fdes = open(fname,O_RDONLY|O_BINARY,0)) == -1) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open file %s for reading",fname);
11555c6c1daeSBarry Smith     } else if (type == FILE_MODE_APPEND) {
11565c6c1daeSBarry Smith       if ((vbinary->fdes = open(fname,O_WRONLY|O_APPEND|O_BINARY,0)) == -1) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open file %s for writing",fname);
11575c6c1daeSBarry Smith     } else if (fname) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Unknown file type");
11585c6c1daeSBarry Smith #else
11595c6c1daeSBarry Smith     if (type == FILE_MODE_WRITE) {
11605c6c1daeSBarry Smith       if ((vbinary->fdes = creat(fname,0666)) == -1) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot create file %s for writing",fname);
11615c6c1daeSBarry Smith     } else if (type == FILE_MODE_READ && fname) {
11625c6c1daeSBarry Smith       if ((vbinary->fdes = open(fname,O_RDONLY,0)) == -1) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open file %s for reading",fname);
11635c6c1daeSBarry Smith     } else if (type == FILE_MODE_APPEND) {
11645c6c1daeSBarry Smith       if ((vbinary->fdes = open(fname,O_WRONLY|O_APPEND,0)) == -1) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open file %s for writing",fname);
11655c6c1daeSBarry Smith     } else if (fname) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Unknown file type");
11665c6c1daeSBarry Smith #endif
11675c6c1daeSBarry Smith   } else vbinary->fdes = -1;
11685c6c1daeSBarry Smith 
11695c6c1daeSBarry Smith   /*
11705c6c1daeSBarry Smith       try to open info file: all processors open this file if read only
11715c6c1daeSBarry Smith   */
11725c6c1daeSBarry Smith   if (!vbinary->skipinfo && (!rank || type == FILE_MODE_READ)) {
11735c6c1daeSBarry Smith     char infoname[PETSC_MAX_PATH_LEN],iname[PETSC_MAX_PATH_LEN];
11745c6c1daeSBarry Smith 
1175e0385b85SDave May     ierr = PetscStrcpy(infoname,vbinary->filename);CHKERRQ(ierr);
11765c6c1daeSBarry Smith     /* remove .gz if it ends library name */
11775c6c1daeSBarry Smith     ierr = PetscStrstr(infoname,".gz",&gz);CHKERRQ(ierr);
11785c6c1daeSBarry Smith     if (gz) {
11795c6c1daeSBarry Smith       ierr = PetscStrlen(gz,&len);CHKERRQ(ierr);
1180a297a907SKarl Rupp       if (len == 3) *gz = 0;
11815c6c1daeSBarry Smith     }
11825c6c1daeSBarry Smith 
11835c6c1daeSBarry Smith     ierr = PetscStrcat(infoname,".info");CHKERRQ(ierr);
11845c6c1daeSBarry Smith     ierr = PetscFixFilename(infoname,iname);CHKERRQ(ierr);
11855c6c1daeSBarry Smith     if (type == FILE_MODE_READ) {
1186ce94432eSBarry Smith       ierr = PetscFileRetrieve(PetscObjectComm((PetscObject)viewer),iname,infoname,PETSC_MAX_PATH_LEN,&found);CHKERRQ(ierr);
1187c5929fdfSBarry Smith       ierr = PetscOptionsInsertFile(PetscObjectComm((PetscObject)viewer),((PetscObject)viewer)->options,infoname,PETSC_FALSE);CHKERRQ(ierr);
11885c6c1daeSBarry Smith     } else {
11895c6c1daeSBarry Smith       vbinary->fdes_info = fopen(infoname,"w");
11905c6c1daeSBarry Smith       if (!vbinary->fdes_info) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open .info file %s for writing",infoname);
11915c6c1daeSBarry Smith     }
11925c6c1daeSBarry Smith   }
11935c6c1daeSBarry Smith #if defined(PETSC_USE_LOG)
1194e0385b85SDave May   PetscLogObjectState((PetscObject)viewer,"File: %s",vbinary->filename);
11955c6c1daeSBarry Smith #endif
11965c6c1daeSBarry Smith   PetscFunctionReturn(0);
11975c6c1daeSBarry Smith }
11985c6c1daeSBarry Smith 
11995c6c1daeSBarry Smith #if defined(PETSC_HAVE_MPIIO)
1200e0385b85SDave May static PetscErrorCode PetscViewerFileSetUp_BinaryMPIIO(PetscViewer viewer)
12015c6c1daeSBarry Smith {
12025c6c1daeSBarry Smith   PetscMPIInt        rank;
12035c6c1daeSBarry Smith   PetscErrorCode     ierr;
12045c6c1daeSBarry Smith   size_t             len;
12055c6c1daeSBarry Smith   PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data;
12062259a519SDave May   char               *gz;
12075c6c1daeSBarry Smith   PetscBool          found;
12085c6c1daeSBarry Smith   PetscFileMode      type = vbinary->btype;
12095c6c1daeSBarry Smith 
12105c6c1daeSBarry Smith   PetscFunctionBegin;
1211e0385b85SDave May   if (type == (PetscFileMode) -1) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"Must call PetscViewerFileSetMode()");
12122259a519SDave May   if (!vbinary->filename) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"Must call PetscViewerFileSetName()");
1213e0385b85SDave May   ierr = PetscViewerFileClose_BinaryMPIIO(viewer);CHKERRQ(ierr);
12145c6c1daeSBarry Smith 
1215ce94432eSBarry Smith   ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)viewer),&rank);CHKERRQ(ierr);
12165c6c1daeSBarry Smith 
1217a297a907SKarl Rupp   vbinary->storecompressed = PETSC_FALSE;
12185c6c1daeSBarry Smith 
12195c6c1daeSBarry Smith   /* only first processor opens file if writeable */
12205c6c1daeSBarry Smith   if (type == FILE_MODE_READ) {
1221ce94432eSBarry Smith     MPI_File_open(PetscObjectComm((PetscObject)viewer),vbinary->filename,MPI_MODE_RDONLY,MPI_INFO_NULL,&vbinary->mfdes);CHKERRQ(ierr);
12225c6c1daeSBarry Smith   } else if (type == FILE_MODE_WRITE) {
1223ce94432eSBarry Smith     MPI_File_open(PetscObjectComm((PetscObject)viewer),vbinary->filename,MPI_MODE_WRONLY | MPI_MODE_CREATE,MPI_INFO_NULL,&vbinary->mfdes);CHKERRQ(ierr);
12245c6c1daeSBarry Smith   }
12255c6c1daeSBarry Smith 
12265c6c1daeSBarry Smith   /*
12275c6c1daeSBarry Smith       try to open info file: all processors open this file if read only
12285c6c1daeSBarry Smith 
1229bebe2cf6SSatish Balay       Below is identical code to the code for Binary above, should be put in separate routine
12305c6c1daeSBarry Smith   */
12315c6c1daeSBarry Smith   if (!vbinary->skipinfo && (!rank || type == FILE_MODE_READ)) {
12325c6c1daeSBarry Smith     char infoname[PETSC_MAX_PATH_LEN],iname[PETSC_MAX_PATH_LEN];
12335c6c1daeSBarry Smith 
1234e0385b85SDave May     ierr = PetscStrcpy(infoname,vbinary->filename);CHKERRQ(ierr);
12355c6c1daeSBarry Smith     /* remove .gz if it ends library name */
12365c6c1daeSBarry Smith     ierr = PetscStrstr(infoname,".gz",&gz);CHKERRQ(ierr);
12375c6c1daeSBarry Smith     if (gz) {
12385c6c1daeSBarry Smith       ierr = PetscStrlen(gz,&len);CHKERRQ(ierr);
1239a297a907SKarl Rupp       if (len == 3) *gz = 0;
12405c6c1daeSBarry Smith     }
12415c6c1daeSBarry Smith 
12425c6c1daeSBarry Smith     ierr = PetscStrcat(infoname,".info");CHKERRQ(ierr);
12435c6c1daeSBarry Smith     ierr = PetscFixFilename(infoname,iname);CHKERRQ(ierr);
12445c6c1daeSBarry Smith     if (type == FILE_MODE_READ) {
1245ce94432eSBarry Smith       ierr = PetscFileRetrieve(PetscObjectComm((PetscObject)viewer),iname,infoname,PETSC_MAX_PATH_LEN,&found);CHKERRQ(ierr);
1246c5929fdfSBarry Smith       ierr = PetscOptionsInsertFile(PetscObjectComm((PetscObject)viewer),((PetscObject)viewer)->options,infoname,PETSC_FALSE);CHKERRQ(ierr);
12475c6c1daeSBarry Smith     } else {
12485c6c1daeSBarry Smith       vbinary->fdes_info = fopen(infoname,"w");
12495c6c1daeSBarry Smith       if (!vbinary->fdes_info) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open .info file %s for writing",infoname);
12505c6c1daeSBarry Smith     }
12515c6c1daeSBarry Smith   }
12525c6c1daeSBarry Smith #if defined(PETSC_USE_LOG)
1253e0385b85SDave May   PetscLogObjectState((PetscObject)viewer,"File: %s",vbinary->filename);
12545c6c1daeSBarry Smith #endif
12555c6c1daeSBarry Smith   PetscFunctionReturn(0);
12565c6c1daeSBarry Smith }
12575c6c1daeSBarry Smith 
125881f0254dSBarry Smith static PetscErrorCode PetscViewerBinarySetUseMPIIO_Binary(PetscViewer viewer,PetscBool flg)
12595c6c1daeSBarry Smith {
12605c6c1daeSBarry Smith   PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data;
12615c6c1daeSBarry Smith   PetscFunctionBegin;
1262bc196f7cSDave May   vbinary->usempiio = flg;
12635c6c1daeSBarry Smith   PetscFunctionReturn(0);
12645c6c1daeSBarry Smith }
12655c6c1daeSBarry Smith #endif
12665c6c1daeSBarry Smith 
126781f0254dSBarry Smith static PetscErrorCode PetscViewerView_Binary(PetscViewer v,PetscViewer viewer)
12682bf49c77SBarry Smith {
12692bf49c77SBarry Smith   PetscErrorCode     ierr;
12702bf49c77SBarry Smith   PetscViewer_Binary *binary = (PetscViewer_Binary*)v->data;
12712bf49c77SBarry Smith 
12722bf49c77SBarry Smith   PetscFunctionBegin;
12732bf49c77SBarry Smith   if (binary->filename) {
12742bf49c77SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"Filename: %s\n",binary->filename);CHKERRQ(ierr);
12752bf49c77SBarry Smith   }
12762bf49c77SBarry Smith   PetscFunctionReturn(0);
12772bf49c77SBarry Smith }
12782bf49c77SBarry Smith 
127903a1d59fSDave May static PetscErrorCode PetscViewerSetUp_Binary(PetscViewer v)
128003a1d59fSDave May {
128103a1d59fSDave May   PetscErrorCode     ierr;
128203a1d59fSDave May   PetscViewer_Binary *binary = (PetscViewer_Binary*)v->data;
1283e0385b85SDave May 
128403a1d59fSDave May   PetscFunctionBegin;
1285da07bb01SDave May   if (!binary->setfromoptionscalled) { ierr = PetscViewerSetFromOptions(v);CHKERRQ(ierr); }
128603a1d59fSDave May 
1287e0385b85SDave May #if defined(PETSC_HAVE_MPIIO)
1288bc196f7cSDave May   if (binary->usempiio) {
1289e0385b85SDave May     ierr = PetscViewerFileSetUp_BinaryMPIIO(v);CHKERRQ(ierr);
1290e0385b85SDave May   } else {
1291e0385b85SDave May #endif
1292e0385b85SDave May     ierr = PetscViewerFileSetUp_Binary(v);CHKERRQ(ierr);
1293e0385b85SDave May #if defined(PETSC_HAVE_MPIIO)
1294e0385b85SDave May   }
1295e0385b85SDave May #endif
129603a1d59fSDave May   PetscFunctionReturn(0);
129703a1d59fSDave May }
129803a1d59fSDave May 
12994416b707SBarry Smith static PetscErrorCode PetscViewerSetFromOptions_Binary(PetscOptionItems *PetscOptionsObject,PetscViewer v)
130003a1d59fSDave May {
130103a1d59fSDave May   PetscErrorCode     ierr;
130203a1d59fSDave May   PetscViewer_Binary *binary = (PetscViewer_Binary*)v->data;
1303d22fd6bcSDave May   char               defaultname[PETSC_MAX_PATH_LEN];
130403a1d59fSDave May   PetscBool          flg;
1305e0385b85SDave May 
130603a1d59fSDave May   PetscFunctionBegin;
130703a1d59fSDave May   ierr = PetscOptionsHead(PetscOptionsObject,"Binary PetscViewer Options");CHKERRQ(ierr);
1308d22fd6bcSDave May   ierr = PetscSNPrintf(defaultname,PETSC_MAX_PATH_LEN-1,"binaryoutput");CHKERRQ(ierr);
1309d22fd6bcSDave May   ierr = PetscOptionsString("-viewer_binary_filename","Specify filename","PetscViewerFileSetName",defaultname,defaultname,PETSC_MAX_PATH_LEN-1,&flg);CHKERRQ(ierr);
1310d22fd6bcSDave May   if (flg) { ierr = PetscViewerFileSetName_Binary(v,defaultname);CHKERRQ(ierr); }
131134a9cc2cSBarry Smith   ierr = PetscOptionsBool("-viewer_binary_skip_info","Skip writing/reading .info file","PetscViewerBinarySetSkipInfo",PETSC_FALSE,&binary->skipinfo,NULL);CHKERRQ(ierr);
131234a9cc2cSBarry Smith   ierr = PetscOptionsBool("-viewer_binary_skip_options","Skip parsing vec load options","PetscViewerBinarySetSkipOptions",PETSC_TRUE,&binary->skipoptions,NULL);CHKERRQ(ierr);
131334a9cc2cSBarry Smith   ierr = PetscOptionsBool("-viewer_binary_skip_header","Skip writing/reading header information","PetscViewerBinarySetSkipHeader",PETSC_FALSE,&binary->skipheader,NULL);CHKERRQ(ierr);
131403a1d59fSDave May #if defined(PETSC_HAVE_MPIIO)
131534a9cc2cSBarry Smith   ierr = PetscOptionsBool("-viewer_binary_mpiio","Use MPI-IO functionality to write/read binary file","PetscViewerBinarySetUseMPIIO",PETSC_FALSE,&binary->usempiio,NULL);CHKERRQ(ierr);
131634a9cc2cSBarry Smith #elif defined(PETSC_HAVE_MPIUNI)
131734a9cc2cSBarry Smith   ierr = PetscOptionsBool("-viewer_binary_mpiio","Use MPI-IO functionality to write/read binary file","PetscViewerBinarySetUseMPIIO",PETSC_FALSE,NULL,NULL);CHKERRQ(ierr);
131803a1d59fSDave May #endif
131903a1d59fSDave May   ierr = PetscOptionsTail();CHKERRQ(ierr);
1320bc196f7cSDave May   binary->setfromoptionscalled = PETSC_TRUE;
132103a1d59fSDave May   PetscFunctionReturn(0);
132203a1d59fSDave May }
132303a1d59fSDave May 
13248556b5ebSBarry Smith /*MC
13258556b5ebSBarry Smith    PETSCVIEWERBINARY - A viewer that saves to binary files
13268556b5ebSBarry Smith 
13278556b5ebSBarry Smith 
13288556b5ebSBarry Smith .seealso:  PetscViewerBinaryOpen(), PETSC_VIEWER_STDOUT_(),PETSC_VIEWER_STDOUT_SELF, PETSC_VIEWER_STDOUT_WORLD, PetscViewerCreate(), PetscViewerASCIIOpen(),
13298556b5ebSBarry Smith            PetscViewerMatlabOpen(), VecView(), DMView(), PetscViewerMatlabPutArray(), PETSCVIEWERASCII, PETSCVIEWERMATLAB, PETSCVIEWERDRAW,
133067918a83SBarry Smith            PetscViewerFileSetName(), PetscViewerFileSetMode(), PetscViewerFormat, PetscViewerType, PetscViewerSetType(),
133167918a83SBarry Smith            PetscViewerBinaryGetUseMPIIO(), PetscViewerBinarySetUseMPIIO()
13328556b5ebSBarry Smith 
13331b266c99SBarry Smith   Level: beginner
13341b266c99SBarry Smith 
13358556b5ebSBarry Smith M*/
13368556b5ebSBarry Smith 
13378cc058d9SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerCreate_Binary(PetscViewer v)
13385c6c1daeSBarry Smith {
13395c6c1daeSBarry Smith   PetscErrorCode     ierr;
13405c6c1daeSBarry Smith   PetscViewer_Binary *vbinary;
13415c6c1daeSBarry Smith 
13425c6c1daeSBarry Smith   PetscFunctionBegin;
1343b00a9115SJed Brown   ierr                     = PetscNewLog(v,&vbinary);CHKERRQ(ierr);
13445c6c1daeSBarry Smith   v->data                  = (void*)vbinary;
134503a1d59fSDave May   v->ops->setfromoptions   = PetscViewerSetFromOptions_Binary;
13465c6c1daeSBarry Smith   v->ops->destroy          = PetscViewerDestroy_Binary;
13472bf49c77SBarry Smith   v->ops->view             = PetscViewerView_Binary;
1348c98fd787SBarry Smith   v->ops->setup            = PetscViewerSetUp_Binary;
1349c98fd787SBarry Smith   v->ops->flush            = NULL;
13505c6c1daeSBarry Smith   vbinary->fdes_info       = 0;
13515c6c1daeSBarry Smith   vbinary->fdes            = 0;
13525c6c1daeSBarry Smith   vbinary->skipinfo        = PETSC_FALSE;
13535c6c1daeSBarry Smith   vbinary->skipoptions     = PETSC_TRUE;
13545c6c1daeSBarry Smith   vbinary->skipheader      = PETSC_FALSE;
1355da07bb01SDave May   vbinary->setfromoptionscalled = PETSC_FALSE;
1356559f443fSBarry Smith   v->ops->getsubviewer     = PetscViewerGetSubViewer_Binary;
1357559f443fSBarry Smith   v->ops->restoresubviewer = PetscViewerRestoreSubViewer_Binary;
13581d641e7bSMichael Lange   v->ops->read             = PetscViewerBinaryRead;
13595c6c1daeSBarry Smith   vbinary->btype           = (PetscFileMode) -1;
13605c6c1daeSBarry Smith   vbinary->storecompressed = PETSC_FALSE;
13615c6c1daeSBarry Smith   vbinary->filename        = 0;
13625c6c1daeSBarry Smith   vbinary->flowcontrol     = 256; /* seems a good number for Cray XT-5 */
13635c6c1daeSBarry Smith 
1364bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)v,"PetscViewerBinaryGetFlowControl_C",PetscViewerBinaryGetFlowControl_Binary);CHKERRQ(ierr);
1365bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)v,"PetscViewerBinarySetFlowControl_C",PetscViewerBinarySetFlowControl_Binary);CHKERRQ(ierr);
1366bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)v,"PetscViewerBinarySetSkipHeader_C",PetscViewerBinarySetSkipHeader_Binary);CHKERRQ(ierr);
1367bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)v,"PetscViewerBinaryGetSkipHeader_C",PetscViewerBinaryGetSkipHeader_Binary);CHKERRQ(ierr);
1368807ea322SDave May   ierr = PetscObjectComposeFunction((PetscObject)v,"PetscViewerBinaryGetSkipOptions_C",PetscViewerBinaryGetSkipOptions_Binary);CHKERRQ(ierr);
1369807ea322SDave May   ierr = PetscObjectComposeFunction((PetscObject)v,"PetscViewerBinarySetSkipOptions_C",PetscViewerBinarySetSkipOptions_Binary);CHKERRQ(ierr);
1370807ea322SDave May   ierr = PetscObjectComposeFunction((PetscObject)v,"PetscViewerBinaryGetSkipInfo_C",PetscViewerBinaryGetSkipInfo_Binary);CHKERRQ(ierr);
1371807ea322SDave May   ierr = PetscObjectComposeFunction((PetscObject)v,"PetscViewerBinarySetSkipInfo_C",PetscViewerBinarySetSkipInfo_Binary);CHKERRQ(ierr);
1372bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)v,"PetscViewerBinaryGetInfoPointer_C",PetscViewerBinaryGetInfoPointer_Binary);CHKERRQ(ierr);
1373bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)v,"PetscViewerFileSetName_C",PetscViewerFileSetName_Binary);CHKERRQ(ierr);
1374bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)v,"PetscViewerFileSetMode_C",PetscViewerFileSetMode_Binary);CHKERRQ(ierr);
1375bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)v,"PetscViewerFileGetMode_C",PetscViewerFileGetMode_Binary);CHKERRQ(ierr);
1376bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)v,"PetscViewerFileGetName_C",PetscViewerFileGetName_Binary);CHKERRQ(ierr);
13775c6c1daeSBarry Smith #if defined(PETSC_HAVE_MPIIO)
1378bc196f7cSDave May   ierr = PetscObjectComposeFunction((PetscObject)v,"PetscViewerBinaryGetUseMPIIO_C",PetscViewerBinaryGetUseMPIIO_Binary);CHKERRQ(ierr);
1379bc196f7cSDave May   ierr = PetscObjectComposeFunction((PetscObject)v,"PetscViewerBinarySetUseMPIIO_C",PetscViewerBinarySetUseMPIIO_Binary);CHKERRQ(ierr);
13805c6c1daeSBarry Smith #endif
13815c6c1daeSBarry Smith   PetscFunctionReturn(0);
13825c6c1daeSBarry Smith }
13835c6c1daeSBarry Smith 
13845c6c1daeSBarry Smith /* ---------------------------------------------------------------------*/
13855c6c1daeSBarry Smith /*
13865c6c1daeSBarry Smith     The variable Petsc_Viewer_Binary_keyval is used to indicate an MPI attribute that
13875c6c1daeSBarry Smith   is attached to a communicator, in this case the attribute is a PetscViewer.
13885c6c1daeSBarry Smith */
13895c6c1daeSBarry Smith static int Petsc_Viewer_Binary_keyval = MPI_KEYVAL_INVALID;
13905c6c1daeSBarry Smith 
13915c6c1daeSBarry Smith /*@C
13925c6c1daeSBarry Smith      PETSC_VIEWER_BINARY_ - Creates a binary PetscViewer shared by all processors
13935c6c1daeSBarry Smith                      in a communicator.
13945c6c1daeSBarry Smith 
13955c6c1daeSBarry Smith      Collective on MPI_Comm
13965c6c1daeSBarry Smith 
13975c6c1daeSBarry Smith      Input Parameter:
13985c6c1daeSBarry Smith .    comm - the MPI communicator to share the binary PetscViewer
13995c6c1daeSBarry Smith 
14005c6c1daeSBarry Smith      Level: intermediate
14015c6c1daeSBarry Smith 
14025c6c1daeSBarry Smith    Options Database Keys:
14035c6c1daeSBarry Smith +    -viewer_binary_filename <name>
14045c6c1daeSBarry Smith .    -viewer_binary_skip_info
1405a2d7db39SDave May .    -viewer_binary_skip_options
1406a2d7db39SDave May .    -viewer_binary_skip_header
1407a2d7db39SDave May -    -viewer_binary_mpiio
14085c6c1daeSBarry Smith 
14095c6c1daeSBarry Smith    Environmental variables:
14105c6c1daeSBarry Smith -   PETSC_VIEWER_BINARY_FILENAME
14115c6c1daeSBarry Smith 
14125c6c1daeSBarry Smith      Notes:
14135c6c1daeSBarry Smith      Unlike almost all other PETSc routines, PETSC_VIEWER_BINARY_ does not return
14145c6c1daeSBarry Smith      an error code.  The binary PetscViewer is usually used in the form
14155c6c1daeSBarry Smith $       XXXView(XXX object,PETSC_VIEWER_BINARY_(comm));
14165c6c1daeSBarry Smith 
14175c6c1daeSBarry Smith .seealso: PETSC_VIEWER_BINARY_WORLD, PETSC_VIEWER_BINARY_SELF, PetscViewerBinaryOpen(), PetscViewerCreate(),
14185c6c1daeSBarry Smith           PetscViewerDestroy()
14195c6c1daeSBarry Smith @*/
14205c6c1daeSBarry Smith PetscViewer PETSC_VIEWER_BINARY_(MPI_Comm comm)
14215c6c1daeSBarry Smith {
14225c6c1daeSBarry Smith   PetscErrorCode ierr;
14235c6c1daeSBarry Smith   PetscBool      flg;
14245c6c1daeSBarry Smith   PetscViewer    viewer;
14255c6c1daeSBarry Smith   char           fname[PETSC_MAX_PATH_LEN];
14265c6c1daeSBarry Smith   MPI_Comm       ncomm;
14275c6c1daeSBarry Smith 
14285c6c1daeSBarry Smith   PetscFunctionBegin;
1429efca3c55SSatish Balay   ierr = PetscCommDuplicate(comm,&ncomm,NULL);if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_BINARY_",__FILE__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");PetscFunctionReturn(0);}
14305c6c1daeSBarry Smith   if (Petsc_Viewer_Binary_keyval == MPI_KEYVAL_INVALID) {
14315c6c1daeSBarry Smith     ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,MPI_NULL_DELETE_FN,&Petsc_Viewer_Binary_keyval,0);
1432efca3c55SSatish Balay     if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_BINARY_",__FILE__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");PetscFunctionReturn(0);}
14335c6c1daeSBarry Smith   }
14345c6c1daeSBarry Smith   ierr = MPI_Attr_get(ncomm,Petsc_Viewer_Binary_keyval,(void**)&viewer,(int*)&flg);
1435efca3c55SSatish Balay   if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_BINARY_",__FILE__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");PetscFunctionReturn(0);}
14365c6c1daeSBarry Smith   if (!flg) { /* PetscViewer not yet created */
14375c6c1daeSBarry Smith     ierr = PetscOptionsGetenv(ncomm,"PETSC_VIEWER_BINARY_FILENAME",fname,PETSC_MAX_PATH_LEN,&flg);
1438efca3c55SSatish Balay     if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_BINARY_",__FILE__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");PetscFunctionReturn(0);}
14395c6c1daeSBarry Smith     if (!flg) {
14405c6c1daeSBarry Smith       ierr = PetscStrcpy(fname,"binaryoutput");
1441efca3c55SSatish Balay       if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_BINARY_",__FILE__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");PetscFunctionReturn(0);}
14425c6c1daeSBarry Smith     }
14435c6c1daeSBarry Smith     ierr = PetscViewerBinaryOpen(ncomm,fname,FILE_MODE_WRITE,&viewer);
1444efca3c55SSatish Balay     if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_BINARY_",__FILE__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");PetscFunctionReturn(0);}
14455c6c1daeSBarry Smith     ierr = PetscObjectRegisterDestroy((PetscObject)viewer);
1446efca3c55SSatish Balay     if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_BINARY_",__FILE__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");PetscFunctionReturn(0);}
14475c6c1daeSBarry Smith     ierr = MPI_Attr_put(ncomm,Petsc_Viewer_Binary_keyval,(void*)viewer);
1448efca3c55SSatish Balay     if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_BINARY_",__FILE__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");PetscFunctionReturn(0);}
14495c6c1daeSBarry Smith   }
14505c6c1daeSBarry Smith   ierr = PetscCommDestroy(&ncomm);
1451efca3c55SSatish Balay   if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_BINARY_",__FILE__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");PetscFunctionReturn(0);}
14525c6c1daeSBarry Smith   PetscFunctionReturn(viewer);
14535c6c1daeSBarry Smith }
1454