#include <Xpetra_TpetraRowMatrix.hpp>

Inheritance diagram for Xpetra::TpetraRowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >:

Destructor Method
virtual	~TpetraRowMatrix ()
	Destructor. More...

Matrix Query Methods
const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > >	getRowMap () const
	Returns the Map that describes the row distribution in this matrix. More...

const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > >	getColMap () const
	Returns the Map that describes the column distribution in this matrix. More...

Tpetra::global_size_t	getGlobalNumRows () const
	Returns the number of global rows in this matrix. More...

Tpetra::global_size_t	getGlobalNumCols () const
	Returns the number of global columns in this matrix. More...

size_t	getNodeNumRows () const
	Returns the number of rows owned on the calling node. More...

size_t	getNodeNumCols () const
	Returns the number of columns needed to apply the forward operator on this node, i.e., the number of elements listed in the column map. More...

Tpetra::global_size_t	getGlobalNumEntries () const
	Returns the global number of entries in this matrix. More...

size_t	getNodeNumEntries () const
	Returns the local number of entries in this matrix. More...

size_t	getNumEntriesInLocalRow (LocalOrdinal localRow) const
	Returns the current number of entries on this node in the specified local row. More...

size_t	getGlobalMaxNumRowEntries () const
	Returns the maximum number of entries across all rows/columns on all nodes. More...

size_t	getNodeMaxNumRowEntries () const
	Returns the maximum number of entries across all rows/columns on this node. More...

bool	isLocallyIndexed () const
	If matrix indices are in the local range, this function returns true. Otherwise, this function returns false. *‍/. More...

bool	isGloballyIndexed () const
	If matrix indices are in the global range, this function returns true. Otherwise, this function returns false. *‍/. More...

bool	isFillComplete () const
	Returns true if fillComplete() has been called. More...

bool	supportsRowViews () const
	Returns true if getLocalRowView() and getGlobalRowView() are valid for this class. More...

Extraction Methods
void	getLocalRowCopy (LocalOrdinal LocalRow, const Teuchos::ArrayView< LocalOrdinal > &Indices, const Teuchos::ArrayView< Scalar > &Values, size_t &NumEntries) const
	Extract a list of entries in a specified local row of the graph. Put into storage allocated by calling routine. More...

void	getGlobalRowView (GlobalOrdinal GlobalRow, ArrayView< const GlobalOrdinal > &indices, ArrayView< const Scalar > &values) const
	Extract a const, non-persisting view of global indices in a specified row of the matrix. More...

void	getLocalRowView (LocalOrdinal LocalRow, ArrayView< const LocalOrdinal > &indices, ArrayView< const Scalar > &values) const
	Extract a const, non-persisting view of local indices in a specified row of the matrix. More...

void	getLocalDiagCopy (Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &diag) const
	Get a copy of the diagonal entries owned by this node, with local row indices. More...

Mathematical Methods
ScalarTraits< Scalar >::magnitudeType	getFrobeniusNorm () const
	Returns the Frobenius norm of the matrix. More...

Pure virtual functions to be overridden by subclasses.
const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > >	getDomainMap () const
	Returns the Map associated with the domain of this operator, which must be compatible with X.getMap(). More...

const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > >	getRangeMap () const
	Returns the Map associated with the range of this operator, which must be compatible with Y.getMap(). More...

void	apply (const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &X, MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &Y, Teuchos::ETransp mode=Teuchos::NO_TRANS, Scalar alpha=Teuchos::ScalarTraits< Scalar >::one(), Scalar beta=Teuchos::ScalarTraits< Scalar >::zero()) const
	Computes the operator-multivector application. More...

Xpetra specific
RCP< Tpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > >	mtx_

	TpetraRowMatrix (const Teuchos::RCP< Tpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &mtx)
	TpetraCrsMatrix constructor to wrap a Tpetra::CrsMatrix object. More...

RCP< const Tpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > >	getTpetra_RowMatrix () const
	Get the underlying Tpetra matrix. More...

RCP< Tpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > >	getTpetra_RowMatrixNonConst () const
	Get the underlying Tpetra matrix. More...

