1 /* $Id: petscviewer.h,v 1.76 2000/05/10 16:44:25 bsmith Exp bsmith $ */ 2 /* 3 Viewers are objects where other objects can be looked at or stored. 4 */ 5 6 #if !defined(__PETSCVIEWER_H) 7 #define __PETSCVIEWER_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(char*,char*,char*,int(*)(Viewer)); 32 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 33 #define ViewerRegisterDynamic(a,b,c,d) ViewerRegister(a,b,c,0) 34 #else 35 #define ViewerRegisterDynamic(a,b,c,d) ViewerRegister(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 EXTERN int ViewerGetSingleton(Viewer,Viewer*); 54 EXTERN int ViewerRestoreSingleton(Viewer,Viewer*); 55 56 #define VIEWER_FORMAT_ASCII_DEFAULT 0 57 #define VIEWER_FORMAT_ASCII_MATLAB 1 58 #define VIEWER_FORMAT_ASCII_IMPL 2 59 #define VIEWER_FORMAT_ASCII_INFO 3 60 #define VIEWER_FORMAT_ASCII_INFO_LONG 4 61 #define VIEWER_FORMAT_ASCII_COMMON 5 62 #define VIEWER_FORMAT_ASCII_SYMMODU 6 63 #define VIEWER_FORMAT_ASCII_INDEX 7 64 #define VIEWER_FORMAT_ASCII_DENSE 8 65 66 #define VIEWER_FORMAT_BINARY_DEFAULT 9 67 #define VIEWER_FORMAT_BINARY_NATIVE 10 68 69 #define VIEWER_FORMAT_DRAW_BASIC 11 70 #define VIEWER_FORMAT_DRAW_LG 12 71 #define VIEWER_FORMAT_DRAW_CONTOUR 13 72 #define VIEWER_FORMAT_DRAW_PORTS 15 73 74 #define VIEWER_FORMAT_NATIVE 14 75 76 EXTERN int ViewerSetFormat(Viewer,int,char[]); 77 EXTERN int ViewerPushFormat(Viewer,int,char[]); 78 EXTERN int ViewerPopFormat(Viewer); 79 EXTERN int ViewerGetFormat(Viewer,int*); 80 EXTERN int ViewerFlush(Viewer); 81 82 /* 83 Operations explicit to a particular class of viewers 84 */ 85 EXTERN int ViewerASCIIGetPointer(Viewer,FILE**); 86 EXTERN int ViewerASCIIPrintf(Viewer,const char[],...); 87 EXTERN int ViewerASCIISynchronizedPrintf(Viewer,const char[],...); 88 EXTERN int ViewerASCIIPushTab(Viewer); 89 EXTERN int ViewerASCIIPopTab(Viewer); 90 EXTERN int ViewerASCIIUseTabs(Viewer,PetscTruth); 91 EXTERN int ViewerBinaryGetDescriptor(Viewer,int*); 92 EXTERN int ViewerBinaryGetInfoPointer(Viewer,FILE **); 93 EXTERN int ViewerBinarySetType(Viewer,ViewerBinaryType); 94 EXTERN int ViewerStringSPrintf(Viewer,char *,...); 95 EXTERN int ViewerStringSetString(Viewer,char[],int); 96 EXTERN int ViewerDrawClear(Viewer); 97 EXTERN int ViewerDrawSetInfo(Viewer,const char[],const char[],int,int,int,int); 98 EXTERN int ViewerSocketSetConnection(Viewer,const char[],int); 99 100 EXTERN int ViewerSetFilename(Viewer,const char[]); 101 EXTERN int ViewerGetFilename(Viewer,char**); 102 103 /* 104 These are all the default viewers that do not have 105 to be explicitly opened 106 */ 107 EXTERN Viewer VIEWER_STDOUT_(MPI_Comm); 108 EXTERN Viewer VIEWER_STDERR_(MPI_Comm); 109 EXTERN Viewer VIEWER_DRAW_(MPI_Comm); 110 EXTERN Viewer VIEWER_SOCKET_(MPI_Comm); 111 EXTERN Viewer VIEWER_BINARY_(MPI_Comm); 112 113 #define VIEWER_STDOUT_SELF VIEWER_STDOUT_(PETSC_COMM_SELF) 114 #define VIEWER_STDOUT_WORLD VIEWER_STDOUT_(PETSC_COMM_WORLD) 115 #define VIEWER_STDERR_SELF VIEWER_STDERR_(PETSC_COMM_SELF) 116 #define VIEWER_STDERR_WORLD VIEWER_STDERR_(PETSC_COMM_WORLD) 117 #define VIEWER_DRAW_SELF VIEWER_DRAW_(PETSC_COMM_SELF) 118 #define VIEWER_DRAW_WORLD VIEWER_DRAW_(PETSC_COMM_WORLD) 119 #define VIEWER_SOCKET_WORLD VIEWER_SOCKET_(PETSC_COMM_WORLD) 120 #define VIEWER_SOCKET_SELF VIEWER_SOCKET_(PETSC_COMM_SELF) 121 #define VIEWER_BINARY_WORLD VIEWER_BINARY_(PETSC_COMM_WORLD) 122 #define VIEWER_BINARY_SELF VIEWER_BINARY_(PETSC_COMM_SELF) 123 124 /* 125 Viewer based on the ALICE Memory Snooper 126 */ 127 #if defined(PETSC_HAVE_AMS) 128 #include "ams.h" 129 EXTERN int ViewerAMSGetAMSComm(Viewer,AMS_Comm *); 130 EXTERN int ViewerAMSOpen(MPI_Comm,const char[],Viewer*); 131 EXTERN Viewer VIEWER_AMS_(MPI_Comm); 132 EXTERN int VIEWER_AMS_Destroy(MPI_Comm); 133 #define VIEWER_AMS_WORLD VIEWER_AMS_(PETSC_COMM_WORLD) 134 #endif 135 136 /* 137 Viewer utility routines used by PETSc that are not normally used 138 by users. 139 */ 140 EXTERN int ViewerSocketPutScalar(Viewer,int,int,Scalar*); 141 EXTERN int ViewerSocketPutReal(Viewer,int,int,double*); 142 EXTERN int ViewerSocketPutInt(Viewer,int,int*); 143 EXTERN int ViewerSocketPutSparse_Private(Viewer,int,int,int,Scalar*,int*,int *); 144 145 EXTERN int ViewerDestroyAMS_Private(void); 146 147 /* 148 Manages sets of viewers 149 */ 150 typedef struct _p_Viewers* Viewers; 151 EXTERN int ViewersCreate(MPI_Comm,Viewers*); 152 EXTERN int ViewersDestroy(Viewers); 153 EXTERN int ViewersGetViewer(Viewers,int,Viewer*); 154 155 #endif 156 157 158 159 160