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