#include <Xpetra_TpetraMultiVector_def.hpp>

Inheritance diagram for Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >:

Private Types
typedef int	LocalOrdinal
typedef long long	GlobalOrdinal
typedef EpetraNode	Node
typedef TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >	TpetraMultiVectorClass

Constructors and destructor
	TpetraMultiVector (const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &map, size_t NumVectors, bool zeroOut=true)
	Basic constuctor.
	TpetraMultiVector (const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &source, const Teuchos::DataAccess copyOrView)
	Copy constructor (performs a deep copy).
	TpetraMultiVector (const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &map, const Teuchos::ArrayView< const Scalar > &A, size_t LDA, size_t NumVectors)
	Create multivector by copying two-dimensional array of local data.
	TpetraMultiVector (const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &map, const Teuchos::ArrayView< const Teuchos::ArrayView< const Scalar > > &ArrayOfPtrs, size_t NumVectors)
	Create multivector by copying array of views of local data.
virtual	~TpetraMultiVector ()
	Destructor (virtual for memory safety of derived classes).

Post-construction modification routines
void	replaceGlobalValue (GlobalOrdinal globalRow, size_t vectorIndex, const Scalar &value)
	Replace value, using global (row) index.
void	sumIntoGlobalValue (GlobalOrdinal globalRow, size_t vectorIndex, const Scalar &value)
	Add value to existing value, using global (row) index.
void	replaceLocalValue (LocalOrdinal myRow, size_t vectorIndex, const Scalar &value)
	Replace value, using local (row) index.
void	sumIntoLocalValue (LocalOrdinal myRow, size_t vectorIndex, const Scalar &value)
	Add value to existing value, using local (row) index.
void	putScalar (const Scalar &value)
	Set all values in the multivector with the given value.
void	reduce ()
	Sum values of a locally replicated multivector across all processes.

Data Copy and View get methods
Teuchos::RCP< const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > >	getVector (size_t j) const
	Return a Vector which is a const view of column j.
Teuchos::RCP< Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > >	getVectorNonConst (size_t j)
	Return a Vector which is a nonconst view of column j.
Teuchos::ArrayRCP< const Scalar >	getData (size_t j) const
	Const view of the local values in a particular vector of this multivector.
Teuchos::ArrayRCP< Scalar >	getDataNonConst (size_t j)
	View of the local values in a particular vector of this multivector.
void	get1dCopy (Teuchos::ArrayView< Scalar > A, size_t LDA) const
	Fill the given array with a copy of this multivector's local values.
void	get2dCopy (Teuchos::ArrayView< const Teuchos::ArrayView< Scalar > > ArrayOfPtrs) const
	Fill the given array with a copy of this multivector's local values.
Teuchos::ArrayRCP< const Scalar >	get1dView () const
	Const persisting (1-D) view of this multivector's local values.
Teuchos::ArrayRCP< Teuchos::ArrayRCP< const Scalar > >	get2dView () const
	Return const persisting pointers to values.
Teuchos::ArrayRCP< Scalar >	get1dViewNonConst ()
	Nonconst persisting (1-D) view of this multivector's local values.
Teuchos::ArrayRCP< Teuchos::ArrayRCP< Scalar > >	get2dViewNonConst ()
	Return non-const persisting pointers to values.

Mathematical methods
void	dot (const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A, const Teuchos::ArrayView< Scalar > &dots) const
	Compute dot product of each corresponding pair of vectors, dots[i] = this[i].dot(A[i]).
void	abs (const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A)
	Put element-wise absolute values of input Multi-vector in target: A = abs(this).
void	reciprocal (const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A)
	Put element-wise reciprocal values of input Multi-vector in target, this(i,j) = 1/A(i,j).
void	scale (const Scalar &alpha)
	Scale the current values of a multi-vector, this = alpha*this.
void	scale (Teuchos::ArrayView< const Scalar > alpha)
	Scale the current values of a multi-vector, this[j] = alpha[j]*this[j].
void	scale (const Scalar &alpha, const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A)
	Replace multi-vector values with scaled values of A, this = alpha*A.
void	update (const Scalar &alpha, const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A, const Scalar &beta)
	Update multi-vector values with scaled values of A, this = betathis + alphaA.
void	update (const Scalar &alpha, const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A, const Scalar &beta, const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &B, const Scalar &gamma)
	Update multi-vector with scaled values of A and B, this = gammathis + alphaA + beta*B.
