xref: /petsc/src/sys/classes/viewer/impls/draw/drawv.c (revision d4c7638e66bfbab42594e49bfd8787d3c0f17499)
15c6c1daeSBarry Smith 
25c6c1daeSBarry Smith #include <../src/sys/classes/viewer/impls/draw/vdraw.h> /*I "petscdraw.h" I*/
3665c2dedSJed Brown #include <petscviewer.h>                                /*I "petscviewer.h" I*/
45c6c1daeSBarry Smith 
5e0877f53SBarry Smith static PetscErrorCode PetscViewerDestroy_Draw(PetscViewer v)
65c6c1daeSBarry Smith {
75c6c1daeSBarry Smith   PetscErrorCode   ierr;
85c6c1daeSBarry Smith   PetscInt         i;
95c6c1daeSBarry Smith   PetscViewer_Draw *vdraw = (PetscViewer_Draw*)v->data;
105c6c1daeSBarry Smith 
115c6c1daeSBarry Smith   PetscFunctionBegin;
125c6c1daeSBarry Smith   if (vdraw->singleton_made) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"Destroying PetscViewer without first restoring singleton");
135c6c1daeSBarry Smith   for (i=0; i<vdraw->draw_max; i++) {
145c6c1daeSBarry Smith     ierr = PetscDrawAxisDestroy(&vdraw->drawaxis[i]);CHKERRQ(ierr);
155c6c1daeSBarry Smith     ierr = PetscDrawLGDestroy(&vdraw->drawlg[i]);CHKERRQ(ierr);
165c6c1daeSBarry Smith     ierr = PetscDrawDestroy(&vdraw->draw[i]);CHKERRQ(ierr);
175c6c1daeSBarry Smith   }
185c6c1daeSBarry Smith   ierr = PetscFree(vdraw->display);CHKERRQ(ierr);
195c6c1daeSBarry Smith   ierr = PetscFree(vdraw->title);CHKERRQ(ierr);
205c6c1daeSBarry Smith   ierr = PetscFree3(vdraw->draw,vdraw->drawlg,vdraw->drawaxis);CHKERRQ(ierr);
215c6c1daeSBarry Smith   ierr = PetscFree(vdraw->bounds);CHKERRQ(ierr);
22d1da0b69SBarry Smith   ierr = PetscFree(vdraw->drawtype);CHKERRQ(ierr);
23e5ab1681SLisandro Dalcin   ierr = PetscFree(v->data);CHKERRQ(ierr);
245c6c1daeSBarry Smith   PetscFunctionReturn(0);
255c6c1daeSBarry Smith }
265c6c1daeSBarry Smith 
27e0877f53SBarry Smith static PetscErrorCode PetscViewerFlush_Draw(PetscViewer v)
285c6c1daeSBarry Smith {
295c6c1daeSBarry Smith   PetscErrorCode   ierr;
305c6c1daeSBarry Smith   PetscInt         i;
315c6c1daeSBarry Smith   PetscViewer_Draw *vdraw = (PetscViewer_Draw*)v->data;
325c6c1daeSBarry Smith 
335c6c1daeSBarry Smith   PetscFunctionBegin;
345c6c1daeSBarry Smith   for (i=0; i<vdraw->draw_max; i++) {
355b399a63SLisandro Dalcin     if (vdraw->draw[i]) {ierr = PetscDrawFlush(vdraw->draw[i]);CHKERRQ(ierr);}
365c6c1daeSBarry Smith   }
375c6c1daeSBarry Smith   PetscFunctionReturn(0);
385c6c1daeSBarry Smith }
395c6c1daeSBarry Smith 
405c6c1daeSBarry Smith /*@C
415c6c1daeSBarry Smith     PetscViewerDrawGetDraw - Returns PetscDraw object from PetscViewer object.
425c6c1daeSBarry Smith     This PetscDraw object may then be used to perform graphics using
435c6c1daeSBarry Smith     PetscDrawXXX() commands.
445c6c1daeSBarry Smith 
45d94959e9SLisandro Dalcin     Collective on PetscViewer
465c6c1daeSBarry Smith 
475c6c1daeSBarry Smith     Input Parameters:
485c6c1daeSBarry Smith +   viewer - the PetscViewer (created with PetscViewerDrawOpen())
495c6c1daeSBarry Smith -   windownumber - indicates which subwindow (usually 0)
505c6c1daeSBarry Smith 
515c6c1daeSBarry Smith     Ouput Parameter:
525c6c1daeSBarry Smith .   draw - the draw object
535c6c1daeSBarry Smith 
545c6c1daeSBarry Smith     Level: intermediate
555c6c1daeSBarry Smith 
565c6c1daeSBarry Smith    Concepts: drawing^accessing PetscDraw context from PetscViewer
575c6c1daeSBarry Smith    Concepts: graphics
585c6c1daeSBarry Smith 
595c6c1daeSBarry Smith .seealso: PetscViewerDrawGetLG(), PetscViewerDrawGetAxis(), PetscViewerDrawOpen()
605c6c1daeSBarry Smith @*/
615c6c1daeSBarry Smith PetscErrorCode  PetscViewerDrawGetDraw(PetscViewer viewer,PetscInt windownumber,PetscDraw *draw)
625c6c1daeSBarry Smith {
63e5ab1681SLisandro Dalcin   PetscViewer_Draw *vdraw;
645c6c1daeSBarry Smith   PetscErrorCode   ierr;
655c6c1daeSBarry Smith   PetscBool        isdraw;
665c6c1daeSBarry Smith 
675c6c1daeSBarry Smith   PetscFunctionBegin;
685c6c1daeSBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
69e5ab1681SLisandro Dalcin   PetscValidLogicalCollectiveInt(viewer,windownumber,2);
705c6c1daeSBarry Smith   if (draw) PetscValidPointer(draw,3);
715c6c1daeSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
725c6c1daeSBarry Smith   if (!isdraw) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Must be draw type PetscViewer");
735c6c1daeSBarry Smith   if (windownumber < 0) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Window number cannot be negative");
74e5ab1681SLisandro Dalcin   vdraw = (PetscViewer_Draw*)viewer->data;
75e5ab1681SLisandro Dalcin 
765c6c1daeSBarry Smith   windownumber += vdraw->draw_base;
775c6c1daeSBarry Smith   if (windownumber >= vdraw->draw_max) {
785c6c1daeSBarry Smith     /* allocate twice as many slots as needed */
795c6c1daeSBarry Smith     PetscInt      draw_max  = vdraw->draw_max;
805c6c1daeSBarry Smith     PetscDraw     *tdraw    = vdraw->draw;
815c6c1daeSBarry Smith     PetscDrawLG   *drawlg   = vdraw->drawlg;
825c6c1daeSBarry Smith     PetscDrawAxis *drawaxis = vdraw->drawaxis;
835c6c1daeSBarry Smith 
845c6c1daeSBarry Smith     vdraw->draw_max = 2*windownumber;
85a297a907SKarl Rupp 
861795a4d1SJed Brown     ierr = PetscCalloc3(vdraw->draw_max,&vdraw->draw,vdraw->draw_max,&vdraw->drawlg,vdraw->draw_max,&vdraw->drawaxis);CHKERRQ(ierr);
875c6c1daeSBarry Smith 
885c6c1daeSBarry Smith     ierr = PetscMemcpy(vdraw->draw,tdraw,draw_max*sizeof(PetscDraw));CHKERRQ(ierr);
895c6c1daeSBarry Smith     ierr = PetscMemcpy(vdraw->drawlg,drawlg,draw_max*sizeof(PetscDrawLG));CHKERRQ(ierr);
905c6c1daeSBarry Smith     ierr = PetscMemcpy(vdraw->drawaxis,drawaxis,draw_max*sizeof(PetscDrawAxis));CHKERRQ(ierr);
915c6c1daeSBarry Smith 
925c6c1daeSBarry Smith     ierr = PetscFree3(tdraw,drawlg,drawaxis);CHKERRQ(ierr);
935c6c1daeSBarry Smith   }
945c6c1daeSBarry Smith 
955c6c1daeSBarry Smith   if (!vdraw->draw[windownumber]) {
96e5ab1681SLisandro Dalcin     char *title = vdraw->title, tmp_str[128];
9710f3a0f4SLisandro Dalcin     if (windownumber) {
9810f3a0f4SLisandro Dalcin       ierr = PetscSNPrintf(tmp_str,sizeof(tmp_str),"%s:%d",vdraw->title?vdraw->title:"",windownumber);CHKERRQ(ierr);
995c6c1daeSBarry Smith       title = tmp_str;
1005c6c1daeSBarry Smith     }
101ce94432eSBarry Smith     ierr = PetscDrawCreate(PetscObjectComm((PetscObject)viewer),vdraw->display,title,PETSC_DECIDE,PETSC_DECIDE,vdraw->w,vdraw->h,&vdraw->draw[windownumber]);CHKERRQ(ierr);
102e5ab1681SLisandro Dalcin     ierr = PetscLogObjectParent((PetscObject)viewer,(PetscObject)vdraw->draw[windownumber]);CHKERRQ(ierr);
103d1da0b69SBarry Smith     if (vdraw->drawtype) {
104d1da0b69SBarry Smith       ierr = PetscDrawSetType(vdraw->draw[windownumber],vdraw->drawtype);CHKERRQ(ierr);
105d1da0b69SBarry Smith     }
106afe78b3cSBarry Smith     ierr = PetscDrawSetPause(vdraw->draw[windownumber],vdraw->pause);CHKERRQ(ierr);
107d94959e9SLisandro Dalcin     ierr = PetscDrawSetOptionsPrefix(vdraw->draw[windownumber],((PetscObject)viewer)->prefix);CHKERRQ(ierr);
1085c6c1daeSBarry Smith     ierr = PetscDrawSetFromOptions(vdraw->draw[windownumber]);CHKERRQ(ierr);
1095c6c1daeSBarry Smith   }
1105c6c1daeSBarry Smith   if (draw) *draw = vdraw->draw[windownumber];
1115c6c1daeSBarry Smith   if (draw) PetscValidHeaderSpecific(*draw,PETSC_DRAW_CLASSID,-1);
1125c6c1daeSBarry Smith   PetscFunctionReturn(0);
1135c6c1daeSBarry Smith }
1145c6c1daeSBarry Smith 
1155c6c1daeSBarry Smith /*@C
1165c6c1daeSBarry Smith     PetscViewerDrawBaseAdd - add to the base integer that is added to the windownumber passed to PetscViewerDrawGetDraw()
1175c6c1daeSBarry Smith 
118d94959e9SLisandro Dalcin     Logically Collective on PetscViewer
1195c6c1daeSBarry Smith 
1205c6c1daeSBarry Smith     Input Parameters:
1215c6c1daeSBarry Smith +  viewer - the PetscViewer (created with PetscViewerDrawOpen())
1225c6c1daeSBarry Smith -   windownumber - how much to add to the base
1235c6c1daeSBarry Smith 
1245c6c1daeSBarry Smith     Level: developer
1255c6c1daeSBarry Smith 
1265c6c1daeSBarry Smith    Concepts: drawing^accessing PetscDraw context from PetscViewer
1275c6c1daeSBarry Smith    Concepts: graphics
1285c6c1daeSBarry Smith 
1295c6c1daeSBarry Smith .seealso: PetscViewerDrawGetLG(), PetscViewerDrawGetAxis(), PetscViewerDrawOpen(), PetscViewerDrawGetDraw(), PetscViewerDrawBaseSet()
1305c6c1daeSBarry Smith @*/
1315c6c1daeSBarry Smith PetscErrorCode  PetscViewerDrawBaseAdd(PetscViewer viewer,PetscInt windownumber)
1325c6c1daeSBarry Smith {
133e5ab1681SLisandro Dalcin   PetscViewer_Draw *vdraw;
1345c6c1daeSBarry Smith   PetscErrorCode   ierr;
1355c6c1daeSBarry Smith   PetscBool        isdraw;
1365c6c1daeSBarry Smith 
1375c6c1daeSBarry Smith   PetscFunctionBegin;
1385c6c1daeSBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
139e5ab1681SLisandro Dalcin   PetscValidLogicalCollectiveInt(viewer,windownumber,2);
1405c6c1daeSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
1415c6c1daeSBarry Smith   if (!isdraw) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Must be draw type PetscViewer");
142e5ab1681SLisandro Dalcin   vdraw = (PetscViewer_Draw*)viewer->data;
143e5ab1681SLisandro Dalcin 
1445c6c1daeSBarry Smith   if (windownumber + vdraw->draw_base < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Resulting base %D cannot be negative",windownumber+vdraw->draw_base);
1455c6c1daeSBarry Smith   vdraw->draw_base += windownumber;
1465c6c1daeSBarry Smith   PetscFunctionReturn(0);
1475c6c1daeSBarry Smith }
1485c6c1daeSBarry Smith 
1495c6c1daeSBarry Smith /*@C
1505c6c1daeSBarry Smith     PetscViewerDrawBaseSet - sets the base integer that is added to the windownumber passed to PetscViewerDrawGetDraw()
1515c6c1daeSBarry Smith 
152d94959e9SLisandro Dalcin     Logically Collective on PetscViewer
1535c6c1daeSBarry Smith 
1545c6c1daeSBarry Smith     Input Parameters:
1555c6c1daeSBarry Smith +   viewer - the PetscViewer (created with PetscViewerDrawOpen())
1565c6c1daeSBarry Smith -   windownumber - value to set the base
1575c6c1daeSBarry Smith 
1585c6c1daeSBarry Smith     Level: developer
1595c6c1daeSBarry Smith 
1605c6c1daeSBarry Smith    Concepts: drawing^accessing PetscDraw context from PetscViewer
1615c6c1daeSBarry Smith    Concepts: graphics
1625c6c1daeSBarry Smith 
1635c6c1daeSBarry Smith .seealso: PetscViewerDrawGetLG(), PetscViewerDrawGetAxis(), PetscViewerDrawOpen(), PetscViewerDrawGetDraw(), PetscViewerDrawBaseAdd()
1645c6c1daeSBarry Smith @*/
1655c6c1daeSBarry Smith PetscErrorCode  PetscViewerDrawBaseSet(PetscViewer viewer,PetscInt windownumber)
1665c6c1daeSBarry Smith {
167e5ab1681SLisandro Dalcin   PetscViewer_Draw *vdraw;
1685c6c1daeSBarry Smith   PetscErrorCode   ierr;
1695c6c1daeSBarry Smith   PetscBool        isdraw;
1705c6c1daeSBarry Smith 
1715c6c1daeSBarry Smith   PetscFunctionBegin;
1725c6c1daeSBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
173e5ab1681SLisandro Dalcin   PetscValidLogicalCollectiveInt(viewer,windownumber,2);
1745c6c1daeSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
1755c6c1daeSBarry Smith   if (!isdraw) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Must be draw type PetscViewer");
176e5ab1681SLisandro Dalcin   vdraw = (PetscViewer_Draw*)viewer->data;
177e5ab1681SLisandro Dalcin 
1785c6c1daeSBarry Smith   if (windownumber < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Resulting base %D cannot be negative",windownumber);
1795c6c1daeSBarry Smith   vdraw->draw_base = windownumber;
1805c6c1daeSBarry Smith   PetscFunctionReturn(0);
1815c6c1daeSBarry Smith }
1825c6c1daeSBarry Smith 
1835c6c1daeSBarry Smith /*@C
1845c6c1daeSBarry Smith     PetscViewerDrawGetDrawLG - Returns PetscDrawLG object from PetscViewer object.
1855c6c1daeSBarry Smith     This PetscDrawLG object may then be used to perform graphics using
1865c6c1daeSBarry Smith     PetscDrawLGXXX() commands.
1875c6c1daeSBarry Smith 
188d94959e9SLisandro Dalcin     Collective on PetscViewer
1895c6c1daeSBarry Smith 
1905c6c1daeSBarry Smith     Input Parameter:
1915c6c1daeSBarry Smith +   PetscViewer - the PetscViewer (created with PetscViewerDrawOpen())
1925c6c1daeSBarry Smith -   windownumber - indicates which subwindow (usually 0)
1935c6c1daeSBarry Smith 
1945c6c1daeSBarry Smith     Ouput Parameter:
1955c6c1daeSBarry Smith .   draw - the draw line graph object
1965c6c1daeSBarry Smith 
1975c6c1daeSBarry Smith     Level: intermediate
1985c6c1daeSBarry Smith 
1995c6c1daeSBarry Smith   Concepts: line graph^accessing context
2005c6c1daeSBarry Smith 
2015c6c1daeSBarry Smith .seealso: PetscViewerDrawGetDraw(), PetscViewerDrawGetAxis(), PetscViewerDrawOpen()
2025c6c1daeSBarry Smith @*/
2035c6c1daeSBarry Smith PetscErrorCode  PetscViewerDrawGetDrawLG(PetscViewer viewer,PetscInt windownumber,PetscDrawLG *drawlg)
2045c6c1daeSBarry Smith {
2055c6c1daeSBarry Smith   PetscErrorCode   ierr;
2065c6c1daeSBarry Smith   PetscBool        isdraw;
207e5ab1681SLisandro Dalcin   PetscViewer_Draw *vdraw;
2085c6c1daeSBarry Smith 
2095c6c1daeSBarry Smith   PetscFunctionBegin;
2105c6c1daeSBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
211e5ab1681SLisandro Dalcin   PetscValidLogicalCollectiveInt(viewer,windownumber,2);
2125c6c1daeSBarry Smith   PetscValidPointer(drawlg,3);
2135c6c1daeSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
2145c6c1daeSBarry Smith   if (!isdraw) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Must be draw type PetscViewer");
2155c6c1daeSBarry Smith   if (windownumber < 0) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Window number cannot be negative");
216e5ab1681SLisandro Dalcin   vdraw = (PetscViewer_Draw*)viewer->data;
2175c6c1daeSBarry Smith 
2185c6c1daeSBarry Smith   if (windownumber+vdraw->draw_base >= vdraw->draw_max || !vdraw->draw[windownumber+vdraw->draw_base]) {
2190298fd71SBarry Smith     ierr = PetscViewerDrawGetDraw(viewer,windownumber,NULL);CHKERRQ(ierr);
2205c6c1daeSBarry Smith   }
2215c6c1daeSBarry Smith   if (!vdraw->drawlg[windownumber+vdraw->draw_base]) {
2225c6c1daeSBarry Smith     ierr = PetscDrawLGCreate(vdraw->draw[windownumber+vdraw->draw_base],1,&vdraw->drawlg[windownumber+vdraw->draw_base]);CHKERRQ(ierr);
2233bb1ff40SBarry Smith     ierr = PetscLogObjectParent((PetscObject)viewer,(PetscObject)vdraw->drawlg[windownumber+vdraw->draw_base]);CHKERRQ(ierr);
224de1a4edeSLisandro Dalcin     ierr = PetscDrawLGSetFromOptions(vdraw->drawlg[windownumber+vdraw->draw_base]);CHKERRQ(ierr);
2255c6c1daeSBarry Smith   }
2265c6c1daeSBarry Smith   *drawlg = vdraw->drawlg[windownumber+vdraw->draw_base];
2275c6c1daeSBarry Smith   PetscFunctionReturn(0);
2285c6c1daeSBarry Smith }
2295c6c1daeSBarry Smith 
2305c6c1daeSBarry Smith /*@C
2315c6c1daeSBarry Smith     PetscViewerDrawGetDrawAxis - Returns PetscDrawAxis object from PetscViewer object.
2325c6c1daeSBarry Smith     This PetscDrawAxis object may then be used to perform graphics using
2335c6c1daeSBarry Smith     PetscDrawAxisXXX() commands.
2345c6c1daeSBarry Smith 
235d94959e9SLisandro Dalcin     Collective on PetscViewer
2365c6c1daeSBarry Smith 
2375c6c1daeSBarry Smith     Input Parameter:
2385c6c1daeSBarry Smith +   viewer - the PetscViewer (created with PetscViewerDrawOpen()
2395c6c1daeSBarry Smith -   windownumber - indicates which subwindow (usually 0)
2405c6c1daeSBarry Smith 
2415c6c1daeSBarry Smith     Ouput Parameter:
2425c6c1daeSBarry Smith .   drawaxis - the draw axis object
2435c6c1daeSBarry Smith 
2445c6c1daeSBarry Smith     Level: advanced
2455c6c1daeSBarry Smith 
2465c6c1daeSBarry Smith   Concepts: line graph^accessing context
2475c6c1daeSBarry Smith 
2485c6c1daeSBarry Smith .seealso: PetscViewerDrawGetDraw(), PetscViewerDrawGetLG(), PetscViewerDrawOpen()
2495c6c1daeSBarry Smith @*/
2505c6c1daeSBarry Smith PetscErrorCode  PetscViewerDrawGetDrawAxis(PetscViewer viewer,PetscInt windownumber,PetscDrawAxis *drawaxis)
2515c6c1daeSBarry Smith {
2525c6c1daeSBarry Smith   PetscErrorCode   ierr;
2535c6c1daeSBarry Smith   PetscBool        isdraw;
254e5ab1681SLisandro Dalcin   PetscViewer_Draw *vdraw;
2555c6c1daeSBarry Smith 
2565c6c1daeSBarry Smith   PetscFunctionBegin;
2575c6c1daeSBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
258e5ab1681SLisandro Dalcin   PetscValidLogicalCollectiveInt(viewer,windownumber,2);
2595c6c1daeSBarry Smith   PetscValidPointer(drawaxis,3);
2605c6c1daeSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
2615c6c1daeSBarry Smith   if (!isdraw) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Must be draw type PetscViewer");
2625c6c1daeSBarry Smith   if (windownumber < 0) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Window number cannot be negative");
263e5ab1681SLisandro Dalcin   vdraw = (PetscViewer_Draw*)viewer->data;
2645c6c1daeSBarry Smith 
2655c6c1daeSBarry Smith   if (windownumber+vdraw->draw_base >= vdraw->draw_max || !vdraw->draw[windownumber+vdraw->draw_base]) {
2660298fd71SBarry Smith     ierr = PetscViewerDrawGetDraw(viewer,windownumber,NULL);CHKERRQ(ierr);
2675c6c1daeSBarry Smith   }
2685c6c1daeSBarry Smith   if (!vdraw->drawaxis[windownumber+vdraw->draw_base]) {
2695c6c1daeSBarry Smith     ierr = PetscDrawAxisCreate(vdraw->draw[windownumber+vdraw->draw_base],&vdraw->drawaxis[windownumber+vdraw->draw_base]);CHKERRQ(ierr);
2703bb1ff40SBarry Smith     ierr = PetscLogObjectParent((PetscObject)viewer,(PetscObject)vdraw->drawaxis[windownumber+vdraw->draw_base]);CHKERRQ(ierr);
2715c6c1daeSBarry Smith   }
2725c6c1daeSBarry Smith   *drawaxis = vdraw->drawaxis[windownumber+vdraw->draw_base];
2735c6c1daeSBarry Smith   PetscFunctionReturn(0);
2745c6c1daeSBarry Smith }
2755c6c1daeSBarry Smith 
2765c6c1daeSBarry Smith PetscErrorCode  PetscViewerDrawResize(PetscViewer v,int w,int h)
2775c6c1daeSBarry Smith {
278e5ab1681SLisandro Dalcin   PetscErrorCode   ierr;
279e5ab1681SLisandro Dalcin   PetscViewer_Draw *vdraw;
280e5ab1681SLisandro Dalcin   PetscBool        isdraw;
2815c6c1daeSBarry Smith 
2825c6c1daeSBarry Smith   PetscFunctionBegin;
283e5ab1681SLisandro Dalcin   PetscValidHeaderSpecific(v,PETSC_VIEWER_CLASSID,1);
284e5ab1681SLisandro Dalcin   ierr = PetscObjectTypeCompare((PetscObject)v,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
285e5ab1681SLisandro Dalcin   if (!isdraw) PetscFunctionReturn(0);
286e5ab1681SLisandro Dalcin   vdraw = (PetscViewer_Draw*)v->data;
287e5ab1681SLisandro Dalcin 
288e5ab1681SLisandro Dalcin   if (w >= 1) vdraw->w = w;
289e5ab1681SLisandro Dalcin   if (h >= 1) vdraw->h = h;
2905c6c1daeSBarry Smith   PetscFunctionReturn(0);
2915c6c1daeSBarry Smith }
2925c6c1daeSBarry Smith 
2935c6c1daeSBarry Smith PetscErrorCode  PetscViewerDrawSetInfo(PetscViewer v,const char display[],const char title[],int x,int y,int w,int h)
2945c6c1daeSBarry Smith {
2955c6c1daeSBarry Smith   PetscErrorCode   ierr;
296e5ab1681SLisandro Dalcin   PetscViewer_Draw *vdraw;
297e5ab1681SLisandro Dalcin   PetscBool        isdraw;
2985c6c1daeSBarry Smith 
2995c6c1daeSBarry Smith   PetscFunctionBegin;
300e5ab1681SLisandro Dalcin   PetscValidHeaderSpecific(v,PETSC_VIEWER_CLASSID,1);
301e5ab1681SLisandro Dalcin   ierr = PetscObjectTypeCompare((PetscObject)v,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
302e5ab1681SLisandro Dalcin   if (!isdraw) PetscFunctionReturn(0);
303e5ab1681SLisandro Dalcin   vdraw = (PetscViewer_Draw*)v->data;
304e5ab1681SLisandro Dalcin 
3055c6c1daeSBarry Smith   ierr = PetscStrallocpy(display,&vdraw->display);CHKERRQ(ierr);
3065c6c1daeSBarry Smith   ierr = PetscStrallocpy(title,&vdraw->title);CHKERRQ(ierr);
307e5ab1681SLisandro Dalcin   if (w >= 1) vdraw->w = w;
308e5ab1681SLisandro Dalcin   if (h >= 1) vdraw->h = h;
3095c6c1daeSBarry Smith   PetscFunctionReturn(0);
3105c6c1daeSBarry Smith }
3115c6c1daeSBarry Smith 
312d1da0b69SBarry Smith PetscErrorCode  PetscViewerDrawSetDrawType(PetscViewer v,PetscDrawType drawtype)
313d1da0b69SBarry Smith {
314d1da0b69SBarry Smith   PetscErrorCode   ierr;
315e5ab1681SLisandro Dalcin   PetscViewer_Draw *vdraw;
316e5ab1681SLisandro Dalcin   PetscBool        isdraw;
317d1da0b69SBarry Smith 
318d1da0b69SBarry Smith   PetscFunctionBegin;
319e5ab1681SLisandro Dalcin   PetscValidHeaderSpecific(v,PETSC_VIEWER_CLASSID,1);
320e5ab1681SLisandro Dalcin   ierr = PetscObjectTypeCompare((PetscObject)v,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
321e5ab1681SLisandro Dalcin   if (!isdraw) PetscFunctionReturn(0);
322e5ab1681SLisandro Dalcin   vdraw = (PetscViewer_Draw*)v->data;
323e5ab1681SLisandro Dalcin 
324d1da0b69SBarry Smith   ierr = PetscFree(vdraw->drawtype);CHKERRQ(ierr);
325d1da0b69SBarry Smith   ierr = PetscStrallocpy(drawtype,(char**)&vdraw->drawtype);CHKERRQ(ierr);
326d1da0b69SBarry Smith   PetscFunctionReturn(0);
327d1da0b69SBarry Smith }
328d1da0b69SBarry Smith 
3295c6c1daeSBarry Smith /*@C
3305c6c1daeSBarry Smith    PetscViewerDrawOpen - Opens a window for use as a PetscViewer. If you want to
3315c6c1daeSBarry Smith    do graphics in this window, you must call PetscViewerDrawGetDraw() and
3325c6c1daeSBarry Smith    perform the graphics on the PetscDraw object.
3335c6c1daeSBarry Smith 
3345c6c1daeSBarry Smith    Collective on MPI_Comm
3355c6c1daeSBarry Smith 
3365c6c1daeSBarry Smith    Input Parameters:
3375c6c1daeSBarry Smith +  comm - communicator that will share window
3385c6c1daeSBarry Smith .  display - the X display on which to open, or null for the local machine
3395c6c1daeSBarry Smith .  title - the title to put in the title bar, or null for no title
3405c6c1daeSBarry Smith .  x, y - the screen coordinates of the upper left corner of window, or use PETSC_DECIDE
3415c6c1daeSBarry Smith -  w, h - window width and height in pixels, or may use PETSC_DECIDE or PETSC_DRAW_FULL_SIZE, PETSC_DRAW_HALF_SIZE,
3425c6c1daeSBarry Smith           PETSC_DRAW_THIRD_SIZE, PETSC_DRAW_QUARTER_SIZE
3435c6c1daeSBarry Smith 
3445c6c1daeSBarry Smith    Output Parameters:
3455c6c1daeSBarry Smith . viewer - the PetscViewer
3465c6c1daeSBarry Smith 
3475c6c1daeSBarry Smith    Format Options:
3485c6c1daeSBarry Smith +  PETSC_VIEWER_DRAW_BASIC - displays with basic format
3495c6c1daeSBarry Smith -  PETSC_VIEWER_DRAW_LG    - displays using a line graph
3505c6c1daeSBarry Smith 
3515c6c1daeSBarry Smith    Options Database Keys:
3525c6c1daeSBarry Smith    PetscViewerDrawOpen() calls PetscDrawCreate(), so see the manual page for
3535c6c1daeSBarry Smith    PetscDrawCreate() for runtime options, including
3545c6c1daeSBarry Smith +  -draw_type x or null
3555c6c1daeSBarry Smith .  -nox - Disables all x-windows output
3565c6c1daeSBarry Smith .  -display <name> - Specifies name of machine for the X display
3575c6c1daeSBarry Smith .  -geometry <x,y,w,h> - allows setting the window location and size
3585c6c1daeSBarry Smith -  -draw_pause <pause> - Sets time (in seconds) that the
3595c6c1daeSBarry Smith      program pauses after PetscDrawPause() has been called
3605c6c1daeSBarry Smith      (0 is default, -1 implies until user input).
3615c6c1daeSBarry Smith 
3625c6c1daeSBarry Smith    Level: beginner
3635c6c1daeSBarry Smith 
3645c6c1daeSBarry Smith    Note for Fortran Programmers:
3655c6c1daeSBarry Smith    Whenever indicating null character data in a Fortran code,
3660298fd71SBarry Smith    NULL_CHARACTER must be employed; using NULL is not
3670298fd71SBarry Smith    correct for character data!  Thus, NULL_CHARACTER can be
3685c6c1daeSBarry Smith    used for the display and title input parameters.
3695c6c1daeSBarry Smith 
3705c6c1daeSBarry Smith   Concepts: graphics^opening PetscViewer
3715c6c1daeSBarry Smith   Concepts: drawing^opening PetscViewer
3725c6c1daeSBarry Smith 
3735c6c1daeSBarry Smith 
3745c6c1daeSBarry Smith .seealso: PetscDrawCreate(), PetscViewerDestroy(), PetscViewerDrawGetDraw(), PetscViewerCreate(), PETSC_VIEWER_DRAW_,
3755c6c1daeSBarry Smith           PETSC_VIEWER_DRAW_WORLD, PETSC_VIEWER_DRAW_SELF
3765c6c1daeSBarry Smith @*/
3775c6c1daeSBarry Smith PetscErrorCode  PetscViewerDrawOpen(MPI_Comm comm,const char display[],const char title[],int x,int y,int w,int h,PetscViewer *viewer)
3785c6c1daeSBarry Smith {
3795c6c1daeSBarry Smith   PetscErrorCode ierr;
3805c6c1daeSBarry Smith 
3815c6c1daeSBarry Smith   PetscFunctionBegin;
3825c6c1daeSBarry Smith   ierr = PetscViewerCreate(comm,viewer);CHKERRQ(ierr);
3835c6c1daeSBarry Smith   ierr = PetscViewerSetType(*viewer,PETSCVIEWERDRAW);CHKERRQ(ierr);
3845c6c1daeSBarry Smith   ierr = PetscViewerDrawSetInfo(*viewer,display,title,x,y,w,h);CHKERRQ(ierr);
3855c6c1daeSBarry Smith   PetscFunctionReturn(0);
3865c6c1daeSBarry Smith }
3875c6c1daeSBarry Smith 
3883f08860eSBarry Smith PetscErrorCode PetscViewerGetSubViewer_Draw(PetscViewer viewer,MPI_Comm comm,PetscViewer *sviewer)
3895c6c1daeSBarry Smith {
3905c6c1daeSBarry Smith   PetscErrorCode   ierr;
3915c6c1daeSBarry Smith   PetscMPIInt      rank;
3925c6c1daeSBarry Smith   PetscInt         i;
393c6228bbaSLisandro Dalcin   PetscViewer_Draw *vdraw = (PetscViewer_Draw*)viewer->data,*svdraw;
3945c6c1daeSBarry Smith 
3955c6c1daeSBarry Smith   PetscFunctionBegin;
3963f08860eSBarry Smith   if (vdraw->singleton_made) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"Trying to get SubViewer without first restoring previous");
3975c6c1daeSBarry Smith   /* only processor zero can use the PetscViewer draw singleton */
398c6228bbaSLisandro Dalcin   if (*sviewer) *sviewer = NULL;
399ce94432eSBarry Smith   ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)viewer),&rank);CHKERRQ(ierr);
4005c6c1daeSBarry Smith   if (!rank) {
4015c6c1daeSBarry Smith     ierr = PetscViewerCreate(PETSC_COMM_SELF,sviewer);CHKERRQ(ierr);
4025c6c1daeSBarry Smith     ierr = PetscViewerSetType(*sviewer,PETSCVIEWERDRAW);CHKERRQ(ierr);
403c6228bbaSLisandro Dalcin     svdraw = (PetscViewer_Draw*)(*sviewer)->data;
404c6228bbaSLisandro Dalcin     (*sviewer)->format = viewer->format;
405c6228bbaSLisandro Dalcin     for (i=0; i<vdraw->draw_max; i++) { /* XXX this is wrong if svdraw->draw_max (initially 5) < vdraw->draw_max */
406c6228bbaSLisandro Dalcin       if (vdraw->draw[i]) {ierr = PetscDrawGetSingleton(vdraw->draw[i],&svdraw->draw[i]);CHKERRQ(ierr);}
4075c6c1daeSBarry Smith     }
4085c6c1daeSBarry Smith   }
4095c6c1daeSBarry Smith   vdraw->singleton_made = PETSC_TRUE;
4105c6c1daeSBarry Smith   PetscFunctionReturn(0);
4115c6c1daeSBarry Smith }
4125c6c1daeSBarry Smith 
4133f08860eSBarry Smith PetscErrorCode PetscViewerRestoreSubViewer_Draw(PetscViewer viewer,MPI_Comm comm,PetscViewer *sviewer)
4145c6c1daeSBarry Smith {
4155c6c1daeSBarry Smith   PetscErrorCode   ierr;
4165c6c1daeSBarry Smith   PetscMPIInt      rank;
4175c6c1daeSBarry Smith   PetscInt         i;
418c6228bbaSLisandro Dalcin   PetscViewer_Draw *vdraw = (PetscViewer_Draw*)viewer->data,*svdraw;
4195c6c1daeSBarry Smith 
4205c6c1daeSBarry Smith   PetscFunctionBegin;
4215c6c1daeSBarry Smith   if (!vdraw->singleton_made) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"Trying to restore a singleton that was not gotten");
422ce94432eSBarry Smith   ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)viewer),&rank);CHKERRQ(ierr);
4235c6c1daeSBarry Smith   if (!rank) {
424c6228bbaSLisandro Dalcin     svdraw = (PetscViewer_Draw*)(*sviewer)->data;
4255c6c1daeSBarry Smith     for (i=0; i<vdraw->draw_max; i++) {
426c6228bbaSLisandro Dalcin       if (vdraw->draw[i] && svdraw->draw[i]) {
427c6228bbaSLisandro Dalcin         ierr = PetscDrawRestoreSingleton(vdraw->draw[i],&svdraw->draw[i]);CHKERRQ(ierr);
4285c6c1daeSBarry Smith       }
4295c6c1daeSBarry Smith     }
430c6228bbaSLisandro Dalcin     ierr = PetscFree3(svdraw->draw,svdraw->drawlg,svdraw->drawaxis);CHKERRQ(ierr);
4315c6c1daeSBarry Smith     ierr = PetscFree((*sviewer)->data);CHKERRQ(ierr);
4325c6c1daeSBarry Smith     ierr = PetscHeaderDestroy(sviewer);CHKERRQ(ierr);
4335c6c1daeSBarry Smith   }
4345c6c1daeSBarry Smith   vdraw->singleton_made = PETSC_FALSE;
4355c6c1daeSBarry Smith   PetscFunctionReturn(0);
4365c6c1daeSBarry Smith }
4375c6c1daeSBarry Smith 
4384416b707SBarry Smith PetscErrorCode PetscViewerSetFromOptions_Draw(PetscOptionItems *PetscOptionsObject,PetscViewer v)
439e9457bf7SBarry Smith {
440e9457bf7SBarry Smith   PetscErrorCode ierr;
441e9457bf7SBarry Smith   PetscReal      bounds[16];
442e9457bf7SBarry Smith   PetscInt       nbounds = 16;
443e9457bf7SBarry Smith   PetscBool      flg;
444e9457bf7SBarry Smith 
445e9457bf7SBarry Smith   PetscFunctionBegin;
446e55864a3SBarry Smith   ierr = PetscOptionsHead(PetscOptionsObject,"Draw PetscViewer Options");CHKERRQ(ierr);
447e9457bf7SBarry Smith   ierr = PetscOptionsRealArray("-draw_bounds","Bounds to put on plots axis","PetscViewerDrawSetBounds",bounds,&nbounds,&flg);CHKERRQ(ierr);
448e9457bf7SBarry Smith   if (flg) {
449e9457bf7SBarry Smith     ierr = PetscViewerDrawSetBounds(v,nbounds/2,bounds);CHKERRQ(ierr);
450e9457bf7SBarry Smith   }
451e9457bf7SBarry Smith   ierr = PetscOptionsTail();CHKERRQ(ierr);
452e9457bf7SBarry Smith   PetscFunctionReturn(0);
453e9457bf7SBarry Smith }
454e9457bf7SBarry Smith 
4550076e027SBarry Smith PetscErrorCode PetscViewerView_Draw(PetscViewer viewer,PetscViewer v)
4560076e027SBarry Smith {
4570076e027SBarry Smith   PetscErrorCode   ierr;
4580076e027SBarry Smith   PetscDraw        draw;
4590076e027SBarry Smith   PetscInt         i;
4600076e027SBarry Smith   PetscViewer_Draw *vdraw = (PetscViewer_Draw*)viewer->data;
4610076e027SBarry Smith 
4620076e027SBarry Smith   PetscFunctionBegin;
4630076e027SBarry Smith   /*  If the PetscViewer has just been created then no vdraw->draw yet
4640076e027SBarry Smith       exists so this will not actually call the viewer on any draws. */
4650076e027SBarry Smith   for (i=0; i<vdraw->draw_base; i++) {
4660076e027SBarry Smith     if (vdraw->draw[i]) {
4670076e027SBarry Smith       ierr = PetscViewerDrawGetDraw(viewer,i,&draw);CHKERRQ(ierr);
4680076e027SBarry Smith       ierr = PetscDrawView(draw,v);CHKERRQ(ierr);
4690076e027SBarry Smith     }
4700076e027SBarry Smith   }
4710076e027SBarry Smith   PetscFunctionReturn(0);
4720076e027SBarry Smith }
4730076e027SBarry Smith 
4748556b5ebSBarry Smith /*MC
4758556b5ebSBarry Smith    PETSCVIEWERDRAW - A viewer that generates graphics, either to the screen or a file
4768556b5ebSBarry Smith 
4778556b5ebSBarry Smith 
4788556b5ebSBarry Smith .seealso:  PetscViewerDrawOpen(), PetscViewerDrawGetDraw(), PETSC_VIEWER_DRAW_(),PETSC_VIEWER_DRAW_SELF, PETSC_VIEWER_DRAW_WORLD,
4798556b5ebSBarry Smith            PetscViewerCreate(), PetscViewerASCIIOpen(), PetscViewerBinaryOpen(), PETSCVIEWERBINARY,
4808556b5ebSBarry Smith            PetscViewerMatlabOpen(), VecView(), DMView(), PetscViewerMatlabPutArray(), PETSCVIEWERASCII, PETSCVIEWERMATLAB,
4818556b5ebSBarry Smith            PetscViewerFileSetName(), PetscViewerFileSetMode(), PetscViewerFormat, PetscViewerType, PetscViewerSetType()
4828556b5ebSBarry Smith 
4831b266c99SBarry Smith   Level: beginner
4841b266c99SBarry Smith 
4858556b5ebSBarry Smith M*/
4868cc058d9SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerCreate_Draw(PetscViewer viewer)
4875c6c1daeSBarry Smith {
4885c6c1daeSBarry Smith   PetscErrorCode   ierr;
4895c6c1daeSBarry Smith   PetscViewer_Draw *vdraw;
4905c6c1daeSBarry Smith 
4915c6c1daeSBarry Smith   PetscFunctionBegin;
492b00a9115SJed Brown   ierr = PetscNewLog(viewer,&vdraw);CHKERRQ(ierr);
4935c6c1daeSBarry Smith   viewer->data = (void*)vdraw;
4945c6c1daeSBarry Smith 
4955c6c1daeSBarry Smith   viewer->ops->flush            = PetscViewerFlush_Draw;
4960076e027SBarry Smith   viewer->ops->view             = PetscViewerView_Draw;
4975c6c1daeSBarry Smith   viewer->ops->destroy          = PetscViewerDestroy_Draw;
498e9457bf7SBarry Smith   viewer->ops->setfromoptions   = PetscViewerSetFromOptions_Draw;
499559f443fSBarry Smith   viewer->ops->getsubviewer     = PetscViewerGetSubViewer_Draw;
500559f443fSBarry Smith   viewer->ops->restoresubviewer = PetscViewerRestoreSubViewer_Draw;
5015c6c1daeSBarry Smith 
5025c6c1daeSBarry Smith   /* these are created on the fly if requested */
5035c6c1daeSBarry Smith   vdraw->draw_max  = 5;
5045c6c1daeSBarry Smith   vdraw->draw_base = 0;
505ccad63c3SBarry Smith   vdraw->w         = PETSC_DECIDE;
506ccad63c3SBarry Smith   vdraw->h         = PETSC_DECIDE;
507a297a907SKarl Rupp 
5081795a4d1SJed Brown   ierr = PetscCalloc3(vdraw->draw_max,&vdraw->draw,vdraw->draw_max,&vdraw->drawlg,vdraw->draw_max,&vdraw->drawaxis);CHKERRQ(ierr);
5095c6c1daeSBarry Smith   vdraw->singleton_made = PETSC_FALSE;
5105c6c1daeSBarry Smith   PetscFunctionReturn(0);
5115c6c1daeSBarry Smith }
5125c6c1daeSBarry Smith 
5135c6c1daeSBarry Smith /*@
5145c6c1daeSBarry Smith     PetscViewerDrawClear - Clears a PetscDraw graphic associated with a PetscViewer.
5155c6c1daeSBarry Smith 
5165c6c1daeSBarry Smith     Not Collective
5175c6c1daeSBarry Smith 
5185c6c1daeSBarry Smith     Input Parameter:
5195c6c1daeSBarry Smith .  viewer - the PetscViewer
5205c6c1daeSBarry Smith 
5215c6c1daeSBarry Smith     Level: intermediate
5225c6c1daeSBarry Smith 
5235c6c1daeSBarry Smith .seealso: PetscViewerDrawOpen(), PetscViewerDrawGetDraw(),
5245c6c1daeSBarry Smith 
5255c6c1daeSBarry Smith @*/
5265c6c1daeSBarry Smith PetscErrorCode  PetscViewerDrawClear(PetscViewer viewer)
5275c6c1daeSBarry Smith {
5285c6c1daeSBarry Smith   PetscErrorCode   ierr;
5295c6c1daeSBarry Smith   PetscViewer_Draw *vdraw;
530e5ab1681SLisandro Dalcin   PetscBool        isdraw;
531e5ab1681SLisandro Dalcin   PetscInt         i;
5325c6c1daeSBarry Smith 
5335c6c1daeSBarry Smith   PetscFunctionBegin;
534e5ab1681SLisandro Dalcin   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
5355c6c1daeSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
536e5ab1681SLisandro Dalcin   if (!isdraw) PetscFunctionReturn(0);
5375c6c1daeSBarry Smith   vdraw = (PetscViewer_Draw*)viewer->data;
538e5ab1681SLisandro Dalcin 
5395c6c1daeSBarry Smith   for (i=0; i<vdraw->draw_max; i++) {
5405c6c1daeSBarry Smith     if (vdraw->draw[i]) {ierr = PetscDrawClear(vdraw->draw[i]);CHKERRQ(ierr);}
5415c6c1daeSBarry Smith   }
5425c6c1daeSBarry Smith   PetscFunctionReturn(0);
5435c6c1daeSBarry Smith }
5445c6c1daeSBarry Smith 
5455c6c1daeSBarry Smith /*@
5465c6c1daeSBarry Smith     PetscViewerDrawGetPause - Gets a pause for the first present draw
5475c6c1daeSBarry Smith 
5485c6c1daeSBarry Smith     Not Collective
5495c6c1daeSBarry Smith 
5505c6c1daeSBarry Smith     Input Parameter:
5515c6c1daeSBarry Smith .  viewer - the PetscViewer
5525c6c1daeSBarry Smith 
5535c6c1daeSBarry Smith     Output Parameter:
5545c6c1daeSBarry Smith .  pause - the pause value
5555c6c1daeSBarry Smith 
5565c6c1daeSBarry Smith     Level: intermediate
5575c6c1daeSBarry Smith 
5585c6c1daeSBarry Smith .seealso: PetscViewerDrawOpen(), PetscViewerDrawGetDraw(),
5595c6c1daeSBarry Smith 
5605c6c1daeSBarry Smith @*/
5615c6c1daeSBarry Smith PetscErrorCode  PetscViewerDrawGetPause(PetscViewer viewer,PetscReal *pause)
5625c6c1daeSBarry Smith {
5635c6c1daeSBarry Smith   PetscErrorCode   ierr;
5645c6c1daeSBarry Smith   PetscViewer_Draw *vdraw;
565e5ab1681SLisandro Dalcin   PetscBool        isdraw;
566e5ab1681SLisandro Dalcin   PetscInt         i;
5675c6c1daeSBarry Smith   PetscDraw        draw;
5685c6c1daeSBarry Smith 
5695c6c1daeSBarry Smith   PetscFunctionBegin;
570e5ab1681SLisandro Dalcin   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
5715c6c1daeSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
572e5ab1681SLisandro Dalcin   if (!isdraw) {*pause = 0.0; PetscFunctionReturn(0);}
5735c6c1daeSBarry Smith   vdraw = (PetscViewer_Draw*)viewer->data;
574e5ab1681SLisandro Dalcin 
5755c6c1daeSBarry Smith   for (i=0; i<vdraw->draw_max; i++) {
5765c6c1daeSBarry Smith     if (vdraw->draw[i]) {
5775c6c1daeSBarry Smith       ierr = PetscDrawGetPause(vdraw->draw[i],pause);CHKERRQ(ierr);
5785c6c1daeSBarry Smith       PetscFunctionReturn(0);
5795c6c1daeSBarry Smith     }
5805c6c1daeSBarry Smith   }
5815c6c1daeSBarry Smith   /* none exist yet so create one and get its pause */
5825c6c1daeSBarry Smith   ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
583e5ab1681SLisandro Dalcin   ierr = PetscDrawGetPause(draw,pause);CHKERRQ(ierr);
5845c6c1daeSBarry Smith   PetscFunctionReturn(0);
5855c6c1daeSBarry Smith }
5865c6c1daeSBarry Smith 
5875c6c1daeSBarry Smith /*@
5885c6c1daeSBarry Smith     PetscViewerDrawSetPause - Sets a pause for each PetscDraw in the viewer
5895c6c1daeSBarry Smith 
5905c6c1daeSBarry Smith     Not Collective
5915c6c1daeSBarry Smith 
5925c6c1daeSBarry Smith     Input Parameters:
5935c6c1daeSBarry Smith +  viewer - the PetscViewer
5945c6c1daeSBarry Smith -  pause - the pause value
5955c6c1daeSBarry Smith 
5965c6c1daeSBarry Smith     Level: intermediate
5975c6c1daeSBarry Smith 
5985c6c1daeSBarry Smith .seealso: PetscViewerDrawOpen(), PetscViewerDrawGetDraw(),
5995c6c1daeSBarry Smith 
6005c6c1daeSBarry Smith @*/
6015c6c1daeSBarry Smith PetscErrorCode  PetscViewerDrawSetPause(PetscViewer viewer,PetscReal pause)
6025c6c1daeSBarry Smith {
6035c6c1daeSBarry Smith   PetscErrorCode   ierr;
604e5ab1681SLisandro Dalcin   PetscViewer_Draw *vdraw;
6055c6c1daeSBarry Smith   PetscBool        isdraw;
606e5ab1681SLisandro Dalcin   PetscInt         i;
6075c6c1daeSBarry Smith 
6085c6c1daeSBarry Smith   PetscFunctionBegin;
609e5ab1681SLisandro Dalcin   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
6105c6c1daeSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
611e5ab1681SLisandro Dalcin   if (!isdraw) PetscFunctionReturn(0);
612e5ab1681SLisandro Dalcin   vdraw = (PetscViewer_Draw*)viewer->data;
613afe78b3cSBarry Smith 
614afe78b3cSBarry Smith   vdraw->pause = pause;
6155c6c1daeSBarry Smith   for (i=0; i<vdraw->draw_max; i++) {
6165c6c1daeSBarry Smith     if (vdraw->draw[i]) {ierr = PetscDrawSetPause(vdraw->draw[i],pause);CHKERRQ(ierr);}
6175c6c1daeSBarry Smith   }
6185c6c1daeSBarry Smith   PetscFunctionReturn(0);
6195c6c1daeSBarry Smith }
6205c6c1daeSBarry Smith 
6215c6c1daeSBarry Smith 
6225c6c1daeSBarry Smith /*@
6235c6c1daeSBarry Smith     PetscViewerDrawSetHold - Holds previous image when drawing new image
6245c6c1daeSBarry Smith 
6255c6c1daeSBarry Smith     Not Collective
6265c6c1daeSBarry Smith 
6275c6c1daeSBarry Smith     Input Parameters:
6285c6c1daeSBarry Smith +  viewer - the PetscViewer
6295c6c1daeSBarry Smith -  hold - indicates to hold or not
6305c6c1daeSBarry Smith 
6315c6c1daeSBarry Smith     Level: intermediate
6325c6c1daeSBarry Smith 
6335c6c1daeSBarry Smith .seealso: PetscViewerDrawOpen(), PetscViewerDrawGetDraw(),
6345c6c1daeSBarry Smith 
6355c6c1daeSBarry Smith @*/
6365c6c1daeSBarry Smith PetscErrorCode  PetscViewerDrawSetHold(PetscViewer viewer,PetscBool hold)
6375c6c1daeSBarry Smith {
6385c6c1daeSBarry Smith   PetscErrorCode   ierr;
6395c6c1daeSBarry Smith   PetscViewer_Draw *vdraw;
6405c6c1daeSBarry Smith   PetscBool        isdraw;
6415c6c1daeSBarry Smith 
6425c6c1daeSBarry Smith   PetscFunctionBegin;
643e5ab1681SLisandro Dalcin   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
6445c6c1daeSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
645e5ab1681SLisandro Dalcin   if (!isdraw) PetscFunctionReturn(0);
6465c6c1daeSBarry Smith   vdraw = (PetscViewer_Draw*)viewer->data;
647e5ab1681SLisandro Dalcin 
6485c6c1daeSBarry Smith   vdraw->hold = hold;
6495c6c1daeSBarry Smith   PetscFunctionReturn(0);
6505c6c1daeSBarry Smith }
6515c6c1daeSBarry Smith 
6525c6c1daeSBarry Smith /*@
653d97d059aSBarry Smith     PetscViewerDrawGetHold - Checks if holds previous image when drawing new image
6545c6c1daeSBarry Smith 
6555c6c1daeSBarry Smith     Not Collective
6565c6c1daeSBarry Smith 
6575c6c1daeSBarry Smith     Input Parameter:
6585c6c1daeSBarry Smith .  viewer - the PetscViewer
6595c6c1daeSBarry Smith 
6605c6c1daeSBarry Smith     Output Parameter:
6615c6c1daeSBarry Smith .  hold - indicates to hold or not
6625c6c1daeSBarry Smith 
6635c6c1daeSBarry Smith     Level: intermediate
6645c6c1daeSBarry Smith 
6655c6c1daeSBarry Smith .seealso: PetscViewerDrawOpen(), PetscViewerDrawGetDraw(),
6665c6c1daeSBarry Smith 
6675c6c1daeSBarry Smith @*/
6685c6c1daeSBarry Smith PetscErrorCode  PetscViewerDrawGetHold(PetscViewer viewer,PetscBool *hold)
6695c6c1daeSBarry Smith {
6705c6c1daeSBarry Smith   PetscErrorCode   ierr;
6715c6c1daeSBarry Smith   PetscViewer_Draw *vdraw;
6725c6c1daeSBarry Smith   PetscBool        isdraw;
6735c6c1daeSBarry Smith 
6745c6c1daeSBarry Smith   PetscFunctionBegin;
675e5ab1681SLisandro Dalcin   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
6765c6c1daeSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
677e5ab1681SLisandro Dalcin   if (!isdraw) {*hold = PETSC_FALSE; PetscFunctionReturn(0);}
6785c6c1daeSBarry Smith   vdraw = (PetscViewer_Draw*)viewer->data;
679e5ab1681SLisandro Dalcin 
6805c6c1daeSBarry Smith   *hold = vdraw->hold;
6815c6c1daeSBarry Smith   PetscFunctionReturn(0);
6825c6c1daeSBarry Smith }
6835c6c1daeSBarry Smith 
6845c6c1daeSBarry Smith /* ---------------------------------------------------------------------*/
6855c6c1daeSBarry Smith /*
6865c6c1daeSBarry Smith     The variable Petsc_Viewer_Draw_keyval is used to indicate an MPI attribute that
6875c6c1daeSBarry Smith   is attached to a communicator, in this case the attribute is a PetscViewer.
6885c6c1daeSBarry Smith */
689*d4c7638eSBarry Smith PetscMPIInt Petsc_Viewer_Draw_keyval = MPI_KEYVAL_INVALID;
6905c6c1daeSBarry Smith 
6915c6c1daeSBarry Smith /*@C
6925c6c1daeSBarry Smith     PETSC_VIEWER_DRAW_ - Creates a window PetscViewer shared by all processors
6935c6c1daeSBarry Smith                      in a communicator.
6945c6c1daeSBarry Smith 
6955c6c1daeSBarry Smith      Collective on MPI_Comm
6965c6c1daeSBarry Smith 
6975c6c1daeSBarry Smith      Input Parameter:
6985c6c1daeSBarry Smith .    comm - the MPI communicator to share the window PetscViewer
6995c6c1daeSBarry Smith 
7005c6c1daeSBarry Smith      Level: intermediate
7015c6c1daeSBarry Smith 
7025c6c1daeSBarry Smith      Notes:
7035c6c1daeSBarry Smith      Unlike almost all other PETSc routines, PETSC_VIEWER_DRAW_ does not return
7045c6c1daeSBarry Smith      an error code.  The window is usually used in the form
7055c6c1daeSBarry Smith $       XXXView(XXX object,PETSC_VIEWER_DRAW_(comm));
7065c6c1daeSBarry Smith 
7075c6c1daeSBarry Smith .seealso: PETSC_VIEWER_DRAW_WORLD, PETSC_VIEWER_DRAW_SELF, PetscViewerDrawOpen(),
7085c6c1daeSBarry Smith @*/
7095c6c1daeSBarry Smith PetscViewer  PETSC_VIEWER_DRAW_(MPI_Comm comm)
7105c6c1daeSBarry Smith {
7115c6c1daeSBarry Smith   PetscErrorCode ierr;
7125c6c1daeSBarry Smith   PetscMPIInt    flag;
7135c6c1daeSBarry Smith   PetscViewer    viewer;
7145c6c1daeSBarry Smith   MPI_Comm       ncomm;
7155c6c1daeSBarry Smith 
7165c6c1daeSBarry Smith   PetscFunctionBegin;
717efca3c55SSatish Balay   ierr = PetscCommDuplicate(comm,&ncomm,NULL);if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_DRAW_",__FILE__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");PetscFunctionReturn(0);}
7185c6c1daeSBarry Smith   if (Petsc_Viewer_Draw_keyval == MPI_KEYVAL_INVALID) {
7195c6c1daeSBarry Smith     ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,MPI_NULL_DELETE_FN,&Petsc_Viewer_Draw_keyval,0);
720efca3c55SSatish Balay     if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_DRAW_",__FILE__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");PetscFunctionReturn(0);}
7215c6c1daeSBarry Smith   }
7225c6c1daeSBarry Smith   ierr = MPI_Attr_get(ncomm,Petsc_Viewer_Draw_keyval,(void**)&viewer,&flag);
723efca3c55SSatish Balay   if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_DRAW_",__FILE__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");PetscFunctionReturn(0);}
7245c6c1daeSBarry Smith   if (!flag) { /* PetscViewer not yet created */
7255c6c1daeSBarry Smith     ierr = PetscViewerDrawOpen(ncomm,0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,&viewer);
726efca3c55SSatish Balay     if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_DRAW_",__FILE__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");PetscFunctionReturn(0);}
7275c6c1daeSBarry Smith     ierr = PetscObjectRegisterDestroy((PetscObject)viewer);
728efca3c55SSatish Balay     if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_DRAW_",__FILE__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");PetscFunctionReturn(0);}
7295c6c1daeSBarry Smith     ierr = MPI_Attr_put(ncomm,Petsc_Viewer_Draw_keyval,(void*)viewer);
730efca3c55SSatish Balay     if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_DRAW_",__FILE__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");PetscFunctionReturn(0);}
7315c6c1daeSBarry Smith   }
7325c6c1daeSBarry Smith   ierr = PetscCommDestroy(&ncomm);
733efca3c55SSatish Balay   if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_DRAW_",__FILE__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");PetscFunctionReturn(0);}
7345c6c1daeSBarry Smith   PetscFunctionReturn(viewer);
7355c6c1daeSBarry Smith }
7365c6c1daeSBarry Smith 
7375c6c1daeSBarry Smith /*@
7385c6c1daeSBarry Smith     PetscViewerDrawSetBounds - sets the upper and lower bounds to be used in plotting
7395c6c1daeSBarry Smith 
7405c6c1daeSBarry Smith     Collective on PetscViewer
7415c6c1daeSBarry Smith 
7425c6c1daeSBarry Smith     Input Parameters:
7435c6c1daeSBarry Smith +   viewer - the PetscViewer (created with PetscViewerDrawOpen())
7445c6c1daeSBarry Smith .   nbounds - number of plots that can be made with this viewer, for example the dof passed to DMDACreate()
7455c6c1daeSBarry Smith -   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, .....
7465c6c1daeSBarry Smith 
747e9457bf7SBarry Smith 
748e9457bf7SBarry Smith     Options Database:
749e9457bf7SBarry Smith .   -draw_bounds  minF0,maxF0,minF1,maxF1
750e9457bf7SBarry Smith 
7515c6c1daeSBarry Smith     Level: intermediate
7525c6c1daeSBarry Smith 
753f3f0eb19SBarry Smith     Notes: 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
754f3f0eb19SBarry Smith       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
755f3f0eb19SBarry Smith       this viewer. Otherwise the color to physical value meaning changes with each new image if this is not set.
756f3f0eb19SBarry Smith 
7575c6c1daeSBarry Smith    Concepts: drawing^accessing PetscDraw context from PetscViewer
7585c6c1daeSBarry Smith    Concepts: graphics
7595c6c1daeSBarry Smith 
7605c6c1daeSBarry Smith .seealso: PetscViewerDrawGetLG(), PetscViewerDrawGetAxis(), PetscViewerDrawOpen()
7615c6c1daeSBarry Smith @*/
7625c6c1daeSBarry Smith PetscErrorCode  PetscViewerDrawSetBounds(PetscViewer viewer,PetscInt nbounds,const PetscReal *bounds)
7635c6c1daeSBarry Smith {
764e5ab1681SLisandro Dalcin   PetscViewer_Draw *vdraw;
765e5ab1681SLisandro Dalcin   PetscBool        isdraw;
7665c6c1daeSBarry Smith   PetscErrorCode   ierr;
7675c6c1daeSBarry Smith 
7685c6c1daeSBarry Smith 
7695c6c1daeSBarry Smith   PetscFunctionBegin;
7705c6c1daeSBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
771e5ab1681SLisandro Dalcin   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
772e5ab1681SLisandro Dalcin   if (!isdraw) PetscFunctionReturn(0);
773e5ab1681SLisandro Dalcin   vdraw = (PetscViewer_Draw*)viewer->data;
774a297a907SKarl Rupp 
775e5ab1681SLisandro Dalcin   vdraw->nbounds = nbounds;
776e5ab1681SLisandro Dalcin   ierr = PetscFree(vdraw->bounds);CHKERRQ(ierr);
777785e854fSJed Brown   ierr = PetscMalloc1(2*nbounds,&vdraw->bounds);CHKERRQ(ierr);
7785c6c1daeSBarry Smith   ierr = PetscMemcpy(vdraw->bounds,bounds,2*nbounds*sizeof(PetscReal));CHKERRQ(ierr);
7795c6c1daeSBarry Smith   PetscFunctionReturn(0);
7805c6c1daeSBarry Smith }
7815c6c1daeSBarry Smith 
7825c6c1daeSBarry Smith /*@C
7835c6c1daeSBarry Smith     PetscViewerDrawGetBounds - gets the upper and lower bounds to be used in plotting set with PetscViewerDrawSetBounds()
7845c6c1daeSBarry Smith 
7855c6c1daeSBarry Smith     Collective on PetscViewer
7865c6c1daeSBarry Smith 
7875c6c1daeSBarry Smith     Input Parameter:
7885c6c1daeSBarry Smith .   viewer - the PetscViewer (created with PetscViewerDrawOpen())
7895c6c1daeSBarry Smith 
7905c6c1daeSBarry Smith     Output Paramters:
7915c6c1daeSBarry Smith +   nbounds - number of plots that can be made with this viewer, for example the dof passed to DMDACreate()
7925c6c1daeSBarry Smith -   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, .....
7935c6c1daeSBarry Smith 
7945c6c1daeSBarry Smith     Level: intermediate
7955c6c1daeSBarry Smith 
7965c6c1daeSBarry Smith    Concepts: drawing^accessing PetscDraw context from PetscViewer
7975c6c1daeSBarry Smith    Concepts: graphics
7985c6c1daeSBarry Smith 
799f3f0eb19SBarry Smith .seealso: PetscViewerDrawGetLG(), PetscViewerDrawGetAxis(), PetscViewerDrawOpen(), PetscViewerDrawSetBounds()
8005c6c1daeSBarry Smith @*/
8015c6c1daeSBarry Smith PetscErrorCode  PetscViewerDrawGetBounds(PetscViewer viewer,PetscInt *nbounds,const PetscReal **bounds)
8025c6c1daeSBarry Smith {
803e5ab1681SLisandro Dalcin   PetscViewer_Draw *vdraw;
804e5ab1681SLisandro Dalcin   PetscBool        isdraw;
805e5ab1681SLisandro Dalcin   PetscErrorCode   ierr;
8065c6c1daeSBarry Smith 
8075c6c1daeSBarry Smith   PetscFunctionBegin;
8085c6c1daeSBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
809e5ab1681SLisandro Dalcin   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
810e5ab1681SLisandro Dalcin   if (!isdraw) {if (nbounds) *nbounds = 0; if (bounds) *bounds = NULL; PetscFunctionReturn(0);}
811e5ab1681SLisandro Dalcin   vdraw = (PetscViewer_Draw*)viewer->data;
812e5ab1681SLisandro Dalcin 
813e5ab1681SLisandro Dalcin   if (nbounds) *nbounds = vdraw->nbounds;
814e5ab1681SLisandro Dalcin   if (bounds)  *bounds  = vdraw->bounds;
8155c6c1daeSBarry Smith   PetscFunctionReturn(0);
8165c6c1daeSBarry Smith }
817