xref: /petsc/include/petscdraw.h (revision a58c3bc3391eee32bc3fd94ac7edeea38fe57aae)
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 "petsc.h"
7 PETSC_EXTERN_CXX_BEGIN
8 
9 extern PetscCookie PETSC_DRAW_COOKIE;
10 
11 /*E
12     PetscDrawType - String with the name of a PetscDraw
13 
14    Level: beginner
15 
16 .seealso: PetscDrawSetType(), PetscDraw, PetscViewer
17 E*/
18 #define PetscDrawType const char*
19 #define PETSC_DRAW_X     "x"
20 #define PETSC_DRAW_NULL  "null"
21 #define PETSC_DRAW_PS    "ps"
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 extern PetscFList PetscDrawList;
36 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawRegisterAll(const char[]);
37 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawInitializePackage(const char[]);
38 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawRegisterDestroy(void);
39 
40 EXTERN PetscErrorCode PETSC_DLLEXPORT 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(char *name_solver,char *path,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 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawGetType(PetscDraw,PetscDrawType*);
87 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawSetType(PetscDraw,PetscDrawType);
88 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscDraw*);
89 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawSetFromOptions(PetscDraw);
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 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawOpenX(MPI_Comm,const char[],const char[],int,int,int,int,PetscDraw*);
134 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawOpenPS(MPI_Comm,char *,PetscDraw *);
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 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawOpenNull(MPI_Comm,PetscDraw *);
141 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawDestroy(PetscDraw);
142 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawIsNull(PetscDraw,PetscTruth*);
143 
144 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawGetPopup(PetscDraw,PetscDraw*);
145 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawCheckResizedWindow(PetscDraw);
146 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawResizeWindow(PetscDraw,int,int);
147 
148 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawScalePopup(PetscDraw,PetscReal,PetscReal);
149 
150 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawLine(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal,int);
151 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawLineSetWidth(PetscDraw,PetscReal);
152 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawLineGetWidth(PetscDraw,PetscReal*);
153 
154 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawPoint(PetscDraw,PetscReal,PetscReal,int);
155 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawPointSetSize(PetscDraw,PetscReal);
156 
157 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawRectangle(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal,int,int,int,int);
158 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawTriangle(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,int,int,int);
159 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawEllipse(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal,int);
160 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawTensorContourPatch(PetscDraw,int,int,PetscReal*,PetscReal*,PetscReal,PetscReal,PetscReal*);
161 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawTensorContour(PetscDraw,int,int,const PetscReal[],const PetscReal[],PetscReal *);
162 
163 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawString(PetscDraw,PetscReal,PetscReal,int,const char[]);
164 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawStringVertical(PetscDraw,PetscReal,PetscReal,int,const char[]);
165 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawStringSetSize(PetscDraw,PetscReal,PetscReal);
166 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawStringGetSize(PetscDraw,PetscReal*,PetscReal*);
167 
168 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawSetViewPort(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal);
169 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawSplitViewPort(PetscDraw);
170 
171 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawSetCoordinates(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal);
172 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawGetCoordinates(PetscDraw,PetscReal*,PetscReal*,PetscReal*,PetscReal*);
173 
174 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawSetTitle(PetscDraw,const char[]);
175 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawAppendTitle(PetscDraw,const char[]);
176 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawGetTitle(PetscDraw,char **);
177 
178 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawSetPause(PetscDraw,int);
179 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawGetPause(PetscDraw,int*);
180 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawPause(PetscDraw);
181 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawSetDoubleBuffer(PetscDraw);
182 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawFlush(PetscDraw);
183 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawSynchronizedFlush(PetscDraw);
184 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawClear(PetscDraw);
185 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawSynchronizedClear(PetscDraw);
186 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawBOP(PetscDraw);
187 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawEOP(PetscDraw);
188 
189 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawSetDisplay(PetscDraw,char*);
190 #define PetscDrawSetFilename(a,b) PetscDrawSetDisplay(a,b)
191 
192 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawGetSingleton(PetscDraw,PetscDraw*);
193 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawRestoreSingleton(PetscDraw,PetscDraw*);
194 
195 /*E
196     PetscDrawButton - Used to determine which button was pressed
197 
198    Level: intermediate
199 
200 .seealso: PetscDrawGetMouseButton(), PetscDrawSynchronizedGetMouseButton()
201 E*/
202 typedef enum {BUTTON_NONE,BUTTON_LEFT,BUTTON_CENTER,BUTTON_RIGHT,BUTTON_LEFT_SHIFT,BUTTON_CENTER_SHIFT,BUTTON_RIGHT_SHIFT} PetscDrawButton;
203 
204 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawGetMouseButton(PetscDraw,PetscDrawButton *,PetscReal*,PetscReal *,PetscReal *,PetscReal *);
205 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawSynchronizedGetMouseButton(PetscDraw,PetscDrawButton *,PetscReal*,PetscReal *,PetscReal *,PetscReal *);
206 
207 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawZoom(PetscDraw,PetscErrorCode (*)(PetscDraw,void *),void *);
208 
209 /*S
210      PetscDrawViewPorts - Subwindows in a PetscDraw object
211 
212    Level: intermediate
213 
214   Concepts: graphics
215 
216 .seealso:  PetscDrawViewPortsCreate(), PetscDrawViewPortsSet()
217 S*/
218 typedef struct {
219   PetscInt  nports;
220   PetscReal *xl;
221   PetscReal *xr;
222   PetscReal *yl;
223   PetscReal *yr;
224   PetscDraw draw;
225 } PetscDrawViewPorts;
226 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawViewPortsCreate(PetscDraw,PetscInt,PetscDrawViewPorts**);
227 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawViewPortsCreateRect(PetscDraw,PetscInt,PetscInt,PetscDrawViewPorts**);
228 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawViewPortsDestroy(PetscDrawViewPorts*);
229 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawViewPortsSet(PetscDrawViewPorts*,int);
230 
231 /*S
232      PetscDrawAxis - Manages X-Y axis
233 
234    Level: advanced
235 
236   Concepts: graphics, axis
237 
238 .seealso:  PetscDrawAxisCreate(), PetscDrawAxisSetLimits(), PetscDrawAxisSetColors(), PetscDrawAxisSetLabels()
239 S*/
240 typedef struct _p_DrawAxis* PetscDrawAxis;
241 
242 extern PetscCookie DRAWAXIS_COOKIE;
243 
244 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawAxisCreate(PetscDraw,PetscDrawAxis *);
245 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawAxisDestroy(PetscDrawAxis);
246 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawAxisDraw(PetscDrawAxis);
247 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawAxisSetLimits(PetscDrawAxis,PetscReal,PetscReal,PetscReal,PetscReal);
248 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawAxisSetHoldLimits(PetscDrawAxis,PetscTruth);
249 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawAxisSetColors(PetscDrawAxis,int,int,int);
250 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawAxisSetLabels(PetscDrawAxis,const char[],const char[],const char[]);
251 
252 /*S
253      PetscDrawLG - Manages drawing x-y plots
254 
255    Level: advanced
256 
257   Concepts: graphics, axis
258 
259 .seealso:  PetscDrawAxisCreate(), PetscDrawLGCreate(), PetscDrawLGAddPoint()
260 S*/
261 typedef struct _p_DrawLG*   PetscDrawLG;
262 
263 extern PetscCookie DRAWLG_COOKIE;
264 
265 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawLGCreate(PetscDraw,int,PetscDrawLG *);
266 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawLGDestroy(PetscDrawLG);
267 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawLGAddPoint(PetscDrawLG,PetscReal*,PetscReal*);
268 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawLGAddPoints(PetscDrawLG,int,PetscReal**,PetscReal**);
269 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawLGDraw(PetscDrawLG);
270 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawLGPrint(PetscDrawLG);
271 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawLGReset(PetscDrawLG);
272 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawLGSetDimension(PetscDrawLG,int);
273 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawLGGetAxis(PetscDrawLG,PetscDrawAxis *);
274 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawLGGetDraw(PetscDrawLG,PetscDraw *);
275 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawLGIndicateDataPoints(PetscDrawLG);
276 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawLGSetLimits(PetscDrawLG,PetscReal,PetscReal,PetscReal,PetscReal);
277 
278 /*S
279      PetscDrawSP - Manages drawing scatter plots
280 
281    Level: advanced
282 
283   Concepts: graphics, scatter plots
284 
285 .seealso:  PetscDrawSPCreate()
286 S*/
287 typedef struct _p_DrawSP*   PetscDrawSP;
288 
289 extern PetscCookie DRAWSP_COOKIE;
290 
291 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawSPCreate(PetscDraw,int,PetscDrawSP *);
292 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawSPDestroy(PetscDrawSP);
293 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawSPAddPoint(PetscDrawSP,PetscReal*,PetscReal*);
294 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawSPAddPoints(PetscDrawSP,int,PetscReal**,PetscReal**);
295 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawSPDraw(PetscDrawSP);
296 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawSPReset(PetscDrawSP);
297 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawSPSetDimension(PetscDrawSP,int);
298 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawSPGetAxis(PetscDrawSP,PetscDrawAxis *);
299 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawSPGetDraw(PetscDrawSP,PetscDraw *);
300 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawSPSetLimits(PetscDrawSP,PetscReal,PetscReal,PetscReal,PetscReal);
301 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawLGSPDraw(PetscDrawLG,PetscDrawSP);
302 
303 /*S
304      PetscDrawHG - Manages drawing histograms
305 
306    Level: advanced
307 
308   Concepts: graphics, histograms
309 
310 .seealso:  PetscDrawHGCreate()
311 S*/
312 typedef struct _p_DrawHG*   PetscDrawHG;
313 
314 extern PetscCookie DRAWHG_COOKIE;
315 
316 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawHGCreate(PetscDraw,int,PetscDrawHG *);
317 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawHGDestroy(PetscDrawHG);
318 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawHGAddValue(PetscDrawHG,PetscReal);
319 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawHGDraw(PetscDrawHG);
320 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawHGPrint(PetscDrawHG);
321 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawHGReset(PetscDrawHG);
322 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawHGGetAxis(PetscDrawHG,PetscDrawAxis *);
323 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawHGGetDraw(PetscDrawHG,PetscDraw *);
324 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawHGSetLimits(PetscDrawHG,PetscReal,PetscReal,int,int);
325 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawHGSetNumberBins(PetscDrawHG,int);
326 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawHGSetColor(PetscDrawHG,int);
327 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawHGCalcStats(PetscDrawHG, PetscTruth);
328 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawHGIntegerBins(PetscDrawHG, PetscTruth);
329 
330 /*
331     PetscViewer routines that allow you to access underlying PetscDraw objects
332 */
333 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerDrawGetDraw(PetscViewer,PetscInt,PetscDraw*);
334 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerDrawBaseAdd(PetscViewer,PetscInt);
335 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerDrawBaseSet(PetscViewer,PetscInt);
336 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerDrawGetDrawLG(PetscViewer,PetscInt,PetscDrawLG*);
337 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscViewerDrawGetDrawAxis(PetscViewer,PetscInt,PetscDrawAxis*);
338 
339 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawUtilitySetCmapHue(unsigned char *,unsigned char *,unsigned char *,int);
340 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDrawUtilitySetGamma(PetscReal);
341 
342 PETSC_EXTERN_CXX_END
343 #endif
344