PETScWrappers Namespace Reference

Namespaces
namespace	internal
namespace	internals
namespace	MatrixIterators
namespace	MPI

Classes
class	FullMatrix
class	MatrixBase
class	MatrixFree
class	PreconditionBase
class	PreconditionBlockJacobi
class	PreconditionBoomerAMG
class	PreconditionEisenstat
class	PreconditionICC
class	PreconditionILU
class	PreconditionJacobi
class	PreconditionLU
class	PreconditionNone
class	PreconditionParaSails
class	PreconditionSOR
class	PreconditionSSOR
class	SolverBase
class	SolverBiCG
class	SolverBicgstab
class	SolverCG
class	SolverCGS
class	SolverChebychev
class	SolverCR
class	SolverGMRES
class	SolverLSQR
class	SolverPreOnly
class	SolverRichardson
class	SolverTCQMR
class	SolverTFQMR
class	SparseDirectMUMPS
class	SparseMatrix
class	VectorBase

Typedefs
using	PreconditionerBase = PreconditionBase

Functions
void	set_option_value (const std::string &name, const std::string &value)
PetscErrorCode	destroy_matrix (Mat &matrix)
PetscErrorCode	destroy_krylov_solver (KSP &krylov_solver)
void	set_matrix_option (Mat &matrix, const MatOption option_name, const PetscBool option_value=PETSC_FALSE)
void	close_matrix (Mat &matrix)
void	set_keep_zero_rows (Mat &matrix)
void	swap (VectorBase &u, VectorBase &v)

Detailed Description

A namespace in which wrapper classes for PETSc objects reside.

Typedef Documentation

PreconditionerBase

using PETScWrappers::PreconditionerBase = typedef PreconditionBase

Alias for backwards-compatibility.

Deprecated:

Use PETScWrappers::PreconditionBase instead.

Definition at line 1030 of file petsc_precondition.h.

Function Documentation

set_option_value()

void PETScWrappers::set_option_value ( const std::string &  name, const std::string &  value  )

inline

Set an option in the global PETSc database. This function just wraps PetscOptionsSetValue with a version check (the signature of this function changed in PETSc 3.7.0).

Definition at line 46 of file petsc_compatibility.h.

destroy_matrix()

PetscErrorCode PETScWrappers::destroy_matrix ( Mat &  matrix )

inline

Destroy a PETSc matrix. This function wraps MatDestroy with a version check (the signature of this function changed in PETSc 3.2.0).

Warning

Since the primary intent of this function is to enable RAII semantics in the PETSc wrappers, this function will not throw an exception if an error occurs, but instead just returns the error code given by MatDestroy.

Definition at line 70 of file petsc_compatibility.h.

destroy_krylov_solver()

PetscErrorCode PETScWrappers::destroy_krylov_solver ( KSP &  krylov_solver )

inline

Destroy a Krylov Subspace (KSP) PETSc solver. This function wraps KSPDestroy with a version check (the signature of this function changed in PETSc 3.2.0).

Warning

Since the primary intent of this function is to enable RAII semantics in the PETSc wrappers, this function will not throw an exception if an error occurs, but instead just returns the error code given by MatDestroy.

Definition at line 89 of file petsc_compatibility.h.

set_matrix_option()

void PETScWrappers::set_matrix_option ( Mat &  matrix, const MatOption  option_name, const PetscBool  option_value = PETSC_FALSE  )

inline

Set a PETSc matrix option. This function wraps MatSetOption with a version check.

Warning

The argument option_value is ignored in versions of PETSc before 3.0.0 since the corresponding function did not take this argument.

Definition at line 105 of file petsc_compatibility.h.

close_matrix()

void PETScWrappers::close_matrix ( Mat &  matrix )

inline

Tell PETSc that we are not planning on adding new entries to the matrix. Generate errors in debug mode.

Definition at line 120 of file petsc_compatibility.h.

set_keep_zero_rows()

void PETScWrappers::set_keep_zero_rows ( Mat &  matrix )

inline

Tell PETSc to keep the SparsityPattern entries even if we delete a row with clear_rows() which calls MatZeroRows(). Otherwise one can not write into that row afterwards.

Definition at line 137 of file petsc_compatibility.h.

swap()

void swap ( VectorBase &  u, VectorBase &  v  )

inline

Global function swap which overloads the default implementation of the C++ standard library which uses a temporary object. The function simply exchanges the data of the two vectors.

Definition at line 853 of file petsc_vector_base.h.