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> 10e9fa29b7SSatish Balay 11014dd563SJed Brown PETSC_EXTERN PetscClassId PETSC_VIEWER_CLASSID; 12e9fa29b7SSatish Balay 1376bdecfbSBarry Smith /*J 14b9617806SBarry Smith PetscViewerType - String with the name of a PETSc PETScViewer 15b9617806SBarry Smith 16b9617806SBarry Smith Level: beginner 17b9617806SBarry Smith 188f6c3df8SBarry Smith .seealso: PetscViewerSetType(), PetscViewer, PetscViewerRegister(), PetscViewerCreate() 1976bdecfbSBarry Smith J*/ 2019fd82e9SBarry Smith typedef const char* PetscViewerType; 212692d6eeSBarry Smith #define PETSCVIEWERSOCKET "socket" 222692d6eeSBarry Smith #define PETSCVIEWERASCII "ascii" 232692d6eeSBarry Smith #define PETSCVIEWERBINARY "binary" 242692d6eeSBarry Smith #define PETSCVIEWERSTRING "string" 252692d6eeSBarry Smith #define PETSCVIEWERDRAW "draw" 262692d6eeSBarry Smith #define PETSCVIEWERVU "vu" 272692d6eeSBarry Smith #define PETSCVIEWERMATHEMATICA "mathematica" 282692d6eeSBarry Smith #define PETSCVIEWERNETCDF "netcdf" 292692d6eeSBarry Smith #define PETSCVIEWERHDF5 "hdf5" 304061b8bfSJed Brown #define PETSCVIEWERVTK "vtk" 312692d6eeSBarry Smith #define PETSCVIEWERMATLAB "matlab" 32*e04113cfSBarry Smith #define PETSCVIEWERSAWS "saws" 3377ed5343SBarry Smith 34140e18c1SBarry Smith PETSC_EXTERN PetscFunctionList PetscViewerList; 35607a6623SBarry Smith PETSC_EXTERN PetscErrorCode PetscViewerRegisterAll(void); 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); 49014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerBinarySetMPIIO(PetscViewer); 50014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetMPIIO(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*); 58014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerStringOpen(MPI_Comm,char[],PetscInt,PetscViewer*); 59014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerDrawOpen(MPI_Comm,const char[],const char[],int,int,int,int,PetscViewer*); 60014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerMathematicaOpen(MPI_Comm, int, const char[], const char[], PetscViewer *); 61014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerSiloOpen(MPI_Comm, const char[], PetscViewer *); 62014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerMatlabOpen(MPI_Comm,const char[],PetscFileMode,PetscViewer*); 634b0e389bSBarry Smith 6419fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode PetscViewerGetType(PetscViewer,PetscViewerType*); 6519fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode PetscViewerSetType(PetscViewer,PetscViewerType); 66014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerDestroy(PetscViewer*); 67014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerGetSingleton(PetscViewer,PetscViewer*); 68014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerRestoreSingleton(PetscViewer,PetscViewer*); 69014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerGetSubcomm(PetscViewer,MPI_Comm,PetscViewer*); 70014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerRestoreSubcomm(PetscViewer,MPI_Comm,PetscViewer*); 71ae39576cSLois Curfman McInnes 72014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerSetUp(PetscViewer); 73014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerView(PetscViewer,PetscViewer); 74f69a0ea3SMatthew Knepley 75014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerSetOptionsPrefix(PetscViewer,const char[]); 76014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerAppendOptionsPrefix(PetscViewer,const char[]); 77014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerGetOptionsPrefix(PetscViewer,const char*[]); 78090de74eSSatish Balay 79b9617806SBarry Smith /*E 80b9617806SBarry Smith PetscViewerFormat - Way a viewer presents the object 81b9617806SBarry Smith 82b9617806SBarry Smith Level: beginner 83b9617806SBarry Smith 84cfaaf4edSHong Zhang The values below are also listed in finclude/petscviewer.h. If another values is added below it 85cfaaf4edSHong Zhang must also be added there. 86cfaaf4edSHong Zhang 87b9617806SBarry Smith .seealso: PetscViewerSetFormat(), PetscViewer, PetscViewerType, PetscViewerPushFormat(), PetscViewerPopFormat() 88b9617806SBarry Smith E*/ 89fb9695e5SSatish Balay typedef enum { 90117016b1SBarry Smith PETSC_VIEWER_DEFAULT, 91f3ef73ceSBarry Smith PETSC_VIEWER_ASCII_MATLAB, 924ebda54eSMatthew Knepley PETSC_VIEWER_ASCII_MATHEMATICA, 93f3ef73ceSBarry Smith PETSC_VIEWER_ASCII_IMPL, 94f3ef73ceSBarry Smith PETSC_VIEWER_ASCII_INFO, 95456192e2SBarry Smith PETSC_VIEWER_ASCII_INFO_DETAIL, 96f3ef73ceSBarry Smith PETSC_VIEWER_ASCII_COMMON, 97f3ef73ceSBarry Smith PETSC_VIEWER_ASCII_SYMMODU, 98f3ef73ceSBarry Smith PETSC_VIEWER_ASCII_INDEX, 99f3ef73ceSBarry Smith PETSC_VIEWER_ASCII_DENSE, 1003c215bfdSMatthew Knepley PETSC_VIEWER_ASCII_MATRIXMARKET, 101a505fa5bSMatthew Knepley PETSC_VIEWER_ASCII_VTK, 102b85befe5SMatthew Knepley PETSC_VIEWER_ASCII_VTK_CELL, 103b6d733afSMatthew Knepley PETSC_VIEWER_ASCII_VTK_COORDS, 104493617b5SMatthew Knepley PETSC_VIEWER_ASCII_PCICE, 105cfaaf4edSHong Zhang PETSC_VIEWER_ASCII_PYTHON, 106cfaaf4edSHong Zhang PETSC_VIEWER_ASCII_FACTOR_INFO, 10767ad5babSMatthew G Knepley PETSC_VIEWER_ASCII_LATEX, 108f3ef73ceSBarry Smith PETSC_VIEWER_DRAW_BASIC, 109f3ef73ceSBarry Smith PETSC_VIEWER_DRAW_LG, 110f3ef73ceSBarry Smith PETSC_VIEWER_DRAW_CONTOUR, 111f3ef73ceSBarry Smith PETSC_VIEWER_DRAW_PORTS, 1124061b8bfSJed Brown PETSC_VIEWER_VTK_VTS, 113b263465dSJed Brown PETSC_VIEWER_VTK_VTU, 114a261c58fSBarry Smith PETSC_VIEWER_BINARY_MATLAB, 115f3ef73ceSBarry Smith PETSC_VIEWER_NATIVE, 116cfaaf4edSHong Zhang PETSC_VIEWER_NOFORMAT 117cfaaf4edSHong Zhang } PetscViewerFormat; 118014dd563SJed Brown PETSC_EXTERN const char *const PetscViewerFormats[]; 119090de74eSSatish Balay 120014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerSetFormat(PetscViewer,PetscViewerFormat); 121014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerPushFormat(PetscViewer,PetscViewerFormat); 122014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerPopFormat(PetscViewer); 123014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerGetFormat(PetscViewer,PetscViewerFormat*); 124014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerFlush(PetscViewer); 1254b0e389bSBarry Smith 126cffb1e40SBarry Smith PETSC_EXTERN PetscErrorCode PetscOptionsGetViewer(MPI_Comm,const char[],const char[],PetscViewer*,PetscViewerFormat*,PetscBool*); 127cffb1e40SBarry Smith PETSC_EXTERN PetscErrorCode PetscOptionsViewer(const char[],const char[],const char[],PetscViewer*,PetscViewerFormat *,PetscBool *); 1282bf49c77SBarry Smith 12977ed5343SBarry Smith /* 13077ed5343SBarry Smith Operations explicit to a particular class of viewers 13177ed5343SBarry Smith */ 132ed5c6e3eSMatthew Knepley 133014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetPointer(PetscViewer,FILE**); 134014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerFileGetMode(PetscViewer,PetscFileMode*); 135014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerFileSetMode(PetscViewer,PetscFileMode); 136014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerASCIIPrintf(PetscViewer,const char[],...); 137014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerASCIISynchronizedPrintf(PetscViewer,const char[],...); 138014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerASCIISynchronizedAllow(PetscViewer,PetscBool); 139014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerASCIIPushTab(PetscViewer); 140014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerASCIIPopTab(PetscViewer); 141014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerASCIIUseTabs(PetscViewer,PetscBool ); 142014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerASCIISetTab(PetscViewer,PetscInt); 143014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetTab(PetscViewer,PetscInt*); 144014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerASCIIAddTab(PetscViewer,PetscInt); 145014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerASCIISubtractTab(PetscViewer,PetscInt); 146014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetDescriptor(PetscViewer,int*); 147014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetInfoPointer(PetscViewer,FILE **); 148014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerBinaryRead(PetscViewer,void*,PetscInt,PetscDataType); 149014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerBinaryWrite(PetscViewer,void*,PetscInt,PetscDataType,PetscBool ); 150014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerStringSPrintf(PetscViewer,const char[],...); 151014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerStringSetString(PetscViewer,char[],PetscInt); 152014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerDrawClear(PetscViewer); 153014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerDrawSetHold(PetscViewer,PetscBool); 154014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerDrawGetHold(PetscViewer,PetscBool*); 155014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerDrawSetPause(PetscViewer,PetscReal); 156014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerDrawGetPause(PetscViewer,PetscReal*); 157014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerDrawSetInfo(PetscViewer,const char[],const char[],int,int,int,int); 158014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerDrawResize(PetscViewer,int,int); 159014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerDrawSetBounds(PetscViewer,PetscInt,const PetscReal*); 160014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerDrawGetBounds(PetscViewer,PetscInt*,const PetscReal**); 161014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerSocketSetConnection(PetscViewer,const char[],int); 162014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerBinarySkipInfo(PetscViewer); 163014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerBinarySetSkipOptions(PetscViewer,PetscBool ); 164014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetSkipOptions(PetscViewer,PetscBool *); 165014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerBinarySetSkipHeader(PetscViewer,PetscBool); 166014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetSkipHeader(PetscViewer,PetscBool*); 167014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerBinaryReadStringArray(PetscViewer,char***); 168014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerBinaryWriteStringArray(PetscViewer,char**); 169c655490fSBarry Smith 170014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerFileSetName(PetscViewer,const char[]); 171014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerFileGetName(PetscViewer,const char**); 17277ed5343SBarry Smith 173014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerVUGetPointer(PetscViewer, FILE**); 174014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerVUSetVecSeen(PetscViewer, PetscBool ); 175014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerVUGetVecSeen(PetscViewer, PetscBool *); 176014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerVUPrintDeferred(PetscViewer, const char [], ...); 177014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerVUFlushDeferred(PetscViewer); 17855dcf840SMatthew Knepley 179607a6623SBarry Smith PETSC_EXTERN PetscErrorCode PetscViewerMathematicaInitializePackage(void); 180014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerMathematicaFinalizePackage(void); 181014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerMathematicaGetName(PetscViewer, const char **); 182014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerMathematicaSetName(PetscViewer, const char []); 183014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerMathematicaClearName(PetscViewer); 184014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerMathematicaSkipPackets(PetscViewer, int); 1854ebda54eSMatthew Knepley 186014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerSiloGetName(PetscViewer, char **); 187014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerSiloSetName(PetscViewer, const char []); 188014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerSiloClearName(PetscViewer); 189014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerSiloGetMeshName(PetscViewer, char **); 190014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerSiloSetMeshName(PetscViewer, const char []); 191014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerSiloClearMeshName(PetscViewer); 1924ebda54eSMatthew Knepley 193014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerNetcdfOpen(MPI_Comm,const char[],PetscFileMode,PetscViewer*); 194014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerNetcdfGetID(PetscViewer, int *); 195e3eb5169SDinesh Kaushik 196893c9c94SMatthew G Knepley typedef enum {PETSC_VTK_POINT_FIELD, PETSC_VTK_POINT_VECTOR_FIELD, PETSC_VTK_CELL_FIELD, PETSC_VTK_CELL_VECTOR_FIELD} PetscViewerVTKFieldType; 19718e2ec27SBarry Smith PETSC_EXTERN PetscErrorCode PetscViewerVTKAddField(PetscViewer,PetscObject,PetscErrorCode (*PetscViewerVTKWriteFunction)(PetscObject,PetscViewer),PetscViewerVTKFieldType,PetscObject); 198014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerVTKOpen(MPI_Comm,const char[],PetscFileMode,PetscViewer*); 1994061b8bfSJed Brown 20077ed5343SBarry Smith /* 201d70abbfaSBarry Smith These are all the default viewers that do not have to be explicitly opened 20277ed5343SBarry Smith */ 203014dd563SJed Brown PETSC_EXTERN PetscViewer PETSC_VIEWER_STDOUT_(MPI_Comm); 204014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetStdout(MPI_Comm,PetscViewer*); 205014dd563SJed Brown PETSC_EXTERN PetscViewer PETSC_VIEWER_STDERR_(MPI_Comm); 206014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetStderr(MPI_Comm,PetscViewer*); 207014dd563SJed Brown PETSC_EXTERN PetscViewer PETSC_VIEWER_DRAW_(MPI_Comm); 208014dd563SJed Brown PETSC_EXTERN PetscViewer PETSC_VIEWER_SOCKET_(MPI_Comm); 209014dd563SJed Brown PETSC_EXTERN PetscViewer PETSC_VIEWER_BINARY_(MPI_Comm); 210014dd563SJed Brown PETSC_EXTERN PetscViewer PETSC_VIEWER_MATLAB_(MPI_Comm); 211014dd563SJed Brown PETSC_EXTERN PetscViewer PETSC_VIEWER_MATHEMATICA_WORLD_PRIVATE; 2125311e20fSBarry Smith 213b0a32e0cSBarry Smith #define PETSC_VIEWER_STDERR_SELF PETSC_VIEWER_STDERR_(PETSC_COMM_SELF) 214b0a32e0cSBarry Smith #define PETSC_VIEWER_STDERR_WORLD PETSC_VIEWER_STDERR_(PETSC_COMM_WORLD) 21530de9b25SBarry Smith 21630de9b25SBarry Smith /*MC 21730de9b25SBarry Smith PETSC_VIEWER_STDOUT_WORLD - same as PETSC_VIEWER_STDOUT_(PETSC_COMM_WORLD) 21830de9b25SBarry Smith 21930de9b25SBarry Smith Level: beginner 22030de9b25SBarry Smith M*/ 22130de9b25SBarry Smith #define PETSC_VIEWER_STDOUT_WORLD PETSC_VIEWER_STDOUT_(PETSC_COMM_WORLD) 22230de9b25SBarry Smith 22330de9b25SBarry Smith /*MC 22430de9b25SBarry Smith PETSC_VIEWER_STDOUT_SELF - same as PETSC_VIEWER_STDOUT_(PETSC_COMM_SELF) 22530de9b25SBarry Smith 22630de9b25SBarry Smith Level: beginner 22730de9b25SBarry Smith M*/ 22830de9b25SBarry Smith #define PETSC_VIEWER_STDOUT_SELF PETSC_VIEWER_STDOUT_(PETSC_COMM_SELF) 22930de9b25SBarry Smith 23030de9b25SBarry Smith /*MC 23130de9b25SBarry Smith PETSC_VIEWER_DRAW_WORLD - same as PETSC_VIEWER_DRAW_(PETSC_COMM_WORLD) 23230de9b25SBarry Smith 23330de9b25SBarry Smith Level: intermediate 23430de9b25SBarry Smith M*/ 235b0a32e0cSBarry Smith #define PETSC_VIEWER_DRAW_WORLD PETSC_VIEWER_DRAW_(PETSC_COMM_WORLD) 23630de9b25SBarry Smith 23730de9b25SBarry Smith /*MC 23830de9b25SBarry Smith PETSC_VIEWER_DRAW_SELF - same as PETSC_VIEWER_DRAW_(PETSC_COMM_SELF) 23930de9b25SBarry Smith 24030de9b25SBarry Smith Level: intermediate 24130de9b25SBarry Smith M*/ 24230de9b25SBarry Smith #define PETSC_VIEWER_DRAW_SELF PETSC_VIEWER_DRAW_(PETSC_COMM_SELF) 24330de9b25SBarry Smith 24430de9b25SBarry Smith /*MC 24530de9b25SBarry Smith PETSC_VIEWER_SOCKET_WORLD - same as PETSC_VIEWER_SOCKET_(PETSC_COMM_WORLD) 24630de9b25SBarry Smith 24730de9b25SBarry Smith Level: intermediate 24830de9b25SBarry Smith M*/ 249b0a32e0cSBarry Smith #define PETSC_VIEWER_SOCKET_WORLD PETSC_VIEWER_SOCKET_(PETSC_COMM_WORLD) 25030de9b25SBarry Smith 25130de9b25SBarry Smith /*MC 25230de9b25SBarry Smith PETSC_VIEWER_SOCKET_SELF - same as PETSC_VIEWER_SOCKET_(PETSC_COMM_SELF) 25330de9b25SBarry Smith 25430de9b25SBarry Smith Level: intermediate 25530de9b25SBarry Smith M*/ 256b0a32e0cSBarry Smith #define PETSC_VIEWER_SOCKET_SELF PETSC_VIEWER_SOCKET_(PETSC_COMM_SELF) 25730de9b25SBarry Smith 25830de9b25SBarry Smith /*MC 25930de9b25SBarry Smith PETSC_VIEWER_BINARY_WORLD - same as PETSC_VIEWER_BINARY_(PETSC_COMM_WORLD) 26030de9b25SBarry Smith 26130de9b25SBarry Smith Level: intermediate 26230de9b25SBarry Smith M*/ 263b0a32e0cSBarry Smith #define PETSC_VIEWER_BINARY_WORLD PETSC_VIEWER_BINARY_(PETSC_COMM_WORLD) 26430de9b25SBarry Smith 26530de9b25SBarry Smith /*MC 26630de9b25SBarry Smith PETSC_VIEWER_BINARY_SELF - same as PETSC_VIEWER_BINARY_(PETSC_COMM_SELF) 26730de9b25SBarry Smith 26830de9b25SBarry Smith Level: intermediate 26930de9b25SBarry Smith M*/ 270b0a32e0cSBarry Smith #define PETSC_VIEWER_BINARY_SELF PETSC_VIEWER_BINARY_(PETSC_COMM_SELF) 27130de9b25SBarry Smith 272cbb32127SBarry Smith /*MC 273cbb32127SBarry Smith PETSC_VIEWER_MATLAB_WORLD - same as PETSC_VIEWER_MATLAB_(PETSC_COMM_WORLD) 274cbb32127SBarry Smith 275cbb32127SBarry Smith Level: intermediate 276cbb32127SBarry Smith M*/ 277cbb32127SBarry Smith #define PETSC_VIEWER_MATLAB_WORLD PETSC_VIEWER_MATLAB_(PETSC_COMM_WORLD) 278cbb32127SBarry Smith 279cbb32127SBarry Smith /*MC 280cbb32127SBarry Smith PETSC_VIEWER_MATLAB_SELF - same as PETSC_VIEWER_MATLAB_(PETSC_COMM_SELF) 281cbb32127SBarry Smith 282cbb32127SBarry Smith Level: intermediate 283cbb32127SBarry Smith M*/ 284cbb32127SBarry Smith #define PETSC_VIEWER_MATLAB_SELF PETSC_VIEWER_MATLAB_(PETSC_COMM_SELF) 285cbb32127SBarry Smith 2867eb62a3eSMatthew Knepley #define PETSC_VIEWER_MATHEMATICA_WORLD (PetscViewerInitializeMathematicaWorld_Private(),PETSC_VIEWER_MATHEMATICA_WORLD_PRIVATE) 28765ef3172SBarry Smith 288639ff905SBarry Smith #undef __FUNCT__ 289639ff905SBarry Smith #define __FUNCT__ "PetscViewerFlowControlStart" 290639ff905SBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscViewerFlowControlStart(PetscViewer viewer,PetscInt *mcnt,PetscInt *cnt) 291639ff905SBarry Smith { 292639ff905SBarry Smith PetscErrorCode ierr; 293639ff905SBarry Smith PetscFunctionBegin; 294639ff905SBarry Smith ierr = PetscViewerBinaryGetFlowControl(viewer,mcnt);CHKERRQ(ierr); 295639ff905SBarry Smith ierr = PetscViewerBinaryGetFlowControl(viewer,cnt);CHKERRQ(ierr); 296639ff905SBarry Smith PetscFunctionReturn(0); 297e03d165dSBarry Smith } 298639ff905SBarry Smith 299639ff905SBarry Smith #undef __FUNCT__ 300639ff905SBarry Smith #define __FUNCT__ "PetscViewerFlowControlStepMaster" 301639ff905SBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscViewerFlowControlStepMaster(PetscViewer viewer,PetscInt i,PetscInt *mcnt,PetscInt cnt) 302639ff905SBarry Smith { 303639ff905SBarry Smith PetscErrorCode ierr; 304639ff905SBarry Smith MPI_Comm comm; 305639ff905SBarry Smith 306639ff905SBarry Smith PetscFunctionBegin; 307639ff905SBarry Smith ierr = PetscObjectGetComm((PetscObject)viewer,&comm);CHKERRQ(ierr); 308639ff905SBarry Smith if (i >= *mcnt) { 309639ff905SBarry Smith *mcnt += cnt; 310639ff905SBarry Smith ierr = MPI_Bcast(mcnt,1,MPIU_INT,0,comm);CHKERRQ(ierr); 311639ff905SBarry Smith } 312639ff905SBarry Smith PetscFunctionReturn(0); 313639ff905SBarry Smith } 314639ff905SBarry Smith 315639ff905SBarry Smith #undef __FUNCT__ 316639ff905SBarry Smith #define __FUNCT__ "PetscViewerFlowControlEndMaster" 317639ff905SBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscViewerFlowControlEndMaster(PetscViewer viewer,PetscInt *mcnt) 318639ff905SBarry Smith { 319639ff905SBarry Smith PetscErrorCode ierr; 320639ff905SBarry Smith MPI_Comm comm; 321639ff905SBarry Smith PetscFunctionBegin; 322639ff905SBarry Smith ierr = PetscObjectGetComm((PetscObject)viewer,&comm);CHKERRQ(ierr); 323639ff905SBarry Smith *mcnt = 0; 324639ff905SBarry Smith ierr = MPI_Bcast(mcnt,1,MPIU_INT,0,comm);CHKERRQ(ierr); 325639ff905SBarry Smith PetscFunctionReturn(0); 326639ff905SBarry Smith } 327639ff905SBarry Smith 328639ff905SBarry Smith #undef __FUNCT__ 329639ff905SBarry Smith #define __FUNCT__ "PetscViewerFlowControlStepWorker" 330639ff905SBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscViewerFlowControlStepWorker(PetscViewer viewer,PetscMPIInt rank,PetscInt *mcnt) 331639ff905SBarry Smith { 332639ff905SBarry Smith PetscErrorCode ierr; 333639ff905SBarry Smith MPI_Comm comm; 334639ff905SBarry Smith PetscFunctionBegin; 335639ff905SBarry Smith ierr = PetscObjectGetComm((PetscObject)viewer,&comm);CHKERRQ(ierr); 336639ff905SBarry Smith while (PETSC_TRUE) { 337639ff905SBarry Smith if (rank < *mcnt) break; 338639ff905SBarry Smith ierr = MPI_Bcast(mcnt,1,MPIU_INT,0,comm);CHKERRQ(ierr); 339639ff905SBarry Smith } 340639ff905SBarry Smith PetscFunctionReturn(0); 341639ff905SBarry Smith } 342639ff905SBarry Smith 343639ff905SBarry Smith #undef __FUNCT__ 344639ff905SBarry Smith #define __FUNCT__ "PetscViewerFlowControlEndWorker" 345639ff905SBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscViewerFlowControlEndWorker(PetscViewer viewer,PetscInt *mcnt) 346639ff905SBarry Smith { 347639ff905SBarry Smith PetscErrorCode ierr; 348639ff905SBarry Smith MPI_Comm comm; 349639ff905SBarry Smith PetscFunctionBegin; 350639ff905SBarry Smith ierr = PetscObjectGetComm((PetscObject)viewer,&comm);CHKERRQ(ierr); 351639ff905SBarry Smith while (PETSC_TRUE) { 352639ff905SBarry Smith ierr = MPI_Bcast(mcnt,1,MPIU_INT,0,comm);CHKERRQ(ierr); 353639ff905SBarry Smith if (!*mcnt) break; 354639ff905SBarry Smith } 355639ff905SBarry Smith PetscFunctionReturn(0); 356fca9dd48SBarry Smith } 357e03d165dSBarry Smith 35877ed5343SBarry Smith /* 359a5057860SBarry Smith PetscViewer writes to MATLAB .mat file 360cbb32127SBarry Smith */ 361014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerMatlabPutArray(PetscViewer,int,int,const PetscScalar*,const char*); 362014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerMatlabGetArray(PetscViewer,int,int,PetscScalar*,const char*); 363014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerMatlabPutVariable(PetscViewer,const char*,void*); 364cbb32127SBarry Smith 365*e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 366*e04113cfSBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectViewSAWs(PetscObject,PetscViewer); 367bfb97211SBarry Smith #endif 368bfb97211SBarry Smith 369b9617806SBarry Smith /*S 3701890ba74SBarry Smith PetscViewers - Abstract collection of PetscViewers. It is just an expandable array of viewers. 371b9617806SBarry Smith 372b9617806SBarry Smith Level: intermediate 373b9617806SBarry Smith 374b9617806SBarry Smith Concepts: viewing 375b9617806SBarry Smith 376b9617806SBarry Smith .seealso: PetscViewerCreate(), PetscViewerSetType(), PetscViewerType, PetscViewer, PetscViewersCreate(), 377b9617806SBarry Smith PetscViewersGetViewer() 378b9617806SBarry Smith S*/ 37995fbd943SSatish Balay typedef struct _n_PetscViewers* PetscViewers; 380014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewersCreate(MPI_Comm,PetscViewers*); 381014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewersDestroy(PetscViewers*); 382014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewersGetViewer(PetscViewers,PetscInt,PetscViewer*); 383d132466eSBarry Smith 384e1e7ae07SJed Brown /* Reset __FUNCT__ in case the user does not define it themselves */ 385e1e7ae07SJed Brown #undef __FUNCT__ 386e1e7ae07SJed Brown #define __FUNCT__ "User provided function" 387e1e7ae07SJed Brown 388cb5b572fSBarry Smith #endif 389