Concrete implementation of Xpetra::Matrix. More...

#include <Xpetra_CrsMatrixWrap_decl.hpp>

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

Private Types
typedef Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >	Map

typedef Xpetra::CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >	CrsMatrix

typedef Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >	Matrix

typedef Xpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node >	CrsGraph

typedef Xpetra::TpetraCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >	TpetraCrsMatrix

typedef Xpetra::CrsMatrixFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >	CrsMatrixFactory

typedef Xpetra::MatrixView< Scalar, LocalOrdinal, GlobalOrdinal, Node >	MatrixView

using	local_matrix_type = typename Xpetra::CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::local_matrix_type

using	local_matrix_device_type = typename Xpetra::CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::local_matrix_device_type

using	local_matrix_host_type = typename Xpetra::CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::local_matrix_host_type

Overridden from Teuchos::LabeledObject
bool	finalDefaultView_

RCP< CrsMatrix >	matrixData_

void	setObjectLabel (const std::string &objectLabel)

virtual local_matrix_type	getLocalMatrixDevice () const

virtual local_matrix_type::host_mirror_type	getLocalMatrixHost () const

bool	hasCrsGraph () const
	Supports the getCrsGraph() call.

RCP< const CrsGraph >	getCrsGraph () const
	Returns the CrsGraph associated with this matrix.

RCP< CrsMatrix >	getCrsMatrix () const

LocalOrdinal	GetStorageBlockSize () const
	Returns the block size of the storage mechanism, which is usually 1, except for Tpetra::BlockCrsMatrix.

void	residual (const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &X, const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &B, MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &R) const
	Compute a residual R = B - (this) X.

void	replaceCrsMatrix (RCP< CrsMatrix > &M)
	Expert only.

void	CreateDefaultView ()

void	updateDefaultView () const

Constructor/Destructor Methods
	CrsMatrixWrap (const RCP< const Map > &rowMap)
	Constructor for a dynamic profile matrix (Epetra only)

	CrsMatrixWrap (const RCP< const Map > &rowMap, size_t maxNumEntriesPerRow)
	Constructor specifying fixed number of entries for each row.

	CrsMatrixWrap (const RCP< const Map > &rowMap, const ArrayRCP< const size_t > &NumEntriesPerRowToAlloc)
	Constructor specifying (possibly different) number of entries in each row.

	CrsMatrixWrap (const RCP< const Map > &rowMap, const RCP< const Map > &colMap, size_t maxNumEntriesPerRow)
	Constructor specifying fixed number of entries for each row and column map.

	CrsMatrixWrap (const RCP< const Map > &rowMap, const RCP< const Map > &colMap, const ArrayRCP< const size_t > &NumEntriesPerRowToAlloc)
	Constructor specifying fixed number of entries for each row and column map.

	CrsMatrixWrap (const RCP< const Map > &rowMap, const RCP< const Map > &colMap, const local_matrix_type &lclMatrix, const Teuchos::RCP< Teuchos::ParameterList > &params=null)
	Constructor specifying fixed number of entries for each row and column map.

	CrsMatrixWrap (const local_matrix_type &lclMatrix, const RCP< const Map > &rowMap, const RCP< const Map > &colMap, const RCP< const Map > &domainMap=Teuchos::null, const RCP< const Map > &rangeMap=Teuchos::null, const Teuchos::RCP< Teuchos::ParameterList > &params=null)
	Constructor specifying fixed number of entries for each row and column map.

	CrsMatrixWrap (RCP< CrsMatrix > matrix)

	CrsMatrixWrap (const RCP< const CrsGraph > &graph, const RCP< ParameterList > &paramList=Teuchos::null)

	CrsMatrixWrap (const RCP< const CrsGraph > &graph, typename Xpetra::CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::local_matrix_type::values_type &values, const RCP< ParameterList > &paramList=Teuchos::null)

virtual	~CrsMatrixWrap ()
	Destructor.

Insertion/Removal Methods
void	insertGlobalValues (GlobalOrdinal globalRow, const ArrayView< const GlobalOrdinal > &cols, const ArrayView< const Scalar > &vals)
	Insert matrix entries, using global IDs.

void	insertLocalValues (LocalOrdinal localRow, const ArrayView< const LocalOrdinal > &cols, const ArrayView< const Scalar > &vals)
	Insert matrix entries, using local IDs.

