Actual source code: petscviewertypes.h

      1: /*
      2:      PetscViewers are objects where other objects can be looked at or stored.
      3: */

      5: #pragma once

      7: /* MANSEC = Sys */
      8: /* SUBMANSEC = Viewer */

     10: /*S
     11:   PetscViewer - Abstract PETSc object for displaying in ASCII, saving to a binary file, graphically displaying, etc.
     12:                 PETSc objects and their data

     14:   Level: beginner

     16:   Notes:
     17:   Each PETSc class, for example `Vec`, has a viewer method associated with that class, for example `VecView()`, that can be used
     18:   to view, display, store to a file information about that object, etc. Each class also has a method that uses
     19:   the options database to view the object, for example `VecViewFromOptions()`.

     21:   See `PetscViewerType` for a list of all `PetscViewer` types.

     23: .seealso: [](sec_viewers), `PetscViewerType`, `PETSCVIEWERASCII`, `PetscViewerCreate()`, `PetscViewerSetType()`,
     24:           `VecView()`, `VecViewFromOptions()`, `PetscObjectView()`
     25: S*/
     26: typedef struct _p_PetscViewer *PetscViewer;