Actual source code: petscviewer.h

petsc-3.9.2 2018-05-20
Report Typos and Errors
  1: /*
  2:      PetscViewers are objects where other objects can be looked at or stored.
  3: */


  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"

 35: PETSC_EXTERN PetscFunctionList PetscViewerList;
 36: PETSC_EXTERN PetscErrorCode PetscViewerInitializePackage(void);

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

 40: PETSC_EXTERN PetscErrorCode PetscViewerCreate(MPI_Comm,PetscViewer*);
 41: PETSC_EXTERN PetscErrorCode PetscViewerSetFromOptions(PetscViewer);
 42: PETSC_EXTERN PetscErrorCode PetscViewerASCIIOpenWithFILE(MPI_Comm,FILE*,PetscViewer*);

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

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

 70: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaOpen(MPI_Comm, int, const char[], const char[], PetscViewer *);
 71: PETSC_EXTERN PetscErrorCode PetscViewerSiloOpen(MPI_Comm, const char[], PetscViewer *);
 72: PETSC_EXTERN PetscErrorCode PetscViewerMatlabOpen(MPI_Comm,const char[],PetscFileMode,PetscViewer*);

 74: /*E
 75:     PetscViewerGLVisType - indicates what type of GLVis viewer to use

 77:     Level: beginner

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

 87: PETSC_EXTERN PetscErrorCode PetscViewerGetType(PetscViewer,PetscViewerType*);
 88: PETSC_EXTERN PetscErrorCode PetscViewerSetType(PetscViewer,PetscViewerType);
 89: PETSC_EXTERN PetscErrorCode PetscViewerDestroy(PetscViewer*);
 90: PETSC_EXTERN PetscErrorCode PetscViewerGetSubViewer(PetscViewer,MPI_Comm,PetscViewer*);
 91: PETSC_EXTERN PetscErrorCode PetscViewerRestoreSubViewer(PetscViewer,MPI_Comm,PetscViewer*);

 93: PETSC_EXTERN PetscErrorCode PetscViewerSetUp(PetscViewer);
 94: PETSC_EXTERN PetscErrorCode PetscViewerView(PetscViewer,PetscViewer);
 95: PETSC_STATIC_INLINE PetscErrorCode PetscViewerViewFromOptions(PetscViewer A,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,name);}

 97: PETSC_EXTERN PetscErrorCode PetscViewerSetOptionsPrefix(PetscViewer,const char[]);
 98: PETSC_EXTERN PetscErrorCode PetscViewerAppendOptionsPrefix(PetscViewer,const char[]);
 99: PETSC_EXTERN PetscErrorCode PetscViewerGetOptionsPrefix(PetscViewer,const char*[]);

101: /*E
102:     PetscViewerFormat - Way a viewer presents the object

104:    Level: beginner

106:    The values below are also listed in petsc/finclude/petscviewer.h. If another values is added below it
107:    must also be added there.

109: .seealso: PetscViewer, PetscViewerType, PetscViewerPushFormat(), PetscViewerPopFormat()
110: E*/
111: typedef enum {
112:   PETSC_VIEWER_DEFAULT,
113:   PETSC_VIEWER_ASCII_MATLAB,
114:   PETSC_VIEWER_ASCII_MATHEMATICA,
115:   PETSC_VIEWER_ASCII_IMPL,
116:   PETSC_VIEWER_ASCII_INFO,
117:   PETSC_VIEWER_ASCII_INFO_DETAIL,
118:   PETSC_VIEWER_ASCII_COMMON,
119:   PETSC_VIEWER_ASCII_SYMMODU,
120:   PETSC_VIEWER_ASCII_INDEX,
121:   PETSC_VIEWER_ASCII_DENSE,
122:   PETSC_VIEWER_ASCII_MATRIXMARKET,
123:   PETSC_VIEWER_ASCII_VTK,
124:   PETSC_VIEWER_ASCII_VTK_CELL,
125:   PETSC_VIEWER_ASCII_VTK_COORDS,
126:   PETSC_VIEWER_ASCII_PCICE,
127:   PETSC_VIEWER_ASCII_PYTHON,
128:   PETSC_VIEWER_ASCII_FACTOR_INFO,
129:   PETSC_VIEWER_ASCII_LATEX,
130:   PETSC_VIEWER_ASCII_XML,
131:   PETSC_VIEWER_ASCII_GLVIS,
132:   PETSC_VIEWER_DRAW_BASIC,
133:   PETSC_VIEWER_DRAW_LG,
134:   PETSC_VIEWER_DRAW_CONTOUR,
135:   PETSC_VIEWER_DRAW_PORTS,
136:   PETSC_VIEWER_VTK_VTS,
137:   PETSC_VIEWER_VTK_VTR,
138:   PETSC_VIEWER_VTK_VTU,
139:   PETSC_VIEWER_BINARY_MATLAB,
140:   PETSC_VIEWER_NATIVE,
141:   PETSC_VIEWER_HDF5_VIZ,
142:   PETSC_VIEWER_NOFORMAT,
143:   PETSC_VIEWER_LOAD_BALANCE
144:   } PetscViewerFormat;
145: PETSC_EXTERN const char *const PetscViewerFormats[];

