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 PetscViewerSiloOpen(MPI_Comm, const char[], PetscViewer *); 77 PETSC_EXTERN PetscErrorCode PetscViewerMatlabOpen(MPI_Comm, const char[], PetscFileMode, PetscViewer *); 78 79 /*E 80 PetscViewerGLVisType - indicates what type of `PETSCVIEWERGLVIS` viewer to use 81 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 85 86 Level: beginner 87 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 *)); 98 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 *); 104 105 PETSC_EXTERN PetscErrorCode PetscViewerSetUp(PetscViewer); 106 PETSC_EXTERN PetscErrorCode PetscViewerView(PetscViewer, PetscViewer); 107 PETSC_EXTERN PetscErrorCode PetscViewerViewFromOptions(PetscViewer, PetscObject, const char[]); 108 109 PETSC_EXTERN PetscErrorCode PetscViewerSetOptionsPrefix(PetscViewer, const char[]); 110 PETSC_EXTERN PetscErrorCode PetscViewerAppendOptionsPrefix(PetscViewer, const char[]); 111 PETSC_EXTERN PetscErrorCode PetscViewerGetOptionsPrefix(PetscViewer, const char *[]); 112 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); 117 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 123 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 149 150 Level: beginner 151 152 Note: 153 A variety of specialized formats also exist 154 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[]; 203 204 PETSC_EXTERN PETSC_DEPRECATED_FUNCTION(3, 7, 0, "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); 209 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 PETSC_EXTERN PetscErrorCode PetscOptionsGetViewers(MPI_Comm, PetscOptions, const char[], const char[], PetscInt *, PetscViewer *, PetscViewerFormat *, PetscBool *); 215 #define PetscOptionsViewer(a, b, c, d, e, f) PetscOptionsViewer_Private(PetscOptionsObject, a, b, c, d, e, f) 216 PETSC_EXTERN PetscErrorCode PetscOptionsViewer_Private(PetscOptionItems *, const char[], const char[], const char[], PetscViewer *, PetscViewerFormat *, PetscBool *); 217 218 typedef struct { 219 PetscViewer viewer; 220 PetscViewerFormat format; 221 PetscDrawLG lg; 222 PetscInt view_interval; 223 void *data; 224 } PetscViewerAndFormat; 225 PETSC_EXTERN PetscErrorCode PetscViewerAndFormatCreate(PetscViewer, PetscViewerFormat, PetscViewerAndFormat **); 226 PETSC_EXTERN PetscErrorCode PetscViewerAndFormatDestroy(PetscViewerAndFormat **); 227 228 /* 229 Operations explicit to a particular class of viewers 230 */ 231 232 PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetPointer(PetscViewer, FILE **); 233 PETSC_EXTERN PetscErrorCode PetscViewerFileGetMode(PetscViewer, PetscFileMode *); 234 PETSC_EXTERN PetscErrorCode PetscViewerFileSetMode(PetscViewer, PetscFileMode); 235 PETSC_EXTERN PetscErrorCode PetscViewerRead(PetscViewer, void *, PetscInt, PetscInt *, PetscDataType); 236 PETSC_EXTERN PetscErrorCode PetscViewerASCIIPrintf(PetscViewer, const char[], ...) PETSC_ATTRIBUTE_FORMAT(2, 3); 237 PETSC_EXTERN PetscErrorCode PetscViewerASCIISynchronizedPrintf(PetscViewer, const char[], ...) PETSC_ATTRIBUTE_FORMAT(2, 3); 238 PETSC_EXTERN PetscErrorCode PetscViewerASCIIPushSynchronized(PetscViewer); 239 PETSC_EXTERN PetscErrorCode PetscViewerASCIIPopSynchronized(PetscViewer); 240 PETSC_EXTERN PetscErrorCode PetscViewerASCIIPushTab(PetscViewer); 241 PETSC_EXTERN PetscErrorCode PetscViewerASCIIPopTab(PetscViewer); 242 PETSC_EXTERN PetscErrorCode PetscViewerASCIIUseTabs(PetscViewer, PetscBool); 243 PETSC_EXTERN PetscErrorCode PetscViewerASCIISetTab(PetscViewer, PetscInt); 244 PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetTab(PetscViewer, PetscInt *); 245 PETSC_EXTERN PetscErrorCode PetscViewerASCIIAddTab(PetscViewer, PetscInt); 246 PETSC_EXTERN PetscErrorCode PetscViewerASCIISubtractTab(PetscViewer, PetscInt); 247 PETSC_EXTERN PetscErrorCode PetscViewerASCIIRead(PetscViewer, void *, PetscInt, PetscInt *, PetscDataType); 248 PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetDescriptor(PetscViewer, int *); 249 PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetInfoPointer(PetscViewer, FILE **); 250 PETSC_EXTERN PetscErrorCode PetscViewerBinaryRead(PetscViewer, void *, PetscInt, PetscInt *, PetscDataType); 251 PETSC_EXTERN PetscErrorCode PetscViewerBinaryWrite(PetscViewer, const void *, PetscInt, PetscDataType); 252 PETSC_EXTERN PetscErrorCode PetscViewerBinaryReadAll(PetscViewer, void *, PetscInt, PetscInt64, PetscInt64, PetscDataType); 253 PETSC_EXTERN PetscErrorCode PetscViewerBinaryWriteAll(PetscViewer, const void *, PetscInt, PetscInt64, PetscInt64, PetscDataType); 254 PETSC_EXTERN PetscErrorCode PetscViewerStringSPrintf(PetscViewer, const char[], ...) PETSC_ATTRIBUTE_FORMAT(2, 3); 255 PETSC_EXTERN PetscErrorCode PetscViewerStringSetString(PetscViewer, char[], size_t); 256 PETSC_EXTERN PetscErrorCode PetscViewerStringGetStringRead(PetscViewer, const char *[], size_t *); 257 PETSC_EXTERN PetscErrorCode PetscViewerStringSetOwnString(PetscViewer); 258 PETSC_EXTERN PetscErrorCode PetscViewerDrawClear(PetscViewer); 259 PETSC_EXTERN PetscErrorCode PetscViewerDrawSetHold(PetscViewer, PetscBool); 260 PETSC_EXTERN PetscErrorCode PetscViewerDrawGetHold(PetscViewer, PetscBool *); 261 PETSC_EXTERN PetscErrorCode PetscViewerDrawSetPause(PetscViewer, PetscReal); 262 PETSC_EXTERN PetscErrorCode PetscViewerDrawGetPause(PetscViewer, PetscReal *); 263 PETSC_EXTERN PetscErrorCode PetscViewerDrawSetInfo(PetscViewer, const char[], const char[], int, int, int, int); 264 PETSC_EXTERN PetscErrorCode PetscViewerDrawResize(PetscViewer, int, int); 265 PETSC_EXTERN PetscErrorCode PetscViewerDrawSetBounds(PetscViewer, PetscInt, const PetscReal *); 266 PETSC_EXTERN PetscErrorCode PetscViewerDrawGetBounds(PetscViewer, PetscInt *, const PetscReal **); 267 PETSC_EXTERN PetscErrorCode PetscViewerSocketSetConnection(PetscViewer, const char[], int); 268 PETSC_EXTERN PetscErrorCode PetscViewerBinarySkipInfo(PetscViewer); 269 PETSC_EXTERN PetscErrorCode PetscViewerBinarySetSkipInfo(PetscViewer, PetscBool); 270 PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetSkipInfo(PetscViewer, PetscBool *); 271 PETSC_EXTERN PetscErrorCode PetscViewerBinarySetSkipOptions(PetscViewer, PetscBool); 272 PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetSkipOptions(PetscViewer, PetscBool *); 273 PETSC_EXTERN PetscErrorCode PetscViewerBinarySetSkipHeader(PetscViewer, PetscBool); 274 PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetSkipHeader(PetscViewer, PetscBool *); 275 PETSC_EXTERN PetscErrorCode PetscViewerBinaryReadStringArray(PetscViewer, char ***); 276 PETSC_EXTERN PetscErrorCode PetscViewerBinaryWriteStringArray(PetscViewer, const char *const *); 277 278 PETSC_EXTERN PetscErrorCode PetscViewerFileSetName(PetscViewer, const char[]); 279 PETSC_EXTERN PetscErrorCode PetscViewerFileGetName(PetscViewer, const char **); 280 281 PETSC_EXTERN PetscErrorCode PetscViewerVUGetPointer(PetscViewer, FILE **); 282 PETSC_EXTERN PetscErrorCode PetscViewerVUSetVecSeen(PetscViewer, PetscBool); 283 PETSC_EXTERN PetscErrorCode PetscViewerVUGetVecSeen(PetscViewer, PetscBool *); 284 PETSC_EXTERN PetscErrorCode PetscViewerVUPrintDeferred(PetscViewer, const char[], ...) PETSC_ATTRIBUTE_FORMAT(2, 3); 285 PETSC_EXTERN PetscErrorCode PetscViewerVUFlushDeferred(PetscViewer); 286 287 /*@C 288 PetscViewerVUSetMode - Sets the mode in which to open the file. 289 290 Not Collective 291 292 Input Parameters: 293 + viewer - The `PetscViewer` 294 - mode - The file mode 295 296 Level: deprecated 297 298 Note: 299 Use `PetscViewerFileSetMode()` instead. 300 301 .seealso: [](sec_viewers), `PetscViewer`, `PetscViewerFileSetMode()` 302 @*/ 303 PETSC_DEPRECATED_FUNCTION(3, 15, 0, "PetscViewerFileSetMode()", ) static inline PetscErrorCode PetscViewerVUSetMode(PetscViewer viewer, PetscFileMode mode) 304 { 305 return PetscViewerFileSetMode(viewer, mode); 306 } 307 308 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaInitializePackage(void); 309 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaFinalizePackage(void); 310 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaGetName(PetscViewer, const char **); 311 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaSetName(PetscViewer, const char[]); 312 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaClearName(PetscViewer); 313 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaSkipPackets(PetscViewer, int); 314 315 PETSC_EXTERN PetscErrorCode PetscViewerSiloClearName(PetscViewer); 316 PETSC_EXTERN PetscErrorCode PetscViewerSiloClearMeshName(PetscViewer); 317 318 typedef enum { 319 PETSC_VTK_INVALID, 320 PETSC_VTK_POINT_FIELD, 321 PETSC_VTK_POINT_VECTOR_FIELD, 322 PETSC_VTK_CELL_FIELD, 323 PETSC_VTK_CELL_VECTOR_FIELD 324 } PetscViewerVTKFieldType; 325 PETSC_EXTERN PetscErrorCode PetscViewerVTKAddField(PetscViewer, PetscObject, PetscErrorCode (*PetscViewerVTKWriteFunction)(PetscObject, PetscViewer), PetscInt, PetscViewerVTKFieldType, PetscBool, PetscObject); 326 PETSC_EXTERN PetscErrorCode PetscViewerVTKGetDM(PetscViewer, PetscObject *); 327 PETSC_EXTERN PetscErrorCode PetscViewerVTKOpen(MPI_Comm, const char[], PetscFileMode, PetscViewer *); 328 329 /* 330 These are all the default viewers that do not have to be explicitly opened 331 */ 332 PETSC_EXTERN PetscViewer PETSC_VIEWER_STDOUT_(MPI_Comm); 333 PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetStdout(MPI_Comm, PetscViewer *); 334 PETSC_EXTERN PetscViewer PETSC_VIEWER_STDERR_(MPI_Comm); 335 PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetStderr(MPI_Comm, PetscViewer *); 336 PETSC_EXTERN PetscViewer PETSC_VIEWER_DRAW_(MPI_Comm); 337 PETSC_EXTERN PetscViewer PETSC_VIEWER_SOCKET_(MPI_Comm); 338 PETSC_EXTERN PetscViewer PETSC_VIEWER_BINARY_(MPI_Comm); 339 PETSC_EXTERN PetscViewer PETSC_VIEWER_MATLAB_(MPI_Comm); 340 PETSC_EXTERN PetscViewer PETSC_VIEWER_HDF5_(MPI_Comm); 341 PETSC_EXTERN PetscViewer PETSC_VIEWER_GLVIS_(MPI_Comm); 342 PETSC_EXTERN PetscViewer PETSC_VIEWER_EXODUSII_(MPI_Comm); 343 PETSC_EXTERN PetscViewer PETSC_VIEWER_MATHEMATICA_WORLD_PRIVATE; 344 345 /*MC 346 PETSC_VIEWER_STDERR_SELF - same as `PETSC_VIEWER_STDERR_`(PETSC_COMM_SELF) 347 348 Level: beginner 349 M*/ 350 #define PETSC_VIEWER_STDERR_SELF PETSC_VIEWER_STDERR_(PETSC_COMM_SELF) 351 352 /*MC 353 PETSC_VIEWER_STDERR_WORLD - same as `PETSC_VIEWER_STDERR_`(PETSC_COMM_WORLD) 354 355 Level: beginner 356 M*/ 357 #define PETSC_VIEWER_STDERR_WORLD PETSC_VIEWER_STDERR_(PETSC_COMM_WORLD) 358 359 /*MC 360 PETSC_VIEWER_STDOUT_WORLD - same as `PETSC_VIEWER_STDOUT_`(PETSC_COMM_WORLD) 361 362 Level: beginner 363 M*/ 364 #define PETSC_VIEWER_STDOUT_WORLD PETSC_VIEWER_STDOUT_(PETSC_COMM_WORLD) 365 366 /*MC 367 PETSC_VIEWER_STDOUT_SELF - same as `PETSC_VIEWER_STDOUT_`(PETSC_COMM_SELF) 368 369 Level: beginner 370 M*/ 371 #define PETSC_VIEWER_STDOUT_SELF PETSC_VIEWER_STDOUT_(PETSC_COMM_SELF) 372 373 /*MC 374 PETSC_VIEWER_DRAW_WORLD - same as `PETSC_VIEWER_DRAW_`(PETSC_COMM_WORLD) 375 376 Level: intermediate 377 M*/ 378 #define PETSC_VIEWER_DRAW_WORLD PETSC_VIEWER_DRAW_(PETSC_COMM_WORLD) 379 380 /*MC 381 PETSC_VIEWER_DRAW_SELF - same as `PETSC_VIEWER_DRAW_`(PETSC_COMM_SELF) 382 383 Level: intermediate 384 M*/ 385 #define PETSC_VIEWER_DRAW_SELF PETSC_VIEWER_DRAW_(PETSC_COMM_SELF) 386 387 /*MC 388 PETSC_VIEWER_SOCKET_WORLD - same as `PETSC_VIEWER_SOCKET_`(PETSC_COMM_WORLD) 389 390 Level: intermediate 391 M*/ 392 #define PETSC_VIEWER_SOCKET_WORLD PETSC_VIEWER_SOCKET_(PETSC_COMM_WORLD) 393 394 /*MC 395 PETSC_VIEWER_SOCKET_SELF - same as `PETSC_VIEWER_SOCKET_`(PETSC_COMM_SELF) 396 397 Level: intermediate 398 M*/ 399 #define PETSC_VIEWER_SOCKET_SELF PETSC_VIEWER_SOCKET_(PETSC_COMM_SELF) 400 401 /*MC 402 PETSC_VIEWER_BINARY_WORLD - same as `PETSC_VIEWER_BINARY_`(PETSC_COMM_WORLD) 403 404 Level: intermediate 405 M*/ 406 #define PETSC_VIEWER_BINARY_WORLD PETSC_VIEWER_BINARY_(PETSC_COMM_WORLD) 407 408 /*MC 409 PETSC_VIEWER_BINARY_SELF - same as `PETSC_VIEWER_BINARY_`(PETSC_COMM_SELF) 410 411 Level: intermediate 412 M*/ 413 #define PETSC_VIEWER_BINARY_SELF PETSC_VIEWER_BINARY_(PETSC_COMM_SELF) 414 415 /*MC 416 PETSC_VIEWER_MATLAB_WORLD - same as `PETSC_VIEWER_MATLAB_`(PETSC_COMM_WORLD) 417 418 Level: intermediate 419 M*/ 420 #define PETSC_VIEWER_MATLAB_WORLD PETSC_VIEWER_MATLAB_(PETSC_COMM_WORLD) 421 422 /*MC 423 PETSC_VIEWER_MATLAB_SELF - same as `PETSC_VIEWER_MATLAB_`(PETSC_COMM_SELF) 424 425 Level: intermediate 426 M*/ 427 #define PETSC_VIEWER_MATLAB_SELF PETSC_VIEWER_MATLAB_(PETSC_COMM_SELF) 428 429 #define PETSC_VIEWER_MATHEMATICA_WORLD (PetscViewerInitializeMathematicaWorld_Private(), PETSC_VIEWER_MATHEMATICA_WORLD_PRIVATE) 430 431 PETSC_EXTERN PetscErrorCode PetscViewerFlowControlStart(PetscViewer, PetscInt *, PetscInt *); 432 PETSC_EXTERN PetscErrorCode PetscViewerFlowControlStepMain(PetscViewer, PetscInt, PetscInt *, PetscInt); 433 PETSC_EXTERN PetscErrorCode PetscViewerFlowControlEndMain(PetscViewer, PetscInt *); 434 PETSC_EXTERN PetscErrorCode PetscViewerFlowControlStepWorker(PetscViewer, PetscMPIInt, PetscInt *); 435 PETSC_EXTERN PetscErrorCode PetscViewerFlowControlEndWorker(PetscViewer, PetscInt *); 436 PETSC_DEPRECATED_FUNCTION(3, 15, 0, "PetscViewerFlowControlStepMain()", ) static inline PetscErrorCode PetscViewerFlowControlStepMaster(PetscViewer viewer, PetscInt i, PetscInt *mcnt, PetscInt cnt) 437 { 438 return PetscViewerFlowControlStepMain(viewer, i, mcnt, cnt); 439 } 440 PETSC_DEPRECATED_FUNCTION(3, 15, 0, "PetscViewerFlowControlEndMain()", ) static inline PetscErrorCode PetscViewerFlowControlEndMaster(PetscViewer viewer, PetscInt *mcnt) 441 { 442 return PetscViewerFlowControlEndMain(viewer, mcnt); 443 } 444 445 /* 446 PetscViewer writes to MATLAB .mat file 447 */ 448 PETSC_EXTERN PetscErrorCode PetscViewerMatlabPutArray(PetscViewer, int, int, const PetscScalar *, const char *); 449 PETSC_EXTERN PetscErrorCode PetscViewerMatlabGetArray(PetscViewer, int, int, PetscScalar *, const char *); 450 PETSC_EXTERN PetscErrorCode PetscViewerMatlabPutVariable(PetscViewer, const char *, void *); 451 452 #if defined(PETSC_HAVE_SAWS) 453 PETSC_EXTERN PetscErrorCode PetscObjectViewSAWs(PetscObject, PetscViewer); 454 #endif 455 456 /*S 457 PetscViewers - Abstract collection of `PetscViewer`s. It is stored as an expandable array of viewers. 458 459 Level: intermediate 460 461 .seealso: [](sec_viewers), `PetscViewerCreate()`, `PetscViewerSetType()`, `PetscViewerType`, `PetscViewer`, `PetscViewersCreate()`, 462 `PetscViewersGetViewer()` 463 S*/ 464 typedef struct _n_PetscViewers *PetscViewers; 465 PETSC_EXTERN PetscErrorCode PetscViewersCreate(MPI_Comm, PetscViewers *); 466 PETSC_EXTERN PetscErrorCode PetscViewersDestroy(PetscViewers *); 467 PETSC_EXTERN PetscErrorCode PetscViewersGetViewer(PetscViewers, PetscInt, PetscViewer *); 468