xref: /petsc/include/petscdraw.h (revision bb5b24f58d6a1ffb5e6df85fcf5defc57450a95a)
1 /*
2   Interface to the PETSc graphics
3 */
4 #ifndef PETSCDRAW_H
5 #define PETSCDRAW_H
6 #include <petscsys.h>
7 #include <petscdrawtypes.h>
8 
9 /* SUBMANSEC = Sys */
10 
11 PETSC_EXTERN PetscClassId PETSC_DRAW_CLASSID;
12 
13 PETSC_EXTERN PetscFunctionList PetscDrawList;
14 PETSC_EXTERN PetscErrorCode    PetscDrawInitializePackage(void);
15 PETSC_EXTERN PetscErrorCode    PetscDrawFinalizePackage(void);
16 PETSC_EXTERN PetscErrorCode    PetscDrawRegister(const char[], PetscErrorCode (*)(PetscDraw));
17 
18 PETSC_EXTERN PetscErrorCode PetscDrawGetType(PetscDraw, PetscDrawType *);
19 PETSC_EXTERN PetscErrorCode PetscDrawSetType(PetscDraw, PetscDrawType);
20 PETSC_EXTERN PetscErrorCode PetscDrawCreate(MPI_Comm, const char[], const char[], int, int, int, int, PetscDraw *);
21 PETSC_EXTERN PetscErrorCode PetscDrawSetOptionsPrefix(PetscDraw, const char[]);
22 PETSC_EXTERN PetscErrorCode PetscDrawSetFromOptions(PetscDraw);
23 PETSC_EXTERN PetscErrorCode PetscDrawSetSave(PetscDraw, const char[]);
24 PETSC_EXTERN PetscErrorCode PetscDrawSetSaveMovie(PetscDraw, const char[]);
25 PETSC_EXTERN PetscErrorCode PetscDrawSetSaveFinalImage(PetscDraw, const char[]);
26 PETSC_EXTERN PetscErrorCode PetscDrawView(PetscDraw, PetscViewer);
27 PETSC_EXTERN PetscErrorCode PetscDrawViewFromOptions(PetscDraw, PetscObject, const char[]);
28 
29 /*
30    Number of basic colors in the draw routines, the others are used
31    for a uniform colormap.
32 */
33 #define PETSC_DRAW_BASIC_COLORS 33
34 
35 #define PETSC_DRAW_ROTATE      -1 /* will rotate through the colors, start with 2 */
36 #define PETSC_DRAW_WHITE       0
37 #define PETSC_DRAW_BLACK       1
38 #define PETSC_DRAW_RED         2
39 #define PETSC_DRAW_GREEN       3
40 #define PETSC_DRAW_CYAN        4
41 #define PETSC_DRAW_BLUE        5
42 #define PETSC_DRAW_MAGENTA     6
43 #define PETSC_DRAW_AQUAMARINE  7
44 #define PETSC_DRAW_FORESTGREEN 8
45 #define PETSC_DRAW_ORANGE      9
46 #define PETSC_DRAW_VIOLET      10
47 #define PETSC_DRAW_BROWN       11
48 #define PETSC_DRAW_PINK        12
49 #define PETSC_DRAW_CORAL       13
50 #define PETSC_DRAW_GRAY        14
51 #define PETSC_DRAW_YELLOW      15
52 
53 #define PETSC_DRAW_GOLD            16
54 #define PETSC_DRAW_LIGHTPINK       17
55 #define PETSC_DRAW_MEDIUMTURQUOISE 18
56 #define PETSC_DRAW_KHAKI           19
57 #define PETSC_DRAW_DIMGRAY         20
58 #define PETSC_DRAW_YELLOWGREEN     21
59 #define PETSC_DRAW_SKYBLUE         22
60 #define PETSC_DRAW_DARKGREEN       23
61 #define PETSC_DRAW_NAVYBLUE        24
62 #define PETSC_DRAW_SANDYBROWN      25
63 #define PETSC_DRAW_CADETBLUE       26
64 #define PETSC_DRAW_POWDERBLUE      27
65 #define PETSC_DRAW_DEEPPINK        28
66 #define PETSC_DRAW_THISTLE         29
67 #define PETSC_DRAW_LIMEGREEN       30
68 #define PETSC_DRAW_LAVENDERBLUSH   31
69 #define PETSC_DRAW_PLUM            32
70 #define PETSC_DRAW_MAXCOLOR        256
71 
72 /*MC
73 
74    PetscDrawRealToColor - Maps a real value within an interval to a color.
75    The color is an integer value in the range [`PETSC_DRAW_BASIC_COLORS` to 255]
76    that can be passed to various drawing routines.
77 
78    Synopsis:
79    #include <petscdraw.h>
80    int PetscDrawRealToColor(PetscReal value,PetscReal min,PetscReal max)
81 
82    Not Collective
83 
84    Input Parameters:
85 +  value - value to map within the interval [min,max]
86 .  min - lower end of interval
87 -  max - upper end of interval
88 
89    Note:
90    Values outside the interval [min,max] are clipped.
91 
92    Level: intermediate
93 
94 .seealso: `PetscDrawPointPixel()`, `PetscDrawPoint()`, `PetscDrawLine()`, `PetscDrawTriangle()`, `PetscDrawRectangle()`
95 
96 M*/
97 static inline int PetscDrawRealToColor(PetscReal value, PetscReal min, PetscReal max)
98 {
99   value = PetscClipInterval(value, min, max);
100   return PETSC_DRAW_BASIC_COLORS + (int)((255 - PETSC_DRAW_BASIC_COLORS) * (value - min) / (max - min));
101 }
102 
103 PETSC_EXTERN PetscErrorCode PetscDrawOpenX(MPI_Comm, const char[], const char[], int, int, int, int, PetscDraw *);
104 
105 #define PETSC_DRAW_FULL_SIZE    -3
106 #define PETSC_DRAW_HALF_SIZE    -4
107 #define PETSC_DRAW_THIRD_SIZE   -5
108 #define PETSC_DRAW_QUARTER_SIZE -6
109 
110 PETSC_EXTERN PetscErrorCode PetscDrawOpenImage(MPI_Comm, const char[], int, int, PetscDraw *);
111 PETSC_EXTERN PetscErrorCode PetscDrawOpenNull(MPI_Comm, PetscDraw *);
112 PETSC_EXTERN PetscErrorCode PetscDrawDestroy(PetscDraw *);
113 PETSC_EXTERN PetscErrorCode PetscDrawIsNull(PetscDraw, PetscBool *);
114 
115 PETSC_EXTERN PetscErrorCode PetscDrawGetPopup(PetscDraw, PetscDraw *);
116 PETSC_EXTERN PetscErrorCode PetscDrawScalePopup(PetscDraw, PetscReal, PetscReal);
117 
118 PETSC_EXTERN PetscErrorCode PetscDrawCheckResizedWindow(PetscDraw);
119 PETSC_EXTERN PetscErrorCode PetscDrawResizeWindow(PetscDraw, int, int);
120 PETSC_EXTERN PetscErrorCode PetscDrawGetWindowSize(PetscDraw, int *, int *);
121 PETSC_EXTERN PetscErrorCode PetscDrawPixelToCoordinate(PetscDraw, int, int, PetscReal *, PetscReal *);
122 PETSC_EXTERN PetscErrorCode PetscDrawCoordinateToPixel(PetscDraw, PetscReal, PetscReal, int *, int *);
123 
124 PETSC_EXTERN PetscErrorCode PetscDrawIndicatorFunction(PetscDraw, PetscReal, PetscReal, PetscReal, PetscReal, int, PetscErrorCode (*)(void *, PetscReal, PetscReal, PetscBool *), void *);
125 
126 PETSC_EXTERN PetscErrorCode PetscDrawLine(PetscDraw, PetscReal, PetscReal, PetscReal, PetscReal, int);
127 PETSC_EXTERN PetscErrorCode PetscDrawArrow(PetscDraw, PetscReal, PetscReal, PetscReal, PetscReal, int);
128 PETSC_EXTERN PetscErrorCode PetscDrawLineSetWidth(PetscDraw, PetscReal);
129 PETSC_EXTERN PetscErrorCode PetscDrawLineGetWidth(PetscDraw, PetscReal *);
130 
131 /*E
132     PetscDrawMarkerType - How a "mark" is indicate in a figure
133 
134    Level: intermediate
135 
136 $  `PETSC_MARKER_CROSS` - a small pixel based x symbol or the character x if that is not available
137 $  `PETSC_MARKER_PLUS` - a small pixel based + symbol or the character + if that is not available
138 $  `PETSC_MARKER_CIRCLE` - a small pixel based circle symbol or the character o if that is not available
139 $  `PETSC_MARKER_POINT` - the make obtained with PetscDrawPoint()
140 
141 .seealso: `PetscDrawMarker()`, `PetscDrawSetMarkerType()`
142 E*/
143 typedef enum {
144   PETSC_DRAW_MARKER_CROSS,
145   PETSC_DRAW_MARKER_POINT,
146   PETSC_DRAW_MARKER_PLUS,
147   PETSC_DRAW_MARKER_CIRCLE
148 } PetscDrawMarkerType;
149 PETSC_EXTERN const char *const PetscDrawMarkerTypes[];
150 
151 PETSC_EXTERN PetscErrorCode PetscDrawMarker(PetscDraw, PetscReal, PetscReal, int);
152 PETSC_EXTERN PetscErrorCode PetscDrawSetMarkerType(PetscDraw, PetscDrawMarkerType);
153 PETSC_EXTERN PetscErrorCode PetscDrawGetMarkerType(PetscDraw, PetscDrawMarkerType *);
154 
155 PETSC_EXTERN PetscErrorCode PetscDrawPoint(PetscDraw, PetscReal, PetscReal, int);
156 PETSC_EXTERN PetscErrorCode PetscDrawPointPixel(PetscDraw, int, int, int);
157 PETSC_EXTERN PetscErrorCode PetscDrawPointSetSize(PetscDraw, PetscReal);
158 
159 PETSC_EXTERN PetscErrorCode PetscDrawRectangle(PetscDraw, PetscReal, PetscReal, PetscReal, PetscReal, int, int, int, int);
160 PETSC_EXTERN PetscErrorCode PetscDrawTriangle(PetscDraw, PetscReal, PetscReal, PetscReal, PetscReal, PetscReal, PetscReal, int, int, int);
161 PETSC_EXTERN PetscErrorCode PetscDrawEllipse(PetscDraw, PetscReal, PetscReal, PetscReal, PetscReal, int);
162 PETSC_EXTERN PetscErrorCode PetscDrawTensorContourPatch(PetscDraw, int, int, PetscReal *, PetscReal *, PetscReal, PetscReal, PetscReal *);
163 PETSC_EXTERN PetscErrorCode PetscDrawTensorContour(PetscDraw, int, int, const PetscReal[], const PetscReal[], PetscReal *);
164 
165 PETSC_EXTERN PetscErrorCode PetscDrawString(PetscDraw, PetscReal, PetscReal, int, const char[]);
166 PETSC_EXTERN PetscErrorCode PetscDrawStringCentered(PetscDraw, PetscReal, PetscReal, int, const char[]);
167 PETSC_EXTERN PetscErrorCode PetscDrawStringBoxed(PetscDraw, PetscReal, PetscReal, int, int, const char[], PetscReal *, PetscReal *);
168 PETSC_EXTERN PetscErrorCode PetscDrawStringVertical(PetscDraw, PetscReal, PetscReal, int, const char[]);
169 PETSC_EXTERN PetscErrorCode PetscDrawStringSetSize(PetscDraw, PetscReal, PetscReal);
170 PETSC_EXTERN PetscErrorCode PetscDrawStringGetSize(PetscDraw, PetscReal *, PetscReal *);
171 
172 PETSC_EXTERN PetscErrorCode PetscDrawSetViewPort(PetscDraw, PetscReal, PetscReal, PetscReal, PetscReal);
173 PETSC_EXTERN PetscErrorCode PetscDrawGetViewPort(PetscDraw, PetscReal *, PetscReal *, PetscReal *, PetscReal *);
174 PETSC_EXTERN PetscErrorCode PetscDrawSplitViewPort(PetscDraw);
175 
176 PETSC_EXTERN PetscErrorCode PetscDrawSetCoordinates(PetscDraw, PetscReal, PetscReal, PetscReal, PetscReal);
177 PETSC_EXTERN PetscErrorCode PetscDrawGetCoordinates(PetscDraw, PetscReal *, PetscReal *, PetscReal *, PetscReal *);
178 
179 PETSC_EXTERN PetscErrorCode PetscDrawSetTitle(PetscDraw, const char[]);
180 PETSC_EXTERN PetscErrorCode PetscDrawAppendTitle(PetscDraw, const char[]);
181 PETSC_EXTERN PetscErrorCode PetscDrawGetTitle(PetscDraw, const char *[]);
182 
183 PETSC_EXTERN PetscErrorCode PetscDrawSetPause(PetscDraw, PetscReal);
184 PETSC_EXTERN PetscErrorCode PetscDrawGetPause(PetscDraw, PetscReal *);
185 PETSC_EXTERN PetscErrorCode PetscDrawPause(PetscDraw);
186 PETSC_EXTERN PetscErrorCode PetscDrawSetDoubleBuffer(PetscDraw);
187 PETSC_EXTERN PetscErrorCode PetscDrawClear(PetscDraw);
188 PETSC_EXTERN PetscErrorCode PetscDrawFlush(PetscDraw);
189 PETSC_EXTERN PetscErrorCode PetscDrawSave(PetscDraw);
190 PETSC_EXTERN PetscErrorCode PetscDrawSaveMovie(PetscDraw);
191 PETSC_EXTERN PetscErrorCode PetscDrawBOP(PetscDraw);
192 PETSC_EXTERN PetscErrorCode PetscDrawEOP(PetscDraw);
193 
194 PETSC_EXTERN PetscErrorCode PetscDrawSetDisplay(PetscDraw, const char[]);
195 PETSC_EXTERN PetscErrorCode PetscDrawGetSingleton(PetscDraw, PetscDraw *);
196 PETSC_EXTERN PetscErrorCode PetscDrawRestoreSingleton(PetscDraw, PetscDraw *);
197 
198 PETSC_EXTERN PetscErrorCode PetscDrawGetCurrentPoint(PetscDraw, PetscReal *, PetscReal *);
199 PETSC_EXTERN PetscErrorCode PetscDrawSetCurrentPoint(PetscDraw, PetscReal, PetscReal);
200 PETSC_EXTERN PetscErrorCode PetscDrawPushCurrentPoint(PetscDraw, PetscReal, PetscReal);
201 PETSC_EXTERN PetscErrorCode PetscDrawPopCurrentPoint(PetscDraw);
202 PETSC_EXTERN PetscErrorCode PetscDrawGetBoundingBox(PetscDraw, PetscReal *, PetscReal *, PetscReal *, PetscReal *);
203 
204 PETSC_EXTERN PetscErrorCode PetscDrawSetVisible(PetscDraw, PetscBool);
205 
206 /*E
207     PetscDrawButton - Used to determine which button was pressed
208 
209    Level: intermediate
210 
211 .seealso: `PetscDrawGetMouseButton()`
212 E*/
213 typedef enum {
214   PETSC_BUTTON_NONE = 0,
215   PETSC_BUTTON_LEFT,
216   PETSC_BUTTON_CENTER,
217   PETSC_BUTTON_RIGHT,
218   PETSC_BUTTON_WHEEL_UP,
219   PETSC_BUTTON_WHEEL_DOWN,
220   PETSC_BUTTON_LEFT_SHIFT,
221   PETSC_BUTTON_CENTER_SHIFT,
222   PETSC_BUTTON_RIGHT_SHIFT
223 } PetscDrawButton;
224 
225 PETSC_EXTERN PetscErrorCode PetscDrawGetMouseButton(PetscDraw, PetscDrawButton *, PetscReal *, PetscReal *, PetscReal *, PetscReal *);
226 
227 PETSC_EXTERN PetscErrorCode PetscDrawZoom(PetscDraw, PetscErrorCode (*)(PetscDraw, void *), void *);
228 
229 /*S
230      PetscDrawViewPorts - Subwindows in a `PetscDraw` object
231 
232    Level: intermediate
233 
234 .seealso: `PetscDrawViewPortsCreate()`, `PetscDrawViewPortsSet()`
235 S*/
236 typedef struct {
237   PetscInt   nports;
238   PetscReal *xl;
239   PetscReal *xr;
240   PetscReal *yl;
241   PetscReal *yr;
242   PetscDraw  draw;
243   PetscReal  port_xl, port_yl, port_xr, port_yr; /* original port of parent PetscDraw */
244 } PetscDrawViewPorts;
245 PETSC_EXTERN PetscErrorCode PetscDrawViewPortsCreate(PetscDraw, PetscInt, PetscDrawViewPorts **);
246 PETSC_EXTERN PetscErrorCode PetscDrawViewPortsCreateRect(PetscDraw, PetscInt, PetscInt, PetscDrawViewPorts **);
247 PETSC_EXTERN PetscErrorCode PetscDrawViewPortsDestroy(PetscDrawViewPorts *);
248 PETSC_EXTERN PetscErrorCode PetscDrawViewPortsSet(PetscDrawViewPorts *, PetscInt);
249 
250 PETSC_EXTERN PetscClassId PETSC_DRAWAXIS_CLASSID;
251 
252 PETSC_EXTERN PetscErrorCode PetscDrawAxisCreate(PetscDraw, PetscDrawAxis *);
253 PETSC_EXTERN PetscErrorCode PetscDrawAxisDestroy(PetscDrawAxis *);
254 PETSC_EXTERN PetscErrorCode PetscDrawAxisDraw(PetscDrawAxis);
255 PETSC_EXTERN PetscErrorCode PetscDrawAxisSetLimits(PetscDrawAxis, PetscReal, PetscReal, PetscReal, PetscReal);
256 PETSC_EXTERN PetscErrorCode PetscDrawAxisGetLimits(PetscDrawAxis, PetscReal *, PetscReal *, PetscReal *, PetscReal *);
257 PETSC_EXTERN PetscErrorCode PetscDrawAxisSetHoldLimits(PetscDrawAxis, PetscBool);
258 PETSC_EXTERN PetscErrorCode PetscDrawAxisSetColors(PetscDrawAxis, int, int, int);
259 PETSC_EXTERN PetscErrorCode PetscDrawAxisSetLabels(PetscDrawAxis, const char[], const char[], const char[]);
260 
261 PETSC_EXTERN PetscClassId PETSC_DRAWLG_CLASSID;
262 
263 PETSC_EXTERN PetscErrorCode PetscDrawLGCreate(PetscDraw, PetscInt, PetscDrawLG *);
264 PETSC_EXTERN PetscErrorCode PetscDrawLGDestroy(PetscDrawLG *);
265 PETSC_EXTERN PetscErrorCode PetscDrawLGAddPoint(PetscDrawLG, const PetscReal *, const PetscReal *);
266 PETSC_EXTERN PetscErrorCode PetscDrawLGAddCommonPoint(PetscDrawLG, const PetscReal, const PetscReal *);
267 PETSC_EXTERN PetscErrorCode PetscDrawLGAddPoints(PetscDrawLG, PetscInt, PetscReal **, PetscReal **);
268 PETSC_EXTERN PetscErrorCode PetscDrawLGDraw(PetscDrawLG);
269 PETSC_EXTERN PetscErrorCode PetscDrawLGSave(PetscDrawLG);
270 PETSC_EXTERN PetscErrorCode PetscDrawLGView(PetscDrawLG, PetscViewer);
271 PETSC_EXTERN PetscErrorCode PetscDrawLGReset(PetscDrawLG);
272 PETSC_EXTERN PetscErrorCode PetscDrawLGSetDimension(PetscDrawLG, PetscInt);
273 PETSC_EXTERN PetscErrorCode PetscDrawLGGetDimension(PetscDrawLG, PetscInt *);
274 PETSC_EXTERN PetscErrorCode PetscDrawLGSetLegend(PetscDrawLG, const char *const *);
275 PETSC_EXTERN PetscErrorCode PetscDrawLGGetAxis(PetscDrawLG, PetscDrawAxis *);
276 PETSC_EXTERN PetscErrorCode PetscDrawLGGetDraw(PetscDrawLG, PetscDraw *);
277 PETSC_EXTERN PetscErrorCode PetscDrawLGSetUseMarkers(PetscDrawLG, PetscBool);
278 PETSC_EXTERN PetscErrorCode PetscDrawLGSetLimits(PetscDrawLG, PetscReal, PetscReal, PetscReal, PetscReal);
279 PETSC_EXTERN PetscErrorCode PetscDrawLGSetColors(PetscDrawLG, const int[]);
280 PETSC_EXTERN PetscErrorCode PetscDrawLGSetOptionsPrefix(PetscDrawLG, const char[]);
281 PETSC_EXTERN PetscErrorCode PetscDrawLGSetFromOptions(PetscDrawLG);
282 
283 PETSC_EXTERN PetscClassId PETSC_DRAWSP_CLASSID;
284 
285 PETSC_EXTERN PetscErrorCode PetscDrawSPCreate(PetscDraw, int, PetscDrawSP *);
286 PETSC_EXTERN PetscErrorCode PetscDrawSPDestroy(PetscDrawSP *);
287 PETSC_EXTERN PetscErrorCode PetscDrawSPAddPoint(PetscDrawSP, PetscReal *, PetscReal *);
288 PETSC_EXTERN PetscErrorCode PetscDrawSPAddPoints(PetscDrawSP, int, PetscReal **, PetscReal **);
289 PETSC_EXTERN PetscErrorCode PetscDrawSPDraw(PetscDrawSP, PetscBool);
290 PETSC_EXTERN PetscErrorCode PetscDrawSPSave(PetscDrawSP);
291 PETSC_EXTERN PetscErrorCode PetscDrawSPReset(PetscDrawSP);
292 PETSC_EXTERN PetscErrorCode PetscDrawSPGetDimension(PetscDrawSP, int *);
293 PETSC_EXTERN PetscErrorCode PetscDrawSPSetDimension(PetscDrawSP, int);
294 PETSC_EXTERN PetscErrorCode PetscDrawSPGetAxis(PetscDrawSP, PetscDrawAxis *);
295 PETSC_EXTERN PetscErrorCode PetscDrawSPGetDraw(PetscDrawSP, PetscDraw *);
296 PETSC_EXTERN PetscErrorCode PetscDrawSPSetLimits(PetscDrawSP, PetscReal, PetscReal, PetscReal, PetscReal);
297 PETSC_EXTERN PetscErrorCode PetscDrawLGSPDraw(PetscDrawLG, PetscDrawSP);
298 PETSC_EXTERN PetscErrorCode PetscDrawSPAddPointColorized(PetscDrawSP, PetscReal *, PetscReal *, PetscReal *);
299 
300 PETSC_EXTERN PetscClassId PETSC_DRAWHG_CLASSID;
301 
302 PETSC_EXTERN PetscErrorCode PetscDrawHGCreate(PetscDraw, int, PetscDrawHG *);
303 PETSC_EXTERN PetscErrorCode PetscDrawHGDestroy(PetscDrawHG *);
304 PETSC_EXTERN PetscErrorCode PetscDrawHGAddValue(PetscDrawHG, PetscReal);
305 PETSC_EXTERN PetscErrorCode PetscDrawHGDraw(PetscDrawHG);
306 PETSC_EXTERN PetscErrorCode PetscDrawHGSave(PetscDrawHG);
307 PETSC_EXTERN PetscErrorCode PetscDrawHGView(PetscDrawHG, PetscViewer);
308 PETSC_EXTERN PetscErrorCode PetscDrawHGReset(PetscDrawHG);
309 PETSC_EXTERN PetscErrorCode PetscDrawHGGetAxis(PetscDrawHG, PetscDrawAxis *);
310 PETSC_EXTERN PetscErrorCode PetscDrawHGGetDraw(PetscDrawHG, PetscDraw *);
311 PETSC_EXTERN PetscErrorCode PetscDrawHGSetLimits(PetscDrawHG, PetscReal, PetscReal, int, int);
312 PETSC_EXTERN PetscErrorCode PetscDrawHGSetNumberBins(PetscDrawHG, int);
313 PETSC_EXTERN PetscErrorCode PetscDrawHGSetColor(PetscDrawHG, int);
314 PETSC_EXTERN PetscErrorCode PetscDrawHGCalcStats(PetscDrawHG, PetscBool);
315 PETSC_EXTERN PetscErrorCode PetscDrawHGIntegerBins(PetscDrawHG, PetscBool);
316 
317 PETSC_EXTERN PetscClassId PETSC_DRAWBAR_CLASSID;
318 
319 PETSC_EXTERN PetscErrorCode PetscDrawBarCreate(PetscDraw, PetscDrawBar *);
320 PETSC_EXTERN PetscErrorCode PetscDrawBarSetData(PetscDrawBar, PetscInt, const PetscReal[], const char *const *);
321 PETSC_EXTERN PetscErrorCode PetscDrawBarDestroy(PetscDrawBar *);
322 PETSC_EXTERN PetscErrorCode PetscDrawBarDraw(PetscDrawBar);
323 PETSC_EXTERN PetscErrorCode PetscDrawBarSave(PetscDrawBar);
324 PETSC_EXTERN PetscErrorCode PetscDrawBarSetColor(PetscDrawBar, int);
325 PETSC_EXTERN PetscErrorCode PetscDrawBarSetLimits(PetscDrawBar, PetscReal, PetscReal);
326 PETSC_EXTERN PetscErrorCode PetscDrawBarSort(PetscDrawBar, PetscBool, PetscReal);
327 PETSC_EXTERN PetscErrorCode PetscDrawBarSetFromOptions(PetscDrawBar);
328 PETSC_EXTERN PetscErrorCode PetscDrawBarGetAxis(PetscDrawBar, PetscDrawAxis *);
329 PETSC_EXTERN PetscErrorCode PetscDrawBarGetDraw(PetscDrawBar, PetscDraw *);
330 
331 PETSC_EXTERN PetscErrorCode PetscDrawUtilitySetCmap(const char[], int, unsigned char[], unsigned char[], unsigned char[]);
332 PETSC_EXTERN PetscErrorCode PetscDrawUtilitySetGamma(PetscReal);
333 
334 /*
335     Handling of X11 I/O window resizing, window closing and errors in parallel
336 */
337 #if PetscDefined(HAVE_X) && PetscDefined(HAVE_SETJMP_H)
338   #include <setjmp.h>
339 
340 PETSC_EXTERN jmp_buf PetscXIOErrorHandlerJumpBuf;
341 PETSC_EXTERN void    PetscXIOErrorHandlerJump(void *);
342 PETSC_EXTERN_TYPEDEF typedef void (*PetscXIOErrorHandler)(void *);
343 PETSC_EXTERN PetscXIOErrorHandler PetscSetXIOErrorHandler(PetscXIOErrorHandler);
344 
345   /*MC
346     PetscDrawCollectiveBegin - Begins a set of draw operations
347 
348    Collective
349 
350    Synopsis:
351     #include <petscdraw.h>
352     PetscErrorCode PetscDrawCollectiveBegin(PetscDraw draw)
353 
354     Collective
355 
356    Input Parameters:
357 .   draw - the draw object
358 
359    Notes:
360     This is a macro that handles its own error checking, it does not return an error code.
361 
362     The set of operations needs to be ended by a call to `PetscDrawCollectiveEnd()`.
363 
364     X windows draw operations that are enclosed by these routines handle correctly resizing or closing of
365     the window without crashing the program.
366 
367   Developer Notes:
368     This only applies to X windows and so should have a more specific name such as `PetscDrawXCollectiveBegin()`
369 
370   Level: advanced
371 
372 .seealso: `PetscDrawCollectiveEnd()`
373 M*/
374   #define PetscDrawCollectiveBegin(draw) \
375     do { \
376       jmp_buf                       _Petsc_jmpbuf; \
377       volatile PetscXIOErrorHandler _Petsc_xioerrhdl = PETSC_NULLPTR; \
378       PetscBool                     _Petsc_isdrawx, _Petsc_xioerr, _Petsc_xioerr_local = PETSC_FALSE; \
379       PetscCall(PetscObjectTypeCompare((PetscObject)(draw), PETSC_DRAW_X, &_Petsc_isdrawx)); \
380       if (_Petsc_isdrawx) { \
381         PetscCall(PetscMemcpy(&_Petsc_jmpbuf, &PetscXIOErrorHandlerJumpBuf, sizeof(_Petsc_jmpbuf))); \
382         _Petsc_xioerrhdl = PetscSetXIOErrorHandler(PetscXIOErrorHandlerJump); \
383         if (setjmp(PetscXIOErrorHandlerJumpBuf)) { \
384           _Petsc_xioerr_local = PETSC_TRUE; \
385           do { \
386             PetscDrawCollectiveEnd(draw); \
387           } \
388         } \
389         do { \
390       } while (0)
391 
392   /*MC
393     PetscDrawCollectiveEnd - Ends a set of draw operations begun with `PetscDrawCollectiveBegin()`
394 
395    Collective
396 
397    Synopsis:
398     #include <petscdraw.h>
399     PetscErrorCode PetscDrawCollectiveEnd(PetscDraw draw)
400 
401     Collective
402 
403   Input Parameters:
404 .   draw - the draw object
405 
406   Notes:
407     This is a macro that handles its own error checking, it does not return an error code.
408 
409     X windows draw operations that are enclosed by these routines handle correctly resizing or closing of
410     the window without crashing the program.
411 
412   Developer Notes:
413     This only applies to X windows and so should have a more specific name such as `PetscDrawXCollectiveEnd()`
414 
415   Level: advanced
416 
417 .seealso: `PetscDrawCollectiveBegin()`
418 M*/
419   #define PetscDrawCollectiveEnd(draw) \
420     if (_Petsc_isdrawx) { \
421       (void)PetscSetXIOErrorHandler(_Petsc_xioerrhdl); \
422       PetscCall(PetscMemcpy(&PetscXIOErrorHandlerJumpBuf, &_Petsc_jmpbuf, sizeof(PetscXIOErrorHandlerJumpBuf))); \
423       PetscCallMPI(MPI_Allreduce(&_Petsc_xioerr_local, &_Petsc_xioerr, 1, MPIU_BOOL, MPI_LOR, PetscObjectComm((PetscObject)(draw)))); \
424       if (_Petsc_xioerr) { \
425         PetscCall(PetscDrawSetType((draw), PETSC_DRAW_NULL)); \
426         PetscFunctionReturn(PETSC_SUCCESS); \
427       } \
428     } \
429     } \
430     while (0)
431 
432 #else
433   #define PetscDrawCollectiveBegin(draw)
434   #define PetscDrawCollectiveEnd(draw)
435 #endif /* PetscDefined(HAVE_X) && PetscDefined(HAVE_SETJMP_H) */
436 
437 #endif /* PETSCDRAW_H */
438