xref: /petsc/include/petscviewer.h (revision c2ea1186303e6ad186d8293edcc4dffdc3bb3ffe)
1 /* $Id: viewer.h,v 1.46 1997/09/26 02:22:17 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 
29 extern int ViewerGetType(Viewer,ViewerType*);
30 extern int ViewerDestroy(Viewer);
31 
32 extern int ViewerASCIIGetPointer(Viewer,FILE**);
33 extern int ViewerBinaryGetDescriptor(Viewer,int*);
34 extern int ViewerBinaryGetInfoPointer(Viewer,FILE **);
35 
36 #define VIEWER_FORMAT_ASCII_DEFAULT       0
37 #define VIEWER_FORMAT_ASCII_MATLAB        1
38 #define VIEWER_FORMAT_ASCII_IMPL          2
39 #define VIEWER_FORMAT_ASCII_INFO          3
40 #define VIEWER_FORMAT_ASCII_INFO_LONG     4
41 #define VIEWER_FORMAT_ASCII_COMMON        5
42 #define VIEWER_FORMAT_ASCII_SYMMODU       6
43 #define VIEWER_FORMAT_BINARY_DEFAULT      0
44 #define VIEWER_FORMAT_BINARY_NATIVE       1
45 #define VIEWER_FORMAT_DRAW_BASIC          0
46 #define VIEWER_FORMAT_DRAW_LG             1
47 #define VIEWER_FORMAT_DRAW_CONTOUR        2
48 
49 extern int    ViewerSetFormat(Viewer,int,char *);
50 extern int    ViewerPushFormat(Viewer,int,char *);
51 extern int    ViewerPopFormat(Viewer);
52 extern int    ViewerGetFormat(Viewer,int*);
53 
54 extern int    ViewerFlush(Viewer);
55 extern int    ViewerStringSPrintf(Viewer,char *,...);
56 
57 extern Viewer VIEWER_STDOUT_SELF;
58 extern Viewer VIEWER_STDERR_SELF;
59 extern Viewer VIEWER_STDOUT_WORLD;
60 extern Viewer VIEWER_STDOUT_(MPI_Comm);
61 extern int    VIEWER_STDOUT_Destroy(MPI_Comm);
62 extern Viewer VIEWER_STDERR_WORLD;
63 extern Viewer VIEWER_STDERR_(MPI_Comm);
64 extern int    VIEWER_STDERR_Destroy(MPI_Comm);
65 extern Viewer VIEWER_DRAWX_WORLD_PRIVATE_0;
66 extern Viewer VIEWER_DRAWX_WORLD_PRIVATE_1;
67 extern Viewer VIEWER_DRAWX_WORLD_PRIVATE_2;
68 extern Viewer VIEWER_DRAWX_SELF_PRIVATE;
69 extern Viewer VIEWER_MATLAB_WORLD_PRIVATE;
70 extern Viewer VIEWER_MATLAB_SELF_PRIVATE;  /* not yet used */
71 
72 extern int    ViewerInitializeDrawXWorld_Private_0();
73 extern int    ViewerInitializeDrawXWorld_Private_1();
74 extern int    ViewerInitializeDrawXWorld_Private_2();
75 extern int    ViewerInitializeDrawXSelf_Private();
76 extern int    ViewerInitializeMatlabWorld_Private();
77 extern Viewer VIEWER_DRAWX_(MPI_Comm);
78 extern int    VIEWER_DRAWX_Destroy(MPI_Comm);
79 
80 #define VIEWER_DRAWX_WORLD_0 \
81               (ViewerInitializeDrawXWorld_Private_0(),VIEWER_DRAWX_WORLD_PRIVATE_0)
82 #define VIEWER_DRAWX_WORLD_1 \
83               (ViewerInitializeDrawXWorld_Private_1(),VIEWER_DRAWX_WORLD_PRIVATE_1)
84 #define VIEWER_DRAWX_WORLD_2 \
85               (ViewerInitializeDrawXWorld_Private_2(),VIEWER_DRAWX_WORLD_PRIVATE_2)
86 
87 #define VIEWER_DRAWX_SELF \
88               (ViewerInitializeDrawXSelf_Private(),VIEWER_DRAWX_SELF_PRIVATE)
89 #define VIEWER_DRAWX_WORLD VIEWER_DRAWX_WORLD_0
90 #define VIEWER_MATLAB_WORLD \
91         (ViewerInitializeMatlabWorld_Private(),VIEWER_MATLAB_WORLD_PRIVATE)
92 
93 extern int ViewersDrawOpenX(MPI_Comm,char *,char **,int,int,int,Viewer**);
94 extern int ViewersDestroy(int,Viewer *);
95 
96 #endif
97