Additional Inherited Members
Public Types inherited from Xpetra::RowMatrix< RowMatrix<>::scalar_type, typename RowMatrix< RowMatrix<>::scalar_type >::local_ordinal_type, typename RowMatrix< RowMatrix<>::scalar_type, typename RowMatrix< RowMatrix<>::scalar_type >::local_ordinal_type >::global_ordinal_type, typename RowMatrix< RowMatrix<>::scalar_type, typename RowMatrix< RowMatrix<>::scalar_type >::local_ordinal_type, typename RowMatrix< RowMatrix<>::scalar_type, typename RowMatrix< RowMatrix<>::scalar_type >::local_ordinal_type >::global_ordinal_type >::node_type >
typedef RowMatrix<>::scalar_type	scalar_type

typedef typename RowMatrix< RowMatrix<>::scalar_type >::local_ordinal_type	local_ordinal_type

typedef typename RowMatrix< RowMatrix<>::scalar_type, typename RowMatrix< RowMatrix<>::scalar_type >::local_ordinal_type >::global_ordinal_type	global_ordinal_type

typedef typename RowMatrix< RowMatrix<>::scalar_type, typename RowMatrix< RowMatrix<>::scalar_type >::local_ordinal_type, typename RowMatrix< RowMatrix<>::scalar_type, typename RowMatrix< RowMatrix<>::scalar_type >::local_ordinal_type >::global_ordinal_type >::node_type	node_type

Public Member Functions inherited from Xpetra::RowMatrix< RowMatrix<>::scalar_type, typename RowMatrix< RowMatrix<>::scalar_type >::local_ordinal_type, typename RowMatrix< RowMatrix<>::scalar_type, typename RowMatrix< RowMatrix<>::scalar_type >::local_ordinal_type >::global_ordinal_type, typename RowMatrix< RowMatrix<>::scalar_type, typename RowMatrix< RowMatrix<>::scalar_type >::local_ordinal_type, typename RowMatrix< RowMatrix<>::scalar_type, typename RowMatrix< RowMatrix<>::scalar_type >::local_ordinal_type >::global_ordinal_type >::node_type >
virtual	~RowMatrix ()
	Destructor. More...

virtual const Teuchos::RCP< const Map< typename RowMatrix< RowMatrix<>::scalar_type >::local_ordinal_type, typename RowMatrix< RowMatrix<>::scalar_type, typename RowMatrix< RowMatrix<>::scalar_type >::local_ordinal_type >::global_ordinal_type, typename RowMatrix< RowMatrix<>::scalar_type, typename RowMatrix< RowMatrix<>::scalar_type >::local_ordinal_type, typename RowMatrix< RowMatrix<>::scalar_type, typename RowMatrix< RowMatrix<>::scalar_type >::local_ordinal_type >::global_ordinal_type >::node_type > >	getRowMap () const=0
	Returns the Map that describes the row distribution in this matrix. More...

virtual const Teuchos::RCP< const Map< typename RowMatrix< RowMatrix<>::scalar_type >::local_ordinal_type, typename RowMatrix< RowMatrix<>::scalar_type, typename RowMatrix< RowMatrix<>::scalar_type >::local_ordinal_type >::global_ordinal_type, typename RowMatrix< RowMatrix<>::scalar_type, typename RowMatrix< RowMatrix<>::scalar_type >::local_ordinal_type, typename RowMatrix< RowMatrix<>::scalar_type, typename RowMatrix< RowMatrix<>::scalar_type >::local_ordinal_type >::global_ordinal_type >::node_type > >	getColMap () const=0
	Returns the Map that describes the column distribution in this matrix. More...

virtual global_size_t	getGlobalNumRows () const=0
	Returns the number of global rows in this matrix. More...

virtual global_size_t	getGlobalNumCols () const=0
	Returns the number of global columns in this matrix. More...

virtual size_t	getNodeNumRows () const=0
	Returns the number of rows owned on the calling node. More...

virtual size_t	getNodeNumCols () const=0
	Returns the number of columns needed to apply the forward operator on this node, i.e., the number of elements listed in the column map. More...

virtual global_size_t	getGlobalNumEntries () const=0
	Returns the global number of entries in this matrix. More...

virtual size_t	getNodeNumEntries () const=0
	Returns the local number of entries in this matrix. More...

virtual size_t	getNumEntriesInLocalRow (typename RowMatrix< RowMatrix<>::scalar_type >::local_ordinal_type localRow) const=0
	Returns the current number of entries on this node in the specified local row. More...

virtual size_t	getGlobalMaxNumRowEntries () const=0
	Returns the maximum number of entries across all rows/columns on all nodes. More...

