Actual source code: petscviewer.h

  1: /*
  2:      PetscViewers are objects where other objects can be looked at or stored.
  3: */

  5: #if !defined(PETSCVIEWER_H)
  6: #define PETSCVIEWER_H

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

 12: PETSC_EXTERN PetscClassId PETSC_VIEWER_CLASSID;

 14: /*J
 15:     PetscViewerType - String with the name of a PETSc PETScViewer

 17:    Level: beginner

 19: .seealso: 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"

 37: PETSC_EXTERN PetscFunctionList PetscViewerList;
 38: PETSC_EXTERN PetscErrorCode PetscViewerInitializePackage(void);

 40: PETSC_EXTERN PetscErrorCode PetscViewerRegister(const char[],PetscErrorCode (*)(PetscViewer));

 42: PETSC_EXTERN PetscErrorCode PetscViewerCreate(MPI_Comm,PetscViewer*);
 43: PETSC_EXTERN PetscErrorCode PetscViewerSetFromOptions(PetscViewer);
 44: PETSC_EXTERN PetscErrorCode PetscViewerASCIIOpenWithFILE(MPI_Comm,FILE*,PetscViewer*);

 46: PETSC_EXTERN PetscErrorCode PetscViewerASCIIOpen(MPI_Comm,const char[],PetscViewer*);
 47: PETSC_EXTERN PetscErrorCode PetscViewerASCIISetFILE(PetscViewer,FILE*);
 48: PETSC_EXTERN PetscErrorCode PetscViewerBinaryOpen(MPI_Comm,const char[],PetscFileMode,PetscViewer*);
 49: PETSC_EXTERN PetscErrorCode PetscViewerADIOSOpen(MPI_Comm,const char[],PetscFileMode,PetscViewer*);
 50: PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetFlowControl(PetscViewer,PetscInt*);
 51: PETSC_EXTERN PetscErrorCode PetscViewerBinarySetFlowControl(PetscViewer,PetscInt);
 52: PETSC_EXTERN PetscErrorCode PetscViewerBinarySetUseMPIIO(PetscViewer,PetscBool);
 53: PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetUseMPIIO(PetscViewer,PetscBool *);
 54: #if defined(PETSC_HAVE_MPIIO)
 55: PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetMPIIODescriptor(PetscViewer,MPI_File*);
 56: PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetMPIIOOffset(PetscViewer,MPI_Offset*);
 57: PETSC_EXTERN PetscErrorCode PetscViewerBinaryAddMPIIOOffset(PetscViewer,MPI_Offset);
 58: #endif

 60: PETSC_EXTERN PetscErrorCode PetscViewerSocketOpen(MPI_Comm,const char[],int,PetscViewer*);
 61: PETSC_EXTERN PetscErrorCode PetscViewerStringOpen(MPI_Comm,char[],size_t,PetscViewer*);
 62: PETSC_EXTERN PetscErrorCode PetscViewerDrawOpen(MPI_Comm,const char[],const char[],int,int,int,int,PetscViewer*);
 63: PETSC_EXTERN PetscErrorCode PetscViewerDrawSetDrawType(PetscViewer,PetscDrawType);
 64: PETSC_EXTERN PetscErrorCode PetscViewerDrawGetDrawType(PetscViewer,PetscDrawType*);
 65: PETSC_EXTERN PetscErrorCode PetscViewerDrawSetTitle(PetscViewer,const char[]);
 66: PETSC_EXTERN PetscErrorCode PetscViewerDrawGetTitle(PetscViewer,const char*[]);
 67: PETSC_EXTERN PetscErrorCode PetscViewerDrawGetDraw(PetscViewer,PetscInt,PetscDraw*);
 68: PETSC_EXTERN PetscErrorCode PetscViewerDrawBaseAdd(PetscViewer,PetscInt);
 69: PETSC_EXTERN PetscErrorCode PetscViewerDrawBaseSet(PetscViewer,PetscInt);
 70: PETSC_EXTERN PetscErrorCode PetscViewerDrawGetDrawLG(PetscViewer,PetscInt,PetscDrawLG*);
 71: PETSC_EXTERN PetscErrorCode PetscViewerDrawGetDrawAxis(PetscViewer,PetscInt,PetscDrawAxis*);

 73: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaOpen(MPI_Comm, int, const char[], const char[], PetscViewer *);
 74: PETSC_EXTERN PetscErrorCode PetscViewerSiloOpen(MPI_Comm, const char[], PetscViewer *);
 75: PETSC_EXTERN PetscErrorCode PetscViewerMatlabOpen(MPI_Comm,const char[],PetscFileMode,PetscViewer*);

 77: /*E
 78:     PetscViewerGLVisType - indicates what type of GLVis viewer to use

 80:     Level: beginner

 82: .seealso: PetscViewerGLVisOpen()
 83: E*/
 84: typedef enum {PETSC_VIEWER_GLVIS_DUMP, PETSC_VIEWER_GLVIS_SOCKET} PetscViewerGLVisType;
 85: PETSC_EXTERN PetscErrorCode PetscViewerGLVisOpen(MPI_Comm,PetscViewerGLVisType,const char*,PetscInt,PetscViewer*);
 86: PETSC_EXTERN PetscErrorCode PetscViewerGLVisSetPrecision(PetscViewer,PetscInt);
 87: PETSC_EXTERN PetscErrorCode PetscViewerGLVisSetSnapId(PetscViewer,PetscInt);
 88: PETSC_EXTERN PetscErrorCode PetscViewerGLVisSetFields(PetscViewer,PetscInt,const char*[],PetscInt[],PetscErrorCode(*)(PetscObject,PetscInt,PetscObject[],void*),PetscObject[],void*,PetscErrorCode(*)(void*));

 90: PETSC_EXTERN PetscErrorCode PetscViewerGetType(PetscViewer,PetscViewerType*);
 91: PETSC_EXTERN PetscErrorCode PetscViewerSetType(PetscViewer,PetscViewerType);
 92: PETSC_EXTERN PetscErrorCode PetscViewerDestroy(PetscViewer*);
 93: PETSC_EXTERN PetscErrorCode PetscViewerGetSubViewer(PetscViewer,MPI_Comm,PetscViewer*);
 94: PETSC_EXTERN PetscErrorCode PetscViewerRestoreSubViewer(PetscViewer,MPI_Comm,PetscViewer*);

 96: PETSC_EXTERN PetscErrorCode PetscViewerSetUp(PetscViewer);
 97: PETSC_EXTERN PetscErrorCode PetscViewerView(PetscViewer,PetscViewer);
 98: PETSC_EXTERN PetscErrorCode PetscViewerViewFromOptions(PetscViewer,PetscObject,const char[]);

