#include <Xpetra_TpetraCrsMatrix_decl.hpp>

Inheritance diagram for Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >:

Private Types
typedef int	LocalOrdinal
typedef int	GlobalOrdinal
typedef EpetraNode	Node
typedef TpetraCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >	TpetraCrsMatrixClass
typedef TpetraVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >	TpetraVectorClass
typedef TpetraImport< LocalOrdinal, GlobalOrdinal, Node >	TpetraImportClass
typedef TpetraExport< LocalOrdinal, GlobalOrdinal, Node >	TpetraExportClass
typedef Xpetra::CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::local_matrix_type	local_matrix_type
using	CrsMatrix
using	Vector
using	SC

Constructor/Destructor Methods
	TpetraCrsMatrix (const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &rowMap, size_t maxNumEntriesPerRow, const Teuchos::RCP< Teuchos::ParameterList > &params=Teuchos::null)
	Constructor specifying fixed number of entries for each row.
	TpetraCrsMatrix (const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &rowMap, const ArrayRCP< const size_t > &NumEntriesPerRowToAlloc, const Teuchos::RCP< Teuchos::ParameterList > &params=Teuchos::null)
	Constructor specifying (possibly different) number of entries in each row.
	TpetraCrsMatrix (const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &rowMap, const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &colMap, size_t maxNumEntriesPerRow, const Teuchos::RCP< Teuchos::ParameterList > &params=Teuchos::null)
	Constructor specifying column Map and fixed number of entries for each row.
	TpetraCrsMatrix (const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &rowMap, const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &colMap, const ArrayRCP< const size_t > &NumEntriesPerRowToAlloc, const Teuchos::RCP< Teuchos::ParameterList > &params=Teuchos::null)
	Constructor specifying column Map and number of entries in each row.
	TpetraCrsMatrix (const Teuchos::RCP< const CrsGraph< LocalOrdinal, GlobalOrdinal, Node > > &graph, const Teuchos::RCP< Teuchos::ParameterList > &params=Teuchos::null)
	Constructor specifying a previously constructed graph.
	TpetraCrsMatrix (const Teuchos::RCP< const CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &sourceMatrix, const Import< LocalOrdinal, GlobalOrdinal, Node > &importer, const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &domainMap=Teuchos::null, const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &rangeMap=Teuchos::null, const Teuchos::RCP< Teuchos::ParameterList > &params=Teuchos::null)
	Constructor for a fused import.
	TpetraCrsMatrix (const Teuchos::RCP< const CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &sourceMatrix, const Export< LocalOrdinal, GlobalOrdinal, Node > &exporter, const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &domainMap=Teuchos::null, const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &rangeMap=Teuchos::null, const Teuchos::RCP< Teuchos::ParameterList > &params=Teuchos::null)
	Constructor for a fused export.
	TpetraCrsMatrix (const Teuchos::RCP< const CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &sourceMatrix, const Import< LocalOrdinal, GlobalOrdinal, Node > &RowImporter, const Teuchos::RCP< const Import< LocalOrdinal, GlobalOrdinal, Node > > DomainImporter, const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &domainMap, const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &rangeMap, const Teuchos::RCP< Teuchos::ParameterList > &params)
	Constructor for a fused import.
	TpetraCrsMatrix (const Teuchos::RCP< const CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &sourceMatrix, const Export< LocalOrdinal, GlobalOrdinal, Node > &RowExporter, const Teuchos::RCP< const Export< LocalOrdinal, GlobalOrdinal, Node > > DomainExporter, const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &domainMap, const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &rangeMap, const Teuchos::RCP< Teuchos::ParameterList > &params)
	Constructor for a fused export.
	TpetraCrsMatrix (const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &rowMap, const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &colMap, const local_matrix_type &lclMatrix, const Teuchos::RCP< Teuchos::ParameterList > &params=null)
	Constructor specifying column Map and a local matrix, which the resulting CrsMatrix views.
	TpetraCrsMatrix (const local_matrix_type &lclMatrix, const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &rowMap, const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &colMap, const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &domainMap=Teuchos::null, const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &rangeMap=Teuchos::null, const Teuchos::RCP< Teuchos::ParameterList > &params=null)
	Constructor specifying local matrix and 4 maps.
virtual	~TpetraCrsMatrix ()
	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.
void	setAllToScalar (const Scalar &alpha)
	Set all matrix entries equal to scalarThis.
void	scale (const Scalar &alpha)
	Scale the current values of a matrix, this = alpha*this.
void	allocateAllValues (size_t numNonZeros, ArrayRCP< size_t > &rowptr, ArrayRCP< LocalOrdinal > &colind, ArrayRCP< Scalar > &values)
	Allocates and returns ArrayRCPs of the Crs arrays — This is an Xpetra-only routine.
void	setAllValues (const ArrayRCP< size_t > &rowptr, const ArrayRCP< LocalOrdinal > &colind, const ArrayRCP< Scalar > &values)
	Sets the 1D pointer arrays of the graph.
void	getAllValues (ArrayRCP< const size_t > &rowptr, ArrayRCP< const LocalOrdinal > &colind, ArrayRCP< const Scalar > &values) const
	Gets the 1D pointer arrays of the graph.
void	getAllValues (ArrayRCP< Scalar > &values)
	Gets the 1D pointer arrays of the graph.
