Actual source code: petscdraw.h
1: /*
2: Interface to the PETSc graphics
3: */
4: #pragma once
5: #include <petscsys.h>
6: #include <petscdrawtypes.h>
8: /* SUBMANSEC = Sys */
10: PETSC_EXTERN PetscClassId PETSC_DRAW_CLASSID;
12: PETSC_EXTERN PetscFunctionList PetscDrawList;
13: PETSC_EXTERN PetscErrorCode PetscDrawInitializePackage(void);
14: PETSC_EXTERN PetscErrorCode PetscDrawFinalizePackage(void);
15: PETSC_EXTERN PetscErrorCode PetscDrawRegister(const char[], PetscErrorCode (*)(PetscDraw));
17: PETSC_EXTERN PetscErrorCode PetscDrawGetType(PetscDraw, PetscDrawType *);
18: PETSC_EXTERN PetscErrorCode PetscDrawSetType(PetscDraw, PetscDrawType);
19: PETSC_EXTERN PetscErrorCode PetscDrawCreate(MPI_Comm, const char[], const char[], int, int, int, int, PetscDraw *);
20: PETSC_EXTERN PetscErrorCode PetscDrawSetOptionsPrefix(PetscDraw, const char[]);
21: PETSC_EXTERN PetscErrorCode PetscDrawSetFromOptions(PetscDraw);
22: PETSC_EXTERN PetscErrorCode PetscDrawSetSave(PetscDraw, const char[]);
23: PETSC_EXTERN PetscErrorCode PetscDrawSetSaveMovie(PetscDraw, const char[]);
24: PETSC_EXTERN PetscErrorCode PetscDrawSetSaveFinalImage(PetscDraw, const char[]);
25: PETSC_EXTERN PetscErrorCode PetscDrawView(PetscDraw, PetscViewer);
26: PETSC_EXTERN PetscErrorCode PetscDrawViewFromOptions(PetscDraw, PetscObject, const char[]);
28: /*
29: Number of basic colors in the draw routines, the others are used
30: for a uniform colormap.
31: */
32: #define PETSC_DRAW_BASIC_COLORS 33
34: #define PETSC_DRAW_ROTATE -1 /* will rotate through the colors, start with 2 */
35: #define PETSC_DRAW_WHITE 0
36: #define PETSC_DRAW_BLACK 1
37: #define PETSC_DRAW_RED 2
38: #define PETSC_DRAW_GREEN 3
39: #define PETSC_DRAW_CYAN 4
40: #define PETSC_DRAW_BLUE 5
41: #define PETSC_DRAW_MAGENTA 6
42: #define PETSC_DRAW_AQUAMARINE 7
43: #define PETSC_DRAW_FORESTGREEN 8
44: #define PETSC_DRAW_ORANGE 9
45: #define PETSC_DRAW_VIOLET 10
46: #define PETSC_DRAW_BROWN 11
47: #define PETSC_DRAW_PINK 12
48: #define PETSC_DRAW_CORAL 13
49: #define PETSC_DRAW_GRAY 14
50: #define PETSC_DRAW_YELLOW 15
52: #define PETSC_DRAW_GOLD 16
53: #define PETSC_DRAW_LIGHTPINK 17
54: #define PETSC_DRAW_MEDIUMTURQUOISE 18
55: #define PETSC_DRAW_KHAKI 19
56: #define PETSC_DRAW_DIMGRAY 20
57: #define PETSC_DRAW_YELLOWGREEN 21
58: #define PETSC_DRAW_SKYBLUE 22
59: #define PETSC_DRAW_DARKGREEN 23
60: #define PETSC_DRAW_NAVYBLUE 24
61: #define PETSC_DRAW_SANDYBROWN 25
62: #define PETSC_DRAW_CADETBLUE 26
63: #define PETSC_DRAW_POWDERBLUE 27
64: #define PETSC_DRAW_DEEPPINK 28
65: #define PETSC_DRAW_THISTLE 29
66: #define PETSC_DRAW_LIMEGREEN 30
67: #define PETSC_DRAW_LAVENDERBLUSH 31
68: #define PETSC_DRAW_PLUM 32
69: #define PETSC_DRAW_MAXCOLOR 256
71: /*MC
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.
76: Synopsis:
77: #include <petscdraw.h>
78: int PetscDrawRealToColor(PetscReal value,PetscReal min,PetscReal max)
80: Not Collective
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
87: Returns:
88: The result as integer
90: Level: intermediate
92: Note:
93: Values outside the interval [`min`, `max`] are clipped.
95: .seealso: `PetscDraw`, `PetscDrawPointPixel()`, `PetscDrawPoint()`, `PetscDrawLine()`, `PetscDrawTriangle()`, `PetscDrawRectangle()`
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: }
103: PETSC_EXTERN PetscErrorCode PetscDrawOpenX(MPI_Comm, const char[], const char[], int, int, int, int, PetscDraw *);
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
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 *);
115: PETSC_EXTERN PetscErrorCode PetscDrawGetPopup(PetscDraw, PetscDraw *);
116: PETSC_EXTERN PetscErrorCode PetscDrawScalePopup(PetscDraw, PetscReal, PetscReal);
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 *);
124: PETSC_EXTERN PetscErrorCode PetscDrawIndicatorFunction(PetscDraw, PetscReal, PetscReal, PetscReal, PetscReal, int, PetscErrorCode (*)(void *, PetscReal, PetscReal, PetscBool *), void *);
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 *);
131: /*E
132: PetscDrawMarkerType - How a "mark" is indicate in a figure
134: Values:
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()`
140: Level: intermediate
142: .seealso: `PetscDraw`, `PetscDrawMarker()`, `PetscDrawSetMarkerType()`
143: E*/
144: typedef enum {
145: PETSC_DRAW_MARKER_CROSS,
146: PETSC_DRAW_MARKER_POINT,
147: PETSC_DRAW_MARKER_PLUS,
148: PETSC_DRAW_MARKER_CIRCLE
149: } PetscDrawMarkerType;
150: PETSC_EXTERN const char *const PetscDrawMarkerTypes[];
152: PETSC_EXTERN PetscErrorCode PetscDrawMarker(PetscDraw, PetscReal, PetscReal, int);
153: PETSC_EXTERN PetscErrorCode PetscDrawSetMarkerType(PetscDraw, PetscDrawMarkerType);
154: PETSC_EXTERN PetscErrorCode PetscDrawGetMarkerType(PetscDraw, PetscDrawMarkerType *);
156: PETSC_EXTERN PetscErrorCode PetscDrawPoint(PetscDraw, PetscReal, PetscReal, int);
157: PETSC_EXTERN PetscErrorCode PetscDrawPointPixel(PetscDraw, int, int, int);
158: PETSC_EXTERN PetscErrorCode PetscDrawPointSetSize(PetscDraw, PetscReal);
160: PETSC_EXTERN PetscErrorCode PetscDrawRectangle(PetscDraw, PetscReal, PetscReal, PetscReal, PetscReal, int, int, int, int);
161: PETSC_EXTERN PetscErrorCode PetscDrawTriangle(PetscDraw, PetscReal, PetscReal, PetscReal, PetscReal, PetscReal, PetscReal, int, int, int);
162: PETSC_EXTERN PetscErrorCode PetscDrawEllipse(PetscDraw, PetscReal, PetscReal, PetscReal, PetscReal, int);
163: PETSC_EXTERN PetscErrorCode PetscDrawTensorContourPatch(PetscDraw, int, int, PetscReal *, PetscReal *, PetscReal, PetscReal, PetscReal *);
164: PETSC_EXTERN PetscErrorCode PetscDrawTensorContour(PetscDraw, int, int, const PetscReal[], const PetscReal[], PetscReal *);
166: PETSC_EXTERN PetscErrorCode PetscDrawString(PetscDraw, PetscReal, PetscReal, int, const char[]);
167: PETSC_EXTERN PetscErrorCode PetscDrawStringCentered(PetscDraw, PetscReal, PetscReal, int, const char[]);
168: PETSC_EXTERN PetscErrorCode PetscDrawStringBoxed(PetscDraw, PetscReal, PetscReal, int, int, const char[], PetscReal *, PetscReal *);
169: PETSC_EXTERN PetscErrorCode PetscDrawStringVertical(PetscDraw, PetscReal, PetscReal, int, const char[]);
170: PETSC_EXTERN PetscErrorCode PetscDrawStringSetSize(PetscDraw, PetscReal, PetscReal);
171: PETSC_EXTERN PetscErrorCode PetscDrawStringGetSize(PetscDraw, PetscReal *, PetscReal *);
173: PETSC_EXTERN PetscErrorCode PetscDrawSetViewPort(PetscDraw, PetscReal, PetscReal, PetscReal, PetscReal);
174: PETSC_EXTERN PetscErrorCode PetscDrawGetViewPort(PetscDraw, PetscReal *, PetscReal *, PetscReal *, PetscReal *);
175: PETSC_EXTERN PetscErrorCode PetscDrawSplitViewPort(PetscDraw);
177: PETSC_EXTERN PetscErrorCode PetscDrawSetCoordinates(PetscDraw, PetscReal, PetscReal, PetscReal, PetscReal);
178: PETSC_EXTERN PetscErrorCode PetscDrawGetCoordinates(PetscDraw, PetscReal *, PetscReal *, PetscReal *, PetscReal *);
180: PETSC_EXTERN PetscErrorCode PetscDrawSetTitle(PetscDraw, const char[]);
181: PETSC_EXTERN PetscErrorCode PetscDrawAppendTitle(PetscDraw, const char[]);
182: PETSC_EXTERN PetscErrorCode PetscDrawGetTitle(PetscDraw, const char *[]);
184: PETSC_EXTERN PetscErrorCode PetscDrawSetPause(PetscDraw, PetscReal);
185: PETSC_EXTERN PetscErrorCode PetscDrawGetPause(PetscDraw, PetscReal *);
186: PETSC_EXTERN PetscErrorCode PetscDrawPause(PetscDraw);
187: PETSC_EXTERN PetscErrorCode PetscDrawSetDoubleBuffer(PetscDraw);
188: PETSC_EXTERN PetscErrorCode PetscDrawClear(PetscDraw);
189: PETSC_EXTERN PetscErrorCode PetscDrawFlush(PetscDraw);
190: PETSC_EXTERN PetscErrorCode PetscDrawSave(PetscDraw);
191: PETSC_EXTERN PetscErrorCode PetscDrawSaveMovie(PetscDraw);
192: PETSC_EXTERN PetscErrorCode PetscDrawBOP(PetscDraw);
193: PETSC_EXTERN PetscErrorCode PetscDrawEOP(PetscDraw);
195: PETSC_EXTERN PetscErrorCode PetscDrawSetDisplay(PetscDraw, const char[]);
196: PETSC_EXTERN PetscErrorCode PetscDrawGetSingleton(PetscDraw, PetscDraw *);
197: PETSC_EXTERN PetscErrorCode PetscDrawRestoreSingleton(PetscDraw, PetscDraw *);
199: PETSC_EXTERN PetscErrorCode PetscDrawGetCurrentPoint(PetscDraw, PetscReal *, PetscReal *);
200: PETSC_EXTERN PetscErrorCode PetscDrawSetCurrentPoint(PetscDraw, PetscReal, PetscReal);
201: PETSC_EXTERN PetscErrorCode PetscDrawPushCurrentPoint(PetscDraw, PetscReal, PetscReal);
202: PETSC_EXTERN PetscErrorCode PetscDrawPopCurrentPoint(PetscDraw);
203: PETSC_EXTERN PetscErrorCode PetscDrawGetBoundingBox(PetscDraw, PetscReal *, PetscReal *, PetscReal *, PetscReal *);
205: PETSC_EXTERN PetscErrorCode PetscDrawSetVisible(PetscDraw, PetscBool);
207: /*E
208: PetscDrawButton - Used to determine which button was pressed
210: Values:
211: + `PETSC_BUTTON_NONE` - no button was pressed
212: . `PETSC_BUTTON_LEFT` - the left button
213: . `PETSC_BUTTON_CENTER` - the center button
214: . `PETSC_BUTTON_RIGHT` - the right button
215: . `PETSC_BUTTON_WHEEL_UP` - the wheel was moved up
216: . `PETSC_BUTTON_WHEEL_DOWN` - the wheel was moved down
217: . `PETSC_BUTTON_LEFT_SHIFT` - the left button and the shift key
218: . `PETSC_BUTTON_CENTER_SHIFT`- the center button and the shift key
219: - `PETSC_BUTTON_RIGHT_SHIFT` - the right button and the shift key
221: Level: intermediate
223: .seealso: `PetscDraw`, `PetscDrawGetMouseButton()`
224: E*/
225: typedef enum {
226: PETSC_BUTTON_NONE = 0,
227: PETSC_BUTTON_LEFT,
228: PETSC_BUTTON_CENTER,
229: PETSC_BUTTON_RIGHT,
230: PETSC_BUTTON_WHEEL_UP,
231: PETSC_BUTTON_WHEEL_DOWN,
232: PETSC_BUTTON_LEFT_SHIFT,
233: PETSC_BUTTON_CENTER_SHIFT,
234: PETSC_BUTTON_RIGHT_SHIFT
235: } PetscDrawButton;
237: PETSC_EXTERN PetscErrorCode PetscDrawGetMouseButton(PetscDraw, PetscDrawButton *, PetscReal *, PetscReal *, PetscReal *, PetscReal *);
239: PETSC_EXTERN PetscErrorCode PetscDrawZoom(PetscDraw, PetscErrorCode (*)(PetscDraw, void *), void *);
241: /*S
242: PetscDrawViewPorts - Object representing subwindows in a `PetscDraw` object
244: Level: intermediate
246: .seealso: `PetscDraw`, `PetscDrawViewPortsCreate()`, `PetscDrawViewPortsSet()`
247: S*/
248: typedef struct {
249: PetscInt nports;
250: PetscReal *xl;
251: PetscReal *xr;
252: PetscReal *yl;
253: PetscReal *yr;
254: PetscDraw draw;
255: PetscReal port_xl, port_yl, port_xr, port_yr; /* original port of parent PetscDraw */
256: } PetscDrawViewPorts;
257: PETSC_EXTERN PetscErrorCode PetscDrawViewPortsCreate(PetscDraw, PetscInt, PetscDrawViewPorts **);
258: PETSC_EXTERN PetscErrorCode PetscDrawViewPortsCreateRect(PetscDraw, PetscInt, PetscInt, PetscDrawViewPorts **);
259: PETSC_EXTERN PetscErrorCode PetscDrawViewPortsDestroy(PetscDrawViewPorts *);
260: PETSC_EXTERN PetscErrorCode PetscDrawViewPortsSet(PetscDrawViewPorts *, PetscInt);
262: PETSC_EXTERN PetscClassId PETSC_DRAWAXIS_CLASSID;
264: PETSC_EXTERN PetscErrorCode PetscDrawAxisCreate(PetscDraw, PetscDrawAxis *);
265: PETSC_EXTERN PetscErrorCode PetscDrawAxisDestroy(PetscDrawAxis *);
266: PETSC_EXTERN PetscErrorCode PetscDrawAxisDraw(PetscDrawAxis);
267: PETSC_EXTERN PetscErrorCode PetscDrawAxisSetLimits(PetscDrawAxis, PetscReal, PetscReal, PetscReal, PetscReal);
268: PETSC_EXTERN PetscErrorCode PetscDrawAxisGetLimits(PetscDrawAxis, PetscReal *, PetscReal *, PetscReal *, PetscReal *);
269: PETSC_EXTERN PetscErrorCode PetscDrawAxisSetHoldLimits(PetscDrawAxis, PetscBool);
270: PETSC_EXTERN PetscErrorCode PetscDrawAxisSetColors(PetscDrawAxis, int, int, int);
271: PETSC_EXTERN PetscErrorCode PetscDrawAxisSetLabels(PetscDrawAxis, const char[], const char[], const char[]);
273: PETSC_EXTERN PetscClassId PETSC_DRAWLG_CLASSID;
275: PETSC_EXTERN PetscErrorCode PetscDrawLGCreate(PetscDraw, PetscInt, PetscDrawLG *);
276: PETSC_EXTERN PetscErrorCode PetscDrawLGDestroy(PetscDrawLG *);
277: PETSC_EXTERN PetscErrorCode PetscDrawLGAddPoint(PetscDrawLG, const PetscReal *, const PetscReal *);
278: PETSC_EXTERN PetscErrorCode PetscDrawLGAddCommonPoint(PetscDrawLG, const PetscReal, const PetscReal *);
279: PETSC_EXTERN PetscErrorCode PetscDrawLGAddPoints(PetscDrawLG, PetscInt, PetscReal **, PetscReal **);
280: PETSC_EXTERN PetscErrorCode PetscDrawLGDraw(PetscDrawLG);
281: PETSC_EXTERN PetscErrorCode PetscDrawLGSave(PetscDrawLG);
282: PETSC_EXTERN PetscErrorCode PetscDrawLGView(PetscDrawLG, PetscViewer);
283: PETSC_EXTERN PetscErrorCode PetscDrawLGReset(PetscDrawLG);
284: PETSC_EXTERN PetscErrorCode PetscDrawLGSetDimension(PetscDrawLG, PetscInt);
285: PETSC_EXTERN PetscErrorCode PetscDrawLGGetDimension(PetscDrawLG, PetscInt *);
286: PETSC_EXTERN PetscErrorCode PetscDrawLGSetLegend(PetscDrawLG, const char *const *);
287: PETSC_EXTERN PetscErrorCode PetscDrawLGGetAxis(PetscDrawLG, PetscDrawAxis *);
288: PETSC_EXTERN PetscErrorCode PetscDrawLGGetDraw(PetscDrawLG, PetscDraw *);
289: PETSC_EXTERN PetscErrorCode PetscDrawLGSetUseMarkers(PetscDrawLG, PetscBool);
290: PETSC_EXTERN PetscErrorCode PetscDrawLGSetLimits(PetscDrawLG, PetscReal, PetscReal, PetscReal, PetscReal);
291: PETSC_EXTERN PetscErrorCode PetscDrawLGSetColors(PetscDrawLG, const int[]);
292: PETSC_EXTERN PetscErrorCode PetscDrawLGSetOptionsPrefix(PetscDrawLG, const char[]);
293: PETSC_EXTERN PetscErrorCode PetscDrawLGSetFromOptions(PetscDrawLG);
295: PETSC_EXTERN PetscClassId PETSC_DRAWSP_CLASSID;
297: PETSC_EXTERN PetscErrorCode PetscDrawSPCreate(PetscDraw, int, PetscDrawSP *);
298: PETSC_EXTERN PetscErrorCode PetscDrawSPDestroy(PetscDrawSP *);
299: PETSC_EXTERN PetscErrorCode PetscDrawSPAddPoint(PetscDrawSP, PetscReal *, PetscReal *);
300: PETSC_EXTERN PetscErrorCode PetscDrawSPAddPoints(PetscDrawSP, int, PetscReal **, PetscReal **);
301: PETSC_EXTERN PetscErrorCode PetscDrawSPDraw(PetscDrawSP, PetscBool);
302: PETSC_EXTERN PetscErrorCode PetscDrawSPSave(PetscDrawSP);
303: PETSC_EXTERN PetscErrorCode PetscDrawSPReset(PetscDrawSP);
304: PETSC_EXTERN PetscErrorCode PetscDrawSPGetDimension(PetscDrawSP, int *);
305: PETSC_EXTERN PetscErrorCode PetscDrawSPSetDimension(PetscDrawSP, int);
306: PETSC_EXTERN PetscErrorCode PetscDrawSPGetAxis(PetscDrawSP, PetscDrawAxis *);
307: PETSC_EXTERN PetscErrorCode PetscDrawSPGetDraw(PetscDrawSP, PetscDraw *);
308: PETSC_EXTERN PetscErrorCode PetscDrawSPSetLimits(PetscDrawSP, PetscReal, PetscReal, PetscReal, PetscReal);
309: PETSC_EXTERN PetscErrorCode PetscDrawLGSPDraw(PetscDrawLG, PetscDrawSP);
310: PETSC_EXTERN PetscErrorCode PetscDrawSPAddPointColorized(PetscDrawSP, PetscReal *, PetscReal *, PetscReal *);
312: PETSC_EXTERN PetscClassId PETSC_DRAWHG_CLASSID;
314: PETSC_EXTERN PetscErrorCode PetscDrawHGCreate(PetscDraw, int, PetscDrawHG *);
315: PETSC_EXTERN PetscErrorCode PetscDrawHGDestroy(PetscDrawHG *);
316: PETSC_EXTERN PetscErrorCode PetscDrawHGAddValue(PetscDrawHG, PetscReal);
317: PETSC_EXTERN PetscErrorCode PetscDrawHGAddWeightedValue(PetscDrawHG, PetscReal, PetscReal);
318: PETSC_EXTERN PetscErrorCode PetscDrawHGDraw(PetscDrawHG);
319: PETSC_EXTERN PetscErrorCode PetscDrawHGSave(PetscDrawHG);
320: PETSC_EXTERN PetscErrorCode PetscDrawHGView(PetscDrawHG, PetscViewer);
321: PETSC_EXTERN PetscErrorCode PetscDrawHGReset(PetscDrawHG);
322: PETSC_EXTERN PetscErrorCode PetscDrawHGGetAxis(PetscDrawHG, PetscDrawAxis *);
323: PETSC_EXTERN PetscErrorCode PetscDrawHGGetDraw(PetscDrawHG, PetscDraw *);
324: PETSC_EXTERN PetscErrorCode PetscDrawHGSetLimits(PetscDrawHG, PetscReal, PetscReal, int, int);
325: PETSC_EXTERN PetscErrorCode PetscDrawHGSetNumberBins(PetscDrawHG, int);
326: PETSC_EXTERN PetscErrorCode PetscDrawHGSetColor(PetscDrawHG, int);
327: PETSC_EXTERN PetscErrorCode PetscDrawHGCalcStats(PetscDrawHG, PetscBool);
328: PETSC_EXTERN PetscErrorCode PetscDrawHGIntegerBins(PetscDrawHG, PetscBool);
330: PETSC_EXTERN PetscClassId PETSC_DRAWBAR_CLASSID;
332: PETSC_EXTERN PetscErrorCode PetscDrawBarCreate(PetscDraw, PetscDrawBar *);
333: PETSC_EXTERN PetscErrorCode PetscDrawBarSetData(PetscDrawBar, PetscInt, const PetscReal[], const char *const *);
334: PETSC_EXTERN PetscErrorCode PetscDrawBarDestroy(PetscDrawBar *);
335: PETSC_EXTERN PetscErrorCode PetscDrawBarDraw(PetscDrawBar);
336: PETSC_EXTERN PetscErrorCode PetscDrawBarSave(PetscDrawBar);
337: PETSC_EXTERN PetscErrorCode PetscDrawBarSetColor(PetscDrawBar, int);
338: PETSC_EXTERN PetscErrorCode PetscDrawBarSetLimits(PetscDrawBar, PetscReal, PetscReal);
339: PETSC_EXTERN PetscErrorCode PetscDrawBarSort(PetscDrawBar, PetscBool, PetscReal);
340: PETSC_EXTERN PetscErrorCode PetscDrawBarSetFromOptions(PetscDrawBar);
341: PETSC_EXTERN PetscErrorCode PetscDrawBarGetAxis(PetscDrawBar, PetscDrawAxis *);
342: PETSC_EXTERN PetscErrorCode PetscDrawBarGetDraw(PetscDrawBar, PetscDraw *);
344: PETSC_EXTERN PetscErrorCode PetscDrawUtilitySetCmap(const char[], int, unsigned char[], unsigned char[], unsigned char[]);
345: PETSC_EXTERN PetscErrorCode PetscDrawUtilitySetGamma(PetscReal);
347: /*
348: Handling of X11 I/O window resizing, window closing and errors in parallel
349: */
350: #if PetscDefined(HAVE_X) && PetscDefined(HAVE_SETJMP_H)
351: #include <setjmp.h>
353: PETSC_EXTERN jmp_buf PetscXIOErrorHandlerJumpBuf;
354: PETSC_EXTERN void PetscXIOErrorHandlerJump(void *);
355: PETSC_EXTERN_TYPEDEF typedef void(PetscXIOErrorHandlerFn)(void *);
356: PETSC_EXTERN_TYPEDEF typedef PetscXIOErrorHandlerFn *PetscXIOErrorHandler;
357: PETSC_EXTERN PetscXIOErrorHandlerFn *PetscSetXIOErrorHandler(PetscXIOErrorHandlerFn *);
359: /*MC
360: PetscDrawCollectiveBegin - Begins a set of draw operations
362: Collective
364: Synopsis:
365: #include <petscdraw.h>
366: PetscErrorCode PetscDrawCollectiveBegin(PetscDraw draw)
368: Collective
370: Input Parameter:
371: . draw - the draw object
373: Level: advanced
375: Notes:
376: This is a macro that handles its own error checking, it does not return an error code.
378: The set of operations needs to be ended by a call to `PetscDrawCollectiveEnd()`.
380: X windows draw operations that are enclosed by these routines handle correctly resizing or closing of
381: the window without crashing the program.
383: Developer Note:
384: This only applies to X windows and so should have a more specific name such as `PetscDrawXCollectiveBegin()`
386: .seealso: `PetscDraw`, `PetscDrawCollectiveEnd()`
387: M*/
388: #define PetscDrawCollectiveBegin(draw) \
389: do { \
390: jmp_buf _Petsc_jmpbuf; \
391: PetscXIOErrorHandlerFn *volatile _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)
406: /*MC
407: PetscDrawCollectiveEnd - Ends a set of draw operations begun with `PetscDrawCollectiveBegin()`
409: Collective
411: Synopsis:
412: #include <petscdraw.h>
413: PetscErrorCode PetscDrawCollectiveEnd(PetscDraw draw)
415: Collective
417: Input Parameter:
418: . draw - the draw object
420: Level: advanced
422: Notes:
423: This is a macro that handles its own error checking, it does not return an error code.
425: X windows draw operations that are enclosed by these routines handle correctly resizing or closing of
426: the window without crashing the program.
428: Developer Note:
429: This only applies to X windows and so should have a more specific name such as `PetscDrawXCollectiveEnd()`
431: .seealso: `PetscDraw`, `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(MPIU_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)
446: #else
447: #define PetscDrawCollectiveBegin(draw)
448: #define PetscDrawCollectiveEnd(draw)
449: #endif /* PetscDefined(HAVE_X) && PetscDefined(HAVE_SETJMP_H) */