100: PETSC_EXTERN PetscErrorCode PetscViewerSetOptionsPrefix(PetscViewer,const char[]);
101: PETSC_EXTERN PetscErrorCode PetscViewerAppendOptionsPrefix(PetscViewer,const char[]);
102: PETSC_EXTERN PetscErrorCode PetscViewerGetOptionsPrefix(PetscViewer,const char*[]);

104: PETSC_EXTERN PetscErrorCode PetscViewerReadable(PetscViewer,PetscBool*);
105: PETSC_EXTERN PetscErrorCode PetscViewerWritable(PetscViewer,PetscBool*);
106: PETSC_EXTERN PetscErrorCode PetscViewerCheckReadable(PetscViewer);
107: PETSC_EXTERN PetscErrorCode PetscViewerCheckWritable(PetscViewer);

109: #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)")
110: #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)")
111: #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)")
112: /*E
113:     PetscViewerFormat - Way a viewer presents the object

115:    Level: beginner

117: .seealso: PetscViewer, PetscViewerType, PetscViewerPushFormat(), PetscViewerPopFormat()
118: E*/
119: typedef enum {
120:   PETSC_VIEWER_DEFAULT,
121:   PETSC_VIEWER_ASCII_MATLAB,
122:   PETSC_VIEWER_ASCII_MATHEMATICA,
123:   PETSC_VIEWER_ASCII_IMPL,
124:   PETSC_VIEWER_ASCII_INFO,
125:   PETSC_VIEWER_ASCII_INFO_DETAIL,
126:   PETSC_VIEWER_ASCII_COMMON,
127:   PETSC_VIEWER_ASCII_SYMMODU,
128:   PETSC_VIEWER_ASCII_INDEX,
129:   PETSC_VIEWER_ASCII_DENSE,
130:   PETSC_VIEWER_ASCII_MATRIXMARKET,
131:   PETSC_VIEWER_ASCII_VTK_DEPRECATED,
132:   PETSC_VIEWER_ASCII_VTK_ATTR = PETSC_VIEWER_ASCII_VTK_DEPRECATED,
133:   PETSC_VIEWER_ASCII_VTK_CELL_DEPRECATED,
134:   PETSC_VIEWER_ASCII_VTK_CELL_ATTR = PETSC_VIEWER_ASCII_VTK_CELL_DEPRECATED,
135:   PETSC_VIEWER_ASCII_VTK_COORDS_DEPRECATED,
136:   PETSC_VIEWER_ASCII_VTK_COORDS_ATTR = PETSC_VIEWER_ASCII_VTK_COORDS_DEPRECATED,
137:   PETSC_VIEWER_ASCII_PCICE,
138:   PETSC_VIEWER_ASCII_PYTHON,
139:   PETSC_VIEWER_ASCII_FACTOR_INFO,
140:   PETSC_VIEWER_ASCII_LATEX,
141:   PETSC_VIEWER_ASCII_XML,
142:   PETSC_VIEWER_ASCII_FLAMEGRAPH,
143:   PETSC_VIEWER_ASCII_GLVIS,
144:   PETSC_VIEWER_ASCII_CSV,
145:   PETSC_VIEWER_DRAW_BASIC,
146:   PETSC_VIEWER_DRAW_LG,
147:   PETSC_VIEWER_DRAW_LG_XRANGE,
148:   PETSC_VIEWER_DRAW_CONTOUR,
149:   PETSC_VIEWER_DRAW_PORTS,
150:   PETSC_VIEWER_VTK_VTS,
151:   PETSC_VIEWER_VTK_VTR,
152:   PETSC_VIEWER_VTK_VTU,
153:   PETSC_VIEWER_BINARY_MATLAB,
154:   PETSC_VIEWER_NATIVE,
155:   PETSC_VIEWER_HDF5_PETSC,
156:   PETSC_VIEWER_HDF5_VIZ,
157:   PETSC_VIEWER_HDF5_XDMF,
158:   PETSC_VIEWER_HDF5_MAT,
159:   PETSC_VIEWER_NOFORMAT,
160:   PETSC_VIEWER_LOAD_BALANCE,
161:   PETSC_VIEWER_FAILED
162:   } PetscViewerFormat;
163: PETSC_EXTERN const char *const PetscViewerFormats[];

