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

 35:   *inviewer = 0;
 36: #if !defined(PETSC_USE_DYNAMIC_LIBRARIES)
 37:   PetscInitializePackage(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:   if (!PetscViewerList) {
 88:     PetscViewerRegisterAll(PETSC_NULL);
 89:   }
 90:    PetscFListFind(viewer->comm,PetscViewerList,type,(void (**)(void)) &r);
 91:   if (!r) SETERRQ1(PETSC_ERR_ARG_UNKNOWN_TYPE,"Unknown PetscViewer type given: %s",type);

 93:   PetscObjectChangeTypeName((PetscObject)viewer,type);
 94:   (*r)(viewer);
 95:   return(0);
 96: }

100: /*@C
101:    PetscViewerRegisterDestroy - Frees the list of PetscViewer methods that were
102:    registered by PetscViewerRegisterDynamic().

104:    Not Collective

106:    Level: developer

108: .seealso: PetscViewerRegisterDynamic(), PetscViewerRegisterAll()
109: @*/
110: PetscErrorCode  PetscViewerRegisterDestroy(void)
111: {

115:   if (PetscViewerList) {
116:     PetscFListDestroy(&PetscViewerList);
117:     PetscViewerList = 0;
118:   }
119:   return(0);
120: }

124: PetscErrorCode  PetscViewerRegister(const char *sname,const char *path,const char *name,PetscErrorCode (*function)(PetscViewer))
125: {
127:   char fullname[PETSC_MAX_PATH_LEN];

130:   PetscFListConcat(path,name,fullname);
131:   PetscFListAdd(&PetscViewerList,sname,fullname,(void (*)(void))function);
132:   return(0);
133: }

137: /*@C
138:    PetscViewerSetFromOptions - Sets the graphics type from the options database.
139:       Defaults to a PETSc X windows graphics.

141:    Collective on PetscViewer

143:    Input Parameter:
144: .     PetscViewer - the graphics context

146:    Level: intermediate

148:    Notes: 
149:     Must be called after PetscViewerCreate() before the PetscViewer is used.

151:   Concepts: PetscViewer^setting options

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

155: @*/
156: PetscErrorCode  PetscViewerSetFromOptions(PetscViewer viewer)
157: {
159:   char       vtype[256];
160:   PetscTruth flg;


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

182:   return(0);
183: }