xref: /petsc/include/petscviewer.h (revision 488ecbaffa467bb032d31d7eb20bc6d0ef6d986c)
1 /* $Id: viewer.h,v 1.53 1998/06/11 19:59:10 bsmith Exp bsmith $ */
2 /*
3      Viewers are objects where other objects can be looked at or stored.
4 */
5 
6 #if !defined(__VIEWER_H)
7 #define __VIEWER_H
8 
9 typedef struct _p_Viewer*            Viewer;
10 
11 /*
12     petsc.h must be included AFTER the definition of Viewer for ADIC to
13    process correctly.
14 */
15 #include "petsc.h"
16 
17 #define VIEWER_COOKIE              PETSC_COOKIE+1
18 typedef enum { MATLAB_VIEWER,ASCII_FILE_VIEWER, ASCII_FILES_VIEWER,
19                BINARY_FILE_VIEWER, STRING_VIEWER, DRAW_VIEWER,
20                AMS_VIEWER} ViewerType;
21 
22 extern int ViewerFileOpenASCII(MPI_Comm,char*,Viewer *);
23 typedef enum {BINARY_RDONLY, BINARY_WRONLY, BINARY_CREATE} ViewerBinaryType;
24 extern int ViewerFileOpenBinary(MPI_Comm,char*,ViewerBinaryType,Viewer *);
25 extern int ViewerMatlabOpen(MPI_Comm,char*,int,Viewer *);
26 extern int ViewerStringOpen(MPI_Comm,char *,int, Viewer *);
27 extern int ViewerDrawOpenX(MPI_Comm,char *,char *,int,int,int,int,Viewer*);
28 extern int ViewerDrawOpenVRML(MPI_Comm,char *,char *,Viewer*);
29 extern int ViewerDrawClear(Viewer);
30 
31 extern int ViewerAMSOpen(MPI_Comm,char *,Viewer*);
32 
33 extern int ViewerGetType(Viewer,ViewerType*);
34 extern int ViewerDestroy(Viewer);
35 
36 extern int ViewerASCIIGetPointer(Viewer,FILE**);
37 
38 extern int ViewerBinaryGetDescriptor(Viewer,int*);
39 extern int ViewerBinaryGetInfoPointer(Viewer,FILE **);
40 
41 #define VIEWER_FORMAT_ASCII_DEFAULT       0
42 #define VIEWER_FORMAT_ASCII_MATLAB        1
43 #define VIEWER_FORMAT_ASCII_IMPL          2
44 #define VIEWER_FORMAT_ASCII_INFO          3
45 #define VIEWER_FORMAT_ASCII_INFO_LONG     4
46 #define VIEWER_FORMAT_ASCII_COMMON        5
47 #define VIEWER_FORMAT_ASCII_SYMMODU       6
48 #define VIEWER_FORMAT_ASCII_INDEX         7
49 
50 #define VIEWER_FORMAT_BINARY_DEFAULT      0
51 #define VIEWER_FORMAT_BINARY_NATIVE       1
52 
53 #define VIEWER_FORMAT_DRAW_BASIC          0
54 #define VIEWER_FORMAT_DRAW_LG             1
55 #define VIEWER_FORMAT_DRAW_CONTOUR        2
56 
57 extern int    ViewerSetFormat(Viewer,int,char *);
58 extern int    ViewerPushFormat(Viewer,int,char *);
59 extern int    ViewerPopFormat(Viewer);
60 extern int    ViewerGetFormat(Viewer,int*);
61 
62 extern int    ViewerFlush(Viewer);
63 extern int    ViewerStringSPrintf(Viewer,char *,...);
64 
65 extern Viewer VIEWER_STDOUT_SELF;
66 extern Viewer VIEWER_STDERR_SELF;
67 extern Viewer VIEWER_STDOUT_WORLD;
68 extern Viewer VIEWER_STDOUT_(MPI_Comm);
69 extern int    VIEWER_STDOUT_Destroy(MPI_Comm);
70 extern Viewer VIEWER_STDERR_WORLD;
71 extern Viewer VIEWER_STDERR_(MPI_Comm);
72 extern int    VIEWER_STDERR_Destroy(MPI_Comm);
73 extern Viewer VIEWER_DRAWX_WORLD_PRIVATE_0;
74 extern Viewer VIEWER_DRAWX_WORLD_PRIVATE_1;
75 extern Viewer VIEWER_DRAWX_WORLD_PRIVATE_2;
76 extern Viewer VIEWER_DRAWX_SELF_PRIVATE;
77 extern Viewer VIEWER_MATLAB_WORLD_PRIVATE;
78 extern Viewer VIEWER_MATLAB_SELF_PRIVATE;  /* not yet used */
79 
80 extern int    ViewerInitializeDrawXWorld_Private_0(void);
81 extern int    ViewerInitializeDrawXWorld_Private_1(void);
82 extern int    ViewerInitializeDrawXWorld_Private_2(void);
83 extern int    ViewerInitializeDrawXSelf_Private(void);
84 extern int    ViewerInitializeMatlabWorld_Private(void);
85 extern Viewer VIEWER_DRAWX_(MPI_Comm);
86 extern int    VIEWER_DRAWX_Destroy(MPI_Comm);
87 extern Viewer VIEWER_AMS_(MPI_Comm);
88 extern int    VIEWER_AMS_Destroy(MPI_Comm);
89 
90 #define VIEWER_DRAWX_WORLD_0 \
91               (ViewerInitializeDrawXWorld_Private_0(),VIEWER_DRAWX_WORLD_PRIVATE_0)
92 #define VIEWER_DRAWX_WORLD_1 \
93               (ViewerInitializeDrawXWorld_Private_1(),VIEWER_DRAWX_WORLD_PRIVATE_1)
94 #define VIEWER_DRAWX_WORLD_2 \
95               (ViewerInitializeDrawXWorld_Private_2(),VIEWER_DRAWX_WORLD_PRIVATE_2)
96 
97 #define VIEWER_DRAWX_SELF \
98               (ViewerInitializeDrawXSelf_Private(),VIEWER_DRAWX_SELF_PRIVATE)
99 #define VIEWER_DRAWX_WORLD VIEWER_DRAWX_WORLD_0
100 
101 #define VIEWER_MATLAB_WORLD \
102         (ViewerInitializeMatlabWorld_Private(),VIEWER_MATLAB_WORLD_PRIVATE)
103 
104 extern int ViewersDrawOpenX(MPI_Comm,char *,char **,int,int,int,Viewer**);
105 extern int ViewersDestroy(int,Viewer *);
106 
107 #endif
108