xref: /petsc/include/petscviewer.h (revision 44bdcb2d3326b2ce09a36bf9b6840bc8773a5d60)
1 /* $Id: viewer.h,v 1.51 1998/04/03 23:19:27 bsmith Exp bsmith $ */
2 /*
3      Viewers are objects where other objects can be looked at or stored.
4 */
5 
6 #if !defined(__VIEWER_PACKAGE)
7 #define __VIEWER_PACKAGE
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} ViewerType;
20 
21 extern int ViewerFileOpenASCII(MPI_Comm,char*,Viewer *);
22 typedef enum { BINARY_RDONLY, BINARY_WRONLY, BINARY_CREATE} ViewerBinaryType;
23 extern int ViewerFileOpenBinary(MPI_Comm,char*,ViewerBinaryType,Viewer *);
24 extern int ViewerMatlabOpen(MPI_Comm,char*,int,Viewer *);
25 extern int ViewerStringOpen(MPI_Comm,char *,int, Viewer *);
26 extern int ViewerDrawOpenX(MPI_Comm,char *,char *,int,int,int,int,Viewer*);
27 extern int ViewerDrawOpenVRML(MPI_Comm,char *,char *,Viewer*);
28 extern int ViewerDrawClear(Viewer);
29 
30 extern int ViewerGetType(Viewer,ViewerType*);
31 extern int ViewerDestroy(Viewer);
32 
33 extern int ViewerASCIIGetPointer(Viewer,FILE**);
34 
35 extern int ViewerBinaryGetDescriptor(Viewer,int*);
36 extern int ViewerBinaryGetInfoPointer(Viewer,FILE **);
37 
38 #define VIEWER_FORMAT_ASCII_DEFAULT       0
39 #define VIEWER_FORMAT_ASCII_MATLAB        1
40 #define VIEWER_FORMAT_ASCII_IMPL          2
41 #define VIEWER_FORMAT_ASCII_INFO          3
42 #define VIEWER_FORMAT_ASCII_INFO_LONG     4
43 #define VIEWER_FORMAT_ASCII_COMMON        5
44 #define VIEWER_FORMAT_ASCII_SYMMODU       6
45 #define VIEWER_FORMAT_ASCII_INDEX         7
46 
47 #define VIEWER_FORMAT_BINARY_DEFAULT      0
48 #define VIEWER_FORMAT_BINARY_NATIVE       1
49 
50 #define VIEWER_FORMAT_DRAW_BASIC          0
51 #define VIEWER_FORMAT_DRAW_LG             1
52 #define VIEWER_FORMAT_DRAW_CONTOUR        2
53 
54 extern int    ViewerSetFormat(Viewer,int,char *);
55 extern int    ViewerPushFormat(Viewer,int,char *);
56 extern int    ViewerPopFormat(Viewer);
57 extern int    ViewerGetFormat(Viewer,int*);
58 
59 extern int    ViewerFlush(Viewer);
60 extern int    ViewerStringSPrintf(Viewer,char *,...);
61 
62 extern Viewer VIEWER_STDOUT_SELF;
63 extern Viewer VIEWER_STDERR_SELF;
64 extern Viewer VIEWER_STDOUT_WORLD;
65 extern Viewer VIEWER_STDOUT_(MPI_Comm);
66 extern int    VIEWER_STDOUT_Destroy(MPI_Comm);
67 extern Viewer VIEWER_STDERR_WORLD;
68 extern Viewer VIEWER_STDERR_(MPI_Comm);
69 extern int    VIEWER_STDERR_Destroy(MPI_Comm);
70 extern Viewer VIEWER_DRAWX_WORLD_PRIVATE_0;
71 extern Viewer VIEWER_DRAWX_WORLD_PRIVATE_1;
72 extern Viewer VIEWER_DRAWX_WORLD_PRIVATE_2;
73 extern Viewer VIEWER_DRAWX_SELF_PRIVATE;
74 extern Viewer VIEWER_MATLAB_WORLD_PRIVATE;
75 extern Viewer VIEWER_MATLAB_SELF_PRIVATE;  /* not yet used */
76 
77 extern int    ViewerInitializeDrawXWorld_Private_0(void);
78 extern int    ViewerInitializeDrawXWorld_Private_1(void);
79 extern int    ViewerInitializeDrawXWorld_Private_2(void);
80 extern int    ViewerInitializeDrawXSelf_Private(void);
81 extern int    ViewerInitializeMatlabWorld_Private(void);
82 extern Viewer VIEWER_DRAWX_(MPI_Comm);
83 extern int    VIEWER_DRAWX_Destroy(MPI_Comm);
84 
85 #define VIEWER_DRAWX_WORLD_0 \
86               (ViewerInitializeDrawXWorld_Private_0(),VIEWER_DRAWX_WORLD_PRIVATE_0)
87 #define VIEWER_DRAWX_WORLD_1 \
88               (ViewerInitializeDrawXWorld_Private_1(),VIEWER_DRAWX_WORLD_PRIVATE_1)
89 #define VIEWER_DRAWX_WORLD_2 \
90               (ViewerInitializeDrawXWorld_Private_2(),VIEWER_DRAWX_WORLD_PRIVATE_2)
91 
92 #define VIEWER_DRAWX_SELF \
93               (ViewerInitializeDrawXSelf_Private(),VIEWER_DRAWX_SELF_PRIVATE)
94 #define VIEWER_DRAWX_WORLD VIEWER_DRAWX_WORLD_0
95 
96 #define VIEWER_MATLAB_WORLD \
97         (ViewerInitializeMatlabWorld_Private(),VIEWER_MATLAB_WORLD_PRIVATE)
98 
99 extern int ViewersDrawOpenX(MPI_Comm,char *,char **,int,int,int,Viewer**);
100 extern int ViewersDestroy(int,Viewer *);
101 
102 #endif
103