Wrapper class for hypre's ParCSRMatrix. More...

#include <HypreMatrix.hpp>

Inheritance diagram for geosx::HypreMatrix:

Public Types
using	Vector = HypreVector
	Compatible vector type.

Public Types inherited from geosx::LinearOperator< HypreVector >
using	Vector = HypreVector
	Alias for template parameter.

Public Member Functions
HYPRE_ParCSRMatrix const &	unwrapped () const
	Returns a pointer to implementation. More...

HYPRE_IJMatrix const &	unwrappedIJ () const
	Returns a pointer to implementation. More...

Constructor/Destructor Methods
	HypreMatrix ()
	Empty matrix constructor. More...

	HypreMatrix (HypreMatrix const &src)
	Copy constructor. More...

	~HypreMatrix () override
	Virtual destructor.

MatrixBase interface
virtual void	createWithLocalSize (localIndex const localRows, localIndex const localCols, localIndex const maxEntriesPerRow, MPI_Comm const &comm) override
	Create a rectangular matrix from number of rows/columns. More...

virtual void	createWithGlobalSize (globalIndex const globalRows, globalIndex const globalCols, localIndex const maxEntriesPerRow, MPI_Comm const &comm) override
	Create a rectangular matrix from number of rows/columns. More...

virtual void	open () override
	Open matrix for adding new entries. More...

virtual void	close () override
	Assemble and compress the matrix. More...

virtual bool	created () const override
	Query matrix creation status. More...

virtual void	reset () override
	Reset the matrix to default state.

virtual void	set (real64 const value) override
	Set all non-zero elements to a value. More...

virtual void	zero () override
	Set all elements to zero.

virtual void	add (globalIndex const rowIndex, globalIndex const colIndex, real64 const value) override
	Add to one element. More...

virtual void	set (globalIndex const rowIndex, globalIndex const colIndex, real64 const value) override
	Set one element. More...

virtual void	insert (globalIndex const rowIndex, globalIndex const colIndex, real64 const value) override
	Insert one element. More...

virtual void	add (globalIndex const rowIndex, globalIndex const colIndices, real64 const values, localIndex const size) override
	Add elements to one row using c-style arrays. More...

virtual void	set (globalIndex const rowIndex, globalIndex const colIndices, real64 const values, localIndex const size) override
	Set elements to one row using c-style arrays. More...

virtual void	insert (globalIndex const rowIndex, globalIndex const colIndices, real64 const values, localIndex const size) override
	Insert elements to one row using c-style arrays. More...

virtual void	add (globalIndex const rowIndex, arraySlice1d< globalIndex const > const &colIndices, arraySlice1d< real64 const > const &values) override
	Add elements to one row using array1d. More...

virtual void	set (globalIndex const rowIndex, arraySlice1d< globalIndex const > const &colIndices, arraySlice1d< real64 const > const &values) override
	Set elements of one row using array1d. More...

virtual void	insert (globalIndex const rowIndex, arraySlice1d< globalIndex const > const &colIndices, arraySlice1d< real64 const > const &values) override
	Insert elements of one row using array1d. More...

virtual void	add (arraySlice1d< globalIndex const > const &rowIndices, arraySlice1d< globalIndex const > const &colIndices, arraySlice2d< real64 const, MatrixLayout::ROW_MAJOR > const &values) override
	Add a dense block of values. More...

virtual void	set (arraySlice1d< globalIndex const > const &rowIndices, arraySlice1d< globalIndex const > const &colIndices, arraySlice2d< real64 const, MatrixLayout::ROW_MAJOR > const &values) override
	Set a dense block of values. More...

virtual void	insert (arraySlice1d< globalIndex const > const &rowIndices, arraySlice1d< globalIndex const > const &colIndices, arraySlice2d< real64 const, MatrixLayout::ROW_MAJOR > const &values) override
	Insert a dense block of values. More...

virtual void	add (arraySlice1d< globalIndex const > const &rowIndices, arraySlice1d< globalIndex const > const &colIndices, arraySlice2d< real64 const, MatrixLayout::COL_MAJOR > const &values) override
	Add a dense block of values. More...

virtual void	set (arraySlice1d< globalIndex const > const &rowIndices, arraySlice1d< globalIndex const > const &colIndices, arraySlice2d< real64 const, MatrixLayout::COL_MAJOR > const &values) override
	Set a dense block of values. More...