165: PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use PetscViewerPushFormat()/PetscViewerPopFormat()") PetscErrorCode PetscViewerSetFormat(PetscViewer,PetscViewerFormat);
166: PETSC_EXTERN PetscErrorCode PetscViewerPushFormat(PetscViewer,PetscViewerFormat);
167: PETSC_EXTERN PetscErrorCode PetscViewerPopFormat(PetscViewer);
168: PETSC_EXTERN PetscErrorCode PetscViewerGetFormat(PetscViewer,PetscViewerFormat*);
169: PETSC_EXTERN PetscErrorCode PetscViewerFlush(PetscViewer);

171: PETSC_EXTERN PetscErrorCode PetscOptionsPushGetViewerOff(PetscBool);
172: PETSC_EXTERN PetscErrorCode PetscOptionsPopGetViewerOff(void);
173: PETSC_EXTERN PetscErrorCode PetscOptionsGetViewerOff(PetscBool*);
174: PETSC_EXTERN PetscErrorCode PetscOptionsGetViewer(MPI_Comm,PetscOptions,const char[],const char[],PetscViewer*,PetscViewerFormat*,PetscBool*);
175: #define PetscOptionsViewer(a,b,c,d,e,f) PetscOptionsViewer_Private(PetscOptionsObject,a,b,c,d,e,f)
176: PETSC_EXTERN PetscErrorCode PetscOptionsViewer_Private(PetscOptionItems*,const char[],const char[],const char[],PetscViewer*,PetscViewerFormat *,PetscBool *);

178: typedef struct {PetscViewer viewer;PetscViewerFormat format;PetscDrawLG lg;void *data;} PetscViewerAndFormat;
179: PETSC_EXTERN PetscErrorCode PetscViewerAndFormatCreate(PetscViewer,PetscViewerFormat,PetscViewerAndFormat**);
180: PETSC_EXTERN PetscErrorCode PetscViewerAndFormatDestroy(PetscViewerAndFormat**);

182: /*
183:    Operations explicit to a particular class of viewers
184: */