void	replaceGlobalValues (GlobalOrdinal globalRow, const ArrayView< const GlobalOrdinal > &cols, const ArrayView< const Scalar > &vals)
	Replace matrix entries, using global IDs.

void	replaceLocalValues (LocalOrdinal localRow, const ArrayView< const LocalOrdinal > &cols, const ArrayView< const Scalar > &vals)
	Replace matrix entries, using local IDs.

virtual void	setAllToScalar (const Scalar &alpha)
	Set all matrix entries equal to scalar.

void	scale (const Scalar &alpha)
	Scale the current values of a matrix, this = alpha*this.

Transformational Methods
void	resumeFill (const RCP< ParameterList > &params=null)

void	fillComplete (const RCP< const Map > &domainMap, const RCP< const Map > &rangeMap, const RCP< Teuchos::ParameterList > &params=null)
	Signal that data entry is complete, specifying domain and range maps.

void	fillComplete (const RCP< ParameterList > &params=null)
	Signal that data entry is complete.

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

global_size_t	getGlobalNumCols () const
	Returns the number of global columns in the matrix.

size_t	getLocalNumRows () const
	Returns the number of matrix rows owned on the calling node.

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

size_t	getLocalNumEntries () 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	getNumEntriesInGlobalRow (GlobalOrdinal globalRow) const
	Returns the current number of entries in the specified global 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 and the matrix is in compute mode.

void	getLocalRowCopy (LocalOrdinal LocalRow, const ArrayView< LocalOrdinal > &Indices, const ArrayView< Scalar > &Values, size_t &NumEntries) const
	Extract a list of entries in a specified local row of the matrix. 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 (Xpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &diag) const
	Get a copy of the diagonal entries owned by this node, with local row idices.

void	getLocalDiagOffsets (Teuchos::ArrayRCP< size_t > &offsets) const
	Get offsets of the diagonal entries in the matrix.

void	getLocalDiagCopy (Xpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &diag, const Teuchos::ArrayView< const size_t > &offsets) const
	Get a copy of the diagonal entries owned by this node, with local row indices, using row offsets.

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

void	leftScale (const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &x)
	Left scale matrix using the given vector entries.

void	rightScale (const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &x)
	Right scale matrix using the given vector entries.

bool	haveGlobalConstants () const
	Returns true if globalConstants have been computed; false otherwise.

Methods implementing Matrix
Multiplies this matrix by a MultiVector. `X` is required to be post-imported, i.e., described by the column map of the matrix. `Y` is required to be pre-exported, i.e., described by the row map of the matrix. Both are required to have constant stride, and they are not permitted to ocupy overlapping space. No runtime checking will be performed in a non-debug build. This method is templated on the scalar type of MultiVector objects, allowing this method to be applied to MultiVector objects of arbitrary type. However, it is recommended that multiply() not be called directly; instead, use the CrsMatrixMultiplyOp, as it will handle the import/exprt operations required to apply a matrix with non-trivial communication needs. If `beta` is equal to zero, the operation will enjoy overwrite semantics (`Y` will be overwritten with the result of the multiplication). Otherwise, the result of the multiplication will be accumulated into `Y`.
virtual void	apply (const Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &X, Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &Y, Teuchos::ETransp mode=Teuchos::NO_TRANS, Scalar alpha=ScalarTraits< Scalar >::one(), Scalar beta=ScalarTraits< Scalar >::zero()) const
	Computes the sparse matrix-multivector multiplication.

virtual void	apply (const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &X, MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &Y, Teuchos::ETransp mode, Scalar alpha, Scalar beta, bool sumInterfaceValues, const RCP< Import< LocalOrdinal, GlobalOrdinal, Node > > &regionInterfaceImporter, const Teuchos::ArrayRCP< LocalOrdinal > &regionInterfaceLIDs) const
	Computes the matrix-multivector multiplication for region layout matrices.

const RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > >	getDomainMap () const
	Returns the Map associated with the domain of this operator. This will be `null` until fillComplete() is called.

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

const RCP< const Map > &	getColMap () const
	Returns the Map that describes the column distribution in this matrix. This might be `null` until fillComplete() is called.

