Actual source code: viewreg.c
petsc-3.14.6 2021-03-30
2: #include <petsc/private/viewerimpl.h>
3: #include <petsc/private/hashtable.h>
4: #if defined(PETSC_HAVE_SAWS)
5: #include <petscviewersaws.h>
6: #endif
8: PetscFunctionList PetscViewerList = NULL;
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: int 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:
115: Calling XXXViewFromOptions in an inner loop can be very expensive. This can appear, for example, when using
116: many small subsolves. Call this function to control viewer creation in PetscOptionsGetViewer, thus removing the expensive XXXViewFromOptions calls.
118: .seealso: PetscOptionsGetViewer(), PetscOptionsPopGetViewerOff()
119: @*/
120: PetscErrorCode PetscOptionsPushGetViewerOff(PetscBool flg)
121: {
123: if (inoviewers > PETSCVIEWERGETVIEWEROFFPUSHESMAX - 1) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many PetscOptionsPushGetViewerOff(), perhaps you forgot PetscOptionsPopGetViewerOff()?");
125: noviewers[inoviewers++] = noviewer;
126: noviewer = flg;
127: return(0);
128: }
130: /*@
131: PetscOptionsPopGetViewerOff - reset whether PetscOptionsGetViewer returns a viewer.
133: Logically Collective
135: Level: developer
137: Notes:
138: Calling XXXViewFromOptions in an inner loop can be very expensive. This can appear, for example, when using
139: many small subsolves. Call this function to control viewer creation in PetscOptionsGetViewer, thus removing the expensive XXXViewFromOptions calls.
141: .seealso: PetscOptionsGetViewer(), PetscOptionsPushGetViewerOff()
142: @*/
143: PetscErrorCode PetscOptionsPopGetViewerOff(void)
144: {
146: if (!inoviewers) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many PetscOptionsPopGetViewerOff(), perhaps you forgot PetscOptionsPushGetViewerOff()?");
147: noviewer = noviewers[--inoviewers];
148: return(0);
149: }
151: /*@
152: PetscOptionsGetViewerOff - does PetscOptionsGetViewer return a viewer?
154: Logically Collective
156: Output Parameter:
157: . flg - whether viewers are returned.
159: Level: developer
161: Notes:
162: Calling XXXViewFromOptions in an inner loop can be very expensive. This can appear, for example, when using
163: many small subsolves.
165: .seealso: PetscOptionsGetViewer(), PetscOptionsPushGetViewerOff(), PetscOptionsPopGetViewerOff()
166: @*/
167: PetscErrorCode PetscOptionsGetViewerOff(PetscBool *flg)
168: {
171: *flg = noviewer;
172: return(0);
173: }
175: /*@C
176: PetscOptionsGetViewer - Gets a viewer appropriate for the type indicated by the user
178: Collective
180: Input Parameters:
181: + comm - the communicator to own the viewer
182: . pre - the string to prepend to the name or NULL
183: - name - the option one is seeking
185: Output Parameter:
186: + viewer - the viewer, pass NULL if not needed
187: . format - the PetscViewerFormat requested by the user, pass NULL if not needed
188: - set - PETSC_TRUE if found, else PETSC_FALSE
190: Level: intermediate
192: Notes:
193: If no value is provided ascii:stdout is used
194: $ ascii[:[filename][:[format][:append]]] defaults to stdout - format can be one of ascii_info, ascii_info_detail, or ascii_matlab,
195: for example ascii::ascii_info prints just the information about the object not all details
196: unless :append is given filename opens in write mode, overwriting what was already there
197: $ binary[:[filename][:[format][:append]]] defaults to the file binaryoutput
198: $ draw[:drawtype[:filename]] for example, draw:tikz, draw:tikz:figure.tex or draw:x
199: $ socket[:port] defaults to the standard output port
200: $ saws[:communicatorname] publishes object to the Scientific Application Webserver (SAWs)
202: Use PetscViewerDestroy() after using the viewer, otherwise a memory leak will occur
204: You can control whether calls to this function create a viewer (or return early with *set of PETSC_FALSE) with
205: PetscOptionsPushGetViewerOff. This is useful if calling many small subsolves, in which case XXXViewFromOptions can take
206: an appreciable fraction of the runtime.
208: If PETSc is configured with --with-viewfromoptions=0 this function always returns with *set of PETSC_FALSE
210: .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(),
211: PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool()
212: PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(),
213: PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
214: PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
215: PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
216: PetscOptionsFList(), PetscOptionsEList(), PetscOptionsPushGetViewerOff(), PetscOptionsPopGetViewerOff(),
217: PetscOptionsGetViewerOff()
218: @*/
219: PetscErrorCode PetscOptionsGetViewer(MPI_Comm comm,PetscOptions options,const char pre[],const char name[],PetscViewer *viewer,PetscViewerFormat *format,PetscBool *set)
220: {
221: const char *value;
222: PetscErrorCode ierr;
223: PetscBool flag,hashelp;
228: if (viewer) *viewer = NULL;
229: if (format) *format = PETSC_VIEWER_DEFAULT;
230: if (set) *set = PETSC_FALSE;
231: PetscOptionsGetViewerOff(&flag);
232: if (flag) return(0);
234: PetscOptionsHasHelp(NULL,&hashelp);
235: if (hashelp) {
236: PetscBool found;
238: if (!PetscOptionsHelpPrintedSingleton) {
239: PetscOptionsHelpPrintedCreate(&PetscOptionsHelpPrintedSingleton);
240: }
241: PetscOptionsHelpPrintedCheck(PetscOptionsHelpPrintedSingleton,pre,name,&found);
242: if (!found && viewer) {
243: (*PetscHelpPrintf)(comm,"----------------------------------------\nViewer (-%s%s) options:\n",pre ? pre : "",name+1);
244: (*PetscHelpPrintf)(comm," -%s%s ascii[:[filename][:[format][:append]]]: %s (%s)\n",pre ? pre : "",name+1,"Prints object to stdout or ASCII file","PetscOptionsGetViewer");
245: (*PetscHelpPrintf)(comm," -%s%s binary[:[filename][:[format][:append]]]: %s (%s)\n",pre ? pre : "",name+1,"Saves object to a binary file","PetscOptionsGetViewer");
246: (*PetscHelpPrintf)(comm," -%s%s draw[:[drawtype][:filename|format]] %s (%s)\n",pre ? pre : "",name+1,"Draws object","PetscOptionsGetViewer");
247: (*PetscHelpPrintf)(comm," -%s%s socket[:port]: %s (%s)\n",pre ? pre : "",name+1,"Pushes object to a Unix socket","PetscOptionsGetViewer");
248: (*PetscHelpPrintf)(comm," -%s%s saws[:communicatorname]: %s (%s)\n",pre ? pre : "",name+1,"Publishes object to SAWs","PetscOptionsGetViewer");
249: }
250: }
252: if (format) *format = PETSC_VIEWER_DEFAULT;
253: PetscOptionsFindPair(options,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,PETSCVIEWEREXODUSII,NULL};
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: #if defined(PETSC_HAVE_EXODUSII)
315: case 9:
316: if (!(*viewer = PETSC_VIEWER_EXODUSII_(comm))) CHKERRQ(PETSC_ERR_PLIB);
317: break;
318: #endif
319: default: SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Unsupported viewer %s",loc0_vtype);
320: }
321: PetscObjectReference((PetscObject)*viewer);
322: } else {
323: if (loc2_fmt && !*loc1_fname && (cnt == 0)) { /* ASCII format without file name */
324: PetscViewerASCIIGetStdout(comm,viewer);
325: PetscObjectReference((PetscObject)*viewer);
326: } else {
327: PetscFileMode fmode;
328: PetscViewerCreate(comm,viewer);
329: PetscViewerSetType(*viewer,*loc0_vtype ? loc0_vtype : "ascii");
330: fmode = FILE_MODE_WRITE;
331: if (loc3_fmode && *loc3_fmode) { /* Has non-empty file mode ("write" or "append") */
332: PetscEnumFind(PetscFileModes,loc3_fmode,(PetscEnum*)&fmode,&flag);
333: if (!flag) SETERRQ1(comm,PETSC_ERR_ARG_UNKNOWN_TYPE,"Unknown file mode: %s",loc3_fmode);
334: }
335: if (loc2_fmt) {
336: PetscBool tk,im;
337: PetscStrcmp(loc1_fname,"tikz",&tk);
338: PetscStrcmp(loc1_fname,"image",&im);
339: if (tk || im) {
340: PetscViewerDrawSetInfo(*viewer,NULL,loc2_fmt,PETSC_DECIDE,PETSC_DECIDE,PETSC_DECIDE,PETSC_DECIDE);
341: *loc2_fmt = 0;
342: }
343: }
344: PetscViewerFileSetMode(*viewer,flag?fmode:FILE_MODE_WRITE);
345: PetscViewerFileSetName(*viewer,loc1_fname);
346: if (*loc1_fname) {
347: PetscViewerDrawSetDrawType(*viewer,loc1_fname);
348: }
349: PetscViewerSetFromOptions(*viewer);
350: }
351: }
352: }
353: if (viewer) {
354: PetscViewerSetUp(*viewer);
355: }
356: if (loc2_fmt && *loc2_fmt) {
357: PetscViewerFormat tfmt;
359: PetscEnumFind(PetscViewerFormats,loc2_fmt,(PetscEnum*)&tfmt,&flag);
360: if (format) *format = tfmt;
361: if (!flag) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Unknown viewer format %s",loc2_fmt);
362: } else if (viewer && (cnt == 6) && format) { /* Get format from VTK viewer */
363: PetscViewerGetFormat(*viewer,format);
364: }
365: PetscFree(loc0_vtype);
366: }
367: }
368: return(0);
369: }
371: /*@
372: PetscViewerCreate - Creates a viewing context
374: Collective
376: Input Parameter:
377: . comm - MPI communicator
379: Output Parameter:
380: . inviewer - location to put the PetscViewer context
382: Level: advanced
384: .seealso: PetscViewerDestroy(), PetscViewerSetType(), PetscViewerType
386: @*/
387: PetscErrorCode PetscViewerCreate(MPI_Comm comm,PetscViewer *inviewer)
388: {
389: PetscViewer viewer;
393: *inviewer = NULL;
394: PetscViewerInitializePackage();
395: PetscHeaderCreate(viewer,PETSC_VIEWER_CLASSID,"PetscViewer","PetscViewer","Viewer",comm,PetscViewerDestroy,PetscViewerView);
396: *inviewer = viewer;
397: viewer->data = NULL;
398: return(0);
399: }
401: /*@C
402: PetscViewerSetType - Builds PetscViewer for a particular implementation.
404: Collective on PetscViewer
406: Input Parameter:
407: + viewer - the PetscViewer context
408: - type - for example, PETSCVIEWERASCII
410: Options Database Command:
411: . -viewer_type <type> - Sets the type; use -help for a list
412: of available methods (for instance, ascii)
414: Level: advanced
416: Notes:
417: See "include/petscviewer.h" for available methods (for instance,
418: PETSCVIEWERSOCKET)
420: .seealso: PetscViewerCreate(), PetscViewerGetType(), PetscViewerType, PetscViewerPushFormat()
421: @*/
422: PetscErrorCode PetscViewerSetType(PetscViewer viewer,PetscViewerType type)
423: {
424: PetscErrorCode ierr,(*r)(PetscViewer);
425: PetscBool match;
430: PetscObjectTypeCompare((PetscObject)viewer,type,&match);
431: if (match) return(0);
433: /* cleanup any old type that may be there */
434: if (viewer->data) {
435: (*viewer->ops->destroy)(viewer);
437: viewer->ops->destroy = NULL;
438: viewer->data = NULL;
439: }
440: PetscMemzero(viewer->ops,sizeof(struct _PetscViewerOps));
442: PetscFunctionListFind(PetscViewerList,type,&r);
443: if (!r) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE,"Unknown PetscViewer type given: %s",type);
445: PetscObjectChangeTypeName((PetscObject)viewer,type);
446: (*r)(viewer);
447: return(0);
448: }
450: /*@C
451: PetscViewerRegister - Adds a viewer
453: Not Collective
455: Input Parameters:
456: + name_solver - name of a new user-defined viewer
457: - routine_create - routine to create method context
459: Level: developer
460: Notes:
461: PetscViewerRegister() may be called multiple times to add several user-defined viewers.
463: Sample usage:
464: .vb
465: PetscViewerRegister("my_viewer_type",MyViewerCreate);
466: .ve
468: Then, your solver can be chosen with the procedural interface via
469: $ PetscViewerSetType(viewer,"my_viewer_type")
470: or at runtime via the option
471: $ -viewer_type my_viewer_type
473: .seealso: PetscViewerRegisterAll(), PetscViewerRegisterDestroy()
474: @*/
475: PetscErrorCode PetscViewerRegister(const char *sname,PetscErrorCode (*function)(PetscViewer))
476: {
480: PetscViewerInitializePackage();
481: PetscFunctionListAdd(&PetscViewerList,sname,function);
482: return(0);
483: }
485: /*@C
486: PetscViewerSetFromOptions - Sets the graphics type from the options database.
487: Defaults to a PETSc X windows graphics.
489: Collective on PetscViewer
491: Input Parameter:
492: . PetscViewer - the graphics context
494: Level: intermediate
496: Notes:
497: Must be called after PetscViewerCreate() before the PetscViewer is used.
499: .seealso: PetscViewerCreate(), PetscViewerSetType(), PetscViewerType
501: @*/
502: PetscErrorCode PetscViewerSetFromOptions(PetscViewer viewer)
503: {
504: PetscErrorCode ierr;
505: char vtype[256];
506: PetscBool flg;
511: if (!PetscViewerList) {
512: PetscViewerRegisterAll();
513: }
514: PetscObjectOptionsBegin((PetscObject)viewer);
515: PetscOptionsFList("-viewer_type","Type of PetscViewer","None",PetscViewerList,(char*)(((PetscObject)viewer)->type_name ? ((PetscObject)viewer)->type_name : PETSCVIEWERASCII),vtype,256,&flg);
516: if (flg) {
517: PetscViewerSetType(viewer,vtype);
518: }
519: /* type has not been set? */
520: if (!((PetscObject)viewer)->type_name) {
521: PetscViewerSetType(viewer,PETSCVIEWERASCII);
522: }
523: if (viewer->ops->setfromoptions) {
524: (*viewer->ops->setfromoptions)(PetscOptionsObject,viewer);
525: }
527: /* process any options handlers added with PetscObjectAddOptionsHandler() */
528: PetscObjectProcessOptionsHandlers(PetscOptionsObject,(PetscObject)viewer);
529: PetscViewerViewFromOptions(viewer,NULL,"-viewer_view");
530: PetscOptionsEnd();
531: return(0);
532: }
534: PetscErrorCode PetscViewerFlowControlStart(PetscViewer viewer,PetscInt *mcnt,PetscInt *cnt)
535: {
538: PetscViewerBinaryGetFlowControl(viewer,mcnt);
539: PetscViewerBinaryGetFlowControl(viewer,cnt);
540: return(0);
541: }
543: PetscErrorCode PetscViewerFlowControlStepMaster(PetscViewer viewer,PetscInt i,PetscInt *mcnt,PetscInt cnt)
544: {
546: MPI_Comm comm;
549: PetscObjectGetComm((PetscObject)viewer,&comm);
550: if (i >= *mcnt) {
551: *mcnt += cnt;
552: MPI_Bcast(mcnt,1,MPIU_INT,0,comm);
553: }
554: return(0);
555: }
557: PetscErrorCode PetscViewerFlowControlEndMaster(PetscViewer viewer,PetscInt *mcnt)
558: {
560: MPI_Comm comm;
562: PetscObjectGetComm((PetscObject)viewer,&comm);
563: *mcnt = 0;
564: MPI_Bcast(mcnt,1,MPIU_INT,0,comm);
565: return(0);
566: }
568: PetscErrorCode PetscViewerFlowControlStepWorker(PetscViewer viewer,PetscMPIInt rank,PetscInt *mcnt)
569: {
571: MPI_Comm comm;
573: PetscObjectGetComm((PetscObject)viewer,&comm);
574: while (PETSC_TRUE) {
575: if (rank < *mcnt) break;
576: MPI_Bcast(mcnt,1,MPIU_INT,0,comm);
577: }
578: return(0);
579: }
581: PetscErrorCode PetscViewerFlowControlEndWorker(PetscViewer viewer,PetscInt *mcnt)
582: {
584: MPI_Comm comm;
586: PetscObjectGetComm((PetscObject)viewer,&comm);
587: while (PETSC_TRUE) {
588: MPI_Bcast(mcnt,1,MPIU_INT,0,comm);
589: if (!*mcnt) break;
590: }
591: return(0);
592: }