Wrapper for PETSc's matrix class. More...

#include <petsc.hpp>

Inheritance diagram for mfem::PetscParMatrix:

Collaboration diagram for mfem::PetscParMatrix:

Public Member Functions
	PetscParMatrix ()
	Create an empty matrix to be used as a reference to an existing matrix. More...

	PetscParMatrix (petsc::Mat a, bool ref=false)
	Creates PetscParMatrix out of PETSc's Mat. More...

	PetscParMatrix (const PetscParMatrix *pa, Operator::Type tid)
	Convert a PetscParMatrix pa with a new PETSc format tid. Note that if pa is already a PetscParMatrix of the same type as tid, the resulting PetscParMatrix will share the same Mat object. More...

	PetscParMatrix (const PetscParMatrix &A, const Array< PetscInt > &rows, const Array< PetscInt > &cols)
	Creates a PetscParMatrix extracting the submatrix of A with rows row indices and cols column indices. More...

	PetscParMatrix (const HypreParMatrix *ha, Operator::Type tid=Operator::PETSC_MATAIJ)
	Convert a HypreParMatrix ha to a PetscParMatrix in the given PETSc format tid. More...

	PetscParMatrix (const SparseMatrix *sa, Operator::Type tid=Operator::PETSC_MATAIJ)
	Convert a SparseMatrix ha to a PetscParMatrix in the given PETSc format tid. More...

	PetscParMatrix (MPI_Comm comm, const Operator *op, Operator::Type tid=Operator::PETSC_MATSHELL)
	Convert an mfem::Operator into a PetscParMatrix in the given PETSc format tid. More...

	PetscParMatrix (MPI_Comm comm, PetscInt glob_size, PetscInt row_starts, SparseMatrix diag, Operator::Type tid)
	Creates block-diagonal square parallel matrix. More...

	PetscParMatrix (MPI_Comm comm, PetscInt global_num_rows, PetscInt global_num_cols, PetscInt row_starts, PetscInt col_starts, SparseMatrix *diag, Operator::Type tid)
	Creates block-diagonal rectangular parallel matrix. More...

virtual	~PetscParMatrix ()
	Calls PETSc's destroy function. More...

void	SetMat (petsc::Mat newA)
	Replace the inner Mat Object. The reference count of newA is increased. More...

void	Mult (double a, const Vector &x, double b, Vector &y) const
	Matvec: y = a A x + b y. More...

void	MultTranspose (double a, const Vector &x, double b, Vector &y) const
	Matvec transpose: y = a A^T x + b y. More...

void	Mult (const Vector &x, Vector &y) const override
	Operator application: `y=A(x)`. More...

void	MultTranspose (const Vector &x, Vector &y) const override
	Action of the transpose operator: `y=A^t(x)`. The default behavior in class Operator is to generate an error. More...

void	AddMult (const Vector &x, Vector &y, const double a=1.0) const override
	Operator application: `y+=A(x)` (default) or `y+=a*A(x)`. More...

void	AddMultTranspose (const Vector &x, Vector &y, const double a=1.0) const override
	Operator transpose application: `y+=A^t(x)` (default) or `y+=a*A^t(x)`. More...

MPI_Comm	GetComm () const
	Get the associated MPI communicator. More...

	operator petsc::Mat () const
	Typecasting to PETSc's Mat type. More...

	operator PetscObject () const
	Typecasting to PETSc object. More...

PetscInt	GetRowStart () const
	Returns the global index of the first local row. More...

PetscInt	GetColStart () const
	Returns the global index of the first local column. More...

PetscInt	GetNumRows () const
	Returns the local number of rows. More...

PetscInt	GetNumCols () const
	Returns the local number of columns. More...

PetscInt	M () const
	Returns the global number of rows. More...

PetscInt	N () const
	Returns the global number of columns. More...

PetscInt	GetGlobalNumRows () const
	Returns the global number of rows. More...

PetscInt	GetGlobalNumCols () const
	Returns the global number of columns. More...