virtual size_t	getNodeMaxNumRowEntries () const=0
	Returns the maximum number of entries across all rows/columns on this node. More...

virtual bool	isLocallyIndexed () const=0
	If matrix indices are in the local range, this function returns true. Otherwise, this function returns false. *‍/. More...

virtual bool	isGloballyIndexed () const=0
	If matrix indices are in the global range, this function returns true. Otherwise, this function returns false. *‍/. More...

virtual bool	isFillComplete () const=0
	Returns true if fillComplete() has been called. More...

virtual bool	supportsRowViews () const=0
	Returns true if getLocalRowView() and getGlobalRowView() are valid for this class. More...

virtual void	getLocalRowCopy (typename RowMatrix< RowMatrix<>::scalar_type >::local_ordinal_type LocalRow, const Teuchos::ArrayView< typename RowMatrix< RowMatrix<>::scalar_type >::local_ordinal_type > &Indices, const Teuchos::ArrayView< RowMatrix<>::scalar_type > &Values, size_t &NumEntries) const=0
	Extract a list of entries in a specified local row of the graph. Put into storage allocated by calling routine. More...

virtual void	getGlobalRowView (typename RowMatrix< RowMatrix<>::scalar_type, typename RowMatrix< RowMatrix<>::scalar_type >::local_ordinal_type >::global_ordinal_type GlobalRow, ArrayView< const typename RowMatrix< RowMatrix<>::scalar_type, typename RowMatrix< RowMatrix<>::scalar_type >::local_ordinal_type >::global_ordinal_type > &indices, ArrayView< const RowMatrix<>::scalar_type > &values) const=0
	Extract a const, non-persisting view of global indices in a specified row of the matrix. More...

virtual void	getLocalRowView (typename RowMatrix< RowMatrix<>::scalar_type >::local_ordinal_type LocalRow, ArrayView< const typename RowMatrix< RowMatrix<>::scalar_type >::local_ordinal_type > &indices, ArrayView< const RowMatrix<>::scalar_type > &values) const=0
	Extract a const, non-persisting view of local indices in a specified row of the matrix. More...

virtual void	getLocalDiagCopy (Vector< RowMatrix<>::scalar_type, typename RowMatrix< RowMatrix<>::scalar_type >::local_ordinal_type, typename RowMatrix< RowMatrix<>::scalar_type, typename RowMatrix< RowMatrix<>::scalar_type >::local_ordinal_type >::global_ordinal_type, typename RowMatrix< RowMatrix<>::scalar_type, typename RowMatrix< RowMatrix<>::scalar_type >::local_ordinal_type, typename RowMatrix< RowMatrix<>::scalar_type, typename RowMatrix< RowMatrix<>::scalar_type >::local_ordinal_type >::global_ordinal_type >::node_type > &diag) const=0
	Get a copy of the diagonal entries owned by this node, with local row indices. More...

virtual ScalarTraits< RowMatrix<>::scalar_type >::magnitudeType	getFrobeniusNorm () const=0
	Returns the Frobenius norm of the matrix. More...

virtual const Teuchos::RCP< const Map< typename RowMatrix< RowMatrix<>::scalar_type >::local_ordinal_type, typename RowMatrix< RowMatrix<>::scalar_type, typename RowMatrix< RowMatrix<>::scalar_type >::local_ordinal_type >::global_ordinal_type, typename RowMatrix< RowMatrix<>::scalar_type, typename RowMatrix< RowMatrix<>::scalar_type >::local_ordinal_type, typename RowMatrix< RowMatrix<>::scalar_type, typename RowMatrix< RowMatrix<>::scalar_type >::local_ordinal_type >::global_ordinal_type >::node_type > >	getDomainMap () const=0
	Returns the Map associated with the domain of this operator, which must be compatible with X.getMap(). More...

virtual const Teuchos::RCP< const Map< typename RowMatrix< RowMatrix<>::scalar_type >::local_ordinal_type, typename RowMatrix< RowMatrix<>::scalar_type, typename RowMatrix< RowMatrix<>::scalar_type >::local_ordinal_type >::global_ordinal_type, typename RowMatrix< RowMatrix<>::scalar_type, typename RowMatrix< RowMatrix<>::scalar_type >::local_ordinal_type, typename RowMatrix< RowMatrix<>::scalar_type, typename RowMatrix< RowMatrix<>::scalar_type >::local_ordinal_type >::global_ordinal_type >::node_type > >	getRangeMap () const=0
	Returns the Map associated with the range of this operator, which must be compatible with Y.getMap(). More...