186: PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetPointer(PetscViewer,FILE**);
187: PETSC_EXTERN PetscErrorCode PetscViewerFileGetMode(PetscViewer,PetscFileMode*);
188: PETSC_EXTERN PetscErrorCode PetscViewerFileSetMode(PetscViewer,PetscFileMode);
189: PETSC_EXTERN PetscErrorCode PetscViewerRead(PetscViewer,void*,PetscInt,PetscInt*,PetscDataType);
190: PETSC_EXTERN PetscErrorCode PetscViewerASCIIPrintf(PetscViewer,const char[],...) PETSC_ATTRIBUTE_FORMAT(2,3);
191: PETSC_EXTERN PetscErrorCode PetscViewerASCIISynchronizedPrintf(PetscViewer,const char[],...) PETSC_ATTRIBUTE_FORMAT(2,3);
192: PETSC_EXTERN PetscErrorCode PetscViewerASCIIPushSynchronized(PetscViewer);
193: PETSC_EXTERN PetscErrorCode PetscViewerASCIIPopSynchronized(PetscViewer);
194: PETSC_EXTERN PetscErrorCode PetscViewerASCIIPushTab(PetscViewer);
195: PETSC_EXTERN PetscErrorCode PetscViewerASCIIPopTab(PetscViewer);
196: PETSC_EXTERN PetscErrorCode PetscViewerASCIIUseTabs(PetscViewer,PetscBool);
197: PETSC_EXTERN PetscErrorCode PetscViewerASCIISetTab(PetscViewer,PetscInt);
198: PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetTab(PetscViewer,PetscInt*);
199: PETSC_EXTERN PetscErrorCode PetscViewerASCIIAddTab(PetscViewer,PetscInt);
200: PETSC_EXTERN PetscErrorCode PetscViewerASCIISubtractTab(PetscViewer,PetscInt);
201: PETSC_EXTERN PetscErrorCode PetscViewerASCIIRead(PetscViewer,void *,PetscInt,PetscInt*,PetscDataType);
202: PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetDescriptor(PetscViewer,int*);
203: PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetInfoPointer(PetscViewer,FILE **);
204: PETSC_EXTERN PetscErrorCode PetscViewerBinaryRead(PetscViewer,void*,PetscInt,PetscInt*,PetscDataType);
205: PETSC_EXTERN PetscErrorCode PetscViewerBinaryWrite(PetscViewer,const void*,PetscInt,PetscDataType);
206: PETSC_EXTERN PetscErrorCode PetscViewerBinaryReadAll(PetscViewer,void*,PetscInt,PetscInt,PetscInt,PetscDataType);
207: PETSC_EXTERN PetscErrorCode PetscViewerBinaryWriteAll(PetscViewer,const void*,PetscInt,PetscInt,PetscInt,PetscDataType);
208: PETSC_EXTERN PetscErrorCode PetscViewerStringSPrintf(PetscViewer,const char[],...) PETSC_ATTRIBUTE_FORMAT(2,3);
209: PETSC_EXTERN PetscErrorCode PetscViewerStringSetString(PetscViewer,char[],size_t);
210: PETSC_EXTERN PetscErrorCode PetscViewerStringGetStringRead(PetscViewer,const char*[],size_t*);
211: PETSC_EXTERN PetscErrorCode PetscViewerStringSetOwnString(PetscViewer);
212: PETSC_EXTERN PetscErrorCode PetscViewerDrawClear(PetscViewer);
213: PETSC_EXTERN PetscErrorCode PetscViewerDrawSetHold(PetscViewer,PetscBool);
214: PETSC_EXTERN PetscErrorCode PetscViewerDrawGetHold(PetscViewer,PetscBool*);
215: PETSC_EXTERN PetscErrorCode PetscViewerDrawSetPause(PetscViewer,PetscReal);
216: PETSC_EXTERN PetscErrorCode PetscViewerDrawGetPause(PetscViewer,PetscReal*);
217: PETSC_EXTERN PetscErrorCode PetscViewerDrawSetInfo(PetscViewer,const char[],const char[],int,int,int,int);
218: PETSC_EXTERN PetscErrorCode PetscViewerDrawResize(PetscViewer,int,int);
219: PETSC_EXTERN PetscErrorCode PetscViewerDrawSetBounds(PetscViewer,PetscInt,const PetscReal*);
220: PETSC_EXTERN PetscErrorCode PetscViewerDrawGetBounds(PetscViewer,PetscInt*,const PetscReal**);
221: PETSC_EXTERN PetscErrorCode PetscViewerSocketSetConnection(PetscViewer,const char[],int);
222: PETSC_EXTERN PetscErrorCode PetscViewerBinarySkipInfo(PetscViewer);
223: PETSC_EXTERN PetscErrorCode PetscViewerBinarySetSkipInfo(PetscViewer,PetscBool);
224: PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetSkipInfo(PetscViewer,PetscBool*);
225: PETSC_EXTERN PetscErrorCode PetscViewerBinarySetSkipOptions(PetscViewer,PetscBool);
226: PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetSkipOptions(PetscViewer,PetscBool *);
227: PETSC_EXTERN PetscErrorCode PetscViewerBinarySetSkipHeader(PetscViewer,PetscBool);
228: PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetSkipHeader(PetscViewer,PetscBool*);
229: PETSC_EXTERN PetscErrorCode PetscViewerBinaryReadStringArray(PetscViewer,char***);
230: PETSC_EXTERN PetscErrorCode PetscViewerBinaryWriteStringArray(PetscViewer,const char *const*);

