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 typedef enum {PETSC_FILE_RDONLY,PETSC_FILE_WRONLY,PETSC_FILE_CREATE} PetscViewerFileType; 111 EXTERN int PetscViewerBinaryOpen(MPI_Comm,const char[],PetscViewerFileType,PetscViewer*); 112 EXTERN int PetscViewerSocketOpen(MPI_Comm,const char[],int,PetscViewer*); 113 EXTERN int PetscViewerStringOpen(MPI_Comm,char[],int,PetscViewer*); 114 EXTERN int PetscViewerDrawOpen(MPI_Comm,const char[],const char[],int,int,int,int,PetscViewer*); 115 EXTERN int PetscViewerAMSSetCommName(PetscViewer,const char[]); 116 EXTERN int PetscViewerMathematicaOpen(MPI_Comm, int, const char[], const char[], PetscViewer *); 117 EXTERN int PetscViewerSiloOpen(MPI_Comm, const char[], PetscViewer *); 118 EXTERN int PetscViewerMatlabOpen(MPI_Comm,const char[],PetscViewerFileType,PetscViewer*); 119 120 EXTERN int PetscViewerGetType(PetscViewer,PetscViewerType*); 121 EXTERN int PetscViewerSetType(PetscViewer,const PetscViewerType); 122 EXTERN int PetscViewerDestroy(PetscViewer); 123 EXTERN int PetscViewerGetSingleton(PetscViewer,PetscViewer*); 124 EXTERN int PetscViewerRestoreSingleton(PetscViewer,PetscViewer*); 125 126 127 /*E 128 PetscViewerFormat - Way a viewer presents the object 129 130 Level: beginner 131 132 .seealso: PetscViewerSetFormat(), PetscViewer, PetscViewerType, PetscViewerPushFormat(), PetscViewerPopFormat() 133 E*/ 134 typedef enum { 135 PETSC_VIEWER_ASCII_DEFAULT, 136 PETSC_VIEWER_ASCII_MATLAB, 137 PETSC_VIEWER_ASCII_MATHEMATICA, 138 PETSC_VIEWER_ASCII_IMPL, 139 PETSC_VIEWER_ASCII_INFO, 140 PETSC_VIEWER_ASCII_INFO_DETAIL, 141 PETSC_VIEWER_ASCII_COMMON, 142 PETSC_VIEWER_ASCII_SYMMODU, 143 PETSC_VIEWER_ASCII_INDEX, 144 PETSC_VIEWER_ASCII_DENSE, 145 PETSC_VIEWER_BINARY_DEFAULT, 146 PETSC_VIEWER_BINARY_NATIVE, 147 PETSC_VIEWER_DRAW_BASIC, 148 PETSC_VIEWER_DRAW_LG, 149 PETSC_VIEWER_DRAW_CONTOUR, 150 PETSC_VIEWER_DRAW_PORTS, 151 PETSC_VIEWER_NATIVE, 152 PETSC_VIEWER_NOFORMAT, 153 PETSC_VIEWER_ASCII_FACTOR_INFO} PetscViewerFormat; 154 155 EXTERN int PetscViewerSetFormat(PetscViewer,PetscViewerFormat); 156 EXTERN int PetscViewerPushFormat(PetscViewer,PetscViewerFormat); 157 EXTERN int PetscViewerPopFormat(PetscViewer); 158 EXTERN int PetscViewerGetFormat(PetscViewer,PetscViewerFormat*); 159 EXTERN int PetscViewerFlush(PetscViewer); 160 161 /* 162 Operations explicit to a particular class of viewers 163 */ 164 165 /*E 166 PetscViewerFormat - Access mode for a file. 167 168 Level: beginner 169 170 .seealso: PetscViewerASCIISetMode() 171 E*/ 172 typedef enum {FILE_MODE_READ, FILE_MODE_WRITE, FILE_MODE_APPEND, FILE_MODE_UPDATE, FILE_MODE_APPEND_UPDATE} PetscFileMode; 173 174 EXTERN int PetscViewerASCIIGetPointer(PetscViewer,FILE**); 175 EXTERN int PetscViewerASCIISetMode(PetscViewer,PetscFileMode); 176 EXTERN int PetscViewerASCIIPrintf(PetscViewer,const char[],...) PETSC_PRINTF_FORMAT_CHECK(2,3); 177 EXTERN int PetscViewerASCIISynchronizedPrintf(PetscViewer,const char[],...) PETSC_PRINTF_FORMAT_CHECK(2,3); 178 EXTERN int PetscViewerASCIIPushTab(PetscViewer); 179 EXTERN int PetscViewerASCIIPopTab(PetscViewer); 180 EXTERN int PetscViewerASCIIUseTabs(PetscViewer,PetscTruth); 181 EXTERN int PetscViewerASCIISetTab(PetscViewer,int); 182 EXTERN int PetscViewerBinaryGetDescriptor(PetscViewer,int*); 183 EXTERN int PetscViewerBinaryGetInfoPointer(PetscViewer,FILE **); 184 EXTERN int PetscViewerSetFileType(PetscViewer,PetscViewerFileType); 185 EXTERN int PetscViewerStringSPrintf(PetscViewer,const char[],...) PETSC_PRINTF_FORMAT_CHECK(2,3); 186 EXTERN int PetscViewerStringSetString(PetscViewer,char[],int); 187 EXTERN int PetscViewerDrawClear(PetscViewer); 188 EXTERN int PetscViewerDrawSetInfo(PetscViewer,const char[],const char[],int,int,int,int); 189 EXTERN int PetscViewerSocketSetConnection(PetscViewer,const char[],int); 190 EXTERN int PetscViewerBinarySkipInfo(PetscViewer); 191 EXTERN int PetscViewerBinaryLoadInfo(PetscViewer); 192 193 194 EXTERN int PetscViewerSetFilename(PetscViewer,const char[]); 195 EXTERN int PetscViewerGetFilename(PetscViewer,char**); 196 197 EXTERN int PetscPLAPACKInitializePackage(char *); 198 EXTERN int PetscPLAPACKFinalizePackage(void); 199 200 EXTERN int PetscViewerVUGetPointer(PetscViewer, FILE**); 201 EXTERN int PetscViewerVUSetMode(PetscViewer, PetscFileMode); 202 EXTERN int PetscViewerVUSetVecSeen(PetscViewer, PetscTruth); 203 EXTERN int PetscViewerVUGetVecSeen(PetscViewer, PetscTruth *); 204 EXTERN int PetscViewerVUPrintDeferred(PetscViewer, const char [], ...) PETSC_PRINTF_FORMAT_CHECK(2,3); 205 EXTERN int PetscViewerVUFlushDeferred(PetscViewer); 206 207 EXTERN int PetscViewerMathematicaInitializePackage(char *); 208 EXTERN int PetscViewerMathematicaFinalizePackage(void); 209 EXTERN int PetscViewerMathematicaGetName(PetscViewer, const char **); 210 EXTERN int PetscViewerMathematicaSetName(PetscViewer, const char []); 211 EXTERN int PetscViewerMathematicaClearName(PetscViewer); 212 EXTERN int PetscViewerMathematicaSkipPackets(PetscViewer, int); 213 214 EXTERN int PetscViewerSiloGetName(PetscViewer, char **); 215 EXTERN int PetscViewerSiloSetName(PetscViewer, const char []); 216 EXTERN int PetscViewerSiloClearName(PetscViewer); 217 EXTERN int PetscViewerSiloGetMeshName(PetscViewer, char **); 218 EXTERN int PetscViewerSiloSetMeshName(PetscViewer, const char []); 219 EXTERN int PetscViewerSiloClearMeshName(PetscViewer); 220 221 EXTERN int PetscViewerNetcdfOpen(MPI_Comm,const char[],PetscViewerFileType,PetscViewer*); 222 EXTERN int PetscViewerNetcdfGetID(PetscViewer, int *); 223 224 EXTERN int PetscViewerHDF4Open(MPI_Comm,const char[],PetscViewerFileType,PetscViewer*); 225 EXTERN int PetscViewerHDF4WriteSDS(PetscViewer viewer, float *xf, int d, int *dims, int bs); 226 227 /* 228 These are all the default viewers that do not have 229 to be explicitly opened 230 */ 231 EXTERN PetscViewer PETSC_VIEWER_STDOUT_(MPI_Comm); 232 EXTERN PetscViewer PETSC_VIEWER_STDERR_(MPI_Comm); 233 EXTERN PetscViewer PETSC_VIEWER_DRAW_(MPI_Comm); 234 EXTERN PetscViewer PETSC_VIEWER_SOCKET_(MPI_Comm); 235 EXTERN PetscViewer PETSC_VIEWER_BINARY_(MPI_Comm); 236 EXTERN PetscViewer PETSC_VIEWER_MATLAB_(MPI_Comm); 237 EXTERN PetscViewer PETSC_VIEWER_MATHEMATICA_WORLD_PRIVATE; 238 239 #define PETSC_VIEWER_STDERR_SELF PETSC_VIEWER_STDERR_(PETSC_COMM_SELF) 240 #define PETSC_VIEWER_STDERR_WORLD PETSC_VIEWER_STDERR_(PETSC_COMM_WORLD) 241 242 /*MC 243 PETSC_VIEWER_STDOUT_WORLD - same as PETSC_VIEWER_STDOUT_(PETSC_COMM_WORLD) 244 245 Level: beginner 246 M*/ 247 #define PETSC_VIEWER_STDOUT_WORLD PETSC_VIEWER_STDOUT_(PETSC_COMM_WORLD) 248 249 /*MC 250 PETSC_VIEWER_STDOUT_SELF - same as PETSC_VIEWER_STDOUT_(PETSC_COMM_SELF) 251 252 Level: beginner 253 M*/ 254 #define PETSC_VIEWER_STDOUT_SELF PETSC_VIEWER_STDOUT_(PETSC_COMM_SELF) 255 256 /*MC 257 PETSC_VIEWER_DRAW_WORLD - same as PETSC_VIEWER_DRAW_(PETSC_COMM_WORLD) 258 259 Level: intermediate 260 M*/ 261 #define PETSC_VIEWER_DRAW_WORLD PETSC_VIEWER_DRAW_(PETSC_COMM_WORLD) 262 263 /*MC 264 PETSC_VIEWER_DRAW_SELF - same as PETSC_VIEWER_DRAW_(PETSC_COMM_SELF) 265 266 Level: intermediate 267 M*/ 268 #define PETSC_VIEWER_DRAW_SELF PETSC_VIEWER_DRAW_(PETSC_COMM_SELF) 269 270 /*MC 271 PETSC_VIEWER_SOCKET_WORLD - same as PETSC_VIEWER_SOCKET_(PETSC_COMM_WORLD) 272 273 Level: intermediate 274 M*/ 275 #define PETSC_VIEWER_SOCKET_WORLD PETSC_VIEWER_SOCKET_(PETSC_COMM_WORLD) 276 277 /*MC 278 PETSC_VIEWER_SOCKET_SELF - same as PETSC_VIEWER_SOCKET_(PETSC_COMM_SELF) 279 280 Level: intermediate 281 M*/ 282 #define PETSC_VIEWER_SOCKET_SELF PETSC_VIEWER_SOCKET_(PETSC_COMM_SELF) 283 284 /*MC 285 PETSC_VIEWER_BINARY_WORLD - same as PETSC_VIEWER_BINARY_(PETSC_COMM_WORLD) 286 287 Level: intermediate 288 M*/ 289 #define PETSC_VIEWER_BINARY_WORLD PETSC_VIEWER_BINARY_(PETSC_COMM_WORLD) 290 291 /*MC 292 PETSC_VIEWER_BINARY_SELF - same as PETSC_VIEWER_BINARY_(PETSC_COMM_SELF) 293 294 Level: intermediate 295 M*/ 296 #define PETSC_VIEWER_BINARY_SELF PETSC_VIEWER_BINARY_(PETSC_COMM_SELF) 297 298 /*MC 299 PETSC_VIEWER_MATLAB_WORLD - same as PETSC_VIEWER_MATLAB_(PETSC_COMM_WORLD) 300 301 Level: intermediate 302 M*/ 303 #define PETSC_VIEWER_MATLAB_WORLD PETSC_VIEWER_MATLAB_(PETSC_COMM_WORLD) 304 305 /*MC 306 PETSC_VIEWER_MATLAB_SELF - same as PETSC_VIEWER_MATLAB_(PETSC_COMM_SELF) 307 308 Level: intermediate 309 M*/ 310 #define PETSC_VIEWER_MATLAB_SELF PETSC_VIEWER_MATLAB_(PETSC_COMM_SELF) 311 312 #define PETSC_VIEWER_MATHEMATICA_WORLD (PetscViewerInitializeMathematicaWorld_Private(),PETSC_VIEWER_MATHEMATICA_WORLD_PRIVATE) 313 314 /* 315 PetscViewer based on the ALICE Memory Snooper 316 */ 317 #if defined(PETSC_HAVE_AMS) 318 #include "ams.h" 319 EXTERN int PetscViewerAMSGetAMSComm(PetscViewer,AMS_Comm *); 320 EXTERN int PetscViewerAMSOpen(MPI_Comm,const char[],PetscViewer*); 321 EXTERN int PetscViewerAMSLock(PetscViewer); 322 EXTERN PetscViewer PETSC_VIEWER_AMS_(MPI_Comm); 323 EXTERN int PETSC_VIEWER_AMS_Destroy(MPI_Comm); 324 #define PETSC_VIEWER_AMS_WORLD PETSC_VIEWER_AMS_(PETSC_COMM_WORLD) 325 #endif 326 327 /* 328 petscViewer writes to Matlab .mat file 329 */ 330 EXTERN int PetscViewerMatlabPutArray(PetscViewer,int,int,PetscScalar*,char*); 331 EXTERN int PetscViewerMatlabGetArray(PetscViewer,int,int,PetscScalar*,char*); 332 EXTERN int PetscViewerMatlabPutVariable(PetscViewer,const char*,void*); 333 334 /* 335 PetscViewer utility routines used by PETSc that are not normally used 336 by users. 337 */ 338 EXTERN int PetscViewerSocketPutScalar(PetscViewer,int,int,PetscScalar*); 339 EXTERN int PetscViewerSocketPutReal(PetscViewer,int,int,PetscReal*); 340 EXTERN int PetscViewerSocketPutInt(PetscViewer,int,int*); 341 EXTERN int PetscViewerSocketPutSparse_Private(PetscViewer,int,int,int,PetscScalar*,int*,int *); 342 EXTERN int PetscViewerDestroyAMS_Private(void); 343 344 /*S 345 PetscViewers - Abstract collection of PetscViewers 346 347 Level: intermediate 348 349 Concepts: viewing 350 351 .seealso: PetscViewerCreate(), PetscViewerSetType(), PetscViewerType, PetscViewer, PetscViewersCreate(), 352 PetscViewersGetViewer() 353 S*/ 354 typedef struct _p_PetscViewers* PetscViewers; 355 EXTERN int PetscViewersCreate(MPI_Comm,PetscViewers*); 356 EXTERN int PetscViewersDestroy(PetscViewers); 357 EXTERN int PetscViewersGetViewer(PetscViewers,int,PetscViewer*); 358 359 PETSC_EXTERN_CXX_END 360 #endif 361