virtual void	insert (arraySlice1d< globalIndex const > const &rowIndices, arraySlice1d< globalIndex const > const &colIndices, arraySlice2d< real64 const, MatrixLayout::COL_MAJOR > const &values) override
	Insert a dense block of values. More...

virtual void	add (globalIndex const rowIndices, globalIndex const colIndices, real64 const *values, localIndex const numRows, localIndex const numCols) override
	Add a dense block of values. More...

virtual void	set (globalIndex const rowIndices, globalIndex const colIndices, real64 const *values, localIndex const numRows, localIndex const numCols) override
	Set a dense block of values. More...

virtual void	insert (globalIndex const rowIndices, globalIndex const colIndices, real64 const *values, localIndex const numRows, localIndex const numCols) override
	Insert dense matrix. More...

virtual void	apply (HypreVector const &src, HypreVector &dst) const override
	Apply operator to a vector. More...

virtual void	applyTranspose (Vector const &src, Vector &dst) const override
	Apply transpose of the matrix to a vector. More...

virtual void	multiply (HypreMatrix const &src, HypreMatrix &dst) const override
	Matrix/Matrix multiplication. More...

virtual void	leftMultiplyTranspose (HypreMatrix const &src, HypreMatrix &dst) const override
	Matrix/Matrix transpose multiplication. More...

virtual void	rightMultiplyTranspose (HypreMatrix const &src, HypreMatrix &dst) const override
	Matrix/Matrix transpose multiplication. More...

virtual void	multiplyRAP (HypreMatrix const &R, HypreMatrix const &P, HypreMatrix &dst) const override
	Compute the triple product `dst = R * this * P` More...

virtual void	multiplyPtAP (HypreMatrix const &P, HypreMatrix &dst) const override
	Compute the triple product `dst = P^T * this * P` More...

virtual void	gemv (real64 const alpha, HypreVector const &x, real64 const beta, HypreVector &y, bool useTranspose=false) const override
	Compute gemv `y = alphaAx + beta*y`. More...

virtual void	scale (real64 const scalingFactor) override
	Multiply all elements by scalingFactor. More...

virtual void	leftScale (HypreVector const &vec) override
	Pre-multiplies (left) with diagonal matrix consisting of the values in vec. More...

virtual void	rightScale (HypreVector const &vec) override
	Post-multiplies (right) with diagonal matrix consisting of the values in vec. More...

virtual void	leftRightScale (HypreVector const &vecLeft, HypreVector const &vecRight) override
	Post-multiplies (right) with diagonal matrix consisting of the values in vecRight and pre-multiplies (left) with diagonal matrix consisting of the values in vec. More...

virtual void	transpose (HypreMatrix &dst) const override
	Matrix transposition. More...

virtual real64	clearRow (globalIndex const row, bool const keepDiag=false, real64 const diagValue=0.0) override
	Clear a row, and optionally set diagonal element to `diagValue`. More...

virtual void	addEntries (HypreMatrix const &src, real64 const scale=1.0, bool const samePattern=true) override
	Add entries of another matrix to this. More...

virtual void	addDiagonal (HypreVector const &src) override
	Add entries of a vector to the diagonal of this matrix. More...

virtual localIndex	maxRowLength () const override
	Returns the number of nonzero entries in the longest row of the matrix. More...

virtual localIndex	localRowLength (localIndex localRowIndex) const override
	Get row length via local row index. More...

virtual localIndex	globalRowLength (globalIndex globalRowIndex) const override
	Get row length via global row index. More...

virtual void	getRowCopy (globalIndex globalRow, arraySlice1d< globalIndex > const &colIndices, arraySlice1d< real64 > const &values) const override
	Returns a copy of the data in row `globalRow`. More...

virtual real64	getDiagValue (globalIndex globalRow) const override
	get diagonal element value on a given row More...

virtual void	extractDiagonal (HypreVector &dst) const override
	Extract diagonal values into a vector. More...

virtual globalIndex	numGlobalRows () const override
	Returns the number of global rows. More...

virtual globalIndex	numGlobalCols () const override
	Returns the number of global columns. More...

virtual localIndex	numLocalRows () const override
	Return the local number of columns on each processor. More...

virtual localIndex	numLocalCols () const override
	Return the local number of columns on each processor. More...

virtual globalIndex	ilower () const override
	Returns the index of the first global row owned by that processor. More...

virtual globalIndex	iupper () const override
	Returns index one past the last global row owned by that processor. More...