147: PETSC_EXTERN PETSC_DEPRECATED("Use PetscViewerPushFormat()/PetscViewerPopFormat()") PetscErrorCode PetscViewerSetFormat(PetscViewer,PetscViewerFormat);
148: PETSC_EXTERN PetscErrorCode PetscViewerPushFormat(PetscViewer,PetscViewerFormat);
149: PETSC_EXTERN PetscErrorCode PetscViewerPopFormat(PetscViewer);
150: PETSC_EXTERN PetscErrorCode PetscViewerGetFormat(PetscViewer,PetscViewerFormat*);
151: PETSC_EXTERN PetscErrorCode PetscViewerFlush(PetscViewer);

153: PETSC_EXTERN PetscErrorCode PetscOptionsPushGetViewerOff(PetscBool);
154: PETSC_EXTERN PetscErrorCode PetscOptionsPopGetViewerOff(void);
155: PETSC_EXTERN PetscErrorCode PetscOptionsGetViewerOff(PetscBool*);
156: PETSC_EXTERN PetscErrorCode PetscOptionsGetViewer(MPI_Comm,const char[],const char[],PetscViewer*,PetscViewerFormat*,PetscBool*);
157: #define PetscOptionsViewer(a,b,c,d,e,f) PetscOptionsViewer_Private(PetscOptionsObject,a,b,c,d,e,f);
158: PETSC_EXTERN PetscErrorCode PetscOptionsViewer_Private(PetscOptionItems*,const char[],const char[],const char[],PetscViewer*,PetscViewerFormat *,PetscBool *);

160: typedef struct {PetscViewer viewer;PetscViewerFormat format;} PetscViewerAndFormat;
161: PETSC_EXTERN PetscErrorCode  PetscViewerAndFormatCreate(PetscViewer,PetscViewerFormat,PetscViewerAndFormat**);
162: PETSC_EXTERN PetscErrorCode  PetscViewerAndFormatDestroy(PetscViewerAndFormat**);

164: /*
165:    Operations explicit to a particular class of viewers
166: */