const RCP< const Map > &	getColMap (viewLabel_t viewLabel) const
	Returns the Map that describes the column distribution in this matrix.

void	removeEmptyProcessesInPlace (const Teuchos::RCP< const Map > &newMap)

const Teuchos::RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > >	getMap () const
	Implements DistObject interface.

void	doImport (const Matrix &source, const Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node > &importer, CombineMode CM)
	Import.

void	doExport (const Matrix &dest, const Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node > &importer, CombineMode CM)
	Export.

void	doImport (const Matrix &source, const Xpetra::Export< LocalOrdinal, GlobalOrdinal, Node > &exporter, CombineMode CM)
	Import (using an Exporter).

void	doExport (const Matrix &dest, const Xpetra::Export< LocalOrdinal, GlobalOrdinal, Node > &exporter, CombineMode CM)
	Export (using an Importer).

Overridden from Teuchos::Describable
std::string	description () const
	Return a simple one-line description of this object.

void	describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const
	Print the object with some verbosity level to an FancyOStream object.

Additional Inherited Members
Public Types inherited from Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >
typedef Scalar	scalar_type

typedef LocalOrdinal	local_ordinal_type

typedef GlobalOrdinal	global_ordinal_type

typedef Node	node_type

using	local_matrix_type = typename Xpetra::CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::local_matrix_type

using	local_matrix_device_type = typename Xpetra::CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::local_matrix_device_type

using	local_matrix_host_type = typename Xpetra::CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::local_matrix_host_type

using	ATS = KokkosKernels::ArithTraits< Scalar >

using	impl_scalar_type = typename ATS::val_type

Public Types inherited from Xpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node >
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 Node	node_type
	The Kokkos Node type.

Public Member Functions inherited from Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >
void	SetFixedBlockSize (LocalOrdinal blksize, GlobalOrdinal offset=0)

LocalOrdinal	GetFixedBlockSize () const

bool	IsFixedBlockSizeSet () const
	Returns true, if `SetFixedBlockSize` has been called before.

virtual void	SetMaxEigenvalueEstimate (Scalar const &sigma)

virtual Scalar	GetMaxEigenvalueEstimate () const

	Matrix ()

virtual	~Matrix ()
	Destructor.

void	CreateView (viewLabel_t viewLabel, const RCP< const Map > &rowMap, const RCP< const Map > &colMap)

void	CreateView (const viewLabel_t viewLabel, const RCP< const Matrix > &A, bool transposeA=false, const RCP< const Matrix > &B=Teuchos::null, bool transposeB=false)

void	PrintViews (Teuchos::FancyOStream &out) const
	Print all of the views associated with the Matrix.

void	RemoveView (const viewLabel_t viewLabel)

const viewLabel_t	SwitchToView (const viewLabel_t viewLabel)

bool	IsView (const viewLabel_t viewLabel) const

const viewLabel_t	SwitchToDefaultView ()

const viewLabel_t &	GetDefaultViewLabel () const

const viewLabel_t &	GetCurrentViewLabel () const

virtual const RCP< const Map > &	getRowMap () const
	Returns the Map that describes the row distribution in this matrix.

virtual const RCP< const Map > &	getRowMap (viewLabel_t viewLabel) const
	Returns the Map that describes the row distribution in this matrix.

Public Member Functions inherited from Xpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node >
virtual	~Operator ()

virtual bool	hasTransposeApply () const
	Whether this operator supports applying the transpose or conjugate transpose.

Public Member Functions inherited from Teuchos::Describable
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)

void	describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const

virtual	~Describable ()

Public Member Functions inherited from Teuchos::LabeledObject
	LabeledObject ()

virtual	~LabeledObject ()

virtual std::string	getObjectLabel () const

Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel	verbLevel_default

Protected Attributes inherited from Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >
Teuchos::Hashtable< viewLabel_t, RCP< MatrixView > >	operatorViewTable_

viewLabel_t	defaultViewLabel_

viewLabel_t	currentViewLabel_

Detailed Description

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

Concrete implementation of Xpetra::Matrix.

Definition at line 52 of file Xpetra_CrsMatrixWrap_decl.hpp.

Member Typedef Documentation

◆ Map

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

typedef Xpetra::Map<LocalOrdinal, GlobalOrdinal, Node> Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Map

