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