void	norm1 (const Teuchos::ArrayView< typename Teuchos::ScalarTraits< Scalar >::magnitudeType > &norms) const
	Compute 1-norm of each vector in multi-vector.
void	norm2 (const Teuchos::ArrayView< typename Teuchos::ScalarTraits< Scalar >::magnitudeType > &norms) const
void	normInf (const Teuchos::ArrayView< typename Teuchos::ScalarTraits< Scalar >::magnitudeType > &norms) const
	Compute Inf-norm of each vector in multi-vector.
void	meanValue (const Teuchos::ArrayView< Scalar > &means) const
	Compute mean (average) value of each vector in multi-vector. The outcome of this routine is undefined for non-floating point scalar types (e.g., int).
void	multiply (Teuchos::ETransp transA, Teuchos::ETransp transB, const Scalar &alpha, const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A, const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &B, const Scalar &beta)
	Matrix-matrix multiplication: this = betathis + alphaop(A)*op(B).

Attribute access functions
size_t	getNumVectors () const
	Number of columns in the multivector.
size_t	getLocalLength () const
	Local number of rows on the calling process.
global_size_t	getGlobalLength () const
	Global number of rows in the multivector.
bool	isSameSize (const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &vec) const

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 the given verbosity level to a FancyOStream.
void	elementWiseMultiply (Scalar scalarAB, const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A, const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &B, Scalar scalarThis)
	Element-wise multiply of a Vector A with a TpetraMultiVector B.
void	randomize (bool bUseXpetraImplementation=false)
	Set multi-vector values to random numbers.
void	randomize (const Scalar &minVal, const Scalar &maxVal, bool bUseXpetraImplementation=false)
	Set multi-vector values to random numbers.
Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > >	getMap () const
	The Map describing the parallel distribution of this object.
void	doImport (const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > &source, const Import< LocalOrdinal, GlobalOrdinal, Node > &importer, CombineMode CM)
	Import data into this object using an Import object ("forward mode").
void	beginImport (const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > &source, const Import< LocalOrdinal, GlobalOrdinal, Node > &importer, CombineMode CM)
	Import data into this object using an Import object ("forward mode").
void	endImport (const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > &source, const Import< LocalOrdinal, GlobalOrdinal, Node > &importer, CombineMode CM)
	Import data into this object using an Import object ("forward mode").
void	doExport (const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > &dest, const Import< LocalOrdinal, GlobalOrdinal, Node > &importer, CombineMode CM)
void	beginExport (const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > &dest, const Import< LocalOrdinal, GlobalOrdinal, Node > &importer, CombineMode CM)
void	endExport (const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > &dest, const Import< LocalOrdinal, GlobalOrdinal, Node > &importer, CombineMode CM)
void	doImport (const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > &source, const Export< LocalOrdinal, GlobalOrdinal, Node > &exporter, CombineMode CM)
void	beginImport (const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > &source, const Export< LocalOrdinal, GlobalOrdinal, Node > &exporter, CombineMode CM)
void	endImport (const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > &source, const Export< LocalOrdinal, GlobalOrdinal, Node > &exporter, CombineMode CM)
void	doExport (const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > &dest, const Export< LocalOrdinal, GlobalOrdinal, Node > &exporter, CombineMode CM)
	Export data into this object using an Export object ("forward mode").
void	beginExport (const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > &dest, const Export< LocalOrdinal, GlobalOrdinal, Node > &exporter, CombineMode CM)
	Export data into this object using an Export object ("forward mode").
void	endExport (const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > &dest, const Export< LocalOrdinal, GlobalOrdinal, Node > &exporter, CombineMode CM)
	Export data into this object using an Export object ("forward mode").
void	replaceMap (const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &map)

Xpetra specific
	TpetraMultiVector (const Teuchos::RCP< Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &vec)
	TpetraMultiVector constructor to wrap a Tpetra::MultiVector object.
RCP< Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > >	getTpetra_MultiVector () const
	Get the underlying Tpetra multivector.
void	setSeed (unsigned int seed)
	Set seed for Random function.
virtual void	assign (const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &rhs)
	Implementation of the assignment operator (operator=); does a deep copy.

Xpetra specific
virtual dual_view_type::t_host_const_um	getHostLocalView (Access::ReadOnlyStruct) const
virtual dual_view_type::t_dev_const_um	getDeviceLocalView (Access::ReadOnlyStruct) const
typedef Xpetra::MultiVector< Scalar, int, long long, EpetraNode >::dual_view_type	dual_view_type
RCP< Tpetra::MultiVector< Scalar, int, long long, EpetraNode > >	vec_
	The Tpetra::MultiVector which this class wraps.