virtual globalIndex	jlower () const override
	Returns the index of the first global col owned by that processor. More...

virtual globalIndex	jupper () const override
	Returns index one past the last global col owned by that processor. More...

virtual localIndex	numLocalNonzeros () const override
	Returns the number of nonzeros in the local portion of the matrix. More...

virtual globalIndex	numGlobalNonzeros () const override
	Returns the total number of nonzeros in the matrix. More...

virtual real64	normInf () const override
	Returns the infinity norm of the matrix. More...

virtual real64	norm1 () const override
	Returns the one norm of the matrix. More...

virtual real64	normFrobenius () const override
	Returns the Frobenius norm of the matrix. More...

virtual localIndex	getLocalRowID (globalIndex const index) const override
	Map a global row index to local row index. More...

virtual globalIndex	getGlobalRowID (localIndex const index) const override
	Map a local row index to global row index. More...

virtual MPI_Comm	getComm () const override
	Get the MPI communicator the matrix was created with. More...

virtual void	print (std::ostream &os=std::cout) const override
	Print the matrix in Trilinos format to a stream. More...

virtual void	write (string const &filename, LAIOutputFormat const format=LAIOutputFormat::MATRIX_MARKET) const override
	Write the matrix to filename in a matlab-compatible format. More...

Public Member Functions inherited from geosx::LinearOperator< HypreVector >
	LinearOperator ()=default
	Constructor.

virtual	~LinearOperator ()=default
	Destructor.

Detailed Description

Wrapper class for hypre's ParCSRMatrix.

This class creates and provides basic support for the HYPRE_ParCSRMatrix object type used in Hypre using the linear-algebraic system interface (IJ interface).

Definition at line 58 of file HypreMatrix.hpp.

Constructor & Destructor Documentation

◆ HypreMatrix() [1/2]

geosx::HypreMatrix::HypreMatrix ( )

Empty matrix constructor.

Create an empty (distributed) matrix.

◆ HypreMatrix() [2/2]

geosx::HypreMatrix::HypreMatrix ( HypreMatrix const & src )

Copy constructor.

Parameters

[in] src the matrix to be copied

Member Function Documentation

◆ add() [1/6]

virtual void geosx::HypreMatrix::add	(	globalIndex const	rowIndex,
		globalIndex const	colIndex,
		real64 const	value
	)

overridevirtual

Add to one element.

Parameters

rowIndex	Global row index
colIndex	Global column index
value	Value to add to prescribed location

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ add() [2/6]

virtual void geosx::HypreMatrix::add	(	globalIndex const	rowIndex,
		globalIndex const *	colIndices,
		real64 const *	values,
		localIndex const	size
	)

overridevirtual

Add elements to one row using c-style arrays.

Parameters

rowIndex	Global row index
colIndices	Global column indices
values	Values to add to prescribed locations
size	Number of elements

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ add() [3/6]

virtual void geosx::HypreMatrix::add	(	globalIndex const	rowIndex,
		arraySlice1d< globalIndex const > const &	colIndices,
		arraySlice1d< real64 const > const &	values
	)

overridevirtual

Add elements to one row using array1d.

Parameters

rowIndex	Global row index
colIndices	Global column indices
values	Values to add to prescribed locations

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ add() [4/6]

virtual void geosx::HypreMatrix::add	(	arraySlice1d< globalIndex const > const &	rowIndices,
		arraySlice1d< globalIndex const > const &	colIndices,
		arraySlice2d< real64 const, MatrixLayout::ROW_MAJOR > const &	values
	)

overridevirtual

Add a dense block of values.

Parameters

rowIndices	Global row indices
colIndices	Global col indices
values	Dense local matrix of values

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ add() [5/6]

virtual void geosx::HypreMatrix::add	(	arraySlice1d< globalIndex const > const &	rowIndices,
		arraySlice1d< globalIndex const > const &	colIndices,
		arraySlice2d< real64 const, MatrixLayout::COL_MAJOR > const &	values
	)

overridevirtual

Add a dense block of values.

Parameters

rowIndices	Global row indices
colIndices	Global col indices
values	Dense local matrix of values

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ add() [6/6]

virtual void geosx::HypreMatrix::add	(	globalIndex const *	rowIndices,
		globalIndex const *	colIndices,
		real64 const *	values,
		localIndex const	numRows,
		localIndex const	numCols
	)

overridevirtual

Add a dense block of values.

Parameters