PetscInt	NNZ () const
	Returns the number of nonzeros. More...

PetscParVector *	GetX () const
	Returns the inner vector in the domain of A (it creates it if needed) More...

PetscParVector *	GetY () const
	Returns the inner vector in the range of A (it creates it if needed) More...

PetscParMatrix *	Transpose (bool action=false)
	Returns the transpose of the PetscParMatrix. More...

void	Print (const char *fname=NULL, bool binary=false) const
	Prints the matrix (to stdout if fname is NULL) More...

void	operator*= (double s)
	Scale all entries by s: A_scaled = s*A. More...

void	EliminateRowsCols (const Array< int > &rows_cols, const PetscParVector &X, PetscParVector &B, double diag=1.)
	Eliminate rows and columns from the matrix, and rows from the vector B. Modify B with the BC values in X. Put diag on the diagonal corresponding to eliminated entries. More...

void	EliminateRowsCols (const Array< int > &rows_cols, const HypreParVector &X, HypreParVector &B, double diag=1.)

PetscParMatrix *	EliminateRowsCols (const Array< int > &rows_cols)
	Eliminate rows and columns from the matrix and store the eliminated elements in a new matrix Ae (returned). More...

void	ScaleRows (const Vector &s)
	Scale the local row i by s(i). More...

void	ScaleCols (const Vector &s)
	Scale the local col i by s(i). More...

void	Shift (double s)
	Shift diagonal by a constant. More...

void	Shift (const Vector &s)
	Shift diagonal by a vector. More...

void	EliminateRows (const Array< int > &rows)
	Eliminate only the rows from the matrix. More...

void	SetBlockSize (PetscInt rbs, PetscInt cbs=-1)
	Set row and column block sizes of a matrix. More...

void	MakeRef (const PetscParMatrix &master)
	Makes this object a reference to another PetscParMatrix. More...

petsc::Mat	ReleaseMat (bool dereference)
	Release the PETSc Mat object. If dereference is true, decrement the refcount of the Mat object. More...

Type	GetType () const

Assignment operators
PetscParMatrix &	operator= (const PetscParMatrix &B)

PetscParMatrix &	operator= (const HypreParMatrix &B)

PetscParMatrix &	operator+= (const PetscParMatrix &B)

PetscParMatrix &	operator-= (const PetscParMatrix &B)

Public Member Functions inherited from mfem::Operator
void	InitTVectors (const Operator Po, const Operator Ri, const Operator *Pi, Vector &x, Vector &b, Vector &X, Vector &B) const
	Initializes memory for true vectors of linear system. More...

	Operator (int s=0)
	Construct a square Operator with given size s (default 0). More...

	Operator (int h, int w)
	Construct an Operator with the given height (output size) and width (input size). More...

int	Height () const
	Get the height (size of output) of the Operator. Synonym with NumRows(). More...

int	NumRows () const
	Get the number of rows (size of output) of the Operator. Synonym with Height(). More...

int	Width () const
	Get the width (size of input) of the Operator. Synonym with NumCols(). More...

int	NumCols () const
	Get the number of columns (size of input) of the Operator. Synonym with Width(). More...

virtual MemoryClass	GetMemoryClass () const
	Return the MemoryClass preferred by the Operator. More...

virtual void	ArrayMult (const Array< const Vector > &X, Array< Vector > &Y) const
	Operator application on a matrix: `Y=A(X)`. More...

virtual void	ArrayMultTranspose (const Array< const Vector > &X, Array< Vector > &Y) const
	Action of the transpose operator on a matrix: `Y=A^t(X)`. More...

virtual void	ArrayAddMult (const Array< const Vector > &X, Array< Vector > &Y, const double a=1.0) const
	Operator application on a matrix: `Y+=A(X)` (default) or `Y+=a*A(X)`. More...

virtual void	ArrayAddMultTranspose (const Array< const Vector > &X, Array< Vector > &Y, const double a=1.0) const
	Operator transpose application on a matrix: `Y+=A^t(X)` (default) or `Y+=a*A^t(X)`. More...

