Actual source code: petscdraw.h
1: /* $Id: petscdraw.h,v 1.79 2001/09/07 20:07:55 bsmith Exp $ */
2: /*
3: Interface to the PETSc graphics (currently only support for X-windows
4: */
7: #include petsc.h
9: extern int PETSC_DRAW_COOKIE;
11: /*E
12: PetscDrawType - String with the name of a PetscDraw
14: Level: beginner
16: .seealso: PetscDrawSetType(), PetscDraw, PetscViewer
17: E*/
18: typedef char* PetscDrawType;
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
27: Level: beginner
29: Concepts: graphics
31: .seealso: PetscDrawCreate(), PetscDrawSetType(), PetscDrawType
32: S*/
33: typedef struct _p_PetscDraw* PetscDraw;
35: extern PetscFList PetscDrawList;
36: EXTERN int PetscDrawRegisterAll(char *);
37: EXTERN int PetscDrawRegisterDestroy(void);
39: EXTERN int PetscDrawRegister(char*,char*,char*,int(*)(PetscDraw));
41: /*MC
42: PetscDrawRegisterDynamic - Adds a method to the Krylov subspace solver package.
44: Synopsis:
45: int PetscDrawRegisterDynamic(char *name_solver,char *path,char *name_create,int (*routine_create)(PetscDraw))
47: Not Collective
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
55: Level: developer
57: Notes:
58: PetscDrawRegisterDynamic() may be called multiple times to add several user-defined solvers.
60: If dynamic libraries are used, then the fourth input argument (routine_create)
61: is ignored.
63: Sample usage:
64: .vb
65: PetscDrawRegisterDynamic("my_draw_type",/home/username/my_lib/lib/libO/solaris/mylib.a,
66: "MyDrawCreate",MyDrawCreate);
67: .ve
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
74: Concepts: graphics^registering new draw classes
75: Concepts: PetscDraw^registering new draw classes
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
85: EXTERN int PetscDrawGetType(PetscDraw,PetscDrawType*);
86: EXTERN int PetscDrawSetType(PetscDraw,PetscDrawType);
87: EXTERN int PetscDrawCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscDraw*);
88: EXTERN int PetscDrawSetFromOptions(PetscDraw);
90: /*
91: Number of basic colors in the draw routines, the others are used
92: for a uniform colormap.
93: */
94: #define PETSC_DRAW_BASIC_COLORS 33
96: #define PETSC_DRAW_ROTATE -1 /* will rotate through the colors, start with 2 */
97: #define PETSC_DRAW_WHITE 0
98: #define PETSC_DRAW_BLACK 1
99: #define PETSC_DRAW_RED 2
100: #define PETSC_DRAW_GREEN 3
101: #define PETSC_DRAW_CYAN 4
102: #define PETSC_DRAW_BLUE 5
103: #define PETSC_DRAW_MAGENTA 6
104: #define PETSC_DRAW_AQUAMARINE 7
105: #define PETSC_DRAW_FORESTGREEN 8
106: #define PETSC_DRAW_ORANGE 9
107: #define PETSC_DRAW_VIOLET 10
108: #define PETSC_DRAW_BROWN 11
109: #define PETSC_DRAW_PINK 12
110: #define PETSC_DRAW_CORAL 13
111: #define PETSC_DRAW_GRAY 14
112: #define PETSC_DRAW_YELLOW 15
114: #define PETSC_DRAW_GOLD 16
115: #define PETSC_DRAW_LIGHTPINK 17
116: #define PETSC_DRAW_MEDIUMTURQUOISE 18
117: #define PETSC_DRAW_KHAKI 19
118: #define PETSC_DRAW_DIMGRAY 20
119: #define PETSC_DRAW_YELLOWGREEN 21
120: #define PETSC_DRAW_SKYBLUE 22
121: #define PETSC_DRAW_DARKGREEN 23
122: #define PETSC_DRAW_NAVYBLUE 24
123: #define PETSC_DRAW_SANDYBROWN 25
124: #define PETSC_DRAW_CADETBLUE 26
125: #define PETSC_DRAW_POWDERBLUE 27
126: #define PETSC_DRAW_DEEPPINK 28
127: #define PETSC_DRAW_THISTLE 29
128: #define PETSC_DRAW_LIMEGREEN 30
129: #define PETSC_DRAW_LAVENDERBLUSH 31
130: #define PETSC_DRAW_PLUM 32
132: EXTERN int PetscDrawOpenX(MPI_Comm,const char[],const char[],int,int,int,int,PetscDraw*);
133: EXTERN int PetscDrawOpenPS(MPI_Comm,char *,PetscDraw *);
134: #define PETSC_DRAW_FULL_SIZE -3
135: #define PETSC_DRAW_HALF_SIZE -4
136: #define PETSC_DRAW_THIRD_SIZE -5
137: #define PETSC_DRAW_QUARTER_SIZE -6
139: EXTERN int PetscDrawOpenNull(MPI_Comm,PetscDraw *);
140: EXTERN int PetscDrawDestroy(PetscDraw);
141: EXTERN int PetscDrawIsNull(PetscDraw,PetscTruth*);
143: EXTERN int PetscDrawGetPopup(PetscDraw,PetscDraw*);
144: EXTERN int PetscDrawCheckResizedWindow(PetscDraw);
145: EXTERN int PetscDrawResizeWindow(PetscDraw,int,int);
147: EXTERN int PetscDrawScalePopup(PetscDraw,PetscReal min,PetscReal max);
149: EXTERN int PetscDrawLine(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal,int);
150: EXTERN int PetscDrawLineSetWidth(PetscDraw,PetscReal);
151: EXTERN int PetscDrawLineGetWidth(PetscDraw,PetscReal*);
153: EXTERN int PetscDrawPoint(PetscDraw,PetscReal,PetscReal,int);
154: EXTERN int PetscDrawPointSetSize(PetscDraw,PetscReal);
156: EXTERN int PetscDrawRectangle(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal,int,int,int,int);
157: EXTERN int PetscDrawTriangle(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,int,int,int);
158: EXTERN int PetscDrawEllipse(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal,int);
159: EXTERN int PetscDrawTensorContourPatch(PetscDraw,int,int,PetscReal*,PetscReal*,PetscReal,PetscReal,PetscReal*);
160: EXTERN int PetscDrawTensorContour(PetscDraw,int,int,const PetscReal[],const PetscReal[],PetscReal *);
162: EXTERN int PetscDrawString(PetscDraw,PetscReal,PetscReal,int,char*);
163: EXTERN int PetscDrawStringVertical(PetscDraw,PetscReal,PetscReal,int,char*);
164: EXTERN int PetscDrawStringSetSize(PetscDraw,PetscReal,PetscReal);
165: EXTERN int PetscDrawStringGetSize(PetscDraw,PetscReal*,PetscReal*);
167: EXTERN int PetscDrawSetViewPort(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal);
168: EXTERN int PetscDrawSplitViewPort(PetscDraw);
170: EXTERN int PetscDrawSetCoordinates(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal);
171: EXTERN int PetscDrawGetCoordinates(PetscDraw,PetscReal*,PetscReal*,PetscReal*,PetscReal*);
173: EXTERN int PetscDrawSetTitle(PetscDraw,char *);
174: EXTERN int PetscDrawAppendTitle(PetscDraw,char *);
175: EXTERN int PetscDrawGetTitle(PetscDraw,char **);
177: EXTERN int PetscDrawSetPause(PetscDraw,int);
178: EXTERN int PetscDrawGetPause(PetscDraw,int*);
179: EXTERN int PetscDrawPause(PetscDraw);
180: EXTERN int PetscDrawSetDoubleBuffer(PetscDraw);
181: EXTERN int PetscDrawFlush(PetscDraw);
182: EXTERN int PetscDrawSynchronizedFlush(PetscDraw);
183: EXTERN int PetscDrawClear(PetscDraw);
184: EXTERN int PetscDrawSynchronizedClear(PetscDraw);
185: EXTERN int PetscDrawBOP(PetscDraw);
186: EXTERN int PetscDrawEOP(PetscDraw);
188: EXTERN int PetscDrawSetDisplay(PetscDraw,char*);
189: #define PetscDrawSetFilename(a,b) PetscDrawSetDisplay(a,b)
191: EXTERN int PetscDrawGetSingleton(PetscDraw,PetscDraw*);
192: EXTERN int PetscDrawRestoreSingleton(PetscDraw,PetscDraw*);
194: /*E
195: PetscDrawButton - Used to determine which button was pressed
197: Level: intermediate
199: .seealso: PetscDrawGetMouseButton(), PetscDrawSynchronizedGetMouseButton()
200: E*/
201: typedef enum {BUTTON_NONE,BUTTON_LEFT,BUTTON_CENTER,BUTTON_RIGHT,BUTTON_LEFT_SHIFT,BUTTON_CENTER_SHIFT,BUTTON_RIGHT_SHIFT} PetscDrawButton;
203: EXTERN int PetscDrawGetMouseButton(PetscDraw,PetscDrawButton *,PetscReal*,PetscReal *,PetscReal *,PetscReal *);
204: EXTERN int PetscDrawSynchronizedGetMouseButton(PetscDraw,PetscDrawButton *,PetscReal*,PetscReal *,PetscReal *,PetscReal *);
206: EXTERN int PetscDrawZoom(PetscDraw,int (*)(PetscDraw,void *),void *);
208: /*S
209: PetscDrawViewPorts - Subwindows in a PetscDraw object
211: Level: intermediate
213: Concepts: graphics
215: .seealso: PetscDrawViewPortsCreate(), PetscDrawViewPortsSet()
216: S*/
217: typedef struct {
218: int nports;
219: PetscReal *xl,*xr,*yl,*yr;
220: PetscDraw draw;
221: } PetscDrawViewPorts;
222: EXTERN int PetscDrawViewPortsCreate(PetscDraw,int,PetscDrawViewPorts**);
223: EXTERN int PetscDrawViewPortsDestroy(PetscDrawViewPorts*);
224: EXTERN int PetscDrawViewPortsSet(PetscDrawViewPorts*,int);
226: /*S
227: PetscDrawAxis - Manages X-Y axis
229: Level: advanced
231: Concepts: graphics, axis
233: .seealso: PetscDrawAxisCreate(), PetscDrawAxisSetLimits(), PetscDrawAxisSetColors(), PetscDrawAxisSetLabels()
234: S*/
235: typedef struct _p_DrawAxis* PetscDrawAxis;
237: extern int DRAWAXIS_COOKIE;
239: EXTERN int PetscDrawAxisCreate(PetscDraw,PetscDrawAxis *);
240: EXTERN int PetscDrawAxisDestroy(PetscDrawAxis);
241: EXTERN int PetscDrawAxisDraw(PetscDrawAxis);
242: EXTERN int PetscDrawAxisSetLimits(PetscDrawAxis,PetscReal,PetscReal,PetscReal,PetscReal);
243: EXTERN int PetscDrawAxisSetHoldLimits(PetscDrawAxis,PetscTruth);
244: EXTERN int PetscDrawAxisSetColors(PetscDrawAxis,int,int,int);
245: EXTERN int PetscDrawAxisSetLabels(PetscDrawAxis,char*,char*,char*);
247: /*S
248: PetscDrawLG - Manages drawing x-y plots
250: Level: advanced
252: Concepts: graphics, axis
254: .seealso: PetscDrawAxisCreate(), PetscDrawLGCreate(), PetscDrawLGAddPoint()
255: S*/
256: typedef struct _p_DrawLG* PetscDrawLG;
258: extern int DRAWLG_COOKIE;
260: EXTERN int PetscDrawLGCreate(PetscDraw,int,PetscDrawLG *);
261: EXTERN int PetscDrawLGDestroy(PetscDrawLG);
262: EXTERN int PetscDrawLGAddPoint(PetscDrawLG,PetscReal*,PetscReal*);
263: EXTERN int PetscDrawLGAddPoints(PetscDrawLG,int,PetscReal**,PetscReal**);
264: EXTERN int PetscDrawLGDraw(PetscDrawLG);
265: EXTERN int PetscDrawLGPrint(PetscDrawLG);
266: EXTERN int PetscDrawLGReset(PetscDrawLG);
267: EXTERN int PetscDrawLGSetDimension(PetscDrawLG,int);
268: EXTERN int PetscDrawLGGetAxis(PetscDrawLG,PetscDrawAxis *);
269: EXTERN int PetscDrawLGGetDraw(PetscDrawLG,PetscDraw *);
270: EXTERN int PetscDrawLGIndicateDataPoints(PetscDrawLG);
271: EXTERN int PetscDrawLGSetLimits(PetscDrawLG,PetscReal,PetscReal,PetscReal,PetscReal);
273: /*S
274: PetscDrawSP - Manages drawing scatter plots
276: Level: advanced
278: Concepts: graphics, scatter plots
280: .seealso: PetscDrawSPCreate()
281: S*/
282: typedef struct _p_DrawSP* PetscDrawSP;
284: extern int DRAWSP_COOKIE;
286: EXTERN int PetscDrawSPCreate(PetscDraw,int,PetscDrawSP *);
287: EXTERN int PetscDrawSPDestroy(PetscDrawSP);
288: EXTERN int PetscDrawSPAddPoint(PetscDrawSP,PetscReal*,PetscReal*);
289: EXTERN int PetscDrawSPAddPoints(PetscDrawSP,int,PetscReal**,PetscReal**);
290: EXTERN int PetscDrawSPDraw(PetscDrawSP);
291: EXTERN int PetscDrawSPReset(PetscDrawSP);
292: EXTERN int PetscDrawSPSetDimension(PetscDrawSP,int);
293: EXTERN int PetscDrawSPGetAxis(PetscDrawSP,PetscDrawAxis *);
294: EXTERN int PetscDrawSPGetDraw(PetscDrawSP,PetscDraw *);
295: EXTERN int PetscDrawSPSetLimits(PetscDrawSP,PetscReal,PetscReal,PetscReal,PetscReal);
297: /*S
298: PetscDrawHG - Manages drawing histograms
300: Level: advanced
302: Concepts: graphics, histograms
304: .seealso: PetscDrawHGCreate()
305: S*/
306: typedef struct _p_DrawHG* PetscDrawHG;
308: extern int DRAWHG_COOKIE;
310: EXTERN int PetscDrawHGCreate(PetscDraw,int,PetscDrawHG *);
311: EXTERN int PetscDrawHGDestroy(PetscDrawHG);
312: EXTERN int PetscDrawHGAddValue(PetscDrawHG,PetscReal);
313: EXTERN int PetscDrawHGDraw(PetscDrawHG);
314: EXTERN int PetscDrawHGPrint(PetscDrawHG);
315: EXTERN int PetscDrawHGReset(PetscDrawHG);
316: EXTERN int PetscDrawHGGetAxis(PetscDrawHG,PetscDrawAxis *);
317: EXTERN int PetscDrawHGGetDraw(PetscDrawHG,PetscDraw *);
318: EXTERN int PetscDrawHGSetLimits(PetscDrawHG,PetscReal,PetscReal,int,int);
319: EXTERN int PetscDrawHGSetNumberBins(PetscDrawHG,int);
320: EXTERN int PetscDrawHGSetColor(PetscDrawHG,int);
321: EXTERN int PetscDrawHGCalcStats(PetscDrawHG, PetscTruth);
322: EXTERN int PetscDrawHGIntegerBins(PetscDrawHG, PetscTruth);
324: /*
325: PetscViewer routines that allow you to access underlying PetscDraw objects
326: */
327: EXTERN int PetscViewerDrawGetDraw(PetscViewer,int,PetscDraw*);
328: EXTERN int PetscViewerDrawGetDrawLG(PetscViewer,int,PetscDrawLG*);
329: EXTERN int PetscViewerDrawGetDrawAxis(PetscViewer,int,PetscDrawAxis*);
331: EXTERN int PetscDrawUtilitySetCmapHue(unsigned char *,unsigned char *,unsigned char *,int);
332: EXTERN int PetscDrawUtilitySetGamma(PetscReal);
334: /* Mesh management routines */
335: typedef struct _p_DrawMesh* PetscDrawMesh;
336: int PetscDrawMeshCreate(PetscDrawMesh *,PetscReal *,PetscReal *,PetscReal *,
337: int,int,int,int,int,int,int,int,int,int,int,int,int,PetscReal *,int);
338: int PetscDrawMeshCreateSimple(PetscDrawMesh *,PetscReal *,PetscReal *,PetscReal *,int,int,int,int,PetscReal *,int);
339: int PetscDrawMeshDestroy(PetscDrawMesh *);
344: #endif