rowIndices	Global row indices
colIndices	Global col indices
values	Dense local matrix of values
numRows	Number of row indices
numCols	Number of column indices

Note: Row major layout assumed in values

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ addDiagonal()

virtual void geosx::HypreMatrix::addDiagonal ( HypreVector const & src )

overridevirtual

Add entries of a vector to the diagonal of this matrix.

Parameters

src	the source vector

Note: this must be square and have a (possibly zero) diagonal entry in every row. this and src must have the same parallel row distribution.

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ addEntries()

virtual void geosx::HypreMatrix::addEntries	(	HypreMatrix const &	src,
		real64 const	scale = `1.0`,
		bool const	samePattern = `true`
	)

overridevirtual

Add entries of another matrix to this.

Parameters

src	the source matrix
scale	factor to scale entries of `src` by
samePattern	whether to keep the original pattern or to extend it

Note: Sparsity pattern of this must be a superset of sparsity of src. this and src must have the same parallel row distribution.

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ apply()

virtual void geosx::HypreMatrix::apply	(	HypreVector const &	src,
		HypreVector &	dst
	)		const

overridevirtual

Apply operator to a vector.

Parameters

src	Input vector (x).
dst	Output vector (b).

Warning: src and dst cannot alias the same vector (some implementations may allow this).

Implements geosx::LinearOperator< HypreVector >.

◆ applyTranspose()

virtual void geosx::HypreMatrix::applyTranspose	(	Vector const &	src,
		Vector &	dst
	)		const

overridevirtual

Apply transpose of the matrix to a vector.

Parameters

src	Input vector (x).
dst	Output vector (b).

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ clearRow()

virtual real64 geosx::HypreMatrix::clearRow	(	globalIndex const	row,
		bool const	keepDiag = `false`,
		real64 const	diagValue = `0.0`
	)

overridevirtual

Clear a row, and optionally set diagonal element to diagValue.

Parameters

row	globalIndex of the row to be cleared.
diagValue	(Optional) set diagonal element to desired value.
keepDiag	if `true`, `diagValue` is ignored and original diagonal is preserved

Returns: original diagonal value if matrix is square; zero otherwise

Note: diagValue and keepDiag are ignored if the matrix is not square

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ close()

virtual void geosx::HypreMatrix::close ( )

overridevirtual

Assemble and compress the matrix.

Compresses the matrix to CSR format with contiguous memory on each processor. Prevents from adding new entries in the sparsity pattern but allows for modification of existing entries.

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ created()

virtual bool geosx::HypreMatrix::created ( ) const

overridevirtual

Query matrix creation status.

Returns: true if matrix has been created

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ createWithGlobalSize()

virtual void geosx::HypreMatrix::createWithGlobalSize	(	globalIndex const	globalRows,
		globalIndex const	globalCols,
		localIndex const	maxEntriesPerRow,
		MPI_Comm const &	comm
	)

overridevirtual

Create a rectangular matrix from number of rows/columns.

Parameters

comm	MPI communicator.
globalRows	Global number of rows.
globalCols	Global number of columns.
maxEntriesPerRow	Maximum number of entries per row (hint).

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ createWithLocalSize()

virtual void geosx::HypreMatrix::createWithLocalSize	(	localIndex const	localRows,
		localIndex const	localCols,
		localIndex const	maxEntriesPerRow,
		MPI_Comm const &	comm
	)

overridevirtual

Create a rectangular matrix from number of rows/columns.

Parameters

comm	MPI communicator.
localRows	Local number of rows.
localCols	Local number of columns.
maxEntriesPerRow	Maximum number of entries per row (hint).

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ extractDiagonal()

virtual void geosx::HypreMatrix::extractDiagonal ( HypreVector & dst ) const

overridevirtual

Extract diagonal values into a vector.

Parameters

dst	the target vector, must have the same row partitioning as `this`

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ gemv()

virtual void geosx::HypreMatrix::gemv	(	real64 const	alpha,
		HypreVector const &	x,
		real64 const	beta,
		HypreVector &	y,
		bool	useTranspose = `false`
	)		const

overridevirtual

Compute gemv y = alpha*A*x + beta*y.

Note: The naming convention follows the BLAS library.

Parameters

alpha	Scalar factor for added matvec product.
x	Input vector.
beta	Scalar factor for right hand side.
y	Output vector.
useTranspose	Boolean, set to true to use `A^T`.

Warning: x and y cannot alias the same vector.

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ getComm()

