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_HDF5         "hdf5"
 65: #define PETSC_VIEWER_MATLAB       "matlab"

 68: EXTERN PetscErrorCode  PetscViewerRegisterAll(const char *);
 69: EXTERN PetscErrorCode  PetscViewerRegisterDestroy(void);
 70: EXTERN PetscErrorCode  PetscViewerInitializePackage(const char[]);

 72: EXTERN PetscErrorCode  PetscViewerRegister(const char*,const char*,const char*,PetscErrorCode (*)(PetscViewer));

 74: /*MC
 75:    PetscViewerRegisterDynamic - Adds a method to the Krylov subspace solver package.

 77:    Synopsis:
 78:    PetscErrorCode PetscViewerRegisterDynamic(char *name_solver,char *path,char *name_create,PetscErrorCode (*routine_create)(PetscViewer))

 80:    Not Collective

 82:    Input Parameters:
 83: +  name_solver - name of a new user-defined solver
 84: .  path - path (either absolute or relative) the library containing this solver
 85: .  name_create - name of routine to create method context
 86: -  routine_create - routine to create method context

 88:    Level: developer

 90:    Notes:
 91:    PetscViewerRegisterDynamic() may be called multiple times to add several user-defined solvers.

 93:    If dynamic libraries are used, then the fourth input argument (routine_create)
 94:    is ignored.

 96:    Sample usage:
 97: .vb
 98:    PetscViewerRegisterDynamic("my_viewer_type",/home/username/my_lib/lib/libO/solaris/mylib.a,
 99:                "MyViewerCreate",MyViewerCreate);
100: .ve

102:    Then, your solver can be chosen with the procedural interface via
103: $     PetscViewerSetType(ksp,"my_viewer_type")
104:    or at runtime via the option
105: $     -viewer_type my_viewer_type

107:   Concepts: registering^Viewers

109: .seealso: PetscViewerRegisterAll(), PetscViewerRegisterDestroy()
110: M*/
111: #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
112: #define PetscViewerRegisterDynamic(a,b,c,d) PetscViewerRegister(a,b,c,0)
113: #else
114: #define PetscViewerRegisterDynamic(a,b,c,d) PetscViewerRegister(a,b,c,d)
115: #endif

117: EXTERN PetscErrorCode  PetscViewerCreate(MPI_Comm,PetscViewer*);
118: PetscPolymorphicSubroutine(PetscViewerCreate,(PetscViewer *v),(PETSC_COMM_SELF,v))
119: EXTERN PetscErrorCode  PetscViewerSetFromOptions(PetscViewer);

121: EXTERN PetscErrorCode  PetscViewerASCIIOpen(MPI_Comm,const char[],PetscViewer*);
122: EXTERN PetscErrorCode  PetscViewerBinaryCreate(MPI_Comm,PetscViewer*);
123: EXTERN PetscErrorCode  PetscViewerBinaryOpen(MPI_Comm,const char[],PetscFileMode,PetscViewer*);
124: EXTERN PetscErrorCode  PetscViewerSocketOpen(MPI_Comm,const char[],int,PetscViewer*);
125: EXTERN PetscErrorCode  PetscViewerStringOpen(MPI_Comm,char[],PetscInt,PetscViewer*);
126: EXTERN PetscErrorCode  PetscViewerDrawOpen(MPI_Comm,const char[],const char[],int,int,int,int,PetscViewer*);
127: EXTERN PetscErrorCode  PetscViewerMathematicaOpen(MPI_Comm, int, const char[], const char[], PetscViewer *);
128: EXTERN PetscErrorCode  PetscViewerSiloOpen(MPI_Comm, const char[], PetscViewer *);
129: EXTERN PetscErrorCode  PetscViewerMatlabOpen(MPI_Comm,const char[],PetscFileMode,PetscViewer*);

