Actual source code: petscdraw.h
1: /*
2: Interface to the PETSc graphics
3: */
4: #ifndef PETSCDRAW_H
5: #define PETSCDRAW_H
6: #include <petscsys.h>
7: #include <petscdrawtypes.h>
9: /* SUBMANSEC = Sys */
11: PETSC_EXTERN PetscClassId PETSC_DRAW_CLASSID;
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));
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[]);
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
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
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
72: /*MC
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.
78: Synopsis:
79: #include <petscdraw.h>
80: int PetscDrawRealToColor(PetscReal value,PetscReal min,PetscReal max)
82: Not Collective
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
89: Note:
90: Values outside the interval [min,max] are clipped.
92: Level: intermediate
94: .seealso: `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: Level: intermediate
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()
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[];
151: PETSC_EXTERN PetscErrorCode PetscDrawMarker(PetscDraw, PetscReal, PetscReal, int);
152: PETSC_EXTERN PetscErrorCode PetscDrawSetMarkerType(PetscDraw, PetscDrawMarkerType);
153: PETSC_EXTERN PetscErrorCode PetscDrawGetMarkerType(PetscDraw, PetscDrawMarkerType *);
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);
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 *);
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 *);
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);
176: PETSC_EXTERN PetscErrorCode PetscDrawSetCoordinates(PetscDraw, PetscReal, PetscReal, PetscReal, PetscReal);
177: PETSC_EXTERN PetscErrorCode PetscDrawGetCoordinates(PetscDraw, PetscReal *, PetscReal *, PetscReal *, PetscReal *);
179: PETSC_EXTERN PetscErrorCode PetscDrawSetTitle(PetscDraw, const char[]);
180: PETSC_EXTERN PetscErrorCode PetscDrawAppendTitle(PetscDraw, const char[]);
181: PETSC_EXTERN PetscErrorCode PetscDrawGetTitle(PetscDraw, const char *[]);
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);
194: PETSC_EXTERN PetscErrorCode PetscDrawSetDisplay(PetscDraw, const char[]);
195: PETSC_EXTERN PetscErrorCode PetscDrawGetSingleton(PetscDraw, PetscDraw *);
196: PETSC_EXTERN PetscErrorCode PetscDrawRestoreSingleton(PetscDraw, PetscDraw *);
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 *);
204: /*E
205: PetscDrawButton - Used to determine which button was pressed
207: Level: intermediate
209: .seealso: `PetscDrawGetMouseButton()`
210: E*/
211: typedef enum {
212: PETSC_BUTTON_NONE = 0,
213: PETSC_BUTTON_LEFT,
214: PETSC_BUTTON_CENTER,
215: PETSC_BUTTON_RIGHT,
216: PETSC_BUTTON_WHEEL_UP,
217: PETSC_BUTTON_WHEEL_DOWN,
218: PETSC_BUTTON_LEFT_SHIFT,
219: PETSC_BUTTON_CENTER_SHIFT,
220: PETSC_BUTTON_RIGHT_SHIFT
221: } PetscDrawButton;
223: PETSC_EXTERN PetscErrorCode PetscDrawGetMouseButton(PetscDraw, PetscDrawButton *, PetscReal *, PetscReal *, PetscReal *, PetscReal *);
225: PETSC_EXTERN PetscErrorCode PetscDrawZoom(PetscDraw, PetscErrorCode (*)(PetscDraw, void *), void *);
227: /*S
228: PetscDrawViewPorts - Subwindows in a `PetscDraw` object
230: Level: intermediate
232: .seealso: `PetscDrawViewPortsCreate()`, `PetscDrawViewPortsSet()`
233: S*/
234: typedef struct {
235: PetscInt nports;
236: PetscReal *xl;
237: PetscReal *xr;
238: PetscReal *yl;
239: PetscReal *yr;
240: PetscDraw draw;
241: PetscReal port_xl, port_yl, port_xr, port_yr; /* original port of parent PetscDraw */
242: } PetscDrawViewPorts;
243: PETSC_EXTERN PetscErrorCode PetscDrawViewPortsCreate(PetscDraw, PetscInt, PetscDrawViewPorts **);
244: PETSC_EXTERN PetscErrorCode PetscDrawViewPortsCreateRect(PetscDraw, PetscInt, PetscInt, PetscDrawViewPorts **);
245: PETSC_EXTERN PetscErrorCode PetscDrawViewPortsDestroy(PetscDrawViewPorts *);
246: PETSC_EXTERN PetscErrorCode PetscDrawViewPortsSet(PetscDrawViewPorts *, PetscInt);
248: PETSC_EXTERN PetscClassId PETSC_DRAWAXIS_CLASSID;
250: PETSC_EXTERN PetscErrorCode PetscDrawAxisCreate(PetscDraw, PetscDrawAxis *);
251: PETSC_EXTERN PetscErrorCode PetscDrawAxisDestroy(PetscDrawAxis *);
252: PETSC_EXTERN PetscErrorCode PetscDrawAxisDraw(PetscDrawAxis);
253: PETSC_EXTERN PetscErrorCode PetscDrawAxisSetLimits(PetscDrawAxis, PetscReal, PetscReal, PetscReal, PetscReal);
254: PETSC_EXTERN PetscErrorCode PetscDrawAxisGetLimits(PetscDrawAxis, PetscReal *, PetscReal *, PetscReal *, PetscReal *);
255: PETSC_EXTERN PetscErrorCode PetscDrawAxisSetHoldLimits(PetscDrawAxis, PetscBool);
256: PETSC_EXTERN PetscErrorCode PetscDrawAxisSetColors(PetscDrawAxis, int, int, int);
257: PETSC_EXTERN PetscErrorCode PetscDrawAxisSetLabels(PetscDrawAxis, const char[], const char[], const char[]);
259: PETSC_EXTERN PetscClassId PETSC_DRAWLG_CLASSID;
261: PETSC_EXTERN PetscErrorCode PetscDrawLGCreate(PetscDraw, PetscInt, PetscDrawLG *);
262: PETSC_EXTERN PetscErrorCode PetscDrawLGDestroy(PetscDrawLG *);
263: PETSC_EXTERN PetscErrorCode PetscDrawLGAddPoint(PetscDrawLG, const PetscReal *, const PetscReal *);
264: PETSC_EXTERN PetscErrorCode PetscDrawLGAddCommonPoint(PetscDrawLG, const PetscReal, const PetscReal *);
265: PETSC_EXTERN PetscErrorCode PetscDrawLGAddPoints(PetscDrawLG, PetscInt, PetscReal **, PetscReal **);
266: PETSC_EXTERN PetscErrorCode PetscDrawLGDraw(PetscDrawLG);
267: PETSC_EXTERN PetscErrorCode PetscDrawLGSave(PetscDrawLG);
268: PETSC_EXTERN PetscErrorCode PetscDrawLGView(PetscDrawLG, PetscViewer);
269: PETSC_EXTERN PetscErrorCode PetscDrawLGReset(PetscDrawLG);
270: PETSC_EXTERN PetscErrorCode PetscDrawLGSetDimension(PetscDrawLG, PetscInt);
271: PETSC_EXTERN PetscErrorCode PetscDrawLGGetDimension(PetscDrawLG, PetscInt *);
272: PETSC_EXTERN PetscErrorCode PetscDrawLGSetLegend(PetscDrawLG, const char *const *);
273: PETSC_EXTERN PetscErrorCode PetscDrawLGGetAxis(PetscDrawLG, PetscDrawAxis *);
274: PETSC_EXTERN PetscErrorCode PetscDrawLGGetDraw(PetscDrawLG, PetscDraw *);
275: PETSC_EXTERN PetscErrorCode PetscDrawLGSetUseMarkers(PetscDrawLG, PetscBool);
276: PETSC_EXTERN PetscErrorCode PetscDrawLGSetLimits(PetscDrawLG, PetscReal, PetscReal, PetscReal, PetscReal);
277: PETSC_EXTERN PetscErrorCode PetscDrawLGSetColors(PetscDrawLG, const int[]);
278: PETSC_EXTERN PetscErrorCode PetscDrawLGSetOptionsPrefix(PetscDrawLG, const char[]);
279: PETSC_EXTERN PetscErrorCode PetscDrawLGSetFromOptions(PetscDrawLG);
281: PETSC_EXTERN PetscClassId PETSC_DRAWSP_CLASSID;
283: PETSC_EXTERN PetscErrorCode PetscDrawSPCreate(PetscDraw, int, PetscDrawSP *);
284: PETSC_EXTERN PetscErrorCode PetscDrawSPDestroy(PetscDrawSP *);
285: PETSC_EXTERN PetscErrorCode PetscDrawSPAddPoint(PetscDrawSP, PetscReal *, PetscReal *);
286: PETSC_EXTERN PetscErrorCode PetscDrawSPAddPoints(PetscDrawSP, int, PetscReal **, PetscReal **);
287: PETSC_EXTERN PetscErrorCode PetscDrawSPDraw(PetscDrawSP, PetscBool);
288: PETSC_EXTERN PetscErrorCode PetscDrawSPSave(PetscDrawSP);
289: PETSC_EXTERN PetscErrorCode PetscDrawSPReset(PetscDrawSP);
290: PETSC_EXTERN PetscErrorCode PetscDrawSPGetDimension(PetscDrawSP, int *);
291: PETSC_EXTERN PetscErrorCode PetscDrawSPSetDimension(PetscDrawSP, int);
292: PETSC_EXTERN PetscErrorCode PetscDrawSPGetAxis(PetscDrawSP, PetscDrawAxis *);
293: PETSC_EXTERN PetscErrorCode PetscDrawSPGetDraw(PetscDrawSP, PetscDraw *);
294: PETSC_EXTERN PetscErrorCode PetscDrawSPSetLimits(PetscDrawSP, PetscReal, PetscReal, PetscReal, PetscReal);
295: PETSC_EXTERN PetscErrorCode PetscDrawLGSPDraw(PetscDrawLG, PetscDrawSP);
296: PETSC_EXTERN PetscErrorCode PetscDrawSPAddPointColorized(PetscDrawSP, PetscReal *, PetscReal *, PetscReal *);
298: PETSC_EXTERN PetscClassId PETSC_DRAWHG_CLASSID;
300: PETSC_EXTERN PetscErrorCode PetscDrawHGCreate(PetscDraw, int, PetscDrawHG *);
301: PETSC_EXTERN PetscErrorCode PetscDrawHGDestroy(PetscDrawHG *);
302: PETSC_EXTERN PetscErrorCode PetscDrawHGAddValue(PetscDrawHG, PetscReal);
303: PETSC_EXTERN PetscErrorCode PetscDrawHGDraw(PetscDrawHG);
304: PETSC_EXTERN PetscErrorCode PetscDrawHGSave(PetscDrawHG);
305: PETSC_EXTERN PetscErrorCode PetscDrawHGView(PetscDrawHG, PetscViewer);
306: PETSC_EXTERN PetscErrorCode PetscDrawHGReset(PetscDrawHG);
307: PETSC_EXTERN PetscErrorCode PetscDrawHGGetAxis(PetscDrawHG, PetscDrawAxis *);
308: PETSC_EXTERN PetscErrorCode PetscDrawHGGetDraw(PetscDrawHG, PetscDraw *);
309: PETSC_EXTERN PetscErrorCode PetscDrawHGSetLimits(PetscDrawHG, PetscReal, PetscReal, int, int);
310: PETSC_EXTERN PetscErrorCode PetscDrawHGSetNumberBins(PetscDrawHG, int);
311: PETSC_EXTERN PetscErrorCode PetscDrawHGSetColor(PetscDrawHG, int);
312: PETSC_EXTERN PetscErrorCode PetscDrawHGCalcStats(PetscDrawHG, PetscBool);
313: PETSC_EXTERN PetscErrorCode PetscDrawHGIntegerBins(PetscDrawHG, PetscBool);
315: PETSC_EXTERN PetscClassId PETSC_DRAWBAR_CLASSID;
317: PETSC_EXTERN PetscErrorCode PetscDrawBarCreate(PetscDraw, PetscDrawBar *);
318: PETSC_EXTERN PetscErrorCode PetscDrawBarSetData(PetscDrawBar, PetscInt, const PetscReal[], const char *const *);
319: PETSC_EXTERN PetscErrorCode PetscDrawBarDestroy(PetscDrawBar *);
320: PETSC_EXTERN PetscErrorCode PetscDrawBarDraw(PetscDrawBar);
321: PETSC_EXTERN PetscErrorCode PetscDrawBarSave(PetscDrawBar);
322: PETSC_EXTERN PetscErrorCode PetscDrawBarSetColor(PetscDrawBar, int);
323: PETSC_EXTERN PetscErrorCode PetscDrawBarSetLimits(PetscDrawBar, PetscReal, PetscReal);
324: PETSC_EXTERN PetscErrorCode PetscDrawBarSort(PetscDrawBar, PetscBool, PetscReal);
325: PETSC_EXTERN PetscErrorCode PetscDrawBarSetFromOptions(PetscDrawBar);
326: PETSC_EXTERN PetscErrorCode PetscDrawBarGetAxis(PetscDrawBar, PetscDrawAxis *);
327: PETSC_EXTERN PetscErrorCode PetscDrawBarGetDraw(PetscDrawBar, PetscDraw *);
329: PETSC_EXTERN PetscErrorCode PetscDrawUtilitySetCmap(const char[], int, unsigned char[], unsigned char[], unsigned char[]);
330: PETSC_EXTERN PetscErrorCode PetscDrawUtilitySetGamma(PetscReal);
332: /*
333: Handling of X11 I/O window resizing, window closing and errors in parallel
334: */
335: #if PetscDefined(HAVE_X) && PetscDefined(HAVE_SETJMP_H)
336: #include <setjmp.h>
338: PETSC_EXTERN jmp_buf PetscXIOErrorHandlerJumpBuf;
339: PETSC_EXTERN void PetscXIOErrorHandlerJump(void *);
340: PETSC_EXTERN_TYPEDEF typedef void (*PetscXIOErrorHandler)(void *);
341: PETSC_EXTERN PetscXIOErrorHandler PetscSetXIOErrorHandler(PetscXIOErrorHandler);
343: /*MC
344: PetscDrawCollectiveBegin - Begins a set of draw operations
346: Collective
348: Synopsis:
349: #include <petscdraw.h>
350: PetscErrorCode PetscDrawCollectiveBegin(PetscDraw draw)
352: Collective
354: Input Parameters:
355: . draw - the draw object
357: Notes:
358: This is a macro that handles its own error checking, it does not return an error code.
360: The set of operations needs to be ended by a call to `PetscDrawCollectiveEnd()`.
362: X windows draw operations that are enclosed by these routines handle correctly resizing or closing of
363: the window without crashing the program.
365: Developer Notes:
366: This only applies to X windows and so should have a more specific name such as `PetscDrawXCollectiveBegin()`
368: Level: advanced
370: .seealso: `PetscDrawCollectiveEnd()`
371: M*/
372: #define PetscDrawCollectiveBegin(draw) \
373: do { \
374: jmp_buf _Petsc_jmpbuf; \
375: volatile PetscXIOErrorHandler _Petsc_xioerrhdl = PETSC_NULLPTR; \
376: PetscBool _Petsc_isdrawx, _Petsc_xioerr, _Petsc_xioerr_local = PETSC_FALSE; \
377: PetscObjectTypeCompare((PetscObject)(draw), PETSC_DRAW_X, &_Petsc_isdrawx); \
378: if (_Petsc_isdrawx) { \
379: PetscMemcpy(&_Petsc_jmpbuf, &PetscXIOErrorHandlerJumpBuf, sizeof(_Petsc_jmpbuf)); \
380: _Petsc_xioerrhdl = PetscSetXIOErrorHandler(PetscXIOErrorHandlerJump); \
381: if (setjmp(PetscXIOErrorHandlerJumpBuf)) { \
382: _Petsc_xioerr_local = PETSC_TRUE; \
383: do { \
384: PetscDrawCollectiveEnd(draw); \
385: } \
386: } \
387: do { \
388: } while (0)
390: /*MC
391: PetscDrawCollectiveEnd - Ends a set of draw operations begun with `PetscDrawCollectiveBegin()`
393: Collective
395: Synopsis:
396: #include <petscdraw.h>
397: PetscErrorCode PetscDrawCollectiveEnd(PetscDraw draw)
399: Collective
401: Input Parameters:
402: . draw - the draw object
404: Notes:
405: This is a macro that handles its own error checking, it does not return an error code.
407: X windows draw operations that are enclosed by these routines handle correctly resizing or closing of
408: the window without crashing the program.
410: Developer Notes:
411: This only applies to X windows and so should have a more specific name such as `PetscDrawXCollectiveEnd()`
413: Level: advanced
415: .seealso: `PetscDrawCollectiveBegin()`
416: M*/
417: #define PetscDrawCollectiveEnd(draw) \
418: if (_Petsc_isdrawx) { \
419: (void)PetscSetXIOErrorHandler(_Petsc_xioerrhdl); \
420: PetscMemcpy(&PetscXIOErrorHandlerJumpBuf, &_Petsc_jmpbuf, sizeof(PetscXIOErrorHandlerJumpBuf)); \
421: MPI_Allreduce(&_Petsc_xioerr_local, &_Petsc_xioerr, 1, MPIU_BOOL, MPI_LOR, PetscObjectComm((PetscObject)(draw))); \
422: if (_Petsc_xioerr) { \
423: PetscDrawSetType((draw), PETSC_DRAW_NULL); \
424: return 0; \
425: } \
426: } \
427: } \
428: while (0)
430: #else
431: #define PetscDrawCollectiveBegin(draw)
432: #define PetscDrawCollectiveEnd(draw)
433: #endif /* PetscDefined(HAVE_X) && PetscDefined(HAVE_SETJMP_H) */
435: #endif /* PETSCDRAW_H */