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