Additional Inherited Members
Public Types inherited from Xpetra::MultiVector< Scalar, int, long long, EpetraNode >
typedef Scalar	scalar_type
typedef int	local_ordinal_type
typedef long long	global_ordinal_type
typedef EpetraNode	node_type
using	impl_scalar_type
using	dual_view_type
using	dual_view_type_const
using	host_execution_space
using	dev_execution_space
virtual void	Xpetra_randomize ()
	Set multi-vector values to random numbers. XPetra implementation.
virtual	~MultiVector ()
	Destructor.
MultiVector< Scalar, int, long long, EpetraNode > &	operator= (const MultiVector< Scalar, int, long long, EpetraNode > &rhs)
	Assignment operator: Does a deep copy.
virtual	~DistObject ()
	Destructor.
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 void	setObjectLabel (const std::string &objectLabel)
virtual std::string	getObjectLabel () const
Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel	verbLevel_default

Detailed Description

template<class Scalar>
class Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >

Definition at line 862 of file Xpetra_TpetraMultiVector_def.hpp.

Member Typedef Documentation

◆ LocalOrdinal

template<class Scalar>

typedef int Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::LocalOrdinal

private

Definition at line 864 of file Xpetra_TpetraMultiVector_def.hpp.

◆ GlobalOrdinal

template<class Scalar>

typedef long long Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::GlobalOrdinal

private

Definition at line 865 of file Xpetra_TpetraMultiVector_def.hpp.

◆ Node

template<class Scalar>

typedef EpetraNode Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::Node

private

Definition at line 866 of file Xpetra_TpetraMultiVector_def.hpp.

◆ TpetraMultiVectorClass

template<class Scalar>

typedef TpetraMultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node> Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::TpetraMultiVectorClass

private

Definition at line 869 of file Xpetra_TpetraMultiVector_def.hpp.

◆ dual_view_type

typedef Xpetra::MultiVector<Scalar,int,long long,EpetraNode>::dual_view_type Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::dual_view_type

Definition at line 254 of file Xpetra_TpetraMultiVector_decl.hpp.

Constructor & Destructor Documentation

◆ TpetraMultiVector() [1/5]

template<class Scalar>

Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::TpetraMultiVector	(	const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &	map,
		size_t	NumVectors,
		bool	zeroOut = true )

inline

Basic constuctor.

Definition at line 876 of file Xpetra_TpetraMultiVector_def.hpp.

◆ TpetraMultiVector() [2/5]

template<class Scalar>

Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::TpetraMultiVector	(	const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	source,
		const Teuchos::DataAccess	copyOrView )

inline

Copy constructor (performs a deep copy).

Definition at line 881 of file Xpetra_TpetraMultiVector_def.hpp.

◆ TpetraMultiVector() [3/5]

template<class Scalar>

Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::TpetraMultiVector	(	const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &	map,
		const Teuchos::ArrayView< const Scalar > &	A,
		size_t	LDA,
		size_t	NumVectors )

inline

Create multivector by copying two-dimensional array of local data.

Definition at line 886 of file Xpetra_TpetraMultiVector_def.hpp.

◆ TpetraMultiVector() [4/5]

template<class Scalar>

Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::TpetraMultiVector	(	const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &	map,
		const Teuchos::ArrayView< const Teuchos::ArrayView< const Scalar > > &	ArrayOfPtrs,
		size_t	NumVectors )

inline

Create multivector by copying array of views of local data.

Definition at line 891 of file Xpetra_TpetraMultiVector_def.hpp.

◆ ~TpetraMultiVector()

template<class Scalar>

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

inlinevirtual

Destructor (virtual for memory safety of derived classes).

Definition at line 896 of file Xpetra_TpetraMultiVector_def.hpp.

◆ TpetraMultiVector() [5/5]

template<class Scalar>

Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::TpetraMultiVector ( const Teuchos::RCP< Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > & vec )

inline

TpetraMultiVector constructor to wrap a Tpetra::MultiVector object.

Definition at line 1076 of file Xpetra_TpetraMultiVector_def.hpp.

Member Function Documentation

◆ replaceGlobalValue()

template<class Scalar>

void Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::replaceGlobalValue	(	GlobalOrdinal	globalRow,
		size_t	vectorIndex,
		const Scalar &	value )

inlinevirtual

Replace value, using global (row) index.

