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