Actual source code: viewreg.c
1: /*$Id: viewreg.c,v 1.36 2001/06/21 21:15:13 bsmith Exp bsmith $*/
3: #include "src/sys/src/viewer/viewerimpl.h" /*I "petsc.h" I*/
5: PetscFList PetscViewerList = 0;
9: /*@C
10: PetscViewerCreate - Creates a viewing context
12: Collective on MPI_Comm
14: Input Parameter:
15: . comm - MPI communicator
17: Output Parameter:
18: . inviewer - location to put the PetscViewer context
20: Level: advanced
22: Concepts: graphics^creating PetscViewer
23: Concepts: file input/output^creating PetscViewer
24: Concepts: sockets^creating PetscViewer
26: .seealso: PetscViewerDestroy(), PetscViewerSetType()
28: @*/
29: int PetscViewerCreate(MPI_Comm comm,PetscViewer *inviewer)
30: {
31: PetscViewer viewer;
34: *inviewer = 0;
35: PetscHeaderCreate(viewer,_p_PetscViewer,struct _PetscViewerOps,PETSC_VIEWER_COOKIE,-1,"PetscViewer",comm,PetscViewerDestroy,0);
36: PetscLogObjectCreate(viewer);
37: *inviewer = viewer;
38: viewer->type = -1;
39: viewer->data = 0;
40: return(0);
41: }
42:
45: /*@C
46: PetscViewerSetType - Builds PetscViewer for a particular implementation.
48: Collective on PetscViewer
50: Input Parameter:
51: + viewer - the PetscViewer context
52: - type - for example, "ASCII"
54: Options Database Command:
55: . -draw_type <type> - Sets the type; use -help for a list
56: of available methods (for instance, ascii)
58: Level: advanced
60: Notes:
61: See "include/petscviewer.h" for available methods (for instance,
62: PETSC_VIEWER_SOCKET)
64: .seealso: PetscViewerCreate(), PetscViewerGetType()
65: @*/
66: int PetscViewerSetType(PetscViewer viewer,const PetscViewerType type)
67: {
68: int ierr,(*r)(PetscViewer);
69: PetscTruth match;
75: PetscTypeCompare((PetscObject)viewer,type,&match);
76: if (match) return(0);
78: if (viewer->data) {
79: /* destroy the old private PetscViewer context */
80: (*viewer->ops->destroy)(viewer);
81: viewer->data = 0;
82: }
83: /* Get the function pointers for the graphics method requested */
84: if (!PetscViewerList) SETERRQ(1,"No PetscViewer implementations registered");
86: PetscFListFind(viewer->comm,PetscViewerList,type,(void (**)(void)) &r);
88: if (!r) SETERRQ1(1,"Unknown PetscViewer type given: %s",type);
90: viewer->data = 0;
91: PetscMemzero(viewer->ops,sizeof(struct _PetscViewerOps));
92: (*r)(viewer);
94: PetscObjectChangeTypeName((PetscObject)viewer,type);
96: return(0);
97: }
101: /*@C
102: PetscViewerRegisterDestroy - Frees the list of PetscViewer methods that were
103: registered by PetscViewerRegisterDynamic().
105: Not Collective
107: Level: developer
109: .seealso: PetscViewerRegisterDynamic(), PetscViewerRegisterAll()
110: @*/
111: int PetscViewerRegisterDestroy(void)
112: {
116: if (PetscViewerList) {
117: PetscFListDestroy(&PetscViewerList);
118: PetscViewerList = 0;
119: }
120: return(0);
121: }
125: int PetscViewerRegister(const char *sname,const char *path,const char *name,int (*function)(PetscViewer))
126: {
127: int ierr;
128: char fullname[PETSC_MAX_PATH_LEN];
131: PetscFListConcat(path,name,fullname);
132: PetscFListAdd(&PetscViewerList,sname,fullname,(void (*)(void))function);
133: return(0);
134: }
138: /*@C
139: PetscViewerSetFromOptions - Sets the graphics type from the options database.
140: Defaults to a PETSc X windows graphics.
142: Collective on PetscViewer
144: Input Parameter:
145: . PetscViewer - the graphics context
147: Level: intermediate
149: Notes:
150: Must be called after PetscViewerCreate() before the PetscViewer is used.
152: Concepts: PetscViewer^setting options
154: .seealso: PetscViewerCreate(), PetscViewerSetType()
156: @*/
157: int PetscViewerSetFromOptions(PetscViewer viewer)
158: {
159: int ierr;
160: char vtype[256];
161: PetscTruth flg;
166: if (!PetscViewerList) SETERRQ(1,"No PetscViewer implementations registered");
167: PetscOptionsBegin(viewer->comm,viewer->prefix,"PetscViewer options","PetscViewer");
168: PetscOptionsList("-viewer_type","Type of PetscViewer","None",PetscViewerList,(char *)(viewer->type_name?viewer->type_name:PETSC_VIEWER_ASCII),vtype,256,&flg);
169: if (flg) {
170: PetscViewerSetType(viewer,vtype);
171: }
172: /* type has not been set? */
173: if (!viewer->type_name) {
174: PetscViewerSetType(viewer,PETSC_VIEWER_ASCII);
175: }
176: if (viewer->ops->setfromoptions) {
177: (*viewer->ops->setfromoptions)(viewer);
178: }
179: PetscOptionsEnd();
181: return(0);
182: }