xref: /petsc/include/petscviewer.h (revision acfcf0e5ba359b58e6a8a7af3f239cd7334278e8)
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 PetscViewerBinarySetMPIIO(PetscViewer);
125 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerBinaryGetMPIIO(PetscViewer,PetscBool *);
126 #if defined(PETSC_HAVE_MPIIO)
127 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerBinaryGetMPIIODescriptor(PetscViewer,MPI_File*);
128 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerBinaryGetMPIIOOffset(PetscViewer,MPI_Offset*);
129 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerBinaryAddMPIIOOffset(PetscViewer,MPI_Offset);
130 #endif
131 
132 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerSocketOpen(MPI_Comm,const char[],int,PetscViewer*);
133 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerStringOpen(MPI_Comm,char[],PetscInt,PetscViewer*);
134 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerDrawOpen(MPI_Comm,const char[],const char[],int,int,int,int,PetscViewer*);
135 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerMathematicaOpen(MPI_Comm, int, const char[], const char[], PetscViewer *);
136 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerSiloOpen(MPI_Comm, const char[], PetscViewer *);
137 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerMatlabOpen(MPI_Comm,const char[],PetscFileMode,PetscViewer*);
138 
139 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerGetType(PetscViewer,const PetscViewerType*);
140 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerSetType(PetscViewer,const PetscViewerType);
141 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerDestroy(PetscViewer);
142 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerGetSingleton(PetscViewer,PetscViewer*);
143 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerRestoreSingleton(PetscViewer,PetscViewer*);
144 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerGetSubcomm(PetscViewer,MPI_Comm,PetscViewer*);
145 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerRestoreSubcomm(PetscViewer,MPI_Comm,PetscViewer*);
146 
147 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerSetUp(PetscViewer);
148 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerView(PetscViewer,PetscViewer);
149 
150 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerSetOptionsPrefix(PetscViewer,const char[]);
151 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerAppendOptionsPrefix(PetscViewer,const char[]);
152 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerGetOptionsPrefix(PetscViewer,const char*[]);
153 
154 /*E
155     PetscViewerFormat - Way a viewer presents the object
156 
157    Level: beginner
158 
159    The values below are also listed in finclude/petscviewer.h. If another values is added below it
160    must also be added there.
161 
162 .seealso: PetscViewerSetFormat(), PetscViewer, PetscViewerType, PetscViewerPushFormat(), PetscViewerPopFormat()
163 E*/
164 typedef enum {
165   PETSC_VIEWER_DEFAULT,
166   PETSC_VIEWER_ASCII_MATLAB,
167   PETSC_VIEWER_ASCII_MATHEMATICA,
168   PETSC_VIEWER_ASCII_IMPL,
169   PETSC_VIEWER_ASCII_INFO,
170   PETSC_VIEWER_ASCII_INFO_DETAIL,
171   PETSC_VIEWER_ASCII_COMMON,
172   PETSC_VIEWER_ASCII_SYMMODU,
173   PETSC_VIEWER_ASCII_INDEX,
174   PETSC_VIEWER_ASCII_DENSE,
175   PETSC_VIEWER_ASCII_MATRIXMARKET,
176   PETSC_VIEWER_ASCII_VTK,
177   PETSC_VIEWER_ASCII_VTK_CELL,
178   PETSC_VIEWER_ASCII_VTK_COORDS,
179   PETSC_VIEWER_ASCII_PCICE,
180   PETSC_VIEWER_ASCII_PYLITH,
181   PETSC_VIEWER_ASCII_PYLITH_LOCAL,
182   PETSC_VIEWER_ASCII_PYTHON,
183   PETSC_VIEWER_ASCII_FACTOR_INFO,
184   PETSC_VIEWER_DRAW_BASIC,
185   PETSC_VIEWER_DRAW_LG,
186   PETSC_VIEWER_DRAW_CONTOUR,
187   PETSC_VIEWER_DRAW_PORTS,
188   PETSC_VIEWER_NATIVE,
189   PETSC_VIEWER_NOFORMAT
190   } PetscViewerFormat;
191 
192 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerSetFormat(PetscViewer,PetscViewerFormat);
193 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerPushFormat(PetscViewer,PetscViewerFormat);
194 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerPopFormat(PetscViewer);
195 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerGetFormat(PetscViewer,PetscViewerFormat*);
196 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerFlush(PetscViewer);
197 
198 /*S
199      PetscViewerASCIIMonitor - Context for the default KSP, SNES and TS monitors that print
200                                   ASCII strings of residual norms etc.
201 
202 
203    Level: advanced
204 
205   Concepts: viewing, monitoring
206 
207 .seealso:  PetscViewerCreate(), PetscViewerSetType(), PetscViewerType, KSPMonitorSet(), SNESMonitorSet(), TSMonitorSet(),
208            KSPMonitorDefault(), SNESMonitorDefault()
209 
210 S*/
211 struct _n_PetscViewerASCIIMonitor {
212   PetscViewer viewer;
213   PetscInt    tabs;
214 };
215 typedef struct _n_PetscViewerASCIIMonitor* PetscViewerASCIIMonitor;
216 
217 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerASCIIMonitorCreate(MPI_Comm,const char *,PetscInt,PetscViewerASCIIMonitor*);
218 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerASCIIMonitorDestroy(PetscViewerASCIIMonitor);
219 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerASCIIMonitorPrintf(PetscViewerASCIIMonitor,const char[],...);
220 
221 /*
222    Operations explicit to a particular class of viewers
223 */
224 
225 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerASCIIGetPointer(PetscViewer,FILE**);
226 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerFileGetMode(PetscViewer,PetscFileMode*);
227 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerFileSetMode(PetscViewer,PetscFileMode);
228 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerASCIIPrintf(PetscViewer,const char[],...) PETSC_PRINTF_FORMAT_CHECK(2,3);
229 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerASCIISynchronizedPrintf(PetscViewer,const char[],...) PETSC_PRINTF_FORMAT_CHECK(2,3);
230 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerASCIIPushTab(PetscViewer);
231 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerASCIIPopTab(PetscViewer);
232 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerASCIIUseTabs(PetscViewer,PetscBool );
233 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerASCIISetTab(PetscViewer,PetscInt);
234 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerBinaryGetDescriptor(PetscViewer,int*);
235 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerBinaryGetInfoPointer(PetscViewer,FILE **);
236 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerBinaryRead(PetscViewer,void*,PetscInt,PetscDataType);
237 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerBinaryWrite(PetscViewer,void*,PetscInt,PetscDataType,PetscBool );
238 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerStringSPrintf(PetscViewer,const char[],...) PETSC_PRINTF_FORMAT_CHECK(2,3);
239 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerStringSetString(PetscViewer,char[],PetscInt);
240 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerDrawClear(PetscViewer);
241 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerDrawSetInfo(PetscViewer,const char[],const char[],int,int,int,int);
242 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerSocketSetConnection(PetscViewer,const char[],int);
243 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerBinarySkipInfo(PetscViewer);
244 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerBinarySetSkipOptions(PetscViewer,PetscBool );
245 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerBinaryGetSkipOptions(PetscViewer,PetscBool *);
246 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerBinaryReadStringArray(PetscViewer,char***);
247 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerBinaryWriteStringArray(PetscViewer,char**);
248 
249 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerFileSetName(PetscViewer,const char[]);
250 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerFileGetName(PetscViewer,char**);
251 
252 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscPLAPACKInitializePackage(MPI_Comm com);
253 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscPLAPACKFinalizePackage(void);
254 
255 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerVUGetPointer(PetscViewer, FILE**);
256 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerVUSetVecSeen(PetscViewer, PetscBool );
257 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerVUGetVecSeen(PetscViewer, PetscBool  *);
258 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerVUPrintDeferred(PetscViewer, const char [], ...) PETSC_PRINTF_FORMAT_CHECK(2,3);
259 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerVUFlushDeferred(PetscViewer);
260 
261 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerMathematicaInitializePackage(const char[]);
262 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerMathematicaFinalizePackage(void);
263 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerMathematicaGetName(PetscViewer, const char **);
264 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerMathematicaSetName(PetscViewer, const char []);
265 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerMathematicaClearName(PetscViewer);
266 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerMathematicaSkipPackets(PetscViewer, int);
267 
268 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerSiloGetName(PetscViewer, char **);
269 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerSiloSetName(PetscViewer, const char []);
270 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerSiloClearName(PetscViewer);
271 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerSiloGetMeshName(PetscViewer, char **);
272 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerSiloSetMeshName(PetscViewer, const char []);
273 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerSiloClearMeshName(PetscViewer);
274 
275 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerNetcdfOpen(MPI_Comm,const char[],PetscFileMode,PetscViewer*);
276 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerNetcdfGetID(PetscViewer, int *);
277 
278 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerHDF5WriteSDS(PetscViewer,float *,int,int *,int);
279 
280 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerHDF5Open(MPI_Comm,const char[],PetscFileMode,PetscViewer*);
281 #ifdef PETSC_HAVE_HDF5
282 #include <hdf5.h>
283 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerHDF5GetFileId(PetscViewer,hid_t*);
284 #endif
285 
286 /*
287      These are all the default viewers that do not have
288    to be explicitly opened
289 */
290 EXTERN PetscViewer PETSCSYS_DLLEXPORT PETSC_VIEWER_STDOUT_(MPI_Comm);
291 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerASCIIGetStdout(MPI_Comm,PetscViewer*);
292 EXTERN PetscViewer PETSCSYS_DLLEXPORT PETSC_VIEWER_STDERR_(MPI_Comm);
293 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerASCIIGetStderr(MPI_Comm,PetscViewer*);
294 EXTERN PetscViewer PETSCSYS_DLLEXPORT PETSC_VIEWER_DRAW_(MPI_Comm);
295 EXTERN PetscViewer PETSCSYS_DLLEXPORT PETSC_VIEWER_SOCKET_(MPI_Comm);
296 EXTERN PetscViewer PETSCSYS_DLLEXPORT PETSC_VIEWER_BINARY_(MPI_Comm);
297 EXTERN PetscViewer PETSCSYS_DLLEXPORT PETSC_VIEWER_MATLAB_(MPI_Comm);
298 EXTERN PetscViewer PETSC_VIEWER_MATHEMATICA_WORLD_PRIVATE;
299 
300 #define PETSC_VIEWER_STDERR_SELF  PETSC_VIEWER_STDERR_(PETSC_COMM_SELF)
301 #define PETSC_VIEWER_STDERR_WORLD PETSC_VIEWER_STDERR_(PETSC_COMM_WORLD)
302 
303 /*MC
304   PETSC_VIEWER_STDOUT_WORLD  - same as PETSC_VIEWER_STDOUT_(PETSC_COMM_WORLD)
305 
306   Level: beginner
307 M*/
308 #define PETSC_VIEWER_STDOUT_WORLD PETSC_VIEWER_STDOUT_(PETSC_COMM_WORLD)
309 
310 /*MC
311   PETSC_VIEWER_STDOUT_SELF  - same as PETSC_VIEWER_STDOUT_(PETSC_COMM_SELF)
312 
313   Level: beginner
314 M*/
315 #define PETSC_VIEWER_STDOUT_SELF  PETSC_VIEWER_STDOUT_(PETSC_COMM_SELF)
316 
317 /*MC
318   PETSC_VIEWER_DRAW_WORLD  - same as PETSC_VIEWER_DRAW_(PETSC_COMM_WORLD)
319 
320   Level: intermediate
321 M*/
322 #define PETSC_VIEWER_DRAW_WORLD   PETSC_VIEWER_DRAW_(PETSC_COMM_WORLD)
323 
324 /*MC
325   PETSC_VIEWER_DRAW_SELF  - same as PETSC_VIEWER_DRAW_(PETSC_COMM_SELF)
326 
327   Level: intermediate
328 M*/
329 #define PETSC_VIEWER_DRAW_SELF    PETSC_VIEWER_DRAW_(PETSC_COMM_SELF)
330 
331 /*MC
332   PETSC_VIEWER_SOCKET_WORLD  - same as PETSC_VIEWER_SOCKET_(PETSC_COMM_WORLD)
333 
334   Level: intermediate
335 M*/
336 #define PETSC_VIEWER_SOCKET_WORLD PETSC_VIEWER_SOCKET_(PETSC_COMM_WORLD)
337 
338 /*MC
339   PETSC_VIEWER_SOCKET_SELF  - same as PETSC_VIEWER_SOCKET_(PETSC_COMM_SELF)
340 
341   Level: intermediate
342 M*/
343 #define PETSC_VIEWER_SOCKET_SELF  PETSC_VIEWER_SOCKET_(PETSC_COMM_SELF)
344 
345 /*MC
346   PETSC_VIEWER_BINARY_WORLD  - same as PETSC_VIEWER_BINARY_(PETSC_COMM_WORLD)
347 
348   Level: intermediate
349 M*/
350 #define PETSC_VIEWER_BINARY_WORLD PETSC_VIEWER_BINARY_(PETSC_COMM_WORLD)
351 
352 /*MC
353   PETSC_VIEWER_BINARY_SELF  - same as PETSC_VIEWER_BINARY_(PETSC_COMM_SELF)
354 
355   Level: intermediate
356 M*/
357 #define PETSC_VIEWER_BINARY_SELF  PETSC_VIEWER_BINARY_(PETSC_COMM_SELF)
358 
359 /*MC
360   PETSC_VIEWER_MATLAB_WORLD  - same as PETSC_VIEWER_MATLAB_(PETSC_COMM_WORLD)
361 
362   Level: intermediate
363 M*/
364 #define PETSC_VIEWER_MATLAB_WORLD PETSC_VIEWER_MATLAB_(PETSC_COMM_WORLD)
365 
366 /*MC
367   PETSC_VIEWER_MATLAB_SELF  - same as PETSC_VIEWER_MATLAB_(PETSC_COMM_SELF)
368 
369   Level: intermediate
370 M*/
371 #define PETSC_VIEWER_MATLAB_SELF  PETSC_VIEWER_MATLAB_(PETSC_COMM_SELF)
372 
373 #define PETSC_VIEWER_MATHEMATICA_WORLD (PetscViewerInitializeMathematicaWorld_Private(),PETSC_VIEWER_MATHEMATICA_WORLD_PRIVATE)
374 
375 /*
376    petscViewer writes to Matlab .mat file
377 */
378 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerMatlabPutArray(PetscViewer,int,int,PetscScalar*,char*);
379 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerMatlabGetArray(PetscViewer,int,int,PetscScalar*,char*);
380 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewerMatlabPutVariable(PetscViewer,const char*,void*);
381 
382 /*S
383      PetscViewers - Abstract collection of PetscViewers. It is just an expandable array of viewers.
384 
385    Level: intermediate
386 
387   Concepts: viewing
388 
389 .seealso:  PetscViewerCreate(), PetscViewerSetType(), PetscViewerType, PetscViewer, PetscViewersCreate(),
390            PetscViewersGetViewer()
391 S*/
392 typedef struct _n_PetscViewers* PetscViewers;
393 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewersCreate(MPI_Comm,PetscViewers*);
394 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewersDestroy(PetscViewers);
395 EXTERN PetscErrorCode PETSCSYS_DLLEXPORT PetscViewersGetViewer(PetscViewers,PetscInt,PetscViewer*);
396 
397 #if defined(PETSC_HAVE_AMS)
398 #include <ams.h>
399 EXTERN PetscErrorCode PetscViewerAMSSetCommName(PetscViewer,const char[]);
400 EXTERN PetscErrorCode PetscViewerAMSGetAMSComm(PetscViewer,AMS_Comm *);
401 EXTERN PetscErrorCode PetscViewerAMSOpen(MPI_Comm,const char[],PetscViewer*);
402 EXTERN PetscErrorCode PetscViewerAMSLock(PetscViewer);
403 EXTERN PetscViewer    PETSC_VIEWER_AMS_(MPI_Comm);
404 EXTERN PetscErrorCode PETSC_VIEWER_AMS_Destroy(MPI_Comm);
405 #define PETSC_VIEWER_AMS_WORLD PETSC_VIEWER_AMS_(PETSC_COMM_WORLD)
406 #endif
407 
408 
409 PETSC_EXTERN_CXX_END
410 #endif
411