1: /* $Id: petscviewer.h,v 1.85 2001/08/06 21:13:28 bsmith Exp $ */
  2: /*
  3:      PetscViewers are objects where other objects can be looked at or stored.
  4: */


  9: extern int PETSC_VIEWER_COOKIE;

 11: /*S
 12:      PetscViewer - Abstract PETSc object that helps view (in ASCII, binary, graphically etc)
 13:          other PETSc objects

 15:    Level: beginner

 17:   Concepts: viewing

 19: .seealso:  PetscViewerCreate(), PetscViewerSetType(), PetscViewerType
 20: S*/
 21: typedef struct _p_PetscViewer* PetscViewer;

 23: /*
 24:     petsc.h must be included AFTER the definition of PetscViewer for ADIC to 
 25:    process correctly.
 26: */
 27:  #include petsc.h

 29: /*E
 30:     PetscViewerType - String with the name of a PETSc PETScViewer

 32:    Level: beginner

 34: .seealso: PetscViewerSetType(), PetscViewer
 35: E*/
 36: typedef char* PetscViewerType;
 37: #define PETSC_VIEWER_SOCKET       "socket"
 38: #define PETSC_VIEWER_ASCII        "ascii"
 39: #define PETSC_VIEWER_BINARY       "binary"
 40: #define PETSC_VIEWER_STRING       "string"
 41: #define PETSC_VIEWER_DRAW         "draw"
 42: #define PETSC_VIEWER_AMS          "ams"
 43: #define PETSC_VIEWER_VU           "vu"
 44: #define PETSC_VIEWER_MATHEMATICA  "mathematica"
 45: #define PETSC_VIEWER_SILO         "silo"

 47: extern PetscFList PetscViewerList;
 48: EXTERN int PetscViewerRegisterAll(char *);
 49: EXTERN int PetscViewerRegisterDestroy(void);

 51: EXTERN int PetscViewerRegister(char*,char*,char*,int(*)(PetscViewer));
 52: #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
 53: #define PetscViewerRegisterDynamic(a,b,c,d) PetscViewerRegister(a,b,c,0)
 54: #else
 55: #define PetscViewerRegisterDynamic(a,b,c,d) PetscViewerRegister(a,b,c,d)
 56: #endif
 57: EXTERN int PetscViewerCreate(MPI_Comm,PetscViewer*);
 58: EXTERN int PetscViewerSetFromOptions(PetscViewer);

 60: EXTERN int PetscViewerASCIIOpen(MPI_Comm,const char[],PetscViewer*);
 61: typedef enum {PETSC_BINARY_RDONLY,PETSC_BINARY_WRONLY,PETSC_BINARY_CREATE} PetscViewerBinaryType;
 62: EXTERN int PetscViewerBinaryOpen(MPI_Comm,const char[],PetscViewerBinaryType,PetscViewer*);
 63: EXTERN int PetscViewerSocketOpen(MPI_Comm,const char[],int,PetscViewer*);
 64: EXTERN int PetscViewerStringOpen(MPI_Comm,char[],int,PetscViewer*);
 65: EXTERN int PetscViewerDrawOpen(MPI_Comm,const char[],const char[],int,int,int,int,PetscViewer*);
 66: EXTERN int PetscViewerAMSSetCommName(PetscViewer,const char[]);
 67: EXTERN int PetscViewerMathematicaOpen(MPI_Comm, int, const char[], const char[], PetscViewer *);
 68: EXTERN int PetscViewerSiloOpen(MPI_Comm, const char[], PetscViewer *);

 70: EXTERN int PetscViewerGetType(PetscViewer,PetscViewerType*);
 71: EXTERN int PetscViewerSetType(PetscViewer,PetscViewerType);
 72: EXTERN int PetscViewerDestroy(PetscViewer);
 73: EXTERN int PetscViewerGetSingleton(PetscViewer,PetscViewer*);
 74: EXTERN int PetscViewerRestoreSingleton(PetscViewer,PetscViewer*);


 77: /*E
 78:     PetscViewerFormat - Way a viewer presents the object

 80:    Level: beginner

 82: .seealso: PetscViewerSetFormat(), PetscViewer, PetscViewerType, PetscViewerPushFormat(), PetscViewerPopFormat()
 83: E*/
 84: typedef enum {
 85:   PETSC_VIEWER_ASCII_DEFAULT,
 86:   PETSC_VIEWER_ASCII_MATLAB,
 87:   PETSC_VIEWER_ASCII_MATHEMATICA,
 88:   PETSC_VIEWER_ASCII_IMPL,
 89:   PETSC_VIEWER_ASCII_INFO,
 90:   PETSC_VIEWER_ASCII_INFO_DETAIL,
 91:   PETSC_VIEWER_ASCII_COMMON,
 92:   PETSC_VIEWER_ASCII_SYMMODU,
 93:   PETSC_VIEWER_ASCII_INDEX,
 94:   PETSC_VIEWER_ASCII_DENSE,
 95:   PETSC_VIEWER_BINARY_DEFAULT,
 96:   PETSC_VIEWER_BINARY_NATIVE,
 97:   PETSC_VIEWER_DRAW_BASIC,
 98:   PETSC_VIEWER_DRAW_LG,
 99:   PETSC_VIEWER_DRAW_CONTOUR,
100:   PETSC_VIEWER_DRAW_PORTS,
101:   PETSC_VIEWER_NATIVE,
102:   PETSC_VIEWER_NOFORMAT,
103:   PETSC_VIEWER_ASCII_FACTOR_INFO} PetscViewerFormat;

