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 extern PetscErrorCode PetscDrawSetSave(PetscDraw,const char*); 90 91 /* 92 Number of basic colors in the draw routines, the others are used 93 for a uniform colormap. 94 */ 95 #define PETSC_DRAW_BASIC_COLORS 33 96 97 #define PETSC_DRAW_ROTATE -1 /* will rotate through the colors, start with 2 */ 98 #define PETSC_DRAW_WHITE 0 99 #define PETSC_DRAW_BLACK 1 100 #define PETSC_DRAW_RED 2 101 #define PETSC_DRAW_GREEN 3 102 #define PETSC_DRAW_CYAN 4 103 #define PETSC_DRAW_BLUE 5 104 #define PETSC_DRAW_MAGENTA 6 105 #define PETSC_DRAW_AQUAMARINE 7 106 #define PETSC_DRAW_FORESTGREEN 8 107 #define PETSC_DRAW_ORANGE 9 108 #define PETSC_DRAW_VIOLET 10 109 #define PETSC_DRAW_BROWN 11 110 #define PETSC_DRAW_PINK 12 111 #define PETSC_DRAW_CORAL 13 112 #define PETSC_DRAW_GRAY 14 113 #define PETSC_DRAW_YELLOW 15 114 115 #define PETSC_DRAW_GOLD 16 116 #define PETSC_DRAW_LIGHTPINK 17 117 #define PETSC_DRAW_MEDIUMTURQUOISE 18 118 #define PETSC_DRAW_KHAKI 19 119 #define PETSC_DRAW_DIMGRAY 20 120 #define PETSC_DRAW_YELLOWGREEN 21 121 #define PETSC_DRAW_SKYBLUE 22 122 #define PETSC_DRAW_DARKGREEN 23 123 #define PETSC_DRAW_NAVYBLUE 24 124 #define PETSC_DRAW_SANDYBROWN 25 125 #define PETSC_DRAW_CADETBLUE 26 126 #define PETSC_DRAW_POWDERBLUE 27 127 #define PETSC_DRAW_DEEPPINK 28 128 #define PETSC_DRAW_THISTLE 29 129 #define PETSC_DRAW_LIMEGREEN 30 130 #define PETSC_DRAW_LAVENDERBLUSH 31 131 #define PETSC_DRAW_PLUM 32 132 133 extern PetscErrorCode PetscDrawOpenX(MPI_Comm,const char[],const char[],int,int,int,int,PetscDraw*); 134 extern PetscErrorCode PetscDrawOpenPS(MPI_Comm,char *,PetscDraw *); 135 #define PETSC_DRAW_FULL_SIZE -3 136 #define PETSC_DRAW_HALF_SIZE -4 137 #define PETSC_DRAW_THIRD_SIZE -5 138 #define PETSC_DRAW_QUARTER_SIZE -6 139 140 extern PetscErrorCode PetscDrawOpenNull(MPI_Comm,PetscDraw *); 141 extern PetscErrorCode PetscDrawDestroy(PetscDraw*); 142 extern PetscErrorCode PetscDrawIsNull(PetscDraw,PetscBool *); 143 144 extern PetscErrorCode PetscDrawGetPopup(PetscDraw,PetscDraw*); 145 extern PetscErrorCode PetscDrawCheckResizedWindow(PetscDraw); 146 extern PetscErrorCode PetscDrawResizeWindow(PetscDraw,int,int); 147 148 extern PetscErrorCode PetscDrawScalePopup(PetscDraw,PetscReal,PetscReal); 149 150 extern PetscErrorCode PetscDrawLine(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal,int); 151 extern PetscErrorCode PetscDrawLineSetWidth(PetscDraw,PetscReal); 152 extern PetscErrorCode PetscDrawLineGetWidth(PetscDraw,PetscReal*); 153 154 extern PetscErrorCode PetscDrawPoint(PetscDraw,PetscReal,PetscReal,int); 155 extern PetscErrorCode PetscDrawPointSetSize(PetscDraw,PetscReal); 156 157 extern PetscErrorCode PetscDrawRectangle(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal,int,int,int,int); 158 extern PetscErrorCode PetscDrawTriangle(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,int,int,int); 159 extern PetscErrorCode PetscDrawEllipse(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal,int); 160 extern PetscErrorCode PetscDrawTensorContourPatch(PetscDraw,int,int,PetscReal*,PetscReal*,PetscReal,PetscReal,PetscReal*); 161 extern PetscErrorCode PetscDrawTensorContour(PetscDraw,int,int,const PetscReal[],const PetscReal[],PetscReal *); 162 163 extern PetscErrorCode PetscDrawString(PetscDraw,PetscReal,PetscReal,int,const char[]); 164 extern PetscErrorCode PetscDrawStringVertical(PetscDraw,PetscReal,PetscReal,int,const char[]); 165 extern PetscErrorCode PetscDrawStringSetSize(PetscDraw,PetscReal,PetscReal); 166 extern PetscErrorCode PetscDrawStringGetSize(PetscDraw,PetscReal*,PetscReal*); 167 168 extern PetscErrorCode PetscDrawSetViewPort(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal); 169 extern PetscErrorCode PetscDrawSplitViewPort(PetscDraw); 170 171 extern PetscErrorCode PetscDrawSetCoordinates(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal); 172 extern PetscErrorCode PetscDrawGetCoordinates(PetscDraw,PetscReal*,PetscReal*,PetscReal*,PetscReal*); 173 174 extern PetscErrorCode PetscDrawSetTitle(PetscDraw,const char[]); 175 extern PetscErrorCode PetscDrawAppendTitle(PetscDraw,const char[]); 176 extern PetscErrorCode PetscDrawGetTitle(PetscDraw,char **); 177 178 extern PetscErrorCode PetscDrawSetPause(PetscDraw,PetscReal); 179 extern PetscErrorCode PetscDrawGetPause(PetscDraw,PetscReal*); 180 extern PetscErrorCode PetscDrawPause(PetscDraw); 181 extern PetscErrorCode PetscDrawSetDoubleBuffer(PetscDraw); 182 extern PetscErrorCode PetscDrawFlush(PetscDraw); 183 extern PetscErrorCode PetscDrawSynchronizedFlush(PetscDraw); 184 extern PetscErrorCode PetscDrawClear(PetscDraw); 185 extern PetscErrorCode PetscDrawSave(PetscDraw); 186 extern PetscErrorCode PetscDrawSynchronizedClear(PetscDraw); 187 extern PetscErrorCode PetscDrawBOP(PetscDraw); 188 extern PetscErrorCode PetscDrawEOP(PetscDraw); 189 190 extern PetscErrorCode PetscDrawSetDisplay(PetscDraw,char*); 191 #define PetscDrawSetFilename(a,b) PetscDrawSetDisplay(a,b) 192 193 extern PetscErrorCode PetscDrawGetSingleton(PetscDraw,PetscDraw*); 194 extern PetscErrorCode PetscDrawRestoreSingleton(PetscDraw,PetscDraw*); 195 196 /*E 197 PetscDrawButton - Used to determine which button was pressed 198 199 Level: intermediate 200 201 .seealso: PetscDrawGetMouseButton(), PetscDrawSynchronizedGetMouseButton() 202 E*/ 203 typedef enum {BUTTON_NONE,BUTTON_LEFT,BUTTON_CENTER,BUTTON_RIGHT,BUTTON_LEFT_SHIFT,BUTTON_CENTER_SHIFT,BUTTON_RIGHT_SHIFT} PetscDrawButton; 204 205 extern PetscErrorCode PetscDrawGetMouseButton(PetscDraw,PetscDrawButton *,PetscReal*,PetscReal *,PetscReal *,PetscReal *); 206 extern PetscErrorCode PetscDrawSynchronizedGetMouseButton(PetscDraw,PetscDrawButton *,PetscReal*,PetscReal *,PetscReal *,PetscReal *); 207 208 extern PetscErrorCode PetscDrawZoom(PetscDraw,PetscErrorCode (*)(PetscDraw,void *),void *); 209 210 /*S 211 PetscDrawViewPorts - Subwindows in a PetscDraw object 212 213 Level: intermediate 214 215 Concepts: graphics 216 217 .seealso: PetscDrawViewPortsCreate(), PetscDrawViewPortsSet() 218 S*/ 219 typedef struct { 220 PetscInt nports; 221 PetscReal *xl; 222 PetscReal *xr; 223 PetscReal *yl; 224 PetscReal *yr; 225 PetscDraw draw; 226 } PetscDrawViewPorts; 227 extern PetscErrorCode PetscDrawViewPortsCreate(PetscDraw,PetscInt,PetscDrawViewPorts**); 228 extern PetscErrorCode PetscDrawViewPortsCreateRect(PetscDraw,PetscInt,PetscInt,PetscDrawViewPorts**); 229 extern PetscErrorCode PetscDrawViewPortsDestroy(PetscDrawViewPorts*); 230 extern PetscErrorCode PetscDrawViewPortsSet(PetscDrawViewPorts*,PetscInt); 231 232 /*S 233 PetscDrawAxis - Manages X-Y axis 234 235 Level: advanced 236 237 Concepts: graphics, axis 238 239 .seealso: PetscDrawAxisCreate(), PetscDrawAxisSetLimits(), PetscDrawAxisSetColors(), PetscDrawAxisSetLabels() 240 S*/ 241 typedef struct _p_DrawAxis* PetscDrawAxis; 242 243 extern PetscClassId DRAWAXIS_CLASSID; 244 245 extern PetscErrorCode PetscDrawAxisCreate(PetscDraw,PetscDrawAxis *); 246 extern PetscErrorCode PetscDrawAxisDestroy(PetscDrawAxis*); 247 extern PetscErrorCode PetscDrawAxisDraw(PetscDrawAxis); 248 extern PetscErrorCode PetscDrawAxisSetLimits(PetscDrawAxis,PetscReal,PetscReal,PetscReal,PetscReal); 249 extern PetscErrorCode PetscDrawAxisSetHoldLimits(PetscDrawAxis,PetscBool ); 250 extern PetscErrorCode PetscDrawAxisSetColors(PetscDrawAxis,int,int,int); 251 extern PetscErrorCode PetscDrawAxisSetLabels(PetscDrawAxis,const char[],const char[],const char[]); 252 253 /*S 254 PetscDrawLG - Manages drawing x-y plots 255 256 Level: advanced 257 258 Concepts: graphics, axis 259 260 .seealso: PetscDrawAxisCreate(), PetscDrawLGCreate(), PetscDrawLGAddPoint() 261 S*/ 262 typedef struct _p_DrawLG* PetscDrawLG; 263 264 extern PetscClassId DRAWLG_CLASSID; 265 266 extern PetscErrorCode PetscDrawLGCreate(PetscDraw,int,PetscDrawLG *); 267 extern PetscErrorCode PetscDrawLGDestroy(PetscDrawLG*); 268 extern PetscErrorCode PetscDrawLGAddPoint(PetscDrawLG,PetscReal*,PetscReal*); 269 extern PetscErrorCode PetscDrawLGAddPoints(PetscDrawLG,int,PetscReal**,PetscReal**); 270 extern PetscErrorCode PetscDrawLGDraw(PetscDrawLG); 271 extern PetscErrorCode PetscDrawLGPrint(PetscDrawLG); 272 extern PetscErrorCode PetscDrawLGReset(PetscDrawLG); 273 extern PetscErrorCode PetscDrawLGSetDimension(PetscDrawLG,PetscInt); 274 extern PetscErrorCode PetscDrawLGGetAxis(PetscDrawLG,PetscDrawAxis *); 275 extern PetscErrorCode PetscDrawLGGetDraw(PetscDrawLG,PetscDraw *); 276 extern PetscErrorCode PetscDrawLGIndicateDataPoints(PetscDrawLG); 277 extern PetscErrorCode PetscDrawLGSetLimits(PetscDrawLG,PetscReal,PetscReal,PetscReal,PetscReal); 278 279 /*S 280 PetscDrawSP - Manages drawing scatter plots 281 282 Level: advanced 283 284 Concepts: graphics, scatter plots 285 286 .seealso: PetscDrawSPCreate() 287 S*/ 288 typedef struct _p_DrawSP* PetscDrawSP; 289 290 extern PetscClassId DRAWSP_CLASSID; 291 292 extern PetscErrorCode PetscDrawSPCreate(PetscDraw,int,PetscDrawSP *); 293 extern PetscErrorCode PetscDrawSPDestroy(PetscDrawSP*); 294 extern PetscErrorCode PetscDrawSPAddPoint(PetscDrawSP,PetscReal*,PetscReal*); 295 extern PetscErrorCode PetscDrawSPAddPoints(PetscDrawSP,int,PetscReal**,PetscReal**); 296 extern PetscErrorCode PetscDrawSPDraw(PetscDrawSP); 297 extern PetscErrorCode PetscDrawSPReset(PetscDrawSP); 298 extern PetscErrorCode PetscDrawSPSetDimension(PetscDrawSP,int); 299 extern PetscErrorCode PetscDrawSPGetAxis(PetscDrawSP,PetscDrawAxis *); 300 extern PetscErrorCode PetscDrawSPGetDraw(PetscDrawSP,PetscDraw *); 301 extern PetscErrorCode PetscDrawSPSetLimits(PetscDrawSP,PetscReal,PetscReal,PetscReal,PetscReal); 302 extern PetscErrorCode PetscDrawLGSPDraw(PetscDrawLG,PetscDrawSP); 303 304 /*S 305 PetscDrawHG - Manages drawing histograms 306 307 Level: advanced 308 309 Concepts: graphics, histograms 310 311 .seealso: PetscDrawHGCreate() 312 S*/ 313 typedef struct _p_DrawHG* PetscDrawHG; 314 315 extern PetscClassId DRAWHG_CLASSID; 316 317 extern PetscErrorCode PetscDrawHGCreate(PetscDraw,int,PetscDrawHG *); 318 extern PetscErrorCode PetscDrawHGDestroy(PetscDrawHG*); 319 extern PetscErrorCode PetscDrawHGAddValue(PetscDrawHG,PetscReal); 320 extern PetscErrorCode PetscDrawHGDraw(PetscDrawHG); 321 extern PetscErrorCode PetscDrawHGPrint(PetscDrawHG); 322 extern PetscErrorCode PetscDrawHGReset(PetscDrawHG); 323 extern PetscErrorCode PetscDrawHGGetAxis(PetscDrawHG,PetscDrawAxis *); 324 extern PetscErrorCode PetscDrawHGGetDraw(PetscDrawHG,PetscDraw *); 325 extern PetscErrorCode PetscDrawHGSetLimits(PetscDrawHG,PetscReal,PetscReal,int,int); 326 extern PetscErrorCode PetscDrawHGSetNumberBins(PetscDrawHG,int); 327 extern PetscErrorCode PetscDrawHGSetColor(PetscDrawHG,int); 328 extern PetscErrorCode PetscDrawHGCalcStats(PetscDrawHG, PetscBool ); 329 extern PetscErrorCode PetscDrawHGIntegerBins(PetscDrawHG, PetscBool ); 330 331 /* 332 PetscViewer routines that allow you to access underlying PetscDraw objects 333 */ 334 extern PetscErrorCode PetscViewerDrawGetDraw(PetscViewer,PetscInt,PetscDraw*); 335 extern PetscErrorCode PetscViewerDrawBaseAdd(PetscViewer,PetscInt); 336 extern PetscErrorCode PetscViewerDrawBaseSet(PetscViewer,PetscInt); 337 extern PetscErrorCode PetscViewerDrawGetDrawLG(PetscViewer,PetscInt,PetscDrawLG*); 338 extern PetscErrorCode PetscViewerDrawGetDrawAxis(PetscViewer,PetscInt,PetscDrawAxis*); 339 340 extern PetscErrorCode PetscDrawUtilitySetCmapHue(unsigned char *,unsigned char *,unsigned char *,int); 341 extern PetscErrorCode PetscDrawUtilitySetGamma(PetscReal); 342 343 PETSC_EXTERN_CXX_END 344 #endif 345