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