Implements Xpetra::MultiVector< Scalar, int, long long, EpetraNode >.

Definition at line 904 of file Xpetra_TpetraMultiVector_def.hpp.

◆ sumIntoGlobalValue()

template<class Scalar>

void Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::sumIntoGlobalValue	(	GlobalOrdinal	globalRow,
		size_t	vectorIndex,
		const Scalar &	value )

inlinevirtual

Add value to existing value, using global (row) index.

Implements Xpetra::MultiVector< Scalar, int, long long, EpetraNode >.

Definition at line 907 of file Xpetra_TpetraMultiVector_def.hpp.

◆ replaceLocalValue()

template<class Scalar>

void Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::replaceLocalValue	(	LocalOrdinal	myRow,
		size_t	vectorIndex,
		const Scalar &	value )

inlinevirtual

Replace value, using local (row) index.

Implements Xpetra::MultiVector< Scalar, int, long long, EpetraNode >.

Definition at line 910 of file Xpetra_TpetraMultiVector_def.hpp.

◆ sumIntoLocalValue()

template<class Scalar>

void Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::sumIntoLocalValue	(	LocalOrdinal	myRow,
		size_t	vectorIndex,
		const Scalar &	value )

inlinevirtual

Add value to existing value, using local (row) index.

Implements Xpetra::MultiVector< Scalar, int, long long, EpetraNode >.

Definition at line 913 of file Xpetra_TpetraMultiVector_def.hpp.

◆ putScalar()

template<class Scalar>

void Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::putScalar ( const Scalar & value )

inlinevirtual

Set all values in the multivector with the given value.

Implements Xpetra::MultiVector< Scalar, int, long long, EpetraNode >.

Definition at line 916 of file Xpetra_TpetraMultiVector_def.hpp.

◆ reduce()

template<class Scalar>

void Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::reduce ( )

inline

Sum values of a locally replicated multivector across all processes.

Definition at line 919 of file Xpetra_TpetraMultiVector_def.hpp.

◆ getVector()

template<class Scalar>

Teuchos::RCP< const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::getVector ( size_t j ) const

inlinevirtual

Return a Vector which is a const view of column j.

Implements Xpetra::MultiVector< Scalar, int, long long, EpetraNode >.

Definition at line 927 of file Xpetra_TpetraMultiVector_def.hpp.

◆ getVectorNonConst()

template<class Scalar>

Teuchos::RCP< Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::getVectorNonConst ( size_t j )

inlinevirtual

Return a Vector which is a nonconst view of column j.

Implements Xpetra::MultiVector< Scalar, int, long long, EpetraNode >.

Definition at line 930 of file Xpetra_TpetraMultiVector_def.hpp.

◆ getData()

template<class Scalar>

Teuchos::ArrayRCP< const Scalar > Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::getData ( size_t j ) const

inlinevirtual

Const view of the local values in a particular vector of this multivector.

Implements Xpetra::MultiVector< Scalar, int, long long, EpetraNode >.

Definition at line 933 of file Xpetra_TpetraMultiVector_def.hpp.

◆ getDataNonConst()

template<class Scalar>

Teuchos::ArrayRCP< Scalar > Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::getDataNonConst ( size_t j )

inlinevirtual

View of the local values in a particular vector of this multivector.

Implements Xpetra::MultiVector< Scalar, int, long long, EpetraNode >.

Definition at line 936 of file Xpetra_TpetraMultiVector_def.hpp.

◆ get1dCopy()

template<class Scalar>

void Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::get1dCopy	(	Teuchos::ArrayView< Scalar >	A,
		size_t	LDA ) const

inline

Fill the given array with a copy of this multivector's local values.

Definition at line 939 of file Xpetra_TpetraMultiVector_def.hpp.

◆ get2dCopy()

template<class Scalar>

void Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::get2dCopy ( Teuchos::ArrayView< const Teuchos::ArrayView< Scalar > > ArrayOfPtrs ) const

inline

Fill the given array with a copy of this multivector's local values.

Definition at line 942 of file Xpetra_TpetraMultiVector_def.hpp.

◆ get1dView()

template<class Scalar>

Teuchos::ArrayRCP< const Scalar > Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::get1dView ( ) const

inline

Const persisting (1-D) view of this multivector's local values.

Definition at line 945 of file Xpetra_TpetraMultiVector_def.hpp.

◆ get2dView()

template<class Scalar>

Teuchos::ArrayRCP< Teuchos::ArrayRCP< const Scalar > > Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::get2dView ( ) const