131: EXTERN PetscErrorCode  PetscViewerGetType(PetscViewer,PetscViewerType*);
132: EXTERN PetscErrorCode  PetscViewerSetType(PetscViewer,PetscViewerType);
133: EXTERN PetscErrorCode  PetscViewerDestroy(PetscViewer);
134: EXTERN PetscErrorCode  PetscViewerGetSingleton(PetscViewer,PetscViewer*);
135: EXTERN PetscErrorCode  PetscViewerRestoreSingleton(PetscViewer,PetscViewer*);
136: EXTERN PetscErrorCode  PetscViewerGetSubcomm(PetscViewer,MPI_Comm,PetscViewer*);
137: EXTERN PetscErrorCode  PetscViewerRestoreSubcomm(PetscViewer,MPI_Comm,PetscViewer*);

139: EXTERN PetscErrorCode  PetscViewerSetUp(PetscViewer);
140: EXTERN PetscErrorCode  PetscViewerView(PetscViewer,PetscViewer);

142: EXTERN PetscErrorCode  PetscViewerSetOptionsPrefix(PetscViewer,const char[]);
143: EXTERN PetscErrorCode  PetscViewerAppendOptionsPrefix(PetscViewer,const char[]);
144: EXTERN PetscErrorCode  PetscViewerGetOptionsPrefix(PetscViewer,const char*[]);

146: /*E
147:     PetscViewerFormat - Way a viewer presents the object

149:    Level: beginner

151: .seealso: PetscViewerSetFormat(), PetscViewer, PetscViewerType, PetscViewerPushFormat(), PetscViewerPopFormat()
152: E*/
153: typedef enum {
154:   PETSC_VIEWER_ASCII_DEFAULT,
155:   PETSC_VIEWER_ASCII_MATLAB,
156:   PETSC_VIEWER_ASCII_MATHEMATICA,
157:   PETSC_VIEWER_ASCII_IMPL,
158:   PETSC_VIEWER_ASCII_INFO,
159:   PETSC_VIEWER_ASCII_INFO_DETAIL,
160:   PETSC_VIEWER_ASCII_COMMON,
161:   PETSC_VIEWER_ASCII_SYMMODU,
162:   PETSC_VIEWER_ASCII_INDEX,
163:   PETSC_VIEWER_ASCII_DENSE,
164:   PETSC_VIEWER_ASCII_VTK,
165:   PETSC_VIEWER_ASCII_VTK_CELL,
166:   PETSC_VIEWER_ASCII_VTK_COORDS,
167:   PETSC_VIEWER_ASCII_PCICE,
168:   PETSC_VIEWER_ASCII_PYLITH,
169:   PETSC_VIEWER_ASCII_PYLITH_LOCAL,
170:   PETSC_VIEWER_BINARY_DEFAULT,
171:   PETSC_VIEWER_BINARY_NATIVE,
172:   PETSC_VIEWER_DRAW_BASIC,
173:   PETSC_VIEWER_DRAW_LG,
174:   PETSC_VIEWER_DRAW_CONTOUR,
175:   PETSC_VIEWER_DRAW_PORTS,
176:   PETSC_VIEWER_NATIVE,
177:   PETSC_VIEWER_NOFORMAT,
178:   PETSC_VIEWER_ASCII_FACTOR_INFO} PetscViewerFormat;

180: EXTERN PetscErrorCode  PetscViewerSetFormat(PetscViewer,PetscViewerFormat);
181: EXTERN PetscErrorCode  PetscViewerPushFormat(PetscViewer,PetscViewerFormat);
182: EXTERN PetscErrorCode  PetscViewerPopFormat(PetscViewer);
183: EXTERN PetscErrorCode  PetscViewerGetFormat(PetscViewer,PetscViewerFormat*);
184: EXTERN PetscErrorCode  PetscViewerFlush(PetscViewer);

186: /*S
187:      PetscViewerASCIIMonitor - Context for the default KSP, SNES and TS monitors that print
188:                                   ASCII strings of residual norms etc.


191:    Level: advanced

193:   Concepts: viewing, monitoring

195: .seealso:  PetscViewerCreate(), PetscViewerSetType(), PetscViewerType, KSPMonitorSet(), SNESMonitorSet(), TSMonitorSet(),
196:            KSPMonitorDefault(), SNESMonitorDefault()

198: S*/
199: struct _p_PetscViewerASCIIMonitor {
200:   PetscViewer viewer;
201:   PetscInt    tabs;
202: };
203: typedef struct _p_PetscViewerASCIIMonitor* PetscViewerASCIIMonitor;