virtual void	apply (const MultiVector< RowMatrix<>::scalar_type, typename RowMatrix< RowMatrix<>::scalar_type >::local_ordinal_type, typename RowMatrix< RowMatrix<>::scalar_type, typename RowMatrix< RowMatrix<>::scalar_type >::local_ordinal_type >::global_ordinal_type, typename RowMatrix< RowMatrix<>::scalar_type, typename RowMatrix< RowMatrix<>::scalar_type >::local_ordinal_type, typename RowMatrix< RowMatrix<>::scalar_type, typename RowMatrix< RowMatrix<>::scalar_type >::local_ordinal_type >::global_ordinal_type >::node_type > &X, MultiVector< RowMatrix<>::scalar_type, typename RowMatrix< RowMatrix<>::scalar_type >::local_ordinal_type, typename RowMatrix< RowMatrix<>::scalar_type, typename RowMatrix< RowMatrix<>::scalar_type >::local_ordinal_type >::global_ordinal_type, typename RowMatrix< RowMatrix<>::scalar_type, typename RowMatrix< RowMatrix<>::scalar_type >::local_ordinal_type, typename RowMatrix< RowMatrix<>::scalar_type, typename RowMatrix< RowMatrix<>::scalar_type >::local_ordinal_type >::global_ordinal_type >::node_type > &Y, Teuchos::ETransp mode=Teuchos::NO_TRANS, RowMatrix<>::scalar_type alpha=Teuchos::ScalarTraits< RowMatrix<>::scalar_type >::one(), RowMatrix<>::scalar_type beta=Teuchos::ScalarTraits< RowMatrix<>::scalar_type >::zero()) const=0
	Computes the operator-multivector application. More...

Detailed Description

template<class Scalar = RowMatrix<>::scalar_type, class LocalOrdinal = typename RowMatrix<Scalar>::local_ordinal_type, class GlobalOrdinal = typename RowMatrix<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
class Xpetra::TpetraRowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Definition at line 73 of file Xpetra_TpetraRowMatrix.hpp.

Constructor & Destructor Documentation

◆ ~TpetraRowMatrix()

template<class Scalar = RowMatrix<>::scalar_type, class LocalOrdinal = typename RowMatrix<Scalar>::local_ordinal_type, class GlobalOrdinal = typename RowMatrix<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>

virtual Xpetra::TpetraRowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::~TpetraRowMatrix ( )

inlinevirtual

Destructor.

Definition at line 83 of file Xpetra_TpetraRowMatrix.hpp.

◆ TpetraRowMatrix()

template<class Scalar = RowMatrix<>::scalar_type, class LocalOrdinal = typename RowMatrix<Scalar>::local_ordinal_type, class GlobalOrdinal = typename RowMatrix<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>

Xpetra::TpetraRowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::TpetraRowMatrix ( const Teuchos::RCP< Tpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > & mtx )

inline

TpetraCrsMatrix constructor to wrap a Tpetra::CrsMatrix object.

Definition at line 182 of file Xpetra_TpetraRowMatrix.hpp.

Member Function Documentation

◆ getRowMap()

template<class Scalar = RowMatrix<>::scalar_type, class LocalOrdinal = typename RowMatrix<Scalar>::local_ordinal_type, class GlobalOrdinal = typename RowMatrix<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>

const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::TpetraRowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getRowMap ( ) const

inline

Returns the Map that describes the row distribution in this matrix.

Definition at line 91 of file Xpetra_TpetraRowMatrix.hpp.

◆ getColMap()

template<class Scalar = RowMatrix<>::scalar_type, class LocalOrdinal = typename RowMatrix<Scalar>::local_ordinal_type, class GlobalOrdinal = typename RowMatrix<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>

const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::TpetraRowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getColMap ( ) const

inline

Returns the Map that describes the column distribution in this matrix.

Definition at line 94 of file Xpetra_TpetraRowMatrix.hpp.

◆ getGlobalNumRows()

template<class Scalar = RowMatrix<>::scalar_type, class LocalOrdinal = typename RowMatrix<Scalar>::local_ordinal_type, class GlobalOrdinal = typename RowMatrix<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>

