xref: /petsc/include/petscdraw.h (revision 665c2ded495bb9782a7454dcfef3abf1536c3670) 
1 /*
2   Interface to the PETSc graphics (currently only support for X-windows
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 /*J
12     PetscDrawType - String with the name of a PetscDraw
13 
14    Level: beginner
15 
16 .seealso: PetscDrawSetType(), PetscDraw, PetscViewer
17 J*/
18 typedef const char* PetscDrawType;
19 #define PETSC_DRAW_X          "x"
20 #define PETSC_DRAW_GLUT       "glut"
21 #define PETSC_DRAW_OPENGLES   "opengles"
22 #define PETSC_DRAW_NULL       "null"
23 #define PETSC_DRAW_WIN32      "win32"
24 #define PETSC_DRAW_TIKZ       "tikz"
25 
26 PETSC_EXTERN PetscFunctionList PetscDrawList;
27 PETSC_EXTERN PetscErrorCode PetscDrawRegisterAll(const char[]);
28 PETSC_EXTERN PetscErrorCode PetscDrawInitializePackage(const char[]);
29 PETSC_EXTERN PetscErrorCode PetscDrawRegisterDestroy(void);
30 
31 PETSC_EXTERN PetscErrorCode PetscDrawRegister(const char*,const char*,const char*,PetscErrorCode(*)(PetscDraw));
32 
33 /*MC
34    PetscDrawRegisterDynamic - Adds a method to the graphics package.
35 
36    Synopsis:
37    #include "petscdraw.h"
38    PetscErrorCode PetscDrawRegisterDynamic(const char *name_solver,const char *path,const char *name_create,PetscErrorCode (*routine_create)(PetscDraw))
39 
40    Not Collective
41 
42    Input Parameters:
43 +  name_solver - name of a new user-defined solver
44 .  path - path (either absolute or relative) the library containing this solver
45 .  name_create - name of routine to create method context
46 -  routine_create - routine to create method context
47 
48    Level: developer
49 
50    Notes:
51    PetscDrawRegisterDynamic() may be called multiple times to add several user-defined solvers.
52 
53    If dynamic libraries are used, then the fourth input argument (routine_create)
54    is ignored.
55 
56    Sample usage:
57 .vb
58    PetscDrawRegisterDynamic("my_draw_type",/home/username/my_lib/lib/libO/solaris/mylib.a,
59                "MyDrawCreate",MyDrawCreate);
60 .ve
61 
62    Then, your solver can be chosen with the procedural interface via
63 $     PetscDrawSetType(ksp,"my_draw_type")
64    or at runtime via the option
65 $     -draw_type my_draw_type
66 
67    Concepts: graphics^registering new draw classes
68    Concepts: PetscDraw^registering new draw classes
69 
70 .seealso: PetscDrawRegisterAll(), PetscDrawRegisterDestroy()
71 M*/
72 #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
73 #define PetscDrawRegisterDynamic(a,b,c,d) PetscDrawRegister(a,b,c,0)
74 #else
75 #define PetscDrawRegisterDynamic(a,b,c,d) PetscDrawRegister(a,b,c,d)
76 #endif
77 
78 PETSC_EXTERN PetscErrorCode PetscDrawGetType(PetscDraw,PetscDrawType*);
79 PETSC_EXTERN PetscErrorCode PetscDrawSetType(PetscDraw,PetscDrawType);
80 PETSC_EXTERN PetscErrorCode PetscDrawCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscDraw*);
81 PETSC_EXTERN PetscErrorCode PetscDrawSetFromOptions(PetscDraw);
82 PETSC_EXTERN PetscErrorCode PetscDrawSetSave(PetscDraw,const char*,PetscBool);
83 
84 /*
85    Number of basic colors in the draw routines, the others are used
86    for a uniform colormap.
87 */
88 #define PETSC_DRAW_BASIC_COLORS 33
89 
90 #define PETSC_DRAW_ROTATE          -1         /* will rotate through the colors, start with 2 */
91 #define PETSC_DRAW_WHITE            0
92 #define PETSC_DRAW_BLACK            1
93 #define PETSC_DRAW_RED              2
94 #define PETSC_DRAW_GREEN            3
95 #define PETSC_DRAW_CYAN             4
96 #define PETSC_DRAW_BLUE             5
97 #define PETSC_DRAW_MAGENTA          6
98 #define PETSC_DRAW_AQUAMARINE       7
99 #define PETSC_DRAW_FORESTGREEN      8
100 #define PETSC_DRAW_ORANGE           9
101 #define PETSC_DRAW_VIOLET          10
102 #define PETSC_DRAW_BROWN           11
103 #define PETSC_DRAW_PINK            12
104 #define PETSC_DRAW_CORAL           13
105 #define PETSC_DRAW_GRAY            14
106 #define PETSC_DRAW_YELLOW          15
107 
108 #define PETSC_DRAW_GOLD            16
109 #define PETSC_DRAW_LIGHTPINK       17
110 #define PETSC_DRAW_MEDIUMTURQUOISE 18
111 #define PETSC_DRAW_KHAKI           19
112 #define PETSC_DRAW_DIMGRAY         20
113 #define PETSC_DRAW_YELLOWGREEN     21
114 #define PETSC_DRAW_SKYBLUE         22
115 #define PETSC_DRAW_DARKGREEN       23
116 #define PETSC_DRAW_NAVYBLUE        24
117 #define PETSC_DRAW_SANDYBROWN      25
118 #define PETSC_DRAW_CADETBLUE       26
119 #define PETSC_DRAW_POWDERBLUE      27
120 #define PETSC_DRAW_DEEPPINK        28
121 #define PETSC_DRAW_THISTLE         29
122 #define PETSC_DRAW_LIMEGREEN       30
123 #define PETSC_DRAW_LAVENDERBLUSH   31
124 #define PETSC_DRAW_PLUM            32
125 
126 PETSC_EXTERN PetscErrorCode PetscDrawOpenX(MPI_Comm,const char[],const char[],int,int,int,int,PetscDraw*);
127 PETSC_EXTERN PetscErrorCode PetscDrawOpenGLUT(MPI_Comm,const char[],const char[],int,int,int,int,PetscDraw*);
128 
129 #define PETSC_DRAW_FULL_SIZE    -3
130 #define PETSC_DRAW_HALF_SIZE    -4
131 #define PETSC_DRAW_THIRD_SIZE   -5
132 #define PETSC_DRAW_QUARTER_SIZE -6
133 
134 PETSC_EXTERN PetscErrorCode PetscDrawOpenNull(MPI_Comm,PetscDraw *);
135 PETSC_EXTERN PetscErrorCode PetscDrawDestroy(PetscDraw*);
136 PETSC_EXTERN PetscErrorCode PetscDrawIsNull(PetscDraw,PetscBool *);
137 
138 PETSC_EXTERN PetscErrorCode PetscDrawGetPopup(PetscDraw,PetscDraw*);
139 PETSC_EXTERN PetscErrorCode PetscDrawCheckResizedWindow(PetscDraw);
140 PETSC_EXTERN PetscErrorCode PetscDrawResizeWindow(PetscDraw,int,int);
141 
142 PETSC_EXTERN PetscErrorCode PetscDrawScalePopup(PetscDraw,PetscReal,PetscReal);
143 
144 PETSC_EXTERN PetscErrorCode PetscDrawPixelToCoordinate(PetscDraw,PetscInt,PetscInt,PetscReal*,PetscReal*);
145 PETSC_EXTERN PetscErrorCode PetscDrawCoordinateToPixel(PetscDraw,PetscReal,PetscReal,PetscInt*,PetscInt*);
146 
147 PETSC_EXTERN PetscErrorCode PetscDrawIndicatorFunction(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal,int,PetscErrorCode (*)(void*,PetscReal,PetscReal,PetscBool*),void*);
148 
149 PETSC_EXTERN PetscErrorCode PetscDrawLine(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal,int);
150 PETSC_EXTERN PetscErrorCode PetscDrawArrow(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal,int);
151 PETSC_EXTERN PetscErrorCode PetscDrawLineSetWidth(PetscDraw,PetscReal);
152 PETSC_EXTERN PetscErrorCode PetscDrawLineGetWidth(PetscDraw,PetscReal*);
153 
154 PETSC_EXTERN PetscErrorCode PetscDrawPoint(PetscDraw,PetscReal,PetscReal,int);
155 PETSC_EXTERN PetscErrorCode PetscDrawPointPixel(PetscDraw,PetscInt,PetscInt,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 PetscDrawBoxedString(PetscDraw,PetscReal,PetscReal,int,int,const char[],PetscReal*,PetscReal*);
166 PETSC_EXTERN PetscErrorCode PetscDrawBoxedStringSize(PetscDraw,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,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 PetscDrawFlush(PetscDraw);
187 PETSC_EXTERN PetscErrorCode PetscDrawSynchronizedFlush(PetscDraw);
188 PETSC_EXTERN PetscErrorCode PetscDrawClear(PetscDraw);
189 PETSC_EXTERN PetscErrorCode PetscDrawSave(PetscDraw);
190 PETSC_EXTERN PetscErrorCode PetscDrawSynchronizedClear(PetscDraw);
191 PETSC_EXTERN PetscErrorCode PetscDrawBOP(PetscDraw);
192 PETSC_EXTERN PetscErrorCode PetscDrawEOP(PetscDraw);
193 
194 PETSC_EXTERN PetscErrorCode PetscDrawSetDisplay(PetscDraw,const char[]);
195 PETSC_EXTERN PetscErrorCode PetscDrawGetSingleton(PetscDraw,PetscDraw*);
196 PETSC_EXTERN PetscErrorCode PetscDrawRestoreSingleton(PetscDraw,PetscDraw*);
197 
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*);
203 
204 /*E
205     PetscDrawButton - Used to determine which button was pressed
206 
207    Level: intermediate
208 
209 .seealso: PetscDrawGetMouseButton(), PetscDrawSynchronizedGetMouseButton()
210 E*/
211 typedef enum {PETSC_BUTTON_NONE,PETSC_BUTTON_LEFT,PETSC_BUTTON_CENTER,PETSC_BUTTON_RIGHT,PETSC_BUTTON_LEFT_SHIFT,PETSC_BUTTON_CENTER_SHIFT,PETSC_BUTTON_RIGHT_SHIFT} PetscDrawButton;
212 
213 PETSC_EXTERN PetscErrorCode PetscDrawGetMouseButton(PetscDraw,PetscDrawButton *,PetscReal*,PetscReal *,PetscReal *,PetscReal *);
214 PETSC_EXTERN PetscErrorCode PetscDrawSynchronizedGetMouseButton(PetscDraw,PetscDrawButton *,PetscReal*,PetscReal *,PetscReal *,PetscReal *);
215 
216 PETSC_EXTERN PetscErrorCode PetscDrawZoom(PetscDraw,PetscErrorCode (*)(PetscDraw,void *),void *);
217 
218 /*S
219      PetscDrawViewPorts - Subwindows in a PetscDraw object
220 
221    Level: intermediate
222 
223   Concepts: graphics
224 
225 .seealso:  PetscDrawViewPortsCreate(), PetscDrawViewPortsSet()
226 S*/
227 typedef struct {
228   PetscInt  nports;
229   PetscReal *xl;
230   PetscReal *xr;
231   PetscReal *yl;
232   PetscReal *yr;
233   PetscDraw draw;
234   PetscReal port_xl,port_yl,port_xr,port_yr;   /* original port of parent PetscDraw */
235 
236 } PetscDrawViewPorts;
237 PETSC_EXTERN PetscErrorCode PetscDrawViewPortsCreate(PetscDraw,PetscInt,PetscDrawViewPorts**);
238 PETSC_EXTERN PetscErrorCode PetscDrawViewPortsCreateRect(PetscDraw,PetscInt,PetscInt,PetscDrawViewPorts**);
239 PETSC_EXTERN PetscErrorCode PetscDrawViewPortsDestroy(PetscDrawViewPorts*);
240 PETSC_EXTERN PetscErrorCode PetscDrawViewPortsSet(PetscDrawViewPorts*,PetscInt);
241 
242 PETSC_EXTERN PetscClassId PETSC_DRAWAXIS_CLASSID;
243 
244 PETSC_EXTERN PetscErrorCode PetscDrawAxisCreate(PetscDraw,PetscDrawAxis *);
245 PETSC_EXTERN PetscErrorCode PetscDrawAxisDestroy(PetscDrawAxis*);
246 PETSC_EXTERN PetscErrorCode PetscDrawAxisDraw(PetscDrawAxis);
247 PETSC_EXTERN PetscErrorCode PetscDrawAxisSetLimits(PetscDrawAxis,PetscReal,PetscReal,PetscReal,PetscReal);
248 PETSC_EXTERN PetscErrorCode PetscDrawAxisGetLimits(PetscDrawAxis,PetscReal*,PetscReal*,PetscReal*,PetscReal*);
249 PETSC_EXTERN PetscErrorCode PetscDrawAxisSetHoldLimits(PetscDrawAxis,PetscBool );
250 PETSC_EXTERN PetscErrorCode PetscDrawAxisSetColors(PetscDrawAxis,int,int,int);
251 PETSC_EXTERN PetscErrorCode PetscDrawAxisSetLabels(PetscDrawAxis,const char[],const char[],const char[]);
252 
253 PETSC_EXTERN PetscClassId PETSC_DRAWLG_CLASSID;
254 
255 PETSC_EXTERN PetscErrorCode PetscDrawLGCreate(PetscDraw,PetscInt,PetscDrawLG *);
256 PETSC_EXTERN PetscErrorCode PetscDrawLGDestroy(PetscDrawLG*);
257 PETSC_EXTERN PetscErrorCode PetscDrawLGAddPoint(PetscDrawLG,const PetscReal*,const PetscReal*);
258 PETSC_EXTERN PetscErrorCode PetscDrawLGAddCommonPoint(PetscDrawLG,const PetscReal,const PetscReal*);
259 PETSC_EXTERN PetscErrorCode PetscDrawLGAddPoints(PetscDrawLG,PetscInt,PetscReal**,PetscReal**);
260 PETSC_EXTERN PetscErrorCode PetscDrawLGDraw(PetscDrawLG);
261 PETSC_EXTERN PetscErrorCode PetscDrawLGPrint(PetscDrawLG);
262 PETSC_EXTERN PetscErrorCode PetscDrawLGReset(PetscDrawLG);
263 PETSC_EXTERN PetscErrorCode PetscDrawLGSetDimension(PetscDrawLG,PetscInt);
264 PETSC_EXTERN PetscErrorCode PetscDrawLGGetDimension(PetscDrawLG,PetscInt*);
265 PETSC_EXTERN PetscErrorCode PetscDrawLGSetLegend(PetscDrawLG,const char *const*);
266 PETSC_EXTERN PetscErrorCode PetscDrawLGGetAxis(PetscDrawLG,PetscDrawAxis *);
267 PETSC_EXTERN PetscErrorCode PetscDrawLGGetDraw(PetscDrawLG,PetscDraw *);
268 PETSC_EXTERN PetscErrorCode PetscDrawLGIndicateDataPoints(PetscDrawLG);
269 PETSC_EXTERN PetscErrorCode PetscDrawLGSetLimits(PetscDrawLG,PetscReal,PetscReal,PetscReal,PetscReal);
270 PETSC_EXTERN PetscErrorCode PetscDrawLGSetColors(PetscDrawLG,const int*);
271 
272 PETSC_EXTERN PetscClassId PETSC_DRAWSP_CLASSID;
273 
274 PETSC_EXTERN PetscErrorCode PetscDrawSPCreate(PetscDraw,int,PetscDrawSP *);
275 PETSC_EXTERN PetscErrorCode PetscDrawSPDestroy(PetscDrawSP*);
276 PETSC_EXTERN PetscErrorCode PetscDrawSPAddPoint(PetscDrawSP,PetscReal*,PetscReal*);
277 PETSC_EXTERN PetscErrorCode PetscDrawSPAddPoints(PetscDrawSP,int,PetscReal**,PetscReal**);
278 PETSC_EXTERN PetscErrorCode PetscDrawSPDraw(PetscDrawSP,PetscBool);
279 PETSC_EXTERN PetscErrorCode PetscDrawSPReset(PetscDrawSP);
280 PETSC_EXTERN PetscErrorCode PetscDrawSPSetDimension(PetscDrawSP,int);
281 PETSC_EXTERN PetscErrorCode PetscDrawSPGetAxis(PetscDrawSP,PetscDrawAxis *);
282 PETSC_EXTERN PetscErrorCode PetscDrawSPGetDraw(PetscDrawSP,PetscDraw *);
283 PETSC_EXTERN PetscErrorCode PetscDrawSPSetLimits(PetscDrawSP,PetscReal,PetscReal,PetscReal,PetscReal);
284 PETSC_EXTERN PetscErrorCode PetscDrawLGSPDraw(PetscDrawLG,PetscDrawSP);
285 
286 PETSC_EXTERN PetscClassId PETSC_DRAWHG_CLASSID;
287 
288 PETSC_EXTERN PetscErrorCode PetscDrawHGCreate(PetscDraw,int,PetscDrawHG *);
289 PETSC_EXTERN PetscErrorCode PetscDrawHGDestroy(PetscDrawHG*);
290 PETSC_EXTERN PetscErrorCode PetscDrawHGAddValue(PetscDrawHG,PetscReal);
291 PETSC_EXTERN PetscErrorCode PetscDrawHGDraw(PetscDrawHG);
292 PETSC_EXTERN PetscErrorCode PetscDrawHGPrint(PetscDrawHG);
293 PETSC_EXTERN PetscErrorCode PetscDrawHGReset(PetscDrawHG);
294 PETSC_EXTERN PetscErrorCode PetscDrawHGGetAxis(PetscDrawHG,PetscDrawAxis *);
295 PETSC_EXTERN PetscErrorCode PetscDrawHGGetDraw(PetscDrawHG,PetscDraw *);
296 PETSC_EXTERN PetscErrorCode PetscDrawHGSetLimits(PetscDrawHG,PetscReal,PetscReal,int,int);
297 PETSC_EXTERN PetscErrorCode PetscDrawHGSetNumberBins(PetscDrawHG,int);
298 PETSC_EXTERN PetscErrorCode PetscDrawHGSetColor(PetscDrawHG,int);
299 PETSC_EXTERN PetscErrorCode PetscDrawHGCalcStats(PetscDrawHG, PetscBool );
300 PETSC_EXTERN PetscErrorCode PetscDrawHGIntegerBins(PetscDrawHG, PetscBool );
301 
302 /*
303     PetscViewer routines that allow you to access underlying PetscDraw objects
304 */
305 PETSC_EXTERN PetscErrorCode PetscViewerDrawGetDraw(PetscViewer,PetscInt,PetscDraw*);
306 PETSC_EXTERN PetscErrorCode PetscViewerDrawBaseAdd(PetscViewer,PetscInt);
307 PETSC_EXTERN PetscErrorCode PetscViewerDrawBaseSet(PetscViewer,PetscInt);
308 PETSC_EXTERN PetscErrorCode PetscViewerDrawGetDrawLG(PetscViewer,PetscInt,PetscDrawLG*);
309 PETSC_EXTERN PetscErrorCode PetscViewerDrawGetDrawAxis(PetscViewer,PetscInt,PetscDrawAxis*);
310 
311 PETSC_EXTERN PetscErrorCode PetscDrawUtilitySetCmapHue(unsigned char *,unsigned char *,unsigned char *,int);
312 PETSC_EXTERN PetscErrorCode PetscDrawUtilitySetGamma(PetscReal);
313 
314 #endif
315