xref: /petsc/include/petscdraw.h (revision a69119a591a03a9d906b29c0a4e9802e4d7c9795)
1 /*
2   Interface to the PETSc graphics
3 */
4 #if !defined(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   value = PetscClipInterval(value, min, max);
99   return PETSC_DRAW_BASIC_COLORS + (int)((255 - PETSC_DRAW_BASIC_COLORS) * (value - min) / (max - min));
100 }
101 
102 PETSC_EXTERN PetscErrorCode PetscDrawOpenX(MPI_Comm, const char[], const char[], int, int, int, int, PetscDraw *);
103 
104 #define PETSC_DRAW_FULL_SIZE    -3
105 #define PETSC_DRAW_HALF_SIZE    -4
106 #define PETSC_DRAW_THIRD_SIZE   -5
107 #define PETSC_DRAW_QUARTER_SIZE -6
108 
109 PETSC_EXTERN PetscErrorCode PetscDrawOpenImage(MPI_Comm, const char[], int, int, PetscDraw *);
110 PETSC_EXTERN PetscErrorCode PetscDrawOpenNull(MPI_Comm, PetscDraw *);
111 PETSC_EXTERN PetscErrorCode PetscDrawDestroy(PetscDraw *);
112 PETSC_EXTERN PetscErrorCode PetscDrawIsNull(PetscDraw, PetscBool *);
113 
114 PETSC_EXTERN PetscErrorCode PetscDrawGetPopup(PetscDraw, PetscDraw *);
115 PETSC_EXTERN PetscErrorCode PetscDrawScalePopup(PetscDraw, PetscReal, PetscReal);
116 
117 PETSC_EXTERN PetscErrorCode PetscDrawCheckResizedWindow(PetscDraw);
118 PETSC_EXTERN PetscErrorCode PetscDrawResizeWindow(PetscDraw, int, int);
119 PETSC_EXTERN PetscErrorCode PetscDrawGetWindowSize(PetscDraw, int *, int *);
120 PETSC_EXTERN PetscErrorCode PetscDrawPixelToCoordinate(PetscDraw, int, int, PetscReal *, PetscReal *);
121 PETSC_EXTERN PetscErrorCode PetscDrawCoordinateToPixel(PetscDraw, PetscReal, PetscReal, int *, int *);
122 
123 PETSC_EXTERN PetscErrorCode PetscDrawIndicatorFunction(PetscDraw, PetscReal, PetscReal, PetscReal, PetscReal, int, PetscErrorCode (*)(void *, PetscReal, PetscReal, PetscBool *), void *);
124 
125 PETSC_EXTERN PetscErrorCode PetscDrawLine(PetscDraw, PetscReal, PetscReal, PetscReal, PetscReal, int);
126 PETSC_EXTERN PetscErrorCode PetscDrawArrow(PetscDraw, PetscReal, PetscReal, PetscReal, PetscReal, int);
127 PETSC_EXTERN PetscErrorCode PetscDrawLineSetWidth(PetscDraw, PetscReal);
128 PETSC_EXTERN PetscErrorCode PetscDrawLineGetWidth(PetscDraw, PetscReal *);
129 
130 /*E
131     PetscDrawMarkerType - How a "mark" is indicate in a figure
132 
133    Level: intermediate
134 
135 $  `PETSC_MARKER_CROSS` - a small pixel based x symbol or the character x if that is not available
136 $  `PETSC_MARKER_PLUS` - a small pixel based + symbol or the character + if that is not available
137 $  `PETSC_MARKER_CIRCLE` - a small pixel based circle symbol or the character o if that is not available
138 $  `PETSC_MARKER_POINT` - the make obtained with PetscDrawPoint()
139 
140 .seealso: `PetscDrawMarker()`, `PetscDrawSetMarkerType()`
141 E*/
142 typedef enum {
143   PETSC_DRAW_MARKER_CROSS,
144   PETSC_DRAW_MARKER_POINT,
145   PETSC_DRAW_MARKER_PLUS,
146   PETSC_DRAW_MARKER_CIRCLE
147 } PetscDrawMarkerType;
148 PETSC_EXTERN const char *const PetscDrawMarkerTypes[];
149 
150 PETSC_EXTERN PetscErrorCode PetscDrawMarker(PetscDraw, PetscReal, PetscReal, int);
151 PETSC_EXTERN PetscErrorCode PetscDrawSetMarkerType(PetscDraw, PetscDrawMarkerType);
152 PETSC_EXTERN PetscErrorCode PetscDrawGetMarkerType(PetscDraw, PetscDrawMarkerType *);
153 
154 PETSC_EXTERN PetscErrorCode PetscDrawPoint(PetscDraw, PetscReal, PetscReal, int);
155 PETSC_EXTERN PetscErrorCode PetscDrawPointPixel(PetscDraw, int, int, int);
156 PETSC_EXTERN PetscErrorCode PetscDrawPointSetSize(PetscDraw, PetscReal);
157 
158 PETSC_EXTERN PetscErrorCode PetscDrawRectangle(PetscDraw, PetscReal, PetscReal, PetscReal, PetscReal, int, int, int, int);
159 PETSC_EXTERN PetscErrorCode PetscDrawTriangle(PetscDraw, PetscReal, PetscReal, PetscReal, PetscReal, PetscReal, PetscReal, int, int, int);
160 PETSC_EXTERN PetscErrorCode PetscDrawEllipse(PetscDraw, PetscReal, PetscReal, PetscReal, PetscReal, int);
161 PETSC_EXTERN PetscErrorCode PetscDrawTensorContourPatch(PetscDraw, int, int, PetscReal *, PetscReal *, PetscReal, PetscReal, PetscReal *);
162 PETSC_EXTERN PetscErrorCode PetscDrawTensorContour(PetscDraw, int, int, const PetscReal[], const PetscReal[], PetscReal *);
163 
164 PETSC_EXTERN PetscErrorCode PetscDrawString(PetscDraw, PetscReal, PetscReal, int, const char[]);
165 PETSC_EXTERN PetscErrorCode PetscDrawStringCentered(PetscDraw, PetscReal, PetscReal, int, const char[]);
166 PETSC_EXTERN PetscErrorCode PetscDrawStringBoxed(PetscDraw, PetscReal, PetscReal, int, int, const char[], PetscReal *, PetscReal *);
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, const 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 PetscDrawClear(PetscDraw);
187 PETSC_EXTERN PetscErrorCode PetscDrawFlush(PetscDraw);
188 PETSC_EXTERN PetscErrorCode PetscDrawSave(PetscDraw);
189 PETSC_EXTERN PetscErrorCode PetscDrawSaveMovie(PetscDraw);
190 PETSC_EXTERN PetscErrorCode PetscDrawBOP(PetscDraw);
191 PETSC_EXTERN PetscErrorCode PetscDrawEOP(PetscDraw);
192 
193 PETSC_EXTERN PetscErrorCode PetscDrawSetDisplay(PetscDraw, const char[]);
194 PETSC_EXTERN PetscErrorCode PetscDrawGetSingleton(PetscDraw, PetscDraw *);
195 PETSC_EXTERN PetscErrorCode PetscDrawRestoreSingleton(PetscDraw, PetscDraw *);
196 
197 PETSC_EXTERN PetscErrorCode PetscDrawGetCurrentPoint(PetscDraw, PetscReal *, PetscReal *);
198 PETSC_EXTERN PetscErrorCode PetscDrawSetCurrentPoint(PetscDraw, PetscReal, PetscReal);
199 PETSC_EXTERN PetscErrorCode PetscDrawPushCurrentPoint(PetscDraw, PetscReal, PetscReal);
200 PETSC_EXTERN PetscErrorCode PetscDrawPopCurrentPoint(PetscDraw);
201 PETSC_EXTERN PetscErrorCode PetscDrawGetBoundingBox(PetscDraw, PetscReal *, PetscReal *, PetscReal *, PetscReal *);
202 
203 /*E
204     PetscDrawButton - Used to determine which button was pressed
205 
206    Level: intermediate
207 
208 .seealso: `PetscDrawGetMouseButton()`
209 E*/
210 typedef enum {
211   PETSC_BUTTON_NONE = 0,
212   PETSC_BUTTON_LEFT,
213   PETSC_BUTTON_CENTER,
214   PETSC_BUTTON_RIGHT,
215   PETSC_BUTTON_WHEEL_UP,
216   PETSC_BUTTON_WHEEL_DOWN,
217   PETSC_BUTTON_LEFT_SHIFT,
218   PETSC_BUTTON_CENTER_SHIFT,
219   PETSC_BUTTON_RIGHT_SHIFT
220 } PetscDrawButton;
221 
222 PETSC_EXTERN PetscErrorCode PetscDrawGetMouseButton(PetscDraw, PetscDrawButton *, PetscReal *, PetscReal *, PetscReal *, PetscReal *);
223 
224 PETSC_EXTERN PetscErrorCode PetscDrawZoom(PetscDraw, PetscErrorCode (*)(PetscDraw, void *), void *);
225 
226 /*S
227      PetscDrawViewPorts - Subwindows in a `PetscDraw` object
228 
229    Level: intermediate
230 
231 .seealso: `PetscDrawViewPortsCreate()`, `PetscDrawViewPortsSet()`
232 S*/
233 typedef struct {
234   PetscInt   nports;
235   PetscReal *xl;
236   PetscReal *xr;
237   PetscReal *yl;
238   PetscReal *yr;
239   PetscDraw  draw;
240   PetscReal  port_xl, port_yl, port_xr, port_yr; /* original port of parent PetscDraw */
241 } PetscDrawViewPorts;
242 PETSC_EXTERN PetscErrorCode PetscDrawViewPortsCreate(PetscDraw, PetscInt, PetscDrawViewPorts **);
243 PETSC_EXTERN PetscErrorCode PetscDrawViewPortsCreateRect(PetscDraw, PetscInt, PetscInt, PetscDrawViewPorts **);
244 PETSC_EXTERN PetscErrorCode PetscDrawViewPortsDestroy(PetscDrawViewPorts *);
245 PETSC_EXTERN PetscErrorCode PetscDrawViewPortsSet(PetscDrawViewPorts *, PetscInt);
246 
247 PETSC_EXTERN PetscClassId PETSC_DRAWAXIS_CLASSID;
248 
249 PETSC_EXTERN PetscErrorCode PetscDrawAxisCreate(PetscDraw, PetscDrawAxis *);
250 PETSC_EXTERN PetscErrorCode PetscDrawAxisDestroy(PetscDrawAxis *);
251 PETSC_EXTERN PetscErrorCode PetscDrawAxisDraw(PetscDrawAxis);
252 PETSC_EXTERN PetscErrorCode PetscDrawAxisSetLimits(PetscDrawAxis, PetscReal, PetscReal, PetscReal, PetscReal);
253 PETSC_EXTERN PetscErrorCode PetscDrawAxisGetLimits(PetscDrawAxis, PetscReal *, PetscReal *, PetscReal *, PetscReal *);
254 PETSC_EXTERN PetscErrorCode PetscDrawAxisSetHoldLimits(PetscDrawAxis, PetscBool);
255 PETSC_EXTERN PetscErrorCode PetscDrawAxisSetColors(PetscDrawAxis, int, int, int);
256 PETSC_EXTERN PetscErrorCode PetscDrawAxisSetLabels(PetscDrawAxis, const char[], const char[], const char[]);
257 
258 PETSC_EXTERN PetscClassId PETSC_DRAWLG_CLASSID;
259 
260 PETSC_EXTERN PetscErrorCode PetscDrawLGCreate(PetscDraw, PetscInt, PetscDrawLG *);
261 PETSC_EXTERN PetscErrorCode PetscDrawLGDestroy(PetscDrawLG *);
262 PETSC_EXTERN PetscErrorCode PetscDrawLGAddPoint(PetscDrawLG, const PetscReal *, const PetscReal *);
263 PETSC_EXTERN PetscErrorCode PetscDrawLGAddCommonPoint(PetscDrawLG, const PetscReal, const PetscReal *);
264 PETSC_EXTERN PetscErrorCode PetscDrawLGAddPoints(PetscDrawLG, PetscInt, PetscReal **, PetscReal **);
265 PETSC_EXTERN PetscErrorCode PetscDrawLGDraw(PetscDrawLG);
266 PETSC_EXTERN PetscErrorCode PetscDrawLGSave(PetscDrawLG);
267 PETSC_EXTERN PetscErrorCode PetscDrawLGView(PetscDrawLG, PetscViewer);
268 PETSC_EXTERN PetscErrorCode PetscDrawLGReset(PetscDrawLG);
269 PETSC_EXTERN PetscErrorCode PetscDrawLGSetDimension(PetscDrawLG, PetscInt);
270 PETSC_EXTERN PetscErrorCode PetscDrawLGGetDimension(PetscDrawLG, PetscInt *);
271 PETSC_EXTERN PetscErrorCode PetscDrawLGSetLegend(PetscDrawLG, const char *const *);
272 PETSC_EXTERN PetscErrorCode PetscDrawLGGetAxis(PetscDrawLG, PetscDrawAxis *);
273 PETSC_EXTERN PetscErrorCode PetscDrawLGGetDraw(PetscDrawLG, PetscDraw *);
274 PETSC_EXTERN PetscErrorCode PetscDrawLGSetUseMarkers(PetscDrawLG, PetscBool);
275 PETSC_EXTERN PetscErrorCode PetscDrawLGSetLimits(PetscDrawLG, PetscReal, PetscReal, PetscReal, PetscReal);
276 PETSC_EXTERN PetscErrorCode PetscDrawLGSetColors(PetscDrawLG, const int[]);
277 PETSC_EXTERN PetscErrorCode PetscDrawLGSetOptionsPrefix(PetscDrawLG, const char[]);
278 PETSC_EXTERN PetscErrorCode PetscDrawLGSetFromOptions(PetscDrawLG);
279 
280 PETSC_EXTERN PetscClassId PETSC_DRAWSP_CLASSID;
281 
282 PETSC_EXTERN PetscErrorCode PetscDrawSPCreate(PetscDraw, int, PetscDrawSP *);
283 PETSC_EXTERN PetscErrorCode PetscDrawSPDestroy(PetscDrawSP *);
284 PETSC_EXTERN PetscErrorCode PetscDrawSPAddPoint(PetscDrawSP, PetscReal *, PetscReal *);
285 PETSC_EXTERN PetscErrorCode PetscDrawSPAddPoints(PetscDrawSP, int, PetscReal **, PetscReal **);
286 PETSC_EXTERN PetscErrorCode PetscDrawSPDraw(PetscDrawSP, PetscBool);
287 PETSC_EXTERN PetscErrorCode PetscDrawSPSave(PetscDrawSP);
288 PETSC_EXTERN PetscErrorCode PetscDrawSPReset(PetscDrawSP);
289 PETSC_EXTERN PetscErrorCode PetscDrawSPGetDimension(PetscDrawSP, int *);
290 PETSC_EXTERN PetscErrorCode PetscDrawSPSetDimension(PetscDrawSP, int);
291 PETSC_EXTERN PetscErrorCode PetscDrawSPGetAxis(PetscDrawSP, PetscDrawAxis *);
292 PETSC_EXTERN PetscErrorCode PetscDrawSPGetDraw(PetscDrawSP, PetscDraw *);
293 PETSC_EXTERN PetscErrorCode PetscDrawSPSetLimits(PetscDrawSP, PetscReal, PetscReal, PetscReal, PetscReal);
294 PETSC_EXTERN PetscErrorCode PetscDrawLGSPDraw(PetscDrawLG, PetscDrawSP);
295 PETSC_EXTERN PetscErrorCode PetscDrawSPAddPointColorized(PetscDrawSP, PetscReal *, PetscReal *, PetscReal *);
296 
297 PETSC_EXTERN PetscClassId PETSC_DRAWHG_CLASSID;
298 
299 PETSC_EXTERN PetscErrorCode PetscDrawHGCreate(PetscDraw, int, PetscDrawHG *);
300 PETSC_EXTERN PetscErrorCode PetscDrawHGDestroy(PetscDrawHG *);
301 PETSC_EXTERN PetscErrorCode PetscDrawHGAddValue(PetscDrawHG, PetscReal);
302 PETSC_EXTERN PetscErrorCode PetscDrawHGDraw(PetscDrawHG);
303 PETSC_EXTERN PetscErrorCode PetscDrawHGSave(PetscDrawHG);
304 PETSC_EXTERN PetscErrorCode PetscDrawHGView(PetscDrawHG, PetscViewer);
305 PETSC_EXTERN PetscErrorCode PetscDrawHGReset(PetscDrawHG);
306 PETSC_EXTERN PetscErrorCode PetscDrawHGGetAxis(PetscDrawHG, PetscDrawAxis *);
307 PETSC_EXTERN PetscErrorCode PetscDrawHGGetDraw(PetscDrawHG, PetscDraw *);
308 PETSC_EXTERN PetscErrorCode PetscDrawHGSetLimits(PetscDrawHG, PetscReal, PetscReal, int, int);
309 PETSC_EXTERN PetscErrorCode PetscDrawHGSetNumberBins(PetscDrawHG, int);
310 PETSC_EXTERN PetscErrorCode PetscDrawHGSetColor(PetscDrawHG, int);
311 PETSC_EXTERN PetscErrorCode PetscDrawHGCalcStats(PetscDrawHG, PetscBool);
312 PETSC_EXTERN PetscErrorCode PetscDrawHGIntegerBins(PetscDrawHG, PetscBool);
313 
314 PETSC_EXTERN PetscClassId PETSC_DRAWBAR_CLASSID;
315 
316 PETSC_EXTERN PetscErrorCode PetscDrawBarCreate(PetscDraw, PetscDrawBar *);
317 PETSC_EXTERN PetscErrorCode PetscDrawBarSetData(PetscDrawBar, PetscInt, const PetscReal[], const char *const *);
318 PETSC_EXTERN PetscErrorCode PetscDrawBarDestroy(PetscDrawBar *);
319 PETSC_EXTERN PetscErrorCode PetscDrawBarDraw(PetscDrawBar);
320 PETSC_EXTERN PetscErrorCode PetscDrawBarSave(PetscDrawBar);
321 PETSC_EXTERN PetscErrorCode PetscDrawBarSetColor(PetscDrawBar, int);
322 PETSC_EXTERN PetscErrorCode PetscDrawBarSetLimits(PetscDrawBar, PetscReal, PetscReal);
323 PETSC_EXTERN PetscErrorCode PetscDrawBarSort(PetscDrawBar, PetscBool, PetscReal);
324 PETSC_EXTERN PetscErrorCode PetscDrawBarSetFromOptions(PetscDrawBar);
325 PETSC_EXTERN PetscErrorCode PetscDrawBarGetAxis(PetscDrawBar, PetscDrawAxis *);
326 PETSC_EXTERN PetscErrorCode PetscDrawBarGetDraw(PetscDrawBar, PetscDraw *);
327 
328 PETSC_EXTERN PetscErrorCode PetscDrawUtilitySetCmap(const char[], int, unsigned char[], unsigned char[], unsigned char[]);
329 PETSC_EXTERN PetscErrorCode PetscDrawUtilitySetGamma(PetscReal);
330 
331 /*
332     Handling of X11 I/O window resizing, window closing and errors in parallel
333 */
334 #if PetscDefined(HAVE_X) && PetscDefined(HAVE_SETJMP_H)
335 #include <setjmp.h>
336 
337 PETSC_EXTERN jmp_buf PetscXIOErrorHandlerJumpBuf;
338 PETSC_EXTERN void    PetscXIOErrorHandlerJump(void *);
339 PETSC_EXTERN_TYPEDEF typedef void (*PetscXIOErrorHandler)(void *);
340 PETSC_EXTERN PetscXIOErrorHandler PetscSetXIOErrorHandler(PetscXIOErrorHandler);
341 
342 /*MC
343     PetscDrawCollectiveBegin - Begins a set of draw operations
344 
345    Collective
346 
347    Synopsis:
348     #include <petscdraw.h>
349     PetscErrorCode PetscDrawCollectiveBegin(PetscDraw draw)
350 
351     Collective
352 
353    Input Parameters:
354 .   draw - the draw object
355 
356    Notes:
357     This is a macro that handles its own error checking, it does not return an error code.
358 
359     The set of operations needs to be ended by a call to `PetscDrawCollectiveEnd()`.
360 
361     X windows draw operations that are enclosed by these routines handle correctly resizing or closing of
362     the window without crashing the program.
363 
364   Developer Notes:
365     This only applies to X windows and so should have a more specific name such as `PetscDrawXCollectiveBegin()`
366 
367   Level: advanced
368 
369 .seealso: `PetscDrawCollectiveEnd()`
370 M*/
371 #define PetscDrawCollectiveBegin(draw) \
372   do { \
373     jmp_buf                       _Petsc_jmpbuf; \
374     volatile PetscXIOErrorHandler _Petsc_xioerrhdl = PETSC_NULLPTR; \
375     PetscBool                     _Petsc_isdrawx, _Petsc_xioerr, _Petsc_xioerr_local = PETSC_FALSE; \
376     PetscCall(PetscObjectTypeCompare((PetscObject)(draw), PETSC_DRAW_X, &_Petsc_isdrawx)); \
377     if (_Petsc_isdrawx) { \
378       PetscCall(PetscMemcpy(&_Petsc_jmpbuf, &PetscXIOErrorHandlerJumpBuf, sizeof(_Petsc_jmpbuf))); \
379       _Petsc_xioerrhdl = PetscSetXIOErrorHandler(PetscXIOErrorHandlerJump); \
380       if (setjmp(PetscXIOErrorHandlerJumpBuf)) { \
381         _Petsc_xioerr_local = PETSC_TRUE; \
382         do { PetscDrawCollectiveEnd(draw); } \
383       } \
384       do { \
385     } while (0)
386 
387 /*MC
388     PetscDrawCollectiveEnd - Ends a set of draw operations begun with `PetscDrawCollectiveBegin()`
389 
390    Collective
391 
392    Synopsis:
393     #include <petscdraw.h>
394     PetscErrorCode PetscDrawCollectiveEnd(PetscDraw draw)
395 
396     Collective
397 
398   Input Parameters:
399 .   draw - the draw object
400 
401   Notes:
402     This is a macro that handles its own error checking, it does not return an error code.
403 
404     X windows draw operations that are enclosed by these routines handle correctly resizing or closing of
405     the window without crashing the program.
406 
407   Developer Notes:
408     This only applies to X windows and so should have a more specific name such as `PetscDrawXCollectiveEnd()`
409 
410   Level: advanced
411 
412 .seealso: `PetscDrawCollectiveBegin()`
413 M*/
414 #define PetscDrawCollectiveEnd(draw) \
415   if (_Petsc_isdrawx) { \
416     (void)PetscSetXIOErrorHandler(_Petsc_xioerrhdl); \
417     PetscCall(PetscMemcpy(&PetscXIOErrorHandlerJumpBuf, &_Petsc_jmpbuf, sizeof(PetscXIOErrorHandlerJumpBuf))); \
418     PetscCallMPI(MPI_Allreduce(&_Petsc_xioerr_local, &_Petsc_xioerr, 1, MPIU_BOOL, MPI_LOR, PetscObjectComm((PetscObject)(draw)))); \
419     if (_Petsc_xioerr) { \
420       PetscCall(PetscDrawSetType((draw), PETSC_DRAW_NULL)); \
421       PetscFunctionReturn(0); \
422     } \
423   } \
424   } \
425   while (0)
426 
427 #else
428 #define PetscDrawCollectiveBegin(draw)
429 #define PetscDrawCollectiveEnd(draw)
430 #endif /* PetscDefined(HAVE_X) && PetscDefined(HAVE_SETJMP_H) */
431 
432 #endif /* PETSCDRAW_H */
433