xref: /petsc/src/sys/classes/draw/utils/lgc.c (revision 064a246e8b5c1f87897a54b4a9ec05181ea08258)
15c6c1daeSBarry Smith 
25ccc9f3cSMatthew G Knepley #include <petscviewer.h>
3e118a51fSLisandro Dalcin #include <../src/sys/classes/draw/utils/lgimpl.h>  /*I   "petscdraw.h"  I*/
45c6c1daeSBarry Smith PetscClassId PETSC_DRAWLG_CLASSID = 0;
55c6c1daeSBarry Smith 
65c6c1daeSBarry Smith /*@
75c6c1daeSBarry Smith    PetscDrawLGGetAxis - Gets the axis context associated with a line graph.
85c6c1daeSBarry Smith    This is useful if one wants to change some axis property, such as
95c6c1daeSBarry Smith    labels, color, etc. The axis context should not be destroyed by the
105c6c1daeSBarry Smith    application code.
115c6c1daeSBarry Smith 
125c6c1daeSBarry Smith    Not Collective, if PetscDrawLG is parallel then PetscDrawAxis is parallel
135c6c1daeSBarry Smith 
145c6c1daeSBarry Smith    Input Parameter:
155c6c1daeSBarry Smith .  lg - the line graph context
165c6c1daeSBarry Smith 
175c6c1daeSBarry Smith    Output Parameter:
185c6c1daeSBarry Smith .  axis - the axis context
195c6c1daeSBarry Smith 
205c6c1daeSBarry Smith    Level: advanced
215c6c1daeSBarry Smith 
22ba1e01c4SBarry Smith .seealso: PetscDrawLGCreate(), PetscDrawAxis
23ba1e01c4SBarry Smith 
245c6c1daeSBarry Smith @*/
255c6c1daeSBarry Smith PetscErrorCode  PetscDrawLGGetAxis(PetscDrawLG lg,PetscDrawAxis *axis)
265c6c1daeSBarry Smith {
275c6c1daeSBarry Smith   PetscFunctionBegin;
28e118a51fSLisandro Dalcin   PetscValidHeaderSpecific(lg,PETSC_DRAWLG_CLASSID,1);
2945f3bb6eSLisandro Dalcin   PetscValidPointer(axis,2);
305c6c1daeSBarry Smith   *axis = lg->axis;
315c6c1daeSBarry Smith   PetscFunctionReturn(0);
325c6c1daeSBarry Smith }
335c6c1daeSBarry Smith 
345c6c1daeSBarry Smith /*@
355c6c1daeSBarry Smith    PetscDrawLGGetDraw - Gets the draw context associated with a line graph.
365c6c1daeSBarry Smith 
375c6c1daeSBarry Smith    Not Collective, if PetscDrawLG is parallel then PetscDraw is parallel
385c6c1daeSBarry Smith 
395c6c1daeSBarry Smith    Input Parameter:
405c6c1daeSBarry Smith .  lg - the line graph context
415c6c1daeSBarry Smith 
425c6c1daeSBarry Smith    Output Parameter:
435c6c1daeSBarry Smith .  draw - the draw context
445c6c1daeSBarry Smith 
455c6c1daeSBarry Smith    Level: intermediate
465c6c1daeSBarry Smith 
47ba1e01c4SBarry Smith .seealso: PetscDrawLGCreate(), PetscDraw
485c6c1daeSBarry Smith @*/
495c6c1daeSBarry Smith PetscErrorCode  PetscDrawLGGetDraw(PetscDrawLG lg,PetscDraw *draw)
505c6c1daeSBarry Smith {
515c6c1daeSBarry Smith   PetscFunctionBegin;
525c6c1daeSBarry Smith   PetscValidHeaderSpecific(lg,PETSC_DRAWLG_CLASSID,1);
5345f3bb6eSLisandro Dalcin   PetscValidPointer(draw,2);
545c6c1daeSBarry Smith   *draw = lg->win;
555c6c1daeSBarry Smith   PetscFunctionReturn(0);
565c6c1daeSBarry Smith }
575c6c1daeSBarry Smith 
585c6c1daeSBarry Smith 
595c6c1daeSBarry Smith /*@
605c6c1daeSBarry Smith    PetscDrawLGSPDraw - Redraws a line graph.
615c6c1daeSBarry Smith 
625b399a63SLisandro Dalcin    Collective on PetscDrawLG
635c6c1daeSBarry Smith 
645c6c1daeSBarry Smith    Input Parameter:
655c6c1daeSBarry Smith .  lg - the line graph context
665c6c1daeSBarry Smith 
675c6c1daeSBarry Smith    Level: intermediate
685c6c1daeSBarry Smith 
695c6c1daeSBarry Smith .seealso: PetscDrawLGDraw(), PetscDrawSPDraw()
705c6c1daeSBarry Smith 
7195452b02SPatrick Sanan    Developer Notes:
7295452b02SPatrick Sanan     This code cheats and uses the fact that the LG and SP structs are the same
735c6c1daeSBarry Smith 
745c6c1daeSBarry Smith @*/
755c6c1daeSBarry Smith PetscErrorCode  PetscDrawLGSPDraw(PetscDrawLG lg,PetscDrawSP spin)
765c6c1daeSBarry Smith {
775c6c1daeSBarry Smith   PetscDrawLG    sp = (PetscDrawLG)spin;
785c6c1daeSBarry Smith   PetscReal      xmin,xmax,ymin,ymax;
795c6c1daeSBarry Smith   PetscErrorCode ierr;
80e118a51fSLisandro Dalcin   PetscBool      isnull;
81e118a51fSLisandro Dalcin   PetscMPIInt    rank;
82e118a51fSLisandro Dalcin   PetscDraw      draw;
835c6c1daeSBarry Smith 
845c6c1daeSBarry Smith   PetscFunctionBegin;
855c6c1daeSBarry Smith   PetscValidHeaderSpecific(lg,PETSC_DRAWLG_CLASSID,1);
86*064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(sp,PETSC_DRAWLG_CLASSID,2);
875b399a63SLisandro Dalcin   ierr = PetscDrawIsNull(lg->win,&isnull);CHKERRQ(ierr);
88e118a51fSLisandro Dalcin   if (isnull) PetscFunctionReturn(0);
89ffc4695bSBarry Smith   ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)lg),&rank);CHKERRMPI(ierr);
905c6c1daeSBarry Smith 
915b399a63SLisandro Dalcin   draw = lg->win;
92e118a51fSLisandro Dalcin   ierr = PetscDrawCheckResizedWindow(draw);CHKERRQ(ierr);
935b399a63SLisandro Dalcin   ierr = PetscDrawClear(draw);CHKERRQ(ierr);
94e118a51fSLisandro Dalcin 
95e118a51fSLisandro Dalcin   xmin = PetscMin(lg->xmin,sp->xmin); ymin = PetscMin(lg->ymin,sp->ymin);
96e118a51fSLisandro Dalcin   xmax = PetscMax(lg->xmax,sp->xmax); ymax = PetscMax(lg->ymax,sp->ymax);
975c6c1daeSBarry Smith   ierr = PetscDrawAxisSetLimits(lg->axis,xmin,xmax,ymin,ymax);CHKERRQ(ierr);
985c6c1daeSBarry Smith   ierr = PetscDrawAxisDraw(lg->axis);CHKERRQ(ierr);
995c6c1daeSBarry Smith 
1005b399a63SLisandro Dalcin   ierr = PetscDrawCollectiveBegin(draw);CHKERRQ(ierr);
1015c6c1daeSBarry Smith   if (!rank) {
102e118a51fSLisandro Dalcin     int i,j,dim,nopts;
1035c6c1daeSBarry Smith     dim   = lg->dim;
1045c6c1daeSBarry Smith     nopts = lg->nopts;
1055c6c1daeSBarry Smith     for (i=0; i<dim; i++) {
1065c6c1daeSBarry Smith       for (j=1; j<nopts; j++) {
1075c6c1daeSBarry Smith         ierr = PetscDrawLine(draw,lg->x[(j-1)*dim+i],lg->y[(j-1)*dim+i],lg->x[j*dim+i],lg->y[j*dim+i],PETSC_DRAW_BLACK+i);CHKERRQ(ierr);
108b6fe0379SLisandro Dalcin         if (lg->use_markers) {
10978e9f83eSLisandro Dalcin           ierr = PetscDrawMarker(draw,lg->x[j*dim+i],lg->y[j*dim+i],PETSC_DRAW_RED);CHKERRQ(ierr);
1105c6c1daeSBarry Smith         }
1115c6c1daeSBarry Smith       }
1125c6c1daeSBarry Smith     }
1135c6c1daeSBarry Smith     dim   = sp->dim;
1145c6c1daeSBarry Smith     nopts = sp->nopts;
1155c6c1daeSBarry Smith     for (i=0; i<dim; i++) {
1165c6c1daeSBarry Smith       for (j=0; j<nopts; j++) {
11778e9f83eSLisandro Dalcin         ierr = PetscDrawMarker(draw,sp->x[j*dim+i],sp->y[j*dim+i],PETSC_DRAW_RED);CHKERRQ(ierr);
1185c6c1daeSBarry Smith       }
1195c6c1daeSBarry Smith     }
1205c6c1daeSBarry Smith   }
121e118a51fSLisandro Dalcin   ierr = PetscDrawCollectiveEnd(draw);CHKERRQ(ierr);
1225b399a63SLisandro Dalcin 
1235b399a63SLisandro Dalcin   ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
1245b399a63SLisandro Dalcin   ierr = PetscDrawPause(draw);CHKERRQ(ierr);
1255c6c1daeSBarry Smith   PetscFunctionReturn(0);
1265c6c1daeSBarry Smith }
1275c6c1daeSBarry Smith 
1285c6c1daeSBarry Smith 
1295c6c1daeSBarry Smith /*@
1305c6c1daeSBarry Smith     PetscDrawLGCreate - Creates a line graph data structure.
1315c6c1daeSBarry Smith 
1325b399a63SLisandro Dalcin     Collective on PetscDraw
1335c6c1daeSBarry Smith 
1345c6c1daeSBarry Smith     Input Parameters:
1355c6c1daeSBarry Smith +   draw - the window where the graph will be made.
1365c6c1daeSBarry Smith -   dim - the number of curves which will be drawn
1375c6c1daeSBarry Smith 
1385c6c1daeSBarry Smith     Output Parameters:
139e118a51fSLisandro Dalcin .   outlg - the line graph context
1405c6c1daeSBarry Smith 
1415c6c1daeSBarry Smith     Level: intermediate
1425c6c1daeSBarry Smith 
14395452b02SPatrick Sanan     Notes:
14495452b02SPatrick Sanan     The MPI communicator that owns the PetscDraw owns this PetscDrawLG, but the calls to set options and add points are ignored on all processes except the
1457e25d57eSBarry Smith            zeroth MPI process in the communicator. All MPI processes in the communicator must call PetscDrawLGDraw() to display the updated graph.
1467e25d57eSBarry Smith 
147ba1e01c4SBarry Smith .seealso:  PetscDrawLGDestroy(), PetscDrawLGAddPoint(), PetscDrawLGAddCommonPoint(), PetscDrawLGAddPoints(), PetscDrawLGDraw(), PetscDrawLGSave(),
148ba1e01c4SBarry Smith            PetscDrawLGView(), PetscDrawLGReset(), PetscDrawLGSetDimension(), PetscDrawLGGetDimension(), PetscDrawLGSetLegend(), PetscDrawLGGetAxis(),
149ba1e01c4SBarry Smith            PetscDrawLGGetDraw(), PetscDrawLGSetUseMarkers(), PetscDrawLGSetLimits(), PetscDrawLGSetColors(), PetscDrawLGSetOptionsPrefix(), PetscDrawLGSetFromOptions()
1505c6c1daeSBarry Smith @*/
151e118a51fSLisandro Dalcin PetscErrorCode  PetscDrawLGCreate(PetscDraw draw,PetscInt dim,PetscDrawLG *outlg)
1525c6c1daeSBarry Smith {
1535c6c1daeSBarry Smith   PetscDrawLG    lg;
154e118a51fSLisandro Dalcin   PetscErrorCode ierr;
1555c6c1daeSBarry Smith 
1565c6c1daeSBarry Smith   PetscFunctionBegin;
1575c6c1daeSBarry Smith   PetscValidHeaderSpecific(draw,PETSC_DRAW_CLASSID,1);
158e118a51fSLisandro Dalcin   PetscValidLogicalCollectiveInt(draw,dim,2);
159e118a51fSLisandro Dalcin   PetscValidPointer(outlg,3);
160e118a51fSLisandro Dalcin 
16171917b75SLisandro Dalcin   ierr = PetscHeaderCreate(lg,PETSC_DRAWLG_CLASSID,"DrawLG","Line Graph","Draw",PetscObjectComm((PetscObject)draw),PetscDrawLGDestroy,NULL);CHKERRQ(ierr);
162e118a51fSLisandro Dalcin   ierr = PetscLogObjectParent((PetscObject)draw,(PetscObject)lg);CHKERRQ(ierr);
163c2bac407SLisandro Dalcin   ierr = PetscDrawLGSetOptionsPrefix(lg,((PetscObject)draw)->prefix);CHKERRQ(ierr);
164e118a51fSLisandro Dalcin 
165e118a51fSLisandro Dalcin   ierr = PetscObjectReference((PetscObject)draw);CHKERRQ(ierr);
166e118a51fSLisandro Dalcin   lg->win = draw;
167a297a907SKarl Rupp 
16869c83917SLisandro Dalcin   lg->view    = NULL;
16969c83917SLisandro Dalcin   lg->destroy = NULL;
1705c6c1daeSBarry Smith   lg->nopts   = 0;
1715c6c1daeSBarry Smith   lg->dim     = dim;
1725c6c1daeSBarry Smith   lg->xmin    = 1.e20;
1735c6c1daeSBarry Smith   lg->ymin    = 1.e20;
1745c6c1daeSBarry Smith   lg->xmax    = -1.e20;
1755c6c1daeSBarry Smith   lg->ymax    = -1.e20;
176a297a907SKarl Rupp 
177dcca6d9dSJed Brown   ierr = PetscMalloc2(dim*CHUNCKSIZE,&lg->x,dim*CHUNCKSIZE,&lg->y);CHKERRQ(ierr);
1783bb1ff40SBarry Smith   ierr = PetscLogObjectMemory((PetscObject)lg,2*dim*CHUNCKSIZE*sizeof(PetscReal));CHKERRQ(ierr);
179a297a907SKarl Rupp 
1805c6c1daeSBarry Smith   lg->len         = dim*CHUNCKSIZE;
1815c6c1daeSBarry Smith   lg->loc         = 0;
182b6fe0379SLisandro Dalcin   lg->use_markers = PETSC_FALSE;
183a297a907SKarl Rupp 
1845c6c1daeSBarry Smith   ierr = PetscDrawAxisCreate(draw,&lg->axis);CHKERRQ(ierr);
1853bb1ff40SBarry Smith   ierr = PetscLogObjectParent((PetscObject)lg,(PetscObject)lg->axis);CHKERRQ(ierr);
186a297a907SKarl Rupp 
187e118a51fSLisandro Dalcin   *outlg = lg;
1885c6c1daeSBarry Smith   PetscFunctionReturn(0);
1895c6c1daeSBarry Smith }
1905c6c1daeSBarry Smith 
1915c6c1daeSBarry Smith /*@
1925c6c1daeSBarry Smith    PetscDrawLGSetColors - Sets the color of each line graph drawn
1935c6c1daeSBarry Smith 
1945b399a63SLisandro Dalcin    Logically Collective on PetscDrawLG
1955c6c1daeSBarry Smith 
1965c6c1daeSBarry Smith    Input Parameter:
1975c6c1daeSBarry Smith +  lg - the line graph context.
1985c6c1daeSBarry Smith -  colors - the colors
1995c6c1daeSBarry Smith 
2005c6c1daeSBarry Smith    Level: intermediate
2015c6c1daeSBarry Smith 
202ba1e01c4SBarry Smith .seealso: PetscDrawLGCreate()
203ba1e01c4SBarry Smith 
2045c6c1daeSBarry Smith @*/
20545f3bb6eSLisandro Dalcin PetscErrorCode  PetscDrawLGSetColors(PetscDrawLG lg,const int colors[])
2065c6c1daeSBarry Smith {
2075c6c1daeSBarry Smith   PetscErrorCode ierr;
2085c6c1daeSBarry Smith 
2095c6c1daeSBarry Smith   PetscFunctionBegin;
2105c6c1daeSBarry Smith   PetscValidHeaderSpecific(lg,PETSC_DRAWLG_CLASSID,1);
21145f3bb6eSLisandro Dalcin   if (lg->dim) PetscValidIntPointer(colors,2);
212e118a51fSLisandro Dalcin 
2135c6c1daeSBarry Smith   ierr = PetscFree(lg->colors);CHKERRQ(ierr);
214785e854fSJed Brown   ierr = PetscMalloc1(lg->dim,&lg->colors);CHKERRQ(ierr);
215580bdb30SBarry Smith   ierr = PetscArraycpy(lg->colors,colors,lg->dim);CHKERRQ(ierr);
2165c6c1daeSBarry Smith   PetscFunctionReturn(0);
2175c6c1daeSBarry Smith }
2185c6c1daeSBarry Smith 
2195c6c1daeSBarry Smith /*@C
2205c6c1daeSBarry Smith    PetscDrawLGSetLegend - sets the names of each curve plotted
2215c6c1daeSBarry Smith 
2225b399a63SLisandro Dalcin    Logically Collective on PetscDrawLG
2235c6c1daeSBarry Smith 
2245c6c1daeSBarry Smith    Input Parameter:
2255c6c1daeSBarry Smith +  lg - the line graph context.
2265c6c1daeSBarry Smith -  names - the names for each curve
2275c6c1daeSBarry Smith 
2285c6c1daeSBarry Smith    Level: intermediate
2295c6c1daeSBarry Smith 
23095452b02SPatrick Sanan    Notes:
23195452b02SPatrick Sanan     Call PetscDrawLGGetAxis() and then change properties of the PetscDrawAxis for detailed control of the plot
232ba1e01c4SBarry Smith 
233ba1e01c4SBarry Smith .seealso: PetscDrawLGGetAxis(), PetscDrawAxis, PetscDrawAxisSetColors(), PetscDrawAxisSetLabels(), PetscDrawAxisSetHoldLimits()
234ba1e01c4SBarry Smith 
2355c6c1daeSBarry Smith @*/
2365c6c1daeSBarry Smith PetscErrorCode  PetscDrawLGSetLegend(PetscDrawLG lg,const char *const *names)
2375c6c1daeSBarry Smith {
2385c6c1daeSBarry Smith   PetscErrorCode ierr;
2395c6c1daeSBarry Smith   PetscInt       i;
2405c6c1daeSBarry Smith 
2415c6c1daeSBarry Smith   PetscFunctionBegin;
2425c6c1daeSBarry Smith   PetscValidHeaderSpecific(lg,PETSC_DRAWLG_CLASSID,1);
24345f3bb6eSLisandro Dalcin   if (names) PetscValidPointer(names,2);
2445c6c1daeSBarry Smith 
2455c6c1daeSBarry Smith   if (lg->legend) {
2465c6c1daeSBarry Smith     for (i=0; i<lg->dim; i++) {
2475c6c1daeSBarry Smith       ierr = PetscFree(lg->legend[i]);CHKERRQ(ierr);
2485c6c1daeSBarry Smith     }
2495c6c1daeSBarry Smith     ierr = PetscFree(lg->legend);CHKERRQ(ierr);
2505c6c1daeSBarry Smith   }
2515c6c1daeSBarry Smith   if (names) {
252785e854fSJed Brown     ierr = PetscMalloc1(lg->dim,&lg->legend);CHKERRQ(ierr);
2535c6c1daeSBarry Smith     for (i=0; i<lg->dim; i++) {
2545c6c1daeSBarry Smith       ierr = PetscStrallocpy(names[i],&lg->legend[i]);CHKERRQ(ierr);
2555c6c1daeSBarry Smith     }
2565c6c1daeSBarry Smith   }
2575c6c1daeSBarry Smith   PetscFunctionReturn(0);
2585c6c1daeSBarry Smith }
2595c6c1daeSBarry Smith 
2605c6c1daeSBarry Smith /*@
2615c6c1daeSBarry Smith    PetscDrawLGGetDimension - Change the number of lines that are to be drawn.
2625c6c1daeSBarry Smith 
2635b399a63SLisandro Dalcin    Not Collective
2645c6c1daeSBarry Smith 
2655c6c1daeSBarry Smith    Input Parameter:
2665c6c1daeSBarry Smith .  lg - the line graph context.
2675c6c1daeSBarry Smith 
2685c6c1daeSBarry Smith    Output Parameter:
2695c6c1daeSBarry Smith .  dim - the number of curves.
2705c6c1daeSBarry Smith 
2715c6c1daeSBarry Smith    Level: intermediate
2725c6c1daeSBarry Smith 
273ba1e01c4SBarry Smith .seealso: PetscDrawLGCreate(), PetscDrawLGSetDimension()
274ba1e01c4SBarry Smith 
2755c6c1daeSBarry Smith @*/
2765c6c1daeSBarry Smith PetscErrorCode  PetscDrawLGGetDimension(PetscDrawLG lg,PetscInt *dim)
2775c6c1daeSBarry Smith {
2785c6c1daeSBarry Smith   PetscFunctionBegin;
2795c6c1daeSBarry Smith   PetscValidHeaderSpecific(lg,PETSC_DRAWLG_CLASSID,1);
28045f3bb6eSLisandro Dalcin   PetscValidIntPointer(dim,2);
2815c6c1daeSBarry Smith   *dim = lg->dim;
2825c6c1daeSBarry Smith   PetscFunctionReturn(0);
2835c6c1daeSBarry Smith }
2845c6c1daeSBarry Smith 
2855c6c1daeSBarry Smith /*@
2865c6c1daeSBarry Smith    PetscDrawLGSetDimension - Change the number of lines that are to be drawn.
2875c6c1daeSBarry Smith 
2885b399a63SLisandro Dalcin    Logically Collective on PetscDrawLG
2895c6c1daeSBarry Smith 
2905c6c1daeSBarry Smith    Input Parameter:
2915c6c1daeSBarry Smith +  lg - the line graph context.
2925c6c1daeSBarry Smith -  dim - the number of curves.
2935c6c1daeSBarry Smith 
2945c6c1daeSBarry Smith    Level: intermediate
2955c6c1daeSBarry Smith 
296ba1e01c4SBarry Smith .seealso: PetscDrawLGCreate(), PetscDrawLGGetDimension()
2975c6c1daeSBarry Smith @*/
2985c6c1daeSBarry Smith PetscErrorCode  PetscDrawLGSetDimension(PetscDrawLG lg,PetscInt dim)
2995c6c1daeSBarry Smith {
3005c6c1daeSBarry Smith   PetscErrorCode ierr;
3015c6c1daeSBarry Smith   PetscInt       i;
3025c6c1daeSBarry Smith 
3035c6c1daeSBarry Smith   PetscFunctionBegin;
3045c6c1daeSBarry Smith   PetscValidHeaderSpecific(lg,PETSC_DRAWLG_CLASSID,1);
3055c6c1daeSBarry Smith   PetscValidLogicalCollectiveInt(lg,dim,2);
3065c6c1daeSBarry Smith   if (lg->dim == dim) PetscFunctionReturn(0);
3075c6c1daeSBarry Smith 
3085c6c1daeSBarry Smith   ierr = PetscFree2(lg->x,lg->y);CHKERRQ(ierr);
3095c6c1daeSBarry Smith   if (lg->legend) {
3105c6c1daeSBarry Smith     for (i=0; i<lg->dim; i++) {
3115c6c1daeSBarry Smith       ierr = PetscFree(lg->legend[i]);CHKERRQ(ierr);
3125c6c1daeSBarry Smith     }
3135c6c1daeSBarry Smith     ierr = PetscFree(lg->legend);CHKERRQ(ierr);
3145c6c1daeSBarry Smith   }
3155c6c1daeSBarry Smith   ierr    = PetscFree(lg->colors);CHKERRQ(ierr);
3165c6c1daeSBarry Smith   lg->dim = dim;
317dcca6d9dSJed Brown   ierr    = PetscMalloc2(dim*CHUNCKSIZE,&lg->x,dim*CHUNCKSIZE,&lg->y);CHKERRQ(ierr);
3183bb1ff40SBarry Smith   ierr    = PetscLogObjectMemory((PetscObject)lg,2*dim*CHUNCKSIZE*sizeof(PetscReal));CHKERRQ(ierr);
3195c6c1daeSBarry Smith   lg->len = dim*CHUNCKSIZE;
3205c6c1daeSBarry Smith   PetscFunctionReturn(0);
3215c6c1daeSBarry Smith }
3225c6c1daeSBarry Smith 
32371917b75SLisandro Dalcin 
32471917b75SLisandro Dalcin /*@
32571917b75SLisandro Dalcin    PetscDrawLGSetLimits - Sets the axis limits for a line graph. If more
32671917b75SLisandro Dalcin    points are added after this call, the limits will be adjusted to
32771917b75SLisandro Dalcin    include those additional points.
32871917b75SLisandro Dalcin 
32971917b75SLisandro Dalcin    Logically Collective on PetscDrawLG
33071917b75SLisandro Dalcin 
33171917b75SLisandro Dalcin    Input Parameters:
33271917b75SLisandro Dalcin +  xlg - the line graph context
33371917b75SLisandro Dalcin -  x_min,x_max,y_min,y_max - the limits
33471917b75SLisandro Dalcin 
33571917b75SLisandro Dalcin    Level: intermediate
33671917b75SLisandro Dalcin 
337ba1e01c4SBarry Smith .seealso: PetscDrawLGCreate()
338ba1e01c4SBarry Smith 
33971917b75SLisandro Dalcin @*/
34071917b75SLisandro Dalcin PetscErrorCode  PetscDrawLGSetLimits(PetscDrawLG lg,PetscReal x_min,PetscReal x_max,PetscReal y_min,PetscReal y_max)
34171917b75SLisandro Dalcin {
34271917b75SLisandro Dalcin   PetscFunctionBegin;
34371917b75SLisandro Dalcin   PetscValidHeaderSpecific(lg,PETSC_DRAWLG_CLASSID,1);
34471917b75SLisandro Dalcin 
34571917b75SLisandro Dalcin   (lg)->xmin = x_min;
34671917b75SLisandro Dalcin   (lg)->xmax = x_max;
34771917b75SLisandro Dalcin   (lg)->ymin = y_min;
34871917b75SLisandro Dalcin   (lg)->ymax = y_max;
34971917b75SLisandro Dalcin   PetscFunctionReturn(0);
35071917b75SLisandro Dalcin }
35171917b75SLisandro Dalcin 
3525c6c1daeSBarry Smith /*@
3535c6c1daeSBarry Smith    PetscDrawLGReset - Clears line graph to allow for reuse with new data.
3545c6c1daeSBarry Smith 
3555b399a63SLisandro Dalcin    Logically Collective on PetscDrawLG
3565c6c1daeSBarry Smith 
3575c6c1daeSBarry Smith    Input Parameter:
3585c6c1daeSBarry Smith .  lg - the line graph context.
3595c6c1daeSBarry Smith 
3605c6c1daeSBarry Smith    Level: intermediate
3615c6c1daeSBarry Smith 
362ba1e01c4SBarry Smith .seealso: PetscDrawLGCreate()
363ba1e01c4SBarry Smith 
3645c6c1daeSBarry Smith @*/
3655c6c1daeSBarry Smith PetscErrorCode  PetscDrawLGReset(PetscDrawLG lg)
3665c6c1daeSBarry Smith {
3675c6c1daeSBarry Smith   PetscFunctionBegin;
3685c6c1daeSBarry Smith   PetscValidHeaderSpecific(lg,PETSC_DRAWLG_CLASSID,1);
3695c6c1daeSBarry Smith   lg->xmin  = 1.e20;
3705c6c1daeSBarry Smith   lg->ymin  = 1.e20;
3715c6c1daeSBarry Smith   lg->xmax  = -1.e20;
3725c6c1daeSBarry Smith   lg->ymax  = -1.e20;
3735c6c1daeSBarry Smith   lg->loc   = 0;
3745c6c1daeSBarry Smith   lg->nopts = 0;
3755c6c1daeSBarry Smith   PetscFunctionReturn(0);
3765c6c1daeSBarry Smith }
3775c6c1daeSBarry Smith 
3785c6c1daeSBarry Smith /*@
3795c6c1daeSBarry Smith    PetscDrawLGDestroy - Frees all space taken up by line graph data structure.
3805c6c1daeSBarry Smith 
3815b399a63SLisandro Dalcin    Collective on PetscDrawLG
3825c6c1daeSBarry Smith 
3835c6c1daeSBarry Smith    Input Parameter:
3845c6c1daeSBarry Smith .  lg - the line graph context
3855c6c1daeSBarry Smith 
3865c6c1daeSBarry Smith    Level: intermediate
3875c6c1daeSBarry Smith 
3885c6c1daeSBarry Smith .seealso:  PetscDrawLGCreate()
3895c6c1daeSBarry Smith @*/
3905c6c1daeSBarry Smith PetscErrorCode  PetscDrawLGDestroy(PetscDrawLG *lg)
3915c6c1daeSBarry Smith {
3925c6c1daeSBarry Smith   PetscErrorCode ierr;
3935c6c1daeSBarry Smith   PetscInt       i;
3945c6c1daeSBarry Smith 
3955c6c1daeSBarry Smith   PetscFunctionBegin;
3965c6c1daeSBarry Smith   if (!*lg) PetscFunctionReturn(0);
397e118a51fSLisandro Dalcin   PetscValidHeaderSpecific(*lg,PETSC_DRAWLG_CLASSID,1);
398e118a51fSLisandro Dalcin   if (--((PetscObject)(*lg))->refct > 0) {*lg = NULL; PetscFunctionReturn(0);}
3995c6c1daeSBarry Smith 
4005c6c1daeSBarry Smith   if ((*lg)->legend) {
4015c6c1daeSBarry Smith     for (i=0; i<(*lg)->dim; i++) {
4025c6c1daeSBarry Smith       ierr = PetscFree((*lg)->legend[i]);CHKERRQ(ierr);
4035c6c1daeSBarry Smith     }
4045c6c1daeSBarry Smith     ierr = PetscFree((*lg)->legend);CHKERRQ(ierr);
4055c6c1daeSBarry Smith   }
4065c6c1daeSBarry Smith   ierr = PetscFree((*lg)->colors);CHKERRQ(ierr);
4075c6c1daeSBarry Smith   ierr = PetscFree2((*lg)->x,(*lg)->y);CHKERRQ(ierr);
408e118a51fSLisandro Dalcin   ierr = PetscDrawAxisDestroy(&(*lg)->axis);CHKERRQ(ierr);
409e118a51fSLisandro Dalcin   ierr = PetscDrawDestroy(&(*lg)->win);CHKERRQ(ierr);
4105c6c1daeSBarry Smith   ierr = PetscHeaderDestroy(lg);CHKERRQ(ierr);
4115c6c1daeSBarry Smith   PetscFunctionReturn(0);
4125c6c1daeSBarry Smith }
4135c6c1daeSBarry Smith /*@
414b6fe0379SLisandro Dalcin    PetscDrawLGSetUseMarkers - Causes LG to draw a marker for each data-point.
4155c6c1daeSBarry Smith 
4165b399a63SLisandro Dalcin    Logically Collective on PetscDrawLG
4175c6c1daeSBarry Smith 
4185c6c1daeSBarry Smith    Input Parameters:
419287de1a7SBarry Smith +  lg - the linegraph context
420287de1a7SBarry Smith -  flg - should mark each data point
421287de1a7SBarry Smith 
422287de1a7SBarry Smith    Options Database:
423b6fe0379SLisandro Dalcin .  -lg_use_markers  <true,false>
4245c6c1daeSBarry Smith 
4255c6c1daeSBarry Smith    Level: intermediate
4265c6c1daeSBarry Smith 
427ba1e01c4SBarry Smith .seealso: PetscDrawLGCreate()
428ba1e01c4SBarry Smith 
4295c6c1daeSBarry Smith @*/
430b6fe0379SLisandro Dalcin PetscErrorCode  PetscDrawLGSetUseMarkers(PetscDrawLG lg,PetscBool flg)
4315c6c1daeSBarry Smith {
4325c6c1daeSBarry Smith   PetscFunctionBegin;
433e118a51fSLisandro Dalcin   PetscValidHeaderSpecific(lg,PETSC_DRAWLG_CLASSID,1);
43445f3bb6eSLisandro Dalcin   PetscValidLogicalCollectiveBool(lg,flg,2);
435b6fe0379SLisandro Dalcin   lg->use_markers = flg;
4365c6c1daeSBarry Smith   PetscFunctionReturn(0);
4375c6c1daeSBarry Smith }
4385c6c1daeSBarry Smith 
4395c6c1daeSBarry Smith /*@
4405c6c1daeSBarry Smith    PetscDrawLGDraw - Redraws a line graph.
4415c6c1daeSBarry Smith 
4425b399a63SLisandro Dalcin    Collective on PetscDrawLG
4435c6c1daeSBarry Smith 
4445c6c1daeSBarry Smith    Input Parameter:
4455c6c1daeSBarry Smith .  lg - the line graph context
4465c6c1daeSBarry Smith 
4475c6c1daeSBarry Smith    Level: intermediate
4485c6c1daeSBarry Smith 
449ba1e01c4SBarry Smith .seealso: PetscDrawSPDraw(), PetscDrawLGSPDraw(), PetscDrawLGReset()
4505c6c1daeSBarry Smith 
4515c6c1daeSBarry Smith @*/
4525c6c1daeSBarry Smith PetscErrorCode  PetscDrawLGDraw(PetscDrawLG lg)
4535c6c1daeSBarry Smith {
454e118a51fSLisandro Dalcin   PetscReal      xmin,xmax,ymin,ymax;
4555c6c1daeSBarry Smith   PetscErrorCode ierr;
456e118a51fSLisandro Dalcin   PetscMPIInt    rank;
457e118a51fSLisandro Dalcin   PetscDraw      draw;
4585c6c1daeSBarry Smith   PetscBool      isnull;
4595c6c1daeSBarry Smith 
4605c6c1daeSBarry Smith   PetscFunctionBegin;
4615c6c1daeSBarry Smith   PetscValidHeaderSpecific(lg,PETSC_DRAWLG_CLASSID,1);
4628f69470aSLisandro Dalcin   ierr = PetscDrawIsNull(lg->win,&isnull);CHKERRQ(ierr);
4638f69470aSLisandro Dalcin   if (isnull) PetscFunctionReturn(0);
464ffc4695bSBarry Smith   ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)lg),&rank);CHKERRMPI(ierr);
4655c6c1daeSBarry Smith 
4665b399a63SLisandro Dalcin   draw = lg->win;
4675c6c1daeSBarry Smith   ierr = PetscDrawCheckResizedWindow(draw);CHKERRQ(ierr);
4685b399a63SLisandro Dalcin   ierr = PetscDrawClear(draw);CHKERRQ(ierr);
469e118a51fSLisandro Dalcin 
470e118a51fSLisandro Dalcin   xmin = lg->xmin; xmax = lg->xmax; ymin = lg->ymin; ymax = lg->ymax;
4715c6c1daeSBarry Smith   ierr = PetscDrawAxisSetLimits(lg->axis,xmin,xmax,ymin,ymax);CHKERRQ(ierr);
4725c6c1daeSBarry Smith   ierr = PetscDrawAxisDraw(lg->axis);CHKERRQ(ierr);
4735c6c1daeSBarry Smith 
4745b399a63SLisandro Dalcin   ierr = PetscDrawCollectiveBegin(draw);CHKERRQ(ierr);
4755c6c1daeSBarry Smith   if (!rank) {
476e118a51fSLisandro Dalcin     int i,j,dim=lg->dim,nopts=lg->nopts,cl;
4775c6c1daeSBarry Smith     for (i=0; i<dim; i++) {
4785c6c1daeSBarry Smith       for (j=1; j<nopts; j++) {
4790ed3bfb6SBarry Smith         cl   = lg->colors ? lg->colors[i] : ((PETSC_DRAW_BLACK + i) % PETSC_DRAW_MAXCOLOR);
4805c6c1daeSBarry Smith         ierr = PetscDrawLine(draw,lg->x[(j-1)*dim+i],lg->y[(j-1)*dim+i],lg->x[j*dim+i],lg->y[j*dim+i],cl);CHKERRQ(ierr);
48171917b75SLisandro Dalcin         if (lg->use_markers) {ierr = PetscDrawMarker(draw,lg->x[j*dim+i],lg->y[j*dim+i],cl);CHKERRQ(ierr);}
4825c6c1daeSBarry Smith       }
4835c6c1daeSBarry Smith     }
4845c6c1daeSBarry Smith   }
48556a02f31SLisandro Dalcin   if (!rank && lg->legend) {
486e118a51fSLisandro Dalcin     int       i,dim=lg->dim,cl;
4875c6c1daeSBarry Smith     PetscReal xl,yl,xr,yr,tw,th;
48871917b75SLisandro Dalcin     size_t    slen,len=0;
48971917b75SLisandro Dalcin     ierr = PetscDrawAxisGetLimits(lg->axis,&xl,&xr,&yl,&yr);CHKERRQ(ierr);
4905c6c1daeSBarry Smith     ierr = PetscDrawStringGetSize(draw,&tw,&th);CHKERRQ(ierr);
4915c6c1daeSBarry Smith     for (i=0; i<dim; i++) {
49271917b75SLisandro Dalcin       ierr = PetscStrlen(lg->legend[i],&slen);CHKERRQ(ierr);
49371917b75SLisandro Dalcin       len = PetscMax(len,slen);
4945c6c1daeSBarry Smith     }
49571917b75SLisandro Dalcin     xr = xr - 1.5*tw; xl = xr - (len + 7)*tw;
49671917b75SLisandro Dalcin     yr = yr - 1.0*th; yl = yr - (dim + 1)*th;
49771917b75SLisandro Dalcin     ierr = PetscDrawLine(draw,xl,yl,xr,yl,PETSC_DRAW_BLACK);CHKERRQ(ierr);
49871917b75SLisandro Dalcin     ierr = PetscDrawLine(draw,xr,yl,xr,yr,PETSC_DRAW_BLACK);CHKERRQ(ierr);
49971917b75SLisandro Dalcin     ierr = PetscDrawLine(draw,xr,yr,xl,yr,PETSC_DRAW_BLACK);CHKERRQ(ierr);
50071917b75SLisandro Dalcin     ierr = PetscDrawLine(draw,xl,yr,xl,yl,PETSC_DRAW_BLACK);CHKERRQ(ierr);
5015c6c1daeSBarry Smith     for  (i=0; i<dim; i++) {
50271917b75SLisandro Dalcin       cl   = lg->colors ? lg->colors[i] : (PETSC_DRAW_BLACK + i);
50371917b75SLisandro Dalcin       ierr = PetscDrawLine(draw,xl + 1*tw,yr - (i + 1)*th,xl + 5*tw,yr - (i + 1)*th,cl);CHKERRQ(ierr);
50471917b75SLisandro Dalcin       ierr = PetscDrawString(draw,xl + 6*tw,yr - (i + 1.5)*th,PETSC_DRAW_BLACK,lg->legend[i]);CHKERRQ(ierr);
5055c6c1daeSBarry Smith     }
5065c6c1daeSBarry Smith   }
507e118a51fSLisandro Dalcin   ierr = PetscDrawCollectiveEnd(draw);CHKERRQ(ierr);
5085b399a63SLisandro Dalcin 
5095b399a63SLisandro Dalcin   ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
510e118a51fSLisandro Dalcin   ierr = PetscDrawPause(draw);CHKERRQ(ierr);
5115c6c1daeSBarry Smith   PetscFunctionReturn(0);
5125c6c1daeSBarry Smith }
5135c6c1daeSBarry Smith 
51457fd6651SLisandro Dalcin /*@
51557fd6651SLisandro Dalcin   PetscDrawLGSave - Saves a drawn image
51657fd6651SLisandro Dalcin 
51757fd6651SLisandro Dalcin   Collective on PetscDrawLG
51857fd6651SLisandro Dalcin 
51957fd6651SLisandro Dalcin   Input Parameter:
52057fd6651SLisandro Dalcin . lg - The line graph context
52157fd6651SLisandro Dalcin 
52257fd6651SLisandro Dalcin   Level: intermediate
52357fd6651SLisandro Dalcin 
52457fd6651SLisandro Dalcin .seealso:  PetscDrawLGCreate(), PetscDrawLGGetDraw(), PetscDrawSetSave(), PetscDrawSave()
52557fd6651SLisandro Dalcin @*/
52657fd6651SLisandro Dalcin PetscErrorCode  PetscDrawLGSave(PetscDrawLG lg)
52757fd6651SLisandro Dalcin {
52857fd6651SLisandro Dalcin   PetscErrorCode ierr;
52957fd6651SLisandro Dalcin 
53057fd6651SLisandro Dalcin   PetscFunctionBegin;
53157fd6651SLisandro Dalcin   PetscValidHeaderSpecific(lg,PETSC_DRAWLG_CLASSID,1);
53257fd6651SLisandro Dalcin   ierr = PetscDrawSave(lg->win);CHKERRQ(ierr);
53357fd6651SLisandro Dalcin   PetscFunctionReturn(0);
53457fd6651SLisandro Dalcin }
53557fd6651SLisandro Dalcin 
5365c6c1daeSBarry Smith /*@
53734a5a0e3SBarry Smith   PetscDrawLGView - Prints a line graph.
5385c6c1daeSBarry Smith 
5395b399a63SLisandro Dalcin   Collective on PetscDrawLG
5405c6c1daeSBarry Smith 
5415c6c1daeSBarry Smith   Input Parameter:
5425c6c1daeSBarry Smith . lg - the line graph context
5435c6c1daeSBarry Smith 
5445c6c1daeSBarry Smith   Level: beginner
5455c6c1daeSBarry Smith 
546ba1e01c4SBarry Smith .seealso: PetscDrawLGCreate()
547ba1e01c4SBarry Smith 
5485c6c1daeSBarry Smith @*/
54934a5a0e3SBarry Smith PetscErrorCode  PetscDrawLGView(PetscDrawLG lg,PetscViewer viewer)
5505c6c1daeSBarry Smith {
5515c6c1daeSBarry Smith   PetscReal      xmin=lg->xmin, xmax=lg->xmax, ymin=lg->ymin, ymax=lg->ymax;
55234a5a0e3SBarry Smith   PetscInt       i, j, dim = lg->dim, nopts = lg->nopts;
55334a5a0e3SBarry Smith   PetscErrorCode ierr;
5545c6c1daeSBarry Smith 
5555c6c1daeSBarry Smith   PetscFunctionBegin;
5565c6c1daeSBarry Smith   PetscValidHeaderSpecific(lg,PETSC_DRAWLG_CLASSID,1);
557e118a51fSLisandro Dalcin 
5585c6c1daeSBarry Smith   if (nopts < 1)                  PetscFunctionReturn(0);
5595c6c1daeSBarry Smith   if (xmin > xmax || ymin > ymax) PetscFunctionReturn(0);
5605c6c1daeSBarry Smith 
56134a5a0e3SBarry Smith   if (!viewer){
56234a5a0e3SBarry Smith     ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)lg),&viewer);CHKERRQ(ierr);
56334a5a0e3SBarry Smith   }
56498c3331eSBarry Smith   ierr = PetscObjectPrintClassNamePrefixType((PetscObject)lg,viewer);CHKERRQ(ierr);
5655c6c1daeSBarry Smith   for (i = 0; i < dim; i++) {
56634a5a0e3SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer, "Line %D>\n", i);CHKERRQ(ierr);
5675c6c1daeSBarry Smith     for (j = 0; j < nopts; j++) {
56834a5a0e3SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer, "  X: %g Y: %g\n", (double)lg->x[j*dim+i], (double)lg->y[j*dim+i]);CHKERRQ(ierr);
5695c6c1daeSBarry Smith     }
5705c6c1daeSBarry Smith   }
5715c6c1daeSBarry Smith   PetscFunctionReturn(0);
5725c6c1daeSBarry Smith }
573287de1a7SBarry Smith 
574c2bac407SLisandro Dalcin /*@C
575c2bac407SLisandro Dalcin    PetscDrawLGSetOptionsPrefix - Sets the prefix used for searching for all
576c2bac407SLisandro Dalcin    PetscDrawLG options in the database.
577c2bac407SLisandro Dalcin 
578c2bac407SLisandro Dalcin    Logically Collective on PetscDrawLG
579c2bac407SLisandro Dalcin 
580c2bac407SLisandro Dalcin    Input Parameter:
581c2bac407SLisandro Dalcin +  lg - the line graph context
582c2bac407SLisandro Dalcin -  prefix - the prefix to prepend to all option names
583c2bac407SLisandro Dalcin 
584c2bac407SLisandro Dalcin    Level: advanced
585c2bac407SLisandro Dalcin 
586ba1e01c4SBarry Smith .seealso: PetscDrawLGSetFromOptions(), PetscDrawLGCreate()
587c2bac407SLisandro Dalcin @*/
588c2bac407SLisandro Dalcin PetscErrorCode  PetscDrawLGSetOptionsPrefix(PetscDrawLG lg,const char prefix[])
589c2bac407SLisandro Dalcin {
590c2bac407SLisandro Dalcin   PetscErrorCode ierr;
591c2bac407SLisandro Dalcin 
592c2bac407SLisandro Dalcin   PetscFunctionBegin;
593c2bac407SLisandro Dalcin   PetscValidHeaderSpecific(lg,PETSC_DRAWLG_CLASSID,1);
594c2bac407SLisandro Dalcin   ierr = PetscObjectSetOptionsPrefix((PetscObject)lg,prefix);CHKERRQ(ierr);
595c2bac407SLisandro Dalcin   PetscFunctionReturn(0);
596c2bac407SLisandro Dalcin }
597c2bac407SLisandro Dalcin 
598287de1a7SBarry Smith /*@
599287de1a7SBarry Smith     PetscDrawLGSetFromOptions - Sets options related to the PetscDrawLG
600287de1a7SBarry Smith 
6015b399a63SLisandro Dalcin     Collective on PetscDrawLG
602287de1a7SBarry Smith 
603287de1a7SBarry Smith     Options Database:
604287de1a7SBarry Smith 
605287de1a7SBarry Smith     Level: intermediate
606287de1a7SBarry Smith 
607287de1a7SBarry Smith .seealso:  PetscDrawLGDestroy(), PetscDrawLGCreate()
608287de1a7SBarry Smith @*/
609287de1a7SBarry Smith PetscErrorCode  PetscDrawLGSetFromOptions(PetscDrawLG lg)
610287de1a7SBarry Smith {
611287de1a7SBarry Smith   PetscErrorCode      ierr;
61271917b75SLisandro Dalcin   PetscBool           usemarkers,set;
61371917b75SLisandro Dalcin   PetscDrawMarkerType markertype;
614287de1a7SBarry Smith 
615287de1a7SBarry Smith   PetscFunctionBegin;
616e118a51fSLisandro Dalcin   PetscValidHeaderSpecific(lg,PETSC_DRAWLG_CLASSID,1);
617e118a51fSLisandro Dalcin 
61871917b75SLisandro Dalcin   ierr = PetscDrawGetMarkerType(lg->win,&markertype);CHKERRQ(ierr);
61971917b75SLisandro Dalcin   ierr = PetscOptionsGetEnum(((PetscObject)lg)->options,((PetscObject)lg)->prefix,"-lg_marker_type",PetscDrawMarkerTypes,(PetscEnum*)&markertype,&set);CHKERRQ(ierr);
62071917b75SLisandro Dalcin   if (set) {
62171917b75SLisandro Dalcin     ierr = PetscDrawLGSetUseMarkers(lg,PETSC_TRUE);CHKERRQ(ierr);
62271917b75SLisandro Dalcin     ierr = PetscDrawSetMarkerType(lg->win,markertype);CHKERRQ(ierr);
62371917b75SLisandro Dalcin   }
62471917b75SLisandro Dalcin   usemarkers = lg->use_markers;
62571917b75SLisandro Dalcin   ierr = PetscOptionsGetBool(((PetscObject)lg)->options,((PetscObject)lg)->prefix,"-lg_use_markers",&usemarkers,&set);CHKERRQ(ierr);
62671917b75SLisandro Dalcin   if (set) {ierr = PetscDrawLGSetUseMarkers(lg,usemarkers);CHKERRQ(ierr);}
627287de1a7SBarry Smith   PetscFunctionReturn(0);
628287de1a7SBarry Smith }
629