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 /*S 10 PetscViewer - Abstract PETSc object that helps view (in ASCII, binary, graphically etc) 11 other PETSc objects 12 13 Level: beginner 14 15 Concepts: viewing 16 17 .seealso: PetscViewerCreate(), PetscViewerSetType(), PetscViewerType 18 S*/ 19 typedef struct _p_PetscViewer* PetscViewer; 20 21 /* 22 petsc.h must be included AFTER the definition of PetscViewer for ADIC to 23 process correctly. 24 */ 25 #include "petsc.h" 26 27 #define PETSC_VIEWER_COOKIE PETSC_COOKIE+1 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_MATHEMATICA "mathematica" 44 #define PETSC_VIEWER_SILO "silo" 45 46 extern PetscFList PetscViewerList; 47 EXTERN int PetscViewerRegisterAll(char *); 48 EXTERN int PetscViewerRegisterDestroy(void); 49 50 EXTERN int PetscViewerRegister(char*,char*,char*,int(*)(PetscViewer)); 51 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 52 #define PetscViewerRegisterDynamic(a,b,c,d) PetscViewerRegister(a,b,c,0) 53 #else 54 #define PetscViewerRegisterDynamic(a,b,c,d) PetscViewerRegister(a,b,c,d) 55 #endif 56 EXTERN int PetscViewerCreate(MPI_Comm,PetscViewer*); 57 EXTERN int PetscViewerSetFromOptions(PetscViewer); 58 59 EXTERN int PetscViewerASCIIOpen(MPI_Comm,const char[],PetscViewer*); 60 typedef enum {PETSC_BINARY_RDONLY,PETSC_BINARY_WRONLY,PETSC_BINARY_CREATE} PetscViewerBinaryType; 61 EXTERN int PetscViewerBinaryOpen(MPI_Comm,const char[],PetscViewerBinaryType,PetscViewer*); 62 EXTERN int PetscViewerSocketOpen(MPI_Comm,const char[],int,PetscViewer*); 63 EXTERN int PetscViewerStringOpen(MPI_Comm,char[],int,PetscViewer*); 64 EXTERN int PetscViewerDrawOpen(MPI_Comm,const char[],const char[],int,int,int,int,PetscViewer*); 65 EXTERN int PetscViewerAMSSetCommName(PetscViewer,const char[]); 66 EXTERN int PetscViewerMathematicaOpen(MPI_Comm, int, const char[], const char[], PetscViewer *); 67 EXTERN int PetscViewerSiloOpen(MPI_Comm, const char[], PetscViewer *); 68 69 EXTERN int PetscViewerGetType(PetscViewer,PetscViewerType*); 70 EXTERN int PetscViewerSetType(PetscViewer,PetscViewerType); 71 EXTERN int PetscViewerDestroy(PetscViewer); 72 EXTERN int PetscViewerGetSingleton(PetscViewer,PetscViewer*); 73 EXTERN int PetscViewerRestoreSingleton(PetscViewer,PetscViewer*); 74 75 76 /*E 77 PetscViewerFormat - Way a viewer presents the object 78 79 Level: beginner 80 81 .seealso: PetscViewerSetFormat(), PetscViewer, PetscViewerType, PetscViewerPushFormat(), PetscViewerPopFormat() 82 E*/ 83 typedef enum { 84 PETSC_VIEWER_ASCII_DEFAULT, 85 PETSC_VIEWER_ASCII_MATLAB, 86 PETSC_VIEWER_ASCII_MATHEMATICA, 87 PETSC_VIEWER_ASCII_IMPL, 88 PETSC_VIEWER_ASCII_INFO, 89 PETSC_VIEWER_ASCII_INFO_LONG, 90 PETSC_VIEWER_ASCII_COMMON, 91 PETSC_VIEWER_ASCII_SYMMODU, 92 PETSC_VIEWER_ASCII_INDEX, 93 PETSC_VIEWER_ASCII_DENSE, 94 PETSC_VIEWER_BINARY_DEFAULT, 95 PETSC_VIEWER_BINARY_NATIVE, 96 PETSC_VIEWER_DRAW_BASIC, 97 PETSC_VIEWER_DRAW_LG, 98 PETSC_VIEWER_DRAW_CONTOUR, 99 PETSC_VIEWER_DRAW_PORTS, 100 PETSC_VIEWER_NATIVE, 101 PETSC_VIEWER_NOFORMAT} PetscViewerFormat; 102 103 EXTERN int PetscViewerSetFormat(PetscViewer,PetscViewerFormat); 104 EXTERN int PetscViewerPushFormat(PetscViewer,PetscViewerFormat); 105 EXTERN int PetscViewerPopFormat(PetscViewer); 106 EXTERN int PetscViewerGetFormat(PetscViewer,PetscViewerFormat*); 107 EXTERN int PetscViewerFlush(PetscViewer); 108 109 /* 110 Operations explicit to a particular class of viewers 111 */ 112 EXTERN int PetscViewerASCIIGetPointer(PetscViewer,FILE**); 113 EXTERN int PetscViewerASCIIPrintf(PetscViewer,const char[],...); 114 EXTERN int PetscViewerASCIISynchronizedPrintf(PetscViewer,const char[],...); 115 EXTERN int PetscViewerASCIIPushTab(PetscViewer); 116 EXTERN int PetscViewerASCIIPopTab(PetscViewer); 117 EXTERN int PetscViewerASCIIUseTabs(PetscViewer,PetscTruth); 118 EXTERN int PetscViewerASCIISetTab(PetscViewer,int); 119 EXTERN int PetscViewerBinaryGetDescriptor(PetscViewer,int*); 120 EXTERN int PetscViewerBinaryGetInfoPointer(PetscViewer,FILE **); 121 EXTERN int PetscViewerBinarySetType(PetscViewer,PetscViewerBinaryType); 122 EXTERN int PetscViewerStringSPrintf(PetscViewer,char *,...); 123 EXTERN int PetscViewerStringSetString(PetscViewer,char[],int); 124 EXTERN int PetscViewerDrawClear(PetscViewer); 125 EXTERN int PetscViewerDrawSetInfo(PetscViewer,const char[],const char[],int,int,int,int); 126 EXTERN int PetscViewerSocketSetConnection(PetscViewer,const char[],int); 127 EXTERN int PetscViewerBinarySkipInfo(PetscViewer); 128 129 EXTERN int PetscViewerSetFilename(PetscViewer,const char[]); 130 EXTERN int PetscViewerGetFilename(PetscViewer,char**); 131 132 EXTERN int ViewerMathematicaGetName(PetscViewer, char **); 133 EXTERN int ViewerMathematicaSetName(PetscViewer, const char []); 134 EXTERN int ViewerMathematicaClearName(PetscViewer); 135 EXTERN int ViewerMathematicaSkipPackets(PetscViewer, int); 136 #ifdef PETSC_HAVE_MATHEMATICA 137 EXTERN int ViewerMathematicaGetLink(PetscViewer, MLINK *); 138 #endif 139 140 EXTERN int ViewerSiloGetName(PetscViewer, char **); 141 EXTERN int ViewerSiloSetName(PetscViewer, const char []); 142 EXTERN int ViewerSiloClearName(PetscViewer); 143 EXTERN int ViewerSiloGetMeshName(PetscViewer, char **); 144 EXTERN int ViewerSiloSetMeshName(PetscViewer, const char []); 145 EXTERN int ViewerSiloClearMeshName(PetscViewer); 146 147 /* 148 These are all the default viewers that do not have 149 to be explicitly opened 150 */ 151 EXTERN PetscViewer PETSC_VIEWER_STDOUT_(MPI_Comm); 152 EXTERN PetscViewer PETSC_VIEWER_STDERR_(MPI_Comm); 153 EXTERN PetscViewer PETSC_VIEWER_DRAW_(MPI_Comm); 154 EXTERN PetscViewer PETSC_VIEWER_SOCKET_(MPI_Comm); 155 EXTERN PetscViewer PETSC_VIEWER_BINARY_(MPI_Comm); 156 EXTERN PetscViewer VIEWER_MATHEMATICA_WORLD_PRIVATE; 157 158 #define PETSC_VIEWER_STDOUT_SELF PETSC_VIEWER_STDOUT_(PETSC_COMM_SELF) 159 #define PETSC_VIEWER_STDOUT_WORLD PETSC_VIEWER_STDOUT_(PETSC_COMM_WORLD) 160 #define PETSC_VIEWER_STDERR_SELF PETSC_VIEWER_STDERR_(PETSC_COMM_SELF) 161 #define PETSC_VIEWER_STDERR_WORLD PETSC_VIEWER_STDERR_(PETSC_COMM_WORLD) 162 #define PETSC_VIEWER_DRAW_SELF PETSC_VIEWER_DRAW_(PETSC_COMM_SELF) 163 #define PETSC_VIEWER_DRAW_WORLD PETSC_VIEWER_DRAW_(PETSC_COMM_WORLD) 164 #define PETSC_VIEWER_SOCKET_WORLD PETSC_VIEWER_SOCKET_(PETSC_COMM_WORLD) 165 #define PETSC_VIEWER_SOCKET_SELF PETSC_VIEWER_SOCKET_(PETSC_COMM_SELF) 166 #define PETSC_VIEWER_BINARY_WORLD PETSC_VIEWER_BINARY_(PETSC_COMM_WORLD) 167 #define PETSC_VIEWER_BINARY_SELF PETSC_VIEWER_BINARY_(PETSC_COMM_SELF) 168 #define VIEWER_MATHEMATICA_WORLD (ViewerInitializeMathematicaWorld_Private(),VIEWER_MATHEMATICA_WORLD_PRIVATE) 169 170 /* 171 PetscViewer based on the ALICE Memory Snooper 172 */ 173 #if defined(PETSC_HAVE_AMS) 174 #include "ams.h" 175 EXTERN int PetscViewerAMSGetAMSComm(PetscViewer,AMS_Comm *); 176 EXTERN int PetscViewerAMSOpen(MPI_Comm,const char[],PetscViewer*); 177 EXTERN int PetscViewerAMSLock(PetscViewer); 178 EXTERN PetscViewer PETSC_VIEWER_AMS_(MPI_Comm); 179 EXTERN int PETSC_VIEWER_AMS_Destroy(MPI_Comm); 180 #define PETSC_VIEWER_AMS_WORLD PETSC_VIEWER_AMS_(PETSC_COMM_WORLD) 181 #endif 182 183 /* 184 PetscViewer utility routines used by PETSc that are not normally used 185 by users. 186 */ 187 EXTERN int PetscViewerSocketPutScalar(PetscViewer,int,int,PetscScalar*); 188 EXTERN int PetscViewerSocketPutReal(PetscViewer,int,int,PetscReal*); 189 EXTERN int PetscViewerSocketPutInt(PetscViewer,int,int*); 190 EXTERN int PetscViewerSocketPutSparse_Private(PetscViewer,int,int,int,PetscScalar*,int*,int *); 191 EXTERN int PetscViewerDestroyAMS_Private(void); 192 193 /*S 194 PetscViewers - Abstract collection of PetscViewers 195 196 Level: intermediate 197 198 Concepts: viewing 199 200 .seealso: PetscViewerCreate(), PetscViewerSetType(), PetscViewerType, PetscViewer, PetscViewersCreate(), 201 PetscViewersGetViewer() 202 S*/ 203 typedef struct _p_PetscViewers* PetscViewers; 204 EXTERN int PetscViewersCreate(MPI_Comm,PetscViewers*); 205 EXTERN int PetscViewersDestroy(PetscViewers); 206 EXTERN int PetscViewersGetViewer(PetscViewers,int,PetscViewer*); 207 208 #endif 209 210 211 212 213