Actual source code: petscdraw.h

  1: /*
  2:   Interface to the PETSc graphics (currently only support for X-windows
  3: */
 6:  #include petscsys.h
  7: PETSC_EXTERN_CXX_BEGIN

  9: extern PetscClassId PETSC_DRAW_CLASSID;

 11: /*J
 12:     PetscDrawType - String with the name of a PetscDraw 

 14:    Level: beginner

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

 26:    Level: beginner

 28:   Concepts: graphics

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

 34: extern PetscFList PetscDrawList;
 35: extern PetscErrorCode  PetscDrawRegisterAll(const char[]);
 36: extern PetscErrorCode  PetscDrawInitializePackage(const char[]);
 37: extern PetscErrorCode  PetscDrawRegisterDestroy(void);

 39: extern PetscErrorCode  PetscDrawRegister(const char*,const char*,const char*,PetscErrorCode(*)(PetscDraw));

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

 44:    Synopsis:
 45:    PetscErrorCode PetscDrawRegisterDynamic(const char *name_solver,const char *path,const char *name_create,PetscErrorCode (*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 PetscErrorCode  PetscDrawGetType(PetscDraw,const PetscDrawType*);
 86: extern PetscErrorCode  PetscDrawSetType(PetscDraw,const PetscDrawType);
 87: extern PetscErrorCode  PetscDrawCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscDraw*);
 88: extern PetscErrorCode  PetscDrawSetFromOptions(PetscDraw);
 89: extern PetscErrorCode  PetscDrawSetSave(PetscDraw,const char*);

 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 PetscErrorCode  PetscDrawOpenX(MPI_Comm,const char[],const char[],int,int,int,int,PetscDraw*);
134: extern PetscErrorCode  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 PetscErrorCode  PetscDrawOpenNull(MPI_Comm,PetscDraw *);
141: extern PetscErrorCode  PetscDrawDestroy(PetscDraw*);
142: extern PetscErrorCode  PetscDrawIsNull(PetscDraw,PetscBool *);

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

148: extern PetscErrorCode  PetscDrawScalePopup(PetscDraw,PetscReal,PetscReal);

150: extern PetscErrorCode  PetscDrawLine(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal,int);
151: extern PetscErrorCode  PetscDrawArrow(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal,int);
152: extern PetscErrorCode  PetscDrawLineSetWidth(PetscDraw,PetscReal);
153: extern PetscErrorCode  PetscDrawLineGetWidth(PetscDraw,PetscReal*);

155: extern PetscErrorCode  PetscDrawPoint(PetscDraw,PetscReal,PetscReal,int);
156: extern PetscErrorCode  PetscDrawPointSetSize(PetscDraw,PetscReal);

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

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

169: extern PetscErrorCode  PetscDrawSetViewPort(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal);
170: extern PetscErrorCode  PetscDrawSplitViewPort(PetscDraw);

172: extern PetscErrorCode  PetscDrawSetCoordinates(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal);
173: extern PetscErrorCode  PetscDrawGetCoordinates(PetscDraw,PetscReal*,PetscReal*,PetscReal*,PetscReal*);

175: extern PetscErrorCode  PetscDrawSetTitle(PetscDraw,const char[]);
176: extern PetscErrorCode  PetscDrawAppendTitle(PetscDraw,const char[]);
177: extern PetscErrorCode  PetscDrawGetTitle(PetscDraw,char **);

179: extern PetscErrorCode  PetscDrawSetPause(PetscDraw,PetscReal);
180: extern PetscErrorCode  PetscDrawGetPause(PetscDraw,PetscReal*);
181: extern PetscErrorCode  PetscDrawPause(PetscDraw);
182: extern PetscErrorCode  PetscDrawSetDoubleBuffer(PetscDraw);
183: extern PetscErrorCode  PetscDrawFlush(PetscDraw);
184: extern PetscErrorCode  PetscDrawSynchronizedFlush(PetscDraw);
185: extern PetscErrorCode  PetscDrawClear(PetscDraw);
186: extern PetscErrorCode  PetscDrawSave(PetscDraw);
187: extern PetscErrorCode  PetscDrawSynchronizedClear(PetscDraw);
188: extern PetscErrorCode  PetscDrawBOP(PetscDraw);
189: extern PetscErrorCode  PetscDrawEOP(PetscDraw);

191: extern PetscErrorCode  PetscDrawSetDisplay(PetscDraw,char*);
192: #define PetscDrawSetFilename(a,b) PetscDrawSetDisplay(a,b)

194: extern PetscErrorCode  PetscDrawGetSingleton(PetscDraw,PetscDraw*);
195: extern PetscErrorCode  PetscDrawRestoreSingleton(PetscDraw,PetscDraw*);

197: /*E
198:     PetscDrawButton - Used to determine which button was pressed

200:    Level: intermediate

202: .seealso: PetscDrawGetMouseButton(), PetscDrawSynchronizedGetMouseButton()
203: E*/
204: typedef enum {BUTTON_NONE,BUTTON_LEFT,BUTTON_CENTER,BUTTON_RIGHT,BUTTON_LEFT_SHIFT,BUTTON_CENTER_SHIFT,BUTTON_RIGHT_SHIFT} PetscDrawButton;