205: EXTERN PetscErrorCode  PetscViewerASCIIMonitorCreate(MPI_Comm,const char *,PetscInt,PetscViewerASCIIMonitor*);
206: EXTERN PetscErrorCode  PetscViewerASCIIMonitorDestroy(PetscViewerASCIIMonitor);
207: EXTERN PetscErrorCode  PetscViewerASCIIMonitorPrintf(PetscViewerASCIIMonitor,const char[],...);

209: /*
210:    Operations explicit to a particular class of viewers
211: */

213: EXTERN PetscErrorCode  PetscViewerASCIIGetPointer(PetscViewer,FILE**);
214: EXTERN PetscErrorCode  PetscViewerFileGetMode(PetscViewer,PetscFileMode*);
215: EXTERN PetscErrorCode  PetscViewerFileSetMode(PetscViewer,PetscFileMode);
216: EXTERN PetscErrorCode  PetscViewerASCIIPrintf(PetscViewer,const char[],...) PETSC_PRINTF_FORMAT_CHECK(2,3);
217: EXTERN PetscErrorCode  PetscViewerASCIISynchronizedPrintf(PetscViewer,const char[],...) PETSC_PRINTF_FORMAT_CHECK(2,3);
218: EXTERN PetscErrorCode  PetscViewerASCIIPushTab(PetscViewer);
219: EXTERN PetscErrorCode  PetscViewerASCIIPopTab(PetscViewer);
220: EXTERN PetscErrorCode  PetscViewerASCIIUseTabs(PetscViewer,PetscTruth);
221: EXTERN PetscErrorCode  PetscViewerASCIISetTab(PetscViewer,PetscInt);
222: EXTERN PetscErrorCode  PetscViewerBinaryGetDescriptor(PetscViewer,int*);
223: EXTERN PetscErrorCode  PetscViewerBinaryGetInfoPointer(PetscViewer,FILE **);
224: EXTERN PetscErrorCode  PetscViewerBinaryRead(PetscViewer,void*,PetscInt,PetscDataType);
225: EXTERN PetscErrorCode  PetscViewerBinaryWrite(PetscViewer,void*,PetscInt,PetscDataType,PetscTruth);
226: EXTERN PetscErrorCode  PetscViewerStringSPrintf(PetscViewer,const char[],...) PETSC_PRINTF_FORMAT_CHECK(2,3);
227: EXTERN PetscErrorCode  PetscViewerStringSetString(PetscViewer,char[],PetscInt);
228: EXTERN PetscErrorCode  PetscViewerDrawClear(PetscViewer);
229: EXTERN PetscErrorCode  PetscViewerDrawSetInfo(PetscViewer,const char[],const char[],int,int,int,int);
230: EXTERN PetscErrorCode  PetscViewerSocketSetConnection(PetscViewer,const char[],PetscInt);
231: EXTERN PetscErrorCode  PetscViewerBinarySkipInfo(PetscViewer);
232: EXTERN PetscErrorCode  PetscViewerBinaryLoadInfo(PetscViewer);
233: EXTERN PetscErrorCode  PetscViewerBinarySetSkipOptions(PetscViewer,PetscTruth);
234: EXTERN PetscErrorCode  PetscViewerBinaryGetSkipOptions(PetscViewer,PetscTruth*);
235: EXTERN PetscErrorCode  PetscViewerBinaryReadStringArray(PetscViewer,char***);
236: EXTERN PetscErrorCode  PetscViewerBinaryWriteStringArray(PetscViewer,char**);

238: EXTERN PetscErrorCode  PetscViewerFileSetName(PetscViewer,const char[]);
239: EXTERN PetscErrorCode  PetscViewerFileGetName(PetscViewer,char**);

