1 2 #include <petsc-private/viewerimpl.h> /*I "petscviewer.h" I*/ 3 #if defined(PETSC_HAVE_AMS) 4 #include <petscviewerams.h> 5 #endif 6 7 PetscFunctionList PetscViewerList = 0; 8 9 #undef __FUNCT__ 10 #define __FUNCT__ "PetscOptionsGetViewer" 11 /*@C 12 PetscOptionsGetViewer - Gets a viewer appropriate for the type indicated by the user 13 14 Collective on MPI_Comm 15 16 Input Parameters: 17 + comm - the communicator to own the viewer 18 . pre - the string to prepend to the name or NULL 19 - name - the option one is seeking 20 21 Output Parameter: 22 + viewer - the viewer 23 . format - the PetscViewerFormat requested by the user 24 - set - PETSC_TRUE if found, else PETSC_FALSE 25 26 Level: intermediate 27 28 Notes: If no value is provided ascii:stdout is used 29 $ ascii[:[filename][:[format][:append]]] defaults to stdout - format can be one of ascii_info, ascii_info_detail, or ascii_matlab, for example ascii::ascii_info prints just the info 30 $ about the object to standard out - unless :append is given filename opens in write mode 31 $ binary[:[filename][:[format][:append]]] defaults to binaryoutput 32 $ draw 33 $ socket[:port] defaults to the standard output port 34 $ ams[:communicatorname] publishes object to the AMS (Argonne Memory Snooper) 35 36 Use PetscViewerDestroy() after using the viewer, otherwise a memory leak will occur 37 38 .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), 39 PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool() 40 PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(), 41 PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 42 PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 43 PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 44 PetscOptionsList(), PetscOptionsEList() 45 @*/ 46 PetscErrorCode PetscOptionsGetViewer(MPI_Comm comm,const char pre[],const char name[],PetscViewer *viewer,PetscViewerFormat *format,PetscBool *set) 47 { 48 char *value; 49 PetscErrorCode ierr; 50 PetscBool flag; 51 52 PetscFunctionBegin; 53 PetscValidCharPointer(name,3); 54 55 if (format) *format = PETSC_VIEWER_DEFAULT; 56 if (set) *set = PETSC_FALSE; 57 ierr = PetscOptionsFindPair_Private(pre,name,&value,&flag);CHKERRQ(ierr); 58 if (flag) { 59 if (set) *set = PETSC_TRUE; 60 if (!value) { 61 ierr = PetscViewerASCIIGetStdout(comm,viewer);CHKERRQ(ierr); 62 ierr = PetscObjectReference((PetscObject)*viewer);CHKERRQ(ierr); 63 } else { 64 char *loc0_vtype,*loc1_fname,*loc2_fmt = NULL,*loc3_fmode = NULL; 65 PetscInt cnt; 66 const char *viewers[] = {PETSCVIEWERASCII,PETSCVIEWERBINARY,PETSCVIEWERDRAW,PETSCVIEWERSOCKET,PETSCVIEWERMATLAB,PETSCVIEWERAMS,PETSCVIEWERVTK,0}; 67 68 ierr = PetscStrallocpy(value,&loc0_vtype);CHKERRQ(ierr); 69 ierr = PetscStrchr(loc0_vtype,':',&loc1_fname);CHKERRQ(ierr); 70 if (loc1_fname) { 71 *loc1_fname++ = 0; 72 ierr = PetscStrchr(loc1_fname,':',&loc2_fmt);CHKERRQ(ierr); 73 } 74 if (loc2_fmt) { 75 *loc2_fmt++ = 0; 76 ierr = PetscStrchr(loc2_fmt,':',&loc3_fmode);CHKERRQ(ierr); 77 } 78 if (loc3_fmode) *loc3_fmode++ = 0; 79 ierr = PetscStrendswithwhich(*loc0_vtype ? loc0_vtype : "ascii",viewers,&cnt);CHKERRQ(ierr); 80 if (cnt > (PetscInt) sizeof(viewers)-1) SETERRQ1(comm,PETSC_ERR_ARG_OUTOFRANGE,"Unknown viewer type: %s",loc0_vtype); 81 if (!loc1_fname) { 82 switch (cnt) { 83 case 0: 84 ierr = PetscViewerASCIIGetStdout(comm,viewer);CHKERRQ(ierr); 85 break; 86 case 1: 87 if (!(*viewer = PETSC_VIEWER_BINARY_(comm))) CHKERRQ(PETSC_ERR_PLIB); 88 break; 89 case 2: 90 if (!(*viewer = PETSC_VIEWER_DRAW_(comm))) CHKERRQ(PETSC_ERR_PLIB); 91 break; 92 #if defined(PETSC_USE_SOCKET_VIEWER) 93 case 3: 94 if (!(*viewer = PETSC_VIEWER_SOCKET_(comm))) CHKERRQ(PETSC_ERR_PLIB); 95 break; 96 #endif 97 #if defined(PETSC_HAVE_MATLAB_ENGINE) 98 case 4: 99 if (!(*viewer = PETSC_VIEWER_MATLAB_(comm))) CHKERRQ(PETSC_ERR_PLIB); 100 break; 101 #endif 102 #if defined(PETSC_HAVE_AMS) 103 case 5: 104 if (!(*viewer = PETSC_VIEWER_AMS_(comm))) CHKERRQ(PETSC_ERR_PLIB); 105 break; 106 #endif 107 default: SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Unsupported viewer %s",loc0_vtype); 108 } 109 ierr = PetscObjectReference((PetscObject)*viewer);CHKERRQ(ierr); 110 } else { 111 if (loc2_fmt && !*loc1_fname && (cnt == 0)) { /* ASCII format without file name */ 112 ierr = PetscViewerASCIIGetStdout(comm,viewer);CHKERRQ(ierr); 113 ierr = PetscObjectReference((PetscObject)*viewer);CHKERRQ(ierr); 114 } else { 115 PetscFileMode fmode; 116 ierr = PetscViewerCreate(comm,viewer);CHKERRQ(ierr); 117 ierr = PetscViewerSetType(*viewer,*loc0_vtype ? loc0_vtype : "ascii");CHKERRQ(ierr); 118 #if defined(PETSC_HAVE_AMS) 119 ierr = PetscViewerAMSSetCommName(*viewer,loc1_fname);CHKERRQ(ierr); 120 #endif 121 fmode = FILE_MODE_WRITE; 122 if (loc3_fmode && *loc3_fmode) { /* Has non-empty file mode ("write" or "append") */ 123 ierr = PetscEnumFind(PetscFileModes,loc3_fmode,(PetscEnum*)&fmode,&flag);CHKERRQ(ierr); 124 if (!flag) SETERRQ1(comm,PETSC_ERR_ARG_UNKNOWN_TYPE,"Unknown file mode: %s",loc3_fmode); 125 } 126 ierr = PetscViewerFileSetMode(*viewer,flag?fmode:FILE_MODE_WRITE);CHKERRQ(ierr); 127 ierr = PetscViewerFileSetName(*viewer,loc1_fname);CHKERRQ(ierr); 128 } 129 } 130 if (loc2_fmt && *loc2_fmt) { 131 ierr = PetscEnumFind(PetscViewerFormats,loc2_fmt,(PetscEnum*)format,&flag);CHKERRQ(ierr); 132 if (!flag) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Unknown viewer format %s",loc2_fmt);CHKERRQ(ierr); 133 } 134 ierr = PetscViewerSetUp(*viewer);CHKERRQ(ierr); 135 ierr = PetscFree(loc0_vtype);CHKERRQ(ierr); 136 } 137 } 138 PetscFunctionReturn(0); 139 } 140 141 #undef __FUNCT__ 142 #define __FUNCT__ "PetscViewerCreate" 143 /*@ 144 PetscViewerCreate - Creates a viewing context 145 146 Collective on MPI_Comm 147 148 Input Parameter: 149 . comm - MPI communicator 150 151 Output Parameter: 152 . inviewer - location to put the PetscViewer context 153 154 Level: advanced 155 156 Concepts: graphics^creating PetscViewer 157 Concepts: file input/output^creating PetscViewer 158 Concepts: sockets^creating PetscViewer 159 160 .seealso: PetscViewerDestroy(), PetscViewerSetType(), PetscViewerType 161 162 @*/ 163 PetscErrorCode PetscViewerCreate(MPI_Comm comm,PetscViewer *inviewer) 164 { 165 PetscViewer viewer; 166 PetscErrorCode ierr; 167 168 PetscFunctionBegin; 169 *inviewer = 0; 170 #if !defined(PETSC_USE_DYNAMIC_LIBRARIES) 171 ierr = PetscViewerInitializePackage();CHKERRQ(ierr); 172 #endif 173 ierr = PetscHeaderCreate(viewer,_p_PetscViewer,struct _PetscViewerOps,PETSC_VIEWER_CLASSID,"PetscViewer","PetscViewer","Viewer",comm,PetscViewerDestroy,0);CHKERRQ(ierr); 174 *inviewer = viewer; 175 viewer->data = 0; 176 PetscFunctionReturn(0); 177 } 178 179 #undef __FUNCT__ 180 #define __FUNCT__ "PetscViewerSetType" 181 /*@C 182 PetscViewerSetType - Builds PetscViewer for a particular implementation. 183 184 Collective on PetscViewer 185 186 Input Parameter: 187 + viewer - the PetscViewer context 188 - type - for example, "ASCII" 189 190 Options Database Command: 191 . -draw_type <type> - Sets the type; use -help for a list 192 of available methods (for instance, ascii) 193 194 Level: advanced 195 196 Notes: 197 See "include/petscviewer.h" for available methods (for instance, 198 PETSC_VIEWER_SOCKET) 199 200 .seealso: PetscViewerCreate(), PetscViewerGetType(), PetscViewerType 201 @*/ 202 PetscErrorCode PetscViewerSetType(PetscViewer viewer,PetscViewerType type) 203 { 204 PetscErrorCode ierr,(*r)(PetscViewer); 205 PetscBool match; 206 207 PetscFunctionBegin; 208 PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1); 209 PetscValidCharPointer(type,2); 210 ierr = PetscObjectTypeCompare((PetscObject)viewer,type,&match);CHKERRQ(ierr); 211 if (match) PetscFunctionReturn(0); 212 213 /* cleanup any old type that may be there */ 214 if (viewer->data) { 215 ierr = (*viewer->ops->destroy)(viewer);CHKERRQ(ierr); 216 217 viewer->ops->destroy = NULL; 218 viewer->data = 0; 219 } 220 ierr = PetscMemzero(viewer->ops,sizeof(struct _PetscViewerOps));CHKERRQ(ierr); 221 222 ierr = PetscFunctionListFind(PetscViewerList,type,&r);CHKERRQ(ierr); 223 if (!r) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE,"Unknown PetscViewer type given: %s",type); 224 225 ierr = PetscObjectChangeTypeName((PetscObject)viewer,type);CHKERRQ(ierr); 226 ierr = (*r)(viewer);CHKERRQ(ierr); 227 PetscFunctionReturn(0); 228 } 229 230 #undef __FUNCT__ 231 #define __FUNCT__ "PetscViewerRegisterDestroy" 232 /*@C 233 PetscViewerRegisterDestroy - Frees the list of PetscViewer methods that were 234 registered by PetscViewerRegister(). 235 236 Not Collective 237 238 Level: developer 239 240 .seealso: PetscViewerRegister(), PetscViewerRegisterAll() 241 @*/ 242 PetscErrorCode PetscViewerRegisterDestroy(void) 243 { 244 PetscErrorCode ierr; 245 246 PetscFunctionBegin; 247 ierr = PetscFunctionListDestroy(&PetscViewerList);CHKERRQ(ierr); 248 PetscFunctionReturn(0); 249 } 250 251 #undef __FUNCT__ 252 #define __FUNCT__ "PetscViewerRegister" 253 /*@C 254 PetscViewerRegister - Adds a viewer 255 256 Not Collective 257 258 Input Parameters: 259 + name_solver - name of a new user-defined viewer 260 - routine_create - routine to create method context 261 262 Level: developer 263 Notes: 264 PetscViewerRegister() may be called multiple times to add several user-defined viewers. 265 266 Sample usage: 267 .vb 268 PetscViewerRegister("my_viewer_type",MyViewerCreate); 269 .ve 270 271 Then, your solver can be chosen with the procedural interface via 272 $ PetscViewerSetType(viewer,"my_viewer_type") 273 or at runtime via the option 274 $ -viewer_type my_viewer_type 275 276 Concepts: registering^Viewers 277 278 .seealso: PetscViewerRegisterAll(), PetscViewerRegisterDestroy() 279 @*/ 280 PetscErrorCode PetscViewerRegister(const char *sname,PetscErrorCode (*function)(PetscViewer)) 281 { 282 PetscErrorCode ierr; 283 284 PetscFunctionBegin; 285 ierr = PetscFunctionListAdd(&PetscViewerList,sname,function);CHKERRQ(ierr); 286 PetscFunctionReturn(0); 287 } 288 289 #undef __FUNCT__ 290 #define __FUNCT__ "PetscViewerSetFromOptions" 291 /*@C 292 PetscViewerSetFromOptions - Sets the graphics type from the options database. 293 Defaults to a PETSc X windows graphics. 294 295 Collective on PetscViewer 296 297 Input Parameter: 298 . PetscViewer - the graphics context 299 300 Level: intermediate 301 302 Notes: 303 Must be called after PetscViewerCreate() before the PetscViewer is used. 304 305 Concepts: PetscViewer^setting options 306 307 .seealso: PetscViewerCreate(), PetscViewerSetType(), PetscViewerType 308 309 @*/ 310 PetscErrorCode PetscViewerSetFromOptions(PetscViewer viewer) 311 { 312 PetscErrorCode ierr; 313 char vtype[256]; 314 PetscBool flg; 315 316 PetscFunctionBegin; 317 PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1); 318 319 if (!PetscViewerList) { 320 ierr = PetscViewerRegisterAll();CHKERRQ(ierr); 321 } 322 ierr = PetscObjectOptionsBegin((PetscObject)viewer);CHKERRQ(ierr); 323 ierr = PetscOptionsList("-viewer_type","Type of PetscViewer","None",PetscViewerList,(char*)(((PetscObject)viewer)->type_name ? ((PetscObject)viewer)->type_name : PETSCVIEWERASCII),vtype,256,&flg);CHKERRQ(ierr); 324 if (flg) { 325 ierr = PetscViewerSetType(viewer,vtype);CHKERRQ(ierr); 326 } 327 /* type has not been set? */ 328 if (!((PetscObject)viewer)->type_name) { 329 ierr = PetscViewerSetType(viewer,PETSCVIEWERASCII);CHKERRQ(ierr); 330 } 331 if (viewer->ops->setfromoptions) { 332 ierr = (*viewer->ops->setfromoptions)(viewer);CHKERRQ(ierr); 333 } 334 335 /* process any options handlers added with PetscObjectAddOptionsHandler() */ 336 ierr = PetscObjectProcessOptionsHandlers((PetscObject)viewer);CHKERRQ(ierr); 337 ierr = PetscOptionsEnd();CHKERRQ(ierr); 338 PetscFunctionReturn(0); 339 } 340