232: PETSC_EXTERN PetscErrorCode PetscViewerFileSetName(PetscViewer,const char[]);
233: PETSC_EXTERN PetscErrorCode PetscViewerFileGetName(PetscViewer,const char**);

235: PETSC_EXTERN PetscErrorCode PetscViewerVUGetPointer(PetscViewer, FILE**);
236: PETSC_EXTERN PetscErrorCode PetscViewerVUSetVecSeen(PetscViewer, PetscBool);
237: PETSC_EXTERN PetscErrorCode PetscViewerVUGetVecSeen(PetscViewer, PetscBool  *);
238: PETSC_EXTERN PetscErrorCode PetscViewerVUPrintDeferred(PetscViewer, const char [], ...) PETSC_ATTRIBUTE_FORMAT(2,3);
239: PETSC_EXTERN PetscErrorCode PetscViewerVUFlushDeferred(PetscViewer);

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

244:   Not Collective

246:   Input Parameters:
247: + viewer - The PetscViewer
248: - mode   - The file mode

250:   Level: deprecated

252:   Note:
253:   Use PetscViewerFileSetMode() instead.

255: .seealso: PetscViewerFileSetMode()
256: @*/
257: PETSC_DEPRECATED_FUNCTION("Use PetscViewerFileSetMode (since v3.15)") PETSC_STATIC_INLINE PetscErrorCode PetscViewerVUSetMode(PetscViewer viewer, PetscFileMode mode) {return PetscViewerFileSetMode(viewer, mode);}

259: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaInitializePackage(void);
260: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaFinalizePackage(void);
261: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaGetName(PetscViewer, const char **);
262: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaSetName(PetscViewer, const char []);
263: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaClearName(PetscViewer);
264: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaSkipPackets(PetscViewer, int);

266: PETSC_EXTERN PetscErrorCode PetscViewerSiloGetName(PetscViewer, char **);
267: PETSC_EXTERN PetscErrorCode PetscViewerSiloSetName(PetscViewer, const char []);
268: PETSC_EXTERN PetscErrorCode PetscViewerSiloClearName(PetscViewer);
269: PETSC_EXTERN PetscErrorCode PetscViewerSiloGetMeshName(PetscViewer, char **);
270: PETSC_EXTERN PetscErrorCode PetscViewerSiloSetMeshName(PetscViewer, const char []);
271: PETSC_EXTERN PetscErrorCode PetscViewerSiloClearMeshName(PetscViewer);

273: typedef enum {PETSC_VTK_INVALID, PETSC_VTK_POINT_FIELD, PETSC_VTK_POINT_VECTOR_FIELD, PETSC_VTK_CELL_FIELD, PETSC_VTK_CELL_VECTOR_FIELD} PetscViewerVTKFieldType;
274: PETSC_EXTERN PetscErrorCode PetscViewerVTKAddField(PetscViewer,PetscObject,PetscErrorCode (*PetscViewerVTKWriteFunction)(PetscObject,PetscViewer),PetscInt,PetscViewerVTKFieldType,PetscBool,PetscObject);
275: PETSC_EXTERN PetscErrorCode PetscViewerVTKGetDM(PetscViewer,PetscObject*);
276: PETSC_EXTERN PetscErrorCode PetscViewerVTKOpen(MPI_Comm,const char[],PetscFileMode,PetscViewer*);

