Actual source code: viewreg.c

  1: #define PETSC_DLL

  3: #include "src/sys/viewer/viewerimpl.h"  /*I "petsc.h" I*/  

  5: PetscFList PetscViewerList              = 0;

  9: /*@
 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: PetscErrorCode  PetscViewerCreate(MPI_Comm comm,PetscViewer *inviewer)
 30: {
 31:   PetscViewer    viewer;

 35:   *inviewer = 0;
 36: #if !defined(PETSC_USE_DYNAMIC_LIBRARIES)
 37:   PetscViewerInitializePackage(PETSC_NULL);
 38: #endif
 39:   PetscHeaderCreate(viewer,_p_PetscViewer,struct _PetscViewerOps,PETSC_VIEWER_COOKIE,-1,"PetscViewer",comm,PetscViewerDestroy,0);
 40:   *inviewer           = viewer;
 41:   viewer->data        = 0;
 42:   return(0);
 43: }
 44: 
 47: /*@C
 48:    PetscViewerSetType - Builds PetscViewer for a particular implementation.

 50:    Collective on PetscViewer

 52:    Input Parameter:
 53: +  viewer      - the PetscViewer context
 54: -  type        - for example, "ASCII"

 56:    Options Database Command:
 57: .  -draw_type  <type> - Sets the type; use -help for a list 
 58:     of available methods (for instance, ascii)

 60:    Level: advanced

 62:    Notes:  
 63:    See "include/petscviewer.h" for available methods (for instance,
 64:    PETSC_VIEWER_SOCKET)

 66: .seealso: PetscViewerCreate(), PetscViewerGetType()
 67: @*/
 68: PetscErrorCode  PetscViewerSetType(PetscViewer viewer,PetscViewerType type)
 69: {
 70:   PetscErrorCode ierr,(*r)(PetscViewer);
 71:   PetscTruth     match;

 76:   CHKMEMQ;
 77:   PetscTypeCompare((PetscObject)viewer,type,&match);
 78:   if (match) return(0);

 80:   /* cleanup any old type that may be there */
 81:   if (viewer->data) {
 82:     (*viewer->ops->destroy)(viewer);
 83:     viewer->data = 0;
 84:   }
 85:   PetscMemzero(viewer->ops,sizeof(struct _PetscViewerOps));

 87:    PetscFListFind(PetscViewerList,viewer->comm,type,(void (**)(void)) &r);
 88:   if (!r) SETERRQ1(PETSC_ERR_ARG_UNKNOWN_TYPE,"Unknown PetscViewer type given: %s",type);

 90:   PetscObjectChangeTypeName((PetscObject)viewer,type);
 91:   (*r)(viewer);
 92:   return(0);
 93: }

 97: /*@C
 98:    PetscViewerRegisterDestroy - Frees the list of PetscViewer methods that were
 99:    registered by PetscViewerRegisterDynamic().

101:    Not Collective

103:    Level: developer

105: .seealso: PetscViewerRegisterDynamic(), PetscViewerRegisterAll()
106: @*/
107: PetscErrorCode  PetscViewerRegisterDestroy(void)
108: {

112:   PetscFListDestroy(&PetscViewerList);
113:   return(0);
114: }

118: PetscErrorCode  PetscViewerRegister(const char *sname,const char *path,const char *name,PetscErrorCode (*function)(PetscViewer))
119: {
121:   char fullname[PETSC_MAX_PATH_LEN];

124:   PetscFListConcat(path,name,fullname);
125:   PetscFListAdd(&PetscViewerList,sname,fullname,(void (*)(void))function);
126:   return(0);
127: }

131: /*@C
132:    PetscViewerSetFromOptions - Sets the graphics type from the options database.
133:       Defaults to a PETSc X windows graphics.

135:    Collective on PetscViewer

137:    Input Parameter:
138: .     PetscViewer - the graphics context

140:    Level: intermediate

142:    Notes: 
143:     Must be called after PetscViewerCreate() before the PetscViewer is used.

145:   Concepts: PetscViewer^setting options

147: .seealso: PetscViewerCreate(), PetscViewerSetType()

149: @*/
150: PetscErrorCode  PetscViewerSetFromOptions(PetscViewer viewer)
151: {
153:   char       vtype[256];
154:   PetscTruth flg;


159:   if (!PetscViewerList) {
160:     PetscViewerRegisterAll(PETSC_NULL);
161:   }
162:   PetscOptionsBegin(viewer->comm,viewer->prefix,"PetscViewer options","PetscViewer");
163:     PetscOptionsList("-viewer_type","Type of PetscViewer","None",PetscViewerList,(char *)(viewer->type_name?viewer->type_name:PETSC_VIEWER_ASCII),vtype,256,&flg);
164:     if (flg) {
165:       PetscViewerSetType(viewer,vtype);
166:     }
167:     /* type has not been set? */
168:     if (!viewer->type_name) {
169:       PetscViewerSetType(viewer,PETSC_VIEWER_ASCII);
170:     }
171:     if (viewer->ops->setfromoptions) {
172:       (*viewer->ops->setfromoptions)(viewer);
173:     }
174:   PetscOptionsEnd();

176:   return(0);
177: }