geosx::NormalOperator< MATRIX, VECTOR > Class Template Reference

NormalOperator Simple class to apply the operator A^T * A to a vector. More...

#include <Arnoldi.hpp>

Inheritance diagram for geosx::NormalOperator< MATRIX, VECTOR >:

Public Member Functions
void	set (MATRIX const &matrix, MPI_Comm const comm)
	Sets the matrix. More...
globalIndex	numGlobalRows () const override
	Returns the global number of rows. More...
globalIndex	numGlobalCols () const override
	Returns the global number of columns. More...
localIndex	numLocalRows () const
	Returns the local number of rows. More...
MPI_Comm const &	getComm () const
	Returns the communicator. More...
void	apply (VECTOR const &x, VECTOR &y) const override
	Applies the matrix and its transpose to a vector. More...
Public Member Functions inherited from geosx::LinearOperator< VECTOR >
	LinearOperator ()=default
	Constructor.
virtual	~LinearOperator ()=default
	Destructor.
virtual void	residual (Vector const &x, Vector const &b, Vector &r) const
	Compute residual r = Ax - b. More...

Additional Inherited Members
Public Types inherited from geosx::LinearOperator< VECTOR >
using	Vector = VECTOR
	Alias for template parameter.

Detailed Description

template<typename MATRIX, typename VECTOR>
class geosx::NormalOperator< MATRIX, VECTOR >

NormalOperator Simple class to apply the operator A^T * A to a vector.

Definition at line 33 of file Arnoldi.hpp.

Member Function Documentation

apply()

template<typename MATRIX , typename VECTOR >

void geosx::NormalOperator< MATRIX, VECTOR >::apply ( VECTOR const &  x, VECTOR &  y  ) const

inlineoverridevirtual

Applies the matrix and its transpose to a vector.

Parameters

x	the input vector
y	the output vector

Implements geosx::LinearOperator< VECTOR >.

Definition at line 89 of file Arnoldi.hpp.

getComm()

template<typename MATRIX , typename VECTOR >

MPI_Comm const& geosx::NormalOperator< MATRIX, VECTOR >::getComm ( ) const

inline

Returns the communicator.

Returns

the communicator

Definition at line 79 of file Arnoldi.hpp.

numGlobalCols()

template<typename MATRIX , typename VECTOR >

globalIndex geosx::NormalOperator< MATRIX, VECTOR >::numGlobalCols ( ) const

inlineoverridevirtual

Returns the global number of columns.

Returns

the global number of columns

Implements geosx::LinearOperator< VECTOR >.

Definition at line 61 of file Arnoldi.hpp.

numGlobalRows()

template<typename MATRIX , typename VECTOR >

globalIndex geosx::NormalOperator< MATRIX, VECTOR >::numGlobalRows ( ) const

inlineoverridevirtual

Returns the global number of rows.

Returns

the global number of rows

Implements geosx::LinearOperator< VECTOR >.

Definition at line 52 of file Arnoldi.hpp.

numLocalRows()

template<typename MATRIX , typename VECTOR >

localIndex geosx::NormalOperator< MATRIX, VECTOR >::numLocalRows ( ) const

inline

Returns the local number of rows.

Returns

the local number of rows

Definition at line 70 of file Arnoldi.hpp.

set()

template<typename MATRIX , typename VECTOR >

void geosx::NormalOperator< MATRIX, VECTOR >::set ( MATRIX const &  matrix, MPI_Comm const  comm  )

inline

Sets the matrix.

Parameters

matrix	the matrix
comm	the MPI communicator

Definition at line 42 of file Arnoldi.hpp.

---

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

• coreComponents/linearAlgebra/interfaces/direct/Arnoldi.hpp