virtual MPI_Comm geosx::HypreMatrix::getComm ( ) const

overridevirtual

Get the MPI communicator the matrix was created with.

Returns: MPI communicator passed in create...()

Note: when build without MPI, may return anything (MPI_Comm will be a mock type defined in MpiWrapper)

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ getDiagValue()

virtual real64 geosx::HypreMatrix::getDiagValue ( globalIndex globalRow ) const

overridevirtual

get diagonal element value on a given row

Parameters

globalRow global row index

Returns: value of diagonal element on the row

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ getGlobalRowID()

virtual globalIndex geosx::HypreMatrix::getGlobalRowID ( localIndex const index ) const

overridevirtual

Map a local row index to global row index.

Parameters

index the local row index (between 0 and number of local rows)

Returns: the global row index corresponding to index

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ getLocalRowID()

virtual localIndex geosx::HypreMatrix::getLocalRowID ( globalIndex const index ) const

overridevirtual

Map a global row index to local row index.

Parameters

index the global row index

Returns: the local row index corresponding to index, or -1 if not a local row

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ getRowCopy()

virtual void geosx::HypreMatrix::getRowCopy	(	globalIndex	globalRow,
		arraySlice1d< globalIndex > const &	colIndices,
		arraySlice1d< real64 > const &	values
	)		const

overridevirtual

Returns a copy of the data in row globalRow.

Parameters

[in]	globalRow	the index of global row to extract
[out]	colIndices	the output array of global column indices (must have a large enough size)
[out]	values	the output array of values (must have a large enough size)

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ globalRowLength()

virtual localIndex geosx::HypreMatrix::globalRowLength ( globalIndex globalRowIndex ) const

overridevirtual

Get row length via global row index.

Parameters

[in] globalRowIndex the global row index

Returns: the number of nonzero entries in the row

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ ilower()

virtual globalIndex geosx::HypreMatrix::ilower ( ) const

overridevirtual

Returns the index of the first global row owned by that processor.

Returns: the index of the first global row owned by that processor

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ insert() [1/6]

virtual void geosx::HypreMatrix::insert	(	globalIndex const	rowIndex,
		globalIndex const	colIndex,
		real64 const	value
	)

overridevirtual

Insert one element.

Parameters

rowIndex	Global row index
colIndex	Global column index
value	Value to insert at prescribed location

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ insert() [2/6]

virtual void geosx::HypreMatrix::insert	(	globalIndex const	rowIndex,
		globalIndex const *	colIndices,
		real64 const *	values,
		localIndex const	size
	)

overridevirtual

Insert elements to one row using c-style arrays.

Parameters

rowIndex	Global row index
colIndices	Global column indices
values	Values to add to prescribed locations
size	Number of elements

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ insert() [3/6]

virtual void geosx::HypreMatrix::insert	(	globalIndex const	rowIndex,
		arraySlice1d< globalIndex const > const &	colIndices,
		arraySlice1d< real64 const > const &	values
	)

overridevirtual

Insert elements of one row using array1d.

Parameters

rowIndex	Global row index
colIndices	Global column indices
values	Values to add to prescribed locations

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ insert() [4/6]

virtual void geosx::HypreMatrix::insert	(	arraySlice1d< globalIndex const > const &	rowIndices,
		arraySlice1d< globalIndex const > const &	colIndices,
		arraySlice2d< real64 const, MatrixLayout::ROW_MAJOR > const &	values
	)

overridevirtual

Insert a dense block of values.

Parameters

rowIndices	Global row indices
colIndices	Global col indices
values	Dense local matrix of values

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ insert() [5/6]

virtual void geosx::HypreMatrix::insert	(	arraySlice1d< globalIndex const > const &	rowIndices,
		arraySlice1d< globalIndex const > const &	colIndices,
		arraySlice2d< real64 const, MatrixLayout::COL_MAJOR > const &	values
	)

overridevirtual

Insert a dense block of values.

Parameters

rowIndices	Global row indices
colIndices	Global col indices
values	Dense local matrix of values

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ insert() [6/6]

virtual void geosx::HypreMatrix::insert	(	globalIndex const *	rowIndices,
		globalIndex const *	colIndices,
		real64 const *	values,
		localIndex const	numRows,
		localIndex const	numCols
	)

overridevirtual

Insert dense matrix.

Parameters

rowIndices	Global row indices
colIndices	Global col indices
values	Dense local matrix of values
numRows	Number of row indices
numCols	Number of column indices

