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