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