virtual Operator &	GetGradient (const Vector &x) const
	Evaluate the gradient operator at the point x. The default behavior in class Operator is to generate an error. More...

virtual void	AssembleDiagonal (Vector &diag) const
	Computes the diagonal entries into diag. Typically, this operation only makes sense for linear Operators. In some cases, only an approximation of the diagonal is computed. More...

virtual const Operator *	GetProlongation () const
	Prolongation operator from linear algebra (linear system) vectors, to input vectors for the operator. `NULL` means identity. More...

virtual const Operator *	GetRestriction () const
	Restriction operator from input vectors for the operator to linear algebra (linear system) vectors. `NULL` means identity. More...

virtual const Operator *	GetOutputProlongation () const
	Prolongation operator from linear algebra (linear system) vectors, to output vectors for the operator. `NULL` means identity. More...

virtual const Operator *	GetOutputRestrictionTranspose () const
	Transpose of GetOutputRestriction, directly available in this form to facilitate matrix-free RAP-type operators. More...

virtual const Operator *	GetOutputRestriction () const
	Restriction operator from output vectors for the operator to linear algebra (linear system) vectors. `NULL` means identity. More...

void	FormLinearSystem (const Array< int > &ess_tdof_list, Vector &x, Vector &b, Operator *&A, Vector &X, Vector &B, int copy_interior=0)
	Form a constrained linear system using a matrix-free approach. More...

void	FormRectangularLinearSystem (const Array< int > &trial_tdof_list, const Array< int > &test_tdof_list, Vector &x, Vector &b, Operator *&A, Vector &X, Vector &B)
	Form a column-constrained linear system using a matrix-free approach. More...

virtual void	RecoverFEMSolution (const Vector &X, const Vector &b, Vector &x)
	Reconstruct a solution vector x (e.g. a GridFunction) from the solution X of a constrained linear system obtained from Operator::FormLinearSystem() or Operator::FormRectangularLinearSystem(). More...

void	FormSystemOperator (const Array< int > &ess_tdof_list, Operator *&A)
	Return in A a parallel (on truedofs) version of this square operator. More...

void	FormRectangularSystemOperator (const Array< int > &trial_tdof_list, const Array< int > &test_tdof_list, Operator *&A)
	Return in A a parallel (on truedofs) version of this rectangular operator (including constraints). More...

void	FormDiscreteOperator (Operator *&A)
	Return in A a parallel (on truedofs) version of this rectangular operator. More...

void	PrintMatlab (std::ostream &out, int n, int m=0) const
	Prints operator with input size n and output size m in Matlab format. More...

virtual void	PrintMatlab (std::ostream &out) const
	Prints operator in Matlab format. More...

virtual	~Operator ()
	Virtual destructor. More...

Type	GetType () const
	Return the type ID of the Operator class. More...

Protected Member Functions
void	Init ()
	Initialize with defaults. Does not initialize inherited members. More...

void	Destroy ()
	Delete all owned data. Does not perform re-initialization with defaults. More...

void	MakeWrapper (MPI_Comm comm, const Operator op, petsc::Mat B)
	Creates a wrapper around a mfem::Operator op using PETSc's MATSHELL object and returns the Mat in B. More...

void	ConvertOperator (MPI_Comm comm, const Operator &op, petsc::Mat *B, Operator::Type tid)

Protected Member Functions inherited from mfem::Operator
void	FormConstrainedSystemOperator (const Array< int > &ess_tdof_list, ConstrainedOperator *&Aout)
	see FormSystemOperator() More...

void	FormRectangularConstrainedSystemOperator (const Array< int > &trial_tdof_list, const Array< int > &test_tdof_list, RectangularConstrainedOperator *&Aout)
	see FormRectangularSystemOperator() More...

