petsc-3.14.6 2021-03-30
PETSC_VIEWER_SOCKET_
Creates a socket viewer shared by all processors in a communicator.
Synopsis
PetscViewer PETSC_VIEWER_SOCKET_(MPI_Comm comm)
Collective
Input Parameter
| comm | - the MPI communicator to share the socket PetscViewer
|
Options Database Keys
For use with the default PETSC_VIEWER_SOCKET_WORLD or if
NULL is passed for machine or PETSC_DEFAULT is passed for port
-viewer_socket_machine <machine>
-viewer_socket_port <port>
Environmental variables
| PETSC_VIEWER_SOCKET_PORT | - portnumber
|
| PETSC_VIEWER_SOCKET_MACHINE | - machine name
|
Notes
Unlike almost all other PETSc routines, Petsc_VIEWER_SOCKET_ does not return
an error code, it returns NULL if it fails. The socket PetscViewer is usually used in the form
XXXView(XXX object,PETSC_VIEWER_SOCKET_(comm));
Currently the only socket client available is MATLAB. See
src/dm/tests/ex12.c and ex12.m for an example of usage.
Connects to a waiting socket and stays connected until PetscViewerDestroy() is called.
Use this for communicating with an interactive MATLAB session, see PETSC_VIEWER_MATLAB_() for writing output to a
.mat file. Use PetscMatlabEngineCreate() or PETSC_MATLAB_ENGINE_(), PETSC_MATLAB_ENGINE_SELF, or PETSC_MATLAB_ENGINE_WORLD
for communicating with a MATLAB Engine
See Also
PETSC_VIEWER_SOCKET_WORLD, PETSC_VIEWER_SOCKET_SELF, PetscViewerSocketOpen(), PetscViewerCreate(),
PetscViewerSocketSetConnection(), PetscViewerDestroy(), PETSC_VIEWER_SOCKET_(), PetscViewerBinaryWrite(), PetscViewerBinaryRead(),
PetscViewerBinaryWriteStringArray(), PetscViewerBinaryGetDescriptor(), PETSC_VIEWER_MATLAB_()
Level
intermediate
Location
src/sys/classes/viewer/impls/socket/send.c
Index of all Viewer routines
Table of Contents for all manual pages
Index of all manual pages