inline

Return const persisting pointers to values.

Definition at line 948 of file Xpetra_TpetraMultiVector_def.hpp.

◆ get1dViewNonConst()

template<class Scalar>

Teuchos::ArrayRCP< Scalar > Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::get1dViewNonConst ( )

inline

Nonconst persisting (1-D) view of this multivector's local values.

Definition at line 951 of file Xpetra_TpetraMultiVector_def.hpp.

◆ get2dViewNonConst()

template<class Scalar>

Teuchos::ArrayRCP< Teuchos::ArrayRCP< Scalar > > Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::get2dViewNonConst ( )

inline

Return non-const persisting pointers to values.

Definition at line 954 of file Xpetra_TpetraMultiVector_def.hpp.

◆ dot()

template<class Scalar>

void Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::dot	(	const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	A,
		const Teuchos::ArrayView< Scalar > &	dots ) const

inlinevirtual

Compute dot product of each corresponding pair of vectors, dots[i] = this[i].dot(A[i]).

Implements Xpetra::MultiVector< Scalar, int, long long, EpetraNode >.

Definition at line 962 of file Xpetra_TpetraMultiVector_def.hpp.

◆ abs()

template<class Scalar>

void Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::abs ( const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > & A )

inlinevirtual

Put element-wise absolute values of input Multi-vector in target: A = abs(this).

Implements Xpetra::MultiVector< Scalar, int, long long, EpetraNode >.

Definition at line 965 of file Xpetra_TpetraMultiVector_def.hpp.

◆ reciprocal()

template<class Scalar>

void Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::reciprocal ( const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > & A )

inlinevirtual

Put element-wise reciprocal values of input Multi-vector in target, this(i,j) = 1/A(i,j).

Implements Xpetra::MultiVector< Scalar, int, long long, EpetraNode >.

Definition at line 968 of file Xpetra_TpetraMultiVector_def.hpp.

◆ scale() [1/3]

template<class Scalar>

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

inlinevirtual

Scale the current values of a multi-vector, this = alpha*this.

Implements Xpetra::MultiVector< Scalar, int, long long, EpetraNode >.

Definition at line 971 of file Xpetra_TpetraMultiVector_def.hpp.

◆ scale() [2/3]

template<class Scalar>

void Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::scale ( Teuchos::ArrayView< const Scalar > alpha )

inline

Scale the current values of a multi-vector, this[j] = alpha[j]*this[j].

Definition at line 974 of file Xpetra_TpetraMultiVector_def.hpp.

◆ scale() [3/3]

template<class Scalar>

void Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::scale	(	const Scalar &	alpha,
		const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	A )

inline

Replace multi-vector values with scaled values of A, this = alpha*A.

Definition at line 977 of file Xpetra_TpetraMultiVector_def.hpp.

◆ update() [1/2]

template<class Scalar>

void Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::update	(	const Scalar &	alpha,
		const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	A,
		const Scalar &	beta )

inlinevirtual

Update multi-vector values with scaled values of A, this = beta*this + alpha*A.

Implements Xpetra::MultiVector< Scalar, int, long long, EpetraNode >.

Definition at line 980 of file Xpetra_TpetraMultiVector_def.hpp.

◆ update() [2/2]

template<class Scalar>

void Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::update	(	const Scalar &	alpha,
		const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	A,
		const Scalar &	beta,
		const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	B,
		const Scalar &	gamma )

inline

Update multi-vector with scaled values of A and B, this = gamma*this + alpha*A + beta*B.

Definition at line 983 of file Xpetra_TpetraMultiVector_def.hpp.

◆ norm1()

template<class Scalar>

void Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::norm1 ( const Teuchos::ArrayView< typename Teuchos::ScalarTraits< Scalar >::magnitudeType > & norms ) const

inlinevirtual

Compute 1-norm of each vector in multi-vector.

Implements Xpetra::MultiVector< Scalar, int, long long, EpetraNode >.

Definition at line 986 of file Xpetra_TpetraMultiVector_def.hpp.

◆ norm2()

template<class Scalar>

void Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::norm2 ( const Teuchos::ArrayView< typename Teuchos::ScalarTraits< Scalar >::magnitudeType > & norms ) const

inlinevirtual

Implements Xpetra::MultiVector< Scalar, int, long long, EpetraNode >.

Definition at line 989 of file Xpetra_TpetraMultiVector_def.hpp.

◆ normInf()

template<class Scalar>

void Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::normInf ( const Teuchos::ArrayView< typename Teuchos::ScalarTraits< Scalar >::magnitudeType > & norms ) const

inlinevirtual

Compute Inf-norm of each vector in multi-vector.

Implements Xpetra::MultiVector< Scalar, int, long long, EpetraNode >.

Definition at line 992 of file Xpetra_TpetraMultiVector_def.hpp.

◆ meanValue()

template<class Scalar>

void Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::meanValue ( const Teuchos::ArrayView< Scalar > & means ) const

inlinevirtual

Compute mean (average) value of each vector in multi-vector. The outcome of this routine is undefined for non-floating point scalar types (e.g., int).

Implements Xpetra::MultiVector< Scalar, int, long long, EpetraNode >.

Definition at line 995 of file Xpetra_TpetraMultiVector_def.hpp.

◆ multiply()

template<class Scalar>

void Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::multiply	(	Teuchos::ETransp	transA,
		Teuchos::ETransp	transB,
		const Scalar &	alpha,
		const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	A,
		const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	B,
		const Scalar &	beta )

inlinevirtual

Matrix-matrix multiplication: this = beta*this + alpha*op(A)*op(B).

Implements Xpetra::MultiVector< Scalar, int, long long, EpetraNode >.

Definition at line 998 of file Xpetra_TpetraMultiVector_def.hpp.

◆ getNumVectors()

template<class Scalar>

size_t Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::getNumVectors ( ) const

inlinevirtual

Number of columns in the multivector.

Implements Xpetra::MultiVector< Scalar, int, long long, EpetraNode >.

Definition at line 1006 of file Xpetra_TpetraMultiVector_def.hpp.

◆ getLocalLength()

template<class Scalar>

size_t Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::getLocalLength ( ) const

inlinevirtual

Local number of rows on the calling process.

Implements Xpetra::MultiVector< Scalar, int, long long, EpetraNode >.

Definition at line 1009 of file Xpetra_TpetraMultiVector_def.hpp.

◆ getGlobalLength()

template<class Scalar>

global_size_t Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::getGlobalLength ( ) const

inlinevirtual

Global number of rows in the multivector.

Implements Xpetra::MultiVector< Scalar, int, long long, EpetraNode >.

Definition at line 1012 of file Xpetra_TpetraMultiVector_def.hpp.

◆ isSameSize()

template<class Scalar>

bool Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::isSameSize ( const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > & vec ) const

inlinevirtual

Implements Xpetra::MultiVector< Scalar, int, long long, EpetraNode >.

Definition at line 1015 of file Xpetra_TpetraMultiVector_def.hpp.

◆ description()

template<class Scalar>

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

inlinevirtual

A simple one-line description of this object.

Implements Xpetra::MultiVector< Scalar, int, long long, EpetraNode >.

Reimplemented in Xpetra::TpetraVector< Scalar, int, long long, EpetraNode >.

Definition at line 1023 of file Xpetra_TpetraMultiVector_def.hpp.

◆ describe()

template<class Scalar>

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

inlinevirtual

Print the object with the given verbosity level to a FancyOStream.

Implements Xpetra::MultiVector< Scalar, int, long long, EpetraNode >.

Reimplemented in Xpetra::TpetraVector< Scalar, int, long long, EpetraNode >.

Definition at line 1026 of file Xpetra_TpetraMultiVector_def.hpp.

◆ elementWiseMultiply()

template<class Scalar>

void Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::elementWiseMultiply	(	Scalar	scalarAB,
		const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	A,
		const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	B,
		Scalar	scalarThis )

inlinevirtual

Element-wise multiply of a Vector A with a TpetraMultiVector B.

Implements Xpetra::MultiVector< Scalar, int, long long, EpetraNode >.

Definition at line 1031 of file Xpetra_TpetraMultiVector_def.hpp.

◆ randomize() [1/2]

template<class Scalar>

void Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::randomize ( bool bUseXpetraImplementation = false )

inlinevirtual

Set multi-vector values to random numbers.

Implements Xpetra::MultiVector< Scalar, int, long long, EpetraNode >.

Definition at line 1034 of file Xpetra_TpetraMultiVector_def.hpp.

◆ randomize() [2/2]

template<class Scalar>

void Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::randomize	(	const Scalar &	minVal,
		const Scalar &	maxVal,
		bool	bUseXpetraImplementation = false )

inline

Set multi-vector values to random numbers.

Definition at line 1037 of file Xpetra_TpetraMultiVector_def.hpp.

◆ getMap()

