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