#include <Xpetra_MultiVector_decl.hpp>

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

Public Types
typedef Scalar	scalar_type

typedef LocalOrdinal	local_ordinal_type

typedef GlobalOrdinal	global_ordinal_type

typedef Node	node_type

Protected Member Functions
virtual void	assign (const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &rhs)=0
	Implementation of the assignment operator (operator=); does a deep copy. More...

Constructor/Destructor Methods
virtual	~MultiVector ()
	Destructor. More...

MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	operator= (const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &rhs)
	Assignment operator: Does a deep copy. More...

Post-construction modification routines
virtual void	replaceGlobalValue (GlobalOrdinal globalRow, size_t vectorIndex, const Scalar &value)=0
	Replace value, using global (row) index. More...

virtual void	sumIntoGlobalValue (GlobalOrdinal globalRow, size_t vectorIndex, const Scalar &value)=0
	Add value to existing value, using global (row) index. More...

virtual void	replaceLocalValue (LocalOrdinal myRow, size_t vectorIndex, const Scalar &value)=0
	Replace value, using local (row) index. More...

virtual void	sumIntoLocalValue (LocalOrdinal myRow, size_t vectorIndex, const Scalar &value)=0
	Add value to existing value, using local (row) index. More...

virtual void	putScalar (const Scalar &value)=0
	Set all values in the multivector with the given value. More...

Data Copy and View get methods
virtual Teuchos::RCP< const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > >	getVector (size_t j) const =0
	Return a Vector which is a const view of column j. More...

virtual Teuchos::RCP< Vector < Scalar, LocalOrdinal, GlobalOrdinal, Node > >	getVectorNonConst (size_t j)=0
	Return a Vector which is a nonconst view of column j. More...

virtual Teuchos::ArrayRCP < const Scalar >	getData (size_t j) const =0
	Const view of the local values in a particular vector of this multivector. More...

virtual Teuchos::ArrayRCP< Scalar >	getDataNonConst (size_t j)=0
	View of the local values in a particular vector of this multivector. More...

Mathematical methods
virtual void	dot (const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A, const Teuchos::ArrayView< Scalar > &dots) const =0
	Compute dot product of each corresponding pair of vectors, dots[i] = this[i].dot(A[i]). More...

virtual void	abs (const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A)=0
	Put element-wise absolute values of input Multi-vector in target: A = abs(this). More...

virtual void	reciprocal (const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A)=0
	Put element-wise reciprocal values of input Multi-vector in target, this(i,j) = 1/A(i,j). More...

virtual void	scale (const Scalar &alpha)=0
	Scale the current values of a multi-vector, this = alpha*this. More...

virtual void	scale (Teuchos::ArrayView< const Scalar > alpha)=0
	Scale the current values of a multi-vector, this[j] = alpha[j]*this[j]. More...

virtual void	update (const Scalar &alpha, const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A, const Scalar &beta)=0
	Update multi-vector values with scaled values of A, this = betathis + alphaA. More...

virtual 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)=0
	Update multi-vector with scaled values of A and B, this = gammathis + alphaA + beta*B. More...

virtual void	norm1 (const Teuchos::ArrayView< typename Teuchos::ScalarTraits< Scalar >::magnitudeType > &norms) const =0
	Compute 1-norm of each vector in multi-vector. More...

virtual void	norm2 (const Teuchos::ArrayView< typename Teuchos::ScalarTraits< Scalar >::magnitudeType > &norms) const =0

virtual void	normInf (const Teuchos::ArrayView< typename Teuchos::ScalarTraits< Scalar >::magnitudeType > &norms) const =0
	Compute Inf-norm of each vector in multi-vector. More...

virtual void	meanValue (const Teuchos::ArrayView< Scalar > &means) const =0

virtual 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)=0
	Matrix-matrix multiplication: this = betathis + alphaop(A)*op(B). More...

virtual void	elementWiseMultiply (Scalar scalarAB, const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A, const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &B, Scalar scalarThis)=0
	Multiply a Vector A elementwise by a MultiVector B. More...

Attribute access functions
virtual size_t	getNumVectors () const =0
	Number of columns in the multivector. More...

virtual size_t	getLocalLength () const =0
	Local number of rows on the calling process. More...

virtual global_size_t	getGlobalLength () const =0
	Global number of rows in the multivector. More...

