15c6c1daeSBarry Smith 2af0996ceSBarry Smith #include <petsc/private/viewerimpl.h> /*I "petscsys.h" I*/ 35c6c1daeSBarry Smith 45c6c1daeSBarry Smith const char *const PetscViewerFormats[] = { 55c6c1daeSBarry Smith "DEFAULT", 65c6c1daeSBarry Smith "ASCII_MATLAB", 75c6c1daeSBarry Smith "ASCII_MATHEMATICA", 85c6c1daeSBarry Smith "ASCII_IMPL", 95c6c1daeSBarry Smith "ASCII_INFO", 105c6c1daeSBarry Smith "ASCII_INFO_DETAIL", 115c6c1daeSBarry Smith "ASCII_COMMON", 125c6c1daeSBarry Smith "ASCII_SYMMODU", 135c6c1daeSBarry Smith "ASCII_INDEX", 145c6c1daeSBarry Smith "ASCII_DENSE", 155c6c1daeSBarry Smith "ASCII_MATRIXMARKET", 165c6c1daeSBarry Smith "ASCII_VTK", 175c6c1daeSBarry Smith "ASCII_VTK_CELL", 185c6c1daeSBarry Smith "ASCII_VTK_COORDS", 195c6c1daeSBarry Smith "ASCII_PCICE", 205c6c1daeSBarry Smith "ASCII_PYTHON", 215c6c1daeSBarry Smith "ASCII_FACTOR_INFO", 222e61fd76SBarry Smith "ASCII_LATEX", 23bb1d7374SBarry Smith "ASCII_XML", 248135c375SStefano Zampini "ASCII_GLVIS", 255c6c1daeSBarry Smith "DRAW_BASIC", 265c6c1daeSBarry Smith "DRAW_LG", 275c6c1daeSBarry Smith "DRAW_CONTOUR", 285c6c1daeSBarry Smith "DRAW_PORTS", 295c6c1daeSBarry Smith "VTK_VTS", 303a062f41SBarry Smith "VTK_VTR", 312e61fd76SBarry Smith "VTK_VTU", 32a261c58fSBarry Smith "BINARY_MATLAB", 335c6c1daeSBarry Smith "NATIVE", 34*8aa4816bSVaclav Hapla "HDF5_PETSC", 35898f909eSMatthew G. Knepley "HDF5_VIZ", 36*8aa4816bSVaclav Hapla "HDF5_XDMF", 372e61fd76SBarry Smith "NOFORMAT", 38ef5fdb51SBarry Smith "LOAD_BALANCE", 392e61fd76SBarry Smith "PetscViewerFormat", 402e61fd76SBarry Smith "PETSC_VIEWER_", 412e61fd76SBarry Smith 0 425c6c1daeSBarry Smith }; 435c6c1daeSBarry Smith 445c6c1daeSBarry Smith /*@C 455c6c1daeSBarry Smith PetscViewerSetFormat - Sets the format for PetscViewers. 465c6c1daeSBarry Smith 475c6c1daeSBarry Smith Logically Collective on PetscViewer 485c6c1daeSBarry Smith 496a9046bcSBarry Smith This routine is deprecated, you should use PetscViewerPushFormat()/PetscViewerPopFormat() 506a9046bcSBarry Smith 515c6c1daeSBarry Smith Input Parameters: 525c6c1daeSBarry Smith + viewer - the PetscViewer 535c6c1daeSBarry Smith - format - the format 545c6c1daeSBarry Smith 555c6c1daeSBarry Smith Level: intermediate 565c6c1daeSBarry Smith 575c6c1daeSBarry Smith Notes: 585c6c1daeSBarry Smith Available formats include 595c6c1daeSBarry Smith + PETSC_VIEWER_DEFAULT - default format 605c6c1daeSBarry Smith . PETSC_VIEWER_ASCII_MATLAB - MATLAB format 615c6c1daeSBarry Smith . PETSC_VIEWER_ASCII_DENSE - print matrix as dense 625c6c1daeSBarry Smith . PETSC_VIEWER_ASCII_IMPL - implementation-specific format 635c6c1daeSBarry Smith (which is in many cases the same as the default) 645c6c1daeSBarry Smith . PETSC_VIEWER_ASCII_INFO - basic information about object 655c6c1daeSBarry Smith . PETSC_VIEWER_ASCII_INFO_DETAIL - more detailed info 665c6c1daeSBarry Smith about object 675c6c1daeSBarry Smith . PETSC_VIEWER_ASCII_COMMON - identical output format for 685c6c1daeSBarry Smith all objects of a particular type 695c6c1daeSBarry Smith . PETSC_VIEWER_ASCII_INDEX - (for vectors) prints the vector 705c6c1daeSBarry Smith element number next to each vector entry 715c6c1daeSBarry Smith . PETSC_VIEWER_ASCII_SYMMODU - print parallel vectors without 725c6c1daeSBarry Smith indicating the processor ranges 735c6c1daeSBarry Smith . PETSC_VIEWER_ASCII_VTK - outputs the object to a VTK file 745c6c1daeSBarry Smith . PETSC_VIEWER_NATIVE - store the object to the binary 755c6c1daeSBarry Smith file in its native format (for example, dense 765c6c1daeSBarry Smith matrices are stored as dense), DMDA vectors are dumped directly to the 775c6c1daeSBarry Smith file instead of being first put in the natural ordering 785c6c1daeSBarry Smith . PETSC_VIEWER_DRAW_BASIC - views the vector with a simple 1d plot 795c6c1daeSBarry Smith . PETSC_VIEWER_DRAW_LG - views the vector with a line graph 805c6c1daeSBarry Smith - PETSC_VIEWER_DRAW_CONTOUR - views the vector with a contour plot 815c6c1daeSBarry Smith 825c6c1daeSBarry Smith These formats are most often used for viewing matrices and vectors. 835c6c1daeSBarry Smith 845c6c1daeSBarry Smith If a format (for example PETSC_VIEWER_DRAW_CONTOUR) was applied to a viewer 855c6c1daeSBarry Smith where it didn't apply (PETSC_VIEWER_STDOUT_WORLD) it cause the default behavior 865c6c1daeSBarry Smith for that viewer to be used. 875c6c1daeSBarry Smith 88f55353a2SBarry Smith Note: This supports passing in a NULL for the viewer for use in the debugger, but it should never be called in the code with a NULL viewer 89f55353a2SBarry Smith 905c6c1daeSBarry Smith Concepts: PetscViewer^setting format 915c6c1daeSBarry Smith 925c6c1daeSBarry Smith .seealso: PetscViewerASCIIOpen(), PetscViewerBinaryOpen(), MatView(), VecView(), PetscViewerType, 935c6c1daeSBarry Smith PetscViewerPushFormat(), PetscViewerPopFormat(), PetscViewerDrawOpen(),PetscViewerSocketOpen() 945c6c1daeSBarry Smith @*/ 955c6c1daeSBarry Smith PetscErrorCode PetscViewerSetFormat(PetscViewer viewer,PetscViewerFormat format) 965c6c1daeSBarry Smith { 975c6c1daeSBarry Smith PetscFunctionBegin; 985c6c1daeSBarry Smith if (!viewer) viewer = PETSC_VIEWER_STDOUT_SELF; 995c6c1daeSBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1); 1005c6c1daeSBarry Smith PetscValidLogicalCollectiveEnum(viewer,format,2); 1015c6c1daeSBarry Smith viewer->format = format; 1025c6c1daeSBarry Smith PetscFunctionReturn(0); 1035c6c1daeSBarry Smith } 1045c6c1daeSBarry Smith 1055c6c1daeSBarry Smith /*@C 1065c6c1daeSBarry Smith PetscViewerPushFormat - Sets the format for file PetscViewers. 1075c6c1daeSBarry Smith 1085c6c1daeSBarry Smith Logically Collective on PetscViewer 1095c6c1daeSBarry Smith 1105c6c1daeSBarry Smith Input Parameters: 1115c6c1daeSBarry Smith + viewer - the PetscViewer 1125c6c1daeSBarry Smith - format - the format 1135c6c1daeSBarry Smith 1145c6c1daeSBarry Smith Level: intermediate 1155c6c1daeSBarry Smith 1165c6c1daeSBarry Smith Notes: 1175c6c1daeSBarry Smith Available formats include 1185c6c1daeSBarry Smith + PETSC_VIEWER_DEFAULT - default format 1195c6c1daeSBarry Smith . PETSC_VIEWER_ASCII_MATLAB - MATLAB format 1205c6c1daeSBarry Smith . PETSC_VIEWER_ASCII_IMPL - implementation-specific format 1215c6c1daeSBarry Smith (which is in many cases the same as the default) 1225c6c1daeSBarry Smith . PETSC_VIEWER_ASCII_INFO - basic information about object 1235c6c1daeSBarry Smith . PETSC_VIEWER_ASCII_INFO_DETAIL - more detailed info 1245c6c1daeSBarry Smith about object 1255c6c1daeSBarry Smith . PETSC_VIEWER_ASCII_COMMON - identical output format for 1265c6c1daeSBarry Smith all objects of a particular type 1275c6c1daeSBarry Smith . PETSC_VIEWER_ASCII_INDEX - (for vectors) prints the vector 1285c6c1daeSBarry Smith element number next to each vector entry 1295c6c1daeSBarry Smith . PETSC_VIEWER_NATIVE - store the object to the binary 1305c6c1daeSBarry Smith file in its native format (for example, dense 1315c6c1daeSBarry Smith matrices are stored as dense), for DMDA vectors displays vectors in DMDA ordering, not natural 1325c6c1daeSBarry Smith . PETSC_VIEWER_DRAW_BASIC - views the vector with a simple 1d plot 1335c6c1daeSBarry Smith . PETSC_VIEWER_DRAW_LG - views the vector with a line graph 134fe866b2dSBarry Smith . PETSC_VIEWER_DRAW_CONTOUR - views the vector with a contour plot 135fe866b2dSBarry Smith - PETSC_VIEWER_ASCII_XML - saves the data in XML format, needed for PetscLogView() when viewing with PetscLogNestedBegin() 1365c6c1daeSBarry Smith 1375c6c1daeSBarry Smith These formats are most often used for viewing matrices and vectors. 1385c6c1daeSBarry Smith Currently, the object name is used only in the MATLAB format. 1395c6c1daeSBarry Smith 1405c6c1daeSBarry Smith Concepts: PetscViewer^setting format 1415c6c1daeSBarry Smith 1425c6c1daeSBarry Smith .seealso: PetscViewerASCIIOpen(), PetscViewerBinaryOpen(), MatView(), VecView(), 1435c6c1daeSBarry Smith PetscViewerSetFormat(), PetscViewerPopFormat() 1445c6c1daeSBarry Smith @*/ 1455c6c1daeSBarry Smith PetscErrorCode PetscViewerPushFormat(PetscViewer viewer,PetscViewerFormat format) 1465c6c1daeSBarry Smith { 1475c6c1daeSBarry Smith PetscFunctionBegin; 1485c6c1daeSBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1); 1495c6c1daeSBarry Smith PetscValidLogicalCollectiveEnum(viewer,format,2); 150a2628df9SBarry Smith if (viewer->iformat > PETSCVIEWERFORMATPUSHESMAX-1) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many PetscViewerPushFormat(), perhaps you forgot PetscViewerPopFormat()?"); 1515c6c1daeSBarry Smith 1525c6c1daeSBarry Smith viewer->formats[viewer->iformat++] = viewer->format; 1535c6c1daeSBarry Smith viewer->format = format; 1545c6c1daeSBarry Smith PetscFunctionReturn(0); 1555c6c1daeSBarry Smith } 1565c6c1daeSBarry Smith 1575c6c1daeSBarry Smith /*@C 1585c6c1daeSBarry Smith PetscViewerPopFormat - Resets the format for file PetscViewers. 1595c6c1daeSBarry Smith 1605c6c1daeSBarry Smith Logically Collective on PetscViewer 1615c6c1daeSBarry Smith 1625c6c1daeSBarry Smith Input Parameters: 1635c6c1daeSBarry Smith . viewer - the PetscViewer 1645c6c1daeSBarry Smith 1655c6c1daeSBarry Smith Level: intermediate 1665c6c1daeSBarry Smith 1675c6c1daeSBarry Smith Concepts: PetscViewer^setting format 1685c6c1daeSBarry Smith 1695c6c1daeSBarry Smith .seealso: PetscViewerASCIIOpen(), PetscViewerBinaryOpen(), MatView(), VecView(), 1705c6c1daeSBarry Smith PetscViewerSetFormat(), PetscViewerPushFormat() 1715c6c1daeSBarry Smith @*/ 1725c6c1daeSBarry Smith PetscErrorCode PetscViewerPopFormat(PetscViewer viewer) 1735c6c1daeSBarry Smith { 1745c6c1daeSBarry Smith PetscFunctionBegin; 1755c6c1daeSBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1); 1765c6c1daeSBarry Smith if (viewer->iformat <= 0) PetscFunctionReturn(0); 1775c6c1daeSBarry Smith 1785c6c1daeSBarry Smith viewer->format = viewer->formats[--viewer->iformat]; 1795c6c1daeSBarry Smith PetscFunctionReturn(0); 1805c6c1daeSBarry Smith } 1815c6c1daeSBarry Smith 1825c6c1daeSBarry Smith PetscErrorCode PetscViewerGetFormat(PetscViewer viewer,PetscViewerFormat *format) 1835c6c1daeSBarry Smith { 1845c6c1daeSBarry Smith PetscFunctionBegin; 1855c6c1daeSBarry Smith *format = viewer->format; 1865c6c1daeSBarry Smith PetscFunctionReturn(0); 1875c6c1daeSBarry Smith } 1885c6c1daeSBarry Smith 1895c6c1daeSBarry Smith 1905c6c1daeSBarry Smith 191