bool	haveGlobalConstants () const
	Returns true if globalConstants have been computed; false otherwise.

Transformational Methods
void	resumeFill (const RCP< ParameterList > &params=null)
void	fillComplete (const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &domainMap, const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &rangeMap, const RCP< 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.
void	replaceDomainMapAndImporter (const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &newDomainMap, Teuchos::RCP< const Import< LocalOrdinal, GlobalOrdinal, Node > > &newImporter)
	Replaces the current domainMap and importer with the user-specified objects.
void	expertStaticFillComplete (const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &domainMap, const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &rangeMap, const RCP< const Import< LocalOrdinal, GlobalOrdinal, Node > > &importer=Teuchos::null, const RCP< const Export< LocalOrdinal, GlobalOrdinal, Node > > &exporter=Teuchos::null, const RCP< ParameterList > &params=Teuchos::null)
	Expert static fill complete.

Methods implementing RowMatrix
const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > >	getRowMap () const
	Returns the Map that describes the row distribution in this matrix.
const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > >	getColMap () const
	Returns the Map that describes the column distribution in this matrix.
RCP< const CrsGraph< LocalOrdinal, GlobalOrdinal, Node > >	getCrsGraph () const
	Returns the CrsGraph associated with this matrix.
global_size_t	getGlobalNumRows () const
	Number of global elements in the row map of this matrix.
global_size_t	getGlobalNumCols () const
	Number of global columns in the matrix.
size_t	getLocalNumRows () const
	Returns the number of matrix rows owned on the calling node.
size_t	getLocalNumCols () const
	Returns the number of columns connected to the locally owned rows of this matrix.
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 (locally owned) 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 the matrix is in compute mode, i.e. if fillComplete() has been called.
bool	isFillActive () const
	Returns true if the matrix is in edit mode.
ScalarTraits< Scalar >::magnitudeType	getFrobeniusNorm () const
	Returns the Frobenius norm of the matrix.
bool	supportsRowViews () const
	Returns true if getLocalRowView() and getGlobalRowView() are valid for this class.
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	getGlobalRowCopy (GlobalOrdinal GlobalRow, const ArrayView< GlobalOrdinal > &indices, const ArrayView< Scalar > &values, size_t &numEntries) const
	Extract a list of entries in a specified global row of this matrix. Put into pre-allocated storage.
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.

Methods implementing Operator
void	apply (const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &X, 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.
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< Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node > > &regionInterfaceImporter, const Teuchos::ArrayRCP< LocalOrdinal > &regionInterfaceLIDs) const
	Computes the matrix-multivector multiplication for region layout matrices.
const RCP< const 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 Map< LocalOrdinal, GlobalOrdinal, Node > >	getRangeMap () const
	Returns the Map associated with the range of this operator, which must be compatible with Y.getMap().

Overridden from Teuchos::Describable
std::string	description () const
	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.

Overridden from Teuchos::LabeledObject
void	setObjectLabel (const std::string &objectLabel)
	TpetraCrsMatrix (const TpetraCrsMatrix &matrix)
	Deep copy constructor.
void	getLocalDiagCopy (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 (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.
void	replaceDiag (const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &diag)
	Replace the diagonal entries of the matrix.
void	leftScale (const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &x)
	Left scale operator with given vector values.
void	rightScale (const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &x)
	Right scale operator with given vector values.
Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > >	getMap () const
	Implements DistObject interface.
void	doImport (const DistObject< char, LocalOrdinal, GlobalOrdinal, Node > &source, const Import< LocalOrdinal, GlobalOrdinal, Node > &importer, CombineMode CM)
	Import.
void	doExport (const DistObject< char, LocalOrdinal, GlobalOrdinal, Node > &dest, const Import< LocalOrdinal, GlobalOrdinal, Node > &importer, CombineMode CM)
	Export.
void	doImport (const DistObject< char, LocalOrdinal, GlobalOrdinal, Node > &source, const Export< LocalOrdinal, GlobalOrdinal, Node > &exporter, CombineMode CM)
	Import (using an Exporter).
void	doExport (const DistObject< char, LocalOrdinal, GlobalOrdinal, Node > &dest, const Export< LocalOrdinal, GlobalOrdinal, Node > &exporter, CombineMode CM)
	Export (using an Importer).
void	removeEmptyProcessesInPlace (const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &newMap)

Xpetra specific
bool	hasMatrix () const
	Does this have an underlying matrix.
	TpetraCrsMatrix (const Teuchos::RCP< Tpetra::CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &mtx)
	TpetraCrsMatrix constructor to wrap a Tpetra::CrsMatrix object.
RCP< const Tpetra::CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > >	getTpetra_CrsMatrix () const
	Get the underlying Tpetra matrix.
RCP< Tpetra::CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > >	getTpetra_CrsMatrixNonConst () const
	Get the underlying Tpetra matrix.
local_matrix_type	getLocalMatrix () const
	Access the local Kokkos::CrsMatrix data.
void	setAllValues (const typename local_matrix_type::row_map_type &ptr, const typename local_matrix_type::StaticCrsGraphType::entries_type::non_const_type &ind, const typename local_matrix_type::values_type &val)
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.

Xpetra specific
local_matrix_type::HostMirror	getLocalMatrixHost () const
	Access the local Kokkos::CrsMatrix data.
local_matrix_type	getLocalMatrixDevice () const
	Access the local Kokkos::CrsMatrix data.
RCP< Tpetra::CrsMatrix< Scalar, int, int, EpetraNode > >	mtx_

Additional Inherited Members
Public Types inherited from Xpetra::CrsMatrix< Scalar, int, int, EpetraNode >
typedef Scalar	scalar_type
typedef int	local_ordinal_type
typedef int	global_ordinal_type
typedef EpetraNode	node_type
using	impl_scalar_type
using	execution_space
using	local_graph_type
using	local_matrix_type
	The specialization of Kokkos::CrsMatrix that represents the part of the sparse matrix on each MPI process. The same as for Tpetra.
Public Types inherited from Xpetra::RowMatrix< Scalar, int, int, EpetraNode >
typedef Scalar	scalar_type
typedef int	local_ordinal_type
typedef int	global_ordinal_type
typedef EpetraNode	node_type
virtual	~CrsMatrix ()
	Destructor.
virtual void	getLocalDiagCopy (Vector< Scalar, int, int, EpetraNode > &diag) const=0
	Get a copy of the diagonal entries owned by this node, with local row indices.
virtual void	replaceDiag (const Vector< Scalar, int, int, EpetraNode > &diag)=0
	Replace the diagonal entries of the matrix.
virtual void	leftScale (const Vector< Scalar, int, int, EpetraNode > &x)=0
	Left scale matrix using the given vector entries.
virtual void	rightScale (const Vector< Scalar, int, int, EpetraNode > &x)=0
	Right scale matrix using the given vector entries.
virtual	~RowMatrix ()
	Destructor.
virtual	~DistObject ()
	Destructor.
virtual void	beginImport (const DistObject< char, int, int, EpetraNode > &source, const Import< int, int, EpetraNode > &importer, CombineMode CM)
	Import data into this object using an Import object ("forward mode").
virtual void	endImport (const DistObject< char, int, int, EpetraNode > &source, const Import< int, int, EpetraNode > &importer, CombineMode CM)
	Import data into this object using an Import object ("forward mode").
virtual void	beginExport (const DistObject< char, int, int, EpetraNode > &source, const Export< int, int, EpetraNode > &exporter, CombineMode CM)
	Export data into this object using an Export object ("forward mode").
virtual void	endExport (const DistObject< char, int, int, EpetraNode > &source, const Export< int, int, EpetraNode > &exporter, CombineMode CM)
	Export data into this object using an Export object ("forward mode").
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

Detailed Description

template<class Scalar>
class Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >

Definition at line 476 of file Xpetra_TpetraCrsMatrix_decl.hpp.

Member Typedef Documentation

◆ LocalOrdinal

template<class Scalar>

typedef int Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::LocalOrdinal

private

Definition at line 479 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ GlobalOrdinal

template<class Scalar>

typedef int Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::GlobalOrdinal

private

Definition at line 480 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ Node

template<class Scalar>

typedef EpetraNode Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::Node

private

Definition at line 481 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ TpetraCrsMatrixClass

template<class Scalar>

typedef TpetraCrsMatrix<Scalar,LocalOrdinal,GlobalOrdinal,Node> Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::TpetraCrsMatrixClass

private

Definition at line 483 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ TpetraVectorClass

template<class Scalar>

typedef TpetraVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::TpetraVectorClass

private

Definition at line 484 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ TpetraImportClass

template<class Scalar>

typedef TpetraImport<LocalOrdinal,GlobalOrdinal,Node> Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::TpetraImportClass

private

Definition at line 485 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ TpetraExportClass

template<class Scalar>

typedef TpetraExport<LocalOrdinal,GlobalOrdinal,Node> Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::TpetraExportClass

private

Definition at line 486 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ local_matrix_type

template<class Scalar>

typedef Xpetra::CrsMatrix<Scalar,LocalOrdinal,GlobalOrdinal,Node>::local_matrix_type Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::local_matrix_type

private

Definition at line 490 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ CrsMatrix

using Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::CrsMatrix

private

◆ Vector

using Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::Vector

private

◆ SC

using Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::SC

private

Constructor & Destructor Documentation

◆ TpetraCrsMatrix() [1/13]

template<class Scalar>

Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::TpetraCrsMatrix	(	const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &	rowMap,
		size_t	maxNumEntriesPerRow,
		const Teuchos::RCP< Teuchos::ParameterList > &	params = Teuchos::null )

inline

Constructor specifying fixed number of entries for each row.

Definition at line 499 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ TpetraCrsMatrix() [2/13]

template<class Scalar>

Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::TpetraCrsMatrix	(	const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &	rowMap,
		const ArrayRCP< const size_t > &	NumEntriesPerRowToAlloc,
		const Teuchos::RCP< Teuchos::ParameterList > &	params = Teuchos::null )

inline

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

Definition at line 504 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ TpetraCrsMatrix() [3/13]

template<class Scalar>

Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::TpetraCrsMatrix	(	const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &	rowMap,
		const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &	colMap,
		size_t	maxNumEntriesPerRow,
		const Teuchos::RCP< Teuchos::ParameterList > &	params = Teuchos::null )

inline

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

Definition at line 509 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ TpetraCrsMatrix() [4/13]

template<class Scalar>

Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::TpetraCrsMatrix	(	const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &	rowMap,
		const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &	colMap,
		const ArrayRCP< const size_t > &	NumEntriesPerRowToAlloc,
		const Teuchos::RCP< Teuchos::ParameterList > &	params = Teuchos::null )

inline

Constructor specifying column Map and number of entries in each row.

Definition at line 514 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ TpetraCrsMatrix() [5/13]

template<class Scalar>

Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::TpetraCrsMatrix	(	const Teuchos::RCP< const CrsGraph< LocalOrdinal, GlobalOrdinal, Node > > &	graph,
		const Teuchos::RCP< Teuchos::ParameterList > &	params = Teuchos::null )

inline

Constructor specifying a previously constructed graph.

Definition at line 519 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ TpetraCrsMatrix() [6/13]

template<class Scalar>

Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::TpetraCrsMatrix	(	const Teuchos::RCP< const CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &	sourceMatrix,
		const Import< LocalOrdinal, GlobalOrdinal, Node > &	importer,
		const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &	domainMap = Teuchos::null,
		const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &	rangeMap = Teuchos::null,
		const Teuchos::RCP< Teuchos::ParameterList > &	params = Teuchos::null )

inline

Constructor for a fused import.

Definition at line 526 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ TpetraCrsMatrix() [7/13]

template<class Scalar>

Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::TpetraCrsMatrix	(	const Teuchos::RCP< const CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &	sourceMatrix,
		const Export< LocalOrdinal, GlobalOrdinal, Node > &	exporter,
		const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &	domainMap = Teuchos::null,
		const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &	rangeMap = Teuchos::null,
		const Teuchos::RCP< Teuchos::ParameterList > &	params = Teuchos::null )

inline

Constructor for a fused export.

Definition at line 535 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ TpetraCrsMatrix() [8/13]

template<class Scalar>

Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::TpetraCrsMatrix	(	const Teuchos::RCP< const CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &	sourceMatrix,
		const Import< LocalOrdinal, GlobalOrdinal, Node > &	RowImporter,
		const Teuchos::RCP< const Import< LocalOrdinal, GlobalOrdinal, Node > >	DomainImporter,
		const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &	domainMap,
		const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &	rangeMap,
		const Teuchos::RCP< Teuchos::ParameterList > &	params )

inline

Constructor for a fused import.

Definition at line 544 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ TpetraCrsMatrix() [9/13]

template<class Scalar>

Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::TpetraCrsMatrix	(	const Teuchos::RCP< const CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &	sourceMatrix,
		const Export< LocalOrdinal, GlobalOrdinal, Node > &	RowExporter,
		const Teuchos::RCP< const Export< LocalOrdinal, GlobalOrdinal, Node > >	DomainExporter,
		const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &	domainMap,
		const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &	rangeMap,
		const Teuchos::RCP< Teuchos::ParameterList > &	params )

inline

Constructor for a fused export.

Definition at line 555 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ TpetraCrsMatrix() [10/13]

template<class Scalar>

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

inline

Constructor specifying column Map and a local matrix, which the resulting CrsMatrix views.

Unlike most other CrsMatrix constructors, successful completion of this constructor will result in a fill-complete matrix.

Parameters

rowMap	[in] Distribution of rows of the matrix.
colMap	[in] Distribution of columns of the matrix.
lclMatrix	[in] A local CrsMatrix containing all local matrix values as well as a local graph. The graph's local row indices must come from the specified row Map, and its local column indices must come from the specified column Map.
params	[in/out] Optional list of parameters. If not null, any missing parameters will be filled in with their default values.

Definition at line 586 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ TpetraCrsMatrix() [11/13]

template<class Scalar>

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

inline

Constructor specifying local matrix and 4 maps.

Definition at line 594 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ ~TpetraCrsMatrix()

template<class Scalar>

virtual Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::~TpetraCrsMatrix ( )

inlinevirtual

Destructor.

Definition at line 606 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ TpetraCrsMatrix() [12/13]

template<class Scalar>

Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::TpetraCrsMatrix ( const TpetraCrsMatrix< Scalar, int, int, EpetraNode > & matrix )

inline

Deep copy constructor.

Definition at line 786 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ TpetraCrsMatrix() [13/13]

template<class Scalar>

Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::TpetraCrsMatrix ( const Teuchos::RCP< Tpetra::CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > & mtx )

inline

TpetraCrsMatrix constructor to wrap a Tpetra::CrsMatrix object.

Definition at line 838 of file Xpetra_TpetraCrsMatrix_decl.hpp.

Member Function Documentation

◆ insertGlobalValues()

template<class Scalar>

void Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::insertGlobalValues	(	GlobalOrdinal	globalRow,
		const ArrayView< const GlobalOrdinal > &	cols,
		const ArrayView< const Scalar > &	vals )

inlinevirtual

Insert matrix entries, using global IDs.

Implements Xpetra::CrsMatrix< Scalar, int, int, EpetraNode >.

Definition at line 614 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ insertLocalValues()

template<class Scalar>

void Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::insertLocalValues	(	LocalOrdinal	localRow,
		const ArrayView< const LocalOrdinal > &	cols,
		const ArrayView< const Scalar > &	vals )

inlinevirtual

Insert matrix entries, using local IDs.

Implements Xpetra::CrsMatrix< Scalar, int, int, EpetraNode >.

Definition at line 617 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ replaceGlobalValues()

template<class Scalar>

void Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::replaceGlobalValues	(	GlobalOrdinal	globalRow,
		const ArrayView< const GlobalOrdinal > &	cols,
		const ArrayView< const Scalar > &	vals )

inlinevirtual

Replace matrix entries, using global IDs.

Implements Xpetra::CrsMatrix< Scalar, int, int, EpetraNode >.

Definition at line 620 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ replaceLocalValues()

template<class Scalar>

void Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::replaceLocalValues	(	LocalOrdinal	localRow,
		const ArrayView< const LocalOrdinal > &	cols,
		const ArrayView< const Scalar > &	vals )

inlinevirtual

Replace matrix entries, using local IDs.

Implements Xpetra::CrsMatrix< Scalar, int, int, EpetraNode >.

Definition at line 624 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ setAllToScalar()

template<class Scalar>

void Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::setAllToScalar ( const Scalar & alpha )

inlinevirtual

Set all matrix entries equal to scalarThis.

Implements Xpetra::CrsMatrix< Scalar, int, int, EpetraNode >.

Definition at line 630 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ scale()

template<class Scalar>

void Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::scale ( const Scalar & alpha )

inlinevirtual

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

Implements Xpetra::CrsMatrix< Scalar, int, int, EpetraNode >.

Definition at line 633 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ allocateAllValues()

template<class Scalar>

void Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::allocateAllValues	(	size_t	numNonZeros,
		ArrayRCP< size_t > &	rowptr,
		ArrayRCP< LocalOrdinal > &	colind,
		ArrayRCP< Scalar > &	values )

inlinevirtual

Allocates and returns ArrayRCPs of the Crs arrays — This is an Xpetra-only routine.

Implements Xpetra::CrsMatrix< Scalar, int, int, EpetraNode >.

Definition at line 637 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ setAllValues() [1/2]

template<class Scalar>

void Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::setAllValues	(	const ArrayRCP< size_t > &	rowptr,
		const ArrayRCP< LocalOrdinal > &	colind,
		const ArrayRCP< Scalar > &	values )

inlinevirtual

Sets the 1D pointer arrays of the graph.

Implements Xpetra::CrsMatrix< Scalar, int, int, EpetraNode >.

Definition at line 640 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ getAllValues() [1/2]

template<class Scalar>

void Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::getAllValues	(	ArrayRCP< const size_t > &	rowptr,
		ArrayRCP< const LocalOrdinal > &	colind,
		ArrayRCP< const Scalar > &	values ) const

inlinevirtual

Gets the 1D pointer arrays of the graph.

Implements Xpetra::CrsMatrix< Scalar, int, int, EpetraNode >.

Definition at line 643 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ getAllValues() [2/2]

template<class Scalar>

void Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::getAllValues ( ArrayRCP< Scalar > & values )

inline

Gets the 1D pointer arrays of the graph.

Definition at line 646 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ haveGlobalConstants()

template<class Scalar>

bool Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::haveGlobalConstants ( ) const

inlinevirtual

Returns true if globalConstants have been computed; false otherwise.

Implements Xpetra::CrsMatrix< Scalar, int, int, EpetraNode >.

Definition at line 648 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ resumeFill()

template<class Scalar>

void Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::resumeFill ( const RCP< ParameterList > & params = null )

inlinevirtual

Implements Xpetra::CrsMatrix< Scalar, int, int, EpetraNode >.

Definition at line 656 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ fillComplete() [1/2]

template<class Scalar>

void Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::fillComplete	(	const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &	domainMap,
		const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &	rangeMap,
		const RCP< ParameterList > &	params = null )

inlinevirtual

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

Implements Xpetra::CrsMatrix< Scalar, int, int, EpetraNode >.

Definition at line 659 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ fillComplete() [2/2]

template<class Scalar>

void Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::fillComplete ( const RCP< ParameterList > & params = null )

inline

Signal that data entry is complete.

Definition at line 662 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ replaceDomainMapAndImporter()

template<class Scalar>

void Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::replaceDomainMapAndImporter	(	const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &	newDomainMap,
		Teuchos::RCP< const Import< LocalOrdinal, GlobalOrdinal, Node > > &	newImporter )

inlinevirtual

Replaces the current domainMap and importer with the user-specified objects.

Implements Xpetra::CrsMatrix< Scalar, int, int, EpetraNode >.

Definition at line 666 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ expertStaticFillComplete()

template<class Scalar>

void Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::expertStaticFillComplete	(	const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &	domainMap,
		const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &	rangeMap,
		const RCP< const Import< LocalOrdinal, GlobalOrdinal, Node > > &	importer = Teuchos::null,
		const RCP< const Export< LocalOrdinal, GlobalOrdinal, Node > > &	exporter = Teuchos::null,
		const RCP< ParameterList > &	params = Teuchos::null )

inlinevirtual

Expert static fill complete.

Implements Xpetra::CrsMatrix< Scalar, int, int, EpetraNode >.

Definition at line 669 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ getRowMap()

template<class Scalar>

const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::getRowMap ( ) const

inlinevirtual

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

Implements Xpetra::CrsMatrix< Scalar, int, int, EpetraNode >.

Definition at line 681 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ getColMap()

template<class Scalar>

const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::getColMap ( ) const

inlinevirtual

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

Implements Xpetra::CrsMatrix< Scalar, int, int, EpetraNode >.

Definition at line 684 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ getCrsGraph()

template<class Scalar>

RCP< const CrsGraph< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::getCrsGraph ( ) const

inlinevirtual

Returns the CrsGraph associated with this matrix.

Implements Xpetra::CrsMatrix< Scalar, int, int, EpetraNode >.

Definition at line 687 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ getGlobalNumRows()

template<class Scalar>

global_size_t Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::getGlobalNumRows ( ) const

inlinevirtual

Number of global elements in the row map of this matrix.

Implements Xpetra::CrsMatrix< Scalar, int, int, EpetraNode >.

Definition at line 690 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ getGlobalNumCols()

template<class Scalar>

global_size_t Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::getGlobalNumCols ( ) const

inlinevirtual

Number of global columns in the matrix.

Implements Xpetra::CrsMatrix< Scalar, int, int, EpetraNode >.

Definition at line 693 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ getLocalNumRows()

template<class Scalar>

size_t Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::getLocalNumRows ( ) const

inlinevirtual

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

Implements Xpetra::CrsMatrix< Scalar, int, int, EpetraNode >.

Definition at line 696 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ getLocalNumCols()

template<class Scalar>

size_t Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::getLocalNumCols ( ) const

inlinevirtual

Returns the number of columns connected to the locally owned rows of this matrix.

Implements Xpetra::CrsMatrix< Scalar, int, int, EpetraNode >.

Definition at line 699 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ getGlobalNumEntries()

template<class Scalar>

global_size_t Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::getGlobalNumEntries ( ) const

inlinevirtual

Returns the global number of entries in this matrix.

Implements Xpetra::CrsMatrix< Scalar, int, int, EpetraNode >.

Definition at line 702 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ getLocalNumEntries()

template<class Scalar>

size_t Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::getLocalNumEntries ( ) const

inlinevirtual

Returns the local number of entries in this matrix.

Implements Xpetra::CrsMatrix< Scalar, int, int, EpetraNode >.

Definition at line 705 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ getNumEntriesInLocalRow()

template<class Scalar>

size_t Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::getNumEntriesInLocalRow ( LocalOrdinal localRow ) const

inlinevirtual

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

Implements Xpetra::CrsMatrix< Scalar, int, int, EpetraNode >.

Definition at line 708 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ getNumEntriesInGlobalRow()

template<class Scalar>

size_t Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::getNumEntriesInGlobalRow ( GlobalOrdinal globalRow ) const

inlinevirtual

Returns the current number of entries in the (locally owned) global row.

Implements Xpetra::CrsMatrix< Scalar, int, int, EpetraNode >.

Definition at line 711 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ getGlobalMaxNumRowEntries()

template<class Scalar>

size_t Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::getGlobalMaxNumRowEntries ( ) const

inlinevirtual

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

Implements Xpetra::CrsMatrix< Scalar, int, int, EpetraNode >.

Definition at line 714 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ getLocalMaxNumRowEntries()

template<class Scalar>

size_t Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::getLocalMaxNumRowEntries ( ) const

inlinevirtual

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

Implements Xpetra::CrsMatrix< Scalar, int, int, EpetraNode >.

Definition at line 717 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ isLocallyIndexed()

template<class Scalar>

bool Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::isLocallyIndexed ( ) const

inlinevirtual

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

Implements Xpetra::CrsMatrix< Scalar, int, int, EpetraNode >.

Definition at line 720 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ isGloballyIndexed()

template<class Scalar>

bool Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::isGloballyIndexed ( ) const

inlinevirtual

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

Implements Xpetra::CrsMatrix< Scalar, int, int, EpetraNode >.

Definition at line 723 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ isFillComplete()

template<class Scalar>

bool Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::isFillComplete ( ) const

inlinevirtual

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

Implements Xpetra::CrsMatrix< Scalar, int, int, EpetraNode >.

Definition at line 726 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ isFillActive()

template<class Scalar>

bool Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::isFillActive ( ) const

inlinevirtual

Returns true if the matrix is in edit mode.

Implements Xpetra::CrsMatrix< Scalar, int, int, EpetraNode >.

Definition at line 729 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ getFrobeniusNorm()

template<class Scalar>

ScalarTraits< Scalar >::magnitudeType Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::getFrobeniusNorm ( ) const

inlinevirtual

Returns the Frobenius norm of the matrix.

Implements Xpetra::CrsMatrix< Scalar, int, int, EpetraNode >.

Definition at line 732 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ supportsRowViews()

template<class Scalar>

bool Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::supportsRowViews ( ) const

inlinevirtual

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

Implements Xpetra::CrsMatrix< Scalar, int, int, EpetraNode >.

Definition at line 735 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ getLocalRowCopy()

template<class Scalar>

void Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::getLocalRowCopy	(	LocalOrdinal	LocalRow,
		const ArrayView< LocalOrdinal > &	Indices,
		const ArrayView< Scalar > &	Values,
		size_t &	NumEntries ) const

inlinevirtual

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

Implements Xpetra::CrsMatrix< Scalar, int, int, EpetraNode >.

Definition at line 738 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ getGlobalRowView()

template<class Scalar>

void Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::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::CrsMatrix< Scalar, int, int, EpetraNode >.

Definition at line 741 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ getGlobalRowCopy()

template<class Scalar>

void Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::getGlobalRowCopy	(	GlobalOrdinal	GlobalRow,
		const ArrayView< GlobalOrdinal > &	indices,
		const ArrayView< Scalar > &	values,
		size_t &	numEntries ) const

inlinevirtual

Extract a list of entries in a specified global row of this matrix. Put into pre-allocated storage.

Implements Xpetra::CrsMatrix< Scalar, int, int, EpetraNode >.

Definition at line 744 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ getLocalRowView()

template<class Scalar>

void Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::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::CrsMatrix< Scalar, int, int, EpetraNode >.

Definition at line 747 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ apply() [1/2]

template<class Scalar>

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

inlinevirtual

Computes the sparse matrix-multivector multiplication.

Implements Xpetra::CrsMatrix< Scalar, int, int, EpetraNode >.

Definition at line 755 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ apply() [2/2]

template<class Scalar>

void Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::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< Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node > > &	regionInterfaceImporter,
		const Teuchos::ArrayRCP< LocalOrdinal > &	regionInterfaceLIDs ) const

inline

Computes the matrix-multivector multiplication for region layout matrices.

Definition at line 758 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ getDomainMap()

template<class Scalar>

const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::getDomainMap ( ) const

inlinevirtual

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

Implements Xpetra::CrsMatrix< Scalar, int, int, EpetraNode >.

Definition at line 761 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ getRangeMap()

template<class Scalar>

const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::getRangeMap ( ) const

inlinevirtual

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

Implements Xpetra::CrsMatrix< Scalar, int, int, EpetraNode >.

Definition at line 764 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ description()

template<class Scalar>

std::string Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::description ( ) const

inlinevirtual

A simple one-line description of this object.

Implements Xpetra::CrsMatrix< Scalar, int, int, EpetraNode >.

Definition at line 772 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ describe()

template<class Scalar>

void Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::describe	(	Teuchos::FancyOStream &	out,
		const Teuchos::EVerbosityLevel	verbLevel = Teuchos::Describable::verbLevel_default ) const

inlinevirtual

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

Implements Xpetra::CrsMatrix< Scalar, int, int, EpetraNode >.

Definition at line 775 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ setObjectLabel()

template<class Scalar>

void Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::setObjectLabel ( const std::string & objectLabel )

inlinevirtual

Implements Xpetra::CrsMatrix< Scalar, int, int, EpetraNode >.

Definition at line 781 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ getLocalDiagCopy() [1/2]

template<class Scalar>

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

inline

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

Definition at line 789 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ getLocalDiagOffsets()

template<class Scalar>

void Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::getLocalDiagOffsets ( Teuchos::ArrayRCP< size_t > & offsets ) const

inlinevirtual

Get offsets of the diagonal entries in the matrix.

Implements Xpetra::CrsMatrix< Scalar, int, int, EpetraNode >.

Definition at line 792 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ getLocalDiagCopy() [2/2]

template<class Scalar>

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

inline

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

Definition at line 795 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ replaceDiag()

template<class Scalar>

void Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::replaceDiag ( const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > & diag )

inline

Replace the diagonal entries of the matrix.

Definition at line 798 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ leftScale()

template<class Scalar>

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

inline

Left scale operator with given vector values.

Definition at line 801 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ rightScale()

template<class Scalar>

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

inline

Right scale operator with given vector values.

Definition at line 804 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ getMap()

template<class Scalar>

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

inlinevirtual

Implements DistObject interface.

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

Implements Xpetra::DistObject< char, int, int, EpetraNode >.

Definition at line 810 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ doImport() [1/2]

template<class Scalar>

void Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::doImport	(	const DistObject< char, LocalOrdinal, GlobalOrdinal, Node > &	source,
		const Import< LocalOrdinal, GlobalOrdinal, Node > &	importer,
		CombineMode	CM )

inlinevirtual

Import.

Implements Xpetra::DistObject< char, int, int, EpetraNode >.

Definition at line 813 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ doExport() [1/2]

template<class Scalar>

void Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::doExport	(	const DistObject< char, LocalOrdinal, GlobalOrdinal, Node > &	dest,
		const Import< LocalOrdinal, GlobalOrdinal, Node > &	importer,
		CombineMode	CM )

inline

Export.

Definition at line 817 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ doImport() [2/2]

template<class Scalar>

void Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::doImport	(	const DistObject< char, LocalOrdinal, GlobalOrdinal, Node > &	source,
		const Export< LocalOrdinal, GlobalOrdinal, Node > &	exporter,
		CombineMode	CM )

inline

Import (using an Exporter).

Definition at line 821 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ doExport() [2/2]

template<class Scalar>

void Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::doExport	(	const DistObject< char, LocalOrdinal, GlobalOrdinal, Node > &	dest,
		const Export< LocalOrdinal, GlobalOrdinal, Node > &	exporter,
		CombineMode	CM )

inlinevirtual

Export (using an Importer).

Implements Xpetra::DistObject< char, int, int, EpetraNode >.

Definition at line 825 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ removeEmptyProcessesInPlace()

template<class Scalar>

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

inlinevirtual

Implements Xpetra::CrsMatrix< Scalar, int, int, EpetraNode >.

Definition at line 828 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ hasMatrix()

template<class Scalar>

bool Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::hasMatrix ( ) const

inlinevirtual

Does this have an underlying matrix.

Implements Xpetra::CrsMatrix< Scalar, int, int, EpetraNode >.

Definition at line 835 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ getTpetra_CrsMatrix()

template<class Scalar>

RCP< const Tpetra::CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::getTpetra_CrsMatrix ( ) const

inline

Get the underlying Tpetra matrix.

Definition at line 843 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ getTpetra_CrsMatrixNonConst()

template<class Scalar>

RCP< Tpetra::CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::getTpetra_CrsMatrixNonConst ( ) const

inline

Get the underlying Tpetra matrix.

Definition at line 846 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ getLocalMatrix()

template<class Scalar>

local_matrix_type Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::getLocalMatrix ( ) const

inline

Access the local Kokkos::CrsMatrix data.

Definition at line 850 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ setAllValues() [2/2]

template<class Scalar>

void Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::setAllValues	(	const typename local_matrix_type::row_map_type &	ptr,
		const typename local_matrix_type::StaticCrsGraphType::entries_type::non_const_type &	ind,
		const typename local_matrix_type::values_type &	val )

inline

Definition at line 854 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ GetStorageBlockSize()

template<class Scalar>

LocalOrdinal Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::GetStorageBlockSize ( ) const

inlinevirtual

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

Implements Xpetra::CrsMatrix< Scalar, int, int, EpetraNode >.

Definition at line 860 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ residual()

template<class Scalar>

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

inlinevirtual

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

Implements Xpetra::CrsMatrix< Scalar, int, int, EpetraNode >.

Definition at line 863 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ getLocalMatrixHost()

local_matrix_type::HostMirror Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::getLocalMatrixHost ( ) const

inlinevirtual

Access the local Kokkos::CrsMatrix data.

Implements Xpetra::CrsMatrix< Scalar, int, int, EpetraNode >.

Definition at line 440 of file Xpetra_TpetraCrsMatrix_decl.hpp.

◆ getLocalMatrixDevice()

local_matrix_type Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::getLocalMatrixDevice ( ) const

inlinevirtual

Access the local Kokkos::CrsMatrix data.

Implements Xpetra::CrsMatrix< Scalar, int, int, EpetraNode >.

Definition at line 444 of file Xpetra_TpetraCrsMatrix_decl.hpp.

Member Data Documentation

◆ mtx_

RCP< Tpetra::CrsMatrix<Scalar, int, int, EpetraNode> > Xpetra::TpetraCrsMatrix< Scalar, int, int, EpetraNode >::mtx_

private

Definition at line 466 of file Xpetra_TpetraCrsMatrix_decl.hpp.

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

Private Types

Constructor/Destructor Methods

Insertion/Removal Methods

Transformational Methods

Methods implementing RowMatrix

Methods implementing Operator

Overridden from Teuchos::Describable

Overridden from Teuchos::LabeledObject

Xpetra specific

Xpetra specific

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ LocalOrdinal

◆ GlobalOrdinal

◆ Node

◆ TpetraCrsMatrixClass

◆ TpetraVectorClass

◆ TpetraImportClass

◆ TpetraExportClass

◆ local_matrix_type

◆ CrsMatrix

◆ Vector

◆ SC

Constructor & Destructor Documentation

◆ TpetraCrsMatrix() [1/13]

◆ TpetraCrsMatrix() [2/13]

◆ TpetraCrsMatrix() [3/13]

◆ TpetraCrsMatrix() [4/13]

◆ TpetraCrsMatrix() [5/13]

◆ TpetraCrsMatrix() [6/13]

◆ TpetraCrsMatrix() [7/13]

◆ TpetraCrsMatrix() [8/13]

◆ TpetraCrsMatrix() [9/13]

◆ TpetraCrsMatrix() [10/13]

◆ TpetraCrsMatrix() [11/13]

◆ ~TpetraCrsMatrix()

◆ TpetraCrsMatrix() [12/13]

◆ TpetraCrsMatrix() [13/13]

Member Function Documentation

◆ insertGlobalValues()

◆ insertLocalValues()

◆ replaceGlobalValues()

◆ replaceLocalValues()

◆ setAllToScalar()

◆ scale()

◆ allocateAllValues()

◆ setAllValues() [1/2]

◆ getAllValues() [1/2]

◆ getAllValues() [2/2]

◆ haveGlobalConstants()

◆ resumeFill()

◆ fillComplete() [1/2]

◆ fillComplete() [2/2]

◆ replaceDomainMapAndImporter()

◆ expertStaticFillComplete()

◆ getRowMap()

◆ getColMap()

◆ getCrsGraph()

◆ getGlobalNumRows()

◆ getGlobalNumCols()

◆ getLocalNumRows()

◆ getLocalNumCols()

◆ getGlobalNumEntries()

◆ getLocalNumEntries()

◆ getNumEntriesInLocalRow()

◆ getNumEntriesInGlobalRow()

◆ getGlobalMaxNumRowEntries()

◆ getLocalMaxNumRowEntries()

◆ isLocallyIndexed()

◆ isGloballyIndexed()

◆ isFillComplete()

◆ isFillActive()

◆ getFrobeniusNorm()

◆ supportsRowViews()

◆ getLocalRowCopy()

◆ getGlobalRowView()

◆ getGlobalRowCopy()

◆ getLocalRowView()

◆ apply() [1/2]