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