Public Types | Public Member Functions | Protected Member Functions | Private Attributes | List of all members
Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

#include <Xpetra_BlockedMultiVector.hpp>

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

Public Types

typedef Scalar scalar_type
 
typedef LocalOrdinal local_ordinal_type
 
typedef GlobalOrdinal global_ordinal_type
 
typedef Node node_type
 
- Public Types inherited from Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >
typedef Scalar scalar_type
 
typedef LocalOrdinal local_ordinal_type
 
typedef GlobalOrdinal global_ordinal_type
 
typedef Node node_type
 

Public Member Functions

Teuchos::RCP< const MapgetMap () const
 Access function for the underlying Map this DistObject was constructed with. More...
 
Teuchos::RCP< MultiVectorgetMultiVector (size_t r) const
 return partial multivector associated with block row r More...
 
Teuchos::RCP< MultiVectorgetMultiVector (size_t r, bool bThyraMode) const
 return partial multivector associated with block row r More...
 
void setMultiVector (size_t r, Teuchos::RCP< const MultiVector > v, bool bThyraMode)
 set partial multivector associated with block row r More...
 
RCP< const MapExtractorgetMapExtractor () const
 access to underlying MapExtractor object More...
 
Teuchos::RCP< MultiVectorMerge () const
 merge BlockedMultiVector blocks to a single MultiVector More...
 
- Public Member Functions inherited from Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >
virtual ~MultiVector ()
 Destructor. More...
 
MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > & operator= (const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &rhs)
 Assignment operator: Does a deep copy. More...
 
- Public Member Functions inherited from Xpetra::DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node >
virtual ~DistObject ()
 Destructor. More...
 

Protected Member Functions

virtual void assign (const MultiVector &rhs)
 Implementation of the assignment operator (operator=); does a deep copy. More...
 

Private Attributes

Teuchos::RCP< const MapExtractormapextractor_
 
std::vector< Teuchos::RCP< MultiVector > > vv_
 array containing RCPs of the partial vectors More...
 
bool bThyraMode_
 boolean flag, which is true, if BlockedCrsMatrix has been created using Thyra-style numbering for sub blocks, i.e. all GIDs of submaps are contiguous and start from 0. More...
 
size_t numVectors_
 number of vectors (columns in multi vector) More...
 

Constructor/Destructor Methods

 BlockedMultiVector (Teuchos::RCP< const MapExtractor > mapExtractor, Teuchos::RCP< const MultiVector > v)
 Constructor. More...
 
 BlockedMultiVector (Teuchos::RCP< const MapExtractor > mapExtractor, Teuchos::RCP< MultiVector > v)
 
virtual ~BlockedMultiVector ()
 Destructor. More...
 
BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > & operator= (const MultiVector &rhs)
 Assignment operator: Does a deep copy. More...
 

Post-construction modification routines

virtual void replaceGlobalValue (GlobalOrdinal globalRow, size_t vectorIndex, const Scalar &value)
 Replace value, using global (row) index. More...
 
virtual void sumIntoGlobalValue (GlobalOrdinal globalRow, size_t vectorIndex, const Scalar &value)
 Add value to existing value, using global (row) index. More...
 
virtual void replaceLocalValue (LocalOrdinal myRow, size_t vectorIndex, const Scalar &value)
 Replace value, using local (row) index. More...
 
virtual void sumIntoLocalValue (LocalOrdinal myRow, size_t vectorIndex, const Scalar &value)
 Add value to existing value, using local (row) index. More...
 
virtual void putScalar (const Scalar &value)
 Set all values in the multivector with the given value. More...
 

Data Copy and View get methods

virtual Teuchos::RCP< const VectorgetVector (size_t j) const
 Return a Vector which is a const view of column j. More...
 
virtual Teuchos::RCP< VectorgetVectorNonConst (size_t j)
 Return a Vector which is a nonconst view of column j. More...
 
virtual Teuchos::ArrayRCP< const Scalar > getData (size_t j) const
 Const view of the local values in a particular vector of this multivector. More...
 
virtual Teuchos::ArrayRCP< Scalar > getDataNonConst (size_t j)
 View of the local values in a particular vector of this multivector. More...
 

Mathematical methods

virtual void dot (const MultiVector &A, const Teuchos::ArrayView< Scalar > &dots) const
 Compute dot product of each corresponding pair of vectors, dots[i] = this[i].dot(A[i]). More...
 
virtual void abs (const MultiVector &A)
 Put element-wise absolute values of input Multi-vector in target: A = abs(this). More...
 
virtual void reciprocal (const MultiVector &A)
 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)
 Scale the current values of a multi-vector, this = alpha*this. More...
 
virtual void scale (Teuchos::ArrayView< const Scalar > alpha)
 Scale the current values of a multi-vector, this[j] = alpha[j]*this[j]. More...
 
