Actual source code: petscviewer.h
1: /*
2: PetscViewers are objects where other objects can be looked at or stored.
3: */
10: #endif
12: /*S
13: PetscViewer - Abstract PETSc object that helps view (in ASCII, binary, graphically etc)
14: other PETSc objects
16: Level: beginner
18: Concepts: viewing
20: .seealso: PetscViewerCreate(), PetscViewerSetType(), PetscViewerType
21: S*/
22: typedef struct _p_PetscViewer* PetscViewer;
25: }
26: #endif
28: #include petsc.h
32: #endif
37: }
38: #endif
41: /*
42: petsc.h must be included AFTER the definition of PetscViewer for ADIC to
43: process correctly.
44: */
46: /*E
47: PetscViewerType - String with the name of a PETSc PETScViewer
49: Level: beginner
51: .seealso: PetscViewerSetType(), PetscViewer
52: E*/
53: #define PetscViewerType const char*
54: #define PETSC_VIEWER_SOCKET "socket"
55: #define PETSC_VIEWER_ASCII "ascii"
56: #define PETSC_VIEWER_BINARY "binary"
57: #define PETSC_VIEWER_STRING "string"
58: #define PETSC_VIEWER_DRAW "draw"
59: #define PETSC_VIEWER_VU "vu"
60: #define PETSC_VIEWER_MATHEMATICA "mathematica"
61: #define PETSC_VIEWER_SILO "silo"
62: #define PETSC_VIEWER_NETCDF "netcdf"
63: #define PETSC_VIEWER_HDF4 "hdf4"
64: #define PETSC_VIEWER_MATLAB "matlab"
67: EXTERN PetscErrorCode PetscViewerRegisterAll(const char *);
68: EXTERN PetscErrorCode PetscViewerRegisterDestroy(void);
70: EXTERN PetscErrorCode PetscViewerRegister(const char*,const char*,const char*,PetscErrorCode (*)(PetscViewer));
72: /*MC
73: PetscViewerRegisterDynamic - Adds a method to the Krylov subspace solver package.
75: Synopsis:
76: PetscErrorCode PetscViewerRegisterDynamic(char *name_solver,char *path,char *name_create,PetscErrorCode (*routine_create)(PetscViewer))
78: Not Collective
80: Input Parameters:
81: + name_solver - name of a new user-defined solver
82: . path - path (either absolute or relative) the library containing this solver
83: . name_create - name of routine to create method context
84: - routine_create - routine to create method context
86: Level: developer
88: Notes:
89: PetscViewerRegisterDynamic() may be called multiple times to add several user-defined solvers.
91: If dynamic libraries are used, then the fourth input argument (routine_create)
92: is ignored.
94: Sample usage:
95: .vb
96: PetscViewerRegisterDynamic("my_viewer_type",/home/username/my_lib/lib/libO/solaris/mylib.a,
97: "MyViewerCreate",MyViewerCreate);
98: .ve
100: Then, your solver can be chosen with the procedural interface via
101: $ PetscViewerSetType(ksp,"my_viewer_type")
102: or at runtime via the option
103: $ -viewer_type my_viewer_type
105: Concepts: registering^Viewers
107: .seealso: PetscViewerRegisterAll(), PetscViewerRegisterDestroy()
108: M*/
109: #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
110: #define PetscViewerRegisterDynamic(a,b,c,d) PetscViewerRegister(a,b,c,0)
111: #else
112: #define PetscViewerRegisterDynamic(a,b,c,d) PetscViewerRegister(a,b,c,d)
113: #endif
115: EXTERN PetscErrorCode PetscViewerCreate(MPI_Comm,PetscViewer*);
116: PetscPolymorphicSubroutine(PetscViewerCreate,(PetscViewer *v),(PETSC_COMM_SELF,v))
117: EXTERN PetscErrorCode PetscViewerSetFromOptions(PetscViewer);
119: EXTERN PetscErrorCode PetscViewerASCIIOpen(MPI_Comm,const char[],PetscViewer*);
120: EXTERN PetscErrorCode PetscViewerBinaryCreate(MPI_Comm,PetscViewer*);
121: EXTERN PetscErrorCode PetscViewerBinaryOpen(MPI_Comm,const char[],PetscFileMode,PetscViewer*);
122: EXTERN PetscErrorCode PetscViewerSocketOpen(MPI_Comm,const char[],int,PetscViewer*);
123: EXTERN PetscErrorCode PetscViewerStringOpen(MPI_Comm,char[],PetscInt,PetscViewer*);
124: EXTERN PetscErrorCode PetscViewerDrawOpen(MPI_Comm,const char[],const char[],int,int,int,int,PetscViewer*);
125: EXTERN PetscErrorCode PetscViewerMathematicaOpen(MPI_Comm, int, const char[], const char[], PetscViewer *);
126: EXTERN PetscErrorCode PetscViewerSiloOpen(MPI_Comm, const char[], PetscViewer *);
127: EXTERN PetscErrorCode PetscViewerMatlabOpen(MPI_Comm,const char[],PetscFileMode,PetscViewer*);
129: EXTERN PetscErrorCode PetscViewerGetType(PetscViewer,PetscViewerType*);
130: EXTERN PetscErrorCode PetscViewerSetType(PetscViewer,PetscViewerType);
131: EXTERN PetscErrorCode PetscViewerDestroy(PetscViewer);
132: EXTERN PetscErrorCode PetscViewerGetSingleton(PetscViewer,PetscViewer*);
133: EXTERN PetscErrorCode PetscViewerRestoreSingleton(PetscViewer,PetscViewer*);
135: EXTERN PetscErrorCode PetscViewerSetUp(PetscViewer);
136: EXTERN PetscErrorCode PetscViewerView(PetscViewer,PetscViewer);
138: EXTERN PetscErrorCode PetscViewerSetOptionsPrefix(PetscViewer,const char[]);
139: EXTERN PetscErrorCode PetscViewerAppendOptionsPrefix(PetscViewer,const char[]);
140: EXTERN PetscErrorCode PetscViewerGetOptionsPrefix(PetscViewer,const char*[]);
142: /*E
143: PetscViewerFormat - Way a viewer presents the object
145: Level: beginner
147: .seealso: PetscViewerSetFormat(), PetscViewer, PetscViewerType, PetscViewerPushFormat(), PetscViewerPopFormat()
148: E*/
149: typedef enum {
150: PETSC_VIEWER_ASCII_DEFAULT,
151: PETSC_VIEWER_ASCII_MATLAB,
152: PETSC_VIEWER_ASCII_MATHEMATICA,
153: PETSC_VIEWER_ASCII_IMPL,
154: PETSC_VIEWER_ASCII_INFO,
155: PETSC_VIEWER_ASCII_INFO_DETAIL,
156: PETSC_VIEWER_ASCII_COMMON,
157: PETSC_VIEWER_ASCII_SYMMODU,
158: PETSC_VIEWER_ASCII_INDEX,
159: PETSC_VIEWER_ASCII_DENSE,
160: PETSC_VIEWER_ASCII_VTK,
161: PETSC_VIEWER_ASCII_VTK_CELL,
162: PETSC_VIEWER_ASCII_VTK_COORDS,
163: PETSC_VIEWER_ASCII_PCICE,
164: PETSC_VIEWER_ASCII_PYLITH,
165: PETSC_VIEWER_ASCII_PYLITH_LOCAL,
166: PETSC_VIEWER_BINARY_DEFAULT,
167: PETSC_VIEWER_BINARY_NATIVE,
168: PETSC_VIEWER_DRAW_BASIC,
169: PETSC_VIEWER_DRAW_LG,
170: PETSC_VIEWER_DRAW_CONTOUR,
171: PETSC_VIEWER_DRAW_PORTS,
172: PETSC_VIEWER_NATIVE,
173: PETSC_VIEWER_NOFORMAT,
174: PETSC_VIEWER_ASCII_FACTOR_INFO} PetscViewerFormat;
176: EXTERN PetscErrorCode PetscViewerSetFormat(PetscViewer,PetscViewerFormat);
177: EXTERN PetscErrorCode PetscViewerPushFormat(PetscViewer,PetscViewerFormat);
178: EXTERN PetscErrorCode PetscViewerPopFormat(PetscViewer);
179: EXTERN PetscErrorCode PetscViewerGetFormat(PetscViewer,PetscViewerFormat*);
180: EXTERN PetscErrorCode PetscViewerFlush(PetscViewer);
182: /*S
183: PetscViewerASCIIMonitor - Context for the default KSP, SNES and TS monitors that print
184: ASCII strings of residual norms etc.
187: Level: advanced
189: Concepts: viewing, monitoring
191: .seealso: PetscViewerCreate(), PetscViewerSetType(), PetscViewerType, KSPMonitorSet(), SNESMonitorSet(), TSMonitorSet(),
192: KSPMonitorDefault(), SNESMonitorDefault()
194: S*/
195: struct _p_PetscViewerASCIIMonitor {
196: PetscViewer viewer;
197: PetscInt tabs;
198: };
199: typedef struct _p_PetscViewerASCIIMonitor* PetscViewerASCIIMonitor;
201: EXTERN PetscErrorCode PetscViewerASCIIMonitorCreate(MPI_Comm,const char *,PetscInt,PetscViewerASCIIMonitor*);
202: EXTERN PetscErrorCode PetscViewerASCIIMonitorDestroy(PetscViewerASCIIMonitor);
203: EXTERN PetscErrorCode PetscViewerASCIIMonitorPrintf(PetscViewerASCIIMonitor,const char[],...);
205: /*
206: Operations explicit to a particular class of viewers
207: */
209: EXTERN PetscErrorCode PetscViewerASCIIGetPointer(PetscViewer,FILE**);
210: EXTERN PetscErrorCode PetscViewerFileGetMode(PetscViewer,PetscFileMode*);
211: EXTERN PetscErrorCode PetscViewerFileSetMode(PetscViewer,PetscFileMode);
212: EXTERN PetscErrorCode PetscViewerASCIIPrintf(PetscViewer,const char[],...) PETSC_PRINTF_FORMAT_CHECK(2,3);
213: EXTERN PetscErrorCode PetscViewerASCIISynchronizedPrintf(PetscViewer,const char[],...) PETSC_PRINTF_FORMAT_CHECK(2,3);
214: EXTERN PetscErrorCode PetscViewerASCIIPushTab(PetscViewer);
215: EXTERN PetscErrorCode PetscViewerASCIIPopTab(PetscViewer);
216: EXTERN PetscErrorCode PetscViewerASCIIUseTabs(PetscViewer,PetscTruth);
217: EXTERN PetscErrorCode PetscViewerASCIISetTab(PetscViewer,PetscInt);
218: EXTERN PetscErrorCode PetscViewerBinaryGetDescriptor(PetscViewer,int*);
219: EXTERN PetscErrorCode PetscViewerBinaryGetInfoPointer(PetscViewer,FILE **);
220: EXTERN PetscErrorCode PetscViewerBinaryRead(PetscViewer,void*,PetscInt,PetscDataType);
221: EXTERN PetscErrorCode PetscViewerBinaryWrite(PetscViewer,void*,PetscInt,PetscDataType,PetscTruth);
222: EXTERN PetscErrorCode PetscViewerStringSPrintf(PetscViewer,const char[],...) PETSC_PRINTF_FORMAT_CHECK(2,3);
223: EXTERN PetscErrorCode PetscViewerStringSetString(PetscViewer,char[],PetscInt);
224: EXTERN PetscErrorCode PetscViewerDrawClear(PetscViewer);
225: EXTERN PetscErrorCode PetscViewerDrawSetInfo(PetscViewer,const char[],const char[],int,int,int,int);
226: EXTERN PetscErrorCode PetscViewerSocketSetConnection(PetscViewer,const char[],PetscInt);
227: EXTERN PetscErrorCode PetscViewerBinarySkipInfo(PetscViewer);
228: EXTERN PetscErrorCode PetscViewerBinaryLoadInfo(PetscViewer);
229: EXTERN PetscErrorCode PetscViewerBinarySetSkipOptions(PetscViewer,PetscTruth);
230: EXTERN PetscErrorCode PetscViewerBinaryGetSkipOptions(PetscViewer,PetscTruth*);
231: EXTERN PetscErrorCode PetscViewerBinaryReadStringArray(PetscViewer,char***);
232: EXTERN PetscErrorCode PetscViewerBinaryWriteStringArray(PetscViewer,char**);
234: EXTERN PetscErrorCode PetscViewerFileSetName(PetscViewer,const char[]);
235: EXTERN PetscErrorCode PetscViewerFileGetName(PetscViewer,char**);
237: EXTERN PetscErrorCode PetscPLAPACKInitializePackage(char *);
238: EXTERN PetscErrorCode PetscPLAPACKFinalizePackage(void);
240: EXTERN PetscErrorCode PetscViewerVUGetPointer(PetscViewer, FILE**);
241: EXTERN PetscErrorCode PetscViewerVUSetVecSeen(PetscViewer, PetscTruth);
242: EXTERN PetscErrorCode PetscViewerVUGetVecSeen(PetscViewer, PetscTruth *);
243: EXTERN PetscErrorCode PetscViewerVUPrintDeferred(PetscViewer, const char [], ...) PETSC_PRINTF_FORMAT_CHECK(2,3);
244: EXTERN PetscErrorCode PetscViewerVUFlushDeferred(PetscViewer);
246: EXTERN PetscErrorCode PetscViewerMathematicaInitializePackage(char *);
247: EXTERN PetscErrorCode PetscViewerMathematicaFinalizePackage(void);
248: EXTERN PetscErrorCode PetscViewerMathematicaGetName(PetscViewer, const char **);
249: EXTERN PetscErrorCode PetscViewerMathematicaSetName(PetscViewer, const char []);
250: EXTERN PetscErrorCode PetscViewerMathematicaClearName(PetscViewer);
251: EXTERN PetscErrorCode PetscViewerMathematicaSkipPackets(PetscViewer, int);
253: EXTERN PetscErrorCode PetscViewerSiloGetName(PetscViewer, char **);
254: EXTERN PetscErrorCode PetscViewerSiloSetName(PetscViewer, const char []);
255: EXTERN PetscErrorCode PetscViewerSiloClearName(PetscViewer);
256: EXTERN PetscErrorCode PetscViewerSiloGetMeshName(PetscViewer, char **);
257: EXTERN PetscErrorCode PetscViewerSiloSetMeshName(PetscViewer, const char []);
258: EXTERN PetscErrorCode PetscViewerSiloClearMeshName(PetscViewer);
260: EXTERN PetscErrorCode PetscViewerNetcdfOpen(MPI_Comm,const char[],PetscFileMode,PetscViewer*);
261: EXTERN PetscErrorCode PetscViewerNetcdfGetID(PetscViewer, int *);
263: EXTERN PetscErrorCode PetscViewerHDF4Open(MPI_Comm,const char[],PetscFileMode,PetscViewer*);
264: EXTERN PetscErrorCode PetscViewerHDF4WriteSDS(PetscViewer viewer, float *xf, int d, int *dims, int bs);
266: /*
267: These are all the default viewers that do not have
268: to be explicitly opened
269: */
270: EXTERN PetscViewer PETSC_VIEWER_STDOUT_(MPI_Comm);
271: EXTERN PetscErrorCode PetscViewerASCIIGetStdout(MPI_Comm,PetscViewer*);
272: EXTERN PetscViewer PETSC_VIEWER_STDERR_(MPI_Comm);
273: EXTERN PetscErrorCode PetscViewerASCIIGetStderr(MPI_Comm,PetscViewer*);
274: EXTERN PetscViewer PETSC_VIEWER_DRAW_(MPI_Comm);
275: EXTERN PetscViewer PETSC_VIEWER_SOCKET_(MPI_Comm);
276: EXTERN PetscViewer PETSC_VIEWER_BINARY_(MPI_Comm);
277: EXTERN PetscViewer PETSC_VIEWER_MATLAB_(MPI_Comm);
278: EXTERN PetscViewer PETSC_VIEWER_MATHEMATICA_WORLD_PRIVATE;
280: #define PETSC_VIEWER_STDERR_SELF PETSC_VIEWER_STDERR_(PETSC_COMM_SELF)
281: #define PETSC_VIEWER_STDERR_WORLD PETSC_VIEWER_STDERR_(PETSC_COMM_WORLD)
283: /*MC
284: PETSC_VIEWER_STDOUT_WORLD - same as PETSC_VIEWER_STDOUT_(PETSC_COMM_WORLD)
286: Level: beginner
287: M*/
288: #define PETSC_VIEWER_STDOUT_WORLD PETSC_VIEWER_STDOUT_(PETSC_COMM_WORLD)
290: /*MC
291: PETSC_VIEWER_STDOUT_SELF - same as PETSC_VIEWER_STDOUT_(PETSC_COMM_SELF)
293: Level: beginner
294: M*/
295: #define PETSC_VIEWER_STDOUT_SELF PETSC_VIEWER_STDOUT_(PETSC_COMM_SELF)
297: /*MC
298: PETSC_VIEWER_DRAW_WORLD - same as PETSC_VIEWER_DRAW_(PETSC_COMM_WORLD)
300: Level: intermediate
301: M*/
302: #define PETSC_VIEWER_DRAW_WORLD PETSC_VIEWER_DRAW_(PETSC_COMM_WORLD)
304: /*MC
305: PETSC_VIEWER_DRAW_SELF - same as PETSC_VIEWER_DRAW_(PETSC_COMM_SELF)
307: Level: intermediate
308: M*/
309: #define PETSC_VIEWER_DRAW_SELF PETSC_VIEWER_DRAW_(PETSC_COMM_SELF)
311: /*MC
312: PETSC_VIEWER_SOCKET_WORLD - same as PETSC_VIEWER_SOCKET_(PETSC_COMM_WORLD)
314: Level: intermediate
315: M*/
316: #define PETSC_VIEWER_SOCKET_WORLD PETSC_VIEWER_SOCKET_(PETSC_COMM_WORLD)
318: /*MC
319: PETSC_VIEWER_SOCKET_SELF - same as PETSC_VIEWER_SOCKET_(PETSC_COMM_SELF)
321: Level: intermediate
322: M*/
323: #define PETSC_VIEWER_SOCKET_SELF PETSC_VIEWER_SOCKET_(PETSC_COMM_SELF)
325: /*MC
326: PETSC_VIEWER_BINARY_WORLD - same as PETSC_VIEWER_BINARY_(PETSC_COMM_WORLD)
328: Level: intermediate
329: M*/
330: #define PETSC_VIEWER_BINARY_WORLD PETSC_VIEWER_BINARY_(PETSC_COMM_WORLD)
332: /*MC
333: PETSC_VIEWER_BINARY_SELF - same as PETSC_VIEWER_BINARY_(PETSC_COMM_SELF)
335: Level: intermediate
336: M*/
337: #define PETSC_VIEWER_BINARY_SELF PETSC_VIEWER_BINARY_(PETSC_COMM_SELF)
339: /*MC
340: PETSC_VIEWER_MATLAB_WORLD - same as PETSC_VIEWER_MATLAB_(PETSC_COMM_WORLD)
342: Level: intermediate
343: M*/
344: #define PETSC_VIEWER_MATLAB_WORLD PETSC_VIEWER_MATLAB_(PETSC_COMM_WORLD)
346: /*MC
347: PETSC_VIEWER_MATLAB_SELF - same as PETSC_VIEWER_MATLAB_(PETSC_COMM_SELF)
349: Level: intermediate
350: M*/
351: #define PETSC_VIEWER_MATLAB_SELF PETSC_VIEWER_MATLAB_(PETSC_COMM_SELF)
353: #define PETSC_VIEWER_MATHEMATICA_WORLD (PetscViewerInitializeMathematicaWorld_Private(),PETSC_VIEWER_MATHEMATICA_WORLD_PRIVATE)
355: /*
356: petscViewer writes to Matlab .mat file
357: */
358: EXTERN PetscErrorCode PetscViewerMatlabPutArray(PetscViewer,int,int,PetscScalar*,char*);
359: EXTERN PetscErrorCode PetscViewerMatlabGetArray(PetscViewer,int,int,PetscScalar*,char*);
360: EXTERN PetscErrorCode PetscViewerMatlabPutVariable(PetscViewer,const char*,void*);
362: /*S
363: PetscViewers - Abstract collection of PetscViewers
365: Level: intermediate
367: Concepts: viewing
369: .seealso: PetscViewerCreate(), PetscViewerSetType(), PetscViewerType, PetscViewer, PetscViewersCreate(),
370: PetscViewersGetViewer()
371: S*/
372: typedef struct _n_PetscViewers* PetscViewers;
373: EXTERN PetscErrorCode PetscViewersCreate(MPI_Comm,PetscViewers*);
374: EXTERN PetscErrorCode PetscViewersDestroy(PetscViewers);
375: EXTERN PetscErrorCode PetscViewersGetViewer(PetscViewers,int,PetscViewer*);
378: #endif