Actual source code: petscviewer.h
petsc-3.4.5 2014-06-29
1: /*
2: PetscViewers are objects where other objects can be looked at or stored.
3: */
8: #include <petscsys.h>
9: #include <petscviewertypes.h>
11: PETSC_EXTERN PetscClassId PETSC_VIEWER_CLASSID;
13: /*J
14: PetscViewerType - String with the name of a PETSc PETScViewer
16: Level: beginner
18: .seealso: PetscViewerSetType(), PetscViewer, PetscViewerRegister(), PetscViewerCreate()
19: J*/
20: typedef const char* PetscViewerType;
21: #define PETSCVIEWERSOCKET "socket"
22: #define PETSCVIEWERASCII "ascii"
23: #define PETSCVIEWERBINARY "binary"
24: #define PETSCVIEWERSTRING "string"
25: #define PETSCVIEWERDRAW "draw"
26: #define PETSCVIEWERVU "vu"
27: #define PETSCVIEWERMATHEMATICA "mathematica"
28: #define PETSCVIEWERNETCDF "netcdf"
29: #define PETSCVIEWERHDF5 "hdf5"
30: #define PETSCVIEWERVTK "vtk"
31: #define PETSCVIEWERMATLAB "matlab"
32: #define PETSCVIEWERAMS "ams"
34: PETSC_EXTERN PetscFunctionList PetscViewerList;
35: PETSC_EXTERN PetscErrorCode PetscViewerRegisterAll(void);
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 PetscViewerBinarySetMPIIO(PetscViewer);
50: PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetMPIIO(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[],PetscInt,PetscViewer*);
59: PETSC_EXTERN PetscErrorCode PetscViewerDrawOpen(MPI_Comm,const char[],const char[],int,int,int,int,PetscViewer*);
60: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaOpen(MPI_Comm, int, const char[], const char[], PetscViewer *);
61: PETSC_EXTERN PetscErrorCode PetscViewerSiloOpen(MPI_Comm, const char[], PetscViewer *);
62: PETSC_EXTERN PetscErrorCode PetscViewerMatlabOpen(MPI_Comm,const char[],PetscFileMode,PetscViewer*);
64: PETSC_EXTERN PetscErrorCode PetscViewerGetType(PetscViewer,PetscViewerType*);
65: PETSC_EXTERN PetscErrorCode PetscViewerSetType(PetscViewer,PetscViewerType);
66: PETSC_EXTERN PetscErrorCode PetscViewerDestroy(PetscViewer*);
67: PETSC_EXTERN PetscErrorCode PetscViewerGetSingleton(PetscViewer,PetscViewer*);
68: PETSC_EXTERN PetscErrorCode PetscViewerRestoreSingleton(PetscViewer,PetscViewer*);
69: PETSC_EXTERN PetscErrorCode PetscViewerGetSubcomm(PetscViewer,MPI_Comm,PetscViewer*);
70: PETSC_EXTERN PetscErrorCode PetscViewerRestoreSubcomm(PetscViewer,MPI_Comm,PetscViewer*);
72: PETSC_EXTERN PetscErrorCode PetscViewerSetUp(PetscViewer);
73: PETSC_EXTERN PetscErrorCode PetscViewerView(PetscViewer,PetscViewer);
75: PETSC_EXTERN PetscErrorCode PetscViewerSetOptionsPrefix(PetscViewer,const char[]);
76: PETSC_EXTERN PetscErrorCode PetscViewerAppendOptionsPrefix(PetscViewer,const char[]);
77: PETSC_EXTERN PetscErrorCode PetscViewerGetOptionsPrefix(PetscViewer,const char*[]);
79: /*E
80: PetscViewerFormat - Way a viewer presents the object
82: Level: beginner
84: The values below are also listed in finclude/petscviewer.h. If another values is added below it
85: must also be added there.
87: .seealso: PetscViewerSetFormat(), PetscViewer, PetscViewerType, PetscViewerPushFormat(), PetscViewerPopFormat()
88: E*/
89: typedef enum {
90: PETSC_VIEWER_DEFAULT,
91: PETSC_VIEWER_ASCII_MATLAB,
92: PETSC_VIEWER_ASCII_MATHEMATICA,
93: PETSC_VIEWER_ASCII_IMPL,
94: PETSC_VIEWER_ASCII_INFO,
95: PETSC_VIEWER_ASCII_INFO_DETAIL,
96: PETSC_VIEWER_ASCII_COMMON,
97: PETSC_VIEWER_ASCII_SYMMODU,
98: PETSC_VIEWER_ASCII_INDEX,
99: PETSC_VIEWER_ASCII_DENSE,
100: PETSC_VIEWER_ASCII_MATRIXMARKET,
101: PETSC_VIEWER_ASCII_VTK,
102: PETSC_VIEWER_ASCII_VTK_CELL,
103: PETSC_VIEWER_ASCII_VTK_COORDS,
104: PETSC_VIEWER_ASCII_PCICE,
105: PETSC_VIEWER_ASCII_PYTHON,
106: PETSC_VIEWER_ASCII_FACTOR_INFO,
107: PETSC_VIEWER_ASCII_LATEX,
108: PETSC_VIEWER_DRAW_BASIC,
109: PETSC_VIEWER_DRAW_LG,
110: PETSC_VIEWER_DRAW_CONTOUR,
111: PETSC_VIEWER_DRAW_PORTS,
112: PETSC_VIEWER_VTK_VTS,
113: PETSC_VIEWER_VTK_VTU,
114: PETSC_VIEWER_BINARY_MATLAB,
115: PETSC_VIEWER_NATIVE,
116: PETSC_VIEWER_NOFORMAT
117: } PetscViewerFormat;
118: PETSC_EXTERN const char *const PetscViewerFormats[];
120: PETSC_EXTERN PetscErrorCode PetscViewerSetFormat(PetscViewer,PetscViewerFormat);
121: PETSC_EXTERN PetscErrorCode PetscViewerPushFormat(PetscViewer,PetscViewerFormat);
122: PETSC_EXTERN PetscErrorCode PetscViewerPopFormat(PetscViewer);
123: PETSC_EXTERN PetscErrorCode PetscViewerGetFormat(PetscViewer,PetscViewerFormat*);
124: PETSC_EXTERN PetscErrorCode PetscViewerFlush(PetscViewer);
126: PETSC_EXTERN PetscErrorCode PetscOptionsGetViewer(MPI_Comm,const char[],const char[],PetscViewer*,PetscViewerFormat*,PetscBool*);
127: PETSC_EXTERN PetscErrorCode PetscOptionsViewer(const char[],const char[],const char[],PetscViewer*,PetscViewerFormat *,PetscBool *);
129: /*
130: Operations explicit to a particular class of viewers
131: */
133: PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetPointer(PetscViewer,FILE**);
134: PETSC_EXTERN PetscErrorCode PetscViewerFileGetMode(PetscViewer,PetscFileMode*);
135: PETSC_EXTERN PetscErrorCode PetscViewerFileSetMode(PetscViewer,PetscFileMode);
136: PETSC_EXTERN PetscErrorCode PetscViewerASCIIPrintf(PetscViewer,const char[],...);
137: PETSC_EXTERN PetscErrorCode PetscViewerASCIISynchronizedPrintf(PetscViewer,const char[],...);
138: PETSC_EXTERN PetscErrorCode PetscViewerASCIISynchronizedAllow(PetscViewer,PetscBool);
139: PETSC_EXTERN PetscErrorCode PetscViewerASCIIPushTab(PetscViewer);
140: PETSC_EXTERN PetscErrorCode PetscViewerASCIIPopTab(PetscViewer);
141: PETSC_EXTERN PetscErrorCode PetscViewerASCIIUseTabs(PetscViewer,PetscBool );
142: PETSC_EXTERN PetscErrorCode PetscViewerASCIISetTab(PetscViewer,PetscInt);
143: PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetTab(PetscViewer,PetscInt*);
144: PETSC_EXTERN PetscErrorCode PetscViewerASCIIAddTab(PetscViewer,PetscInt);
145: PETSC_EXTERN PetscErrorCode PetscViewerASCIISubtractTab(PetscViewer,PetscInt);
146: PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetDescriptor(PetscViewer,int*);
147: PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetInfoPointer(PetscViewer,FILE **);
148: PETSC_EXTERN PetscErrorCode PetscViewerBinaryRead(PetscViewer,void*,PetscInt,PetscDataType);
149: PETSC_EXTERN PetscErrorCode PetscViewerBinaryWrite(PetscViewer,void*,PetscInt,PetscDataType,PetscBool );
150: PETSC_EXTERN PetscErrorCode PetscViewerStringSPrintf(PetscViewer,const char[],...);
151: PETSC_EXTERN PetscErrorCode PetscViewerStringSetString(PetscViewer,char[],PetscInt);
152: PETSC_EXTERN PetscErrorCode PetscViewerDrawClear(PetscViewer);
153: PETSC_EXTERN PetscErrorCode PetscViewerDrawSetHold(PetscViewer,PetscBool);
154: PETSC_EXTERN PetscErrorCode PetscViewerDrawGetHold(PetscViewer,PetscBool*);
155: PETSC_EXTERN PetscErrorCode PetscViewerDrawSetPause(PetscViewer,PetscReal);
156: PETSC_EXTERN PetscErrorCode PetscViewerDrawGetPause(PetscViewer,PetscReal*);
157: PETSC_EXTERN PetscErrorCode PetscViewerDrawSetInfo(PetscViewer,const char[],const char[],int,int,int,int);
158: PETSC_EXTERN PetscErrorCode PetscViewerDrawResize(PetscViewer,int,int);
159: PETSC_EXTERN PetscErrorCode PetscViewerDrawSetBounds(PetscViewer,PetscInt,const PetscReal*);
160: PETSC_EXTERN PetscErrorCode PetscViewerDrawGetBounds(PetscViewer,PetscInt*,const PetscReal**);
161: PETSC_EXTERN PetscErrorCode PetscViewerSocketSetConnection(PetscViewer,const char[],int);
162: PETSC_EXTERN PetscErrorCode PetscViewerBinarySkipInfo(PetscViewer);
163: PETSC_EXTERN PetscErrorCode PetscViewerBinarySetSkipOptions(PetscViewer,PetscBool );
164: PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetSkipOptions(PetscViewer,PetscBool *);
165: PETSC_EXTERN PetscErrorCode PetscViewerBinarySetSkipHeader(PetscViewer,PetscBool);
166: PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetSkipHeader(PetscViewer,PetscBool*);
167: PETSC_EXTERN PetscErrorCode PetscViewerBinaryReadStringArray(PetscViewer,char***);
168: PETSC_EXTERN PetscErrorCode PetscViewerBinaryWriteStringArray(PetscViewer,char**);
170: PETSC_EXTERN PetscErrorCode PetscViewerFileSetName(PetscViewer,const char[]);
171: PETSC_EXTERN PetscErrorCode PetscViewerFileGetName(PetscViewer,const char**);
173: PETSC_EXTERN PetscErrorCode PetscViewerVUGetPointer(PetscViewer, FILE**);
174: PETSC_EXTERN PetscErrorCode PetscViewerVUSetVecSeen(PetscViewer, PetscBool );
175: PETSC_EXTERN PetscErrorCode PetscViewerVUGetVecSeen(PetscViewer, PetscBool *);
176: PETSC_EXTERN PetscErrorCode PetscViewerVUPrintDeferred(PetscViewer, const char [], ...);
177: PETSC_EXTERN PetscErrorCode PetscViewerVUFlushDeferred(PetscViewer);
179: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaInitializePackage(void);
180: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaFinalizePackage(void);
181: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaGetName(PetscViewer, const char **);
182: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaSetName(PetscViewer, const char []);
183: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaClearName(PetscViewer);
184: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaSkipPackets(PetscViewer, int);
186: PETSC_EXTERN PetscErrorCode PetscViewerSiloGetName(PetscViewer, char **);
187: PETSC_EXTERN PetscErrorCode PetscViewerSiloSetName(PetscViewer, const char []);
188: PETSC_EXTERN PetscErrorCode PetscViewerSiloClearName(PetscViewer);
189: PETSC_EXTERN PetscErrorCode PetscViewerSiloGetMeshName(PetscViewer, char **);
190: PETSC_EXTERN PetscErrorCode PetscViewerSiloSetMeshName(PetscViewer, const char []);
191: PETSC_EXTERN PetscErrorCode PetscViewerSiloClearMeshName(PetscViewer);
193: PETSC_EXTERN PetscErrorCode PetscViewerNetcdfOpen(MPI_Comm,const char[],PetscFileMode,PetscViewer*);
194: PETSC_EXTERN PetscErrorCode PetscViewerNetcdfGetID(PetscViewer, int *);
196: typedef enum {PETSC_VTK_POINT_FIELD, PETSC_VTK_POINT_VECTOR_FIELD, PETSC_VTK_CELL_FIELD, PETSC_VTK_CELL_VECTOR_FIELD} PetscViewerVTKFieldType;
197: PETSC_EXTERN PetscErrorCode PetscViewerVTKAddField(PetscViewer,PetscObject,PetscErrorCode (*PetscViewerVTKWriteFunction)(PetscObject,PetscViewer),PetscViewerVTKFieldType,PetscObject);
198: PETSC_EXTERN PetscErrorCode PetscViewerVTKOpen(MPI_Comm,const char[],PetscFileMode,PetscViewer*);
200: /*
201: These are all the default viewers that do not have to be explicitly opened
202: */
203: PETSC_EXTERN PetscViewer PETSC_VIEWER_STDOUT_(MPI_Comm);
204: PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetStdout(MPI_Comm,PetscViewer*);
205: PETSC_EXTERN PetscViewer PETSC_VIEWER_STDERR_(MPI_Comm);
206: PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetStderr(MPI_Comm,PetscViewer*);
207: PETSC_EXTERN PetscViewer PETSC_VIEWER_DRAW_(MPI_Comm);
208: PETSC_EXTERN PetscViewer PETSC_VIEWER_SOCKET_(MPI_Comm);
209: PETSC_EXTERN PetscViewer PETSC_VIEWER_BINARY_(MPI_Comm);
210: PETSC_EXTERN PetscViewer PETSC_VIEWER_MATLAB_(MPI_Comm);
211: PETSC_EXTERN PetscViewer PETSC_VIEWER_MATHEMATICA_WORLD_PRIVATE;
213: #define PETSC_VIEWER_STDERR_SELF PETSC_VIEWER_STDERR_(PETSC_COMM_SELF)
214: #define PETSC_VIEWER_STDERR_WORLD PETSC_VIEWER_STDERR_(PETSC_COMM_WORLD)
216: /*MC
217: PETSC_VIEWER_STDOUT_WORLD - same as PETSC_VIEWER_STDOUT_(PETSC_COMM_WORLD)
219: Level: beginner
220: M*/
221: #define PETSC_VIEWER_STDOUT_WORLD PETSC_VIEWER_STDOUT_(PETSC_COMM_WORLD)
223: /*MC
224: PETSC_VIEWER_STDOUT_SELF - same as PETSC_VIEWER_STDOUT_(PETSC_COMM_SELF)
226: Level: beginner
227: M*/
228: #define PETSC_VIEWER_STDOUT_SELF PETSC_VIEWER_STDOUT_(PETSC_COMM_SELF)
230: /*MC
231: PETSC_VIEWER_DRAW_WORLD - same as PETSC_VIEWER_DRAW_(PETSC_COMM_WORLD)
233: Level: intermediate
234: M*/
235: #define PETSC_VIEWER_DRAW_WORLD PETSC_VIEWER_DRAW_(PETSC_COMM_WORLD)
237: /*MC
238: PETSC_VIEWER_DRAW_SELF - same as PETSC_VIEWER_DRAW_(PETSC_COMM_SELF)
240: Level: intermediate
241: M*/
242: #define PETSC_VIEWER_DRAW_SELF PETSC_VIEWER_DRAW_(PETSC_COMM_SELF)
244: /*MC
245: PETSC_VIEWER_SOCKET_WORLD - same as PETSC_VIEWER_SOCKET_(PETSC_COMM_WORLD)
247: Level: intermediate
248: M*/
249: #define PETSC_VIEWER_SOCKET_WORLD PETSC_VIEWER_SOCKET_(PETSC_COMM_WORLD)
251: /*MC
252: PETSC_VIEWER_SOCKET_SELF - same as PETSC_VIEWER_SOCKET_(PETSC_COMM_SELF)
254: Level: intermediate
255: M*/
256: #define PETSC_VIEWER_SOCKET_SELF PETSC_VIEWER_SOCKET_(PETSC_COMM_SELF)
258: /*MC
259: PETSC_VIEWER_BINARY_WORLD - same as PETSC_VIEWER_BINARY_(PETSC_COMM_WORLD)
261: Level: intermediate
262: M*/
263: #define PETSC_VIEWER_BINARY_WORLD PETSC_VIEWER_BINARY_(PETSC_COMM_WORLD)
265: /*MC
266: PETSC_VIEWER_BINARY_SELF - same as PETSC_VIEWER_BINARY_(PETSC_COMM_SELF)
268: Level: intermediate
269: M*/
270: #define PETSC_VIEWER_BINARY_SELF PETSC_VIEWER_BINARY_(PETSC_COMM_SELF)
272: /*MC
273: PETSC_VIEWER_MATLAB_WORLD - same as PETSC_VIEWER_MATLAB_(PETSC_COMM_WORLD)
275: Level: intermediate
276: M*/
277: #define PETSC_VIEWER_MATLAB_WORLD PETSC_VIEWER_MATLAB_(PETSC_COMM_WORLD)
279: /*MC
280: PETSC_VIEWER_MATLAB_SELF - same as PETSC_VIEWER_MATLAB_(PETSC_COMM_SELF)
282: Level: intermediate
283: M*/
284: #define PETSC_VIEWER_MATLAB_SELF PETSC_VIEWER_MATLAB_(PETSC_COMM_SELF)
286: #define PETSC_VIEWER_MATHEMATICA_WORLD (PetscViewerInitializeMathematicaWorld_Private(),PETSC_VIEWER_MATHEMATICA_WORLD_PRIVATE)
290: PETSC_STATIC_INLINE PetscErrorCode PetscViewerFlowControlStart(PetscViewer viewer,PetscInt *mcnt,PetscInt *cnt)
291: {
294: PetscViewerBinaryGetFlowControl(viewer,mcnt);
295: PetscViewerBinaryGetFlowControl(viewer,cnt);
296: return(0);
297: }
301: PETSC_STATIC_INLINE PetscErrorCode PetscViewerFlowControlStepMaster(PetscViewer viewer,PetscInt i,PetscInt *mcnt,PetscInt cnt)
302: {
304: MPI_Comm comm;
307: PetscObjectGetComm((PetscObject)viewer,&comm);
308: if (i >= *mcnt) {
309: *mcnt += cnt;
310: MPI_Bcast(mcnt,1,MPIU_INT,0,comm);
311: }
312: return(0);
313: }
317: PETSC_STATIC_INLINE PetscErrorCode PetscViewerFlowControlEndMaster(PetscViewer viewer,PetscInt *mcnt)
318: {
320: MPI_Comm comm;
322: PetscObjectGetComm((PetscObject)viewer,&comm);
323: *mcnt = 0;
324: MPI_Bcast(mcnt,1,MPIU_INT,0,comm);
325: return(0);
326: }
330: PETSC_STATIC_INLINE PetscErrorCode PetscViewerFlowControlStepWorker(PetscViewer viewer,PetscMPIInt rank,PetscInt *mcnt)
331: {
333: MPI_Comm comm;
335: PetscObjectGetComm((PetscObject)viewer,&comm);
336: while (PETSC_TRUE) {
337: if (rank < *mcnt) break;
338: MPI_Bcast(mcnt,1,MPIU_INT,0,comm);
339: }
340: return(0);
341: }
345: PETSC_STATIC_INLINE PetscErrorCode PetscViewerFlowControlEndWorker(PetscViewer viewer,PetscInt *mcnt)
346: {
348: MPI_Comm comm;
350: PetscObjectGetComm((PetscObject)viewer,&comm);
351: while (PETSC_TRUE) {
352: MPI_Bcast(mcnt,1,MPIU_INT,0,comm);
353: if (!*mcnt) break;
354: }
355: return(0);
356: }
358: /*
359: PetscViewer writes to MATLAB .mat file
360: */
361: PETSC_EXTERN PetscErrorCode PetscViewerMatlabPutArray(PetscViewer,int,int,const PetscScalar*,const char*);
362: PETSC_EXTERN PetscErrorCode PetscViewerMatlabGetArray(PetscViewer,int,int,PetscScalar*,const char*);
363: PETSC_EXTERN PetscErrorCode PetscViewerMatlabPutVariable(PetscViewer,const char*,void*);
365: #if defined(PETSC_HAVE_AMS)
366: PETSC_EXTERN PetscErrorCode PetscObjectViewAMS(PetscObject,PetscViewer);
367: #endif
369: /*S
370: PetscViewers - Abstract collection of PetscViewers. It is just an expandable array of viewers.
372: Level: intermediate
374: Concepts: viewing
376: .seealso: PetscViewerCreate(), PetscViewerSetType(), PetscViewerType, PetscViewer, PetscViewersCreate(),
377: PetscViewersGetViewer()
378: S*/
379: typedef struct _n_PetscViewers* PetscViewers;
380: PETSC_EXTERN PetscErrorCode PetscViewersCreate(MPI_Comm,PetscViewers*);
381: PETSC_EXTERN PetscErrorCode PetscViewersDestroy(PetscViewers*);
382: PETSC_EXTERN PetscErrorCode PetscViewersGetViewer(PetscViewers,PetscInt,PetscViewer*);
384: /* Reset __FUNCT__ in case the user does not define it themselves */
388: #endif