xref: /petsc/include/petscviewer.h (revision cd5eaeb712f0bc77bdce843018b541db19340d1f) 
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 PetscViewerBinarySetUseMPIIO(PetscViewer,PetscBool);
49 PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetUseMPIIO(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,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,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 petsc/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 #define PetscOptionsViewer(a,b,c,d,e,f) PetscOptionsViewer_Private(PetscOptionsObject,a,b,c,d,e,f);
132 PETSC_EXTERN PetscErrorCode PetscOptionsViewer_Private(PetscOptions*,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,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,PetscInt*,PetscDataType);
153 PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetDescriptor(PetscViewer,int*);
154 PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetInfoPointer(PetscViewer,FILE **);
155 PETSC_EXTERN PetscErrorCode PetscViewerBinaryRead(PetscViewer,void*,PetscInt,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 PetscViewerBinarySetSkipInfo(PetscViewer,PetscBool);
171 PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetSkipInfo(PetscViewer,PetscBool*);
172 PETSC_EXTERN PetscErrorCode PetscViewerBinarySetSkipOptions(PetscViewer,PetscBool );
173 PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetSkipOptions(PetscViewer,PetscBool *);
174 PETSC_EXTERN PetscErrorCode PetscViewerBinarySetSkipHeader(PetscViewer,PetscBool);
175 PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetSkipHeader(PetscViewer,PetscBool*);
176 PETSC_EXTERN PetscErrorCode PetscViewerBinaryReadStringArray(PetscViewer,char***);
177 PETSC_EXTERN PetscErrorCode PetscViewerBinaryWriteStringArray(PetscViewer,char**);
178 
179 PETSC_EXTERN PetscErrorCode PetscViewerFileSetName(PetscViewer,const char[]);
180 PETSC_EXTERN PetscErrorCode PetscViewerFileGetName(PetscViewer,const char**);
181 
182 PETSC_EXTERN PetscErrorCode PetscViewerVUGetPointer(PetscViewer, FILE**);
183 PETSC_EXTERN PetscErrorCode PetscViewerVUSetVecSeen(PetscViewer, PetscBool );
184 PETSC_EXTERN PetscErrorCode PetscViewerVUGetVecSeen(PetscViewer, PetscBool  *);
185 PETSC_EXTERN PetscErrorCode PetscViewerVUPrintDeferred(PetscViewer, const char [], ...);
186 PETSC_EXTERN PetscErrorCode PetscViewerVUFlushDeferred(PetscViewer);
187 
188 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaInitializePackage(void);
189 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaFinalizePackage(void);
190 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaGetName(PetscViewer, const char **);
191 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaSetName(PetscViewer, const char []);
192 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaClearName(PetscViewer);
193 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaSkipPackets(PetscViewer, int);
194 
195 PETSC_EXTERN PetscErrorCode PetscViewerSiloGetName(PetscViewer, char **);
196 PETSC_EXTERN PetscErrorCode PetscViewerSiloSetName(PetscViewer, const char []);
197 PETSC_EXTERN PetscErrorCode PetscViewerSiloClearName(PetscViewer);
198 PETSC_EXTERN PetscErrorCode PetscViewerSiloGetMeshName(PetscViewer, char **);
199 PETSC_EXTERN PetscErrorCode PetscViewerSiloSetMeshName(PetscViewer, const char []);
200 PETSC_EXTERN PetscErrorCode PetscViewerSiloClearMeshName(PetscViewer);
201 
202 PETSC_EXTERN PetscErrorCode PetscViewerNetcdfOpen(MPI_Comm,const char[],PetscFileMode,PetscViewer*);
203 PETSC_EXTERN PetscErrorCode PetscViewerNetcdfGetID(PetscViewer, int *);
204 
205 typedef enum {PETSC_VTK_POINT_FIELD, PETSC_VTK_POINT_VECTOR_FIELD, PETSC_VTK_CELL_FIELD, PETSC_VTK_CELL_VECTOR_FIELD} PetscViewerVTKFieldType;
206 PETSC_EXTERN PetscErrorCode PetscViewerVTKAddField(PetscViewer,PetscObject,PetscErrorCode (*PetscViewerVTKWriteFunction)(PetscObject,PetscViewer),PetscViewerVTKFieldType,PetscObject);
207 PETSC_EXTERN PetscErrorCode PetscViewerVTKOpen(MPI_Comm,const char[],PetscFileMode,PetscViewer*);
208 
209 /*
210      These are all the default viewers that do not have to be explicitly opened
211 */
212 PETSC_EXTERN PetscViewer    PETSC_VIEWER_STDOUT_(MPI_Comm);
213 PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetStdout(MPI_Comm,PetscViewer*);
214 PETSC_EXTERN PetscViewer    PETSC_VIEWER_STDERR_(MPI_Comm);
215 PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetStderr(MPI_Comm,PetscViewer*);
216 PETSC_EXTERN PetscViewer    PETSC_VIEWER_DRAW_(MPI_Comm);
217 PETSC_EXTERN PetscViewer    PETSC_VIEWER_SOCKET_(MPI_Comm);
218 PETSC_EXTERN PetscViewer    PETSC_VIEWER_BINARY_(MPI_Comm);
219 PETSC_EXTERN PetscViewer    PETSC_VIEWER_MATLAB_(MPI_Comm);
220 PETSC_EXTERN PetscViewer    PETSC_VIEWER_HDF5_(MPI_Comm);
221 PETSC_EXTERN PetscViewer   PETSC_VIEWER_MATHEMATICA_WORLD_PRIVATE;
222 
223 #define PETSC_VIEWER_STDERR_SELF  PETSC_VIEWER_STDERR_(PETSC_COMM_SELF)
224 #define PETSC_VIEWER_STDERR_WORLD PETSC_VIEWER_STDERR_(PETSC_COMM_WORLD)
225 
226 /*MC
227   PETSC_VIEWER_STDOUT_WORLD  - same as PETSC_VIEWER_STDOUT_(PETSC_COMM_WORLD)
228 
229   Level: beginner
230 M*/
231 #define PETSC_VIEWER_STDOUT_WORLD PETSC_VIEWER_STDOUT_(PETSC_COMM_WORLD)
232 
233 /*MC
234   PETSC_VIEWER_STDOUT_SELF  - same as PETSC_VIEWER_STDOUT_(PETSC_COMM_SELF)
235 
236   Level: beginner
237 M*/
238 #define PETSC_VIEWER_STDOUT_SELF  PETSC_VIEWER_STDOUT_(PETSC_COMM_SELF)
239 
240 /*MC
241   PETSC_VIEWER_DRAW_WORLD  - same as PETSC_VIEWER_DRAW_(PETSC_COMM_WORLD)
242 
243   Level: intermediate
244 M*/
245 #define PETSC_VIEWER_DRAW_WORLD   PETSC_VIEWER_DRAW_(PETSC_COMM_WORLD)
246 
247 /*MC
248   PETSC_VIEWER_DRAW_SELF  - same as PETSC_VIEWER_DRAW_(PETSC_COMM_SELF)
249 
250   Level: intermediate
251 M*/
252 #define PETSC_VIEWER_DRAW_SELF    PETSC_VIEWER_DRAW_(PETSC_COMM_SELF)
253 
254 /*MC
255   PETSC_VIEWER_SOCKET_WORLD  - same as PETSC_VIEWER_SOCKET_(PETSC_COMM_WORLD)
256 
257   Level: intermediate
258 M*/
259 #define PETSC_VIEWER_SOCKET_WORLD PETSC_VIEWER_SOCKET_(PETSC_COMM_WORLD)
260 
261 /*MC
262   PETSC_VIEWER_SOCKET_SELF  - same as PETSC_VIEWER_SOCKET_(PETSC_COMM_SELF)
263 
264   Level: intermediate
265 M*/
266 #define PETSC_VIEWER_SOCKET_SELF  PETSC_VIEWER_SOCKET_(PETSC_COMM_SELF)
267 
268 /*MC
269   PETSC_VIEWER_BINARY_WORLD  - same as PETSC_VIEWER_BINARY_(PETSC_COMM_WORLD)
270 
271   Level: intermediate
272 M*/
273 #define PETSC_VIEWER_BINARY_WORLD PETSC_VIEWER_BINARY_(PETSC_COMM_WORLD)
274 
275 /*MC
276   PETSC_VIEWER_BINARY_SELF  - same as PETSC_VIEWER_BINARY_(PETSC_COMM_SELF)
277 
278   Level: intermediate
279 M*/
280 #define PETSC_VIEWER_BINARY_SELF  PETSC_VIEWER_BINARY_(PETSC_COMM_SELF)
281 
282 /*MC
283   PETSC_VIEWER_MATLAB_WORLD  - same as PETSC_VIEWER_MATLAB_(PETSC_COMM_WORLD)
284 
285   Level: intermediate
286 M*/
287 #define PETSC_VIEWER_MATLAB_WORLD PETSC_VIEWER_MATLAB_(PETSC_COMM_WORLD)
288 
289 /*MC
290   PETSC_VIEWER_MATLAB_SELF  - same as PETSC_VIEWER_MATLAB_(PETSC_COMM_SELF)
291 
292   Level: intermediate
293 M*/
294 #define PETSC_VIEWER_MATLAB_SELF  PETSC_VIEWER_MATLAB_(PETSC_COMM_SELF)
295 
296 #define PETSC_VIEWER_MATHEMATICA_WORLD (PetscViewerInitializeMathematicaWorld_Private(),PETSC_VIEWER_MATHEMATICA_WORLD_PRIVATE)
297 
298 #undef __FUNCT__
299 #define __FUNCT__ "PetscViewerFlowControlStart"
300 PETSC_STATIC_INLINE PetscErrorCode PetscViewerFlowControlStart(PetscViewer viewer,PetscInt *mcnt,PetscInt *cnt)
301 {
302   PetscErrorCode ierr;
303   PetscFunctionBegin;
304   ierr = PetscViewerBinaryGetFlowControl(viewer,mcnt);CHKERRQ(ierr);
305   ierr = PetscViewerBinaryGetFlowControl(viewer,cnt);CHKERRQ(ierr);
306   PetscFunctionReturn(0);
307 }
308 
309 #undef __FUNCT__
310 #define __FUNCT__ "PetscViewerFlowControlStepMaster"
311 PETSC_STATIC_INLINE PetscErrorCode PetscViewerFlowControlStepMaster(PetscViewer viewer,PetscInt i,PetscInt *mcnt,PetscInt cnt)
312 {
313   PetscErrorCode ierr;
314   MPI_Comm       comm;
315 
316   PetscFunctionBegin;
317   ierr = PetscObjectGetComm((PetscObject)viewer,&comm);CHKERRQ(ierr);
318   if (i >= *mcnt) {
319     *mcnt += cnt;
320     ierr = MPI_Bcast(mcnt,1,MPIU_INT,0,comm);CHKERRQ(ierr);
321   }
322   PetscFunctionReturn(0);
323 }
324 
325 #undef __FUNCT__
326 #define __FUNCT__ "PetscViewerFlowControlEndMaster"
327 PETSC_STATIC_INLINE PetscErrorCode PetscViewerFlowControlEndMaster(PetscViewer viewer,PetscInt *mcnt)
328 {
329   PetscErrorCode ierr;
330   MPI_Comm       comm;
331   PetscFunctionBegin;
332   ierr = PetscObjectGetComm((PetscObject)viewer,&comm);CHKERRQ(ierr);
333   *mcnt = 0;
334   ierr = MPI_Bcast(mcnt,1,MPIU_INT,0,comm);CHKERRQ(ierr);
335   PetscFunctionReturn(0);
336 }
337 
338 #undef __FUNCT__
339 #define __FUNCT__ "PetscViewerFlowControlStepWorker"
340 PETSC_STATIC_INLINE PetscErrorCode PetscViewerFlowControlStepWorker(PetscViewer viewer,PetscMPIInt rank,PetscInt *mcnt)
341 {
342   PetscErrorCode ierr;
343   MPI_Comm       comm;
344   PetscFunctionBegin;
345   ierr = PetscObjectGetComm((PetscObject)viewer,&comm);CHKERRQ(ierr);
346   while (PETSC_TRUE) {
347     if (rank < *mcnt) break;
348     ierr = MPI_Bcast(mcnt,1,MPIU_INT,0,comm);CHKERRQ(ierr);
349   }
350   PetscFunctionReturn(0);
351 }
352 
353 #undef __FUNCT__
354 #define __FUNCT__ "PetscViewerFlowControlEndWorker"
355 PETSC_STATIC_INLINE PetscErrorCode PetscViewerFlowControlEndWorker(PetscViewer viewer,PetscInt *mcnt)
356 {
357   PetscErrorCode ierr;
358   MPI_Comm       comm;
359   PetscFunctionBegin;
360   ierr = PetscObjectGetComm((PetscObject)viewer,&comm);CHKERRQ(ierr);
361   while (PETSC_TRUE) {
362     ierr = MPI_Bcast(mcnt,1,MPIU_INT,0,comm);CHKERRQ(ierr);
363     if (!*mcnt) break;
364   }
365   PetscFunctionReturn(0);
366 }
367 
368 /*
369    PetscViewer writes to MATLAB .mat file
370 */
371 PETSC_EXTERN PetscErrorCode PetscViewerMatlabPutArray(PetscViewer,int,int,const PetscScalar*,const char*);
372 PETSC_EXTERN PetscErrorCode PetscViewerMatlabGetArray(PetscViewer,int,int,PetscScalar*,const char*);
373 PETSC_EXTERN PetscErrorCode PetscViewerMatlabPutVariable(PetscViewer,const char*,void*);
374 
375 #if defined(PETSC_HAVE_SAWS)
376 PETSC_EXTERN PetscErrorCode PetscObjectViewSAWs(PetscObject,PetscViewer);
377 #endif
378 
379 /*S
380      PetscViewers - Abstract collection of PetscViewers. It is just an expandable array of viewers.
381 
382    Level: intermediate
383 
384   Concepts: viewing
385 
386 .seealso:  PetscViewerCreate(), PetscViewerSetType(), PetscViewerType, PetscViewer, PetscViewersCreate(),
387            PetscViewersGetViewer()
388 S*/
389 typedef struct _n_PetscViewers* PetscViewers;
390 PETSC_EXTERN PetscErrorCode PetscViewersCreate(MPI_Comm,PetscViewers*);
391 PETSC_EXTERN PetscErrorCode PetscViewersDestroy(PetscViewers*);
392 PETSC_EXTERN PetscErrorCode PetscViewersGetViewer(PetscViewers,PetscInt,PetscViewer*);
393 
394 /* Reset __FUNCT__ in case the user does not define it themselves */
395 #undef __FUNCT__
396 #define __FUNCT__ "User provided function"
397 
398 #endif
399