Note: Row major layout assumed in values

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ iupper()

virtual globalIndex geosx::HypreMatrix::iupper ( ) const

overridevirtual

Returns index one past the last global row owned by that processor.

Returns: the next index after last global row owned by that processor

Note: The intention is for [ilower; iupper) to be used as a half-open index range

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ jlower()

virtual globalIndex geosx::HypreMatrix::jlower ( ) const

overridevirtual

Returns the index of the first global col owned by that processor.

Returns: index of the first owned global col

Note: Matrix implementations don't physically "own" column ranges the same way they do row ranges. Instead, the column range refers to the "diagonal" block of columns which would correspond to the local range of entries of a vector created with the same local/global size as the number of matrix columns.

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ jupper()

virtual globalIndex geosx::HypreMatrix::jupper ( ) const

overridevirtual

Returns index one past the last global col owned by that processor.

Returns: index one past the last owned global col

Note: The intention is for [jlower; jupper) to be used as a half-open index range.; Also see note for jlower() about the meaning of "owned" columns.

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ leftMultiplyTranspose()

virtual void geosx::HypreMatrix::leftMultiplyTranspose	(	HypreMatrix const &	src,
		HypreMatrix &	dst
	)		const

overridevirtual

Matrix/Matrix transpose multiplication.

Compute this^T * B = C.

Parameters

src	Input matrix (B).
dst	Output matrix (C).

Note that the output matrix C should have the same row-map as this. If close() has already been called on C, then C's sparsity pattern must already contain the nonzero entries produced by the product this*B.

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ leftRightScale()

virtual void geosx::HypreMatrix::leftRightScale	(	HypreVector const &	vecLeft,
		HypreVector const &	vecRight
	)

overridevirtual

Post-multiplies (right) with diagonal matrix consisting of the values in vecRight and pre-multiplies (left) with diagonal matrix consisting of the values in vec.

Parameters

vecLeft	vec to pre-multiply with.
vecRight	vec to post-multiply with.

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ leftScale()

virtual void geosx::HypreMatrix::leftScale ( HypreVector const & vec )

overridevirtual

Pre-multiplies (left) with diagonal matrix consisting of the values in vec.

Parameters

vec	Vector to pre-multiply with.

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ localRowLength()

virtual localIndex geosx::HypreMatrix::localRowLength ( localIndex localRowIndex ) const

overridevirtual

Get row length via local row index.

Parameters

[in] localRowIndex the local row index

Returns: the number of nonzero entries in the row

TODO: Breaks the goal of hiding local row indexing from user. Revise use cases to use ilower() and iupper().

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ maxRowLength()

virtual localIndex geosx::HypreMatrix::maxRowLength ( ) const

overridevirtual

Returns the number of nonzero entries in the longest row of the matrix.

Returns: the max length of a row

Collective.

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ multiply()

virtual void geosx::HypreMatrix::multiply	(	HypreMatrix const &	src,
		HypreMatrix &	dst
	)		const

overridevirtual

Matrix/Matrix multiplication.

Compute this * B = C.

Parameters

src	Input matrix (B).
dst	Output matrix (C).

Note that the output matrix C should have the same row-map as this. If close() has already been called on C, then C's sparsity pattern must already contain the nonzero entries produced by the product this*B.

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ multiplyPtAP()

virtual void geosx::HypreMatrix::multiplyPtAP	(	HypreMatrix const &	P,
		HypreMatrix &	dst
	)		const

overridevirtual

Compute the triple product dst = P^T * this * P

Parameters

P	the "prolongation" matrix
dst	the resulting product matrix (will be re-created as needed)

Reimplemented from geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ multiplyRAP()

virtual void geosx::HypreMatrix::multiplyRAP	(	HypreMatrix const &	R,
		HypreMatrix const &	P,
		HypreMatrix &	dst
	)		const

overridevirtual

Compute the triple product dst = R * this * P

Parameters

R	the "restriction" matrix
P	the "prolongation" matrix
dst	the resulting product matrix (will be re-created as needed)

Reimplemented from geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ norm1()

virtual real64 geosx::HypreMatrix::norm1 ( ) const

overridevirtual

Returns the one norm of the matrix.

Returns: the value of 1-norm

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ normFrobenius()

virtual real64 geosx::HypreMatrix::normFrobenius ( ) const

overridevirtual

Returns the Frobenius norm of the matrix.

