xref: /petsc/include/petscviewer.h (revision 5c8f6a953e7ed1c81f507d64aebddb11080b60e9)
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 #if defined(PETSC_USE_EXTERN_CXX) && defined(__cplusplus)
9 extern "C" {
10 #endif
11 
12 /*S
13      PetscViewer - Abstract PETSc object that helps view (in ASCII, binary, graphically etc)
14          other PETSc objects
15 
16    Level: beginner
17 
18   Concepts: viewing
19 
20 .seealso:  PetscViewerCreate(), PetscViewerSetType(), PetscViewerType
21 S*/
22 typedef struct _p_PetscViewer* PetscViewer;
23 
24 #if defined(PETSC_USE_EXTERN_CXX) && defined(__cplusplus)
25 }
26 #endif
27 
28 #include <petscsys.h>
29 
30 PETSC_EXTERN PetscClassId PETSC_VIEWER_CLASSID;
31 
32 /*J
33     PetscViewerType - String with the name of a PETSc PETScViewer
34 
35    Level: beginner
36 
37 .seealso: PetscViewerSetType(), PetscViewer
38 J*/
39 typedef const char* PetscViewerType;
40 #define PETSCVIEWERSOCKET       "socket"
41 #define PETSCVIEWERASCII        "ascii"
42 #define PETSCVIEWERBINARY       "binary"
43 #define PETSCVIEWERSTRING       "string"
44 #define PETSCVIEWERDRAW         "draw"
45 #define PETSCVIEWERVU           "vu"
46 #define PETSCVIEWERMATHEMATICA  "mathematica"
47 #define PETSCVIEWERNETCDF       "netcdf"
48 #define PETSCVIEWERHDF5         "hdf5"
49 #define PETSCVIEWERVTK          "vtk"
50 #define PETSCVIEWERMATLAB       "matlab"
51 #define PETSCVIEWERAMS          "ams"
52 
53 PETSC_EXTERN PetscFunctionList PetscViewerList;
54 PETSC_EXTERN PetscErrorCode PetscViewerRegisterAll(const char *);
55 PETSC_EXTERN PetscErrorCode PetscViewerRegisterDestroy(void);
56 PETSC_EXTERN PetscErrorCode PetscViewerInitializePackage(const char[]);
57 
58 PETSC_EXTERN PetscErrorCode PetscViewerRegister(const char*,const char*,const char*,PetscErrorCode (*)(PetscViewer));
59 
60 /*MC
61    PetscViewerRegisterDynamic - Adds a viewer
62 
63    Synopsis
64    #include "petscviewer.h"
65    PetscErrorCode PetscViewerRegisterDynamic(const char *name_solver,const char *path,const char *name_create,PetscErrorCode (*routine_create)(PetscViewer))
66 
67    Not Collective
68 
69    Input Parameters:
70 +  name_solver - name of a new user-defined viewer
71 .  path - path (either absolute or relative) the library containing this viewer
72 .  name_create - name of routine to create method context
73 -  routine_create - routine to create method context
74 
75    Level: developer
76 
77    Notes:
78    PetscViewerRegisterDynamic() may be called multiple times to add several user-defined viewers.
79 
80    If dynamic libraries are used, then the fourth input argument (routine_create)
81    is ignored.
82 
83    Sample usage:
84 .vb
85    PetscViewerRegisterDynamic("my_viewer_type",/home/username/my_lib/lib/libO/solaris/mylib.a,
86                "MyViewerCreate",MyViewerCreate);
87 .ve
88 
89    Then, your solver can be chosen with the procedural interface via
90 $     PetscViewerSetType(viewer,"my_viewer_type")
91    or at runtime via the option
92 $     -viewer_type my_viewer_type
93 
94   Concepts: registering^Viewers
95 
96 .seealso: PetscViewerRegisterAll(), PetscViewerRegisterDestroy()
97 M*/
98 #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
99 #define PetscViewerRegisterDynamic(a,b,c,d) PetscViewerRegister(a,b,c,0)
100 #else
101 #define PetscViewerRegisterDynamic(a,b,c,d) PetscViewerRegister(a,b,c,d)
102 #endif
103 
104 PETSC_EXTERN PetscErrorCode PetscViewerCreate(MPI_Comm,PetscViewer*);
105 PETSC_EXTERN PetscErrorCode PetscViewerSetFromOptions(PetscViewer);
106 PETSC_EXTERN PetscErrorCode PetscViewerASCIIOpenWithFILE(MPI_Comm,FILE*,PetscViewer*);
107 
108 PETSC_EXTERN PetscErrorCode PetscViewerASCIIOpen(MPI_Comm,const char[],PetscViewer*);
109 PETSC_EXTERN PetscErrorCode PetscViewerASCIISetFILE(PetscViewer,FILE*);
110 PETSC_EXTERN PetscErrorCode PetscViewerBinaryOpen(MPI_Comm,const char[],PetscFileMode,PetscViewer*);
111 PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetFlowControl(PetscViewer,PetscInt*);
112 PETSC_EXTERN PetscErrorCode PetscViewerBinarySetFlowControl(PetscViewer,PetscInt);
113 PETSC_EXTERN PetscErrorCode PetscViewerBinarySetMPIIO(PetscViewer);
114 PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetMPIIO(PetscViewer,PetscBool *);
115 #if defined(PETSC_HAVE_MPIIO)
116 PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetMPIIODescriptor(PetscViewer,MPI_File*);
117 PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetMPIIOOffset(PetscViewer,MPI_Offset*);
118 PETSC_EXTERN PetscErrorCode PetscViewerBinaryAddMPIIOOffset(PetscViewer,MPI_Offset);
119 #endif
120 
121 PETSC_EXTERN PetscErrorCode PetscViewerSocketOpen(MPI_Comm,const char[],int,PetscViewer*);
122 PETSC_EXTERN PetscErrorCode PetscViewerStringOpen(MPI_Comm,char[],PetscInt,PetscViewer*);
123 PETSC_EXTERN PetscErrorCode PetscViewerDrawOpen(MPI_Comm,const char[],const char[],int,int,int,int,PetscViewer*);
124 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaOpen(MPI_Comm, int, const char[], const char[], PetscViewer *);
125 PETSC_EXTERN PetscErrorCode PetscViewerSiloOpen(MPI_Comm, const char[], PetscViewer *);
126 PETSC_EXTERN PetscErrorCode PetscViewerMatlabOpen(MPI_Comm,const char[],PetscFileMode,PetscViewer*);
127 
128 PETSC_EXTERN PetscErrorCode PetscViewerGetType(PetscViewer,PetscViewerType*);
129 PETSC_EXTERN PetscErrorCode PetscViewerSetType(PetscViewer,PetscViewerType);
130 PETSC_EXTERN PetscErrorCode PetscViewerDestroy(PetscViewer*);
131 PETSC_EXTERN PetscErrorCode PetscViewerGetSingleton(PetscViewer,PetscViewer*);
132 PETSC_EXTERN PetscErrorCode PetscViewerRestoreSingleton(PetscViewer,PetscViewer*);
133 PETSC_EXTERN PetscErrorCode PetscViewerGetSubcomm(PetscViewer,MPI_Comm,PetscViewer*);
134 PETSC_EXTERN PetscErrorCode PetscViewerRestoreSubcomm(PetscViewer,MPI_Comm,PetscViewer*);
135 
136 PETSC_EXTERN PetscErrorCode PetscViewerSetUp(PetscViewer);
137 PETSC_EXTERN PetscErrorCode PetscViewerView(PetscViewer,PetscViewer);
138 
139 PETSC_EXTERN PetscErrorCode PetscViewerSetOptionsPrefix(PetscViewer,const char[]);
140 PETSC_EXTERN PetscErrorCode PetscViewerAppendOptionsPrefix(PetscViewer,const char[]);
141 PETSC_EXTERN PetscErrorCode PetscViewerGetOptionsPrefix(PetscViewer,const char*[]);
142 
143 /*E
144     PetscViewerFormat - Way a viewer presents the object
145 
146    Level: beginner
147 
148    The values below are also listed in finclude/petscviewer.h. If another values is added below it
149    must also be added there.
150 
151 .seealso: PetscViewerSetFormat(), PetscViewer, PetscViewerType, PetscViewerPushFormat(), PetscViewerPopFormat()
152 E*/
153 typedef enum {
154   PETSC_VIEWER_DEFAULT,
155   PETSC_VIEWER_ASCII_MATLAB,
156   PETSC_VIEWER_ASCII_MATHEMATICA,
157   PETSC_VIEWER_ASCII_IMPL,
158   PETSC_VIEWER_ASCII_INFO,
159   PETSC_VIEWER_ASCII_INFO_DETAIL,
160   PETSC_VIEWER_ASCII_COMMON,
161   PETSC_VIEWER_ASCII_SYMMODU,
162   PETSC_VIEWER_ASCII_INDEX,
163   PETSC_VIEWER_ASCII_DENSE,
164   PETSC_VIEWER_ASCII_MATRIXMARKET,
165   PETSC_VIEWER_ASCII_VTK,
166   PETSC_VIEWER_ASCII_VTK_CELL,
167   PETSC_VIEWER_ASCII_VTK_COORDS,
168   PETSC_VIEWER_ASCII_PCICE,
169   PETSC_VIEWER_ASCII_PYTHON,
170   PETSC_VIEWER_ASCII_FACTOR_INFO,
171   PETSC_VIEWER_ASCII_LATEX,
172   PETSC_VIEWER_DRAW_BASIC,
173   PETSC_VIEWER_DRAW_LG,
174   PETSC_VIEWER_DRAW_CONTOUR,
175   PETSC_VIEWER_DRAW_PORTS,
176   PETSC_VIEWER_VTK_VTS,
177   PETSC_VIEWER_VTK_VTU,
178   PETSC_VIEWER_NATIVE,
179   PETSC_VIEWER_NOFORMAT
180   } PetscViewerFormat;
181 PETSC_EXTERN const char *const PetscViewerFormats[];
182 
183 PETSC_EXTERN PetscErrorCode PetscViewerSetFormat(PetscViewer,PetscViewerFormat);
184 PETSC_EXTERN PetscErrorCode PetscViewerPushFormat(PetscViewer,PetscViewerFormat);
185 PETSC_EXTERN PetscErrorCode PetscViewerPopFormat(PetscViewer);
186 PETSC_EXTERN PetscErrorCode PetscViewerGetFormat(PetscViewer,PetscViewerFormat*);
187 PETSC_EXTERN PetscErrorCode PetscViewerFlush(PetscViewer);
188 
189 PETSC_EXTERN PetscErrorCode PetscOptionsGetViewer(MPI_Comm,const char[],const char[],PetscViewer*,PetscViewerFormat*,PetscBool*);
190 PETSC_EXTERN PetscErrorCode PetscOptionsViewer(const char[],const char[],const char[],PetscViewer*,PetscViewerFormat *,PetscBool *);
191 
192 /*
193    Operations explicit to a particular class of viewers
194 */
195 
196 PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetPointer(PetscViewer,FILE**);
197 PETSC_EXTERN PetscErrorCode PetscViewerFileGetMode(PetscViewer,PetscFileMode*);
198 PETSC_EXTERN PetscErrorCode PetscViewerFileSetMode(PetscViewer,PetscFileMode);
199 PETSC_EXTERN PetscErrorCode PetscViewerASCIIPrintf(PetscViewer,const char[],...);
200 PETSC_EXTERN PetscErrorCode PetscViewerASCIISynchronizedPrintf(PetscViewer,const char[],...);
201 PETSC_EXTERN PetscErrorCode PetscViewerASCIISynchronizedAllow(PetscViewer,PetscBool);
202 PETSC_EXTERN PetscErrorCode PetscViewerASCIIPushTab(PetscViewer);
203 PETSC_EXTERN PetscErrorCode PetscViewerASCIIPopTab(PetscViewer);
204 PETSC_EXTERN PetscErrorCode PetscViewerASCIIUseTabs(PetscViewer,PetscBool );
205 PETSC_EXTERN PetscErrorCode PetscViewerASCIISetTab(PetscViewer,PetscInt);
206 PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetTab(PetscViewer,PetscInt*);
207 PETSC_EXTERN PetscErrorCode PetscViewerASCIIAddTab(PetscViewer,PetscInt);
208 PETSC_EXTERN PetscErrorCode PetscViewerASCIISubtractTab(PetscViewer,PetscInt);
209 PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetDescriptor(PetscViewer,int*);
210 PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetInfoPointer(PetscViewer,FILE **);
211 PETSC_EXTERN PetscErrorCode PetscViewerBinaryRead(PetscViewer,void*,PetscInt,PetscDataType);
212 PETSC_EXTERN PetscErrorCode PetscViewerBinaryWrite(PetscViewer,void*,PetscInt,PetscDataType,PetscBool );
213 PETSC_EXTERN PetscErrorCode PetscViewerStringSPrintf(PetscViewer,const char[],...);
214 PETSC_EXTERN PetscErrorCode PetscViewerStringSetString(PetscViewer,char[],PetscInt);
215 PETSC_EXTERN PetscErrorCode PetscViewerDrawClear(PetscViewer);
216 PETSC_EXTERN PetscErrorCode PetscViewerDrawSetHold(PetscViewer,PetscBool);
217 PETSC_EXTERN PetscErrorCode PetscViewerDrawGetHold(PetscViewer,PetscBool*);
218 PETSC_EXTERN PetscErrorCode PetscViewerDrawSetPause(PetscViewer,PetscReal);
219 PETSC_EXTERN PetscErrorCode PetscViewerDrawGetPause(PetscViewer,PetscReal*);
220 PETSC_EXTERN PetscErrorCode PetscViewerDrawSetInfo(PetscViewer,const char[],const char[],int,int,int,int);
221 PETSC_EXTERN PetscErrorCode PetscViewerDrawResize(PetscViewer,int,int);
222 PETSC_EXTERN PetscErrorCode PetscViewerDrawSetBounds(PetscViewer,PetscInt,const PetscReal*);
223 PETSC_EXTERN PetscErrorCode PetscViewerDrawGetBounds(PetscViewer,PetscInt*,const PetscReal**);
224 PETSC_EXTERN PetscErrorCode PetscViewerSocketSetConnection(PetscViewer,const char[],int);
225 PETSC_EXTERN PetscErrorCode PetscViewerBinarySkipInfo(PetscViewer);
226 PETSC_EXTERN PetscErrorCode PetscViewerBinarySetSkipOptions(PetscViewer,PetscBool );
227 PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetSkipOptions(PetscViewer,PetscBool *);
228 PETSC_EXTERN PetscErrorCode PetscViewerBinarySetSkipHeader(PetscViewer,PetscBool);
229 PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetSkipHeader(PetscViewer,PetscBool*);
230 PETSC_EXTERN PetscErrorCode PetscViewerBinaryReadStringArray(PetscViewer,char***);
231 PETSC_EXTERN PetscErrorCode PetscViewerBinaryWriteStringArray(PetscViewer,char**);
232 
233 PETSC_EXTERN PetscErrorCode PetscViewerFileSetName(PetscViewer,const char[]);
234 PETSC_EXTERN PetscErrorCode PetscViewerFileGetName(PetscViewer,const char**);
235 
236 PETSC_EXTERN PetscErrorCode PetscViewerVUGetPointer(PetscViewer, FILE**);
237 PETSC_EXTERN PetscErrorCode PetscViewerVUSetVecSeen(PetscViewer, PetscBool );
238 PETSC_EXTERN PetscErrorCode PetscViewerVUGetVecSeen(PetscViewer, PetscBool  *);
239 PETSC_EXTERN PetscErrorCode PetscViewerVUPrintDeferred(PetscViewer, const char [], ...);
240 PETSC_EXTERN PetscErrorCode PetscViewerVUFlushDeferred(PetscViewer);
241 
242 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaInitializePackage(const char[]);
243 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaFinalizePackage(void);
244 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaGetName(PetscViewer, const char **);
245 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaSetName(PetscViewer, const char []);
246 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaClearName(PetscViewer);
247 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaSkipPackets(PetscViewer, int);
248 
249 PETSC_EXTERN PetscErrorCode PetscViewerSiloGetName(PetscViewer, char **);
250 PETSC_EXTERN PetscErrorCode PetscViewerSiloSetName(PetscViewer, const char []);
251 PETSC_EXTERN PetscErrorCode PetscViewerSiloClearName(PetscViewer);
252 PETSC_EXTERN PetscErrorCode PetscViewerSiloGetMeshName(PetscViewer, char **);
253 PETSC_EXTERN PetscErrorCode PetscViewerSiloSetMeshName(PetscViewer, const char []);
254 PETSC_EXTERN PetscErrorCode PetscViewerSiloClearMeshName(PetscViewer);
255 
256 PETSC_EXTERN PetscErrorCode PetscViewerNetcdfOpen(MPI_Comm,const char[],PetscFileMode,PetscViewer*);
257 PETSC_EXTERN PetscErrorCode PetscViewerNetcdfGetID(PetscViewer, int *);
258 
259 PETSC_EXTERN PetscErrorCode PetscViewerHDF5WriteSDS(PetscViewer,float *,int,int *,int);
260 
261 PETSC_EXTERN PetscErrorCode PetscViewerHDF5Open(MPI_Comm,const char[],PetscFileMode,PetscViewer*);
262 PETSC_EXTERN PetscErrorCode PetscViewerHDF5PushGroup(PetscViewer,const char *);
263 PETSC_EXTERN PetscErrorCode PetscViewerHDF5PopGroup(PetscViewer);
264 PETSC_EXTERN PetscErrorCode PetscViewerHDF5GetGroup(PetscViewer, const char **);
265 PETSC_EXTERN PetscErrorCode PetscViewerHDF5IncrementTimestep(PetscViewer);
266 PETSC_EXTERN PetscErrorCode PetscViewerHDF5SetTimestep(PetscViewer,PetscInt);
267 PETSC_EXTERN PetscErrorCode PetscViewerHDF5GetTimestep(PetscViewer,PetscInt*);
268 #ifdef PETSC_HAVE_HDF5
269 #include <hdf5.h>
270 PETSC_EXTERN PetscErrorCode PetscViewerHDF5GetFileId(PetscViewer,hid_t*);
271 PETSC_EXTERN PetscErrorCode PetscViewerHDF5OpenGroup(PetscViewer, hid_t *, hid_t *);
272 #endif
273 
274 typedef enum {PETSC_VTK_POINT_FIELD, PETSC_VTK_POINT_VECTOR_FIELD, PETSC_VTK_CELL_FIELD, PETSC_VTK_CELL_VECTOR_FIELD} PetscViewerVTKFieldType;
275 PETSC_EXTERN PetscErrorCode PetscViewerVTKAddField(PetscViewer,PetscObject,PetscErrorCode (*PetscViewerVTKWriteFunction)(PetscObject,PetscViewer),PetscViewerVTKFieldType,PetscObject);
276 PETSC_EXTERN PetscErrorCode PetscViewerVTKOpen(MPI_Comm,const char[],PetscFileMode,PetscViewer*);
277 
278 /*
279      These are all the default viewers that do not have
280    to be explicitly opened
281 */
282 PETSC_EXTERN PetscViewer    PETSC_VIEWER_STDOUT_(MPI_Comm);
283 PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetStdout(MPI_Comm,PetscViewer*);
284 PETSC_EXTERN PetscViewer    PETSC_VIEWER_STDERR_(MPI_Comm);
285 PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetStderr(MPI_Comm,PetscViewer*);
286 PETSC_EXTERN PetscViewer    PETSC_VIEWER_DRAW_(MPI_Comm);
287 PETSC_EXTERN PetscViewer    PETSC_VIEWER_SOCKET_(MPI_Comm);
288 PETSC_EXTERN PetscViewer    PETSC_VIEWER_BINARY_(MPI_Comm);
289 PETSC_EXTERN PetscViewer    PETSC_VIEWER_MATLAB_(MPI_Comm);
290 PETSC_EXTERN PetscViewer   PETSC_VIEWER_MATHEMATICA_WORLD_PRIVATE;
291 
292 #define PETSC_VIEWER_STDERR_SELF  PETSC_VIEWER_STDERR_(PETSC_COMM_SELF)
293 #define PETSC_VIEWER_STDERR_WORLD PETSC_VIEWER_STDERR_(PETSC_COMM_WORLD)
294 
295 /*MC
296   PETSC_VIEWER_STDOUT_WORLD  - same as PETSC_VIEWER_STDOUT_(PETSC_COMM_WORLD)
297 
298   Level: beginner
299 M*/
300 #define PETSC_VIEWER_STDOUT_WORLD PETSC_VIEWER_STDOUT_(PETSC_COMM_WORLD)
301 
302 /*MC
303   PETSC_VIEWER_STDOUT_SELF  - same as PETSC_VIEWER_STDOUT_(PETSC_COMM_SELF)
304 
305   Level: beginner
306 M*/
307 #define PETSC_VIEWER_STDOUT_SELF  PETSC_VIEWER_STDOUT_(PETSC_COMM_SELF)
308 
309 /*MC
310   PETSC_VIEWER_DRAW_WORLD  - same as PETSC_VIEWER_DRAW_(PETSC_COMM_WORLD)
311 
312   Level: intermediate
313 M*/
314 #define PETSC_VIEWER_DRAW_WORLD   PETSC_VIEWER_DRAW_(PETSC_COMM_WORLD)
315 
316 /*MC
317   PETSC_VIEWER_DRAW_SELF  - same as PETSC_VIEWER_DRAW_(PETSC_COMM_SELF)
318 
319   Level: intermediate
320 M*/
321 #define PETSC_VIEWER_DRAW_SELF    PETSC_VIEWER_DRAW_(PETSC_COMM_SELF)
322 
323 /*MC
324   PETSC_VIEWER_SOCKET_WORLD  - same as PETSC_VIEWER_SOCKET_(PETSC_COMM_WORLD)
325 
326   Level: intermediate
327 M*/
328 #define PETSC_VIEWER_SOCKET_WORLD PETSC_VIEWER_SOCKET_(PETSC_COMM_WORLD)
329 
330 /*MC
331   PETSC_VIEWER_SOCKET_SELF  - same as PETSC_VIEWER_SOCKET_(PETSC_COMM_SELF)
332 
333   Level: intermediate
334 M*/
335 #define PETSC_VIEWER_SOCKET_SELF  PETSC_VIEWER_SOCKET_(PETSC_COMM_SELF)
336 
337 /*MC
338   PETSC_VIEWER_BINARY_WORLD  - same as PETSC_VIEWER_BINARY_(PETSC_COMM_WORLD)
339 
340   Level: intermediate
341 M*/
342 #define PETSC_VIEWER_BINARY_WORLD PETSC_VIEWER_BINARY_(PETSC_COMM_WORLD)
343 
344 /*MC
345   PETSC_VIEWER_BINARY_SELF  - same as PETSC_VIEWER_BINARY_(PETSC_COMM_SELF)
346 
347   Level: intermediate
348 M*/
349 #define PETSC_VIEWER_BINARY_SELF  PETSC_VIEWER_BINARY_(PETSC_COMM_SELF)
350 
351 /*MC
352   PETSC_VIEWER_MATLAB_WORLD  - same as PETSC_VIEWER_MATLAB_(PETSC_COMM_WORLD)
353 
354   Level: intermediate
355 M*/
356 #define PETSC_VIEWER_MATLAB_WORLD PETSC_VIEWER_MATLAB_(PETSC_COMM_WORLD)
357 
358 /*MC
359   PETSC_VIEWER_MATLAB_SELF  - same as PETSC_VIEWER_MATLAB_(PETSC_COMM_SELF)
360 
361   Level: intermediate
362 M*/
363 #define PETSC_VIEWER_MATLAB_SELF  PETSC_VIEWER_MATLAB_(PETSC_COMM_SELF)
364 
365 #define PETSC_VIEWER_MATHEMATICA_WORLD (PetscViewerInitializeMathematicaWorld_Private(),PETSC_VIEWER_MATHEMATICA_WORLD_PRIVATE)
366 
367 #undef __FUNCT__
368 #define __FUNCT__ "PetscViewerFlowControlStart"
369 PETSC_STATIC_INLINE PetscErrorCode PetscViewerFlowControlStart(PetscViewer viewer,PetscInt *mcnt,PetscInt *cnt)
370 {
371   PetscErrorCode ierr;
372   PetscFunctionBegin;
373   ierr = PetscViewerBinaryGetFlowControl(viewer,mcnt);CHKERRQ(ierr);
374   ierr = PetscViewerBinaryGetFlowControl(viewer,cnt);CHKERRQ(ierr);
375   PetscFunctionReturn(0);
376 }
377 
378 #undef __FUNCT__
379 #define __FUNCT__ "PetscViewerFlowControlStepMaster"
380 PETSC_STATIC_INLINE PetscErrorCode PetscViewerFlowControlStepMaster(PetscViewer viewer,PetscInt i,PetscInt *mcnt,PetscInt cnt)
381 {
382   PetscErrorCode ierr;
383   MPI_Comm       comm;
384 
385   PetscFunctionBegin;
386   ierr = PetscObjectGetComm((PetscObject)viewer,&comm);CHKERRQ(ierr);
387   if (i >= *mcnt) {
388     *mcnt += cnt;
389     ierr = MPI_Bcast(mcnt,1,MPIU_INT,0,comm);CHKERRQ(ierr);
390   }
391   PetscFunctionReturn(0);
392 }
393 
394 #undef __FUNCT__
395 #define __FUNCT__ "PetscViewerFlowControlEndMaster"
396 PETSC_STATIC_INLINE PetscErrorCode PetscViewerFlowControlEndMaster(PetscViewer viewer,PetscInt *mcnt)
397 {
398   PetscErrorCode ierr;
399   MPI_Comm       comm;
400   PetscFunctionBegin;
401   ierr = PetscObjectGetComm((PetscObject)viewer,&comm);CHKERRQ(ierr);
402   *mcnt = 0;
403   ierr = MPI_Bcast(mcnt,1,MPIU_INT,0,comm);CHKERRQ(ierr);
404   PetscFunctionReturn(0);
405 }
406 
407 #undef __FUNCT__
408 #define __FUNCT__ "PetscViewerFlowControlStepWorker"
409 PETSC_STATIC_INLINE PetscErrorCode PetscViewerFlowControlStepWorker(PetscViewer viewer,PetscMPIInt rank,PetscInt *mcnt)
410 {
411   PetscErrorCode ierr;
412   MPI_Comm       comm;
413   PetscFunctionBegin;
414   ierr = PetscObjectGetComm((PetscObject)viewer,&comm);CHKERRQ(ierr);
415   while (PETSC_TRUE) {
416     if (rank < *mcnt) break;
417     ierr = MPI_Bcast(mcnt,1,MPIU_INT,0,comm);CHKERRQ(ierr);
418   }
419   PetscFunctionReturn(0);
420 }
421 
422 #undef __FUNCT__
423 #define __FUNCT__ "PetscViewerFlowControlEndWorker"
424 PETSC_STATIC_INLINE PetscErrorCode PetscViewerFlowControlEndWorker(PetscViewer viewer,PetscInt *mcnt)
425 {
426   PetscErrorCode ierr;
427   MPI_Comm       comm;
428   PetscFunctionBegin;
429   ierr = PetscObjectGetComm((PetscObject)viewer,&comm);CHKERRQ(ierr);
430   while (PETSC_TRUE) {
431     ierr = MPI_Bcast(mcnt,1,MPIU_INT,0,comm);CHKERRQ(ierr);
432     if (!*mcnt) break;
433   }
434   PetscFunctionReturn(0);
435 }
436 
437 /*
438    PetscViewer writes to MATLAB .mat file
439 */
440 PETSC_EXTERN PetscErrorCode PetscViewerMatlabPutArray(PetscViewer,int,int,const PetscScalar*,const char*);
441 PETSC_EXTERN PetscErrorCode PetscViewerMatlabGetArray(PetscViewer,int,int,PetscScalar*,const char*);
442 PETSC_EXTERN PetscErrorCode PetscViewerMatlabPutVariable(PetscViewer,const char*,void*);
443 
444 /*S
445      PetscViewers - Abstract collection of PetscViewers. It is just an expandable array of viewers.
446 
447    Level: intermediate
448 
449   Concepts: viewing
450 
451 .seealso:  PetscViewerCreate(), PetscViewerSetType(), PetscViewerType, PetscViewer, PetscViewersCreate(),
452            PetscViewersGetViewer()
453 S*/
454 typedef struct _n_PetscViewers* PetscViewers;
455 PETSC_EXTERN PetscErrorCode PetscViewersCreate(MPI_Comm,PetscViewers*);
456 PETSC_EXTERN PetscErrorCode PetscViewersDestroy(PetscViewers*);
457 PETSC_EXTERN PetscErrorCode PetscViewersGetViewer(PetscViewers,PetscInt,PetscViewer*);
458 
459 #if defined(PETSC_HAVE_AMS)
460 #include <ams.h>
461 PETSC_EXTERN PetscErrorCode PetscViewerAMSSetCommName(PetscViewer,const char[]);
462 PETSC_EXTERN PetscErrorCode PetscViewerAMSGetAMSComm(PetscViewer,AMS_Comm *);
463 PETSC_EXTERN PetscErrorCode PetscViewerAMSOpen(MPI_Comm,const char[],PetscViewer*);
464 PETSC_EXTERN PetscErrorCode PetscViewerAMSLock(PetscViewer);
465 PETSC_EXTERN PetscViewer    PETSC_VIEWER_AMS_(MPI_Comm);
466 PETSC_EXTERN PetscErrorCode PETSC_VIEWER_AMS_Destroy(MPI_Comm);
467 #define PETSC_VIEWER_AMS_WORLD PETSC_VIEWER_AMS_(PETSC_COMM_WORLD)
468 #endif
469 
470 #endif
471