Tpetra::global_size_t Xpetra::TpetraRowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getGlobalNumRows ( ) const

inline

Returns the number of global rows in this matrix.

Definition at line 97 of file Xpetra_TpetraRowMatrix.hpp.

◆ getGlobalNumCols()

template<class Scalar = RowMatrix<>::scalar_type, class LocalOrdinal = typename RowMatrix<Scalar>::local_ordinal_type, class GlobalOrdinal = typename RowMatrix<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>

Tpetra::global_size_t Xpetra::TpetraRowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getGlobalNumCols ( ) const

inline

Returns the number of global columns in this matrix.

Definition at line 100 of file Xpetra_TpetraRowMatrix.hpp.

◆ getNodeNumRows()

template<class Scalar = RowMatrix<>::scalar_type, class LocalOrdinal = typename RowMatrix<Scalar>::local_ordinal_type, class GlobalOrdinal = typename RowMatrix<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>

size_t Xpetra::TpetraRowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getNodeNumRows ( ) const

inline

Returns the number of rows owned on the calling node.

Definition at line 103 of file Xpetra_TpetraRowMatrix.hpp.

◆ getNodeNumCols()

template<class Scalar = RowMatrix<>::scalar_type, class LocalOrdinal = typename RowMatrix<Scalar>::local_ordinal_type, class GlobalOrdinal = typename RowMatrix<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>

size_t Xpetra::TpetraRowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getNodeNumCols ( ) const

inline

Returns the number of columns needed to apply the forward operator on this node, i.e., the number of elements listed in the column map.

Definition at line 106 of file Xpetra_TpetraRowMatrix.hpp.

◆ getGlobalNumEntries()

template<class Scalar = RowMatrix<>::scalar_type, class LocalOrdinal = typename RowMatrix<Scalar>::local_ordinal_type, class GlobalOrdinal = typename RowMatrix<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>

Tpetra::global_size_t Xpetra::TpetraRowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getGlobalNumEntries ( ) const

inline

Returns the global number of entries in this matrix.

Definition at line 109 of file Xpetra_TpetraRowMatrix.hpp.

◆ getNodeNumEntries()

template<class Scalar = RowMatrix<>::scalar_type, class LocalOrdinal = typename RowMatrix<Scalar>::local_ordinal_type, class GlobalOrdinal = typename RowMatrix<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>

size_t Xpetra::TpetraRowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getNodeNumEntries ( ) const

inline

Returns the local number of entries in this matrix.

Definition at line 112 of file Xpetra_TpetraRowMatrix.hpp.

◆ getNumEntriesInLocalRow()

template<class Scalar = RowMatrix<>::scalar_type, class LocalOrdinal = typename RowMatrix<Scalar>::local_ordinal_type, class GlobalOrdinal = typename RowMatrix<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>

size_t Xpetra::TpetraRowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getNumEntriesInLocalRow ( LocalOrdinal localRow ) const

inline

Returns the current number of entries on this node in the specified local row.

Definition at line 115 of file Xpetra_TpetraRowMatrix.hpp.

◆ getGlobalMaxNumRowEntries()

template<class Scalar = RowMatrix<>::scalar_type, class LocalOrdinal = typename RowMatrix<Scalar>::local_ordinal_type, class GlobalOrdinal = typename RowMatrix<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>

size_t Xpetra::TpetraRowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getGlobalMaxNumRowEntries ( ) const

inline

Returns the maximum number of entries across all rows/columns on all nodes.

Definition at line 118 of file Xpetra_TpetraRowMatrix.hpp.

◆ getNodeMaxNumRowEntries()

template<class Scalar = RowMatrix<>::scalar_type, class LocalOrdinal = typename RowMatrix<Scalar>::local_ordinal_type, class GlobalOrdinal = typename RowMatrix<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>

size_t Xpetra::TpetraRowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getNodeMaxNumRowEntries ( ) const

inline

Returns the maximum number of entries across all rows/columns on this node.

Definition at line 121 of file Xpetra_TpetraRowMatrix.hpp.

◆ isLocallyIndexed()

template<class Scalar = RowMatrix<>::scalar_type, class LocalOrdinal = typename RowMatrix<Scalar>::local_ordinal_type, class GlobalOrdinal = typename RowMatrix<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>

bool Xpetra::TpetraRowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::isLocallyIndexed ( ) const