Returns: the value of Frobenius norm

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ normInf()

virtual real64 geosx::HypreMatrix::normInf ( ) const

overridevirtual

Returns the infinity norm of the matrix.

Returns: the value of infinity norm

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ numGlobalCols()

virtual globalIndex geosx::HypreMatrix::numGlobalCols ( ) const

overridevirtual

Returns the number of global columns.

Returns: number of global columns

Implements geosx::LinearOperator< HypreVector >.

◆ numGlobalNonzeros()

virtual globalIndex geosx::HypreMatrix::numGlobalNonzeros ( ) const

overridevirtual

Returns the total number of nonzeros in the matrix.

Returns: the total number of nonzeros in the matrix

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ numGlobalRows()

virtual globalIndex geosx::HypreMatrix::numGlobalRows ( ) const

overridevirtual

Returns the number of global rows.

Returns: number of global rows

Implements geosx::LinearOperator< HypreVector >.

◆ numLocalCols()

virtual localIndex geosx::HypreMatrix::numLocalCols ( ) const

overridevirtual

Return the local number of columns on each processor.

Returns: number of local rows

Note: Matrix implementations don't physically "own" columns ranges as they do rows. Instead, the local column range refers to the "diagonal" block of columns which would correspond to the local range of entries of a source vector created with the same local/global size as the number of matrix columns.

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ numLocalNonzeros()

virtual localIndex geosx::HypreMatrix::numLocalNonzeros ( ) const

overridevirtual

Returns the number of nonzeros in the local portion of the matrix.

Returns: the number of nonzeros in the local portion of the matrix

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ numLocalRows()

virtual localIndex geosx::HypreMatrix::numLocalRows ( ) const

overridevirtual

Return the local number of columns on each processor.

Returns: number of local columns

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ open()

virtual void geosx::HypreMatrix::open ( )

overridevirtual

Open matrix for adding new entries.

Note: Adding entries that result in modifications of sparsity pattern may not be allowed by most implementations. An error will be raised in that case.

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ print()

virtual void geosx::HypreMatrix::print ( std::ostream & os = std::cout ) const

overridevirtual

Print the matrix in Trilinos format to a stream.

Parameters

os	the output stream

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ rightMultiplyTranspose()

virtual void geosx::HypreMatrix::rightMultiplyTranspose	(	HypreMatrix const &	src,
		HypreMatrix &	dst
	)		const

overridevirtual

Matrix/Matrix transpose multiplication.

Compute B * this^T = C.

Parameters

src	Input matrix (B).
dst	Output matrix (C).

Note that the output matrix C should have the same row-map as this. If close() has already been called on C, then C's sparsity pattern must already contain the nonzero entries produced by the product this*B.

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ rightScale()

virtual void geosx::HypreMatrix::rightScale ( HypreVector const & vec )

overridevirtual

Post-multiplies (right) with diagonal matrix consisting of the values in vec.

Parameters

vec	Vector to post-multiply with.

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ scale()

virtual void geosx::HypreMatrix::scale ( real64 const scalingFactor )

overridevirtual

Multiply all elements by scalingFactor.

Parameters

scalingFactor Scaling factor.

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ set() [1/7]

virtual void geosx::HypreMatrix::set ( real64 const value )

overridevirtual

Set all non-zero elements to a value.

Parameters

value the value to set all elements to

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ set() [2/7]

virtual void geosx::HypreMatrix::set	(	globalIndex const	rowIndex,
		globalIndex const	colIndex,
		real64 const	value
	)

overridevirtual

Set one element.

Parameters

rowIndex	Global row index
colIndex	Global column index
value	Value to set at prescribed location

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ set() [3/7]

virtual void geosx::HypreMatrix::set	(	globalIndex const	rowIndex,
		globalIndex const *	colIndices,
		real64 const *	values,
		localIndex const	size
	)

overridevirtual

Set elements to one row using c-style arrays.

Parameters

rowIndex	Global row index
colIndices	Global column indices
values	Values to add to prescribed locations
size	Number of elements

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ set() [4/7]

virtual void geosx::HypreMatrix::set	(	globalIndex const	rowIndex,
		arraySlice1d< globalIndex const > const &	colIndices,
		arraySlice1d< real64 const > const &	values
	)

overridevirtual

Set elements of one row using array1d.

Parameters

rowIndex	Global row index
colIndices	Global column indices
values	Values to add to prescribed locations

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ set() [5/7]

