xref: /petsc/include/petscviewer.h (revision e1311b9049e89cb3452dcd306fde571f4b440ff2)
1*e1311b90SBarry Smith /* $Id: viewer.h,v 1.50 1998/03/23 21:27:32 bsmith Exp bsmith $ */
284cb2905SBarry Smith /*
384cb2905SBarry Smith      Viewers are objects where other objects can be looked at or stored.
484cb2905SBarry Smith */
53c119ea2SBarry Smith 
62eb8c8abSBarry Smith #if !defined(__VIEWER_PACKAGE)
72eb8c8abSBarry Smith #define __VIEWER_PACKAGE
82eb8c8abSBarry Smith 
9f09e8eb9SSatish Balay typedef struct _p_Viewer*            Viewer;
103c119ea2SBarry Smith 
113c119ea2SBarry Smith /*
123c119ea2SBarry Smith     petsc.h must be included AFTER the definition of Viewer for ADIC to
133c119ea2SBarry Smith    process correctly.
143c119ea2SBarry Smith */
152eb8c8abSBarry Smith #include "petsc.h"
162eb8c8abSBarry Smith 
172eb8c8abSBarry Smith #define VIEWER_COOKIE              PETSC_COOKIE+1
18bcd2baecSBarry Smith typedef enum { MATLAB_VIEWER,ASCII_FILE_VIEWER, ASCII_FILES_VIEWER,
19bcd2baecSBarry Smith                BINARY_FILE_VIEWER, STRING_VIEWER, DRAW_VIEWER} ViewerType;
202eb8c8abSBarry Smith 
21dbb450caSBarry Smith extern int ViewerFileOpenASCII(MPI_Comm,char*,Viewer *);
224b0e389bSBarry Smith typedef enum { BINARY_RDONLY, BINARY_WRONLY, BINARY_CREATE} ViewerBinaryType;
2321b0d8fbSLois Curfman McInnes extern int ViewerFileOpenBinary(MPI_Comm,char*,ViewerBinaryType,Viewer *);
24d7e8b826SBarry Smith extern int ViewerMatlabOpen(MPI_Comm,char*,int,Viewer *);
25bcd2baecSBarry Smith extern int ViewerStringOpen(MPI_Comm,char *,int, Viewer *);
26bcd2baecSBarry Smith extern int ViewerDrawOpenX(MPI_Comm,char *,char *,int,int,int,int,Viewer*);
27a2ce50c7SBarry Smith extern int ViewerDrawOpenVRML(MPI_Comm,char *,char *,Viewer*);
28d64ed03dSBarry Smith extern int ViewerDrawClear(Viewer);
294b0e389bSBarry Smith 
30bcd2baecSBarry Smith extern int ViewerGetType(Viewer,ViewerType*);
319651b370SBarry Smith extern int ViewerDestroy(Viewer);
32ae39576cSLois Curfman McInnes 
3390ace30eSBarry Smith extern int ViewerASCIIGetPointer(Viewer,FILE**);
34*e1311b90SBarry Smith 
3590ace30eSBarry Smith extern int ViewerBinaryGetDescriptor(Viewer,int*);
36496e697eSBarry Smith extern int ViewerBinaryGetInfoPointer(Viewer,FILE **);
3790ace30eSBarry Smith 
38639f9d9dSBarry Smith #define VIEWER_FORMAT_ASCII_DEFAULT       0
39639f9d9dSBarry Smith #define VIEWER_FORMAT_ASCII_MATLAB        1
40639f9d9dSBarry Smith #define VIEWER_FORMAT_ASCII_IMPL          2
41639f9d9dSBarry Smith #define VIEWER_FORMAT_ASCII_INFO          3
42639f9d9dSBarry Smith #define VIEWER_FORMAT_ASCII_INFO_LONG     4
43639f9d9dSBarry Smith #define VIEWER_FORMAT_ASCII_COMMON        5
4409b0ea9bSLois Curfman McInnes #define VIEWER_FORMAT_ASCII_SYMMODU       6
45090de74eSSatish Balay 
46639f9d9dSBarry Smith #define VIEWER_FORMAT_BINARY_DEFAULT      0
47639f9d9dSBarry Smith #define VIEWER_FORMAT_BINARY_NATIVE       1
48090de74eSSatish Balay 
495311e20fSBarry Smith #define VIEWER_FORMAT_DRAW_BASIC          0
505311e20fSBarry Smith #define VIEWER_FORMAT_DRAW_LG             1
510513a670SBarry Smith #define VIEWER_FORMAT_DRAW_CONTOUR        2
525311e20fSBarry Smith 
5390ace30eSBarry Smith extern int    ViewerSetFormat(Viewer,int,char *);
545311e20fSBarry Smith extern int    ViewerPushFormat(Viewer,int,char *);
555311e20fSBarry Smith extern int    ViewerPopFormat(Viewer);
5690ace30eSBarry Smith extern int    ViewerGetFormat(Viewer,int*);
5790ace30eSBarry Smith 
585fe861cdSBarry Smith extern int    ViewerFlush(Viewer);
5977c4ece6SBarry Smith extern int    ViewerStringSPrintf(Viewer,char *,...);
604b0e389bSBarry Smith 
616d4a8577SBarry Smith extern Viewer VIEWER_STDOUT_SELF;
626d4a8577SBarry Smith extern Viewer VIEWER_STDERR_SELF;
6325482d47SBarry Smith extern Viewer VIEWER_STDOUT_WORLD;
640752156aSBarry Smith extern Viewer VIEWER_STDOUT_(MPI_Comm);
650752156aSBarry Smith extern int    VIEWER_STDOUT_Destroy(MPI_Comm);
66c22c1629SBarry Smith extern Viewer VIEWER_STDERR_WORLD;
670752156aSBarry Smith extern Viewer VIEWER_STDERR_(MPI_Comm);
680752156aSBarry Smith extern int    VIEWER_STDERR_Destroy(MPI_Comm);
69639f9d9dSBarry Smith extern Viewer VIEWER_DRAWX_WORLD_PRIVATE_0;
70639f9d9dSBarry Smith extern Viewer VIEWER_DRAWX_WORLD_PRIVATE_1;
71639f9d9dSBarry Smith extern Viewer VIEWER_DRAWX_WORLD_PRIVATE_2;
725311e20fSBarry Smith extern Viewer VIEWER_DRAWX_SELF_PRIVATE;
73c16cb8f2SBarry Smith extern Viewer VIEWER_MATLAB_WORLD_PRIVATE;
74c16cb8f2SBarry Smith extern Viewer VIEWER_MATLAB_SELF_PRIVATE;  /* not yet used */
755311e20fSBarry Smith 
76cf256101SBarry Smith extern int    ViewerInitializeDrawXWorld_Private_0(void);
77cf256101SBarry Smith extern int    ViewerInitializeDrawXWorld_Private_1(void);
78cf256101SBarry Smith extern int    ViewerInitializeDrawXWorld_Private_2(void);
79cf256101SBarry Smith extern int    ViewerInitializeDrawXSelf_Private(void);
80cf256101SBarry Smith extern int    ViewerInitializeMatlabWorld_Private(void);
8158562591SBarry Smith extern Viewer VIEWER_DRAWX_(MPI_Comm);
8256cd22aeSBarry Smith extern int    VIEWER_DRAWX_Destroy(MPI_Comm);
835311e20fSBarry Smith 
84639f9d9dSBarry Smith #define VIEWER_DRAWX_WORLD_0 \
85639f9d9dSBarry Smith               (ViewerInitializeDrawXWorld_Private_0(),VIEWER_DRAWX_WORLD_PRIVATE_0)
86639f9d9dSBarry Smith #define VIEWER_DRAWX_WORLD_1 \
87639f9d9dSBarry Smith               (ViewerInitializeDrawXWorld_Private_1(),VIEWER_DRAWX_WORLD_PRIVATE_1)
88639f9d9dSBarry Smith #define VIEWER_DRAWX_WORLD_2 \
89639f9d9dSBarry Smith               (ViewerInitializeDrawXWorld_Private_2(),VIEWER_DRAWX_WORLD_PRIVATE_2)
90639f9d9dSBarry Smith 
915311e20fSBarry Smith #define VIEWER_DRAWX_SELF \
925311e20fSBarry Smith               (ViewerInitializeDrawXSelf_Private(),VIEWER_DRAWX_SELF_PRIVATE)
93639f9d9dSBarry Smith #define VIEWER_DRAWX_WORLD VIEWER_DRAWX_WORLD_0
94*e1311b90SBarry Smith 
95c16cb8f2SBarry Smith #define VIEWER_MATLAB_WORLD \
96c16cb8f2SBarry Smith         (ViewerInitializeMatlabWorld_Private(),VIEWER_MATLAB_WORLD_PRIVATE)
97c16cb8f2SBarry Smith 
982bdab257SBarry Smith extern int ViewersDrawOpenX(MPI_Comm,char *,char **,int,int,int,Viewer**);
992bdab257SBarry Smith extern int ViewersDestroy(int,Viewer *);
1002bdab257SBarry Smith 
1012eb8c8abSBarry Smith #endif
102