241: EXTERN PetscErrorCode  PetscPLAPACKInitializePackage(const char[]);
242: EXTERN PetscErrorCode  PetscPLAPACKFinalizePackage(void);

244: EXTERN PetscErrorCode  PetscViewerVUGetPointer(PetscViewer, FILE**);
245: EXTERN PetscErrorCode  PetscViewerVUSetVecSeen(PetscViewer, PetscTruth);
246: EXTERN PetscErrorCode  PetscViewerVUGetVecSeen(PetscViewer, PetscTruth *);
247: EXTERN PetscErrorCode  PetscViewerVUPrintDeferred(PetscViewer, const char [], ...) PETSC_PRINTF_FORMAT_CHECK(2,3);
248: EXTERN PetscErrorCode  PetscViewerVUFlushDeferred(PetscViewer);

250: EXTERN PetscErrorCode  PetscViewerMathematicaInitializePackage(const char[]);
251: EXTERN PetscErrorCode  PetscViewerMathematicaFinalizePackage(void);
252: EXTERN PetscErrorCode  PetscViewerMathematicaGetName(PetscViewer, const char **);
253: EXTERN PetscErrorCode  PetscViewerMathematicaSetName(PetscViewer, const char []);
254: EXTERN PetscErrorCode  PetscViewerMathematicaClearName(PetscViewer);
255: EXTERN PetscErrorCode  PetscViewerMathematicaSkipPackets(PetscViewer, int);

257: EXTERN PetscErrorCode  PetscViewerSiloGetName(PetscViewer, char **);
258: EXTERN PetscErrorCode  PetscViewerSiloSetName(PetscViewer, const char []);
259: EXTERN PetscErrorCode  PetscViewerSiloClearName(PetscViewer);
260: EXTERN PetscErrorCode  PetscViewerSiloGetMeshName(PetscViewer, char **);
261: EXTERN PetscErrorCode  PetscViewerSiloSetMeshName(PetscViewer, const char []);
262: EXTERN PetscErrorCode  PetscViewerSiloClearMeshName(PetscViewer);

264: EXTERN PetscErrorCode  PetscViewerNetcdfOpen(MPI_Comm,const char[],PetscFileMode,PetscViewer*);
265: EXTERN PetscErrorCode  PetscViewerNetcdfGetID(PetscViewer, int *);

267: EXTERN PetscErrorCode  PetscViewerHDF4Open(MPI_Comm,const char[],PetscFileMode,PetscViewer*);
268: EXTERN PetscErrorCode  PetscViewerHDF4WriteSDS(PetscViewer,float *,int,int *,int);

270: EXTERN PetscErrorCode  PetscViewerHDF5Open(MPI_Comm,const char[],PetscFileMode,PetscViewer*);
271: #ifdef PETSC_HAVE_HDF5
272: #include <hdf5.h>
273: EXTERN PetscErrorCode  PetscViewerHDF5GetFileId(PetscViewer viewer, hid_t *file_id);
274: #endif

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

290: #define PETSC_VIEWER_STDERR_SELF  PETSC_VIEWER_STDERR_(PETSC_COMM_SELF)
291: #define PETSC_VIEWER_STDERR_WORLD PETSC_VIEWER_STDERR_(PETSC_COMM_WORLD)

293: /*MC
294:   PETSC_VIEWER_STDOUT_WORLD  - same as PETSC_VIEWER_STDOUT_(PETSC_COMM_WORLD)

296:   Level: beginner
297: M*/
298: #define PETSC_VIEWER_STDOUT_WORLD PETSC_VIEWER_STDOUT_(PETSC_COMM_WORLD)

300: /*MC
301:   PETSC_VIEWER_STDOUT_SELF  - same as PETSC_VIEWER_STDOUT_(PETSC_COMM_SELF)

303:   Level: beginner
304: M*/
305: #define PETSC_VIEWER_STDOUT_SELF  PETSC_VIEWER_STDOUT_(PETSC_COMM_SELF)

