1 /* $Id: viewer.h,v 1.64 1999/01/14 17:01:28 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(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 48 extern int ViewerGetOutputname(Viewer,char**); 49 extern int ViewerGetType(Viewer,ViewerType*); 50 extern int ViewerSetType(Viewer,ViewerType); 51 extern int ViewerDestroy(Viewer); 52 53 #define VIEWER_FORMAT_ASCII_DEFAULT 0 54 #define VIEWER_FORMAT_ASCII_MATLAB 1 55 #define VIEWER_FORMAT_ASCII_IMPL 2 56 #define VIEWER_FORMAT_ASCII_INFO 3 57 #define VIEWER_FORMAT_ASCII_INFO_LONG 4 58 #define VIEWER_FORMAT_ASCII_COMMON 5 59 #define VIEWER_FORMAT_ASCII_SYMMODU 6 60 #define VIEWER_FORMAT_ASCII_INDEX 7 61 #define VIEWER_FORMAT_ASCII_DENSE 8 62 63 #define VIEWER_FORMAT_BINARY_DEFAULT 0 64 #define VIEWER_FORMAT_BINARY_NATIVE 1 65 66 #define VIEWER_FORMAT_DRAW_BASIC 0 67 #define VIEWER_FORMAT_DRAW_LG 1 68 #define VIEWER_FORMAT_DRAW_CONTOUR 2 69 70 extern int ViewerSetFormat(Viewer,int,char[]); 71 extern int ViewerPushFormat(Viewer,int,char[]); 72 extern int ViewerPopFormat(Viewer); 73 extern int ViewerGetFormat(Viewer,int*); 74 extern int ViewerFlush(Viewer); 75 76 /* 77 Operations explicit to a particular class of viewers 78 */ 79 extern int ViewerASCIIGetPointer(Viewer,FILE**); 80 extern int ViewerASCIIPrintf(Viewer,const char[],...); 81 extern int ViewerASCIIPushTab(Viewer); 82 extern int ViewerASCIIPopTab(Viewer); 83 extern int ViewerBinaryGetDescriptor(Viewer,int*); 84 extern int ViewerBinaryGetInfoPointer(Viewer,FILE **); 85 extern int ViewerBinarySetType(Viewer,ViewerBinaryType); 86 extern int ViewerStringSPrintf(Viewer,char *,...); 87 extern int ViewerStringSetString(Viewer,char[],int); 88 extern int ViewerDrawClear(Viewer); 89 extern int ViewerDrawSetInfo(Viewer,const char[],const char[],int,int,int,int); 90 extern int ViewerSocketSetConnection(Viewer,const char[],int); 91 92 extern int ViewerSetFilename(Viewer,const char[]); 93 94 /* 95 These are all the default viewers that do not have 96 to be explicitly opened 97 */ 98 extern Viewer VIEWER_STDOUT_SELF; 99 extern Viewer VIEWER_STDERR_SELF; 100 extern Viewer VIEWER_STDOUT_WORLD; 101 extern Viewer VIEWER_STDOUT_(MPI_Comm); 102 extern int VIEWER_STDOUT_Destroy(MPI_Comm); 103 extern Viewer VIEWER_STDERR_WORLD; 104 extern Viewer VIEWER_STDERR_(MPI_Comm); 105 extern int VIEWER_STDERR_Destroy(MPI_Comm); 106 extern Viewer VIEWER_DRAW_WORLD_PRIVATE_0; 107 extern Viewer VIEWER_DRAW_WORLD_PRIVATE_1; 108 extern Viewer VIEWER_DRAW_WORLD_PRIVATE_2; 109 extern Viewer VIEWER_DRAW_SELF_PRIVATE; 110 extern Viewer VIEWER_SOCKET_WORLD_PRIVATE; 111 extern Viewer VIEWER_SOCKET_SELF_PRIVATE; /* not yet used */ 112 113 extern int ViewerInitializeDrawWorld_Private_0(void); 114 extern int ViewerInitializeDrawWorld_Private_1(void); 115 extern int ViewerInitializeDrawWorld_Private_2(void); 116 extern int ViewerInitializeDrawSelf_Private(void); 117 extern int ViewerInitializeSocketWorld_Private(void); 118 extern Viewer VIEWER_DRAW_(MPI_Comm); 119 extern int VIEWER_DRAW_Destroy(MPI_Comm); 120 extern Viewer VIEWER_SOCKET_(MPI_Comm); 121 extern int VIEWER_SOCKET_Destroy(MPI_Comm); 122 123 #define VIEWER_DRAW_WORLD_0 \ 124 (ViewerInitializeDrawWorld_Private_0(),VIEWER_DRAW_WORLD_PRIVATE_0) 125 #define VIEWER_DRAW_WORLD_1 \ 126 (ViewerInitializeDrawWorld_Private_1(),VIEWER_DRAW_WORLD_PRIVATE_1) 127 #define VIEWER_DRAW_WORLD_2 \ 128 (ViewerInitializeDrawWorld_Private_2(),VIEWER_DRAW_WORLD_PRIVATE_2) 129 130 #define VIEWER_DRAW_SELF \ 131 (ViewerInitializeDrawSelf_Private(),VIEWER_DRAW_SELF_PRIVATE) 132 #define VIEWER_DRAW_WORLD VIEWER_DRAW_WORLD_0 133 134 #define VIEWER_SOCKET_WORLD \ 135 (ViewerInitializeSocketWorld_Private(),VIEWER_SOCKET_WORLD_PRIVATE) 136 137 /* 138 Viewer based on the ALICE Memory Snooper 139 */ 140 #if defined(HAVE_AMS) 141 #include "ams.h" 142 extern int ViewerAMSGetAMSComm(Viewer,AMS_Comm *); 143 extern int ViewerAMSOpen(MPI_Comm,const char[],Viewer*); 144 extern Viewer VIEWER_AMS_(MPI_Comm); 145 extern int VIEWER_AMS_Destroy(MPI_Comm); 146 extern Viewer VIEWER_AMS_WORLD_PRIVATE; 147 extern int ViewerInitializeAMSWorld_Private(void); 148 #define VIEWER_AMS_WORLD (ViewerInitializeAMSWorld_Private(),VIEWER_AMS_WORLD_PRIVATE) 149 #endif 150 151 /* 152 Viewer utility routines used by PETSc that are not normally used 153 by users. 154 */ 155 extern int ViewerSocketPutScalar_Private(Viewer,int,int,Scalar*); 156 extern int ViewerSocketPutDouble_Private(Viewer,int,int,double*); 157 extern int ViewerSocketPutInt_Private(Viewer,int,int*); 158 extern int ViewerSocketPutSparse_Private(Viewer,int,int,int,Scalar*,int*,int *); 159 extern int ViewerInitializeASCII_Private(void); 160 extern int ViewerDestroyASCII_Private(void); 161 extern int ViewerDestroyDraw_Private(void); 162 extern int ViewerDestroySocket_Private(void); 163 extern int ViewerDestroyAMS_Private(void); 164 165 #endif 166 167