168: PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetPointer(PetscViewer,FILE**);
169: PETSC_EXTERN PetscErrorCode PetscViewerFileGetMode(PetscViewer,PetscFileMode*);
170: PETSC_EXTERN PetscErrorCode PetscViewerFileSetMode(PetscViewer,PetscFileMode);
171: PETSC_EXTERN PetscErrorCode PetscViewerRead(PetscViewer,void*,PetscInt,PetscInt*,PetscDataType);
172: PETSC_EXTERN PetscErrorCode PetscViewerASCIIPrintf(PetscViewer,const char[],...);
173: PETSC_EXTERN PetscErrorCode PetscViewerASCIISynchronizedPrintf(PetscViewer,const char[],...);
174: PETSC_EXTERN PetscErrorCode PetscViewerASCIIPushSynchronized(PetscViewer);
175: PETSC_EXTERN PetscErrorCode PetscViewerASCIIPopSynchronized(PetscViewer);
176: PETSC_EXTERN PetscErrorCode PetscViewerASCIIPushTab(PetscViewer);
177: PETSC_EXTERN PetscErrorCode PetscViewerASCIIPopTab(PetscViewer);
178: PETSC_EXTERN PetscErrorCode PetscViewerASCIIUseTabs(PetscViewer,PetscBool );
179: PETSC_EXTERN PetscErrorCode PetscViewerASCIISetTab(PetscViewer,PetscInt);
180: PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetTab(PetscViewer,PetscInt*);
181: PETSC_EXTERN PetscErrorCode PetscViewerASCIIAddTab(PetscViewer,PetscInt);
182: PETSC_EXTERN PetscErrorCode PetscViewerASCIISubtractTab(PetscViewer,PetscInt);
183: PETSC_EXTERN PetscErrorCode PetscViewerASCIIRead(PetscViewer,void *,PetscInt,PetscInt*,PetscDataType);
184: PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetDescriptor(PetscViewer,int*);
185: PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetInfoPointer(PetscViewer,FILE **);
186: PETSC_EXTERN PetscErrorCode PetscViewerBinaryRead(PetscViewer,void*,PetscInt,PetscInt*,PetscDataType);
187: PETSC_EXTERN PetscErrorCode PetscViewerBinaryWrite(PetscViewer,void*,PetscInt,PetscDataType,PetscBool );
188: PETSC_EXTERN PetscErrorCode PetscViewerStringSPrintf(PetscViewer,const char[],...);
189: PETSC_EXTERN PetscErrorCode PetscViewerStringSetString(PetscViewer,char[],PetscInt);
190: PETSC_EXTERN PetscErrorCode PetscViewerDrawClear(PetscViewer);
191: PETSC_EXTERN PetscErrorCode PetscViewerDrawSetHold(PetscViewer,PetscBool);
192: PETSC_EXTERN PetscErrorCode PetscViewerDrawGetHold(PetscViewer,PetscBool*);
193: PETSC_EXTERN PetscErrorCode PetscViewerDrawSetPause(PetscViewer,PetscReal);
194: PETSC_EXTERN PetscErrorCode PetscViewerDrawGetPause(PetscViewer,PetscReal*);
195: PETSC_EXTERN PetscErrorCode PetscViewerDrawSetInfo(PetscViewer,const char[],const char[],int,int,int,int);
196: PETSC_EXTERN PetscErrorCode PetscViewerDrawResize(PetscViewer,int,int);
197: PETSC_EXTERN PetscErrorCode PetscViewerDrawSetBounds(PetscViewer,PetscInt,const PetscReal*);
198: PETSC_EXTERN PetscErrorCode PetscViewerDrawGetBounds(PetscViewer,PetscInt*,const PetscReal**);
199: PETSC_EXTERN PetscErrorCode PetscViewerSocketSetConnection(PetscViewer,const char[],int);
200: PETSC_EXTERN PetscErrorCode PetscViewerBinarySkipInfo(PetscViewer);
201: PETSC_EXTERN PetscErrorCode PetscViewerBinarySetSkipInfo(PetscViewer,PetscBool);
202: PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetSkipInfo(PetscViewer,PetscBool*);
203: PETSC_EXTERN PetscErrorCode PetscViewerBinarySetSkipOptions(PetscViewer,PetscBool );
204: PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetSkipOptions(PetscViewer,PetscBool *);
205: PETSC_EXTERN PetscErrorCode PetscViewerBinarySetSkipHeader(PetscViewer,PetscBool);
206: PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetSkipHeader(PetscViewer,PetscBool*);
207: PETSC_EXTERN PetscErrorCode PetscViewerBinaryReadStringArray(PetscViewer,char***);
208: PETSC_EXTERN PetscErrorCode PetscViewerBinaryWriteStringArray(PetscViewer,const char *const*);

210: PETSC_EXTERN PetscErrorCode PetscViewerFileSetName(PetscViewer,const char[]);
211: PETSC_EXTERN PetscErrorCode PetscViewerFileGetName(PetscViewer,const char**);

213: PETSC_EXTERN PetscErrorCode PetscViewerVUGetPointer(PetscViewer, FILE**);
214: PETSC_EXTERN PetscErrorCode PetscViewerVUSetVecSeen(PetscViewer, PetscBool );
215: PETSC_EXTERN PetscErrorCode PetscViewerVUGetVecSeen(PetscViewer, PetscBool  *);
216: PETSC_EXTERN PetscErrorCode PetscViewerVUPrintDeferred(PetscViewer, const char [], ...);
217: PETSC_EXTERN PetscErrorCode PetscViewerVUFlushDeferred(PetscViewer);

219: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaInitializePackage(void);
220: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaFinalizePackage(void);
221: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaGetName(PetscViewer, const char **);
222: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaSetName(PetscViewer, const char []);
223: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaClearName(PetscViewer);
224: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaSkipPackets(PetscViewer, int);

