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