inline

If matrix indices are in the local range, this function returns true. Otherwise, this function returns false. *‍/.

Definition at line 124 of file Xpetra_TpetraRowMatrix.hpp.

◆ isGloballyIndexed()

template<class Scalar = RowMatrix<>::scalar_type, class LocalOrdinal = typename RowMatrix<Scalar>::local_ordinal_type, class GlobalOrdinal = typename RowMatrix<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>

bool Xpetra::TpetraRowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::isGloballyIndexed ( ) const

inline

If matrix indices are in the global range, this function returns true. Otherwise, this function returns false. *‍/.

Definition at line 127 of file Xpetra_TpetraRowMatrix.hpp.

◆ isFillComplete()

template<class Scalar = RowMatrix<>::scalar_type, class LocalOrdinal = typename RowMatrix<Scalar>::local_ordinal_type, class GlobalOrdinal = typename RowMatrix<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>

bool Xpetra::TpetraRowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::isFillComplete ( ) const

inline

Returns true if fillComplete() has been called.

Definition at line 130 of file Xpetra_TpetraRowMatrix.hpp.

◆ supportsRowViews()

template<class Scalar = RowMatrix<>::scalar_type, class LocalOrdinal = typename RowMatrix<Scalar>::local_ordinal_type, class GlobalOrdinal = typename RowMatrix<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>

bool Xpetra::TpetraRowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::supportsRowViews ( ) const

inline

Returns true if getLocalRowView() and getGlobalRowView() are valid for this class.

Definition at line 133 of file Xpetra_TpetraRowMatrix.hpp.

◆ getLocalRowCopy()

template<class Scalar = RowMatrix<>::scalar_type, class LocalOrdinal = typename RowMatrix<Scalar>::local_ordinal_type, class GlobalOrdinal = typename RowMatrix<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>

void Xpetra::TpetraRowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getLocalRowCopy	(	LocalOrdinal	LocalRow,
		const Teuchos::ArrayView< LocalOrdinal > &	Indices,
		const Teuchos::ArrayView< Scalar > &	Values,
		size_t &	NumEntries
	)		const

inline

Extract a list of entries in a specified local row of the graph. Put into storage allocated by calling routine.

Definition at line 141 of file Xpetra_TpetraRowMatrix.hpp.

◆ getGlobalRowView()

template<class Scalar = RowMatrix<>::scalar_type, class LocalOrdinal = typename RowMatrix<Scalar>::local_ordinal_type, class GlobalOrdinal = typename RowMatrix<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>

void Xpetra::TpetraRowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getGlobalRowView	(	GlobalOrdinal	GlobalRow,
		ArrayView< const GlobalOrdinal > &	indices,
		ArrayView< const Scalar > &	values
	)		const

inline

Extract a const, non-persisting view of global indices in a specified row of the matrix.

Definition at line 144 of file Xpetra_TpetraRowMatrix.hpp.

◆ getLocalRowView()

template<class Scalar = RowMatrix<>::scalar_type, class LocalOrdinal = typename RowMatrix<Scalar>::local_ordinal_type, class GlobalOrdinal = typename RowMatrix<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>

void Xpetra::TpetraRowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getLocalRowView	(	LocalOrdinal	LocalRow,
		ArrayView< const LocalOrdinal > &	indices,
		ArrayView< const Scalar > &	values
	)		const

inline

Extract a const, non-persisting view of local indices in a specified row of the matrix.

Definition at line 147 of file Xpetra_TpetraRowMatrix.hpp.

◆ getLocalDiagCopy()

template<class Scalar = RowMatrix<>::scalar_type, class LocalOrdinal = typename RowMatrix<Scalar>::local_ordinal_type, class GlobalOrdinal = typename RowMatrix<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>

void Xpetra::TpetraRowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getLocalDiagCopy ( Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > & diag ) const

inline

Get a copy of the diagonal entries owned by this node, with local row indices.

Definition at line 150 of file Xpetra_TpetraRowMatrix.hpp.

◆ getFrobeniusNorm()

template<class Scalar = RowMatrix<>::scalar_type, class LocalOrdinal = typename RowMatrix<Scalar>::local_ordinal_type, class GlobalOrdinal = typename RowMatrix<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>

ScalarTraits< Scalar >::magnitudeType Xpetra::TpetraRowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getFrobeniusNorm ( ) const

inline