private

Definition at line 53 of file Xpetra_CrsMatrixWrap_decl.hpp.

◆ CrsMatrix

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

typedef Xpetra::CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::CrsMatrix

private

Definition at line 54 of file Xpetra_CrsMatrixWrap_decl.hpp.

◆ Matrix

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

typedef Xpetra::Matrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Matrix

private

Definition at line 55 of file Xpetra_CrsMatrixWrap_decl.hpp.

◆ CrsGraph

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

typedef Xpetra::CrsGraph<LocalOrdinal, GlobalOrdinal, Node> Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::CrsGraph

private

Definition at line 56 of file Xpetra_CrsMatrixWrap_decl.hpp.

◆ TpetraCrsMatrix

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

typedef Xpetra::TpetraCrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::TpetraCrsMatrix

private

Definition at line 57 of file Xpetra_CrsMatrixWrap_decl.hpp.

◆ CrsMatrixFactory

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

typedef Xpetra::CrsMatrixFactory<Scalar, LocalOrdinal, GlobalOrdinal, Node> Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::CrsMatrixFactory

private

Definition at line 58 of file Xpetra_CrsMatrixWrap_decl.hpp.

◆ MatrixView

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

typedef Xpetra::MatrixView<Scalar, LocalOrdinal, GlobalOrdinal, Node> Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::MatrixView

private

Definition at line 59 of file Xpetra_CrsMatrixWrap_decl.hpp.

◆ local_matrix_type

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

using Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::local_matrix_type = typename Xpetra::CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>::local_matrix_type

private

Definition at line 60 of file Xpetra_CrsMatrixWrap_decl.hpp.

◆ local_matrix_device_type

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

using Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::local_matrix_device_type = typename Xpetra::CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>::local_matrix_device_type

private

Definition at line 61 of file Xpetra_CrsMatrixWrap_decl.hpp.

◆ local_matrix_host_type

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

using Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::local_matrix_host_type = typename Xpetra::CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>::local_matrix_host_type

private

Definition at line 62 of file Xpetra_CrsMatrixWrap_decl.hpp.

Constructor & Destructor Documentation

◆ CrsMatrixWrap() [1/10]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::CrsMatrixWrap ( const RCP< const Map > & rowMap )

Constructor for a dynamic profile matrix (Epetra only)

Definition at line 34 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ CrsMatrixWrap() [2/10]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::CrsMatrixWrap	(	const RCP< const Map > &	rowMap,
		size_t	maxNumEntriesPerRow
	)

Constructor specifying fixed number of entries for each row.

Definition at line 41 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ CrsMatrixWrap() [3/10]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::CrsMatrixWrap	(	const RCP< const Map > &	rowMap,
		const ArrayRCP< const size_t > &	NumEntriesPerRowToAlloc
	)

Constructor specifying (possibly different) number of entries in each row.

Definition at line 49 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ CrsMatrixWrap() [4/10]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::CrsMatrixWrap	(	const RCP< const Map > &	rowMap,
		const RCP< const Map > &	colMap,
		size_t	maxNumEntriesPerRow
	)

Constructor specifying fixed number of entries for each row and column map.

Definition at line 57 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ CrsMatrixWrap() [5/10]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::CrsMatrixWrap	(	const RCP< const Map > &	rowMap,
		const RCP< const Map > &	colMap,
		const ArrayRCP< const size_t > &	NumEntriesPerRowToAlloc
	)

Constructor specifying fixed number of entries for each row and column map.

Definition at line 67 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ CrsMatrixWrap() [6/10]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::CrsMatrixWrap	(	const RCP< const Map > &	rowMap,
		const RCP< const Map > &	colMap,
		const local_matrix_type &	lclMatrix,
		const Teuchos::RCP< Teuchos::ParameterList > &	params = `null`
	)

Constructor specifying fixed number of entries for each row and column map.

Definition at line 77 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ CrsMatrixWrap() [7/10]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::CrsMatrixWrap	(	const local_matrix_type &	lclMatrix,
		const RCP< const Map > &	rowMap,
		const RCP< const Map > &	colMap,
		const RCP< const Map > &	domainMap = `Teuchos::null`,
		const RCP< const Map > &	rangeMap = `Teuchos::null`,
		const Teuchos::RCP< Teuchos::ParameterList > &	params = `null`
	)

