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,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 == 4) SETERRQ1(comm,PETSC_ERR_ARG_OUTOFRANGE,"Unknown viewer type: %s",cvalue); 67 if (!loc) { 68 if (cnt == 0) { 69 ierr = PetscViewerASCIIGetStdout(comm,viewer);CHKERRQ(ierr); 70 } 71 if (cnt == 1) { 72 *viewer = PETSC_VIEWER_BINARY_(comm);CHKERRQ(ierr); 73 } 74 if (cnt == 2) { 75 *viewer = PETSC_VIEWER_DRAW_(comm);CHKERRQ(ierr); 76 } 77 if (cnt == 3) { 78 *viewer = PETSC_VIEWER_SOCKET_(comm);CHKERRQ(ierr); 79 } 80 } else { 81 ierr = PetscStrchr(loc,':',&loc2);CHKERRQ(ierr); 82 if (loc2) {*loc2 = 0; loc2++;} 83 if (loc2 && !*loc) { /* ASCII format without file name */ 84 ierr = PetscViewerASCIIGetStdout(comm,viewer);CHKERRQ(ierr); 85 } else { 86 ierr = PetscViewerCreate(comm,viewer);CHKERRQ(ierr); 87 ierr = PetscViewerSetType(*viewer,*cvalue ? cvalue : "ascii");CHKERRQ(ierr); 88 ierr = PetscViewerFileSetMode(*viewer,FILE_MODE_WRITE);CHKERRQ(ierr); 89 ierr = PetscViewerFileSetName(*viewer,loc);CHKERRQ(ierr); 90 ierr = PetscObjectComposeFunction((PetscObject)*viewer,"PetscOptionsDestroyViewer","PetscViewerDestroy",(void (*)(void))PetscViewerDestroy);CHKERRQ(ierr); 91 } 92 } 93 ierr = PetscFree(cvalue);CHKERRQ(ierr); 94 ierr = PetscViewerSetUp(*viewer);CHKERRQ(ierr); 95 } 96 } 97 PetscFunctionReturn(0); 98 } 99 100 #undef __FUNCT__ 101 #define __FUNCT__ "PetscOptionsRestoreViewer" 102 /*@C 103 PetscOptionsRestoresViewer - Restores a viewer obtained with PetscOptionsGetViewer() 104 105 Collective on PetscViewer 106 107 Input Parameters: 108 . viewer - the viewer 109 110 Level: intermediate 111 112 .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), 113 PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool() 114 PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(), 115 PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 116 PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 117 PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 118 PetscOptionsList(), PetscOptionsEList(), PetscOptionsRestoreViewer() 119 @*/ 120 PetscErrorCode PetscOptionsRestoreViewer(PetscViewer viewer) 121 { 122 PetscErrorCode ierr,(*f)(PetscViewer*); 123 124 PetscFunctionBegin; 125 ierr = PetscObjectQueryFunction((PetscObject)viewer,"PetscOptionsDestroyViewer",(void (**)(void))&f);CHKERRQ(ierr); 126 if (f) { 127 ierr = (*f)(&viewer);CHKERRQ(ierr); 128 } 129 PetscFunctionReturn(0); 130 } 131 132 #undef __FUNCT__ 133 #define __FUNCT__ "PetscViewerCreate" 134 /*@ 135 PetscViewerCreate - Creates a viewing context 136 137 Collective on MPI_Comm 138 139 Input Parameter: 140 . comm - MPI communicator 141 142 Output Parameter: 143 . inviewer - location to put the PetscViewer context 144 145 Level: advanced 146 147 Concepts: graphics^creating PetscViewer 148 Concepts: file input/output^creating PetscViewer 149 Concepts: sockets^creating PetscViewer 150 151 .seealso: PetscViewerDestroy(), PetscViewerSetType(), PetscViewerType 152 153 @*/ 154 PetscErrorCode PetscViewerCreate(MPI_Comm comm,PetscViewer *inviewer) 155 { 156 PetscViewer viewer; 157 PetscErrorCode ierr; 158 159 PetscFunctionBegin; 160 *inviewer = 0; 161 #if !defined(PETSC_USE_DYNAMIC_LIBRARIES) 162 ierr = PetscViewerInitializePackage(PETSC_NULL);CHKERRQ(ierr); 163 #endif 164 ierr = PetscHeaderCreate(viewer,_p_PetscViewer,struct _PetscViewerOps,PETSC_VIEWER_CLASSID,-1,"PetscViewer","PetscViewer","Viewer",comm,PetscViewerDestroy,0);CHKERRQ(ierr); 165 *inviewer = viewer; 166 viewer->data = 0; 167 PetscFunctionReturn(0); 168 } 169 170 #undef __FUNCT__ 171 #define __FUNCT__ "PetscViewerSetType" 172 /*@C 173 PetscViewerSetType - Builds PetscViewer for a particular implementation. 174 175 Collective on PetscViewer 176 177 Input Parameter: 178 + viewer - the PetscViewer context 179 - type - for example, "ASCII" 180 181 Options Database Command: 182 . -draw_type <type> - Sets the type; use -help for a list 183 of available methods (for instance, ascii) 184 185 Level: advanced 186 187 Notes: 188 See "include/petscviewer.h" for available methods (for instance, 189 PETSC_VIEWER_SOCKET) 190 191 .seealso: PetscViewerCreate(), PetscViewerGetType(), PetscViewerType 192 @*/ 193 PetscErrorCode PetscViewerSetType(PetscViewer viewer,PetscViewerType type) 194 { 195 PetscErrorCode ierr,(*r)(PetscViewer); 196 PetscBool match; 197 198 PetscFunctionBegin; 199 PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1); 200 PetscValidCharPointer(type,2); 201 CHKMEMQ; 202 ierr = PetscObjectTypeCompare((PetscObject)viewer,type,&match);CHKERRQ(ierr); 203 if (match) PetscFunctionReturn(0); 204 205 /* cleanup any old type that may be there */ 206 if (viewer->data) { 207 ierr = (*viewer->ops->destroy)(viewer);CHKERRQ(ierr); 208 viewer->ops->destroy = PETSC_NULL; 209 viewer->data = 0; 210 } 211 ierr = PetscMemzero(viewer->ops,sizeof(struct _PetscViewerOps));CHKERRQ(ierr); 212 213 ierr = PetscFListFind(PetscViewerList,((PetscObject)viewer)->comm,type,PETSC_TRUE,(void (**)(void)) &r);CHKERRQ(ierr); 214 if (!r) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE,"Unknown PetscViewer type given: %s",type); 215 216 ierr = PetscObjectChangeTypeName((PetscObject)viewer,type);CHKERRQ(ierr); 217 ierr = (*r)(viewer);CHKERRQ(ierr); 218 PetscFunctionReturn(0); 219 } 220 221 #undef __FUNCT__ 222 #define __FUNCT__ "PetscViewerRegisterDestroy" 223 /*@C 224 PetscViewerRegisterDestroy - Frees the list of PetscViewer methods that were 225 registered by PetscViewerRegisterDynamic(). 226 227 Not Collective 228 229 Level: developer 230 231 .seealso: PetscViewerRegisterDynamic(), PetscViewerRegisterAll() 232 @*/ 233 PetscErrorCode PetscViewerRegisterDestroy(void) 234 { 235 PetscErrorCode ierr; 236 237 PetscFunctionBegin; 238 ierr = PetscFListDestroy(&PetscViewerList);CHKERRQ(ierr); 239 PetscFunctionReturn(0); 240 } 241 242 #undef __FUNCT__ 243 #define __FUNCT__ "PetscViewerRegister" 244 PetscErrorCode PetscViewerRegister(const char *sname,const char *path,const char *name,PetscErrorCode (*function)(PetscViewer)) 245 { 246 PetscErrorCode ierr; 247 char fullname[PETSC_MAX_PATH_LEN]; 248 249 PetscFunctionBegin; 250 ierr = PetscFListConcat(path,name,fullname);CHKERRQ(ierr); 251 ierr = PetscFListAdd(&PetscViewerList,sname,fullname,(void (*)(void))function);CHKERRQ(ierr); 252 PetscFunctionReturn(0); 253 } 254 255 #undef __FUNCT__ 256 #define __FUNCT__ "PetscViewerSetFromOptions" 257 /*@C 258 PetscViewerSetFromOptions - Sets the graphics type from the options database. 259 Defaults to a PETSc X windows graphics. 260 261 Collective on PetscViewer 262 263 Input Parameter: 264 . PetscViewer - the graphics context 265 266 Level: intermediate 267 268 Notes: 269 Must be called after PetscViewerCreate() before the PetscViewer is used. 270 271 Concepts: PetscViewer^setting options 272 273 .seealso: PetscViewerCreate(), PetscViewerSetType(), PetscViewerType 274 275 @*/ 276 PetscErrorCode PetscViewerSetFromOptions(PetscViewer viewer) 277 { 278 PetscErrorCode ierr; 279 char vtype[256]; 280 PetscBool flg; 281 282 PetscFunctionBegin; 283 PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1); 284 285 if (!PetscViewerList) { 286 ierr = PetscViewerRegisterAll(PETSC_NULL);CHKERRQ(ierr); 287 } 288 ierr = PetscObjectOptionsBegin((PetscObject)viewer);CHKERRQ(ierr); 289 ierr = PetscOptionsList("-viewer_type","Type of PetscViewer","None",PetscViewerList,(char *)(((PetscObject)viewer)->type_name?((PetscObject)viewer)->type_name:PETSCVIEWERASCII),vtype,256,&flg);CHKERRQ(ierr); 290 if (flg) { 291 ierr = PetscViewerSetType(viewer,vtype);CHKERRQ(ierr); 292 } 293 /* type has not been set? */ 294 if (!((PetscObject)viewer)->type_name) { 295 ierr = PetscViewerSetType(viewer,PETSCVIEWERASCII);CHKERRQ(ierr); 296 } 297 if (viewer->ops->setfromoptions) { 298 ierr = (*viewer->ops->setfromoptions)(viewer);CHKERRQ(ierr); 299 } 300 301 /* process any options handlers added with PetscObjectAddOptionsHandler() */ 302 ierr = PetscObjectProcessOptionsHandlers((PetscObject)viewer);CHKERRQ(ierr); 303 ierr = PetscOptionsEnd();CHKERRQ(ierr); 304 305 PetscFunctionReturn(0); 306 } 307