278: /*
279:      These are all the default viewers that do not have to be explicitly opened
280: */
281: PETSC_EXTERN PetscViewer    PETSC_VIEWER_STDOUT_(MPI_Comm);
282: PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetStdout(MPI_Comm,PetscViewer*);
283: PETSC_EXTERN PetscViewer    PETSC_VIEWER_STDERR_(MPI_Comm);
284: PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetStderr(MPI_Comm,PetscViewer*);
285: PETSC_EXTERN PetscViewer    PETSC_VIEWER_DRAW_(MPI_Comm);
286: PETSC_EXTERN PetscViewer    PETSC_VIEWER_SOCKET_(MPI_Comm);
287: PETSC_EXTERN PetscViewer    PETSC_VIEWER_BINARY_(MPI_Comm);
288: PETSC_EXTERN PetscViewer    PETSC_VIEWER_MATLAB_(MPI_Comm);
289: PETSC_EXTERN PetscViewer    PETSC_VIEWER_HDF5_(MPI_Comm);
290: PETSC_EXTERN PetscViewer    PETSC_VIEWER_GLVIS_(MPI_Comm);
291: PETSC_EXTERN PetscViewer    PETSC_VIEWER_EXODUSII_(MPI_Comm);
292: PETSC_EXTERN PetscViewer    PETSC_VIEWER_MATHEMATICA_WORLD_PRIVATE;

294: /*MC
295:   PETSC_VIEWER_STDERR_SELF  - same as PETSC_VIEWER_STDERR_(PETSC_COMM_SELF)

297:   Level: beginner
298: M*/
299: #define PETSC_VIEWER_STDERR_SELF  PETSC_VIEWER_STDERR_(PETSC_COMM_SELF)

301: /*MC
302:   PETSC_VIEWER_STDERR_WORLD  - same as PETSC_VIEWER_STDERR_(PETSC_COMM_WORLD)

304:   Level: beginner
305: M*/
306: #define PETSC_VIEWER_STDERR_WORLD PETSC_VIEWER_STDERR_(PETSC_COMM_WORLD)

308: /*MC
309:   PETSC_VIEWER_STDOUT_WORLD  - same as PETSC_VIEWER_STDOUT_(PETSC_COMM_WORLD)

311:   Level: beginner
312: M*/
313: #define PETSC_VIEWER_STDOUT_WORLD PETSC_VIEWER_STDOUT_(PETSC_COMM_WORLD)

315: /*MC
316:   PETSC_VIEWER_STDOUT_SELF  - same as PETSC_VIEWER_STDOUT_(PETSC_COMM_SELF)

318:   Level: beginner
319: M*/
320: #define PETSC_VIEWER_STDOUT_SELF  PETSC_VIEWER_STDOUT_(PETSC_COMM_SELF)

322: /*MC
323:   PETSC_VIEWER_DRAW_WORLD  - same as PETSC_VIEWER_DRAW_(PETSC_COMM_WORLD)

325:   Level: intermediate
326: M*/
327: #define PETSC_VIEWER_DRAW_WORLD   PETSC_VIEWER_DRAW_(PETSC_COMM_WORLD)

329: /*MC
330:   PETSC_VIEWER_DRAW_SELF  - same as PETSC_VIEWER_DRAW_(PETSC_COMM_SELF)

332:   Level: intermediate
333: M*/
334: #define PETSC_VIEWER_DRAW_SELF    PETSC_VIEWER_DRAW_(PETSC_COMM_SELF)

336: /*MC
337:   PETSC_VIEWER_SOCKET_WORLD  - same as PETSC_VIEWER_SOCKET_(PETSC_COMM_WORLD)

339:   Level: intermediate
340: M*/
341: #define PETSC_VIEWER_SOCKET_WORLD PETSC_VIEWER_SOCKET_(PETSC_COMM_WORLD)

343: /*MC
344:   PETSC_VIEWER_SOCKET_SELF  - same as PETSC_VIEWER_SOCKET_(PETSC_COMM_SELF)

346:   Level: intermediate
347: M*/
348: #define PETSC_VIEWER_SOCKET_SELF  PETSC_VIEWER_SOCKET_(PETSC_COMM_SELF)

