Actual source code: petscviewer.h

  1: /*
  2:      PetscViewers are objects where other objects can be looked at or stored.
  3: */
  4: #ifndef PETSCVIEWER_H
  5: #define PETSCVIEWER_H

  7: #include <petscsys.h>
  8: #include <petscviewertypes.h>
  9: #include <petscdrawtypes.h>

 11: /* SUBMANSEC = Viewer */

 13: PETSC_EXTERN PetscClassId PETSC_VIEWER_CLASSID;

 15: /*J
 16:     PetscViewerType - String with the name of a PETSc `PetscViewer` implementation

 18:    Level: beginner

 20: .seealso: [](sec_viewers), `PetscViewerSetType()`, `PetscViewer`, `PetscViewerRegister()`, `PetscViewerCreate()`
 21: J*/
 22: typedef const char *PetscViewerType;
 23: #define PETSCVIEWERSOCKET      "socket"
 24: #define PETSCVIEWERASCII       "ascii"
 25: #define PETSCVIEWERBINARY      "binary"
 26: #define PETSCVIEWERSTRING      "string"
 27: #define PETSCVIEWERDRAW        "draw"
 28: #define PETSCVIEWERVU          "vu"
 29: #define PETSCVIEWERMATHEMATICA "mathematica"
 30: #define PETSCVIEWERHDF5        "hdf5"
 31: #define PETSCVIEWERVTK         "vtk"
 32: #define PETSCVIEWERMATLAB      "matlab"
 33: #define PETSCVIEWERSAWS        "saws"
 34: #define PETSCVIEWERGLVIS       "glvis"
 35: #define PETSCVIEWERADIOS       "adios"
 36: #define PETSCVIEWEREXODUSII    "exodusii"
 37: #define PETSCVIEWERCGNS        "cgns"

 39: PETSC_EXTERN PetscFunctionList PetscViewerList;
 40: PETSC_EXTERN PetscErrorCode    PetscViewerInitializePackage(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("Legacy VTK deprecated; use PetscViewerVTKOpen() with XML (.vtr .vts .vtu) format (since 3.14)")
119: #define PETSC_VIEWER_ASCII_VTK_CELL_ATTR   PETSC_VIEWER_ASCII_VTK_CELL PETSC_DEPRECATED_ENUM("Legacy VTK deprecated; use PetscViewerVTKOpen() with XML (.vtr .vts .vtu) format (since 3.14)")
120: #define PETSC_VIEWER_ASCII_VTK_COORDS_ATTR PETSC_VIEWER_ASCII_VTK_COORDS PETSC_DEPRECATED_ENUM("Legacy VTK deprecated; use PetscViewerVTKOpen() with XML (.vtr .vts .vtu) format (since 3.14)")
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 dense
128: .    `PETSC_VIEWER_ASCII_IMPL` - implementation-specific format
129:       (which is in many cases the same as the default)
130: .    `PETSC_VIEWER_ASCII_INFO` - basic information about object
131: .    `PETSC_VIEWER_ASCII_INFO_DETAIL` - more detailed info
132:        about object
133: .    `PETSC_VIEWER_ASCII_COMMON` - identical output format for
134:        all objects of a particular type
135: .    `PETSC_VIEWER_ASCII_INDEX` - (for vectors) prints the vector
136:        element number next to each vector entry
137: .    `PETSC_VIEWER_ASCII_SYMMODU` - print parallel vectors without
138:        indicating the processor ranges
139: .    `PETSC_VIEWER_ASCII_VTK` - outputs the object to a VTK file (deprecated since v3.14)
140: .    `PETSC_VIEWER_NATIVE` - store the object to the binary
141:        file in its native format (for example, dense
142:        matrices are stored as dense), `DMDA` vectors are dumped directly to the
143:        file instead of being first put in the natural ordering
144: .    `PETSC_VIEWER_ASCII_LATEX` - output the data in LaTeX
145: .    `PETSC_VIEWER_BINARY_MATLAB` - output additional information that can be used to read the data into MATLAB
146: .    `PETSC_VIEWER_DRAW_BASIC` - views the vector with a simple 1d plot
147: .    `PETSC_VIEWER_DRAW_LG` - views the vector with a line graph
148: -    `PETSC_VIEWER_DRAW_CONTOUR` - views the vector with a contour plot

150:    Level: beginner

152:    Note:
153:    A variety of specialized formats also exist

155: .seealso: [](sec_viewers), `PetscViewer`, `PetscViewerType`, `PetscViewerPushFormat()`, `PetscViewerPopFormat()`
156: E*/
157: typedef enum {
158:   PETSC_VIEWER_DEFAULT,
159:   PETSC_VIEWER_ASCII_MATLAB,
160:   PETSC_VIEWER_ASCII_MATHEMATICA,
161:   PETSC_VIEWER_ASCII_IMPL,
162:   PETSC_VIEWER_ASCII_INFO,
163:   PETSC_VIEWER_ASCII_INFO_DETAIL,
164:   PETSC_VIEWER_ASCII_COMMON,
165:   PETSC_VIEWER_ASCII_SYMMODU,
166:   PETSC_VIEWER_ASCII_INDEX,
167:   PETSC_VIEWER_ASCII_DENSE,
168:   PETSC_VIEWER_ASCII_MATRIXMARKET,
169:   PETSC_VIEWER_ASCII_VTK_DEPRECATED,
170:   PETSC_VIEWER_ASCII_VTK_ATTR = PETSC_VIEWER_ASCII_VTK_DEPRECATED,
171:   PETSC_VIEWER_ASCII_VTK_CELL_DEPRECATED,
172:   PETSC_VIEWER_ASCII_VTK_CELL_ATTR = PETSC_VIEWER_ASCII_VTK_CELL_DEPRECATED,
173:   PETSC_VIEWER_ASCII_VTK_COORDS_DEPRECATED,
174:   PETSC_VIEWER_ASCII_VTK_COORDS_ATTR = PETSC_VIEWER_ASCII_VTK_COORDS_DEPRECATED,
175:   PETSC_VIEWER_ASCII_PCICE,
176:   PETSC_VIEWER_ASCII_PYTHON,
177:   PETSC_VIEWER_ASCII_FACTOR_INFO,
178:   PETSC_VIEWER_ASCII_LATEX,
179:   PETSC_VIEWER_ASCII_XML,
180:   PETSC_VIEWER_ASCII_FLAMEGRAPH,
181:   PETSC_VIEWER_ASCII_GLVIS,
182:   PETSC_VIEWER_ASCII_CSV,
183:   PETSC_VIEWER_DRAW_BASIC,
184:   PETSC_VIEWER_DRAW_LG,
185:   PETSC_VIEWER_DRAW_LG_XRANGE,
186:   PETSC_VIEWER_DRAW_CONTOUR,
187:   PETSC_VIEWER_DRAW_PORTS,
188:   PETSC_VIEWER_VTK_VTS,
189:   PETSC_VIEWER_VTK_VTR,
190:   PETSC_VIEWER_VTK_VTU,
191:   PETSC_VIEWER_BINARY_MATLAB,
192:   PETSC_VIEWER_NATIVE,
193:   PETSC_VIEWER_HDF5_PETSC,
194:   PETSC_VIEWER_HDF5_VIZ,
195:   PETSC_VIEWER_HDF5_XDMF,
196:   PETSC_VIEWER_HDF5_MAT,
197:   PETSC_VIEWER_NOFORMAT,
198:   PETSC_VIEWER_LOAD_BALANCE,
199:   PETSC_VIEWER_FAILED,
200:   PETSC_VIEWER_ALL
201: } PetscViewerFormat;
202: PETSC_EXTERN const char *const PetscViewerFormats[];

204: PETSC_EXTERN                PETSC_DEPRECATED_FUNCTION("Use PetscViewerPushFormat()/PetscViewerPopFormat()") PetscErrorCode PetscViewerSetFormat(PetscViewer, PetscViewerFormat);
205: PETSC_EXTERN PetscErrorCode PetscViewerPushFormat(PetscViewer, PetscViewerFormat);
206: PETSC_EXTERN PetscErrorCode PetscViewerPopFormat(PetscViewer);
207: PETSC_EXTERN PetscErrorCode PetscViewerGetFormat(PetscViewer, PetscViewerFormat *);
208: PETSC_EXTERN PetscErrorCode PetscViewerFlush(PetscViewer);

210: PETSC_EXTERN PetscErrorCode PetscOptionsPushGetViewerOff(PetscBool);
211: PETSC_EXTERN PetscErrorCode PetscOptionsPopGetViewerOff(void);
212: PETSC_EXTERN PetscErrorCode PetscOptionsGetViewerOff(PetscBool *);
213: PETSC_EXTERN PetscErrorCode PetscOptionsGetViewer(MPI_Comm, PetscOptions, const char[], const char[], PetscViewer *, PetscViewerFormat *, PetscBool *);
214: #define PetscOptionsViewer(a, b, c, d, e, f) PetscOptionsViewer_Private(PetscOptionsObject, a, b, c, d, e, f)
215: PETSC_EXTERN PetscErrorCode PetscOptionsViewer_Private(PetscOptionItems *, const char[], const char[], const char[], PetscViewer *, PetscViewerFormat *, PetscBool *);

217: typedef struct {
218:   PetscViewer       viewer;
219:   PetscViewerFormat format;
220:   PetscDrawLG       lg;
221:   PetscInt          view_interval;
222:   void             *data;
223: } PetscViewerAndFormat;
224: PETSC_EXTERN PetscErrorCode PetscViewerAndFormatCreate(PetscViewer, PetscViewerFormat, PetscViewerAndFormat **);
225: PETSC_EXTERN PetscErrorCode PetscViewerAndFormatDestroy(PetscViewerAndFormat **);

227: /*
228:    Operations explicit to a particular class of viewers
229: */

231: PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetPointer(PetscViewer, FILE **);
232: PETSC_EXTERN PetscErrorCode PetscViewerFileGetMode(PetscViewer, PetscFileMode *);
233: PETSC_EXTERN PetscErrorCode PetscViewerFileSetMode(PetscViewer, PetscFileMode);
234: PETSC_EXTERN PetscErrorCode PetscViewerRead(PetscViewer, void *, PetscInt, PetscInt *, PetscDataType);
235: PETSC_EXTERN PetscErrorCode PetscViewerASCIIPrintf(PetscViewer, const char[], ...) PETSC_ATTRIBUTE_FORMAT(2, 3);
236: PETSC_EXTERN PetscErrorCode PetscViewerASCIISynchronizedPrintf(PetscViewer, const char[], ...) PETSC_ATTRIBUTE_FORMAT(2, 3);
237: PETSC_EXTERN PetscErrorCode PetscViewerASCIIPushSynchronized(PetscViewer);
238: PETSC_EXTERN PetscErrorCode PetscViewerASCIIPopSynchronized(PetscViewer);
239: PETSC_EXTERN PetscErrorCode PetscViewerASCIIPushTab(PetscViewer);
240: PETSC_EXTERN PetscErrorCode PetscViewerASCIIPopTab(PetscViewer);
241: PETSC_EXTERN PetscErrorCode PetscViewerASCIIUseTabs(PetscViewer, PetscBool);
242: PETSC_EXTERN PetscErrorCode PetscViewerASCIISetTab(PetscViewer, PetscInt);
243: PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetTab(PetscViewer, PetscInt *);
244: PETSC_EXTERN PetscErrorCode PetscViewerASCIIAddTab(PetscViewer, PetscInt);
245: PETSC_EXTERN PetscErrorCode PetscViewerASCIISubtractTab(PetscViewer, PetscInt);
246: PETSC_EXTERN PetscErrorCode PetscViewerASCIIRead(PetscViewer, void *, PetscInt, PetscInt *, PetscDataType);
247: PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetDescriptor(PetscViewer, int *);
248: PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetInfoPointer(PetscViewer, FILE **);
249: PETSC_EXTERN PetscErrorCode PetscViewerBinaryRead(PetscViewer, void *, PetscInt, PetscInt *, PetscDataType);
250: PETSC_EXTERN PetscErrorCode PetscViewerBinaryWrite(PetscViewer, const void *, PetscInt, PetscDataType);
251: PETSC_EXTERN PetscErrorCode PetscViewerBinaryReadAll(PetscViewer, void *, PetscInt, PetscInt, PetscInt, PetscDataType);
252: PETSC_EXTERN PetscErrorCode PetscViewerBinaryWriteAll(PetscViewer, const void *, PetscInt, PetscInt, PetscInt, PetscDataType);
253: PETSC_EXTERN PetscErrorCode PetscViewerStringSPrintf(PetscViewer, const char[], ...) PETSC_ATTRIBUTE_FORMAT(2, 3);
254: PETSC_EXTERN PetscErrorCode PetscViewerStringSetString(PetscViewer, char[], size_t);
255: PETSC_EXTERN PetscErrorCode PetscViewerStringGetStringRead(PetscViewer, const char *[], size_t *);
256: PETSC_EXTERN PetscErrorCode PetscViewerStringSetOwnString(PetscViewer);
257: PETSC_EXTERN PetscErrorCode PetscViewerDrawClear(PetscViewer);
258: PETSC_EXTERN PetscErrorCode PetscViewerDrawSetHold(PetscViewer, PetscBool);
259: PETSC_EXTERN PetscErrorCode PetscViewerDrawGetHold(PetscViewer, PetscBool *);
260: PETSC_EXTERN PetscErrorCode PetscViewerDrawSetPause(PetscViewer, PetscReal);
261: PETSC_EXTERN PetscErrorCode PetscViewerDrawGetPause(PetscViewer, PetscReal *);
262: PETSC_EXTERN PetscErrorCode PetscViewerDrawSetInfo(PetscViewer, const char[], const char[], int, int, int, int);
263: PETSC_EXTERN PetscErrorCode PetscViewerDrawResize(PetscViewer, int, int);
264: PETSC_EXTERN PetscErrorCode PetscViewerDrawSetBounds(PetscViewer, PetscInt, const PetscReal *);
265: PETSC_EXTERN PetscErrorCode PetscViewerDrawGetBounds(PetscViewer, PetscInt *, const PetscReal **);
266: PETSC_EXTERN PetscErrorCode PetscViewerSocketSetConnection(PetscViewer, const char[], int);
267: PETSC_EXTERN PetscErrorCode PetscViewerBinarySkipInfo(PetscViewer);
268: PETSC_EXTERN PetscErrorCode PetscViewerBinarySetSkipInfo(PetscViewer, PetscBool);
269: PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetSkipInfo(PetscViewer, PetscBool *);
270: PETSC_EXTERN PetscErrorCode PetscViewerBinarySetSkipOptions(PetscViewer, PetscBool);
271: PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetSkipOptions(PetscViewer, PetscBool *);
272: PETSC_EXTERN PetscErrorCode PetscViewerBinarySetSkipHeader(PetscViewer, PetscBool);
273: PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetSkipHeader(PetscViewer, PetscBool *);
274: PETSC_EXTERN PetscErrorCode PetscViewerBinaryReadStringArray(PetscViewer, char ***);
275: PETSC_EXTERN PetscErrorCode PetscViewerBinaryWriteStringArray(PetscViewer, const char *const *);

277: PETSC_EXTERN PetscErrorCode PetscViewerFileSetName(PetscViewer, const char[]);
278: PETSC_EXTERN PetscErrorCode PetscViewerFileGetName(PetscViewer, const char **);

280: PETSC_EXTERN PetscErrorCode PetscViewerVUGetPointer(PetscViewer, FILE **);
281: PETSC_EXTERN PetscErrorCode PetscViewerVUSetVecSeen(PetscViewer, PetscBool);
282: PETSC_EXTERN PetscErrorCode PetscViewerVUGetVecSeen(PetscViewer, PetscBool *);
283: PETSC_EXTERN PetscErrorCode PetscViewerVUPrintDeferred(PetscViewer, const char[], ...) PETSC_ATTRIBUTE_FORMAT(2, 3);
284: PETSC_EXTERN PetscErrorCode PetscViewerVUFlushDeferred(PetscViewer);

286: /*@C
287:   PetscViewerVUSetMode - Sets the mode in which to open the file.

289:   Not Collective

291:   Input Parameters:
292: + viewer - The `PetscViewer`
293: - mode   - The file mode

295:   Level: deprecated

297:   Note:
298:   Use `PetscViewerFileSetMode()` instead.

300: .seealso: [](sec_viewers), `PetscViewer`, `PetscViewerFileSetMode()`
301: @*/
302: PETSC_DEPRECATED_FUNCTION("Use PetscViewerFileSetMode (since v3.15)") static inline PetscErrorCode PetscViewerVUSetMode(PetscViewer viewer, PetscFileMode mode)
303: {
304:   return PetscViewerFileSetMode(viewer, mode);
305: }

307: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaInitializePackage(void);
308: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaFinalizePackage(void);
309: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaGetName(PetscViewer, const char **);
310: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaSetName(PetscViewer, const char[]);
311: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaClearName(PetscViewer);
312: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaSkipPackets(PetscViewer, int);

314: PETSC_EXTERN PetscErrorCode PetscViewerSiloGetName(PetscViewer, char **);
315: PETSC_EXTERN PetscErrorCode PetscViewerSiloSetName(PetscViewer, const char[]);
316: PETSC_EXTERN PetscErrorCode PetscViewerSiloClearName(PetscViewer);
317: PETSC_EXTERN PetscErrorCode PetscViewerSiloGetMeshName(PetscViewer, char **);
318: PETSC_EXTERN PetscErrorCode PetscViewerSiloSetMeshName(PetscViewer, const char[]);
319: PETSC_EXTERN PetscErrorCode PetscViewerSiloClearMeshName(PetscViewer);

321: typedef enum {
322:   PETSC_VTK_INVALID,
323:   PETSC_VTK_POINT_FIELD,
324:   PETSC_VTK_POINT_VECTOR_FIELD,
325:   PETSC_VTK_CELL_FIELD,
326:   PETSC_VTK_CELL_VECTOR_FIELD
327: } PetscViewerVTKFieldType;
328: PETSC_EXTERN PetscErrorCode PetscViewerVTKAddField(PetscViewer, PetscObject, PetscErrorCode (*PetscViewerVTKWriteFunction)(PetscObject, PetscViewer), PetscInt, PetscViewerVTKFieldType, PetscBool, PetscObject);
329: PETSC_EXTERN PetscErrorCode PetscViewerVTKGetDM(PetscViewer, PetscObject *);
330: PETSC_EXTERN PetscErrorCode PetscViewerVTKOpen(MPI_Comm, const char[], PetscFileMode, PetscViewer *);

332: /*
333:      These are all the default viewers that do not have to be explicitly opened
334: */
335: PETSC_EXTERN PetscViewer    PETSC_VIEWER_STDOUT_(MPI_Comm);
336: PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetStdout(MPI_Comm, PetscViewer *);
337: PETSC_EXTERN PetscViewer    PETSC_VIEWER_STDERR_(MPI_Comm);
338: PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetStderr(MPI_Comm, PetscViewer *);
339: PETSC_EXTERN PetscViewer    PETSC_VIEWER_DRAW_(MPI_Comm);
340: PETSC_EXTERN PetscViewer    PETSC_VIEWER_SOCKET_(MPI_Comm);
341: PETSC_EXTERN PetscViewer    PETSC_VIEWER_BINARY_(MPI_Comm);
342: PETSC_EXTERN PetscViewer    PETSC_VIEWER_MATLAB_(MPI_Comm);
343: PETSC_EXTERN PetscViewer    PETSC_VIEWER_HDF5_(MPI_Comm);
344: PETSC_EXTERN PetscViewer    PETSC_VIEWER_GLVIS_(MPI_Comm);
345: PETSC_EXTERN PetscViewer    PETSC_VIEWER_EXODUSII_(MPI_Comm);
346: PETSC_EXTERN PetscViewer    PETSC_VIEWER_MATHEMATICA_WORLD_PRIVATE;

348: /*MC
349:   PETSC_VIEWER_STDERR_SELF  - same as `PETSC_VIEWER_STDERR_`(PETSC_COMM_SELF)

351:   Level: beginner
352: M*/
353: #define PETSC_VIEWER_STDERR_SELF PETSC_VIEWER_STDERR_(PETSC_COMM_SELF)

355: /*MC
356:   PETSC_VIEWER_STDERR_WORLD  - same as `PETSC_VIEWER_STDERR_`(PETSC_COMM_WORLD)

358:   Level: beginner
359: M*/
360: #define PETSC_VIEWER_STDERR_WORLD PETSC_VIEWER_STDERR_(PETSC_COMM_WORLD)

362: /*MC
363:   PETSC_VIEWER_STDOUT_WORLD  - same as `PETSC_VIEWER_STDOUT_`(PETSC_COMM_WORLD)

365:   Level: beginner
366: M*/
367: #define PETSC_VIEWER_STDOUT_WORLD PETSC_VIEWER_STDOUT_(PETSC_COMM_WORLD)

369: /*MC
370:   PETSC_VIEWER_STDOUT_SELF  - same as `PETSC_VIEWER_STDOUT_`(PETSC_COMM_SELF)

372:   Level: beginner
373: M*/
374: #define PETSC_VIEWER_STDOUT_SELF PETSC_VIEWER_STDOUT_(PETSC_COMM_SELF)

376: /*MC
377:   PETSC_VIEWER_DRAW_WORLD  - same as `PETSC_VIEWER_DRAW_`(PETSC_COMM_WORLD)

379:   Level: intermediate
380: M*/
381: #define PETSC_VIEWER_DRAW_WORLD PETSC_VIEWER_DRAW_(PETSC_COMM_WORLD)

383: /*MC
384:   PETSC_VIEWER_DRAW_SELF  - same as `PETSC_VIEWER_DRAW_`(PETSC_COMM_SELF)

386:   Level: intermediate
387: M*/
388: #define PETSC_VIEWER_DRAW_SELF PETSC_VIEWER_DRAW_(PETSC_COMM_SELF)

390: /*MC
391:   PETSC_VIEWER_SOCKET_WORLD  - same as `PETSC_VIEWER_SOCKET_`(PETSC_COMM_WORLD)

393:   Level: intermediate
394: M*/
395: #define PETSC_VIEWER_SOCKET_WORLD PETSC_VIEWER_SOCKET_(PETSC_COMM_WORLD)

397: /*MC
398:   PETSC_VIEWER_SOCKET_SELF  - same as `PETSC_VIEWER_SOCKET_`(PETSC_COMM_SELF)

400:   Level: intermediate
401: M*/
402: #define PETSC_VIEWER_SOCKET_SELF PETSC_VIEWER_SOCKET_(PETSC_COMM_SELF)

404: /*MC
405:   PETSC_VIEWER_BINARY_WORLD  - same as `PETSC_VIEWER_BINARY_`(PETSC_COMM_WORLD)

407:   Level: intermediate
408: M*/
409: #define PETSC_VIEWER_BINARY_WORLD PETSC_VIEWER_BINARY_(PETSC_COMM_WORLD)

411: /*MC
412:   PETSC_VIEWER_BINARY_SELF  - same as `PETSC_VIEWER_BINARY_`(PETSC_COMM_SELF)

414:   Level: intermediate
415: M*/
416: #define PETSC_VIEWER_BINARY_SELF PETSC_VIEWER_BINARY_(PETSC_COMM_SELF)

418: /*MC
419:   PETSC_VIEWER_MATLAB_WORLD  - same as `PETSC_VIEWER_MATLAB_`(PETSC_COMM_WORLD)

421:   Level: intermediate
422: M*/
423: #define PETSC_VIEWER_MATLAB_WORLD PETSC_VIEWER_MATLAB_(PETSC_COMM_WORLD)

425: /*MC
426:   PETSC_VIEWER_MATLAB_SELF  - same as `PETSC_VIEWER_MATLAB_`(PETSC_COMM_SELF)

428:   Level: intermediate
429: M*/
430: #define PETSC_VIEWER_MATLAB_SELF PETSC_VIEWER_MATLAB_(PETSC_COMM_SELF)

432: #define PETSC_VIEWER_MATHEMATICA_WORLD (PetscViewerInitializeMathematicaWorld_Private(), PETSC_VIEWER_MATHEMATICA_WORLD_PRIVATE)

434: PETSC_EXTERN PetscErrorCode PetscViewerFlowControlStart(PetscViewer, PetscInt *, PetscInt *);
435: PETSC_EXTERN PetscErrorCode PetscViewerFlowControlStepMain(PetscViewer, PetscInt, PetscInt *, PetscInt);
436: PETSC_EXTERN PetscErrorCode PetscViewerFlowControlEndMain(PetscViewer, PetscInt *);
437: PETSC_EXTERN PetscErrorCode PetscViewerFlowControlStepWorker(PetscViewer, PetscMPIInt, PetscInt *);
438: PETSC_EXTERN PetscErrorCode PetscViewerFlowControlEndWorker(PetscViewer, PetscInt *);
439: PETSC_DEPRECATED_FUNCTION("Use PetscViewerFlowControlStepMain (since v3.15)") static inline PetscErrorCode PetscViewerFlowControlStepMaster(PetscViewer viewer, PetscInt i, PetscInt *mcnt, PetscInt cnt)
440: {
441:   return PetscViewerFlowControlStepMain(viewer, i, mcnt, cnt);
442: }
443: PETSC_DEPRECATED_FUNCTION("Use PetscViewerFlowControlEndMain (since v3.15)") static inline PetscErrorCode PetscViewerFlowControlEndMaster(PetscViewer viewer, PetscInt *mcnt)
444: {
445:   return PetscViewerFlowControlEndMain(viewer, mcnt);
446: }

448: /*
449:    PetscViewer writes to MATLAB .mat file
450: */
451: PETSC_EXTERN PetscErrorCode PetscViewerMatlabPutArray(PetscViewer, int, int, const PetscScalar *, const char *);
452: PETSC_EXTERN PetscErrorCode PetscViewerMatlabGetArray(PetscViewer, int, int, PetscScalar *, const char *);
453: PETSC_EXTERN PetscErrorCode PetscViewerMatlabPutVariable(PetscViewer, const char *, void *);

455: #if defined(PETSC_HAVE_SAWS)
456: PETSC_EXTERN PetscErrorCode PetscObjectViewSAWs(PetscObject, PetscViewer);
457: #endif

459: /*S
460:    PetscViewers - Abstract collection of `PetscViewer`s. It is stored as an expandable array of viewers.

462:    Level: intermediate

464: .seealso: [](sec_viewers), `PetscViewerCreate()`, `PetscViewerSetType()`, `PetscViewerType`, `PetscViewer`, `PetscViewersCreate()`,
465:           `PetscViewersGetViewer()`
466: S*/
467: typedef struct _n_PetscViewers *PetscViewers;
468: PETSC_EXTERN PetscErrorCode     PetscViewersCreate(MPI_Comm, PetscViewers *);
469: PETSC_EXTERN PetscErrorCode     PetscViewersDestroy(PetscViewers *);
470: PETSC_EXTERN PetscErrorCode     PetscViewersGetViewer(PetscViewers, PetscInt, PetscViewer *);

472: #endif