#include <Xpetra_TpetraRowMatrix.hpp>

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

Xpetra specific
RCP< Tpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > >	mtx_
	TpetraRowMatrix ()=default
	TpetraRowMatrix (const Teuchos::RCP< Tpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &mtx)
	TpetraCrsMatrix constructor to wrap a Tpetra::CrsMatrix object.
void	setTpetra_RowMatrix (const Teuchos::RCP< Tpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &mtx)
	Set the underlying Tpetra matrix.
RCP< const Tpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > >	getTpetra_RowMatrix () const
	Get the underlying Tpetra matrix.
RCP< Tpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > >	getTpetra_RowMatrixNonConst () const
	Get the underlying Tpetra matrix.

Destructor Method
virtual	~TpetraRowMatrix ()=default
	Destructor.

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

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

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

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().
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().
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.

Additional Inherited Members
Public Types inherited from Xpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Tpetra::KokkosClassic::DefaultNode::DefaultNodeType >
typedef Scalar	scalar_type
typedef LocalOrdinal	local_ordinal_type
typedef GlobalOrdinal	global_ordinal_type
typedef Tpetra::KokkosClassic::DefaultNode::DefaultNodeType	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.
virtual	~RowMatrix ()
	Destructor.
virtual size_t	getLocalNumEntries () const=0
	Returns the local number of entries in this matrix.
virtual void	getLocalDiagCopy (Vector< Scalar, LocalOrdinal, GlobalOrdinal, Tpetra::KokkosClassic::DefaultNode::DefaultNodeType > &diag) const=0
	Get a copy of the diagonal entries owned by this node, with local row indices.
