xref: /petsc/include/petscviewer.h (revision dced61a5cfeeeda68dfa4ee3e53b34d3cfb8da9f) 
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 PetscViewerGetSubViewer(PetscViewer,MPI_Comm,PetscViewer*);
69 PETSC_EXTERN PetscErrorCode PetscViewerRestoreSubViewer(PetscViewer,MPI_Comm,PetscViewer*);
70 
71 PETSC_EXTERN PetscErrorCode PetscViewerSetUp(PetscViewer);
72 PETSC_EXTERN PetscErrorCode PetscViewerView(PetscViewer,PetscViewer);
73 PETSC_STATIC_INLINE PetscErrorCode PetscViewerViewFromOptions(PetscViewer A,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,name);}
74 
75 PETSC_EXTERN PetscErrorCode PetscViewerSetOptionsPrefix(PetscViewer,const char[]);
76 PETSC_EXTERN PetscErrorCode PetscViewerAppendOptionsPrefix(PetscViewer,const char[]);
77 PETSC_EXTERN PetscErrorCode PetscViewerGetOptionsPrefix(PetscViewer,const char*[]);
78 
79 /*E
80     PetscViewerFormat - Way a viewer presents the object
81 
82    Level: beginner
83 
84    The values below are also listed in petsc/finclude/petscviewer.h. If another values is added below it
85    must also be added there.
86 
87 .seealso: PetscViewerSetFormat(), PetscViewer, PetscViewerType, PetscViewerPushFormat(), PetscViewerPopFormat()
88 E*/
89 typedef enum {
90   PETSC_VIEWER_DEFAULT,
91   PETSC_VIEWER_ASCII_MATLAB,
92   PETSC_VIEWER_ASCII_MATHEMATICA,
93   PETSC_VIEWER_ASCII_IMPL,
94   PETSC_VIEWER_ASCII_INFO,
95   PETSC_VIEWER_ASCII_INFO_DETAIL,
96   PETSC_VIEWER_ASCII_COMMON,
97   PETSC_VIEWER_ASCII_SYMMODU,
98   PETSC_VIEWER_ASCII_INDEX,
99   PETSC_VIEWER_ASCII_DENSE,
100   PETSC_VIEWER_ASCII_MATRIXMARKET,
101   PETSC_VIEWER_ASCII_VTK,
102   PETSC_VIEWER_ASCII_VTK_CELL,
103   PETSC_VIEWER_ASCII_VTK_COORDS,
104   PETSC_VIEWER_ASCII_PCICE,
105   PETSC_VIEWER_ASCII_PYTHON,
106   PETSC_VIEWER_ASCII_FACTOR_INFO,
107   PETSC_VIEWER_ASCII_LATEX,
108   PETSC_VIEWER_DRAW_BASIC,
109   PETSC_VIEWER_DRAW_LG,
110   PETSC_VIEWER_DRAW_CONTOUR,
111   PETSC_VIEWER_DRAW_PORTS,
112   PETSC_VIEWER_VTK_VTS,
113   PETSC_VIEWER_VTK_VTR,
114   PETSC_VIEWER_VTK_VTU,
115   PETSC_VIEWER_BINARY_MATLAB,
116   PETSC_VIEWER_NATIVE,
117   PETSC_VIEWER_HDF5_VIZ,
118   PETSC_VIEWER_NOFORMAT
119   } PetscViewerFormat;
120 PETSC_EXTERN const char *const PetscViewerFormats[];
121 
122 PETSC_EXTERN PetscErrorCode PetscViewerSetFormat(PetscViewer,PetscViewerFormat);
123 PETSC_EXTERN PetscErrorCode PetscViewerPushFormat(PetscViewer,PetscViewerFormat);
124 PETSC_EXTERN PetscErrorCode PetscViewerPopFormat(PetscViewer);
125 PETSC_EXTERN PetscErrorCode PetscViewerGetFormat(PetscViewer,PetscViewerFormat*);
126 PETSC_EXTERN PetscErrorCode PetscViewerFlush(PetscViewer);
127 
128 PETSC_EXTERN PetscErrorCode PetscOptionsGetViewer(MPI_Comm,const char[],const char[],PetscViewer*,PetscViewerFormat*,PetscBool*);
129 #define PetscOptionsViewer(a,b,c,d,e,f) PetscOptionsViewer_Private(PetscOptionsObject,a,b,c,d,e,f);
130 PETSC_EXTERN PetscErrorCode PetscOptionsViewer_Private(PetscOptions*,const char[],const char[],const char[],PetscViewer*,PetscViewerFormat *,PetscBool *);
131 
132 /*
133    Operations explicit to a particular class of viewers
134 */
135 
136 PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetPointer(PetscViewer,FILE**);
137 PETSC_EXTERN PetscErrorCode PetscViewerFileGetMode(PetscViewer,PetscFileMode*);
138 PETSC_EXTERN PetscErrorCode PetscViewerFileSetMode(PetscViewer,PetscFileMode);
139 PETSC_EXTERN PetscErrorCode PetscViewerRead(PetscViewer,void*,PetscInt,PetscInt*,PetscDataType);
140 PETSC_EXTERN PetscErrorCode PetscViewerASCIIPrintf(PetscViewer,const char[],...);
141 PETSC_EXTERN PetscErrorCode PetscViewerASCIISynchronizedPrintf(PetscViewer,const char[],...);
142 PETSC_EXTERN PetscErrorCode PetscViewerASCIIPushSynchronized(PetscViewer);
143 PETSC_EXTERN PetscErrorCode PetscViewerASCIIPopSynchronized(PetscViewer);
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,PetscInt*,PetscDataType);
152 PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetDescriptor(PetscViewer,int*);
153 PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetInfoPointer(PetscViewer,FILE **);
154 PETSC_EXTERN PetscErrorCode PetscViewerBinaryRead(PetscViewer,void*,PetscInt,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 PetscViewerBinarySetSkipInfo(PetscViewer,PetscBool);
170 PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetSkipInfo(PetscViewer,PetscBool*);
171 PETSC_EXTERN PetscErrorCode PetscViewerBinarySetSkipOptions(PetscViewer,PetscBool );
172 PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetSkipOptions(PetscViewer,PetscBool *);
173 PETSC_EXTERN PetscErrorCode PetscViewerBinarySetSkipHeader(PetscViewer,PetscBool);
174 PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetSkipHeader(PetscViewer,PetscBool*);
175 PETSC_EXTERN PetscErrorCode PetscViewerBinaryReadStringArray(PetscViewer,char***);
176 PETSC_EXTERN PetscErrorCode PetscViewerBinaryWriteStringArray(PetscViewer,char**);
177 
178 PETSC_EXTERN PetscErrorCode PetscViewerFileSetName(PetscViewer,const char[]);
179 PETSC_EXTERN PetscErrorCode PetscViewerFileGetName(PetscViewer,const char**);
180 
181 PETSC_EXTERN PetscErrorCode PetscViewerVUGetPointer(PetscViewer, FILE**);
182 PETSC_EXTERN PetscErrorCode PetscViewerVUSetVecSeen(PetscViewer, PetscBool );
183 PETSC_EXTERN PetscErrorCode PetscViewerVUGetVecSeen(PetscViewer, PetscBool  *);
184 PETSC_EXTERN PetscErrorCode PetscViewerVUPrintDeferred(PetscViewer, const char [], ...);
185 PETSC_EXTERN PetscErrorCode PetscViewerVUFlushDeferred(PetscViewer);
186 
187 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaInitializePackage(void);
188 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaFinalizePackage(void);
189 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaGetName(PetscViewer, const char **);
190 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaSetName(PetscViewer, const char []);
191 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaClearName(PetscViewer);
192 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaSkipPackets(PetscViewer, int);
193 
194 PETSC_EXTERN PetscErrorCode PetscViewerSiloGetName(PetscViewer, char **);
195 PETSC_EXTERN PetscErrorCode PetscViewerSiloSetName(PetscViewer, const char []);
196 PETSC_EXTERN PetscErrorCode PetscViewerSiloClearName(PetscViewer);
197 PETSC_EXTERN PetscErrorCode PetscViewerSiloGetMeshName(PetscViewer, char **);
198 PETSC_EXTERN PetscErrorCode PetscViewerSiloSetMeshName(PetscViewer, const char []);
199 PETSC_EXTERN PetscErrorCode PetscViewerSiloClearMeshName(PetscViewer);
200 
201 PETSC_EXTERN PetscErrorCode PetscViewerNetcdfOpen(MPI_Comm,const char[],PetscFileMode,PetscViewer*);
202 PETSC_EXTERN PetscErrorCode PetscViewerNetcdfGetID(PetscViewer, int *);
203 
204 typedef enum {PETSC_VTK_POINT_FIELD, PETSC_VTK_POINT_VECTOR_FIELD, PETSC_VTK_CELL_FIELD, PETSC_VTK_CELL_VECTOR_FIELD} PetscViewerVTKFieldType;
205 PETSC_EXTERN PetscErrorCode PetscViewerVTKAddField(PetscViewer,PetscObject,PetscErrorCode (*PetscViewerVTKWriteFunction)(PetscObject,PetscViewer),PetscViewerVTKFieldType,PetscObject);
206 PETSC_EXTERN PetscErrorCode PetscViewerVTKOpen(MPI_Comm,const char[],PetscFileMode,PetscViewer*);
207 
208 /*
209      These are all the default viewers that do not have to be explicitly opened
210 */
211 PETSC_EXTERN PetscViewer    PETSC_VIEWER_STDOUT_(MPI_Comm);
212 PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetStdout(MPI_Comm,PetscViewer*);
213 PETSC_EXTERN PetscViewer    PETSC_VIEWER_STDERR_(MPI_Comm);
214 PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetStderr(MPI_Comm,PetscViewer*);
215 PETSC_EXTERN PetscViewer    PETSC_VIEWER_DRAW_(MPI_Comm);
216 PETSC_EXTERN PetscViewer    PETSC_VIEWER_SOCKET_(MPI_Comm);
217 PETSC_EXTERN PetscViewer    PETSC_VIEWER_BINARY_(MPI_Comm);
218 PETSC_EXTERN PetscViewer    PETSC_VIEWER_MATLAB_(MPI_Comm);
219 PETSC_EXTERN PetscViewer    PETSC_VIEWER_HDF5_(MPI_Comm);
220 PETSC_EXTERN PetscViewer   PETSC_VIEWER_MATHEMATICA_WORLD_PRIVATE;
221 
222 #define PETSC_VIEWER_STDERR_SELF  PETSC_VIEWER_STDERR_(PETSC_COMM_SELF)
223 #define PETSC_VIEWER_STDERR_WORLD PETSC_VIEWER_STDERR_(PETSC_COMM_WORLD)
224 
225 /*MC
226   PETSC_VIEWER_STDOUT_WORLD  - same as PETSC_VIEWER_STDOUT_(PETSC_COMM_WORLD)
227 
228   Level: beginner
229 M*/
230 #define PETSC_VIEWER_STDOUT_WORLD PETSC_VIEWER_STDOUT_(PETSC_COMM_WORLD)
231 
232 /*MC
233   PETSC_VIEWER_STDOUT_SELF  - same as PETSC_VIEWER_STDOUT_(PETSC_COMM_SELF)
234 
235   Level: beginner
236 M*/
237 #define PETSC_VIEWER_STDOUT_SELF  PETSC_VIEWER_STDOUT_(PETSC_COMM_SELF)
238 
239 /*MC
240   PETSC_VIEWER_DRAW_WORLD  - same as PETSC_VIEWER_DRAW_(PETSC_COMM_WORLD)
241 
242   Level: intermediate
243 M*/
244 #define PETSC_VIEWER_DRAW_WORLD   PETSC_VIEWER_DRAW_(PETSC_COMM_WORLD)
245 
246 /*MC
247   PETSC_VIEWER_DRAW_SELF  - same as PETSC_VIEWER_DRAW_(PETSC_COMM_SELF)
248 
249   Level: intermediate
250 M*/
251 #define PETSC_VIEWER_DRAW_SELF    PETSC_VIEWER_DRAW_(PETSC_COMM_SELF)
252 
253 /*MC
254   PETSC_VIEWER_SOCKET_WORLD  - same as PETSC_VIEWER_SOCKET_(PETSC_COMM_WORLD)
255 
256   Level: intermediate
257 M*/
258 #define PETSC_VIEWER_SOCKET_WORLD PETSC_VIEWER_SOCKET_(PETSC_COMM_WORLD)
259 
260 /*MC
261   PETSC_VIEWER_SOCKET_SELF  - same as PETSC_VIEWER_SOCKET_(PETSC_COMM_SELF)
262 
263   Level: intermediate
264 M*/
265 #define PETSC_VIEWER_SOCKET_SELF  PETSC_VIEWER_SOCKET_(PETSC_COMM_SELF)
266 
267 /*MC
268   PETSC_VIEWER_BINARY_WORLD  - same as PETSC_VIEWER_BINARY_(PETSC_COMM_WORLD)
269 
270   Level: intermediate
271 M*/
272 #define PETSC_VIEWER_BINARY_WORLD PETSC_VIEWER_BINARY_(PETSC_COMM_WORLD)
273 
274 /*MC
275   PETSC_VIEWER_BINARY_SELF  - same as PETSC_VIEWER_BINARY_(PETSC_COMM_SELF)
276 
277   Level: intermediate
278 M*/
279 #define PETSC_VIEWER_BINARY_SELF  PETSC_VIEWER_BINARY_(PETSC_COMM_SELF)
280 
281 /*MC
282   PETSC_VIEWER_MATLAB_WORLD  - same as PETSC_VIEWER_MATLAB_(PETSC_COMM_WORLD)
283 
284   Level: intermediate
285 M*/
286 #define PETSC_VIEWER_MATLAB_WORLD PETSC_VIEWER_MATLAB_(PETSC_COMM_WORLD)
287 
288 /*MC
289   PETSC_VIEWER_MATLAB_SELF  - same as PETSC_VIEWER_MATLAB_(PETSC_COMM_SELF)
290 
291   Level: intermediate
292 M*/
293 #define PETSC_VIEWER_MATLAB_SELF  PETSC_VIEWER_MATLAB_(PETSC_COMM_SELF)
294 
295 #define PETSC_VIEWER_MATHEMATICA_WORLD (PetscViewerInitializeMathematicaWorld_Private(),PETSC_VIEWER_MATHEMATICA_WORLD_PRIVATE)
296 
297 #undef __FUNCT__
298 #define __FUNCT__ "PetscViewerFlowControlStart"
299 PETSC_STATIC_INLINE PetscErrorCode PetscViewerFlowControlStart(PetscViewer viewer,PetscInt *mcnt,PetscInt *cnt)
300 {
301   PetscErrorCode ierr;
302   PetscFunctionBegin;
303   ierr = PetscViewerBinaryGetFlowControl(viewer,mcnt);CHKERRQ(ierr);
304   ierr = PetscViewerBinaryGetFlowControl(viewer,cnt);CHKERRQ(ierr);
305   PetscFunctionReturn(0);
306 }
307 
308 #undef __FUNCT__
309 #define __FUNCT__ "PetscViewerFlowControlStepMaster"
310 PETSC_STATIC_INLINE PetscErrorCode PetscViewerFlowControlStepMaster(PetscViewer viewer,PetscInt i,PetscInt *mcnt,PetscInt cnt)
311 {
312   PetscErrorCode ierr;
313   MPI_Comm       comm;
314 
315   PetscFunctionBegin;
316   ierr = PetscObjectGetComm((PetscObject)viewer,&comm);CHKERRQ(ierr);
317   if (i >= *mcnt) {
318     *mcnt += cnt;
319     ierr = MPI_Bcast(mcnt,1,MPIU_INT,0,comm);CHKERRQ(ierr);
320   }
321   PetscFunctionReturn(0);
322 }
323 
324 #undef __FUNCT__
325 #define __FUNCT__ "PetscViewerFlowControlEndMaster"
326 PETSC_STATIC_INLINE PetscErrorCode PetscViewerFlowControlEndMaster(PetscViewer viewer,PetscInt *mcnt)
327 {
328   PetscErrorCode ierr;
329   MPI_Comm       comm;
330   PetscFunctionBegin;
331   ierr = PetscObjectGetComm((PetscObject)viewer,&comm);CHKERRQ(ierr);
332   *mcnt = 0;
333   ierr = MPI_Bcast(mcnt,1,MPIU_INT,0,comm);CHKERRQ(ierr);
334   PetscFunctionReturn(0);
335 }
336 
337 #undef __FUNCT__
338 #define __FUNCT__ "PetscViewerFlowControlStepWorker"
339 PETSC_STATIC_INLINE PetscErrorCode PetscViewerFlowControlStepWorker(PetscViewer viewer,PetscMPIInt rank,PetscInt *mcnt)
340 {
341   PetscErrorCode ierr;
342   MPI_Comm       comm;
343   PetscFunctionBegin;
344   ierr = PetscObjectGetComm((PetscObject)viewer,&comm);CHKERRQ(ierr);
345   while (PETSC_TRUE) {
346     if (rank < *mcnt) break;
347     ierr = MPI_Bcast(mcnt,1,MPIU_INT,0,comm);CHKERRQ(ierr);
348   }
349   PetscFunctionReturn(0);
350 }
351 
352 #undef __FUNCT__
353 #define __FUNCT__ "PetscViewerFlowControlEndWorker"
354 PETSC_STATIC_INLINE PetscErrorCode PetscViewerFlowControlEndWorker(PetscViewer viewer,PetscInt *mcnt)
355 {
356   PetscErrorCode ierr;
357   MPI_Comm       comm;
358   PetscFunctionBegin;
359   ierr = PetscObjectGetComm((PetscObject)viewer,&comm);CHKERRQ(ierr);
360   while (PETSC_TRUE) {
361     ierr = MPI_Bcast(mcnt,1,MPIU_INT,0,comm);CHKERRQ(ierr);
362     if (!*mcnt) break;
363   }
364   PetscFunctionReturn(0);
365 }
366 
367 /*
368    PetscViewer writes to MATLAB .mat file
369 */
370 PETSC_EXTERN PetscErrorCode PetscViewerMatlabPutArray(PetscViewer,int,int,const PetscScalar*,const char*);
371 PETSC_EXTERN PetscErrorCode PetscViewerMatlabGetArray(PetscViewer,int,int,PetscScalar*,const char*);
372 PETSC_EXTERN PetscErrorCode PetscViewerMatlabPutVariable(PetscViewer,const char*,void*);
373 
374 #if defined(PETSC_HAVE_SAWS)
375 PETSC_EXTERN PetscErrorCode PetscObjectViewSAWs(PetscObject,PetscViewer);
376 #endif
377 
378 /*S
379      PetscViewers - Abstract collection of PetscViewers. It is just an expandable array of viewers.
380 
381    Level: intermediate
382 
383   Concepts: viewing
384 
385 .seealso:  PetscViewerCreate(), PetscViewerSetType(), PetscViewerType, PetscViewer, PetscViewersCreate(),
386            PetscViewersGetViewer()
387 S*/
388 typedef struct _n_PetscViewers* PetscViewers;
389 PETSC_EXTERN PetscErrorCode PetscViewersCreate(MPI_Comm,PetscViewers*);
390 PETSC_EXTERN PetscErrorCode PetscViewersDestroy(PetscViewers*);
391 PETSC_EXTERN PetscErrorCode PetscViewersGetViewer(PetscViewers,PetscInt,PetscViewer*);
392 
393 /* Reset __FUNCT__ in case the user does not define it themselves */
394 #undef __FUNCT__
395 #define __FUNCT__ "User provided function"
396 
397 #endif
398