Actual source code: drawv.c
petsc-3.12.5 2020-03-29
2: #include <../src/sys/classes/viewer/impls/draw/vdraw.h>
3: #include <petscviewer.h>
5: static PetscErrorCode PetscViewerDestroy_Draw(PetscViewer v)
6: {
7: PetscErrorCode ierr;
8: PetscInt i;
9: PetscViewer_Draw *vdraw = (PetscViewer_Draw*)v->data;
12: if (vdraw->singleton_made) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"Destroying PetscViewer without first restoring singleton");
13: for (i=0; i<vdraw->draw_max; i++) {
14: PetscDrawAxisDestroy(&vdraw->drawaxis[i]);
15: PetscDrawLGDestroy(&vdraw->drawlg[i]);
16: PetscDrawDestroy(&vdraw->draw[i]);
17: }
18: PetscFree(vdraw->display);
19: PetscFree(vdraw->title);
20: PetscFree3(vdraw->draw,vdraw->drawlg,vdraw->drawaxis);
21: PetscFree(vdraw->bounds);
22: PetscFree(vdraw->drawtype);
23: PetscFree(v->data);
24: return(0);
25: }
27: static PetscErrorCode PetscViewerFlush_Draw(PetscViewer v)
28: {
29: PetscErrorCode ierr;
30: PetscInt i;
31: PetscViewer_Draw *vdraw = (PetscViewer_Draw*)v->data;
34: for (i=0; i<vdraw->draw_max; i++) {
35: if (vdraw->draw[i]) {PetscDrawFlush(vdraw->draw[i]);}
36: }
37: return(0);
38: }
40: /*@C
41: PetscViewerDrawGetDraw - Returns PetscDraw object from PetscViewer object.
42: This PetscDraw object may then be used to perform graphics using
43: PetscDrawXXX() commands.
45: Collective on PetscViewer
47: Input Parameters:
48: + viewer - the PetscViewer (created with PetscViewerDrawOpen())
49: - windownumber - indicates which subwindow (usually 0)
51: Ouput Parameter:
52: . draw - the draw object
54: Level: intermediate
57: .seealso: PetscViewerDrawGetLG(), PetscViewerDrawGetAxis(), PetscViewerDrawOpen()
58: @*/
59: PetscErrorCode PetscViewerDrawGetDraw(PetscViewer viewer,PetscInt windownumber,PetscDraw *draw)
60: {
61: PetscViewer_Draw *vdraw;
62: PetscErrorCode ierr;
63: PetscBool isdraw;
69: PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);
70: if (!isdraw) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Must be draw type PetscViewer");
71: if (windownumber < 0) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Window number cannot be negative");
72: vdraw = (PetscViewer_Draw*)viewer->data;
74: windownumber += vdraw->draw_base;
75: if (windownumber >= vdraw->draw_max) {
76: /* allocate twice as many slots as needed */
77: PetscInt draw_max = vdraw->draw_max;
78: PetscDraw *tdraw = vdraw->draw;
79: PetscDrawLG *drawlg = vdraw->drawlg;
80: PetscDrawAxis *drawaxis = vdraw->drawaxis;
82: vdraw->draw_max = 2*windownumber;
84: PetscCalloc3(vdraw->draw_max,&vdraw->draw,vdraw->draw_max,&vdraw->drawlg,vdraw->draw_max,&vdraw->drawaxis);
85: PetscArraycpy(vdraw->draw,tdraw,draw_max);
86: PetscArraycpy(vdraw->drawlg,drawlg,draw_max);
87: PetscArraycpy(vdraw->drawaxis,drawaxis,draw_max);
88: PetscFree3(tdraw,drawlg,drawaxis);
89: }
91: if (!vdraw->draw[windownumber]) {
92: char *title = vdraw->title, tmp_str[128];
93: if (windownumber) {
94: PetscSNPrintf(tmp_str,sizeof(tmp_str),"%s:%d",vdraw->title?vdraw->title:"",windownumber);
95: title = tmp_str;
96: }
97: PetscDrawCreate(PetscObjectComm((PetscObject)viewer),vdraw->display,title,PETSC_DECIDE,PETSC_DECIDE,vdraw->w,vdraw->h,&vdraw->draw[windownumber]);
98: PetscLogObjectParent((PetscObject)viewer,(PetscObject)vdraw->draw[windownumber]);
99: if (vdraw->drawtype) {
100: PetscDrawSetType(vdraw->draw[windownumber],vdraw->drawtype);
101: }
102: PetscDrawSetPause(vdraw->draw[windownumber],vdraw->pause);
103: PetscDrawSetOptionsPrefix(vdraw->draw[windownumber],((PetscObject)viewer)->prefix);
104: PetscDrawSetFromOptions(vdraw->draw[windownumber]);
105: }
106: if (draw) *draw = vdraw->draw[windownumber];
108: return(0);
109: }
111: /*@C
112: PetscViewerDrawBaseAdd - add to the base integer that is added to the windownumber passed to PetscViewerDrawGetDraw()
114: Logically Collective on PetscViewer
116: Input Parameters:
117: + viewer - the PetscViewer (created with PetscViewerDrawOpen())
118: - windownumber - how much to add to the base
120: Level: developer
123: .seealso: PetscViewerDrawGetLG(), PetscViewerDrawGetAxis(), PetscViewerDrawOpen(), PetscViewerDrawGetDraw(), PetscViewerDrawBaseSet()
124: @*/
125: PetscErrorCode PetscViewerDrawBaseAdd(PetscViewer viewer,PetscInt windownumber)
126: {
127: PetscViewer_Draw *vdraw;
128: PetscErrorCode ierr;
129: PetscBool isdraw;
134: PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);
135: if (!isdraw) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Must be draw type PetscViewer");
136: vdraw = (PetscViewer_Draw*)viewer->data;
138: if (windownumber + vdraw->draw_base < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Resulting base %D cannot be negative",windownumber+vdraw->draw_base);
139: vdraw->draw_base += windownumber;
140: return(0);
141: }
143: /*@C
144: PetscViewerDrawBaseSet - sets the base integer that is added to the windownumber passed to PetscViewerDrawGetDraw()
146: Logically Collective on PetscViewer
148: Input Parameters:
149: + viewer - the PetscViewer (created with PetscViewerDrawOpen())
150: - windownumber - value to set the base
152: Level: developer
155: .seealso: PetscViewerDrawGetLG(), PetscViewerDrawGetAxis(), PetscViewerDrawOpen(), PetscViewerDrawGetDraw(), PetscViewerDrawBaseAdd()
156: @*/
157: PetscErrorCode PetscViewerDrawBaseSet(PetscViewer viewer,PetscInt windownumber)
158: {
159: PetscViewer_Draw *vdraw;
160: PetscErrorCode ierr;
161: PetscBool isdraw;
166: PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);
167: if (!isdraw) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Must be draw type PetscViewer");
168: vdraw = (PetscViewer_Draw*)viewer->data;
170: if (windownumber < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Resulting base %D cannot be negative",windownumber);
171: vdraw->draw_base = windownumber;
172: return(0);
173: }
175: /*@C
176: PetscViewerDrawGetDrawLG - Returns PetscDrawLG object from PetscViewer object.
177: This PetscDrawLG object may then be used to perform graphics using
178: PetscDrawLGXXX() commands.
180: Collective on PetscViewer
182: Input Parameter:
183: + PetscViewer - the PetscViewer (created with PetscViewerDrawOpen())
184: - windownumber - indicates which subwindow (usually 0)
186: Ouput Parameter:
187: . draw - the draw line graph object
189: Level: intermediate
191: .seealso: PetscViewerDrawGetDraw(), PetscViewerDrawGetAxis(), PetscViewerDrawOpen()
192: @*/
193: PetscErrorCode PetscViewerDrawGetDrawLG(PetscViewer viewer,PetscInt windownumber,PetscDrawLG *drawlg)
194: {
195: PetscErrorCode ierr;
196: PetscBool isdraw;
197: PetscViewer_Draw *vdraw;
203: PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);
204: if (!isdraw) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Must be draw type PetscViewer");
205: if (windownumber < 0) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Window number cannot be negative");
206: vdraw = (PetscViewer_Draw*)viewer->data;
208: if (windownumber+vdraw->draw_base >= vdraw->draw_max || !vdraw->draw[windownumber+vdraw->draw_base]) {
209: PetscViewerDrawGetDraw(viewer,windownumber,NULL);
210: }
211: if (!vdraw->drawlg[windownumber+vdraw->draw_base]) {
212: PetscDrawLGCreate(vdraw->draw[windownumber+vdraw->draw_base],1,&vdraw->drawlg[windownumber+vdraw->draw_base]);
213: PetscLogObjectParent((PetscObject)viewer,(PetscObject)vdraw->drawlg[windownumber+vdraw->draw_base]);
214: PetscDrawLGSetFromOptions(vdraw->drawlg[windownumber+vdraw->draw_base]);
215: }
216: *drawlg = vdraw->drawlg[windownumber+vdraw->draw_base];
217: return(0);
218: }
220: /*@C
221: PetscViewerDrawGetDrawAxis - Returns PetscDrawAxis object from PetscViewer object.
222: This PetscDrawAxis object may then be used to perform graphics using
223: PetscDrawAxisXXX() commands.
225: Collective on PetscViewer
227: Input Parameter:
228: + viewer - the PetscViewer (created with PetscViewerDrawOpen()
229: - windownumber - indicates which subwindow (usually 0)
231: Ouput Parameter:
232: . drawaxis - the draw axis object
234: Level: advanced
236: .seealso: PetscViewerDrawGetDraw(), PetscViewerDrawGetLG(), PetscViewerDrawOpen()
237: @*/
238: PetscErrorCode PetscViewerDrawGetDrawAxis(PetscViewer viewer,PetscInt windownumber,PetscDrawAxis *drawaxis)
239: {
240: PetscErrorCode ierr;
241: PetscBool isdraw;
242: PetscViewer_Draw *vdraw;
248: PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);
249: if (!isdraw) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Must be draw type PetscViewer");
250: if (windownumber < 0) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Window number cannot be negative");
251: vdraw = (PetscViewer_Draw*)viewer->data;
253: if (windownumber+vdraw->draw_base >= vdraw->draw_max || !vdraw->draw[windownumber+vdraw->draw_base]) {
254: PetscViewerDrawGetDraw(viewer,windownumber,NULL);
255: }
256: if (!vdraw->drawaxis[windownumber+vdraw->draw_base]) {
257: PetscDrawAxisCreate(vdraw->draw[windownumber+vdraw->draw_base],&vdraw->drawaxis[windownumber+vdraw->draw_base]);
258: PetscLogObjectParent((PetscObject)viewer,(PetscObject)vdraw->drawaxis[windownumber+vdraw->draw_base]);
259: }
260: *drawaxis = vdraw->drawaxis[windownumber+vdraw->draw_base];
261: return(0);
262: }
264: PetscErrorCode PetscViewerDrawResize(PetscViewer v,int w,int h)
265: {
266: PetscErrorCode ierr;
267: PetscViewer_Draw *vdraw;
268: PetscBool isdraw;
272: PetscObjectTypeCompare((PetscObject)v,PETSCVIEWERDRAW,&isdraw);
273: if (!isdraw) return(0);
274: vdraw = (PetscViewer_Draw*)v->data;
276: if (w >= 1) vdraw->w = w;
277: if (h >= 1) vdraw->h = h;
278: return(0);
279: }
281: PetscErrorCode PetscViewerDrawSetInfo(PetscViewer v,const char display[],const char title[],int x,int y,int w,int h)
282: {
283: PetscErrorCode ierr;
284: PetscViewer_Draw *vdraw;
285: PetscBool isdraw;
289: PetscObjectTypeCompare((PetscObject)v,PETSCVIEWERDRAW,&isdraw);
290: if (!isdraw) return(0);
291: vdraw = (PetscViewer_Draw*)v->data;
293: PetscStrallocpy(display,&vdraw->display);
294: PetscStrallocpy(title,&vdraw->title);
295: if (w >= 1) vdraw->w = w;
296: if (h >= 1) vdraw->h = h;
297: return(0);
298: }
300: PetscErrorCode PetscViewerDrawSetDrawType(PetscViewer v,PetscDrawType drawtype)
301: {
302: PetscErrorCode ierr;
303: PetscViewer_Draw *vdraw;
304: PetscBool isdraw;
308: PetscObjectTypeCompare((PetscObject)v,PETSCVIEWERDRAW,&isdraw);
309: if (!isdraw) return(0);
310: vdraw = (PetscViewer_Draw*)v->data;
312: PetscFree(vdraw->drawtype);
313: PetscStrallocpy(drawtype,(char**)&vdraw->drawtype);
314: return(0);
315: }
317: PetscErrorCode PetscViewerDrawGetDrawType(PetscViewer v,PetscDrawType *drawtype)
318: {
319: PetscErrorCode ierr;
320: PetscViewer_Draw *vdraw;
321: PetscBool isdraw;
325: PetscObjectTypeCompare((PetscObject)v,PETSCVIEWERDRAW,&isdraw);
326: if (!isdraw) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Must be draw type PetscViewer");
327: vdraw = (PetscViewer_Draw*)v->data;
329: *drawtype = vdraw->drawtype;
330: return(0);
331: }
333: PetscErrorCode PetscViewerDrawSetTitle(PetscViewer v,const char title[])
334: {
335: PetscErrorCode ierr;
336: PetscViewer_Draw *vdraw;
337: PetscBool isdraw;
341: PetscObjectTypeCompare((PetscObject)v,PETSCVIEWERDRAW,&isdraw);
342: if (!isdraw) return(0);
343: vdraw = (PetscViewer_Draw*)v->data;
345: PetscFree(vdraw->title);
346: PetscStrallocpy(title,&vdraw->title);
347: return(0);
348: }
350: PetscErrorCode PetscViewerDrawGetTitle(PetscViewer v,const char *title[])
351: {
352: PetscErrorCode ierr;
353: PetscViewer_Draw *vdraw;
354: PetscBool isdraw;
358: PetscObjectTypeCompare((PetscObject)v,PETSCVIEWERDRAW,&isdraw);
359: if (!isdraw) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Must be draw type PetscViewer");
360: vdraw = (PetscViewer_Draw*)v->data;
362: *title = vdraw->title;
363: return(0);
364: }
366: /*@C
367: PetscViewerDrawOpen - Opens a window for use as a PetscViewer. If you want to
368: do graphics in this window, you must call PetscViewerDrawGetDraw() and
369: perform the graphics on the PetscDraw object.
371: Collective
373: Input Parameters:
374: + comm - communicator that will share window
375: . display - the X display on which to open, or null for the local machine
376: . title - the title to put in the title bar, or null for no title
377: . x, y - the screen coordinates of the upper left corner of window, or use PETSC_DECIDE
378: - w, h - window width and height in pixels, or may use PETSC_DECIDE or PETSC_DRAW_FULL_SIZE, PETSC_DRAW_HALF_SIZE,
379: PETSC_DRAW_THIRD_SIZE, PETSC_DRAW_QUARTER_SIZE
381: Output Parameters:
382: . viewer - the PetscViewer
384: Format Options:
385: + PETSC_VIEWER_DRAW_BASIC - displays with basic format
386: - PETSC_VIEWER_DRAW_LG - displays using a line graph
388: Options Database Keys:
389: PetscViewerDrawOpen() calls PetscDrawCreate(), so see the manual page for
390: PetscDrawCreate() for runtime options, including
391: + -draw_type x or null
392: . -nox - Disables all x-windows output
393: . -display <name> - Specifies name of machine for the X display
394: . -geometry <x,y,w,h> - allows setting the window location and size
395: - -draw_pause <pause> - Sets time (in seconds) that the
396: program pauses after PetscDrawPause() has been called
397: (0 is default, -1 implies until user input).
399: Level: beginner
401: Note for Fortran Programmers:
402: Whenever indicating null character data in a Fortran code,
403: PETSC_NULL_CHARACTER must be employed; using NULL is not
404: correct for character data! Thus, PETSC_NULL_CHARACTER can be
405: used for the display and title input parameters.
409: .seealso: PetscDrawCreate(), PetscViewerDestroy(), PetscViewerDrawGetDraw(), PetscViewerCreate(), PETSC_VIEWER_DRAW_,
410: PETSC_VIEWER_DRAW_WORLD, PETSC_VIEWER_DRAW_SELF
411: @*/
412: PetscErrorCode PetscViewerDrawOpen(MPI_Comm comm,const char display[],const char title[],int x,int y,int w,int h,PetscViewer *viewer)
413: {
417: PetscViewerCreate(comm,viewer);
418: PetscViewerSetType(*viewer,PETSCVIEWERDRAW);
419: PetscViewerDrawSetInfo(*viewer,display,title,x,y,w,h);
420: return(0);
421: }
423: PetscErrorCode PetscViewerGetSubViewer_Draw(PetscViewer viewer,MPI_Comm comm,PetscViewer *sviewer)
424: {
425: PetscErrorCode ierr;
426: PetscMPIInt rank;
427: PetscInt i;
428: PetscViewer_Draw *vdraw = (PetscViewer_Draw*)viewer->data,*svdraw;
431: if (vdraw->singleton_made) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"Trying to get SubViewer without first restoring previous");
432: /* only processor zero can use the PetscViewer draw singleton */
433: if (sviewer) *sviewer = NULL;
434: MPI_Comm_rank(PetscObjectComm((PetscObject)viewer),&rank);
435: if (!rank) {
436: PetscMPIInt flg;
438: MPI_Comm_compare(PETSC_COMM_SELF,comm,&flg);
439: if (flg != MPI_IDENT && flg != MPI_CONGRUENT) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"PetscViewerGetSubViewer() for PETSCVIEWERDRAW requires a singleton MPI_Comm");
440: PetscViewerCreate(comm,sviewer);
441: PetscViewerSetType(*sviewer,PETSCVIEWERDRAW);
442: svdraw = (PetscViewer_Draw*)(*sviewer)->data;
443: (*sviewer)->format = viewer->format;
444: for (i=0; i<vdraw->draw_max; i++) { /* XXX this is wrong if svdraw->draw_max (initially 5) < vdraw->draw_max */
445: if (vdraw->draw[i]) {PetscDrawGetSingleton(vdraw->draw[i],&svdraw->draw[i]);}
446: }
447: }
448: vdraw->singleton_made = PETSC_TRUE;
449: return(0);
450: }
452: PetscErrorCode PetscViewerRestoreSubViewer_Draw(PetscViewer viewer,MPI_Comm comm,PetscViewer *sviewer)
453: {
454: PetscErrorCode ierr;
455: PetscMPIInt rank;
456: PetscInt i;
457: PetscViewer_Draw *vdraw = (PetscViewer_Draw*)viewer->data,*svdraw;
460: if (!vdraw->singleton_made) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"Trying to restore a singleton that was not gotten");
461: MPI_Comm_rank(PetscObjectComm((PetscObject)viewer),&rank);
462: if (!rank) {
463: svdraw = (PetscViewer_Draw*)(*sviewer)->data;
464: for (i=0; i<vdraw->draw_max; i++) {
465: if (vdraw->draw[i] && svdraw->draw[i]) {
466: PetscDrawRestoreSingleton(vdraw->draw[i],&svdraw->draw[i]);
467: }
468: }
469: PetscFree3(svdraw->draw,svdraw->drawlg,svdraw->drawaxis);
470: PetscFree((*sviewer)->data);
471: PetscHeaderDestroy(sviewer);
472: }
473: vdraw->singleton_made = PETSC_FALSE;
474: return(0);
475: }
477: PetscErrorCode PetscViewerSetFromOptions_Draw(PetscOptionItems *PetscOptionsObject,PetscViewer v)
478: {
480: PetscReal bounds[16];
481: PetscInt nbounds = 16;
482: PetscBool flg;
485: PetscOptionsHead(PetscOptionsObject,"Draw PetscViewer Options");
486: PetscOptionsRealArray("-draw_bounds","Bounds to put on plots axis","PetscViewerDrawSetBounds",bounds,&nbounds,&flg);
487: if (flg) {
488: PetscViewerDrawSetBounds(v,nbounds/2,bounds);
489: }
490: PetscOptionsTail();
491: return(0);
492: }
494: PetscErrorCode PetscViewerView_Draw(PetscViewer viewer,PetscViewer v)
495: {
496: PetscErrorCode ierr;
497: PetscDraw draw;
498: PetscInt i;
499: PetscViewer_Draw *vdraw = (PetscViewer_Draw*)viewer->data;
502: /* If the PetscViewer has just been created then no vdraw->draw yet
503: exists so this will not actually call the viewer on any draws. */
504: for (i=0; i<vdraw->draw_base; i++) {
505: if (vdraw->draw[i]) {
506: PetscViewerDrawGetDraw(viewer,i,&draw);
507: PetscDrawView(draw,v);
508: }
509: }
510: return(0);
511: }
513: /*MC
514: PETSCVIEWERDRAW - A viewer that generates graphics, either to the screen or a file
517: .seealso: PetscViewerDrawOpen(), PetscViewerDrawGetDraw(), PETSC_VIEWER_DRAW_(),PETSC_VIEWER_DRAW_SELF, PETSC_VIEWER_DRAW_WORLD,
518: PetscViewerCreate(), PetscViewerASCIIOpen(), PetscViewerBinaryOpen(), PETSCVIEWERBINARY,
519: PetscViewerMatlabOpen(), VecView(), DMView(), PetscViewerMatlabPutArray(), PETSCVIEWERASCII, PETSCVIEWERMATLAB,
520: PetscViewerFileSetName(), PetscViewerFileSetMode(), PetscViewerFormat, PetscViewerType, PetscViewerSetType()
522: Level: beginner
524: M*/
525: PETSC_EXTERN PetscErrorCode PetscViewerCreate_Draw(PetscViewer viewer)
526: {
527: PetscErrorCode ierr;
528: PetscViewer_Draw *vdraw;
531: PetscNewLog(viewer,&vdraw);
532: viewer->data = (void*)vdraw;
534: viewer->ops->flush = PetscViewerFlush_Draw;
535: viewer->ops->view = PetscViewerView_Draw;
536: viewer->ops->destroy = PetscViewerDestroy_Draw;
537: viewer->ops->setfromoptions = PetscViewerSetFromOptions_Draw;
538: viewer->ops->getsubviewer = PetscViewerGetSubViewer_Draw;
539: viewer->ops->restoresubviewer = PetscViewerRestoreSubViewer_Draw;
541: /* these are created on the fly if requested */
542: vdraw->draw_max = 5;
543: vdraw->draw_base = 0;
544: vdraw->w = PETSC_DECIDE;
545: vdraw->h = PETSC_DECIDE;
547: PetscCalloc3(vdraw->draw_max,&vdraw->draw,vdraw->draw_max,&vdraw->drawlg,vdraw->draw_max,&vdraw->drawaxis);
548: vdraw->singleton_made = PETSC_FALSE;
549: return(0);
550: }
552: /*@
553: PetscViewerDrawClear - Clears a PetscDraw graphic associated with a PetscViewer.
555: Not Collective
557: Input Parameter:
558: . viewer - the PetscViewer
560: Level: intermediate
562: .seealso: PetscViewerDrawOpen(), PetscViewerDrawGetDraw(),
564: @*/
565: PetscErrorCode PetscViewerDrawClear(PetscViewer viewer)
566: {
567: PetscErrorCode ierr;
568: PetscViewer_Draw *vdraw;
569: PetscBool isdraw;
570: PetscInt i;
574: PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);
575: if (!isdraw) return(0);
576: vdraw = (PetscViewer_Draw*)viewer->data;
578: for (i=0; i<vdraw->draw_max; i++) {
579: if (vdraw->draw[i]) {PetscDrawClear(vdraw->draw[i]);}
580: }
581: return(0);
582: }
584: /*@
585: PetscViewerDrawGetPause - Gets a pause for the first present draw
587: Not Collective
589: Input Parameter:
590: . viewer - the PetscViewer
592: Output Parameter:
593: . pause - the pause value
595: Level: intermediate
597: .seealso: PetscViewerDrawOpen(), PetscViewerDrawGetDraw(),
599: @*/
600: PetscErrorCode PetscViewerDrawGetPause(PetscViewer viewer,PetscReal *pause)
601: {
602: PetscErrorCode ierr;
603: PetscViewer_Draw *vdraw;
604: PetscBool isdraw;
605: PetscInt i;
606: PetscDraw draw;
610: PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);
611: if (!isdraw) {*pause = 0.0; return(0);}
612: vdraw = (PetscViewer_Draw*)viewer->data;
614: for (i=0; i<vdraw->draw_max; i++) {
615: if (vdraw->draw[i]) {
616: PetscDrawGetPause(vdraw->draw[i],pause);
617: return(0);
618: }
619: }
620: /* none exist yet so create one and get its pause */
621: PetscViewerDrawGetDraw(viewer,0,&draw);
622: PetscDrawGetPause(draw,pause);
623: return(0);
624: }
626: /*@
627: PetscViewerDrawSetPause - Sets a pause for each PetscDraw in the viewer
629: Not Collective
631: Input Parameters:
632: + viewer - the PetscViewer
633: - pause - the pause value
635: Level: intermediate
637: .seealso: PetscViewerDrawOpen(), PetscViewerDrawGetDraw(),
639: @*/
640: PetscErrorCode PetscViewerDrawSetPause(PetscViewer viewer,PetscReal pause)
641: {
642: PetscErrorCode ierr;
643: PetscViewer_Draw *vdraw;
644: PetscBool isdraw;
645: PetscInt i;
649: PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);
650: if (!isdraw) return(0);
651: vdraw = (PetscViewer_Draw*)viewer->data;
653: vdraw->pause = pause;
654: for (i=0; i<vdraw->draw_max; i++) {
655: if (vdraw->draw[i]) {PetscDrawSetPause(vdraw->draw[i],pause);}
656: }
657: return(0);
658: }
661: /*@
662: PetscViewerDrawSetHold - Holds previous image when drawing new image
664: Not Collective
666: Input Parameters:
667: + viewer - the PetscViewer
668: - hold - indicates to hold or not
670: Level: intermediate
672: .seealso: PetscViewerDrawOpen(), PetscViewerDrawGetDraw(),
674: @*/
675: PetscErrorCode PetscViewerDrawSetHold(PetscViewer viewer,PetscBool hold)
676: {
677: PetscErrorCode ierr;
678: PetscViewer_Draw *vdraw;
679: PetscBool isdraw;
683: PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);
684: if (!isdraw) return(0);
685: vdraw = (PetscViewer_Draw*)viewer->data;
687: vdraw->hold = hold;
688: return(0);
689: }
691: /*@
692: PetscViewerDrawGetHold - Checks if holds previous image when drawing new image
694: Not Collective
696: Input Parameter:
697: . viewer - the PetscViewer
699: Output Parameter:
700: . hold - indicates to hold or not
702: Level: intermediate
704: .seealso: PetscViewerDrawOpen(), PetscViewerDrawGetDraw(),
706: @*/
707: PetscErrorCode PetscViewerDrawGetHold(PetscViewer viewer,PetscBool *hold)
708: {
709: PetscErrorCode ierr;
710: PetscViewer_Draw *vdraw;
711: PetscBool isdraw;
715: PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);
716: if (!isdraw) {*hold = PETSC_FALSE; return(0);}
717: vdraw = (PetscViewer_Draw*)viewer->data;
719: *hold = vdraw->hold;
720: return(0);
721: }
723: /* ---------------------------------------------------------------------*/
724: /*
725: The variable Petsc_Viewer_Draw_keyval is used to indicate an MPI attribute that
726: is attached to a communicator, in this case the attribute is a PetscViewer.
727: */
728: PetscMPIInt Petsc_Viewer_Draw_keyval = MPI_KEYVAL_INVALID;
730: /*@C
731: PETSC_VIEWER_DRAW_ - Creates a window PetscViewer shared by all processors
732: in a communicator.
734: Collective
736: Input Parameter:
737: . comm - the MPI communicator to share the window PetscViewer
739: Level: intermediate
741: Notes:
742: Unlike almost all other PETSc routines, PETSC_VIEWER_DRAW_ does not return
743: an error code. The window is usually used in the form
744: $ XXXView(XXX object,PETSC_VIEWER_DRAW_(comm));
746: .seealso: PETSC_VIEWER_DRAW_WORLD, PETSC_VIEWER_DRAW_SELF, PetscViewerDrawOpen(),
747: @*/
748: PetscViewer PETSC_VIEWER_DRAW_(MPI_Comm comm)
749: {
751: PetscMPIInt flag;
752: PetscViewer viewer;
753: MPI_Comm ncomm;
756: PetscCommDuplicate(comm,&ncomm,NULL);if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_DRAW_",__FILE__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");return(0);}
757: if (Petsc_Viewer_Draw_keyval == MPI_KEYVAL_INVALID) {
758: MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,MPI_COMM_NULL_DELETE_FN,&Petsc_Viewer_Draw_keyval,0);
759: if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_DRAW_",__FILE__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");return(0);}
760: }
761: MPI_Comm_get_attr(ncomm,Petsc_Viewer_Draw_keyval,(void**)&viewer,&flag);
762: if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_DRAW_",__FILE__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");return(0);}
763: if (!flag) { /* PetscViewer not yet created */
764: PetscViewerDrawOpen(ncomm,0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,&viewer);
765: if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_DRAW_",__FILE__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");return(0);}
766: PetscObjectRegisterDestroy((PetscObject)viewer);
767: if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_DRAW_",__FILE__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");return(0);}
768: MPI_Comm_set_attr(ncomm,Petsc_Viewer_Draw_keyval,(void*)viewer);
769: if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_DRAW_",__FILE__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");return(0);}
770: }
771: PetscCommDestroy(&ncomm);
772: if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_DRAW_",__FILE__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");return(0);}
773: PetscFunctionReturn(viewer);
774: }
776: /*@
777: PetscViewerDrawSetBounds - sets the upper and lower bounds to be used in plotting
779: Collective on PetscViewer
781: Input Parameters:
782: + viewer - the PetscViewer (created with PetscViewerDrawOpen())
783: . nbounds - number of plots that can be made with this viewer, for example the dof passed to DMDACreate()
784: - bounds - the actual bounds, the size of this is 2*nbounds, the values are stored in the order min F_0, max F_0, min F_1, max F_1, .....
787: Options Database:
788: . -draw_bounds minF0,maxF0,minF1,maxF1
790: Level: intermediate
792: Notes:
793: this determines the colors used in 2d contour plots generated with VecView() for DMDA in 2d. Any values in the vector below or above the
794: bounds are moved to the bound value before plotting. In this way the color index from color to physical value remains the same for all plots generated with
795: this viewer. Otherwise the color to physical value meaning changes with each new image if this is not set.
798: .seealso: PetscViewerDrawGetLG(), PetscViewerDrawGetAxis(), PetscViewerDrawOpen()
799: @*/
800: PetscErrorCode PetscViewerDrawSetBounds(PetscViewer viewer,PetscInt nbounds,const PetscReal *bounds)
801: {
802: PetscViewer_Draw *vdraw;
803: PetscBool isdraw;
804: PetscErrorCode ierr;
809: PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);
810: if (!isdraw) return(0);
811: vdraw = (PetscViewer_Draw*)viewer->data;
813: vdraw->nbounds = nbounds;
814: PetscFree(vdraw->bounds);
815: PetscMalloc1(2*nbounds,&vdraw->bounds);
816: PetscArraycpy(vdraw->bounds,bounds,2*nbounds);
817: return(0);
818: }
820: /*@C
821: PetscViewerDrawGetBounds - gets the upper and lower bounds to be used in plotting set with PetscViewerDrawSetBounds()
823: Collective on PetscViewer
825: Input Parameter:
826: . viewer - the PetscViewer (created with PetscViewerDrawOpen())
828: Output Paramters:
829: + nbounds - number of plots that can be made with this viewer, for example the dof passed to DMDACreate()
830: - bounds - the actual bounds, the size of this is 2*nbounds, the values are stored in the order min F_0, max F_0, min F_1, max F_1, .....
832: Level: intermediate
835: .seealso: PetscViewerDrawGetLG(), PetscViewerDrawGetAxis(), PetscViewerDrawOpen(), PetscViewerDrawSetBounds()
836: @*/
837: PetscErrorCode PetscViewerDrawGetBounds(PetscViewer viewer,PetscInt *nbounds,const PetscReal **bounds)
838: {
839: PetscViewer_Draw *vdraw;
840: PetscBool isdraw;
841: PetscErrorCode ierr;
845: PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);
846: if (!isdraw) {if (nbounds) *nbounds = 0; if (bounds) *bounds = NULL; return(0);}
847: vdraw = (PetscViewer_Draw*)viewer->data;
849: if (nbounds) *nbounds = vdraw->nbounds;
850: if (bounds) *bounds = vdraw->bounds;
851: return(0);
852: }