Operator *	SetupRAP (const Operator Pi, const Operator Po)
	Returns RAP Operator of this, using input/output Prolongation matrices Pi corresponds to "P", Po corresponds to "Rt". More...

Protected Attributes
petsc::Mat	A
	The actual PETSc object. More...

PetscParVector *	X
	Auxiliary vectors for typecasting. More...

PetscParVector *	Y

Protected Attributes inherited from mfem::Operator
int	height
	Dimension of the output / number of rows in the matrix. More...

int	width
	Dimension of the input / number of columns in the matrix. More...

Friends
class	PetscLinearSolver

class	PetscPreconditioner

Additional Inherited Members
Public Types inherited from mfem::Operator
enum	DiagonalPolicy { DIAG_ZERO, DIAG_ONE, DIAG_KEEP }
	Defines operator diagonal policy upon elimination of rows and/or columns. More...

enum	Type { ANY_TYPE, MFEM_SPARSEMAT, Hypre_ParCSR, PETSC_MATAIJ, PETSC_MATIS, PETSC_MATSHELL, PETSC_MATNEST, PETSC_MATHYPRE, PETSC_MATGENERIC, Complex_Operator, MFEM_ComplexSparseMat, Complex_Hypre_ParCSR, Complex_DenseMat, MFEM_Block_Matrix, MFEM_Block_Operator }
	Enumeration defining IDs for some classes derived from Operator. More...

Detailed Description

Wrapper for PETSc's matrix class.

Definition at line 315 of file petsc.hpp.

Constructor & Destructor Documentation

◆ PetscParMatrix() [1/9]

mfem::PetscParMatrix::PetscParMatrix ( )

Create an empty matrix to be used as a reference to an existing matrix.

Definition at line 1038 of file petsc.cpp.

◆ PetscParMatrix() [2/9]

mfem::PetscParMatrix::PetscParMatrix	(	petsc::Mat	a,
		bool	ref = `false`
	)

Creates PetscParMatrix out of PETSc's Mat.

Parameters

[in]	a	The PETSc Mat object.
[in]	ref	If true, we increase the reference count of a.

Definition at line 1790 of file petsc.cpp.

◆ PetscParMatrix() [3/9]

mfem::PetscParMatrix::PetscParMatrix	(	const PetscParMatrix *	pa,
		Operator::Type	tid
	)

explicit

Convert a PetscParMatrix pa with a new PETSc format tid. Note that if pa is already a PetscParMatrix of the same type as tid, the resulting PetscParMatrix will share the same Mat object.

Definition at line 1063 of file petsc.cpp.

◆ PetscParMatrix() [4/9]

mfem::PetscParMatrix::PetscParMatrix	(	const PetscParMatrix &	A,
		const Array< PetscInt > &	rows,
		const Array< PetscInt > &	cols
	)

Creates a PetscParMatrix extracting the submatrix of A with rows row indices and cols column indices.

Definition at line 1043 of file petsc.cpp.

◆ PetscParMatrix() [5/9]

mfem::PetscParMatrix::PetscParMatrix	(	const HypreParMatrix *	ha,
		Operator::Type	tid = `Operator::PETSC_MATAIJ`
	)

explicit

Convert a HypreParMatrix ha to a PetscParMatrix in the given PETSc format tid.

The supported type ids are: Operator::PETSC_MATAIJ, Operator::PETSC_MATIS, Operator::PETSC_MATSHELL and Operator::PETSC_MATHYPRE ha can be destroyed unless tid == PETSC_MATSHELL or tid == PETSC_MATHYPRE

Definition at line 1071 of file petsc.cpp.

◆ PetscParMatrix() [6/9]

mfem::PetscParMatrix::PetscParMatrix	(	const SparseMatrix *	sa,
		Operator::Type	tid = `Operator::PETSC_MATAIJ`
	)

explicit

Convert a SparseMatrix ha to a PetscParMatrix in the given PETSc format tid.

Definition at line 1079 of file petsc.cpp.

◆ PetscParMatrix() [7/9]

