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
  8: PETSC_EXTERN_CXX_BEGIN

 10: extern int PETSC_DRAW_COOKIE;

 12: /*E
 13:     PetscDrawType - String with the name of a PetscDraw 

 15:    Level: beginner

 17: .seealso: PetscDrawSetType(), PetscDraw, PetscViewer
 18: E*/
 19: #define PetscDrawType char*
 20: #define PETSC_DRAW_X     "x"
 21: #define PETSC_DRAW_NULL  "null"
 22: #define PETSC_DRAW_PS    "ps"
 23: #define PETSC_DRAW_WIN32 "win32"
 24: 
 25: /*S
 26:      PetscDraw - Abstract PETSc object for graphics

 28:    Level: beginner

 30:   Concepts: graphics

 32: .seealso:  PetscDrawCreate(), PetscDrawSetType(), PetscDrawType
 33: S*/
 34: typedef struct _p_PetscDraw* PetscDraw;

 36: extern PetscFList PetscDrawList;
 37: EXTERN int PetscDrawRegisterAll(const char *);
 38: EXTERN int PetscDrawRegisterDestroy(void);

 40: EXTERN int PetscDrawRegister(const char*,const char*,const char*,int(*)(PetscDraw));

 42: /*MC
 43:    PetscDrawRegisterDynamic - Adds a method to the Krylov subspace solver package.

 45:    Synopsis:
 46:    int PetscDrawRegisterDynamic(char *name_solver,char *path,char *name_create,int (*routine_create)(PetscDraw))

 48:    Not Collective

 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

 56:    Level: developer

 58:    Notes:
 59:    PetscDrawRegisterDynamic() may be called multiple times to add several user-defined solvers.

 61:    If dynamic libraries are used, then the fourth input argument (routine_create)
 62:    is ignored.

 64:    Sample usage:
 65: .vb
 66:    PetscDrawRegisterDynamic("my_draw_type",/home/username/my_lib/lib/libO/solaris/mylib.a,
 67:                "MyDrawCreate",MyDrawCreate);
 68: .ve

 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

 75:    Concepts: graphics^registering new draw classes
 76:    Concepts: PetscDraw^registering new draw classes

 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

 86: EXTERN int PetscDrawGetType(PetscDraw,PetscDrawType*);
 87: EXTERN int PetscDrawSetType(PetscDraw,const PetscDrawType);
 88: EXTERN int PetscDrawCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscDraw*);
 89: EXTERN int PetscDrawSetFromOptions(PetscDraw);

 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

 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

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

133: EXTERN int PetscDrawOpenX(MPI_Comm,const char[],const char[],int,int,int,int,PetscDraw*);
134: EXTERN int 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

140: EXTERN int PetscDrawOpenNull(MPI_Comm,PetscDraw *);
141: EXTERN int PetscDrawDestroy(PetscDraw);
142: EXTERN int PetscDrawIsNull(PetscDraw,PetscTruth*);

144: EXTERN int PetscDrawGetPopup(PetscDraw,PetscDraw*);
145: EXTERN int PetscDrawCheckResizedWindow(PetscDraw);
146: EXTERN int PetscDrawResizeWindow(PetscDraw,int,int);

148: EXTERN int PetscDrawScalePopup(PetscDraw,PetscReal min,PetscReal max);

150: EXTERN int PetscDrawLine(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal,int);
151: EXTERN int PetscDrawLineSetWidth(PetscDraw,PetscReal);
152: EXTERN int PetscDrawLineGetWidth(PetscDraw,PetscReal*);

154: EXTERN int PetscDrawPoint(PetscDraw,PetscReal,PetscReal,int);
155: EXTERN int PetscDrawPointSetSize(PetscDraw,PetscReal);

157: EXTERN int PetscDrawRectangle(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal,int,int,int,int);
158: EXTERN int PetscDrawTriangle(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,int,int,int);
159: EXTERN int PetscDrawEllipse(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal,int);
160: EXTERN int PetscDrawTensorContourPatch(PetscDraw,int,int,PetscReal*,PetscReal*,PetscReal,PetscReal,PetscReal*);
161: EXTERN int PetscDrawTensorContour(PetscDraw,int,int,const PetscReal[],const PetscReal[],PetscReal *);

163: EXTERN int PetscDrawString(PetscDraw,PetscReal,PetscReal,int,const char[]);
164: EXTERN int PetscDrawStringVertical(PetscDraw,PetscReal,PetscReal,int,const char[]);
165: EXTERN int PetscDrawStringSetSize(PetscDraw,PetscReal,PetscReal);
166: EXTERN int PetscDrawStringGetSize(PetscDraw,PetscReal*,PetscReal*);

168: EXTERN int PetscDrawSetViewPort(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal);
169: EXTERN int PetscDrawSplitViewPort(PetscDraw);

171: EXTERN int PetscDrawSetCoordinates(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal);
172: EXTERN int PetscDrawGetCoordinates(PetscDraw,PetscReal*,PetscReal*,PetscReal*,PetscReal*);

174: EXTERN int PetscDrawSetTitle(PetscDraw,const char[]);
175: EXTERN int PetscDrawAppendTitle(PetscDraw,const char[]);
176: EXTERN int PetscDrawGetTitle(PetscDraw,char **);

178: EXTERN int PetscDrawSetPause(PetscDraw,int);
179: EXTERN int PetscDrawGetPause(PetscDraw,int*);
180: EXTERN int PetscDrawPause(PetscDraw);
181: EXTERN int PetscDrawSetDoubleBuffer(PetscDraw);
182: EXTERN int PetscDrawFlush(PetscDraw);
183: EXTERN int PetscDrawSynchronizedFlush(PetscDraw);
184: EXTERN int PetscDrawClear(PetscDraw);
185: EXTERN int PetscDrawSynchronizedClear(PetscDraw);
186: EXTERN int PetscDrawBOP(PetscDraw);
187: EXTERN int PetscDrawEOP(PetscDraw);

189: EXTERN int PetscDrawSetDisplay(PetscDraw,char*);
190: #define PetscDrawSetFilename(a,b) PetscDrawSetDisplay(a,b)

192: EXTERN int PetscDrawGetSingleton(PetscDraw,PetscDraw*);
193: EXTERN int PetscDrawRestoreSingleton(PetscDraw,PetscDraw*);

195: /*E
196:     PetscDrawButton - Used to determine which button was pressed

198:    Level: intermediate

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;

204: EXTERN int PetscDrawGetMouseButton(PetscDraw,PetscDrawButton *,PetscReal*,PetscReal *,PetscReal *,PetscReal *);
205: EXTERN int PetscDrawSynchronizedGetMouseButton(PetscDraw,PetscDrawButton *,PetscReal*,PetscReal *,PetscReal *,PetscReal *);

207: EXTERN int PetscDrawZoom(PetscDraw,int (*)(PetscDraw,void *),void *);

209: /*S
210:      PetscDrawViewPorts - Subwindows in a PetscDraw object

212:    Level: intermediate

214:   Concepts: graphics

216: .seealso:  PetscDrawViewPortsCreate(), PetscDrawViewPortsSet()
217: S*/
218: typedef struct {
219:   int       nports;
220:   PetscReal    *xl,*xr,*yl,*yr;
221:   PetscDraw draw;
222: } PetscDrawViewPorts;
223: EXTERN int PetscDrawViewPortsCreate(PetscDraw,int,PetscDrawViewPorts**);
224: EXTERN int PetscDrawViewPortsDestroy(PetscDrawViewPorts*);
225: EXTERN int PetscDrawViewPortsSet(PetscDrawViewPorts*,int);

