1 2 /* 3 Provides the registration process for PETSc PetscDraw routines 4 */ 5 #include <petsc/private/drawimpl.h> /*I "petscdraw.h" I*/ 6 #include <petscviewer.h> /*I "petscviewer.h" I*/ 7 #if defined(PETSC_HAVE_SAWS) 8 #include <petscviewersaws.h> 9 #endif 10 11 /* 12 Contains the list of registered PetscDraw routines 13 */ 14 PetscFunctionList PetscDrawList = 0; 15 16 #undef __FUNCT__ 17 #define __FUNCT__ "PetscDrawView" 18 /*@C 19 PetscDrawView - Prints the PetscDraw data structure. 20 21 Collective on PetscDraw 22 23 Input Parameters: 24 + indraw - the PetscDraw context 25 - viewer - visualization context 26 27 See PetscDrawSetFromOptions() for options database keys 28 29 Note: 30 The available visualization contexts include 31 + PETSC_VIEWER_STDOUT_SELF - standard output (default) 32 - PETSC_VIEWER_STDOUT_WORLD - synchronized standard 33 output where only the first processor opens 34 the file. All other processors send their 35 data to the first processor to print. 36 37 The user can open an alternative visualization context with 38 PetscViewerASCIIOpen() - output to a specified file. 39 40 Level: beginner 41 42 .keywords: PetscDraw, view 43 44 .seealso: PCView(), PetscViewerASCIIOpen() 45 @*/ 46 PetscErrorCode PetscDrawView(PetscDraw indraw,PetscViewer viewer) 47 { 48 PetscErrorCode ierr; 49 PetscBool isdraw; 50 #if defined(PETSC_HAVE_SAWS) 51 PetscBool issaws; 52 #endif 53 54 PetscFunctionBegin; 55 PetscValidHeaderSpecific(indraw,PETSC_DRAW_CLASSID,1); 56 if (!viewer) { 57 ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)indraw),&viewer);CHKERRQ(ierr); 58 } 59 PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 60 PetscCheckSameComm(indraw,1,viewer,2); 61 62 ierr = PetscObjectPrintClassNamePrefixType((PetscObject)indraw,viewer);CHKERRQ(ierr); 63 ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr); 64 #if defined(PETSC_HAVE_SAWS) 65 ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSAWS,&issaws);CHKERRQ(ierr); 66 #endif 67 if (isdraw) { 68 PetscDraw draw; 69 char str[36]; 70 PetscReal x,y,bottom,h; 71 72 ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr); 73 ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr); 74 ierr = PetscStrcpy(str,"PetscDraw: ");CHKERRQ(ierr); 75 ierr = PetscStrcat(str,((PetscObject)indraw)->type_name);CHKERRQ(ierr); 76 ierr = PetscDrawStringBoxed(draw,x,y,PETSC_DRAW_RED,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr); 77 bottom = y - h; 78 ierr = PetscDrawPushCurrentPoint(draw,x,bottom);CHKERRQ(ierr); 79 #if defined(PETSC_HAVE_SAWS) 80 } else if (issaws) { 81 PetscMPIInt rank; 82 83 ierr = PetscObjectName((PetscObject)indraw);CHKERRQ(ierr); 84 ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr); 85 if (!((PetscObject)indraw)->amsmem && !rank) { 86 ierr = PetscObjectViewSAWs((PetscObject)indraw,viewer);CHKERRQ(ierr); 87 } 88 #endif 89 } else if (indraw->ops->view) { 90 ierr = (*indraw->ops->view)(indraw,viewer);CHKERRQ(ierr); 91 } 92 PetscFunctionReturn(0); 93 } 94 95 #undef __FUNCT__ 96 #define __FUNCT__ "PetscDrawCreate" 97 /*@C 98 PetscDrawCreate - Creates a graphics context. 99 100 Collective on MPI_Comm 101 102 Input Parameter: 103 + comm - MPI communicator 104 . display - X display when using X windows 105 . title - optional title added to top of window 106 . x,y - coordinates of lower left corner of window or PETSC_DECIDE 107 - w, h - width and height of window or PETSC_DECIDE or PETSC_DRAW_HALF_SIZE, PETSC_DRAW_FULL_SIZE, 108 or PETSC_DRAW_THIRD_SIZE or PETSC_DRAW_QUARTER_SIZE 109 110 Output Parameter: 111 . draw - location to put the PetscDraw context 112 113 Level: beginner 114 115 Concepts: graphics^creating context 116 Concepts: drawing^creating context 117 118 .seealso: PetscDrawSetFromOptions(), PetscDrawDestroy(), PetscDrawSetType() 119 @*/ 120 PetscErrorCode PetscDrawCreate(MPI_Comm comm,const char display[],const char title[],int x,int y,int w,int h,PetscDraw *indraw) 121 { 122 PetscDraw draw; 123 PetscErrorCode ierr; 124 PetscReal dpause = 0.0; 125 PetscBool flag; 126 127 PetscFunctionBegin; 128 ierr = PetscDrawInitializePackage();CHKERRQ(ierr); 129 *indraw = 0; 130 ierr = PetscHeaderCreate(draw,PETSC_DRAW_CLASSID,"Draw","Graphics","Draw",comm,PetscDrawDestroy,PetscDrawView);CHKERRQ(ierr); 131 132 draw->data = NULL; 133 ierr = PetscStrallocpy(display,&draw->display);CHKERRQ(ierr); 134 ierr = PetscStrallocpy(title,&draw->title);CHKERRQ(ierr); 135 draw->x = x; 136 draw->y = y; 137 draw->w = w; 138 draw->h = h; 139 draw->pause = 0.0; 140 draw->coor_xl = 0.0; 141 draw->coor_xr = 1.0; 142 draw->coor_yl = 0.0; 143 draw->coor_yr = 1.0; 144 draw->port_xl = 0.0; 145 draw->port_xr = 1.0; 146 draw->port_yl = 0.0; 147 draw->port_yr = 1.0; 148 draw->popup = NULL; 149 150 ierr = PetscOptionsGetReal(NULL,NULL,"-draw_pause",&dpause,&flag);CHKERRQ(ierr); 151 if (flag) draw->pause = dpause; 152 draw->savefilename = NULL; 153 draw->savefilecount = 0; 154 draw->savefilemovie = PETSC_FALSE; 155 156 ierr = PetscDrawSetCurrentPoint(draw,.5,.9);CHKERRQ(ierr); 157 158 draw->boundbox_xl = .5; 159 draw->boundbox_xr = .5; 160 draw->boundbox_yl = .9; 161 draw->boundbox_yr = .9; 162 163 *indraw = draw; 164 PetscFunctionReturn(0); 165 } 166 167 #undef __FUNCT__ 168 #define __FUNCT__ "PetscDrawSetType" 169 /*@C 170 PetscDrawSetType - Builds graphics object for a particular implementation 171 172 Collective on PetscDraw 173 174 Input Parameter: 175 + draw - the graphics context 176 - type - for example, PETSC_DRAW_X 177 178 Options Database Command: 179 . -draw_type <type> - Sets the type; use -help for a list of available methods (for instance, x) 180 181 See PetscDrawSetFromOptions for additional options database keys 182 183 Level: intermediate 184 185 Notes: 186 See "petsc/include/petscdraw.h" for available methods (for instance, 187 PETSC_DRAW_X) 188 189 Concepts: drawing^X windows 190 Concepts: X windows^graphics 191 Concepts: drawing^Microsoft Windows 192 193 .seealso: PetscDrawSetFromOptions(), PetscDrawCreate(), PetscDrawDestroy() 194 @*/ 195 PetscErrorCode PetscDrawSetType(PetscDraw draw,PetscDrawType type) 196 { 197 PetscErrorCode ierr,(*r)(PetscDraw); 198 PetscBool match; 199 PetscBool flg=PETSC_FALSE; 200 201 PetscFunctionBegin; 202 PetscValidHeaderSpecific(draw,PETSC_DRAW_CLASSID,1); 203 PetscValidCharPointer(type,2); 204 205 ierr = PetscObjectTypeCompare((PetscObject)draw,type,&match);CHKERRQ(ierr); 206 if (match) PetscFunctionReturn(0); 207 208 /* User requests no graphics */ 209 ierr = PetscOptionsHasName(((PetscObject)draw)->options,NULL,"-nox",&flg);CHKERRQ(ierr); 210 211 /* 212 This is not ideal, but it allows codes to continue to run if X graphics 213 was requested but is not installed on this machine. Mostly this is for 214 testing. 215 */ 216 #if !defined(PETSC_HAVE_X) 217 if (!flg) { 218 ierr = PetscStrcmp(type,PETSC_DRAW_X,&match);CHKERRQ(ierr); 219 if (match) { 220 PetscBool dontwarn = PETSC_TRUE; 221 flg = PETSC_TRUE; 222 ierr = PetscOptionsHasName(NULL,NULL,"-nox_warning",&dontwarn);CHKERRQ(ierr); 223 if (!dontwarn) (*PetscErrorPrintf)("PETSc installed without X windows on this machine\nproceeding without graphics\n"); 224 } 225 } 226 #endif 227 if (flg) type = PETSC_DRAW_NULL; 228 229 ierr = PetscFunctionListFind(PetscDrawList,type,&r);CHKERRQ(ierr); 230 if (!r) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE,"Unknown PetscDraw type given: %s",type); 231 if (draw->ops->destroy) {ierr = (*draw->ops->destroy)(draw);CHKERRQ(ierr);} 232 ierr = PetscMemzero(draw->ops,sizeof(struct _PetscDrawOps));CHKERRQ(ierr); 233 ierr = PetscObjectChangeTypeName((PetscObject)draw,type);CHKERRQ(ierr); 234 ierr = (*r)(draw);CHKERRQ(ierr); 235 PetscFunctionReturn(0); 236 } 237 238 #undef __FUNCT__ 239 #define __FUNCT__ "PetscDrawGetType" 240 /*@C 241 PetscDrawGetType - Gets the PetscDraw type as a string from the PetscDraw object. 242 243 Not Collective 244 245 Input Parameter: 246 . draw - Krylov context 247 248 Output Parameters: 249 . name - name of PetscDraw method 250 251 Level: advanced 252 253 @*/ 254 PetscErrorCode PetscDrawGetType(PetscDraw draw,PetscDrawType *type) 255 { 256 PetscFunctionBegin; 257 PetscValidHeaderSpecific(draw,PETSC_DRAW_CLASSID,1); 258 PetscValidPointer(type,2); 259 *type = ((PetscObject)draw)->type_name; 260 PetscFunctionReturn(0); 261 } 262 263 #undef __FUNCT__ 264 #define __FUNCT__ "PetscDrawRegister" 265 /*@C 266 PetscDrawRegister - Adds a method to the graphics package. 267 268 Not Collective 269 270 Input Parameters: 271 + name_solver - name of a new user-defined graphics class 272 - routine_create - routine to create method context 273 274 Level: developer 275 276 Notes: 277 PetscDrawRegister() may be called multiple times to add several user-defined graphics classes 278 279 Sample usage: 280 .vb 281 PetscDrawRegister("my_draw_type", MyDrawCreate); 282 .ve 283 284 Then, your specific graphics package can be chosen with the procedural interface via 285 $ PetscDrawSetType(ksp,"my_draw_type") 286 or at runtime via the option 287 $ -draw_type my_draw_type 288 289 Concepts: graphics^registering new draw classes 290 Concepts: PetscDraw^registering new draw classes 291 292 .seealso: PetscDrawRegisterAll(), PetscDrawRegisterDestroy() 293 @*/ 294 PetscErrorCode PetscDrawRegister(const char *sname,PetscErrorCode (*function)(PetscDraw)) 295 { 296 PetscErrorCode ierr; 297 298 PetscFunctionBegin; 299 ierr = PetscFunctionListAdd(&PetscDrawList,sname,function);CHKERRQ(ierr); 300 PetscFunctionReturn(0); 301 } 302 303 #undef __FUNCT__ 304 #define __FUNCT__ "PetscDrawSetFromOptions" 305 /*@ 306 PetscDrawSetFromOptions - Sets the graphics type from the options database. 307 Defaults to a PETSc X windows graphics. 308 309 Collective on PetscDraw 310 311 Input Parameter: 312 . draw - the graphics context 313 314 Options Database Keys: 315 + -nox - do not use X graphics (ignore graphics calls, but run program correctly) 316 . -nox_warning - when X windows support is not installed this prevents the warning message from being printed 317 . -draw_pause <pause amount> -- -1 indicates wait for mouse input, -2 indicates pause when window is to be destroyed 318 . -draw_marker_type - <x,point> 319 . -draw_save [optional filename] - (X windows only) saves each image before it is cleared to a file 320 . -draw_save_final_image [optional filename] - (X windows only) saves the final image displayed in a window 321 . -draw_save_movie - converts image files to a movie at the end of the run. See PetscDrawSetSave() 322 - -draw_save_single_file - saves each new image in the same file, normally each new image is saved in a new file with filename_%d 323 324 Level: intermediate 325 326 Notes: 327 Must be called after PetscDrawCreate() before the PetscDraw is used. 328 329 Concepts: drawing^setting options 330 Concepts: graphics^setting options 331 332 .seealso: PetscDrawCreate(), PetscDrawSetType(), PetscDrawSetSave(), PetscDrawSetSaveFinalImage() 333 334 @*/ 335 PetscErrorCode PetscDrawSetFromOptions(PetscDraw draw) 336 { 337 PetscErrorCode ierr; 338 PetscBool flg,nox; 339 char vtype[256]; 340 const char *def; 341 #if !defined(PETSC_USE_WINDOWS_GRAPHICS) && !defined(PETSC_HAVE_X) 342 PetscBool warn; 343 #endif 344 345 PetscFunctionBegin; 346 PetscValidHeaderSpecific(draw,PETSC_DRAW_CLASSID,1); 347 348 ierr = PetscDrawRegisterAll();CHKERRQ(ierr); 349 350 if (((PetscObject)draw)->type_name) def = ((PetscObject)draw)->type_name; 351 else { 352 ierr = PetscOptionsHasName(((PetscObject)draw)->options,NULL,"-nox",&nox);CHKERRQ(ierr); 353 def = PETSC_DRAW_NULL; 354 #if defined(PETSC_USE_WINDOWS_GRAPHICS) 355 if (!nox) def = PETSC_DRAW_WIN32; 356 #elif defined(PETSC_HAVE_X) 357 if (!nox) def = PETSC_DRAW_X; 358 #elif defined(PETSC_HAVE_GLUT) 359 if (!nox) def = PETSC_DRAW_GLUT; 360 #elif defined(PETSC_HAVE_OPENGLES) 361 if (!nox) def = PETSC_DRAW_OPENGLES; 362 #else 363 ierr = PetscOptionsHasName(NULL,NULL,"-nox_warning",&warn);CHKERRQ(ierr); 364 if (!nox && !warn) (*PetscErrorPrintf)("PETSc installed without X windows, Microsoft Graphics, OpenGL ES, or GLUT/OpenGL on this machine\nproceeding without graphics\n"); 365 #endif 366 } 367 ierr = PetscObjectOptionsBegin((PetscObject)draw);CHKERRQ(ierr); 368 ierr = PetscOptionsFList("-draw_type","Type of graphical output","PetscDrawSetType",PetscDrawList,def,vtype,256,&flg);CHKERRQ(ierr); 369 if (flg) { 370 ierr = PetscDrawSetType(draw,vtype);CHKERRQ(ierr); 371 } else if (!((PetscObject)draw)->type_name) { 372 ierr = PetscDrawSetType(draw,def);CHKERRQ(ierr); 373 } 374 ierr = PetscOptionsName("-nox","Run without graphics","None",&nox);CHKERRQ(ierr); 375 #if defined(PETSC_HAVE_X) 376 { 377 char filename[PETSC_MAX_PATH_LEN]; 378 PetscBool save,movie = PETSC_FALSE; 379 ierr = PetscOptionsBool("-draw_save_movie","Make a movie from the images saved (X Windows only)","PetscDrawSetSave",movie,&movie,NULL);CHKERRQ(ierr); 380 ierr = PetscOptionsBool("-draw_save_single_file","Each new image replaces previous image in file","PetscDrawSetSave",draw->savesinglefile,&draw->savesinglefile,NULL);CHKERRQ(ierr); 381 ierr = PetscOptionsString("-draw_save","Save graphics to file (X Windows only)","PetscDrawSetSave",filename,filename,PETSC_MAX_PATH_LEN,&save);CHKERRQ(ierr); 382 if (save) { 383 ierr = PetscDrawSetSave(draw,filename,movie);CHKERRQ(ierr); 384 } 385 ierr = PetscOptionsString("-draw_save_final_image","Save graphics to file (X Windows only)","PetscDrawSetSaveFinalImage",filename,filename,PETSC_MAX_PATH_LEN,&save);CHKERRQ(ierr); 386 if (save) { 387 ierr = PetscDrawSetSaveFinalImage(draw,filename);CHKERRQ(ierr); 388 } 389 } 390 #endif 391 ierr = PetscOptionsReal("-draw_pause","Amount of time that program pauses after plots","PetscDrawSetPause",draw->pause,&draw->pause,NULL);CHKERRQ(ierr); 392 ierr = PetscOptionsEnum("-draw_marker_type","Type of marker to use on plots","PetscDrawSetMarkerType",PetscDrawMarkerTypes,(PetscEnum)draw->markertype,(PetscEnum *)&draw->markertype,NULL);CHKERRQ(ierr); 393 394 /* process any options handlers added with PetscObjectAddOptionsHandler() */ 395 ierr = PetscObjectProcessOptionsHandlers(PetscOptionsObject,(PetscObject)draw);CHKERRQ(ierr); 396 397 ierr = PetscDrawViewFromOptions(draw,NULL,"-draw_view");CHKERRQ(ierr); 398 ierr = PetscOptionsEnd();CHKERRQ(ierr); 399 PetscFunctionReturn(0); 400 } 401