Class ae108::cpppetsc::Viewer

template <class Policy>

ClassList > ae108 > cpppetsc > Viewer

Public Types

Type	Name
enum std::uint8_t	Mode Used to specify the mode a file is opened with.

Public Functions

Type	Name
	Viewer (UniqueEntity< PetscViewer > viewer) Creates a Viewer from the provided viewer (takes ownership).
PetscViewer	data () const Returns the internal PetscViewer.

Public Static Functions

Type	Name
Viewer	fromAsciiFilePath (const char * path, const Mode mode) Creates a PetscViewer that writes to an ASCII file at path.
Viewer	fromBinaryFilePath (const char * path, const Mode mode) Creates a PetscViewer that writes to a Binary file at path.
Viewer	fromHdf5FilePath (const char * path, const Mode mode) Creates a PetscViewer that writes to an HDF5 file at path.
Viewer	fromStdout () Creates a PetscViewer that writes to stdout.

Public Types Documentation

enum Mode

Used to specify the mode a file is opened with.

enum ae108::cpppetsc::Viewer::Mode {
    read,
    write
};

---

Public Functions Documentation

function Viewer

Creates a Viewer from the provided viewer (takes ownership).

explicit ae108::cpppetsc::Viewer::Viewer (
    UniqueEntity< PetscViewer > viewer
) 

---

function data

Returns the internal PetscViewer.

PetscViewer ae108::cpppetsc::Viewer::data () const

---

Public Static Functions Documentation

function fromAsciiFilePath

Creates a PetscViewer that writes to an ASCII file at path.

static Viewer ae108::cpppetsc::Viewer::fromAsciiFilePath (
    const char * path,
    const Mode mode
) 

---

function fromBinaryFilePath

Creates a PetscViewer that writes to a Binary file at path.

static Viewer ae108::cpppetsc::Viewer::fromBinaryFilePath (
    const char * path,
    const Mode mode
) 

---

function fromHdf5FilePath

Creates a PetscViewer that writes to an HDF5 file at path.

static Viewer ae108::cpppetsc::Viewer::fromHdf5FilePath (
    const char * path,
    const Mode mode
) 

---

function fromStdout

Creates a PetscViewer that writes to stdout.

static Viewer ae108::cpppetsc::Viewer::fromStdout () 

---

---

The documentation for this class was generated from the following file cpppetsc/src/include/ae108/cpppetsc/Viewer.h