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" 32e04113cfSBarry Smith #define PETSCVIEWERSAWS "saws" 3377ed5343SBarry Smith 34140e18c1SBarry Smith PETSC_EXTERN PetscFunctionList PetscViewerList; 35607a6623SBarry Smith PETSC_EXTERN PetscErrorCode PetscViewerInitializePackage(void); 367b2a1423SBarry Smith 37bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode PetscViewerRegister(const char[],PetscErrorCode (*)(PetscViewer)); 3830de9b25SBarry Smith 39014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerCreate(MPI_Comm,PetscViewer*); 40014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerSetFromOptions(PetscViewer); 41014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerASCIIOpenWithFILE(MPI_Comm,FILE*,PetscViewer*); 427b2a1423SBarry Smith 43014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerASCIIOpen(MPI_Comm,const char[],PetscViewer*); 44014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerASCIISetFILE(PetscViewer,FILE*); 45014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerBinaryOpen(MPI_Comm,const char[],PetscFileMode,PetscViewer*); 46014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetFlowControl(PetscViewer,PetscInt*); 47014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerBinarySetFlowControl(PetscViewer,PetscInt); 48bc196f7cSDave May PETSC_EXTERN PetscErrorCode PetscViewerBinarySetUseMPIIO(PetscViewer,PetscBool); 49bc196f7cSDave May PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetUseMPIIO(PetscViewer,PetscBool *); 500fc9d207SBarry Smith #if defined(PETSC_HAVE_MPIIO) 51014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetMPIIODescriptor(PetscViewer,MPI_File*); 52014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetMPIIOOffset(PetscViewer,MPI_Offset*); 53014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerBinaryAddMPIIOOffset(PetscViewer,MPI_Offset); 54951e3c8eSBarry Smith #endif 5539802e9eSBarry Smith 56014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerSocketOpen(MPI_Comm,const char[],int,PetscViewer*); 5789d949e2SBarry Smith PETSC_EXTERN PetscErrorCode PetscViewerStringOpen(MPI_Comm,char[],size_t,PetscViewer*); 58014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerDrawOpen(MPI_Comm,const char[],const char[],int,int,int,int,PetscViewer*); 59d1da0b69SBarry Smith #include <petscdrawtypes.h> 60d1da0b69SBarry Smith PETSC_EXTERN PetscErrorCode PetscViewerDrawSetDrawType(PetscViewer,PetscDrawType); 61014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerMathematicaOpen(MPI_Comm, int, const char[], const char[], PetscViewer *); 62014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerSiloOpen(MPI_Comm, const char[], PetscViewer *); 63014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerMatlabOpen(MPI_Comm,const char[],PetscFileMode,PetscViewer*); 644b0e389bSBarry Smith 6519fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode PetscViewerGetType(PetscViewer,PetscViewerType*); 6619fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode PetscViewerSetType(PetscViewer,PetscViewerType); 67014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerDestroy(PetscViewer*); 683f08860eSBarry Smith PETSC_EXTERN PetscErrorCode PetscViewerGetSubViewer(PetscViewer,MPI_Comm,PetscViewer*); 693f08860eSBarry Smith PETSC_EXTERN PetscErrorCode PetscViewerRestoreSubViewer(PetscViewer,MPI_Comm,PetscViewer*); 70ae39576cSLois Curfman McInnes 71014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerSetUp(PetscViewer); 72014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerView(PetscViewer,PetscViewer); 73685405a1SBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscViewerViewFromOptions(PetscViewer A,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,name);} 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 84af0996ceSBarry Smith The values below are also listed in petsc/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, 113a13bc4e3SShao-Ching Huang PETSC_VIEWER_VTK_VTR, 114b263465dSJed Brown PETSC_VIEWER_VTK_VTU, 115a261c58fSBarry Smith PETSC_VIEWER_BINARY_MATLAB, 116f3ef73ceSBarry Smith PETSC_VIEWER_NATIVE, 117ffe0aed0SMatthew G. Knepley PETSC_VIEWER_HDF5_VIZ, 118cfaaf4edSHong Zhang PETSC_VIEWER_NOFORMAT 119cfaaf4edSHong Zhang } PetscViewerFormat; 120014dd563SJed Brown PETSC_EXTERN const char *const PetscViewerFormats[]; 121090de74eSSatish Balay 122014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerSetFormat(PetscViewer,PetscViewerFormat); 123014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerPushFormat(PetscViewer,PetscViewerFormat); 124014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerPopFormat(PetscViewer); 125014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerGetFormat(PetscViewer,PetscViewerFormat*); 126014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerFlush(PetscViewer); 1274b0e389bSBarry Smith 128cffb1e40SBarry Smith PETSC_EXTERN PetscErrorCode PetscOptionsGetViewer(MPI_Comm,const char[],const char[],PetscViewer*,PetscViewerFormat*,PetscBool*); 129e55864a3SBarry Smith #define PetscOptionsViewer(a,b,c,d,e,f) PetscOptionsViewer_Private(PetscOptionsObject,a,b,c,d,e,f); 1308c34d3f5SBarry Smith PETSC_EXTERN PetscErrorCode PetscOptionsViewer_Private(PetscOptions*,const char[],const char[],const char[],PetscViewer*,PetscViewerFormat *,PetscBool *); 1312bf49c77SBarry Smith 13277ed5343SBarry Smith /* 13377ed5343SBarry Smith Operations explicit to a particular class of viewers 13477ed5343SBarry Smith */ 135ed5c6e3eSMatthew Knepley 136014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetPointer(PetscViewer,FILE**); 137014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerFileGetMode(PetscViewer,PetscFileMode*); 138014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerFileSetMode(PetscViewer,PetscFileMode); 139060da220SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscViewerRead(PetscViewer,void*,PetscInt,PetscInt*,PetscDataType); 140014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerASCIIPrintf(PetscViewer,const char[],...); 141014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerASCIISynchronizedPrintf(PetscViewer,const char[],...); 142*1575c14dSBarry Smith PETSC_EXTERN PetscErrorCode PetscViewerASCIIPushSynchronized(PetscViewer); 143*1575c14dSBarry Smith PETSC_EXTERN PetscErrorCode PetscViewerASCIIPopSynchronized(PetscViewer); 144014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerASCIIPushTab(PetscViewer); 145014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerASCIIPopTab(PetscViewer); 146014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerASCIIUseTabs(PetscViewer,PetscBool ); 147014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerASCIISetTab(PetscViewer,PetscInt); 148014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetTab(PetscViewer,PetscInt*); 149014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerASCIIAddTab(PetscViewer,PetscInt); 150014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerASCIISubtractTab(PetscViewer,PetscInt); 151060da220SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscViewerASCIIRead(PetscViewer,void *,PetscInt,PetscInt*,PetscDataType); 152014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetDescriptor(PetscViewer,int*); 153014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetInfoPointer(PetscViewer,FILE **); 154060da220SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscViewerBinaryRead(PetscViewer,void*,PetscInt,PetscInt*,PetscDataType); 155014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerBinaryWrite(PetscViewer,void*,PetscInt,PetscDataType,PetscBool ); 156014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerStringSPrintf(PetscViewer,const char[],...); 157014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerStringSetString(PetscViewer,char[],PetscInt); 158014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerDrawClear(PetscViewer); 159014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerDrawSetHold(PetscViewer,PetscBool); 160014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerDrawGetHold(PetscViewer,PetscBool*); 161014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerDrawSetPause(PetscViewer,PetscReal); 162014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerDrawGetPause(PetscViewer,PetscReal*); 163014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerDrawSetInfo(PetscViewer,const char[],const char[],int,int,int,int); 164014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerDrawResize(PetscViewer,int,int); 165014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerDrawSetBounds(PetscViewer,PetscInt,const PetscReal*); 166014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerDrawGetBounds(PetscViewer,PetscInt*,const PetscReal**); 167014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerSocketSetConnection(PetscViewer,const char[],int); 168014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerBinarySkipInfo(PetscViewer); 169807ea322SDave May PETSC_EXTERN PetscErrorCode PetscViewerBinarySetSkipInfo(PetscViewer,PetscBool); 170807ea322SDave May PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetSkipInfo(PetscViewer,PetscBool*); 171014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerBinarySetSkipOptions(PetscViewer,PetscBool ); 172014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetSkipOptions(PetscViewer,PetscBool *); 173014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerBinarySetSkipHeader(PetscViewer,PetscBool); 174014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerBinaryGetSkipHeader(PetscViewer,PetscBool*); 175014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerBinaryReadStringArray(PetscViewer,char***); 176014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerBinaryWriteStringArray(PetscViewer,char**); 177c655490fSBarry Smith 178014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerFileSetName(PetscViewer,const char[]); 179014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerFileGetName(PetscViewer,const char**); 18077ed5343SBarry Smith 181014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerVUGetPointer(PetscViewer, FILE**); 182014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerVUSetVecSeen(PetscViewer, PetscBool ); 183014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerVUGetVecSeen(PetscViewer, PetscBool *); 184014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerVUPrintDeferred(PetscViewer, const char [], ...); 185014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerVUFlushDeferred(PetscViewer); 18655dcf840SMatthew Knepley 187607a6623SBarry Smith PETSC_EXTERN PetscErrorCode PetscViewerMathematicaInitializePackage(void); 188014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerMathematicaFinalizePackage(void); 189014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerMathematicaGetName(PetscViewer, const char **); 190014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerMathematicaSetName(PetscViewer, const char []); 191014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerMathematicaClearName(PetscViewer); 192014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerMathematicaSkipPackets(PetscViewer, int); 1934ebda54eSMatthew Knepley 194014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerSiloGetName(PetscViewer, char **); 195014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerSiloSetName(PetscViewer, const char []); 196014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerSiloClearName(PetscViewer); 197014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerSiloGetMeshName(PetscViewer, char **); 198014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerSiloSetMeshName(PetscViewer, const char []); 199014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerSiloClearMeshName(PetscViewer); 2004ebda54eSMatthew Knepley 201014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerNetcdfOpen(MPI_Comm,const char[],PetscFileMode,PetscViewer*); 202014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerNetcdfGetID(PetscViewer, int *); 203e3eb5169SDinesh Kaushik 204893c9c94SMatthew G Knepley typedef enum {PETSC_VTK_POINT_FIELD, PETSC_VTK_POINT_VECTOR_FIELD, PETSC_VTK_CELL_FIELD, PETSC_VTK_CELL_VECTOR_FIELD} PetscViewerVTKFieldType; 20518e2ec27SBarry Smith PETSC_EXTERN PetscErrorCode PetscViewerVTKAddField(PetscViewer,PetscObject,PetscErrorCode (*PetscViewerVTKWriteFunction)(PetscObject,PetscViewer),PetscViewerVTKFieldType,PetscObject); 206014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerVTKOpen(MPI_Comm,const char[],PetscFileMode,PetscViewer*); 2074061b8bfSJed Brown 20877ed5343SBarry Smith /* 209d70abbfaSBarry Smith These are all the default viewers that do not have to be explicitly opened 21077ed5343SBarry Smith */ 211014dd563SJed Brown PETSC_EXTERN PetscViewer PETSC_VIEWER_STDOUT_(MPI_Comm); 212014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetStdout(MPI_Comm,PetscViewer*); 213014dd563SJed Brown PETSC_EXTERN PetscViewer PETSC_VIEWER_STDERR_(MPI_Comm); 214014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerASCIIGetStderr(MPI_Comm,PetscViewer*); 215014dd563SJed Brown PETSC_EXTERN PetscViewer PETSC_VIEWER_DRAW_(MPI_Comm); 216014dd563SJed Brown PETSC_EXTERN PetscViewer PETSC_VIEWER_SOCKET_(MPI_Comm); 217014dd563SJed Brown PETSC_EXTERN PetscViewer PETSC_VIEWER_BINARY_(MPI_Comm); 218014dd563SJed Brown PETSC_EXTERN PetscViewer PETSC_VIEWER_MATLAB_(MPI_Comm); 219a75e6a4aSMatthew G. Knepley PETSC_EXTERN PetscViewer PETSC_VIEWER_HDF5_(MPI_Comm); 220014dd563SJed Brown PETSC_EXTERN PetscViewer PETSC_VIEWER_MATHEMATICA_WORLD_PRIVATE; 2215311e20fSBarry Smith 222b0a32e0cSBarry Smith #define PETSC_VIEWER_STDERR_SELF PETSC_VIEWER_STDERR_(PETSC_COMM_SELF) 223b0a32e0cSBarry Smith #define PETSC_VIEWER_STDERR_WORLD PETSC_VIEWER_STDERR_(PETSC_COMM_WORLD) 22430de9b25SBarry Smith 22530de9b25SBarry Smith /*MC 22630de9b25SBarry Smith PETSC_VIEWER_STDOUT_WORLD - same as PETSC_VIEWER_STDOUT_(PETSC_COMM_WORLD) 22730de9b25SBarry Smith 22830de9b25SBarry Smith Level: beginner 22930de9b25SBarry Smith M*/ 23030de9b25SBarry Smith #define PETSC_VIEWER_STDOUT_WORLD PETSC_VIEWER_STDOUT_(PETSC_COMM_WORLD) 23130de9b25SBarry Smith 23230de9b25SBarry Smith /*MC 23330de9b25SBarry Smith PETSC_VIEWER_STDOUT_SELF - same as PETSC_VIEWER_STDOUT_(PETSC_COMM_SELF) 23430de9b25SBarry Smith 23530de9b25SBarry Smith Level: beginner 23630de9b25SBarry Smith M*/ 23730de9b25SBarry Smith #define PETSC_VIEWER_STDOUT_SELF PETSC_VIEWER_STDOUT_(PETSC_COMM_SELF) 23830de9b25SBarry Smith 23930de9b25SBarry Smith /*MC 24030de9b25SBarry Smith PETSC_VIEWER_DRAW_WORLD - same as PETSC_VIEWER_DRAW_(PETSC_COMM_WORLD) 24130de9b25SBarry Smith 24230de9b25SBarry Smith Level: intermediate 24330de9b25SBarry Smith M*/ 244b0a32e0cSBarry Smith #define PETSC_VIEWER_DRAW_WORLD PETSC_VIEWER_DRAW_(PETSC_COMM_WORLD) 24530de9b25SBarry Smith 24630de9b25SBarry Smith /*MC 24730de9b25SBarry Smith PETSC_VIEWER_DRAW_SELF - same as PETSC_VIEWER_DRAW_(PETSC_COMM_SELF) 24830de9b25SBarry Smith 24930de9b25SBarry Smith Level: intermediate 25030de9b25SBarry Smith M*/ 25130de9b25SBarry Smith #define PETSC_VIEWER_DRAW_SELF PETSC_VIEWER_DRAW_(PETSC_COMM_SELF) 25230de9b25SBarry Smith 25330de9b25SBarry Smith /*MC 25430de9b25SBarry Smith PETSC_VIEWER_SOCKET_WORLD - same as PETSC_VIEWER_SOCKET_(PETSC_COMM_WORLD) 25530de9b25SBarry Smith 25630de9b25SBarry Smith Level: intermediate 25730de9b25SBarry Smith M*/ 258b0a32e0cSBarry Smith #define PETSC_VIEWER_SOCKET_WORLD PETSC_VIEWER_SOCKET_(PETSC_COMM_WORLD) 25930de9b25SBarry Smith 26030de9b25SBarry Smith /*MC 26130de9b25SBarry Smith PETSC_VIEWER_SOCKET_SELF - same as PETSC_VIEWER_SOCKET_(PETSC_COMM_SELF) 26230de9b25SBarry Smith 26330de9b25SBarry Smith Level: intermediate 26430de9b25SBarry Smith M*/ 265b0a32e0cSBarry Smith #define PETSC_VIEWER_SOCKET_SELF PETSC_VIEWER_SOCKET_(PETSC_COMM_SELF) 26630de9b25SBarry Smith 26730de9b25SBarry Smith /*MC 26830de9b25SBarry Smith PETSC_VIEWER_BINARY_WORLD - same as PETSC_VIEWER_BINARY_(PETSC_COMM_WORLD) 26930de9b25SBarry Smith 27030de9b25SBarry Smith Level: intermediate 27130de9b25SBarry Smith M*/ 272b0a32e0cSBarry Smith #define PETSC_VIEWER_BINARY_WORLD PETSC_VIEWER_BINARY_(PETSC_COMM_WORLD) 27330de9b25SBarry Smith 27430de9b25SBarry Smith /*MC 27530de9b25SBarry Smith PETSC_VIEWER_BINARY_SELF - same as PETSC_VIEWER_BINARY_(PETSC_COMM_SELF) 27630de9b25SBarry Smith 27730de9b25SBarry Smith Level: intermediate 27830de9b25SBarry Smith M*/ 279b0a32e0cSBarry Smith #define PETSC_VIEWER_BINARY_SELF PETSC_VIEWER_BINARY_(PETSC_COMM_SELF) 28030de9b25SBarry Smith 281cbb32127SBarry Smith /*MC 282cbb32127SBarry Smith PETSC_VIEWER_MATLAB_WORLD - same as PETSC_VIEWER_MATLAB_(PETSC_COMM_WORLD) 283cbb32127SBarry Smith 284cbb32127SBarry Smith Level: intermediate 285cbb32127SBarry Smith M*/ 286cbb32127SBarry Smith #define PETSC_VIEWER_MATLAB_WORLD PETSC_VIEWER_MATLAB_(PETSC_COMM_WORLD) 287cbb32127SBarry Smith 288cbb32127SBarry Smith /*MC 289cbb32127SBarry Smith PETSC_VIEWER_MATLAB_SELF - same as PETSC_VIEWER_MATLAB_(PETSC_COMM_SELF) 290cbb32127SBarry Smith 291cbb32127SBarry Smith Level: intermediate 292cbb32127SBarry Smith M*/ 293cbb32127SBarry Smith #define PETSC_VIEWER_MATLAB_SELF PETSC_VIEWER_MATLAB_(PETSC_COMM_SELF) 294cbb32127SBarry Smith 2957eb62a3eSMatthew Knepley #define PETSC_VIEWER_MATHEMATICA_WORLD (PetscViewerInitializeMathematicaWorld_Private(),PETSC_VIEWER_MATHEMATICA_WORLD_PRIVATE) 29665ef3172SBarry Smith 297639ff905SBarry Smith #undef __FUNCT__ 298639ff905SBarry Smith #define __FUNCT__ "PetscViewerFlowControlStart" 299639ff905SBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscViewerFlowControlStart(PetscViewer viewer,PetscInt *mcnt,PetscInt *cnt) 300639ff905SBarry Smith { 301639ff905SBarry Smith PetscErrorCode ierr; 302639ff905SBarry Smith PetscFunctionBegin; 303639ff905SBarry Smith ierr = PetscViewerBinaryGetFlowControl(viewer,mcnt);CHKERRQ(ierr); 304639ff905SBarry Smith ierr = PetscViewerBinaryGetFlowControl(viewer,cnt);CHKERRQ(ierr); 305639ff905SBarry Smith PetscFunctionReturn(0); 306e03d165dSBarry Smith } 307639ff905SBarry Smith 308639ff905SBarry Smith #undef __FUNCT__ 309639ff905SBarry Smith #define __FUNCT__ "PetscViewerFlowControlStepMaster" 310639ff905SBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscViewerFlowControlStepMaster(PetscViewer viewer,PetscInt i,PetscInt *mcnt,PetscInt cnt) 311639ff905SBarry Smith { 312639ff905SBarry Smith PetscErrorCode ierr; 313639ff905SBarry Smith MPI_Comm comm; 314639ff905SBarry Smith 315639ff905SBarry Smith PetscFunctionBegin; 316639ff905SBarry Smith ierr = PetscObjectGetComm((PetscObject)viewer,&comm);CHKERRQ(ierr); 317639ff905SBarry Smith if (i >= *mcnt) { 318639ff905SBarry Smith *mcnt += cnt; 319639ff905SBarry Smith ierr = MPI_Bcast(mcnt,1,MPIU_INT,0,comm);CHKERRQ(ierr); 320639ff905SBarry Smith } 321639ff905SBarry Smith PetscFunctionReturn(0); 322639ff905SBarry Smith } 323639ff905SBarry Smith 324639ff905SBarry Smith #undef __FUNCT__ 325639ff905SBarry Smith #define __FUNCT__ "PetscViewerFlowControlEndMaster" 326639ff905SBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscViewerFlowControlEndMaster(PetscViewer viewer,PetscInt *mcnt) 327639ff905SBarry Smith { 328639ff905SBarry Smith PetscErrorCode ierr; 329639ff905SBarry Smith MPI_Comm comm; 330639ff905SBarry Smith PetscFunctionBegin; 331639ff905SBarry Smith ierr = PetscObjectGetComm((PetscObject)viewer,&comm);CHKERRQ(ierr); 332639ff905SBarry Smith *mcnt = 0; 333639ff905SBarry Smith ierr = MPI_Bcast(mcnt,1,MPIU_INT,0,comm);CHKERRQ(ierr); 334639ff905SBarry Smith PetscFunctionReturn(0); 335639ff905SBarry Smith } 336639ff905SBarry Smith 337639ff905SBarry Smith #undef __FUNCT__ 338639ff905SBarry Smith #define __FUNCT__ "PetscViewerFlowControlStepWorker" 339639ff905SBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscViewerFlowControlStepWorker(PetscViewer viewer,PetscMPIInt rank,PetscInt *mcnt) 340639ff905SBarry Smith { 341639ff905SBarry Smith PetscErrorCode ierr; 342639ff905SBarry Smith MPI_Comm comm; 343639ff905SBarry Smith PetscFunctionBegin; 344639ff905SBarry Smith ierr = PetscObjectGetComm((PetscObject)viewer,&comm);CHKERRQ(ierr); 345639ff905SBarry Smith while (PETSC_TRUE) { 346639ff905SBarry Smith if (rank < *mcnt) break; 347639ff905SBarry Smith ierr = MPI_Bcast(mcnt,1,MPIU_INT,0,comm);CHKERRQ(ierr); 348639ff905SBarry Smith } 349639ff905SBarry Smith PetscFunctionReturn(0); 350639ff905SBarry Smith } 351639ff905SBarry Smith 352639ff905SBarry Smith #undef __FUNCT__ 353639ff905SBarry Smith #define __FUNCT__ "PetscViewerFlowControlEndWorker" 354639ff905SBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscViewerFlowControlEndWorker(PetscViewer viewer,PetscInt *mcnt) 355639ff905SBarry Smith { 356639ff905SBarry Smith PetscErrorCode ierr; 357639ff905SBarry Smith MPI_Comm comm; 358639ff905SBarry Smith PetscFunctionBegin; 359639ff905SBarry Smith ierr = PetscObjectGetComm((PetscObject)viewer,&comm);CHKERRQ(ierr); 360639ff905SBarry Smith while (PETSC_TRUE) { 361639ff905SBarry Smith ierr = MPI_Bcast(mcnt,1,MPIU_INT,0,comm);CHKERRQ(ierr); 362639ff905SBarry Smith if (!*mcnt) break; 363639ff905SBarry Smith } 364639ff905SBarry Smith PetscFunctionReturn(0); 365fca9dd48SBarry Smith } 366e03d165dSBarry Smith 36777ed5343SBarry Smith /* 368a5057860SBarry Smith PetscViewer writes to MATLAB .mat file 369cbb32127SBarry Smith */ 370014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerMatlabPutArray(PetscViewer,int,int,const PetscScalar*,const char*); 371014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerMatlabGetArray(PetscViewer,int,int,PetscScalar*,const char*); 372014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewerMatlabPutVariable(PetscViewer,const char*,void*); 373cbb32127SBarry Smith 374e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 375e04113cfSBarry Smith PETSC_EXTERN PetscErrorCode PetscObjectViewSAWs(PetscObject,PetscViewer); 376bfb97211SBarry Smith #endif 377bfb97211SBarry Smith 378b9617806SBarry Smith /*S 3791890ba74SBarry Smith PetscViewers - Abstract collection of PetscViewers. It is just an expandable array of viewers. 380b9617806SBarry Smith 381b9617806SBarry Smith Level: intermediate 382b9617806SBarry Smith 383b9617806SBarry Smith Concepts: viewing 384b9617806SBarry Smith 385b9617806SBarry Smith .seealso: PetscViewerCreate(), PetscViewerSetType(), PetscViewerType, PetscViewer, PetscViewersCreate(), 386b9617806SBarry Smith PetscViewersGetViewer() 387b9617806SBarry Smith S*/ 38895fbd943SSatish Balay typedef struct _n_PetscViewers* PetscViewers; 389014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewersCreate(MPI_Comm,PetscViewers*); 390014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewersDestroy(PetscViewers*); 391014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscViewersGetViewer(PetscViewers,PetscInt,PetscViewer*); 392d132466eSBarry Smith 393e1e7ae07SJed Brown /* Reset __FUNCT__ in case the user does not define it themselves */ 394e1e7ae07SJed Brown #undef __FUNCT__ 395e1e7ae07SJed Brown #define __FUNCT__ "User provided function" 396e1e7ae07SJed Brown 397cb5b572fSBarry Smith #endif 398