virtual bool	isSameSize (const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &vec) const =0

Overridden from Teuchos::Describable
virtual std::string	description () const =0
	A simple one-line description of this object. More...

virtual void	describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const =0
	Print the object with the given verbosity level to a FancyOStream. More...

virtual void	replaceMap (const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node >> &map)=0

Xpetra specific
using	impl_scalar_type = typename Kokkos::ArithTraits< Scalar >::val_type

using	dual_view_type = Kokkos::DualView< impl_scalar_type **, Kokkos::LayoutStride, typename node_type::device_type, Kokkos::MemoryUnmanaged >

using	dual_view_type_const = Kokkos::DualView< const impl_scalar_type **, Kokkos::LayoutStride, typename node_type::device_type, Kokkos::MemoryUnmanaged >

using	host_execution_space = typename dual_view_type::host_mirror_space

using	dev_execution_space = typename dual_view_type::t_dev::execution_space

virtual void	setSeed (unsigned int seed)=0
	Set seed for Random function. More...

virtual void	randomize (bool bUseXpetraImplementation=false)=0
	Set multi-vector values to random numbers. More...

virtual void	randomize (const Scalar &minVal, const Scalar &maxVal, bool bUseXpetraImplementation=false)=0
	Set multi-vector values to random numbers. More...

virtual void	Xpetra_randomize ()
	Set multi-vector values to random numbers. XPetra implementation. More...

virtual void	Xpetra_randomize (const Scalar &minVal, const Scalar &maxVal)
	Set multi-vector values to random numbers. XPetra implementation. More...

virtual dual_view_type::t_host_const_um	getHostLocalView (Access::ReadOnlyStruct) const

virtual dual_view_type::t_dev_const_um	getDeviceLocalView (Access::ReadOnlyStruct) const

virtual dual_view_type::t_host_um	getHostLocalView (Access::OverwriteAllStruct) const

virtual dual_view_type::t_dev_um	getDeviceLocalView (Access::OverwriteAllStruct) const

virtual dual_view_type::t_host_um	getHostLocalView (Access::ReadWriteStruct) const

virtual dual_view_type::t_dev_um	getDeviceLocalView (Access::ReadWriteStruct) const

Detailed Description

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

Definition at line 40 of file Xpetra_MultiVector_decl.hpp.

Member Typedef Documentation

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

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

Definition at line 43 of file Xpetra_MultiVector_decl.hpp.

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

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

Definition at line 44 of file Xpetra_MultiVector_decl.hpp.

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

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

Definition at line 45 of file Xpetra_MultiVector_decl.hpp.

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

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

Definition at line 46 of file Xpetra_MultiVector_decl.hpp.

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

using Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::impl_scalar_type = typename Kokkos::ArithTraits<Scalar>::val_type

Definition at line 234 of file Xpetra_MultiVector_decl.hpp.

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

using Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::dual_view_type = Kokkos::DualView<impl_scalar_type**, Kokkos::LayoutStride, typename node_type::device_type, Kokkos::MemoryUnmanaged>

Definition at line 235 of file Xpetra_MultiVector_decl.hpp.

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

using Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::dual_view_type_const = Kokkos::DualView<const impl_scalar_type**, Kokkos::LayoutStride, typename node_type::device_type, Kokkos::MemoryUnmanaged>

Definition at line 236 of file Xpetra_MultiVector_decl.hpp.

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

using Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::host_execution_space = typename dual_view_type::host_mirror_space

Definition at line 237 of file Xpetra_MultiVector_decl.hpp.

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

using Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::dev_execution_space = typename dual_view_type::t_dev::execution_space

Definition at line 238 of file Xpetra_MultiVector_decl.hpp.

Constructor & Destructor Documentation

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

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

virtual

Destructor.

Definition at line 19 of file Xpetra_MultiVector_def.hpp.

Member Function Documentation

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

MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > & Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::operator= ( const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > & rhs )

Assignment operator: Does a deep copy.

The assignment operator does a deep copy, just like subclasses' copy constructors.

Note: This currently only works if both *this and the input argument are instances of the same subclass. We do not currently allow assignment between an Xpetra::TpetraMultiVector and an Xpetra::EpetraMultiVector, or vice versa, for example.

Definition at line 25 of file Xpetra_MultiVector_def.hpp.

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