mfem::PetscParMatrix::PetscParMatrix	(	MPI_Comm	comm,
		const Operator *	op,
		Operator::Type	tid = `Operator::PETSC_MATSHELL`
	)

Convert an mfem::Operator into a PetscParMatrix in the given PETSc format tid.

If tid is Operator::PETSC_MATSHELL and op is not a PetscParMatrix, it converts any mfem::Operator op implementing Operator::Mult() and Operator::MultTranspose() into a PetscParMatrix. The Operator op should not be deleted while the constructed PetscParMatrix is used.

Otherwise, it tries to convert the operator in PETSc's classes. op cannot be destroyed if tid == PETSC_MATHYPRE.

In particular, if op is a BlockOperator, then a MATNEST Mat object is created using tid as the type for the blocks. Note that if op is already a PetscParMatrix of the same type as tid, the resulting PetscParMatrix will share the same Mat object

Definition at line 1087 of file petsc.cpp.

◆ PetscParMatrix() [8/9]

mfem::PetscParMatrix::PetscParMatrix	(	MPI_Comm	comm,
		PetscInt	glob_size,
		PetscInt *	row_starts,
		SparseMatrix *	diag,
		Operator::Type	tid
	)

Creates block-diagonal square parallel matrix.

The block-diagonal is given by diag which must be in CSR format (finalized). The new PetscParMatrix does not take ownership of any of the input arrays. The type id tid can be either PETSC_MATAIJ (parallel distributed CSR) or PETSC_MATIS.

Definition at line 1096 of file petsc.cpp.

◆ PetscParMatrix() [9/9]

mfem::PetscParMatrix::PetscParMatrix	(	MPI_Comm	comm,
		PetscInt	global_num_rows,
		PetscInt	global_num_cols,
		PetscInt *	row_starts,
		PetscInt *	col_starts,
		SparseMatrix *	diag,
		Operator::Type	tid
	)

Creates block-diagonal rectangular parallel matrix.

The block-diagonal is given by diag which must be in CSR format (finalized). The new PetscParMatrix does not take ownership of any of the input arrays. The type id tid can be either PETSC_MATAIJ (parallel distributed CSR) or PETSC_MATIS.

Definition at line 1109 of file petsc.cpp.

◆ ~PetscParMatrix()

virtual mfem::PetscParMatrix::~PetscParMatrix ( )

inlinevirtual

Calls PETSc's destroy function.

Definition at line 425 of file petsc.hpp.

Member Function Documentation

◆ AddMult()

void mfem::PetscParMatrix::AddMult	(	const Vector &	x,
		Vector &	y,
		const double	a = `1.0`
	)		const

inlineoverridevirtual

Operator application: y+=A(x) (default) or y+=a*A(x).

Reimplemented from mfem::Operator.

Definition at line 450 of file petsc.hpp.

◆ AddMultTranspose()

void mfem::PetscParMatrix::AddMultTranspose	(	const Vector &	x,
		Vector &	y,
		const double	a = `1.0`
	)		const

inlineoverridevirtual

Operator transpose application: y+=A^t(x) (default) or y+=a*A^t(x).

Reimplemented from mfem::Operator.

Definition at line 454 of file petsc.hpp.

◆ ConvertOperator()

void mfem::PetscParMatrix::ConvertOperator	(	MPI_Comm	comm,
		const Operator &	op,
		petsc::Mat *	B,
		Operator::Type	tid
	)

protected

Convert an mfem::Operator into a Mat B; op can be destroyed unless tid == PETSC_MATSHELL or tid == PETSC_MATHYPRE if op is a BlockOperator, the operator type is relevant to the individual blocks

Definition at line 1376 of file petsc.cpp.

◆ Destroy()

void mfem::PetscParMatrix::Destroy ( )

protected

Delete all owned data. Does not perform re-initialization with defaults.

Definition at line 1777 of file petsc.cpp.

◆ EliminateRows()

void mfem::PetscParMatrix::EliminateRows ( const Array< int > & rows )