Constructor specifying fixed number of entries for each row and column map.

Definition at line 87 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ CrsMatrixWrap() [8/10]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::CrsMatrixWrap ( RCP< CrsMatrix > matrix )

Definition at line 99 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ CrsMatrixWrap() [9/10]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::CrsMatrixWrap	(	const RCP< const CrsGraph > &	graph,
		const RCP< ParameterList > &	paramList = `Teuchos::null`
	)

Definition at line 109 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ CrsMatrixWrap() [10/10]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::CrsMatrixWrap	(	const RCP< const CrsGraph > &	graph,
		typename Xpetra::CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::local_matrix_type::values_type &	values,
		const RCP< ParameterList > &	paramList = `Teuchos::null`
	)

Definition at line 119 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ ~CrsMatrixWrap()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

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

virtual

Destructor.

Definition at line 132 of file Xpetra_CrsMatrixWrap_def.hpp.

Member Function Documentation

◆ insertGlobalValues()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::insertGlobalValues	(	GlobalOrdinal	globalRow,
		const ArrayView< const GlobalOrdinal > &	cols,
		const ArrayView< const Scalar > &	vals
	)

virtual

Insert matrix entries, using global IDs.

All index values must be in the global space.

Precondition: globalRow exists as an ID in the global row map; isLocallyIndexed() == false; isStorageOptimized() == false

Postcondition: isGloballyIndexed() == true

Note: If globalRow does not belong to the matrix on this node, then it will be communicated to the appropriate node when globalAssemble() is called (which will, at the latest, occur during the next call to fillComplete().) Otherwise, the entries will be inserted in the local matrix.; If the matrix row already contains values at the indices corresponding to values in cols, then the new values will be summed with the old values; this may happen at insertion or during the next call to fillComplete().; If hasColMap() == true, only (cols[i],vals[i]) where cols[i] belongs to the column map on this node will be inserted into the matrix.

Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 135 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ insertLocalValues()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::insertLocalValues	(	LocalOrdinal	localRow,
		const ArrayView< const LocalOrdinal > &	cols,
		const ArrayView< const Scalar > &	vals
	)

virtual

Insert matrix entries, using local IDs.

All index values must be in the local space.

Precondition: localRow exists as an ID in the global row map; isGloballyIndexed() == false; isStorageOptimized() == false

Postcondition: isLocallyIndexed() == true

Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 140 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ replaceGlobalValues()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::replaceGlobalValues	(	GlobalOrdinal	globalRow,
		const ArrayView< const GlobalOrdinal > &	cols,
		const ArrayView< const Scalar > &	vals
	)

virtual

Replace matrix entries, using global IDs.

All index values must be in the global space.

Precondition: globalRow is a global row belonging to the matrix on this node.

Note: If (globalRow,cols[i]) corresponds to an entry that is duplicated in this matrix row (likely because it was inserted more than once and fillComplete() has not been called in the interim), the behavior of this function is not defined.

Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 145 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ replaceLocalValues()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::replaceLocalValues	(	LocalOrdinal	localRow,
		const ArrayView< const LocalOrdinal > &	cols,
		const ArrayView< const Scalar > &	vals
	)

virtual

Replace matrix entries, using local IDs.

All index values must be in the local space. Note that if a value is not already present for the specified location in the matrix, the input value will be ignored silently.

Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 150 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ setAllToScalar()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::setAllToScalar ( const Scalar & alpha )

virtual

Set all matrix entries equal to scalar.

Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 155 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ scale()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::scale ( const Scalar & alpha )

virtual

Scale the current values of a matrix, this = alpha*this.

Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 158 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ resumeFill()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::resumeFill ( const RCP< ParameterList > & params = null )

virtual

Resume fill operations. After calling fillComplete(), resumeFill() must be called before initiating any changes to the matrix.

resumeFill() may be called repeatedly.

Postcondition: isFillActive() == true; isFillComplete() == false

Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 163 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ fillComplete() [1/2]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::fillComplete	(	const RCP< const Map > &	domainMap,
		const RCP< const Map > &	rangeMap,
		const RCP< Teuchos::ParameterList > &	params = `null`
	)

virtual

Signal that data entry is complete, specifying domain and range maps.

