1 /* 2 Interface to the PETSc graphics (currently only support for X-windows 3 */ 4 #if !defined(__PETSCDRAW_H) 5 #define __PETSCDRAW_H 6 #include <petscsys.h> 7 8 PETSC_EXTERN PetscClassId PETSC_DRAW_CLASSID; 9 10 /*J 11 PetscDrawType - String with the name of a PetscDraw 12 13 Level: beginner 14 15 .seealso: PetscDrawSetType(), PetscDraw, PetscViewer 16 J*/ 17 #define PetscDrawType char* 18 #define PETSC_DRAW_X "x" 19 #define PETSC_DRAW_GLUT "glut" 20 #define PETSC_DRAW_OPENGLES "opengles" 21 #define PETSC_DRAW_NULL "null" 22 #define PETSC_DRAW_WIN32 "win32" 23 24 /*S 25 PetscDraw - Abstract PETSc object for graphics 26 27 Level: beginner 28 29 Concepts: graphics 30 31 .seealso: PetscDrawCreate(), PetscDrawSetType(), PetscDrawType 32 S*/ 33 typedef struct _p_PetscDraw* PetscDraw; 34 35 PETSC_EXTERN PetscFList PetscDrawList; 36 PETSC_EXTERN PetscErrorCode PetscDrawRegisterAll(const char[]); 37 PETSC_EXTERN PetscErrorCode PetscDrawInitializePackage(const char[]); 38 PETSC_EXTERN PetscErrorCode PetscDrawRegisterDestroy(void); 39 40 PETSC_EXTERN PetscErrorCode PetscDrawRegister(const char*,const char*,const char*,PetscErrorCode(*)(PetscDraw)); 41 42 /*MC 43 PetscDrawRegisterDynamic - Adds a method to the Krylov subspace solver package. 44 45 Synopsis: 46 PetscErrorCode PetscDrawRegisterDynamic(const char *name_solver,const char *path,const char *name_create,PetscErrorCode (*routine_create)(PetscDraw)) 47 48 Not Collective 49 50 Input Parameters: 51 + name_solver - name of a new user-defined solver 52 . path - path (either absolute or relative) the library containing this solver 53 . name_create - name of routine to create method context 54 - routine_create - routine to create method context 55 56 Level: developer 57 58 Notes: 59 PetscDrawRegisterDynamic() may be called multiple times to add several user-defined solvers. 60 61 If dynamic libraries are used, then the fourth input argument (routine_create) 62 is ignored. 63 64 Sample usage: 65 .vb 66 PetscDrawRegisterDynamic("my_draw_type",/home/username/my_lib/lib/libO/solaris/mylib.a, 67 "MyDrawCreate",MyDrawCreate); 68 .ve 69 70 Then, your solver can be chosen with the procedural interface via 71 $ PetscDrawSetType(ksp,"my_draw_type") 72 or at runtime via the option 73 $ -draw_type my_draw_type 74 75 Concepts: graphics^registering new draw classes 76 Concepts: PetscDraw^registering new draw classes 77 78 .seealso: PetscDrawRegisterAll(), PetscDrawRegisterDestroy() 79 M*/ 80 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 81 #define PetscDrawRegisterDynamic(a,b,c,d) PetscDrawRegister(a,b,c,0) 82 #else 83 #define PetscDrawRegisterDynamic(a,b,c,d) PetscDrawRegister(a,b,c,d) 84 #endif 85 86 PETSC_EXTERN PetscErrorCode PetscDrawGetType(PetscDraw,const PetscDrawType*); 87 PETSC_EXTERN PetscErrorCode PetscDrawSetType(PetscDraw,const PetscDrawType); 88 PETSC_EXTERN PetscErrorCode PetscDrawCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscDraw*); 89 PETSC_EXTERN PetscErrorCode PetscDrawSetFromOptions(PetscDraw); 90 PETSC_EXTERN PetscErrorCode PetscDrawSetSave(PetscDraw,const char*,PetscBool); 91 92 /* 93 Number of basic colors in the draw routines, the others are used 94 for a uniform colormap. 95 */ 96 #define PETSC_DRAW_BASIC_COLORS 33 97 98 #define PETSC_DRAW_ROTATE -1 /* will rotate through the colors, start with 2 */ 99 #define PETSC_DRAW_WHITE 0 100 #define PETSC_DRAW_BLACK 1 101 #define PETSC_DRAW_RED 2 102 #define PETSC_DRAW_GREEN 3 103 #define PETSC_DRAW_CYAN 4 104 #define PETSC_DRAW_BLUE 5 105 #define PETSC_DRAW_MAGENTA 6 106 #define PETSC_DRAW_AQUAMARINE 7 107 #define PETSC_DRAW_FORESTGREEN 8 108 #define PETSC_DRAW_ORANGE 9 109 #define PETSC_DRAW_VIOLET 10 110 #define PETSC_DRAW_BROWN 11 111 #define PETSC_DRAW_PINK 12 112 #define PETSC_DRAW_CORAL 13 113 #define PETSC_DRAW_GRAY 14 114 #define PETSC_DRAW_YELLOW 15 115 116 #define PETSC_DRAW_GOLD 16 117 #define PETSC_DRAW_LIGHTPINK 17 118 #define PETSC_DRAW_MEDIUMTURQUOISE 18 119 #define PETSC_DRAW_KHAKI 19 120 #define PETSC_DRAW_DIMGRAY 20 121 #define PETSC_DRAW_YELLOWGREEN 21 122 #define PETSC_DRAW_SKYBLUE 22 123 #define PETSC_DRAW_DARKGREEN 23 124 #define PETSC_DRAW_NAVYBLUE 24 125 #define PETSC_DRAW_SANDYBROWN 25 126 #define PETSC_DRAW_CADETBLUE 26 127 #define PETSC_DRAW_POWDERBLUE 27 128 #define PETSC_DRAW_DEEPPINK 28 129 #define PETSC_DRAW_THISTLE 29 130 #define PETSC_DRAW_LIMEGREEN 30 131 #define PETSC_DRAW_LAVENDERBLUSH 31 132 #define PETSC_DRAW_PLUM 32 133 134 PETSC_EXTERN PetscErrorCode PetscDrawOpenX(MPI_Comm,const char[],const char[],int,int,int,int,PetscDraw*); 135 PETSC_EXTERN PetscErrorCode PetscDrawOpenGLUT(MPI_Comm,const char[],const char[],int,int,int,int,PetscDraw*); 136 137 #define PETSC_DRAW_FULL_SIZE -3 138 #define PETSC_DRAW_HALF_SIZE -4 139 #define PETSC_DRAW_THIRD_SIZE -5 140 #define PETSC_DRAW_QUARTER_SIZE -6 141 142 PETSC_EXTERN PetscErrorCode PetscDrawOpenNull(MPI_Comm,PetscDraw *); 143 PETSC_EXTERN PetscErrorCode PetscDrawDestroy(PetscDraw*); 144 PETSC_EXTERN PetscErrorCode PetscDrawIsNull(PetscDraw,PetscBool *); 145 146 PETSC_EXTERN PetscErrorCode PetscDrawGetPopup(PetscDraw,PetscDraw*); 147 PETSC_EXTERN PetscErrorCode PetscDrawCheckResizedWindow(PetscDraw); 148 PETSC_EXTERN PetscErrorCode PetscDrawResizeWindow(PetscDraw,int,int); 149 150 PETSC_EXTERN PetscErrorCode PetscDrawScalePopup(PetscDraw,PetscReal,PetscReal); 151 152 PETSC_EXTERN PetscErrorCode PetscDrawLine(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal,int); 153 PETSC_EXTERN PetscErrorCode PetscDrawArrow(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal,int); 154 PETSC_EXTERN PetscErrorCode PetscDrawLineSetWidth(PetscDraw,PetscReal); 155 PETSC_EXTERN PetscErrorCode PetscDrawLineGetWidth(PetscDraw,PetscReal*); 156 157 PETSC_EXTERN PetscErrorCode PetscDrawPoint(PetscDraw,PetscReal,PetscReal,int); 158 PETSC_EXTERN PetscErrorCode PetscDrawPointSetSize(PetscDraw,PetscReal); 159 160 PETSC_EXTERN PetscErrorCode PetscDrawRectangle(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal,int,int,int,int); 161 PETSC_EXTERN PetscErrorCode PetscDrawTriangle(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,int,int,int); 162 PETSC_EXTERN PetscErrorCode PetscDrawEllipse(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal,int); 163 PETSC_EXTERN PetscErrorCode PetscDrawTensorContourPatch(PetscDraw,int,int,PetscReal*,PetscReal*,PetscReal,PetscReal,PetscReal*); 164 PETSC_EXTERN PetscErrorCode PetscDrawTensorContour(PetscDraw,int,int,const PetscReal[],const PetscReal[],PetscReal *); 165 166 PETSC_EXTERN PetscErrorCode PetscDrawString(PetscDraw,PetscReal,PetscReal,int,const char[]); 167 PETSC_EXTERN PetscErrorCode PetscDrawStringVertical(PetscDraw,PetscReal,PetscReal,int,const char[]); 168 PETSC_EXTERN PetscErrorCode PetscDrawStringSetSize(PetscDraw,PetscReal,PetscReal); 169 PETSC_EXTERN PetscErrorCode PetscDrawStringGetSize(PetscDraw,PetscReal*,PetscReal*); 170 171 PETSC_EXTERN PetscErrorCode PetscDrawSetViewPort(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal); 172 PETSC_EXTERN PetscErrorCode PetscDrawGetViewPort(PetscDraw,PetscReal*,PetscReal*,PetscReal*,PetscReal*); 173 PETSC_EXTERN PetscErrorCode PetscDrawSplitViewPort(PetscDraw); 174 175 PETSC_EXTERN PetscErrorCode PetscDrawSetCoordinates(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal); 176 PETSC_EXTERN PetscErrorCode PetscDrawGetCoordinates(PetscDraw,PetscReal*,PetscReal*,PetscReal*,PetscReal*); 177 178 PETSC_EXTERN PetscErrorCode PetscDrawSetTitle(PetscDraw,const char[]); 179 PETSC_EXTERN PetscErrorCode PetscDrawAppendTitle(PetscDraw,const char[]); 180 PETSC_EXTERN PetscErrorCode PetscDrawGetTitle(PetscDraw,char **); 181 182 PETSC_EXTERN PetscErrorCode PetscDrawSetPause(PetscDraw,PetscReal); 183 PETSC_EXTERN PetscErrorCode PetscDrawGetPause(PetscDraw,PetscReal*); 184 PETSC_EXTERN PetscErrorCode PetscDrawPause(PetscDraw); 185 PETSC_EXTERN PetscErrorCode PetscDrawSetDoubleBuffer(PetscDraw); 186 PETSC_EXTERN PetscErrorCode PetscDrawFlush(PetscDraw); 187 PETSC_EXTERN PetscErrorCode PetscDrawSynchronizedFlush(PetscDraw); 188 PETSC_EXTERN PetscErrorCode PetscDrawClear(PetscDraw); 189 PETSC_EXTERN PetscErrorCode PetscDrawSave(PetscDraw); 190 PETSC_EXTERN PetscErrorCode PetscDrawSynchronizedClear(PetscDraw); 191 PETSC_EXTERN PetscErrorCode PetscDrawBOP(PetscDraw); 192 PETSC_EXTERN PetscErrorCode PetscDrawEOP(PetscDraw); 193 194 PETSC_EXTERN PetscErrorCode PetscDrawSetDisplay(PetscDraw,char*); 195 #define PetscDrawSetFilename(a,b) PetscDrawSetDisplay(a,b) 196 197 PETSC_EXTERN PetscErrorCode PetscDrawGetSingleton(PetscDraw,PetscDraw*); 198 PETSC_EXTERN PetscErrorCode PetscDrawRestoreSingleton(PetscDraw,PetscDraw*); 199 200 /*E 201 PetscDrawButton - Used to determine which button was pressed 202 203 Level: intermediate 204 205 .seealso: PetscDrawGetMouseButton(), PetscDrawSynchronizedGetMouseButton() 206 E*/ 207 typedef enum {PETSC_BUTTON_NONE,PETSC_BUTTON_LEFT,PETSC_BUTTON_CENTER,PETSC_BUTTON_RIGHT,PETSC_BUTTON_LEFT_SHIFT,PETSC_BUTTON_CENTER_SHIFT,PETSC_BUTTON_RIGHT_SHIFT} PetscDrawButton; 208 209 PETSC_EXTERN PetscErrorCode PetscDrawGetMouseButton(PetscDraw,PetscDrawButton *,PetscReal*,PetscReal *,PetscReal *,PetscReal *); 210 PETSC_EXTERN PetscErrorCode PetscDrawSynchronizedGetMouseButton(PetscDraw,PetscDrawButton *,PetscReal*,PetscReal *,PetscReal *,PetscReal *); 211 212 PETSC_EXTERN PetscErrorCode PetscDrawZoom(PetscDraw,PetscErrorCode (*)(PetscDraw,void *),void *); 213 214 /*S 215 PetscDrawViewPorts - Subwindows in a PetscDraw object 216 217 Level: intermediate 218 219 Concepts: graphics 220 221 .seealso: PetscDrawViewPortsCreate(), PetscDrawViewPortsSet() 222 S*/ 223 typedef struct { 224 PetscInt nports; 225 PetscReal *xl; 226 PetscReal *xr; 227 PetscReal *yl; 228 PetscReal *yr; 229 PetscDraw draw; 230 PetscReal port_xl,port_yl,port_xr,port_yr; /* original port of parent PetscDraw */ 231 232 } PetscDrawViewPorts; 233 PETSC_EXTERN PetscErrorCode PetscDrawViewPortsCreate(PetscDraw,PetscInt,PetscDrawViewPorts**); 234 PETSC_EXTERN PetscErrorCode PetscDrawViewPortsCreateRect(PetscDraw,PetscInt,PetscInt,PetscDrawViewPorts**); 235 PETSC_EXTERN PetscErrorCode PetscDrawViewPortsDestroy(PetscDrawViewPorts*); 236 PETSC_EXTERN PetscErrorCode PetscDrawViewPortsSet(PetscDrawViewPorts*,PetscInt); 237 238 /*S 239 PetscDrawAxis - Manages X-Y axis 240 241 Level: advanced 242 243 Concepts: graphics, axis 244 245 .seealso: PetscDrawAxisCreate(), PetscDrawAxisSetLimits(), PetscDrawAxisSetColors(), PetscDrawAxisSetLabels() 246 S*/ 247 typedef struct _p_PetscDrawAxis* PetscDrawAxis; 248 249 PETSC_EXTERN PetscClassId PETSC_DRAWAXIS_CLASSID; 250 251 PETSC_EXTERN PetscErrorCode PetscDrawAxisCreate(PetscDraw,PetscDrawAxis *); 252 PETSC_EXTERN PetscErrorCode PetscDrawAxisDestroy(PetscDrawAxis*); 253 PETSC_EXTERN PetscErrorCode PetscDrawAxisDraw(PetscDrawAxis); 254 PETSC_EXTERN PetscErrorCode PetscDrawAxisSetLimits(PetscDrawAxis,PetscReal,PetscReal,PetscReal,PetscReal); 255 PETSC_EXTERN PetscErrorCode PetscDrawAxisSetHoldLimits(PetscDrawAxis,PetscBool ); 256 PETSC_EXTERN PetscErrorCode PetscDrawAxisSetColors(PetscDrawAxis,int,int,int); 257 PETSC_EXTERN PetscErrorCode PetscDrawAxisSetLabels(PetscDrawAxis,const char[],const char[],const char[]); 258 259 /*S 260 PetscDrawLG - Manages drawing x-y plots 261 262 Level: advanced 263 264 Concepts: graphics, axis 265 266 .seealso: PetscDrawAxisCreate(), PetscDrawLGCreate(), PetscDrawLGAddPoint() 267 S*/ 268 typedef struct _p_PetscDrawLG* PetscDrawLG; 269 270 PETSC_EXTERN PetscClassId PETSC_DRAWLG_CLASSID; 271 272 PETSC_EXTERN PetscErrorCode PetscDrawLGCreate(PetscDraw,int,PetscDrawLG *); 273 PETSC_EXTERN PetscErrorCode PetscDrawLGDestroy(PetscDrawLG*); 274 PETSC_EXTERN PetscErrorCode PetscDrawLGAddPoint(PetscDrawLG,PetscReal*,PetscReal*); 275 PETSC_EXTERN PetscErrorCode PetscDrawLGAddPoints(PetscDrawLG,int,PetscReal**,PetscReal**); 276 PETSC_EXTERN PetscErrorCode PetscDrawLGDraw(PetscDrawLG); 277 PETSC_EXTERN PetscErrorCode PetscDrawLGPrint(PetscDrawLG); 278 PETSC_EXTERN PetscErrorCode PetscDrawLGReset(PetscDrawLG); 279 PETSC_EXTERN PetscErrorCode PetscDrawLGSetDimension(PetscDrawLG,PetscInt); 280 PETSC_EXTERN PetscErrorCode PetscDrawLGSetLegend(PetscDrawLG,const char *const*); 281 PETSC_EXTERN PetscErrorCode PetscDrawLGGetAxis(PetscDrawLG,PetscDrawAxis *); 282 PETSC_EXTERN PetscErrorCode PetscDrawLGGetDraw(PetscDrawLG,PetscDraw *); 283 PETSC_EXTERN PetscErrorCode PetscDrawLGIndicateDataPoints(PetscDrawLG); 284 PETSC_EXTERN PetscErrorCode PetscDrawLGSetLimits(PetscDrawLG,PetscReal,PetscReal,PetscReal,PetscReal); 285 PETSC_EXTERN PetscErrorCode PetscDrawLGSetColors(PetscDrawLG,const int*); 286 287 /*S 288 PetscDrawSP - Manages drawing scatter plots 289 290 Level: advanced 291 292 Concepts: graphics, scatter plots 293 294 .seealso: PetscDrawSPCreate() 295 S*/ 296 typedef struct _p_PetscDrawSP* PetscDrawSP; 297 298 PETSC_EXTERN PetscClassId PETSC_DRAWSP_CLASSID; 299 300 PETSC_EXTERN PetscErrorCode PetscDrawSPCreate(PetscDraw,int,PetscDrawSP *); 301 PETSC_EXTERN PetscErrorCode PetscDrawSPDestroy(PetscDrawSP*); 302 PETSC_EXTERN PetscErrorCode PetscDrawSPAddPoint(PetscDrawSP,PetscReal*,PetscReal*); 303 PETSC_EXTERN PetscErrorCode PetscDrawSPAddPoints(PetscDrawSP,int,PetscReal**,PetscReal**); 304 PETSC_EXTERN PetscErrorCode PetscDrawSPDraw(PetscDrawSP); 305 PETSC_EXTERN PetscErrorCode PetscDrawSPReset(PetscDrawSP); 306 PETSC_EXTERN PetscErrorCode PetscDrawSPSetDimension(PetscDrawSP,int); 307 PETSC_EXTERN PetscErrorCode PetscDrawSPGetAxis(PetscDrawSP,PetscDrawAxis *); 308 PETSC_EXTERN PetscErrorCode PetscDrawSPGetDraw(PetscDrawSP,PetscDraw *); 309 PETSC_EXTERN PetscErrorCode PetscDrawSPSetLimits(PetscDrawSP,PetscReal,PetscReal,PetscReal,PetscReal); 310 PETSC_EXTERN PetscErrorCode PetscDrawLGSPDraw(PetscDrawLG,PetscDrawSP); 311 312 /*S 313 PetscDrawHG - Manages drawing histograms 314 315 Level: advanced 316 317 Concepts: graphics, histograms 318 319 .seealso: PetscDrawHGCreate() 320 S*/ 321 typedef struct _p_PetscDrawHG* PetscDrawHG; 322 323 PETSC_EXTERN PetscClassId PETSC_DRAWHG_CLASSID; 324 325 PETSC_EXTERN PetscErrorCode PetscDrawHGCreate(PetscDraw,int,PetscDrawHG *); 326 PETSC_EXTERN PetscErrorCode PetscDrawHGDestroy(PetscDrawHG*); 327 PETSC_EXTERN PetscErrorCode PetscDrawHGAddValue(PetscDrawHG,PetscReal); 328 PETSC_EXTERN PetscErrorCode PetscDrawHGDraw(PetscDrawHG); 329 PETSC_EXTERN PetscErrorCode PetscDrawHGPrint(PetscDrawHG); 330 PETSC_EXTERN PetscErrorCode PetscDrawHGReset(PetscDrawHG); 331 PETSC_EXTERN PetscErrorCode PetscDrawHGGetAxis(PetscDrawHG,PetscDrawAxis *); 332 PETSC_EXTERN PetscErrorCode PetscDrawHGGetDraw(PetscDrawHG,PetscDraw *); 333 PETSC_EXTERN PetscErrorCode PetscDrawHGSetLimits(PetscDrawHG,PetscReal,PetscReal,int,int); 334 PETSC_EXTERN PetscErrorCode PetscDrawHGSetNumberBins(PetscDrawHG,int); 335 PETSC_EXTERN PetscErrorCode PetscDrawHGSetColor(PetscDrawHG,int); 336 PETSC_EXTERN PetscErrorCode PetscDrawHGCalcStats(PetscDrawHG, PetscBool ); 337 PETSC_EXTERN PetscErrorCode PetscDrawHGIntegerBins(PetscDrawHG, PetscBool ); 338 339 /* 340 PetscViewer routines that allow you to access underlying PetscDraw objects 341 */ 342 PETSC_EXTERN PetscErrorCode PetscViewerDrawGetDraw(PetscViewer,PetscInt,PetscDraw*); 343 PETSC_EXTERN PetscErrorCode PetscViewerDrawBaseAdd(PetscViewer,PetscInt); 344 PETSC_EXTERN PetscErrorCode PetscViewerDrawBaseSet(PetscViewer,PetscInt); 345 PETSC_EXTERN PetscErrorCode PetscViewerDrawGetDrawLG(PetscViewer,PetscInt,PetscDrawLG*); 346 PETSC_EXTERN PetscErrorCode PetscViewerDrawGetDrawAxis(PetscViewer,PetscInt,PetscDrawAxis*); 347 348 PETSC_EXTERN PetscErrorCode PetscDrawUtilitySetCmapHue(unsigned char *,unsigned char *,unsigned char *,int); 349 PETSC_EXTERN PetscErrorCode PetscDrawUtilitySetGamma(PetscReal); 350 351 #endif 352