xref: /petsc/include/petscviewer.h (revision df6f6c19b095f1abc1ac27fcbb9c2092a4a2a65e) 
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_HDF5_VIZ,
121   PETSC_VIEWER_NOFORMAT
122   } PetscViewerFormat;
123 PETSC_EXTERN const char *const PetscViewerFormats[];
124 
125 PETSC_EXTERN PetscErrorCode PetscViewerSetFormat(PetscViewer,PetscViewerFormat);
126 PETSC_EXTERN PetscErrorCode PetscViewerPushFormat(PetscViewer,PetscViewerFormat);
127 PETSC_EXTERN PetscErrorCode PetscViewerPopFormat(PetscViewer);
128 PETSC_EXTERN PetscErrorCode PetscViewerGetFormat(PetscViewer,PetscViewerFormat*);
129 PETSC_EXTERN PetscErrorCode PetscViewerFlush(PetscViewer);
130 
131 PETSC_EXTERN PetscErrorCode PetscOptionsGetViewer(MPI_Comm,const char[],const char[],PetscViewer*,PetscViewerFormat*,PetscBool*);
132 PETSC_EXTERN PetscErrorCode PetscOptionsViewer(const char[],const char[],const char[],PetscViewer*,PetscViewerFormat *,PetscBool *);
133 
134 /*
135    Operations explicit to a particular class of viewers
136 */
137 
138 PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetPointer(PetscViewer,FILE**);
139 PETSC_EXTERN PetscErrorCode PetscViewerFileGetMode(PetscViewer,PetscFileMode*);
140 PETSC_EXTERN PetscErrorCode PetscViewerFileSetMode(PetscViewer,PetscFileMode);
141 PETSC_EXTERN PetscErrorCode PetscViewerRead(PetscViewer,void*,PetscInt,PetscDataType);
142 PETSC_EXTERN PetscErrorCode PetscViewerASCIIPrintf(PetscViewer,const char[],...);
143 PETSC_EXTERN PetscErrorCode PetscViewerASCIISynchronizedPrintf(PetscViewer,const char[],...);
144 PETSC_EXTERN PetscErrorCode PetscViewerASCIISynchronizedAllow(PetscViewer,PetscBool);
145 PETSC_EXTERN PetscErrorCode PetscViewerASCIIPushTab(PetscViewer);
146 PETSC_EXTERN PetscErrorCode PetscViewerASCIIPopTab(PetscViewer);
147 PETSC_EXTERN PetscErrorCode PetscViewerASCIIUseTabs(PetscViewer,PetscBool );
148 PETSC_EXTERN PetscErrorCode PetscViewerASCIISetTab(PetscViewer,PetscInt);
149 PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetTab(PetscViewer,PetscInt*);
150 PETSC_EXTERN PetscErrorCode PetscViewerASCIIAddTab(PetscViewer,PetscInt);
151 PETSC_EXTERN PetscErrorCode PetscViewerASCIISubtractTab(PetscViewer,PetscInt);
152 PETSC_EXTERN PetscErrorCode PetscViewerASCIIRead(PetscViewer,void *,PetscInt,PetscDataType);
153 PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetDescriptor(PetscViewer,int*);
154 PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetInfoPointer(PetscViewer,FILE **);
155 PETSC_EXTERN PetscErrorCode PetscViewerBinaryRead(PetscViewer,void*,PetscInt,PetscDataType);
156 PETSC_EXTERN PetscErrorCode PetscViewerBinaryWrite(PetscViewer,void*,PetscInt,PetscDataType,PetscBool );
157 PETSC_EXTERN PetscErrorCode PetscViewerStringSPrintf(PetscViewer,const char[],...);
158 PETSC_EXTERN PetscErrorCode PetscViewerStringSetString(PetscViewer,char[],PetscInt);
159 PETSC_EXTERN PetscErrorCode PetscViewerDrawClear(PetscViewer);
160 PETSC_EXTERN PetscErrorCode PetscViewerDrawSetHold(PetscViewer,PetscBool);
161 PETSC_EXTERN PetscErrorCode PetscViewerDrawGetHold(PetscViewer,PetscBool*);
162 PETSC_EXTERN PetscErrorCode PetscViewerDrawSetPause(PetscViewer,PetscReal);
163 PETSC_EXTERN PetscErrorCode PetscViewerDrawGetPause(PetscViewer,PetscReal*);
164 PETSC_EXTERN PetscErrorCode PetscViewerDrawSetInfo(PetscViewer,const char[],const char[],int,int,int,int);
165 PETSC_EXTERN PetscErrorCode PetscViewerDrawResize(PetscViewer,int,int);
166 PETSC_EXTERN PetscErrorCode PetscViewerDrawSetBounds(PetscViewer,PetscInt,const PetscReal*);
167 PETSC_EXTERN PetscErrorCode PetscViewerDrawGetBounds(PetscViewer,PetscInt*,const PetscReal**);
168 PETSC_EXTERN PetscErrorCode PetscViewerSocketSetConnection(PetscViewer,const char[],int);
169 PETSC_EXTERN PetscErrorCode PetscViewerBinarySkipInfo(PetscViewer);
170 PETSC_EXTERN PetscErrorCode PetscViewerBinarySetSkipOptions(PetscViewer,PetscBool );
171 PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetSkipOptions(PetscViewer,PetscBool *);
172 PETSC_EXTERN PetscErrorCode PetscViewerBinarySetSkipHeader(PetscViewer,PetscBool);
173 PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetSkipHeader(PetscViewer,PetscBool*);
174 PETSC_EXTERN PetscErrorCode PetscViewerBinaryReadStringArray(PetscViewer,char***);
175 PETSC_EXTERN PetscErrorCode PetscViewerBinaryWriteStringArray(PetscViewer,char**);
176 
177 PETSC_EXTERN PetscErrorCode PetscViewerFileSetName(PetscViewer,const char[]);
178 PETSC_EXTERN PetscErrorCode PetscViewerFileGetName(PetscViewer,const char**);
179 
180 PETSC_EXTERN PetscErrorCode PetscViewerVUGetPointer(PetscViewer, FILE**);
181 PETSC_EXTERN PetscErrorCode PetscViewerVUSetVecSeen(PetscViewer, PetscBool );
182 PETSC_EXTERN PetscErrorCode PetscViewerVUGetVecSeen(PetscViewer, PetscBool  *);
183 PETSC_EXTERN PetscErrorCode PetscViewerVUPrintDeferred(PetscViewer, const char [], ...);
184 PETSC_EXTERN PetscErrorCode PetscViewerVUFlushDeferred(PetscViewer);
185 
186 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaInitializePackage(void);
187 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaFinalizePackage(void);
188 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaGetName(PetscViewer, const char **);
189 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaSetName(PetscViewer, const char []);
190 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaClearName(PetscViewer);
191 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaSkipPackets(PetscViewer, int);
192 
193 PETSC_EXTERN PetscErrorCode PetscViewerSiloGetName(PetscViewer, char **);
194 PETSC_EXTERN PetscErrorCode PetscViewerSiloSetName(PetscViewer, const char []);
195 PETSC_EXTERN PetscErrorCode PetscViewerSiloClearName(PetscViewer);
196 PETSC_EXTERN PetscErrorCode PetscViewerSiloGetMeshName(PetscViewer, char **);
197 PETSC_EXTERN PetscErrorCode PetscViewerSiloSetMeshName(PetscViewer, const char []);
198 PETSC_EXTERN PetscErrorCode PetscViewerSiloClearMeshName(PetscViewer);
199 
200 PETSC_EXTERN PetscErrorCode PetscViewerNetcdfOpen(MPI_Comm,const char[],PetscFileMode,PetscViewer*);
201 PETSC_EXTERN PetscErrorCode PetscViewerNetcdfGetID(PetscViewer, int *);
202 
203 typedef enum {PETSC_VTK_POINT_FIELD, PETSC_VTK_POINT_VECTOR_FIELD, PETSC_VTK_CELL_FIELD, PETSC_VTK_CELL_VECTOR_FIELD} PetscViewerVTKFieldType;
204 PETSC_EXTERN PetscErrorCode PetscViewerVTKAddField(PetscViewer,PetscObject,PetscErrorCode (*PetscViewerVTKWriteFunction)(PetscObject,PetscViewer),PetscViewerVTKFieldType,PetscObject);
205 PETSC_EXTERN PetscErrorCode PetscViewerVTKOpen(MPI_Comm,const char[],PetscFileMode,PetscViewer*);
206 
207 /*
208      These are all the default viewers that do not have to be explicitly opened
209 */
210 PETSC_EXTERN PetscViewer    PETSC_VIEWER_STDOUT_(MPI_Comm);
211 PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetStdout(MPI_Comm,PetscViewer*);
212 PETSC_EXTERN PetscViewer    PETSC_VIEWER_STDERR_(MPI_Comm);
213 PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetStderr(MPI_Comm,PetscViewer*);
214 PETSC_EXTERN PetscViewer    PETSC_VIEWER_DRAW_(MPI_Comm);
215 PETSC_EXTERN PetscViewer    PETSC_VIEWER_SOCKET_(MPI_Comm);
216 PETSC_EXTERN PetscViewer    PETSC_VIEWER_BINARY_(MPI_Comm);
217 PETSC_EXTERN PetscViewer    PETSC_VIEWER_MATLAB_(MPI_Comm);
218 PETSC_EXTERN PetscViewer    PETSC_VIEWER_HDF5_(MPI_Comm);
219 PETSC_EXTERN PetscViewer   PETSC_VIEWER_MATHEMATICA_WORLD_PRIVATE;
220 
221 #define PETSC_VIEWER_STDERR_SELF  PETSC_VIEWER_STDERR_(PETSC_COMM_SELF)
222 #define PETSC_VIEWER_STDERR_WORLD PETSC_VIEWER_STDERR_(PETSC_COMM_WORLD)
223 
224 /*MC
225   PETSC_VIEWER_STDOUT_WORLD  - same as PETSC_VIEWER_STDOUT_(PETSC_COMM_WORLD)
226 
227   Level: beginner
228 M*/
229 #define PETSC_VIEWER_STDOUT_WORLD PETSC_VIEWER_STDOUT_(PETSC_COMM_WORLD)
230 
231 /*MC
232   PETSC_VIEWER_STDOUT_SELF  - same as PETSC_VIEWER_STDOUT_(PETSC_COMM_SELF)
233 
234   Level: beginner
235 M*/
236 #define PETSC_VIEWER_STDOUT_SELF  PETSC_VIEWER_STDOUT_(PETSC_COMM_SELF)
237 
238 /*MC
239   PETSC_VIEWER_DRAW_WORLD  - same as PETSC_VIEWER_DRAW_(PETSC_COMM_WORLD)
240 
241   Level: intermediate
242 M*/
243 #define PETSC_VIEWER_DRAW_WORLD   PETSC_VIEWER_DRAW_(PETSC_COMM_WORLD)
244 
245 /*MC
246   PETSC_VIEWER_DRAW_SELF  - same as PETSC_VIEWER_DRAW_(PETSC_COMM_SELF)
247 
248   Level: intermediate
249 M*/
250 #define PETSC_VIEWER_DRAW_SELF    PETSC_VIEWER_DRAW_(PETSC_COMM_SELF)
251 
252 /*MC
253   PETSC_VIEWER_SOCKET_WORLD  - same as PETSC_VIEWER_SOCKET_(PETSC_COMM_WORLD)
254 
255   Level: intermediate
256 M*/
257 #define PETSC_VIEWER_SOCKET_WORLD PETSC_VIEWER_SOCKET_(PETSC_COMM_WORLD)
258 
259 /*MC
260   PETSC_VIEWER_SOCKET_SELF  - same as PETSC_VIEWER_SOCKET_(PETSC_COMM_SELF)
261 
262   Level: intermediate
263 M*/
264 #define PETSC_VIEWER_SOCKET_SELF  PETSC_VIEWER_SOCKET_(PETSC_COMM_SELF)
265 
266 /*MC
267   PETSC_VIEWER_BINARY_WORLD  - same as PETSC_VIEWER_BINARY_(PETSC_COMM_WORLD)
268 
269   Level: intermediate
270 M*/
271 #define PETSC_VIEWER_BINARY_WORLD PETSC_VIEWER_BINARY_(PETSC_COMM_WORLD)
272 
273 /*MC
274   PETSC_VIEWER_BINARY_SELF  - same as PETSC_VIEWER_BINARY_(PETSC_COMM_SELF)
275 
276   Level: intermediate
277 M*/
278 #define PETSC_VIEWER_BINARY_SELF  PETSC_VIEWER_BINARY_(PETSC_COMM_SELF)
279 
280 /*MC
281   PETSC_VIEWER_MATLAB_WORLD  - same as PETSC_VIEWER_MATLAB_(PETSC_COMM_WORLD)
282 
283   Level: intermediate
284 M*/
285 #define PETSC_VIEWER_MATLAB_WORLD PETSC_VIEWER_MATLAB_(PETSC_COMM_WORLD)
286 
287 /*MC
288   PETSC_VIEWER_MATLAB_SELF  - same as PETSC_VIEWER_MATLAB_(PETSC_COMM_SELF)
289 
290   Level: intermediate
291 M*/
292 #define PETSC_VIEWER_MATLAB_SELF  PETSC_VIEWER_MATLAB_(PETSC_COMM_SELF)
293 
294 #define PETSC_VIEWER_MATHEMATICA_WORLD (PetscViewerInitializeMathematicaWorld_Private(),PETSC_VIEWER_MATHEMATICA_WORLD_PRIVATE)
295 
296 #undef __FUNCT__
297 #define __FUNCT__ "PetscViewerFlowControlStart"
298 PETSC_STATIC_INLINE PetscErrorCode PetscViewerFlowControlStart(PetscViewer viewer,PetscInt *mcnt,PetscInt *cnt)
299 {
300   PetscErrorCode ierr;
301   PetscFunctionBegin;
302   ierr = PetscViewerBinaryGetFlowControl(viewer,mcnt);CHKERRQ(ierr);
303   ierr = PetscViewerBinaryGetFlowControl(viewer,cnt);CHKERRQ(ierr);
304   PetscFunctionReturn(0);
305 }
306 
307 #undef __FUNCT__
308 #define __FUNCT__ "PetscViewerFlowControlStepMaster"
309 PETSC_STATIC_INLINE PetscErrorCode PetscViewerFlowControlStepMaster(PetscViewer viewer,PetscInt i,PetscInt *mcnt,PetscInt cnt)
310 {
311   PetscErrorCode ierr;
312   MPI_Comm       comm;
313 
314   PetscFunctionBegin;
315   ierr = PetscObjectGetComm((PetscObject)viewer,&comm);CHKERRQ(ierr);
316   if (i >= *mcnt) {
317     *mcnt += cnt;
318     ierr = MPI_Bcast(mcnt,1,MPIU_INT,0,comm);CHKERRQ(ierr);
319   }
320   PetscFunctionReturn(0);
321 }
322 
323 #undef __FUNCT__
324 #define __FUNCT__ "PetscViewerFlowControlEndMaster"
325 PETSC_STATIC_INLINE PetscErrorCode PetscViewerFlowControlEndMaster(PetscViewer viewer,PetscInt *mcnt)
326 {
327   PetscErrorCode ierr;
328   MPI_Comm       comm;
329   PetscFunctionBegin;
330   ierr = PetscObjectGetComm((PetscObject)viewer,&comm);CHKERRQ(ierr);
331   *mcnt = 0;
332   ierr = MPI_Bcast(mcnt,1,MPIU_INT,0,comm);CHKERRQ(ierr);
333   PetscFunctionReturn(0);
334 }
335 
336 #undef __FUNCT__
337 #define __FUNCT__ "PetscViewerFlowControlStepWorker"
338 PETSC_STATIC_INLINE PetscErrorCode PetscViewerFlowControlStepWorker(PetscViewer viewer,PetscMPIInt rank,PetscInt *mcnt)
339 {
340   PetscErrorCode ierr;
341   MPI_Comm       comm;
342   PetscFunctionBegin;
343   ierr = PetscObjectGetComm((PetscObject)viewer,&comm);CHKERRQ(ierr);
344   while (PETSC_TRUE) {
345     if (rank < *mcnt) break;
346     ierr = MPI_Bcast(mcnt,1,MPIU_INT,0,comm);CHKERRQ(ierr);
347   }
348   PetscFunctionReturn(0);
349 }
350 
351 #undef __FUNCT__
352 #define __FUNCT__ "PetscViewerFlowControlEndWorker"
353 PETSC_STATIC_INLINE PetscErrorCode PetscViewerFlowControlEndWorker(PetscViewer viewer,PetscInt *mcnt)
354 {
355   PetscErrorCode ierr;
356   MPI_Comm       comm;
357   PetscFunctionBegin;
358   ierr = PetscObjectGetComm((PetscObject)viewer,&comm);CHKERRQ(ierr);
359   while (PETSC_TRUE) {
360     ierr = MPI_Bcast(mcnt,1,MPIU_INT,0,comm);CHKERRQ(ierr);
361     if (!*mcnt) break;
362   }
363   PetscFunctionReturn(0);
364 }
365 
366 /*
367    PetscViewer writes to MATLAB .mat file
368 */
369 PETSC_EXTERN PetscErrorCode PetscViewerMatlabPutArray(PetscViewer,int,int,const PetscScalar*,const char*);
370 PETSC_EXTERN PetscErrorCode PetscViewerMatlabGetArray(PetscViewer,int,int,PetscScalar*,const char*);
371 PETSC_EXTERN PetscErrorCode PetscViewerMatlabPutVariable(PetscViewer,const char*,void*);
372 
373 #if defined(PETSC_HAVE_SAWS)
374 PETSC_EXTERN PetscErrorCode PetscObjectViewSAWs(PetscObject,PetscViewer);
375 #endif
376 
377 /*S
378      PetscViewers - Abstract collection of PetscViewers. It is just an expandable array of viewers.
379 
380    Level: intermediate
381 
382   Concepts: viewing
383 
384 .seealso:  PetscViewerCreate(), PetscViewerSetType(), PetscViewerType, PetscViewer, PetscViewersCreate(),
385            PetscViewersGetViewer()
386 S*/
387 typedef struct _n_PetscViewers* PetscViewers;
388 PETSC_EXTERN PetscErrorCode PetscViewersCreate(MPI_Comm,PetscViewers*);
389 PETSC_EXTERN PetscErrorCode PetscViewersDestroy(PetscViewers*);
390 PETSC_EXTERN PetscErrorCode PetscViewersGetViewer(PetscViewers,PetscInt,PetscViewer*);
391 
392 /* Reset __FUNCT__ in case the user does not define it themselves */
393 #undef __FUNCT__
394 #define __FUNCT__ "User provided function"
395 
396 #endif
397