Actual source code: viewreg.c
petsc-3.9.4 2018-09-11
2: #include <petsc/private/viewerimpl.h>
3: #include <petsc/private/hash.h>
4: #if defined(PETSC_HAVE_SAWS)
5: #include <petscviewersaws.h>
6: #endif
8: PetscFunctionList PetscViewerList = 0;
11: PetscOptionsHelpPrinted PetscOptionsHelpPrintedSingleton = NULL;
12: KHASH_SET_INIT_STR(HTPrinted)
13: struct _n_PetscOptionsHelpPrinted{
14: khash_t(HTPrinted) *printed;
15: PetscSegBuffer strings;
16: };
18: PetscErrorCode PetscOptionsHelpPrintedDestroy(PetscOptionsHelpPrinted *hp)
19: {
23: if (!*hp) return(0);
24: kh_destroy(HTPrinted,(*hp)->printed);
25: PetscSegBufferDestroy(&(*hp)->strings);
26: PetscFree(*hp);
27: return(0);
28: }
30: /*@C
31: PetscOptionsHelpPrintedCreate - Creates an object used to manage tracking which help messages have
32: been printed so they will not be printed again.
34: Not collective
36: Level: developer
38: .seealso: PetscOptionsHelpPrintedCheck(), PetscOptionsHelpPrintChecked()
39: @*/
40: PetscErrorCode PetscOptionsHelpPrintedCreate(PetscOptionsHelpPrinted *hp)
41: {
42: PetscErrorCode ierr;
45: PetscNew(hp);
46: (*hp)->printed = kh_init(HTPrinted);
47: PetscSegBufferCreate(sizeof(char),10000,&(*hp)->strings);
48: return(0);
49: }
51: /*@C
52: PetscOptionsHelpPrintedCheck - Checks if a particular pre, name pair has previous been entered (meaning the help message was printed)
54: Not collective
56: Input Parameters:
57: + hp - the object used to manage tracking what help messages have been printed
58: . pre - the prefix part of the string, many be NULL
59: - name - the string to look for (cannot be NULL)
61: Output Parameter:
62: . found - PETSC_TRUE if the string was already set
64: Level: intermediate
67: .seealso: PetscOptionsHelpPrintedCreate()
68: @*/
69: PetscErrorCode PetscOptionsHelpPrintedCheck(PetscOptionsHelpPrinted hp,const char *pre,const char* name,PetscBool *found)
70: {
71: size_t l1,l2;
72: #if !defined(PETSC_HAVE_THREADSAFETY)
73: char *both;
74: khint_t newitem;
75: #endif
76: PetscErrorCode ierr;
79: PetscStrlen(pre,&l1);
80: PetscStrlen(name,&l2);
81: if (l1+l2 == 0) {
82: *found = PETSC_FALSE;
83: return(0);
84: }
85: #if !defined(PETSC_HAVE_THREADSAFETY)
86: PetscSegBufferGet(hp->strings,l1+l2+1,&both);
87: PetscStrcpy(both,pre);
88: PetscStrcat(both,name);
89: kh_put(HTPrinted,hp->printed,both,&newitem);
90: if (!newitem) {
91: PetscSegBufferUnuse(hp->strings,l1+l2+1);
92: }
93: *found = newitem ? PETSC_FALSE : PETSC_TRUE;
94: #else
95: *found = PETSC_FALSE;
96: #endif
97: return(0);
98: }
100: static PetscBool noviewer = PETSC_FALSE;
101: static PetscBool noviewers[PETSCVIEWERGETVIEWEROFFPUSHESMAX];
102: static PetscInt inoviewers = 0;
104: /*@
105: PetscOptionsPushGetViewerOff - control whether PetscOptionsGetViewer returns a viewer.
107: Logically Collective
109: Input Parameter:
110: . flg - PETSC_TRUE to turn off viewer creation, PETSC_FALSE to turn it on.
112: Level: developer
114: Notes: Calling XXXViewFromOptions in an inner loop can be very expensive. This can appear, for example, when using
115: many small subsolves. Call this function to control viewer creation in PetscOptionsGetViewer, thus removing the expensive XXXViewFromOptions calls.
117: .seealso: PetscOptionsGetViewer(), PetscOptionsPopGetViewerOff()
118: @*/
119: PetscErrorCode PetscOptionsPushGetViewerOff(PetscBool flg)
120: {
122: if (inoviewers > PETSCVIEWERGETVIEWEROFFPUSHESMAX - 1) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many PetscOptionsPushGetViewerOff(), perhaps you forgot PetscOptionsPopGetViewerOff()?");
124: noviewers[inoviewers++] = noviewer;
125: noviewer = flg;
126: return(0);
127: }
129: /*@
130: PetscOptionsPopGetViewerOff - reset whether PetscOptionsGetViewer returns a viewer.
132: Logically Collective
134: Level: developer
136: Notes: Calling XXXViewFromOptions in an inner loop can be very expensive. This can appear, for example, when using
137: many small subsolves. Call this function to control viewer creation in PetscOptionsGetViewer, thus removing the expensive XXXViewFromOptions calls.
139: .seealso: PetscOptionsGetViewer(), PetscOptionsPushGetViewerOff()
140: @*/
141: PetscErrorCode PetscOptionsPopGetViewerOff(void)
142: {
144: if (!inoviewers) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many PetscOptionsPopGetViewerOff(), perhaps you forgot PetscOptionsPushGetViewerOff()?");
145: noviewer = noviewers[--inoviewers];
146: return(0);
147: }
149: /*@
150: PetscOptionsGetViewerOff - does PetscOptionsGetViewer return a viewer?
152: Logically Collective
154: Output Parameter:
155: . flg - whether viewers are returned.
157: Level: developer
159: Notes: Calling XXXViewFromOptions in an inner loop can be very expensive. This can appear, for example, when using
160: many small subsolves.
162: .seealso: PetscOptionsGetViewer(), PetscOptionsPushGetViewerOff(), PetscOptionsPopGetViewerOff()
163: @*/
164: PetscErrorCode PetscOptionsGetViewerOff(PetscBool *flg)
165: {
168: *flg = noviewer;
169: return(0);
170: }
172: /*@C
173: PetscOptionsGetViewer - Gets a viewer appropriate for the type indicated by the user
175: Collective on MPI_Comm
177: Input Parameters:
178: + comm - the communicator to own the viewer
179: . pre - the string to prepend to the name or NULL
180: - name - the option one is seeking
182: Output Parameter:
183: + viewer - the viewer, pass NULL if not needed
184: . format - the PetscViewerFormat requested by the user, pass NULL if not needed
185: - set - PETSC_TRUE if found, else PETSC_FALSE
187: Level: intermediate
189: Notes: If no value is provided ascii:stdout is used
190: $ ascii[:[filename][:[format][:append]]] defaults to stdout - format can be one of ascii_info, ascii_info_detail, or ascii_matlab,
191: for example ascii::ascii_info prints just the information about the object not all details
192: unless :append is given filename opens in write mode, overwriting what was already there
193: $ binary[:[filename][:[format][:append]]] defaults to the file binaryoutput
194: $ draw[:drawtype[:filename]] for example, draw:tikz, draw:tikz:figure.tex or draw:x
195: $ socket[:port] defaults to the standard output port
196: $ saws[:communicatorname] publishes object to the Scientific Application Webserver (SAWs)
198: Use PetscViewerDestroy() after using the viewer, otherwise a memory leak will occur
200: You can control whether calls to this function create a viewer (or return early with *set of PETSC_FALSE) with
201: PetscOptionsPushGetViewerOff. This is useful if calling many small subsolves, in which case XXXViewFromOptions can take
202: an appreciable fraction of the runtime.
204: If PETSc is configured with --with-viewfromoptions=0 this function always returns with *set of PETSC_FALSE
206: .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(),
207: PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool()
208: PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(),
209: PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
210: PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
211: PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
212: PetscOptionsFList(), PetscOptionsEList(), PetscOptionsPushGetViewerOff(), PetscOptionsPopGetViewerOff(),
213: PetscOptionsGetViewerOff()
214: @*/
215: PetscErrorCode PetscOptionsGetViewer(MPI_Comm comm,const char pre[],const char name[],PetscViewer *viewer,PetscViewerFormat *format,PetscBool *set)
216: {
217: char *value;
218: PetscErrorCode ierr;
219: PetscBool flag,hashelp;
224: if (set) *set = PETSC_FALSE;
225: #if defined(PETSC_SKIP_VIEWFROMOPTIONS)
226: return(0);
227: #endif
228: PetscOptionsGetViewerOff(&flag);
229: if (flag) return(0);
231: PetscOptionsHasName(NULL,NULL,"-help",&hashelp);
232: if (hashelp) {
233: PetscBool found;
235: if (!PetscOptionsHelpPrintedSingleton) {
236: PetscOptionsHelpPrintedCreate(&PetscOptionsHelpPrintedSingleton);
237: }
238: PetscOptionsHelpPrintedCheck(PetscOptionsHelpPrintedSingleton,pre,name,&found);
239: if (!found) {
240: if (viewer) {
241: (*PetscHelpPrintf)(comm,"\n -%s%s ascii[:[filename][:[format][:append]]]: %s (%s)\n",pre ? pre : "",name+1,"Prints object to stdout or ASCII file","PetscOptionsGetViewer");
242: (*PetscHelpPrintf)(comm," -%s%s binary[:[filename][:[format][:append]]]: %s (%s)\n",pre ? pre : "",name+1,"Saves object to a binary file","PetscOptionsGetViewer");
243: (*PetscHelpPrintf)(comm," -%s%s draw[:[drawtype][:filename|format]] %s (%s)\n",pre ? pre : "",name+1,"Draws object","PetscOptionsGetViewer");
244: (*PetscHelpPrintf)(comm," -%s%s socket[:port]: %s (%s)\n",pre ? pre : "",name+1,"Pushes object to a Unix socket","PetscOptionsGetViewer");
245: (*PetscHelpPrintf)(comm," -%s%s saws[:communicatorname]: %s (%s)\n\n",pre ? pre : "",name+1,"Publishes object to SAWs","PetscOptionsGetViewer");
246: } else {
247: (*PetscHelpPrintf)(comm," -%s%s\n",pre ? pre : "",name+1);
248: }
249: }
250: }
252: if (format) *format = PETSC_VIEWER_DEFAULT;
253: PetscOptionsFindPair_Private(NULL,pre,name,&value,&flag);
254: if (flag) {
255: if (set) *set = PETSC_TRUE;
256: if (!value) {
257: if (viewer) {
258: PetscViewerASCIIGetStdout(comm,viewer);
259: PetscObjectReference((PetscObject)*viewer);
260: }
261: } else {
262: char *loc0_vtype,*loc1_fname,*loc2_fmt = NULL,*loc3_fmode = NULL;
263: PetscInt cnt;
264: const char *viewers[] = {PETSCVIEWERASCII,PETSCVIEWERBINARY,PETSCVIEWERDRAW,PETSCVIEWERSOCKET,PETSCVIEWERMATLAB,PETSCVIEWERSAWS,PETSCVIEWERVTK,PETSCVIEWERHDF5,PETSCVIEWERGLVIS,0};
266: PetscStrallocpy(value,&loc0_vtype);
267: PetscStrchr(loc0_vtype,':',&loc1_fname);
268: if (loc1_fname) {
269: *loc1_fname++ = 0;
270: PetscStrchr(loc1_fname,':',&loc2_fmt);
271: }
272: if (loc2_fmt) {
273: *loc2_fmt++ = 0;
274: PetscStrchr(loc2_fmt,':',&loc3_fmode);
275: }
276: if (loc3_fmode) *loc3_fmode++ = 0;
277: PetscStrendswithwhich(*loc0_vtype ? loc0_vtype : "ascii",viewers,&cnt);
278: if (cnt > (PetscInt) sizeof(viewers)-1) SETERRQ1(comm,PETSC_ERR_ARG_OUTOFRANGE,"Unknown viewer type: %s",loc0_vtype);
279: if (viewer) {
280: if (!loc1_fname) {
281: switch (cnt) {
282: case 0:
283: PetscViewerASCIIGetStdout(comm,viewer);
284: break;
285: case 1:
286: if (!(*viewer = PETSC_VIEWER_BINARY_(comm))) CHKERRQ(PETSC_ERR_PLIB);
287: break;
288: case 2:
289: if (!(*viewer = PETSC_VIEWER_DRAW_(comm))) CHKERRQ(PETSC_ERR_PLIB);
290: break;
291: #if defined(PETSC_USE_SOCKET_VIEWER)
292: case 3:
293: if (!(*viewer = PETSC_VIEWER_SOCKET_(comm))) CHKERRQ(PETSC_ERR_PLIB);
294: break;
295: #endif
296: #if defined(PETSC_HAVE_MATLAB_ENGINE)
297: case 4:
298: if (!(*viewer = PETSC_VIEWER_MATLAB_(comm))) CHKERRQ(PETSC_ERR_PLIB);
299: break;
300: #endif
301: #if defined(PETSC_HAVE_SAWS)
302: case 5:
303: if (!(*viewer = PETSC_VIEWER_SAWS_(comm))) CHKERRQ(PETSC_ERR_PLIB);
304: break;
305: #endif
306: #if defined(PETSC_HAVE_HDF5)
307: case 7:
308: if (!(*viewer = PETSC_VIEWER_HDF5_(comm))) CHKERRQ(PETSC_ERR_PLIB);
309: break;
310: #endif
311: case 8:
312: if (!(*viewer = PETSC_VIEWER_GLVIS_(comm))) CHKERRQ(PETSC_ERR_PLIB);
313: break;
314: default: SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Unsupported viewer %s",loc0_vtype);
315: }
316: PetscObjectReference((PetscObject)*viewer);
317: } else {
318: if (loc2_fmt && !*loc1_fname && (cnt == 0)) { /* ASCII format without file name */
319: PetscViewerASCIIGetStdout(comm,viewer);
320: PetscObjectReference((PetscObject)*viewer);
321: } else {
322: PetscFileMode fmode;
323: PetscViewerCreate(comm,viewer);
324: PetscViewerSetType(*viewer,*loc0_vtype ? loc0_vtype : "ascii");
325: fmode = FILE_MODE_WRITE;
326: if (loc3_fmode && *loc3_fmode) { /* Has non-empty file mode ("write" or "append") */
327: PetscEnumFind(PetscFileModes,loc3_fmode,(PetscEnum*)&fmode,&flag);
328: if (!flag) SETERRQ1(comm,PETSC_ERR_ARG_UNKNOWN_TYPE,"Unknown file mode: %s",loc3_fmode);
329: }
330: if (loc2_fmt) {
331: PetscBool tk,im;
332: PetscStrcmp(loc1_fname,"tikz",&tk);
333: PetscStrcmp(loc1_fname,"image",&im);
334: if (tk || im) {
335: PetscViewerDrawSetInfo(*viewer,NULL,loc2_fmt,PETSC_DECIDE,PETSC_DECIDE,PETSC_DECIDE,PETSC_DECIDE);
336: *loc2_fmt = 0;
337: }
338: }
339: PetscViewerFileSetMode(*viewer,flag?fmode:FILE_MODE_WRITE);
340: PetscViewerFileSetName(*viewer,loc1_fname);
341: if (*loc1_fname) {
342: PetscViewerDrawSetDrawType(*viewer,loc1_fname);
343: }
344: }
345: }
346: }
347: if (viewer) {
348: PetscViewerSetUp(*viewer);
349: }
350: if (loc2_fmt && *loc2_fmt) {
351: PetscViewerFormat tfmt;
353: PetscEnumFind(PetscViewerFormats,loc2_fmt,(PetscEnum*)&tfmt,&flag);
354: if (format) *format = tfmt;
355: if (!flag) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Unknown viewer format %s",loc2_fmt);
356: } else if (viewer && (cnt == 6) && format) { /* Get format from VTK viewer */
357: PetscViewerGetFormat(*viewer,format);
358: }
359: PetscFree(loc0_vtype);
360: }
361: }
362: return(0);
363: }
365: /*@
366: PetscViewerCreate - Creates a viewing context
368: Collective on MPI_Comm
370: Input Parameter:
371: . comm - MPI communicator
373: Output Parameter:
374: . inviewer - location to put the PetscViewer context
376: Level: advanced
378: Concepts: graphics^creating PetscViewer
379: Concepts: file input/output^creating PetscViewer
380: Concepts: sockets^creating PetscViewer
382: .seealso: PetscViewerDestroy(), PetscViewerSetType(), PetscViewerType
384: @*/
385: PetscErrorCode PetscViewerCreate(MPI_Comm comm,PetscViewer *inviewer)
386: {
387: PetscViewer viewer;
391: *inviewer = 0;
392: PetscViewerInitializePackage();
393: PetscHeaderCreate(viewer,PETSC_VIEWER_CLASSID,"PetscViewer","PetscViewer","Viewer",comm,PetscViewerDestroy,NULL);
394: *inviewer = viewer;
395: viewer->data = 0;
396: return(0);
397: }
399: /*@C
400: PetscViewerSetType - Builds PetscViewer for a particular implementation.
402: Collective on PetscViewer
404: Input Parameter:
405: + viewer - the PetscViewer context
406: - type - for example, PETSCVIEWERASCII
408: Options Database Command:
409: . -draw_type <type> - Sets the type; use -help for a list
410: of available methods (for instance, ascii)
412: Level: advanced
414: Notes:
415: See "include/petscviewer.h" for available methods (for instance,
416: PETSCVIEWERSOCKET)
418: .seealso: PetscViewerCreate(), PetscViewerGetType(), PetscViewerType, PetscViewerPushFormat()
419: @*/
420: PetscErrorCode PetscViewerSetType(PetscViewer viewer,PetscViewerType type)
421: {
422: PetscErrorCode ierr,(*r)(PetscViewer);
423: PetscBool match;
428: PetscObjectTypeCompare((PetscObject)viewer,type,&match);
429: if (match) return(0);
431: /* cleanup any old type that may be there */
432: if (viewer->data) {
433: (*viewer->ops->destroy)(viewer);
435: viewer->ops->destroy = NULL;
436: viewer->data = 0;
437: }
438: PetscMemzero(viewer->ops,sizeof(struct _PetscViewerOps));
440: PetscFunctionListFind(PetscViewerList,type,&r);
441: if (!r) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE,"Unknown PetscViewer type given: %s",type);
443: PetscObjectChangeTypeName((PetscObject)viewer,type);
444: (*r)(viewer);
445: return(0);
446: }
448: /*@C
449: PetscViewerRegister - Adds a viewer
451: Not Collective
453: Input Parameters:
454: + name_solver - name of a new user-defined viewer
455: - routine_create - routine to create method context
457: Level: developer
458: Notes:
459: PetscViewerRegister() may be called multiple times to add several user-defined viewers.
461: Sample usage:
462: .vb
463: PetscViewerRegister("my_viewer_type",MyViewerCreate);
464: .ve
466: Then, your solver can be chosen with the procedural interface via
467: $ PetscViewerSetType(viewer,"my_viewer_type")
468: or at runtime via the option
469: $ -viewer_type my_viewer_type
471: Concepts: registering^Viewers
473: .seealso: PetscViewerRegisterAll(), PetscViewerRegisterDestroy()
474: @*/
475: PetscErrorCode PetscViewerRegister(const char *sname,PetscErrorCode (*function)(PetscViewer))
476: {
480: PetscFunctionListAdd(&PetscViewerList,sname,function);
481: return(0);
482: }
484: /*@C
485: PetscViewerSetFromOptions - Sets the graphics type from the options database.
486: Defaults to a PETSc X windows graphics.
488: Collective on PetscViewer
490: Input Parameter:
491: . PetscViewer - the graphics context
493: Level: intermediate
495: Notes:
496: Must be called after PetscViewerCreate() before the PetscViewer is used.
498: Concepts: PetscViewer^setting options
500: .seealso: PetscViewerCreate(), PetscViewerSetType(), PetscViewerType
502: @*/
503: PetscErrorCode PetscViewerSetFromOptions(PetscViewer viewer)
504: {
505: PetscErrorCode ierr;
506: char vtype[256];
507: PetscBool flg;
512: if (!PetscViewerList) {
513: PetscViewerRegisterAll();
514: }
515: PetscObjectOptionsBegin((PetscObject)viewer);
516: PetscOptionsFList("-viewer_type","Type of PetscViewer","None",PetscViewerList,(char*)(((PetscObject)viewer)->type_name ? ((PetscObject)viewer)->type_name : PETSCVIEWERASCII),vtype,256,&flg);
517: if (flg) {
518: PetscViewerSetType(viewer,vtype);
519: }
520: /* type has not been set? */
521: if (!((PetscObject)viewer)->type_name) {
522: PetscViewerSetType(viewer,PETSCVIEWERASCII);
523: }
524: if (viewer->ops->setfromoptions) {
525: (*viewer->ops->setfromoptions)(PetscOptionsObject,viewer);
526: }
528: /* process any options handlers added with PetscObjectAddOptionsHandler() */
529: PetscObjectProcessOptionsHandlers(PetscOptionsObject,(PetscObject)viewer);
530: PetscViewerViewFromOptions(viewer,NULL,"-viewer_view");
531: PetscOptionsEnd();
532: return(0);
533: }
535: PetscErrorCode PetscViewerFlowControlStart(PetscViewer viewer,PetscInt *mcnt,PetscInt *cnt)
536: {
539: PetscViewerBinaryGetFlowControl(viewer,mcnt);
540: PetscViewerBinaryGetFlowControl(viewer,cnt);
541: return(0);
542: }
544: PetscErrorCode PetscViewerFlowControlStepMaster(PetscViewer viewer,PetscInt i,PetscInt *mcnt,PetscInt cnt)
545: {
547: MPI_Comm comm;
550: PetscObjectGetComm((PetscObject)viewer,&comm);
551: if (i >= *mcnt) {
552: *mcnt += cnt;
553: MPI_Bcast(mcnt,1,MPIU_INT,0,comm);
554: }
555: return(0);
556: }
558: PetscErrorCode PetscViewerFlowControlEndMaster(PetscViewer viewer,PetscInt *mcnt)
559: {
561: MPI_Comm comm;
563: PetscObjectGetComm((PetscObject)viewer,&comm);
564: *mcnt = 0;
565: MPI_Bcast(mcnt,1,MPIU_INT,0,comm);
566: return(0);
567: }
569: PetscErrorCode PetscViewerFlowControlStepWorker(PetscViewer viewer,PetscMPIInt rank,PetscInt *mcnt)
570: {
572: MPI_Comm comm;
574: PetscObjectGetComm((PetscObject)viewer,&comm);
575: while (PETSC_TRUE) {
576: if (rank < *mcnt) break;
577: MPI_Bcast(mcnt,1,MPIU_INT,0,comm);
578: }
579: return(0);
580: }
582: PetscErrorCode PetscViewerFlowControlEndWorker(PetscViewer viewer,PetscInt *mcnt)
583: {
585: MPI_Comm comm;
587: PetscObjectGetComm((PetscObject)viewer,&comm);
588: while (PETSC_TRUE) {
589: MPI_Bcast(mcnt,1,MPIU_INT,0,comm);
590: if (!*mcnt) break;
591: }
592: return(0);
593: }