virtual void update (const Scalar &alpha, const MultiVector &A, const Scalar &beta)
 Update multi-vector values with scaled values of A, this = beta*this + alpha*A. More...
 
virtual void update (const Scalar &alpha, const MultiVector &A, const Scalar &beta, const MultiVector &B, const Scalar &gamma)
 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
 Compute 1-norm of each vector in multi-vector. More...
 
virtual void norm2 (const Teuchos::ArrayView< typename Teuchos::ScalarTraits< Scalar >::magnitudeType > &norms) const
 
virtual void normInf (const Teuchos::ArrayView< typename Teuchos::ScalarTraits< Scalar >::magnitudeType > &norms) const
 Compute Inf-norm of each vector in multi-vector. More...
 
virtual 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). More...
 
virtual void multiply (Teuchos::ETransp transA, Teuchos::ETransp transB, const Scalar &alpha, const MultiVector &A, const MultiVector &B, const Scalar &beta)
 Matrix-matrix multiplication: this = beta*this + alpha*op(A)*op(B). More...
 
virtual void elementWiseMultiply (Scalar scalarAB, const Vector &A, const MultiVector &B, Scalar scalarThis)
 Element-wise multiply of a Vector A with a MultiVector B. More...
 

Attribute access functions

virtual size_t getNumVectors () const
 Number of columns in the multivector. More...
 
virtual size_t getLocalLength () const
 Local number of rows on the calling process. More...
 
virtual global_size_t getGlobalLength () const
 Global number of rows in the multivector. More...
 

Overridden from Teuchos::Describable

virtual std::string description () const
 A simple one-line description of this object. More...
 
virtual 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. More...
 
virtual void replaceMap (const RCP< const Map > &map)
 
virtual void doImport (const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > &source, const Import &importer, CombineMode CM)
 Import. More...
 
virtual void doExport (const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > &dest, const Import &importer, CombineMode CM)
 Export. More...
 
virtual void doImport (const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > &source, const Export &exporter, CombineMode CM)
 Import (using an Exporter). More...
 
virtual void doExport (const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > &dest, const Export &exporter, CombineMode CM)
 Export (using an Importer). More...
 

Xpetra specific

virtual void setSeed (unsigned int seed)
 Set seed for Random function. More...
 
virtual void randomize (bool bUseXpetraImplementation=false)
 
virtual void Xpetra_randomize ()
 Set multi-vector values to random numbers. XPetra implementation. More...
 

Detailed Description

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
class Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Definition at line 69 of file Xpetra_BlockedMultiVector.hpp.

Member Typedef Documentation

◆ scalar_type

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
typedef Scalar Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::scalar_type

Definition at line 73 of file Xpetra_BlockedMultiVector.hpp.

◆ local_ordinal_type

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
typedef LocalOrdinal Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::local_ordinal_type

Definition at line 74 of file Xpetra_BlockedMultiVector.hpp.

◆ global_ordinal_type

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
typedef GlobalOrdinal Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::global_ordinal_type

Definition at line 75 of file Xpetra_BlockedMultiVector.hpp.

◆ node_type

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
typedef Node Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::node_type

Definition at line 76 of file Xpetra_BlockedMultiVector.hpp.

Constructor & Destructor Documentation

◆ BlockedMultiVector() [1/2]

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::BlockedMultiVector ( Teuchos::RCP< const MapExtractor mapExtractor,
Teuchos::RCP< const MultiVector v 
)
inline

Constructor.

Const version of constructor which accepts a const version of the multi-vector

Note
If you change the information in input vector v the data in the blocked multi-vector are not affected (and vice versa). Consider the blocked multivector to be a copy of the input multivector (not a view)
Parameters
mapExtractorMapExtractor object containing information about the block splitting
vMultiVector that is to be splitted into a blocked multi vector

Definition at line 98 of file Xpetra_BlockedMultiVector.hpp.

◆ BlockedMultiVector() [2/2]

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::BlockedMultiVector ( Teuchos::RCP< const MapExtractor mapExtractor,
Teuchos::RCP< MultiVector v 
)
inline

Non-const version of constructor which accepts a non-const version of the multi-vector

Note
If you change the information in input vector v the data in the blocked multi-vector are not affected (and vice versa). Consider the blocked multivector to be a copy of the input multivector (not a view)
Parameters
mapExtractorMapExtractor object containing information about the block splitting
vMultiVector that is to be splitted into a blocked multi vector

Definition at line 124 of file Xpetra_BlockedMultiVector.hpp.

◆ ~BlockedMultiVector()

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::~BlockedMultiVector ( )
inlinevirtual

Destructor.

Definition at line 140 of file Xpetra_BlockedMultiVector.hpp.

Member Function Documentation