template<class Scalar>

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

inlinevirtual

The Map describing the parallel distribution of this object.

Implements Xpetra::DistObject< Scalar, int, long long, EpetraNode >.

Definition at line 1042 of file Xpetra_TpetraMultiVector_def.hpp.

◆ doImport() [1/2]

template<class Scalar>

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

inlinevirtual

Import data into this object using an Import object ("forward mode").

Implements Xpetra::DistObject< Scalar, int, long long, EpetraNode >.

Definition at line 1044 of file Xpetra_TpetraMultiVector_def.hpp.

◆ beginImport() [1/2]

template<class Scalar>

void Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::beginImport	(	const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	source,
		const Import< LocalOrdinal, GlobalOrdinal, Node > &	importer,
		CombineMode	CM )

inlinevirtual

Import data into this object using an Import object ("forward mode").

Reimplemented from Xpetra::DistObject< Scalar, int, long long, EpetraNode >.

Definition at line 1046 of file Xpetra_TpetraMultiVector_def.hpp.

◆ endImport() [1/2]

template<class Scalar>

void Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::endImport	(	const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	source,
		const Import< LocalOrdinal, GlobalOrdinal, Node > &	importer,
		CombineMode	CM )

inlinevirtual

Import data into this object using an Import object ("forward mode").

Reimplemented from Xpetra::DistObject< Scalar, int, long long, EpetraNode >.

Definition at line 1048 of file Xpetra_TpetraMultiVector_def.hpp.

◆ doExport() [1/2]

template<class Scalar>

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

inline

Definition at line 1050 of file Xpetra_TpetraMultiVector_def.hpp.

◆ beginExport() [1/2]

template<class Scalar>

void Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::beginExport	(	const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	dest,
		const Import< LocalOrdinal, GlobalOrdinal, Node > &	importer,
		CombineMode	CM )

inline

Definition at line 1052 of file Xpetra_TpetraMultiVector_def.hpp.

◆ endExport() [1/2]

template<class Scalar>

void Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::endExport	(	const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	dest,
		const Import< LocalOrdinal, GlobalOrdinal, Node > &	importer,
		CombineMode	CM )

inline

Definition at line 1054 of file Xpetra_TpetraMultiVector_def.hpp.

◆ doImport() [2/2]

template<class Scalar>

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

inline

Definition at line 1056 of file Xpetra_TpetraMultiVector_def.hpp.

◆ beginImport() [2/2]

template<class Scalar>

void Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::beginImport	(	const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	source,
		const Export< LocalOrdinal, GlobalOrdinal, Node > &	exporter,
		CombineMode	CM )

inline

Definition at line 1058 of file Xpetra_TpetraMultiVector_def.hpp.

◆ endImport() [2/2]

template<class Scalar>

void Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::endImport	(	const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	source,
		const Export< LocalOrdinal, GlobalOrdinal, Node > &	exporter,
		CombineMode	CM )

inline

Definition at line 1060 of file Xpetra_TpetraMultiVector_def.hpp.

◆ doExport() [2/2]

template<class Scalar>

void Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::doExport	(	const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	source,
		const Export< LocalOrdinal, GlobalOrdinal, Node > &	exporter,
		CombineMode	CM )

inlinevirtual

Export data into this object using an Export object ("forward mode").

Implements Xpetra::DistObject< Scalar, int, long long, EpetraNode >.

Definition at line 1062 of file Xpetra_TpetraMultiVector_def.hpp.

◆ beginExport() [2/2]

template<class Scalar>

void Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::beginExport	(	const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	source,
		const Export< LocalOrdinal, GlobalOrdinal, Node > &	exporter,
		CombineMode	CM )

inlinevirtual

Export data into this object using an Export object ("forward mode").

Reimplemented from Xpetra::DistObject< Scalar, int, long long, EpetraNode >.

Definition at line 1064 of file Xpetra_TpetraMultiVector_def.hpp.

◆ endExport() [2/2]

template<class Scalar>

void Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::endExport	(	const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	source,
		const Export< LocalOrdinal, GlobalOrdinal, Node > &	exporter,
		CombineMode	CM )

inlinevirtual

Export data into this object using an Export object ("forward mode").

Reimplemented from Xpetra::DistObject< Scalar, int, long long, EpetraNode >.

Definition at line 1066 of file Xpetra_TpetraMultiVector_def.hpp.

◆ replaceMap()

template<class Scalar>

void Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::replaceMap ( const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > & map )

inlinevirtual

