1 /* 2 PetscViewers are objects where other objects can be looked at or stored. 3 */ 4 #ifndef PETSCVIEWER_H 5 #define PETSCVIEWER_H 6 7 #include <petscsys.h> 8 #include <petscviewertypes.h> 9 #include <petscdrawtypes.h> 10 11 /* SUBMANSEC = Viewer */ 12 13 PETSC_EXTERN PetscClassId PETSC_VIEWER_CLASSID; 14 15 /*J 16 PetscViewerType - String with the name of a PETSc `PetscViewer` implementation 17 18 Level: beginner 19 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" 38 39 PETSC_EXTERN PetscFunctionList PetscViewerList; 40 PETSC_EXTERN PetscErrorCode PetscViewerInitializePackage(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 GLVis viewer to use 81 82 Level: beginner 83 84 .seealso: [](sec_viewers), `PetscViewerGLVisOpen()` 85 E*/ 86 typedef enum { 87 PETSC_VIEWER_GLVIS_DUMP, 88 PETSC_VIEWER_GLVIS_SOCKET 89 } PetscViewerGLVisType; 90 PETSC_EXTERN PetscErrorCode PetscViewerGLVisOpen(MPI_Comm, PetscViewerGLVisType, const char *, PetscInt, PetscViewer *); 91 PETSC_EXTERN PetscErrorCode PetscViewerGLVisSetPrecision(PetscViewer, PetscInt); 92 PETSC_EXTERN PetscErrorCode PetscViewerGLVisSetSnapId(PetscViewer, PetscInt); 93 PETSC_EXTERN PetscErrorCode PetscViewerGLVisSetFields(PetscViewer, PetscInt, const char *[], PetscInt[], PetscErrorCode (*)(PetscObject, PetscInt, PetscObject[], void *), PetscObject[], void *, PetscErrorCode (*)(void *)); 94 95 PETSC_EXTERN PetscErrorCode PetscViewerGetType(PetscViewer, PetscViewerType *); 96 PETSC_EXTERN PetscErrorCode PetscViewerSetType(PetscViewer, PetscViewerType); 97 PETSC_EXTERN PetscErrorCode PetscViewerDestroy(PetscViewer *); 98 PETSC_EXTERN PetscErrorCode PetscViewerGetSubViewer(PetscViewer, MPI_Comm, PetscViewer *); 99 PETSC_EXTERN PetscErrorCode PetscViewerRestoreSubViewer(PetscViewer, MPI_Comm, PetscViewer *); 100 101 PETSC_EXTERN PetscErrorCode PetscViewerSetUp(PetscViewer); 102 PETSC_EXTERN PetscErrorCode PetscViewerView(PetscViewer, PetscViewer); 103 PETSC_EXTERN PetscErrorCode PetscViewerViewFromOptions(PetscViewer, PetscObject, const char[]); 104 105 PETSC_EXTERN PetscErrorCode PetscViewerSetOptionsPrefix(PetscViewer, const char[]); 106 PETSC_EXTERN PetscErrorCode PetscViewerAppendOptionsPrefix(PetscViewer, const char[]); 107 PETSC_EXTERN PetscErrorCode PetscViewerGetOptionsPrefix(PetscViewer, const char *[]); 108 109 PETSC_EXTERN PetscErrorCode PetscViewerReadable(PetscViewer, PetscBool *); 110 PETSC_EXTERN PetscErrorCode PetscViewerWritable(PetscViewer, PetscBool *); 111 PETSC_EXTERN PetscErrorCode PetscViewerCheckReadable(PetscViewer); 112 PETSC_EXTERN PetscErrorCode PetscViewerCheckWritable(PetscViewer); 113 114 #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)") 115 #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)") 116 #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)") 117 /*E 118 PetscViewerFormat - Way a viewer presents the object 119 120 Level: beginner 121 122 .seealso: [](sec_viewers), `PetscViewer`, `PetscViewerType`, `PetscViewerPushFormat()`, `PetscViewerPopFormat()` 123 E*/ 124 typedef enum { 125 PETSC_VIEWER_DEFAULT, 126 PETSC_VIEWER_ASCII_MATLAB, 127 PETSC_VIEWER_ASCII_MATHEMATICA, 128 PETSC_VIEWER_ASCII_IMPL, 129 PETSC_VIEWER_ASCII_INFO, 130 PETSC_VIEWER_ASCII_INFO_DETAIL, 131 PETSC_VIEWER_ASCII_COMMON, 132 PETSC_VIEWER_ASCII_SYMMODU, 133 PETSC_VIEWER_ASCII_INDEX, 134 PETSC_VIEWER_ASCII_DENSE, 135 PETSC_VIEWER_ASCII_MATRIXMARKET, 136 PETSC_VIEWER_ASCII_VTK_DEPRECATED, 137 PETSC_VIEWER_ASCII_VTK_ATTR = PETSC_VIEWER_ASCII_VTK_DEPRECATED, 138 PETSC_VIEWER_ASCII_VTK_CELL_DEPRECATED, 139 PETSC_VIEWER_ASCII_VTK_CELL_ATTR = PETSC_VIEWER_ASCII_VTK_CELL_DEPRECATED, 140 PETSC_VIEWER_ASCII_VTK_COORDS_DEPRECATED, 141 PETSC_VIEWER_ASCII_VTK_COORDS_ATTR = PETSC_VIEWER_ASCII_VTK_COORDS_DEPRECATED, 142 PETSC_VIEWER_ASCII_PCICE, 143 PETSC_VIEWER_ASCII_PYTHON, 144 PETSC_VIEWER_ASCII_FACTOR_INFO, 145 PETSC_VIEWER_ASCII_LATEX, 146 PETSC_VIEWER_ASCII_XML, 147 PETSC_VIEWER_ASCII_FLAMEGRAPH, 148 PETSC_VIEWER_ASCII_GLVIS, 149 PETSC_VIEWER_ASCII_CSV, 150 PETSC_VIEWER_DRAW_BASIC, 151 PETSC_VIEWER_DRAW_LG, 152 PETSC_VIEWER_DRAW_LG_XRANGE, 153 PETSC_VIEWER_DRAW_CONTOUR, 154 PETSC_VIEWER_DRAW_PORTS, 155 PETSC_VIEWER_VTK_VTS, 156 PETSC_VIEWER_VTK_VTR, 157 PETSC_VIEWER_VTK_VTU, 158 PETSC_VIEWER_BINARY_MATLAB, 159 PETSC_VIEWER_NATIVE, 160 PETSC_VIEWER_HDF5_PETSC, 161 PETSC_VIEWER_HDF5_VIZ, 162 PETSC_VIEWER_HDF5_XDMF, 163 PETSC_VIEWER_HDF5_MAT, 164 PETSC_VIEWER_NOFORMAT, 165 PETSC_VIEWER_LOAD_BALANCE, 166 PETSC_VIEWER_FAILED, 167 PETSC_VIEWER_ALL 168 } PetscViewerFormat; 169 PETSC_EXTERN const char *const PetscViewerFormats[]; 170 171 PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use PetscViewerPushFormat()/PetscViewerPopFormat()") PetscErrorCode PetscViewerSetFormat(PetscViewer, PetscViewerFormat); 172 PETSC_EXTERN PetscErrorCode PetscViewerPushFormat(PetscViewer, PetscViewerFormat); 173 PETSC_EXTERN PetscErrorCode PetscViewerPopFormat(PetscViewer); 174 PETSC_EXTERN PetscErrorCode PetscViewerGetFormat(PetscViewer, PetscViewerFormat *); 175 PETSC_EXTERN PetscErrorCode PetscViewerFlush(PetscViewer); 176 177 PETSC_EXTERN PetscErrorCode PetscOptionsPushGetViewerOff(PetscBool); 178 PETSC_EXTERN PetscErrorCode PetscOptionsPopGetViewerOff(void); 179 PETSC_EXTERN PetscErrorCode PetscOptionsGetViewerOff(PetscBool *); 180 PETSC_EXTERN PetscErrorCode PetscOptionsGetViewer(MPI_Comm, PetscOptions, const char[], const char[], PetscViewer *, PetscViewerFormat *, PetscBool *); 181 #define PetscOptionsViewer(a, b, c, d, e, f) PetscOptionsViewer_Private(PetscOptionsObject, a, b, c, d, e, f) 182 PETSC_EXTERN PetscErrorCode PetscOptionsViewer_Private(PetscOptionItems *, const char[], const char[], const char[], PetscViewer *, PetscViewerFormat *, PetscBool *); 183 184 typedef struct { 185 PetscViewer viewer; 186 PetscViewerFormat format; 187 PetscDrawLG lg; 188 PetscInt view_interval; 189 void *data; 190 } PetscViewerAndFormat; 191 PETSC_EXTERN PetscErrorCode PetscViewerAndFormatCreate(PetscViewer, PetscViewerFormat, PetscViewerAndFormat **); 192 PETSC_EXTERN PetscErrorCode PetscViewerAndFormatDestroy(PetscViewerAndFormat **); 193 194 /* 195 Operations explicit to a particular class of viewers 196 */ 197 198 PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetPointer(PetscViewer, FILE **); 199 PETSC_EXTERN PetscErrorCode PetscViewerFileGetMode(PetscViewer, PetscFileMode *); 200 PETSC_EXTERN PetscErrorCode PetscViewerFileSetMode(PetscViewer, PetscFileMode); 201 PETSC_EXTERN PetscErrorCode PetscViewerRead(PetscViewer, void *, PetscInt, PetscInt *, PetscDataType); 202 PETSC_EXTERN PetscErrorCode PetscViewerASCIIPrintf(PetscViewer, const char[], ...) PETSC_ATTRIBUTE_FORMAT(2, 3); 203 PETSC_EXTERN PetscErrorCode PetscViewerASCIISynchronizedPrintf(PetscViewer, const char[], ...) PETSC_ATTRIBUTE_FORMAT(2, 3); 204 PETSC_EXTERN PetscErrorCode PetscViewerASCIIPushSynchronized(PetscViewer); 205 PETSC_EXTERN PetscErrorCode PetscViewerASCIIPopSynchronized(PetscViewer); 206 PETSC_EXTERN PetscErrorCode PetscViewerASCIIPushTab(PetscViewer); 207 PETSC_EXTERN PetscErrorCode PetscViewerASCIIPopTab(PetscViewer); 208 PETSC_EXTERN PetscErrorCode PetscViewerASCIIUseTabs(PetscViewer, PetscBool); 209 PETSC_EXTERN PetscErrorCode PetscViewerASCIISetTab(PetscViewer, PetscInt); 210 PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetTab(PetscViewer, PetscInt *); 211 PETSC_EXTERN PetscErrorCode PetscViewerASCIIAddTab(PetscViewer, PetscInt); 212 PETSC_EXTERN PetscErrorCode PetscViewerASCIISubtractTab(PetscViewer, PetscInt); 213 PETSC_EXTERN PetscErrorCode PetscViewerASCIIRead(PetscViewer, void *, PetscInt, PetscInt *, PetscDataType); 214 PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetDescriptor(PetscViewer, int *); 215 PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetInfoPointer(PetscViewer, FILE **); 216 PETSC_EXTERN PetscErrorCode PetscViewerBinaryRead(PetscViewer, void *, PetscInt, PetscInt *, PetscDataType); 217 PETSC_EXTERN PetscErrorCode PetscViewerBinaryWrite(PetscViewer, const void *, PetscInt, PetscDataType); 218 PETSC_EXTERN PetscErrorCode PetscViewerBinaryReadAll(PetscViewer, void *, PetscInt, PetscInt, PetscInt, PetscDataType); 219 PETSC_EXTERN PetscErrorCode PetscViewerBinaryWriteAll(PetscViewer, const void *, PetscInt, PetscInt, PetscInt, PetscDataType); 220 PETSC_EXTERN PetscErrorCode PetscViewerStringSPrintf(PetscViewer, const char[], ...) PETSC_ATTRIBUTE_FORMAT(2, 3); 221 PETSC_EXTERN PetscErrorCode PetscViewerStringSetString(PetscViewer, char[], size_t); 222 PETSC_EXTERN PetscErrorCode PetscViewerStringGetStringRead(PetscViewer, const char *[], size_t *); 223 PETSC_EXTERN PetscErrorCode PetscViewerStringSetOwnString(PetscViewer); 224 PETSC_EXTERN PetscErrorCode PetscViewerDrawClear(PetscViewer); 225 PETSC_EXTERN PetscErrorCode PetscViewerDrawSetHold(PetscViewer, PetscBool); 226 PETSC_EXTERN PetscErrorCode PetscViewerDrawGetHold(PetscViewer, PetscBool *); 227 PETSC_EXTERN PetscErrorCode PetscViewerDrawSetPause(PetscViewer, PetscReal); 228 PETSC_EXTERN PetscErrorCode PetscViewerDrawGetPause(PetscViewer, PetscReal *); 229 PETSC_EXTERN PetscErrorCode PetscViewerDrawSetInfo(PetscViewer, const char[], const char[], int, int, int, int); 230 PETSC_EXTERN PetscErrorCode PetscViewerDrawResize(PetscViewer, int, int); 231 PETSC_EXTERN PetscErrorCode PetscViewerDrawSetBounds(PetscViewer, PetscInt, const PetscReal *); 232 PETSC_EXTERN PetscErrorCode PetscViewerDrawGetBounds(PetscViewer, PetscInt *, const PetscReal **); 233 PETSC_EXTERN PetscErrorCode PetscViewerSocketSetConnection(PetscViewer, const char[], int); 234 PETSC_EXTERN PetscErrorCode PetscViewerBinarySkipInfo(PetscViewer); 235 PETSC_EXTERN PetscErrorCode PetscViewerBinarySetSkipInfo(PetscViewer, PetscBool); 236 PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetSkipInfo(PetscViewer, PetscBool *); 237 PETSC_EXTERN PetscErrorCode PetscViewerBinarySetSkipOptions(PetscViewer, PetscBool); 238 PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetSkipOptions(PetscViewer, PetscBool *); 239 PETSC_EXTERN PetscErrorCode PetscViewerBinarySetSkipHeader(PetscViewer, PetscBool); 240 PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetSkipHeader(PetscViewer, PetscBool *); 241 PETSC_EXTERN PetscErrorCode PetscViewerBinaryReadStringArray(PetscViewer, char ***); 242 PETSC_EXTERN PetscErrorCode PetscViewerBinaryWriteStringArray(PetscViewer, const char *const *); 243 244 PETSC_EXTERN PetscErrorCode PetscViewerFileSetName(PetscViewer, const char[]); 245 PETSC_EXTERN PetscErrorCode PetscViewerFileGetName(PetscViewer, const char **); 246 247 PETSC_EXTERN PetscErrorCode PetscViewerVUGetPointer(PetscViewer, FILE **); 248 PETSC_EXTERN PetscErrorCode PetscViewerVUSetVecSeen(PetscViewer, PetscBool); 249 PETSC_EXTERN PetscErrorCode PetscViewerVUGetVecSeen(PetscViewer, PetscBool *); 250 PETSC_EXTERN PetscErrorCode PetscViewerVUPrintDeferred(PetscViewer, const char[], ...) PETSC_ATTRIBUTE_FORMAT(2, 3); 251 PETSC_EXTERN PetscErrorCode PetscViewerVUFlushDeferred(PetscViewer); 252 253 /*@C 254 PetscViewerVUSetMode - Sets the mode in which to open the file. 255 256 Not Collective 257 258 Input Parameters: 259 + viewer - The `PetscViewer` 260 - mode - The file mode 261 262 Level: deprecated 263 264 Note: 265 Use `PetscViewerFileSetMode()` instead. 266 267 .seealso: [](sec_viewers), `PetscViewerFileSetMode()` 268 @*/ 269 PETSC_DEPRECATED_FUNCTION("Use PetscViewerFileSetMode (since v3.15)") static inline PetscErrorCode PetscViewerVUSetMode(PetscViewer viewer, PetscFileMode mode) 270 { 271 return PetscViewerFileSetMode(viewer, mode); 272 } 273 274 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaInitializePackage(void); 275 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaFinalizePackage(void); 276 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaGetName(PetscViewer, const char **); 277 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaSetName(PetscViewer, const char[]); 278 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaClearName(PetscViewer); 279 PETSC_EXTERN PetscErrorCode PetscViewerMathematicaSkipPackets(PetscViewer, int); 280 281 PETSC_EXTERN PetscErrorCode PetscViewerSiloGetName(PetscViewer, char **); 282 PETSC_EXTERN PetscErrorCode PetscViewerSiloSetName(PetscViewer, const char[]); 283 PETSC_EXTERN PetscErrorCode PetscViewerSiloClearName(PetscViewer); 284 PETSC_EXTERN PetscErrorCode PetscViewerSiloGetMeshName(PetscViewer, char **); 285 PETSC_EXTERN PetscErrorCode PetscViewerSiloSetMeshName(PetscViewer, const char[]); 286 PETSC_EXTERN PetscErrorCode PetscViewerSiloClearMeshName(PetscViewer); 287 288 typedef enum { 289 PETSC_VTK_INVALID, 290 PETSC_VTK_POINT_FIELD, 291 PETSC_VTK_POINT_VECTOR_FIELD, 292 PETSC_VTK_CELL_FIELD, 293 PETSC_VTK_CELL_VECTOR_FIELD 294 } PetscViewerVTKFieldType; 295 PETSC_EXTERN PetscErrorCode PetscViewerVTKAddField(PetscViewer, PetscObject, PetscErrorCode (*PetscViewerVTKWriteFunction)(PetscObject, PetscViewer), PetscInt, PetscViewerVTKFieldType, PetscBool, PetscObject); 296 PETSC_EXTERN PetscErrorCode PetscViewerVTKGetDM(PetscViewer, PetscObject *); 297 PETSC_EXTERN PetscErrorCode PetscViewerVTKOpen(MPI_Comm, const char[], PetscFileMode, PetscViewer *); 298 299 /* 300 These are all the default viewers that do not have to be explicitly opened 301 */ 302 PETSC_EXTERN PetscViewer PETSC_VIEWER_STDOUT_(MPI_Comm); 303 PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetStdout(MPI_Comm, PetscViewer *); 304 PETSC_EXTERN PetscViewer PETSC_VIEWER_STDERR_(MPI_Comm); 305 PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetStderr(MPI_Comm, PetscViewer *); 306 PETSC_EXTERN PetscViewer PETSC_VIEWER_DRAW_(MPI_Comm); 307 PETSC_EXTERN PetscViewer PETSC_VIEWER_SOCKET_(MPI_Comm); 308 PETSC_EXTERN PetscViewer PETSC_VIEWER_BINARY_(MPI_Comm); 309 PETSC_EXTERN PetscViewer PETSC_VIEWER_MATLAB_(MPI_Comm); 310 PETSC_EXTERN PetscViewer PETSC_VIEWER_HDF5_(MPI_Comm); 311 PETSC_EXTERN PetscViewer PETSC_VIEWER_GLVIS_(MPI_Comm); 312 PETSC_EXTERN PetscViewer PETSC_VIEWER_EXODUSII_(MPI_Comm); 313 PETSC_EXTERN PetscViewer PETSC_VIEWER_MATHEMATICA_WORLD_PRIVATE; 314 315 /*MC 316 PETSC_VIEWER_STDERR_SELF - same as `PETSC_VIEWER_STDERR_`(PETSC_COMM_SELF) 317 318 Level: beginner 319 M*/ 320 #define PETSC_VIEWER_STDERR_SELF PETSC_VIEWER_STDERR_(PETSC_COMM_SELF) 321 322 /*MC 323 PETSC_VIEWER_STDERR_WORLD - same as `PETSC_VIEWER_STDERR_`(PETSC_COMM_WORLD) 324 325 Level: beginner 326 M*/ 327 #define PETSC_VIEWER_STDERR_WORLD PETSC_VIEWER_STDERR_(PETSC_COMM_WORLD) 328 329 /*MC 330 PETSC_VIEWER_STDOUT_WORLD - same as `PETSC_VIEWER_STDOUT_`(PETSC_COMM_WORLD) 331 332 Level: beginner 333 M*/ 334 #define PETSC_VIEWER_STDOUT_WORLD PETSC_VIEWER_STDOUT_(PETSC_COMM_WORLD) 335 336 /*MC 337 PETSC_VIEWER_STDOUT_SELF - same as `PETSC_VIEWER_STDOUT_`(PETSC_COMM_SELF) 338 339 Level: beginner 340 M*/ 341 #define PETSC_VIEWER_STDOUT_SELF PETSC_VIEWER_STDOUT_(PETSC_COMM_SELF) 342 343 /*MC 344 PETSC_VIEWER_DRAW_WORLD - same as `PETSC_VIEWER_DRAW_`(PETSC_COMM_WORLD) 345 346 Level: intermediate 347 M*/ 348 #define PETSC_VIEWER_DRAW_WORLD PETSC_VIEWER_DRAW_(PETSC_COMM_WORLD) 349 350 /*MC 351 PETSC_VIEWER_DRAW_SELF - same as `PETSC_VIEWER_DRAW_`(PETSC_COMM_SELF) 352 353 Level: intermediate 354 M*/ 355 #define PETSC_VIEWER_DRAW_SELF PETSC_VIEWER_DRAW_(PETSC_COMM_SELF) 356 357 /*MC 358 PETSC_VIEWER_SOCKET_WORLD - same as `PETSC_VIEWER_SOCKET_`(PETSC_COMM_WORLD) 359 360 Level: intermediate 361 M*/ 362 #define PETSC_VIEWER_SOCKET_WORLD PETSC_VIEWER_SOCKET_(PETSC_COMM_WORLD) 363 364 /*MC 365 PETSC_VIEWER_SOCKET_SELF - same as `PETSC_VIEWER_SOCKET_`(PETSC_COMM_SELF) 366 367 Level: intermediate 368 M*/ 369 #define PETSC_VIEWER_SOCKET_SELF PETSC_VIEWER_SOCKET_(PETSC_COMM_SELF) 370 371 /*MC 372 PETSC_VIEWER_BINARY_WORLD - same as `PETSC_VIEWER_BINARY_`(PETSC_COMM_WORLD) 373 374 Level: intermediate 375 M*/ 376 #define PETSC_VIEWER_BINARY_WORLD PETSC_VIEWER_BINARY_(PETSC_COMM_WORLD) 377 378 /*MC 379 PETSC_VIEWER_BINARY_SELF - same as `PETSC_VIEWER_BINARY_`(PETSC_COMM_SELF) 380 381 Level: intermediate 382 M*/ 383 #define PETSC_VIEWER_BINARY_SELF PETSC_VIEWER_BINARY_(PETSC_COMM_SELF) 384 385 /*MC 386 PETSC_VIEWER_MATLAB_WORLD - same as `PETSC_VIEWER_MATLAB_`(PETSC_COMM_WORLD) 387 388 Level: intermediate 389 M*/ 390 #define PETSC_VIEWER_MATLAB_WORLD PETSC_VIEWER_MATLAB_(PETSC_COMM_WORLD) 391 392 /*MC 393 PETSC_VIEWER_MATLAB_SELF - same as `PETSC_VIEWER_MATLAB_`(PETSC_COMM_SELF) 394 395 Level: intermediate 396 M*/ 397 #define PETSC_VIEWER_MATLAB_SELF PETSC_VIEWER_MATLAB_(PETSC_COMM_SELF) 398 399 #define PETSC_VIEWER_MATHEMATICA_WORLD (PetscViewerInitializeMathematicaWorld_Private(), PETSC_VIEWER_MATHEMATICA_WORLD_PRIVATE) 400 401 PETSC_EXTERN PetscErrorCode PetscViewerFlowControlStart(PetscViewer, PetscInt *, PetscInt *); 402 PETSC_EXTERN PetscErrorCode PetscViewerFlowControlStepMain(PetscViewer, PetscInt, PetscInt *, PetscInt); 403 PETSC_EXTERN PetscErrorCode PetscViewerFlowControlEndMain(PetscViewer, PetscInt *); 404 PETSC_EXTERN PetscErrorCode PetscViewerFlowControlStepWorker(PetscViewer, PetscMPIInt, PetscInt *); 405 PETSC_EXTERN PetscErrorCode PetscViewerFlowControlEndWorker(PetscViewer, PetscInt *); 406 PETSC_DEPRECATED_FUNCTION("Use PetscViewerFlowControlStepMain (since v3.15)") static inline PetscErrorCode PetscViewerFlowControlStepMaster(PetscViewer viewer, PetscInt i, PetscInt *mcnt, PetscInt cnt) 407 { 408 return PetscViewerFlowControlStepMain(viewer, i, mcnt, cnt); 409 } 410 PETSC_DEPRECATED_FUNCTION("Use PetscViewerFlowControlEndMain (since v3.15)") static inline PetscErrorCode PetscViewerFlowControlEndMaster(PetscViewer viewer, PetscInt *mcnt) 411 { 412 return PetscViewerFlowControlEndMain(viewer, mcnt); 413 } 414 415 /* 416 PetscViewer writes to MATLAB .mat file 417 */ 418 PETSC_EXTERN PetscErrorCode PetscViewerMatlabPutArray(PetscViewer, int, int, const PetscScalar *, const char *); 419 PETSC_EXTERN PetscErrorCode PetscViewerMatlabGetArray(PetscViewer, int, int, PetscScalar *, const char *); 420 PETSC_EXTERN PetscErrorCode PetscViewerMatlabPutVariable(PetscViewer, const char *, void *); 421 422 #if defined(PETSC_HAVE_SAWS) 423 PETSC_EXTERN PetscErrorCode PetscObjectViewSAWs(PetscObject, PetscViewer); 424 #endif 425 426 /*S 427 PetscViewers - Abstract collection of `PetscViewer`s. It is just an expandable array of viewers. 428 429 Level: intermediate 430 431 .seealso: [](sec_viewers), `PetscViewerCreate()`, `PetscViewerSetType()`, `PetscViewerType`, `PetscViewer`, `PetscViewersCreate()`, 432 `PetscViewersGetViewer()` 433 S*/ 434 typedef struct _n_PetscViewers *PetscViewers; 435 PETSC_EXTERN PetscErrorCode PetscViewersCreate(MPI_Comm, PetscViewers *); 436 PETSC_EXTERN PetscErrorCode PetscViewersDestroy(PetscViewers *); 437 PETSC_EXTERN PetscErrorCode PetscViewersGetViewer(PetscViewers, PetscInt, PetscViewer *); 438 439 #endif 440