307: /*MC
308:   PETSC_VIEWER_DRAW_WORLD  - same as PETSC_VIEWER_DRAW_(PETSC_COMM_WORLD)

310:   Level: intermediate
311: M*/
312: #define PETSC_VIEWER_DRAW_WORLD   PETSC_VIEWER_DRAW_(PETSC_COMM_WORLD)

314: /*MC
315:   PETSC_VIEWER_DRAW_SELF  - same as PETSC_VIEWER_DRAW_(PETSC_COMM_SELF)

317:   Level: intermediate
318: M*/
319: #define PETSC_VIEWER_DRAW_SELF    PETSC_VIEWER_DRAW_(PETSC_COMM_SELF)

321: /*MC
322:   PETSC_VIEWER_SOCKET_WORLD  - same as PETSC_VIEWER_SOCKET_(PETSC_COMM_WORLD)

324:   Level: intermediate
325: M*/
326: #define PETSC_VIEWER_SOCKET_WORLD PETSC_VIEWER_SOCKET_(PETSC_COMM_WORLD)

328: /*MC
329:   PETSC_VIEWER_SOCKET_SELF  - same as PETSC_VIEWER_SOCKET_(PETSC_COMM_SELF)

331:   Level: intermediate
332: M*/
333: #define PETSC_VIEWER_SOCKET_SELF  PETSC_VIEWER_SOCKET_(PETSC_COMM_SELF)

335: /*MC
336:   PETSC_VIEWER_BINARY_WORLD  - same as PETSC_VIEWER_BINARY_(PETSC_COMM_WORLD)

338:   Level: intermediate
339: M*/
340: #define PETSC_VIEWER_BINARY_WORLD PETSC_VIEWER_BINARY_(PETSC_COMM_WORLD)

342: /*MC
343:   PETSC_VIEWER_BINARY_SELF  - same as PETSC_VIEWER_BINARY_(PETSC_COMM_SELF)

345:   Level: intermediate
346: M*/
347: #define PETSC_VIEWER_BINARY_SELF  PETSC_VIEWER_BINARY_(PETSC_COMM_SELF)

349: /*MC
350:   PETSC_VIEWER_MATLAB_WORLD  - same as PETSC_VIEWER_MATLAB_(PETSC_COMM_WORLD)

352:   Level: intermediate
353: M*/
354: #define PETSC_VIEWER_MATLAB_WORLD PETSC_VIEWER_MATLAB_(PETSC_COMM_WORLD)

356: /*MC
357:   PETSC_VIEWER_MATLAB_SELF  - same as PETSC_VIEWER_MATLAB_(PETSC_COMM_SELF)

359:   Level: intermediate
360: M*/
361: #define PETSC_VIEWER_MATLAB_SELF  PETSC_VIEWER_MATLAB_(PETSC_COMM_SELF)

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

365: /*
366:    petscViewer writes to Matlab .mat file
367: */
368: EXTERN PetscErrorCode  PetscViewerMatlabPutArray(PetscViewer,int,int,PetscScalar*,char*);
369: EXTERN PetscErrorCode  PetscViewerMatlabGetArray(PetscViewer,int,int,PetscScalar*,char*);
370: EXTERN PetscErrorCode  PetscViewerMatlabPutVariable(PetscViewer,const char*,void*);

372: /*S
373:      PetscViewers - Abstract collection of PetscViewers

375:    Level: intermediate

377:   Concepts: viewing

379: .seealso:  PetscViewerCreate(), PetscViewerSetType(), PetscViewerType, PetscViewer, PetscViewersCreate(),
380:            PetscViewersGetViewer()
381: S*/
382: typedef struct _n_PetscViewers* PetscViewers;
383: EXTERN PetscErrorCode  PetscViewersCreate(MPI_Comm,PetscViewers*);
384: EXTERN PetscErrorCode  PetscViewersDestroy(PetscViewers);
385: EXTERN PetscErrorCode  PetscViewersGetViewer(PetscViewers,PetscInt,PetscViewer*);

388: #endif