206: extern PetscErrorCode  PetscDrawGetMouseButton(PetscDraw,PetscDrawButton *,PetscReal*,PetscReal *,PetscReal *,PetscReal *);
207: extern PetscErrorCode  PetscDrawSynchronizedGetMouseButton(PetscDraw,PetscDrawButton *,PetscReal*,PetscReal *,PetscReal *,PetscReal *);

209: extern PetscErrorCode  PetscDrawZoom(PetscDraw,PetscErrorCode (*)(PetscDraw,void *),void *);

211: /*S
212:      PetscDrawViewPorts - Subwindows in a PetscDraw object

214:    Level: intermediate

216:   Concepts: graphics

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: extern PetscErrorCode  PetscDrawViewPortsCreate(PetscDraw,PetscInt,PetscDrawViewPorts**);
229: extern PetscErrorCode  PetscDrawViewPortsCreateRect(PetscDraw,PetscInt,PetscInt,PetscDrawViewPorts**);
230: extern PetscErrorCode  PetscDrawViewPortsDestroy(PetscDrawViewPorts*);
231: extern PetscErrorCode  PetscDrawViewPortsSet(PetscDrawViewPorts*,PetscInt);

233: /*S
234:      PetscDrawAxis - Manages X-Y axis

236:    Level: advanced

238:   Concepts: graphics, axis

240: .seealso:  PetscDrawAxisCreate(), PetscDrawAxisSetLimits(), PetscDrawAxisSetColors(), PetscDrawAxisSetLabels()
241: S*/
242: typedef struct _p_DrawAxis* PetscDrawAxis;

244: extern PetscClassId DRAWAXIS_CLASSID;

246: extern PetscErrorCode  PetscDrawAxisCreate(PetscDraw,PetscDrawAxis *);
247: extern PetscErrorCode  PetscDrawAxisDestroy(PetscDrawAxis*);
248: extern PetscErrorCode  PetscDrawAxisDraw(PetscDrawAxis);
249: extern PetscErrorCode  PetscDrawAxisSetLimits(PetscDrawAxis,PetscReal,PetscReal,PetscReal,PetscReal);
250: extern PetscErrorCode  PetscDrawAxisSetHoldLimits(PetscDrawAxis,PetscBool );
251: extern PetscErrorCode  PetscDrawAxisSetColors(PetscDrawAxis,int,int,int);
252: extern PetscErrorCode  PetscDrawAxisSetLabels(PetscDrawAxis,const char[],const char[],const char[]);

254: /*S
255:      PetscDrawLG - Manages drawing x-y plots

257:    Level: advanced

259:   Concepts: graphics, axis

261: .seealso:  PetscDrawAxisCreate(), PetscDrawLGCreate(), PetscDrawLGAddPoint()
262: S*/
263: typedef struct _p_PetscDrawLG*   PetscDrawLG;

265: extern PetscClassId DRAWLG_CLASSID;

267: extern PetscErrorCode  PetscDrawLGCreate(PetscDraw,int,PetscDrawLG *);
268: extern PetscErrorCode  PetscDrawLGDestroy(PetscDrawLG*);
269: extern PetscErrorCode  PetscDrawLGAddPoint(PetscDrawLG,PetscReal*,PetscReal*);
270: extern PetscErrorCode  PetscDrawLGAddPoints(PetscDrawLG,int,PetscReal**,PetscReal**);
271: extern PetscErrorCode  PetscDrawLGDraw(PetscDrawLG);
272: extern PetscErrorCode  PetscDrawLGPrint(PetscDrawLG);
273: extern PetscErrorCode  PetscDrawLGReset(PetscDrawLG);
274: extern PetscErrorCode  PetscDrawLGSetDimension(PetscDrawLG,PetscInt);
275: extern PetscErrorCode  PetscDrawLGSetLegend(PetscDrawLG,const char *const*);
276: extern PetscErrorCode  PetscDrawLGGetAxis(PetscDrawLG,PetscDrawAxis *);
277: extern PetscErrorCode  PetscDrawLGGetDraw(PetscDrawLG,PetscDraw *);
278: extern PetscErrorCode  PetscDrawLGIndicateDataPoints(PetscDrawLG);
279: extern PetscErrorCode  PetscDrawLGSetLimits(PetscDrawLG,PetscReal,PetscReal,PetscReal,PetscReal);
280: extern PetscErrorCode  PetscDrawLGSetColors(PetscDrawLG,const int*);