Off-node indices are distributed (via globalAssemble()), indices are sorted, redundant indices are eliminated, and global indices are transformed to local indices.

Precondition: isFillActive() == true; isFillComplete()() == false

Postcondition: isFillActive() == false; isFillComplete() == true; if os == DoOptimizeStorage, then isStorageOptimized() == true

Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 168 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ fillComplete() [2/2]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::fillComplete ( const RCP< ParameterList > & params = null )

virtual

Signal that data entry is complete.

Off-node entries are distributed (via globalAssemble()), repeated entries are summed, and global indices are transformed to local indices.

Note: This method calls fillComplete( getRowMap(), getRowMap(), os ).

Precondition: isFillActive() == true; isFillComplete()() == false

Postcondition: isFillActive() == false; isFillComplete() == true; if os == DoOptimizeStorage, then isStorageOptimized() == true

Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 176 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ getGlobalNumRows()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

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

virtual

Returns the number of global rows in this matrix.

Undefined if isFillActive().

Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 184 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ getGlobalNumCols()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

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

virtual

Returns the number of global columns in the matrix.

Undefined if isFillActive().

Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 189 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ getLocalNumRows()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

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

virtual

Returns the number of matrix rows owned on the calling node.

Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 194 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ getGlobalNumEntries()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

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

virtual

Returns the global number of entries in this matrix.

Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 199 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ getLocalNumEntries()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

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

virtual

Returns the local number of entries in this matrix.

Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 204 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ getNumEntriesInLocalRow()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

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

virtual

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

Returns OrdinalTraits<size_t>::invalid() if the specified local row is not valid for this matrix.

Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 209 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ getNumEntriesInGlobalRow()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

size_t Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getNumEntriesInGlobalRow ( GlobalOrdinal globalRow ) const

virtual

Returns the current number of entries in the specified global row.

Returns OrdinalTraits<size_t>::invalid() if the row is not owned by this process.

Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 214 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ getGlobalMaxNumRowEntries()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

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

virtual

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

Undefined if isFillActive().

Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 219 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ getLocalMaxNumRowEntries()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

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

virtual

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

Undefined if isFillActive().

Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 224 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ isLocallyIndexed()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

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

virtual

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

Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 229 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ isGloballyIndexed()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

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

virtual

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

Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 234 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ isFillComplete()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

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

virtual

Returns true if fillComplete() has been called and the matrix is in compute mode.

Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 239 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ getLocalRowCopy()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

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

virtual

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

Parameters

LocalRow	- (In) Local row number for which indices are desired.
Indices	- (Out) Local column indices corresponding to values.
Values	- (Out) Matrix values.
NumIndices	- (Out) Number of indices.

Note: A std::runtime_error exception is thrown if either Indices or Values is not large enough to hold the data associated with row LocalRow. If LocalRow is not valid for this node, then Indices and Values are unchanged and NumIndices is returned as OrdinalTraits<size_t>::invalid().

Precondition: isLocallyIndexed()==true or hasColMap() == true

Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 244 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ getGlobalRowView()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

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

virtual

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

Parameters

GlobalRow	- (In) Global row number for which indices are desired.
Indices	- (Out) Global column indices corresponding to values.
Values	- (Out) Row values

Precondition: isLocallyIndexed() == false

Postcondition: indices.size() == getNumEntriesInGlobalRow(GlobalRow)

Note: If GlobalRow does not belong to this node, then indices is set to null.

Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 252 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ getLocalRowView()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

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

virtual

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

Parameters

LocalRow	- (In) Local row number for which indices are desired.
Indices	- (Out) Global column indices corresponding to values.
Values	- (Out) Row values

Precondition: isGloballyIndexed() == false

Postcondition: indices.size() == getNumEntriesInLocalRow(LocalRow)

Note: If LocalRow does not belong to this node, then indices is set to null.

Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 257 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ getLocalDiagCopy() [1/2]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

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

virtual

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

Returns a distributed Vector object partitioned according to this matrix's row map, containing the the zero and non-zero diagonals owned by this node.

Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 262 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ getLocalDiagOffsets()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getLocalDiagOffsets ( Teuchos::ArrayRCP< size_t > & offsets ) const

Get offsets of the diagonal entries in the matrix.

