#include <Xpetra_RowMatrix.hpp>

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

Public Types
typedef Scalar	scalar_type
typedef LocalOrdinal	local_ordinal_type
typedef GlobalOrdinal	global_ordinal_type
typedef Node	node_type
typedef Scalar	scalar_type
	The type of the entries of the input and output multivectors.
typedef LocalOrdinal	local_ordinal_type
	The local index type.
typedef GlobalOrdinal	global_ordinal_type
	The global index type.
typedef Tpetra::KokkosClassic::DefaultNode::DefaultNodeType	node_type
	The Kokkos Node type.

Constructor/Destructor Methods
virtual	~RowMatrix ()
	Destructor.

Matrix Query Methods
virtual const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > >	getRowMap () const =0
	Returns the Map that describes the row distribution in this matrix.
virtual const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > >	getColMap () const =0
	Returns the Map that describes the column distribution in this matrix.
virtual global_size_t	getGlobalNumRows () const =0
	Returns the number of global rows in this matrix.
virtual global_size_t	getGlobalNumCols () const =0
	Returns the number of global columns in this matrix.
virtual size_t	getLocalNumRows () const =0
	Returns the number of rows owned on the calling node.
virtual size_t	getLocalNumCols () 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.
virtual global_size_t	getGlobalNumEntries () const =0
	Returns the global number of entries in this matrix.
virtual size_t	getLocalNumEntries () const =0
	Returns the local number of entries in this matrix.
virtual size_t	getNumEntriesInLocalRow (LocalOrdinal localRow) const =0
	Returns the current number of entries on this node in the specified local row.
virtual size_t	getGlobalMaxNumRowEntries () const =0
	Returns the maximum number of entries across all rows/columns on all nodes.
virtual size_t	getLocalMaxNumRowEntries () const =0
	Returns the maximum number of entries across all rows/columns on this node.
virtual bool	isLocallyIndexed () const =0
	If matrix indices are in the local range, this function returns true. Otherwise, this function returns false. *‍/.
virtual bool	isGloballyIndexed () const =0
	If matrix indices are in the global range, this function returns true. Otherwise, this function returns false. *‍/.
virtual bool	isFillComplete () const =0
	Returns true if fillComplete() has been called.
virtual bool	supportsRowViews () const =0
	Returns true if getLocalRowView() and getGlobalRowView() are valid for this class.