Eliminate only the rows from the matrix.

Definition at line 2276 of file petsc.cpp.

◆ EliminateRowsCols() [1/3]

void mfem::PetscParMatrix::EliminateRowsCols	(	const Array< int > &	rows_cols,
		const PetscParVector &	X,
		PetscParVector &	B,
		double	diag = `1.`
	)

Eliminate rows and columns from the matrix, and rows from the vector B. Modify B with the BC values in X. Put diag on the diagonal corresponding to eliminated entries.

Definition at line 2247 of file petsc.cpp.

◆ EliminateRowsCols() [2/3]

void mfem::PetscParMatrix::EliminateRowsCols	(	const Array< int > &	rows_cols,
		const HypreParVector &	X,
		HypreParVector &	B,
		double	diag = `1.`
	)

Definition at line 2239 of file petsc.cpp.

◆ EliminateRowsCols() [3/3]

PetscParMatrix * mfem::PetscParMatrix::EliminateRowsCols ( const Array< int > & rows_cols )

Eliminate rows and columns from the matrix and store the eliminated elements in a new matrix Ae (returned).

The sum of the modified matrix and the returned matrix, Ae, is equal to the original matrix.

Definition at line 2228 of file petsc.cpp.

◆ GetColStart()

PetscInt mfem::PetscParMatrix::GetColStart ( ) const

Returns the global index of the first local column.

Definition at line 983 of file petsc.cpp.

◆ GetComm()

MPI_Comm mfem::PetscParMatrix::GetComm ( ) const

Get the associated MPI communicator.

Definition at line 1329 of file petsc.cpp.

◆ GetGlobalNumCols()

PetscInt mfem::PetscParMatrix::GetGlobalNumCols ( ) const

inline

Returns the global number of columns.

Definition at line 489 of file petsc.hpp.

◆ GetGlobalNumRows()

PetscInt mfem::PetscParMatrix::GetGlobalNumRows ( ) const

inline

Returns the global number of rows.

Definition at line 486 of file petsc.hpp.

◆ GetNumCols()

PetscInt mfem::PetscParMatrix::GetNumCols ( ) const

Returns the local number of columns.

Definition at line 997 of file petsc.cpp.

◆ GetNumRows()

PetscInt mfem::PetscParMatrix::GetNumRows ( ) const

Returns the local number of rows.

Definition at line 990 of file petsc.cpp.

◆ GetRowStart()

PetscInt mfem::PetscParMatrix::GetRowStart ( ) const

Returns the global index of the first local row.

Definition at line 976 of file petsc.cpp.

◆ GetType()

Operator::Type mfem::PetscParMatrix::GetType ( ) const

Definition at line 2303 of file petsc.cpp.

◆ GetX()

PetscParVector * mfem::PetscParMatrix::GetX ( ) const

Returns the inner vector in the domain of A (it creates it if needed)

Definition at line 1947 of file petsc.cpp.

◆ GetY()

PetscParVector * mfem::PetscParMatrix::GetY ( ) const

Returns the inner vector in the range of A (it creates it if needed)

Definition at line 1957 of file petsc.cpp.

◆ Init()

void mfem::PetscParMatrix::Init ( )

protected

Initialize with defaults. Does not initialize inherited members.

Definition at line 1031 of file petsc.cpp.

◆ M()

PetscInt mfem::PetscParMatrix::M ( ) const

Returns the global number of rows.

Definition at line 1004 of file petsc.cpp.

◆ MakeRef()

void mfem::PetscParMatrix::MakeRef ( const PetscParMatrix & master )

Makes this object a reference to another PetscParMatrix.

Definition at line 1937 of file petsc.cpp.

◆ MakeWrapper()

void mfem::PetscParMatrix::MakeWrapper	(	MPI_Comm	comm,
		const Operator *	op,
		petsc::Mat *	B
	)

protected

Creates a wrapper around a mfem::Operator op using PETSc's MATSHELL object and returns the Mat in B.

