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