282: /*S
283:      PetscDrawSP - Manages drawing scatter plots

285:    Level: advanced

287:   Concepts: graphics, scatter plots

289: .seealso:  PetscDrawSPCreate()
290: S*/
291: typedef struct _p_DrawSP*   PetscDrawSP;

293: extern PetscClassId DRAWSP_CLASSID;

295: extern PetscErrorCode  PetscDrawSPCreate(PetscDraw,int,PetscDrawSP *);
296: extern PetscErrorCode  PetscDrawSPDestroy(PetscDrawSP*);
297: extern PetscErrorCode  PetscDrawSPAddPoint(PetscDrawSP,PetscReal*,PetscReal*);
298: extern PetscErrorCode  PetscDrawSPAddPoints(PetscDrawSP,int,PetscReal**,PetscReal**);
299: extern PetscErrorCode  PetscDrawSPDraw(PetscDrawSP);
300: extern PetscErrorCode  PetscDrawSPReset(PetscDrawSP);
301: extern PetscErrorCode  PetscDrawSPSetDimension(PetscDrawSP,int);
302: extern PetscErrorCode  PetscDrawSPGetAxis(PetscDrawSP,PetscDrawAxis *);
303: extern PetscErrorCode  PetscDrawSPGetDraw(PetscDrawSP,PetscDraw *);
304: extern PetscErrorCode  PetscDrawSPSetLimits(PetscDrawSP,PetscReal,PetscReal,PetscReal,PetscReal);
305: extern PetscErrorCode  PetscDrawLGSPDraw(PetscDrawLG,PetscDrawSP);

307: /*S
308:      PetscDrawHG - Manages drawing histograms

310:    Level: advanced

312:   Concepts: graphics, histograms

314: .seealso:  PetscDrawHGCreate()
315: S*/
316: typedef struct _p_DrawHG*   PetscDrawHG;

318: extern PetscClassId DRAWHG_CLASSID;

320: extern PetscErrorCode  PetscDrawHGCreate(PetscDraw,int,PetscDrawHG *);
321: extern PetscErrorCode  PetscDrawHGDestroy(PetscDrawHG*);
322: extern PetscErrorCode  PetscDrawHGAddValue(PetscDrawHG,PetscReal);
323: extern PetscErrorCode  PetscDrawHGDraw(PetscDrawHG);
324: extern PetscErrorCode  PetscDrawHGPrint(PetscDrawHG);
325: extern PetscErrorCode  PetscDrawHGReset(PetscDrawHG);
326: extern PetscErrorCode  PetscDrawHGGetAxis(PetscDrawHG,PetscDrawAxis *);
327: extern PetscErrorCode  PetscDrawHGGetDraw(PetscDrawHG,PetscDraw *);
328: extern PetscErrorCode  PetscDrawHGSetLimits(PetscDrawHG,PetscReal,PetscReal,int,int);
329: extern PetscErrorCode  PetscDrawHGSetNumberBins(PetscDrawHG,int);
330: extern PetscErrorCode  PetscDrawHGSetColor(PetscDrawHG,int);
331: extern PetscErrorCode  PetscDrawHGCalcStats(PetscDrawHG, PetscBool );
332: extern PetscErrorCode  PetscDrawHGIntegerBins(PetscDrawHG, PetscBool );

334: /*
335:     PetscViewer routines that allow you to access underlying PetscDraw objects
336: */
337: extern PetscErrorCode  PetscViewerDrawGetDraw(PetscViewer,PetscInt,PetscDraw*);
338: extern PetscErrorCode  PetscViewerDrawBaseAdd(PetscViewer,PetscInt);
339: extern PetscErrorCode  PetscViewerDrawBaseSet(PetscViewer,PetscInt);
340: extern PetscErrorCode  PetscViewerDrawGetDrawLG(PetscViewer,PetscInt,PetscDrawLG*);
341: extern PetscErrorCode  PetscViewerDrawGetDrawAxis(PetscViewer,PetscInt,PetscDrawAxis*);

343: extern PetscErrorCode  PetscDrawUtilitySetCmapHue(unsigned char *,unsigned char *,unsigned char *,int);
344: extern PetscErrorCode  PetscDrawUtilitySetGamma(PetscReal);

346: PETSC_EXTERN_CXX_END
347: #endif