1 /* 2 PetscViewers are objects where other objects can be looked at or stored. 3 */ 4 5 #if !defined(__PETSCVIEWER_H) 6 #define __PETSCVIEWER_H 7 #if defined(PETSC_USE_EXTERN_CXX) && defined(__cplusplus) 8 extern "C" { 9 #endif 10 11 extern int PETSC_VIEWER_COOKIE; 12 13 /*S 14 PetscViewer - Abstract PETSc object that helps view (in ASCII, binary, graphically etc) 15 other PETSc objects 16 17 Level: beginner 18 19 Concepts: viewing 20 21 .seealso: PetscViewerCreate(), PetscViewerSetType(), PetscViewerType 22 S*/ 23 typedef struct _p_PetscViewer* PetscViewer; 24 25 #if defined(PETSC_USE_EXTERN_CXX) && defined(__cplusplus) 26 } 27 #endif 28 29 30 /* 31 petsc.h must be included AFTER the definition of PetscViewer for ADIC to 32 process correctly. 33 */ 34 #include "petsc.h" 35 PETSC_EXTERN_CXX_BEGIN 36 /*E 37 PetscViewerType - String with the name of a PETSc PETScViewer 38 39 Level: beginner 40 41 .seealso: PetscViewerSetType(), PetscViewer 42 E*/ 43 #define PetscViewerType char* 44 #define PETSC_VIEWER_SOCKET "socket" 45 #define PETSC_VIEWER_ASCII "ascii" 46 #define PETSC_VIEWER_BINARY "binary" 47 #define PETSC_VIEWER_STRING "string" 48 #define PETSC_VIEWER_DRAW "draw" 49 #define PETSC_VIEWER_AMS "ams" 50 #define PETSC_VIEWER_VU "vu" 51 #define PETSC_VIEWER_MATHEMATICA "mathematica" 52 #define PETSC_VIEWER_SILO "silo" 53 #define PETSC_VIEWER_NETCDF "netcdf" 54 #define PETSC_VIEWER_HDF4 "hdf4" 55 #define PETSC_VIEWER_MATLAB "matlab" 56 57 extern PetscFList PetscViewerList; 58 EXTERN int PetscViewerRegisterAll(const char *); 59 EXTERN int PetscViewerRegisterDestroy(void); 60 61 EXTERN int PetscViewerRegister(const char*,const char*,const char*,int(*)(PetscViewer)); 62 63 /*MC 64 PetscViewerRegisterDynamic - Adds a method to the Krylov subspace solver package. 65 66 Synopsis: 67 int PetscViewerRegisterDynamic(char *name_solver,char *path,char *name_create,int (*routine_create)(PetscViewer)) 68 69 Not Collective 70 71 Input Parameters: 72 + name_solver - name of a new user-defined solver 73 . path - path (either absolute or relative) the library containing this solver 74 . name_create - name of routine to create method context 75 - routine_create - routine to create method context 76 77 Level: developer 78 79 Notes: 80 PetscViewerRegisterDynamic() may be called multiple times to add several user-defined solvers. 81 82 If dynamic libraries are used, then the fourth input argument (routine_create) 83 is ignored. 84 85 Sample usage: 86 .vb 87 PetscViewerRegisterDynamic("my_viewer_type",/home/username/my_lib/lib/libO/solaris/mylib.a, 88 "MyViewerCreate",MyViewerCreate); 89 .ve 90 91 Then, your solver can be chosen with the procedural interface via 92 $ PetscViewerSetType(ksp,"my_viewer_type") 93 or at runtime via the option 94 $ -viewer_type my_viewer_type 95 96 Concepts: registering^Viewers 97 98 .seealso: PetscViewerRegisterAll(), PetscViewerRegisterDestroy() 99 M*/ 100 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 101 #define PetscViewerRegisterDynamic(a,b,c,d) PetscViewerRegister(a,b,c,0) 102 #else 103 #define PetscViewerRegisterDynamic(a,b,c,d) PetscViewerRegister(a,b,c,d) 104 #endif 105 106 EXTERN int PetscViewerCreate(MPI_Comm,PetscViewer*); 107 EXTERN int PetscViewerSetFromOptions(PetscViewer); 108 109 EXTERN int PetscViewerASCIIOpen(MPI_Comm,const char[],PetscViewer*); 110 111 /*E 112 PetscViewerFileType - Indicates how the file should be opened for the viewer 113 114 Level: beginner 115 116 .seealso: PetscViewerSetFileName(), PetscViewerSetFileType(), PetscViewerBinaryOpen(), PetscViewerASCIIOpen(), 117 PetscViewerMatlabOpen() 118 E*/ 119 typedef enum {PETSC_FILE_RDONLY,PETSC_FILE_WRONLY,PETSC_FILE_CREATE} PetscViewerFileType; 120 121 /*M 122 PETSC_FILE_RDONLY - File is open to be read from only, not written to 123 124 Level: beginner 125 126 .seealso: PetscViewerFileType, PETSC_FILE_WRONLY, PETSC_FILE_CREATE, PetscViewerSetFileName(), PetscViewerSetFileType(), 127 PetscViewerBinaryOpen(), PetscViewerASCIIOpen(), PetscViewerMatlabOpen() 128 129 M*/ 130 131 /*M 132 PETSC_FILE_WRONLY - File is open to be appended to. 133 134 Level: beginner 135 136 .seealso: PetscViewerFileType, PETSC_FILE_RDONLY, PETSC_FILE_CREATE, PetscViewerSetFileName(), PetscViewerSetFileType(), 137 PetscViewerBinaryOpen(), PetscViewerASCIIOpen(), PetscViewerMatlabOpen() 138 139 M*/ 140 141 /*M 142 PETSC_FILE_CREATE - Create the file, or delete it and open an empty file if it already existed 143 144 Level: beginner 145 146 .seealso: PetscViewerFileType, PETSC_FILE_RDONLY, PETSC_FILE_WRONLY, PetscViewerSetFileName(), PetscViewerSetFileType(), 147 PetscViewerBinaryOpen(), PetscViewerASCIIOpen(), PetscViewerMatlabOpen() 148 149 M*/ 150 151 EXTERN int PetscViewerBinaryOpen(MPI_Comm,const char[],PetscViewerFileType,PetscViewer*); 152 EXTERN int PetscViewerSocketOpen(MPI_Comm,const char[],int,PetscViewer*); 153 EXTERN int PetscViewerStringOpen(MPI_Comm,char[],int,PetscViewer*); 154 EXTERN int PetscViewerDrawOpen(MPI_Comm,const char[],const char[],int,int,int,int,PetscViewer*); 155 EXTERN int PetscViewerAMSSetCommName(PetscViewer,const char[]); 156 EXTERN int PetscViewerMathematicaOpen(MPI_Comm, int, const char[], const char[], PetscViewer *); 157 EXTERN int PetscViewerSiloOpen(MPI_Comm, const char[], PetscViewer *); 158 EXTERN int PetscViewerMatlabOpen(MPI_Comm,const char[],PetscViewerFileType,PetscViewer*); 159 160 EXTERN int PetscViewerGetType(PetscViewer,PetscViewerType*); 161 EXTERN int PetscViewerSetType(PetscViewer,const PetscViewerType); 162 EXTERN int PetscViewerDestroy(PetscViewer); 163 EXTERN int PetscViewerGetSingleton(PetscViewer,PetscViewer*); 164 EXTERN int PetscViewerRestoreSingleton(PetscViewer,PetscViewer*); 165 166 167 /*E 168 PetscViewerFormat - Way a viewer presents the object 169 170 Level: beginner 171 172 .seealso: PetscViewerSetFormat(), PetscViewer, PetscViewerType, PetscViewerPushFormat(), PetscViewerPopFormat() 173 E*/ 174 typedef enum { 175 PETSC_VIEWER_ASCII_DEFAULT, 176 PETSC_VIEWER_ASCII_MATLAB, 177 PETSC_VIEWER_ASCII_MATHEMATICA, 178 PETSC_VIEWER_ASCII_IMPL, 179 PETSC_VIEWER_ASCII_INFO, 180 PETSC_VIEWER_ASCII_INFO_DETAIL, 181 PETSC_VIEWER_ASCII_COMMON, 182 PETSC_VIEWER_ASCII_SYMMODU, 183 PETSC_VIEWER_ASCII_INDEX, 184 PETSC_VIEWER_ASCII_DENSE, 185 PETSC_VIEWER_BINARY_DEFAULT, 186 PETSC_VIEWER_BINARY_NATIVE, 187 PETSC_VIEWER_DRAW_BASIC, 188 PETSC_VIEWER_DRAW_LG, 189 PETSC_VIEWER_DRAW_CONTOUR, 190 PETSC_VIEWER_DRAW_PORTS, 191 PETSC_VIEWER_NATIVE, 192 PETSC_VIEWER_NOFORMAT, 193 PETSC_VIEWER_ASCII_FACTOR_INFO} PetscViewerFormat; 194 195 EXTERN int PetscViewerSetFormat(PetscViewer,PetscViewerFormat); 196 EXTERN int PetscViewerPushFormat(PetscViewer,PetscViewerFormat); 197 EXTERN int PetscViewerPopFormat(PetscViewer); 198 EXTERN int PetscViewerGetFormat(PetscViewer,PetscViewerFormat*); 199 EXTERN int PetscViewerFlush(PetscViewer); 200 201 /* 202 Operations explicit to a particular class of viewers 203 */ 204 205 /*E 206 PetscViewerFormat - Access mode for a file. 207 208 Level: beginner 209 210 .seealso: PetscViewerASCIISetMode() 211 E*/ 212 typedef enum {FILE_MODE_READ, FILE_MODE_WRITE, FILE_MODE_APPEND, FILE_MODE_UPDATE, FILE_MODE_APPEND_UPDATE} PetscFileMode; 213 214 EXTERN int PetscViewerASCIIGetPointer(PetscViewer,FILE**); 215 EXTERN int PetscViewerASCIISetMode(PetscViewer,PetscFileMode); 216 EXTERN int PetscViewerASCIIPrintf(PetscViewer,const char[],...) PETSC_PRINTF_FORMAT_CHECK(2,3); 217 EXTERN int PetscViewerASCIISynchronizedPrintf(PetscViewer,const char[],...) PETSC_PRINTF_FORMAT_CHECK(2,3); 218 EXTERN int PetscViewerASCIIPushTab(PetscViewer); 219 EXTERN int PetscViewerASCIIPopTab(PetscViewer); 220 EXTERN int PetscViewerASCIIUseTabs(PetscViewer,PetscTruth); 221 EXTERN int PetscViewerASCIISetTab(PetscViewer,int); 222 EXTERN int PetscViewerBinaryGetDescriptor(PetscViewer,int*); 223 EXTERN int PetscViewerBinaryGetInfoPointer(PetscViewer,FILE **); 224 EXTERN int PetscViewerSetFileType(PetscViewer,PetscViewerFileType); 225 EXTERN int PetscViewerStringSPrintf(PetscViewer,const char[],...) PETSC_PRINTF_FORMAT_CHECK(2,3); 226 EXTERN int PetscViewerStringSetString(PetscViewer,char[],int); 227 EXTERN int PetscViewerDrawClear(PetscViewer); 228 EXTERN int PetscViewerDrawSetInfo(PetscViewer,const char[],const char[],int,int,int,int); 229 EXTERN int PetscViewerSocketSetConnection(PetscViewer,const char[],int); 230 EXTERN int PetscViewerBinarySkipInfo(PetscViewer); 231 EXTERN int PetscViewerBinaryLoadInfo(PetscViewer); 232 233 234 EXTERN int PetscViewerSetFilename(PetscViewer,const char[]); 235 EXTERN int PetscViewerGetFilename(PetscViewer,char**); 236 237 EXTERN int PetscPLAPACKInitializePackage(char *); 238 EXTERN int PetscPLAPACKFinalizePackage(void); 239 240 EXTERN int PetscViewerVUGetPointer(PetscViewer, FILE**); 241 EXTERN int PetscViewerVUSetMode(PetscViewer, PetscFileMode); 242 EXTERN int PetscViewerVUSetVecSeen(PetscViewer, PetscTruth); 243 EXTERN int PetscViewerVUGetVecSeen(PetscViewer, PetscTruth *); 244 EXTERN int PetscViewerVUPrintDeferred(PetscViewer, const char [], ...) PETSC_PRINTF_FORMAT_CHECK(2,3); 245 EXTERN int PetscViewerVUFlushDeferred(PetscViewer); 246 247 EXTERN int PetscViewerMathematicaInitializePackage(char *); 248 EXTERN int PetscViewerMathematicaFinalizePackage(void); 249 EXTERN int PetscViewerMathematicaGetName(PetscViewer, const char **); 250 EXTERN int PetscViewerMathematicaSetName(PetscViewer, const char []); 251 EXTERN int PetscViewerMathematicaClearName(PetscViewer); 252 EXTERN int PetscViewerMathematicaSkipPackets(PetscViewer, int); 253 254 EXTERN int PetscViewerSiloGetName(PetscViewer, char **); 255 EXTERN int PetscViewerSiloSetName(PetscViewer, const char []); 256 EXTERN int PetscViewerSiloClearName(PetscViewer); 257 EXTERN int PetscViewerSiloGetMeshName(PetscViewer, char **); 258 EXTERN int PetscViewerSiloSetMeshName(PetscViewer, const char []); 259 EXTERN int PetscViewerSiloClearMeshName(PetscViewer); 260 261 EXTERN int PetscViewerNetcdfOpen(MPI_Comm,const char[],PetscViewerFileType,PetscViewer*); 262 EXTERN int PetscViewerNetcdfGetID(PetscViewer, int *); 263 264 EXTERN int PetscViewerHDF4Open(MPI_Comm,const char[],PetscViewerFileType,PetscViewer*); 265 EXTERN int PetscViewerHDF4WriteSDS(PetscViewer viewer, float *xf, int d, int *dims, int bs); 266 267 /* 268 These are all the default viewers that do not have 269 to be explicitly opened 270 */ 271 EXTERN PetscViewer PETSC_VIEWER_STDOUT_(MPI_Comm); 272 EXTERN PetscViewer PETSC_VIEWER_STDERR_(MPI_Comm); 273 EXTERN PetscViewer PETSC_VIEWER_DRAW_(MPI_Comm); 274 EXTERN PetscViewer PETSC_VIEWER_SOCKET_(MPI_Comm); 275 EXTERN PetscViewer PETSC_VIEWER_BINARY_(MPI_Comm); 276 EXTERN PetscViewer PETSC_VIEWER_MATLAB_(MPI_Comm); 277 EXTERN PetscViewer PETSC_VIEWER_MATHEMATICA_WORLD_PRIVATE; 278 279 #define PETSC_VIEWER_STDERR_SELF PETSC_VIEWER_STDERR_(PETSC_COMM_SELF) 280 #define PETSC_VIEWER_STDERR_WORLD PETSC_VIEWER_STDERR_(PETSC_COMM_WORLD) 281 282 /*MC 283 PETSC_VIEWER_STDOUT_WORLD - same as PETSC_VIEWER_STDOUT_(PETSC_COMM_WORLD) 284 285 Level: beginner 286 M*/ 287 #define PETSC_VIEWER_STDOUT_WORLD PETSC_VIEWER_STDOUT_(PETSC_COMM_WORLD) 288 289 /*MC 290 PETSC_VIEWER_STDOUT_SELF - same as PETSC_VIEWER_STDOUT_(PETSC_COMM_SELF) 291 292 Level: beginner 293 M*/ 294 #define PETSC_VIEWER_STDOUT_SELF PETSC_VIEWER_STDOUT_(PETSC_COMM_SELF) 295 296 /*MC 297 PETSC_VIEWER_DRAW_WORLD - same as PETSC_VIEWER_DRAW_(PETSC_COMM_WORLD) 298 299 Level: intermediate 300 M*/ 301 #define PETSC_VIEWER_DRAW_WORLD PETSC_VIEWER_DRAW_(PETSC_COMM_WORLD) 302 303 /*MC 304 PETSC_VIEWER_DRAW_SELF - same as PETSC_VIEWER_DRAW_(PETSC_COMM_SELF) 305 306 Level: intermediate 307 M*/ 308 #define PETSC_VIEWER_DRAW_SELF PETSC_VIEWER_DRAW_(PETSC_COMM_SELF) 309 310 /*MC 311 PETSC_VIEWER_SOCKET_WORLD - same as PETSC_VIEWER_SOCKET_(PETSC_COMM_WORLD) 312 313 Level: intermediate 314 M*/ 315 #define PETSC_VIEWER_SOCKET_WORLD PETSC_VIEWER_SOCKET_(PETSC_COMM_WORLD) 316 317 /*MC 318 PETSC_VIEWER_SOCKET_SELF - same as PETSC_VIEWER_SOCKET_(PETSC_COMM_SELF) 319 320 Level: intermediate 321 M*/ 322 #define PETSC_VIEWER_SOCKET_SELF PETSC_VIEWER_SOCKET_(PETSC_COMM_SELF) 323 324 /*MC 325 PETSC_VIEWER_BINARY_WORLD - same as PETSC_VIEWER_BINARY_(PETSC_COMM_WORLD) 326 327 Level: intermediate 328 M*/ 329 #define PETSC_VIEWER_BINARY_WORLD PETSC_VIEWER_BINARY_(PETSC_COMM_WORLD) 330 331 /*MC 332 PETSC_VIEWER_BINARY_SELF - same as PETSC_VIEWER_BINARY_(PETSC_COMM_SELF) 333 334 Level: intermediate 335 M*/ 336 #define PETSC_VIEWER_BINARY_SELF PETSC_VIEWER_BINARY_(PETSC_COMM_SELF) 337 338 /*MC 339 PETSC_VIEWER_MATLAB_WORLD - same as PETSC_VIEWER_MATLAB_(PETSC_COMM_WORLD) 340 341 Level: intermediate 342 M*/ 343 #define PETSC_VIEWER_MATLAB_WORLD PETSC_VIEWER_MATLAB_(PETSC_COMM_WORLD) 344 345 /*MC 346 PETSC_VIEWER_MATLAB_SELF - same as PETSC_VIEWER_MATLAB_(PETSC_COMM_SELF) 347 348 Level: intermediate 349 M*/ 350 #define PETSC_VIEWER_MATLAB_SELF PETSC_VIEWER_MATLAB_(PETSC_COMM_SELF) 351 352 #define PETSC_VIEWER_MATHEMATICA_WORLD (PetscViewerInitializeMathematicaWorld_Private(),PETSC_VIEWER_MATHEMATICA_WORLD_PRIVATE) 353 354 /* 355 PetscViewer based on the ALICE Memory Snooper 356 */ 357 #if defined(PETSC_HAVE_AMS) 358 #include "ams.h" 359 EXTERN int PetscViewerAMSGetAMSComm(PetscViewer,AMS_Comm *); 360 EXTERN int PetscViewerAMSOpen(MPI_Comm,const char[],PetscViewer*); 361 EXTERN int PetscViewerAMSLock(PetscViewer); 362 EXTERN PetscViewer PETSC_VIEWER_AMS_(MPI_Comm); 363 EXTERN int PETSC_VIEWER_AMS_Destroy(MPI_Comm); 364 #define PETSC_VIEWER_AMS_WORLD PETSC_VIEWER_AMS_(PETSC_COMM_WORLD) 365 #endif 366 367 /* 368 petscViewer writes to Matlab .mat file 369 */ 370 EXTERN int PetscViewerMatlabPutArray(PetscViewer,int,int,PetscScalar*,char*); 371 EXTERN int PetscViewerMatlabGetArray(PetscViewer,int,int,PetscScalar*,char*); 372 EXTERN int PetscViewerMatlabPutVariable(PetscViewer,const char*,void*); 373 374 /* 375 PetscViewer utility routines used by PETSc that are not normally used 376 by users. 377 */ 378 EXTERN int PetscViewerSocketPutScalar(PetscViewer,int,int,PetscScalar*); 379 EXTERN int PetscViewerSocketPutReal(PetscViewer,int,int,PetscReal*); 380 EXTERN int PetscViewerSocketPutInt(PetscViewer,int,int*); 381 EXTERN int PetscViewerSocketPutSparse_Private(PetscViewer,int,int,int,PetscScalar*,int*,int *); 382 EXTERN int PetscViewerDestroyAMS_Private(void); 383 384 /*S 385 PetscViewers - Abstract collection of PetscViewers 386 387 Level: intermediate 388 389 Concepts: viewing 390 391 .seealso: PetscViewerCreate(), PetscViewerSetType(), PetscViewerType, PetscViewer, PetscViewersCreate(), 392 PetscViewersGetViewer() 393 S*/ 394 typedef struct _p_PetscViewers* PetscViewers; 395 EXTERN int PetscViewersCreate(MPI_Comm,PetscViewers*); 396 EXTERN int PetscViewersDestroy(PetscViewers); 397 EXTERN int PetscViewersGetViewer(PetscViewers,int,PetscViewer*); 398 399 PETSC_EXTERN_CXX_END 400 #endif 401