226: PETSC_EXTERN PetscErrorCode PetscViewerSiloGetName(PetscViewer, char **);
227: PETSC_EXTERN PetscErrorCode PetscViewerSiloSetName(PetscViewer, const char []);
228: PETSC_EXTERN PetscErrorCode PetscViewerSiloClearName(PetscViewer);
229: PETSC_EXTERN PetscErrorCode PetscViewerSiloGetMeshName(PetscViewer, char **);
230: PETSC_EXTERN PetscErrorCode PetscViewerSiloSetMeshName(PetscViewer, const char []);
231: PETSC_EXTERN PetscErrorCode PetscViewerSiloClearMeshName(PetscViewer);

233: typedef enum {PETSC_VTK_POINT_FIELD, PETSC_VTK_POINT_VECTOR_FIELD, PETSC_VTK_CELL_FIELD, PETSC_VTK_CELL_VECTOR_FIELD} PetscViewerVTKFieldType;
234: PETSC_EXTERN PetscErrorCode PetscViewerVTKAddField(PetscViewer,PetscObject,PetscErrorCode (*PetscViewerVTKWriteFunction)(PetscObject,PetscViewer),PetscViewerVTKFieldType,PetscObject);
235: PETSC_EXTERN PetscErrorCode PetscViewerVTKOpen(MPI_Comm,const char[],PetscFileMode,PetscViewer*);

237: /*
238:      These are all the default viewers that do not have to be explicitly opened
239: */
240: PETSC_EXTERN PetscViewer    PETSC_VIEWER_STDOUT_(MPI_Comm);
241: PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetStdout(MPI_Comm,PetscViewer*);
242: PETSC_EXTERN PetscViewer    PETSC_VIEWER_STDERR_(MPI_Comm);
243: PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetStderr(MPI_Comm,PetscViewer*);
244: PETSC_EXTERN PetscViewer    PETSC_VIEWER_DRAW_(MPI_Comm);
245: PETSC_EXTERN PetscViewer    PETSC_VIEWER_SOCKET_(MPI_Comm);
246: PETSC_EXTERN PetscViewer    PETSC_VIEWER_BINARY_(MPI_Comm);
247: PETSC_EXTERN PetscViewer    PETSC_VIEWER_MATLAB_(MPI_Comm);
248: PETSC_EXTERN PetscViewer    PETSC_VIEWER_HDF5_(MPI_Comm);
249: PETSC_EXTERN PetscViewer    PETSC_VIEWER_GLVIS_(MPI_Comm);
250: PETSC_EXTERN PetscViewer    PETSC_VIEWER_MATHEMATICA_WORLD_PRIVATE;

252: #define PETSC_VIEWER_STDERR_SELF  PETSC_VIEWER_STDERR_(PETSC_COMM_SELF)
253: #define PETSC_VIEWER_STDERR_WORLD PETSC_VIEWER_STDERR_(PETSC_COMM_WORLD)

255: /*MC
256:   PETSC_VIEWER_STDOUT_WORLD  - same as PETSC_VIEWER_STDOUT_(PETSC_COMM_WORLD)

258:   Level: beginner
259: M*/
260: #define PETSC_VIEWER_STDOUT_WORLD PETSC_VIEWER_STDOUT_(PETSC_COMM_WORLD)

262: /*MC
263:   PETSC_VIEWER_STDOUT_SELF  - same as PETSC_VIEWER_STDOUT_(PETSC_COMM_SELF)

265:   Level: beginner
266: M*/
267: #define PETSC_VIEWER_STDOUT_SELF  PETSC_VIEWER_STDOUT_(PETSC_COMM_SELF)

269: /*MC
270:   PETSC_VIEWER_DRAW_WORLD  - same as PETSC_VIEWER_DRAW_(PETSC_COMM_WORLD)

272:   Level: intermediate
273: M*/
274: #define PETSC_VIEWER_DRAW_WORLD   PETSC_VIEWER_DRAW_(PETSC_COMM_WORLD)

276: /*MC
277:   PETSC_VIEWER_DRAW_SELF  - same as PETSC_VIEWER_DRAW_(PETSC_COMM_SELF)

279:   Level: intermediate
280: M*/
281: #define PETSC_VIEWER_DRAW_SELF    PETSC_VIEWER_DRAW_(PETSC_COMM_SELF)