This does not take any reference to op, that should not be destroyed until B is needed.

Definition at line 1342 of file petsc.cpp.

◆ Mult() [1/2]

void mfem::PetscParMatrix::Mult	(	double	a,
		const Vector &	x,
		double	b,
		Vector &	y
	)		const

Matvec: y = a A x + b y.

Definition at line 1986 of file petsc.cpp.

◆ Mult() [2/2]

void mfem::PetscParMatrix::Mult	(	const Vector &	x,
		Vector &	y
	)		const

inlineoverridevirtual

Operator application: y=A(x).

Implements mfem::Operator.

Definition at line 444 of file petsc.hpp.

◆ MultTranspose() [1/2]

void mfem::PetscParMatrix::MultTranspose	(	double	a,
		const Vector &	x,
		double	b,
		Vector &	y
	)		const

Matvec transpose: y = a A^T x + b y.

Definition at line 2003 of file petsc.cpp.

◆ MultTranspose() [2/2]

void mfem::PetscParMatrix::MultTranspose	(	const Vector &	x,
		Vector &	y
	)		const

inlineoverridevirtual

Action of the transpose operator: y=A^t(x). The default behavior in class Operator is to generate an error.

Reimplemented from mfem::Operator.

Definition at line 447 of file petsc.hpp.

◆ N()

PetscInt mfem::PetscParMatrix::N ( ) const

Returns the global number of columns.

Definition at line 1011 of file petsc.cpp.

◆ NNZ()

PetscInt mfem::PetscParMatrix::NNZ ( ) const

Returns the number of nonzeros.

Differently from HYPRE, this call is collective on the communicator, as this number is not stored inside PETSc, but needs to be computed.

Definition at line 1018 of file petsc.cpp.

◆ operator petsc::Mat()

mfem::PetscParMatrix::operator petsc::Mat ( ) const

inline

Typecasting to PETSc's Mat type.

Definition at line 462 of file petsc.hpp.

◆ operator PetscObject()

mfem::PetscParMatrix::operator PetscObject ( ) const

inline

Typecasting to PETSc object.

Definition at line 465 of file petsc.hpp.

◆ operator*=()

void mfem::PetscParMatrix::operator*= ( double s )

Scale all entries by s: A_scaled = s*A.

Definition at line 1981 of file petsc.cpp.

◆ operator+=()

PetscParMatrix & mfem::PetscParMatrix::operator+= ( const PetscParMatrix & B )

Definition at line 1160 of file petsc.cpp.

◆ operator-=()

PetscParMatrix & mfem::PetscParMatrix::operator-= ( const PetscParMatrix & B )

Definition at line 1175 of file petsc.cpp.

◆ operator=() [1/2]

PetscParMatrix & mfem::PetscParMatrix::operator= ( const PetscParMatrix & B )

Definition at line 1144 of file petsc.cpp.

◆ operator=() [2/2]

PetscParMatrix & mfem::PetscParMatrix::operator= ( const HypreParMatrix & B )

Definition at line 1123 of file petsc.cpp.

◆ Print()

void mfem::PetscParMatrix::Print	(	const char *	fname = `NULL`,
		bool	binary = `false`
	)		const

Prints the matrix (to stdout if fname is NULL)

Definition at line 2021 of file petsc.cpp.

◆ ReleaseMat()

Mat mfem::PetscParMatrix::ReleaseMat ( bool dereference )

Release the PETSc Mat object. If dereference is true, decrement the refcount of the Mat object.

Definition at line 2290 of file petsc.cpp.

◆ ScaleCols()

void mfem::PetscParMatrix::ScaleCols ( const Vector & s )

Scale the local col i by s(i).

Definition at line 2057 of file petsc.cpp.

◆ ScaleRows()

void mfem::PetscParMatrix::ScaleRows ( const Vector & s )

Scale the local row i by s(i).

Definition at line 2046 of file petsc.cpp.

◆ SetBlockSize()