Returns the Frobenius norm of the matrix.

Definition at line 159 of file Xpetra_TpetraRowMatrix.hpp.

◆ getDomainMap()

template<class Scalar = RowMatrix<>::scalar_type, class LocalOrdinal = typename RowMatrix<Scalar>::local_ordinal_type, class GlobalOrdinal = typename RowMatrix<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>

const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::TpetraRowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getDomainMap ( ) const

inline

Returns the Map associated with the domain of this operator, which must be compatible with X.getMap().

Definition at line 167 of file Xpetra_TpetraRowMatrix.hpp.

◆ getRangeMap()

template<class Scalar = RowMatrix<>::scalar_type, class LocalOrdinal = typename RowMatrix<Scalar>::local_ordinal_type, class GlobalOrdinal = typename RowMatrix<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>

const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::TpetraRowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getRangeMap ( ) const

inline

Returns the Map associated with the range of this operator, which must be compatible with Y.getMap().

Definition at line 170 of file Xpetra_TpetraRowMatrix.hpp.

◆ apply()

template<class Scalar = RowMatrix<>::scalar_type, class LocalOrdinal = typename RowMatrix<Scalar>::local_ordinal_type, class GlobalOrdinal = typename RowMatrix<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>

void Xpetra::TpetraRowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::apply	(	const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	X,
		MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	Y,
		Teuchos::ETransp	mode = `Teuchos::NO_TRANS`,
		Scalar	alpha = `Teuchos::ScalarTraits< Scalar >::one()`,
		Scalar	beta = `Teuchos::ScalarTraits< Scalar >::zero()`
	)		const

inline

Computes the operator-multivector application.

Definition at line 173 of file Xpetra_TpetraRowMatrix.hpp.

◆ getTpetra_RowMatrix()

template<class Scalar = RowMatrix<>::scalar_type, class LocalOrdinal = typename RowMatrix<Scalar>::local_ordinal_type, class GlobalOrdinal = typename RowMatrix<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>

RCP<const Tpetra::RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> > Xpetra::TpetraRowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getTpetra_RowMatrix ( ) const

inline

Get the underlying Tpetra matrix.

Definition at line 185 of file Xpetra_TpetraRowMatrix.hpp.

◆ getTpetra_RowMatrixNonConst()

template<class Scalar = RowMatrix<>::scalar_type, class LocalOrdinal = typename RowMatrix<Scalar>::local_ordinal_type, class GlobalOrdinal = typename RowMatrix<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>

RCP<Tpetra::RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> > Xpetra::TpetraRowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getTpetra_RowMatrixNonConst ( ) const

inline

Get the underlying Tpetra matrix.

Definition at line 188 of file Xpetra_TpetraRowMatrix.hpp.

Member Data Documentation

◆ mtx_

template<class Scalar = RowMatrix<>::scalar_type, class LocalOrdinal = typename RowMatrix<Scalar>::local_ordinal_type, class GlobalOrdinal = typename RowMatrix<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>

RCP< Tpetra::RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> > Xpetra::TpetraRowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::mtx_

private

Definition at line 194 of file Xpetra_TpetraRowMatrix.hpp.

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

Xpetra_TpetraRowMatrix.hpp

Destructor Method

Matrix Query Methods

Extraction Methods

Mathematical Methods

Pure virtual functions to be overridden by subclasses.

Xpetra specific

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~TpetraRowMatrix()

◆ TpetraRowMatrix()

Member Function Documentation

◆ getRowMap()

◆ getColMap()

◆ getGlobalNumRows()

◆ getGlobalNumCols()

◆ getNodeNumRows()

◆ getNodeNumCols()

◆ getGlobalNumEntries()

◆ getNodeNumEntries()

◆ getNumEntriesInLocalRow()

◆ getGlobalMaxNumRowEntries()

◆ getNodeMaxNumRowEntries()

◆ isLocallyIndexed()

◆ isGloballyIndexed()

◆ isFillComplete()

◆ supportsRowViews()

◆ getLocalRowCopy()

◆ getGlobalRowView()

◆ getLocalRowView()

◆ getLocalDiagCopy()

◆ getFrobeniusNorm()

◆ getDomainMap()

◆ getRangeMap()

◆ apply()

◆ getTpetra_RowMatrix()

◆ getTpetra_RowMatrixNonConst()

Member Data Documentation

◆ mtx_