283: /*MC
284:   PETSC_VIEWER_SOCKET_WORLD  - same as PETSC_VIEWER_SOCKET_(PETSC_COMM_WORLD)

286:   Level: intermediate
287: M*/
288: #define PETSC_VIEWER_SOCKET_WORLD PETSC_VIEWER_SOCKET_(PETSC_COMM_WORLD)

290: /*MC
291:   PETSC_VIEWER_SOCKET_SELF  - same as PETSC_VIEWER_SOCKET_(PETSC_COMM_SELF)

293:   Level: intermediate
294: M*/
295: #define PETSC_VIEWER_SOCKET_SELF  PETSC_VIEWER_SOCKET_(PETSC_COMM_SELF)

297: /*MC
298:   PETSC_VIEWER_BINARY_WORLD  - same as PETSC_VIEWER_BINARY_(PETSC_COMM_WORLD)

300:   Level: intermediate
301: M*/
302: #define PETSC_VIEWER_BINARY_WORLD PETSC_VIEWER_BINARY_(PETSC_COMM_WORLD)

304: /*MC
305:   PETSC_VIEWER_BINARY_SELF  - same as PETSC_VIEWER_BINARY_(PETSC_COMM_SELF)

307:   Level: intermediate
308: M*/
309: #define PETSC_VIEWER_BINARY_SELF  PETSC_VIEWER_BINARY_(PETSC_COMM_SELF)

311: /*MC
312:   PETSC_VIEWER_MATLAB_WORLD  - same as PETSC_VIEWER_MATLAB_(PETSC_COMM_WORLD)

314:   Level: intermediate
315: M*/
316: #define PETSC_VIEWER_MATLAB_WORLD PETSC_VIEWER_MATLAB_(PETSC_COMM_WORLD)

318: /*MC
319:   PETSC_VIEWER_MATLAB_SELF  - same as PETSC_VIEWER_MATLAB_(PETSC_COMM_SELF)

321:   Level: intermediate
322: M*/
323: #define PETSC_VIEWER_MATLAB_SELF  PETSC_VIEWER_MATLAB_(PETSC_COMM_SELF)

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

327: PETSC_EXTERN PetscErrorCode PetscViewerFlowControlStart(PetscViewer,PetscInt*,PetscInt*);
328: PETSC_EXTERN PetscErrorCode PetscViewerFlowControlStepMaster(PetscViewer,PetscInt,PetscInt*,PetscInt);
329: PETSC_EXTERN PetscErrorCode PetscViewerFlowControlEndMaster(PetscViewer,PetscInt*);
330: PETSC_EXTERN PetscErrorCode PetscViewerFlowControlStepWorker(PetscViewer,PetscMPIInt,PetscInt*);
331: PETSC_EXTERN PetscErrorCode PetscViewerFlowControlEndWorker(PetscViewer,PetscInt*);

333: /*
334:    PetscViewer writes to MATLAB .mat file
335: */
336: PETSC_EXTERN PetscErrorCode PetscViewerMatlabPutArray(PetscViewer,int,int,const PetscScalar*,const char*);
337: PETSC_EXTERN PetscErrorCode PetscViewerMatlabGetArray(PetscViewer,int,int,PetscScalar*,const char*);
338: PETSC_EXTERN PetscErrorCode PetscViewerMatlabPutVariable(PetscViewer,const char*,void*);

340: #if defined(PETSC_HAVE_SAWS)
341: PETSC_EXTERN PetscErrorCode PetscObjectViewSAWs(PetscObject,PetscViewer);
342: #endif

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

347:    Level: intermediate

349:   Concepts: viewing

351: .seealso:  PetscViewerCreate(), PetscViewerSetType(), PetscViewerType, PetscViewer, PetscViewersCreate(),
352:            PetscViewersGetViewer()
353: S*/
354: typedef struct _n_PetscViewers* PetscViewers;
355: PETSC_EXTERN PetscErrorCode PetscViewersCreate(MPI_Comm,PetscViewers*);
356: PETSC_EXTERN PetscErrorCode PetscViewersDestroy(PetscViewers*);
357: PETSC_EXTERN PetscErrorCode PetscViewersGetViewer(PetscViewers,PetscInt,PetscViewer*);

359: #endif