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