227: /*S
228:      PetscDrawAxis - Manages X-Y axis

230:    Level: advanced

232:   Concepts: graphics, axis

234: .seealso:  PetscDrawAxisCreate(), PetscDrawAxisSetLimits(), PetscDrawAxisSetColors(), PetscDrawAxisSetLabels()
235: S*/
236: typedef struct _p_DrawAxis* PetscDrawAxis;

238: extern int DRAWAXIS_COOKIE;

240: EXTERN int PetscDrawAxisCreate(PetscDraw,PetscDrawAxis *);
241: EXTERN int PetscDrawAxisDestroy(PetscDrawAxis);
242: EXTERN int PetscDrawAxisDraw(PetscDrawAxis);
243: EXTERN int PetscDrawAxisSetLimits(PetscDrawAxis,PetscReal,PetscReal,PetscReal,PetscReal);
244: EXTERN int PetscDrawAxisSetHoldLimits(PetscDrawAxis,PetscTruth);
245: EXTERN int PetscDrawAxisSetColors(PetscDrawAxis,int,int,int);
246: EXTERN int PetscDrawAxisSetLabels(PetscDrawAxis,const char[],const char[],const char[]);

248: /*S
249:      PetscDrawLG - Manages drawing x-y plots

251:    Level: advanced

253:   Concepts: graphics, axis

255: .seealso:  PetscDrawAxisCreate(), PetscDrawLGCreate(), PetscDrawLGAddPoint()
256: S*/
257: typedef struct _p_DrawLG*   PetscDrawLG;

259: extern int DRAWLG_COOKIE;