105: EXTERN int PetscViewerSetFormat(PetscViewer,PetscViewerFormat);
106: EXTERN int PetscViewerPushFormat(PetscViewer,PetscViewerFormat);
107: EXTERN int PetscViewerPopFormat(PetscViewer);
108: EXTERN int PetscViewerGetFormat(PetscViewer,PetscViewerFormat*);
109: EXTERN int PetscViewerFlush(PetscViewer);

111: /*
112:    Operations explicit to a particular class of viewers
113: */

115: /*E
116:   PetscViewerFormat - Access mode for a file.

118:   Level: beginner

120: .seealso: PetscViewerASCIISetMode()
121: E*/
122: typedef enum {FILE_MODE_READ, FILE_MODE_WRITE, FILE_MODE_APPEND, FILE_MODE_UPDATE, FILE_MODE_APPEND_UPDATE} PetscFileMode;

124: EXTERN int PetscViewerASCIIGetPointer(PetscViewer,FILE**);
125: EXTERN int PetscViewerASCIISetMode(PetscViewer,PetscFileMode);
126: EXTERN int PetscViewerASCIIPrintf(PetscViewer,const char[],...) PETSC_PRINTF_FORMAT_CHECK(2,3);
127: EXTERN int PetscViewerASCIISynchronizedPrintf(PetscViewer,const char[],...) PETSC_PRINTF_FORMAT_CHECK(2,3);
128: EXTERN int PetscViewerASCIIPushTab(PetscViewer);
129: EXTERN int PetscViewerASCIIPopTab(PetscViewer);
130: EXTERN int PetscViewerASCIIUseTabs(PetscViewer,PetscTruth);
131: EXTERN int PetscViewerASCIISetTab(PetscViewer,int);
132: EXTERN int PetscViewerBinaryGetDescriptor(PetscViewer,int*);
133: EXTERN int PetscViewerBinaryGetInfoPointer(PetscViewer,FILE **);
134: EXTERN int PetscViewerBinarySetType(PetscViewer,PetscViewerBinaryType);
135: EXTERN int PetscViewerStringSPrintf(PetscViewer,char *,...) PETSC_PRINTF_FORMAT_CHECK(2,3);
136: EXTERN int PetscViewerStringSetString(PetscViewer,char[],int);
137: EXTERN int PetscViewerDrawClear(PetscViewer);
138: EXTERN int PetscViewerDrawSetInfo(PetscViewer,const char[],const char[],int,int,int,int);
139: EXTERN int PetscViewerSocketSetConnection(PetscViewer,const char[],int);
140: EXTERN int PetscViewerBinarySkipInfo(PetscViewer);
141: EXTERN int PetscViewerBinaryLoadInfo(PetscViewer);


144: EXTERN int PetscViewerSetFilename(PetscViewer,const char[]);
145: EXTERN int PetscViewerGetFilename(PetscViewer,char**);

147: EXTERN int PetscPLAPACKInitializePackage(char *);
148: EXTERN int PetscPLAPACKFinalizePackage(void);

150: EXTERN int PetscViewerVUGetPointer(PetscViewer, FILE**);
151: EXTERN int PetscViewerVUSetMode(PetscViewer, PetscFileMode);
152: EXTERN int PetscViewerVUSetVecSeen(PetscViewer, PetscTruth);
153: EXTERN int PetscViewerVUGetVecSeen(PetscViewer, PetscTruth *);
154: EXTERN int PetscViewerVUPrintDeferred(PetscViewer, const char [], ...) PETSC_PRINTF_FORMAT_CHECK(2,3);
155: EXTERN int PetscViewerVUFlushDeferred(PetscViewer);

157: EXTERN int PetscViewerMathematicaInitializePackage(char *);
158: EXTERN int PetscViewerMathematicaFinalizePackage(void);
159: EXTERN int PetscViewerMathematicaGetName(PetscViewer, const char **);
160: EXTERN int PetscViewerMathematicaSetName(PetscViewer, const char []);
161: EXTERN int PetscViewerMathematicaClearName(PetscViewer);
162: EXTERN int PetscViewerMathematicaSkipPackets(PetscViewer, int);

