184cb2905SBarry Smith /* 2b0a32e0cSBarry Smith PetscViewers are objects where other objects can be looked at or stored. 384cb2905SBarry Smith */ 43c119ea2SBarry Smith 50a835dfdSSatish Balay #if !defined(__PETSCVIEWER_H) 60a835dfdSSatish Balay #define __PETSCVIEWER_H 7dfbe8321SBarry Smith 86420c192SJed Brown #include <petscsys.h> 9c619b03eSJed Brown #include <petscviewertypes.h> 100954c5ccSStefano Zampini #include <petscdrawtypes.h> 11e9fa29b7SSatish Balay 12014dd563SJed Brown PETSC_EXTERN PetscClassId PETSC_VIEWER_CLASSID; 13e9fa29b7SSatish Balay 1476bdecfbSBarry Smith /*J 15b9617806SBarry Smith PetscViewerType - String with the name of a PETSc PETScViewer 16b9617806SBarry Smith 17b9617806SBarry Smith Level: beginner 18b9617806SBarry Smith 198f6c3df8SBarry Smith .seealso: PetscViewerSetType(), PetscViewer, PetscViewerRegister(), PetscViewerCreate() 2076bdecfbSBarry Smith J*/ 2119fd82e9SBarry Smith typedef const char* PetscViewerType; 222692d6eeSBarry Smith #define PETSCVIEWERSOCKET "socket" 232692d6eeSBarry Smith #define PETSCVIEWERASCII "ascii" 242692d6eeSBarry Smith #define PETSCVIEWERBINARY "binary" 252692d6eeSBarry Smith #define PETSCVIEWERSTRING "string" 262692d6eeSBarry Smith #define PETSCVIEWERDRAW "draw" 272692d6eeSBarry Smith #define PETSCVIEWERVU "vu" 282692d6eeSBarry Smith #define PETSCVIEWERMATHEMATICA "mathematica" 292692d6eeSBarry Smith #define PETSCVIEWERHDF5 "hdf5" 304061b8bfSJed Brown #define PETSCVIEWERVTK "vtk" 312692d6eeSBarry Smith #define PETSCVIEWERMATLAB "matlab" 32e04113cfSBarry Smith #define PETSCVIEWERSAWS "saws" 338135c375SStefano Zampini #define PETSCVIEWERGLVIS "glvis" 3477ed5343SBarry Smith 35140e18c1SBarry Smith PETSC_EXTERN PetscFunctionList PetscViewerList; 36607a6623SBarry Smith PETSC_EXTERN PetscErrorCode PetscViewerInitializePackage(void); 377b2a1423SBarry Smith 38bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode PetscViewerRegister(const char[],PetscErrorCode (*)(PetscViewer)); 3930de9b25SBarry Smith 40014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerCreate(MPI_Comm,PetscViewer*); 41014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerSetFromOptions(PetscViewer); 42014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerASCIIOpenWithFILE(MPI_Comm,FILE*,PetscViewer*); 437b2a1423SBarry Smith 44014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerASCIIOpen(MPI_Comm,const char[],PetscViewer*); 45014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerASCIISetFILE(PetscViewer,FILE*); 46014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerBinaryOpen(MPI_Comm,const char[],PetscFileMode,PetscViewer*); 47014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetFlowControl(PetscViewer,PetscInt*); 48014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerBinarySetFlowControl(PetscViewer,PetscInt); 49bc196f7cSDave May PETSC_EXTERN PetscErrorCode PetscViewerBinarySetUseMPIIO(PetscViewer,PetscBool); 50bc196f7cSDave May PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetUseMPIIO(PetscViewer,PetscBool *); 510fc9d207SBarry Smith #if defined(PETSC_HAVE_MPIIO) 52014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetMPIIODescriptor(PetscViewer,MPI_File*); 53014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetMPIIOOffset(PetscViewer,MPI_Offset*); 54014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerBinaryAddMPIIOOffset(PetscViewer,MPI_Offset); 55951e3c8eSBarry Smith #endif 5639802e9eSBarry Smith 57014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerSocketOpen(MPI_Comm,const char[],int,PetscViewer*); 5889d949e2SBarry Smith PETSC_EXTERN PetscErrorCode PetscViewerStringOpen(MPI_Comm,char[],size_t,PetscViewer*); 59014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerDrawOpen(MPI_Comm,const char[],const char[],int,int,int,int,PetscViewer*); 60d1da0b69SBarry Smith PETSC_EXTERN PetscErrorCode PetscViewerDrawSetDrawType(PetscViewer,PetscDrawType); 611f49e1f7SLisandro Dalcin PETSC_EXTERN PetscErrorCode PetscViewerDrawGetDrawType(PetscViewer,PetscDrawType*); 62f55236e4SLisandro Dalcin PETSC_EXTERN PetscErrorCode PetscViewerDrawSetTitle(PetscViewer,const char[]); 63f55236e4SLisandro Dalcin PETSC_EXTERN PetscErrorCode PetscViewerDrawGetTitle(PetscViewer,const char*[]); 640954c5ccSStefano Zampini PETSC_EXTERN PetscErrorCode PetscViewerDrawGetDraw(PetscViewer,PetscInt,PetscDraw*); 650954c5ccSStefano Zampini PETSC_EXTERN PetscErrorCode PetscViewerDrawBaseAdd(PetscViewer,PetscInt); 660954c5ccSStefano Zampini PETSC_EXTERN PetscErrorCode PetscViewerDrawBaseSet(PetscViewer,PetscInt); 670954c5ccSStefano Zampini PETSC_EXTERN PetscErrorCode PetscViewerDrawGetDrawLG(PetscViewer,PetscInt,PetscDrawLG*); 680954c5ccSStefano Zampini PETSC_EXTERN PetscErrorCode PetscViewerDrawGetDrawAxis(PetscViewer,PetscInt,PetscDrawAxis*); 690954c5ccSStefano Zampini 70014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerMathematicaOpen(MPI_Comm, int, const char[], const char[], PetscViewer *); 71014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerSiloOpen(MPI_Comm, const char[], PetscViewer *); 72014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerMatlabOpen(MPI_Comm,const char[],PetscFileMode,PetscViewer*); 734b0e389bSBarry Smith 748135c375SStefano Zampini /*E 758135c375SStefano Zampini PetscViewerGLVisType - indicates what type of GLVis viewer to use 768135c375SStefano Zampini 778135c375SStefano Zampini Level: beginner 788135c375SStefano Zampini 798135c375SStefano Zampini .seealso: PetscViewerGLVisOpen() 808135c375SStefano Zampini E*/ 818135c375SStefano Zampini typedef enum {PETSC_VIEWER_GLVIS_DUMP, PETSC_VIEWER_GLVIS_SOCKET} PetscViewerGLVisType; 828135c375SStefano Zampini PETSC_EXTERN PetscErrorCode PetscViewerGLVisOpen(MPI_Comm,PetscViewerGLVisType,const char*,PetscInt,PetscViewer*); 8377eacf09SStefano Zampini PETSC_EXTERN PetscErrorCode PetscViewerGLVisSetPrecision(PetscViewer,PetscInt); 848135c375SStefano Zampini PETSC_EXTERN PetscErrorCode PetscViewerGLVisSetSnapId(PetscViewer,PetscInt); 854cac2994SStefano Zampini PETSC_EXTERN PetscErrorCode PetscViewerGLVisSetFields(PetscViewer,PetscInt,const char*[],PetscInt[],PetscErrorCode(*)(PetscObject,PetscInt,PetscObject[],void*),PetscObject[],void*,PetscErrorCode(*)(void*)); 868135c375SStefano Zampini 8719fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode PetscViewerGetType(PetscViewer,PetscViewerType*); 8819fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode PetscViewerSetType(PetscViewer,PetscViewerType); 89014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerDestroy(PetscViewer*); 903f08860eSBarry Smith PETSC_EXTERN PetscErrorCode PetscViewerGetSubViewer(PetscViewer,MPI_Comm,PetscViewer*); 913f08860eSBarry Smith PETSC_EXTERN PetscErrorCode PetscViewerRestoreSubViewer(PetscViewer,MPI_Comm,PetscViewer*); 92ae39576cSLois Curfman McInnes 93014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerSetUp(PetscViewer); 94014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerView(PetscViewer,PetscViewer); 95685405a1SBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscViewerViewFromOptions(PetscViewer A,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,name);} 96f69a0ea3SMatthew Knepley 97014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerSetOptionsPrefix(PetscViewer,const char[]); 98014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerAppendOptionsPrefix(PetscViewer,const char[]); 99014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerGetOptionsPrefix(PetscViewer,const char*[]); 100090de74eSSatish Balay 101b9617806SBarry Smith /*E 102b9617806SBarry Smith PetscViewerFormat - Way a viewer presents the object 103b9617806SBarry Smith 104b9617806SBarry Smith Level: beginner 105b9617806SBarry Smith 106af0996ceSBarry Smith The values below are also listed in petsc/finclude/petscviewer.h. If another values is added below it 107cfaaf4edSHong Zhang must also be added there. 108cfaaf4edSHong Zhang 1096a9046bcSBarry Smith .seealso: PetscViewer, PetscViewerType, PetscViewerPushFormat(), PetscViewerPopFormat() 110b9617806SBarry Smith E*/ 111fb9695e5SSatish Balay typedef enum { 112117016b1SBarry Smith PETSC_VIEWER_DEFAULT, 113f3ef73ceSBarry Smith PETSC_VIEWER_ASCII_MATLAB, 1144ebda54eSMatthew Knepley PETSC_VIEWER_ASCII_MATHEMATICA, 115f3ef73ceSBarry Smith PETSC_VIEWER_ASCII_IMPL, 116f3ef73ceSBarry Smith PETSC_VIEWER_ASCII_INFO, 117456192e2SBarry Smith PETSC_VIEWER_ASCII_INFO_DETAIL, 118f3ef73ceSBarry Smith PETSC_VIEWER_ASCII_COMMON, 119f3ef73ceSBarry Smith PETSC_VIEWER_ASCII_SYMMODU, 120f3ef73ceSBarry Smith PETSC_VIEWER_ASCII_INDEX, 121f3ef73ceSBarry Smith PETSC_VIEWER_ASCII_DENSE, 1223c215bfdSMatthew Knepley PETSC_VIEWER_ASCII_MATRIXMARKET, 123a505fa5bSMatthew Knepley PETSC_VIEWER_ASCII_VTK, 124b85befe5SMatthew Knepley PETSC_VIEWER_ASCII_VTK_CELL, 125b6d733afSMatthew Knepley PETSC_VIEWER_ASCII_VTK_COORDS, 126493617b5SMatthew Knepley PETSC_VIEWER_ASCII_PCICE, 127cfaaf4edSHong Zhang PETSC_VIEWER_ASCII_PYTHON, 128cfaaf4edSHong Zhang PETSC_VIEWER_ASCII_FACTOR_INFO, 12967ad5babSMatthew G Knepley PETSC_VIEWER_ASCII_LATEX, 130bb1d7374SBarry Smith PETSC_VIEWER_ASCII_XML, 1318135c375SStefano Zampini PETSC_VIEWER_ASCII_GLVIS, 132f3ef73ceSBarry Smith PETSC_VIEWER_DRAW_BASIC, 133f3ef73ceSBarry Smith PETSC_VIEWER_DRAW_LG, 134f3ef73ceSBarry Smith PETSC_VIEWER_DRAW_CONTOUR, 135f3ef73ceSBarry Smith PETSC_VIEWER_DRAW_PORTS, 1364061b8bfSJed Brown PETSC_VIEWER_VTK_VTS, 137a13bc4e3SShao-Ching Huang PETSC_VIEWER_VTK_VTR, 138b263465dSJed Brown PETSC_VIEWER_VTK_VTU, 139a261c58fSBarry Smith PETSC_VIEWER_BINARY_MATLAB, 140f3ef73ceSBarry Smith PETSC_VIEWER_NATIVE, 141*8aa4816bSVaclav Hapla PETSC_VIEWER_HDF5_PETSC, 142ffe0aed0SMatthew G. Knepley PETSC_VIEWER_HDF5_VIZ, 143*8aa4816bSVaclav Hapla PETSC_VIEWER_HDF5_XDMF, 144ef5fdb51SBarry Smith PETSC_VIEWER_NOFORMAT, 145ef5fdb51SBarry Smith PETSC_VIEWER_LOAD_BALANCE 146cfaaf4edSHong Zhang } PetscViewerFormat; 147014dd563SJed Brown PETSC_EXTERN const char *const PetscViewerFormats[]; 148090de74eSSatish Balay 1496a9046bcSBarry Smith PETSC_EXTERN PETSC_DEPRECATED("Use PetscViewerPushFormat()/PetscViewerPopFormat()") PetscErrorCode PetscViewerSetFormat(PetscViewer,PetscViewerFormat); 150014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerPushFormat(PetscViewer,PetscViewerFormat); 151014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerPopFormat(PetscViewer); 152014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerGetFormat(PetscViewer,PetscViewerFormat*); 153014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerFlush(PetscViewer); 1544b0e389bSBarry Smith 155eb55bdffSLawrence Mitchell PETSC_EXTERN PetscErrorCode PetscOptionsPushGetViewerOff(PetscBool); 156a30ec4eaSSatish Balay PETSC_EXTERN PetscErrorCode PetscOptionsPopGetViewerOff(void); 157eb55bdffSLawrence Mitchell PETSC_EXTERN PetscErrorCode PetscOptionsGetViewerOff(PetscBool*); 158cffb1e40SBarry Smith PETSC_EXTERN PetscErrorCode PetscOptionsGetViewer(MPI_Comm,const char[],const char[],PetscViewer*,PetscViewerFormat*,PetscBool*); 159e55864a3SBarry Smith #define PetscOptionsViewer(a,b,c,d,e,f) PetscOptionsViewer_Private(PetscOptionsObject,a,b,c,d,e,f); 1604416b707SBarry Smith PETSC_EXTERN PetscErrorCode PetscOptionsViewer_Private(PetscOptionItems*,const char[],const char[],const char[],PetscViewer*,PetscViewerFormat *,PetscBool *); 1612bf49c77SBarry Smith 162fe01d993SBarry Smith typedef struct {PetscViewer viewer;PetscViewerFormat format;} PetscViewerAndFormat; 163d7cbc13eSBarry Smith PETSC_EXTERN PetscErrorCode PetscViewerAndFormatCreate(PetscViewer,PetscViewerFormat,PetscViewerAndFormat**); 164fe01d993SBarry Smith PETSC_EXTERN PetscErrorCode PetscViewerAndFormatDestroy(PetscViewerAndFormat**); 165fe01d993SBarry Smith 16677ed5343SBarry Smith /* 16777ed5343SBarry Smith Operations explicit to a particular class of viewers 16877ed5343SBarry Smith */ 169ed5c6e3eSMatthew Knepley 170014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetPointer(PetscViewer,FILE**); 171014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerFileGetMode(PetscViewer,PetscFileMode*); 172014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerFileSetMode(PetscViewer,PetscFileMode); 173060da220SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscViewerRead(PetscViewer,void*,PetscInt,PetscInt*,PetscDataType); 174014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerASCIIPrintf(PetscViewer,const char[],...); 175014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerASCIISynchronizedPrintf(PetscViewer,const char[],...); 1761575c14dSBarry Smith PETSC_EXTERN PetscErrorCode PetscViewerASCIIPushSynchronized(PetscViewer); 1771575c14dSBarry Smith PETSC_EXTERN PetscErrorCode PetscViewerASCIIPopSynchronized(PetscViewer); 178014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerASCIIPushTab(PetscViewer); 179014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerASCIIPopTab(PetscViewer); 180014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerASCIIUseTabs(PetscViewer,PetscBool ); 181014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerASCIISetTab(PetscViewer,PetscInt); 182014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetTab(PetscViewer,PetscInt*); 183014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerASCIIAddTab(PetscViewer,PetscInt); 184014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerASCIISubtractTab(PetscViewer,PetscInt); 185060da220SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscViewerASCIIRead(PetscViewer,void *,PetscInt,PetscInt*,PetscDataType); 186014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetDescriptor(PetscViewer,int*); 187014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetInfoPointer(PetscViewer,FILE **); 188060da220SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscViewerBinaryRead(PetscViewer,void*,PetscInt,PetscInt*,PetscDataType); 189014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerBinaryWrite(PetscViewer,void*,PetscInt,PetscDataType,PetscBool ); 190014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerStringSPrintf(PetscViewer,const char[],...); 191014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerStringSetString(PetscViewer,char[],PetscInt); 192014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerDrawClear(PetscViewer); 193014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerDrawSetHold(PetscViewer,PetscBool); 194014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerDrawGetHold(PetscViewer,PetscBool*); 195014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerDrawSetPause(PetscViewer,PetscReal); 196014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerDrawGetPause(PetscViewer,PetscReal*); 197014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerDrawSetInfo(PetscViewer,const char[],const char[],int,int,int,int); 198014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerDrawResize(PetscViewer,int,int); 199014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerDrawSetBounds(PetscViewer,PetscInt,const PetscReal*); 200014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerDrawGetBounds(PetscViewer,PetscInt*,const PetscReal**); 201014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerSocketSetConnection(PetscViewer,const char[],int); 202014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerBinarySkipInfo(PetscViewer); 203807ea322SDave May PETSC_EXTERN PetscErrorCode PetscViewerBinarySetSkipInfo(PetscViewer,PetscBool); 204807ea322SDave May PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetSkipInfo(PetscViewer,PetscBool*); 205014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerBinarySetSkipOptions(PetscViewer,PetscBool ); 206014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetSkipOptions(PetscViewer,PetscBool *); 207014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerBinarySetSkipHeader(PetscViewer,PetscBool); 208014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetSkipHeader(PetscViewer,PetscBool*); 209014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerBinaryReadStringArray(PetscViewer,char***); 21078fbdcc8SBarry Smith PETSC_EXTERN PetscErrorCode PetscViewerBinaryWriteStringArray(PetscViewer,const char *const*); 211c655490fSBarry Smith 212014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerFileSetName(PetscViewer,const char[]); 213014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerFileGetName(PetscViewer,const char**); 21477ed5343SBarry Smith 215014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerVUGetPointer(PetscViewer, FILE**); 216014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerVUSetVecSeen(PetscViewer, PetscBool ); 217014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerVUGetVecSeen(PetscViewer, PetscBool *); 218014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerVUPrintDeferred(PetscViewer, const char [], ...); 219014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerVUFlushDeferred(PetscViewer); 22055dcf840SMatthew Knepley 221607a6623SBarry Smith PETSC_EXTERN PetscErrorCode PetscViewerMathematicaInitializePackage(void); 222014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerMathematicaFinalizePackage(void); 223014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerMathematicaGetName(PetscViewer, const char **); 224014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerMathematicaSetName(PetscViewer, const char []); 225014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerMathematicaClearName(PetscViewer); 226014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerMathematicaSkipPackets(PetscViewer, int); 2274ebda54eSMatthew Knepley 228014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerSiloGetName(PetscViewer, char **); 229014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerSiloSetName(PetscViewer, const char []); 230014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerSiloClearName(PetscViewer); 231014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerSiloGetMeshName(PetscViewer, char **); 232014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerSiloSetMeshName(PetscViewer, const char []); 233014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerSiloClearMeshName(PetscViewer); 2344ebda54eSMatthew Knepley 235893c9c94SMatthew G Knepley typedef enum {PETSC_VTK_POINT_FIELD, PETSC_VTK_POINT_VECTOR_FIELD, PETSC_VTK_CELL_FIELD, PETSC_VTK_CELL_VECTOR_FIELD} PetscViewerVTKFieldType; 23618e2ec27SBarry Smith PETSC_EXTERN PetscErrorCode PetscViewerVTKAddField(PetscViewer,PetscObject,PetscErrorCode (*PetscViewerVTKWriteFunction)(PetscObject,PetscViewer),PetscViewerVTKFieldType,PetscObject); 237014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerVTKOpen(MPI_Comm,const char[],PetscFileMode,PetscViewer*); 2384061b8bfSJed Brown 23977ed5343SBarry Smith /* 240d70abbfaSBarry Smith These are all the default viewers that do not have to be explicitly opened 24177ed5343SBarry Smith */ 242014dd563SJed Brown PETSC_EXTERN PetscViewer PETSC_VIEWER_STDOUT_(MPI_Comm); 243014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetStdout(MPI_Comm,PetscViewer*); 244014dd563SJed Brown PETSC_EXTERN PetscViewer PETSC_VIEWER_STDERR_(MPI_Comm); 245014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetStderr(MPI_Comm,PetscViewer*); 246014dd563SJed Brown PETSC_EXTERN PetscViewer PETSC_VIEWER_DRAW_(MPI_Comm); 247014dd563SJed Brown PETSC_EXTERN PetscViewer PETSC_VIEWER_SOCKET_(MPI_Comm); 248014dd563SJed Brown PETSC_EXTERN PetscViewer PETSC_VIEWER_BINARY_(MPI_Comm); 249014dd563SJed Brown PETSC_EXTERN PetscViewer PETSC_VIEWER_MATLAB_(MPI_Comm); 250a75e6a4aSMatthew G. Knepley PETSC_EXTERN PetscViewer PETSC_VIEWER_HDF5_(MPI_Comm); 2518135c375SStefano Zampini PETSC_EXTERN PetscViewer PETSC_VIEWER_GLVIS_(MPI_Comm); 252014dd563SJed Brown PETSC_EXTERN PetscViewer PETSC_VIEWER_MATHEMATICA_WORLD_PRIVATE; 2535311e20fSBarry Smith 254b0a32e0cSBarry Smith #define PETSC_VIEWER_STDERR_SELF PETSC_VIEWER_STDERR_(PETSC_COMM_SELF) 255b0a32e0cSBarry Smith #define PETSC_VIEWER_STDERR_WORLD PETSC_VIEWER_STDERR_(PETSC_COMM_WORLD) 25630de9b25SBarry Smith 25730de9b25SBarry Smith /*MC 25830de9b25SBarry Smith PETSC_VIEWER_STDOUT_WORLD - same as PETSC_VIEWER_STDOUT_(PETSC_COMM_WORLD) 25930de9b25SBarry Smith 26030de9b25SBarry Smith Level: beginner 26130de9b25SBarry Smith M*/ 26230de9b25SBarry Smith #define PETSC_VIEWER_STDOUT_WORLD PETSC_VIEWER_STDOUT_(PETSC_COMM_WORLD) 26330de9b25SBarry Smith 26430de9b25SBarry Smith /*MC 26530de9b25SBarry Smith PETSC_VIEWER_STDOUT_SELF - same as PETSC_VIEWER_STDOUT_(PETSC_COMM_SELF) 26630de9b25SBarry Smith 26730de9b25SBarry Smith Level: beginner 26830de9b25SBarry Smith M*/ 26930de9b25SBarry Smith #define PETSC_VIEWER_STDOUT_SELF PETSC_VIEWER_STDOUT_(PETSC_COMM_SELF) 27030de9b25SBarry Smith 27130de9b25SBarry Smith /*MC 27230de9b25SBarry Smith PETSC_VIEWER_DRAW_WORLD - same as PETSC_VIEWER_DRAW_(PETSC_COMM_WORLD) 27330de9b25SBarry Smith 27430de9b25SBarry Smith Level: intermediate 27530de9b25SBarry Smith M*/ 276b0a32e0cSBarry Smith #define PETSC_VIEWER_DRAW_WORLD PETSC_VIEWER_DRAW_(PETSC_COMM_WORLD) 27730de9b25SBarry Smith 27830de9b25SBarry Smith /*MC 27930de9b25SBarry Smith PETSC_VIEWER_DRAW_SELF - same as PETSC_VIEWER_DRAW_(PETSC_COMM_SELF) 28030de9b25SBarry Smith 28130de9b25SBarry Smith Level: intermediate 28230de9b25SBarry Smith M*/ 28330de9b25SBarry Smith #define PETSC_VIEWER_DRAW_SELF PETSC_VIEWER_DRAW_(PETSC_COMM_SELF) 28430de9b25SBarry Smith 28530de9b25SBarry Smith /*MC 28630de9b25SBarry Smith PETSC_VIEWER_SOCKET_WORLD - same as PETSC_VIEWER_SOCKET_(PETSC_COMM_WORLD) 28730de9b25SBarry Smith 28830de9b25SBarry Smith Level: intermediate 28930de9b25SBarry Smith M*/ 290b0a32e0cSBarry Smith #define PETSC_VIEWER_SOCKET_WORLD PETSC_VIEWER_SOCKET_(PETSC_COMM_WORLD) 29130de9b25SBarry Smith 29230de9b25SBarry Smith /*MC 29330de9b25SBarry Smith PETSC_VIEWER_SOCKET_SELF - same as PETSC_VIEWER_SOCKET_(PETSC_COMM_SELF) 29430de9b25SBarry Smith 29530de9b25SBarry Smith Level: intermediate 29630de9b25SBarry Smith M*/ 297b0a32e0cSBarry Smith #define PETSC_VIEWER_SOCKET_SELF PETSC_VIEWER_SOCKET_(PETSC_COMM_SELF) 29830de9b25SBarry Smith 29930de9b25SBarry Smith /*MC 30030de9b25SBarry Smith PETSC_VIEWER_BINARY_WORLD - same as PETSC_VIEWER_BINARY_(PETSC_COMM_WORLD) 30130de9b25SBarry Smith 30230de9b25SBarry Smith Level: intermediate 30330de9b25SBarry Smith M*/ 304b0a32e0cSBarry Smith #define PETSC_VIEWER_BINARY_WORLD PETSC_VIEWER_BINARY_(PETSC_COMM_WORLD) 30530de9b25SBarry Smith 30630de9b25SBarry Smith /*MC 30730de9b25SBarry Smith PETSC_VIEWER_BINARY_SELF - same as PETSC_VIEWER_BINARY_(PETSC_COMM_SELF) 30830de9b25SBarry Smith 30930de9b25SBarry Smith Level: intermediate 31030de9b25SBarry Smith M*/ 311b0a32e0cSBarry Smith #define PETSC_VIEWER_BINARY_SELF PETSC_VIEWER_BINARY_(PETSC_COMM_SELF) 31230de9b25SBarry Smith 313cbb32127SBarry Smith /*MC 314cbb32127SBarry Smith PETSC_VIEWER_MATLAB_WORLD - same as PETSC_VIEWER_MATLAB_(PETSC_COMM_WORLD) 315cbb32127SBarry Smith 316cbb32127SBarry Smith Level: intermediate 317cbb32127SBarry Smith M*/ 318cbb32127SBarry Smith #define PETSC_VIEWER_MATLAB_WORLD PETSC_VIEWER_MATLAB_(PETSC_COMM_WORLD) 319cbb32127SBarry Smith 320cbb32127SBarry Smith /*MC 321cbb32127SBarry Smith PETSC_VIEWER_MATLAB_SELF - same as PETSC_VIEWER_MATLAB_(PETSC_COMM_SELF) 322cbb32127SBarry Smith 323cbb32127SBarry Smith Level: intermediate 324cbb32127SBarry Smith M*/ 325cbb32127SBarry Smith #define PETSC_VIEWER_MATLAB_SELF PETSC_VIEWER_MATLAB_(PETSC_COMM_SELF) 326cbb32127SBarry Smith 3277eb62a3eSMatthew Knepley #define PETSC_VIEWER_MATHEMATICA_WORLD (PetscViewerInitializeMathematicaWorld_Private(),PETSC_VIEWER_MATHEMATICA_WORLD_PRIVATE) 32865ef3172SBarry Smith 3294a5f5e6cSBarry Smith PETSC_EXTERN PetscErrorCode PetscViewerFlowControlStart(PetscViewer,PetscInt*,PetscInt*); 3304a5f5e6cSBarry Smith PETSC_EXTERN PetscErrorCode PetscViewerFlowControlStepMaster(PetscViewer,PetscInt,PetscInt*,PetscInt); 3314a5f5e6cSBarry Smith PETSC_EXTERN PetscErrorCode PetscViewerFlowControlEndMaster(PetscViewer,PetscInt*); 3324a5f5e6cSBarry Smith PETSC_EXTERN PetscErrorCode PetscViewerFlowControlStepWorker(PetscViewer,PetscMPIInt,PetscInt*); 3334a5f5e6cSBarry Smith PETSC_EXTERN PetscErrorCode PetscViewerFlowControlEndWorker(PetscViewer,PetscInt*); 334e03d165dSBarry Smith 33577ed5343SBarry Smith /* 336a5057860SBarry Smith PetscViewer writes to MATLAB .mat file 337cbb32127SBarry Smith */ 338014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerMatlabPutArray(PetscViewer,int,int,const PetscScalar*,const char*); 339014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerMatlabGetArray(PetscViewer,int,int,PetscScalar*,const char*); 340014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerMatlabPutVariable(PetscViewer,const char*,void*); 341cbb32127SBarry Smith 342e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 343e04113cfSBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectViewSAWs(PetscObject,PetscViewer); 344bfb97211SBarry Smith #endif 345bfb97211SBarry Smith 346b9617806SBarry Smith /*S 3471890ba74SBarry Smith PetscViewers - Abstract collection of PetscViewers. It is just an expandable array of viewers. 348b9617806SBarry Smith 349b9617806SBarry Smith Level: intermediate 350b9617806SBarry Smith 351b9617806SBarry Smith Concepts: viewing 352b9617806SBarry Smith 353b9617806SBarry Smith .seealso: PetscViewerCreate(), PetscViewerSetType(), PetscViewerType, PetscViewer, PetscViewersCreate(), 354b9617806SBarry Smith PetscViewersGetViewer() 355b9617806SBarry Smith S*/ 35695fbd943SSatish Balay typedef struct _n_PetscViewers* PetscViewers; 357014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewersCreate(MPI_Comm,PetscViewers*); 358014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewersDestroy(PetscViewers*); 359014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewersGetViewer(PetscViewers,PetscInt,PetscViewer*); 360d132466eSBarry Smith 361cb5b572fSBarry Smith #endif 362