virtual void geosx::HypreMatrix::set	(	arraySlice1d< globalIndex const > const &	rowIndices,
		arraySlice1d< globalIndex const > const &	colIndices,
		arraySlice2d< real64 const, MatrixLayout::ROW_MAJOR > const &	values
	)

overridevirtual

Set a dense block of values.

Parameters

rowIndices	Global row indices
colIndices	Global col indices
values	Dense local matrix of values

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ set() [6/7]

virtual void geosx::HypreMatrix::set	(	arraySlice1d< globalIndex const > const &	rowIndices,
		arraySlice1d< globalIndex const > const &	colIndices,
		arraySlice2d< real64 const, MatrixLayout::COL_MAJOR > const &	values
	)

overridevirtual

Set a dense block of values.

Parameters

rowIndices	Global row indices
colIndices	Global col indices
values	Dense local matrix of values

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ set() [7/7]

virtual void geosx::HypreMatrix::set	(	globalIndex const *	rowIndices,
		globalIndex const *	colIndices,
		real64 const *	values,
		localIndex const	numRows,
		localIndex const	numCols
	)

overridevirtual

Set a dense block of values.

Parameters

rowIndices	Global row indices
colIndices	Global col indices
values	Dense local matrix of values
numRows	Number of row indices
numCols	Number of column indices

Note: Row major layout assumed in values

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ transpose()

virtual void geosx::HypreMatrix::transpose ( HypreMatrix & dst ) const

overridevirtual

Matrix transposition.

Compute B = this^T.

Parameters

dst	Output matrix (B).

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

◆ unwrapped()

HYPRE_ParCSRMatrix const& geosx::HypreMatrix::unwrapped ( ) const

Returns a pointer to implementation.

Returns: the underlying HYPRE_ParCSRMatrix object.

◆ unwrappedIJ()

HYPRE_IJMatrix const& geosx::HypreMatrix::unwrappedIJ ( ) const

Returns a pointer to implementation.

Returns: the underlying HYPRE_IJMatrix object.

◆ write()

virtual void geosx::HypreMatrix::write	(	string const &	filename,
		LAIOutputFormat const	format = `LAIOutputFormat::MATRIX_MARKET`
	)		const

overridevirtual

Write the matrix to filename in a matlab-compatible format.

Parameters

filename	name of the output file
format	output format

Within octave / matlab:

load filename M = spconvert(filename_root)

Implements geosx::MatrixBase< HypreMatrix, HypreVector >.

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

coreComponents/linearAlgebra/interfaces/hypre/HypreMatrix.hpp

Public Types

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ HypreMatrix() [1/2]

◆ HypreMatrix() [2/2]

Member Function Documentation

◆ add() [1/6]

◆ add() [2/6]

◆ add() [3/6]

◆ add() [4/6]

◆ add() [5/6]

◆ add() [6/6]

◆ addDiagonal()

◆ addEntries()

◆ apply()

◆ applyTranspose()

◆ clearRow()

◆ close()

◆ created()

◆ createWithGlobalSize()

◆ createWithLocalSize()

◆ extractDiagonal()

◆ gemv()

◆ getComm()

◆ getDiagValue()

◆ getGlobalRowID()

◆ getLocalRowID()

◆ getRowCopy()

◆ globalRowLength()

◆ ilower()

◆ insert() [1/6]

◆ insert() [2/6]

◆ insert() [3/6]

◆ insert() [4/6]

◆ insert() [5/6]

◆ insert() [6/6]

◆ iupper()

◆ jlower()

◆ jupper()

◆ leftMultiplyTranspose()

◆ leftRightScale()

◆ leftScale()

◆ localRowLength()

◆ maxRowLength()

◆ multiply()

◆ multiplyPtAP()

◆ multiplyRAP()

◆ norm1()

◆ normFrobenius()

◆ normInf()

◆ numGlobalCols()

◆ numGlobalNonzeros()

◆ numGlobalRows()

◆ numLocalCols()

◆ numLocalNonzeros()

◆ numLocalRows()

◆ open()

◆ print()

◆ rightMultiplyTranspose()

◆ rightScale()

◆ scale()

◆ set() [1/7]

◆ set() [2/7]

◆ set() [3/7]

◆ set() [4/7]

◆ set() [5/7]

◆ set() [6/7]

◆ set() [7/7]

◆ transpose()

◆ unwrapped()

◆ unwrappedIJ()

◆ write()