xref: /petsc/include/petscdraw.h (revision a8a8f36618f536eff5e4c1df78b3fdf9dd5d254e) 
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 
8 PETSC_EXTERN PetscClassId PETSC_DRAW_CLASSID;
9 
10 /*J
11     PetscDrawType - String with the name of a PetscDraw
12 
13    Level: beginner
14 
15 .seealso: PetscDrawSetType(), PetscDraw, PetscViewer
16 J*/
17 #define PetscDrawType  char*
18 #define PETSC_DRAW_X      "x"
19 #define PETSC_DRAW_OPENGL "opengl"
20 #define PETSC_DRAW_NULL   "null"
21 #define PETSC_DRAW_WIN32  "win32"
22 
23 /*S
24      PetscDraw - Abstract PETSc object for graphics
25 
26    Level: beginner
27 
28   Concepts: graphics
29 
30 .seealso:  PetscDrawCreate(), PetscDrawSetType(), PetscDrawType
31 S*/
32 typedef struct _p_PetscDraw* PetscDraw;
33 
34 PETSC_EXTERN PetscFList PetscDrawList;
35 PETSC_EXTERN PetscErrorCode PetscDrawRegisterAll(const char[]);
36 PETSC_EXTERN PetscErrorCode PetscDrawInitializePackage(const char[]);
37 PETSC_EXTERN PetscErrorCode PetscDrawRegisterDestroy(void);
38 
39 PETSC_EXTERN PetscErrorCode PetscDrawRegister(const char*,const char*,const char*,PetscErrorCode(*)(PetscDraw));
40 
41 /*MC
42    PetscDrawRegisterDynamic - Adds a method to the Krylov subspace solver package.
43 
44    Synopsis:
45    PetscErrorCode PetscDrawRegisterDynamic(const char *name_solver,const char *path,const char *name_create,PetscErrorCode (*routine_create)(PetscDraw))
46 
47    Not Collective
48 
49    Input Parameters:
50 +  name_solver - name of a new user-defined solver
51 .  path - path (either absolute or relative) the library containing this solver
52 .  name_create - name of routine to create method context
53 -  routine_create - routine to create method context
54 
55    Level: developer
56 
57    Notes:
58    PetscDrawRegisterDynamic() may be called multiple times to add several user-defined solvers.
59 
60    If dynamic libraries are used, then the fourth input argument (routine_create)
61    is ignored.
62 
63    Sample usage:
64 .vb
65    PetscDrawRegisterDynamic("my_draw_type",/home/username/my_lib/lib/libO/solaris/mylib.a,
66                "MyDrawCreate",MyDrawCreate);
67 .ve
68 
69    Then, your solver can be chosen with the procedural interface via
70 $     PetscDrawSetType(ksp,"my_draw_type")
71    or at runtime via the option
72 $     -draw_type my_draw_type
73 
74    Concepts: graphics^registering new draw classes
75    Concepts: PetscDraw^registering new draw classes
76 
77 .seealso: PetscDrawRegisterAll(), PetscDrawRegisterDestroy()
78 M*/
79 #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
80 #define PetscDrawRegisterDynamic(a,b,c,d) PetscDrawRegister(a,b,c,0)
81 #else
82 #define PetscDrawRegisterDynamic(a,b,c,d) PetscDrawRegister(a,b,c,d)
83 #endif
84 
85 PETSC_EXTERN PetscErrorCode PetscDrawGetType(PetscDraw,const PetscDrawType*);
86 PETSC_EXTERN PetscErrorCode PetscDrawSetType(PetscDraw,const PetscDrawType);
87 PETSC_EXTERN PetscErrorCode PetscDrawCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscDraw*);
88 PETSC_EXTERN PetscErrorCode PetscDrawSetFromOptions(PetscDraw);
89 PETSC_EXTERN PetscErrorCode PetscDrawSetSave(PetscDraw,const char*,PetscBool);
90 
91 /*
92    Number of basic colors in the draw routines, the others are used
93    for a uniform colormap.
94 */
95 #define PETSC_DRAW_BASIC_COLORS 33
96 
97 #define PETSC_DRAW_ROTATE          -1         /* will rotate through the colors, start with 2 */
98 #define PETSC_DRAW_WHITE            0
99 #define PETSC_DRAW_BLACK            1
100 #define PETSC_DRAW_RED              2
101 #define PETSC_DRAW_GREEN            3
102 #define PETSC_DRAW_CYAN             4
103 #define PETSC_DRAW_BLUE             5
104 #define PETSC_DRAW_MAGENTA          6
105 #define PETSC_DRAW_AQUAMARINE       7
106 #define PETSC_DRAW_FORESTGREEN      8
107 #define PETSC_DRAW_ORANGE           9
108 #define PETSC_DRAW_VIOLET          10
109 #define PETSC_DRAW_BROWN           11
110 #define PETSC_DRAW_PINK            12
111 #define PETSC_DRAW_CORAL           13
112 #define PETSC_DRAW_GRAY            14
113 #define PETSC_DRAW_YELLOW          15
114 
115 #define PETSC_DRAW_GOLD            16
116 #define PETSC_DRAW_LIGHTPINK       17
117 #define PETSC_DRAW_MEDIUMTURQUOISE 18
118 #define PETSC_DRAW_KHAKI           19
119 #define PETSC_DRAW_DIMGRAY         20
120 #define PETSC_DRAW_YELLOWGREEN     21
121 #define PETSC_DRAW_SKYBLUE         22
122 #define PETSC_DRAW_DARKGREEN       23
123 #define PETSC_DRAW_NAVYBLUE        24
124 #define PETSC_DRAW_SANDYBROWN      25
125 #define PETSC_DRAW_CADETBLUE       26
126 #define PETSC_DRAW_POWDERBLUE      27
127 #define PETSC_DRAW_DEEPPINK        28
128 #define PETSC_DRAW_THISTLE         29
129 #define PETSC_DRAW_LIMEGREEN       30
130 #define PETSC_DRAW_LAVENDERBLUSH   31
131 #define PETSC_DRAW_PLUM            32
132 
133 PETSC_EXTERN PetscErrorCode PetscDrawOpenX(MPI_Comm,const char[],const char[],int,int,int,int,PetscDraw*);
134 
135 #define PETSC_DRAW_FULL_SIZE    -3
136 #define PETSC_DRAW_HALF_SIZE    -4
137 #define PETSC_DRAW_THIRD_SIZE   -5
138 #define PETSC_DRAW_QUARTER_SIZE -6
139 
140 PETSC_EXTERN PetscErrorCode PetscDrawOpenNull(MPI_Comm,PetscDraw *);
141 PETSC_EXTERN PetscErrorCode PetscDrawDestroy(PetscDraw*);
142 PETSC_EXTERN PetscErrorCode PetscDrawIsNull(PetscDraw,PetscBool *);
143 
144 PETSC_EXTERN PetscErrorCode PetscDrawGetPopup(PetscDraw,PetscDraw*);
145 PETSC_EXTERN PetscErrorCode PetscDrawCheckResizedWindow(PetscDraw);
146 PETSC_EXTERN PetscErrorCode PetscDrawResizeWindow(PetscDraw,int,int);
147 
148 PETSC_EXTERN PetscErrorCode PetscDrawScalePopup(PetscDraw,PetscReal,PetscReal);
149 
150 PETSC_EXTERN PetscErrorCode PetscDrawLine(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal,int);
151 PETSC_EXTERN PetscErrorCode PetscDrawArrow(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal,int);
152 PETSC_EXTERN PetscErrorCode PetscDrawLineSetWidth(PetscDraw,PetscReal);
153 PETSC_EXTERN PetscErrorCode PetscDrawLineGetWidth(PetscDraw,PetscReal*);
154 
155 PETSC_EXTERN PetscErrorCode PetscDrawPoint(PetscDraw,PetscReal,PetscReal,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 PetscDrawStringVertical(PetscDraw,PetscReal,PetscReal,int,const char[]);
166 PETSC_EXTERN PetscErrorCode PetscDrawStringSetSize(PetscDraw,PetscReal,PetscReal);
167 PETSC_EXTERN PetscErrorCode PetscDrawStringGetSize(PetscDraw,PetscReal*,PetscReal*);
168 
169 PETSC_EXTERN PetscErrorCode PetscDrawSetViewPort(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal);
170 PETSC_EXTERN PetscErrorCode PetscDrawSplitViewPort(PetscDraw);
171 
172 PETSC_EXTERN PetscErrorCode PetscDrawSetCoordinates(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal);
173 PETSC_EXTERN PetscErrorCode PetscDrawGetCoordinates(PetscDraw,PetscReal*,PetscReal*,PetscReal*,PetscReal*);
174 
175 PETSC_EXTERN PetscErrorCode PetscDrawSetTitle(PetscDraw,const char[]);
176 PETSC_EXTERN PetscErrorCode PetscDrawAppendTitle(PetscDraw,const char[]);
177 PETSC_EXTERN PetscErrorCode PetscDrawGetTitle(PetscDraw,char **);
178 
179 PETSC_EXTERN PetscErrorCode PetscDrawSetPause(PetscDraw,PetscReal);
180 PETSC_EXTERN PetscErrorCode PetscDrawGetPause(PetscDraw,PetscReal*);
181 PETSC_EXTERN PetscErrorCode PetscDrawPause(PetscDraw);
182 PETSC_EXTERN PetscErrorCode PetscDrawSetDoubleBuffer(PetscDraw);
183 PETSC_EXTERN PetscErrorCode PetscDrawFlush(PetscDraw);
184 PETSC_EXTERN PetscErrorCode PetscDrawSynchronizedFlush(PetscDraw);
185 PETSC_EXTERN PetscErrorCode PetscDrawClear(PetscDraw);
186 PETSC_EXTERN PetscErrorCode PetscDrawSave(PetscDraw);
187 PETSC_EXTERN PetscErrorCode PetscDrawSynchronizedClear(PetscDraw);
188 PETSC_EXTERN PetscErrorCode PetscDrawBOP(PetscDraw);
189 PETSC_EXTERN PetscErrorCode PetscDrawEOP(PetscDraw);
190 
191 PETSC_EXTERN PetscErrorCode PetscDrawSetDisplay(PetscDraw,char*);
192 #define PetscDrawSetFilename(a,b) PetscDrawSetDisplay(a,b)
193 
194 PETSC_EXTERN PetscErrorCode PetscDrawGetSingleton(PetscDraw,PetscDraw*);
195 PETSC_EXTERN PetscErrorCode PetscDrawRestoreSingleton(PetscDraw,PetscDraw*);
196 
197 /*E
198     PetscDrawButton - Used to determine which button was pressed
199 
200    Level: intermediate
201 
202 .seealso: PetscDrawGetMouseButton(), PetscDrawSynchronizedGetMouseButton()
203 E*/
204 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;
205 
206 PETSC_EXTERN PetscErrorCode PetscDrawGetMouseButton(PetscDraw,PetscDrawButton *,PetscReal*,PetscReal *,PetscReal *,PetscReal *);
207 PETSC_EXTERN PetscErrorCode PetscDrawSynchronizedGetMouseButton(PetscDraw,PetscDrawButton *,PetscReal*,PetscReal *,PetscReal *,PetscReal *);
208 
209 PETSC_EXTERN PetscErrorCode PetscDrawZoom(PetscDraw,PetscErrorCode (*)(PetscDraw,void *),void *);
210 
211 /*S
212      PetscDrawViewPorts - Subwindows in a PetscDraw object
213 
214    Level: intermediate
215 
216   Concepts: graphics
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 } PetscDrawViewPorts;
228 PETSC_EXTERN PetscErrorCode PetscDrawViewPortsCreate(PetscDraw,PetscInt,PetscDrawViewPorts**);
229 PETSC_EXTERN PetscErrorCode PetscDrawViewPortsCreateRect(PetscDraw,PetscInt,PetscInt,PetscDrawViewPorts**);
230 PETSC_EXTERN PetscErrorCode PetscDrawViewPortsDestroy(PetscDrawViewPorts*);
231 PETSC_EXTERN PetscErrorCode PetscDrawViewPortsSet(PetscDrawViewPorts*,PetscInt);
232 
233 /*S
234      PetscDrawAxis - Manages X-Y axis
235 
236    Level: advanced
237 
238   Concepts: graphics, axis
239 
240 .seealso:  PetscDrawAxisCreate(), PetscDrawAxisSetLimits(), PetscDrawAxisSetColors(), PetscDrawAxisSetLabels()
241 S*/
242 typedef struct _p_PetscDrawAxis* PetscDrawAxis;
243 
244 PETSC_EXTERN PetscClassId PETSC_DRAWAXIS_CLASSID;
245 
246 PETSC_EXTERN PetscErrorCode PetscDrawAxisCreate(PetscDraw,PetscDrawAxis *);
247 PETSC_EXTERN PetscErrorCode PetscDrawAxisDestroy(PetscDrawAxis*);
248 PETSC_EXTERN PetscErrorCode PetscDrawAxisDraw(PetscDrawAxis);
249 PETSC_EXTERN PetscErrorCode PetscDrawAxisSetLimits(PetscDrawAxis,PetscReal,PetscReal,PetscReal,PetscReal);
250 PETSC_EXTERN PetscErrorCode PetscDrawAxisSetHoldLimits(PetscDrawAxis,PetscBool );
251 PETSC_EXTERN PetscErrorCode PetscDrawAxisSetColors(PetscDrawAxis,int,int,int);
252 PETSC_EXTERN PetscErrorCode PetscDrawAxisSetLabels(PetscDrawAxis,const char[],const char[],const char[]);
253 
254 /*S
255      PetscDrawLG - Manages drawing x-y plots
256 
257    Level: advanced
258 
259   Concepts: graphics, axis
260 
261 .seealso:  PetscDrawAxisCreate(), PetscDrawLGCreate(), PetscDrawLGAddPoint()
262 S*/
263 typedef struct _p_PetscDrawLG*   PetscDrawLG;
264 
265 PETSC_EXTERN PetscClassId PETSC_DRAWLG_CLASSID;
266 
267 PETSC_EXTERN PetscErrorCode PetscDrawLGCreate(PetscDraw,int,PetscDrawLG *);
268 PETSC_EXTERN PetscErrorCode PetscDrawLGDestroy(PetscDrawLG*);
269 PETSC_EXTERN PetscErrorCode PetscDrawLGAddPoint(PetscDrawLG,PetscReal*,PetscReal*);
270 PETSC_EXTERN PetscErrorCode PetscDrawLGAddPoints(PetscDrawLG,int,PetscReal**,PetscReal**);
271 PETSC_EXTERN PetscErrorCode PetscDrawLGDraw(PetscDrawLG);
272 PETSC_EXTERN PetscErrorCode PetscDrawLGPrint(PetscDrawLG);
273 PETSC_EXTERN PetscErrorCode PetscDrawLGReset(PetscDrawLG);
274 PETSC_EXTERN PetscErrorCode PetscDrawLGSetDimension(PetscDrawLG,PetscInt);
275 PETSC_EXTERN PetscErrorCode PetscDrawLGSetLegend(PetscDrawLG,const char *const*);
276 PETSC_EXTERN PetscErrorCode PetscDrawLGGetAxis(PetscDrawLG,PetscDrawAxis *);
277 PETSC_EXTERN PetscErrorCode PetscDrawLGGetDraw(PetscDrawLG,PetscDraw *);
278 PETSC_EXTERN PetscErrorCode PetscDrawLGIndicateDataPoints(PetscDrawLG);
279 PETSC_EXTERN PetscErrorCode PetscDrawLGSetLimits(PetscDrawLG,PetscReal,PetscReal,PetscReal,PetscReal);
280 PETSC_EXTERN PetscErrorCode PetscDrawLGSetColors(PetscDrawLG,const int*);
281 
282 /*S
283      PetscDrawSP - Manages drawing scatter plots
284 
285    Level: advanced
286 
287   Concepts: graphics, scatter plots
288 
289 .seealso:  PetscDrawSPCreate()
290 S*/
291 typedef struct _p_PetscDrawSP*   PetscDrawSP;
292 
293 PETSC_EXTERN PetscClassId PETSC_DRAWSP_CLASSID;
294 
295 PETSC_EXTERN PetscErrorCode PetscDrawSPCreate(PetscDraw,int,PetscDrawSP *);
296 PETSC_EXTERN PetscErrorCode PetscDrawSPDestroy(PetscDrawSP*);
297 PETSC_EXTERN PetscErrorCode PetscDrawSPAddPoint(PetscDrawSP,PetscReal*,PetscReal*);
298 PETSC_EXTERN PetscErrorCode PetscDrawSPAddPoints(PetscDrawSP,int,PetscReal**,PetscReal**);
299 PETSC_EXTERN PetscErrorCode PetscDrawSPDraw(PetscDrawSP);
300 PETSC_EXTERN PetscErrorCode PetscDrawSPReset(PetscDrawSP);
301 PETSC_EXTERN PetscErrorCode PetscDrawSPSetDimension(PetscDrawSP,int);
302 PETSC_EXTERN PetscErrorCode PetscDrawSPGetAxis(PetscDrawSP,PetscDrawAxis *);
303 PETSC_EXTERN PetscErrorCode PetscDrawSPGetDraw(PetscDrawSP,PetscDraw *);
304 PETSC_EXTERN PetscErrorCode PetscDrawSPSetLimits(PetscDrawSP,PetscReal,PetscReal,PetscReal,PetscReal);
305 PETSC_EXTERN PetscErrorCode PetscDrawLGSPDraw(PetscDrawLG,PetscDrawSP);
306 
307 /*S
308      PetscDrawHG - Manages drawing histograms
309 
310    Level: advanced
311 
312   Concepts: graphics, histograms
313 
314 .seealso:  PetscDrawHGCreate()
315 S*/
316 typedef struct _p_PetscDrawHG*   PetscDrawHG;
317 
318 PETSC_EXTERN PetscClassId PETSC_DRAWHG_CLASSID;
319 
320 PETSC_EXTERN PetscErrorCode PetscDrawHGCreate(PetscDraw,int,PetscDrawHG *);
321 PETSC_EXTERN PetscErrorCode PetscDrawHGDestroy(PetscDrawHG*);
322 PETSC_EXTERN PetscErrorCode PetscDrawHGAddValue(PetscDrawHG,PetscReal);
323 PETSC_EXTERN PetscErrorCode PetscDrawHGDraw(PetscDrawHG);
324 PETSC_EXTERN PetscErrorCode PetscDrawHGPrint(PetscDrawHG);
325 PETSC_EXTERN PetscErrorCode PetscDrawHGReset(PetscDrawHG);
326 PETSC_EXTERN PetscErrorCode PetscDrawHGGetAxis(PetscDrawHG,PetscDrawAxis *);
327 PETSC_EXTERN PetscErrorCode PetscDrawHGGetDraw(PetscDrawHG,PetscDraw *);
328 PETSC_EXTERN PetscErrorCode PetscDrawHGSetLimits(PetscDrawHG,PetscReal,PetscReal,int,int);
329 PETSC_EXTERN PetscErrorCode PetscDrawHGSetNumberBins(PetscDrawHG,int);
330 PETSC_EXTERN PetscErrorCode PetscDrawHGSetColor(PetscDrawHG,int);
331 PETSC_EXTERN PetscErrorCode PetscDrawHGCalcStats(PetscDrawHG, PetscBool );
332 PETSC_EXTERN PetscErrorCode PetscDrawHGIntegerBins(PetscDrawHG, PetscBool );
333 
334 /*
335     PetscViewer routines that allow you to access underlying PetscDraw objects
336 */
337 PETSC_EXTERN PetscErrorCode PetscViewerDrawGetDraw(PetscViewer,PetscInt,PetscDraw*);
338 PETSC_EXTERN PetscErrorCode PetscViewerDrawBaseAdd(PetscViewer,PetscInt);
339 PETSC_EXTERN PetscErrorCode PetscViewerDrawBaseSet(PetscViewer,PetscInt);
340 PETSC_EXTERN PetscErrorCode PetscViewerDrawGetDrawLG(PetscViewer,PetscInt,PetscDrawLG*);
341 PETSC_EXTERN PetscErrorCode PetscViewerDrawGetDrawAxis(PetscViewer,PetscInt,PetscDrawAxis*);
342 
343 PETSC_EXTERN PetscErrorCode PetscDrawUtilitySetCmapHue(unsigned char *,unsigned char *,unsigned char *,int);
344 PETSC_EXTERN PetscErrorCode PetscDrawUtilitySetGamma(PetscReal);
345 
346 #endif
347