void mfem::PetscParMatrix::SetBlockSize	(	PetscInt	rbs,
		PetscInt	cbs = `-1`
	)

Set row and column block sizes of a matrix.

Note: This will error if the local sizes of the matrix are not a multiple of the block sizes.; This is a logically collective operation, so all processes need to call it.

Definition at line 1025 of file petsc.cpp.

◆ SetMat()

void mfem::PetscParMatrix::SetMat ( petsc::Mat newA )

Replace the inner Mat Object. The reference count of newA is increased.

Definition at line 1802 of file petsc.cpp.

◆ Shift() [1/2]

void mfem::PetscParMatrix::Shift ( double s )

Shift diagonal by a constant.

Definition at line 2068 of file petsc.cpp.

◆ Shift() [2/2]

void mfem::PetscParMatrix::Shift ( const Vector & s )

Shift diagonal by a vector.

Definition at line 2073 of file petsc.cpp.

◆ Transpose()

PetscParMatrix * mfem::PetscParMatrix::Transpose ( bool action = false )

Returns the transpose of the PetscParMatrix.

If action is false, the new matrix is constructed with the PETSc function MatTranspose(). If action is true, then the matrix is not actually transposed. Instead, an object that behaves like the transpose is returned.

Definition at line 1967 of file petsc.cpp.

Friends And Related Function Documentation

◆ PetscLinearSolver

friend class PetscLinearSolver

friend

Definition at line 344 of file petsc.hpp.

◆ PetscPreconditioner

friend class PetscPreconditioner

friend

Definition at line 345 of file petsc.hpp.

Member Data Documentation

◆ A

petsc::Mat mfem::PetscParMatrix::A

protected

The actual PETSc object.

Definition at line 319 of file petsc.hpp.

◆ X

PetscParVector* mfem::PetscParMatrix::X

mutableprotected

Auxiliary vectors for typecasting.

Definition at line 322 of file petsc.hpp.

◆ Y

PetscParVector * mfem::PetscParMatrix::Y

mutableprotected

Definition at line 322 of file petsc.hpp.

The documentation for this class was generated from the following files:

linalg/petsc.hpp
linalg/petsc.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PetscParMatrix() [1/9]

◆ PetscParMatrix() [2/9]

◆ PetscParMatrix() [3/9]

◆ PetscParMatrix() [4/9]

◆ PetscParMatrix() [5/9]

◆ PetscParMatrix() [6/9]

◆ PetscParMatrix() [7/9]

◆ PetscParMatrix() [8/9]

◆ PetscParMatrix() [9/9]

◆ ~PetscParMatrix()

Member Function Documentation

◆ AddMult()

◆ AddMultTranspose()

◆ ConvertOperator()

◆ Destroy()

◆ EliminateRows()

◆ EliminateRowsCols() [1/3]

◆ EliminateRowsCols() [2/3]

◆ EliminateRowsCols() [3/3]

◆ GetColStart()

◆ GetComm()

◆ GetGlobalNumCols()

◆ GetGlobalNumRows()

◆ GetNumCols()

◆ GetNumRows()

◆ GetRowStart()

◆ GetType()

◆ GetX()

◆ GetY()

◆ Init()

◆ M()

◆ MakeRef()

◆ MakeWrapper()

◆ Mult() [1/2]

◆ Mult() [2/2]

◆ MultTranspose() [1/2]

◆ MultTranspose() [2/2]

◆ N()

◆ NNZ()

◆ operator petsc::Mat()

◆ operator PetscObject()

◆ operator*=()

◆ operator+=()

◆ operator-=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ Print()

◆ ReleaseMat()

◆ ScaleCols()

◆ ScaleRows()

◆ SetBlockSize()

◆ SetMat()

◆ Shift() [1/2]

◆ Shift() [2/2]

◆ Transpose()

Friends And Related Function Documentation

◆ PetscLinearSolver

◆ PetscPreconditioner

Member Data Documentation

◆ A

◆ X

◆ Y