virtual void Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::replaceGlobalValue	(	GlobalOrdinal	globalRow,
		size_t	vectorIndex,
		const Scalar &	value
	)

pure virtual

Replace value, using global (row) index.

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

virtual void Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::sumIntoGlobalValue	(	GlobalOrdinal	globalRow,
		size_t	vectorIndex,
		const Scalar &	value
	)

pure virtual

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

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

virtual void Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::replaceLocalValue	(	LocalOrdinal	myRow,
		size_t	vectorIndex,
		const Scalar &	value
	)

pure virtual

Replace value, using local (row) index.

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

virtual void Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::sumIntoLocalValue	(	LocalOrdinal	myRow,
		size_t	vectorIndex,
		const Scalar &	value
	)

pure virtual

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

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

virtual void Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::putScalar ( const Scalar & value )

pure virtual

Set all values in the multivector with the given value.

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

virtual Teuchos::RCP<const Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node> > Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getVector ( size_t j ) const

pure virtual

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

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

virtual Teuchos::RCP<Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node> > Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getVectorNonConst ( size_t j )

pure virtual

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

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

virtual Teuchos::ArrayRCP<const Scalar> Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getData ( size_t j ) const

pure virtual

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

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

virtual Teuchos::ArrayRCP<Scalar> Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getDataNonConst ( size_t j )

pure virtual

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

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

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

pure virtual

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

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

virtual void Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::abs ( const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > & A )

pure virtual

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

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

virtual void Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::reciprocal ( const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > & A )

pure virtual

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

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

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

pure virtual

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

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

virtual void Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::scale ( Teuchos::ArrayView< const Scalar > alpha )

pure virtual

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

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

virtual void Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::update	(	const Scalar &	alpha,
		const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	A,
		const Scalar &	beta
	)

pure virtual

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

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

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

pure virtual

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

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

virtual void Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::norm1 ( const Teuchos::ArrayView< typename Teuchos::ScalarTraits< Scalar >::magnitudeType > & norms ) const

pure virtual

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

Implemented in Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >, Xpetra::TpetraMultiVector< Scalar, int, int, EpetraNode >, Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >, Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

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

virtual void Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::norm2 ( const Teuchos::ArrayView< typename Teuchos::ScalarTraits< Scalar >::magnitudeType > & norms ) const

pure virtual

Implemented in Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >, Xpetra::TpetraMultiVector< Scalar, int, int, EpetraNode >, Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >, Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

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

virtual void Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::normInf ( const Teuchos::ArrayView< typename Teuchos::ScalarTraits< Scalar >::magnitudeType > & norms ) const

pure virtual

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

Implemented in Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >, Xpetra::TpetraMultiVector< Scalar, int, int, EpetraNode >, Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >, Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

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

virtual void Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::meanValue ( const Teuchos::ArrayView< Scalar > & means ) const

pure virtual

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

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

virtual void Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::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
	)

pure virtual

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

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

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

pure virtual

Multiply a Vector A elementwise by a MultiVector B.

Compute this = scalarThis * this + scalarAB * B @ A where </tt> denotes element-wise multiplication. In pseudocode, if C denotes *this MultiVector:


C(i,j) = scalarThis * C(i,j) + scalarAB * B(i,j) * A(i,1);

for all rows i and columns j of C.

B must have the same dimensions as *this, while A must have the same number of rows but a single column.

We do not require that A, B, and *this have compatible Maps, as long as the number of rows in A, B, and *this on each process is the same. For example, one or more of these vectors might have a locally replicated Map, or a Map with a local communicator (MPI_COMM_SELF). This case may occur in block relaxation algorithms when applying a diagonal scaling.


Parameters

  
    [in] scalarAB Scaling factor applied to result of elementwise multiplication of A and B 
    [in] A Vector A to be element-wise multiplied with B 
    [in] B MultiVector B to be element-wise multiplied with A 
    [in] scalarThis Scaling factor for existing values in *this<> MultiVector C

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

virtual size_t Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getNumVectors ( ) const

pure virtual

Number of columns in the multivector.

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

virtual size_t Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getLocalLength ( ) const

pure virtual

Local number of rows on the calling process.

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

virtual global_size_t Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getGlobalLength ( ) const

pure virtual

Global number of rows in the multivector.

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

virtual bool Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::isSameSize ( const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > & vec ) const

pure virtual

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

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

pure virtual

A simple one-line description of this object.

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

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

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

