xref: /petsc/src/sys/classes/viewer/impls/draw/drawv.c (revision e5ab1681210b093c2ee26b200f61e98eac43a430)
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 
55c6c1daeSBarry Smith #undef __FUNCT__
65c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerDestroy_Draw"
75c6c1daeSBarry Smith PetscErrorCode PetscViewerDestroy_Draw(PetscViewer v)
85c6c1daeSBarry Smith {
95c6c1daeSBarry Smith   PetscErrorCode   ierr;
105c6c1daeSBarry Smith   PetscInt         i;
115c6c1daeSBarry Smith   PetscViewer_Draw *vdraw = (PetscViewer_Draw*)v->data;
125c6c1daeSBarry Smith 
135c6c1daeSBarry Smith   PetscFunctionBegin;
145c6c1daeSBarry Smith   if (vdraw->singleton_made) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"Destroying PetscViewer without first restoring singleton");
155c6c1daeSBarry Smith   for (i=0; i<vdraw->draw_max; i++) {
165c6c1daeSBarry Smith     ierr = PetscDrawAxisDestroy(&vdraw->drawaxis[i]);CHKERRQ(ierr);
175c6c1daeSBarry Smith     ierr = PetscDrawLGDestroy(&vdraw->drawlg[i]);CHKERRQ(ierr);
185c6c1daeSBarry Smith     ierr = PetscDrawDestroy(&vdraw->draw[i]);CHKERRQ(ierr);
195c6c1daeSBarry Smith   }
205c6c1daeSBarry Smith   ierr = PetscFree(vdraw->display);CHKERRQ(ierr);
215c6c1daeSBarry Smith   ierr = PetscFree(vdraw->title);CHKERRQ(ierr);
225c6c1daeSBarry Smith   ierr = PetscFree3(vdraw->draw,vdraw->drawlg,vdraw->drawaxis);CHKERRQ(ierr);
235c6c1daeSBarry Smith   ierr = PetscFree(vdraw->bounds);CHKERRQ(ierr);
24d1da0b69SBarry Smith   ierr = PetscFree(vdraw->drawtype);CHKERRQ(ierr);
25*e5ab1681SLisandro Dalcin   ierr = PetscFree(v->data);CHKERRQ(ierr);
265c6c1daeSBarry Smith   PetscFunctionReturn(0);
275c6c1daeSBarry Smith }
285c6c1daeSBarry Smith 
295c6c1daeSBarry Smith #undef __FUNCT__
305c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerFlush_Draw"
315c6c1daeSBarry Smith PetscErrorCode PetscViewerFlush_Draw(PetscViewer v)
325c6c1daeSBarry Smith {
335c6c1daeSBarry Smith   PetscErrorCode   ierr;
345c6c1daeSBarry Smith   PetscInt         i;
355c6c1daeSBarry Smith   PetscViewer_Draw *vdraw = (PetscViewer_Draw*)v->data;
365c6c1daeSBarry Smith 
375c6c1daeSBarry Smith   PetscFunctionBegin;
385c6c1daeSBarry Smith   for (i=0; i<vdraw->draw_max; i++) {
395b399a63SLisandro Dalcin     if (vdraw->draw[i]) {ierr = PetscDrawFlush(vdraw->draw[i]);CHKERRQ(ierr);}
405c6c1daeSBarry Smith   }
415c6c1daeSBarry Smith   PetscFunctionReturn(0);
425c6c1daeSBarry Smith }
435c6c1daeSBarry Smith 
445c6c1daeSBarry Smith #undef __FUNCT__
455c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerDrawGetDraw"
465c6c1daeSBarry Smith /*@C
475c6c1daeSBarry Smith     PetscViewerDrawGetDraw - Returns PetscDraw object from PetscViewer object.
485c6c1daeSBarry Smith     This PetscDraw object may then be used to perform graphics using
495c6c1daeSBarry Smith     PetscDrawXXX() commands.
505c6c1daeSBarry Smith 
515c6c1daeSBarry Smith     Not collective (but PetscDraw returned will be parallel object if PetscViewer is)
525c6c1daeSBarry Smith 
535c6c1daeSBarry Smith     Input Parameters:
545c6c1daeSBarry Smith +  viewer - the PetscViewer (created with PetscViewerDrawOpen())
555c6c1daeSBarry Smith -   windownumber - indicates which subwindow (usually 0)
565c6c1daeSBarry Smith 
575c6c1daeSBarry Smith     Ouput Parameter:
585c6c1daeSBarry Smith .   draw - the draw object
595c6c1daeSBarry Smith 
605c6c1daeSBarry Smith     Level: intermediate
615c6c1daeSBarry Smith 
625c6c1daeSBarry Smith    Concepts: drawing^accessing PetscDraw context from PetscViewer
635c6c1daeSBarry Smith    Concepts: graphics
645c6c1daeSBarry Smith 
655c6c1daeSBarry Smith .seealso: PetscViewerDrawGetLG(), PetscViewerDrawGetAxis(), PetscViewerDrawOpen()
665c6c1daeSBarry Smith @*/
675c6c1daeSBarry Smith PetscErrorCode  PetscViewerDrawGetDraw(PetscViewer viewer,PetscInt windownumber,PetscDraw *draw)
685c6c1daeSBarry Smith {
69*e5ab1681SLisandro Dalcin   PetscViewer_Draw *vdraw;
705c6c1daeSBarry Smith   PetscErrorCode   ierr;
715c6c1daeSBarry Smith   PetscBool        isdraw;
725c6c1daeSBarry Smith 
735c6c1daeSBarry Smith   PetscFunctionBegin;
745c6c1daeSBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
75*e5ab1681SLisandro Dalcin   PetscValidLogicalCollectiveInt(viewer,windownumber,2);
765c6c1daeSBarry Smith   if (draw) PetscValidPointer(draw,3);
775c6c1daeSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
785c6c1daeSBarry Smith   if (!isdraw) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Must be draw type PetscViewer");
795c6c1daeSBarry Smith   if (windownumber < 0) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Window number cannot be negative");
80*e5ab1681SLisandro Dalcin   vdraw = (PetscViewer_Draw*)viewer->data;
81*e5ab1681SLisandro Dalcin 
825c6c1daeSBarry Smith   windownumber += vdraw->draw_base;
835c6c1daeSBarry Smith   if (windownumber >= vdraw->draw_max) {
845c6c1daeSBarry Smith     /* allocate twice as many slots as needed */
855c6c1daeSBarry Smith     PetscInt      draw_max  = vdraw->draw_max;
865c6c1daeSBarry Smith     PetscDraw     *tdraw    = vdraw->draw;
875c6c1daeSBarry Smith     PetscDrawLG   *drawlg   = vdraw->drawlg;
885c6c1daeSBarry Smith     PetscDrawAxis *drawaxis = vdraw->drawaxis;
895c6c1daeSBarry Smith 
905c6c1daeSBarry Smith     vdraw->draw_max = 2*windownumber;
91a297a907SKarl Rupp 
921795a4d1SJed Brown     ierr = PetscCalloc3(vdraw->draw_max,&vdraw->draw,vdraw->draw_max,&vdraw->drawlg,vdraw->draw_max,&vdraw->drawaxis);CHKERRQ(ierr);
935c6c1daeSBarry Smith 
945c6c1daeSBarry Smith     ierr = PetscMemcpy(vdraw->draw,tdraw,draw_max*sizeof(PetscDraw));CHKERRQ(ierr);
955c6c1daeSBarry Smith     ierr = PetscMemcpy(vdraw->drawlg,drawlg,draw_max*sizeof(PetscDrawLG));CHKERRQ(ierr);
965c6c1daeSBarry Smith     ierr = PetscMemcpy(vdraw->drawaxis,drawaxis,draw_max*sizeof(PetscDrawAxis));CHKERRQ(ierr);
975c6c1daeSBarry Smith 
985c6c1daeSBarry Smith     ierr = PetscFree3(tdraw,drawlg,drawaxis);CHKERRQ(ierr);
995c6c1daeSBarry Smith   }
1005c6c1daeSBarry Smith 
1015c6c1daeSBarry Smith   if (!vdraw->draw[windownumber]) {
102*e5ab1681SLisandro Dalcin     char *title = vdraw->title, tmp_str[128];
10310f3a0f4SLisandro Dalcin     if (windownumber) {
10410f3a0f4SLisandro Dalcin       ierr = PetscSNPrintf(tmp_str,sizeof(tmp_str),"%s:%d",vdraw->title?vdraw->title:"",windownumber);CHKERRQ(ierr);
1055c6c1daeSBarry Smith       title = tmp_str;
1065c6c1daeSBarry Smith     }
107ce94432eSBarry Smith     ierr = PetscDrawCreate(PetscObjectComm((PetscObject)viewer),vdraw->display,title,PETSC_DECIDE,PETSC_DECIDE,vdraw->w,vdraw->h,&vdraw->draw[windownumber]);CHKERRQ(ierr);
108*e5ab1681SLisandro Dalcin     ierr = PetscLogObjectParent((PetscObject)viewer,(PetscObject)vdraw->draw[windownumber]);CHKERRQ(ierr);
109d1da0b69SBarry Smith     if (vdraw->drawtype) {
110d1da0b69SBarry Smith       ierr = PetscDrawSetType(vdraw->draw[windownumber],vdraw->drawtype);CHKERRQ(ierr);
111d1da0b69SBarry Smith     }
112afe78b3cSBarry Smith     ierr = PetscDrawSetPause(vdraw->draw[windownumber],vdraw->pause);CHKERRQ(ierr);
1135c6c1daeSBarry Smith     ierr = PetscDrawSetFromOptions(vdraw->draw[windownumber]);CHKERRQ(ierr);
1145c6c1daeSBarry Smith   }
1155c6c1daeSBarry Smith   if (draw) *draw = vdraw->draw[windownumber];
1165c6c1daeSBarry Smith   if (draw) PetscValidHeaderSpecific(*draw,PETSC_DRAW_CLASSID,-1);
1175c6c1daeSBarry Smith   PetscFunctionReturn(0);
1185c6c1daeSBarry Smith }
1195c6c1daeSBarry Smith 
1205c6c1daeSBarry Smith #undef __FUNCT__
1215c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerDrawBaseAdd"
1225c6c1daeSBarry Smith /*@C
1235c6c1daeSBarry Smith     PetscViewerDrawBaseAdd - add to the base integer that is added to the windownumber passed to PetscViewerDrawGetDraw()
1245c6c1daeSBarry Smith 
1255c6c1daeSBarry Smith     Not collective (but PetscDraw returned will be parallel object if PetscViewer is)
1265c6c1daeSBarry Smith 
1275c6c1daeSBarry Smith     Input Parameters:
1285c6c1daeSBarry Smith +  viewer - the PetscViewer (created with PetscViewerDrawOpen())
1295c6c1daeSBarry Smith -   windownumber - how much to add to the base
1305c6c1daeSBarry Smith 
1315c6c1daeSBarry Smith     Level: developer
1325c6c1daeSBarry Smith 
1335c6c1daeSBarry Smith    Concepts: drawing^accessing PetscDraw context from PetscViewer
1345c6c1daeSBarry Smith    Concepts: graphics
1355c6c1daeSBarry Smith 
1365c6c1daeSBarry Smith .seealso: PetscViewerDrawGetLG(), PetscViewerDrawGetAxis(), PetscViewerDrawOpen(), PetscViewerDrawGetDraw(), PetscViewerDrawBaseSet()
1375c6c1daeSBarry Smith @*/
1385c6c1daeSBarry Smith PetscErrorCode  PetscViewerDrawBaseAdd(PetscViewer viewer,PetscInt windownumber)
1395c6c1daeSBarry Smith {
140*e5ab1681SLisandro Dalcin   PetscViewer_Draw *vdraw;
1415c6c1daeSBarry Smith   PetscErrorCode   ierr;
1425c6c1daeSBarry Smith   PetscBool        isdraw;
1435c6c1daeSBarry Smith 
1445c6c1daeSBarry Smith   PetscFunctionBegin;
1455c6c1daeSBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
146*e5ab1681SLisandro Dalcin   PetscValidLogicalCollectiveInt(viewer,windownumber,2);
1475c6c1daeSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
1485c6c1daeSBarry Smith   if (!isdraw) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Must be draw type PetscViewer");
149*e5ab1681SLisandro Dalcin   vdraw = (PetscViewer_Draw*)viewer->data;
150*e5ab1681SLisandro Dalcin 
1515c6c1daeSBarry 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);
1525c6c1daeSBarry Smith   vdraw->draw_base += windownumber;
1535c6c1daeSBarry Smith   PetscFunctionReturn(0);
1545c6c1daeSBarry Smith }
1555c6c1daeSBarry Smith 
1565c6c1daeSBarry Smith #undef __FUNCT__
1575c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerDrawBaseSet"
1585c6c1daeSBarry Smith /*@C
1595c6c1daeSBarry Smith     PetscViewerDrawBaseSet - sets the base integer that is added to the windownumber passed to PetscViewerDrawGetDraw()
1605c6c1daeSBarry Smith 
1615c6c1daeSBarry Smith     Not collective (but PetscDraw returned will be parallel object if PetscViewer is)
1625c6c1daeSBarry Smith 
1635c6c1daeSBarry Smith     Input Parameters:
1645c6c1daeSBarry Smith +  viewer - the PetscViewer (created with PetscViewerDrawOpen())
1655c6c1daeSBarry Smith -   windownumber - value to set the base
1665c6c1daeSBarry Smith 
1675c6c1daeSBarry Smith     Level: developer
1685c6c1daeSBarry Smith 
1695c6c1daeSBarry Smith    Concepts: drawing^accessing PetscDraw context from PetscViewer
1705c6c1daeSBarry Smith    Concepts: graphics
1715c6c1daeSBarry Smith 
1725c6c1daeSBarry Smith .seealso: PetscViewerDrawGetLG(), PetscViewerDrawGetAxis(), PetscViewerDrawOpen(), PetscViewerDrawGetDraw(), PetscViewerDrawBaseAdd()
1735c6c1daeSBarry Smith @*/
1745c6c1daeSBarry Smith PetscErrorCode  PetscViewerDrawBaseSet(PetscViewer viewer,PetscInt windownumber)
1755c6c1daeSBarry Smith {
176*e5ab1681SLisandro Dalcin   PetscViewer_Draw *vdraw;
1775c6c1daeSBarry Smith   PetscErrorCode   ierr;
1785c6c1daeSBarry Smith   PetscBool        isdraw;
1795c6c1daeSBarry Smith 
1805c6c1daeSBarry Smith   PetscFunctionBegin;
1815c6c1daeSBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
182*e5ab1681SLisandro Dalcin   PetscValidLogicalCollectiveInt(viewer,windownumber,2);
1835c6c1daeSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
1845c6c1daeSBarry Smith   if (!isdraw) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Must be draw type PetscViewer");
185*e5ab1681SLisandro Dalcin   vdraw = (PetscViewer_Draw*)viewer->data;
186*e5ab1681SLisandro Dalcin 
1875c6c1daeSBarry Smith   if (windownumber < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Resulting base %D cannot be negative",windownumber);
1885c6c1daeSBarry Smith   vdraw->draw_base = windownumber;
1895c6c1daeSBarry Smith   PetscFunctionReturn(0);
1905c6c1daeSBarry Smith }
1915c6c1daeSBarry Smith 
1925c6c1daeSBarry Smith #undef __FUNCT__
1935c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerDrawGetDrawLG"
1945c6c1daeSBarry Smith /*@C
1955c6c1daeSBarry Smith     PetscViewerDrawGetDrawLG - Returns PetscDrawLG object from PetscViewer object.
1965c6c1daeSBarry Smith     This PetscDrawLG object may then be used to perform graphics using
1975c6c1daeSBarry Smith     PetscDrawLGXXX() commands.
1985c6c1daeSBarry Smith 
1995c6c1daeSBarry Smith     Not Collective (but PetscDrawLG object will be parallel if PetscViewer is)
2005c6c1daeSBarry Smith 
2015c6c1daeSBarry Smith     Input Parameter:
2025c6c1daeSBarry Smith +   PetscViewer - the PetscViewer (created with PetscViewerDrawOpen())
2035c6c1daeSBarry Smith -   windownumber - indicates which subwindow (usually 0)
2045c6c1daeSBarry Smith 
2055c6c1daeSBarry Smith     Ouput Parameter:
2065c6c1daeSBarry Smith .   draw - the draw line graph object
2075c6c1daeSBarry Smith 
2085c6c1daeSBarry Smith     Level: intermediate
2095c6c1daeSBarry Smith 
2105c6c1daeSBarry Smith   Concepts: line graph^accessing context
2115c6c1daeSBarry Smith 
2125c6c1daeSBarry Smith .seealso: PetscViewerDrawGetDraw(), PetscViewerDrawGetAxis(), PetscViewerDrawOpen()
2135c6c1daeSBarry Smith @*/
2145c6c1daeSBarry Smith PetscErrorCode  PetscViewerDrawGetDrawLG(PetscViewer viewer,PetscInt windownumber,PetscDrawLG *drawlg)
2155c6c1daeSBarry Smith {
2165c6c1daeSBarry Smith   PetscErrorCode   ierr;
2175c6c1daeSBarry Smith   PetscBool        isdraw;
218*e5ab1681SLisandro Dalcin   PetscViewer_Draw *vdraw;
2195c6c1daeSBarry Smith 
2205c6c1daeSBarry Smith   PetscFunctionBegin;
2215c6c1daeSBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
222*e5ab1681SLisandro Dalcin   PetscValidLogicalCollectiveInt(viewer,windownumber,2);
2235c6c1daeSBarry Smith   PetscValidPointer(drawlg,3);
2245c6c1daeSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
2255c6c1daeSBarry Smith   if (!isdraw) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Must be draw type PetscViewer");
2265c6c1daeSBarry Smith   if (windownumber < 0) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Window number cannot be negative");
227*e5ab1681SLisandro Dalcin   vdraw = (PetscViewer_Draw*)viewer->data;
2285c6c1daeSBarry Smith 
2295c6c1daeSBarry Smith   if (windownumber+vdraw->draw_base >= vdraw->draw_max || !vdraw->draw[windownumber+vdraw->draw_base]) {
2300298fd71SBarry Smith     ierr = PetscViewerDrawGetDraw(viewer,windownumber,NULL);CHKERRQ(ierr);
2315c6c1daeSBarry Smith   }
2325c6c1daeSBarry Smith   if (!vdraw->drawlg[windownumber+vdraw->draw_base]) {
2335c6c1daeSBarry Smith     ierr = PetscDrawLGCreate(vdraw->draw[windownumber+vdraw->draw_base],1,&vdraw->drawlg[windownumber+vdraw->draw_base]);CHKERRQ(ierr);
2343bb1ff40SBarry Smith     ierr = PetscLogObjectParent((PetscObject)viewer,(PetscObject)vdraw->drawlg[windownumber+vdraw->draw_base]);CHKERRQ(ierr);
2355c6c1daeSBarry Smith   }
2365c6c1daeSBarry Smith   *drawlg = vdraw->drawlg[windownumber+vdraw->draw_base];
2375c6c1daeSBarry Smith   PetscFunctionReturn(0);
2385c6c1daeSBarry Smith }
2395c6c1daeSBarry Smith 
2405c6c1daeSBarry Smith #undef __FUNCT__
2415c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerDrawGetDrawAxis"
2425c6c1daeSBarry Smith /*@C
2435c6c1daeSBarry Smith     PetscViewerDrawGetDrawAxis - Returns PetscDrawAxis object from PetscViewer object.
2445c6c1daeSBarry Smith     This PetscDrawAxis object may then be used to perform graphics using
2455c6c1daeSBarry Smith     PetscDrawAxisXXX() commands.
2465c6c1daeSBarry Smith 
2475c6c1daeSBarry Smith     Not Collective (but PetscDrawAxis object will be parallel if PetscViewer is)
2485c6c1daeSBarry Smith 
2495c6c1daeSBarry Smith     Input Parameter:
2505c6c1daeSBarry Smith +   viewer - the PetscViewer (created with PetscViewerDrawOpen()
2515c6c1daeSBarry Smith -   windownumber - indicates which subwindow (usually 0)
2525c6c1daeSBarry Smith 
2535c6c1daeSBarry Smith     Ouput Parameter:
2545c6c1daeSBarry Smith .   drawaxis - the draw axis object
2555c6c1daeSBarry Smith 
2565c6c1daeSBarry Smith     Level: advanced
2575c6c1daeSBarry Smith 
2585c6c1daeSBarry Smith   Concepts: line graph^accessing context
2595c6c1daeSBarry Smith 
2605c6c1daeSBarry Smith .seealso: PetscViewerDrawGetDraw(), PetscViewerDrawGetLG(), PetscViewerDrawOpen()
2615c6c1daeSBarry Smith @*/
2625c6c1daeSBarry Smith PetscErrorCode  PetscViewerDrawGetDrawAxis(PetscViewer viewer,PetscInt windownumber,PetscDrawAxis *drawaxis)
2635c6c1daeSBarry Smith {
2645c6c1daeSBarry Smith   PetscErrorCode   ierr;
2655c6c1daeSBarry Smith   PetscBool        isdraw;
266*e5ab1681SLisandro Dalcin   PetscViewer_Draw *vdraw;
2675c6c1daeSBarry Smith 
2685c6c1daeSBarry Smith   PetscFunctionBegin;
2695c6c1daeSBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
270*e5ab1681SLisandro Dalcin   PetscValidLogicalCollectiveInt(viewer,windownumber,2);
2715c6c1daeSBarry Smith   PetscValidPointer(drawaxis,3);
2725c6c1daeSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
2735c6c1daeSBarry Smith   if (!isdraw) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Must be draw type PetscViewer");
2745c6c1daeSBarry Smith   if (windownumber < 0) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Window number cannot be negative");
275*e5ab1681SLisandro Dalcin   vdraw = (PetscViewer_Draw*)viewer->data;
2765c6c1daeSBarry Smith 
2775c6c1daeSBarry Smith   if (windownumber+vdraw->draw_base >= vdraw->draw_max || !vdraw->draw[windownumber+vdraw->draw_base]) {
2780298fd71SBarry Smith     ierr = PetscViewerDrawGetDraw(viewer,windownumber,NULL);CHKERRQ(ierr);
2795c6c1daeSBarry Smith   }
2805c6c1daeSBarry Smith   if (!vdraw->drawaxis[windownumber+vdraw->draw_base]) {
2815c6c1daeSBarry Smith     ierr = PetscDrawAxisCreate(vdraw->draw[windownumber+vdraw->draw_base],&vdraw->drawaxis[windownumber+vdraw->draw_base]);CHKERRQ(ierr);
2823bb1ff40SBarry Smith     ierr = PetscLogObjectParent((PetscObject)viewer,(PetscObject)vdraw->drawaxis[windownumber+vdraw->draw_base]);CHKERRQ(ierr);
2835c6c1daeSBarry Smith   }
2845c6c1daeSBarry Smith   *drawaxis = vdraw->drawaxis[windownumber+vdraw->draw_base];
2855c6c1daeSBarry Smith   PetscFunctionReturn(0);
2865c6c1daeSBarry Smith }
2875c6c1daeSBarry Smith 
2885c6c1daeSBarry Smith #undef __FUNCT__
2895c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerDrawResize"
2905c6c1daeSBarry Smith PetscErrorCode  PetscViewerDrawResize(PetscViewer v,int w,int h)
2915c6c1daeSBarry Smith {
292*e5ab1681SLisandro Dalcin   PetscErrorCode   ierr;
293*e5ab1681SLisandro Dalcin   PetscViewer_Draw *vdraw;
294*e5ab1681SLisandro Dalcin   PetscBool        isdraw;
2955c6c1daeSBarry Smith 
2965c6c1daeSBarry Smith   PetscFunctionBegin;
297*e5ab1681SLisandro Dalcin   PetscValidHeaderSpecific(v,PETSC_VIEWER_CLASSID,1);
298*e5ab1681SLisandro Dalcin   ierr = PetscObjectTypeCompare((PetscObject)v,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
299*e5ab1681SLisandro Dalcin   if (!isdraw) PetscFunctionReturn(0);
300*e5ab1681SLisandro Dalcin   vdraw = (PetscViewer_Draw*)v->data;
301*e5ab1681SLisandro Dalcin 
302*e5ab1681SLisandro Dalcin   if (w >= 1) vdraw->w = w;
303*e5ab1681SLisandro Dalcin   if (h >= 1) vdraw->h = h;
3045c6c1daeSBarry Smith   PetscFunctionReturn(0);
3055c6c1daeSBarry Smith }
3065c6c1daeSBarry Smith 
3075c6c1daeSBarry Smith #undef __FUNCT__
3085c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerDrawSetInfo"
3095c6c1daeSBarry Smith PetscErrorCode  PetscViewerDrawSetInfo(PetscViewer v,const char display[],const char title[],int x,int y,int w,int h)
3105c6c1daeSBarry Smith {
3115c6c1daeSBarry Smith   PetscErrorCode   ierr;
312*e5ab1681SLisandro Dalcin   PetscViewer_Draw *vdraw;
313*e5ab1681SLisandro Dalcin   PetscBool        isdraw;
3145c6c1daeSBarry Smith 
3155c6c1daeSBarry Smith   PetscFunctionBegin;
316*e5ab1681SLisandro Dalcin   PetscValidHeaderSpecific(v,PETSC_VIEWER_CLASSID,1);
317*e5ab1681SLisandro Dalcin   ierr = PetscObjectTypeCompare((PetscObject)v,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
318*e5ab1681SLisandro Dalcin   if (!isdraw) PetscFunctionReturn(0);
319*e5ab1681SLisandro Dalcin   vdraw = (PetscViewer_Draw*)v->data;
320*e5ab1681SLisandro Dalcin 
3215c6c1daeSBarry Smith   ierr = PetscStrallocpy(display,&vdraw->display);CHKERRQ(ierr);
3225c6c1daeSBarry Smith   ierr = PetscStrallocpy(title,&vdraw->title);CHKERRQ(ierr);
323*e5ab1681SLisandro Dalcin   if (w >= 1) vdraw->w = w;
324*e5ab1681SLisandro Dalcin   if (h >= 1) vdraw->h = h;
3255c6c1daeSBarry Smith   PetscFunctionReturn(0);
3265c6c1daeSBarry Smith }
3275c6c1daeSBarry Smith 
3285c6c1daeSBarry Smith #undef __FUNCT__
329d1da0b69SBarry Smith #define __FUNCT__ "PetscViewerDrawSetDrawType"
330d1da0b69SBarry Smith PetscErrorCode  PetscViewerDrawSetDrawType(PetscViewer v,PetscDrawType drawtype)
331d1da0b69SBarry Smith {
332d1da0b69SBarry Smith   PetscErrorCode   ierr;
333*e5ab1681SLisandro Dalcin   PetscViewer_Draw *vdraw;
334*e5ab1681SLisandro Dalcin   PetscBool        isdraw;
335d1da0b69SBarry Smith 
336d1da0b69SBarry Smith   PetscFunctionBegin;
337*e5ab1681SLisandro Dalcin   PetscValidHeaderSpecific(v,PETSC_VIEWER_CLASSID,1);
338*e5ab1681SLisandro Dalcin   ierr = PetscObjectTypeCompare((PetscObject)v,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
339*e5ab1681SLisandro Dalcin   if (!isdraw) PetscFunctionReturn(0);
340*e5ab1681SLisandro Dalcin   vdraw = (PetscViewer_Draw*)v->data;
341*e5ab1681SLisandro Dalcin 
342d1da0b69SBarry Smith   ierr = PetscFree(vdraw->drawtype);CHKERRQ(ierr);
343d1da0b69SBarry Smith   ierr = PetscStrallocpy(drawtype,(char**)&vdraw->drawtype);CHKERRQ(ierr);
344d1da0b69SBarry Smith   PetscFunctionReturn(0);
345d1da0b69SBarry Smith }
346d1da0b69SBarry Smith 
347d1da0b69SBarry Smith #undef __FUNCT__
3485c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerDrawOpen"
3495c6c1daeSBarry Smith /*@C
3505c6c1daeSBarry Smith    PetscViewerDrawOpen - Opens a window for use as a PetscViewer. If you want to
3515c6c1daeSBarry Smith    do graphics in this window, you must call PetscViewerDrawGetDraw() and
3525c6c1daeSBarry Smith    perform the graphics on the PetscDraw object.
3535c6c1daeSBarry Smith 
3545c6c1daeSBarry Smith    Collective on MPI_Comm
3555c6c1daeSBarry Smith 
3565c6c1daeSBarry Smith    Input Parameters:
3575c6c1daeSBarry Smith +  comm - communicator that will share window
3585c6c1daeSBarry Smith .  display - the X display on which to open, or null for the local machine
3595c6c1daeSBarry Smith .  title - the title to put in the title bar, or null for no title
3605c6c1daeSBarry Smith .  x, y - the screen coordinates of the upper left corner of window, or use PETSC_DECIDE
3615c6c1daeSBarry Smith -  w, h - window width and height in pixels, or may use PETSC_DECIDE or PETSC_DRAW_FULL_SIZE, PETSC_DRAW_HALF_SIZE,
3625c6c1daeSBarry Smith           PETSC_DRAW_THIRD_SIZE, PETSC_DRAW_QUARTER_SIZE
3635c6c1daeSBarry Smith 
3645c6c1daeSBarry Smith    Output Parameters:
3655c6c1daeSBarry Smith . viewer - the PetscViewer
3665c6c1daeSBarry Smith 
3675c6c1daeSBarry Smith    Format Options:
3685c6c1daeSBarry Smith +  PETSC_VIEWER_DRAW_BASIC - displays with basic format
3695c6c1daeSBarry Smith -  PETSC_VIEWER_DRAW_LG    - displays using a line graph
3705c6c1daeSBarry Smith 
3715c6c1daeSBarry Smith    Options Database Keys:
3725c6c1daeSBarry Smith    PetscViewerDrawOpen() calls PetscDrawCreate(), so see the manual page for
3735c6c1daeSBarry Smith    PetscDrawCreate() for runtime options, including
3745c6c1daeSBarry Smith +  -draw_type x or null
3755c6c1daeSBarry Smith .  -nox - Disables all x-windows output
3765c6c1daeSBarry Smith .  -display <name> - Specifies name of machine for the X display
3775c6c1daeSBarry Smith .  -geometry <x,y,w,h> - allows setting the window location and size
3785c6c1daeSBarry Smith -  -draw_pause <pause> - Sets time (in seconds) that the
3795c6c1daeSBarry Smith      program pauses after PetscDrawPause() has been called
3805c6c1daeSBarry Smith      (0 is default, -1 implies until user input).
3815c6c1daeSBarry Smith 
3825c6c1daeSBarry Smith    Level: beginner
3835c6c1daeSBarry Smith 
3845c6c1daeSBarry Smith    Note for Fortran Programmers:
3855c6c1daeSBarry Smith    Whenever indicating null character data in a Fortran code,
3860298fd71SBarry Smith    NULL_CHARACTER must be employed; using NULL is not
3870298fd71SBarry Smith    correct for character data!  Thus, NULL_CHARACTER can be
3885c6c1daeSBarry Smith    used for the display and title input parameters.
3895c6c1daeSBarry Smith 
3905c6c1daeSBarry Smith   Concepts: graphics^opening PetscViewer
3915c6c1daeSBarry Smith   Concepts: drawing^opening PetscViewer
3925c6c1daeSBarry Smith 
3935c6c1daeSBarry Smith 
3945c6c1daeSBarry Smith .seealso: PetscDrawCreate(), PetscViewerDestroy(), PetscViewerDrawGetDraw(), PetscViewerCreate(), PETSC_VIEWER_DRAW_,
3955c6c1daeSBarry Smith           PETSC_VIEWER_DRAW_WORLD, PETSC_VIEWER_DRAW_SELF
3965c6c1daeSBarry Smith @*/
3975c6c1daeSBarry Smith PetscErrorCode  PetscViewerDrawOpen(MPI_Comm comm,const char display[],const char title[],int x,int y,int w,int h,PetscViewer *viewer)
3985c6c1daeSBarry Smith {
3995c6c1daeSBarry Smith   PetscErrorCode ierr;
4005c6c1daeSBarry Smith 
4015c6c1daeSBarry Smith   PetscFunctionBegin;
4025c6c1daeSBarry Smith   ierr = PetscViewerCreate(comm,viewer);CHKERRQ(ierr);
4035c6c1daeSBarry Smith   ierr = PetscViewerSetType(*viewer,PETSCVIEWERDRAW);CHKERRQ(ierr);
4045c6c1daeSBarry Smith   ierr = PetscViewerDrawSetInfo(*viewer,display,title,x,y,w,h);CHKERRQ(ierr);
4055c6c1daeSBarry Smith   PetscFunctionReturn(0);
4065c6c1daeSBarry Smith }
4075c6c1daeSBarry Smith 
4085c6c1daeSBarry Smith #undef __FUNCT__
4093f08860eSBarry Smith #define __FUNCT__ "PetscViewerGetSubViewer_Draw"
4103f08860eSBarry Smith PetscErrorCode PetscViewerGetSubViewer_Draw(PetscViewer viewer,MPI_Comm comm,PetscViewer *sviewer)
4115c6c1daeSBarry Smith {
4125c6c1daeSBarry Smith   PetscErrorCode   ierr;
4135c6c1daeSBarry Smith   PetscMPIInt      rank;
4145c6c1daeSBarry Smith   PetscInt         i;
4155c6c1daeSBarry Smith   PetscViewer_Draw *vdraw = (PetscViewer_Draw*)viewer->data,*vsdraw;
4165c6c1daeSBarry Smith 
4175c6c1daeSBarry Smith   PetscFunctionBegin;
4183f08860eSBarry Smith   if (vdraw->singleton_made) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"Trying to get SubViewer without first restoring previous");
4195c6c1daeSBarry Smith   /* only processor zero can use the PetscViewer draw singleton */
420*e5ab1681SLisandro Dalcin   *sviewer = NULL;
421ce94432eSBarry Smith   ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)viewer),&rank);CHKERRQ(ierr);
4225c6c1daeSBarry Smith   if (!rank) {
4235c6c1daeSBarry Smith     ierr   = PetscViewerCreate(PETSC_COMM_SELF,sviewer);CHKERRQ(ierr);
4245c6c1daeSBarry Smith     ierr   = PetscViewerSetType(*sviewer,PETSCVIEWERDRAW);CHKERRQ(ierr);
4255c6c1daeSBarry Smith     vsdraw = (PetscViewer_Draw*)(*sviewer)->data;
4265c6c1daeSBarry Smith     for (i=0; i<vdraw->draw_max; i++) {
4275c6c1daeSBarry Smith       if (vdraw->draw[i]) {
4285c6c1daeSBarry Smith         ierr = PetscDrawGetSingleton(vdraw->draw[i],&vsdraw->draw[i]);CHKERRQ(ierr);
4295c6c1daeSBarry Smith       }
4305c6c1daeSBarry Smith     }
4315c6c1daeSBarry Smith   }
4325c6c1daeSBarry Smith   vdraw->singleton_made = PETSC_TRUE;
4335c6c1daeSBarry Smith   PetscFunctionReturn(0);
4345c6c1daeSBarry Smith }
4355c6c1daeSBarry Smith 
4365c6c1daeSBarry Smith #undef __FUNCT__
4373f08860eSBarry Smith #define __FUNCT__ "PetscViewerRestoreSubViewer_Draw"
4383f08860eSBarry Smith PetscErrorCode PetscViewerRestoreSubViewer_Draw(PetscViewer viewer,MPI_Comm comm,PetscViewer *sviewer)
4395c6c1daeSBarry Smith {
4405c6c1daeSBarry Smith   PetscErrorCode   ierr;
4415c6c1daeSBarry Smith   PetscMPIInt      rank;
4425c6c1daeSBarry Smith   PetscInt         i;
4435c6c1daeSBarry Smith   PetscViewer_Draw *vdraw = (PetscViewer_Draw*)viewer->data,*vsdraw;
4445c6c1daeSBarry Smith 
4455c6c1daeSBarry Smith   PetscFunctionBegin;
4465c6c1daeSBarry Smith   if (!vdraw->singleton_made) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"Trying to restore a singleton that was not gotten");
447ce94432eSBarry Smith   ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)viewer),&rank);CHKERRQ(ierr);
4485c6c1daeSBarry Smith   if (!rank) {
4495c6c1daeSBarry Smith     vsdraw = (PetscViewer_Draw*)(*sviewer)->data;
4505c6c1daeSBarry Smith     for (i=0; i<vdraw->draw_max; i++) {
4515c6c1daeSBarry Smith       if (vdraw->draw[i] && vsdraw->draw[i]) {
4525c6c1daeSBarry Smith         ierr = PetscDrawRestoreSingleton(vdraw->draw[i],&vsdraw->draw[i]);CHKERRQ(ierr);
4535c6c1daeSBarry Smith       }
4545c6c1daeSBarry Smith     }
4555c6c1daeSBarry Smith     ierr = PetscFree3(vsdraw->draw,vsdraw->drawlg,vsdraw->drawaxis);CHKERRQ(ierr);
4565c6c1daeSBarry Smith     ierr = PetscFree((*sviewer)->data);CHKERRQ(ierr);
4575c6c1daeSBarry Smith     ierr = PetscHeaderDestroy(sviewer);CHKERRQ(ierr);
4585c6c1daeSBarry Smith   }
4595c6c1daeSBarry Smith   vdraw->singleton_made = PETSC_FALSE;
4605c6c1daeSBarry Smith   PetscFunctionReturn(0);
4615c6c1daeSBarry Smith }
4625c6c1daeSBarry Smith 
463e9457bf7SBarry Smith #undef __FUNCT__
464e9457bf7SBarry Smith #define __FUNCT__ "PetscViewerSetFromOptions_Draw"
4654416b707SBarry Smith PetscErrorCode PetscViewerSetFromOptions_Draw(PetscOptionItems *PetscOptionsObject,PetscViewer v)
466e9457bf7SBarry Smith {
467e9457bf7SBarry Smith   PetscErrorCode ierr;
468e9457bf7SBarry Smith   PetscReal      bounds[16];
469e9457bf7SBarry Smith   PetscInt       nbounds = 16;
470e9457bf7SBarry Smith   PetscBool      flg;
471e9457bf7SBarry Smith 
472e9457bf7SBarry Smith   PetscFunctionBegin;
473e55864a3SBarry Smith   ierr = PetscOptionsHead(PetscOptionsObject,"Draw PetscViewer Options");CHKERRQ(ierr);
474e9457bf7SBarry Smith   ierr = PetscOptionsRealArray("-draw_bounds","Bounds to put on plots axis","PetscViewerDrawSetBounds",bounds,&nbounds,&flg);CHKERRQ(ierr);
475e9457bf7SBarry Smith   if (flg) {
476e9457bf7SBarry Smith     ierr = PetscViewerDrawSetBounds(v,nbounds/2,bounds);CHKERRQ(ierr);
477e9457bf7SBarry Smith   }
478e9457bf7SBarry Smith   ierr = PetscOptionsTail();CHKERRQ(ierr);
479e9457bf7SBarry Smith   PetscFunctionReturn(0);
480e9457bf7SBarry Smith }
481e9457bf7SBarry Smith 
4825c6c1daeSBarry Smith #undef __FUNCT__
4830076e027SBarry Smith #define __FUNCT__ "PetscViewerView_Draw"
4840076e027SBarry Smith PetscErrorCode PetscViewerView_Draw(PetscViewer viewer,PetscViewer v)
4850076e027SBarry Smith {
4860076e027SBarry Smith   PetscErrorCode   ierr;
4870076e027SBarry Smith   PetscDraw        draw;
4880076e027SBarry Smith   PetscInt         i;
4890076e027SBarry Smith   PetscViewer_Draw *vdraw = (PetscViewer_Draw*)viewer->data;
4900076e027SBarry Smith 
4910076e027SBarry Smith   PetscFunctionBegin;
4920076e027SBarry Smith   /*  If the PetscViewer has just been created then no vdraw->draw yet
4930076e027SBarry Smith       exists so this will not actually call the viewer on any draws. */
4940076e027SBarry Smith   for (i=0; i<vdraw->draw_base; i++) {
4950076e027SBarry Smith     if (vdraw->draw[i]) {
4960076e027SBarry Smith       ierr = PetscViewerDrawGetDraw(viewer,i,&draw);CHKERRQ(ierr);
4970076e027SBarry Smith       ierr = PetscDrawView(draw,v);CHKERRQ(ierr);
4980076e027SBarry Smith     }
4990076e027SBarry Smith   }
5000076e027SBarry Smith   PetscFunctionReturn(0);
5010076e027SBarry Smith }
5020076e027SBarry Smith 
5030076e027SBarry Smith #undef __FUNCT__
5045c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerCreate_Draw"
5058cc058d9SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerCreate_Draw(PetscViewer viewer)
5065c6c1daeSBarry Smith {
5075c6c1daeSBarry Smith   PetscErrorCode   ierr;
5085c6c1daeSBarry Smith   PetscViewer_Draw *vdraw;
5095c6c1daeSBarry Smith 
5105c6c1daeSBarry Smith   PetscFunctionBegin;
511b00a9115SJed Brown   ierr = PetscNewLog(viewer,&vdraw);CHKERRQ(ierr);
5125c6c1daeSBarry Smith   viewer->data = (void*)vdraw;
5135c6c1daeSBarry Smith 
5145c6c1daeSBarry Smith   viewer->ops->flush            = PetscViewerFlush_Draw;
5150076e027SBarry Smith   viewer->ops->view             = PetscViewerView_Draw;
5165c6c1daeSBarry Smith   viewer->ops->destroy          = PetscViewerDestroy_Draw;
517e9457bf7SBarry Smith   viewer->ops->setfromoptions   = PetscViewerSetFromOptions_Draw;
518559f443fSBarry Smith   viewer->ops->getsubviewer     = PetscViewerGetSubViewer_Draw;
519559f443fSBarry Smith   viewer->ops->restoresubviewer = PetscViewerRestoreSubViewer_Draw;
5205c6c1daeSBarry Smith 
5215c6c1daeSBarry Smith   /* these are created on the fly if requested */
5225c6c1daeSBarry Smith   vdraw->draw_max  = 5;
5235c6c1daeSBarry Smith   vdraw->draw_base = 0;
524ccad63c3SBarry Smith   vdraw->w         = PETSC_DECIDE;
525ccad63c3SBarry Smith   vdraw->h         = PETSC_DECIDE;
526a297a907SKarl Rupp 
5271795a4d1SJed Brown   ierr = PetscCalloc3(vdraw->draw_max,&vdraw->draw,vdraw->draw_max,&vdraw->drawlg,vdraw->draw_max,&vdraw->drawaxis);CHKERRQ(ierr);
5285c6c1daeSBarry Smith   vdraw->singleton_made = PETSC_FALSE;
5295c6c1daeSBarry Smith   PetscFunctionReturn(0);
5305c6c1daeSBarry Smith }
5315c6c1daeSBarry Smith 
5325c6c1daeSBarry Smith #undef __FUNCT__
5335c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerDrawClear"
5345c6c1daeSBarry Smith /*@
5355c6c1daeSBarry Smith     PetscViewerDrawClear - Clears a PetscDraw graphic associated with a PetscViewer.
5365c6c1daeSBarry Smith 
5375c6c1daeSBarry Smith     Not Collective
5385c6c1daeSBarry Smith 
5395c6c1daeSBarry Smith     Input Parameter:
5405c6c1daeSBarry Smith .  viewer - the PetscViewer
5415c6c1daeSBarry Smith 
5425c6c1daeSBarry Smith     Level: intermediate
5435c6c1daeSBarry Smith 
5445c6c1daeSBarry Smith .seealso: PetscViewerDrawOpen(), PetscViewerDrawGetDraw(),
5455c6c1daeSBarry Smith 
5465c6c1daeSBarry Smith @*/
5475c6c1daeSBarry Smith PetscErrorCode  PetscViewerDrawClear(PetscViewer viewer)
5485c6c1daeSBarry Smith {
5495c6c1daeSBarry Smith   PetscErrorCode   ierr;
5505c6c1daeSBarry Smith   PetscViewer_Draw *vdraw;
551*e5ab1681SLisandro Dalcin   PetscBool        isdraw;
552*e5ab1681SLisandro Dalcin   PetscInt         i;
5535c6c1daeSBarry Smith 
5545c6c1daeSBarry Smith   PetscFunctionBegin;
555*e5ab1681SLisandro Dalcin   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
5565c6c1daeSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
557*e5ab1681SLisandro Dalcin   if (!isdraw) PetscFunctionReturn(0);
5585c6c1daeSBarry Smith   vdraw = (PetscViewer_Draw*)viewer->data;
559*e5ab1681SLisandro Dalcin 
5605c6c1daeSBarry Smith   for (i=0; i<vdraw->draw_max; i++) {
5615c6c1daeSBarry Smith     if (vdraw->draw[i]) {ierr = PetscDrawClear(vdraw->draw[i]);CHKERRQ(ierr);}
5625c6c1daeSBarry Smith   }
5635c6c1daeSBarry Smith   PetscFunctionReturn(0);
5645c6c1daeSBarry Smith }
5655c6c1daeSBarry Smith 
5665c6c1daeSBarry Smith #undef __FUNCT__
5675c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerDrawGetPause"
5685c6c1daeSBarry Smith /*@
5695c6c1daeSBarry Smith     PetscViewerDrawGetPause - Gets a pause for the first present draw
5705c6c1daeSBarry Smith 
5715c6c1daeSBarry Smith     Not Collective
5725c6c1daeSBarry Smith 
5735c6c1daeSBarry Smith     Input Parameter:
5745c6c1daeSBarry Smith .  viewer - the PetscViewer
5755c6c1daeSBarry Smith 
5765c6c1daeSBarry Smith     Output Parameter:
5775c6c1daeSBarry Smith .  pause - the pause value
5785c6c1daeSBarry Smith 
5795c6c1daeSBarry Smith     Level: intermediate
5805c6c1daeSBarry Smith 
5815c6c1daeSBarry Smith .seealso: PetscViewerDrawOpen(), PetscViewerDrawGetDraw(),
5825c6c1daeSBarry Smith 
5835c6c1daeSBarry Smith @*/
5845c6c1daeSBarry Smith PetscErrorCode  PetscViewerDrawGetPause(PetscViewer viewer,PetscReal *pause)
5855c6c1daeSBarry Smith {
5865c6c1daeSBarry Smith   PetscErrorCode   ierr;
5875c6c1daeSBarry Smith   PetscViewer_Draw *vdraw;
588*e5ab1681SLisandro Dalcin   PetscBool        isdraw;
589*e5ab1681SLisandro Dalcin   PetscInt         i;
5905c6c1daeSBarry Smith   PetscDraw        draw;
5915c6c1daeSBarry Smith 
5925c6c1daeSBarry Smith   PetscFunctionBegin;
593*e5ab1681SLisandro Dalcin   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
5945c6c1daeSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
595*e5ab1681SLisandro Dalcin   if (!isdraw) {*pause = 0.0; PetscFunctionReturn(0);}
5965c6c1daeSBarry Smith   vdraw = (PetscViewer_Draw*)viewer->data;
597*e5ab1681SLisandro Dalcin 
5985c6c1daeSBarry Smith   for (i=0; i<vdraw->draw_max; i++) {
5995c6c1daeSBarry Smith     if (vdraw->draw[i]) {
6005c6c1daeSBarry Smith       ierr = PetscDrawGetPause(vdraw->draw[i],pause);CHKERRQ(ierr);
6015c6c1daeSBarry Smith       PetscFunctionReturn(0);
6025c6c1daeSBarry Smith     }
6035c6c1daeSBarry Smith   }
6045c6c1daeSBarry Smith   /* none exist yet so create one and get its pause */
6055c6c1daeSBarry Smith   ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
606*e5ab1681SLisandro Dalcin   ierr = PetscDrawGetPause(draw,pause);CHKERRQ(ierr);
6075c6c1daeSBarry Smith   PetscFunctionReturn(0);
6085c6c1daeSBarry Smith }
6095c6c1daeSBarry Smith 
6105c6c1daeSBarry Smith #undef __FUNCT__
6115c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerDrawSetPause"
6125c6c1daeSBarry Smith /*@
6135c6c1daeSBarry Smith     PetscViewerDrawSetPause - Sets a pause for each PetscDraw in the viewer
6145c6c1daeSBarry Smith 
6155c6c1daeSBarry Smith     Not Collective
6165c6c1daeSBarry Smith 
6175c6c1daeSBarry Smith     Input Parameters:
6185c6c1daeSBarry Smith +  viewer - the PetscViewer
6195c6c1daeSBarry Smith -  pause - the pause value
6205c6c1daeSBarry Smith 
6215c6c1daeSBarry Smith     Level: intermediate
6225c6c1daeSBarry Smith 
6235c6c1daeSBarry Smith .seealso: PetscViewerDrawOpen(), PetscViewerDrawGetDraw(),
6245c6c1daeSBarry Smith 
6255c6c1daeSBarry Smith @*/
6265c6c1daeSBarry Smith PetscErrorCode  PetscViewerDrawSetPause(PetscViewer viewer,PetscReal pause)
6275c6c1daeSBarry Smith {
6285c6c1daeSBarry Smith   PetscErrorCode   ierr;
629*e5ab1681SLisandro Dalcin   PetscViewer_Draw *vdraw;
6305c6c1daeSBarry Smith   PetscBool        isdraw;
631*e5ab1681SLisandro Dalcin   PetscInt         i;
6325c6c1daeSBarry Smith 
6335c6c1daeSBarry Smith   PetscFunctionBegin;
634*e5ab1681SLisandro Dalcin   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
6355c6c1daeSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
636*e5ab1681SLisandro Dalcin   if (!isdraw) PetscFunctionReturn(0);
637*e5ab1681SLisandro Dalcin   vdraw = (PetscViewer_Draw*)viewer->data;
638afe78b3cSBarry Smith 
639afe78b3cSBarry Smith   vdraw->pause = pause;
6405c6c1daeSBarry Smith   for (i=0; i<vdraw->draw_max; i++) {
6415c6c1daeSBarry Smith     if (vdraw->draw[i]) {ierr = PetscDrawSetPause(vdraw->draw[i],pause);CHKERRQ(ierr);}
6425c6c1daeSBarry Smith   }
6435c6c1daeSBarry Smith   PetscFunctionReturn(0);
6445c6c1daeSBarry Smith }
6455c6c1daeSBarry Smith 
6465c6c1daeSBarry Smith 
6475c6c1daeSBarry Smith #undef __FUNCT__
6485c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerDrawSetHold"
6495c6c1daeSBarry Smith /*@
6505c6c1daeSBarry Smith     PetscViewerDrawSetHold - Holds previous image when drawing new image
6515c6c1daeSBarry Smith 
6525c6c1daeSBarry Smith     Not Collective
6535c6c1daeSBarry Smith 
6545c6c1daeSBarry Smith     Input Parameters:
6555c6c1daeSBarry Smith +  viewer - the PetscViewer
6565c6c1daeSBarry Smith -  hold - indicates to hold or not
6575c6c1daeSBarry Smith 
6585c6c1daeSBarry Smith     Level: intermediate
6595c6c1daeSBarry Smith 
6605c6c1daeSBarry Smith .seealso: PetscViewerDrawOpen(), PetscViewerDrawGetDraw(),
6615c6c1daeSBarry Smith 
6625c6c1daeSBarry Smith @*/
6635c6c1daeSBarry Smith PetscErrorCode  PetscViewerDrawSetHold(PetscViewer viewer,PetscBool hold)
6645c6c1daeSBarry Smith {
6655c6c1daeSBarry Smith   PetscErrorCode   ierr;
6665c6c1daeSBarry Smith   PetscViewer_Draw *vdraw;
6675c6c1daeSBarry Smith   PetscBool        isdraw;
6685c6c1daeSBarry Smith 
6695c6c1daeSBarry Smith   PetscFunctionBegin;
670*e5ab1681SLisandro Dalcin   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
6715c6c1daeSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
672*e5ab1681SLisandro Dalcin   if (!isdraw) PetscFunctionReturn(0);
6735c6c1daeSBarry Smith   vdraw = (PetscViewer_Draw*)viewer->data;
674*e5ab1681SLisandro Dalcin 
6755c6c1daeSBarry Smith   vdraw->hold = hold;
6765c6c1daeSBarry Smith   PetscFunctionReturn(0);
6775c6c1daeSBarry Smith }
6785c6c1daeSBarry Smith 
6795c6c1daeSBarry Smith #undef __FUNCT__
6805c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerDrawGetHold"
6815c6c1daeSBarry Smith /*@
682d97d059aSBarry Smith     PetscViewerDrawGetHold - Checks if holds previous image when drawing new image
6835c6c1daeSBarry Smith 
6845c6c1daeSBarry Smith     Not Collective
6855c6c1daeSBarry Smith 
6865c6c1daeSBarry Smith     Input Parameter:
6875c6c1daeSBarry Smith .  viewer - the PetscViewer
6885c6c1daeSBarry Smith 
6895c6c1daeSBarry Smith     Output Parameter:
6905c6c1daeSBarry Smith .  hold - indicates to hold or not
6915c6c1daeSBarry Smith 
6925c6c1daeSBarry Smith     Level: intermediate
6935c6c1daeSBarry Smith 
6945c6c1daeSBarry Smith .seealso: PetscViewerDrawOpen(), PetscViewerDrawGetDraw(),
6955c6c1daeSBarry Smith 
6965c6c1daeSBarry Smith @*/
6975c6c1daeSBarry Smith PetscErrorCode  PetscViewerDrawGetHold(PetscViewer viewer,PetscBool *hold)
6985c6c1daeSBarry Smith {
6995c6c1daeSBarry Smith   PetscErrorCode   ierr;
7005c6c1daeSBarry Smith   PetscViewer_Draw *vdraw;
7015c6c1daeSBarry Smith   PetscBool        isdraw;
7025c6c1daeSBarry Smith 
7035c6c1daeSBarry Smith   PetscFunctionBegin;
704*e5ab1681SLisandro Dalcin   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
7055c6c1daeSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
706*e5ab1681SLisandro Dalcin   if (!isdraw) {*hold = PETSC_FALSE; PetscFunctionReturn(0);}
7075c6c1daeSBarry Smith   vdraw = (PetscViewer_Draw*)viewer->data;
708*e5ab1681SLisandro Dalcin 
7095c6c1daeSBarry Smith   *hold = vdraw->hold;
7105c6c1daeSBarry Smith   PetscFunctionReturn(0);
7115c6c1daeSBarry Smith }
7125c6c1daeSBarry Smith 
7135c6c1daeSBarry Smith /* ---------------------------------------------------------------------*/
7145c6c1daeSBarry Smith /*
7155c6c1daeSBarry Smith     The variable Petsc_Viewer_Draw_keyval is used to indicate an MPI attribute that
7165c6c1daeSBarry Smith   is attached to a communicator, in this case the attribute is a PetscViewer.
7175c6c1daeSBarry Smith */
7185c6c1daeSBarry Smith static PetscMPIInt Petsc_Viewer_Draw_keyval = MPI_KEYVAL_INVALID;
7195c6c1daeSBarry Smith 
7205c6c1daeSBarry Smith #undef __FUNCT__
7215c6c1daeSBarry Smith #define __FUNCT__ "PETSC_VIEWER_DRAW_"
7225c6c1daeSBarry Smith /*@C
7235c6c1daeSBarry Smith     PETSC_VIEWER_DRAW_ - Creates a window PetscViewer shared by all processors
7245c6c1daeSBarry Smith                      in a communicator.
7255c6c1daeSBarry Smith 
7265c6c1daeSBarry Smith      Collective on MPI_Comm
7275c6c1daeSBarry Smith 
7285c6c1daeSBarry Smith      Input Parameter:
7295c6c1daeSBarry Smith .    comm - the MPI communicator to share the window PetscViewer
7305c6c1daeSBarry Smith 
7315c6c1daeSBarry Smith      Level: intermediate
7325c6c1daeSBarry Smith 
7335c6c1daeSBarry Smith      Notes:
7345c6c1daeSBarry Smith      Unlike almost all other PETSc routines, PETSC_VIEWER_DRAW_ does not return
7355c6c1daeSBarry Smith      an error code.  The window is usually used in the form
7365c6c1daeSBarry Smith $       XXXView(XXX object,PETSC_VIEWER_DRAW_(comm));
7375c6c1daeSBarry Smith 
7385c6c1daeSBarry Smith .seealso: PETSC_VIEWER_DRAW_WORLD, PETSC_VIEWER_DRAW_SELF, PetscViewerDrawOpen(),
7395c6c1daeSBarry Smith @*/
7405c6c1daeSBarry Smith PetscViewer  PETSC_VIEWER_DRAW_(MPI_Comm comm)
7415c6c1daeSBarry Smith {
7425c6c1daeSBarry Smith   PetscErrorCode ierr;
7435c6c1daeSBarry Smith   PetscMPIInt    flag;
7445c6c1daeSBarry Smith   PetscViewer    viewer;
7455c6c1daeSBarry Smith   MPI_Comm       ncomm;
7465c6c1daeSBarry Smith 
7475c6c1daeSBarry Smith   PetscFunctionBegin;
748efca3c55SSatish 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);}
7495c6c1daeSBarry Smith   if (Petsc_Viewer_Draw_keyval == MPI_KEYVAL_INVALID) {
7505c6c1daeSBarry Smith     ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,MPI_NULL_DELETE_FN,&Petsc_Viewer_Draw_keyval,0);
751efca3c55SSatish Balay     if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_DRAW_",__FILE__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");PetscFunctionReturn(0);}
7525c6c1daeSBarry Smith   }
7535c6c1daeSBarry Smith   ierr = MPI_Attr_get(ncomm,Petsc_Viewer_Draw_keyval,(void**)&viewer,&flag);
754efca3c55SSatish Balay   if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_DRAW_",__FILE__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");PetscFunctionReturn(0);}
7555c6c1daeSBarry Smith   if (!flag) { /* PetscViewer not yet created */
7565c6c1daeSBarry Smith     ierr = PetscViewerDrawOpen(ncomm,0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,&viewer);
757efca3c55SSatish Balay     if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_DRAW_",__FILE__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");PetscFunctionReturn(0);}
7585c6c1daeSBarry Smith     ierr = PetscObjectRegisterDestroy((PetscObject)viewer);
759efca3c55SSatish Balay     if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_DRAW_",__FILE__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");PetscFunctionReturn(0);}
7605c6c1daeSBarry Smith     ierr = MPI_Attr_put(ncomm,Petsc_Viewer_Draw_keyval,(void*)viewer);
761efca3c55SSatish Balay     if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_DRAW_",__FILE__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");PetscFunctionReturn(0);}
7625c6c1daeSBarry Smith   }
7635c6c1daeSBarry Smith   ierr = PetscCommDestroy(&ncomm);
764efca3c55SSatish Balay   if (ierr) {PetscError(PETSC_COMM_SELF,__LINE__,"PETSC_VIEWER_DRAW_",__FILE__,PETSC_ERR_PLIB,PETSC_ERROR_INITIAL," ");PetscFunctionReturn(0);}
7655c6c1daeSBarry Smith   PetscFunctionReturn(viewer);
7665c6c1daeSBarry Smith }
7675c6c1daeSBarry Smith 
7685c6c1daeSBarry Smith #undef __FUNCT__
7695c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerDrawSetBounds"
7705c6c1daeSBarry Smith /*@
7715c6c1daeSBarry Smith     PetscViewerDrawSetBounds - sets the upper and lower bounds to be used in plotting
7725c6c1daeSBarry Smith 
7735c6c1daeSBarry Smith     Collective on PetscViewer
7745c6c1daeSBarry Smith 
7755c6c1daeSBarry Smith     Input Parameters:
7765c6c1daeSBarry Smith +   viewer - the PetscViewer (created with PetscViewerDrawOpen())
7775c6c1daeSBarry Smith .   nbounds - number of plots that can be made with this viewer, for example the dof passed to DMDACreate()
7785c6c1daeSBarry 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, .....
7795c6c1daeSBarry Smith 
780e9457bf7SBarry Smith 
781e9457bf7SBarry Smith     Options Database:
782e9457bf7SBarry Smith .   -draw_bounds  minF0,maxF0,minF1,maxF1
783e9457bf7SBarry Smith 
7845c6c1daeSBarry Smith     Level: intermediate
7855c6c1daeSBarry Smith 
786f3f0eb19SBarry 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
787f3f0eb19SBarry 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
788f3f0eb19SBarry Smith       this viewer. Otherwise the color to physical value meaning changes with each new image if this is not set.
789f3f0eb19SBarry Smith 
7905c6c1daeSBarry Smith    Concepts: drawing^accessing PetscDraw context from PetscViewer
7915c6c1daeSBarry Smith    Concepts: graphics
7925c6c1daeSBarry Smith 
7935c6c1daeSBarry Smith .seealso: PetscViewerDrawGetLG(), PetscViewerDrawGetAxis(), PetscViewerDrawOpen()
7945c6c1daeSBarry Smith @*/
7955c6c1daeSBarry Smith PetscErrorCode  PetscViewerDrawSetBounds(PetscViewer viewer,PetscInt nbounds,const PetscReal *bounds)
7965c6c1daeSBarry Smith {
797*e5ab1681SLisandro Dalcin   PetscViewer_Draw *vdraw;
798*e5ab1681SLisandro Dalcin   PetscBool        isdraw;
7995c6c1daeSBarry Smith   PetscErrorCode   ierr;
8005c6c1daeSBarry Smith 
8015c6c1daeSBarry Smith 
8025c6c1daeSBarry Smith   PetscFunctionBegin;
8035c6c1daeSBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
804*e5ab1681SLisandro Dalcin   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
805*e5ab1681SLisandro Dalcin   if (!isdraw) PetscFunctionReturn(0);
806*e5ab1681SLisandro Dalcin   vdraw = (PetscViewer_Draw*)viewer->data;
807a297a907SKarl Rupp 
808*e5ab1681SLisandro Dalcin   vdraw->nbounds = nbounds;
809*e5ab1681SLisandro Dalcin   ierr = PetscFree(vdraw->bounds);CHKERRQ(ierr);
810785e854fSJed Brown   ierr = PetscMalloc1(2*nbounds,&vdraw->bounds);CHKERRQ(ierr);
8115c6c1daeSBarry Smith   ierr = PetscMemcpy(vdraw->bounds,bounds,2*nbounds*sizeof(PetscReal));CHKERRQ(ierr);
8125c6c1daeSBarry Smith   PetscFunctionReturn(0);
8135c6c1daeSBarry Smith }
8145c6c1daeSBarry Smith 
8155c6c1daeSBarry Smith #undef __FUNCT__
8165c6c1daeSBarry Smith #define __FUNCT__ "PetscViewerDrawGetBounds"
8175c6c1daeSBarry Smith /*@C
8185c6c1daeSBarry Smith     PetscViewerDrawGetBounds - gets the upper and lower bounds to be used in plotting set with PetscViewerDrawSetBounds()
8195c6c1daeSBarry Smith 
8205c6c1daeSBarry Smith     Collective on PetscViewer
8215c6c1daeSBarry Smith 
8225c6c1daeSBarry Smith     Input Parameter:
8235c6c1daeSBarry Smith .   viewer - the PetscViewer (created with PetscViewerDrawOpen())
8245c6c1daeSBarry Smith 
8255c6c1daeSBarry Smith     Output Paramters:
8265c6c1daeSBarry Smith +   nbounds - number of plots that can be made with this viewer, for example the dof passed to DMDACreate()
8275c6c1daeSBarry 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, .....
8285c6c1daeSBarry Smith 
8295c6c1daeSBarry Smith     Level: intermediate
8305c6c1daeSBarry Smith 
8315c6c1daeSBarry Smith    Concepts: drawing^accessing PetscDraw context from PetscViewer
8325c6c1daeSBarry Smith    Concepts: graphics
8335c6c1daeSBarry Smith 
834f3f0eb19SBarry Smith .seealso: PetscViewerDrawGetLG(), PetscViewerDrawGetAxis(), PetscViewerDrawOpen(), PetscViewerDrawSetBounds()
8355c6c1daeSBarry Smith @*/
8365c6c1daeSBarry Smith PetscErrorCode  PetscViewerDrawGetBounds(PetscViewer viewer,PetscInt *nbounds,const PetscReal **bounds)
8375c6c1daeSBarry Smith {
838*e5ab1681SLisandro Dalcin   PetscViewer_Draw *vdraw;
839*e5ab1681SLisandro Dalcin   PetscBool        isdraw;
840*e5ab1681SLisandro Dalcin   PetscErrorCode   ierr;
8415c6c1daeSBarry Smith 
8425c6c1daeSBarry Smith   PetscFunctionBegin;
8435c6c1daeSBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
844*e5ab1681SLisandro Dalcin   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
845*e5ab1681SLisandro Dalcin   if (!isdraw) {if (nbounds) *nbounds = 0; if (bounds) *bounds = NULL; PetscFunctionReturn(0);}
846*e5ab1681SLisandro Dalcin   vdraw = (PetscViewer_Draw*)viewer->data;
847*e5ab1681SLisandro Dalcin 
848*e5ab1681SLisandro Dalcin   if (nbounds) *nbounds = vdraw->nbounds;
849*e5ab1681SLisandro Dalcin   if (bounds)  *bounds  = vdraw->bounds;
8505c6c1daeSBarry Smith   PetscFunctionReturn(0);
8515c6c1daeSBarry Smith }
852