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 54 /*MC 55 PetscViewerRegisterDynamic - Adds a method to the Krylov subspace solver package. 56 57 Synopsis: 58 int PetscViewerRegisterDynamic(char *name_solver,char *path,char *name_create,int (*routine_create)(PetscViewer)) 59 60 Not Collective 61 62 Input Parameters: 63 + name_solver - name of a new user-defined solver 64 . path - path (either absolute or relative) the library containing this solver 65 . name_create - name of routine to create method context 66 - routine_create - routine to create method context 67 68 Level: developer 69 70 Notes: 71 PetscViewerRegisterDynamic() may be called multiple times to add several user-defined solvers. 72 73 If dynamic libraries are used, then the fourth input argument (routine_create) 74 is ignored. 75 76 Sample usage: 77 .vb 78 PetscViewerRegisterDynamic("my_viewer_type",/home/username/my_lib/lib/libO/solaris/mylib.a, 79 "MyViewerCreate",MyViewerCreate); 80 .ve 81 82 Then, your solver can be chosen with the procedural interface via 83 $ PetscViewerSetType(ksp,"my_viewer_type") 84 or at runtime via the option 85 $ -viewer_type my_viewer_type 86 87 Concepts: registering^Viewers 88 89 .seealso: PetscViewerRegisterAll(), PetscViewerRegisterDestroy() 90 M*/ 91 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 92 #define PetscViewerRegisterDynamic(a,b,c,d) PetscViewerRegister(a,b,c,0) 93 #else 94 #define PetscViewerRegisterDynamic(a,b,c,d) PetscViewerRegister(a,b,c,d) 95 #endif 96 97 EXTERN int PetscViewerCreate(MPI_Comm,PetscViewer*); 98 EXTERN int PetscViewerSetFromOptions(PetscViewer); 99 100 EXTERN int PetscViewerASCIIOpen(MPI_Comm,const char[],PetscViewer*); 101 typedef enum {PETSC_BINARY_RDONLY,PETSC_BINARY_WRONLY,PETSC_BINARY_CREATE} PetscViewerBinaryType; 102 EXTERN int PetscViewerBinaryOpen(MPI_Comm,const char[],PetscViewerBinaryType,PetscViewer*); 103 EXTERN int PetscViewerSocketOpen(MPI_Comm,const char[],int,PetscViewer*); 104 EXTERN int PetscViewerStringOpen(MPI_Comm,char[],int,PetscViewer*); 105 EXTERN int PetscViewerDrawOpen(MPI_Comm,const char[],const char[],int,int,int,int,PetscViewer*); 106 EXTERN int PetscViewerAMSSetCommName(PetscViewer,const char[]); 107 EXTERN int PetscViewerMathematicaOpen(MPI_Comm, int, const char[], const char[], PetscViewer *); 108 EXTERN int PetscViewerSiloOpen(MPI_Comm, const char[], PetscViewer *); 109 110 EXTERN int PetscViewerGetType(PetscViewer,PetscViewerType*); 111 EXTERN int PetscViewerSetType(PetscViewer,PetscViewerType); 112 EXTERN int PetscViewerDestroy(PetscViewer); 113 EXTERN int PetscViewerGetSingleton(PetscViewer,PetscViewer*); 114 EXTERN int PetscViewerRestoreSingleton(PetscViewer,PetscViewer*); 115 116 117 /*E 118 PetscViewerFormat - Way a viewer presents the object 119 120 Level: beginner 121 122 .seealso: PetscViewerSetFormat(), PetscViewer, PetscViewerType, PetscViewerPushFormat(), PetscViewerPopFormat() 123 E*/ 124 typedef enum { 125 PETSC_VIEWER_ASCII_DEFAULT, 126 PETSC_VIEWER_ASCII_MATLAB, 127 PETSC_VIEWER_ASCII_MATHEMATICA, 128 PETSC_VIEWER_ASCII_IMPL, 129 PETSC_VIEWER_ASCII_INFO, 130 PETSC_VIEWER_ASCII_INFO_DETAIL, 131 PETSC_VIEWER_ASCII_COMMON, 132 PETSC_VIEWER_ASCII_SYMMODU, 133 PETSC_VIEWER_ASCII_INDEX, 134 PETSC_VIEWER_ASCII_DENSE, 135 PETSC_VIEWER_BINARY_DEFAULT, 136 PETSC_VIEWER_BINARY_NATIVE, 137 PETSC_VIEWER_DRAW_BASIC, 138 PETSC_VIEWER_DRAW_LG, 139 PETSC_VIEWER_DRAW_CONTOUR, 140 PETSC_VIEWER_DRAW_PORTS, 141 PETSC_VIEWER_NATIVE, 142 PETSC_VIEWER_NOFORMAT, 143 PETSC_VIEWER_ASCII_FACTOR_INFO} PetscViewerFormat; 144 145 EXTERN int PetscViewerSetFormat(PetscViewer,PetscViewerFormat); 146 EXTERN int PetscViewerPushFormat(PetscViewer,PetscViewerFormat); 147 EXTERN int PetscViewerPopFormat(PetscViewer); 148 EXTERN int PetscViewerGetFormat(PetscViewer,PetscViewerFormat*); 149 EXTERN int PetscViewerFlush(PetscViewer); 150 151 /* 152 Operations explicit to a particular class of viewers 153 */ 154 155 /*E 156 PetscViewerFormat - Access mode for a file. 157 158 Level: beginner 159 160 .seealso: PetscViewerASCIISetMode() 161 E*/ 162 typedef enum {FILE_MODE_READ, FILE_MODE_WRITE, FILE_MODE_APPEND, FILE_MODE_UPDATE, FILE_MODE_APPEND_UPDATE} PetscFileMode; 163 164 EXTERN int PetscViewerASCIIGetPointer(PetscViewer,FILE**); 165 EXTERN int PetscViewerASCIISetMode(PetscViewer,PetscFileMode); 166 EXTERN int PetscViewerASCIIPrintf(PetscViewer,const char[],...) PETSC_PRINTF_FORMAT_CHECK(2,3); 167 EXTERN int PetscViewerASCIISynchronizedPrintf(PetscViewer,const char[],...) PETSC_PRINTF_FORMAT_CHECK(2,3); 168 EXTERN int PetscViewerASCIIPushTab(PetscViewer); 169 EXTERN int PetscViewerASCIIPopTab(PetscViewer); 170 EXTERN int PetscViewerASCIIUseTabs(PetscViewer,PetscTruth); 171 EXTERN int PetscViewerASCIISetTab(PetscViewer,int); 172 EXTERN int PetscViewerBinaryGetDescriptor(PetscViewer,int*); 173 EXTERN int PetscViewerBinaryGetInfoPointer(PetscViewer,FILE **); 174 EXTERN int PetscViewerBinarySetType(PetscViewer,PetscViewerBinaryType); 175 EXTERN int PetscViewerStringSPrintf(PetscViewer,char *,...) PETSC_PRINTF_FORMAT_CHECK(2,3); 176 EXTERN int PetscViewerStringSetString(PetscViewer,char[],int); 177 EXTERN int PetscViewerDrawClear(PetscViewer); 178 EXTERN int PetscViewerDrawSetInfo(PetscViewer,const char[],const char[],int,int,int,int); 179 EXTERN int PetscViewerSocketSetConnection(PetscViewer,const char[],int); 180 EXTERN int PetscViewerBinarySkipInfo(PetscViewer); 181 EXTERN int PetscViewerBinaryLoadInfo(PetscViewer); 182 183 184 EXTERN int PetscViewerSetFilename(PetscViewer,const char[]); 185 EXTERN int PetscViewerGetFilename(PetscViewer,char**); 186 187 EXTERN int PetscPLAPACKInitializePackage(char *); 188 EXTERN int PetscPLAPACKFinalizePackage(void); 189 190 EXTERN int PetscViewerVUGetPointer(PetscViewer, FILE**); 191 EXTERN int PetscViewerVUSetMode(PetscViewer, PetscFileMode); 192 EXTERN int PetscViewerVUSetVecSeen(PetscViewer, PetscTruth); 193 EXTERN int PetscViewerVUGetVecSeen(PetscViewer, PetscTruth *); 194 EXTERN int PetscViewerVUPrintDeferred(PetscViewer, const char [], ...) PETSC_PRINTF_FORMAT_CHECK(2,3); 195 EXTERN int PetscViewerVUFlushDeferred(PetscViewer); 196 197 EXTERN int PetscViewerMathematicaInitializePackage(char *); 198 EXTERN int PetscViewerMathematicaFinalizePackage(void); 199 EXTERN int PetscViewerMathematicaGetName(PetscViewer, const char **); 200 EXTERN int PetscViewerMathematicaSetName(PetscViewer, const char []); 201 EXTERN int PetscViewerMathematicaClearName(PetscViewer); 202 EXTERN int PetscViewerMathematicaSkipPackets(PetscViewer, int); 203 204 EXTERN int PetscViewerSiloGetName(PetscViewer, char **); 205 EXTERN int PetscViewerSiloSetName(PetscViewer, const char []); 206 EXTERN int PetscViewerSiloClearName(PetscViewer); 207 EXTERN int PetscViewerSiloGetMeshName(PetscViewer, char **); 208 EXTERN int PetscViewerSiloSetMeshName(PetscViewer, const char []); 209 EXTERN int PetscViewerSiloClearMeshName(PetscViewer); 210 211 typedef enum {PETSC_NETCDF_RDONLY,PETSC_NETCDF_RDWR,PETSC_NETCDF_CREATE} PetscViewerNetcdfType; 212 EXTERN int PetscViewerNetcdfOpen(MPI_Comm,const char[],PetscViewerNetcdfType,PetscViewer*); 213 EXTERN int PetscViewerNetcdfGetID(PetscViewer, int *); 214 215 /* 216 These are all the default viewers that do not have 217 to be explicitly opened 218 */ 219 EXTERN PetscViewer PETSC_VIEWER_STDOUT_(MPI_Comm); 220 EXTERN PetscViewer PETSC_VIEWER_STDERR_(MPI_Comm); 221 EXTERN PetscViewer PETSC_VIEWER_DRAW_(MPI_Comm); 222 EXTERN PetscViewer PETSC_VIEWER_SOCKET_(MPI_Comm); 223 EXTERN PetscViewer PETSC_VIEWER_BINARY_(MPI_Comm); 224 EXTERN PetscViewer PETSC_VIEWER_MATHEMATICA_WORLD_PRIVATE; 225 226 #define PETSC_VIEWER_STDERR_SELF PETSC_VIEWER_STDERR_(PETSC_COMM_SELF) 227 #define PETSC_VIEWER_STDERR_WORLD PETSC_VIEWER_STDERR_(PETSC_COMM_WORLD) 228 229 /*MC 230 PETSC_VIEWER_STDOUT_WORLD - same as PETSC_VIEWER_STDOUT_(PETSC_COMM_WORLD) 231 232 Level: beginner 233 M*/ 234 #define PETSC_VIEWER_STDOUT_WORLD PETSC_VIEWER_STDOUT_(PETSC_COMM_WORLD) 235 236 /*MC 237 PETSC_VIEWER_STDOUT_SELF - same as PETSC_VIEWER_STDOUT_(PETSC_COMM_SELF) 238 239 Level: beginner 240 M*/ 241 #define PETSC_VIEWER_STDOUT_SELF PETSC_VIEWER_STDOUT_(PETSC_COMM_SELF) 242 243 /*MC 244 PETSC_VIEWER_DRAW_WORLD - same as PETSC_VIEWER_DRAW_(PETSC_COMM_WORLD) 245 246 Level: intermediate 247 M*/ 248 #define PETSC_VIEWER_DRAW_WORLD PETSC_VIEWER_DRAW_(PETSC_COMM_WORLD) 249 250 /*MC 251 PETSC_VIEWER_DRAW_SELF - same as PETSC_VIEWER_DRAW_(PETSC_COMM_SELF) 252 253 Level: intermediate 254 M*/ 255 #define PETSC_VIEWER_DRAW_SELF PETSC_VIEWER_DRAW_(PETSC_COMM_SELF) 256 257 /*MC 258 PETSC_VIEWER_SOCKET_WORLD - same as PETSC_VIEWER_SOCKET_(PETSC_COMM_WORLD) 259 260 Level: intermediate 261 M*/ 262 #define PETSC_VIEWER_SOCKET_WORLD PETSC_VIEWER_SOCKET_(PETSC_COMM_WORLD) 263 264 /*MC 265 PETSC_VIEWER_SOCKET_SELF - same as PETSC_VIEWER_SOCKET_(PETSC_COMM_SELF) 266 267 Level: intermediate 268 M*/ 269 #define PETSC_VIEWER_SOCKET_SELF PETSC_VIEWER_SOCKET_(PETSC_COMM_SELF) 270 271 /*MC 272 PETSC_VIEWER_BINARY_WORLD - same as PETSC_VIEWER_BINARY_(PETSC_COMM_WORLD) 273 274 Level: intermediate 275 M*/ 276 #define PETSC_VIEWER_BINARY_WORLD PETSC_VIEWER_BINARY_(PETSC_COMM_WORLD) 277 278 /*MC 279 PETSC_VIEWER_BINARY_SELF - same as PETSC_VIEWER_BINARY_(PETSC_COMM_SELF) 280 281 Level: intermediate 282 M*/ 283 #define PETSC_VIEWER_BINARY_SELF PETSC_VIEWER_BINARY_(PETSC_COMM_SELF) 284 285 #define PETSC_VIEWER_MATHEMATICA_WORLD (PetscViewerInitializeMathematicaWorld_Private(),PETSC_VIEWER_MATHEMATICA_WORLD_PRIVATE) 286 287 /* 288 PetscViewer based on the ALICE Memory Snooper 289 */ 290 #if defined(PETSC_HAVE_AMS) 291 #include "ams.h" 292 EXTERN int PetscViewerAMSGetAMSComm(PetscViewer,AMS_Comm *); 293 EXTERN int PetscViewerAMSOpen(MPI_Comm,const char[],PetscViewer*); 294 EXTERN int PetscViewerAMSLock(PetscViewer); 295 EXTERN PetscViewer PETSC_VIEWER_AMS_(MPI_Comm); 296 EXTERN int PETSC_VIEWER_AMS_Destroy(MPI_Comm); 297 #define PETSC_VIEWER_AMS_WORLD PETSC_VIEWER_AMS_(PETSC_COMM_WORLD) 298 #endif 299 300 /* 301 PetscViewer utility routines used by PETSc that are not normally used 302 by users. 303 */ 304 EXTERN int PetscViewerSocketPutScalar(PetscViewer,int,int,PetscScalar*); 305 EXTERN int PetscViewerSocketPutReal(PetscViewer,int,int,PetscReal*); 306 EXTERN int PetscViewerSocketPutInt(PetscViewer,int,int*); 307 EXTERN int PetscViewerSocketPutSparse_Private(PetscViewer,int,int,int,PetscScalar*,int*,int *); 308 EXTERN int PetscViewerDestroyAMS_Private(void); 309 310 /*S 311 PetscViewers - Abstract collection of PetscViewers 312 313 Level: intermediate 314 315 Concepts: viewing 316 317 .seealso: PetscViewerCreate(), PetscViewerSetType(), PetscViewerType, PetscViewer, PetscViewersCreate(), 318 PetscViewersGetViewer() 319 S*/ 320 typedef struct _p_PetscViewers* PetscViewers; 321 EXTERN int PetscViewersCreate(MPI_Comm,PetscViewers*); 322 EXTERN int PetscViewersDestroy(PetscViewers); 323 EXTERN int PetscViewersGetViewer(PetscViewers,int,PetscViewer*); 324 325 #endif 326