350: /*MC
351:   PETSC_VIEWER_BINARY_WORLD  - same as PETSC_VIEWER_BINARY_(PETSC_COMM_WORLD)

353:   Level: intermediate
354: M*/
355: #define PETSC_VIEWER_BINARY_WORLD PETSC_VIEWER_BINARY_(PETSC_COMM_WORLD)

357: /*MC
358:   PETSC_VIEWER_BINARY_SELF  - same as PETSC_VIEWER_BINARY_(PETSC_COMM_SELF)

360:   Level: intermediate
361: M*/
362: #define PETSC_VIEWER_BINARY_SELF  PETSC_VIEWER_BINARY_(PETSC_COMM_SELF)

364: /*MC
365:   PETSC_VIEWER_MATLAB_WORLD  - same as PETSC_VIEWER_MATLAB_(PETSC_COMM_WORLD)

367:   Level: intermediate
368: M*/
369: #define PETSC_VIEWER_MATLAB_WORLD PETSC_VIEWER_MATLAB_(PETSC_COMM_WORLD)

371: /*MC
372:   PETSC_VIEWER_MATLAB_SELF  - same as PETSC_VIEWER_MATLAB_(PETSC_COMM_SELF)

374:   Level: intermediate
375: M*/
376: #define PETSC_VIEWER_MATLAB_SELF  PETSC_VIEWER_MATLAB_(PETSC_COMM_SELF)

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

380: PETSC_EXTERN PetscErrorCode PetscViewerFlowControlStart(PetscViewer,PetscInt*,PetscInt*);
381: PETSC_EXTERN PetscErrorCode PetscViewerFlowControlStepMain(PetscViewer,PetscInt,PetscInt*,PetscInt);
382: PETSC_EXTERN PetscErrorCode PetscViewerFlowControlEndMain(PetscViewer,PetscInt*);
383: PETSC_EXTERN PetscErrorCode PetscViewerFlowControlStepWorker(PetscViewer,PetscMPIInt,PetscInt*);
384: PETSC_EXTERN PetscErrorCode PetscViewerFlowControlEndWorker(PetscViewer,PetscInt*);
385: PETSC_DEPRECATED_FUNCTION("Use PetscViewerFlowControlStepMaster (since v3.15)") PETSC_STATIC_INLINE PetscErrorCode PetscViewerFlowControlStepMaster(PetscViewer viewer,PetscInt i,PetscInt *mcnt,PetscInt cnt) {return PetscViewerFlowControlStepMain(viewer,i,mcnt,cnt);}
386: PETSC_DEPRECATED_FUNCTION("Use PetscViewerFlowControlEndMaster (since v3.15)") PETSC_STATIC_INLINE PetscErrorCode PetscViewerFlowControlEndMaster(PetscViewer viewer, PetscInt *mcnt) {return PetscViewerFlowControlEndMain(viewer,mcnt);}

388: /*
389:    PetscViewer writes to MATLAB .mat file
390: */
391: PETSC_EXTERN PetscErrorCode PetscViewerMatlabPutArray(PetscViewer,int,int,const PetscScalar*,const char*);
392: PETSC_EXTERN PetscErrorCode PetscViewerMatlabGetArray(PetscViewer,int,int,PetscScalar*,const char*);
393: PETSC_EXTERN PetscErrorCode PetscViewerMatlabPutVariable(PetscViewer,const char*,void*);

395: #if defined(PETSC_HAVE_SAWS)
396: PETSC_EXTERN PetscErrorCode PetscObjectViewSAWs(PetscObject,PetscViewer);
397: #endif

399: /*S
400:      PetscViewers - Abstract collection of PetscViewers. It is just an expandable array of viewers.

402:    Level: intermediate

404: .seealso:  PetscViewerCreate(), PetscViewerSetType(), PetscViewerType, PetscViewer, PetscViewersCreate(),
405:            PetscViewersGetViewer()
406: S*/
407: typedef struct _n_PetscViewers* PetscViewers;
408: PETSC_EXTERN PetscErrorCode PetscViewersCreate(MPI_Comm,PetscViewers*);
409: PETSC_EXTERN PetscErrorCode PetscViewersDestroy(PetscViewers*);
410: PETSC_EXTERN PetscErrorCode PetscViewersGetViewer(PetscViewers,PetscInt,PetscViewer*);

412: #endif