Xpetra  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > Class Template Referenceabstract

#include <Xpetra_MultiVector_decl.hpp>

Inheritance diagram for Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >:
Xpetra::DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > Xpetra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > Xpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > Xpetra::ReorderedBlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > Xpetra::TpetraVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > Xpetra::TpetraVector< 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 = beta*this + alpha*A. 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 = gamma*this + alpha*A + 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 = beta*this + alpha*op(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

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 Xpetra_randomize ()
 Set multi-vector values to random numbers. XPetra implementation. More...
 

Detailed Description

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

Definition at line 78 of file Xpetra_MultiVector_decl.hpp.

Member Typedef Documentation

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

Definition at line 84 of file Xpetra_MultiVector_decl.hpp.

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

Definition at line 85 of file Xpetra_MultiVector_decl.hpp.

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

Definition at line 86 of file Xpetra_MultiVector_decl.hpp.

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

Definition at line 87 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 57 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 65 of file Xpetra_MultiVector_def.hpp.

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual void Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::norm1 ( const Teuchos::ArrayView< typename Teuchos::ScalarTraits< Scalar >::magnitudeType > &  norms) const
pure virtual
template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual void Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::norm2 ( const Teuchos::ArrayView< typename Teuchos::ScalarTraits< Scalar >::magnitudeType > &  norms) const
pure virtual
template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual void Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::normInf ( const Teuchos::ArrayView< typename Teuchos::ScalarTraits< Scalar >::magnitudeType > &  norms) const
pure virtual
template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node = 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
template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node = 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]scalarABScaling factor applied to result of elementwise multiplication of A and B
[in]AVector A to be element-wise multiplied with B
[in]BMultiVector B to be element-wise multiplied with A
[in]scalarThisScaling factor for existing values in *this<> MultiVector C

Implemented in Xpetra::EpetraIntVectorT< long long, EpetraNode >, Xpetra::EpetraIntMultiVectorT< long long, EpetraNode >, Xpetra::EpetraMultiVectorT< long long, EpetraNode >, Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >, Xpetra::TpetraMultiVector< Scalar, int, int, EpetraNode >, Xpetra::EpetraIntVectorT< int, EpetraNode >, Xpetra::EpetraIntMultiVectorT< int, EpetraNode >, Xpetra::EpetraMultiVectorT< int, EpetraNode >, Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >, Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >, Xpetra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >, Xpetra::EpetraIntMultiVectorT< EpetraGlobalOrdinal, Node >, Xpetra::EpetraIntVectorT< GO, NO >, and Xpetra::EpetraMultiVectorT< EpetraGlobalOrdinal, Node >.

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node = 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 >.

Implemented in Xpetra::EpetraIntMultiVectorT< long long, EpetraNode >, Xpetra::EpetraIntVectorT< long long, EpetraNode >, Xpetra::EpetraMultiVectorT< long long, EpetraNode >, Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >, Xpetra::TpetraMultiVector< Scalar, int, int, EpetraNode >, Xpetra::EpetraIntMultiVectorT< int, EpetraNode >, Xpetra::EpetraIntVectorT< int, EpetraNode >, Xpetra::TpetraVector< Scalar, int, long long, EpetraNode >, Xpetra::EpetraMultiVectorT< int, EpetraNode >, Xpetra::EpetraVectorT< long long, EpetraNode >, Xpetra::TpetraVector< Scalar, int, int, EpetraNode >, Xpetra::EpetraVectorT< int, EpetraNode >, Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >, Xpetra::EpetraIntMultiVectorT< EpetraGlobalOrdinal, Node >, Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >, Xpetra::EpetraIntVectorT< GO, NO >, Xpetra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >, Xpetra::EpetraMultiVectorT< EpetraGlobalOrdinal, Node >, Xpetra::EpetraVectorT< GO, NO >, Xpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node >, Xpetra::Vector< double, int, int, EpetraNode >, Xpetra::Vector< Scalar, int, int, EpetraNode >, Xpetra::Vector< double, int, EpetraGlobalOrdinal, Node >, Xpetra::Vector< int, int, long long, EpetraNode >, Xpetra::Vector< Scalar, int, long long, EpetraNode >, Xpetra::Vector< int, int, int, EpetraNode >, Xpetra::Vector< double, int, long long, EpetraNode >, Xpetra::Vector< int, int, EpetraGlobalOrdinal, Node >, Xpetra::ReorderedBlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::TpetraVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node = 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 >.

Implemented in Xpetra::EpetraIntMultiVectorT< long long, EpetraNode >, Xpetra::EpetraIntVectorT< long long, EpetraNode >, Xpetra::EpetraMultiVectorT< long long, EpetraNode >, Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >, Xpetra::TpetraMultiVector< Scalar, int, int, EpetraNode >, Xpetra::EpetraIntMultiVectorT< int, EpetraNode >, Xpetra::EpetraIntVectorT< int, EpetraNode >, Xpetra::TpetraVector< Scalar, int, long long, EpetraNode >, Xpetra::EpetraMultiVectorT< int, EpetraNode >, Xpetra::EpetraVectorT< long long, EpetraNode >, Xpetra::TpetraVector< Scalar, int, int, EpetraNode >, Xpetra::EpetraVectorT< int, EpetraNode >, Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >, Xpetra::EpetraIntMultiVectorT< EpetraGlobalOrdinal, Node >, Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >, Xpetra::EpetraIntVectorT< GO, NO >, Xpetra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >, Xpetra::EpetraMultiVectorT< EpetraGlobalOrdinal, Node >, Xpetra::EpetraVectorT< GO, NO >, Xpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node >, Xpetra::Vector< double, int, int, EpetraNode >, Xpetra::Vector< Scalar, int, int, EpetraNode >, Xpetra::Vector< double, int, EpetraGlobalOrdinal, Node >, Xpetra::Vector< int, int, long long, EpetraNode >, Xpetra::Vector< Scalar, int, long long, EpetraNode >, Xpetra::Vector< int, int, int, EpetraNode >, Xpetra::Vector< double, int, long long, EpetraNode >, Xpetra::Vector< int, int, EpetraGlobalOrdinal, Node >, Xpetra::ReorderedBlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::TpetraVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node = 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 >
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 75 of file Xpetra_MultiVector_def.hpp.


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