◆ operator=()

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
BlockedMultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>& Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::operator= ( const MultiVector rhs)
inline

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.

Definition at line 150 of file Xpetra_BlockedMultiVector.hpp.

◆ replaceGlobalValue()

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::replaceGlobalValue ( GlobalOrdinal  globalRow,
size_t  vectorIndex,
const Scalar &  value 
)
inlinevirtual

Replace value, using global (row) index.

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

Definition at line 160 of file Xpetra_BlockedMultiVector.hpp.

◆ sumIntoGlobalValue()

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::sumIntoGlobalValue ( GlobalOrdinal  globalRow,
size_t  vectorIndex,
const Scalar &  value 
)
inlinevirtual

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

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

Definition at line 165 of file Xpetra_BlockedMultiVector.hpp.

◆ replaceLocalValue()

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::replaceLocalValue ( LocalOrdinal  myRow,
size_t  vectorIndex,
const Scalar &  value 
)
inlinevirtual

Replace value, using local (row) index.

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

Definition at line 170 of file Xpetra_BlockedMultiVector.hpp.

◆ sumIntoLocalValue()

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::sumIntoLocalValue ( LocalOrdinal  myRow,
size_t  vectorIndex,
const Scalar &  value 
)
inlinevirtual

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

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

Definition at line 175 of file Xpetra_BlockedMultiVector.hpp.

◆ putScalar()

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::putScalar ( const Scalar &  value)
inlinevirtual

Set all values in the multivector with the given value.

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

Definition at line 180 of file Xpetra_BlockedMultiVector.hpp.

◆ getVector()

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual Teuchos::RCP< const Vector > Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getVector ( size_t  j) const
inlinevirtual

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

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

Definition at line 192 of file Xpetra_BlockedMultiVector.hpp.

◆ getVectorNonConst()

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual Teuchos::RCP< Vector> Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getVectorNonConst ( size_t  j)
inlinevirtual

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

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

Definition at line 198 of file Xpetra_BlockedMultiVector.hpp.

◆ getData()

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual Teuchos::ArrayRCP< const Scalar > Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getData ( size_t  j) const
inlinevirtual

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

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

Definition at line 204 of file Xpetra_BlockedMultiVector.hpp.

◆ getDataNonConst()

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual Teuchos::ArrayRCP< Scalar > Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getDataNonConst ( size_t  j)
inlinevirtual

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

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

Definition at line 210 of file Xpetra_BlockedMultiVector.hpp.