Implements Xpetra::MultiVector< Scalar, int, long long, EpetraNode >.

Definition at line 1068 of file Xpetra_TpetraMultiVector_def.hpp.

◆ getTpetra_MultiVector()

template<class Scalar>

RCP< Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::getTpetra_MultiVector ( ) const

inline

Get the underlying Tpetra multivector.

Definition at line 1081 of file Xpetra_TpetraMultiVector_def.hpp.

◆ setSeed()

template<class Scalar>

void Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::setSeed ( unsigned int seed )

inlinevirtual

Set seed for Random function.

Implements Xpetra::MultiVector< Scalar, int, long long, EpetraNode >.

Definition at line 1084 of file Xpetra_TpetraMultiVector_def.hpp.

◆ assign()

template<class Scalar>

virtual void Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::assign ( const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > & rhs )

inlineprotectedvirtual

Implementation of the assignment operator (operator=); does a deep copy.

Implements Xpetra::MultiVector< Scalar, int, long long, EpetraNode >.

Definition at line 1092 of file Xpetra_TpetraMultiVector_def.hpp.

◆ getHostLocalView()

TpetraMultiVector< Scalar, int, long long, EpetraNode >::dual_view_type::t_host_const_um Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::getHostLocalView ( Access::ReadOnlyStruct ) const

virtual

Reimplemented from Xpetra::MultiVector< Scalar, int, long long, EpetraNode >.

Definition at line 256 of file Xpetra_TpetraMultiVector_def.hpp.

◆ getDeviceLocalView()

TpetraMultiVector< Scalar, int, long long, EpetraNode >::dual_view_type::t_dev_const_um Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::getDeviceLocalView ( Access::ReadOnlyStruct ) const

virtual

Reimplemented from Xpetra::MultiVector< Scalar, int, long long, EpetraNode >.

Definition at line 258 of file Xpetra_TpetraMultiVector_def.hpp.

Member Data Documentation

◆ vec_

RCP<Tpetra::MultiVector<Scalar, int, long long, EpetraNode> > Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >::vec_

private

The Tpetra::MultiVector which this class wraps.

Definition at line 276 of file Xpetra_TpetraMultiVector_decl.hpp.

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

Xpetra_TpetraMultiVector_def.hpp

Private Types

Constructors and destructor

Post-construction modification routines

Data Copy and View get methods

Mathematical methods

Attribute access functions

Overridden from Teuchos::Describable

Xpetra specific

Xpetra specific

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ LocalOrdinal

◆ GlobalOrdinal

◆ Node

◆ TpetraMultiVectorClass

◆ dual_view_type

Constructor & Destructor Documentation

◆ TpetraMultiVector() [1/5]

◆ TpetraMultiVector() [2/5]

◆ TpetraMultiVector() [3/5]

◆ TpetraMultiVector() [4/5]

◆ ~TpetraMultiVector()

◆ TpetraMultiVector() [5/5]

Member Function Documentation

◆ replaceGlobalValue()

◆ sumIntoGlobalValue()

◆ replaceLocalValue()

◆ sumIntoLocalValue()

◆ putScalar()

◆ reduce()

◆ getVector()

◆ getVectorNonConst()

◆ getData()

◆ getDataNonConst()

◆ get1dCopy()

◆ get2dCopy()

◆ get1dView()

◆ get2dView()

◆ get1dViewNonConst()

◆ get2dViewNonConst()

◆ dot()

◆ abs()

◆ reciprocal()

◆ scale() [1/3]

◆ scale() [2/3]

◆ scale() [3/3]

◆ update() [1/2]

◆ update() [2/2]

◆ norm1()

◆ norm2()

◆ normInf()

◆ meanValue()

◆ multiply()

◆ getNumVectors()

◆ getLocalLength()

◆ getGlobalLength()

◆ isSameSize()

◆ description()

◆ describe()

◆ elementWiseMultiply()

◆ randomize() [1/2]

◆ randomize() [2/2]

◆ getMap()

◆ doImport() [1/2]

◆ beginImport() [1/2]

◆ endImport() [1/2]

◆ doExport() [1/2]

◆ beginExport() [1/2]

◆ endExport() [1/2]

◆ doImport() [2/2]

◆ beginImport() [2/2]

◆ endImport() [2/2]

◆ doExport() [2/2]

◆ beginExport() [2/2]

◆ endExport() [2/2]

◆ replaceMap()

◆ getTpetra_MultiVector()

◆ setSeed()

◆ assign()