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