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