xref: /petsc/include/petscviewer.h (revision 7ba4506d7d545948e894dedc80e47cb5d5de7ba1) 
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 
11 PETSC_EXTERN PetscClassId PETSC_VIEWER_CLASSID;
12 
13 /*J
14     PetscViewerType - String with the name of a PETSc PETScViewer
15 
16    Level: beginner
17 
18 .seealso: PetscViewerSetType(), PetscViewer, PetscViewerRegister(), PetscViewerCreate()
19 J*/
20 typedef const char* PetscViewerType;
21 #define PETSCVIEWERSOCKET       "socket"
22 #define PETSCVIEWERASCII        "ascii"
23 #define PETSCVIEWERBINARY       "binary"
24 #define PETSCVIEWERSTRING       "string"
25 #define PETSCVIEWERDRAW         "draw"
26 #define PETSCVIEWERVU           "vu"
27 #define PETSCVIEWERMATHEMATICA  "mathematica"
28 #define PETSCVIEWERNETCDF       "netcdf"
29 #define PETSCVIEWERHDF5         "hdf5"
30 #define PETSCVIEWERVTK          "vtk"
31 #define PETSCVIEWERMATLAB       "matlab"
32 #define PETSCVIEWERSAWS          "saws"
33 
34 PETSC_EXTERN PetscFunctionList PetscViewerList;
35 PETSC_EXTERN PetscErrorCode PetscViewerRegisterAll(void);
36 PETSC_EXTERN PetscErrorCode PetscViewerInitializePackage(void);
37 
38 PETSC_EXTERN PetscErrorCode PetscViewerRegister(const char[],PetscErrorCode (*)(PetscViewer));
39 
40 PETSC_EXTERN PetscErrorCode PetscViewerCreate(MPI_Comm,PetscViewer*);
41 PETSC_EXTERN PetscErrorCode PetscViewerSetFromOptions(PetscViewer);
42 PETSC_EXTERN PetscErrorCode PetscViewerASCIIOpenWithFILE(MPI_Comm,FILE*,PetscViewer*);
43 
44 PETSC_EXTERN PetscErrorCode PetscViewerASCIIOpen(MPI_Comm,const char[],PetscViewer*);
45 PETSC_EXTERN PetscErrorCode PetscViewerASCIISetFILE(PetscViewer,FILE*);
46 PETSC_EXTERN PetscErrorCode PetscViewerBinaryOpen(MPI_Comm,const char[],PetscFileMode,PetscViewer*);
47 PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetFlowControl(PetscViewer,PetscInt*);
48 PETSC_EXTERN PetscErrorCode PetscViewerBinarySetFlowControl(PetscViewer,PetscInt);
49 PETSC_EXTERN PetscErrorCode PetscViewerBinarySetMPIIO(PetscViewer);
50 PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetMPIIO(PetscViewer,PetscBool *);
51 #if defined(PETSC_HAVE_MPIIO)
52 PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetMPIIODescriptor(PetscViewer,MPI_File*);
53 PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetMPIIOOffset(PetscViewer,MPI_Offset*);
54 PETSC_EXTERN PetscErrorCode PetscViewerBinaryAddMPIIOOffset(PetscViewer,MPI_Offset);
55 #endif
56 
57 PETSC_EXTERN PetscErrorCode PetscViewerSocketOpen(MPI_Comm,const char[],int,PetscViewer*);
58 PETSC_EXTERN PetscErrorCode PetscViewerStringOpen(MPI_Comm,char[],size_t,PetscViewer*);
59 PETSC_EXTERN PetscErrorCode PetscViewerDrawOpen(MPI_Comm,const char[],const char[],int,int,int,int,PetscViewer*);
60 #include <petscdrawtypes.h>
61 PETSC_EXTERN PetscErrorCode PetscViewerDrawSetDrawType(PetscViewer,PetscDrawType);
62 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaOpen(MPI_Comm, int, const char[], const char[], PetscViewer *);
63 PETSC_EXTERN PetscErrorCode PetscViewerSiloOpen(MPI_Comm, const char[], PetscViewer *);
64 PETSC_EXTERN PetscErrorCode PetscViewerMatlabOpen(MPI_Comm,const char[],PetscFileMode,PetscViewer*);
65 
66 PETSC_EXTERN PetscErrorCode PetscViewerGetType(PetscViewer,PetscViewerType*);
67 PETSC_EXTERN PetscErrorCode PetscViewerSetType(PetscViewer,PetscViewerType);
68 PETSC_EXTERN PetscErrorCode PetscViewerDestroy(PetscViewer*);
69 PETSC_EXTERN PetscErrorCode PetscViewerGetSingleton(PetscViewer,PetscViewer*);
70 PETSC_EXTERN PetscErrorCode PetscViewerRestoreSingleton(PetscViewer,PetscViewer*);
71 PETSC_EXTERN PetscErrorCode PetscViewerGetSubcomm(PetscViewer,MPI_Comm,PetscViewer*);
72 PETSC_EXTERN PetscErrorCode PetscViewerRestoreSubcomm(PetscViewer,MPI_Comm,PetscViewer*);
73 
74 PETSC_EXTERN PetscErrorCode PetscViewerSetUp(PetscViewer);
75 PETSC_EXTERN PetscErrorCode PetscViewerView(PetscViewer,PetscViewer);
76 PETSC_STATIC_INLINE PetscErrorCode PetscViewerViewFromOptions(PetscViewer A,const char prefix[],const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,prefix,name);}
77 
78 PETSC_EXTERN PetscErrorCode PetscViewerSetOptionsPrefix(PetscViewer,const char[]);
79 PETSC_EXTERN PetscErrorCode PetscViewerAppendOptionsPrefix(PetscViewer,const char[]);
80 PETSC_EXTERN PetscErrorCode PetscViewerGetOptionsPrefix(PetscViewer,const char*[]);
81 
82 /*E
83     PetscViewerFormat - Way a viewer presents the object
84 
85    Level: beginner
86 
87    The values below are also listed in finclude/petscviewer.h. If another values is added below it
88    must also be added there.
89 
90 .seealso: PetscViewerSetFormat(), PetscViewer, PetscViewerType, PetscViewerPushFormat(), PetscViewerPopFormat()
91 E*/
92 typedef enum {
93   PETSC_VIEWER_DEFAULT,
94   PETSC_VIEWER_ASCII_MATLAB,
95   PETSC_VIEWER_ASCII_MATHEMATICA,
96   PETSC_VIEWER_ASCII_IMPL,
97   PETSC_VIEWER_ASCII_INFO,
98   PETSC_VIEWER_ASCII_INFO_DETAIL,
99   PETSC_VIEWER_ASCII_COMMON,
100   PETSC_VIEWER_ASCII_SYMMODU,
101   PETSC_VIEWER_ASCII_INDEX,
102   PETSC_VIEWER_ASCII_DENSE,
103   PETSC_VIEWER_ASCII_MATRIXMARKET,
104   PETSC_VIEWER_ASCII_VTK,
105   PETSC_VIEWER_ASCII_VTK_CELL,
106   PETSC_VIEWER_ASCII_VTK_COORDS,
107   PETSC_VIEWER_ASCII_PCICE,
108   PETSC_VIEWER_ASCII_PYTHON,
109   PETSC_VIEWER_ASCII_FACTOR_INFO,
110   PETSC_VIEWER_ASCII_LATEX,
111   PETSC_VIEWER_DRAW_BASIC,
112   PETSC_VIEWER_DRAW_LG,
113   PETSC_VIEWER_DRAW_CONTOUR,
114   PETSC_VIEWER_DRAW_PORTS,
115   PETSC_VIEWER_VTK_VTS,
116   PETSC_VIEWER_VTK_VTR,
117   PETSC_VIEWER_VTK_VTU,
118   PETSC_VIEWER_BINARY_MATLAB,
119   PETSC_VIEWER_NATIVE,
120   PETSC_VIEWER_NOFORMAT
121   } PetscViewerFormat;
122 PETSC_EXTERN const char *const PetscViewerFormats[];
123 
124 PETSC_EXTERN PetscErrorCode PetscViewerSetFormat(PetscViewer,PetscViewerFormat);
125 PETSC_EXTERN PetscErrorCode PetscViewerPushFormat(PetscViewer,PetscViewerFormat);
126 PETSC_EXTERN PetscErrorCode PetscViewerPopFormat(PetscViewer);
127 PETSC_EXTERN PetscErrorCode PetscViewerGetFormat(PetscViewer,PetscViewerFormat*);
128 PETSC_EXTERN PetscErrorCode PetscViewerFlush(PetscViewer);
129 
130 PETSC_EXTERN PetscErrorCode PetscOptionsGetViewer(MPI_Comm,const char[],const char[],PetscViewer*,PetscViewerFormat*,PetscBool*);
131 PETSC_EXTERN PetscErrorCode PetscOptionsViewer(const char[],const char[],const char[],PetscViewer*,PetscViewerFormat *,PetscBool *);
132 
133 /*
134    Operations explicit to a particular class of viewers
135 */
136 
137 PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetPointer(PetscViewer,FILE**);
138 PETSC_EXTERN PetscErrorCode PetscViewerFileGetMode(PetscViewer,PetscFileMode*);
139 PETSC_EXTERN PetscErrorCode PetscViewerFileSetMode(PetscViewer,PetscFileMode);
140 PETSC_EXTERN PetscErrorCode PetscViewerASCIIPrintf(PetscViewer,const char[],...);
141 PETSC_EXTERN PetscErrorCode PetscViewerASCIISynchronizedPrintf(PetscViewer,const char[],...);
142 PETSC_EXTERN PetscErrorCode PetscViewerASCIISynchronizedAllow(PetscViewer,PetscBool);
143 PETSC_EXTERN PetscErrorCode PetscViewerASCIIPushTab(PetscViewer);
144 PETSC_EXTERN PetscErrorCode PetscViewerASCIIPopTab(PetscViewer);
145 PETSC_EXTERN PetscErrorCode PetscViewerASCIIUseTabs(PetscViewer,PetscBool );
146 PETSC_EXTERN PetscErrorCode PetscViewerASCIISetTab(PetscViewer,PetscInt);
147 PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetTab(PetscViewer,PetscInt*);
148 PETSC_EXTERN PetscErrorCode PetscViewerASCIIAddTab(PetscViewer,PetscInt);
149 PETSC_EXTERN PetscErrorCode PetscViewerASCIISubtractTab(PetscViewer,PetscInt);
150 PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetDescriptor(PetscViewer,int*);
151 PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetInfoPointer(PetscViewer,FILE **);
152 PETSC_EXTERN PetscErrorCode PetscViewerBinaryRead(PetscViewer,void*,PetscInt,PetscDataType);
153 PETSC_EXTERN PetscErrorCode PetscViewerBinaryWrite(PetscViewer,void*,PetscInt,PetscDataType,PetscBool );
154 PETSC_EXTERN PetscErrorCode PetscViewerStringSPrintf(PetscViewer,const char[],...);
155 PETSC_EXTERN PetscErrorCode PetscViewerStringSetString(PetscViewer,char[],PetscInt);
156 PETSC_EXTERN PetscErrorCode PetscViewerDrawClear(PetscViewer);
157 PETSC_EXTERN PetscErrorCode PetscViewerDrawSetHold(PetscViewer,PetscBool);
158 PETSC_EXTERN PetscErrorCode PetscViewerDrawGetHold(PetscViewer,PetscBool*);
159 PETSC_EXTERN PetscErrorCode PetscViewerDrawSetPause(PetscViewer,PetscReal);
160 PETSC_EXTERN PetscErrorCode PetscViewerDrawGetPause(PetscViewer,PetscReal*);
161 PETSC_EXTERN PetscErrorCode PetscViewerDrawSetInfo(PetscViewer,const char[],const char[],int,int,int,int);
162 PETSC_EXTERN PetscErrorCode PetscViewerDrawResize(PetscViewer,int,int);
163 PETSC_EXTERN PetscErrorCode PetscViewerDrawSetBounds(PetscViewer,PetscInt,const PetscReal*);
164 PETSC_EXTERN PetscErrorCode PetscViewerDrawGetBounds(PetscViewer,PetscInt*,const PetscReal**);
165 PETSC_EXTERN PetscErrorCode PetscViewerSocketSetConnection(PetscViewer,const char[],int);
166 PETSC_EXTERN PetscErrorCode PetscViewerBinarySkipInfo(PetscViewer);
167 PETSC_EXTERN PetscErrorCode PetscViewerBinarySetSkipOptions(PetscViewer,PetscBool );
168 PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetSkipOptions(PetscViewer,PetscBool *);
169 PETSC_EXTERN PetscErrorCode PetscViewerBinarySetSkipHeader(PetscViewer,PetscBool);
170 PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetSkipHeader(PetscViewer,PetscBool*);
171 PETSC_EXTERN PetscErrorCode PetscViewerBinaryReadStringArray(PetscViewer,char***);
172 PETSC_EXTERN PetscErrorCode PetscViewerBinaryWriteStringArray(PetscViewer,char**);
173 
174 PETSC_EXTERN PetscErrorCode PetscViewerFileSetName(PetscViewer,const char[]);
175 PETSC_EXTERN PetscErrorCode PetscViewerFileGetName(PetscViewer,const char**);
176 
177 PETSC_EXTERN PetscErrorCode PetscViewerVUGetPointer(PetscViewer, FILE**);
178 PETSC_EXTERN PetscErrorCode PetscViewerVUSetVecSeen(PetscViewer, PetscBool );
179 PETSC_EXTERN PetscErrorCode PetscViewerVUGetVecSeen(PetscViewer, PetscBool  *);
180 PETSC_EXTERN PetscErrorCode PetscViewerVUPrintDeferred(PetscViewer, const char [], ...);
181 PETSC_EXTERN PetscErrorCode PetscViewerVUFlushDeferred(PetscViewer);
182 
183 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaInitializePackage(void);
184 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaFinalizePackage(void);
185 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaGetName(PetscViewer, const char **);
186 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaSetName(PetscViewer, const char []);
187 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaClearName(PetscViewer);
188 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaSkipPackets(PetscViewer, int);
189 
190 PETSC_EXTERN PetscErrorCode PetscViewerSiloGetName(PetscViewer, char **);
191 PETSC_EXTERN PetscErrorCode PetscViewerSiloSetName(PetscViewer, const char []);
192 PETSC_EXTERN PetscErrorCode PetscViewerSiloClearName(PetscViewer);
193 PETSC_EXTERN PetscErrorCode PetscViewerSiloGetMeshName(PetscViewer, char **);
194 PETSC_EXTERN PetscErrorCode PetscViewerSiloSetMeshName(PetscViewer, const char []);
195 PETSC_EXTERN PetscErrorCode PetscViewerSiloClearMeshName(PetscViewer);
196 
197 PETSC_EXTERN PetscErrorCode PetscViewerNetcdfOpen(MPI_Comm,const char[],PetscFileMode,PetscViewer*);
198 PETSC_EXTERN PetscErrorCode PetscViewerNetcdfGetID(PetscViewer, int *);
199 
200 typedef enum {PETSC_VTK_POINT_FIELD, PETSC_VTK_POINT_VECTOR_FIELD, PETSC_VTK_CELL_FIELD, PETSC_VTK_CELL_VECTOR_FIELD} PetscViewerVTKFieldType;
201 PETSC_EXTERN PetscErrorCode PetscViewerVTKAddField(PetscViewer,PetscObject,PetscErrorCode (*PetscViewerVTKWriteFunction)(PetscObject,PetscViewer),PetscViewerVTKFieldType,PetscObject);
202 PETSC_EXTERN PetscErrorCode PetscViewerVTKOpen(MPI_Comm,const char[],PetscFileMode,PetscViewer*);
203 
204 /*
205      These are all the default viewers that do not have to be explicitly opened
206 */
207 PETSC_EXTERN PetscViewer    PETSC_VIEWER_STDOUT_(MPI_Comm);
208 PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetStdout(MPI_Comm,PetscViewer*);
209 PETSC_EXTERN PetscViewer    PETSC_VIEWER_STDERR_(MPI_Comm);
210 PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetStderr(MPI_Comm,PetscViewer*);
211 PETSC_EXTERN PetscViewer    PETSC_VIEWER_DRAW_(MPI_Comm);
212 PETSC_EXTERN PetscViewer    PETSC_VIEWER_SOCKET_(MPI_Comm);
213 PETSC_EXTERN PetscViewer    PETSC_VIEWER_BINARY_(MPI_Comm);
214 PETSC_EXTERN PetscViewer    PETSC_VIEWER_MATLAB_(MPI_Comm);
215 PETSC_EXTERN PetscViewer    PETSC_VIEWER_HDF5_(MPI_Comm);
216 PETSC_EXTERN PetscViewer   PETSC_VIEWER_MATHEMATICA_WORLD_PRIVATE;
217 
218 #define PETSC_VIEWER_STDERR_SELF  PETSC_VIEWER_STDERR_(PETSC_COMM_SELF)
219 #define PETSC_VIEWER_STDERR_WORLD PETSC_VIEWER_STDERR_(PETSC_COMM_WORLD)
220 
221 /*MC
222   PETSC_VIEWER_STDOUT_WORLD  - same as PETSC_VIEWER_STDOUT_(PETSC_COMM_WORLD)
223 
224   Level: beginner
225 M*/
226 #define PETSC_VIEWER_STDOUT_WORLD PETSC_VIEWER_STDOUT_(PETSC_COMM_WORLD)
227 
228 /*MC
229   PETSC_VIEWER_STDOUT_SELF  - same as PETSC_VIEWER_STDOUT_(PETSC_COMM_SELF)
230 
231   Level: beginner
232 M*/
233 #define PETSC_VIEWER_STDOUT_SELF  PETSC_VIEWER_STDOUT_(PETSC_COMM_SELF)
234 
235 /*MC
236   PETSC_VIEWER_DRAW_WORLD  - same as PETSC_VIEWER_DRAW_(PETSC_COMM_WORLD)
237 
238   Level: intermediate
239 M*/
240 #define PETSC_VIEWER_DRAW_WORLD   PETSC_VIEWER_DRAW_(PETSC_COMM_WORLD)
241 
242 /*MC
243   PETSC_VIEWER_DRAW_SELF  - same as PETSC_VIEWER_DRAW_(PETSC_COMM_SELF)
244 
245   Level: intermediate
246 M*/
247 #define PETSC_VIEWER_DRAW_SELF    PETSC_VIEWER_DRAW_(PETSC_COMM_SELF)
248 
249 /*MC
250   PETSC_VIEWER_SOCKET_WORLD  - same as PETSC_VIEWER_SOCKET_(PETSC_COMM_WORLD)
251 
252   Level: intermediate
253 M*/
254 #define PETSC_VIEWER_SOCKET_WORLD PETSC_VIEWER_SOCKET_(PETSC_COMM_WORLD)
255 
256 /*MC
257   PETSC_VIEWER_SOCKET_SELF  - same as PETSC_VIEWER_SOCKET_(PETSC_COMM_SELF)
258 
259   Level: intermediate
260 M*/
261 #define PETSC_VIEWER_SOCKET_SELF  PETSC_VIEWER_SOCKET_(PETSC_COMM_SELF)
262 
263 /*MC
264   PETSC_VIEWER_BINARY_WORLD  - same as PETSC_VIEWER_BINARY_(PETSC_COMM_WORLD)
265 
266   Level: intermediate
267 M*/
268 #define PETSC_VIEWER_BINARY_WORLD PETSC_VIEWER_BINARY_(PETSC_COMM_WORLD)
269 
270 /*MC
271   PETSC_VIEWER_BINARY_SELF  - same as PETSC_VIEWER_BINARY_(PETSC_COMM_SELF)
272 
273   Level: intermediate
274 M*/
275 #define PETSC_VIEWER_BINARY_SELF  PETSC_VIEWER_BINARY_(PETSC_COMM_SELF)
276 
277 /*MC
278   PETSC_VIEWER_MATLAB_WORLD  - same as PETSC_VIEWER_MATLAB_(PETSC_COMM_WORLD)
279 
280   Level: intermediate
281 M*/
282 #define PETSC_VIEWER_MATLAB_WORLD PETSC_VIEWER_MATLAB_(PETSC_COMM_WORLD)
283 
284 /*MC
285   PETSC_VIEWER_MATLAB_SELF  - same as PETSC_VIEWER_MATLAB_(PETSC_COMM_SELF)
286 
287   Level: intermediate
288 M*/
289 #define PETSC_VIEWER_MATLAB_SELF  PETSC_VIEWER_MATLAB_(PETSC_COMM_SELF)
290 
291 #define PETSC_VIEWER_MATHEMATICA_WORLD (PetscViewerInitializeMathematicaWorld_Private(),PETSC_VIEWER_MATHEMATICA_WORLD_PRIVATE)
292 
293 #undef __FUNCT__
294 #define __FUNCT__ "PetscViewerFlowControlStart"
295 PETSC_STATIC_INLINE PetscErrorCode PetscViewerFlowControlStart(PetscViewer viewer,PetscInt *mcnt,PetscInt *cnt)
296 {
297   PetscErrorCode ierr;
298   PetscFunctionBegin;
299   ierr = PetscViewerBinaryGetFlowControl(viewer,mcnt);CHKERRQ(ierr);
300   ierr = PetscViewerBinaryGetFlowControl(viewer,cnt);CHKERRQ(ierr);
301   PetscFunctionReturn(0);
302 }
303 
304 #undef __FUNCT__
305 #define __FUNCT__ "PetscViewerFlowControlStepMaster"
306 PETSC_STATIC_INLINE PetscErrorCode PetscViewerFlowControlStepMaster(PetscViewer viewer,PetscInt i,PetscInt *mcnt,PetscInt cnt)
307 {
308   PetscErrorCode ierr;
309   MPI_Comm       comm;
310 
311   PetscFunctionBegin;
312   ierr = PetscObjectGetComm((PetscObject)viewer,&comm);CHKERRQ(ierr);
313   if (i >= *mcnt) {
314     *mcnt += cnt;
315     ierr = MPI_Bcast(mcnt,1,MPIU_INT,0,comm);CHKERRQ(ierr);
316   }
317   PetscFunctionReturn(0);
318 }
319 
320 #undef __FUNCT__
321 #define __FUNCT__ "PetscViewerFlowControlEndMaster"
322 PETSC_STATIC_INLINE PetscErrorCode PetscViewerFlowControlEndMaster(PetscViewer viewer,PetscInt *mcnt)
323 {
324   PetscErrorCode ierr;
325   MPI_Comm       comm;
326   PetscFunctionBegin;
327   ierr = PetscObjectGetComm((PetscObject)viewer,&comm);CHKERRQ(ierr);
328   *mcnt = 0;
329   ierr = MPI_Bcast(mcnt,1,MPIU_INT,0,comm);CHKERRQ(ierr);
330   PetscFunctionReturn(0);
331 }
332 
333 #undef __FUNCT__
334 #define __FUNCT__ "PetscViewerFlowControlStepWorker"
335 PETSC_STATIC_INLINE PetscErrorCode PetscViewerFlowControlStepWorker(PetscViewer viewer,PetscMPIInt rank,PetscInt *mcnt)
336 {
337   PetscErrorCode ierr;
338   MPI_Comm       comm;
339   PetscFunctionBegin;
340   ierr = PetscObjectGetComm((PetscObject)viewer,&comm);CHKERRQ(ierr);
341   while (PETSC_TRUE) {
342     if (rank < *mcnt) break;
343     ierr = MPI_Bcast(mcnt,1,MPIU_INT,0,comm);CHKERRQ(ierr);
344   }
345   PetscFunctionReturn(0);
346 }
347 
348 #undef __FUNCT__
349 #define __FUNCT__ "PetscViewerFlowControlEndWorker"
350 PETSC_STATIC_INLINE PetscErrorCode PetscViewerFlowControlEndWorker(PetscViewer viewer,PetscInt *mcnt)
351 {
352   PetscErrorCode ierr;
353   MPI_Comm       comm;
354   PetscFunctionBegin;
355   ierr = PetscObjectGetComm((PetscObject)viewer,&comm);CHKERRQ(ierr);
356   while (PETSC_TRUE) {
357     ierr = MPI_Bcast(mcnt,1,MPIU_INT,0,comm);CHKERRQ(ierr);
358     if (!*mcnt) break;
359   }
360   PetscFunctionReturn(0);
361 }
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   Concepts: viewing
380 
381 .seealso:  PetscViewerCreate(), PetscViewerSetType(), PetscViewerType, PetscViewer, PetscViewersCreate(),
382            PetscViewersGetViewer()
383 S*/
384 typedef struct _n_PetscViewers* PetscViewers;
385 PETSC_EXTERN PetscErrorCode PetscViewersCreate(MPI_Comm,PetscViewers*);
386 PETSC_EXTERN PetscErrorCode PetscViewersDestroy(PetscViewers*);
387 PETSC_EXTERN PetscErrorCode PetscViewersGetViewer(PetscViewers,PetscInt,PetscViewer*);
388 
389 /* Reset __FUNCT__ in case the user does not define it themselves */
390 #undef __FUNCT__
391 #define __FUNCT__ "User provided function"
392 
393 #endif
394