xref: /petsc/include/petscviewer.h (revision a56f64adb5834214d3f6efb7ae3eaaf5382713b5)
1 /*
2      PetscViewers are objects where other objects can be looked at or stored.
3 */
4 
5 #if !defined(__PETSCVIEWER_H)
6 #define __PETSCVIEWER_H
7 
8 #include <petscsys.h>
9 #include <petscviewertypes.h>
10 #include <petscdrawtypes.h>
11 
12 PETSC_EXTERN PetscClassId PETSC_VIEWER_CLASSID;
13 
14 /*J
15     PetscViewerType - String with the name of a PETSc PETScViewer
16 
17    Level: beginner
18 
19 .seealso: PetscViewerSetType(), PetscViewer, PetscViewerRegister(), PetscViewerCreate()
20 J*/
21 typedef const char* PetscViewerType;
22 #define PETSCVIEWERSOCKET       "socket"
23 #define PETSCVIEWERASCII        "ascii"
24 #define PETSCVIEWERBINARY       "binary"
25 #define PETSCVIEWERSTRING       "string"
26 #define PETSCVIEWERDRAW         "draw"
27 #define PETSCVIEWERVU           "vu"
28 #define PETSCVIEWERMATHEMATICA  "mathematica"
29 #define PETSCVIEWERHDF5         "hdf5"
30 #define PETSCVIEWERVTK          "vtk"
31 #define PETSCVIEWERMATLAB       "matlab"
32 #define PETSCVIEWERSAWS         "saws"
33 #define PETSCVIEWERGLVIS        "glvis"
34 #define PETSCVIEWERADIOS        "adios"
35 
36 PETSC_EXTERN PetscFunctionList PetscViewerList;
37 PETSC_EXTERN PetscErrorCode PetscViewerInitializePackage(void);
38 
39 PETSC_EXTERN PetscErrorCode PetscViewerRegister(const char[],PetscErrorCode (*)(PetscViewer));
40 
41 PETSC_EXTERN PetscErrorCode PetscViewerCreate(MPI_Comm,PetscViewer*);
42 PETSC_EXTERN PetscErrorCode PetscViewerSetFromOptions(PetscViewer);
43 PETSC_EXTERN PetscErrorCode PetscViewerASCIIOpenWithFILE(MPI_Comm,FILE*,PetscViewer*);
44 
45 PETSC_EXTERN PetscErrorCode PetscViewerASCIIOpen(MPI_Comm,const char[],PetscViewer*);
46 PETSC_EXTERN PetscErrorCode PetscViewerASCIISetFILE(PetscViewer,FILE*);
47 PETSC_EXTERN PetscErrorCode PetscViewerBinaryOpen(MPI_Comm,const char[],PetscFileMode,PetscViewer*);
48 PETSC_EXTERN PetscErrorCode PetscViewerADIOSOpen(MPI_Comm,const char[],PetscFileMode,PetscViewer*);
49 PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetFlowControl(PetscViewer,PetscInt*);
50 PETSC_EXTERN PetscErrorCode PetscViewerBinarySetFlowControl(PetscViewer,PetscInt);
51 PETSC_EXTERN PetscErrorCode PetscViewerBinarySetUseMPIIO(PetscViewer,PetscBool);
52 PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetUseMPIIO(PetscViewer,PetscBool *);
53 #if defined(PETSC_HAVE_MPIIO)
54 PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetMPIIODescriptor(PetscViewer,MPI_File*);
55 PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetMPIIOOffset(PetscViewer,MPI_Offset*);
56 PETSC_EXTERN PetscErrorCode PetscViewerBinaryAddMPIIOOffset(PetscViewer,MPI_Offset);
57 #endif
58 
59 PETSC_EXTERN PetscErrorCode PetscViewerSocketOpen(MPI_Comm,const char[],int,PetscViewer*);
60 PETSC_EXTERN PetscErrorCode PetscViewerStringOpen(MPI_Comm,char[],size_t,PetscViewer*);
61 PETSC_EXTERN PetscErrorCode PetscViewerDrawOpen(MPI_Comm,const char[],const char[],int,int,int,int,PetscViewer*);
62 PETSC_EXTERN PetscErrorCode PetscViewerDrawSetDrawType(PetscViewer,PetscDrawType);
63 PETSC_EXTERN PetscErrorCode PetscViewerDrawGetDrawType(PetscViewer,PetscDrawType*);
64 PETSC_EXTERN PetscErrorCode PetscViewerDrawSetTitle(PetscViewer,const char[]);
65 PETSC_EXTERN PetscErrorCode PetscViewerDrawGetTitle(PetscViewer,const char*[]);
66 PETSC_EXTERN PetscErrorCode PetscViewerDrawGetDraw(PetscViewer,PetscInt,PetscDraw*);
67 PETSC_EXTERN PetscErrorCode PetscViewerDrawBaseAdd(PetscViewer,PetscInt);
68 PETSC_EXTERN PetscErrorCode PetscViewerDrawBaseSet(PetscViewer,PetscInt);
69 PETSC_EXTERN PetscErrorCode PetscViewerDrawGetDrawLG(PetscViewer,PetscInt,PetscDrawLG*);
70 PETSC_EXTERN PetscErrorCode PetscViewerDrawGetDrawAxis(PetscViewer,PetscInt,PetscDrawAxis*);
71 
72 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaOpen(MPI_Comm, int, const char[], const char[], PetscViewer *);
73 PETSC_EXTERN PetscErrorCode PetscViewerSiloOpen(MPI_Comm, const char[], PetscViewer *);
74 PETSC_EXTERN PetscErrorCode PetscViewerMatlabOpen(MPI_Comm,const char[],PetscFileMode,PetscViewer*);
75 
76 /*E
77     PetscViewerGLVisType - indicates what type of GLVis viewer to use
78 
79     Level: beginner
80 
81 .seealso: PetscViewerGLVisOpen()
82 E*/
83 typedef enum {PETSC_VIEWER_GLVIS_DUMP, PETSC_VIEWER_GLVIS_SOCKET} PetscViewerGLVisType;
84 PETSC_EXTERN PetscErrorCode PetscViewerGLVisOpen(MPI_Comm,PetscViewerGLVisType,const char*,PetscInt,PetscViewer*);
85 PETSC_EXTERN PetscErrorCode PetscViewerGLVisSetPrecision(PetscViewer,PetscInt);
86 PETSC_EXTERN PetscErrorCode PetscViewerGLVisSetSnapId(PetscViewer,PetscInt);
87 PETSC_EXTERN PetscErrorCode PetscViewerGLVisSetFields(PetscViewer,PetscInt,const char*[],PetscInt[],PetscErrorCode(*)(PetscObject,PetscInt,PetscObject[],void*),PetscObject[],void*,PetscErrorCode(*)(void*));
88 
89 PETSC_EXTERN PetscErrorCode PetscViewerGetType(PetscViewer,PetscViewerType*);
90 PETSC_EXTERN PetscErrorCode PetscViewerSetType(PetscViewer,PetscViewerType);
91 PETSC_EXTERN PetscErrorCode PetscViewerDestroy(PetscViewer*);
92 PETSC_EXTERN PetscErrorCode PetscViewerGetSubViewer(PetscViewer,MPI_Comm,PetscViewer*);
93 PETSC_EXTERN PetscErrorCode PetscViewerRestoreSubViewer(PetscViewer,MPI_Comm,PetscViewer*);
94 
95 PETSC_EXTERN PetscErrorCode PetscViewerSetUp(PetscViewer);
96 PETSC_EXTERN PetscErrorCode PetscViewerView(PetscViewer,PetscViewer);
97 PETSC_STATIC_INLINE PetscErrorCode PetscViewerViewFromOptions(PetscViewer A,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,name);}
98 
99 PETSC_EXTERN PetscErrorCode PetscViewerSetOptionsPrefix(PetscViewer,const char[]);
100 PETSC_EXTERN PetscErrorCode PetscViewerAppendOptionsPrefix(PetscViewer,const char[]);
101 PETSC_EXTERN PetscErrorCode PetscViewerGetOptionsPrefix(PetscViewer,const char*[]);
102 
103 /*E
104     PetscViewerFormat - Way a viewer presents the object
105 
106    Level: beginner
107 
108 .seealso: PetscViewer, PetscViewerType, PetscViewerPushFormat(), PetscViewerPopFormat()
109 E*/
110 typedef enum {
111   PETSC_VIEWER_DEFAULT,
112   PETSC_VIEWER_ASCII_MATLAB,
113   PETSC_VIEWER_ASCII_MATHEMATICA,
114   PETSC_VIEWER_ASCII_IMPL,
115   PETSC_VIEWER_ASCII_INFO,
116   PETSC_VIEWER_ASCII_INFO_DETAIL,
117   PETSC_VIEWER_ASCII_COMMON,
118   PETSC_VIEWER_ASCII_SYMMODU,
119   PETSC_VIEWER_ASCII_INDEX,
120   PETSC_VIEWER_ASCII_DENSE,
121   PETSC_VIEWER_ASCII_MATRIXMARKET,
122   PETSC_VIEWER_ASCII_VTK,
123   PETSC_VIEWER_ASCII_VTK_CELL,
124   PETSC_VIEWER_ASCII_VTK_COORDS,
125   PETSC_VIEWER_ASCII_PCICE,
126   PETSC_VIEWER_ASCII_PYTHON,
127   PETSC_VIEWER_ASCII_FACTOR_INFO,
128   PETSC_VIEWER_ASCII_LATEX,
129   PETSC_VIEWER_ASCII_XML,
130   PETSC_VIEWER_ASCII_GLVIS,
131   PETSC_VIEWER_DRAW_BASIC,
132   PETSC_VIEWER_DRAW_LG,
133   PETSC_VIEWER_DRAW_CONTOUR,
134   PETSC_VIEWER_DRAW_PORTS,
135   PETSC_VIEWER_VTK_VTS,
136   PETSC_VIEWER_VTK_VTR,
137   PETSC_VIEWER_VTK_VTU,
138   PETSC_VIEWER_BINARY_MATLAB,
139   PETSC_VIEWER_NATIVE,
140   PETSC_VIEWER_HDF5_PETSC,
141   PETSC_VIEWER_HDF5_VIZ,
142   PETSC_VIEWER_HDF5_XDMF,
143   PETSC_VIEWER_NOFORMAT,
144   PETSC_VIEWER_LOAD_BALANCE
145   } PetscViewerFormat;
146 PETSC_EXTERN const char *const PetscViewerFormats[];
147 
148 PETSC_EXTERN PETSC_DEPRECATED("Use PetscViewerPushFormat()/PetscViewerPopFormat()") PetscErrorCode PetscViewerSetFormat(PetscViewer,PetscViewerFormat);
149 PETSC_EXTERN PetscErrorCode PetscViewerPushFormat(PetscViewer,PetscViewerFormat);
150 PETSC_EXTERN PetscErrorCode PetscViewerPopFormat(PetscViewer);
151 PETSC_EXTERN PetscErrorCode PetscViewerGetFormat(PetscViewer,PetscViewerFormat*);
152 PETSC_EXTERN PetscErrorCode PetscViewerFlush(PetscViewer);
153 
154 PETSC_EXTERN PetscErrorCode PetscOptionsPushGetViewerOff(PetscBool);
155 PETSC_EXTERN PetscErrorCode PetscOptionsPopGetViewerOff(void);
156 PETSC_EXTERN PetscErrorCode PetscOptionsGetViewerOff(PetscBool*);
157 PETSC_EXTERN PetscErrorCode PetscOptionsGetViewer(MPI_Comm,const char[],const char[],PetscViewer*,PetscViewerFormat*,PetscBool*);
158 #define PetscOptionsViewer(a,b,c,d,e,f) PetscOptionsViewer_Private(PetscOptionsObject,a,b,c,d,e,f);
159 PETSC_EXTERN PetscErrorCode PetscOptionsViewer_Private(PetscOptionItems*,const char[],const char[],const char[],PetscViewer*,PetscViewerFormat *,PetscBool *);
160 
161 typedef struct {PetscViewer viewer;PetscViewerFormat format;} PetscViewerAndFormat;
162 PETSC_EXTERN PetscErrorCode  PetscViewerAndFormatCreate(PetscViewer,PetscViewerFormat,PetscViewerAndFormat**);
163 PETSC_EXTERN PetscErrorCode  PetscViewerAndFormatDestroy(PetscViewerAndFormat**);
164 
165 /*
166    Operations explicit to a particular class of viewers
167 */
168 
169 PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetPointer(PetscViewer,FILE**);
170 PETSC_EXTERN PetscErrorCode PetscViewerFileGetMode(PetscViewer,PetscFileMode*);
171 PETSC_EXTERN PetscErrorCode PetscViewerFileSetMode(PetscViewer,PetscFileMode);
172 PETSC_EXTERN PetscErrorCode PetscViewerRead(PetscViewer,void*,PetscInt,PetscInt*,PetscDataType);
173 PETSC_EXTERN PetscErrorCode PetscViewerASCIIPrintf(PetscViewer,const char[],...);
174 PETSC_EXTERN PetscErrorCode PetscViewerASCIISynchronizedPrintf(PetscViewer,const char[],...);
175 PETSC_EXTERN PetscErrorCode PetscViewerASCIIPushSynchronized(PetscViewer);
176 PETSC_EXTERN PetscErrorCode PetscViewerASCIIPopSynchronized(PetscViewer);
177 PETSC_EXTERN PetscErrorCode PetscViewerASCIIPushTab(PetscViewer);
178 PETSC_EXTERN PetscErrorCode PetscViewerASCIIPopTab(PetscViewer);
179 PETSC_EXTERN PetscErrorCode PetscViewerASCIIUseTabs(PetscViewer,PetscBool );
180 PETSC_EXTERN PetscErrorCode PetscViewerASCIISetTab(PetscViewer,PetscInt);
181 PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetTab(PetscViewer,PetscInt*);
182 PETSC_EXTERN PetscErrorCode PetscViewerASCIIAddTab(PetscViewer,PetscInt);
183 PETSC_EXTERN PetscErrorCode PetscViewerASCIISubtractTab(PetscViewer,PetscInt);
184 PETSC_EXTERN PetscErrorCode PetscViewerASCIIRead(PetscViewer,void *,PetscInt,PetscInt*,PetscDataType);
185 PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetDescriptor(PetscViewer,int*);
186 PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetInfoPointer(PetscViewer,FILE **);
187 PETSC_EXTERN PetscErrorCode PetscViewerBinaryRead(PetscViewer,void*,PetscInt,PetscInt*,PetscDataType);
188 PETSC_EXTERN PetscErrorCode PetscViewerBinaryWrite(PetscViewer,void*,PetscInt,PetscDataType,PetscBool );
189 PETSC_EXTERN PetscErrorCode PetscViewerStringSPrintf(PetscViewer,const char[],...);
190 PETSC_EXTERN PetscErrorCode PetscViewerStringSetString(PetscViewer,char[],PetscInt);
191 PETSC_EXTERN PetscErrorCode PetscViewerDrawClear(PetscViewer);
192 PETSC_EXTERN PetscErrorCode PetscViewerDrawSetHold(PetscViewer,PetscBool);
193 PETSC_EXTERN PetscErrorCode PetscViewerDrawGetHold(PetscViewer,PetscBool*);
194 PETSC_EXTERN PetscErrorCode PetscViewerDrawSetPause(PetscViewer,PetscReal);
195 PETSC_EXTERN PetscErrorCode PetscViewerDrawGetPause(PetscViewer,PetscReal*);
196 PETSC_EXTERN PetscErrorCode PetscViewerDrawSetInfo(PetscViewer,const char[],const char[],int,int,int,int);
197 PETSC_EXTERN PetscErrorCode PetscViewerDrawResize(PetscViewer,int,int);
198 PETSC_EXTERN PetscErrorCode PetscViewerDrawSetBounds(PetscViewer,PetscInt,const PetscReal*);
199 PETSC_EXTERN PetscErrorCode PetscViewerDrawGetBounds(PetscViewer,PetscInt*,const PetscReal**);
200 PETSC_EXTERN PetscErrorCode PetscViewerSocketSetConnection(PetscViewer,const char[],int);
201 PETSC_EXTERN PetscErrorCode PetscViewerBinarySkipInfo(PetscViewer);
202 PETSC_EXTERN PetscErrorCode PetscViewerBinarySetSkipInfo(PetscViewer,PetscBool);
203 PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetSkipInfo(PetscViewer,PetscBool*);
204 PETSC_EXTERN PetscErrorCode PetscViewerBinarySetSkipOptions(PetscViewer,PetscBool );
205 PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetSkipOptions(PetscViewer,PetscBool *);
206 PETSC_EXTERN PetscErrorCode PetscViewerBinarySetSkipHeader(PetscViewer,PetscBool);
207 PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetSkipHeader(PetscViewer,PetscBool*);
208 PETSC_EXTERN PetscErrorCode PetscViewerBinaryReadStringArray(PetscViewer,char***);
209 PETSC_EXTERN PetscErrorCode PetscViewerBinaryWriteStringArray(PetscViewer,const char *const*);
210 
211 PETSC_EXTERN PetscErrorCode PetscViewerFileSetName(PetscViewer,const char[]);
212 PETSC_EXTERN PetscErrorCode PetscViewerFileGetName(PetscViewer,const char**);
213 
214 PETSC_EXTERN PetscErrorCode PetscViewerVUGetPointer(PetscViewer, FILE**);
215 PETSC_EXTERN PetscErrorCode PetscViewerVUSetVecSeen(PetscViewer, PetscBool );
216 PETSC_EXTERN PetscErrorCode PetscViewerVUGetVecSeen(PetscViewer, PetscBool  *);
217 PETSC_EXTERN PetscErrorCode PetscViewerVUPrintDeferred(PetscViewer, const char [], ...);
218 PETSC_EXTERN PetscErrorCode PetscViewerVUFlushDeferred(PetscViewer);
219 
220 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaInitializePackage(void);
221 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaFinalizePackage(void);
222 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaGetName(PetscViewer, const char **);
223 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaSetName(PetscViewer, const char []);
224 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaClearName(PetscViewer);
225 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaSkipPackets(PetscViewer, int);
226 
227 PETSC_EXTERN PetscErrorCode PetscViewerSiloGetName(PetscViewer, char **);
228 PETSC_EXTERN PetscErrorCode PetscViewerSiloSetName(PetscViewer, const char []);
229 PETSC_EXTERN PetscErrorCode PetscViewerSiloClearName(PetscViewer);
230 PETSC_EXTERN PetscErrorCode PetscViewerSiloGetMeshName(PetscViewer, char **);
231 PETSC_EXTERN PetscErrorCode PetscViewerSiloSetMeshName(PetscViewer, const char []);
232 PETSC_EXTERN PetscErrorCode PetscViewerSiloClearMeshName(PetscViewer);
233 
234 typedef enum {PETSC_VTK_POINT_FIELD, PETSC_VTK_POINT_VECTOR_FIELD, PETSC_VTK_CELL_FIELD, PETSC_VTK_CELL_VECTOR_FIELD} PetscViewerVTKFieldType;
235 PETSC_EXTERN PetscErrorCode PetscViewerVTKAddField(PetscViewer,PetscObject,PetscErrorCode (*PetscViewerVTKWriteFunction)(PetscObject,PetscViewer),PetscViewerVTKFieldType,PetscObject);
236 PETSC_EXTERN PetscErrorCode PetscViewerVTKOpen(MPI_Comm,const char[],PetscFileMode,PetscViewer*);
237 
238 /*
239      These are all the default viewers that do not have to be explicitly opened
240 */
241 PETSC_EXTERN PetscViewer    PETSC_VIEWER_STDOUT_(MPI_Comm);
242 PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetStdout(MPI_Comm,PetscViewer*);
243 PETSC_EXTERN PetscViewer    PETSC_VIEWER_STDERR_(MPI_Comm);
244 PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetStderr(MPI_Comm,PetscViewer*);
245 PETSC_EXTERN PetscViewer    PETSC_VIEWER_DRAW_(MPI_Comm);
246 PETSC_EXTERN PetscViewer    PETSC_VIEWER_SOCKET_(MPI_Comm);
247 PETSC_EXTERN PetscViewer    PETSC_VIEWER_BINARY_(MPI_Comm);
248 PETSC_EXTERN PetscViewer    PETSC_VIEWER_MATLAB_(MPI_Comm);
249 PETSC_EXTERN PetscViewer    PETSC_VIEWER_HDF5_(MPI_Comm);
250 PETSC_EXTERN PetscViewer    PETSC_VIEWER_GLVIS_(MPI_Comm);
251 PETSC_EXTERN PetscViewer    PETSC_VIEWER_MATHEMATICA_WORLD_PRIVATE;
252 
253 #define PETSC_VIEWER_STDERR_SELF  PETSC_VIEWER_STDERR_(PETSC_COMM_SELF)
254 #define PETSC_VIEWER_STDERR_WORLD PETSC_VIEWER_STDERR_(PETSC_COMM_WORLD)
255 
256 /*MC
257   PETSC_VIEWER_STDOUT_WORLD  - same as PETSC_VIEWER_STDOUT_(PETSC_COMM_WORLD)
258 
259   Level: beginner
260 M*/
261 #define PETSC_VIEWER_STDOUT_WORLD PETSC_VIEWER_STDOUT_(PETSC_COMM_WORLD)
262 
263 /*MC
264   PETSC_VIEWER_STDOUT_SELF  - same as PETSC_VIEWER_STDOUT_(PETSC_COMM_SELF)
265 
266   Level: beginner
267 M*/
268 #define PETSC_VIEWER_STDOUT_SELF  PETSC_VIEWER_STDOUT_(PETSC_COMM_SELF)
269 
270 /*MC
271   PETSC_VIEWER_DRAW_WORLD  - same as PETSC_VIEWER_DRAW_(PETSC_COMM_WORLD)
272 
273   Level: intermediate
274 M*/
275 #define PETSC_VIEWER_DRAW_WORLD   PETSC_VIEWER_DRAW_(PETSC_COMM_WORLD)
276 
277 /*MC
278   PETSC_VIEWER_DRAW_SELF  - same as PETSC_VIEWER_DRAW_(PETSC_COMM_SELF)
279 
280   Level: intermediate
281 M*/
282 #define PETSC_VIEWER_DRAW_SELF    PETSC_VIEWER_DRAW_(PETSC_COMM_SELF)
283 
284 /*MC
285   PETSC_VIEWER_SOCKET_WORLD  - same as PETSC_VIEWER_SOCKET_(PETSC_COMM_WORLD)
286 
287   Level: intermediate
288 M*/
289 #define PETSC_VIEWER_SOCKET_WORLD PETSC_VIEWER_SOCKET_(PETSC_COMM_WORLD)
290 
291 /*MC
292   PETSC_VIEWER_SOCKET_SELF  - same as PETSC_VIEWER_SOCKET_(PETSC_COMM_SELF)
293 
294   Level: intermediate
295 M*/
296 #define PETSC_VIEWER_SOCKET_SELF  PETSC_VIEWER_SOCKET_(PETSC_COMM_SELF)
297 
298 /*MC
299   PETSC_VIEWER_BINARY_WORLD  - same as PETSC_VIEWER_BINARY_(PETSC_COMM_WORLD)
300 
301   Level: intermediate
302 M*/
303 #define PETSC_VIEWER_BINARY_WORLD PETSC_VIEWER_BINARY_(PETSC_COMM_WORLD)
304 
305 /*MC
306   PETSC_VIEWER_BINARY_SELF  - same as PETSC_VIEWER_BINARY_(PETSC_COMM_SELF)
307 
308   Level: intermediate
309 M*/
310 #define PETSC_VIEWER_BINARY_SELF  PETSC_VIEWER_BINARY_(PETSC_COMM_SELF)
311 
312 /*MC
313   PETSC_VIEWER_MATLAB_WORLD  - same as PETSC_VIEWER_MATLAB_(PETSC_COMM_WORLD)
314 
315   Level: intermediate
316 M*/
317 #define PETSC_VIEWER_MATLAB_WORLD PETSC_VIEWER_MATLAB_(PETSC_COMM_WORLD)
318 
319 /*MC
320   PETSC_VIEWER_MATLAB_SELF  - same as PETSC_VIEWER_MATLAB_(PETSC_COMM_SELF)
321 
322   Level: intermediate
323 M*/
324 #define PETSC_VIEWER_MATLAB_SELF  PETSC_VIEWER_MATLAB_(PETSC_COMM_SELF)
325 
326 #define PETSC_VIEWER_MATHEMATICA_WORLD (PetscViewerInitializeMathematicaWorld_Private(),PETSC_VIEWER_MATHEMATICA_WORLD_PRIVATE)
327 
328 PETSC_EXTERN PetscErrorCode PetscViewerFlowControlStart(PetscViewer,PetscInt*,PetscInt*);
329 PETSC_EXTERN PetscErrorCode PetscViewerFlowControlStepMaster(PetscViewer,PetscInt,PetscInt*,PetscInt);
330 PETSC_EXTERN PetscErrorCode PetscViewerFlowControlEndMaster(PetscViewer,PetscInt*);
331 PETSC_EXTERN PetscErrorCode PetscViewerFlowControlStepWorker(PetscViewer,PetscMPIInt,PetscInt*);
332 PETSC_EXTERN PetscErrorCode PetscViewerFlowControlEndWorker(PetscViewer,PetscInt*);
333 
334 /*
335    PetscViewer writes to MATLAB .mat file
336 */
337 PETSC_EXTERN PetscErrorCode PetscViewerMatlabPutArray(PetscViewer,int,int,const PetscScalar*,const char*);
338 PETSC_EXTERN PetscErrorCode PetscViewerMatlabGetArray(PetscViewer,int,int,PetscScalar*,const char*);
339 PETSC_EXTERN PetscErrorCode PetscViewerMatlabPutVariable(PetscViewer,const char*,void*);
340 
341 #if defined(PETSC_HAVE_SAWS)
342 PETSC_EXTERN PetscErrorCode PetscObjectViewSAWs(PetscObject,PetscViewer);
343 #endif
344 
345 /*S
346      PetscViewers - Abstract collection of PetscViewers. It is just an expandable array of viewers.
347 
348    Level: intermediate
349 
350   Concepts: viewing
351 
352 .seealso:  PetscViewerCreate(), PetscViewerSetType(), PetscViewerType, PetscViewer, PetscViewersCreate(),
353            PetscViewersGetViewer()
354 S*/
355 typedef struct _n_PetscViewers* PetscViewers;
356 PETSC_EXTERN PetscErrorCode PetscViewersCreate(MPI_Comm,PetscViewers*);
357 PETSC_EXTERN PetscErrorCode PetscViewersDestroy(PetscViewers*);
358 PETSC_EXTERN PetscErrorCode PetscViewersGetViewer(PetscViewers,PetscInt,PetscViewer*);
359 
360 #endif
361