Extraction Methods
virtual void	getLocalRowCopy (LocalOrdinal LocalRow, const Teuchos::ArrayView< LocalOrdinal > &Indices, const Teuchos::ArrayView< Scalar > &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.
virtual void	getGlobalRowView (GlobalOrdinal GlobalRow, ArrayView< const GlobalOrdinal > &indices, ArrayView< const Scalar > &values) const =0
	Extract a const, non-persisting view of global indices in a specified row of the matrix.
virtual void	getLocalRowView (LocalOrdinal LocalRow, ArrayView< const LocalOrdinal > &indices, ArrayView< const Scalar > &values) const =0
	Extract a const, non-persisting view of local indices in a specified row of the matrix.
virtual void	getLocalDiagCopy (Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &diag) const =0
	Get a copy of the diagonal entries owned by this node, with local row indices.

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

Pure virtual functions to be overridden by subclasses.
virtual const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > >	getDomainMap () const =0
	Returns the Map associated with the domain of this operator, which must be compatible with X.getMap().
virtual const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > >	getRangeMap () const =0
	Returns the Map associated with the range of this operator, which must be compatible with Y.getMap().
virtual 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 =0
	Computes the operator-multivector application.

Additional Inherited Members
Public Member Functions inherited from Xpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Tpetra::KokkosClassic::DefaultNode::DefaultNodeType >
virtual	~Operator ()
virtual void	apply (const mv_type &X, mv_type &Y, Teuchos::ETransp mode=Teuchos::NO_TRANS, Scalar alpha=Teuchos::ScalarTraits< Scalar >::one(), Scalar beta=Teuchos::ScalarTraits< Scalar >::zero()) const=0
	Computes the operator-multivector application.
virtual bool	hasTransposeApply () const
	Whether this operator supports applying the transpose or conjugate transpose.
virtual void	removeEmptyProcessesInPlace (const RCP< const map_type > &)
virtual void	residual (const mv_type &X, const mv_type &B, mv_type &R) const=0
	Compute a residual R = B - (this) X.
Public Member Functions inherited from Teuchos::Describable
virtual std::string	description () const
virtual void	describe (FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
void	describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
virtual	~Describable ()
DescribableStreamManipulatorState	describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)
std::ostream &	operator<< (std::ostream &os, const DescribableStreamManipulatorState &d)
virtual std::string	description () const
virtual void	describe (FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
void	describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
virtual	~Describable ()
Public Member Functions inherited from Teuchos::LabeledObject
	LabeledObject ()
virtual	~LabeledObject ()
virtual void	setObjectLabel (const std::string &objectLabel)
virtual std::string	getObjectLabel () const
Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel	verbLevel_default

Detailed Description

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
class Xpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Definition at line 30 of file Xpetra_RowMatrix.hpp.

Member Typedef Documentation

◆ scalar_type

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>

typedef Scalar Xpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::scalar_type

Definition at line 32 of file Xpetra_RowMatrix.hpp.

◆ local_ordinal_type

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>

typedef LocalOrdinal Xpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::local_ordinal_type

Definition at line 33 of file Xpetra_RowMatrix.hpp.

◆ global_ordinal_type

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>

typedef GlobalOrdinal Xpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::global_ordinal_type

Definition at line 34 of file Xpetra_RowMatrix.hpp.

◆ node_type

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>

typedef Node Xpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::node_type

Definition at line 35 of file Xpetra_RowMatrix.hpp.

Constructor & Destructor Documentation

◆ ~RowMatrix()

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>

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

inlinevirtual

Destructor.

Definition at line 41 of file Xpetra_RowMatrix.hpp.

Member Function Documentation

◆ getRowMap()

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>

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

pure virtual

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

◆ getColMap()

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>

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

pure virtual

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

◆ getGlobalNumRows()

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>

virtual global_size_t Xpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getGlobalNumRows ( ) const

pure virtual

Returns the number of global rows in this matrix.

◆ getGlobalNumCols()

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>

virtual global_size_t Xpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getGlobalNumCols ( ) const

pure virtual

Returns the number of global columns in this matrix.

◆ getLocalNumRows()

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>

virtual size_t Xpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getLocalNumRows ( ) const

pure virtual

Returns the number of rows owned on the calling node.

◆ getLocalNumCols()

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>

virtual size_t Xpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getLocalNumCols ( ) const

pure virtual

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.

◆ getGlobalNumEntries()

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>

virtual global_size_t Xpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getGlobalNumEntries ( ) const

pure virtual

Returns the global number of entries in this matrix.

◆ getLocalNumEntries()

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>

virtual size_t Xpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getLocalNumEntries ( ) const

pure virtual

Returns the local number of entries in this matrix.

◆ getNumEntriesInLocalRow()

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>

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

pure virtual

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

◆ getGlobalMaxNumRowEntries()

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>

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

pure virtual

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

◆ getLocalMaxNumRowEntries()

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>

virtual size_t Xpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getLocalMaxNumRowEntries ( ) const

pure virtual

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

◆ isLocallyIndexed()

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>

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

pure virtual

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

◆ isGloballyIndexed()

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>

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

pure virtual

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

◆ isFillComplete()

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>

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

pure virtual

Returns true if fillComplete() has been called.

◆ supportsRowViews()

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>

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

pure virtual

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

◆ getLocalRowCopy()

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>

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

pure virtual

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

◆ getGlobalRowView()

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>

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

pure virtual

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

◆ getLocalRowView()

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>

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

pure virtual

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

◆ getLocalDiagCopy()

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>

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

pure virtual

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

Implemented in Xpetra::CrsMatrix< double, int, EpetraGlobalOrdinal, Node >, Xpetra::CrsMatrix< double, int, int, EpetraNode >, Xpetra::CrsMatrix< double, int, long long, EpetraNode >, Xpetra::CrsMatrix< Scalar, int, int, EpetraNode >, Xpetra::CrsMatrix< Scalar, int, long long, EpetraNode >, Xpetra::CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >, Xpetra::CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Tpetra::KokkosClassic::DefaultNode::DefaultNodeType >, Xpetra::local_matrix_type< Scalar, LocalOrdinal, GlobalOrdinal, Node >, Xpetra::node_type< Scalar, LocalOrdinal, GlobalOrdinal, Node >, Xpetra::TpetraBlockCrsMatrix< Scalar, int, int, EpetraNode >, Xpetra::TpetraBlockCrsMatrix< Scalar, int, long long, EpetraNode >, Xpetra::TpetraBlockCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >, Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >, Xpetra::TpetraCrsMatrix< Scalar, int, long long, EpetraNode >, and Xpetra::TpetraCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

◆ getFrobeniusNorm()

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>

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

pure virtual

Returns the Frobenius norm of the matrix.

◆ getDomainMap()

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>

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

pure virtual

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

Implements Xpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Tpetra::KokkosClassic::DefaultNode::DefaultNodeType >.

◆ getRangeMap()

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>

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

pure virtual

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

Implements Xpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Tpetra::KokkosClassic::DefaultNode::DefaultNodeType >.

◆ apply()

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>

virtual void Xpetra::RowMatrix< 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

pure virtual

Computes the operator-multivector application.

Implemented in Xpetra::CrsMatrix< double, int, EpetraGlobalOrdinal, Node >, Xpetra::CrsMatrix< double, int, int, EpetraNode >, Xpetra::CrsMatrix< double, int, long long, EpetraNode >, Xpetra::CrsMatrix< Scalar, int, int, EpetraNode >, Xpetra::CrsMatrix< Scalar, int, long long, EpetraNode >, Xpetra::CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >, Xpetra::CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Tpetra::KokkosClassic::DefaultNode::DefaultNodeType >, Xpetra::local_matrix_type< Scalar, LocalOrdinal, GlobalOrdinal, Node >, Xpetra::node_type< Scalar, LocalOrdinal, GlobalOrdinal, Node >, Xpetra::TpetraBlockCrsMatrix< Scalar, int, int, EpetraNode >, Xpetra::TpetraBlockCrsMatrix< Scalar, int, long long, EpetraNode >, Xpetra::TpetraBlockCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >, Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >, Xpetra::TpetraCrsMatrix< Scalar, int, long long, EpetraNode >, and Xpetra::TpetraCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

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

Xpetra_RowMatrix.hpp

Public Types

Constructor/Destructor Methods

Matrix Query Methods

Extraction Methods

Mathematical Methods

Pure virtual functions to be overridden by subclasses.

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ scalar_type

◆ local_ordinal_type

◆ global_ordinal_type

◆ node_type

Constructor & Destructor Documentation

◆ ~RowMatrix()

Member Function Documentation

◆ getRowMap()

◆ getColMap()

◆ getGlobalNumRows()

◆ getGlobalNumCols()

◆ getLocalNumRows()

◆ getLocalNumCols()

◆ getGlobalNumEntries()

◆ getLocalNumEntries()

◆ getNumEntriesInLocalRow()

◆ getGlobalMaxNumRowEntries()

◆ getLocalMaxNumRowEntries()

◆ isLocallyIndexed()

◆ isGloballyIndexed()

◆ isFillComplete()

◆ supportsRowViews()

◆ getLocalRowCopy()

◆ getGlobalRowView()

◆ getLocalRowView()

◆ getLocalDiagCopy()

◆ getFrobeniusNorm()

◆ getDomainMap()

◆ getRangeMap()

◆ apply()