Definition at line 267 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ getLocalDiagCopy() [2/2]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getLocalDiagCopy	(	Xpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	diag,
		const Teuchos::ArrayView< const size_t > &	offsets
	)		const

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

Definition at line 272 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ getFrobeniusNorm()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

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

virtual

Get Frobenius norm of the matrix.

Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 277 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ leftScale()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::leftScale ( const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > & x )

virtual

Left scale matrix using the given vector entries.

Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 282 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ rightScale()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::rightScale ( const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > & x )

virtual

Right scale matrix using the given vector entries.

Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 287 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ haveGlobalConstants()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

bool Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::haveGlobalConstants ( ) const

virtual

Returns true if globalConstants have been computed; false otherwise.

Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 292 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ apply() [1/2]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

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

virtual

Computes the sparse matrix-multivector multiplication.

Performs \(Y = \alpha A^{\textrm{mode}} X + \beta Y\), with one special exceptions:

if beta == 0, apply() overwrites Y, so that any values in Y (including NaNs) are ignored.

Implements Xpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 297 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ apply() [2/2]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::apply	(	const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	X,
		MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	Y,
		Teuchos::ETransp	mode,
		Scalar	alpha,
		Scalar	beta,
		bool	sumInterfaceValues,
		const RCP< Import< LocalOrdinal, GlobalOrdinal, Node > > &	regionInterfaceImporter,
		const Teuchos::ArrayRCP< LocalOrdinal > &	regionInterfaceLIDs
	)		const

virtual

Computes the matrix-multivector multiplication for region layout matrices.

Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 306 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ getDomainMap()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

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

virtual

Returns the Map associated with the domain of this operator. This will be null until fillComplete() is called.

Implements Xpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 318 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ getRangeMap()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

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

virtual

Returns the Map associated with the domain of this operator. This will be null until fillComplete() is called.

Implements Xpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 323 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ getColMap() [1/2]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

const RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > & Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getColMap ( ) const

virtual

Returns the Map that describes the column distribution in this matrix. This might be null until fillComplete() is called.

Reimplemented from Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 328 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ getColMap() [2/2]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

const RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > & Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getColMap ( viewLabel_t viewLabel ) const

virtual

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

Reimplemented from Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 331 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ removeEmptyProcessesInPlace()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::removeEmptyProcessesInPlace ( const Teuchos::RCP< const Map > & newMap )

virtual

Reimplemented from Xpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 338 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ getMap()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

const Teuchos::RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getMap ( ) const

virtual

Implements DistObject interface.

Access function for the Tpetra::Map this DistObject was constructed with.

Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 345 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ doImport() [1/2]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::doImport	(	const Matrix &	source,
		const Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node > &	importer,
		CombineMode	CM
	)

virtual

Import.

Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 350 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ doExport() [1/2]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::doExport	(	const Matrix &	dest,
		const Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node > &	importer,
		CombineMode	CM
	)

virtual

Export.

Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 357 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ doImport() [2/2]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::doImport	(	const Matrix &	source,
		const Xpetra::Export< LocalOrdinal, GlobalOrdinal, Node > &	exporter,
		CombineMode	CM
	)

virtual

Import (using an Exporter).

Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 364 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ doExport() [2/2]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::doExport	(	const Matrix &	dest,
		const Xpetra::Export< LocalOrdinal, GlobalOrdinal, Node > &	exporter,
		CombineMode	CM
	)

virtual

Export (using an Importer).

Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 371 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ description()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

std::string Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::description ( ) const

virtual

Return a simple one-line description of this object.

Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 378 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ describe()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::describe	(	Teuchos::FancyOStream &	out,
		const Teuchos::EVerbosityLevel	verbLevel = `Teuchos::Describable::verbLevel_default`
	)		const

virtual

Print the object with some verbosity level to an FancyOStream object.

Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 383 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ setObjectLabel()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::setObjectLabel ( const std::string & objectLabel )

virtual

Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 398 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ getLocalMatrixDevice()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

Xpetra::CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::local_matrix_type Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getLocalMatrixDevice ( ) const

virtual

Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 410 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ getLocalMatrixHost()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::local_matrix_type::host_mirror_type Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getLocalMatrixHost ( ) const

virtual

Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 405 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ hasCrsGraph()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

bool Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::hasCrsGraph ( ) const

virtual

Supports the getCrsGraph() call.

Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 415 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ getCrsGraph()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

