petsc-master 2014-10-23
Report Typos and Errors

VecView

Views a vector object.

Synopsis

#include "petscvec.h"   
PetscErrorCode  VecView(Vec vec,PetscViewer viewer)
Collective on Vec

Input Parameters

vec - the vector
viewer - an optional visualization context

Notes

The available visualization contexts include
PETSC_VIEWER_STDOUT_SELF - standard output (default)
PETSC_VIEWER_STDOUT_WORLD - synchronized standard output where only the first processor opens the file. All other processors send their data to the first processor to print.

You can change the format the vector is printed using the option PetscViewerSetFormat().

The user can open alternative visualization contexts with

PetscViewerASCIIOpen() - Outputs vector to a specified file
PetscViewerBinaryOpen() - Outputs vector in binary to a specified file; corresponding input uses VecLoad()
PetscViewerDrawOpen() - Outputs vector to an X window display
PetscViewerSocketOpen() - Outputs vector to Socket viewer

The user can call PetscViewerSetFormat() to specify the output format of ASCII printed objects (when using PETSC_VIEWER_STDOUT_SELF, PETSC_VIEWER_STDOUT_WORLD and PetscViewerASCIIOpen). Available formats include

PETSC_VIEWER_DEFAULT - default, prints vector contents
PETSC_VIEWER_ASCII_MATLAB - prints vector contents in MATLAB format
PETSC_VIEWER_ASCII_INDEX - prints vector contents, including indices of vector elements
PETSC_VIEWER_ASCII_COMMON - prints vector contents, using a format common among all vector types

Notes: You can pass any number of vector objects, or other PETSc objects to the same viewer.

Notes for binary viewer: If you pass multiply vectors to a binary viewer you can read them back in in the same order

    with VecLoad().

   If the blocksize of the vector is greater than one then you must provide a unique prefix to
   the vector with PetscObjectSetOptionsPrefix((PetscObject)vec,"uniqueprefix"); BEFORE calling VecView() on the
   vector to be stored and then set that same unique prefix on the vector that you pass to VecLoad(). The blocksize
   information is stored in an ASCII file with the same name as the binary file plus a ".info" appended to the
   filename. If you copy the binary file, make sure you copy the associated .info file with it.

Notes for HDF5 Viewer: the name of the Vec (given with PetscObjectSetName() is the name that is used

   for the object in the HDF5 file. If you wish to store the same vector to the HDF5 viewer (with different values,
   obviously) several times, you must change its name each time before calling the VecView(). The name you use
   here should equal the name that you use in the Vec object that you use with VecLoad().

See the manual page for VecLoad() on the exact format the binary viewer stores the values in the file.

See Also

PetscViewerASCIIOpen(), PetscViewerDrawOpen(), PetscDrawLGCreate(),
PetscViewerSocketOpen(), PetscViewerBinaryOpen(), VecLoad(), PetscViewerCreate(), PetscRealView(), PetscScalarView(), PetscIntView()

Level:beginner
Location:
src/vec/vec/interface/vector.c
Index of all Vec routines
Table of Contents for all manual pages
Index of all manual pages

Examples

src/vec/vec/examples/tutorials/ex2.c.html
src/vec/vec/examples/tutorials/ex3.c.html
src/vec/vec/examples/tutorials/ex5.c.html
src/vec/vec/examples/tutorials/ex6.c.html
src/vec/vec/examples/tutorials/ex7.c.html
src/vec/vec/examples/tutorials/ex8.c.html
src/vec/vec/examples/tutorials/ex10.c.html
src/vec/vec/examples/tutorials/ex12.c.html
src/vec/vec/examples/tutorials/ex15.c.html
src/vec/vec/examples/tutorials/ex16.c.html
src/vec/vec/examples/tutorials/ex19.c.html