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