261: EXTERN int PetscDrawLGCreate(PetscDraw,int,PetscDrawLG *);
262: EXTERN int PetscDrawLGDestroy(PetscDrawLG);
263: EXTERN int PetscDrawLGAddPoint(PetscDrawLG,PetscReal*,PetscReal*);
264: EXTERN int PetscDrawLGAddPoints(PetscDrawLG,int,PetscReal**,PetscReal**);
265: EXTERN int PetscDrawLGDraw(PetscDrawLG);
266: EXTERN int PetscDrawLGPrint(PetscDrawLG);
267: EXTERN int PetscDrawLGReset(PetscDrawLG);
268: EXTERN int PetscDrawLGSetDimension(PetscDrawLG,int);
269: EXTERN int PetscDrawLGGetAxis(PetscDrawLG,PetscDrawAxis *);
270: EXTERN int PetscDrawLGGetDraw(PetscDrawLG,PetscDraw *);
271: EXTERN int PetscDrawLGIndicateDataPoints(PetscDrawLG);
272: EXTERN int PetscDrawLGSetLimits(PetscDrawLG,PetscReal,PetscReal,PetscReal,PetscReal);

274: /*S
275:      PetscDrawSP - Manages drawing scatter plots

277:    Level: advanced

279:   Concepts: graphics, scatter plots

281: .seealso:  PetscDrawSPCreate()
282: S*/
283: typedef struct _p_DrawSP*   PetscDrawSP;

285: extern int DRAWSP_COOKIE;

287: EXTERN int PetscDrawSPCreate(PetscDraw,int,PetscDrawSP *);
288: EXTERN int PetscDrawSPDestroy(PetscDrawSP);
289: EXTERN int PetscDrawSPAddPoint(PetscDrawSP,PetscReal*,PetscReal*);
290: EXTERN int PetscDrawSPAddPoints(PetscDrawSP,int,PetscReal**,PetscReal**);
291: EXTERN int PetscDrawSPDraw(PetscDrawSP);
292: EXTERN int PetscDrawSPReset(PetscDrawSP);
293: EXTERN int PetscDrawSPSetDimension(PetscDrawSP,int);
294: EXTERN int PetscDrawSPGetAxis(PetscDrawSP,PetscDrawAxis *);
295: EXTERN int PetscDrawSPGetDraw(PetscDrawSP,PetscDraw *);
296: EXTERN int PetscDrawSPSetLimits(PetscDrawSP,PetscReal,PetscReal,PetscReal,PetscReal);
297: EXTERN int PetscDrawLGSPDraw(PetscDrawLG,PetscDrawSP);

299: /*S
300:      PetscDrawHG - Manages drawing histograms

302:    Level: advanced

304:   Concepts: graphics, histograms

306: .seealso:  PetscDrawHGCreate()
307: S*/
308: typedef struct _p_DrawHG*   PetscDrawHG;

310: extern int DRAWHG_COOKIE;

312: EXTERN int PetscDrawHGCreate(PetscDraw,int,PetscDrawHG *);
313: EXTERN int PetscDrawHGDestroy(PetscDrawHG);
314: EXTERN int PetscDrawHGAddValue(PetscDrawHG,PetscReal);
315: EXTERN int PetscDrawHGDraw(PetscDrawHG);
316: EXTERN int PetscDrawHGPrint(PetscDrawHG);
317: EXTERN int PetscDrawHGReset(PetscDrawHG);
318: EXTERN int PetscDrawHGGetAxis(PetscDrawHG,PetscDrawAxis *);
319: EXTERN int PetscDrawHGGetDraw(PetscDrawHG,PetscDraw *);
320: EXTERN int PetscDrawHGSetLimits(PetscDrawHG,PetscReal,PetscReal,int,int);
321: EXTERN int PetscDrawHGSetNumberBins(PetscDrawHG,int);
322: EXTERN int PetscDrawHGSetColor(PetscDrawHG,int);
323: EXTERN int PetscDrawHGCalcStats(PetscDrawHG, PetscTruth);
324: EXTERN int PetscDrawHGIntegerBins(PetscDrawHG, PetscTruth);

326: /*
327:     PetscViewer routines that allow you to access underlying PetscDraw objects
328: */
329: EXTERN int PetscViewerDrawGetDraw(PetscViewer,int,PetscDraw*);
330: EXTERN int PetscViewerDrawGetDrawLG(PetscViewer,int,PetscDrawLG*);
331: EXTERN int PetscViewerDrawGetDrawAxis(PetscViewer,int,PetscDrawAxis*);

333: EXTERN int PetscDrawUtilitySetCmapHue(unsigned char *,unsigned char *,unsigned char *,int);
334: EXTERN int PetscDrawUtilitySetGamma(PetscReal);

336: /* Mesh management routines */
337: typedef struct _p_DrawMesh* PetscDrawMesh;
338: int PetscDrawMeshCreate(PetscDrawMesh *,PetscReal *,PetscReal *,PetscReal *,
339:                         int,int,int,int,int,int,int,int,int,int,int,int,int,PetscReal *,int);
340: int PetscDrawMeshCreateSimple(PetscDrawMesh *,PetscReal *,PetscReal *,PetscReal *,int,int,int,int,PetscReal *,int);
341: int PetscDrawMeshDestroy(PetscDrawMesh *);

343: PETSC_EXTERN_CXX_END
344: #endif