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 #undef __FUNCT__ 2005c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerBinaryGetFlowControl_Binary" 2015c6c1daeSBarry Smith PetscErrorCode PetscViewerBinaryGetFlowControl_Binary(PetscViewer viewer,PetscInt *fc) 2025c6c1daeSBarry Smith { 2035c6c1daeSBarry Smith PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data; 2045c6c1daeSBarry Smith 2055c6c1daeSBarry Smith PetscFunctionBegin; 2065c6c1daeSBarry Smith *fc = vbinary->flowcontrol; 2075c6c1daeSBarry Smith PetscFunctionReturn(0); 2085c6c1daeSBarry Smith } 2095c6c1daeSBarry Smith 2105c6c1daeSBarry Smith #undef __FUNCT__ 2115c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerBinaryGetFlowControl" 2125c6c1daeSBarry Smith /*@C 2135c6c1daeSBarry Smith PetscViewerBinaryGetFlowControl - Returns how many messages are allowed to outstanding at the same time during parallel IO reads/writes 2145c6c1daeSBarry Smith 2155c6c1daeSBarry Smith Not Collective 2165c6c1daeSBarry Smith 2175c6c1daeSBarry Smith Input Parameter: 2185c6c1daeSBarry Smith . viewer - PetscViewer context, obtained from PetscViewerBinaryOpen() 2195c6c1daeSBarry Smith 2205c6c1daeSBarry Smith Output Parameter: 2215c6c1daeSBarry Smith . fc - the number of messages 2225c6c1daeSBarry Smith 2235c6c1daeSBarry Smith Level: advanced 2245c6c1daeSBarry Smith 2255c6c1daeSBarry Smith .seealso: PetscViewerBinaryOpen(),PetscViewerBinaryGetInfoPointer(), PetscViewerBinarySetFlowControl() 2265c6c1daeSBarry Smith 2275c6c1daeSBarry Smith @*/ 2285c6c1daeSBarry Smith PetscErrorCode PetscViewerBinaryGetFlowControl(PetscViewer viewer,PetscInt *fc) 2295c6c1daeSBarry Smith { 230639ff905SBarry Smith PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data; 2315c6c1daeSBarry Smith PetscErrorCode ierr; 2325c6c1daeSBarry Smith 2335c6c1daeSBarry Smith PetscFunctionBegin; 234639ff905SBarry Smith *fc = vbinary->flowcontrol; 2355c6c1daeSBarry Smith ierr = PetscTryMethod(viewer,"PetscViewerBinaryGetFlowControl_C",(PetscViewer,PetscInt*),(viewer,fc));CHKERRQ(ierr); 2365c6c1daeSBarry Smith PetscFunctionReturn(0); 2375c6c1daeSBarry Smith } 2385c6c1daeSBarry Smith 2395c6c1daeSBarry Smith #undef __FUNCT__ 2405c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerBinarySetFlowControl_Binary" 2415c6c1daeSBarry Smith PetscErrorCode PetscViewerBinarySetFlowControl_Binary(PetscViewer viewer,PetscInt fc) 2425c6c1daeSBarry Smith { 2435c6c1daeSBarry Smith PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data; 2445c6c1daeSBarry Smith 2455c6c1daeSBarry Smith PetscFunctionBegin; 246ce94432eSBarry Smith if (fc <= 1) SETERRQ1(PetscObjectComm((PetscObject)viewer),PETSC_ERR_ARG_OUTOFRANGE,"Flow control count must be greater than 1, %D was set",fc); 2475c6c1daeSBarry Smith vbinary->flowcontrol = fc; 2485c6c1daeSBarry Smith PetscFunctionReturn(0); 2495c6c1daeSBarry Smith } 2505c6c1daeSBarry Smith 2515c6c1daeSBarry Smith #undef __FUNCT__ 2525c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerBinarySetFlowControl" 2535c6c1daeSBarry Smith /*@C 254639ff905SBarry Smith PetscViewerBinarySetFlowControl - Sets how many messages are allowed to outstanding at the same time during parallel IO reads/writes 2555c6c1daeSBarry Smith 2565c6c1daeSBarry Smith Not Collective 2575c6c1daeSBarry Smith 2585c6c1daeSBarry Smith Input Parameter: 2595c6c1daeSBarry Smith + viewer - PetscViewer context, obtained from PetscViewerBinaryOpen() 260639ff905SBarry Smith - fc - the number of messages, defaults to 256 if this function was not called 2615c6c1daeSBarry Smith 2625c6c1daeSBarry Smith Level: advanced 2635c6c1daeSBarry Smith 2645c6c1daeSBarry Smith .seealso: PetscViewerBinaryOpen(),PetscViewerBinaryGetInfoPointer(), PetscViewerBinaryGetFlowControl() 2655c6c1daeSBarry Smith 2665c6c1daeSBarry Smith @*/ 2675c6c1daeSBarry Smith PetscErrorCode PetscViewerBinarySetFlowControl(PetscViewer viewer,PetscInt fc) 2685c6c1daeSBarry Smith { 2695c6c1daeSBarry Smith PetscErrorCode ierr; 2705c6c1daeSBarry Smith 2715c6c1daeSBarry Smith PetscFunctionBegin; 2725c6c1daeSBarry Smith ierr = PetscUseMethod(viewer,"PetscViewerBinarySetFlowControl_C",(PetscViewer,PetscInt),(viewer,fc));CHKERRQ(ierr); 2735c6c1daeSBarry Smith PetscFunctionReturn(0); 2745c6c1daeSBarry Smith } 2755c6c1daeSBarry Smith 2765c6c1daeSBarry Smith #undef __FUNCT__ 2775c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerBinaryGetDescriptor" 2785c6c1daeSBarry Smith /*@C 2795c6c1daeSBarry Smith PetscViewerBinaryGetDescriptor - Extracts the file descriptor from a PetscViewer. 2805c6c1daeSBarry Smith 2815c6c1daeSBarry Smith Not Collective 2825c6c1daeSBarry Smith 2835c6c1daeSBarry Smith Input Parameter: 2845c6c1daeSBarry Smith . viewer - PetscViewer context, obtained from PetscViewerBinaryOpen() 2855c6c1daeSBarry Smith 2865c6c1daeSBarry Smith Output Parameter: 2875c6c1daeSBarry Smith . fdes - file descriptor 2885c6c1daeSBarry Smith 2895c6c1daeSBarry Smith Level: advanced 2905c6c1daeSBarry Smith 2915c6c1daeSBarry Smith Notes: 2925c6c1daeSBarry Smith For writable binary PetscViewers, the descriptor will only be valid for the 2935c6c1daeSBarry Smith first processor in the communicator that shares the PetscViewer. For readable 2945c6c1daeSBarry Smith files it will only be valid on nodes that have the file. If node 0 does not 2955c6c1daeSBarry Smith have the file it generates an error even if another node does have the file. 2965c6c1daeSBarry Smith 2975c6c1daeSBarry Smith Fortran Note: 2985c6c1daeSBarry Smith This routine is not supported in Fortran. 2995c6c1daeSBarry Smith 3005c6c1daeSBarry Smith Concepts: file descriptor^getting 3015c6c1daeSBarry Smith Concepts: PetscViewerBinary^accessing file descriptor 3025c6c1daeSBarry Smith 3035c6c1daeSBarry Smith .seealso: PetscViewerBinaryOpen(),PetscViewerBinaryGetInfoPointer() 3045c6c1daeSBarry Smith @*/ 3055c6c1daeSBarry Smith PetscErrorCode PetscViewerBinaryGetDescriptor(PetscViewer viewer,int *fdes) 3065c6c1daeSBarry Smith { 3075c6c1daeSBarry Smith PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data; 3085c6c1daeSBarry Smith 3095c6c1daeSBarry Smith PetscFunctionBegin; 3105c6c1daeSBarry Smith *fdes = vbinary->fdes; 3115c6c1daeSBarry Smith PetscFunctionReturn(0); 3125c6c1daeSBarry Smith } 3135c6c1daeSBarry Smith 3145c6c1daeSBarry Smith #undef __FUNCT__ 3155c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerBinarySkipInfo" 3165c6c1daeSBarry Smith /*@ 3175c6c1daeSBarry Smith PetscViewerBinarySkipInfo - Binary file will not have .info file created with it 3185c6c1daeSBarry Smith 3195c6c1daeSBarry Smith Not Collective 3205c6c1daeSBarry Smith 3215c6c1daeSBarry Smith Input Paramter: 3225c6c1daeSBarry Smith . viewer - PetscViewer context, obtained from PetscViewerCreate() 3235c6c1daeSBarry Smith 3245c6c1daeSBarry Smith Options Database Key: 3255c6c1daeSBarry Smith . -viewer_binary_skip_info 3265c6c1daeSBarry Smith 3275c6c1daeSBarry Smith Level: advanced 3285c6c1daeSBarry Smith 3295c6c1daeSBarry Smith Notes: This must be called after PetscViewerSetType() but before PetscViewerFileSetName(). If you use PetscViewerBinaryOpen() then 3305c6c1daeSBarry Smith you can only skip the info file with the -viewer_binary_skip_info flag. To use the function you must open the 3315c6c1daeSBarry Smith viewer with PetscViewerCreate(), PetscViewerSetType(), PetscViewerFileSetName(). 3325c6c1daeSBarry Smith 3335c6c1daeSBarry Smith The .info contains meta information about the data in the binary file, for example the block size if it was 3345c6c1daeSBarry Smith set for a vector or matrix. 3355c6c1daeSBarry Smith 3365c6c1daeSBarry Smith Concepts: PetscViewerBinary^accessing info file 3375c6c1daeSBarry Smith 3385c6c1daeSBarry Smith .seealso: PetscViewerBinaryOpen(), PetscViewerBinaryGetDescriptor(), PetscViewerBinarySetSkipOptions(), 3395c6c1daeSBarry Smith PetscViewerBinaryGetSkipOptions() 3405c6c1daeSBarry Smith @*/ 3415c6c1daeSBarry Smith PetscErrorCode PetscViewerBinarySkipInfo(PetscViewer viewer) 3425c6c1daeSBarry Smith { 3435c6c1daeSBarry Smith PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data; 3445c6c1daeSBarry Smith 3455c6c1daeSBarry Smith PetscFunctionBegin; 3465c6c1daeSBarry Smith vbinary->skipinfo = PETSC_TRUE; 3475c6c1daeSBarry Smith PetscFunctionReturn(0); 3485c6c1daeSBarry Smith } 3495c6c1daeSBarry Smith 3505c6c1daeSBarry Smith #undef __FUNCT__ 3515c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerBinarySetSkipOptions" 3525c6c1daeSBarry Smith /*@ 3535c6c1daeSBarry Smith PetscViewerBinarySetSkipOptions - do not use the PETSc options database when loading objects 3545c6c1daeSBarry Smith 3555c6c1daeSBarry Smith Not Collective 3565c6c1daeSBarry Smith 3575c6c1daeSBarry Smith Input Parameters: 3585c6c1daeSBarry Smith + viewer - PetscViewer context, obtained from PetscViewerBinaryOpen() 3595c6c1daeSBarry Smith - skip - PETSC_TRUE means do not use 3605c6c1daeSBarry Smith 3615c6c1daeSBarry Smith Options Database Key: 3625c6c1daeSBarry Smith . -viewer_binary_skip_options 3635c6c1daeSBarry Smith 3645c6c1daeSBarry Smith Level: advanced 3655c6c1daeSBarry Smith 3665c6c1daeSBarry Smith Notes: This must be called after PetscViewerSetType() 3675c6c1daeSBarry Smith 3685c6c1daeSBarry Smith Concepts: PetscViewerBinary^accessing info file 3695c6c1daeSBarry Smith 3705c6c1daeSBarry Smith .seealso: PetscViewerBinaryOpen(), PetscViewerBinaryGetDescriptor(), PetscViewerBinarySkipInfo(), 3715c6c1daeSBarry Smith PetscViewerBinaryGetSkipOptions() 3725c6c1daeSBarry Smith @*/ 3735c6c1daeSBarry Smith PetscErrorCode PetscViewerBinarySetSkipOptions(PetscViewer viewer,PetscBool skip) 3745c6c1daeSBarry Smith { 3755c6c1daeSBarry Smith PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data; 3765c6c1daeSBarry Smith 3775c6c1daeSBarry Smith PetscFunctionBegin; 3785c6c1daeSBarry Smith vbinary->skipoptions = skip; 3795c6c1daeSBarry Smith PetscFunctionReturn(0); 3805c6c1daeSBarry Smith } 3815c6c1daeSBarry Smith 3825c6c1daeSBarry Smith #undef __FUNCT__ 3835c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerBinaryGetSkipOptions" 3845c6c1daeSBarry Smith /*@ 3855c6c1daeSBarry Smith PetscViewerBinaryGetSkipOptions - checks if viewer uses the PETSc options database when loading objects 3865c6c1daeSBarry Smith 3875c6c1daeSBarry Smith Not Collective 3885c6c1daeSBarry Smith 3895c6c1daeSBarry Smith Input Parameter: 3905c6c1daeSBarry Smith . viewer - PetscViewer context, obtained from PetscViewerBinaryOpen() 3915c6c1daeSBarry Smith 3925c6c1daeSBarry Smith Output Parameter: 3935c6c1daeSBarry Smith . skip - PETSC_TRUE means do not use 3945c6c1daeSBarry Smith 3955c6c1daeSBarry Smith Level: advanced 3965c6c1daeSBarry Smith 3975c6c1daeSBarry Smith Notes: This must be called after PetscViewerSetType() 3985c6c1daeSBarry Smith 3995c6c1daeSBarry Smith Concepts: PetscViewerBinary^accessing info file 4005c6c1daeSBarry Smith 4015c6c1daeSBarry Smith .seealso: PetscViewerBinaryOpen(), PetscViewerBinaryGetDescriptor(), PetscViewerBinarySkipInfo(), 4025c6c1daeSBarry Smith PetscViewerBinarySetSkipOptions() 4035c6c1daeSBarry Smith @*/ 4045c6c1daeSBarry Smith PetscErrorCode PetscViewerBinaryGetSkipOptions(PetscViewer viewer,PetscBool *skip) 4055c6c1daeSBarry Smith { 40622d28d08SBarry Smith PetscViewer_Binary *vbinary; 4075c6c1daeSBarry Smith 4085c6c1daeSBarry Smith PetscFunctionBegin; 4095c6c1daeSBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1); 4105c6c1daeSBarry Smith vbinary = (PetscViewer_Binary*)viewer->data; 4115c6c1daeSBarry Smith *skip = vbinary->skipoptions; 4125c6c1daeSBarry Smith PetscFunctionReturn(0); 4135c6c1daeSBarry Smith } 4145c6c1daeSBarry Smith 4155c6c1daeSBarry Smith #undef __FUNCT__ 4165c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerBinarySetSkipHeader_Binary" 4175c6c1daeSBarry Smith PetscErrorCode PetscViewerBinarySetSkipHeader_Binary(PetscViewer viewer,PetscBool skip) 4185c6c1daeSBarry Smith { 4195c6c1daeSBarry Smith PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data; 4205c6c1daeSBarry Smith 4215c6c1daeSBarry Smith PetscFunctionBegin; 4225c6c1daeSBarry Smith vbinary->skipheader = skip; 4235c6c1daeSBarry Smith PetscFunctionReturn(0); 4245c6c1daeSBarry Smith } 4255c6c1daeSBarry Smith 4265c6c1daeSBarry Smith #undef __FUNCT__ 4275c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerBinarySetSkipHeader" 4285c6c1daeSBarry Smith /*@ 4295c6c1daeSBarry Smith PetscViewerBinarySetSkipHeader - do not write a header with size information on output, just raw data 4305c6c1daeSBarry Smith 4315c6c1daeSBarry Smith Not Collective 4325c6c1daeSBarry Smith 4335c6c1daeSBarry Smith Input Parameters: 4345c6c1daeSBarry Smith + viewer - PetscViewer context, obtained from PetscViewerBinaryOpen() 4355c6c1daeSBarry Smith - skip - PETSC_TRUE means do not write header 4365c6c1daeSBarry Smith 4375c6c1daeSBarry Smith Options Database Key: 4385c6c1daeSBarry Smith . -viewer_binary_skip_header 4395c6c1daeSBarry Smith 4405c6c1daeSBarry Smith Level: advanced 4415c6c1daeSBarry Smith 4425c6c1daeSBarry Smith Notes: This must be called after PetscViewerSetType() 4435c6c1daeSBarry Smith 4445c6c1daeSBarry Smith Can ONLY be called on a binary viewer 4455c6c1daeSBarry Smith 4465c6c1daeSBarry Smith .seealso: PetscViewerBinaryOpen(), PetscViewerBinaryGetDescriptor(), PetscViewerBinarySkipInfo(), 4475c6c1daeSBarry Smith PetscViewerBinaryGetSkipHeader() 4485c6c1daeSBarry Smith @*/ 4495c6c1daeSBarry Smith PetscErrorCode PetscViewerBinarySetSkipHeader(PetscViewer viewer,PetscBool skip) 4505c6c1daeSBarry Smith { 4515c6c1daeSBarry Smith PetscErrorCode ierr; 4525c6c1daeSBarry Smith 4535c6c1daeSBarry Smith PetscFunctionBegin; 4545c6c1daeSBarry Smith ierr = PetscUseMethod(viewer,"PetscViewerBinarySetSkipHeader_C",(PetscViewer,PetscBool),(viewer,skip));CHKERRQ(ierr); 4555c6c1daeSBarry Smith PetscFunctionReturn(0); 4565c6c1daeSBarry Smith } 4575c6c1daeSBarry Smith 4585c6c1daeSBarry Smith #undef __FUNCT__ 4595c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerBinaryGetSkipHeader_Binary" 4605c6c1daeSBarry Smith PetscErrorCode PetscViewerBinaryGetSkipHeader_Binary(PetscViewer viewer,PetscBool *skip) 4615c6c1daeSBarry Smith { 4625c6c1daeSBarry Smith PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data; 4635c6c1daeSBarry Smith 4645c6c1daeSBarry Smith PetscFunctionBegin; 4655c6c1daeSBarry Smith *skip = vbinary->skipheader; 4665c6c1daeSBarry Smith PetscFunctionReturn(0); 4675c6c1daeSBarry Smith } 4685c6c1daeSBarry Smith 4695c6c1daeSBarry Smith #undef __FUNCT__ 4705c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerBinaryGetSkipHeader" 4715c6c1daeSBarry Smith /*@ 4725c6c1daeSBarry Smith PetscViewerBinaryGetSkipHeader - checks whether to write a header with size information on output, or just raw data 4735c6c1daeSBarry Smith 4745c6c1daeSBarry Smith Not Collective 4755c6c1daeSBarry Smith 4765c6c1daeSBarry Smith Input Parameter: 4775c6c1daeSBarry Smith . viewer - PetscViewer context, obtained from PetscViewerBinaryOpen() 4785c6c1daeSBarry Smith 4795c6c1daeSBarry Smith Output Parameter: 4805c6c1daeSBarry Smith . skip - PETSC_TRUE means do not write header 4815c6c1daeSBarry Smith 4825c6c1daeSBarry Smith Level: advanced 4835c6c1daeSBarry Smith 4845c6c1daeSBarry Smith Notes: This must be called after PetscViewerSetType() 4855c6c1daeSBarry Smith 4865c6c1daeSBarry Smith Returns false for PETSCSOCKETVIEWER, you cannot skip the header for it. 4875c6c1daeSBarry Smith 4885c6c1daeSBarry Smith .seealso: PetscViewerBinaryOpen(), PetscViewerBinaryGetDescriptor(), PetscViewerBinarySkipInfo(), 4895c6c1daeSBarry Smith PetscViewerBinarySetSkipHeader() 4905c6c1daeSBarry Smith @*/ 4915c6c1daeSBarry Smith PetscErrorCode PetscViewerBinaryGetSkipHeader(PetscViewer viewer,PetscBool *skip) 4925c6c1daeSBarry Smith { 4935c6c1daeSBarry Smith PetscErrorCode ierr; 4945c6c1daeSBarry Smith 4955c6c1daeSBarry Smith PetscFunctionBegin; 4965c6c1daeSBarry Smith *skip = PETSC_FALSE; 4975c6c1daeSBarry Smith ierr = PetscTryMethod(viewer,"PetscViewerBinaryGetSkipHeader_C",(PetscViewer,PetscBool*),(viewer,skip));CHKERRQ(ierr); 4985c6c1daeSBarry Smith PetscFunctionReturn(0); 4995c6c1daeSBarry Smith } 5005c6c1daeSBarry Smith 5015c6c1daeSBarry Smith #undef __FUNCT__ 5025c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerBinaryGetInfoPointer_Binary" 5035c6c1daeSBarry Smith PetscErrorCode PetscViewerBinaryGetInfoPointer_Binary(PetscViewer viewer,FILE **file) 5045c6c1daeSBarry Smith { 505f3b211e4SSatish Balay PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data; 506a261c58fSBarry Smith PetscErrorCode ierr; 507a261c58fSBarry Smith MPI_Comm comm; 5085c6c1daeSBarry Smith 5095c6c1daeSBarry Smith PetscFunctionBegin; 5105c6c1daeSBarry Smith *file = vbinary->fdes_info; 511a261c58fSBarry Smith if (viewer->format == PETSC_VIEWER_BINARY_MATLAB && !vbinary->matlabheaderwritten) { 512a261c58fSBarry Smith vbinary->matlabheaderwritten = PETSC_TRUE; 513a261c58fSBarry Smith ierr = PetscObjectGetComm((PetscObject)viewer,&comm);CHKERRQ(ierr); 514a261c58fSBarry Smith ierr = PetscFPrintf(comm,*file,"%%--- begin code written by PetscViewerBinary for MATLAB format ---%\n");CHKERRQ(ierr); 515a261c58fSBarry Smith ierr = PetscFPrintf(comm,*file,"%%$$ Set.filename = '%s';\n",vbinary->filename);CHKERRQ(ierr); 516a261c58fSBarry Smith ierr = PetscFPrintf(comm,*file,"%%$$ fd = PetscOpenFile(Set.filename);\n");CHKERRQ(ierr); 517a261c58fSBarry Smith ierr = PetscFPrintf(comm,*file,"%%--- end code written by PetscViewerBinary for MATLAB format ---%\n\n");CHKERRQ(ierr); 518a261c58fSBarry Smith } 5195c6c1daeSBarry Smith PetscFunctionReturn(0); 5205c6c1daeSBarry Smith } 5215c6c1daeSBarry Smith 5225c6c1daeSBarry Smith #undef __FUNCT__ 5235c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerBinaryGetInfoPointer" 5245c6c1daeSBarry Smith /*@C 5255c6c1daeSBarry Smith PetscViewerBinaryGetInfoPointer - Extracts the file pointer for the ASCII 5265c6c1daeSBarry Smith info file associated with a binary file. 5275c6c1daeSBarry Smith 5285c6c1daeSBarry Smith Not Collective 5295c6c1daeSBarry Smith 5305c6c1daeSBarry Smith Input Parameter: 5315c6c1daeSBarry Smith . viewer - PetscViewer context, obtained from PetscViewerBinaryOpen() 5325c6c1daeSBarry Smith 5335c6c1daeSBarry Smith Output Parameter: 5340298fd71SBarry Smith . file - file pointer Always returns NULL if not a binary viewer 5355c6c1daeSBarry Smith 5365c6c1daeSBarry Smith Level: advanced 5375c6c1daeSBarry Smith 5385c6c1daeSBarry Smith Notes: 5395c6c1daeSBarry Smith For writable binary PetscViewers, the descriptor will only be valid for the 5405c6c1daeSBarry Smith first processor in the communicator that shares the PetscViewer. 5415c6c1daeSBarry Smith 5425c6c1daeSBarry Smith Fortran Note: 5435c6c1daeSBarry Smith This routine is not supported in Fortran. 5445c6c1daeSBarry Smith 5455c6c1daeSBarry Smith Concepts: PetscViewerBinary^accessing info file 5465c6c1daeSBarry Smith 5475c6c1daeSBarry Smith .seealso: PetscViewerBinaryOpen(),PetscViewerBinaryGetDescriptor() 5485c6c1daeSBarry Smith @*/ 5495c6c1daeSBarry Smith PetscErrorCode PetscViewerBinaryGetInfoPointer(PetscViewer viewer,FILE **file) 5505c6c1daeSBarry Smith { 5515c6c1daeSBarry Smith PetscErrorCode ierr; 5525c6c1daeSBarry Smith 5535c6c1daeSBarry Smith PetscFunctionBegin; 5540298fd71SBarry Smith *file = NULL; 5555c6c1daeSBarry Smith ierr = PetscTryMethod(viewer,"PetscViewerBinaryGetInfoPointer_C",(PetscViewer,FILE **),(viewer,file));CHKERRQ(ierr); 5565c6c1daeSBarry Smith PetscFunctionReturn(0); 5575c6c1daeSBarry Smith } 5585c6c1daeSBarry Smith 5595c6c1daeSBarry Smith #undef __FUNCT__ 5605c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerFileClose_Binary" 5615c6c1daeSBarry Smith static PetscErrorCode PetscViewerFileClose_Binary(PetscViewer v) 5625c6c1daeSBarry Smith { 5635c6c1daeSBarry Smith PetscViewer_Binary *vbinary = (PetscViewer_Binary*)v->data; 5645c6c1daeSBarry Smith PetscErrorCode ierr; 5655c6c1daeSBarry Smith PetscMPIInt rank; 5665c6c1daeSBarry Smith int err; 5675c6c1daeSBarry Smith 5685c6c1daeSBarry Smith PetscFunctionBegin; 569ce94432eSBarry Smith ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)v),&rank);CHKERRQ(ierr); 5705c6c1daeSBarry Smith if ((!rank || vbinary->btype == FILE_MODE_READ) && vbinary->fdes) { 5715c6c1daeSBarry Smith close(vbinary->fdes); 5725c6c1daeSBarry Smith if (!rank && vbinary->storecompressed) { 5735c6c1daeSBarry Smith char par[PETSC_MAX_PATH_LEN],buf[PETSC_MAX_PATH_LEN]; 5745c6c1daeSBarry Smith FILE *fp; 5755c6c1daeSBarry Smith /* compress the file */ 5765c6c1daeSBarry Smith ierr = PetscStrcpy(par,"gzip -f ");CHKERRQ(ierr); 5775c6c1daeSBarry Smith ierr = PetscStrcat(par,vbinary->filename);CHKERRQ(ierr); 5785c6c1daeSBarry Smith #if defined(PETSC_HAVE_POPEN) 5790298fd71SBarry Smith ierr = PetscPOpen(PETSC_COMM_SELF,NULL,par,"r",&fp);CHKERRQ(ierr); 5805c6c1daeSBarry Smith if (fgets(buf,1024,fp)) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_LIB,"Error from command %s\n%s",par,buf); 5810298fd71SBarry Smith ierr = PetscPClose(PETSC_COMM_SELF,fp,NULL);CHKERRQ(ierr); 5825c6c1daeSBarry Smith #else 5835c6c1daeSBarry Smith SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP_SYS,"Cannot run external programs on this machine"); 5845c6c1daeSBarry Smith #endif 5855c6c1daeSBarry Smith } 5865c6c1daeSBarry Smith } 5875c6c1daeSBarry Smith if (vbinary->fdes_info) { 5885c6c1daeSBarry Smith err = fclose(vbinary->fdes_info); 5895c6c1daeSBarry Smith if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file"); 5905c6c1daeSBarry Smith } 5915c6c1daeSBarry Smith ierr = PetscFree(vbinary->filename);CHKERRQ(ierr); 5925c6c1daeSBarry Smith PetscFunctionReturn(0); 5935c6c1daeSBarry Smith } 5945c6c1daeSBarry Smith 5955c6c1daeSBarry Smith #undef __FUNCT__ 5965c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerDestroy_Binary" 5975c6c1daeSBarry Smith PetscErrorCode PetscViewerDestroy_Binary(PetscViewer v) 5985c6c1daeSBarry Smith { 5995c6c1daeSBarry Smith PetscViewer_Binary *vbinary = (PetscViewer_Binary*)v->data; 6005c6c1daeSBarry Smith PetscErrorCode ierr; 6015c6c1daeSBarry Smith 6025c6c1daeSBarry Smith PetscFunctionBegin; 603a261c58fSBarry Smith if (v->format == PETSC_VIEWER_BINARY_MATLAB) { 604a261c58fSBarry Smith MPI_Comm comm; 605a261c58fSBarry Smith FILE *info; 606a261c58fSBarry Smith 607a261c58fSBarry Smith ierr = PetscObjectGetComm((PetscObject)v,&comm);CHKERRQ(ierr); 608a261c58fSBarry Smith ierr = PetscViewerBinaryGetInfoPointer(v,&info);CHKERRQ(ierr); 609a261c58fSBarry Smith ierr = PetscFPrintf(comm,info,"%%--- begin code written by PetscViewerBinary for MATLAB format ---%\n");CHKERRQ(ierr); 610a261c58fSBarry Smith ierr = PetscFPrintf(comm,info,"%%$$ close(fd);\n");CHKERRQ(ierr); 611a261c58fSBarry Smith ierr = PetscFPrintf(comm,info,"%%--- end code written by PetscViewerBinary for MATLAB format ---%\n\n");CHKERRQ(ierr); 612a261c58fSBarry Smith } 6135c6c1daeSBarry Smith ierr = PetscViewerFileClose_Binary(v);CHKERRQ(ierr); 6145c6c1daeSBarry Smith ierr = PetscFree(vbinary);CHKERRQ(ierr); 6155c6c1daeSBarry Smith PetscFunctionReturn(0); 6165c6c1daeSBarry Smith } 6175c6c1daeSBarry Smith 6185c6c1daeSBarry Smith #if defined(PETSC_HAVE_MPIIO) 6195c6c1daeSBarry Smith #undef __FUNCT__ 6205c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerFileClose_MPIIO" 6215c6c1daeSBarry Smith static PetscErrorCode PetscViewerFileClose_MPIIO(PetscViewer v) 6225c6c1daeSBarry Smith { 6235c6c1daeSBarry Smith PetscViewer_Binary *vbinary = (PetscViewer_Binary*)v->data; 6245c6c1daeSBarry Smith int err; 6255c6c1daeSBarry Smith PetscErrorCode ierr; 6265c6c1daeSBarry Smith 6275c6c1daeSBarry Smith PetscFunctionBegin; 6285c6c1daeSBarry Smith if (vbinary->mfdes) { 6295c6c1daeSBarry Smith ierr = MPI_File_close(&vbinary->mfdes);CHKERRQ(ierr); 6305c6c1daeSBarry Smith } 6315c6c1daeSBarry Smith if (vbinary->fdes_info) { 6325c6c1daeSBarry Smith err = fclose(vbinary->fdes_info); 6335c6c1daeSBarry Smith if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file"); 6345c6c1daeSBarry Smith } 6355c6c1daeSBarry Smith ierr = PetscFree(vbinary->filename);CHKERRQ(ierr); 6365c6c1daeSBarry Smith PetscFunctionReturn(0); 6375c6c1daeSBarry Smith } 6385c6c1daeSBarry Smith 6395c6c1daeSBarry Smith 6405c6c1daeSBarry Smith #undef __FUNCT__ 6415c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerDestroy_MPIIO" 6425c6c1daeSBarry Smith PetscErrorCode PetscViewerDestroy_MPIIO(PetscViewer v) 6435c6c1daeSBarry Smith { 6445c6c1daeSBarry Smith PetscViewer_Binary *vbinary = (PetscViewer_Binary*)v->data; 6455c6c1daeSBarry Smith PetscErrorCode ierr; 6465c6c1daeSBarry Smith 6475c6c1daeSBarry Smith PetscFunctionBegin; 6485c6c1daeSBarry Smith ierr = PetscViewerFileClose_MPIIO(v);CHKERRQ(ierr); 6495c6c1daeSBarry Smith ierr = PetscFree(vbinary);CHKERRQ(ierr); 6505c6c1daeSBarry Smith PetscFunctionReturn(0); 6515c6c1daeSBarry Smith } 6525c6c1daeSBarry Smith #endif 6535c6c1daeSBarry Smith 6545c6c1daeSBarry Smith #undef __FUNCT__ 6555c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerBinaryOpen" 6565c6c1daeSBarry Smith /*@C 6575c6c1daeSBarry Smith PetscViewerBinaryOpen - Opens a file for binary input/output. 6585c6c1daeSBarry Smith 6595c6c1daeSBarry Smith Collective on MPI_Comm 6605c6c1daeSBarry Smith 6615c6c1daeSBarry Smith Input Parameters: 6625c6c1daeSBarry Smith + comm - MPI communicator 6635c6c1daeSBarry Smith . name - name of file 6645c6c1daeSBarry Smith - type - type of file 6655c6c1daeSBarry Smith $ FILE_MODE_WRITE - create new file for binary output 6665c6c1daeSBarry Smith $ FILE_MODE_READ - open existing file for binary input 6675c6c1daeSBarry Smith $ FILE_MODE_APPEND - open existing file for binary output 6685c6c1daeSBarry Smith 6695c6c1daeSBarry Smith Output Parameter: 6705c6c1daeSBarry Smith . binv - PetscViewer for binary input/output to use with the specified file 6715c6c1daeSBarry Smith 6725c6c1daeSBarry Smith Options Database Keys: 6735c6c1daeSBarry Smith + -viewer_binary_skip_info 6745c6c1daeSBarry Smith . -viewer_binary_skip_options 6755c6c1daeSBarry Smith - -viewer_binary_skip_header 6765c6c1daeSBarry Smith 6775c6c1daeSBarry Smith Level: beginner 6785c6c1daeSBarry Smith 6795c6c1daeSBarry Smith Note: 6805c6c1daeSBarry Smith This PetscViewer should be destroyed with PetscViewerDestroy(). 6815c6c1daeSBarry Smith 6825c6c1daeSBarry Smith For reading files, the filename may begin with ftp:// or http:// and/or 6835c6c1daeSBarry Smith end with .gz; in this case file is brought over and uncompressed. 6845c6c1daeSBarry Smith 6855c6c1daeSBarry Smith For creating files, if the file name ends with .gz it is automatically 6865c6c1daeSBarry Smith compressed when closed. 6875c6c1daeSBarry Smith 6885c6c1daeSBarry Smith For writing files it only opens the file on processor 0 in the communicator. 6895c6c1daeSBarry Smith For readable files it opens the file on all nodes that have the file. If 6905c6c1daeSBarry Smith node 0 does not have the file it generates an error even if other nodes 6915c6c1daeSBarry Smith do have the file. 6925c6c1daeSBarry Smith 6935c6c1daeSBarry Smith Concepts: binary files 6945c6c1daeSBarry Smith Concepts: PetscViewerBinary^creating 6955c6c1daeSBarry Smith Concepts: gzip 6965c6c1daeSBarry Smith Concepts: accessing remote file 6975c6c1daeSBarry Smith Concepts: remote file 6985c6c1daeSBarry Smith 6995c6c1daeSBarry Smith .seealso: PetscViewerASCIIOpen(), PetscViewerSetFormat(), PetscViewerDestroy(), 7005c6c1daeSBarry Smith VecView(), MatView(), VecLoad(), MatLoad(), PetscViewerBinaryGetDescriptor(), 7015c6c1daeSBarry Smith PetscViewerBinaryGetInfoPointer(), PetscFileMode, PetscViewer, PetscViewerBinaryRead() 7025c6c1daeSBarry Smith @*/ 7035c6c1daeSBarry Smith PetscErrorCode PetscViewerBinaryOpen(MPI_Comm comm,const char name[],PetscFileMode type,PetscViewer *binv) 7045c6c1daeSBarry Smith { 7055c6c1daeSBarry Smith PetscErrorCode ierr; 7065c6c1daeSBarry Smith 7075c6c1daeSBarry Smith PetscFunctionBegin; 7085c6c1daeSBarry Smith ierr = PetscViewerCreate(comm,binv);CHKERRQ(ierr); 7095c6c1daeSBarry Smith ierr = PetscViewerSetType(*binv,PETSCVIEWERBINARY);CHKERRQ(ierr); 7105c6c1daeSBarry Smith ierr = PetscViewerFileSetMode(*binv,type);CHKERRQ(ierr); 7115c6c1daeSBarry Smith ierr = PetscViewerFileSetName(*binv,name);CHKERRQ(ierr); 7125c6c1daeSBarry Smith PetscFunctionReturn(0); 7135c6c1daeSBarry Smith } 7145c6c1daeSBarry Smith 7155c6c1daeSBarry Smith #if defined(PETSC_HAVE_MPIIO) 7165c6c1daeSBarry Smith #undef __FUNCT__ 7175c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerBinaryMPIIO" 7185c6c1daeSBarry Smith static PetscErrorCode PetscViewerBinaryMPIIO(PetscViewer viewer,void *data,PetscInt count,PetscDataType dtype,PetscBool write) 7195c6c1daeSBarry Smith { 7205c6c1daeSBarry Smith PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data; 7215c6c1daeSBarry Smith PetscErrorCode ierr; 7225c6c1daeSBarry Smith MPI_Datatype mdtype; 723e597bc1dSJed Brown PetscMPIInt cnt; 7245c6c1daeSBarry Smith MPI_Status status; 7255c6c1daeSBarry Smith MPI_Aint ul,dsize; 7265c6c1daeSBarry Smith 7275c6c1daeSBarry Smith PetscFunctionBegin; 7284dc2109aSBarry Smith ierr = PetscMPIIntCast(count,&cnt);CHKERRQ(ierr); 7295c6c1daeSBarry Smith ierr = PetscDataTypeToMPIDataType(dtype,&mdtype);CHKERRQ(ierr); 7305c6c1daeSBarry Smith ierr = MPI_File_set_view(vbinary->mfdes,vbinary->moff,mdtype,mdtype,(char*)"native",MPI_INFO_NULL);CHKERRQ(ierr); 7315c6c1daeSBarry Smith if (write) { 7325c6c1daeSBarry Smith ierr = MPIU_File_write_all(vbinary->mfdes,data,cnt,mdtype,&status);CHKERRQ(ierr); 7335c6c1daeSBarry Smith } else { 7345c6c1daeSBarry Smith ierr = MPIU_File_read_all(vbinary->mfdes,data,cnt,mdtype,&status);CHKERRQ(ierr); 7355c6c1daeSBarry Smith } 7365c6c1daeSBarry Smith ierr = MPI_Type_get_extent(mdtype,&ul,&dsize);CHKERRQ(ierr); 737a297a907SKarl Rupp 7385c6c1daeSBarry Smith vbinary->moff += dsize*cnt; 7395c6c1daeSBarry Smith PetscFunctionReturn(0); 7405c6c1daeSBarry Smith } 7415c6c1daeSBarry Smith #endif 7425c6c1daeSBarry Smith 7435c6c1daeSBarry Smith #undef __FUNCT__ 7445c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerBinaryRead" 7455c6c1daeSBarry Smith /*@C 7465c6c1daeSBarry Smith PetscViewerBinaryRead - Reads from a binary file, all processors get the same result 7475c6c1daeSBarry Smith 7485c6c1daeSBarry Smith Collective on MPI_Comm 7495c6c1daeSBarry Smith 7505c6c1daeSBarry Smith Input Parameters: 7515c6c1daeSBarry Smith + viewer - the binary viewer 7525c6c1daeSBarry Smith . data - location to write the data 7535c6c1daeSBarry Smith . count - number of items of data to read 7545c6c1daeSBarry Smith - datatype - type of data to read 7555c6c1daeSBarry Smith 7565c6c1daeSBarry Smith Level: beginner 7575c6c1daeSBarry Smith 7585c6c1daeSBarry Smith Concepts: binary files 7595c6c1daeSBarry Smith 7605c6c1daeSBarry Smith .seealso: PetscViewerASCIIOpen(), PetscViewerSetFormat(), PetscViewerDestroy(), 7615c6c1daeSBarry Smith VecView(), MatView(), VecLoad(), MatLoad(), PetscViewerBinaryGetDescriptor(), 7625c6c1daeSBarry Smith PetscViewerBinaryGetInfoPointer(), PetscFileMode, PetscViewer, PetscBinaryViewerRead() 7635c6c1daeSBarry Smith @*/ 7645c6c1daeSBarry Smith PetscErrorCode PetscViewerBinaryRead(PetscViewer viewer,void *data,PetscInt count,PetscDataType dtype) 7655c6c1daeSBarry Smith { 7665c6c1daeSBarry Smith PetscErrorCode ierr; 7675c6c1daeSBarry Smith PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data; 7685c6c1daeSBarry Smith 7695c6c1daeSBarry Smith #if defined(PETSC_HAVE_MPIIO) 7705c6c1daeSBarry Smith if (vbinary->MPIIO) { 7715c6c1daeSBarry Smith ierr = PetscViewerBinaryMPIIO(viewer,data,count,dtype,PETSC_FALSE);CHKERRQ(ierr); 7725c6c1daeSBarry Smith } else { 7735c6c1daeSBarry Smith #endif 774ce94432eSBarry Smith ierr = PetscBinarySynchronizedRead(PetscObjectComm((PetscObject)viewer),vbinary->fdes,data,count,dtype);CHKERRQ(ierr); 7755c6c1daeSBarry Smith #if defined(PETSC_HAVE_MPIIO) 7765c6c1daeSBarry Smith } 7775c6c1daeSBarry Smith #endif 7785c6c1daeSBarry Smith PetscFunctionReturn(0); 7795c6c1daeSBarry Smith } 7805c6c1daeSBarry Smith 7815c6c1daeSBarry Smith 7825c6c1daeSBarry Smith #undef __FUNCT__ 7835c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerBinaryWrite" 7845c6c1daeSBarry Smith /*@C 7855c6c1daeSBarry Smith PetscViewerBinaryWrite - writes to a binary file, only from the first process 7865c6c1daeSBarry Smith 7875c6c1daeSBarry Smith Collective on MPI_Comm 7885c6c1daeSBarry Smith 7895c6c1daeSBarry Smith Input Parameters: 7905c6c1daeSBarry Smith + viewer - the binary viewer 7915c6c1daeSBarry Smith . data - location of data 7925c6c1daeSBarry Smith . count - number of items of data to read 7935c6c1daeSBarry Smith . dtype - type of data to read 7945c6c1daeSBarry Smith - istemp - data may be overwritten 7955c6c1daeSBarry Smith 7965c6c1daeSBarry Smith Level: beginner 7975c6c1daeSBarry Smith 7985c6c1daeSBarry Smith Notes: because byte-swapping may be done on the values in data it cannot be declared const 7995c6c1daeSBarry Smith 8005c6c1daeSBarry Smith Concepts: binary files 8015c6c1daeSBarry Smith 8025c6c1daeSBarry Smith .seealso: PetscViewerASCIIOpen(), PetscViewerSetFormat(), PetscViewerDestroy(), 8035c6c1daeSBarry Smith VecView(), MatView(), VecLoad(), MatLoad(), PetscViewerBinaryGetDescriptor(), PetscDataType 8045c6c1daeSBarry Smith PetscViewerBinaryGetInfoPointer(), PetscFileMode, PetscViewer, PetscBinaryViewerRead() 8055c6c1daeSBarry Smith @*/ 8065c6c1daeSBarry Smith PetscErrorCode PetscViewerBinaryWrite(PetscViewer viewer,void *data,PetscInt count,PetscDataType dtype,PetscBool istemp) 8075c6c1daeSBarry Smith { 8085c6c1daeSBarry Smith PetscErrorCode ierr; 8095c6c1daeSBarry Smith PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data; 8105c6c1daeSBarry Smith 8115c6c1daeSBarry Smith PetscFunctionBegin; 8125c6c1daeSBarry Smith #if defined(PETSC_HAVE_MPIIO) 8135c6c1daeSBarry Smith if (vbinary->MPIIO) { 8145c6c1daeSBarry Smith ierr = PetscViewerBinaryMPIIO(viewer,data,count,dtype,PETSC_TRUE);CHKERRQ(ierr); 8155c6c1daeSBarry Smith } else { 8165c6c1daeSBarry Smith #endif 817ce94432eSBarry Smith ierr = PetscBinarySynchronizedWrite(PetscObjectComm((PetscObject)viewer),vbinary->fdes,data,count,dtype,istemp);CHKERRQ(ierr); 8185c6c1daeSBarry Smith #if defined(PETSC_HAVE_MPIIO) 8195c6c1daeSBarry Smith } 8205c6c1daeSBarry Smith #endif 8215c6c1daeSBarry Smith PetscFunctionReturn(0); 8225c6c1daeSBarry Smith } 8235c6c1daeSBarry Smith 8245c6c1daeSBarry Smith #undef __FUNCT__ 8255c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerBinaryWriteStringArray" 8265c6c1daeSBarry Smith /*@C 8275c6c1daeSBarry Smith PetscViewerBinaryWriteStringArray - writes to a binary file, only from the first process an array of strings 8285c6c1daeSBarry Smith 8295c6c1daeSBarry Smith Collective on MPI_Comm 8305c6c1daeSBarry Smith 8315c6c1daeSBarry Smith Input Parameters: 8325c6c1daeSBarry Smith + viewer - the binary viewer 8335c6c1daeSBarry Smith - data - location of the array of strings 8345c6c1daeSBarry Smith 8355c6c1daeSBarry Smith 8365c6c1daeSBarry Smith Level: intermediate 8375c6c1daeSBarry Smith 8385c6c1daeSBarry Smith Concepts: binary files 8395c6c1daeSBarry Smith 8405c6c1daeSBarry Smith Notes: array of strings is null terminated 8415c6c1daeSBarry Smith 8425c6c1daeSBarry Smith .seealso: PetscViewerASCIIOpen(), PetscViewerSetFormat(), PetscViewerDestroy(), 8435c6c1daeSBarry Smith VecView(), MatView(), VecLoad(), MatLoad(), PetscViewerBinaryGetDescriptor(), 8445c6c1daeSBarry Smith PetscViewerBinaryGetInfoPointer(), PetscFileMode, PetscViewer, PetscBinaryViewerRead() 8455c6c1daeSBarry Smith @*/ 8465c6c1daeSBarry Smith PetscErrorCode PetscViewerBinaryWriteStringArray(PetscViewer viewer,char **data) 8475c6c1daeSBarry Smith { 8485c6c1daeSBarry Smith PetscErrorCode ierr; 8495c6c1daeSBarry Smith PetscInt i,n = 0,*sizes; 8505c6c1daeSBarry Smith 8515c6c1daeSBarry Smith /* count number of strings */ 8525c6c1daeSBarry Smith while (data[n++]) ; 8535c6c1daeSBarry Smith n--; 8545c6c1daeSBarry Smith ierr = PetscMalloc((n+1)*sizeof(PetscInt),&sizes);CHKERRQ(ierr); 8555c6c1daeSBarry Smith sizes[0] = n; 8565c6c1daeSBarry Smith for (i=0; i<n; i++) { 8575c6c1daeSBarry Smith size_t tmp; 8585c6c1daeSBarry Smith ierr = PetscStrlen(data[i],&tmp);CHKERRQ(ierr); 8595c6c1daeSBarry Smith sizes[i+1] = tmp + 1; /* size includes space for the null terminator */ 8605c6c1daeSBarry Smith } 8615c6c1daeSBarry Smith ierr = PetscViewerBinaryWrite(viewer,sizes,n+1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr); 8625c6c1daeSBarry Smith for (i=0; i<n; i++) { 8635c6c1daeSBarry Smith ierr = PetscViewerBinaryWrite(viewer,data[i],sizes[i+1],PETSC_CHAR,PETSC_FALSE);CHKERRQ(ierr); 8645c6c1daeSBarry Smith } 8655c6c1daeSBarry Smith ierr = PetscFree(sizes);CHKERRQ(ierr); 8665c6c1daeSBarry Smith PetscFunctionReturn(0); 8675c6c1daeSBarry Smith } 8685c6c1daeSBarry Smith 8695c6c1daeSBarry Smith /*@C 8705c6c1daeSBarry Smith PetscViewerBinaryReadStringArray - reads a binary file an array of strings 8715c6c1daeSBarry Smith 8725c6c1daeSBarry Smith Collective on MPI_Comm 8735c6c1daeSBarry Smith 8745c6c1daeSBarry Smith Input Parameter: 8755c6c1daeSBarry Smith . viewer - the binary viewer 8765c6c1daeSBarry Smith 8775c6c1daeSBarry Smith Output Parameter: 8785c6c1daeSBarry Smith . data - location of the array of strings 8795c6c1daeSBarry Smith 8805c6c1daeSBarry Smith Level: intermediate 8815c6c1daeSBarry Smith 8825c6c1daeSBarry Smith Concepts: binary files 8835c6c1daeSBarry Smith 8845c6c1daeSBarry Smith Notes: array of strings is null terminated 8855c6c1daeSBarry Smith 8865c6c1daeSBarry Smith .seealso: PetscViewerASCIIOpen(), PetscViewerSetFormat(), PetscViewerDestroy(), 8875c6c1daeSBarry Smith VecView(), MatView(), VecLoad(), MatLoad(), PetscViewerBinaryGetDescriptor(), 8885c6c1daeSBarry Smith PetscViewerBinaryGetInfoPointer(), PetscFileMode, PetscViewer, PetscBinaryViewerRead() 8895c6c1daeSBarry Smith @*/ 8905c6c1daeSBarry Smith PetscErrorCode PetscViewerBinaryReadStringArray(PetscViewer viewer,char ***data) 8915c6c1daeSBarry Smith { 8925c6c1daeSBarry Smith PetscErrorCode ierr; 8935c6c1daeSBarry Smith PetscInt i,n,*sizes,N = 0; 8945c6c1daeSBarry Smith 8955c6c1daeSBarry Smith /* count number of strings */ 8965c6c1daeSBarry Smith ierr = PetscViewerBinaryRead(viewer,&n,1,PETSC_INT);CHKERRQ(ierr); 8975c6c1daeSBarry Smith ierr = PetscMalloc(n*sizeof(PetscInt),&sizes);CHKERRQ(ierr); 8985c6c1daeSBarry Smith ierr = PetscViewerBinaryRead(viewer,sizes,n,PETSC_INT);CHKERRQ(ierr); 899a297a907SKarl Rupp for (i=0; i<n; i++) N += sizes[i]; 9005c6c1daeSBarry Smith ierr = PetscMalloc((n+1)*sizeof(char*) + N*sizeof(char),data);CHKERRQ(ierr); 9015c6c1daeSBarry Smith (*data)[0] = (char*)((*data) + n + 1); 902a297a907SKarl Rupp for (i=1; i<n; i++) (*data)[i] = (*data)[i-1] + sizes[i-1]; 9035c6c1daeSBarry Smith ierr = PetscViewerBinaryRead(viewer,(*data)[0],N,PETSC_CHAR);CHKERRQ(ierr); 904a297a907SKarl Rupp 9055c6c1daeSBarry Smith (*data)[n] = 0; 906a297a907SKarl Rupp 9075c6c1daeSBarry Smith ierr = PetscFree(sizes);CHKERRQ(ierr); 9085c6c1daeSBarry Smith PetscFunctionReturn(0); 9095c6c1daeSBarry Smith } 9105c6c1daeSBarry Smith 9115c6c1daeSBarry Smith #undef __FUNCT__ 9125c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerFileGetName_Binary" 9135c6c1daeSBarry Smith PetscErrorCode PetscViewerFileGetName_Binary(PetscViewer viewer,const char **name) 9145c6c1daeSBarry Smith { 9155c6c1daeSBarry Smith PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data; 9165c6c1daeSBarry Smith 9175c6c1daeSBarry Smith PetscFunctionBegin; 9185c6c1daeSBarry Smith *name = vbinary->filename; 9195c6c1daeSBarry Smith PetscFunctionReturn(0); 9205c6c1daeSBarry Smith } 9215c6c1daeSBarry Smith 9225c6c1daeSBarry Smith #undef __FUNCT__ 9235c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerFileGetMode" 9245c6c1daeSBarry Smith /*@C 9255c6c1daeSBarry Smith PetscViewerFileGetMode - Gets the type of file to be open 9265c6c1daeSBarry Smith 9275c6c1daeSBarry Smith Not Collective 9285c6c1daeSBarry Smith 9295c6c1daeSBarry Smith Input Parameter: 9305c6c1daeSBarry Smith . viewer - the PetscViewer; must be a binary, MATLAB, hdf, or netcdf PetscViewer 9315c6c1daeSBarry Smith 9325c6c1daeSBarry Smith Output Parameter: 9335c6c1daeSBarry Smith . type - type of file 9345c6c1daeSBarry Smith $ FILE_MODE_WRITE - create new file for binary output 9355c6c1daeSBarry Smith $ FILE_MODE_READ - open existing file for binary input 9365c6c1daeSBarry Smith $ FILE_MODE_APPEND - open existing file for binary output 9375c6c1daeSBarry Smith 9385c6c1daeSBarry Smith Level: advanced 9395c6c1daeSBarry Smith 9405c6c1daeSBarry Smith .seealso: PetscViewerFileSetMode(), PetscViewerCreate(), PetscViewerSetType(), PetscViewerBinaryOpen() 9415c6c1daeSBarry Smith 9425c6c1daeSBarry Smith @*/ 9435c6c1daeSBarry Smith PetscErrorCode PetscViewerFileGetMode(PetscViewer viewer,PetscFileMode *type) 9445c6c1daeSBarry Smith { 9455c6c1daeSBarry Smith PetscErrorCode ierr; 9465c6c1daeSBarry Smith 9475c6c1daeSBarry Smith PetscFunctionBegin; 9485c6c1daeSBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1); 9495c6c1daeSBarry Smith PetscValidPointer(type,2); 9505c6c1daeSBarry Smith ierr = PetscUseMethod(viewer,"PetscViewerFileGetMode_C",(PetscViewer,PetscFileMode*),(viewer,type));CHKERRQ(ierr); 9515c6c1daeSBarry Smith PetscFunctionReturn(0); 9525c6c1daeSBarry Smith } 9535c6c1daeSBarry Smith 9545c6c1daeSBarry Smith #undef __FUNCT__ 9555c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerBinarySetMPIIO" 9565c6c1daeSBarry Smith /*@ 9575c6c1daeSBarry Smith PetscViewerBinarySetMPIIO - Sets a binary viewer to use MPI IO for reading/writing. Must be called 9585c6c1daeSBarry Smith before PetscViewerFileSetName() 9595c6c1daeSBarry Smith 9605c6c1daeSBarry Smith Logically Collective on PetscViewer 9615c6c1daeSBarry Smith 9625c6c1daeSBarry Smith Input Parameters: 9635c6c1daeSBarry Smith . viewer - the PetscViewer; must be a binary 9645c6c1daeSBarry Smith 9655c6c1daeSBarry Smith Options Database: 9665c6c1daeSBarry Smith -viewer_binary_mpiio : Flag for using MPI-IO 9675c6c1daeSBarry Smith 9685c6c1daeSBarry Smith Notes: turns off the default usage of the .info file since that is not scalable 9695c6c1daeSBarry Smith 9705c6c1daeSBarry Smith Level: advanced 9715c6c1daeSBarry Smith 9725c6c1daeSBarry Smith .seealso: PetscViewerFileSetMode(), PetscViewerCreate(), PetscViewerSetType(), PetscViewerBinaryOpen() 9735c6c1daeSBarry Smith 9745c6c1daeSBarry Smith @*/ 9755c6c1daeSBarry Smith PetscErrorCode PetscViewerBinarySetMPIIO(PetscViewer viewer) 9765c6c1daeSBarry Smith { 9775c6c1daeSBarry Smith PetscErrorCode ierr; 9785c6c1daeSBarry Smith 9795c6c1daeSBarry Smith PetscFunctionBegin; 9805c6c1daeSBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1); 9815c6c1daeSBarry Smith ierr = PetscTryMethod(viewer,"PetscViewerBinarySetMPIIO_C",(PetscViewer),(viewer));CHKERRQ(ierr); 9825c6c1daeSBarry Smith PetscFunctionReturn(0); 9835c6c1daeSBarry Smith } 9845c6c1daeSBarry Smith 9855c6c1daeSBarry Smith 9865c6c1daeSBarry Smith #undef __FUNCT__ 9875c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerFileSetMode" 9885c6c1daeSBarry Smith /*@C 9895c6c1daeSBarry Smith PetscViewerFileSetMode - Sets the type of file to be open 9905c6c1daeSBarry Smith 9915c6c1daeSBarry Smith Logically Collective on PetscViewer 9925c6c1daeSBarry Smith 9935c6c1daeSBarry Smith Input Parameters: 9945c6c1daeSBarry Smith + viewer - the PetscViewer; must be a binary, Matlab, hdf, or netcdf PetscViewer 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 PetscViewerFileSetMode(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 PetscValidLogicalCollectiveEnum(viewer,type,2); 10125c6c1daeSBarry Smith ierr = PetscTryMethod(viewer,"PetscViewerFileSetMode_C",(PetscViewer,PetscFileMode),(viewer,type));CHKERRQ(ierr); 10135c6c1daeSBarry Smith PetscFunctionReturn(0); 10145c6c1daeSBarry Smith } 10155c6c1daeSBarry Smith 10165c6c1daeSBarry Smith #undef __FUNCT__ 10175c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerFileGetMode_Binary" 10185c6c1daeSBarry Smith PetscErrorCode PetscViewerFileGetMode_Binary(PetscViewer viewer,PetscFileMode *type) 10195c6c1daeSBarry Smith { 10205c6c1daeSBarry Smith PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data; 10215c6c1daeSBarry Smith 10225c6c1daeSBarry Smith PetscFunctionBegin; 10235c6c1daeSBarry Smith *type = vbinary->btype; 10245c6c1daeSBarry Smith PetscFunctionReturn(0); 10255c6c1daeSBarry Smith } 10265c6c1daeSBarry Smith 10275c6c1daeSBarry Smith #undef __FUNCT__ 10285c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerFileSetMode_Binary" 10295c6c1daeSBarry Smith PetscErrorCode PetscViewerFileSetMode_Binary(PetscViewer viewer,PetscFileMode type) 10305c6c1daeSBarry Smith { 10315c6c1daeSBarry Smith PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data; 10325c6c1daeSBarry Smith 10335c6c1daeSBarry Smith PetscFunctionBegin; 10345c6c1daeSBarry Smith vbinary->btype = type; 10355c6c1daeSBarry Smith PetscFunctionReturn(0); 10365c6c1daeSBarry Smith } 10375c6c1daeSBarry Smith 10385c6c1daeSBarry Smith /* 10395c6c1daeSBarry Smith Actually opens the file 10405c6c1daeSBarry Smith */ 10415c6c1daeSBarry Smith #undef __FUNCT__ 10425c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerFileSetName_Binary" 10435c6c1daeSBarry Smith PetscErrorCode PetscViewerFileSetName_Binary(PetscViewer viewer,const char name[]) 10445c6c1daeSBarry Smith { 10455c6c1daeSBarry Smith PetscMPIInt rank; 10465c6c1daeSBarry Smith PetscErrorCode ierr; 10475c6c1daeSBarry Smith size_t len; 10485c6c1daeSBarry Smith PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data; 10495c6c1daeSBarry Smith const char *fname; 10505c6c1daeSBarry Smith char bname[PETSC_MAX_PATH_LEN],*gz; 10515c6c1daeSBarry Smith PetscBool found; 10525c6c1daeSBarry Smith PetscFileMode type = vbinary->btype; 10535c6c1daeSBarry Smith 10545c6c1daeSBarry Smith PetscFunctionBegin; 10555c6c1daeSBarry Smith if (type == (PetscFileMode) -1) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"Must call PetscViewerFileSetMode() before PetscViewerFileSetName()"); 10565c6c1daeSBarry Smith ierr = PetscViewerFileClose_Binary(viewer);CHKERRQ(ierr); 10570298fd71SBarry Smith ierr = PetscOptionsGetBool(((PetscObject)viewer)->prefix,"-viewer_binary_skip_info",&vbinary->skipinfo,NULL);CHKERRQ(ierr); 10580298fd71SBarry Smith ierr = PetscOptionsGetBool(((PetscObject)viewer)->prefix,"-viewer_binary_skip_options",&vbinary->skipoptions,NULL);CHKERRQ(ierr); 10590298fd71SBarry Smith ierr = PetscOptionsGetBool(((PetscObject)viewer)->prefix,"-viewer_binary_skip_header",&vbinary->skipheader,NULL);CHKERRQ(ierr); 10605c6c1daeSBarry Smith 1061ce94432eSBarry Smith ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)viewer),&rank);CHKERRQ(ierr); 10625c6c1daeSBarry Smith 10635c6c1daeSBarry Smith /* copy name so we can edit it */ 10645c6c1daeSBarry Smith ierr = PetscStrallocpy(name,&vbinary->filename);CHKERRQ(ierr); 10655c6c1daeSBarry Smith 10665c6c1daeSBarry Smith /* if ends in .gz strip that off and note user wants file compressed */ 10675c6c1daeSBarry Smith vbinary->storecompressed = PETSC_FALSE; 10685c6c1daeSBarry Smith if (!rank && type == FILE_MODE_WRITE) { 10695c6c1daeSBarry Smith /* remove .gz if it ends library name */ 10705c6c1daeSBarry Smith ierr = PetscStrstr(vbinary->filename,".gz",&gz);CHKERRQ(ierr); 10715c6c1daeSBarry Smith if (gz) { 10725c6c1daeSBarry Smith ierr = PetscStrlen(gz,&len);CHKERRQ(ierr); 10735c6c1daeSBarry Smith if (len == 3) { 10745c6c1daeSBarry Smith *gz = 0; 10755c6c1daeSBarry Smith vbinary->storecompressed = PETSC_TRUE; 10765c6c1daeSBarry Smith } 10775c6c1daeSBarry Smith } 10785c6c1daeSBarry Smith } 10795c6c1daeSBarry Smith 10805c6c1daeSBarry Smith /* only first processor opens file if writeable */ 10815c6c1daeSBarry Smith if (!rank || type == FILE_MODE_READ) { 10825c6c1daeSBarry Smith 10835c6c1daeSBarry Smith if (type == FILE_MODE_READ) { 10845c6c1daeSBarry Smith /* possibly get the file from remote site or compressed file */ 1085ce94432eSBarry Smith ierr = PetscFileRetrieve(PetscObjectComm((PetscObject)viewer),vbinary->filename,bname,PETSC_MAX_PATH_LEN,&found);CHKERRQ(ierr); 10865c6c1daeSBarry Smith fname = bname; 10875c6c1daeSBarry Smith if (!rank && !found) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot locate file: %s on node zero",vbinary->filename); 10885c6c1daeSBarry Smith else if (!found) { 10895c6c1daeSBarry Smith ierr = PetscInfo(viewer,"Nonzero processor did not locate readonly file\n");CHKERRQ(ierr); 10905c6c1daeSBarry Smith fname = 0; 10915c6c1daeSBarry Smith } 1092a297a907SKarl Rupp } else fname = vbinary->filename; 10935c6c1daeSBarry Smith 10945c6c1daeSBarry Smith #if defined(PETSC_HAVE_O_BINARY) 10955c6c1daeSBarry Smith if (type == FILE_MODE_WRITE) { 10965c6c1daeSBarry 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); 10975c6c1daeSBarry Smith } else if (type == FILE_MODE_READ && fname) { 10985c6c1daeSBarry 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); 10995c6c1daeSBarry Smith } else if (type == FILE_MODE_APPEND) { 11005c6c1daeSBarry 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); 11015c6c1daeSBarry Smith } else if (fname) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Unknown file type"); 11025c6c1daeSBarry Smith #else 11035c6c1daeSBarry Smith if (type == FILE_MODE_WRITE) { 11045c6c1daeSBarry Smith if ((vbinary->fdes = creat(fname,0666)) == -1) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot create file %s for writing",fname); 11055c6c1daeSBarry Smith } else if (type == FILE_MODE_READ && fname) { 11065c6c1daeSBarry 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); 11075c6c1daeSBarry Smith } else if (type == FILE_MODE_APPEND) { 11085c6c1daeSBarry 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); 11095c6c1daeSBarry Smith } else if (fname) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Unknown file type"); 11105c6c1daeSBarry Smith #endif 11115c6c1daeSBarry Smith } else vbinary->fdes = -1; 11125c6c1daeSBarry Smith viewer->format = PETSC_VIEWER_NOFORMAT; 11135c6c1daeSBarry Smith 11145c6c1daeSBarry Smith /* 11155c6c1daeSBarry Smith try to open info file: all processors open this file if read only 11165c6c1daeSBarry Smith */ 11175c6c1daeSBarry Smith if (!vbinary->skipinfo && (!rank || type == FILE_MODE_READ)) { 11185c6c1daeSBarry Smith char infoname[PETSC_MAX_PATH_LEN],iname[PETSC_MAX_PATH_LEN]; 11195c6c1daeSBarry Smith 11205c6c1daeSBarry Smith ierr = PetscStrcpy(infoname,name);CHKERRQ(ierr); 11215c6c1daeSBarry Smith /* remove .gz if it ends library name */ 11225c6c1daeSBarry Smith ierr = PetscStrstr(infoname,".gz",&gz);CHKERRQ(ierr); 11235c6c1daeSBarry Smith if (gz) { 11245c6c1daeSBarry Smith ierr = PetscStrlen(gz,&len);CHKERRQ(ierr); 1125a297a907SKarl Rupp if (len == 3) *gz = 0; 11265c6c1daeSBarry Smith } 11275c6c1daeSBarry Smith 11285c6c1daeSBarry Smith ierr = PetscStrcat(infoname,".info");CHKERRQ(ierr); 11295c6c1daeSBarry Smith ierr = PetscFixFilename(infoname,iname);CHKERRQ(ierr); 11305c6c1daeSBarry Smith if (type == FILE_MODE_READ) { 1131ce94432eSBarry Smith ierr = PetscFileRetrieve(PetscObjectComm((PetscObject)viewer),iname,infoname,PETSC_MAX_PATH_LEN,&found);CHKERRQ(ierr); 1132ce94432eSBarry Smith ierr = PetscOptionsInsertFile(PetscObjectComm((PetscObject)viewer),infoname,PETSC_FALSE);CHKERRQ(ierr); 11335c6c1daeSBarry Smith } else { 11345c6c1daeSBarry Smith vbinary->fdes_info = fopen(infoname,"w"); 11355c6c1daeSBarry Smith if (!vbinary->fdes_info) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open .info file %s for writing",infoname); 11365c6c1daeSBarry Smith } 11375c6c1daeSBarry Smith } 11385c6c1daeSBarry Smith 11395c6c1daeSBarry Smith #if defined(PETSC_USE_LOG) 11405c6c1daeSBarry Smith PetscLogObjectState((PetscObject)viewer,"File: %s",name); 11415c6c1daeSBarry Smith #endif 11425c6c1daeSBarry Smith PetscFunctionReturn(0); 11435c6c1daeSBarry Smith } 11445c6c1daeSBarry Smith 11455c6c1daeSBarry Smith #if defined(PETSC_HAVE_MPIIO) 11465c6c1daeSBarry Smith #undef __FUNCT__ 11475c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerFileSetName_MPIIO" 11485c6c1daeSBarry Smith PetscErrorCode PetscViewerFileSetName_MPIIO(PetscViewer viewer,const char name[]) 11495c6c1daeSBarry Smith { 11505c6c1daeSBarry Smith PetscMPIInt rank; 11515c6c1daeSBarry Smith PetscErrorCode ierr; 11525c6c1daeSBarry Smith size_t len; 11535c6c1daeSBarry Smith PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data; 11545c6c1daeSBarry Smith char *gz; 11555c6c1daeSBarry Smith PetscBool found; 11565c6c1daeSBarry Smith PetscFileMode type = vbinary->btype; 11575c6c1daeSBarry Smith 11585c6c1daeSBarry Smith PetscFunctionBegin; 11595c6c1daeSBarry Smith if (type == (PetscFileMode) -1) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"Must call PetscViewerFileSetMode() before PetscViewerFileSetName()"); 11605c6c1daeSBarry Smith ierr = PetscViewerFileClose_MPIIO(viewer);CHKERRQ(ierr); 11610298fd71SBarry Smith ierr = PetscOptionsGetBool(((PetscObject)viewer)->prefix,"-viewer_binary_skip_info",&vbinary->skipinfo,NULL);CHKERRQ(ierr); 11620298fd71SBarry Smith ierr = PetscOptionsGetBool(((PetscObject)viewer)->prefix,"-viewer_binary_skip_options",&vbinary->skipoptions,NULL);CHKERRQ(ierr); 11635c6c1daeSBarry Smith 1164ce94432eSBarry Smith ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)viewer),&rank);CHKERRQ(ierr); 11655c6c1daeSBarry Smith ierr = PetscStrallocpy(name,&vbinary->filename);CHKERRQ(ierr); 11665c6c1daeSBarry Smith 1167a297a907SKarl Rupp vbinary->storecompressed = PETSC_FALSE; 11685c6c1daeSBarry Smith 11695c6c1daeSBarry Smith /* only first processor opens file if writeable */ 11705c6c1daeSBarry Smith if (type == FILE_MODE_READ) { 1171ce94432eSBarry Smith MPI_File_open(PetscObjectComm((PetscObject)viewer),vbinary->filename,MPI_MODE_RDONLY,MPI_INFO_NULL,&vbinary->mfdes);CHKERRQ(ierr); 11725c6c1daeSBarry Smith } else if (type == FILE_MODE_WRITE) { 1173ce94432eSBarry Smith MPI_File_open(PetscObjectComm((PetscObject)viewer),vbinary->filename,MPI_MODE_WRONLY | MPI_MODE_CREATE,MPI_INFO_NULL,&vbinary->mfdes);CHKERRQ(ierr); 11745c6c1daeSBarry Smith } 11755c6c1daeSBarry Smith viewer->format = PETSC_VIEWER_NOFORMAT; 11765c6c1daeSBarry Smith 11775c6c1daeSBarry Smith /* 11785c6c1daeSBarry Smith try to open info file: all processors open this file if read only 11795c6c1daeSBarry Smith 11805c6c1daeSBarry Smith Below is identical code to the code for Binary above, should be put in seperate routine 11815c6c1daeSBarry Smith */ 11825c6c1daeSBarry Smith if (!vbinary->skipinfo && (!rank || type == FILE_MODE_READ)) { 11835c6c1daeSBarry Smith char infoname[PETSC_MAX_PATH_LEN],iname[PETSC_MAX_PATH_LEN]; 11845c6c1daeSBarry Smith 11855c6c1daeSBarry Smith ierr = PetscStrcpy(infoname,name);CHKERRQ(ierr); 11865c6c1daeSBarry Smith /* remove .gz if it ends library name */ 11875c6c1daeSBarry Smith ierr = PetscStrstr(infoname,".gz",&gz);CHKERRQ(ierr); 11885c6c1daeSBarry Smith if (gz) { 11895c6c1daeSBarry Smith ierr = PetscStrlen(gz,&len);CHKERRQ(ierr); 1190a297a907SKarl Rupp if (len == 3) *gz = 0; 11915c6c1daeSBarry Smith } 11925c6c1daeSBarry Smith 11935c6c1daeSBarry Smith ierr = PetscStrcat(infoname,".info");CHKERRQ(ierr); 11945c6c1daeSBarry Smith ierr = PetscFixFilename(infoname,iname);CHKERRQ(ierr); 11955c6c1daeSBarry Smith if (type == FILE_MODE_READ) { 1196ce94432eSBarry Smith ierr = PetscFileRetrieve(PetscObjectComm((PetscObject)viewer),iname,infoname,PETSC_MAX_PATH_LEN,&found);CHKERRQ(ierr); 1197ce94432eSBarry Smith ierr = PetscOptionsInsertFile(PetscObjectComm((PetscObject)viewer),infoname,PETSC_FALSE);CHKERRQ(ierr); 11985c6c1daeSBarry Smith } else { 11995c6c1daeSBarry Smith vbinary->fdes_info = fopen(infoname,"w"); 12005c6c1daeSBarry Smith if (!vbinary->fdes_info) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open .info file %s for writing",infoname); 12015c6c1daeSBarry Smith } 12025c6c1daeSBarry Smith } 12035c6c1daeSBarry Smith 12045c6c1daeSBarry Smith #if defined(PETSC_USE_LOG) 12055c6c1daeSBarry Smith PetscLogObjectState((PetscObject)viewer,"File: %s",name); 12065c6c1daeSBarry Smith #endif 12075c6c1daeSBarry Smith PetscFunctionReturn(0); 12085c6c1daeSBarry Smith } 12095c6c1daeSBarry Smith 12105c6c1daeSBarry Smith #undef __FUNCT__ 12115c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerBinarySetMPIIO_Binary" 12125c6c1daeSBarry Smith PetscErrorCode PetscViewerBinarySetMPIIO_Binary(PetscViewer viewer) 12135c6c1daeSBarry Smith { 12145c6c1daeSBarry Smith PetscViewer_Binary *vbinary = (PetscViewer_Binary*)viewer->data; 12155c6c1daeSBarry Smith PetscErrorCode ierr; 12165c6c1daeSBarry Smith 12175c6c1daeSBarry Smith PetscFunctionBegin; 12185c6c1daeSBarry Smith if (vbinary->filename) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call before calling PetscViewerFileSetName()"); 12195c6c1daeSBarry Smith viewer->ops->destroy = PetscViewerDestroy_MPIIO; 12205c6c1daeSBarry Smith vbinary->MPIIO = PETSC_TRUE; 12215c6c1daeSBarry Smith /* vbinary->skipinfo = PETSC_TRUE; */ 122200de8ff0SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)viewer,"PetscViewerFileSetName_C","PetscViewerFileSetName_MPIIO",PetscViewerFileSetName_MPIIO);CHKERRQ(ierr); 12235c6c1daeSBarry Smith PetscFunctionReturn(0); 12245c6c1daeSBarry Smith } 12255c6c1daeSBarry Smith #endif 12265c6c1daeSBarry Smith 12272bf49c77SBarry Smith #undef __FUNCT__ 12282bf49c77SBarry Smith #define __FUNCT__ "PetscViewerView_Binary" 12292bf49c77SBarry Smith PetscErrorCode PetscViewerView_Binary(PetscViewer v,PetscViewer viewer) 12302bf49c77SBarry Smith { 12312bf49c77SBarry Smith PetscErrorCode ierr; 12322bf49c77SBarry Smith PetscViewer_Binary *binary = (PetscViewer_Binary*)v->data; 12332bf49c77SBarry Smith 12342bf49c77SBarry Smith PetscFunctionBegin; 12352bf49c77SBarry Smith if (binary->filename) { 12362bf49c77SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Filename: %s\n",binary->filename);CHKERRQ(ierr); 12372bf49c77SBarry Smith } 12382bf49c77SBarry Smith PetscFunctionReturn(0); 12392bf49c77SBarry Smith } 12402bf49c77SBarry Smith 12415c6c1daeSBarry Smith #undef __FUNCT__ 12425c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerCreate_Binary" 1243*8cc058d9SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerCreate_Binary(PetscViewer v) 12445c6c1daeSBarry Smith { 12455c6c1daeSBarry Smith PetscErrorCode ierr; 12465c6c1daeSBarry Smith PetscViewer_Binary *vbinary; 12475c6c1daeSBarry Smith #if defined(PETSC_HAVE_MPIIO) 12485c6c1daeSBarry Smith PetscBool useMPIIO = PETSC_FALSE; 12495c6c1daeSBarry Smith #endif 12505c6c1daeSBarry Smith 12515c6c1daeSBarry Smith PetscFunctionBegin; 12525c6c1daeSBarry Smith ierr = PetscNewLog(v,PetscViewer_Binary,&vbinary);CHKERRQ(ierr); 12535c6c1daeSBarry Smith v->data = (void*)vbinary; 12545c6c1daeSBarry Smith v->ops->destroy = PetscViewerDestroy_Binary; 12552bf49c77SBarry Smith v->ops->view = PetscViewerView_Binary; 12565c6c1daeSBarry Smith v->ops->flush = 0; 12575c6c1daeSBarry Smith v->iformat = 0; 12585c6c1daeSBarry Smith vbinary->fdes_info = 0; 12595c6c1daeSBarry Smith vbinary->fdes = 0; 12605c6c1daeSBarry Smith vbinary->skipinfo = PETSC_FALSE; 12615c6c1daeSBarry Smith vbinary->skipoptions = PETSC_TRUE; 12625c6c1daeSBarry Smith vbinary->skipheader = PETSC_FALSE; 12635c6c1daeSBarry Smith v->ops->getsingleton = PetscViewerGetSingleton_Binary; 12645c6c1daeSBarry Smith v->ops->restoresingleton = PetscViewerRestoreSingleton_Binary; 12655c6c1daeSBarry Smith vbinary->btype = (PetscFileMode) -1; 12665c6c1daeSBarry Smith vbinary->storecompressed = PETSC_FALSE; 12675c6c1daeSBarry Smith vbinary->filename = 0; 12685c6c1daeSBarry Smith vbinary->flowcontrol = 256; /* seems a good number for Cray XT-5 */ 12695c6c1daeSBarry Smith 127000de8ff0SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)v,"PetscViewerBinaryGetFlowControl_C","PetscViewerBinaryGetFlowControl_Binary",PetscViewerBinaryGetFlowControl_Binary);CHKERRQ(ierr); 127100de8ff0SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)v,"PetscViewerBinarySetFlowControl_C","PetscViewerBinarySetFlowControl_Binary",PetscViewerBinarySetFlowControl_Binary);CHKERRQ(ierr); 127200de8ff0SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)v,"PetscViewerBinarySetSkipHeader_C","PetscViewerBinarySetSkipHeader_Binary",PetscViewerBinarySetSkipHeader_Binary);CHKERRQ(ierr); 127300de8ff0SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)v,"PetscViewerBinaryGetSkipHeader_C","PetscViewerBinaryGetSkipHeader_Binary",PetscViewerBinaryGetSkipHeader_Binary);CHKERRQ(ierr); 127400de8ff0SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)v,"PetscViewerBinaryGetInfoPointer_C","PetscViewerBinaryGetInfoPointer_Binary",PetscViewerBinaryGetInfoPointer_Binary);CHKERRQ(ierr); 127500de8ff0SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)v,"PetscViewerFileSetName_C","PetscViewerFileSetName_Binary",PetscViewerFileSetName_Binary);CHKERRQ(ierr); 127600de8ff0SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)v,"PetscViewerFileSetMode_C","PetscViewerFileSetMode_Binary",PetscViewerFileSetMode_Binary);CHKERRQ(ierr); 127700de8ff0SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)v,"PetscViewerFileGetMode_C","PetscViewerFileGetMode_Binary",PetscViewerFileGetMode_Binary);CHKERRQ(ierr); 127800de8ff0SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)v,"PetscViewerFileGetName_C","PetscViewerFileGetName_Binary",PetscViewerFileGetName_Binary);CHKERRQ(ierr); 12795c6c1daeSBarry Smith #if defined(PETSC_HAVE_MPIIO) 128000de8ff0SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)v,"PetscViewerBinarySetMPIIO_C","PetscViewerBinarySetMPIIO_Binary",PetscViewerBinarySetMPIIO_Binary);CHKERRQ(ierr); 12815c6c1daeSBarry Smith 12820298fd71SBarry Smith ierr = PetscOptionsGetBool(NULL,"-viewer_binary_mpiio",&useMPIIO,NULL);CHKERRQ(ierr); 12835c6c1daeSBarry Smith if (useMPIIO) { 12845c6c1daeSBarry Smith ierr = PetscViewerBinarySetMPIIO(v);CHKERRQ(ierr); 12855c6c1daeSBarry Smith } 12865c6c1daeSBarry Smith #endif 12875c6c1daeSBarry Smith PetscFunctionReturn(0); 12885c6c1daeSBarry Smith } 12895c6c1daeSBarry Smith 12905c6c1daeSBarry Smith /* ---------------------------------------------------------------------*/ 12915c6c1daeSBarry Smith /* 12925c6c1daeSBarry Smith The variable Petsc_Viewer_Binary_keyval is used to indicate an MPI attribute that 12935c6c1daeSBarry Smith is attached to a communicator, in this case the attribute is a PetscViewer. 12945c6c1daeSBarry Smith */ 12955c6c1daeSBarry Smith static int Petsc_Viewer_Binary_keyval = MPI_KEYVAL_INVALID; 12965c6c1daeSBarry Smith 12975c6c1daeSBarry Smith #undef __FUNCT__ 12985c6c1daeSBarry Smith #define __FUNCT__ "PETSC_VIEWER_BINARY_" 12995c6c1daeSBarry Smith /*@C 13005c6c1daeSBarry Smith PETSC_VIEWER_BINARY_ - Creates a binary PetscViewer shared by all processors 13015c6c1daeSBarry Smith in a communicator. 13025c6c1daeSBarry Smith 13035c6c1daeSBarry Smith Collective on MPI_Comm 13045c6c1daeSBarry Smith 13055c6c1daeSBarry Smith Input Parameter: 13065c6c1daeSBarry Smith . comm - the MPI communicator to share the binary PetscViewer 13075c6c1daeSBarry Smith 13085c6c1daeSBarry Smith Level: intermediate 13095c6c1daeSBarry Smith 13105c6c1daeSBarry Smith Options Database Keys: 13115c6c1daeSBarry Smith + -viewer_binary_filename <name> 13125c6c1daeSBarry Smith . -viewer_binary_skip_info 13135c6c1daeSBarry Smith - -viewer_binary_skip_options 13145c6c1daeSBarry Smith 13155c6c1daeSBarry Smith Environmental variables: 13165c6c1daeSBarry Smith - PETSC_VIEWER_BINARY_FILENAME 13175c6c1daeSBarry Smith 13185c6c1daeSBarry Smith Notes: 13195c6c1daeSBarry Smith Unlike almost all other PETSc routines, PETSC_VIEWER_BINARY_ does not return 13205c6c1daeSBarry Smith an error code. The binary PetscViewer is usually used in the form 13215c6c1daeSBarry Smith $ XXXView(XXX object,PETSC_VIEWER_BINARY_(comm)); 13225c6c1daeSBarry Smith 13235c6c1daeSBarry Smith .seealso: PETSC_VIEWER_BINARY_WORLD, PETSC_VIEWER_BINARY_SELF, PetscViewerBinaryOpen(), PetscViewerCreate(), 13245c6c1daeSBarry Smith PetscViewerDestroy() 13255c6c1daeSBarry Smith @*/ 13265c6c1daeSBarry Smith PetscViewer PETSC_VIEWER_BINARY_(MPI_Comm comm) 13275c6c1daeSBarry Smith { 13285c6c1daeSBarry Smith PetscErrorCode ierr; 13295c6c1daeSBarry Smith PetscBool flg; 13305c6c1daeSBarry Smith PetscViewer viewer; 13315c6c1daeSBarry Smith char fname[PETSC_MAX_PATH_LEN]; 13325c6c1daeSBarry Smith MPI_Comm ncomm; 13335c6c1daeSBarry Smith 13345c6c1daeSBarry Smith PetscFunctionBegin; 13350298fd71SBarry 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);} 13365c6c1daeSBarry Smith if (Petsc_Viewer_Binary_keyval == MPI_KEYVAL_INVALID) { 13375c6c1daeSBarry Smith ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,MPI_NULL_DELETE_FN,&Petsc_Viewer_Binary_keyval,0); 13385c6c1daeSBarry Smith if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_BINARY_",__FILE__,__SDIR__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");PetscFunctionReturn(0);} 13395c6c1daeSBarry Smith } 13405c6c1daeSBarry Smith ierr = MPI_Attr_get(ncomm,Petsc_Viewer_Binary_keyval,(void**)&viewer,(int*)&flg); 13415c6c1daeSBarry Smith if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_BINARY_",__FILE__,__SDIR__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");PetscFunctionReturn(0);} 13425c6c1daeSBarry Smith if (!flg) { /* PetscViewer not yet created */ 13435c6c1daeSBarry Smith ierr = PetscOptionsGetenv(ncomm,"PETSC_VIEWER_BINARY_FILENAME",fname,PETSC_MAX_PATH_LEN,&flg); 13445c6c1daeSBarry Smith if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_BINARY_",__FILE__,__SDIR__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");PetscFunctionReturn(0);} 13455c6c1daeSBarry Smith if (!flg) { 13465c6c1daeSBarry Smith ierr = PetscStrcpy(fname,"binaryoutput"); 13475c6c1daeSBarry Smith if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_BINARY_",__FILE__,__SDIR__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");PetscFunctionReturn(0);} 13485c6c1daeSBarry Smith } 13495c6c1daeSBarry Smith ierr = PetscViewerBinaryOpen(ncomm,fname,FILE_MODE_WRITE,&viewer); 13505c6c1daeSBarry Smith if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_BINARY_",__FILE__,__SDIR__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");PetscFunctionReturn(0);} 13515c6c1daeSBarry Smith ierr = PetscObjectRegisterDestroy((PetscObject)viewer); 13525c6c1daeSBarry Smith if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_BINARY_",__FILE__,__SDIR__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");PetscFunctionReturn(0);} 13535c6c1daeSBarry Smith ierr = MPI_Attr_put(ncomm,Petsc_Viewer_Binary_keyval,(void*)viewer); 13545c6c1daeSBarry Smith if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_BINARY_",__FILE__,__SDIR__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");PetscFunctionReturn(0);} 13555c6c1daeSBarry Smith } 13565c6c1daeSBarry Smith ierr = PetscCommDestroy(&ncomm); 13575c6c1daeSBarry Smith if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_BINARY_",__FILE__,__SDIR__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");PetscFunctionReturn(0);} 13585c6c1daeSBarry Smith PetscFunctionReturn(viewer); 13595c6c1daeSBarry Smith } 1360