RCP< const Xpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getCrsGraph ( ) const

virtual

Returns the CrsGraph associated with this matrix.

Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 418 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ getCrsMatrix()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

RCP< Xpetra::CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getCrsMatrix ( ) const

Definition at line 421 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ GetStorageBlockSize()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

LocalOrdinal Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetStorageBlockSize ( ) const

virtual

Returns the block size of the storage mechanism, which is usually 1, except for Tpetra::BlockCrsMatrix.

Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 460 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ residual()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::residual	(	const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	X,
		const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	B,
		MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	R
	)		const

virtual

Compute a residual R = B - (*this) * X.

Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 465 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ replaceCrsMatrix()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::replaceCrsMatrix ( RCP< CrsMatrix > & M )

Expert only.

Definition at line 446 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ CreateDefaultView()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::CreateDefaultView ( )

private

Definition at line 426 of file Xpetra_CrsMatrixWrap_def.hpp.

◆ updateDefaultView()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::updateDefaultView ( ) const

private

Definition at line 436 of file Xpetra_CrsMatrixWrap_def.hpp.

Member Data Documentation

◆ finalDefaultView_

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

bool Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::finalDefaultView_

mutableprivate

Definition at line 450 of file Xpetra_CrsMatrixWrap_decl.hpp.

◆ matrixData_

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

RCP<CrsMatrix> Xpetra::CrsMatrixWrap< Scalar, LocalOrdinal, GlobalOrdinal, Node >::matrixData_

private

Definition at line 453 of file Xpetra_CrsMatrixWrap_decl.hpp.

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

Private Types

Overridden from Teuchos::LabeledObject

Constructor/Destructor Methods

Insertion/Removal Methods

Transformational Methods

Methods implementing Matrix

Overridden from Teuchos::Describable

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Map

◆ CrsMatrix

◆ Matrix

◆ CrsGraph

◆ TpetraCrsMatrix

◆ CrsMatrixFactory

◆ MatrixView

◆ local_matrix_type

◆ local_matrix_device_type

◆ local_matrix_host_type

Constructor & Destructor Documentation

◆ CrsMatrixWrap() [1/10]

◆ CrsMatrixWrap() [2/10]

◆ CrsMatrixWrap() [3/10]

◆ CrsMatrixWrap() [4/10]

◆ CrsMatrixWrap() [5/10]

◆ CrsMatrixWrap() [6/10]

◆ CrsMatrixWrap() [7/10]

◆ CrsMatrixWrap() [8/10]

◆ CrsMatrixWrap() [9/10]

◆ CrsMatrixWrap() [10/10]

◆ ~CrsMatrixWrap()

Member Function Documentation

◆ insertGlobalValues()

◆ insertLocalValues()

◆ replaceGlobalValues()

◆ replaceLocalValues()

◆ setAllToScalar()

◆ scale()

◆ resumeFill()

◆ fillComplete() [1/2]

◆ fillComplete() [2/2]

◆ getGlobalNumRows()

◆ getGlobalNumCols()

◆ getLocalNumRows()

◆ getGlobalNumEntries()

◆ getLocalNumEntries()

◆ getNumEntriesInLocalRow()

◆ getNumEntriesInGlobalRow()

◆ getGlobalMaxNumRowEntries()

◆ getLocalMaxNumRowEntries()

◆ isLocallyIndexed()

◆ isGloballyIndexed()

◆ isFillComplete()

◆ getLocalRowCopy()

◆ getGlobalRowView()

◆ getLocalRowView()

◆ getLocalDiagCopy() [1/2]

◆ getLocalDiagOffsets()

◆ getLocalDiagCopy() [2/2]

◆ getFrobeniusNorm()

◆ leftScale()

◆ rightScale()

◆ haveGlobalConstants()

◆ apply() [1/2]

◆ apply() [2/2]

◆ getDomainMap()

◆ getRangeMap()

◆ getColMap() [1/2]

◆ getColMap() [2/2]

◆ removeEmptyProcessesInPlace()

◆ getMap()

◆ doImport() [1/2]

◆ doExport() [1/2]

◆ doImport() [2/2]

◆ doExport() [2/2]

◆ description()

◆ describe()

◆ setObjectLabel()

◆ getLocalMatrixDevice()