virtual void	apply (const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Tpetra::KokkosClassic::DefaultNode::DefaultNodeType > &X, MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Tpetra::KokkosClassic::DefaultNode::DefaultNodeType > &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.
Public Member Functions inherited from Xpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Tpetra::KokkosClassic::DefaultNode::DefaultNodeType >
virtual	~Operator ()
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::TpetraRowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Definition at line 35 of file Xpetra_TpetraRowMatrix.hpp.

Constructor & Destructor Documentation

◆ ~TpetraRowMatrix()

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

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

virtualdefault

Destructor.

◆ TpetraRowMatrix() [1/2]

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

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

default

◆ TpetraRowMatrix() [2/2]

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

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 223 of file Xpetra_TpetraRowMatrix.hpp.

Member Function Documentation

◆ getRowMap()

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

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

inlinevirtual

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

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

Definition at line 50 of file Xpetra_TpetraRowMatrix.hpp.

◆ getColMap()

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

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

inlinevirtual

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

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

Definition at line 56 of file Xpetra_TpetraRowMatrix.hpp.

◆ getGlobalNumRows()

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

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

inlinevirtual

Returns the number of global rows in this matrix.

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

Definition at line 62 of file Xpetra_TpetraRowMatrix.hpp.

◆ getGlobalNumCols()

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

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

inlinevirtual

Returns the number of global columns in this matrix.

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

Definition at line 68 of file Xpetra_TpetraRowMatrix.hpp.

◆ getLocalNumRows()

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

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

inlinevirtual

Returns the number of rows owned on the calling node.

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

Definition at line 74 of file Xpetra_TpetraRowMatrix.hpp.

◆ getLocalNumCols()

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

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

inlinevirtual

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.

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

Definition at line 80 of file Xpetra_TpetraRowMatrix.hpp.

◆ getGlobalNumEntries()

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

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

inlinevirtual

Returns the global number of entries in this matrix.

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

Definition at line 86 of file Xpetra_TpetraRowMatrix.hpp.

◆ getNodeNumEntries()

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

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

inline

Returns the local number of entries in this matrix.

Definition at line 92 of file Xpetra_TpetraRowMatrix.hpp.

◆ getNumEntriesInLocalRow()

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

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

inlinevirtual

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

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

Definition at line 98 of file Xpetra_TpetraRowMatrix.hpp.

◆ getGlobalMaxNumRowEntries()

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

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

inlinevirtual

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

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

Definition at line 104 of file Xpetra_TpetraRowMatrix.hpp.

◆ getLocalMaxNumRowEntries()

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

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

inlinevirtual

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

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

Definition at line 110 of file Xpetra_TpetraRowMatrix.hpp.

◆ isLocallyIndexed()

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

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

inlinevirtual

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

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

Definition at line 116 of file Xpetra_TpetraRowMatrix.hpp.

◆ isGloballyIndexed()

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

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

inlinevirtual

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

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

Definition at line 122 of file Xpetra_TpetraRowMatrix.hpp.

◆ isFillComplete()

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

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

inlinevirtual

Returns true if fillComplete() has been called.

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

Definition at line 128 of file Xpetra_TpetraRowMatrix.hpp.

◆ supportsRowViews()

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

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

inlinevirtual

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

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

Definition at line 134 of file Xpetra_TpetraRowMatrix.hpp.

◆ getLocalRowCopy()

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

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

inlinevirtual

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

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

Definition at line 145 of file Xpetra_TpetraRowMatrix.hpp.

◆ getGlobalRowView()

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

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

inlinevirtual

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

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

Definition at line 158 of file Xpetra_TpetraRowMatrix.hpp.

◆ getLocalRowView()

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

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

inlinevirtual

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

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

Definition at line 169 of file Xpetra_TpetraRowMatrix.hpp.

◆ getLocalDiagCopy()

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

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 180 of file Xpetra_TpetraRowMatrix.hpp.

◆ getFrobeniusNorm()

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

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

inlinevirtual

Returns the Frobenius norm of the matrix.

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

Definition at line 189 of file Xpetra_TpetraRowMatrix.hpp.

◆ getDomainMap()

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

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

inlinevirtual

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

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

Definition at line 200 of file Xpetra_TpetraRowMatrix.hpp.

◆ getRangeMap()

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

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

inlinevirtual

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

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

Definition at line 206 of file Xpetra_TpetraRowMatrix.hpp.

◆ apply()

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

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 212 of file Xpetra_TpetraRowMatrix.hpp.

◆ setTpetra_RowMatrix()

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

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

inline

Set the underlying Tpetra matrix.

Definition at line 227 of file Xpetra_TpetraRowMatrix.hpp.

◆ getTpetra_RowMatrix()

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

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 230 of file Xpetra_TpetraRowMatrix.hpp.

◆ getTpetra_RowMatrixNonConst()

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

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 233 of file Xpetra_TpetraRowMatrix.hpp.

Member Data Documentation

◆ mtx_

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

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

private

Definition at line 238 of file Xpetra_TpetraRowMatrix.hpp.

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

Xpetra_TpetraRowMatrix.hpp

Xpetra specific

Destructor Method

Matrix Query Methods

Extraction Methods

Mathematical Methods

Pure virtual functions to be overridden by subclasses.

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~TpetraRowMatrix()

◆ TpetraRowMatrix() [1/2]

◆ TpetraRowMatrix() [2/2]

Member Function Documentation

◆ getRowMap()

◆ getColMap()

◆ getGlobalNumRows()

◆ getGlobalNumCols()

◆ getLocalNumRows()

◆ getLocalNumCols()

◆ getGlobalNumEntries()

◆ getNodeNumEntries()

◆ getNumEntriesInLocalRow()

◆ getGlobalMaxNumRowEntries()

◆ getLocalMaxNumRowEntries()

◆ isLocallyIndexed()

◆ isGloballyIndexed()

◆ isFillComplete()

◆ supportsRowViews()

◆ getLocalRowCopy()

◆ getGlobalRowView()

◆ getLocalRowView()

◆ getLocalDiagCopy()

◆ getFrobeniusNorm()

◆ getDomainMap()

◆ getRangeMap()

◆ apply()

◆ setTpetra_RowMatrix()

◆ getTpetra_RowMatrix()

◆ getTpetra_RowMatrixNonConst()

Member Data Documentation

◆ mtx_