47#ifndef XPETRA_BLOCKEDVECTOR_DEF_HPP
48#define XPETRA_BLOCKEDVECTOR_DEF_HPP
52#include "Xpetra_BlockedMultiVector.hpp"
61template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
68template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
76template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
84template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
90template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
100template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
109template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
118template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
127template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
136template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
145template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
153template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
161template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
169template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
177template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
185template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
193template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
201template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
209template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
218template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
228template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
237template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
246template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
249scale(
const Scalar& alpha)
255template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
264template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
267update(
const Scalar& alpha,
275template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
278update(
const Scalar& alpha,
288template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
299template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
311template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
323template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
332template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
341template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
350template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
359template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
368template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
382template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
396template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
408template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
418 "BlockedVector::elementWiseMultipy: B must have same blocked map than this.");
421 "BlockedVector::elementWiseMultipy: A has "
422 << A.
getMap()->getLocalNumElements() <<
" elements, B has " << B.
getMap()->getLocalNumElements()
426 "BlockedVector::elementWiseMultipy: A has " << A.
getMap()->getGlobalNumElements()
427 <<
" elements, B has "
428 << B.
getMap()->getGlobalNumElements() <<
".");
436 "BlockedVector::elementWiseMultipy: B must be a BlockedVector.");
452template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
461template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
467 "BlockedVector::getLocalLength: routine not implemented. It has no value as one must iterate on the partial vectors.");
472template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
477 return this->getBlockedMap()->getFullMap()->getGlobalNumElements();
481template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
487 "BlockedVector::isSameSize: routine not implemented. It has no value as one must iterate on the partial vectors.");
492template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
497 return std::string(
"BlockedVector");
501template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
506 out << description() << std::endl;
507 for(
size_t r = 0; r < this->getBlockedMap()->getNumMaps(); r++)
509 getMultiVector(r)->describe(out, verbLevel);
514template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
523template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
534template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
545template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
556template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
567template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
572 for(
size_t r = 0; r < this->getBlockedMap()->getNumMaps(); ++r)
574 getMultiVector(r)->setSeed(seed);
579template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
584 for(
size_t r = 0; r < this->getBlockedMap()->getNumMaps(); ++r)
586 getMultiVector(r)->randomize(bUseXpetraImplementation);
591template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
594randomize(
const Scalar& minVal,
const Scalar& maxVal,
bool bUseXpetraImplementation)
596 for(
size_t r = 0; r < this->getBlockedMap()->getNumMaps(); ++r)
598 getMultiVector(r)->randomize(minVal, maxVal, bUseXpetraImplementation);
603template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
614template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
624 template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
630 return this->getBlockedMap();
634 template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
643 template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
652 template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
664 template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
673 template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
#define XPETRA_MONITOR(funcName)
#define XPETRA_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
virtual void putScalar(const Scalar &value)
Set all values in the multivector with the given value.
virtual void sumIntoLocalValue(LocalOrdinal, size_t, const Scalar &)
Add value to existing value, using local (row) index.
virtual Teuchos::ArrayRCP< const Scalar > getData(size_t j) const
Const view of the local values in a particular vector of this multivector.
Teuchos::RCP< MultiVector > getMultiVector(size_t r) const
return partial multivector associated with block row r
void setMultiVector(size_t r, Teuchos::RCP< const MultiVector > v, bool bThyraMode)
set partial multivector associated with block row r
virtual Teuchos::RCP< const Xpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > getVector(size_t j) const
Return a Vector which is a const view of column j.
virtual Teuchos::ArrayRCP< Scalar > getDataNonConst(size_t j)
View of the local values in a particular vector of this multivector.
virtual void dot(const MultiVector &, const Teuchos::ArrayView< Scalar > &) const
Compute dot product of each corresponding pair of vectors, dots[i] = this[i].dot(A[i]).
virtual void reciprocal(const MultiVector &)
Put element-wise reciprocal values of input Multi-vector in target, this(i,j) = 1/A(i,...
virtual void sumIntoGlobalValue(GlobalOrdinal, size_t, const Scalar &)
Add value to existing value, using global (row) index.
virtual void replaceLocalValue(LocalOrdinal, size_t, const Scalar &)
Replace value, using local (row) index.
Teuchos::RCP< MultiVector > Merge() const
merge BlockedMultiVector blocks to a single MultiVector
virtual Teuchos::RCP< Xpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > getVectorNonConst(size_t j)
Return a Vector which is a nonconst view of column j.
virtual void replaceGlobalValue(GlobalOrdinal, size_t, const Scalar &)
Replace value, using global (row) index.
virtual void norm2(const Teuchos::ArrayView< typename Teuchos::ScalarTraits< Scalar >::magnitudeType > &norms) const
virtual void assign(const MultiVector &rhs)
Implementation of the assignment operator (operator=); does a deep copy.
virtual void scale(const Scalar &alpha)
Scale the current values of a multi-vector, this = alpha*this.
virtual void normInf(const Teuchos::ArrayView< typename Teuchos::ScalarTraits< Scalar >::magnitudeType > &norms) const
Compute Inf-norm of each vector in multi-vector.
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.
virtual void abs(const MultiVector &)
Put element-wise absolute values of input Multi-vector in target: A = abs(this).
virtual void norm1(const Teuchos::ArrayView< typename Teuchos::ScalarTraits< Scalar >::magnitudeType > &norms) const
Compute 1-norm of each vector in multi-vector.
virtual void replaceMap(const RCP< const Map > &map)
virtual void multiply(Teuchos::ETransp, Teuchos::ETransp, const Scalar &, const Xpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &, const Xpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &, const Scalar &)
Matrix-matrix multiplication: this = beta*this + alpha*op(A)*op(B).
Teuchos::RCP< Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > Merge() const
merge BlockedVector blocks to a single Vector
virtual size_t getLocalLength() const
Local number of rows on the calling process.
virtual void replaceMap(const RCP< const Map > &map)
virtual std::string description() const
A simple one-line description of this object.
BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > & operator=(const Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &rhs)
Assignment operator: Does a deep copy.
virtual void Xpetra_randomize()
Set vector values to random numbers. XPetra implementation.
virtual Teuchos::RCP< const Xpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > getVector(size_t j) const
Return a Vector which is a const view of column j.
virtual Teuchos::ArrayRCP< const Scalar > getData(size_t j) const
Const view of the local values in a particular vector of this vector.
virtual void randomize(bool bUseXpetraImplementation=false)
Set multi-vector values to random numbers.
Teuchos::RCP< const Map > getMap() const
Access function for the underlying Map this DistObject was constructed with.
virtual void dot(const Xpetra::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]).
virtual Teuchos::ScalarTraits< Scalar >::magnitudeType norm2() const
Compute 2-norm of vector.
virtual void sumIntoLocalValue(LocalOrdinal myRow, size_t vectorIndex, const Scalar &value)
Add value to existing value, using local (row) index.
virtual Teuchos::RCP< Xpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > getVectorNonConst(size_t j)
Return a Vector which is a nonconst view of column j.
void setMultiVector(size_t r, Teuchos::RCP< const Xpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > v, bool bThyraMode)
set partial Vector associated with block row r
virtual void reciprocal(const Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A)
Put element-wise reciprocal values of input vector in target, this(i,j) = 1/A(i,j).
virtual void putScalar(const Scalar &value)
Set all values in the vector with the given value.
virtual void setSeed(unsigned int seed)
Set seed for Random function.
virtual void doExport(const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > &, const Import &, CombineMode)
Export.
BlockedVector(const Teuchos::RCP< const BlockedMap > &map, bool zeroOut=true)
Constructor.
virtual Teuchos::ScalarTraits< Scalar >::magnitudeType norm1() const
Compute 1-norm of vector.
virtual void replaceLocalValue(LocalOrdinal myRow, size_t vectorIndex, const Scalar &value)
Replace value, using local (row) index.
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.
virtual void sumIntoGlobalValue(GlobalOrdinal globalRow, size_t vectorIndex, const Scalar &value)
Add value to existing value, using global (row) index.
virtual void scale(const Scalar &alpha)
Scale the current values of a vector, this = alpha*this.
virtual void replaceGlobalValue(GlobalOrdinal globalRow, size_t vectorIndex, const Scalar &value)
Replace value, using global (row) index.
virtual Teuchos::ArrayRCP< Scalar > getDataNonConst(size_t j)
View of the local values in a particular vector of this vector.
virtual void elementWiseMultiply(Scalar, const Xpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &, const Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &, Scalar)
Element-wise multiply of a Vector A with a MultiVector B.
virtual size_t getNumVectors() const
Number of columns in the Vector.
virtual void doImport(const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > &, const Import &, CombineMode)
Import.
virtual Scalar meanValue() const
Compute mean (average) value of this Vector.
virtual bool isSameSize(const Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &) const
Local number of rows on the calling process.
virtual void update(const Scalar &alpha, const Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A, const Scalar &beta)
Update multi-vector values with scaled values of A, this = beta*this + alpha*A.
virtual global_size_t getGlobalLength() const
Global number of rows in the Vector.
virtual void assign(const Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &rhs)
Implementation of the assignment operator (operator=); does a deep copy.
Teuchos::RCP< Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > getMultiVector(size_t r) const
return partial Vector associated with block row r
virtual ~BlockedVector()
Destructor.
virtual Teuchos::ScalarTraits< Scalar >::magnitudeType normInf() const
Compute Inf-norm in vector.
virtual void abs(const Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A)
Put element-wise absolute values of input vector in target: A = abs(this).
virtual Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > getMap() const =0
The Map describing the parallel distribution of this object.
Exception throws to report errors in the internal logical of the program.
virtual void Xpetra_randomize()
Set multi-vector values to random numbers. XPetra implementation.
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
#define TEUCHOS_UNREACHABLE_RETURN(dummyReturnVal)
size_t global_size_t
Global size_t object.
CombineMode
Xpetra::Combine Mode enumerable type.