1 /* $Id: viewer.h,v 1.68 1999/04/19 22:18:08 bsmith Exp bsmith $ */ 2 /* 3 Viewers are objects where other objects can be looked at or stored. 4 */ 5 6 #if !defined(__VIEWER_H) 7 #define __VIEWER_H 8 9 typedef struct _p_Viewer* Viewer; 10 11 /* 12 petsc.h must be included AFTER the definition of Viewer for ADIC to 13 process correctly. 14 */ 15 #include "petsc.h" 16 17 #define VIEWER_COOKIE PETSC_COOKIE+1 18 typedef char* ViewerType; 19 20 #define SOCKET_VIEWER "socket" 21 #define ASCII_VIEWER "ascii" 22 #define BINARY_VIEWER "binary" 23 #define STRING_VIEWER "string" 24 #define DRAW_VIEWER "draw" 25 #define AMS_VIEWER "ams" 26 27 extern FList ViewerList; 28 extern int ViewerRegisterAll(char *); 29 extern int ViewerRegisterDestroy(void); 30 31 extern int ViewerRegister_Private(char*,char*,char*,int(*)(Viewer)); 32 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 33 #define ViewerRegister(a,b,c,d) ViewerRegister_Private(a,b,c,0) 34 #else 35 #define ViewerRegister(a,b,c,d) ViewerRegister_Private(a,b,c,d) 36 #endif 37 extern int ViewerCreate(MPI_Comm,Viewer*); 38 extern int ViewerSetFromOptions(Viewer); 39 40 41 extern int ViewerASCIIOpen(MPI_Comm,const char[],Viewer*); 42 typedef enum {BINARY_RDONLY, BINARY_WRONLY, BINARY_CREATE} ViewerBinaryType; 43 extern int ViewerBinaryOpen(MPI_Comm,const char[],ViewerBinaryType,Viewer*); 44 extern int ViewerSocketOpen(MPI_Comm,const char[],int,Viewer*); 45 extern int ViewerStringOpen(MPI_Comm,char[],int, Viewer*); 46 extern int ViewerDrawOpen(MPI_Comm,const char[],const char[],int,int,int,int,Viewer*); 47 extern int ViewerAMSSetCommName(Viewer,const char[]); 48 49 extern int ViewerGetOutputname(Viewer,char**); 50 extern int ViewerGetType(Viewer,ViewerType*); 51 extern int ViewerSetType(Viewer,ViewerType); 52 extern int ViewerDestroy(Viewer); 53 54 #define VIEWER_FORMAT_ASCII_DEFAULT 0 55 #define VIEWER_FORMAT_ASCII_MATLAB 1 56 #define VIEWER_FORMAT_ASCII_IMPL 2 57 #define VIEWER_FORMAT_ASCII_INFO 3 58 #define VIEWER_FORMAT_ASCII_INFO_LONG 4 59 #define VIEWER_FORMAT_ASCII_COMMON 5 60 #define VIEWER_FORMAT_ASCII_SYMMODU 6 61 #define VIEWER_FORMAT_ASCII_INDEX 7 62 #define VIEWER_FORMAT_ASCII_DENSE 8 63 64 #define VIEWER_FORMAT_BINARY_DEFAULT 9 65 #define VIEWER_FORMAT_BINARY_NATIVE 10 66 67 #define VIEWER_FORMAT_DRAW_BASIC 11 68 #define VIEWER_FORMAT_DRAW_LG 12 69 #define VIEWER_FORMAT_DRAW_CONTOUR 13 70 71 #define VIEWER_FORMAT_NATIVE 14 72 73 extern int ViewerSetFormat(Viewer,int,char[]); 74 extern int ViewerPushFormat(Viewer,int,char[]); 75 extern int ViewerPopFormat(Viewer); 76 extern int ViewerGetFormat(Viewer,int*); 77 extern int ViewerFlush(Viewer); 78 79 /* 80 Operations explicit to a particular class of viewers 81 */ 82 extern int ViewerASCIIGetPointer(Viewer,FILE**); 83 extern int ViewerASCIIPrintf(Viewer,const char[],...); 84 extern int ViewerASCIIPushTab(Viewer); 85 extern int ViewerASCIIPopTab(Viewer); 86 extern int ViewerBinaryGetDescriptor(Viewer,int*); 87 extern int ViewerBinaryGetInfoPointer(Viewer,FILE **); 88 extern int ViewerBinarySetType(Viewer,ViewerBinaryType); 89 extern int ViewerStringSPrintf(Viewer,char *,...); 90 extern int ViewerStringSetString(Viewer,char[],int); 91 extern int ViewerDrawClear(Viewer); 92 extern int ViewerDrawSetInfo(Viewer,const char[],const char[],int,int,int,int); 93 extern int ViewerSocketSetConnection(Viewer,const char[],int); 94 95 extern int ViewerSetFilename(Viewer,const char[]); 96 97 /* 98 These are all the default viewers that do not have 99 to be explicitly opened 100 */ 101 extern Viewer VIEWER_STDOUT_SELF; 102 extern Viewer VIEWER_STDERR_SELF; 103 extern Viewer VIEWER_STDOUT_WORLD; 104 extern Viewer VIEWER_STDOUT_(MPI_Comm); 105 extern int VIEWER_STDOUT_Destroy(MPI_Comm); 106 extern Viewer VIEWER_STDERR_WORLD; 107 extern Viewer VIEWER_STDERR_(MPI_Comm); 108 extern int VIEWER_STDERR_Destroy(MPI_Comm); 109 extern Viewer VIEWER_DRAW_WORLD_PRIVATE_0; 110 extern Viewer VIEWER_DRAW_WORLD_PRIVATE_1; 111 extern Viewer VIEWER_DRAW_WORLD_PRIVATE_2; 112 extern Viewer VIEWER_DRAW_SELF_PRIVATE; 113 extern Viewer VIEWER_SOCKET_WORLD_PRIVATE; 114 extern Viewer VIEWER_SOCKET_SELF_PRIVATE; /* not yet used */ 115 116 extern int ViewerInitializeDrawWorld_Private_0(void); 117 extern int ViewerInitializeDrawWorld_Private_1(void); 118 extern int ViewerInitializeDrawWorld_Private_2(void); 119 extern int ViewerInitializeDrawSelf_Private(void); 120 extern int ViewerInitializeSocketWorld_Private(void); 121 extern Viewer VIEWER_DRAW_(MPI_Comm); 122 extern int VIEWER_DRAW_Destroy(MPI_Comm); 123 extern Viewer VIEWER_SOCKET_(MPI_Comm); 124 extern int VIEWER_SOCKET_Destroy(MPI_Comm); 125 126 #define VIEWER_DRAW_WORLD_0 \ 127 (ViewerInitializeDrawWorld_Private_0(),VIEWER_DRAW_WORLD_PRIVATE_0) 128 #define VIEWER_DRAW_WORLD_1 \ 129 (ViewerInitializeDrawWorld_Private_1(),VIEWER_DRAW_WORLD_PRIVATE_1) 130 #define VIEWER_DRAW_WORLD_2 \ 131 (ViewerInitializeDrawWorld_Private_2(),VIEWER_DRAW_WORLD_PRIVATE_2) 132 133 #define VIEWER_DRAW_SELF \ 134 (ViewerInitializeDrawSelf_Private(),VIEWER_DRAW_SELF_PRIVATE) 135 #define VIEWER_DRAW_WORLD VIEWER_DRAW_WORLD_0 136 137 #define VIEWER_SOCKET_WORLD \ 138 (ViewerInitializeSocketWorld_Private(),VIEWER_SOCKET_WORLD_PRIVATE) 139 140 /* 141 Viewer based on the ALICE Memory Snooper 142 */ 143 #if defined(PETSC_HAVE_AMS) 144 #include "ams.h" 145 extern int ViewerAMSGetAMSComm(Viewer,AMS_Comm *); 146 extern int ViewerAMSOpen(MPI_Comm,const char[],Viewer*); 147 extern Viewer VIEWER_AMS_(MPI_Comm); 148 extern int VIEWER_AMS_Destroy(MPI_Comm); 149 extern Viewer VIEWER_AMS_WORLD_PRIVATE; 150 extern int ViewerInitializeAMSWorld_Private(void); 151 #define VIEWER_AMS_WORLD (ViewerInitializeAMSWorld_Private(),VIEWER_AMS_WORLD_PRIVATE) 152 #endif 153 154 /* 155 Viewer utility routines used by PETSc that are not normally used 156 by users. 157 */ 158 extern int ViewerSocketPutScalar_Private(Viewer,int,int,Scalar*); 159 extern int ViewerSocketPutDouble_Private(Viewer,int,int,double*); 160 extern int ViewerSocketPutInt_Private(Viewer,int,int*); 161 extern int ViewerSocketPutSparse_Private(Viewer,int,int,int,Scalar*,int*,int *); 162 extern int ViewerInitializeASCII_Private(void); 163 extern int ViewerDestroyASCII_Private(void); 164 extern int ViewerDestroyDraw_Private(void); 165 extern int ViewerDestroySocket_Private(void); 166 extern int ViewerDestroyAMS_Private(void); 167 168 /* 169 Manages sets of viewers 170 */ 171 typedef struct _p_Viewers* Viewers; 172 extern int ViewersCreate(MPI_Comm,Viewers*); 173 extern int ViewersDestroy(Viewers); 174 extern int ViewersGetViewer(Viewers,int,Viewer*); 175 176 #endif 177 178