164: EXTERN int PetscViewerSiloGetName(PetscViewer, char **);
165: EXTERN int PetscViewerSiloSetName(PetscViewer, const char []);
166: EXTERN int PetscViewerSiloClearName(PetscViewer);
167: EXTERN int PetscViewerSiloGetMeshName(PetscViewer, char **);
168: EXTERN int PetscViewerSiloSetMeshName(PetscViewer, const char []);
169: EXTERN int PetscViewerSiloClearMeshName(PetscViewer);

171: /*
172:      These are all the default viewers that do not have 
173:    to be explicitly opened
174: */
175: EXTERN PetscViewer PETSC_VIEWER_STDOUT_(MPI_Comm);
176: EXTERN PetscViewer PETSC_VIEWER_STDERR_(MPI_Comm);
177: EXTERN PetscViewer PETSC_VIEWER_DRAW_(MPI_Comm);
178: EXTERN PetscViewer PETSC_VIEWER_SOCKET_(MPI_Comm);
179: EXTERN PetscViewer PETSC_VIEWER_BINARY_(MPI_Comm);
180: EXTERN PetscViewer PETSC_VIEWER_MATHEMATICA_WORLD_PRIVATE;

182: #define PETSC_VIEWER_STDOUT_SELF  PETSC_VIEWER_STDOUT_(PETSC_COMM_SELF)
183: #define PETSC_VIEWER_STDOUT_WORLD PETSC_VIEWER_STDOUT_(PETSC_COMM_WORLD)
184: #define PETSC_VIEWER_STDERR_SELF  PETSC_VIEWER_STDERR_(PETSC_COMM_SELF)
185: #define PETSC_VIEWER_STDERR_WORLD PETSC_VIEWER_STDERR_(PETSC_COMM_WORLD)
186: #define PETSC_VIEWER_DRAW_SELF    PETSC_VIEWER_DRAW_(PETSC_COMM_SELF)
187: #define PETSC_VIEWER_DRAW_WORLD   PETSC_VIEWER_DRAW_(PETSC_COMM_WORLD)
188: #define PETSC_VIEWER_SOCKET_WORLD PETSC_VIEWER_SOCKET_(PETSC_COMM_WORLD)
189: #define PETSC_VIEWER_SOCKET_SELF  PETSC_VIEWER_SOCKET_(PETSC_COMM_SELF)
190: #define PETSC_VIEWER_BINARY_WORLD PETSC_VIEWER_BINARY_(PETSC_COMM_WORLD)
191: #define PETSC_VIEWER_BINARY_SELF  PETSC_VIEWER_BINARY_(PETSC_COMM_SELF)
192: #define PETSC_VIEWER_MATHEMATICA_WORLD (PetscViewerInitializeMathematicaWorld_Private(),PETSC_VIEWER_MATHEMATICA_WORLD_PRIVATE) 

194: /*
195:     PetscViewer based on the ALICE Memory Snooper
196: */
197: #if defined(PETSC_HAVE_AMS)
198: #include "ams.h"
199: EXTERN int         PetscViewerAMSGetAMSComm(PetscViewer,AMS_Comm *);
200: EXTERN int         PetscViewerAMSOpen(MPI_Comm,const char[],PetscViewer*);
201: EXTERN int         PetscViewerAMSLock(PetscViewer);
202: EXTERN PetscViewer PETSC_VIEWER_AMS_(MPI_Comm);
203: EXTERN int         PETSC_VIEWER_AMS_Destroy(MPI_Comm);
204: #define PETSC_VIEWER_AMS_WORLD PETSC_VIEWER_AMS_(PETSC_COMM_WORLD)
205: #endif

207: /* 
208:     PetscViewer utility routines used by PETSc that are not normally used
209:    by users.
210: */
211: EXTERN int  PetscViewerSocketPutScalar(PetscViewer,int,int,PetscScalar*);
212: EXTERN int  PetscViewerSocketPutReal(PetscViewer,int,int,PetscReal*);
213: EXTERN int  PetscViewerSocketPutInt(PetscViewer,int,int*);
214: EXTERN int  PetscViewerSocketPutSparse_Private(PetscViewer,int,int,int,PetscScalar*,int*,int *);
215: EXTERN int  PetscViewerDestroyAMS_Private(void);

217: /*S
218:      PetscViewers - Abstract collection of PetscViewers

220:    Level: intermediate

222:   Concepts: viewing

224: .seealso:  PetscViewerCreate(), PetscViewerSetType(), PetscViewerType, PetscViewer, PetscViewersCreate(),
225:            PetscViewersGetViewer()
226: S*/
227: typedef struct _p_PetscViewers* PetscViewers;
228: EXTERN int PetscViewersCreate(MPI_Comm,PetscViewers*);
229: EXTERN int PetscViewersDestroy(PetscViewers);
230: EXTERN int PetscViewersGetViewer(PetscViewers,int,PetscViewer*);

232: #endif