15c6c1daeSBarry Smith 2665c2dedSJed Brown #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) 145c6c1daeSBarry Smith PetscBool MPIIO; 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 */ 275c6c1daeSBarry Smith } PetscViewer_Binary; 285c6c1daeSBarry Smith 295c6c1daeSBarry Smith #undef __FUNCT__ 305c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerGetSingleton_Binary" 315c6c1daeSBarry Smith PetscErrorCode PetscViewerGetSingleton_Binary(PetscViewer viewer,PetscViewer *outviewer) 325c6c1daeSBarry Smith { 335c6c1daeSBarry Smith int rank; 345c6c1daeSBarry Smith PetscErrorCode ierr; 355c6c1daeSBarry Smith PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data,*obinary; 365c6c1daeSBarry Smith 375c6c1daeSBarry Smith PetscFunctionBegin; 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); 44a297a907SKarl Rupp } else *outviewer = 0; 455c6c1daeSBarry Smith PetscFunctionReturn(0); 465c6c1daeSBarry Smith } 475c6c1daeSBarry Smith 485c6c1daeSBarry Smith #undef __FUNCT__ 495c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerRestoreSingleton_Binary" 505c6c1daeSBarry Smith PetscErrorCode PetscViewerRestoreSingleton_Binary(PetscViewer viewer,PetscViewer *outviewer) 515c6c1daeSBarry Smith { 525c6c1daeSBarry Smith PetscErrorCode ierr; 535c6c1daeSBarry Smith PetscErrorCode rank; 545c6c1daeSBarry Smith 555c6c1daeSBarry Smith PetscFunctionBegin; 56ce94432eSBarry Smith ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)viewer),&rank);CHKERRQ(ierr); 575c6c1daeSBarry Smith if (!rank) { 585c6c1daeSBarry Smith ierr = PetscFree((*outviewer)->data);CHKERRQ(ierr); 595c6c1daeSBarry Smith ierr = PetscHeaderDestroy(outviewer);CHKERRQ(ierr); 605c6c1daeSBarry Smith } 615c6c1daeSBarry Smith PetscFunctionReturn(0); 625c6c1daeSBarry Smith } 635c6c1daeSBarry Smith 645c6c1daeSBarry Smith #if defined(PETSC_HAVE_MPIIO) 655c6c1daeSBarry Smith #undef __FUNCT__ 665c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerBinaryGetMPIIOOffset" 675c6c1daeSBarry Smith /*@C 685c6c1daeSBarry Smith PetscViewerBinaryGetMPIIOOffset - Gets the current offset that should be passed to MPI_File_set_view() 695c6c1daeSBarry Smith 705c6c1daeSBarry Smith Not Collective 715c6c1daeSBarry Smith 725c6c1daeSBarry Smith Input Parameter: 735c6c1daeSBarry Smith . viewer - PetscViewer context, obtained from PetscViewerBinaryOpen() 745c6c1daeSBarry Smith 755c6c1daeSBarry Smith Output Parameter: 765c6c1daeSBarry Smith . off - the current offset 775c6c1daeSBarry Smith 785c6c1daeSBarry Smith Level: advanced 795c6c1daeSBarry Smith 805c6c1daeSBarry Smith Fortran Note: 815c6c1daeSBarry Smith This routine is not supported in Fortran. 825c6c1daeSBarry Smith 835c6c1daeSBarry Smith Use PetscViewerBinaryAddMPIIOOffset() to increase this value after you have written a view. 845c6c1daeSBarry Smith 855c6c1daeSBarry Smith Concepts: file descriptor^getting 865c6c1daeSBarry Smith Concepts: PetscViewerBinary^accessing file descriptor 875c6c1daeSBarry Smith 885c6c1daeSBarry Smith .seealso: PetscViewerBinaryOpen(),PetscViewerBinaryGetInfoPointer() 895c6c1daeSBarry Smith @*/ 905c6c1daeSBarry Smith PetscErrorCode PetscViewerBinaryGetMPIIOOffset(PetscViewer viewer,MPI_Offset *off) 915c6c1daeSBarry Smith { 925c6c1daeSBarry Smith PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data; 935c6c1daeSBarry Smith 945c6c1daeSBarry Smith PetscFunctionBegin; 955c6c1daeSBarry Smith *off = vbinary->moff; 965c6c1daeSBarry Smith PetscFunctionReturn(0); 975c6c1daeSBarry Smith } 985c6c1daeSBarry Smith 995c6c1daeSBarry Smith #undef __FUNCT__ 1005c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerBinaryAddMPIIOOffset" 1015c6c1daeSBarry Smith /*@C 1025c6c1daeSBarry Smith PetscViewerBinaryAddMPIIOOffset - Adds to the current offset that should be passed to MPI_File_set_view() 1035c6c1daeSBarry Smith 1045c6c1daeSBarry Smith Not Collective 1055c6c1daeSBarry Smith 1065c6c1daeSBarry Smith Input Parameters: 1075c6c1daeSBarry Smith + viewer - PetscViewer context, obtained from PetscViewerBinaryOpen() 1085c6c1daeSBarry Smith - off - the addition to the offset 1095c6c1daeSBarry Smith 1105c6c1daeSBarry Smith Level: advanced 1115c6c1daeSBarry Smith 1125c6c1daeSBarry Smith Fortran Note: 1135c6c1daeSBarry Smith This routine is not supported in Fortran. 1145c6c1daeSBarry Smith 1155c6c1daeSBarry Smith Use PetscViewerBinaryGetMPIIOOffset() to get the value that you should pass to MPI_File_set_view() 1165c6c1daeSBarry Smith 1175c6c1daeSBarry Smith Concepts: file descriptor^getting 1185c6c1daeSBarry Smith Concepts: PetscViewerBinary^accessing file descriptor 1195c6c1daeSBarry Smith 1205c6c1daeSBarry Smith .seealso: PetscViewerBinaryOpen(),PetscViewerBinaryGetInfoPointer() 1215c6c1daeSBarry Smith @*/ 1225c6c1daeSBarry Smith PetscErrorCode PetscViewerBinaryAddMPIIOOffset(PetscViewer viewer,MPI_Offset off) 1235c6c1daeSBarry Smith { 1245c6c1daeSBarry Smith PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data; 1255c6c1daeSBarry Smith 1265c6c1daeSBarry Smith PetscFunctionBegin; 1275c6c1daeSBarry Smith vbinary->moff += off; 1285c6c1daeSBarry Smith PetscFunctionReturn(0); 1295c6c1daeSBarry Smith } 1305c6c1daeSBarry Smith 1315c6c1daeSBarry Smith #undef __FUNCT__ 1325c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerBinaryGetMPIIODescriptor" 1335c6c1daeSBarry Smith /*@C 1345c6c1daeSBarry Smith PetscViewerBinaryGetMPIIODescriptor - Extracts the MPI IO file descriptor from a PetscViewer. 1355c6c1daeSBarry Smith 1365c6c1daeSBarry Smith Not Collective 1375c6c1daeSBarry Smith 1385c6c1daeSBarry Smith Input Parameter: 1395c6c1daeSBarry Smith . viewer - PetscViewer context, obtained from PetscViewerBinaryOpen() 1405c6c1daeSBarry Smith 1415c6c1daeSBarry Smith Output Parameter: 1425c6c1daeSBarry Smith . fdes - file descriptor 1435c6c1daeSBarry Smith 1445c6c1daeSBarry Smith Level: advanced 1455c6c1daeSBarry Smith 1465c6c1daeSBarry Smith Fortran Note: 1475c6c1daeSBarry Smith This routine is not supported in Fortran. 1485c6c1daeSBarry Smith 1495c6c1daeSBarry Smith Concepts: file descriptor^getting 1505c6c1daeSBarry Smith Concepts: PetscViewerBinary^accessing file descriptor 1515c6c1daeSBarry Smith 1525c6c1daeSBarry Smith .seealso: PetscViewerBinaryOpen(),PetscViewerBinaryGetInfoPointer() 1535c6c1daeSBarry Smith @*/ 1545c6c1daeSBarry Smith PetscErrorCode PetscViewerBinaryGetMPIIODescriptor(PetscViewer viewer,MPI_File *fdes) 1555c6c1daeSBarry Smith { 1565c6c1daeSBarry Smith PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data; 1575c6c1daeSBarry Smith 1585c6c1daeSBarry Smith PetscFunctionBegin; 1595c6c1daeSBarry Smith *fdes = vbinary->mfdes; 1605c6c1daeSBarry Smith PetscFunctionReturn(0); 1615c6c1daeSBarry Smith } 1625c6c1daeSBarry Smith 1635c6c1daeSBarry Smith #undef __FUNCT__ 1645c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerBinaryGetMPIIO" 1655c6c1daeSBarry Smith /*@C 1665c6c1daeSBarry Smith PetscViewerBinaryGetMPIIO - Returns PETSC_TRUE if the binary viewer is an MPI viewer. 1675c6c1daeSBarry Smith 1685c6c1daeSBarry Smith Not Collective 1695c6c1daeSBarry Smith 1705c6c1daeSBarry Smith Input Parameter: 1715c6c1daeSBarry Smith . viewer - PetscViewer context, obtained from PetscViewerBinaryOpen() 1725c6c1daeSBarry Smith 1735c6c1daeSBarry Smith Output Parameter: 1745c6c1daeSBarry Smith - flg - PETSC_TRUE if MPI IO is being used 1755c6c1daeSBarry Smith 1765c6c1daeSBarry Smith Options Database: 1775c6c1daeSBarry Smith -viewer_binary_mpiio : Flag for using MPI-IO 1785c6c1daeSBarry Smith 1795c6c1daeSBarry Smith Level: advanced 1805c6c1daeSBarry Smith 1815c6c1daeSBarry Smith Fortran Note: 1825c6c1daeSBarry Smith This routine is not supported in Fortran. 1835c6c1daeSBarry Smith 1845c6c1daeSBarry Smith Concepts: file descriptor^getting 1855c6c1daeSBarry Smith Concepts: PetscViewerBinary^accessing file descriptor 1865c6c1daeSBarry Smith 1875c6c1daeSBarry Smith .seealso: PetscViewerBinaryOpen(), PetscViewerBinaryGetInfoPointer() 1885c6c1daeSBarry Smith @*/ 1895c6c1daeSBarry Smith PetscErrorCode PetscViewerBinaryGetMPIIO(PetscViewer viewer,PetscBool *flg) 1905c6c1daeSBarry Smith { 1915c6c1daeSBarry Smith PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data; 1925c6c1daeSBarry Smith 1935c6c1daeSBarry Smith PetscFunctionBegin; 1945c6c1daeSBarry Smith *flg = vbinary->MPIIO; 1955c6c1daeSBarry Smith PetscFunctionReturn(0); 1965c6c1daeSBarry Smith } 1975c6c1daeSBarry Smith #endif 1985c6c1daeSBarry Smith 1995c6c1daeSBarry Smith EXTERN_C_BEGIN 2005c6c1daeSBarry Smith #undef __FUNCT__ 2015c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerBinaryGetFlowControl_Binary" 2025c6c1daeSBarry Smith PetscErrorCode PetscViewerBinaryGetFlowControl_Binary(PetscViewer viewer,PetscInt *fc) 2035c6c1daeSBarry Smith { 2045c6c1daeSBarry Smith PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data; 2055c6c1daeSBarry Smith 2065c6c1daeSBarry Smith PetscFunctionBegin; 2075c6c1daeSBarry Smith *fc = vbinary->flowcontrol; 2085c6c1daeSBarry Smith PetscFunctionReturn(0); 2095c6c1daeSBarry Smith } 2105c6c1daeSBarry Smith EXTERN_C_END 2115c6c1daeSBarry Smith 2125c6c1daeSBarry Smith #undef __FUNCT__ 2135c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerBinaryGetFlowControl" 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 { 232639ff905SBarry Smith PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data; 2335c6c1daeSBarry Smith PetscErrorCode ierr; 2345c6c1daeSBarry Smith 2355c6c1daeSBarry Smith PetscFunctionBegin; 236639ff905SBarry Smith *fc = vbinary->flowcontrol; 2375c6c1daeSBarry Smith ierr = PetscTryMethod(viewer,"PetscViewerBinaryGetFlowControl_C",(PetscViewer,PetscInt*),(viewer,fc));CHKERRQ(ierr); 2385c6c1daeSBarry Smith PetscFunctionReturn(0); 2395c6c1daeSBarry Smith } 2405c6c1daeSBarry Smith 2415c6c1daeSBarry Smith EXTERN_C_BEGIN 2425c6c1daeSBarry Smith #undef __FUNCT__ 2435c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerBinarySetFlowControl_Binary" 2445c6c1daeSBarry Smith PetscErrorCode PetscViewerBinarySetFlowControl_Binary(PetscViewer viewer,PetscInt fc) 2455c6c1daeSBarry Smith { 2465c6c1daeSBarry Smith PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data; 2475c6c1daeSBarry Smith 2485c6c1daeSBarry Smith PetscFunctionBegin; 249ce94432eSBarry Smith if (fc <= 1) SETERRQ1(PetscObjectComm((PetscObject)viewer),PETSC_ERR_ARG_OUTOFRANGE,"Flow control count must be greater than 1, %D was set",fc); 2505c6c1daeSBarry Smith vbinary->flowcontrol = fc; 2515c6c1daeSBarry Smith PetscFunctionReturn(0); 2525c6c1daeSBarry Smith } 2535c6c1daeSBarry Smith EXTERN_C_END 2545c6c1daeSBarry Smith 2555c6c1daeSBarry Smith #undef __FUNCT__ 2565c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerBinarySetFlowControl" 2575c6c1daeSBarry Smith /*@C 258639ff905SBarry Smith PetscViewerBinarySetFlowControl - Sets how many messages are allowed to outstanding at the same time during parallel IO reads/writes 2595c6c1daeSBarry Smith 2605c6c1daeSBarry Smith Not Collective 2615c6c1daeSBarry Smith 2625c6c1daeSBarry Smith Input Parameter: 2635c6c1daeSBarry Smith + viewer - PetscViewer context, obtained from PetscViewerBinaryOpen() 264639ff905SBarry Smith - fc - the number of messages, defaults to 256 if this function was not called 2655c6c1daeSBarry Smith 2665c6c1daeSBarry Smith Level: advanced 2675c6c1daeSBarry Smith 2685c6c1daeSBarry Smith .seealso: PetscViewerBinaryOpen(),PetscViewerBinaryGetInfoPointer(), PetscViewerBinaryGetFlowControl() 2695c6c1daeSBarry Smith 2705c6c1daeSBarry Smith @*/ 2715c6c1daeSBarry Smith PetscErrorCode PetscViewerBinarySetFlowControl(PetscViewer viewer,PetscInt fc) 2725c6c1daeSBarry Smith { 2735c6c1daeSBarry Smith PetscErrorCode ierr; 2745c6c1daeSBarry Smith 2755c6c1daeSBarry Smith PetscFunctionBegin; 2765c6c1daeSBarry Smith ierr = PetscUseMethod(viewer,"PetscViewerBinarySetFlowControl_C",(PetscViewer,PetscInt),(viewer,fc));CHKERRQ(ierr); 2775c6c1daeSBarry Smith PetscFunctionReturn(0); 2785c6c1daeSBarry Smith } 2795c6c1daeSBarry Smith 2805c6c1daeSBarry Smith #undef __FUNCT__ 2815c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerBinaryGetDescriptor" 2825c6c1daeSBarry Smith /*@C 2835c6c1daeSBarry Smith PetscViewerBinaryGetDescriptor - Extracts the file descriptor from a PetscViewer. 2845c6c1daeSBarry Smith 2855c6c1daeSBarry Smith Not Collective 2865c6c1daeSBarry Smith 2875c6c1daeSBarry Smith Input Parameter: 2885c6c1daeSBarry Smith . viewer - PetscViewer context, obtained from PetscViewerBinaryOpen() 2895c6c1daeSBarry Smith 2905c6c1daeSBarry Smith Output Parameter: 2915c6c1daeSBarry Smith . fdes - file descriptor 2925c6c1daeSBarry Smith 2935c6c1daeSBarry Smith Level: advanced 2945c6c1daeSBarry Smith 2955c6c1daeSBarry Smith Notes: 2965c6c1daeSBarry Smith For writable binary PetscViewers, the descriptor will only be valid for the 2975c6c1daeSBarry Smith first processor in the communicator that shares the PetscViewer. For readable 2985c6c1daeSBarry Smith files it will only be valid on nodes that have the file. If node 0 does not 2995c6c1daeSBarry Smith have the file it generates an error even if another node does have the file. 3005c6c1daeSBarry Smith 3015c6c1daeSBarry Smith Fortran Note: 3025c6c1daeSBarry Smith This routine is not supported in Fortran. 3035c6c1daeSBarry Smith 3045c6c1daeSBarry Smith Concepts: file descriptor^getting 3055c6c1daeSBarry Smith Concepts: PetscViewerBinary^accessing file descriptor 3065c6c1daeSBarry Smith 3075c6c1daeSBarry Smith .seealso: PetscViewerBinaryOpen(),PetscViewerBinaryGetInfoPointer() 3085c6c1daeSBarry Smith @*/ 3095c6c1daeSBarry Smith PetscErrorCode PetscViewerBinaryGetDescriptor(PetscViewer viewer,int *fdes) 3105c6c1daeSBarry Smith { 3115c6c1daeSBarry Smith PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data; 3125c6c1daeSBarry Smith 3135c6c1daeSBarry Smith PetscFunctionBegin; 3145c6c1daeSBarry Smith *fdes = vbinary->fdes; 3155c6c1daeSBarry Smith PetscFunctionReturn(0); 3165c6c1daeSBarry Smith } 3175c6c1daeSBarry Smith 3185c6c1daeSBarry Smith #undef __FUNCT__ 3195c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerBinarySkipInfo" 3205c6c1daeSBarry Smith /*@ 3215c6c1daeSBarry Smith PetscViewerBinarySkipInfo - Binary file will not have .info file created with it 3225c6c1daeSBarry Smith 3235c6c1daeSBarry Smith Not Collective 3245c6c1daeSBarry Smith 3255c6c1daeSBarry Smith Input Paramter: 3265c6c1daeSBarry Smith . viewer - PetscViewer context, obtained from PetscViewerCreate() 3275c6c1daeSBarry Smith 3285c6c1daeSBarry Smith Options Database Key: 3295c6c1daeSBarry Smith . -viewer_binary_skip_info 3305c6c1daeSBarry Smith 3315c6c1daeSBarry Smith Level: advanced 3325c6c1daeSBarry Smith 3335c6c1daeSBarry Smith Notes: This must be called after PetscViewerSetType() but before PetscViewerFileSetName(). If you use PetscViewerBinaryOpen() then 3345c6c1daeSBarry Smith you can only skip the info file with the -viewer_binary_skip_info flag. To use the function you must open the 3355c6c1daeSBarry Smith viewer with PetscViewerCreate(), PetscViewerSetType(), PetscViewerFileSetName(). 3365c6c1daeSBarry Smith 3375c6c1daeSBarry Smith The .info contains meta information about the data in the binary file, for example the block size if it was 3385c6c1daeSBarry Smith set for a vector or matrix. 3395c6c1daeSBarry Smith 3405c6c1daeSBarry Smith Concepts: PetscViewerBinary^accessing info file 3415c6c1daeSBarry Smith 3425c6c1daeSBarry Smith .seealso: PetscViewerBinaryOpen(), PetscViewerBinaryGetDescriptor(), PetscViewerBinarySetSkipOptions(), 3435c6c1daeSBarry Smith PetscViewerBinaryGetSkipOptions() 3445c6c1daeSBarry Smith @*/ 3455c6c1daeSBarry Smith PetscErrorCode PetscViewerBinarySkipInfo(PetscViewer viewer) 3465c6c1daeSBarry Smith { 3475c6c1daeSBarry Smith PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data; 3485c6c1daeSBarry Smith 3495c6c1daeSBarry Smith PetscFunctionBegin; 3505c6c1daeSBarry Smith vbinary->skipinfo = PETSC_TRUE; 3515c6c1daeSBarry Smith PetscFunctionReturn(0); 3525c6c1daeSBarry Smith } 3535c6c1daeSBarry Smith 3545c6c1daeSBarry Smith #undef __FUNCT__ 3555c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerBinarySetSkipOptions" 3565c6c1daeSBarry Smith /*@ 3575c6c1daeSBarry Smith PetscViewerBinarySetSkipOptions - do not use the PETSc options database when loading objects 3585c6c1daeSBarry Smith 3595c6c1daeSBarry Smith Not Collective 3605c6c1daeSBarry Smith 3615c6c1daeSBarry Smith Input Parameters: 3625c6c1daeSBarry Smith + viewer - PetscViewer context, obtained from PetscViewerBinaryOpen() 3635c6c1daeSBarry Smith - skip - PETSC_TRUE means do not use 3645c6c1daeSBarry Smith 3655c6c1daeSBarry Smith Options Database Key: 3665c6c1daeSBarry Smith . -viewer_binary_skip_options 3675c6c1daeSBarry Smith 3685c6c1daeSBarry Smith Level: advanced 3695c6c1daeSBarry Smith 3705c6c1daeSBarry Smith Notes: This must be called after PetscViewerSetType() 3715c6c1daeSBarry Smith 3725c6c1daeSBarry Smith Concepts: PetscViewerBinary^accessing info file 3735c6c1daeSBarry Smith 3745c6c1daeSBarry Smith .seealso: PetscViewerBinaryOpen(), PetscViewerBinaryGetDescriptor(), PetscViewerBinarySkipInfo(), 3755c6c1daeSBarry Smith PetscViewerBinaryGetSkipOptions() 3765c6c1daeSBarry Smith @*/ 3775c6c1daeSBarry Smith PetscErrorCode PetscViewerBinarySetSkipOptions(PetscViewer viewer,PetscBool skip) 3785c6c1daeSBarry Smith { 3795c6c1daeSBarry Smith PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data; 3805c6c1daeSBarry Smith 3815c6c1daeSBarry Smith PetscFunctionBegin; 3825c6c1daeSBarry Smith vbinary->skipoptions = skip; 3835c6c1daeSBarry Smith PetscFunctionReturn(0); 3845c6c1daeSBarry Smith } 3855c6c1daeSBarry Smith 3865c6c1daeSBarry Smith #undef __FUNCT__ 3875c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerBinaryGetSkipOptions" 3885c6c1daeSBarry Smith /*@ 3895c6c1daeSBarry Smith PetscViewerBinaryGetSkipOptions - checks if viewer uses the PETSc options database when loading objects 3905c6c1daeSBarry Smith 3915c6c1daeSBarry Smith Not Collective 3925c6c1daeSBarry Smith 3935c6c1daeSBarry Smith Input Parameter: 3945c6c1daeSBarry Smith . viewer - PetscViewer context, obtained from PetscViewerBinaryOpen() 3955c6c1daeSBarry Smith 3965c6c1daeSBarry Smith Output Parameter: 3975c6c1daeSBarry Smith . skip - PETSC_TRUE means do not use 3985c6c1daeSBarry Smith 3995c6c1daeSBarry Smith Level: advanced 4005c6c1daeSBarry Smith 4015c6c1daeSBarry Smith Notes: This must be called after PetscViewerSetType() 4025c6c1daeSBarry Smith 4035c6c1daeSBarry Smith Concepts: PetscViewerBinary^accessing info file 4045c6c1daeSBarry Smith 4055c6c1daeSBarry Smith .seealso: PetscViewerBinaryOpen(), PetscViewerBinaryGetDescriptor(), PetscViewerBinarySkipInfo(), 4065c6c1daeSBarry Smith PetscViewerBinarySetSkipOptions() 4075c6c1daeSBarry Smith @*/ 4085c6c1daeSBarry Smith PetscErrorCode PetscViewerBinaryGetSkipOptions(PetscViewer viewer,PetscBool *skip) 4095c6c1daeSBarry Smith { 41022d28d08SBarry Smith PetscViewer_Binary *vbinary; 4115c6c1daeSBarry Smith 4125c6c1daeSBarry Smith PetscFunctionBegin; 4135c6c1daeSBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1); 4145c6c1daeSBarry Smith vbinary = (PetscViewer_Binary*)viewer->data; 4155c6c1daeSBarry Smith *skip = vbinary->skipoptions; 4165c6c1daeSBarry Smith PetscFunctionReturn(0); 4175c6c1daeSBarry Smith } 4185c6c1daeSBarry Smith 4195c6c1daeSBarry Smith EXTERN_C_BEGIN 4205c6c1daeSBarry Smith #undef __FUNCT__ 4215c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerBinarySetSkipHeader_Binary" 4225c6c1daeSBarry Smith PetscErrorCode PetscViewerBinarySetSkipHeader_Binary(PetscViewer viewer,PetscBool skip) 4235c6c1daeSBarry Smith { 4245c6c1daeSBarry Smith PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data; 4255c6c1daeSBarry Smith 4265c6c1daeSBarry Smith PetscFunctionBegin; 4275c6c1daeSBarry Smith vbinary->skipheader = skip; 4285c6c1daeSBarry Smith PetscFunctionReturn(0); 4295c6c1daeSBarry Smith } 4305c6c1daeSBarry Smith EXTERN_C_END 4315c6c1daeSBarry Smith 4325c6c1daeSBarry Smith #undef __FUNCT__ 4335c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerBinarySetSkipHeader" 4345c6c1daeSBarry Smith /*@ 4355c6c1daeSBarry Smith PetscViewerBinarySetSkipHeader - do not write a header with size information on output, just raw data 4365c6c1daeSBarry Smith 4375c6c1daeSBarry Smith Not Collective 4385c6c1daeSBarry Smith 4395c6c1daeSBarry Smith Input Parameters: 4405c6c1daeSBarry Smith + viewer - PetscViewer context, obtained from PetscViewerBinaryOpen() 4415c6c1daeSBarry Smith - skip - PETSC_TRUE means do not write header 4425c6c1daeSBarry Smith 4435c6c1daeSBarry Smith Options Database Key: 4445c6c1daeSBarry Smith . -viewer_binary_skip_header 4455c6c1daeSBarry Smith 4465c6c1daeSBarry Smith Level: advanced 4475c6c1daeSBarry Smith 4485c6c1daeSBarry Smith Notes: This must be called after PetscViewerSetType() 4495c6c1daeSBarry Smith 4505c6c1daeSBarry Smith Can ONLY be called on a binary viewer 4515c6c1daeSBarry Smith 4525c6c1daeSBarry Smith .seealso: PetscViewerBinaryOpen(), PetscViewerBinaryGetDescriptor(), PetscViewerBinarySkipInfo(), 4535c6c1daeSBarry Smith PetscViewerBinaryGetSkipHeader() 4545c6c1daeSBarry Smith @*/ 4555c6c1daeSBarry Smith PetscErrorCode PetscViewerBinarySetSkipHeader(PetscViewer viewer,PetscBool skip) 4565c6c1daeSBarry Smith { 4575c6c1daeSBarry Smith PetscErrorCode ierr; 4585c6c1daeSBarry Smith 4595c6c1daeSBarry Smith PetscFunctionBegin; 4605c6c1daeSBarry Smith ierr = PetscUseMethod(viewer,"PetscViewerBinarySetSkipHeader_C",(PetscViewer,PetscBool),(viewer,skip));CHKERRQ(ierr); 4615c6c1daeSBarry Smith PetscFunctionReturn(0); 4625c6c1daeSBarry Smith } 4635c6c1daeSBarry Smith 4645c6c1daeSBarry Smith EXTERN_C_BEGIN 4655c6c1daeSBarry Smith #undef __FUNCT__ 4665c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerBinaryGetSkipHeader_Binary" 4675c6c1daeSBarry Smith PetscErrorCode PetscViewerBinaryGetSkipHeader_Binary(PetscViewer viewer,PetscBool *skip) 4685c6c1daeSBarry Smith { 4695c6c1daeSBarry Smith PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data; 4705c6c1daeSBarry Smith 4715c6c1daeSBarry Smith PetscFunctionBegin; 4725c6c1daeSBarry Smith *skip = vbinary->skipheader; 4735c6c1daeSBarry Smith PetscFunctionReturn(0); 4745c6c1daeSBarry Smith } 4755c6c1daeSBarry Smith EXTERN_C_END 4765c6c1daeSBarry Smith 4775c6c1daeSBarry Smith #undef __FUNCT__ 4785c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerBinaryGetSkipHeader" 4795c6c1daeSBarry Smith /*@ 4805c6c1daeSBarry Smith PetscViewerBinaryGetSkipHeader - checks whether to write a header with size information on output, or just raw data 4815c6c1daeSBarry Smith 4825c6c1daeSBarry Smith Not Collective 4835c6c1daeSBarry Smith 4845c6c1daeSBarry Smith Input Parameter: 4855c6c1daeSBarry Smith . viewer - PetscViewer context, obtained from PetscViewerBinaryOpen() 4865c6c1daeSBarry Smith 4875c6c1daeSBarry Smith Output Parameter: 4885c6c1daeSBarry Smith . skip - PETSC_TRUE means do not write header 4895c6c1daeSBarry Smith 4905c6c1daeSBarry Smith Level: advanced 4915c6c1daeSBarry Smith 4925c6c1daeSBarry Smith Notes: This must be called after PetscViewerSetType() 4935c6c1daeSBarry Smith 4945c6c1daeSBarry Smith Returns false for PETSCSOCKETVIEWER, you cannot skip the header for it. 4955c6c1daeSBarry Smith 4965c6c1daeSBarry Smith .seealso: PetscViewerBinaryOpen(), PetscViewerBinaryGetDescriptor(), PetscViewerBinarySkipInfo(), 4975c6c1daeSBarry Smith PetscViewerBinarySetSkipHeader() 4985c6c1daeSBarry Smith @*/ 4995c6c1daeSBarry Smith PetscErrorCode PetscViewerBinaryGetSkipHeader(PetscViewer viewer,PetscBool *skip) 5005c6c1daeSBarry Smith { 5015c6c1daeSBarry Smith PetscErrorCode ierr; 5025c6c1daeSBarry Smith 5035c6c1daeSBarry Smith PetscFunctionBegin; 5045c6c1daeSBarry Smith *skip = PETSC_FALSE; 5055c6c1daeSBarry Smith ierr = PetscTryMethod(viewer,"PetscViewerBinaryGetSkipHeader_C",(PetscViewer,PetscBool*),(viewer,skip));CHKERRQ(ierr); 5065c6c1daeSBarry Smith PetscFunctionReturn(0); 5075c6c1daeSBarry Smith } 5085c6c1daeSBarry Smith 5095c6c1daeSBarry Smith EXTERN_C_BEGIN 5105c6c1daeSBarry Smith #undef __FUNCT__ 5115c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerBinaryGetInfoPointer_Binary" 5125c6c1daeSBarry Smith PetscErrorCode PetscViewerBinaryGetInfoPointer_Binary(PetscViewer viewer,FILE **file) 5135c6c1daeSBarry Smith { 514f3b211e4SSatish Balay PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data; 515a261c58fSBarry Smith PetscErrorCode ierr; 516a261c58fSBarry Smith MPI_Comm comm; 5175c6c1daeSBarry Smith 5185c6c1daeSBarry Smith PetscFunctionBegin; 5195c6c1daeSBarry Smith *file = vbinary->fdes_info; 520a261c58fSBarry Smith if (viewer->format == PETSC_VIEWER_BINARY_MATLAB && !vbinary->matlabheaderwritten) { 521a261c58fSBarry Smith vbinary->matlabheaderwritten = PETSC_TRUE; 522a261c58fSBarry Smith ierr = PetscObjectGetComm((PetscObject)viewer,&comm);CHKERRQ(ierr); 523a261c58fSBarry Smith ierr = PetscFPrintf(comm,*file,"%%--- begin code written by PetscViewerBinary for MATLAB format ---%\n");CHKERRQ(ierr); 524a261c58fSBarry Smith ierr = PetscFPrintf(comm,*file,"%%$$ Set.filename = '%s';\n",vbinary->filename);CHKERRQ(ierr); 525a261c58fSBarry Smith ierr = PetscFPrintf(comm,*file,"%%$$ fd = PetscOpenFile(Set.filename);\n");CHKERRQ(ierr); 526a261c58fSBarry Smith ierr = PetscFPrintf(comm,*file,"%%--- end code written by PetscViewerBinary for MATLAB format ---%\n\n");CHKERRQ(ierr); 527a261c58fSBarry Smith } 5285c6c1daeSBarry Smith PetscFunctionReturn(0); 5295c6c1daeSBarry Smith } 5305c6c1daeSBarry Smith EXTERN_C_END 5315c6c1daeSBarry Smith 5325c6c1daeSBarry Smith #undef __FUNCT__ 5335c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerBinaryGetInfoPointer" 5345c6c1daeSBarry Smith /*@C 5355c6c1daeSBarry Smith PetscViewerBinaryGetInfoPointer - Extracts the file pointer for the ASCII 5365c6c1daeSBarry Smith info file associated with a binary file. 5375c6c1daeSBarry Smith 5385c6c1daeSBarry Smith Not Collective 5395c6c1daeSBarry Smith 5405c6c1daeSBarry Smith Input Parameter: 5415c6c1daeSBarry Smith . viewer - PetscViewer context, obtained from PetscViewerBinaryOpen() 5425c6c1daeSBarry Smith 5435c6c1daeSBarry Smith Output Parameter: 5440298fd71SBarry Smith . file - file pointer Always returns NULL if not a binary viewer 5455c6c1daeSBarry Smith 5465c6c1daeSBarry Smith Level: advanced 5475c6c1daeSBarry Smith 5485c6c1daeSBarry Smith Notes: 5495c6c1daeSBarry Smith For writable binary PetscViewers, the descriptor will only be valid for the 5505c6c1daeSBarry Smith first processor in the communicator that shares the PetscViewer. 5515c6c1daeSBarry Smith 5525c6c1daeSBarry Smith Fortran Note: 5535c6c1daeSBarry Smith This routine is not supported in Fortran. 5545c6c1daeSBarry Smith 5555c6c1daeSBarry Smith Concepts: PetscViewerBinary^accessing info file 5565c6c1daeSBarry Smith 5575c6c1daeSBarry Smith .seealso: PetscViewerBinaryOpen(),PetscViewerBinaryGetDescriptor() 5585c6c1daeSBarry Smith @*/ 5595c6c1daeSBarry Smith PetscErrorCode PetscViewerBinaryGetInfoPointer(PetscViewer viewer,FILE **file) 5605c6c1daeSBarry Smith { 5615c6c1daeSBarry Smith PetscErrorCode ierr; 5625c6c1daeSBarry Smith 5635c6c1daeSBarry Smith PetscFunctionBegin; 5640298fd71SBarry Smith *file = NULL; 5655c6c1daeSBarry Smith ierr = PetscTryMethod(viewer,"PetscViewerBinaryGetInfoPointer_C",(PetscViewer,FILE **),(viewer,file));CHKERRQ(ierr); 5665c6c1daeSBarry Smith PetscFunctionReturn(0); 5675c6c1daeSBarry Smith } 5685c6c1daeSBarry Smith 5695c6c1daeSBarry Smith #undef __FUNCT__ 5705c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerFileClose_Binary" 5715c6c1daeSBarry Smith static PetscErrorCode PetscViewerFileClose_Binary(PetscViewer v) 5725c6c1daeSBarry Smith { 5735c6c1daeSBarry Smith PetscViewer_Binary *vbinary = (PetscViewer_Binary*)v->data; 5745c6c1daeSBarry Smith PetscErrorCode ierr; 5755c6c1daeSBarry Smith PetscMPIInt rank; 5765c6c1daeSBarry Smith int err; 5775c6c1daeSBarry Smith 5785c6c1daeSBarry Smith PetscFunctionBegin; 579ce94432eSBarry Smith ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)v),&rank);CHKERRQ(ierr); 5805c6c1daeSBarry Smith if ((!rank || vbinary->btype == FILE_MODE_READ) && vbinary->fdes) { 5815c6c1daeSBarry Smith close(vbinary->fdes); 5825c6c1daeSBarry Smith if (!rank && vbinary->storecompressed) { 5835c6c1daeSBarry Smith char par[PETSC_MAX_PATH_LEN],buf[PETSC_MAX_PATH_LEN]; 5845c6c1daeSBarry Smith FILE *fp; 5855c6c1daeSBarry Smith /* compress the file */ 5865c6c1daeSBarry Smith ierr = PetscStrcpy(par,"gzip -f ");CHKERRQ(ierr); 5875c6c1daeSBarry Smith ierr = PetscStrcat(par,vbinary->filename);CHKERRQ(ierr); 5885c6c1daeSBarry Smith #if defined(PETSC_HAVE_POPEN) 5890298fd71SBarry Smith ierr = PetscPOpen(PETSC_COMM_SELF,NULL,par,"r",&fp);CHKERRQ(ierr); 5905c6c1daeSBarry Smith if (fgets(buf,1024,fp)) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_LIB,"Error from command %s\n%s",par,buf); 5910298fd71SBarry Smith ierr = PetscPClose(PETSC_COMM_SELF,fp,NULL);CHKERRQ(ierr); 5925c6c1daeSBarry Smith #else 5935c6c1daeSBarry Smith SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP_SYS,"Cannot run external programs on this machine"); 5945c6c1daeSBarry Smith #endif 5955c6c1daeSBarry Smith } 5965c6c1daeSBarry Smith } 5975c6c1daeSBarry Smith if (vbinary->fdes_info) { 5985c6c1daeSBarry Smith err = fclose(vbinary->fdes_info); 5995c6c1daeSBarry Smith if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file"); 6005c6c1daeSBarry Smith } 6015c6c1daeSBarry Smith ierr = PetscFree(vbinary->filename);CHKERRQ(ierr); 6025c6c1daeSBarry Smith PetscFunctionReturn(0); 6035c6c1daeSBarry Smith } 6045c6c1daeSBarry Smith 6055c6c1daeSBarry Smith #undef __FUNCT__ 6065c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerDestroy_Binary" 6075c6c1daeSBarry Smith PetscErrorCode PetscViewerDestroy_Binary(PetscViewer v) 6085c6c1daeSBarry Smith { 6095c6c1daeSBarry Smith PetscViewer_Binary *vbinary = (PetscViewer_Binary*)v->data; 6105c6c1daeSBarry Smith PetscErrorCode ierr; 6115c6c1daeSBarry Smith 6125c6c1daeSBarry Smith PetscFunctionBegin; 613a261c58fSBarry Smith if (v->format == PETSC_VIEWER_BINARY_MATLAB) { 614a261c58fSBarry Smith MPI_Comm comm; 615a261c58fSBarry Smith FILE *info; 616a261c58fSBarry Smith 617a261c58fSBarry Smith ierr = PetscObjectGetComm((PetscObject)v,&comm);CHKERRQ(ierr); 618a261c58fSBarry Smith ierr = PetscViewerBinaryGetInfoPointer(v,&info);CHKERRQ(ierr); 619a261c58fSBarry Smith ierr = PetscFPrintf(comm,info,"%%--- begin code written by PetscViewerBinary for MATLAB format ---%\n");CHKERRQ(ierr); 620a261c58fSBarry Smith ierr = PetscFPrintf(comm,info,"%%$$ close(fd);\n");CHKERRQ(ierr); 621a261c58fSBarry Smith ierr = PetscFPrintf(comm,info,"%%--- end code written by PetscViewerBinary for MATLAB format ---%\n\n");CHKERRQ(ierr); 622a261c58fSBarry Smith } 6235c6c1daeSBarry Smith ierr = PetscViewerFileClose_Binary(v);CHKERRQ(ierr); 6245c6c1daeSBarry Smith ierr = PetscFree(vbinary);CHKERRQ(ierr); 6255c6c1daeSBarry Smith PetscFunctionReturn(0); 6265c6c1daeSBarry Smith } 6275c6c1daeSBarry Smith 6285c6c1daeSBarry Smith #if defined(PETSC_HAVE_MPIIO) 6295c6c1daeSBarry Smith #undef __FUNCT__ 6305c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerFileClose_MPIIO" 6315c6c1daeSBarry Smith static PetscErrorCode PetscViewerFileClose_MPIIO(PetscViewer v) 6325c6c1daeSBarry Smith { 6335c6c1daeSBarry Smith PetscViewer_Binary *vbinary = (PetscViewer_Binary*)v->data; 6345c6c1daeSBarry Smith int err; 6355c6c1daeSBarry Smith PetscErrorCode ierr; 6365c6c1daeSBarry Smith 6375c6c1daeSBarry Smith PetscFunctionBegin; 6385c6c1daeSBarry Smith if (vbinary->mfdes) { 6395c6c1daeSBarry Smith ierr = MPI_File_close(&vbinary->mfdes);CHKERRQ(ierr); 6405c6c1daeSBarry Smith } 6415c6c1daeSBarry Smith if (vbinary->fdes_info) { 6425c6c1daeSBarry Smith err = fclose(vbinary->fdes_info); 6435c6c1daeSBarry Smith if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file"); 6445c6c1daeSBarry Smith } 6455c6c1daeSBarry Smith ierr = PetscFree(vbinary->filename);CHKERRQ(ierr); 6465c6c1daeSBarry Smith PetscFunctionReturn(0); 6475c6c1daeSBarry Smith } 6485c6c1daeSBarry Smith 6495c6c1daeSBarry Smith 6505c6c1daeSBarry Smith #undef __FUNCT__ 6515c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerDestroy_MPIIO" 6525c6c1daeSBarry Smith PetscErrorCode PetscViewerDestroy_MPIIO(PetscViewer v) 6535c6c1daeSBarry Smith { 6545c6c1daeSBarry Smith PetscViewer_Binary *vbinary = (PetscViewer_Binary*)v->data; 6555c6c1daeSBarry Smith PetscErrorCode ierr; 6565c6c1daeSBarry Smith 6575c6c1daeSBarry Smith PetscFunctionBegin; 6585c6c1daeSBarry Smith ierr = PetscViewerFileClose_MPIIO(v);CHKERRQ(ierr); 6595c6c1daeSBarry Smith ierr = PetscFree(vbinary);CHKERRQ(ierr); 6605c6c1daeSBarry Smith PetscFunctionReturn(0); 6615c6c1daeSBarry Smith } 6625c6c1daeSBarry Smith #endif 6635c6c1daeSBarry Smith 6645c6c1daeSBarry Smith #undef __FUNCT__ 6655c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerBinaryOpen" 6665c6c1daeSBarry Smith /*@C 6675c6c1daeSBarry Smith PetscViewerBinaryOpen - Opens a file for binary input/output. 6685c6c1daeSBarry Smith 6695c6c1daeSBarry Smith Collective on MPI_Comm 6705c6c1daeSBarry Smith 6715c6c1daeSBarry Smith Input Parameters: 6725c6c1daeSBarry Smith + comm - MPI communicator 6735c6c1daeSBarry Smith . name - name of file 6745c6c1daeSBarry Smith - type - type of file 6755c6c1daeSBarry Smith $ FILE_MODE_WRITE - create new file for binary output 6765c6c1daeSBarry Smith $ FILE_MODE_READ - open existing file for binary input 6775c6c1daeSBarry Smith $ FILE_MODE_APPEND - open existing file for binary output 6785c6c1daeSBarry Smith 6795c6c1daeSBarry Smith Output Parameter: 6805c6c1daeSBarry Smith . binv - PetscViewer for binary input/output to use with the specified file 6815c6c1daeSBarry Smith 6825c6c1daeSBarry Smith Options Database Keys: 6835c6c1daeSBarry Smith + -viewer_binary_skip_info 6845c6c1daeSBarry Smith . -viewer_binary_skip_options 6855c6c1daeSBarry Smith - -viewer_binary_skip_header 6865c6c1daeSBarry Smith 6875c6c1daeSBarry Smith Level: beginner 6885c6c1daeSBarry Smith 6895c6c1daeSBarry Smith Note: 6905c6c1daeSBarry Smith This PetscViewer should be destroyed with PetscViewerDestroy(). 6915c6c1daeSBarry Smith 6925c6c1daeSBarry Smith For reading files, the filename may begin with ftp:// or http:// and/or 6935c6c1daeSBarry Smith end with .gz; in this case file is brought over and uncompressed. 6945c6c1daeSBarry Smith 6955c6c1daeSBarry Smith For creating files, if the file name ends with .gz it is automatically 6965c6c1daeSBarry Smith compressed when closed. 6975c6c1daeSBarry Smith 6985c6c1daeSBarry Smith For writing files it only opens the file on processor 0 in the communicator. 6995c6c1daeSBarry Smith For readable files it opens the file on all nodes that have the file. If 7005c6c1daeSBarry Smith node 0 does not have the file it generates an error even if other nodes 7015c6c1daeSBarry Smith do have the file. 7025c6c1daeSBarry Smith 7035c6c1daeSBarry Smith Concepts: binary files 7045c6c1daeSBarry Smith Concepts: PetscViewerBinary^creating 7055c6c1daeSBarry Smith Concepts: gzip 7065c6c1daeSBarry Smith Concepts: accessing remote file 7075c6c1daeSBarry Smith Concepts: remote file 7085c6c1daeSBarry Smith 7095c6c1daeSBarry Smith .seealso: PetscViewerASCIIOpen(), PetscViewerSetFormat(), PetscViewerDestroy(), 7105c6c1daeSBarry Smith VecView(), MatView(), VecLoad(), MatLoad(), PetscViewerBinaryGetDescriptor(), 7115c6c1daeSBarry Smith PetscViewerBinaryGetInfoPointer(), PetscFileMode, PetscViewer, PetscViewerBinaryRead() 7125c6c1daeSBarry Smith @*/ 7135c6c1daeSBarry Smith PetscErrorCode PetscViewerBinaryOpen(MPI_Comm comm,const char name[],PetscFileMode type,PetscViewer *binv) 7145c6c1daeSBarry Smith { 7155c6c1daeSBarry Smith PetscErrorCode ierr; 7165c6c1daeSBarry Smith 7175c6c1daeSBarry Smith PetscFunctionBegin; 7185c6c1daeSBarry Smith ierr = PetscViewerCreate(comm,binv);CHKERRQ(ierr); 7195c6c1daeSBarry Smith ierr = PetscViewerSetType(*binv,PETSCVIEWERBINARY);CHKERRQ(ierr); 7205c6c1daeSBarry Smith ierr = PetscViewerFileSetMode(*binv,type);CHKERRQ(ierr); 7215c6c1daeSBarry Smith ierr = PetscViewerFileSetName(*binv,name);CHKERRQ(ierr); 7225c6c1daeSBarry Smith PetscFunctionReturn(0); 7235c6c1daeSBarry Smith } 7245c6c1daeSBarry Smith 7255c6c1daeSBarry Smith #if defined(PETSC_HAVE_MPIIO) 7265c6c1daeSBarry Smith #undef __FUNCT__ 7275c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerBinaryMPIIO" 7285c6c1daeSBarry Smith static PetscErrorCode PetscViewerBinaryMPIIO(PetscViewer viewer,void *data,PetscInt count,PetscDataType dtype,PetscBool write) 7295c6c1daeSBarry Smith { 7305c6c1daeSBarry Smith PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data; 7315c6c1daeSBarry Smith PetscErrorCode ierr; 7325c6c1daeSBarry Smith MPI_Datatype mdtype; 733e597bc1dSJed Brown PetscMPIInt cnt; 7345c6c1daeSBarry Smith MPI_Status status; 7355c6c1daeSBarry Smith MPI_Aint ul,dsize; 7365c6c1daeSBarry Smith 7375c6c1daeSBarry Smith PetscFunctionBegin; 7384dc2109aSBarry Smith ierr = PetscMPIIntCast(count,&cnt);CHKERRQ(ierr); 7395c6c1daeSBarry Smith ierr = PetscDataTypeToMPIDataType(dtype,&mdtype);CHKERRQ(ierr); 7405c6c1daeSBarry Smith ierr = MPI_File_set_view(vbinary->mfdes,vbinary->moff,mdtype,mdtype,(char*)"native",MPI_INFO_NULL);CHKERRQ(ierr); 7415c6c1daeSBarry Smith if (write) { 7425c6c1daeSBarry Smith ierr = MPIU_File_write_all(vbinary->mfdes,data,cnt,mdtype,&status);CHKERRQ(ierr); 7435c6c1daeSBarry Smith } else { 7445c6c1daeSBarry Smith ierr = MPIU_File_read_all(vbinary->mfdes,data,cnt,mdtype,&status);CHKERRQ(ierr); 7455c6c1daeSBarry Smith } 7465c6c1daeSBarry Smith ierr = MPI_Type_get_extent(mdtype,&ul,&dsize);CHKERRQ(ierr); 747a297a907SKarl Rupp 7485c6c1daeSBarry Smith vbinary->moff += dsize*cnt; 7495c6c1daeSBarry Smith PetscFunctionReturn(0); 7505c6c1daeSBarry Smith } 7515c6c1daeSBarry Smith #endif 7525c6c1daeSBarry Smith 7535c6c1daeSBarry Smith #undef __FUNCT__ 7545c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerBinaryRead" 7555c6c1daeSBarry Smith /*@C 7565c6c1daeSBarry Smith PetscViewerBinaryRead - Reads from a binary file, all processors get the same result 7575c6c1daeSBarry Smith 7585c6c1daeSBarry Smith Collective on MPI_Comm 7595c6c1daeSBarry Smith 7605c6c1daeSBarry Smith Input Parameters: 7615c6c1daeSBarry Smith + viewer - the binary viewer 7625c6c1daeSBarry Smith . data - location to write the data 7635c6c1daeSBarry Smith . count - number of items of data to read 7645c6c1daeSBarry Smith - datatype - type of data to read 7655c6c1daeSBarry Smith 7665c6c1daeSBarry Smith Level: beginner 7675c6c1daeSBarry Smith 7685c6c1daeSBarry Smith Concepts: binary files 7695c6c1daeSBarry Smith 7705c6c1daeSBarry Smith .seealso: PetscViewerASCIIOpen(), PetscViewerSetFormat(), PetscViewerDestroy(), 7715c6c1daeSBarry Smith VecView(), MatView(), VecLoad(), MatLoad(), PetscViewerBinaryGetDescriptor(), 7725c6c1daeSBarry Smith PetscViewerBinaryGetInfoPointer(), PetscFileMode, PetscViewer, PetscBinaryViewerRead() 7735c6c1daeSBarry Smith @*/ 7745c6c1daeSBarry Smith PetscErrorCode PetscViewerBinaryRead(PetscViewer viewer,void *data,PetscInt count,PetscDataType dtype) 7755c6c1daeSBarry Smith { 7765c6c1daeSBarry Smith PetscErrorCode ierr; 7775c6c1daeSBarry Smith PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data; 7785c6c1daeSBarry Smith 7795c6c1daeSBarry Smith #if defined(PETSC_HAVE_MPIIO) 7805c6c1daeSBarry Smith if (vbinary->MPIIO) { 7815c6c1daeSBarry Smith ierr = PetscViewerBinaryMPIIO(viewer,data,count,dtype,PETSC_FALSE);CHKERRQ(ierr); 7825c6c1daeSBarry Smith } else { 7835c6c1daeSBarry Smith #endif 784ce94432eSBarry Smith ierr = PetscBinarySynchronizedRead(PetscObjectComm((PetscObject)viewer),vbinary->fdes,data,count,dtype);CHKERRQ(ierr); 7855c6c1daeSBarry Smith #if defined(PETSC_HAVE_MPIIO) 7865c6c1daeSBarry Smith } 7875c6c1daeSBarry Smith #endif 7885c6c1daeSBarry Smith PetscFunctionReturn(0); 7895c6c1daeSBarry Smith } 7905c6c1daeSBarry Smith 7915c6c1daeSBarry Smith 7925c6c1daeSBarry Smith #undef __FUNCT__ 7935c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerBinaryWrite" 7945c6c1daeSBarry Smith /*@C 7955c6c1daeSBarry Smith PetscViewerBinaryWrite - writes to a binary file, only from the first process 7965c6c1daeSBarry Smith 7975c6c1daeSBarry Smith Collective on MPI_Comm 7985c6c1daeSBarry Smith 7995c6c1daeSBarry Smith Input Parameters: 8005c6c1daeSBarry Smith + viewer - the binary viewer 8015c6c1daeSBarry Smith . data - location of data 8025c6c1daeSBarry Smith . count - number of items of data to read 8035c6c1daeSBarry Smith . dtype - type of data to read 8045c6c1daeSBarry Smith - istemp - data may be overwritten 8055c6c1daeSBarry Smith 8065c6c1daeSBarry Smith Level: beginner 8075c6c1daeSBarry Smith 8085c6c1daeSBarry Smith Notes: because byte-swapping may be done on the values in data it cannot be declared const 8095c6c1daeSBarry Smith 8105c6c1daeSBarry Smith Concepts: binary files 8115c6c1daeSBarry Smith 8125c6c1daeSBarry Smith .seealso: PetscViewerASCIIOpen(), PetscViewerSetFormat(), PetscViewerDestroy(), 8135c6c1daeSBarry Smith VecView(), MatView(), VecLoad(), MatLoad(), PetscViewerBinaryGetDescriptor(), PetscDataType 8145c6c1daeSBarry Smith PetscViewerBinaryGetInfoPointer(), PetscFileMode, PetscViewer, PetscBinaryViewerRead() 8155c6c1daeSBarry Smith @*/ 8165c6c1daeSBarry Smith PetscErrorCode PetscViewerBinaryWrite(PetscViewer viewer,void *data,PetscInt count,PetscDataType dtype,PetscBool istemp) 8175c6c1daeSBarry Smith { 8185c6c1daeSBarry Smith PetscErrorCode ierr; 8195c6c1daeSBarry Smith PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data; 8205c6c1daeSBarry Smith 8215c6c1daeSBarry Smith PetscFunctionBegin; 8225c6c1daeSBarry Smith #if defined(PETSC_HAVE_MPIIO) 8235c6c1daeSBarry Smith if (vbinary->MPIIO) { 8245c6c1daeSBarry Smith ierr = PetscViewerBinaryMPIIO(viewer,data,count,dtype,PETSC_TRUE);CHKERRQ(ierr); 8255c6c1daeSBarry Smith } else { 8265c6c1daeSBarry Smith #endif 827ce94432eSBarry Smith ierr = PetscBinarySynchronizedWrite(PetscObjectComm((PetscObject)viewer),vbinary->fdes,data,count,dtype,istemp);CHKERRQ(ierr); 8285c6c1daeSBarry Smith #if defined(PETSC_HAVE_MPIIO) 8295c6c1daeSBarry Smith } 8305c6c1daeSBarry Smith #endif 8315c6c1daeSBarry Smith PetscFunctionReturn(0); 8325c6c1daeSBarry Smith } 8335c6c1daeSBarry Smith 8345c6c1daeSBarry Smith #undef __FUNCT__ 8355c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerBinaryWriteStringArray" 8365c6c1daeSBarry Smith /*@C 8375c6c1daeSBarry Smith PetscViewerBinaryWriteStringArray - writes to a binary file, only from the first process an array of strings 8385c6c1daeSBarry Smith 8395c6c1daeSBarry Smith Collective on MPI_Comm 8405c6c1daeSBarry Smith 8415c6c1daeSBarry Smith Input Parameters: 8425c6c1daeSBarry Smith + viewer - the binary viewer 8435c6c1daeSBarry Smith - data - location of the array of strings 8445c6c1daeSBarry Smith 8455c6c1daeSBarry Smith 8465c6c1daeSBarry Smith Level: intermediate 8475c6c1daeSBarry Smith 8485c6c1daeSBarry Smith Concepts: binary files 8495c6c1daeSBarry Smith 8505c6c1daeSBarry Smith Notes: array of strings is null terminated 8515c6c1daeSBarry Smith 8525c6c1daeSBarry Smith .seealso: PetscViewerASCIIOpen(), PetscViewerSetFormat(), PetscViewerDestroy(), 8535c6c1daeSBarry Smith VecView(), MatView(), VecLoad(), MatLoad(), PetscViewerBinaryGetDescriptor(), 8545c6c1daeSBarry Smith PetscViewerBinaryGetInfoPointer(), PetscFileMode, PetscViewer, PetscBinaryViewerRead() 8555c6c1daeSBarry Smith @*/ 8565c6c1daeSBarry Smith PetscErrorCode PetscViewerBinaryWriteStringArray(PetscViewer viewer,char **data) 8575c6c1daeSBarry Smith { 8585c6c1daeSBarry Smith PetscErrorCode ierr; 8595c6c1daeSBarry Smith PetscInt i,n = 0,*sizes; 8605c6c1daeSBarry Smith 8615c6c1daeSBarry Smith /* count number of strings */ 8625c6c1daeSBarry Smith while (data[n++]) ; 8635c6c1daeSBarry Smith n--; 8645c6c1daeSBarry Smith ierr = PetscMalloc((n+1)*sizeof(PetscInt),&sizes);CHKERRQ(ierr); 8655c6c1daeSBarry Smith sizes[0] = n; 8665c6c1daeSBarry Smith for (i=0; i<n; i++) { 8675c6c1daeSBarry Smith size_t tmp; 8685c6c1daeSBarry Smith ierr = PetscStrlen(data[i],&tmp);CHKERRQ(ierr); 8695c6c1daeSBarry Smith sizes[i+1] = tmp + 1; /* size includes space for the null terminator */ 8705c6c1daeSBarry Smith } 8715c6c1daeSBarry Smith ierr = PetscViewerBinaryWrite(viewer,sizes,n+1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr); 8725c6c1daeSBarry Smith for (i=0; i<n; i++) { 8735c6c1daeSBarry Smith ierr = PetscViewerBinaryWrite(viewer,data[i],sizes[i+1],PETSC_CHAR,PETSC_FALSE);CHKERRQ(ierr); 8745c6c1daeSBarry Smith } 8755c6c1daeSBarry Smith ierr = PetscFree(sizes);CHKERRQ(ierr); 8765c6c1daeSBarry Smith PetscFunctionReturn(0); 8775c6c1daeSBarry Smith } 8785c6c1daeSBarry Smith 8795c6c1daeSBarry Smith /*@C 8805c6c1daeSBarry Smith PetscViewerBinaryReadStringArray - reads a binary file an array of strings 8815c6c1daeSBarry Smith 8825c6c1daeSBarry Smith Collective on MPI_Comm 8835c6c1daeSBarry Smith 8845c6c1daeSBarry Smith Input Parameter: 8855c6c1daeSBarry Smith . viewer - the binary viewer 8865c6c1daeSBarry Smith 8875c6c1daeSBarry Smith Output Parameter: 8885c6c1daeSBarry Smith . data - location of the array of strings 8895c6c1daeSBarry Smith 8905c6c1daeSBarry Smith Level: intermediate 8915c6c1daeSBarry Smith 8925c6c1daeSBarry Smith Concepts: binary files 8935c6c1daeSBarry Smith 8945c6c1daeSBarry Smith Notes: array of strings is null terminated 8955c6c1daeSBarry Smith 8965c6c1daeSBarry Smith .seealso: PetscViewerASCIIOpen(), PetscViewerSetFormat(), PetscViewerDestroy(), 8975c6c1daeSBarry Smith VecView(), MatView(), VecLoad(), MatLoad(), PetscViewerBinaryGetDescriptor(), 8985c6c1daeSBarry Smith PetscViewerBinaryGetInfoPointer(), PetscFileMode, PetscViewer, PetscBinaryViewerRead() 8995c6c1daeSBarry Smith @*/ 9005c6c1daeSBarry Smith PetscErrorCode PetscViewerBinaryReadStringArray(PetscViewer viewer,char ***data) 9015c6c1daeSBarry Smith { 9025c6c1daeSBarry Smith PetscErrorCode ierr; 9035c6c1daeSBarry Smith PetscInt i,n,*sizes,N = 0; 9045c6c1daeSBarry Smith 9055c6c1daeSBarry Smith /* count number of strings */ 9065c6c1daeSBarry Smith ierr = PetscViewerBinaryRead(viewer,&n,1,PETSC_INT);CHKERRQ(ierr); 9075c6c1daeSBarry Smith ierr = PetscMalloc(n*sizeof(PetscInt),&sizes);CHKERRQ(ierr); 9085c6c1daeSBarry Smith ierr = PetscViewerBinaryRead(viewer,sizes,n,PETSC_INT);CHKERRQ(ierr); 909a297a907SKarl Rupp for (i=0; i<n; i++) N += sizes[i]; 9105c6c1daeSBarry Smith ierr = PetscMalloc((n+1)*sizeof(char*) + N*sizeof(char),data);CHKERRQ(ierr); 9115c6c1daeSBarry Smith (*data)[0] = (char*)((*data) + n + 1); 912a297a907SKarl Rupp for (i=1; i<n; i++) (*data)[i] = (*data)[i-1] + sizes[i-1]; 9135c6c1daeSBarry Smith ierr = PetscViewerBinaryRead(viewer,(*data)[0],N,PETSC_CHAR);CHKERRQ(ierr); 914a297a907SKarl Rupp 9155c6c1daeSBarry Smith (*data)[n] = 0; 916a297a907SKarl Rupp 9175c6c1daeSBarry Smith ierr = PetscFree(sizes);CHKERRQ(ierr); 9185c6c1daeSBarry Smith PetscFunctionReturn(0); 9195c6c1daeSBarry Smith } 9205c6c1daeSBarry Smith 9215c6c1daeSBarry Smith EXTERN_C_BEGIN 9225c6c1daeSBarry Smith #undef __FUNCT__ 9235c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerFileGetName_Binary" 9245c6c1daeSBarry Smith PetscErrorCode PetscViewerFileGetName_Binary(PetscViewer viewer,const char **name) 9255c6c1daeSBarry Smith { 9265c6c1daeSBarry Smith PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data; 9275c6c1daeSBarry Smith 9285c6c1daeSBarry Smith PetscFunctionBegin; 9295c6c1daeSBarry Smith *name = vbinary->filename; 9305c6c1daeSBarry Smith PetscFunctionReturn(0); 9315c6c1daeSBarry Smith } 9325c6c1daeSBarry Smith EXTERN_C_END 9335c6c1daeSBarry Smith 9345c6c1daeSBarry Smith #undef __FUNCT__ 9355c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerFileGetMode" 9365c6c1daeSBarry Smith /*@C 9375c6c1daeSBarry Smith PetscViewerFileGetMode - Gets the type of file to be open 9385c6c1daeSBarry Smith 9395c6c1daeSBarry Smith Not Collective 9405c6c1daeSBarry Smith 9415c6c1daeSBarry Smith Input Parameter: 9425c6c1daeSBarry Smith . viewer - the PetscViewer; must be a binary, MATLAB, hdf, or netcdf PetscViewer 9435c6c1daeSBarry Smith 9445c6c1daeSBarry Smith Output Parameter: 9455c6c1daeSBarry Smith . type - type of file 9465c6c1daeSBarry Smith $ FILE_MODE_WRITE - create new file for binary output 9475c6c1daeSBarry Smith $ FILE_MODE_READ - open existing file for binary input 9485c6c1daeSBarry Smith $ FILE_MODE_APPEND - open existing file for binary output 9495c6c1daeSBarry Smith 9505c6c1daeSBarry Smith Level: advanced 9515c6c1daeSBarry Smith 9525c6c1daeSBarry Smith .seealso: PetscViewerFileSetMode(), PetscViewerCreate(), PetscViewerSetType(), PetscViewerBinaryOpen() 9535c6c1daeSBarry Smith 9545c6c1daeSBarry Smith @*/ 9555c6c1daeSBarry Smith PetscErrorCode PetscViewerFileGetMode(PetscViewer viewer,PetscFileMode *type) 9565c6c1daeSBarry Smith { 9575c6c1daeSBarry Smith PetscErrorCode ierr; 9585c6c1daeSBarry Smith 9595c6c1daeSBarry Smith PetscFunctionBegin; 9605c6c1daeSBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1); 9615c6c1daeSBarry Smith PetscValidPointer(type,2); 9625c6c1daeSBarry Smith ierr = PetscUseMethod(viewer,"PetscViewerFileGetMode_C",(PetscViewer,PetscFileMode*),(viewer,type));CHKERRQ(ierr); 9635c6c1daeSBarry Smith PetscFunctionReturn(0); 9645c6c1daeSBarry Smith } 9655c6c1daeSBarry Smith 9665c6c1daeSBarry Smith #undef __FUNCT__ 9675c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerBinarySetMPIIO" 9685c6c1daeSBarry Smith /*@ 9695c6c1daeSBarry Smith PetscViewerBinarySetMPIIO - Sets a binary viewer to use MPI IO for reading/writing. Must be called 9705c6c1daeSBarry Smith before PetscViewerFileSetName() 9715c6c1daeSBarry Smith 9725c6c1daeSBarry Smith Logically Collective on PetscViewer 9735c6c1daeSBarry Smith 9745c6c1daeSBarry Smith Input Parameters: 9755c6c1daeSBarry Smith . viewer - the PetscViewer; must be a binary 9765c6c1daeSBarry Smith 9775c6c1daeSBarry Smith Options Database: 9785c6c1daeSBarry Smith -viewer_binary_mpiio : Flag for using MPI-IO 9795c6c1daeSBarry Smith 9805c6c1daeSBarry Smith Notes: turns off the default usage of the .info file since that is not scalable 9815c6c1daeSBarry Smith 9825c6c1daeSBarry Smith Level: advanced 9835c6c1daeSBarry Smith 9845c6c1daeSBarry Smith .seealso: PetscViewerFileSetMode(), PetscViewerCreate(), PetscViewerSetType(), PetscViewerBinaryOpen() 9855c6c1daeSBarry Smith 9865c6c1daeSBarry Smith @*/ 9875c6c1daeSBarry Smith PetscErrorCode PetscViewerBinarySetMPIIO(PetscViewer viewer) 9885c6c1daeSBarry Smith { 9895c6c1daeSBarry Smith PetscErrorCode ierr; 9905c6c1daeSBarry Smith 9915c6c1daeSBarry Smith PetscFunctionBegin; 9925c6c1daeSBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1); 9935c6c1daeSBarry Smith ierr = PetscTryMethod(viewer,"PetscViewerBinarySetMPIIO_C",(PetscViewer),(viewer));CHKERRQ(ierr); 9945c6c1daeSBarry Smith PetscFunctionReturn(0); 9955c6c1daeSBarry Smith } 9965c6c1daeSBarry Smith 9975c6c1daeSBarry Smith 9985c6c1daeSBarry Smith #undef __FUNCT__ 9995c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerFileSetMode" 10005c6c1daeSBarry Smith /*@C 10015c6c1daeSBarry Smith PetscViewerFileSetMode - Sets the type of file to be open 10025c6c1daeSBarry Smith 10035c6c1daeSBarry Smith Logically Collective on PetscViewer 10045c6c1daeSBarry Smith 10055c6c1daeSBarry Smith Input Parameters: 10065c6c1daeSBarry Smith + viewer - the PetscViewer; must be a binary, Matlab, hdf, or netcdf PetscViewer 10075c6c1daeSBarry Smith - type - type of file 10085c6c1daeSBarry Smith $ FILE_MODE_WRITE - create new file for binary output 10095c6c1daeSBarry Smith $ FILE_MODE_READ - open existing file for binary input 10105c6c1daeSBarry Smith $ FILE_MODE_APPEND - open existing file for binary output 10115c6c1daeSBarry Smith 10125c6c1daeSBarry Smith Level: advanced 10135c6c1daeSBarry Smith 10145c6c1daeSBarry Smith .seealso: PetscViewerFileSetMode(), PetscViewerCreate(), PetscViewerSetType(), PetscViewerBinaryOpen() 10155c6c1daeSBarry Smith 10165c6c1daeSBarry Smith @*/ 10175c6c1daeSBarry Smith PetscErrorCode PetscViewerFileSetMode(PetscViewer viewer,PetscFileMode type) 10185c6c1daeSBarry Smith { 10195c6c1daeSBarry Smith PetscErrorCode ierr; 10205c6c1daeSBarry Smith 10215c6c1daeSBarry Smith PetscFunctionBegin; 10225c6c1daeSBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1); 10235c6c1daeSBarry Smith PetscValidLogicalCollectiveEnum(viewer,type,2); 10245c6c1daeSBarry Smith ierr = PetscTryMethod(viewer,"PetscViewerFileSetMode_C",(PetscViewer,PetscFileMode),(viewer,type));CHKERRQ(ierr); 10255c6c1daeSBarry Smith PetscFunctionReturn(0); 10265c6c1daeSBarry Smith } 10275c6c1daeSBarry Smith 10285c6c1daeSBarry Smith EXTERN_C_BEGIN 10295c6c1daeSBarry Smith #undef __FUNCT__ 10305c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerFileGetMode_Binary" 10315c6c1daeSBarry Smith PetscErrorCode PetscViewerFileGetMode_Binary(PetscViewer viewer,PetscFileMode *type) 10325c6c1daeSBarry Smith { 10335c6c1daeSBarry Smith PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data; 10345c6c1daeSBarry Smith 10355c6c1daeSBarry Smith PetscFunctionBegin; 10365c6c1daeSBarry Smith *type = vbinary->btype; 10375c6c1daeSBarry Smith PetscFunctionReturn(0); 10385c6c1daeSBarry Smith } 10395c6c1daeSBarry Smith EXTERN_C_END 10405c6c1daeSBarry Smith 10415c6c1daeSBarry Smith EXTERN_C_BEGIN 10425c6c1daeSBarry Smith #undef __FUNCT__ 10435c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerFileSetMode_Binary" 10445c6c1daeSBarry Smith PetscErrorCode PetscViewerFileSetMode_Binary(PetscViewer viewer,PetscFileMode type) 10455c6c1daeSBarry Smith { 10465c6c1daeSBarry Smith PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data; 10475c6c1daeSBarry Smith 10485c6c1daeSBarry Smith PetscFunctionBegin; 10495c6c1daeSBarry Smith vbinary->btype = type; 10505c6c1daeSBarry Smith PetscFunctionReturn(0); 10515c6c1daeSBarry Smith } 10525c6c1daeSBarry Smith EXTERN_C_END 10535c6c1daeSBarry Smith 10545c6c1daeSBarry Smith /* 10555c6c1daeSBarry Smith Actually opens the file 10565c6c1daeSBarry Smith */ 10575c6c1daeSBarry Smith EXTERN_C_BEGIN 10585c6c1daeSBarry Smith #undef __FUNCT__ 10595c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerFileSetName_Binary" 10605c6c1daeSBarry Smith PetscErrorCode PetscViewerFileSetName_Binary(PetscViewer viewer,const char name[]) 10615c6c1daeSBarry Smith { 10625c6c1daeSBarry Smith PetscMPIInt rank; 10635c6c1daeSBarry Smith PetscErrorCode ierr; 10645c6c1daeSBarry Smith size_t len; 10655c6c1daeSBarry Smith PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data; 10665c6c1daeSBarry Smith const char *fname; 10675c6c1daeSBarry Smith char bname[PETSC_MAX_PATH_LEN],*gz; 10685c6c1daeSBarry Smith PetscBool found; 10695c6c1daeSBarry Smith PetscFileMode type = vbinary->btype; 10705c6c1daeSBarry Smith 10715c6c1daeSBarry Smith PetscFunctionBegin; 10725c6c1daeSBarry Smith if (type == (PetscFileMode) -1) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"Must call PetscViewerFileSetMode() before PetscViewerFileSetName()"); 10735c6c1daeSBarry Smith ierr = PetscViewerFileClose_Binary(viewer);CHKERRQ(ierr); 10740298fd71SBarry Smith ierr = PetscOptionsGetBool(((PetscObject)viewer)->prefix,"-viewer_binary_skip_info",&vbinary->skipinfo,NULL);CHKERRQ(ierr); 10750298fd71SBarry Smith ierr = PetscOptionsGetBool(((PetscObject)viewer)->prefix,"-viewer_binary_skip_options",&vbinary->skipoptions,NULL);CHKERRQ(ierr); 10760298fd71SBarry Smith ierr = PetscOptionsGetBool(((PetscObject)viewer)->prefix,"-viewer_binary_skip_header",&vbinary->skipheader,NULL);CHKERRQ(ierr); 10775c6c1daeSBarry Smith 1078ce94432eSBarry Smith ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)viewer),&rank);CHKERRQ(ierr); 10795c6c1daeSBarry Smith 10805c6c1daeSBarry Smith /* copy name so we can edit it */ 10815c6c1daeSBarry Smith ierr = PetscStrallocpy(name,&vbinary->filename);CHKERRQ(ierr); 10825c6c1daeSBarry Smith 10835c6c1daeSBarry Smith /* if ends in .gz strip that off and note user wants file compressed */ 10845c6c1daeSBarry Smith vbinary->storecompressed = PETSC_FALSE; 10855c6c1daeSBarry Smith if (!rank && type == FILE_MODE_WRITE) { 10865c6c1daeSBarry Smith /* remove .gz if it ends library name */ 10875c6c1daeSBarry Smith ierr = PetscStrstr(vbinary->filename,".gz",&gz);CHKERRQ(ierr); 10885c6c1daeSBarry Smith if (gz) { 10895c6c1daeSBarry Smith ierr = PetscStrlen(gz,&len);CHKERRQ(ierr); 10905c6c1daeSBarry Smith if (len == 3) { 10915c6c1daeSBarry Smith *gz = 0; 10925c6c1daeSBarry Smith vbinary->storecompressed = PETSC_TRUE; 10935c6c1daeSBarry Smith } 10945c6c1daeSBarry Smith } 10955c6c1daeSBarry Smith } 10965c6c1daeSBarry Smith 10975c6c1daeSBarry Smith /* only first processor opens file if writeable */ 10985c6c1daeSBarry Smith if (!rank || type == FILE_MODE_READ) { 10995c6c1daeSBarry Smith 11005c6c1daeSBarry Smith if (type == FILE_MODE_READ) { 11015c6c1daeSBarry Smith /* possibly get the file from remote site or compressed file */ 1102ce94432eSBarry Smith ierr = PetscFileRetrieve(PetscObjectComm((PetscObject)viewer),vbinary->filename,bname,PETSC_MAX_PATH_LEN,&found);CHKERRQ(ierr); 11035c6c1daeSBarry Smith fname = bname; 11045c6c1daeSBarry Smith if (!rank && !found) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot locate file: %s on node zero",vbinary->filename); 11055c6c1daeSBarry Smith else if (!found) { 11065c6c1daeSBarry Smith ierr = PetscInfo(viewer,"Nonzero processor did not locate readonly file\n");CHKERRQ(ierr); 11075c6c1daeSBarry Smith fname = 0; 11085c6c1daeSBarry Smith } 1109a297a907SKarl Rupp } else fname = vbinary->filename; 11105c6c1daeSBarry Smith 11115c6c1daeSBarry Smith #if defined(PETSC_HAVE_O_BINARY) 11125c6c1daeSBarry Smith if (type == FILE_MODE_WRITE) { 11135c6c1daeSBarry 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); 11145c6c1daeSBarry Smith } else if (type == FILE_MODE_READ && fname) { 11155c6c1daeSBarry 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); 11165c6c1daeSBarry Smith } else if (type == FILE_MODE_APPEND) { 11175c6c1daeSBarry 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); 11185c6c1daeSBarry Smith } else if (fname) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Unknown file type"); 11195c6c1daeSBarry Smith #else 11205c6c1daeSBarry Smith if (type == FILE_MODE_WRITE) { 11215c6c1daeSBarry Smith if ((vbinary->fdes = creat(fname,0666)) == -1) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot create file %s for writing",fname); 11225c6c1daeSBarry Smith } else if (type == FILE_MODE_READ && fname) { 11235c6c1daeSBarry 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); 11245c6c1daeSBarry Smith } else if (type == FILE_MODE_APPEND) { 11255c6c1daeSBarry 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); 11265c6c1daeSBarry Smith } else if (fname) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Unknown file type"); 11275c6c1daeSBarry Smith #endif 11285c6c1daeSBarry Smith } else vbinary->fdes = -1; 11295c6c1daeSBarry Smith viewer->format = PETSC_VIEWER_NOFORMAT; 11305c6c1daeSBarry Smith 11315c6c1daeSBarry Smith /* 11325c6c1daeSBarry Smith try to open info file: all processors open this file if read only 11335c6c1daeSBarry Smith */ 11345c6c1daeSBarry Smith if (!vbinary->skipinfo && (!rank || type == FILE_MODE_READ)) { 11355c6c1daeSBarry Smith char infoname[PETSC_MAX_PATH_LEN],iname[PETSC_MAX_PATH_LEN]; 11365c6c1daeSBarry Smith 11375c6c1daeSBarry Smith ierr = PetscStrcpy(infoname,name);CHKERRQ(ierr); 11385c6c1daeSBarry Smith /* remove .gz if it ends library name */ 11395c6c1daeSBarry Smith ierr = PetscStrstr(infoname,".gz",&gz);CHKERRQ(ierr); 11405c6c1daeSBarry Smith if (gz) { 11415c6c1daeSBarry Smith ierr = PetscStrlen(gz,&len);CHKERRQ(ierr); 1142a297a907SKarl Rupp if (len == 3) *gz = 0; 11435c6c1daeSBarry Smith } 11445c6c1daeSBarry Smith 11455c6c1daeSBarry Smith ierr = PetscStrcat(infoname,".info");CHKERRQ(ierr); 11465c6c1daeSBarry Smith ierr = PetscFixFilename(infoname,iname);CHKERRQ(ierr); 11475c6c1daeSBarry Smith if (type == FILE_MODE_READ) { 1148ce94432eSBarry Smith ierr = PetscFileRetrieve(PetscObjectComm((PetscObject)viewer),iname,infoname,PETSC_MAX_PATH_LEN,&found);CHKERRQ(ierr); 1149ce94432eSBarry Smith ierr = PetscOptionsInsertFile(PetscObjectComm((PetscObject)viewer),infoname,PETSC_FALSE);CHKERRQ(ierr); 11505c6c1daeSBarry Smith } else { 11515c6c1daeSBarry Smith vbinary->fdes_info = fopen(infoname,"w"); 11525c6c1daeSBarry Smith if (!vbinary->fdes_info) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open .info file %s for writing",infoname); 11535c6c1daeSBarry Smith } 11545c6c1daeSBarry Smith } 11555c6c1daeSBarry Smith 11565c6c1daeSBarry Smith #if defined(PETSC_USE_LOG) 11575c6c1daeSBarry Smith PetscLogObjectState((PetscObject)viewer,"File: %s",name); 11585c6c1daeSBarry Smith #endif 11595c6c1daeSBarry Smith PetscFunctionReturn(0); 11605c6c1daeSBarry Smith } 11615c6c1daeSBarry Smith EXTERN_C_END 11625c6c1daeSBarry Smith 11635c6c1daeSBarry Smith #if defined(PETSC_HAVE_MPIIO) 11645c6c1daeSBarry Smith EXTERN_C_BEGIN 11655c6c1daeSBarry Smith #undef __FUNCT__ 11665c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerFileSetName_MPIIO" 11675c6c1daeSBarry Smith PetscErrorCode PetscViewerFileSetName_MPIIO(PetscViewer viewer,const char name[]) 11685c6c1daeSBarry Smith { 11695c6c1daeSBarry Smith PetscMPIInt rank; 11705c6c1daeSBarry Smith PetscErrorCode ierr; 11715c6c1daeSBarry Smith size_t len; 11725c6c1daeSBarry Smith PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data; 11735c6c1daeSBarry Smith char *gz; 11745c6c1daeSBarry Smith PetscBool found; 11755c6c1daeSBarry Smith PetscFileMode type = vbinary->btype; 11765c6c1daeSBarry Smith 11775c6c1daeSBarry Smith PetscFunctionBegin; 11785c6c1daeSBarry Smith if (type == (PetscFileMode) -1) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"Must call PetscViewerFileSetMode() before PetscViewerFileSetName()"); 11795c6c1daeSBarry Smith ierr = PetscViewerFileClose_MPIIO(viewer);CHKERRQ(ierr); 11800298fd71SBarry Smith ierr = PetscOptionsGetBool(((PetscObject)viewer)->prefix,"-viewer_binary_skip_info",&vbinary->skipinfo,NULL);CHKERRQ(ierr); 11810298fd71SBarry Smith ierr = PetscOptionsGetBool(((PetscObject)viewer)->prefix,"-viewer_binary_skip_options",&vbinary->skipoptions,NULL);CHKERRQ(ierr); 11825c6c1daeSBarry Smith 1183ce94432eSBarry Smith ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)viewer),&rank);CHKERRQ(ierr); 11845c6c1daeSBarry Smith ierr = PetscStrallocpy(name,&vbinary->filename);CHKERRQ(ierr); 11855c6c1daeSBarry Smith 1186a297a907SKarl Rupp vbinary->storecompressed = PETSC_FALSE; 11875c6c1daeSBarry Smith 11885c6c1daeSBarry Smith /* only first processor opens file if writeable */ 11895c6c1daeSBarry Smith if (type == FILE_MODE_READ) { 1190ce94432eSBarry Smith MPI_File_open(PetscObjectComm((PetscObject)viewer),vbinary->filename,MPI_MODE_RDONLY,MPI_INFO_NULL,&vbinary->mfdes);CHKERRQ(ierr); 11915c6c1daeSBarry Smith } else if (type == FILE_MODE_WRITE) { 1192ce94432eSBarry Smith MPI_File_open(PetscObjectComm((PetscObject)viewer),vbinary->filename,MPI_MODE_WRONLY | MPI_MODE_CREATE,MPI_INFO_NULL,&vbinary->mfdes);CHKERRQ(ierr); 11935c6c1daeSBarry Smith } 11945c6c1daeSBarry Smith viewer->format = PETSC_VIEWER_NOFORMAT; 11955c6c1daeSBarry Smith 11965c6c1daeSBarry Smith /* 11975c6c1daeSBarry Smith try to open info file: all processors open this file if read only 11985c6c1daeSBarry Smith 11995c6c1daeSBarry Smith Below is identical code to the code for Binary above, should be put in seperate routine 12005c6c1daeSBarry Smith */ 12015c6c1daeSBarry Smith if (!vbinary->skipinfo && (!rank || type == FILE_MODE_READ)) { 12025c6c1daeSBarry Smith char infoname[PETSC_MAX_PATH_LEN],iname[PETSC_MAX_PATH_LEN]; 12035c6c1daeSBarry Smith 12045c6c1daeSBarry Smith ierr = PetscStrcpy(infoname,name);CHKERRQ(ierr); 12055c6c1daeSBarry Smith /* remove .gz if it ends library name */ 12065c6c1daeSBarry Smith ierr = PetscStrstr(infoname,".gz",&gz);CHKERRQ(ierr); 12075c6c1daeSBarry Smith if (gz) { 12085c6c1daeSBarry Smith ierr = PetscStrlen(gz,&len);CHKERRQ(ierr); 1209a297a907SKarl Rupp if (len == 3) *gz = 0; 12105c6c1daeSBarry Smith } 12115c6c1daeSBarry Smith 12125c6c1daeSBarry Smith ierr = PetscStrcat(infoname,".info");CHKERRQ(ierr); 12135c6c1daeSBarry Smith ierr = PetscFixFilename(infoname,iname);CHKERRQ(ierr); 12145c6c1daeSBarry Smith if (type == FILE_MODE_READ) { 1215ce94432eSBarry Smith ierr = PetscFileRetrieve(PetscObjectComm((PetscObject)viewer),iname,infoname,PETSC_MAX_PATH_LEN,&found);CHKERRQ(ierr); 1216ce94432eSBarry Smith ierr = PetscOptionsInsertFile(PetscObjectComm((PetscObject)viewer),infoname,PETSC_FALSE);CHKERRQ(ierr); 12175c6c1daeSBarry Smith } else { 12185c6c1daeSBarry Smith vbinary->fdes_info = fopen(infoname,"w"); 12195c6c1daeSBarry Smith if (!vbinary->fdes_info) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open .info file %s for writing",infoname); 12205c6c1daeSBarry Smith } 12215c6c1daeSBarry Smith } 12225c6c1daeSBarry Smith 12235c6c1daeSBarry Smith #if defined(PETSC_USE_LOG) 12245c6c1daeSBarry Smith PetscLogObjectState((PetscObject)viewer,"File: %s",name); 12255c6c1daeSBarry Smith #endif 12265c6c1daeSBarry Smith PetscFunctionReturn(0); 12275c6c1daeSBarry Smith } 12285c6c1daeSBarry Smith EXTERN_C_END 12295c6c1daeSBarry Smith 12305c6c1daeSBarry Smith EXTERN_C_BEGIN 12315c6c1daeSBarry Smith #undef __FUNCT__ 12325c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerBinarySetMPIIO_Binary" 12335c6c1daeSBarry Smith PetscErrorCode PetscViewerBinarySetMPIIO_Binary(PetscViewer viewer) 12345c6c1daeSBarry Smith { 12355c6c1daeSBarry Smith PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data; 12365c6c1daeSBarry Smith PetscErrorCode ierr; 12375c6c1daeSBarry Smith 12385c6c1daeSBarry Smith PetscFunctionBegin; 12395c6c1daeSBarry Smith if (vbinary->filename) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call before calling PetscViewerFileSetName()"); 12405c6c1daeSBarry Smith viewer->ops->destroy = PetscViewerDestroy_MPIIO; 12415c6c1daeSBarry Smith vbinary->MPIIO = PETSC_TRUE; 12425c6c1daeSBarry Smith /* vbinary->skipinfo = PETSC_TRUE; */ 1243*00de8ff0SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)viewer,"PetscViewerFileSetName_C","PetscViewerFileSetName_MPIIO",PetscViewerFileSetName_MPIIO);CHKERRQ(ierr); 12445c6c1daeSBarry Smith PetscFunctionReturn(0); 12455c6c1daeSBarry Smith } 12465c6c1daeSBarry Smith EXTERN_C_END 12475c6c1daeSBarry Smith #endif 12485c6c1daeSBarry Smith 12492bf49c77SBarry Smith #undef __FUNCT__ 12502bf49c77SBarry Smith #define __FUNCT__ "PetscViewerView_Binary" 12512bf49c77SBarry Smith PetscErrorCode PetscViewerView_Binary(PetscViewer v,PetscViewer viewer) 12522bf49c77SBarry Smith { 12532bf49c77SBarry Smith PetscErrorCode ierr; 12542bf49c77SBarry Smith PetscViewer_Binary *binary = (PetscViewer_Binary*)v->data; 12552bf49c77SBarry Smith 12562bf49c77SBarry Smith PetscFunctionBegin; 12572bf49c77SBarry Smith if (binary->filename) { 12582bf49c77SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Filename: %s\n",binary->filename);CHKERRQ(ierr); 12592bf49c77SBarry Smith } 12602bf49c77SBarry Smith PetscFunctionReturn(0); 12612bf49c77SBarry Smith } 12622bf49c77SBarry Smith 12635c6c1daeSBarry Smith EXTERN_C_BEGIN 12645c6c1daeSBarry Smith #undef __FUNCT__ 12655c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerCreate_Binary" 12665c6c1daeSBarry Smith PetscErrorCode PetscViewerCreate_Binary(PetscViewer v) 12675c6c1daeSBarry Smith { 12685c6c1daeSBarry Smith PetscErrorCode ierr; 12695c6c1daeSBarry Smith PetscViewer_Binary *vbinary; 12705c6c1daeSBarry Smith #if defined(PETSC_HAVE_MPIIO) 12715c6c1daeSBarry Smith PetscBool useMPIIO = PETSC_FALSE; 12725c6c1daeSBarry Smith #endif 12735c6c1daeSBarry Smith 12745c6c1daeSBarry Smith PetscFunctionBegin; 12755c6c1daeSBarry Smith ierr = PetscNewLog(v,PetscViewer_Binary,&vbinary);CHKERRQ(ierr); 12765c6c1daeSBarry Smith v->data = (void*)vbinary; 12775c6c1daeSBarry Smith v->ops->destroy = PetscViewerDestroy_Binary; 12782bf49c77SBarry Smith v->ops->view = PetscViewerView_Binary; 12795c6c1daeSBarry Smith v->ops->flush = 0; 12805c6c1daeSBarry Smith v->iformat = 0; 12815c6c1daeSBarry Smith vbinary->fdes_info = 0; 12825c6c1daeSBarry Smith vbinary->fdes = 0; 12835c6c1daeSBarry Smith vbinary->skipinfo = PETSC_FALSE; 12845c6c1daeSBarry Smith vbinary->skipoptions = PETSC_TRUE; 12855c6c1daeSBarry Smith vbinary->skipheader = PETSC_FALSE; 12865c6c1daeSBarry Smith v->ops->getsingleton = PetscViewerGetSingleton_Binary; 12875c6c1daeSBarry Smith v->ops->restoresingleton = PetscViewerRestoreSingleton_Binary; 12885c6c1daeSBarry Smith vbinary->btype = (PetscFileMode) -1; 12895c6c1daeSBarry Smith vbinary->storecompressed = PETSC_FALSE; 12905c6c1daeSBarry Smith vbinary->filename = 0; 12915c6c1daeSBarry Smith vbinary->flowcontrol = 256; /* seems a good number for Cray XT-5 */ 12925c6c1daeSBarry Smith 1293*00de8ff0SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)v,"PetscViewerBinaryGetFlowControl_C","PetscViewerBinaryGetFlowControl_Binary",PetscViewerBinaryGetFlowControl_Binary);CHKERRQ(ierr); 1294*00de8ff0SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)v,"PetscViewerBinarySetFlowControl_C","PetscViewerBinarySetFlowControl_Binary",PetscViewerBinarySetFlowControl_Binary);CHKERRQ(ierr); 1295*00de8ff0SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)v,"PetscViewerBinarySetSkipHeader_C","PetscViewerBinarySetSkipHeader_Binary",PetscViewerBinarySetSkipHeader_Binary);CHKERRQ(ierr); 1296*00de8ff0SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)v,"PetscViewerBinaryGetSkipHeader_C","PetscViewerBinaryGetSkipHeader_Binary",PetscViewerBinaryGetSkipHeader_Binary);CHKERRQ(ierr); 1297*00de8ff0SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)v,"PetscViewerBinaryGetInfoPointer_C","PetscViewerBinaryGetInfoPointer_Binary",PetscViewerBinaryGetInfoPointer_Binary);CHKERRQ(ierr); 1298*00de8ff0SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)v,"PetscViewerFileSetName_C","PetscViewerFileSetName_Binary",PetscViewerFileSetName_Binary);CHKERRQ(ierr); 1299*00de8ff0SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)v,"PetscViewerFileSetMode_C","PetscViewerFileSetMode_Binary",PetscViewerFileSetMode_Binary);CHKERRQ(ierr); 1300*00de8ff0SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)v,"PetscViewerFileGetMode_C","PetscViewerFileGetMode_Binary",PetscViewerFileGetMode_Binary);CHKERRQ(ierr); 1301*00de8ff0SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)v,"PetscViewerFileGetName_C","PetscViewerFileGetName_Binary",PetscViewerFileGetName_Binary);CHKERRQ(ierr); 13025c6c1daeSBarry Smith #if defined(PETSC_HAVE_MPIIO) 1303*00de8ff0SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)v,"PetscViewerBinarySetMPIIO_C","PetscViewerBinarySetMPIIO_Binary",PetscViewerBinarySetMPIIO_Binary);CHKERRQ(ierr); 13045c6c1daeSBarry Smith 13050298fd71SBarry Smith ierr = PetscOptionsGetBool(NULL,"-viewer_binary_mpiio",&useMPIIO,NULL);CHKERRQ(ierr); 13065c6c1daeSBarry Smith if (useMPIIO) { 13075c6c1daeSBarry Smith ierr = PetscViewerBinarySetMPIIO(v);CHKERRQ(ierr); 13085c6c1daeSBarry Smith } 13095c6c1daeSBarry Smith #endif 13105c6c1daeSBarry Smith PetscFunctionReturn(0); 13115c6c1daeSBarry Smith } 13125c6c1daeSBarry Smith EXTERN_C_END 13135c6c1daeSBarry Smith 13145c6c1daeSBarry Smith 13155c6c1daeSBarry Smith /* ---------------------------------------------------------------------*/ 13165c6c1daeSBarry Smith /* 13175c6c1daeSBarry Smith The variable Petsc_Viewer_Binary_keyval is used to indicate an MPI attribute that 13185c6c1daeSBarry Smith is attached to a communicator, in this case the attribute is a PetscViewer. 13195c6c1daeSBarry Smith */ 13205c6c1daeSBarry Smith static int Petsc_Viewer_Binary_keyval = MPI_KEYVAL_INVALID; 13215c6c1daeSBarry Smith 13225c6c1daeSBarry Smith #undef __FUNCT__ 13235c6c1daeSBarry Smith #define __FUNCT__ "PETSC_VIEWER_BINARY_" 13245c6c1daeSBarry Smith /*@C 13255c6c1daeSBarry Smith PETSC_VIEWER_BINARY_ - Creates a binary PetscViewer shared by all processors 13265c6c1daeSBarry Smith in a communicator. 13275c6c1daeSBarry Smith 13285c6c1daeSBarry Smith Collective on MPI_Comm 13295c6c1daeSBarry Smith 13305c6c1daeSBarry Smith Input Parameter: 13315c6c1daeSBarry Smith . comm - the MPI communicator to share the binary PetscViewer 13325c6c1daeSBarry Smith 13335c6c1daeSBarry Smith Level: intermediate 13345c6c1daeSBarry Smith 13355c6c1daeSBarry Smith Options Database Keys: 13365c6c1daeSBarry Smith + -viewer_binary_filename <name> 13375c6c1daeSBarry Smith . -viewer_binary_skip_info 13385c6c1daeSBarry Smith - -viewer_binary_skip_options 13395c6c1daeSBarry Smith 13405c6c1daeSBarry Smith Environmental variables: 13415c6c1daeSBarry Smith - PETSC_VIEWER_BINARY_FILENAME 13425c6c1daeSBarry Smith 13435c6c1daeSBarry Smith Notes: 13445c6c1daeSBarry Smith Unlike almost all other PETSc routines, PETSC_VIEWER_BINARY_ does not return 13455c6c1daeSBarry Smith an error code. The binary PetscViewer is usually used in the form 13465c6c1daeSBarry Smith $ XXXView(XXX object,PETSC_VIEWER_BINARY_(comm)); 13475c6c1daeSBarry Smith 13485c6c1daeSBarry Smith .seealso: PETSC_VIEWER_BINARY_WORLD, PETSC_VIEWER_BINARY_SELF, PetscViewerBinaryOpen(), PetscViewerCreate(), 13495c6c1daeSBarry Smith PetscViewerDestroy() 13505c6c1daeSBarry Smith @*/ 13515c6c1daeSBarry Smith PetscViewer PETSC_VIEWER_BINARY_(MPI_Comm comm) 13525c6c1daeSBarry Smith { 13535c6c1daeSBarry Smith PetscErrorCode ierr; 13545c6c1daeSBarry Smith PetscBool flg; 13555c6c1daeSBarry Smith PetscViewer viewer; 13565c6c1daeSBarry Smith char fname[PETSC_MAX_PATH_LEN]; 13575c6c1daeSBarry Smith MPI_Comm ncomm; 13585c6c1daeSBarry Smith 13595c6c1daeSBarry Smith PetscFunctionBegin; 13600298fd71SBarry Smith ierr = PetscCommDuplicate(comm,&ncomm,NULL);if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_BINARY_",__FILE__,__SDIR__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");PetscFunctionReturn(0);} 13615c6c1daeSBarry Smith if (Petsc_Viewer_Binary_keyval == MPI_KEYVAL_INVALID) { 13625c6c1daeSBarry Smith ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,MPI_NULL_DELETE_FN,&Petsc_Viewer_Binary_keyval,0); 13635c6c1daeSBarry Smith if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_BINARY_",__FILE__,__SDIR__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");PetscFunctionReturn(0);} 13645c6c1daeSBarry Smith } 13655c6c1daeSBarry Smith ierr = MPI_Attr_get(ncomm,Petsc_Viewer_Binary_keyval,(void**)&viewer,(int*)&flg); 13665c6c1daeSBarry Smith if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_BINARY_",__FILE__,__SDIR__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");PetscFunctionReturn(0);} 13675c6c1daeSBarry Smith if (!flg) { /* PetscViewer not yet created */ 13685c6c1daeSBarry Smith ierr = PetscOptionsGetenv(ncomm,"PETSC_VIEWER_BINARY_FILENAME",fname,PETSC_MAX_PATH_LEN,&flg); 13695c6c1daeSBarry Smith if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_BINARY_",__FILE__,__SDIR__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");PetscFunctionReturn(0);} 13705c6c1daeSBarry Smith if (!flg) { 13715c6c1daeSBarry Smith ierr = PetscStrcpy(fname,"binaryoutput"); 13725c6c1daeSBarry Smith if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_BINARY_",__FILE__,__SDIR__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");PetscFunctionReturn(0);} 13735c6c1daeSBarry Smith } 13745c6c1daeSBarry Smith ierr = PetscViewerBinaryOpen(ncomm,fname,FILE_MODE_WRITE,&viewer); 13755c6c1daeSBarry Smith if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_BINARY_",__FILE__,__SDIR__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");PetscFunctionReturn(0);} 13765c6c1daeSBarry Smith ierr = PetscObjectRegisterDestroy((PetscObject)viewer); 13775c6c1daeSBarry Smith if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_BINARY_",__FILE__,__SDIR__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");PetscFunctionReturn(0);} 13785c6c1daeSBarry Smith ierr = MPI_Attr_put(ncomm,Petsc_Viewer_Binary_keyval,(void*)viewer); 13795c6c1daeSBarry Smith if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_BINARY_",__FILE__,__SDIR__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");PetscFunctionReturn(0);} 13805c6c1daeSBarry Smith } 13815c6c1daeSBarry Smith ierr = PetscCommDestroy(&ncomm); 13825c6c1daeSBarry Smith if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_BINARY_",__FILE__,__SDIR__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");PetscFunctionReturn(0);} 13835c6c1daeSBarry Smith PetscFunctionReturn(viewer); 13845c6c1daeSBarry Smith } 1385