pure virtual

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

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

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

virtual void Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::replaceMap ( const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node >> & map )

pure virtual

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

virtual void Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::setSeed ( unsigned int seed )

pure virtual

Set seed for Random function.

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

virtual void Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::randomize ( bool bUseXpetraImplementation = false )

pure virtual

Set multi-vector values to random numbers.

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

virtual void Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::randomize	(	const Scalar &	minVal,
		const Scalar &	maxVal,
		bool	bUseXpetraImplementation = `false`
	)

pure virtual

Set multi-vector values to random numbers.

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

void Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Xpetra_randomize ( )

virtual

Set multi-vector values to random numbers. XPetra implementation.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 32 of file Xpetra_MultiVector_def.hpp.

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

void Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Xpetra_randomize	(	const Scalar &	minVal,
		const Scalar &	maxVal
	)

virtual

Set multi-vector values to random numbers. XPetra implementation.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 48 of file Xpetra_MultiVector_def.hpp.

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

virtual dual_view_type::t_host_const_um Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getHostLocalView ( Access::ReadOnlyStruct ) const

inlinevirtual

Reimplemented in Xpetra::EpetraMultiVectorT< int, EpetraNode >, Xpetra::EpetraIntVectorT< int, EpetraNode >, Xpetra::EpetraIntMultiVectorT< int, EpetraNode >, and Xpetra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 240 of file Xpetra_MultiVector_decl.hpp.

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

virtual dual_view_type::t_dev_const_um Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getDeviceLocalView ( Access::ReadOnlyStruct ) const

inlinevirtual

Reimplemented in Xpetra::EpetraMultiVectorT< int, EpetraNode >, Xpetra::EpetraIntVectorT< int, EpetraNode >, Xpetra::EpetraIntMultiVectorT< int, EpetraNode >, and Xpetra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 248 of file Xpetra_MultiVector_decl.hpp.

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

virtual dual_view_type::t_host_um Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getHostLocalView ( Access::OverwriteAllStruct ) const

inlinevirtual

Reimplemented in Xpetra::EpetraMultiVectorT< int, EpetraNode >, Xpetra::EpetraIntVectorT< int, EpetraNode >, Xpetra::EpetraIntMultiVectorT< int, EpetraNode >, and Xpetra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 256 of file Xpetra_MultiVector_decl.hpp.

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

virtual dual_view_type::t_dev_um Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getDeviceLocalView ( Access::OverwriteAllStruct ) const

inlinevirtual

Reimplemented in Xpetra::EpetraMultiVectorT< int, EpetraNode >, Xpetra::EpetraIntVectorT< int, EpetraNode >, Xpetra::EpetraIntMultiVectorT< int, EpetraNode >, and Xpetra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 264 of file Xpetra_MultiVector_decl.hpp.

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

virtual dual_view_type::t_host_um Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getHostLocalView ( Access::ReadWriteStruct ) const

inlinevirtual

Reimplemented in Xpetra::EpetraMultiVectorT< int, EpetraNode >, Xpetra::EpetraIntVectorT< int, EpetraNode >, Xpetra::EpetraIntMultiVectorT< int, EpetraNode >, and Xpetra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 272 of file Xpetra_MultiVector_decl.hpp.

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

virtual dual_view_type::t_dev_um Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getDeviceLocalView ( Access::ReadWriteStruct ) const

inlinevirtual

Reimplemented in Xpetra::EpetraMultiVectorT< int, EpetraNode >, Xpetra::EpetraIntVectorT< int, EpetraNode >, Xpetra::EpetraIntMultiVectorT< int, EpetraNode >, and Xpetra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 280 of file Xpetra_MultiVector_decl.hpp.

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

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

protectedpure virtual

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

Each subclass must implement this. This includes Xpetra::EpetraMultiVector and Xpetra::TpetraMultiVector.

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

[in]	scalarAB	Scaling factor applied to result of elementwise multiplication of A and B
[in]	A	Vector A to be element-wise multiplied with B
[in]	B	MultiVector B to be element-wise multiplied with A
[in]	scalarThis	Scaling factor for existing values in `*this<> MultiVector C`

Public Types

Protected Member Functions

Constructor/Destructor Methods

Post-construction modification routines

Data Copy and View get methods

Mathematical methods

Attribute access functions

Overridden from Teuchos::Describable

Xpetra specific

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

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