Actual source code: petscviewer.h
1: /*
2: PetscViewers are objects where other objects can be looked at or stored.
3: */
4: #pragma once
6: #include <petscsys.h>
7: #include <petscviewertypes.h>
8: #include <petscdrawtypes.h>
10: /* SUBMANSEC = Viewer */
12: PETSC_EXTERN PetscClassId PETSC_VIEWER_CLASSID;
14: /*J
15: PetscViewerType - String with the name of a PETSc `PetscViewer` implementation
17: Level: beginner
19: .seealso: [](sec_viewers), `PetscViewerSetType()`, `PetscViewer`, `PetscViewerRegister()`, `PetscViewerCreate()`
20: J*/
21: typedef const char *PetscViewerType;
22: #define PETSCVIEWERSOCKET "socket"
23: #define PETSCVIEWERASCII "ascii"
24: #define PETSCVIEWERBINARY "binary"
25: #define PETSCVIEWERSTRING "string"
26: #define PETSCVIEWERDRAW "draw"
27: #define PETSCVIEWERVU "vu"
28: #define PETSCVIEWERMATHEMATICA "mathematica"
29: #define PETSCVIEWERHDF5 "hdf5"
30: #define PETSCVIEWERVTK "vtk"
31: #define PETSCVIEWERMATLAB "matlab"
32: #define PETSCVIEWERSAWS "saws"
33: #define PETSCVIEWERGLVIS "glvis"
34: #define PETSCVIEWERADIOS "adios"
35: #define PETSCVIEWEREXODUSII "exodusii"
36: #define PETSCVIEWERCGNS "cgns"
38: PETSC_EXTERN PetscFunctionList PetscViewerList;
39: PETSC_EXTERN PetscErrorCode PetscViewerInitializePackage(void);
40: PETSC_EXTERN PetscErrorCode PetscViewerFinalizePackage(void);
42: PETSC_EXTERN PetscErrorCode PetscViewerRegister(const char[], PetscErrorCode (*)(PetscViewer));
44: PETSC_EXTERN PetscErrorCode PetscViewerCreate(MPI_Comm, PetscViewer *);
45: PETSC_EXTERN PetscErrorCode PetscViewerSetFromOptions(PetscViewer);
46: PETSC_EXTERN PetscErrorCode PetscViewerASCIIOpenWithFILE(MPI_Comm, FILE *, PetscViewer *);
48: PETSC_EXTERN PetscErrorCode PetscViewerASCIIOpen(MPI_Comm, const char[], PetscViewer *);
49: PETSC_EXTERN PetscErrorCode PetscViewerASCIISetFILE(PetscViewer, FILE *);
50: PETSC_EXTERN PetscErrorCode PetscViewerBinaryOpen(MPI_Comm, const char[], PetscFileMode, PetscViewer *);
51: PETSC_EXTERN PetscErrorCode PetscViewerADIOSOpen(MPI_Comm, const char[], PetscFileMode, PetscViewer *);
52: PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetFlowControl(PetscViewer, PetscInt *);
53: PETSC_EXTERN PetscErrorCode PetscViewerBinarySetFlowControl(PetscViewer, PetscInt);
54: PETSC_EXTERN PetscErrorCode PetscViewerBinarySetUseMPIIO(PetscViewer, PetscBool);
55: PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetUseMPIIO(PetscViewer, PetscBool *);
56: #if defined(PETSC_HAVE_MPIIO)
57: PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetMPIIODescriptor(PetscViewer, MPI_File *);
58: PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetMPIIOOffset(PetscViewer, MPI_Offset *);
59: PETSC_EXTERN PetscErrorCode PetscViewerBinaryAddMPIIOOffset(PetscViewer, MPI_Offset);
60: #endif
62: PETSC_EXTERN PetscErrorCode PetscViewerSocketOpen(MPI_Comm, const char[], int, PetscViewer *);
63: PETSC_EXTERN PetscErrorCode PetscViewerStringOpen(MPI_Comm, char[], size_t, PetscViewer *);
64: PETSC_EXTERN PetscErrorCode PetscViewerDrawOpen(MPI_Comm, const char[], const char[], int, int, int, int, PetscViewer *);
65: PETSC_EXTERN PetscErrorCode PetscViewerDrawSetDrawType(PetscViewer, PetscDrawType);
66: PETSC_EXTERN PetscErrorCode PetscViewerDrawGetDrawType(PetscViewer, PetscDrawType *);
67: PETSC_EXTERN PetscErrorCode PetscViewerDrawSetTitle(PetscViewer, const char[]);
68: PETSC_EXTERN PetscErrorCode PetscViewerDrawGetTitle(PetscViewer, const char *[]);
69: PETSC_EXTERN PetscErrorCode PetscViewerDrawGetDraw(PetscViewer, PetscInt, PetscDraw *);
70: PETSC_EXTERN PetscErrorCode PetscViewerDrawBaseAdd(PetscViewer, PetscInt);
71: PETSC_EXTERN PetscErrorCode PetscViewerDrawBaseSet(PetscViewer, PetscInt);
72: PETSC_EXTERN PetscErrorCode PetscViewerDrawGetDrawLG(PetscViewer, PetscInt, PetscDrawLG *);
73: PETSC_EXTERN PetscErrorCode PetscViewerDrawGetDrawAxis(PetscViewer, PetscInt, PetscDrawAxis *);
75: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaOpen(MPI_Comm, int, const char[], const char[], PetscViewer *);
76: PETSC_EXTERN PetscErrorCode PetscViewerSiloOpen(MPI_Comm, const char[], PetscViewer *);
77: PETSC_EXTERN PetscErrorCode PetscViewerMatlabOpen(MPI_Comm, const char[], PetscFileMode, PetscViewer *);
79: /*E
80: PetscViewerGLVisType - indicates what type of `PETSCVIEWERGLVIS` viewer to use
82: Values:
83: + `PETSC_VIEWER_GLVIS_DUMP` - save the data to a file
84: - `PETSC_VIEWER_GLVIS_SOCKET` - communicate the data to another program via a socket
86: Level: beginner
88: .seealso: [](sec_viewers), `PETSCVIEWERGLVIS`, `PetscViewerGLVisOpen()`
89: E*/
90: typedef enum {
91: PETSC_VIEWER_GLVIS_DUMP,
92: PETSC_VIEWER_GLVIS_SOCKET
93: } PetscViewerGLVisType;
94: PETSC_EXTERN PetscErrorCode PetscViewerGLVisOpen(MPI_Comm, PetscViewerGLVisType, const char *, PetscInt, PetscViewer *);
95: PETSC_EXTERN PetscErrorCode PetscViewerGLVisSetPrecision(PetscViewer, PetscInt);
96: PETSC_EXTERN PetscErrorCode PetscViewerGLVisSetSnapId(PetscViewer, PetscInt);
97: PETSC_EXTERN PetscErrorCode PetscViewerGLVisSetFields(PetscViewer, PetscInt, const char *[], PetscInt[], PetscErrorCode (*)(PetscObject, PetscInt, PetscObject[], void *), PetscObject[], void *, PetscErrorCode (*)(void *));
99: PETSC_EXTERN PetscErrorCode PetscViewerGetType(PetscViewer, PetscViewerType *);
100: PETSC_EXTERN PetscErrorCode PetscViewerSetType(PetscViewer, PetscViewerType);
101: PETSC_EXTERN PetscErrorCode PetscViewerDestroy(PetscViewer *);
102: PETSC_EXTERN PetscErrorCode PetscViewerGetSubViewer(PetscViewer, MPI_Comm, PetscViewer *);
103: PETSC_EXTERN PetscErrorCode PetscViewerRestoreSubViewer(PetscViewer, MPI_Comm, PetscViewer *);
105: PETSC_EXTERN PetscErrorCode PetscViewerSetUp(PetscViewer);
106: PETSC_EXTERN PetscErrorCode PetscViewerView(PetscViewer, PetscViewer);
107: PETSC_EXTERN PetscErrorCode PetscViewerViewFromOptions(PetscViewer, PetscObject, const char[]);
109: PETSC_EXTERN PetscErrorCode PetscViewerSetOptionsPrefix(PetscViewer, const char[]);
110: PETSC_EXTERN PetscErrorCode PetscViewerAppendOptionsPrefix(PetscViewer, const char[]);
111: PETSC_EXTERN PetscErrorCode PetscViewerGetOptionsPrefix(PetscViewer, const char *[]);
113: PETSC_EXTERN PetscErrorCode PetscViewerReadable(PetscViewer, PetscBool *);
114: PETSC_EXTERN PetscErrorCode PetscViewerWritable(PetscViewer, PetscBool *);
115: PETSC_EXTERN PetscErrorCode PetscViewerCheckReadable(PetscViewer);
116: PETSC_EXTERN PetscErrorCode PetscViewerCheckWritable(PetscViewer);
118: #define PETSC_VIEWER_ASCII_VTK_ATTR PETSC_VIEWER_ASCII_VTK PETSC_DEPRECATED_ENUM(3, 14, 0, "PetscViewerVTKOpen() with XML (.vtr.vts.vtu) format", )
119: #define PETSC_VIEWER_ASCII_VTK_CELL_ATTR PETSC_VIEWER_ASCII_VTK_CELL PETSC_DEPRECATED_ENUM(3, 14, 0, "PetscViewerVTKOpen() with XML (.vtr.vts.vtu) format", )
120: #define PETSC_VIEWER_ASCII_VTK_COORDS_ATTR PETSC_VIEWER_ASCII_VTK_COORDS PETSC_DEPRECATED_ENUM(3, 14, 0, "PetscViewerVTKOpen() with XML (.vtr .vts .vtu) format", )
121: /*E
122: PetscViewerFormat - Way a viewer presents the object
124: Values:
125: + `PETSC_VIEWER_DEFAULT` - default format for the specific object being viewed
126: . `PETSC_VIEWER_ASCII_MATLAB` - MATLAB format
127: . `PETSC_VIEWER_ASCII_DENSE` - print matrix as a dense two dimensiona array
128: . `PETSC_VIEWER_ASCII_IMPL` - implementation-specific format (which is in many cases the same as the default)
129: . `PETSC_VIEWER_ASCII_INFO` - basic information about object
130: . `PETSC_VIEWER_ASCII_INFO_DETAIL` - more detailed info about object
131: . `PETSC_VIEWER_ASCII_COMMON` - identical output format for all objects of a particular type
132: . `PETSC_VIEWER_ASCII_INDEX` - (for vectors) prints the vector element number next to each vector entry
133: . `PETSC_VIEWER_ASCII_SYMMODU` - print parallel vectors without indicating the MPI process ranges that own the entries
134: . `PETSC_VIEWER_ASCII_VTK` - outputs the object to a VTK file (deprecated since v3.14)
135: . `PETSC_VIEWER_NATIVE` - store the object to the binary file in its native format (for example, dense
136: matrices are stored as dense), `DMDA` vectors are dumped directly to the
137: file instead of being first put in the natural ordering
138: . `PETSC_VIEWER_ASCII_LATEX` - output the data in LaTeX
139: . `PETSC_VIEWER_BINARY_MATLAB` - output additional information that can be used to read the data into MATLAB
140: . `PETSC_VIEWER_DRAW_BASIC` - views the vector with a simple 1d plot
141: . `PETSC_VIEWER_DRAW_LG` - views the vector with a line graph
142: - `PETSC_VIEWER_DRAW_CONTOUR` - views the vector with a contour plot
144: Level: beginner
146: Note:
147: A variety of specialized formats also exist
149: .seealso: [](sec_viewers), `PetscViewer`, `PetscViewerType`, `PetscViewerPushFormat()`, `PetscViewerPopFormat()`
150: E*/
151: typedef enum {
152: PETSC_VIEWER_DEFAULT,
153: PETSC_VIEWER_ASCII_MATLAB,
154: PETSC_VIEWER_ASCII_MATHEMATICA,
155: PETSC_VIEWER_ASCII_IMPL,
156: PETSC_VIEWER_ASCII_INFO,
157: PETSC_VIEWER_ASCII_INFO_DETAIL,
158: PETSC_VIEWER_ASCII_COMMON,
159: PETSC_VIEWER_ASCII_SYMMODU,
160: PETSC_VIEWER_ASCII_INDEX,
161: PETSC_VIEWER_ASCII_DENSE,
162: PETSC_VIEWER_ASCII_MATRIXMARKET,
163: PETSC_VIEWER_ASCII_VTK_DEPRECATED,
164: PETSC_VIEWER_ASCII_VTK_ATTR = PETSC_VIEWER_ASCII_VTK_DEPRECATED,
165: PETSC_VIEWER_ASCII_VTK_CELL_DEPRECATED,
166: PETSC_VIEWER_ASCII_VTK_CELL_ATTR = PETSC_VIEWER_ASCII_VTK_CELL_DEPRECATED,
167: PETSC_VIEWER_ASCII_VTK_COORDS_DEPRECATED,
168: PETSC_VIEWER_ASCII_VTK_COORDS_ATTR = PETSC_VIEWER_ASCII_VTK_COORDS_DEPRECATED,
169: PETSC_VIEWER_ASCII_PCICE,
170: PETSC_VIEWER_ASCII_PYTHON,
171: PETSC_VIEWER_ASCII_FACTOR_INFO,
172: PETSC_VIEWER_ASCII_LATEX,
173: PETSC_VIEWER_ASCII_XML,
174: PETSC_VIEWER_ASCII_FLAMEGRAPH,
175: PETSC_VIEWER_ASCII_GLVIS,
176: PETSC_VIEWER_ASCII_CSV,
177: PETSC_VIEWER_DRAW_BASIC,
178: PETSC_VIEWER_DRAW_LG,
179: PETSC_VIEWER_DRAW_LG_XRANGE,
180: PETSC_VIEWER_DRAW_CONTOUR,
181: PETSC_VIEWER_DRAW_PORTS,
182: PETSC_VIEWER_VTK_VTS,
183: PETSC_VIEWER_VTK_VTR,
184: PETSC_VIEWER_VTK_VTU,
185: PETSC_VIEWER_BINARY_MATLAB,
186: PETSC_VIEWER_NATIVE,
187: PETSC_VIEWER_HDF5_PETSC,
188: PETSC_VIEWER_HDF5_VIZ,
189: PETSC_VIEWER_HDF5_XDMF,
190: PETSC_VIEWER_HDF5_MAT,
191: PETSC_VIEWER_NOFORMAT,
192: PETSC_VIEWER_LOAD_BALANCE,
193: PETSC_VIEWER_FAILED,
194: PETSC_VIEWER_ALL
195: } PetscViewerFormat;
196: PETSC_EXTERN const char *const PetscViewerFormats[];
198: PETSC_EXTERN PETSC_DEPRECATED_FUNCTION(3, 7, 0, "PetscViewerPushFormat() / PetscViewerPopFormat()", ) PetscErrorCode PetscViewerSetFormat(PetscViewer, PetscViewerFormat);
199: PETSC_EXTERN PetscErrorCode PetscViewerPushFormat(PetscViewer, PetscViewerFormat);
200: PETSC_EXTERN PetscErrorCode PetscViewerPopFormat(PetscViewer);
201: PETSC_EXTERN PetscErrorCode PetscViewerGetFormat(PetscViewer, PetscViewerFormat *);
202: PETSC_EXTERN PetscErrorCode PetscViewerFlush(PetscViewer);
204: PETSC_EXTERN PetscErrorCode PetscOptionsPushGetViewerOff(PetscBool);
205: PETSC_EXTERN PetscErrorCode PetscOptionsPopGetViewerOff(void);
206: PETSC_EXTERN PetscErrorCode PetscOptionsGetViewerOff(PetscBool *);
207: PETSC_EXTERN PetscErrorCode PetscOptionsGetViewer(MPI_Comm, PetscOptions, const char[], const char[], PetscViewer *, PetscViewerFormat *, PetscBool *);
208: PETSC_EXTERN PetscErrorCode PetscOptionsGetViewers(MPI_Comm, PetscOptions, const char[], const char[], PetscInt *, PetscViewer *, PetscViewerFormat *, PetscBool *);
209: #define PetscOptionsViewer(a, b, c, d, e, f) PetscOptionsViewer_Private(PetscOptionsObject, a, b, c, d, e, f)
210: PETSC_EXTERN PetscErrorCode PetscOptionsViewer_Private(PetscOptionItems *, const char[], const char[], const char[], PetscViewer *, PetscViewerFormat *, PetscBool *);
212: typedef struct {
213: PetscViewer viewer;
214: PetscViewerFormat format;
215: PetscDrawLG lg;
216: PetscInt view_interval;
217: void *data;
218: } PetscViewerAndFormat;
219: PETSC_EXTERN PetscErrorCode PetscViewerAndFormatCreate(PetscViewer, PetscViewerFormat, PetscViewerAndFormat **);
220: PETSC_EXTERN PetscErrorCode PetscViewerAndFormatDestroy(PetscViewerAndFormat **);
222: /*
223: Operations explicit to a particular class of viewers
224: */
226: PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetPointer(PetscViewer, FILE **);
227: PETSC_EXTERN PetscErrorCode PetscViewerFileGetMode(PetscViewer, PetscFileMode *);
228: PETSC_EXTERN PetscErrorCode PetscViewerFileSetMode(PetscViewer, PetscFileMode);
229: PETSC_EXTERN PetscErrorCode PetscViewerRead(PetscViewer, void *, PetscInt, PetscInt *, PetscDataType);
230: PETSC_EXTERN PetscErrorCode PetscViewerASCIIPrintf(PetscViewer, const char[], ...) PETSC_ATTRIBUTE_FORMAT(2, 3);
231: PETSC_EXTERN PetscErrorCode PetscViewerASCIISynchronizedPrintf(PetscViewer, const char[], ...) PETSC_ATTRIBUTE_FORMAT(2, 3);
232: PETSC_EXTERN PetscErrorCode PetscViewerASCIIPushSynchronized(PetscViewer);
233: PETSC_EXTERN PetscErrorCode PetscViewerASCIIPopSynchronized(PetscViewer);
234: PETSC_EXTERN PetscErrorCode PetscViewerASCIIPushTab(PetscViewer);
235: PETSC_EXTERN PetscErrorCode PetscViewerASCIIPopTab(PetscViewer);
236: PETSC_EXTERN PetscErrorCode PetscViewerASCIIUseTabs(PetscViewer, PetscBool);
237: PETSC_EXTERN PetscErrorCode PetscViewerASCIISetTab(PetscViewer, PetscInt);
238: PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetTab(PetscViewer, PetscInt *);
239: PETSC_EXTERN PetscErrorCode PetscViewerASCIIAddTab(PetscViewer, PetscInt);
240: PETSC_EXTERN PetscErrorCode PetscViewerASCIISubtractTab(PetscViewer, PetscInt);
241: PETSC_EXTERN PetscErrorCode PetscViewerASCIIRead(PetscViewer, void *, PetscInt, PetscInt *, PetscDataType);
242: PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetDescriptor(PetscViewer, int *);
243: PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetInfoPointer(PetscViewer, FILE **);
244: PETSC_EXTERN PetscErrorCode PetscViewerBinaryRead(PetscViewer, void *, PetscInt, PetscInt *, PetscDataType);
245: PETSC_EXTERN PetscErrorCode PetscViewerBinaryWrite(PetscViewer, const void *, PetscInt, PetscDataType);
246: PETSC_EXTERN PetscErrorCode PetscViewerBinaryReadAll(PetscViewer, void *, PetscInt, PetscInt64, PetscInt64, PetscDataType);
247: PETSC_EXTERN PetscErrorCode PetscViewerBinaryWriteAll(PetscViewer, const void *, PetscInt, PetscInt64, PetscInt64, PetscDataType);
248: PETSC_EXTERN PetscErrorCode PetscViewerStringSPrintf(PetscViewer, const char[], ...) PETSC_ATTRIBUTE_FORMAT(2, 3);
249: PETSC_EXTERN PetscErrorCode PetscViewerStringSetString(PetscViewer, char[], size_t);
250: PETSC_EXTERN PetscErrorCode PetscViewerStringGetStringRead(PetscViewer, const char *[], size_t *);
251: PETSC_EXTERN PetscErrorCode PetscViewerStringSetOwnString(PetscViewer);
252: PETSC_EXTERN PetscErrorCode PetscViewerDrawClear(PetscViewer);
253: PETSC_EXTERN PetscErrorCode PetscViewerDrawSetHold(PetscViewer, PetscBool);
254: PETSC_EXTERN PetscErrorCode PetscViewerDrawGetHold(PetscViewer, PetscBool *);
255: PETSC_EXTERN PetscErrorCode PetscViewerDrawSetPause(PetscViewer, PetscReal);
256: PETSC_EXTERN PetscErrorCode PetscViewerDrawGetPause(PetscViewer, PetscReal *);
257: PETSC_EXTERN PetscErrorCode PetscViewerDrawSetInfo(PetscViewer, const char[], const char[], int, int, int, int);
258: PETSC_EXTERN PetscErrorCode PetscViewerDrawResize(PetscViewer, int, int);
259: PETSC_EXTERN PetscErrorCode PetscViewerDrawSetBounds(PetscViewer, PetscInt, const PetscReal *);
260: PETSC_EXTERN PetscErrorCode PetscViewerDrawGetBounds(PetscViewer, PetscInt *, const PetscReal **);
261: PETSC_EXTERN PetscErrorCode PetscViewerSocketSetConnection(PetscViewer, const char[], int);
262: PETSC_EXTERN PetscErrorCode PetscViewerBinarySkipInfo(PetscViewer);
263: PETSC_EXTERN PetscErrorCode PetscViewerBinarySetSkipInfo(PetscViewer, PetscBool);
264: PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetSkipInfo(PetscViewer, PetscBool *);
265: PETSC_EXTERN PetscErrorCode PetscViewerBinarySetSkipOptions(PetscViewer, PetscBool);
266: PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetSkipOptions(PetscViewer, PetscBool *);
267: PETSC_EXTERN PetscErrorCode PetscViewerBinarySetSkipHeader(PetscViewer, PetscBool);
268: PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetSkipHeader(PetscViewer, PetscBool *);
269: PETSC_EXTERN PetscErrorCode PetscViewerBinaryReadStringArray(PetscViewer, char ***);
270: PETSC_EXTERN PetscErrorCode PetscViewerBinaryWriteStringArray(PetscViewer, const char *const *);
272: PETSC_EXTERN PetscErrorCode PetscViewerFileSetName(PetscViewer, const char[]);
273: PETSC_EXTERN PetscErrorCode PetscViewerFileGetName(PetscViewer, const char **);
275: PETSC_EXTERN PetscErrorCode PetscViewerVUGetPointer(PetscViewer, FILE **);
276: PETSC_EXTERN PetscErrorCode PetscViewerVUSetVecSeen(PetscViewer, PetscBool);
277: PETSC_EXTERN PetscErrorCode PetscViewerVUGetVecSeen(PetscViewer, PetscBool *);
278: PETSC_EXTERN PetscErrorCode PetscViewerVUPrintDeferred(PetscViewer, const char[], ...) PETSC_ATTRIBUTE_FORMAT(2, 3);
279: PETSC_EXTERN PetscErrorCode PetscViewerVUFlushDeferred(PetscViewer);
281: /*@C
282: PetscViewerVUSetMode - Sets the mode in which to open the file.
284: Not Collective
286: Input Parameters:
287: + viewer - The `PetscViewer`
288: - mode - The file mode
290: Level: deprecated
292: Note:
293: Use `PetscViewerFileSetMode()` instead.
295: .seealso: [](sec_viewers), `PetscViewer`, `PetscViewerFileSetMode()`
296: @*/
297: PETSC_DEPRECATED_FUNCTION(3, 15, 0, "PetscViewerFileSetMode()", ) static inline PetscErrorCode PetscViewerVUSetMode(PetscViewer viewer, PetscFileMode mode)
298: {
299: return PetscViewerFileSetMode(viewer, mode);
300: }
302: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaInitializePackage(void);
303: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaFinalizePackage(void);
304: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaGetName(PetscViewer, const char **);
305: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaSetName(PetscViewer, const char[]);
306: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaClearName(PetscViewer);
307: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaSkipPackets(PetscViewer, int);
309: PETSC_EXTERN PetscErrorCode PetscViewerSiloClearName(PetscViewer);
310: PETSC_EXTERN PetscErrorCode PetscViewerSiloClearMeshName(PetscViewer);
312: typedef enum {
313: PETSC_VTK_INVALID,
314: PETSC_VTK_POINT_FIELD,
315: PETSC_VTK_POINT_VECTOR_FIELD,
316: PETSC_VTK_CELL_FIELD,
317: PETSC_VTK_CELL_VECTOR_FIELD
318: } PetscViewerVTKFieldType;
319: PETSC_EXTERN PetscErrorCode PetscViewerVTKAddField(PetscViewer, PetscObject, PetscErrorCode (*PetscViewerVTKWriteFunction)(PetscObject, PetscViewer), PetscInt, PetscViewerVTKFieldType, PetscBool, PetscObject);
320: PETSC_EXTERN PetscErrorCode PetscViewerVTKGetDM(PetscViewer, PetscObject *);
321: PETSC_EXTERN PetscErrorCode PetscViewerVTKOpen(MPI_Comm, const char[], PetscFileMode, PetscViewer *);
323: /*
324: These are all the default viewers that do not have to be explicitly opened
325: */
326: PETSC_EXTERN PetscViewer PETSC_VIEWER_STDOUT_(MPI_Comm);
327: PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetStdout(MPI_Comm, PetscViewer *);
328: PETSC_EXTERN PetscViewer PETSC_VIEWER_STDERR_(MPI_Comm);
329: PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetStderr(MPI_Comm, PetscViewer *);
330: PETSC_EXTERN PetscViewer PETSC_VIEWER_DRAW_(MPI_Comm);
331: PETSC_EXTERN PetscViewer PETSC_VIEWER_SOCKET_(MPI_Comm);
332: PETSC_EXTERN PetscViewer PETSC_VIEWER_BINARY_(MPI_Comm);
333: PETSC_EXTERN PetscViewer PETSC_VIEWER_MATLAB_(MPI_Comm);
334: PETSC_EXTERN PetscViewer PETSC_VIEWER_HDF5_(MPI_Comm);
335: PETSC_EXTERN PetscViewer PETSC_VIEWER_GLVIS_(MPI_Comm);
336: PETSC_EXTERN PetscViewer PETSC_VIEWER_EXODUSII_(MPI_Comm);
337: PETSC_EXTERN PetscViewer PETSC_VIEWER_MATHEMATICA_WORLD_PRIVATE;
339: /*MC
340: PETSC_VIEWER_STDERR_SELF - same as `PETSC_VIEWER_STDERR_`(PETSC_COMM_SELF)
342: Level: beginner
343: M*/
344: #define PETSC_VIEWER_STDERR_SELF PETSC_VIEWER_STDERR_(PETSC_COMM_SELF)
346: /*MC
347: PETSC_VIEWER_STDERR_WORLD - same as `PETSC_VIEWER_STDERR_`(PETSC_COMM_WORLD)
349: Level: beginner
350: M*/
351: #define PETSC_VIEWER_STDERR_WORLD PETSC_VIEWER_STDERR_(PETSC_COMM_WORLD)
353: /*MC
354: PETSC_VIEWER_STDOUT_WORLD - same as `PETSC_VIEWER_STDOUT_`(PETSC_COMM_WORLD)
356: Level: beginner
357: M*/
358: #define PETSC_VIEWER_STDOUT_WORLD PETSC_VIEWER_STDOUT_(PETSC_COMM_WORLD)
360: /*MC
361: PETSC_VIEWER_STDOUT_SELF - same as `PETSC_VIEWER_STDOUT_`(PETSC_COMM_SELF)
363: Level: beginner
364: M*/
365: #define PETSC_VIEWER_STDOUT_SELF PETSC_VIEWER_STDOUT_(PETSC_COMM_SELF)
367: /*MC
368: PETSC_VIEWER_DRAW_WORLD - same as `PETSC_VIEWER_DRAW_`(PETSC_COMM_WORLD)
370: Level: intermediate
371: M*/
372: #define PETSC_VIEWER_DRAW_WORLD PETSC_VIEWER_DRAW_(PETSC_COMM_WORLD)
374: /*MC
375: PETSC_VIEWER_DRAW_SELF - same as `PETSC_VIEWER_DRAW_`(PETSC_COMM_SELF)
377: Level: intermediate
378: M*/
379: #define PETSC_VIEWER_DRAW_SELF PETSC_VIEWER_DRAW_(PETSC_COMM_SELF)
381: /*MC
382: PETSC_VIEWER_SOCKET_WORLD - same as `PETSC_VIEWER_SOCKET_`(PETSC_COMM_WORLD)
384: Level: intermediate
385: M*/
386: #define PETSC_VIEWER_SOCKET_WORLD PETSC_VIEWER_SOCKET_(PETSC_COMM_WORLD)
388: /*MC
389: PETSC_VIEWER_SOCKET_SELF - same as `PETSC_VIEWER_SOCKET_`(PETSC_COMM_SELF)
391: Level: intermediate
392: M*/
393: #define PETSC_VIEWER_SOCKET_SELF PETSC_VIEWER_SOCKET_(PETSC_COMM_SELF)
395: /*MC
396: PETSC_VIEWER_BINARY_WORLD - same as `PETSC_VIEWER_BINARY_`(PETSC_COMM_WORLD)
398: Level: intermediate
399: M*/
400: #define PETSC_VIEWER_BINARY_WORLD PETSC_VIEWER_BINARY_(PETSC_COMM_WORLD)
402: /*MC
403: PETSC_VIEWER_BINARY_SELF - same as `PETSC_VIEWER_BINARY_`(PETSC_COMM_SELF)
405: Level: intermediate
406: M*/
407: #define PETSC_VIEWER_BINARY_SELF PETSC_VIEWER_BINARY_(PETSC_COMM_SELF)
409: /*MC
410: PETSC_VIEWER_MATLAB_WORLD - same as `PETSC_VIEWER_MATLAB_`(PETSC_COMM_WORLD)
412: Level: intermediate
413: M*/
414: #define PETSC_VIEWER_MATLAB_WORLD PETSC_VIEWER_MATLAB_(PETSC_COMM_WORLD)
416: /*MC
417: PETSC_VIEWER_MATLAB_SELF - same as `PETSC_VIEWER_MATLAB_`(PETSC_COMM_SELF)
419: Level: intermediate
420: M*/
421: #define PETSC_VIEWER_MATLAB_SELF PETSC_VIEWER_MATLAB_(PETSC_COMM_SELF)
423: #define PETSC_VIEWER_MATHEMATICA_WORLD (PetscViewerInitializeMathematicaWorld_Private(), PETSC_VIEWER_MATHEMATICA_WORLD_PRIVATE)
425: PETSC_EXTERN PetscErrorCode PetscViewerFlowControlStart(PetscViewer, PetscInt *, PetscInt *);
426: PETSC_EXTERN PetscErrorCode PetscViewerFlowControlStepMain(PetscViewer, PetscInt, PetscInt *, PetscInt);
427: PETSC_EXTERN PetscErrorCode PetscViewerFlowControlEndMain(PetscViewer, PetscInt *);
428: PETSC_EXTERN PetscErrorCode PetscViewerFlowControlStepWorker(PetscViewer, PetscMPIInt, PetscInt *);
429: PETSC_EXTERN PetscErrorCode PetscViewerFlowControlEndWorker(PetscViewer, PetscInt *);
430: PETSC_DEPRECATED_FUNCTION(3, 15, 0, "PetscViewerFlowControlStepMain()", ) static inline PetscErrorCode PetscViewerFlowControlStepMaster(PetscViewer viewer, PetscInt i, PetscInt *mcnt, PetscInt cnt)
431: {
432: return PetscViewerFlowControlStepMain(viewer, i, mcnt, cnt);
433: }
434: PETSC_DEPRECATED_FUNCTION(3, 15, 0, "PetscViewerFlowControlEndMain()", ) static inline PetscErrorCode PetscViewerFlowControlEndMaster(PetscViewer viewer, PetscInt *mcnt)
435: {
436: return PetscViewerFlowControlEndMain(viewer, mcnt);
437: }
439: /*
440: PetscViewer writes to MATLAB .mat file
441: */
442: PETSC_EXTERN PetscErrorCode PetscViewerMatlabPutArray(PetscViewer, int, int, const PetscScalar *, const char *);
443: PETSC_EXTERN PetscErrorCode PetscViewerMatlabGetArray(PetscViewer, int, int, PetscScalar *, const char *);
444: PETSC_EXTERN PetscErrorCode PetscViewerMatlabPutVariable(PetscViewer, const char *, void *);
446: #if defined(PETSC_HAVE_SAWS)
447: PETSC_EXTERN PetscErrorCode PetscObjectViewSAWs(PetscObject, PetscViewer);
448: #endif
450: /*S
451: PetscViewers - Abstract collection of `PetscViewer`s. It is stored as an expandable array of viewers.
453: Level: intermediate
455: .seealso: [](sec_viewers), `PetscViewerCreate()`, `PetscViewerSetType()`, `PetscViewerType`, `PetscViewer`, `PetscViewersCreate()`,
456: `PetscViewersGetViewer()`
457: S*/
458: typedef struct _n_PetscViewers *PetscViewers;
459: PETSC_EXTERN PetscErrorCode PetscViewersCreate(MPI_Comm, PetscViewers *);
460: PETSC_EXTERN PetscErrorCode PetscViewersDestroy(PetscViewers *);
461: PETSC_EXTERN PetscErrorCode PetscViewersGetViewer(PetscViewers, PetscInt, PetscViewer *);