xref: /petsc/include/petscviewer.h (revision 2205254efee3a00a594e5e2a3a70f74dcb40bc03)
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 #ifdef PETSC_HAVE_HDF5
260 #include <hdf5.h>
261 PETSC_EXTERN PetscErrorCode PetscViewerHDF5GetFileId(PetscViewer,hid_t*);
262 PETSC_EXTERN PetscErrorCode PetscViewerHDF5OpenGroup(PetscViewer, hid_t *, hid_t *);
263 
264 /* On 32 bit systems HDF5 is limited by size of integer, because hsize_t is defined as size_t */
265 #define PETSC_HDF5_INT_MAX  2147483647
266 #define PETSC_HDF5_INT_MIN -2147483647
267 
268 #undef __FUNCT__
269 #define __FUNCT__ "PetscHDF5IntCast"
270 PETSC_STATIC_INLINE PetscErrorCode PetscHDF5IntCast(PetscInt a,hsize_t *b)
271 {
272   PetscFunctionBegin;
273 #if defined(PETSC_USE_64BIT_INDICES) && (PETSC_SIZEOF_SIZE_T == 4)
274   if ((a) > PETSC_HDF5_INT_MAX) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Array too long for HDF5");
275 #endif
276   *b =  (hsize_t)(a);
277   PetscFunctionReturn(0);
278 }
279 #endif
280 
281 PETSC_EXTERN PetscErrorCode PetscViewerHDF5WriteSDS(PetscViewer,float *,int,int *,int);
282 
283 PETSC_EXTERN PetscErrorCode PetscViewerHDF5Open(MPI_Comm,const char[],PetscFileMode,PetscViewer*);
284 PETSC_EXTERN PetscErrorCode PetscViewerHDF5PushGroup(PetscViewer,const char *);
285 PETSC_EXTERN PetscErrorCode PetscViewerHDF5PopGroup(PetscViewer);
286 PETSC_EXTERN PetscErrorCode PetscViewerHDF5GetGroup(PetscViewer, const char **);
287 PETSC_EXTERN PetscErrorCode PetscViewerHDF5IncrementTimestep(PetscViewer);
288 PETSC_EXTERN PetscErrorCode PetscViewerHDF5SetTimestep(PetscViewer,PetscInt);
289 PETSC_EXTERN PetscErrorCode PetscViewerHDF5GetTimestep(PetscViewer,PetscInt*);
290 
291 typedef enum {PETSC_VTK_POINT_FIELD, PETSC_VTK_POINT_VECTOR_FIELD, PETSC_VTK_CELL_FIELD, PETSC_VTK_CELL_VECTOR_FIELD} PetscViewerVTKFieldType;
292 PETSC_EXTERN PetscErrorCode PetscViewerVTKAddField(PetscViewer,PetscObject,PetscErrorCode (*PetscViewerVTKWriteFunction)(PetscObject,PetscViewer),PetscViewerVTKFieldType,PetscObject);
293 PETSC_EXTERN PetscErrorCode PetscViewerVTKOpen(MPI_Comm,const char[],PetscFileMode,PetscViewer*);
294 
295 /*
296      These are all the default viewers that do not have
297    to be explicitly opened
298 */
299 PETSC_EXTERN PetscViewer    PETSC_VIEWER_STDOUT_(MPI_Comm);
300 PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetStdout(MPI_Comm,PetscViewer*);
301 PETSC_EXTERN PetscViewer    PETSC_VIEWER_STDERR_(MPI_Comm);
302 PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetStderr(MPI_Comm,PetscViewer*);
303 PETSC_EXTERN PetscViewer    PETSC_VIEWER_DRAW_(MPI_Comm);
304 PETSC_EXTERN PetscViewer    PETSC_VIEWER_SOCKET_(MPI_Comm);
305 PETSC_EXTERN PetscViewer    PETSC_VIEWER_BINARY_(MPI_Comm);
306 PETSC_EXTERN PetscViewer    PETSC_VIEWER_MATLAB_(MPI_Comm);
307 PETSC_EXTERN PetscViewer   PETSC_VIEWER_MATHEMATICA_WORLD_PRIVATE;
308 
309 #define PETSC_VIEWER_STDERR_SELF  PETSC_VIEWER_STDERR_(PETSC_COMM_SELF)
310 #define PETSC_VIEWER_STDERR_WORLD PETSC_VIEWER_STDERR_(PETSC_COMM_WORLD)
311 
312 /*MC
313   PETSC_VIEWER_STDOUT_WORLD  - same as PETSC_VIEWER_STDOUT_(PETSC_COMM_WORLD)
314 
315   Level: beginner
316 M*/
317 #define PETSC_VIEWER_STDOUT_WORLD PETSC_VIEWER_STDOUT_(PETSC_COMM_WORLD)
318 
319 /*MC
320   PETSC_VIEWER_STDOUT_SELF  - same as PETSC_VIEWER_STDOUT_(PETSC_COMM_SELF)
321 
322   Level: beginner
323 M*/
324 #define PETSC_VIEWER_STDOUT_SELF  PETSC_VIEWER_STDOUT_(PETSC_COMM_SELF)
325 
326 /*MC
327   PETSC_VIEWER_DRAW_WORLD  - same as PETSC_VIEWER_DRAW_(PETSC_COMM_WORLD)
328 
329   Level: intermediate
330 M*/
331 #define PETSC_VIEWER_DRAW_WORLD   PETSC_VIEWER_DRAW_(PETSC_COMM_WORLD)
332 
333 /*MC
334   PETSC_VIEWER_DRAW_SELF  - same as PETSC_VIEWER_DRAW_(PETSC_COMM_SELF)
335 
336   Level: intermediate
337 M*/
338 #define PETSC_VIEWER_DRAW_SELF    PETSC_VIEWER_DRAW_(PETSC_COMM_SELF)
339 
340 /*MC
341   PETSC_VIEWER_SOCKET_WORLD  - same as PETSC_VIEWER_SOCKET_(PETSC_COMM_WORLD)
342 
343   Level: intermediate
344 M*/
345 #define PETSC_VIEWER_SOCKET_WORLD PETSC_VIEWER_SOCKET_(PETSC_COMM_WORLD)
346 
347 /*MC
348   PETSC_VIEWER_SOCKET_SELF  - same as PETSC_VIEWER_SOCKET_(PETSC_COMM_SELF)
349 
350   Level: intermediate
351 M*/
352 #define PETSC_VIEWER_SOCKET_SELF  PETSC_VIEWER_SOCKET_(PETSC_COMM_SELF)
353 
354 /*MC
355   PETSC_VIEWER_BINARY_WORLD  - same as PETSC_VIEWER_BINARY_(PETSC_COMM_WORLD)
356 
357   Level: intermediate
358 M*/
359 #define PETSC_VIEWER_BINARY_WORLD PETSC_VIEWER_BINARY_(PETSC_COMM_WORLD)
360 
361 /*MC
362   PETSC_VIEWER_BINARY_SELF  - same as PETSC_VIEWER_BINARY_(PETSC_COMM_SELF)
363 
364   Level: intermediate
365 M*/
366 #define PETSC_VIEWER_BINARY_SELF  PETSC_VIEWER_BINARY_(PETSC_COMM_SELF)
367 
368 /*MC
369   PETSC_VIEWER_MATLAB_WORLD  - same as PETSC_VIEWER_MATLAB_(PETSC_COMM_WORLD)
370 
371   Level: intermediate
372 M*/
373 #define PETSC_VIEWER_MATLAB_WORLD PETSC_VIEWER_MATLAB_(PETSC_COMM_WORLD)
374 
375 /*MC
376   PETSC_VIEWER_MATLAB_SELF  - same as PETSC_VIEWER_MATLAB_(PETSC_COMM_SELF)
377 
378   Level: intermediate
379 M*/
380 #define PETSC_VIEWER_MATLAB_SELF  PETSC_VIEWER_MATLAB_(PETSC_COMM_SELF)
381 
382 #define PETSC_VIEWER_MATHEMATICA_WORLD (PetscViewerInitializeMathematicaWorld_Private(),PETSC_VIEWER_MATHEMATICA_WORLD_PRIVATE)
383 
384 #undef __FUNCT__
385 #define __FUNCT__ "PetscViewerFlowControlStart"
386 PETSC_STATIC_INLINE PetscErrorCode PetscViewerFlowControlStart(PetscViewer viewer,PetscInt *mcnt,PetscInt *cnt)
387 {
388   PetscErrorCode ierr;
389   PetscFunctionBegin;
390   ierr = PetscViewerBinaryGetFlowControl(viewer,mcnt);CHKERRQ(ierr);
391   ierr = PetscViewerBinaryGetFlowControl(viewer,cnt);CHKERRQ(ierr);
392   PetscFunctionReturn(0);
393 }
394 
395 #undef __FUNCT__
396 #define __FUNCT__ "PetscViewerFlowControlStepMaster"
397 PETSC_STATIC_INLINE PetscErrorCode PetscViewerFlowControlStepMaster(PetscViewer viewer,PetscInt i,PetscInt *mcnt,PetscInt cnt)
398 {
399   PetscErrorCode ierr;
400   MPI_Comm       comm;
401 
402   PetscFunctionBegin;
403   ierr = PetscObjectGetComm((PetscObject)viewer,&comm);CHKERRQ(ierr);
404   if (i >= *mcnt) {
405     *mcnt += cnt;
406     ierr = MPI_Bcast(mcnt,1,MPIU_INT,0,comm);CHKERRQ(ierr);
407   }
408   PetscFunctionReturn(0);
409 }
410 
411 #undef __FUNCT__
412 #define __FUNCT__ "PetscViewerFlowControlEndMaster"
413 PETSC_STATIC_INLINE PetscErrorCode PetscViewerFlowControlEndMaster(PetscViewer viewer,PetscInt *mcnt)
414 {
415   PetscErrorCode ierr;
416   MPI_Comm       comm;
417   PetscFunctionBegin;
418   ierr = PetscObjectGetComm((PetscObject)viewer,&comm);CHKERRQ(ierr);
419   *mcnt = 0;
420   ierr = MPI_Bcast(mcnt,1,MPIU_INT,0,comm);CHKERRQ(ierr);
421   PetscFunctionReturn(0);
422 }
423 
424 #undef __FUNCT__
425 #define __FUNCT__ "PetscViewerFlowControlStepWorker"
426 PETSC_STATIC_INLINE PetscErrorCode PetscViewerFlowControlStepWorker(PetscViewer viewer,PetscMPIInt rank,PetscInt *mcnt)
427 {
428   PetscErrorCode ierr;
429   MPI_Comm       comm;
430   PetscFunctionBegin;
431   ierr = PetscObjectGetComm((PetscObject)viewer,&comm);CHKERRQ(ierr);
432   while (PETSC_TRUE) {
433     if (rank < *mcnt) break;
434     ierr = MPI_Bcast(mcnt,1,MPIU_INT,0,comm);CHKERRQ(ierr);
435   }
436   PetscFunctionReturn(0);
437 }
438 
439 #undef __FUNCT__
440 #define __FUNCT__ "PetscViewerFlowControlEndWorker"
441 PETSC_STATIC_INLINE PetscErrorCode PetscViewerFlowControlEndWorker(PetscViewer viewer,PetscInt *mcnt)
442 {
443   PetscErrorCode ierr;
444   MPI_Comm       comm;
445   PetscFunctionBegin;
446   ierr = PetscObjectGetComm((PetscObject)viewer,&comm);CHKERRQ(ierr);
447   while (PETSC_TRUE) {
448     ierr = MPI_Bcast(mcnt,1,MPIU_INT,0,comm);CHKERRQ(ierr);
449     if (!*mcnt) break;
450   }
451   PetscFunctionReturn(0);
452 }
453 
454 /*
455    PetscViewer writes to MATLAB .mat file
456 */
457 PETSC_EXTERN PetscErrorCode PetscViewerMatlabPutArray(PetscViewer,int,int,const PetscScalar*,const char*);
458 PETSC_EXTERN PetscErrorCode PetscViewerMatlabGetArray(PetscViewer,int,int,PetscScalar*,const char*);
459 PETSC_EXTERN PetscErrorCode PetscViewerMatlabPutVariable(PetscViewer,const char*,void*);
460 
461 /*S
462      PetscViewers - Abstract collection of PetscViewers. It is just an expandable array of viewers.
463 
464    Level: intermediate
465 
466   Concepts: viewing
467 
468 .seealso:  PetscViewerCreate(), PetscViewerSetType(), PetscViewerType, PetscViewer, PetscViewersCreate(),
469            PetscViewersGetViewer()
470 S*/
471 typedef struct _n_PetscViewers* PetscViewers;
472 PETSC_EXTERN PetscErrorCode PetscViewersCreate(MPI_Comm,PetscViewers*);
473 PETSC_EXTERN PetscErrorCode PetscViewersDestroy(PetscViewers*);
474 PETSC_EXTERN PetscErrorCode PetscViewersGetViewer(PetscViewers,PetscInt,PetscViewer*);
475 
476 #if defined(PETSC_HAVE_AMS)
477 #include <ams.h>
478 PETSC_EXTERN PetscErrorCode PetscViewerAMSSetCommName(PetscViewer,const char[]);
479 PETSC_EXTERN PetscErrorCode PetscViewerAMSGetAMSComm(PetscViewer,AMS_Comm *);
480 PETSC_EXTERN PetscErrorCode PetscViewerAMSOpen(MPI_Comm,const char[],PetscViewer*);
481 PETSC_EXTERN PetscErrorCode PetscViewerAMSLock(PetscViewer);
482 PETSC_EXTERN PetscViewer    PETSC_VIEWER_AMS_(MPI_Comm);
483 PETSC_EXTERN PetscErrorCode PETSC_VIEWER_AMS_Destroy(MPI_Comm);
484 #define PETSC_VIEWER_AMS_WORLD PETSC_VIEWER_AMS_(PETSC_COMM_WORLD)
485 #endif
486 
487 #endif
488