xref: /petsc/include/petscviewer.h (revision ebead697dbf761eb322f829370bbe90b3bd93fa3) 
1 /*
2      PetscViewers are objects where other objects can be looked at or stored.
3 */
4 #if !defined(PETSCVIEWER_H)
5 #define PETSCVIEWER_H
6 
7 #include <petscsys.h>
8 #include <petscviewertypes.h>
9 #include <petscdrawtypes.h>
10 
11 /* SUBMANSEC = Viewer */
12 
13 PETSC_EXTERN PetscClassId PETSC_VIEWER_CLASSID;
14 
15 /*J
16     PetscViewerType - String with the name of a PETSc PETScViewer
17 
18    Level: beginner
19 
20 .seealso: `PetscViewerSetType()`, `PetscViewer`, `PetscViewerRegister()`, `PetscViewerCreate()`
21 J*/
22 typedef const char* PetscViewerType;
23 #define PETSCVIEWERSOCKET       "socket"
24 #define PETSCVIEWERASCII        "ascii"
25 #define PETSCVIEWERBINARY       "binary"
26 #define PETSCVIEWERSTRING       "string"
27 #define PETSCVIEWERDRAW         "draw"
28 #define PETSCVIEWERVU           "vu"
29 #define PETSCVIEWERMATHEMATICA  "mathematica"
30 #define PETSCVIEWERHDF5         "hdf5"
31 #define PETSCVIEWERVTK          "vtk"
32 #define PETSCVIEWERMATLAB       "matlab"
33 #define PETSCVIEWERSAWS         "saws"
34 #define PETSCVIEWERGLVIS        "glvis"
35 #define PETSCVIEWERADIOS        "adios"
36 #define PETSCVIEWEREXODUSII     "exodusii"
37 #define PETSCVIEWERCGNS         "cgns"
38 
39 PETSC_EXTERN PetscFunctionList PetscViewerList;
40 PETSC_EXTERN PetscErrorCode PetscViewerInitializePackage(void);
41 
42 PETSC_EXTERN PetscErrorCode PetscViewerRegister(const char[],PetscErrorCode (*)(PetscViewer));
43 
44 PETSC_EXTERN PetscErrorCode PetscViewerCreate(MPI_Comm,PetscViewer*);
45 PETSC_EXTERN PetscErrorCode PetscViewerSetFromOptions(PetscViewer);
46 PETSC_EXTERN PetscErrorCode PetscViewerASCIIOpenWithFILE(MPI_Comm,FILE*,PetscViewer*);
47 
48 PETSC_EXTERN PetscErrorCode PetscViewerASCIIOpen(MPI_Comm,const char[],PetscViewer*);
49 PETSC_EXTERN PetscErrorCode PetscViewerASCIISetFILE(PetscViewer,FILE*);
50 PETSC_EXTERN PetscErrorCode PetscViewerBinaryOpen(MPI_Comm,const char[],PetscFileMode,PetscViewer*);
51 PETSC_EXTERN PetscErrorCode PetscViewerADIOSOpen(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 #define PETSC_VIEWER_ASCII_VTK_ATTR        PETSC_VIEWER_ASCII_VTK        PETSC_DEPRECATED_ENUM("Legacy VTK deprecated; use PetscViewerVTKOpen() with XML (.vtr .vts .vtu) format (since 3.14)")
112 #define PETSC_VIEWER_ASCII_VTK_CELL_ATTR   PETSC_VIEWER_ASCII_VTK_CELL   PETSC_DEPRECATED_ENUM("Legacy VTK deprecated; use PetscViewerVTKOpen() with XML (.vtr .vts .vtu) format (since 3.14)")
113 #define PETSC_VIEWER_ASCII_VTK_COORDS_ATTR PETSC_VIEWER_ASCII_VTK_COORDS PETSC_DEPRECATED_ENUM("Legacy VTK deprecated; use PetscViewerVTKOpen() with XML (.vtr .vts .vtu) format (since 3.14)")
114 /*E
115     PetscViewerFormat - Way a viewer presents the object
116 
117    Level: beginner
118 
119 .seealso: `PetscViewer`, `PetscViewerType`, `PetscViewerPushFormat()`, `PetscViewerPopFormat()`
120 E*/
121 typedef enum {
122   PETSC_VIEWER_DEFAULT,
123   PETSC_VIEWER_ASCII_MATLAB,
124   PETSC_VIEWER_ASCII_MATHEMATICA,
125   PETSC_VIEWER_ASCII_IMPL,
126   PETSC_VIEWER_ASCII_INFO,
127   PETSC_VIEWER_ASCII_INFO_DETAIL,
128   PETSC_VIEWER_ASCII_COMMON,
129   PETSC_VIEWER_ASCII_SYMMODU,
130   PETSC_VIEWER_ASCII_INDEX,
131   PETSC_VIEWER_ASCII_DENSE,
132   PETSC_VIEWER_ASCII_MATRIXMARKET,
133   PETSC_VIEWER_ASCII_VTK_DEPRECATED,
134   PETSC_VIEWER_ASCII_VTK_ATTR = PETSC_VIEWER_ASCII_VTK_DEPRECATED,
135   PETSC_VIEWER_ASCII_VTK_CELL_DEPRECATED,
136   PETSC_VIEWER_ASCII_VTK_CELL_ATTR = PETSC_VIEWER_ASCII_VTK_CELL_DEPRECATED,
137   PETSC_VIEWER_ASCII_VTK_COORDS_DEPRECATED,
138   PETSC_VIEWER_ASCII_VTK_COORDS_ATTR = PETSC_VIEWER_ASCII_VTK_COORDS_DEPRECATED,
139   PETSC_VIEWER_ASCII_PCICE,
140   PETSC_VIEWER_ASCII_PYTHON,
141   PETSC_VIEWER_ASCII_FACTOR_INFO,
142   PETSC_VIEWER_ASCII_LATEX,
143   PETSC_VIEWER_ASCII_XML,
144   PETSC_VIEWER_ASCII_FLAMEGRAPH,
145   PETSC_VIEWER_ASCII_GLVIS,
146   PETSC_VIEWER_ASCII_CSV,
147   PETSC_VIEWER_DRAW_BASIC,
148   PETSC_VIEWER_DRAW_LG,
149   PETSC_VIEWER_DRAW_LG_XRANGE,
150   PETSC_VIEWER_DRAW_CONTOUR,
151   PETSC_VIEWER_DRAW_PORTS,
152   PETSC_VIEWER_VTK_VTS,
153   PETSC_VIEWER_VTK_VTR,
154   PETSC_VIEWER_VTK_VTU,
155   PETSC_VIEWER_BINARY_MATLAB,
156   PETSC_VIEWER_NATIVE,
157   PETSC_VIEWER_HDF5_PETSC,
158   PETSC_VIEWER_HDF5_VIZ,
159   PETSC_VIEWER_HDF5_XDMF,
160   PETSC_VIEWER_HDF5_MAT,
161   PETSC_VIEWER_NOFORMAT,
162   PETSC_VIEWER_LOAD_BALANCE,
163   PETSC_VIEWER_FAILED,
164   PETSC_VIEWER_ALL
165   } PetscViewerFormat;
166 PETSC_EXTERN const char *const PetscViewerFormats[];
167 
168 PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use PetscViewerPushFormat()/PetscViewerPopFormat()") PetscErrorCode PetscViewerSetFormat(PetscViewer,PetscViewerFormat);
169 PETSC_EXTERN PetscErrorCode PetscViewerPushFormat(PetscViewer,PetscViewerFormat);
170 PETSC_EXTERN PetscErrorCode PetscViewerPopFormat(PetscViewer);
171 PETSC_EXTERN PetscErrorCode PetscViewerGetFormat(PetscViewer,PetscViewerFormat*);
172 PETSC_EXTERN PetscErrorCode PetscViewerFlush(PetscViewer);
173 
174 PETSC_EXTERN PetscErrorCode PetscOptionsPushGetViewerOff(PetscBool);
175 PETSC_EXTERN PetscErrorCode PetscOptionsPopGetViewerOff(void);
176 PETSC_EXTERN PetscErrorCode PetscOptionsGetViewerOff(PetscBool*);
177 PETSC_EXTERN PetscErrorCode PetscOptionsGetViewer(MPI_Comm,PetscOptions,const char[],const char[],PetscViewer*,PetscViewerFormat*,PetscBool*);
178 #define PetscOptionsViewer(a,b,c,d,e,f) PetscOptionsViewer_Private(PetscOptionsObject,a,b,c,d,e,f)
179 PETSC_EXTERN PetscErrorCode PetscOptionsViewer_Private(PetscOptionItems*,const char[],const char[],const char[],PetscViewer*,PetscViewerFormat *,PetscBool *);
180 
181 typedef struct {PetscViewer viewer;PetscViewerFormat format;PetscDrawLG lg;void *data;} PetscViewerAndFormat;
182 PETSC_EXTERN PetscErrorCode PetscViewerAndFormatCreate(PetscViewer,PetscViewerFormat,PetscViewerAndFormat**);
183 PETSC_EXTERN PetscErrorCode PetscViewerAndFormatDestroy(PetscViewerAndFormat**);
184 
185 /*
186    Operations explicit to a particular class of viewers
187 */
188 
189 PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetPointer(PetscViewer,FILE**);
190 PETSC_EXTERN PetscErrorCode PetscViewerFileGetMode(PetscViewer,PetscFileMode*);
191 PETSC_EXTERN PetscErrorCode PetscViewerFileSetMode(PetscViewer,PetscFileMode);
192 PETSC_EXTERN PetscErrorCode PetscViewerRead(PetscViewer,void*,PetscInt,PetscInt*,PetscDataType);
193 PETSC_EXTERN PetscErrorCode PetscViewerASCIIPrintf(PetscViewer,const char[],...) PETSC_ATTRIBUTE_FORMAT(2,3);
194 PETSC_EXTERN PetscErrorCode PetscViewerASCIISynchronizedPrintf(PetscViewer,const char[],...) PETSC_ATTRIBUTE_FORMAT(2,3);
195 PETSC_EXTERN PetscErrorCode PetscViewerASCIIPushSynchronized(PetscViewer);
196 PETSC_EXTERN PetscErrorCode PetscViewerASCIIPopSynchronized(PetscViewer);
197 PETSC_EXTERN PetscErrorCode PetscViewerASCIIPushTab(PetscViewer);
198 PETSC_EXTERN PetscErrorCode PetscViewerASCIIPopTab(PetscViewer);
199 PETSC_EXTERN PetscErrorCode PetscViewerASCIIUseTabs(PetscViewer,PetscBool);
200 PETSC_EXTERN PetscErrorCode PetscViewerASCIISetTab(PetscViewer,PetscInt);
201 PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetTab(PetscViewer,PetscInt*);
202 PETSC_EXTERN PetscErrorCode PetscViewerASCIIAddTab(PetscViewer,PetscInt);
203 PETSC_EXTERN PetscErrorCode PetscViewerASCIISubtractTab(PetscViewer,PetscInt);
204 PETSC_EXTERN PetscErrorCode PetscViewerASCIIRead(PetscViewer,void *,PetscInt,PetscInt*,PetscDataType);
205 PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetDescriptor(PetscViewer,int*);
206 PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetInfoPointer(PetscViewer,FILE **);
207 PETSC_EXTERN PetscErrorCode PetscViewerBinaryRead(PetscViewer,void*,PetscInt,PetscInt*,PetscDataType);
208 PETSC_EXTERN PetscErrorCode PetscViewerBinaryWrite(PetscViewer,const void*,PetscInt,PetscDataType);
209 PETSC_EXTERN PetscErrorCode PetscViewerBinaryReadAll(PetscViewer,void*,PetscInt,PetscInt,PetscInt,PetscDataType);
210 PETSC_EXTERN PetscErrorCode PetscViewerBinaryWriteAll(PetscViewer,const void*,PetscInt,PetscInt,PetscInt,PetscDataType);
211 PETSC_EXTERN PetscErrorCode PetscViewerStringSPrintf(PetscViewer,const char[],...) PETSC_ATTRIBUTE_FORMAT(2,3);
212 PETSC_EXTERN PetscErrorCode PetscViewerStringSetString(PetscViewer,char[],size_t);
213 PETSC_EXTERN PetscErrorCode PetscViewerStringGetStringRead(PetscViewer,const char*[],size_t*);
214 PETSC_EXTERN PetscErrorCode PetscViewerStringSetOwnString(PetscViewer);
215 PETSC_EXTERN PetscErrorCode PetscViewerDrawClear(PetscViewer);
216 PETSC_EXTERN PetscErrorCode PetscViewerDrawSetHold(PetscViewer,PetscBool);
217 PETSC_EXTERN PetscErrorCode PetscViewerDrawGetHold(PetscViewer,PetscBool*);
218 PETSC_EXTERN PetscErrorCode PetscViewerDrawSetPause(PetscViewer,PetscReal);
219 PETSC_EXTERN PetscErrorCode PetscViewerDrawGetPause(PetscViewer,PetscReal*);
220 PETSC_EXTERN PetscErrorCode PetscViewerDrawSetInfo(PetscViewer,const char[],const char[],int,int,int,int);
221 PETSC_EXTERN PetscErrorCode PetscViewerDrawResize(PetscViewer,int,int);
222 PETSC_EXTERN PetscErrorCode PetscViewerDrawSetBounds(PetscViewer,PetscInt,const PetscReal*);
223 PETSC_EXTERN PetscErrorCode PetscViewerDrawGetBounds(PetscViewer,PetscInt*,const PetscReal**);
224 PETSC_EXTERN PetscErrorCode PetscViewerSocketSetConnection(PetscViewer,const char[],int);
225 PETSC_EXTERN PetscErrorCode PetscViewerBinarySkipInfo(PetscViewer);
226 PETSC_EXTERN PetscErrorCode PetscViewerBinarySetSkipInfo(PetscViewer,PetscBool);
227 PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetSkipInfo(PetscViewer,PetscBool*);
228 PETSC_EXTERN PetscErrorCode PetscViewerBinarySetSkipOptions(PetscViewer,PetscBool);
229 PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetSkipOptions(PetscViewer,PetscBool *);
230 PETSC_EXTERN PetscErrorCode PetscViewerBinarySetSkipHeader(PetscViewer,PetscBool);
231 PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetSkipHeader(PetscViewer,PetscBool*);
232 PETSC_EXTERN PetscErrorCode PetscViewerBinaryReadStringArray(PetscViewer,char***);
233 PETSC_EXTERN PetscErrorCode PetscViewerBinaryWriteStringArray(PetscViewer,const char *const*);
234 
235 PETSC_EXTERN PetscErrorCode PetscViewerFileSetName(PetscViewer,const char[]);
236 PETSC_EXTERN PetscErrorCode PetscViewerFileGetName(PetscViewer,const char**);
237 
238 PETSC_EXTERN PetscErrorCode PetscViewerVUGetPointer(PetscViewer, FILE**);
239 PETSC_EXTERN PetscErrorCode PetscViewerVUSetVecSeen(PetscViewer, PetscBool);
240 PETSC_EXTERN PetscErrorCode PetscViewerVUGetVecSeen(PetscViewer, PetscBool  *);
241 PETSC_EXTERN PetscErrorCode PetscViewerVUPrintDeferred(PetscViewer, const char [], ...) PETSC_ATTRIBUTE_FORMAT(2,3);
242 PETSC_EXTERN PetscErrorCode PetscViewerVUFlushDeferred(PetscViewer);
243 
244 /*@C
245   PetscViewerVUSetMode - Sets the mode in which to open the file.
246 
247   Not Collective
248 
249   Input Parameters:
250 + viewer - The PetscViewer
251 - mode   - The file mode
252 
253   Level: deprecated
254 
255   Note:
256   Use PetscViewerFileSetMode() instead.
257 
258 .seealso: `PetscViewerFileSetMode()`
259 @*/
260 PETSC_DEPRECATED_FUNCTION("Use PetscViewerFileSetMode (since v3.15)") static inline PetscErrorCode PetscViewerVUSetMode(PetscViewer viewer, PetscFileMode mode) {return PetscViewerFileSetMode(viewer, mode);}
261 
262 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaInitializePackage(void);
263 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaFinalizePackage(void);
264 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaGetName(PetscViewer, const char **);
265 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaSetName(PetscViewer, const char []);
266 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaClearName(PetscViewer);
267 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaSkipPackets(PetscViewer, int);
268 
269 PETSC_EXTERN PetscErrorCode PetscViewerSiloGetName(PetscViewer, char **);
270 PETSC_EXTERN PetscErrorCode PetscViewerSiloSetName(PetscViewer, const char []);
271 PETSC_EXTERN PetscErrorCode PetscViewerSiloClearName(PetscViewer);
272 PETSC_EXTERN PetscErrorCode PetscViewerSiloGetMeshName(PetscViewer, char **);
273 PETSC_EXTERN PetscErrorCode PetscViewerSiloSetMeshName(PetscViewer, const char []);
274 PETSC_EXTERN PetscErrorCode PetscViewerSiloClearMeshName(PetscViewer);
275 
276 typedef enum {PETSC_VTK_INVALID, PETSC_VTK_POINT_FIELD, PETSC_VTK_POINT_VECTOR_FIELD, PETSC_VTK_CELL_FIELD, PETSC_VTK_CELL_VECTOR_FIELD} PetscViewerVTKFieldType;
277 PETSC_EXTERN PetscErrorCode PetscViewerVTKAddField(PetscViewer,PetscObject,PetscErrorCode (*PetscViewerVTKWriteFunction)(PetscObject,PetscViewer),PetscInt,PetscViewerVTKFieldType,PetscBool,PetscObject);
278 PETSC_EXTERN PetscErrorCode PetscViewerVTKGetDM(PetscViewer,PetscObject*);
279 PETSC_EXTERN PetscErrorCode PetscViewerVTKOpen(MPI_Comm,const char[],PetscFileMode,PetscViewer*);
280 
281 /*
282      These are all the default viewers that do not have to be explicitly opened
283 */
284 PETSC_EXTERN PetscViewer    PETSC_VIEWER_STDOUT_(MPI_Comm);
285 PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetStdout(MPI_Comm,PetscViewer*);
286 PETSC_EXTERN PetscViewer    PETSC_VIEWER_STDERR_(MPI_Comm);
287 PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetStderr(MPI_Comm,PetscViewer*);
288 PETSC_EXTERN PetscViewer    PETSC_VIEWER_DRAW_(MPI_Comm);
289 PETSC_EXTERN PetscViewer    PETSC_VIEWER_SOCKET_(MPI_Comm);
290 PETSC_EXTERN PetscViewer    PETSC_VIEWER_BINARY_(MPI_Comm);
291 PETSC_EXTERN PetscViewer    PETSC_VIEWER_MATLAB_(MPI_Comm);
292 PETSC_EXTERN PetscViewer    PETSC_VIEWER_HDF5_(MPI_Comm);
293 PETSC_EXTERN PetscViewer    PETSC_VIEWER_GLVIS_(MPI_Comm);
294 PETSC_EXTERN PetscViewer    PETSC_VIEWER_EXODUSII_(MPI_Comm);
295 PETSC_EXTERN PetscViewer    PETSC_VIEWER_MATHEMATICA_WORLD_PRIVATE;
296 
297 /*MC
298   PETSC_VIEWER_STDERR_SELF  - same as PETSC_VIEWER_STDERR_(PETSC_COMM_SELF)
299 
300   Level: beginner
301 M*/
302 #define PETSC_VIEWER_STDERR_SELF  PETSC_VIEWER_STDERR_(PETSC_COMM_SELF)
303 
304 /*MC
305   PETSC_VIEWER_STDERR_WORLD  - same as PETSC_VIEWER_STDERR_(PETSC_COMM_WORLD)
306 
307   Level: beginner
308 M*/
309 #define PETSC_VIEWER_STDERR_WORLD PETSC_VIEWER_STDERR_(PETSC_COMM_WORLD)
310 
311 /*MC
312   PETSC_VIEWER_STDOUT_WORLD  - same as PETSC_VIEWER_STDOUT_(PETSC_COMM_WORLD)
313 
314   Level: beginner
315 M*/
316 #define PETSC_VIEWER_STDOUT_WORLD PETSC_VIEWER_STDOUT_(PETSC_COMM_WORLD)
317 
318 /*MC
319   PETSC_VIEWER_STDOUT_SELF  - same as PETSC_VIEWER_STDOUT_(PETSC_COMM_SELF)
320 
321   Level: beginner
322 M*/
323 #define PETSC_VIEWER_STDOUT_SELF  PETSC_VIEWER_STDOUT_(PETSC_COMM_SELF)
324 
325 /*MC
326   PETSC_VIEWER_DRAW_WORLD  - same as PETSC_VIEWER_DRAW_(PETSC_COMM_WORLD)
327 
328   Level: intermediate
329 M*/
330 #define PETSC_VIEWER_DRAW_WORLD   PETSC_VIEWER_DRAW_(PETSC_COMM_WORLD)
331 
332 /*MC
333   PETSC_VIEWER_DRAW_SELF  - same as PETSC_VIEWER_DRAW_(PETSC_COMM_SELF)
334 
335   Level: intermediate
336 M*/
337 #define PETSC_VIEWER_DRAW_SELF    PETSC_VIEWER_DRAW_(PETSC_COMM_SELF)
338 
339 /*MC
340   PETSC_VIEWER_SOCKET_WORLD  - same as PETSC_VIEWER_SOCKET_(PETSC_COMM_WORLD)
341 
342   Level: intermediate
343 M*/
344 #define PETSC_VIEWER_SOCKET_WORLD PETSC_VIEWER_SOCKET_(PETSC_COMM_WORLD)
345 
346 /*MC
347   PETSC_VIEWER_SOCKET_SELF  - same as PETSC_VIEWER_SOCKET_(PETSC_COMM_SELF)
348 
349   Level: intermediate
350 M*/
351 #define PETSC_VIEWER_SOCKET_SELF  PETSC_VIEWER_SOCKET_(PETSC_COMM_SELF)
352 
353 /*MC
354   PETSC_VIEWER_BINARY_WORLD  - same as PETSC_VIEWER_BINARY_(PETSC_COMM_WORLD)
355 
356   Level: intermediate
357 M*/
358 #define PETSC_VIEWER_BINARY_WORLD PETSC_VIEWER_BINARY_(PETSC_COMM_WORLD)
359 
360 /*MC
361   PETSC_VIEWER_BINARY_SELF  - same as PETSC_VIEWER_BINARY_(PETSC_COMM_SELF)
362 
363   Level: intermediate
364 M*/
365 #define PETSC_VIEWER_BINARY_SELF  PETSC_VIEWER_BINARY_(PETSC_COMM_SELF)
366 
367 /*MC
368   PETSC_VIEWER_MATLAB_WORLD  - same as PETSC_VIEWER_MATLAB_(PETSC_COMM_WORLD)
369 
370   Level: intermediate
371 M*/
372 #define PETSC_VIEWER_MATLAB_WORLD PETSC_VIEWER_MATLAB_(PETSC_COMM_WORLD)
373 
374 /*MC
375   PETSC_VIEWER_MATLAB_SELF  - same as PETSC_VIEWER_MATLAB_(PETSC_COMM_SELF)
376 
377   Level: intermediate
378 M*/
379 #define PETSC_VIEWER_MATLAB_SELF  PETSC_VIEWER_MATLAB_(PETSC_COMM_SELF)
380 
381 #define PETSC_VIEWER_MATHEMATICA_WORLD (PetscViewerInitializeMathematicaWorld_Private(),PETSC_VIEWER_MATHEMATICA_WORLD_PRIVATE)
382 
383 PETSC_EXTERN PetscErrorCode PetscViewerFlowControlStart(PetscViewer,PetscInt*,PetscInt*);
384 PETSC_EXTERN PetscErrorCode PetscViewerFlowControlStepMain(PetscViewer,PetscInt,PetscInt*,PetscInt);
385 PETSC_EXTERN PetscErrorCode PetscViewerFlowControlEndMain(PetscViewer,PetscInt*);
386 PETSC_EXTERN PetscErrorCode PetscViewerFlowControlStepWorker(PetscViewer,PetscMPIInt,PetscInt*);
387 PETSC_EXTERN PetscErrorCode PetscViewerFlowControlEndWorker(PetscViewer,PetscInt*);
388 PETSC_DEPRECATED_FUNCTION("Use PetscViewerFlowControlStepMaster (since v3.15)") static inline PetscErrorCode PetscViewerFlowControlStepMaster(PetscViewer viewer,PetscInt i,PetscInt *mcnt,PetscInt cnt) {return PetscViewerFlowControlStepMain(viewer,i,mcnt,cnt);}
389 PETSC_DEPRECATED_FUNCTION("Use PetscViewerFlowControlEndMaster (since v3.15)") static inline PetscErrorCode PetscViewerFlowControlEndMaster(PetscViewer viewer, PetscInt *mcnt) {return PetscViewerFlowControlEndMain(viewer,mcnt);}
390 
391 /*
392    PetscViewer writes to MATLAB .mat file
393 */
394 PETSC_EXTERN PetscErrorCode PetscViewerMatlabPutArray(PetscViewer,int,int,const PetscScalar*,const char*);
395 PETSC_EXTERN PetscErrorCode PetscViewerMatlabGetArray(PetscViewer,int,int,PetscScalar*,const char*);
396 PETSC_EXTERN PetscErrorCode PetscViewerMatlabPutVariable(PetscViewer,const char*,void*);
397 
398 #if defined(PETSC_HAVE_SAWS)
399 PETSC_EXTERN PetscErrorCode PetscObjectViewSAWs(PetscObject,PetscViewer);
400 #endif
401 
402 /*S
403      PetscViewers - Abstract collection of PetscViewers. It is just an expandable array of viewers.
404 
405    Level: intermediate
406 
407 .seealso: `PetscViewerCreate()`, `PetscViewerSetType()`, `PetscViewerType`, `PetscViewer`, `PetscViewersCreate()`,
408           `PetscViewersGetViewer()`
409 S*/
410 typedef struct _n_PetscViewers* PetscViewers;
411 PETSC_EXTERN PetscErrorCode PetscViewersCreate(MPI_Comm,PetscViewers*);
412 PETSC_EXTERN PetscErrorCode PetscViewersDestroy(PetscViewers*);
413 PETSC_EXTERN PetscErrorCode PetscViewersGetViewer(PetscViewers,PetscInt,PetscViewer*);
414 
415 #endif
416