184cb2905SBarry Smith /* 2b0a32e0cSBarry Smith PetscViewers are objects where other objects can be looked at or stored. 384cb2905SBarry Smith */ 43c119ea2SBarry Smith 50a835dfdSSatish Balay #if !defined(__PETSCVIEWER_H) 60a835dfdSSatish Balay #define __PETSCVIEWER_H 7dfbe8321SBarry Smith 8e9fa29b7SSatish Balay #if defined(PETSC_USE_EXTERN_CXX) && defined(__cplusplus) 9e9fa29b7SSatish Balay extern "C" { 10e9fa29b7SSatish Balay #endif 112eb8c8abSBarry Smith 12b9617806SBarry Smith /*S 13b9617806SBarry Smith PetscViewer - Abstract PETSc object that helps view (in ASCII, binary, graphically etc) 14b9617806SBarry Smith other PETSc objects 15b9617806SBarry Smith 16b9617806SBarry Smith Level: beginner 17b9617806SBarry Smith 18b9617806SBarry Smith Concepts: viewing 19b9617806SBarry Smith 20b9617806SBarry Smith .seealso: PetscViewerCreate(), PetscViewerSetType(), PetscViewerType 21b9617806SBarry Smith S*/ 22b0a32e0cSBarry Smith typedef struct _p_PetscViewer* PetscViewer; 233c119ea2SBarry Smith 24e9fa29b7SSatish Balay #if defined(PETSC_USE_EXTERN_CXX) && defined(__cplusplus) 25e9fa29b7SSatish Balay } 26e9fa29b7SSatish Balay #endif 27e9fa29b7SSatish Balay 288fb59f0aSKris Buschelman #include "petsc.h" 298fb59f0aSKris Buschelman 308fb59f0aSKris Buschelman #if defined(PETSC_USE_EXTERN_CXX) && defined(__cplusplus) 318fb59f0aSKris Buschelman extern "C" { 328fb59f0aSKris Buschelman #endif 338fb59f0aSKris Buschelman 34ff73aad6SKris Buschelman extern PETSC_DLLEXPORT PetscCookie PETSC_VIEWER_COOKIE; 358fb59f0aSKris Buschelman 368fb59f0aSKris Buschelman #if defined(PETSC_USE_EXTERN_CXX) && defined(__cplusplus) 378fb59f0aSKris Buschelman } 388fb59f0aSKris Buschelman #endif 398fb59f0aSKris Buschelman 40e9fa29b7SSatish Balay 413c119ea2SBarry Smith /* 42b0a32e0cSBarry Smith petsc.h must be included AFTER the definition of PetscViewer for ADIC to 433c119ea2SBarry Smith process correctly. 443c119ea2SBarry Smith */ 45e9fa29b7SSatish Balay PETSC_EXTERN_CXX_BEGIN 46b9617806SBarry Smith /*E 47b9617806SBarry Smith PetscViewerType - String with the name of a PETSc PETScViewer 48b9617806SBarry Smith 49b9617806SBarry Smith Level: beginner 50b9617806SBarry Smith 51b9617806SBarry Smith .seealso: PetscViewerSetType(), PetscViewer 52b9617806SBarry Smith E*/ 53f69a0ea3SMatthew Knepley #define PetscViewerType const char* 54b0a32e0cSBarry Smith #define PETSC_VIEWER_SOCKET "socket" 55b0a32e0cSBarry Smith #define PETSC_VIEWER_ASCII "ascii" 56fb9695e5SSatish Balay #define PETSC_VIEWER_BINARY "binary" 57b0a32e0cSBarry Smith #define PETSC_VIEWER_STRING "string" 58fb9695e5SSatish Balay #define PETSC_VIEWER_DRAW "draw" 5944c73c46SMatthew Knepley #define PETSC_VIEWER_VU "vu" 604ebda54eSMatthew Knepley #define PETSC_VIEWER_MATHEMATICA "mathematica" 614ebda54eSMatthew Knepley #define PETSC_VIEWER_SILO "silo" 62e3eb5169SDinesh Kaushik #define PETSC_VIEWER_NETCDF "netcdf" 6300ccbe27SDinesh Kaushik #define PETSC_VIEWER_HDF4 "hdf4" 648e72c77eSMatthew Knepley #define PETSC_VIEWER_HDF5 "hdf5" 65cbb32127SBarry Smith #define PETSC_VIEWER_MATLAB "matlab" 6677ed5343SBarry Smith 67b0a32e0cSBarry Smith extern PetscFList PetscViewerList; 68ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerRegisterAll(const char *); 69ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerRegisterDestroy(void); 7090e10c2fSBarry Smith EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerInitializePackage(const char[]); 717b2a1423SBarry Smith 72ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerRegister(const char*,const char*,const char*,PetscErrorCode (*)(PetscViewer)); 7330de9b25SBarry Smith 7430de9b25SBarry Smith /*MC 7530de9b25SBarry Smith PetscViewerRegisterDynamic - Adds a method to the Krylov subspace solver package. 7630de9b25SBarry Smith 7730de9b25SBarry Smith Synopsis: 78d360dc6fSBarry Smith PetscErrorCode PetscViewerRegisterDynamic(char *name_solver,char *path,char *name_create,PetscErrorCode (*routine_create)(PetscViewer)) 7930de9b25SBarry Smith 8030de9b25SBarry Smith Not Collective 8130de9b25SBarry Smith 8230de9b25SBarry Smith Input Parameters: 8330de9b25SBarry Smith + name_solver - name of a new user-defined solver 8430de9b25SBarry Smith . path - path (either absolute or relative) the library containing this solver 8530de9b25SBarry Smith . name_create - name of routine to create method context 8630de9b25SBarry Smith - routine_create - routine to create method context 8730de9b25SBarry Smith 8830de9b25SBarry Smith Level: developer 8930de9b25SBarry Smith 9030de9b25SBarry Smith Notes: 9130de9b25SBarry Smith PetscViewerRegisterDynamic() may be called multiple times to add several user-defined solvers. 9230de9b25SBarry Smith 9330de9b25SBarry Smith If dynamic libraries are used, then the fourth input argument (routine_create) 9430de9b25SBarry Smith is ignored. 9530de9b25SBarry Smith 9630de9b25SBarry Smith Sample usage: 9730de9b25SBarry Smith .vb 9830de9b25SBarry Smith PetscViewerRegisterDynamic("my_viewer_type",/home/username/my_lib/lib/libO/solaris/mylib.a, 9930de9b25SBarry Smith "MyViewerCreate",MyViewerCreate); 10030de9b25SBarry Smith .ve 10130de9b25SBarry Smith 10230de9b25SBarry Smith Then, your solver can be chosen with the procedural interface via 10330de9b25SBarry Smith $ PetscViewerSetType(ksp,"my_viewer_type") 10430de9b25SBarry Smith or at runtime via the option 10530de9b25SBarry Smith $ -viewer_type my_viewer_type 10630de9b25SBarry Smith 10730de9b25SBarry Smith Concepts: registering^Viewers 10830de9b25SBarry Smith 10930de9b25SBarry Smith .seealso: PetscViewerRegisterAll(), PetscViewerRegisterDestroy() 11030de9b25SBarry Smith M*/ 111aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 112b0a32e0cSBarry Smith #define PetscViewerRegisterDynamic(a,b,c,d) PetscViewerRegister(a,b,c,0) 1137b2a1423SBarry Smith #else 114b0a32e0cSBarry Smith #define PetscViewerRegisterDynamic(a,b,c,d) PetscViewerRegister(a,b,c,d) 1157b2a1423SBarry Smith #endif 11630de9b25SBarry Smith 117ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerCreate(MPI_Comm,PetscViewer*); 118045ff3e0SBarry Smith PetscPolymorphicSubroutine(PetscViewerCreate,(PetscViewer *v),(PETSC_COMM_SELF,v)) 119ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerSetFromOptions(PetscViewer); 1207b2a1423SBarry Smith 121ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerASCIIOpen(MPI_Comm,const char[],PetscViewer*); 122b1967279SMatthew Knepley EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerBinaryCreate(MPI_Comm,PetscViewer*); 1233c67689dSBarry Smith EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerBinaryOpen(MPI_Comm,const char[],PetscFileMode,PetscViewer*); 12439802e9eSBarry Smith EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerBinarySetMPIIO(PetscViewer); 12539802e9eSBarry Smith EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerBinaryGetMPIIO(PetscViewer,PetscTruth*); 126*0fc9d207SBarry Smith #if defined(PETSC_HAVE_MPIIO) 12739802e9eSBarry Smith EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerBinaryGetMPIIODescriptor(PetscViewer,MPI_File*); 12839802e9eSBarry Smith EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerBinaryGetMPIIOOffset(PetscViewer,MPI_Offset*); 12939802e9eSBarry Smith EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerBinaryAddMPIIOOffset(PetscViewer,MPI_Offset); 130951e3c8eSBarry Smith #endif 13139802e9eSBarry Smith 132ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerSocketOpen(MPI_Comm,const char[],int,PetscViewer*); 133ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerStringOpen(MPI_Comm,char[],PetscInt,PetscViewer*); 134ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerDrawOpen(MPI_Comm,const char[],const char[],int,int,int,int,PetscViewer*); 135ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerMathematicaOpen(MPI_Comm, int, const char[], const char[], PetscViewer *); 136ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerSiloOpen(MPI_Comm, const char[], PetscViewer *); 1373c67689dSBarry Smith EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerMatlabOpen(MPI_Comm,const char[],PetscFileMode,PetscViewer*); 1384b0e389bSBarry Smith 139ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerGetType(PetscViewer,PetscViewerType*); 140f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerSetType(PetscViewer,PetscViewerType); 141ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerDestroy(PetscViewer); 142ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerGetSingleton(PetscViewer,PetscViewer*); 143ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerRestoreSingleton(PetscViewer,PetscViewer*); 144a98ce0f4SHong Zhang EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerGetSubcomm(PetscViewer,MPI_Comm,PetscViewer*); 145a98ce0f4SHong Zhang EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerRestoreSubcomm(PetscViewer,MPI_Comm,PetscViewer*); 146ae39576cSLois Curfman McInnes 147f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerSetUp(PetscViewer); 148f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerView(PetscViewer,PetscViewer); 149f69a0ea3SMatthew Knepley 150f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerSetOptionsPrefix(PetscViewer,const char[]); 151f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerAppendOptionsPrefix(PetscViewer,const char[]); 152f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerGetOptionsPrefix(PetscViewer,const char*[]); 153090de74eSSatish Balay 154b9617806SBarry Smith /*E 155b9617806SBarry Smith PetscViewerFormat - Way a viewer presents the object 156b9617806SBarry Smith 157b9617806SBarry Smith Level: beginner 158b9617806SBarry Smith 159b9617806SBarry Smith .seealso: PetscViewerSetFormat(), PetscViewer, PetscViewerType, PetscViewerPushFormat(), PetscViewerPopFormat() 160b9617806SBarry Smith E*/ 161fb9695e5SSatish Balay typedef enum { 162f3ef73ceSBarry Smith PETSC_VIEWER_ASCII_DEFAULT, 163f3ef73ceSBarry Smith PETSC_VIEWER_ASCII_MATLAB, 1644ebda54eSMatthew Knepley PETSC_VIEWER_ASCII_MATHEMATICA, 165f3ef73ceSBarry Smith PETSC_VIEWER_ASCII_IMPL, 166f3ef73ceSBarry Smith PETSC_VIEWER_ASCII_INFO, 167456192e2SBarry Smith PETSC_VIEWER_ASCII_INFO_DETAIL, 168f3ef73ceSBarry Smith PETSC_VIEWER_ASCII_COMMON, 169f3ef73ceSBarry Smith PETSC_VIEWER_ASCII_SYMMODU, 170f3ef73ceSBarry Smith PETSC_VIEWER_ASCII_INDEX, 171f3ef73ceSBarry Smith PETSC_VIEWER_ASCII_DENSE, 172a505fa5bSMatthew Knepley PETSC_VIEWER_ASCII_VTK, 173b85befe5SMatthew Knepley PETSC_VIEWER_ASCII_VTK_CELL, 174b6d733afSMatthew Knepley PETSC_VIEWER_ASCII_VTK_COORDS, 175493617b5SMatthew Knepley PETSC_VIEWER_ASCII_PCICE, 176493617b5SMatthew Knepley PETSC_VIEWER_ASCII_PYLITH, 17739439a91SMatthew Knepley PETSC_VIEWER_ASCII_PYLITH_LOCAL, 178f3ef73ceSBarry Smith PETSC_VIEWER_BINARY_DEFAULT, 179f3ef73ceSBarry Smith PETSC_VIEWER_BINARY_NATIVE, 180f3ef73ceSBarry Smith PETSC_VIEWER_DRAW_BASIC, 181f3ef73ceSBarry Smith PETSC_VIEWER_DRAW_LG, 182f3ef73ceSBarry Smith PETSC_VIEWER_DRAW_CONTOUR, 183f3ef73ceSBarry Smith PETSC_VIEWER_DRAW_PORTS, 184f3ef73ceSBarry Smith PETSC_VIEWER_NATIVE, 1854aedb280SBarry Smith PETSC_VIEWER_NOFORMAT, 1864aedb280SBarry Smith PETSC_VIEWER_ASCII_FACTOR_INFO} PetscViewerFormat; 187090de74eSSatish Balay 188ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerSetFormat(PetscViewer,PetscViewerFormat); 189ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerPushFormat(PetscViewer,PetscViewerFormat); 190ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerPopFormat(PetscViewer); 191ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerGetFormat(PetscViewer,PetscViewerFormat*); 192ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerFlush(PetscViewer); 1934b0e389bSBarry Smith 19423d894e5SBarry Smith /*S 19523d894e5SBarry Smith PetscViewerASCIIMonitor - Context for the default KSP, SNES and TS monitors that print 19623d894e5SBarry Smith ASCII strings of residual norms etc. 19723d894e5SBarry Smith 19823d894e5SBarry Smith 19923d894e5SBarry Smith Level: advanced 20023d894e5SBarry Smith 20123d894e5SBarry Smith Concepts: viewing, monitoring 20223d894e5SBarry Smith 20323d894e5SBarry Smith .seealso: PetscViewerCreate(), PetscViewerSetType(), PetscViewerType, KSPMonitorSet(), SNESMonitorSet(), TSMonitorSet(), 20423d894e5SBarry Smith KSPMonitorDefault(), SNESMonitorDefault() 20523d894e5SBarry Smith 20623d894e5SBarry Smith S*/ 20723d894e5SBarry Smith struct _p_PetscViewerASCIIMonitor { 20823d894e5SBarry Smith PetscViewer viewer; 20923d894e5SBarry Smith PetscInt tabs; 21023d894e5SBarry Smith }; 21123d894e5SBarry Smith typedef struct _p_PetscViewerASCIIMonitor* PetscViewerASCIIMonitor; 21223d894e5SBarry Smith 21323d894e5SBarry Smith EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerASCIIMonitorCreate(MPI_Comm,const char *,PetscInt,PetscViewerASCIIMonitor*); 21423d894e5SBarry Smith EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerASCIIMonitorDestroy(PetscViewerASCIIMonitor); 21523d894e5SBarry Smith EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerASCIIMonitorPrintf(PetscViewerASCIIMonitor,const char[],...); 21623d894e5SBarry Smith 21777ed5343SBarry Smith /* 21877ed5343SBarry Smith Operations explicit to a particular class of viewers 21977ed5343SBarry Smith */ 220ed5c6e3eSMatthew Knepley 221ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerASCIIGetPointer(PetscViewer,FILE**); 2227d0c5eb9SMatthew Knepley EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerFileGetMode(PetscViewer,PetscFileMode*); 2233c67689dSBarry Smith EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerFileSetMode(PetscViewer,PetscFileMode); 224ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerASCIIPrintf(PetscViewer,const char[],...) PETSC_PRINTF_FORMAT_CHECK(2,3); 225ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerASCIISynchronizedPrintf(PetscViewer,const char[],...) PETSC_PRINTF_FORMAT_CHECK(2,3); 226ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerASCIIPushTab(PetscViewer); 227ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerASCIIPopTab(PetscViewer); 228ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerASCIIUseTabs(PetscViewer,PetscTruth); 229ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerASCIISetTab(PetscViewer,PetscInt); 230ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerBinaryGetDescriptor(PetscViewer,int*); 231ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerBinaryGetInfoPointer(PetscViewer,FILE **); 232f588057bSBarry Smith EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerBinaryRead(PetscViewer,void*,PetscInt,PetscDataType); 233f588057bSBarry Smith EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerBinaryWrite(PetscViewer,void*,PetscInt,PetscDataType,PetscTruth); 234ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerStringSPrintf(PetscViewer,const char[],...) PETSC_PRINTF_FORMAT_CHECK(2,3); 235ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerStringSetString(PetscViewer,char[],PetscInt); 236ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerDrawClear(PetscViewer); 237ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerDrawSetInfo(PetscViewer,const char[],const char[],int,int,int,int); 238ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerSocketSetConnection(PetscViewer,const char[],PetscInt); 239ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerBinarySkipInfo(PetscViewer); 2409dcbbd2bSBarry Smith EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerBinarySetSkipOptions(PetscViewer,PetscTruth); 2419dcbbd2bSBarry Smith EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerBinaryGetSkipOptions(PetscViewer,PetscTruth*); 2428a13ba5bSBarry Smith EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerBinaryReadStringArray(PetscViewer,char***); 2438a13ba5bSBarry Smith EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerBinaryWriteStringArray(PetscViewer,char**); 244c655490fSBarry Smith 2453c67689dSBarry Smith EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerFileSetName(PetscViewer,const char[]); 2463c67689dSBarry Smith EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerFileGetName(PetscViewer,char**); 24777ed5343SBarry Smith 248e5bd5246SBarry Smith EXTERN PetscErrorCode PETSC_DLLEXPORT PetscPLAPACKInitializePackage(const char[]); 249ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscPLAPACKFinalizePackage(void); 25044c6da4fSMatthew Knepley 251ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerVUGetPointer(PetscViewer, FILE**); 252ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerVUSetVecSeen(PetscViewer, PetscTruth); 253ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerVUGetVecSeen(PetscViewer, PetscTruth *); 254ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerVUPrintDeferred(PetscViewer, const char [], ...) PETSC_PRINTF_FORMAT_CHECK(2,3); 255ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerVUFlushDeferred(PetscViewer); 25655dcf840SMatthew Knepley 257e5bd5246SBarry Smith EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerMathematicaInitializePackage(const char[]); 258ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerMathematicaFinalizePackage(void); 259ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerMathematicaGetName(PetscViewer, const char **); 260ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerMathematicaSetName(PetscViewer, const char []); 261ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerMathematicaClearName(PetscViewer); 262ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerMathematicaSkipPackets(PetscViewer, int); 2634ebda54eSMatthew Knepley 264ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerSiloGetName(PetscViewer, char **); 265ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerSiloSetName(PetscViewer, const char []); 266ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerSiloClearName(PetscViewer); 267ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerSiloGetMeshName(PetscViewer, char **); 268ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerSiloSetMeshName(PetscViewer, const char []); 269ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerSiloClearMeshName(PetscViewer); 2704ebda54eSMatthew Knepley 2713c67689dSBarry Smith EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerNetcdfOpen(MPI_Comm,const char[],PetscFileMode,PetscViewer*); 272ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerNetcdfGetID(PetscViewer, int *); 273e3eb5169SDinesh Kaushik 2743c67689dSBarry Smith EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerHDF4Open(MPI_Comm,const char[],PetscFileMode,PetscViewer*); 275b864a7bfSBarry Smith EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerHDF4WriteSDS(PetscViewer,float *,int,int *,int); 27600ccbe27SDinesh Kaushik 2778e72c77eSMatthew Knepley EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerHDF5Open(MPI_Comm,const char[],PetscFileMode,PetscViewer*); 2788e72c77eSMatthew Knepley #ifdef PETSC_HAVE_HDF5 2798e72c77eSMatthew Knepley #include <hdf5.h> 2801d1a0024SBarry Smith EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerHDF5GetFileId(PetscViewer,hid_t*); 2818e72c77eSMatthew Knepley #endif 2828e72c77eSMatthew Knepley 28377ed5343SBarry Smith /* 28477ed5343SBarry Smith These are all the default viewers that do not have 28577ed5343SBarry Smith to be explicitly opened 28677ed5343SBarry Smith */ 287ff73aad6SKris Buschelman EXTERN PetscViewer PETSC_DLLEXPORT PETSC_VIEWER_STDOUT_(MPI_Comm); 2883050cee2SBarry Smith EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerASCIIGetStdout(MPI_Comm,PetscViewer*); 289ff73aad6SKris Buschelman EXTERN PetscViewer PETSC_DLLEXPORT PETSC_VIEWER_STDERR_(MPI_Comm); 2903050cee2SBarry Smith EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerASCIIGetStderr(MPI_Comm,PetscViewer*); 291ff73aad6SKris Buschelman EXTERN PetscViewer PETSC_DLLEXPORT PETSC_VIEWER_DRAW_(MPI_Comm); 292ff73aad6SKris Buschelman EXTERN PetscViewer PETSC_DLLEXPORT PETSC_VIEWER_SOCKET_(MPI_Comm); 293ff73aad6SKris Buschelman EXTERN PetscViewer PETSC_DLLEXPORT PETSC_VIEWER_BINARY_(MPI_Comm); 294ff73aad6SKris Buschelman EXTERN PetscViewer PETSC_DLLEXPORT PETSC_VIEWER_MATLAB_(MPI_Comm); 2957eb62a3eSMatthew Knepley EXTERN PetscViewer PETSC_VIEWER_MATHEMATICA_WORLD_PRIVATE; 2965311e20fSBarry Smith 297b0a32e0cSBarry Smith #define PETSC_VIEWER_STDERR_SELF PETSC_VIEWER_STDERR_(PETSC_COMM_SELF) 298b0a32e0cSBarry Smith #define PETSC_VIEWER_STDERR_WORLD PETSC_VIEWER_STDERR_(PETSC_COMM_WORLD) 29930de9b25SBarry Smith 30030de9b25SBarry Smith /*MC 30130de9b25SBarry Smith PETSC_VIEWER_STDOUT_WORLD - same as PETSC_VIEWER_STDOUT_(PETSC_COMM_WORLD) 30230de9b25SBarry Smith 30330de9b25SBarry Smith Level: beginner 30430de9b25SBarry Smith M*/ 30530de9b25SBarry Smith #define PETSC_VIEWER_STDOUT_WORLD PETSC_VIEWER_STDOUT_(PETSC_COMM_WORLD) 30630de9b25SBarry Smith 30730de9b25SBarry Smith /*MC 30830de9b25SBarry Smith PETSC_VIEWER_STDOUT_SELF - same as PETSC_VIEWER_STDOUT_(PETSC_COMM_SELF) 30930de9b25SBarry Smith 31030de9b25SBarry Smith Level: beginner 31130de9b25SBarry Smith M*/ 31230de9b25SBarry Smith #define PETSC_VIEWER_STDOUT_SELF PETSC_VIEWER_STDOUT_(PETSC_COMM_SELF) 31330de9b25SBarry Smith 31430de9b25SBarry Smith /*MC 31530de9b25SBarry Smith PETSC_VIEWER_DRAW_WORLD - same as PETSC_VIEWER_DRAW_(PETSC_COMM_WORLD) 31630de9b25SBarry Smith 31730de9b25SBarry Smith Level: intermediate 31830de9b25SBarry Smith M*/ 319b0a32e0cSBarry Smith #define PETSC_VIEWER_DRAW_WORLD PETSC_VIEWER_DRAW_(PETSC_COMM_WORLD) 32030de9b25SBarry Smith 32130de9b25SBarry Smith /*MC 32230de9b25SBarry Smith PETSC_VIEWER_DRAW_SELF - same as PETSC_VIEWER_DRAW_(PETSC_COMM_SELF) 32330de9b25SBarry Smith 32430de9b25SBarry Smith Level: intermediate 32530de9b25SBarry Smith M*/ 32630de9b25SBarry Smith #define PETSC_VIEWER_DRAW_SELF PETSC_VIEWER_DRAW_(PETSC_COMM_SELF) 32730de9b25SBarry Smith 32830de9b25SBarry Smith /*MC 32930de9b25SBarry Smith PETSC_VIEWER_SOCKET_WORLD - same as PETSC_VIEWER_SOCKET_(PETSC_COMM_WORLD) 33030de9b25SBarry Smith 33130de9b25SBarry Smith Level: intermediate 33230de9b25SBarry Smith M*/ 333b0a32e0cSBarry Smith #define PETSC_VIEWER_SOCKET_WORLD PETSC_VIEWER_SOCKET_(PETSC_COMM_WORLD) 33430de9b25SBarry Smith 33530de9b25SBarry Smith /*MC 33630de9b25SBarry Smith PETSC_VIEWER_SOCKET_SELF - same as PETSC_VIEWER_SOCKET_(PETSC_COMM_SELF) 33730de9b25SBarry Smith 33830de9b25SBarry Smith Level: intermediate 33930de9b25SBarry Smith M*/ 340b0a32e0cSBarry Smith #define PETSC_VIEWER_SOCKET_SELF PETSC_VIEWER_SOCKET_(PETSC_COMM_SELF) 34130de9b25SBarry Smith 34230de9b25SBarry Smith /*MC 34330de9b25SBarry Smith PETSC_VIEWER_BINARY_WORLD - same as PETSC_VIEWER_BINARY_(PETSC_COMM_WORLD) 34430de9b25SBarry Smith 34530de9b25SBarry Smith Level: intermediate 34630de9b25SBarry Smith M*/ 347b0a32e0cSBarry Smith #define PETSC_VIEWER_BINARY_WORLD PETSC_VIEWER_BINARY_(PETSC_COMM_WORLD) 34830de9b25SBarry Smith 34930de9b25SBarry Smith /*MC 35030de9b25SBarry Smith PETSC_VIEWER_BINARY_SELF - same as PETSC_VIEWER_BINARY_(PETSC_COMM_SELF) 35130de9b25SBarry Smith 35230de9b25SBarry Smith Level: intermediate 35330de9b25SBarry Smith M*/ 354b0a32e0cSBarry Smith #define PETSC_VIEWER_BINARY_SELF PETSC_VIEWER_BINARY_(PETSC_COMM_SELF) 35530de9b25SBarry Smith 356cbb32127SBarry Smith /*MC 357cbb32127SBarry Smith PETSC_VIEWER_MATLAB_WORLD - same as PETSC_VIEWER_MATLAB_(PETSC_COMM_WORLD) 358cbb32127SBarry Smith 359cbb32127SBarry Smith Level: intermediate 360cbb32127SBarry Smith M*/ 361cbb32127SBarry Smith #define PETSC_VIEWER_MATLAB_WORLD PETSC_VIEWER_MATLAB_(PETSC_COMM_WORLD) 362cbb32127SBarry Smith 363cbb32127SBarry Smith /*MC 364cbb32127SBarry Smith PETSC_VIEWER_MATLAB_SELF - same as PETSC_VIEWER_MATLAB_(PETSC_COMM_SELF) 365cbb32127SBarry Smith 366cbb32127SBarry Smith Level: intermediate 367cbb32127SBarry Smith M*/ 368cbb32127SBarry Smith #define PETSC_VIEWER_MATLAB_SELF PETSC_VIEWER_MATLAB_(PETSC_COMM_SELF) 369cbb32127SBarry Smith 3707eb62a3eSMatthew Knepley #define PETSC_VIEWER_MATHEMATICA_WORLD (PetscViewerInitializeMathematicaWorld_Private(),PETSC_VIEWER_MATHEMATICA_WORLD_PRIVATE) 37165ef3172SBarry Smith 37277ed5343SBarry Smith /* 373cbb32127SBarry Smith petscViewer writes to Matlab .mat file 374cbb32127SBarry Smith */ 375ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerMatlabPutArray(PetscViewer,int,int,PetscScalar*,char*); 376ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerMatlabGetArray(PetscViewer,int,int,PetscScalar*,char*); 377ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerMatlabPutVariable(PetscViewer,const char*,void*); 378cbb32127SBarry Smith 379b9617806SBarry Smith /*S 380b9617806SBarry Smith PetscViewers - Abstract collection of PetscViewers 381b9617806SBarry Smith 382b9617806SBarry Smith Level: intermediate 383b9617806SBarry Smith 384b9617806SBarry Smith Concepts: viewing 385b9617806SBarry Smith 386b9617806SBarry Smith .seealso: PetscViewerCreate(), PetscViewerSetType(), PetscViewerType, PetscViewer, PetscViewersCreate(), 387b9617806SBarry Smith PetscViewersGetViewer() 388b9617806SBarry Smith S*/ 38995fbd943SSatish Balay typedef struct _n_PetscViewers* PetscViewers; 390ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewersCreate(MPI_Comm,PetscViewers*); 391ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewersDestroy(PetscViewers); 3929c666560SBarry Smith EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewersGetViewer(PetscViewers,PetscInt,PetscViewer*); 393d132466eSBarry Smith 394e9fa29b7SSatish Balay PETSC_EXTERN_CXX_END 395cb5b572fSBarry Smith #endif 396