◆ dot()

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::dot ( const MultiVector 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, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 221 of file Xpetra_BlockedMultiVector.hpp.

◆ abs()

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::abs ( const MultiVector A)
inlinevirtual

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

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

Definition at line 226 of file Xpetra_BlockedMultiVector.hpp.

◆ reciprocal()

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::reciprocal ( const MultiVector A)
inlinevirtual

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

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

Definition at line 231 of file Xpetra_BlockedMultiVector.hpp.

◆ scale() [1/2]

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::scale ( const Scalar &  alpha)
inlinevirtual

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

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

Definition at line 236 of file Xpetra_BlockedMultiVector.hpp.

◆ scale() [2/2]

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::scale ( Teuchos::ArrayView< const Scalar >  alpha)
inlinevirtual

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

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

Definition at line 245 of file Xpetra_BlockedMultiVector.hpp.

◆ update() [1/2]

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::update ( const Scalar &  alpha,
const MultiVector A,
const Scalar &  beta 
)
inlinevirtual

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

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

Definition at line 254 of file Xpetra_BlockedMultiVector.hpp.

◆ update() [2/2]

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::update ( const Scalar &  alpha,
const MultiVector A,
const Scalar &  beta,
const MultiVector B,
const Scalar &  gamma 
)
inlinevirtual

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

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

Definition at line 275 of file Xpetra_BlockedMultiVector.hpp.

◆ norm1()

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::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, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 298 of file Xpetra_BlockedMultiVector.hpp.

◆ norm2()

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::norm2 ( const Teuchos::ArrayView< typename Teuchos::ScalarTraits< Scalar >::magnitudeType > &  norms) const
inlinevirtual

◆ normInf()

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::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, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 330 of file Xpetra_BlockedMultiVector.hpp.

◆ meanValue()

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::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, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 344 of file Xpetra_BlockedMultiVector.hpp.

◆ multiply()

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::multiply ( Teuchos::ETransp  transA,
Teuchos::ETransp  transB,
const Scalar &  alpha,
const MultiVector A,
const MultiVector B,
const Scalar &  beta 
)
inlinevirtual

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

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

Definition at line 349 of file Xpetra_BlockedMultiVector.hpp.

◆ elementWiseMultiply()

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::elementWiseMultiply ( Scalar  scalarAB,
const Vector A,
const MultiVector B,
Scalar  scalarThis 
)
inlinevirtual

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

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

Definition at line 354 of file Xpetra_BlockedMultiVector.hpp.

◆ getNumVectors()

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual size_t Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getNumVectors ( ) const
inlinevirtual

Number of columns in the multivector.

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

Definition at line 364 of file Xpetra_BlockedMultiVector.hpp.

◆ getLocalLength()

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual size_t Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getLocalLength ( ) const
inlinevirtual

Local number of rows on the calling process.

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

Definition at line 369 of file Xpetra_BlockedMultiVector.hpp.

◆ getGlobalLength()

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual global_size_t Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getGlobalLength ( ) const
inlinevirtual

Global number of rows in the multivector.

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

Definition at line 375 of file Xpetra_BlockedMultiVector.hpp.

◆ description()

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual std::string Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::description ( ) const
inlinevirtual

A simple one-line description of this object.

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

Definition at line 385 of file Xpetra_BlockedMultiVector.hpp.

◆ describe()

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::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, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 390 of file Xpetra_BlockedMultiVector.hpp.

◆ replaceMap()

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::replaceMap ( const RCP< const Map > &  map)
inlinevirtual

◆ doImport() [1/2]

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::doImport ( const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > &  source,
const Import importer,
CombineMode  CM 
)
inlinevirtual

◆ doExport() [1/2]

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::doExport ( const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > &  dest,
const Import importer,
CombineMode  CM 
)
inlinevirtual

◆ doImport() [2/2]

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::doImport ( const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > &  source,
const Export exporter,
CombineMode  CM 
)
inlinevirtual

◆ doExport() [2/2]

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::doExport ( const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > &  dest,
const Export exporter,
CombineMode  CM 
)
inlinevirtual

◆ setSeed()

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::setSeed ( unsigned int  seed)
inlinevirtual

Set seed for Random function.

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

Definition at line 426 of file Xpetra_BlockedMultiVector.hpp.

◆ randomize()

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::randomize ( bool  bUseXpetraImplementation = false)
inlinevirtual

◆ Xpetra_randomize()

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Xpetra_randomize ( )
inlinevirtual

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

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

Definition at line 436 of file Xpetra_BlockedMultiVector.hpp.

◆ getMap()

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
Teuchos::RCP< const Map> Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getMap ( ) const
inlinevirtual

Access function for the underlying Map this DistObject was constructed with.

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

Definition at line 486 of file Xpetra_BlockedMultiVector.hpp.

◆ getMultiVector() [1/2]

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
Teuchos::RCP<MultiVector> Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getMultiVector ( size_t  r) const
inline

return partial multivector associated with block row r

Definition at line 489 of file Xpetra_BlockedMultiVector.hpp.

◆ getMultiVector() [2/2]

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
Teuchos::RCP<MultiVector> Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getMultiVector ( size_t  r,
bool  bThyraMode 
) const
inline

return partial multivector associated with block row r

Definition at line 496 of file Xpetra_BlockedMultiVector.hpp.

◆ setMultiVector()

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::setMultiVector ( size_t  r,
Teuchos::RCP< const MultiVector v,
bool  bThyraMode 
)
inline

set partial multivector associated with block row r

Definition at line 526 of file Xpetra_BlockedMultiVector.hpp.

◆ getMapExtractor()

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
RCP<const MapExtractor> Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getMapExtractor ( ) const
inline

access to underlying MapExtractor object

Definition at line 566 of file Xpetra_BlockedMultiVector.hpp.

◆ Merge()

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
Teuchos::RCP<MultiVector> Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Merge ( ) const
inline

merge BlockedMultiVector blocks to a single MultiVector

Definition at line 569 of file Xpetra_BlockedMultiVector.hpp.

◆ assign()

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::assign ( const MultiVector rhs)
inlineprotectedvirtual

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

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

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

Definition at line 592 of file Xpetra_BlockedMultiVector.hpp.

Member Data Documentation

◆ mapextractor_

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
Teuchos::RCP<const MapExtractor> Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::mapextractor_
private

Definition at line 597 of file Xpetra_BlockedMultiVector.hpp.

◆ vv_

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
std::vector<Teuchos::RCP<MultiVector> > Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::vv_
private

array containing RCPs of the partial vectors

Definition at line 598 of file Xpetra_BlockedMultiVector.hpp.

◆ bThyraMode_

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
bool Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::bThyraMode_
private

boolean flag, which is true, if BlockedCrsMatrix has been created using Thyra-style numbering for sub blocks, i.e. all GIDs of submaps are contiguous and start from 0.

Definition at line 599 of file Xpetra_BlockedMultiVector.hpp.

◆ numVectors_

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
size_t Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::numVectors_
private

number of vectors (columns in multi vector)

Definition at line 600 of file Xpetra_BlockedMultiVector.hpp.


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