xref: /petsc/include/petscviewer.h (revision efe48dd8cf8b935accbbb9f4bcb20bc83865fa4d)
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 #if defined(PETSC_USE_EXTERN_CXX) && defined(__cplusplus)
9 extern "C" {
10 #endif
11 
12 /*S
13      PetscViewer - Abstract PETSc object that helps view (in ASCII, binary, graphically etc)
14          other PETSc objects
15 
16    Level: beginner
17 
18   Concepts: viewing
19 
20 .seealso:  PetscViewerCreate(), PetscViewerSetType(), PetscViewerType
21 S*/
22 typedef struct _p_PetscViewer* PetscViewer;
23 
24 #if defined(PETSC_USE_EXTERN_CXX) && defined(__cplusplus)
25 }
26 #endif
27 
28 #include "petscsys.h"
29 
30 #if defined(PETSC_USE_EXTERN_CXX) && defined(__cplusplus)
31 extern "C" {
32 #endif
33 
34 extern PETSCSYS_DLLEXPORT PetscClassId PETSC_VIEWER_CLASSID;
35 
36 #if defined(PETSC_USE_EXTERN_CXX) && defined(__cplusplus)
37 }
38 #endif
39 
40 
41 /*
42     petscsys.h must be included AFTER the definition of PetscViewer for ADIC to
43    process correctly.
44 */
45 PETSC_EXTERN_CXX_BEGIN
46 /*E
47     PetscViewerType - String with the name of a PETSc PETScViewer
48 
49    Level: beginner
50 
51 .seealso: PetscViewerSetType(), PetscViewer
52 E*/
53 #define PetscViewerType char*
54 #define PETSCVIEWERSOCKET       "socket"
55 #define PETSCVIEWERASCII        "ascii"
56 #define PETSCVIEWERBINARY       "binary"
57 #define PETSCVIEWERSTRING       "string"
58 #define PETSCVIEWERDRAW         "draw"
59 #define PETSCVIEWERVU           "vu"
60 #define PETSCVIEWERMATHEMATICA  "mathematica"
61 #define PETSCVIEWERNETCDF       "netcdf"
62 #define PETSCVIEWERHDF5         "hdf5"
63 #define PETSCVIEWERMATLAB       "matlab"
64 #define PETSCVIEWERAMS          "ams"
65 
66 extern PetscFList PetscViewerList;
67 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerRegisterAll(const char *);
68 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerRegisterDestroy(void);
69 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerInitializePackage(const char[]);
70 
71 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerRegister(const char*,const char*,const char*,PetscErrorCode (*)(PetscViewer));
72 
73 /*MC
74    PetscViewerRegisterDynamic - Adds a viewer
75 
76    Synopsis:
77    PetscErrorCode PetscViewerRegisterDynamic(const char *name_solver,const char *path,const char *name_create,PetscErrorCode (*routine_create)(PetscViewer))
78 
79    Not Collective
80 
81    Input Parameters:
82 +  name_solver - name of a new user-defined viewer
83 .  path - path (either absolute or relative) the library containing this viewer
84 .  name_create - name of routine to create method context
85 -  routine_create - routine to create method context
86 
87    Level: developer
88 
89    Notes:
90    PetscViewerRegisterDynamic() may be called multiple times to add several user-defined viewers.
91 
92    If dynamic libraries are used, then the fourth input argument (routine_create)
93    is ignored.
94 
95    Sample usage:
96 .vb
97    PetscViewerRegisterDynamic("my_viewer_type",/home/username/my_lib/lib/libO/solaris/mylib.a,
98                "MyViewerCreate",MyViewerCreate);
99 .ve
100 
101    Then, your solver can be chosen with the procedural interface via
102 $     PetscViewerSetType(viewer,"my_viewer_type")
103    or at runtime via the option
104 $     -viewer_type my_viewer_type
105 
106   Concepts: registering^Viewers
107 
108 .seealso: PetscViewerRegisterAll(), PetscViewerRegisterDestroy()
109 M*/
110 #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
111 #define PetscViewerRegisterDynamic(a,b,c,d) PetscViewerRegister(a,b,c,0)
112 #else
113 #define PetscViewerRegisterDynamic(a,b,c,d) PetscViewerRegister(a,b,c,d)
114 #endif
115 
116 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerCreate(MPI_Comm,PetscViewer*);
117 PetscPolymorphicSubroutine(PetscViewerCreate,(PetscViewer *v),(PETSC_COMM_SELF,v))
118 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerSetFromOptions(PetscViewer);
119 
120 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerASCIIOpen(MPI_Comm,const char[],PetscViewer*);
121 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerBinaryCreate(MPI_Comm,PetscViewer*);
122 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerBinaryOpen(MPI_Comm,const char[],PetscFileMode,PetscViewer*);
123 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerBinaryGetFlowControl(PetscViewer,PetscInt*);
124 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerBinarySetFlowControl(PetscViewer,PetscInt);
125 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerBinarySetMPIIO(PetscViewer);
126 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerBinaryGetMPIIO(PetscViewer,PetscBool *);
127 #if defined(PETSC_HAVE_MPIIO)
128 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerBinaryGetMPIIODescriptor(PetscViewer,MPI_File*);
129 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerBinaryGetMPIIOOffset(PetscViewer,MPI_Offset*);
130 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerBinaryAddMPIIOOffset(PetscViewer,MPI_Offset);
131 #endif
132 
133 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerSocketOpen(MPI_Comm,const char[],int,PetscViewer*);
134 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerStringOpen(MPI_Comm,char[],PetscInt,PetscViewer*);
135 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerDrawOpen(MPI_Comm,const char[],const char[],int,int,int,int,PetscViewer*);
136 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerMathematicaOpen(MPI_Comm, int, const char[], const char[], PetscViewer *);
137 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerSiloOpen(MPI_Comm, const char[], PetscViewer *);
138 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerMatlabOpen(MPI_Comm,const char[],PetscFileMode,PetscViewer*);
139 
140 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerGetType(PetscViewer,const PetscViewerType*);
141 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerSetType(PetscViewer,const PetscViewerType);
142 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerDestroy(PetscViewer);
143 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerGetSingleton(PetscViewer,PetscViewer*);
144 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerRestoreSingleton(PetscViewer,PetscViewer*);
145 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerGetSubcomm(PetscViewer,MPI_Comm,PetscViewer*);
146 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerRestoreSubcomm(PetscViewer,MPI_Comm,PetscViewer*);
147 
148 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerSetUp(PetscViewer);
149 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerView(PetscViewer,PetscViewer);
150 
151 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerSetOptionsPrefix(PetscViewer,const char[]);
152 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerAppendOptionsPrefix(PetscViewer,const char[]);
153 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerGetOptionsPrefix(PetscViewer,const char*[]);
154 
155 /*E
156     PetscViewerFormat - Way a viewer presents the object
157 
158    Level: beginner
159 
160    The values below are also listed in finclude/petscviewer.h. If another values is added below it
161    must also be added there.
162 
163 .seealso: PetscViewerSetFormat(), PetscViewer, PetscViewerType, PetscViewerPushFormat(), PetscViewerPopFormat()
164 E*/
165 typedef enum {
166   PETSC_VIEWER_DEFAULT,
167   PETSC_VIEWER_ASCII_MATLAB,
168   PETSC_VIEWER_ASCII_MATHEMATICA,
169   PETSC_VIEWER_ASCII_IMPL,
170   PETSC_VIEWER_ASCII_INFO,
171   PETSC_VIEWER_ASCII_INFO_DETAIL,
172   PETSC_VIEWER_ASCII_COMMON,
173   PETSC_VIEWER_ASCII_SYMMODU,
174   PETSC_VIEWER_ASCII_INDEX,
175   PETSC_VIEWER_ASCII_DENSE,
176   PETSC_VIEWER_ASCII_MATRIXMARKET,
177   PETSC_VIEWER_ASCII_VTK,
178   PETSC_VIEWER_ASCII_VTK_CELL,
179   PETSC_VIEWER_ASCII_VTK_COORDS,
180   PETSC_VIEWER_ASCII_PCICE,
181   PETSC_VIEWER_ASCII_PYLITH,
182   PETSC_VIEWER_ASCII_PYLITH_LOCAL,
183   PETSC_VIEWER_ASCII_PYTHON,
184   PETSC_VIEWER_ASCII_FACTOR_INFO,
185   PETSC_VIEWER_DRAW_BASIC,
186   PETSC_VIEWER_DRAW_LG,
187   PETSC_VIEWER_DRAW_CONTOUR,
188   PETSC_VIEWER_DRAW_PORTS,
189   PETSC_VIEWER_NATIVE,
190   PETSC_VIEWER_NOFORMAT
191   } PetscViewerFormat;
192 
193 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerSetFormat(PetscViewer,PetscViewerFormat);
194 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerPushFormat(PetscViewer,PetscViewerFormat);
195 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerPopFormat(PetscViewer);
196 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerGetFormat(PetscViewer,PetscViewerFormat*);
197 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerFlush(PetscViewer);
198 
199 /*S
200      PetscViewerASCIIMonitor - Context for the default KSP, SNES and TS monitors that print
201                                   ASCII strings of residual norms etc.
202 
203 
204    Level: advanced
205 
206   Concepts: viewing, monitoring
207 
208 .seealso:  PetscViewerCreate(), PetscViewerSetType(), PetscViewerType, KSPMonitorSet(), SNESMonitorSet(), TSMonitorSet(),
209            KSPMonitorDefault(), SNESMonitorDefault()
210 
211 S*/
212 struct _n_PetscViewerASCIIMonitor {
213   PetscViewer viewer;
214   PetscInt    tabs;
215 };
216 typedef struct _n_PetscViewerASCIIMonitor* PetscViewerASCIIMonitor;
217 
218 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerASCIIMonitorCreate(MPI_Comm,const char *,PetscInt,PetscViewerASCIIMonitor*);
219 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerASCIIMonitorDestroy(PetscViewerASCIIMonitor);
220 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerASCIIMonitorPrintf(PetscViewerASCIIMonitor,const char[],...);
221 
222 /*
223    Operations explicit to a particular class of viewers
224 */
225 
226 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerASCIIGetPointer(PetscViewer,FILE**);
227 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerFileGetMode(PetscViewer,PetscFileMode*);
228 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerFileSetMode(PetscViewer,PetscFileMode);
229 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerASCIIPrintf(PetscViewer,const char[],...) PETSC_PRINTF_FORMAT_CHECK(2,3);
230 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerASCIISynchronizedPrintf(PetscViewer,const char[],...) PETSC_PRINTF_FORMAT_CHECK(2,3);
231 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerASCIIPushTab(PetscViewer);
232 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerASCIIPopTab(PetscViewer);
233 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerASCIIUseTabs(PetscViewer,PetscBool );
234 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerASCIISetTab(PetscViewer,PetscInt);
235 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerBinaryGetDescriptor(PetscViewer,int*);
236 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerBinaryGetInfoPointer(PetscViewer,FILE **);
237 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerBinaryRead(PetscViewer,void*,PetscInt,PetscDataType);
238 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerBinaryWrite(PetscViewer,void*,PetscInt,PetscDataType,PetscBool );
239 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerStringSPrintf(PetscViewer,const char[],...) PETSC_PRINTF_FORMAT_CHECK(2,3);
240 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerStringSetString(PetscViewer,char[],PetscInt);
241 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerDrawClear(PetscViewer);
242 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerDrawSetInfo(PetscViewer,const char[],const char[],int,int,int,int);
243 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerSocketSetConnection(PetscViewer,const char[],int);
244 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerBinarySkipInfo(PetscViewer);
245 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerBinarySetSkipOptions(PetscViewer,PetscBool );
246 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerBinaryGetSkipOptions(PetscViewer,PetscBool *);
247 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerBinaryReadStringArray(PetscViewer,char***);
248 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerBinaryWriteStringArray(PetscViewer,char**);
249 
250 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerFileSetName(PetscViewer,const char[]);
251 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerFileGetName(PetscViewer,char**);
252 
253 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscPLAPACKInitializePackage(MPI_Comm com);
254 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscPLAPACKFinalizePackage(void);
255 
256 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerVUGetPointer(PetscViewer, FILE**);
257 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerVUSetVecSeen(PetscViewer, PetscBool );
258 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerVUGetVecSeen(PetscViewer, PetscBool  *);
259 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerVUPrintDeferred(PetscViewer, const char [], ...) PETSC_PRINTF_FORMAT_CHECK(2,3);
260 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerVUFlushDeferred(PetscViewer);
261 
262 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerMathematicaInitializePackage(const char[]);
263 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerMathematicaFinalizePackage(void);
264 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerMathematicaGetName(PetscViewer, const char **);
265 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerMathematicaSetName(PetscViewer, const char []);
266 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerMathematicaClearName(PetscViewer);
267 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerMathematicaSkipPackets(PetscViewer, int);
268 
269 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerSiloGetName(PetscViewer, char **);
270 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerSiloSetName(PetscViewer, const char []);
271 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerSiloClearName(PetscViewer);
272 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerSiloGetMeshName(PetscViewer, char **);
273 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerSiloSetMeshName(PetscViewer, const char []);
274 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerSiloClearMeshName(PetscViewer);
275 
276 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerNetcdfOpen(MPI_Comm,const char[],PetscFileMode,PetscViewer*);
277 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerNetcdfGetID(PetscViewer, int *);
278 
279 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerHDF5WriteSDS(PetscViewer,float *,int,int *,int);
280 
281 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerHDF5Open(MPI_Comm,const char[],PetscFileMode,PetscViewer*);
282 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerHDF5PushGroup(PetscViewer,const char *);
283 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerHDF5PopGroup(PetscViewer);
284 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerHDF5GetGroup(PetscViewer, const char **);
285 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerHDF5SetTimestep(PetscViewer,PetscInt);
286 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerHDF5GetTimestep(PetscViewer,PetscInt*);
287 #ifdef PETSC_HAVE_HDF5
288 #include <hdf5.h>
289 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerHDF5GetFileId(PetscViewer,hid_t*);
290 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerHDF5OpenGroup(PetscViewer, hid_t *, hid_t *);
291 #endif
292 
293 /*
294      These are all the default viewers that do not have
295    to be explicitly opened
296 */
297 EXTERN PetscViewer PETSCSYS_DLLEXPORT PETSC_VIEWER_STDOUT_(MPI_Comm);
298 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerASCIIGetStdout(MPI_Comm,PetscViewer*);
299 EXTERN PetscViewer PETSCSYS_DLLEXPORT PETSC_VIEWER_STDERR_(MPI_Comm);
300 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerASCIIGetStderr(MPI_Comm,PetscViewer*);
301 EXTERN PetscViewer PETSCSYS_DLLEXPORT PETSC_VIEWER_DRAW_(MPI_Comm);
302 EXTERN PetscViewer PETSCSYS_DLLEXPORT PETSC_VIEWER_SOCKET_(MPI_Comm);
303 EXTERN PetscViewer PETSCSYS_DLLEXPORT PETSC_VIEWER_BINARY_(MPI_Comm);
304 EXTERN PetscViewer PETSCSYS_DLLEXPORT PETSC_VIEWER_MATLAB_(MPI_Comm);
305 EXTERN PetscViewer PETSC_VIEWER_MATHEMATICA_WORLD_PRIVATE;
306 
307 #define PETSC_VIEWER_STDERR_SELF  PETSC_VIEWER_STDERR_(PETSC_COMM_SELF)
308 #define PETSC_VIEWER_STDERR_WORLD PETSC_VIEWER_STDERR_(PETSC_COMM_WORLD)
309 
310 /*MC
311   PETSC_VIEWER_STDOUT_WORLD  - same as PETSC_VIEWER_STDOUT_(PETSC_COMM_WORLD)
312 
313   Level: beginner
314 M*/
315 #define PETSC_VIEWER_STDOUT_WORLD PETSC_VIEWER_STDOUT_(PETSC_COMM_WORLD)
316 
317 /*MC
318   PETSC_VIEWER_STDOUT_SELF  - same as PETSC_VIEWER_STDOUT_(PETSC_COMM_SELF)
319 
320   Level: beginner
321 M*/
322 #define PETSC_VIEWER_STDOUT_SELF  PETSC_VIEWER_STDOUT_(PETSC_COMM_SELF)
323 
324 /*MC
325   PETSC_VIEWER_DRAW_WORLD  - same as PETSC_VIEWER_DRAW_(PETSC_COMM_WORLD)
326 
327   Level: intermediate
328 M*/
329 #define PETSC_VIEWER_DRAW_WORLD   PETSC_VIEWER_DRAW_(PETSC_COMM_WORLD)
330 
331 /*MC
332   PETSC_VIEWER_DRAW_SELF  - same as PETSC_VIEWER_DRAW_(PETSC_COMM_SELF)
333 
334   Level: intermediate
335 M*/
336 #define PETSC_VIEWER_DRAW_SELF    PETSC_VIEWER_DRAW_(PETSC_COMM_SELF)
337 
338 /*MC
339   PETSC_VIEWER_SOCKET_WORLD  - same as PETSC_VIEWER_SOCKET_(PETSC_COMM_WORLD)
340 
341   Level: intermediate
342 M*/
343 #define PETSC_VIEWER_SOCKET_WORLD PETSC_VIEWER_SOCKET_(PETSC_COMM_WORLD)
344 
345 /*MC
346   PETSC_VIEWER_SOCKET_SELF  - same as PETSC_VIEWER_SOCKET_(PETSC_COMM_SELF)
347 
348   Level: intermediate
349 M*/
350 #define PETSC_VIEWER_SOCKET_SELF  PETSC_VIEWER_SOCKET_(PETSC_COMM_SELF)
351 
352 /*MC
353   PETSC_VIEWER_BINARY_WORLD  - same as PETSC_VIEWER_BINARY_(PETSC_COMM_WORLD)
354 
355   Level: intermediate
356 M*/
357 #define PETSC_VIEWER_BINARY_WORLD PETSC_VIEWER_BINARY_(PETSC_COMM_WORLD)
358 
359 /*MC
360   PETSC_VIEWER_BINARY_SELF  - same as PETSC_VIEWER_BINARY_(PETSC_COMM_SELF)
361 
362   Level: intermediate
363 M*/
364 #define PETSC_VIEWER_BINARY_SELF  PETSC_VIEWER_BINARY_(PETSC_COMM_SELF)
365 
366 /*MC
367   PETSC_VIEWER_MATLAB_WORLD  - same as PETSC_VIEWER_MATLAB_(PETSC_COMM_WORLD)
368 
369   Level: intermediate
370 M*/
371 #define PETSC_VIEWER_MATLAB_WORLD PETSC_VIEWER_MATLAB_(PETSC_COMM_WORLD)
372 
373 /*MC
374   PETSC_VIEWER_MATLAB_SELF  - same as PETSC_VIEWER_MATLAB_(PETSC_COMM_SELF)
375 
376   Level: intermediate
377 M*/
378 #define PETSC_VIEWER_MATLAB_SELF  PETSC_VIEWER_MATLAB_(PETSC_COMM_SELF)
379 
380 #define PETSC_VIEWER_MATHEMATICA_WORLD (PetscViewerInitializeMathematicaWorld_Private(),PETSC_VIEWER_MATHEMATICA_WORLD_PRIVATE)
381 
382 #define PetscViewerFlowControlStart(viewer,mcnt,cnt)  (PetscViewerBinaryGetFlowControl(viewer,mcnt) || PetscViewerBinaryGetFlowControl(viewer,cnt))
383 #define PetscViewerFlowControlStepMaster(viewer,i,mcnt,cnt) ((i >= mcnt) ?  (mcnt += cnt,MPI_Bcast(&mcnt,1,MPIU_INT,0,((PetscObject)viewer)->comm)) : 0)
384 #define PetscViewerFlowControlEndMaster(viewer,mcnt) (mcnt = 0,MPI_Bcast(&mcnt,1,MPIU_INT,0,((PetscObject)viewer)->comm))
385 #define PetscViewerFlowControlStepWorker(viewer,rank,mcnt) 0; while (1) { PetscErrorCode _ierr; \
386     if (rank < mcnt) break;				\
387   _ierr = MPI_Bcast(&mcnt,1,MPIU_INT,0,((PetscObject)viewer)->comm);CHKERRQ(_ierr);\
388   }
389 #define PetscViewerFlowControlEndWorker(viewer,mcnt) 0; while (1) { PetscErrorCode _ierr; \
390   _ierr = MPI_Bcast(&mcnt,1,MPIU_INT,0,((PetscObject)viewer)->comm);CHKERRQ(_ierr);\
391     if (mcnt == 0) break;				\
392   }
393 
394 /*
395    petscViewer writes to Matlab .mat file
396 */
397 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerMatlabPutArray(PetscViewer,int,int,PetscScalar*,char*);
398 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerMatlabGetArray(PetscViewer,int,int,PetscScalar*,char*);
399 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerMatlabPutVariable(PetscViewer,const char*,void*);
400 
401 /*S
402      PetscViewers - Abstract collection of PetscViewers. It is just an expandable array of viewers.
403 
404    Level: intermediate
405 
406   Concepts: viewing
407 
408 .seealso:  PetscViewerCreate(), PetscViewerSetType(), PetscViewerType, PetscViewer, PetscViewersCreate(),
409            PetscViewersGetViewer()
410 S*/
411 typedef struct _n_PetscViewers* PetscViewers;
412 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewersCreate(MPI_Comm,PetscViewers*);
413 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewersDestroy(PetscViewers);
414 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewersGetViewer(PetscViewers,PetscInt,PetscViewer*);
415 
416 #if defined(PETSC_HAVE_AMS)
417 #include <ams.h>
418 EXTERN PetscErrorCode PetscViewerAMSSetCommName(PetscViewer,const char[]);
419 EXTERN PetscErrorCode PetscViewerAMSGetAMSComm(PetscViewer,AMS_Comm *);
420 EXTERN PetscErrorCode PetscViewerAMSOpen(MPI_Comm,const char[],PetscViewer*);
421 EXTERN PetscErrorCode PetscViewerAMSLock(PetscViewer);
422 EXTERN PetscViewer    PETSC_VIEWER_AMS_(MPI_Comm);
423 EXTERN PetscErrorCode PETSC_VIEWER_AMS_Destroy(MPI_Comm);
424 #define PETSC_VIEWER_AMS_WORLD PETSC_VIEWER_AMS_(PETSC_COMM_WORLD)
425 #endif
426 
427 
428 PETSC_EXTERN_CXX_END
429 #endif
430