1 /* $Id: petscviewer.h,v 1.85 2001/08/06 21:13:28 bsmith Exp $ */ 2 /* 3 PetscViewers are objects where other objects can be looked at or stored. 4 */ 5 6 #if !defined(__PETSCVIEWER_H) 7 #define __PETSCVIEWER_H 8 9 extern int PETSC_VIEWER_COOKIE; 10 11 /*S 12 PetscViewer - Abstract PETSc object that helps view (in ASCII, binary, graphically etc) 13 other PETSc objects 14 15 Level: beginner 16 17 Concepts: viewing 18 19 .seealso: PetscViewerCreate(), PetscViewerSetType(), PetscViewerType 20 S*/ 21 typedef struct _p_PetscViewer* PetscViewer; 22 23 /* 24 petsc.h must be included AFTER the definition of PetscViewer for ADIC to 25 process correctly. 26 */ 27 #include "petsc.h" 28 29 /*E 30 PetscViewerType - String with the name of a PETSc PETScViewer 31 32 Level: beginner 33 34 .seealso: PetscViewerSetType(), PetscViewer 35 E*/ 36 typedef char* PetscViewerType; 37 #define PETSC_VIEWER_SOCKET "socket" 38 #define PETSC_VIEWER_ASCII "ascii" 39 #define PETSC_VIEWER_BINARY "binary" 40 #define PETSC_VIEWER_STRING "string" 41 #define PETSC_VIEWER_DRAW "draw" 42 #define PETSC_VIEWER_AMS "ams" 43 #define PETSC_VIEWER_VU "vu" 44 #define PETSC_VIEWER_MATHEMATICA "mathematica" 45 #define PETSC_VIEWER_SILO "silo" 46 #define PETSC_VIEWER_NETCDF "netcdf" 47 48 extern PetscFList PetscViewerList; 49 EXTERN int PetscViewerRegisterAll(char *); 50 EXTERN int PetscViewerRegisterDestroy(void); 51 52 EXTERN int PetscViewerRegister(char*,char*,char*,int(*)(PetscViewer)); 53 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 54 #define PetscViewerRegisterDynamic(a,b,c,d) PetscViewerRegister(a,b,c,0) 55 #else 56 #define PetscViewerRegisterDynamic(a,b,c,d) PetscViewerRegister(a,b,c,d) 57 #endif 58 EXTERN int PetscViewerCreate(MPI_Comm,PetscViewer*); 59 EXTERN int PetscViewerSetFromOptions(PetscViewer); 60 61 EXTERN int PetscViewerASCIIOpen(MPI_Comm,const char[],PetscViewer*); 62 typedef enum {PETSC_BINARY_RDONLY,PETSC_BINARY_WRONLY,PETSC_BINARY_CREATE} PetscViewerBinaryType; 63 EXTERN int PetscViewerBinaryOpen(MPI_Comm,const char[],PetscViewerBinaryType,PetscViewer*); 64 EXTERN int PetscViewerSocketOpen(MPI_Comm,const char[],int,PetscViewer*); 65 EXTERN int PetscViewerStringOpen(MPI_Comm,char[],int,PetscViewer*); 66 EXTERN int PetscViewerDrawOpen(MPI_Comm,const char[],const char[],int,int,int,int,PetscViewer*); 67 EXTERN int PetscViewerAMSSetCommName(PetscViewer,const char[]); 68 EXTERN int PetscViewerMathematicaOpen(MPI_Comm, int, const char[], const char[], PetscViewer *); 69 EXTERN int PetscViewerSiloOpen(MPI_Comm, const char[], PetscViewer *); 70 71 EXTERN int PetscViewerGetType(PetscViewer,PetscViewerType*); 72 EXTERN int PetscViewerSetType(PetscViewer,PetscViewerType); 73 EXTERN int PetscViewerDestroy(PetscViewer); 74 EXTERN int PetscViewerGetSingleton(PetscViewer,PetscViewer*); 75 EXTERN int PetscViewerRestoreSingleton(PetscViewer,PetscViewer*); 76 77 78 /*E 79 PetscViewerFormat - Way a viewer presents the object 80 81 Level: beginner 82 83 .seealso: PetscViewerSetFormat(), PetscViewer, PetscViewerType, PetscViewerPushFormat(), PetscViewerPopFormat() 84 E*/ 85 typedef enum { 86 PETSC_VIEWER_ASCII_DEFAULT, 87 PETSC_VIEWER_ASCII_MATLAB, 88 PETSC_VIEWER_ASCII_MATHEMATICA, 89 PETSC_VIEWER_ASCII_IMPL, 90 PETSC_VIEWER_ASCII_INFO, 91 PETSC_VIEWER_ASCII_INFO_DETAIL, 92 PETSC_VIEWER_ASCII_COMMON, 93 PETSC_VIEWER_ASCII_SYMMODU, 94 PETSC_VIEWER_ASCII_INDEX, 95 PETSC_VIEWER_ASCII_DENSE, 96 PETSC_VIEWER_BINARY_DEFAULT, 97 PETSC_VIEWER_BINARY_NATIVE, 98 PETSC_VIEWER_DRAW_BASIC, 99 PETSC_VIEWER_DRAW_LG, 100 PETSC_VIEWER_DRAW_CONTOUR, 101 PETSC_VIEWER_DRAW_PORTS, 102 PETSC_VIEWER_NATIVE, 103 PETSC_VIEWER_NOFORMAT, 104 PETSC_VIEWER_ASCII_FACTOR_INFO} PetscViewerFormat; 105 106 EXTERN int PetscViewerSetFormat(PetscViewer,PetscViewerFormat); 107 EXTERN int PetscViewerPushFormat(PetscViewer,PetscViewerFormat); 108 EXTERN int PetscViewerPopFormat(PetscViewer); 109 EXTERN int PetscViewerGetFormat(PetscViewer,PetscViewerFormat*); 110 EXTERN int PetscViewerFlush(PetscViewer); 111 112 /* 113 Operations explicit to a particular class of viewers 114 */ 115 116 /*E 117 PetscViewerFormat - Access mode for a file. 118 119 Level: beginner 120 121 .seealso: PetscViewerASCIISetMode() 122 E*/ 123 typedef enum {FILE_MODE_READ, FILE_MODE_WRITE, FILE_MODE_APPEND, FILE_MODE_UPDATE, FILE_MODE_APPEND_UPDATE} PetscFileMode; 124 125 EXTERN int PetscViewerASCIIGetPointer(PetscViewer,FILE**); 126 EXTERN int PetscViewerASCIISetMode(PetscViewer,PetscFileMode); 127 EXTERN int PetscViewerASCIIPrintf(PetscViewer,const char[],...) PETSC_PRINTF_FORMAT_CHECK(2,3); 128 EXTERN int PetscViewerASCIISynchronizedPrintf(PetscViewer,const char[],...) PETSC_PRINTF_FORMAT_CHECK(2,3); 129 EXTERN int PetscViewerASCIIPushTab(PetscViewer); 130 EXTERN int PetscViewerASCIIPopTab(PetscViewer); 131 EXTERN int PetscViewerASCIIUseTabs(PetscViewer,PetscTruth); 132 EXTERN int PetscViewerASCIISetTab(PetscViewer,int); 133 EXTERN int PetscViewerBinaryGetDescriptor(PetscViewer,int*); 134 EXTERN int PetscViewerBinaryGetInfoPointer(PetscViewer,FILE **); 135 EXTERN int PetscViewerBinarySetType(PetscViewer,PetscViewerBinaryType); 136 EXTERN int PetscViewerStringSPrintf(PetscViewer,char *,...) PETSC_PRINTF_FORMAT_CHECK(2,3); 137 EXTERN int PetscViewerStringSetString(PetscViewer,char[],int); 138 EXTERN int PetscViewerDrawClear(PetscViewer); 139 EXTERN int PetscViewerDrawSetInfo(PetscViewer,const char[],const char[],int,int,int,int); 140 EXTERN int PetscViewerSocketSetConnection(PetscViewer,const char[],int); 141 EXTERN int PetscViewerBinarySkipInfo(PetscViewer); 142 EXTERN int PetscViewerBinaryLoadInfo(PetscViewer); 143 144 145 EXTERN int PetscViewerSetFilename(PetscViewer,const char[]); 146 EXTERN int PetscViewerGetFilename(PetscViewer,char**); 147 148 EXTERN int PetscPLAPACKInitializePackage(char *); 149 EXTERN int PetscPLAPACKFinalizePackage(void); 150 151 EXTERN int PetscViewerVUGetPointer(PetscViewer, FILE**); 152 EXTERN int PetscViewerVUSetMode(PetscViewer, PetscFileMode); 153 EXTERN int PetscViewerVUSetVecSeen(PetscViewer, PetscTruth); 154 EXTERN int PetscViewerVUGetVecSeen(PetscViewer, PetscTruth *); 155 EXTERN int PetscViewerVUPrintDeferred(PetscViewer, const char [], ...) PETSC_PRINTF_FORMAT_CHECK(2,3); 156 EXTERN int PetscViewerVUFlushDeferred(PetscViewer); 157 158 EXTERN int PetscViewerMathematicaInitializePackage(char *); 159 EXTERN int PetscViewerMathematicaFinalizePackage(void); 160 EXTERN int PetscViewerMathematicaGetName(PetscViewer, const char **); 161 EXTERN int PetscViewerMathematicaSetName(PetscViewer, const char []); 162 EXTERN int PetscViewerMathematicaClearName(PetscViewer); 163 EXTERN int PetscViewerMathematicaSkipPackets(PetscViewer, int); 164 165 EXTERN int PetscViewerSiloGetName(PetscViewer, char **); 166 EXTERN int PetscViewerSiloSetName(PetscViewer, const char []); 167 EXTERN int PetscViewerSiloClearName(PetscViewer); 168 EXTERN int PetscViewerSiloGetMeshName(PetscViewer, char **); 169 EXTERN int PetscViewerSiloSetMeshName(PetscViewer, const char []); 170 EXTERN int PetscViewerSiloClearMeshName(PetscViewer); 171 172 typedef enum {PETSC_NETCDF_RDONLY,PETSC_NETCDF_RDWR,PETSC_NETCDF_CREATE} PetscViewerNetcdfType; 173 EXTERN int PetscViewerNetcdfOpen(MPI_Comm,const char[],PetscViewerNetcdfType,PetscViewer*); 174 EXTERN int PetscViewerNetcdfGetID(PetscViewer, int *); 175 176 /* 177 These are all the default viewers that do not have 178 to be explicitly opened 179 */ 180 EXTERN PetscViewer PETSC_VIEWER_STDOUT_(MPI_Comm); 181 EXTERN PetscViewer PETSC_VIEWER_STDERR_(MPI_Comm); 182 EXTERN PetscViewer PETSC_VIEWER_DRAW_(MPI_Comm); 183 EXTERN PetscViewer PETSC_VIEWER_SOCKET_(MPI_Comm); 184 EXTERN PetscViewer PETSC_VIEWER_BINARY_(MPI_Comm); 185 EXTERN PetscViewer PETSC_VIEWER_MATHEMATICA_WORLD_PRIVATE; 186 187 #define PETSC_VIEWER_STDOUT_SELF PETSC_VIEWER_STDOUT_(PETSC_COMM_SELF) 188 #define PETSC_VIEWER_STDOUT_WORLD PETSC_VIEWER_STDOUT_(PETSC_COMM_WORLD) 189 #define PETSC_VIEWER_STDERR_SELF PETSC_VIEWER_STDERR_(PETSC_COMM_SELF) 190 #define PETSC_VIEWER_STDERR_WORLD PETSC_VIEWER_STDERR_(PETSC_COMM_WORLD) 191 #define PETSC_VIEWER_DRAW_SELF PETSC_VIEWER_DRAW_(PETSC_COMM_SELF) 192 #define PETSC_VIEWER_DRAW_WORLD PETSC_VIEWER_DRAW_(PETSC_COMM_WORLD) 193 #define PETSC_VIEWER_SOCKET_WORLD PETSC_VIEWER_SOCKET_(PETSC_COMM_WORLD) 194 #define PETSC_VIEWER_SOCKET_SELF PETSC_VIEWER_SOCKET_(PETSC_COMM_SELF) 195 #define PETSC_VIEWER_BINARY_WORLD PETSC_VIEWER_BINARY_(PETSC_COMM_WORLD) 196 #define PETSC_VIEWER_BINARY_SELF PETSC_VIEWER_BINARY_(PETSC_COMM_SELF) 197 #define PETSC_VIEWER_MATHEMATICA_WORLD (PetscViewerInitializeMathematicaWorld_Private(),PETSC_VIEWER_MATHEMATICA_WORLD_PRIVATE) 198 199 /* 200 PetscViewer based on the ALICE Memory Snooper 201 */ 202 #if defined(PETSC_HAVE_AMS) 203 #include "ams.h" 204 EXTERN int PetscViewerAMSGetAMSComm(PetscViewer,AMS_Comm *); 205 EXTERN int PetscViewerAMSOpen(MPI_Comm,const char[],PetscViewer*); 206 EXTERN int PetscViewerAMSLock(PetscViewer); 207 EXTERN PetscViewer PETSC_VIEWER_AMS_(MPI_Comm); 208 EXTERN int PETSC_VIEWER_AMS_Destroy(MPI_Comm); 209 #define PETSC_VIEWER_AMS_WORLD PETSC_VIEWER_AMS_(PETSC_COMM_WORLD) 210 #endif 211 212 /* 213 PetscViewer utility routines used by PETSc that are not normally used 214 by users. 215 */ 216 EXTERN int PetscViewerSocketPutScalar(PetscViewer,int,int,PetscScalar*); 217 EXTERN int PetscViewerSocketPutReal(PetscViewer,int,int,PetscReal*); 218 EXTERN int PetscViewerSocketPutInt(PetscViewer,int,int*); 219 EXTERN int PetscViewerSocketPutSparse_Private(PetscViewer,int,int,int,PetscScalar*,int*,int *); 220 EXTERN int PetscViewerDestroyAMS_Private(void); 221 222 /*S 223 PetscViewers - Abstract collection of PetscViewers 224 225 Level: intermediate 226 227 Concepts: viewing 228 229 .seealso: PetscViewerCreate(), PetscViewerSetType(), PetscViewerType, PetscViewer, PetscViewersCreate(), 230 PetscViewersGetViewer() 231 S*/ 232 typedef struct _p_PetscViewers* PetscViewers; 233 EXTERN int PetscViewersCreate(MPI_Comm,PetscViewers*); 234 EXTERN int PetscViewersDestroy(PetscViewers); 235 EXTERN int PetscViewersGetViewer(PetscViewers,int,PetscViewer*); 236 237 #endif 238