Xpetra
Version of the Day
|
#include <Xpetra_EpetraMultiVector.hpp>
Public Member Functions | |
void | randomize (bool bUseXpetraImplementation=false) |
Set multi-vector values to random numbers. More... | |
Teuchos::RCP< const Map < LocalOrdinal, GlobalOrdinal, Node > > | getMap () const |
Implements DistObject interface. More... | |
void | doImport (const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > &source, const Import< LocalOrdinal, GlobalOrdinal, Node > &importer, CombineMode CM) |
Import. More... | |
void | doExport (const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > &dest, const Import< LocalOrdinal, GlobalOrdinal, Node > &importer, CombineMode CM) |
Export. More... | |
void | doImport (const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > &source, const Export< LocalOrdinal, GlobalOrdinal, Node > &exporter, CombineMode CM) |
Import (using an Exporter). More... | |
void | doExport (const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > &dest, const Export< LocalOrdinal, GlobalOrdinal, Node > &exporter, CombineMode CM) |
Export (using an Importer). More... | |
void | replaceMap (const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &map) |
Replace the underlying Map in place. More... | |
Public Member Functions inherited from Xpetra::MultiVector< double, int, EpetraGlobalOrdinal, Node > | |
virtual | ~MultiVector () |
Destructor. More... | |
MultiVector< double, int, EpetraGlobalOrdinal, Node > & | operator= (const MultiVector< double, int, EpetraGlobalOrdinal, Node > &rhs) |
Assignment operator: Does a deep copy. More... | |
virtual void | norm1 (const Teuchos::ArrayView< typename Teuchos::ScalarTraits< double >::magnitudeType > &norms) const =0 |
Compute 1-norm of each vector in multi-vector. More... | |
virtual void | norm2 (const Teuchos::ArrayView< typename Teuchos::ScalarTraits< double >::magnitudeType > &norms) const =0 |
virtual void | normInf (const Teuchos::ArrayView< typename Teuchos::ScalarTraits< double >::magnitudeType > &norms) const =0 |
Compute Inf-norm of each vector in multi-vector. More... | |
virtual void | replaceMap (const RCP< const Map< int, EpetraGlobalOrdinal, Node >> &map)=0 |
virtual void | Xpetra_randomize () |
Set multi-vector values to random numbers. XPetra implementation. More... | |
Public Member Functions inherited from Xpetra::DistObject< Packet, LocalOrdinal, GlobalOrdinal, Node > | |
virtual | ~DistObject () |
Destructor. More... | |
virtual void | doImport (const DistObject< Packet, LocalOrdinal, GlobalOrdinal, Node > &source, const Import< LocalOrdinal, GlobalOrdinal, Node > &importer, CombineMode CM)=0 |
Import data into this object using an Import object ("forward mode"). More... | |
virtual void | doExport (const DistObject< Packet, LocalOrdinal, GlobalOrdinal, Node > &source, const Export< LocalOrdinal, GlobalOrdinal, Node > &exporter, CombineMode CM)=0 |
Export data into this object using an Export object ("forward mode"). More... | |
virtual void | doImport (const DistObject< Packet, LocalOrdinal, GlobalOrdinal, Node > &source, const Export< LocalOrdinal, GlobalOrdinal, Node > &exporter, CombineMode CM)=0 |
Import data into this object using an Export object ("reverse mode"). More... | |
virtual void | doExport (const DistObject< Packet, LocalOrdinal, GlobalOrdinal, Node > &source, const Import< LocalOrdinal, GlobalOrdinal, Node > &importer, CombineMode CM)=0 |
Export data into this object using an Import object ("reverse mode"). More... | |
Protected Member Functions | |
virtual void | assign (const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &rhs) |
Implementation of the assignment operator (operator=); does a deep copy. More... | |
Private Types | |
typedef double | Scalar |
typedef int | LocalOrdinal |
typedef EpetraGlobalOrdinal | GlobalOrdinal |
Constructor/Destructor Methods | |
EpetraMultiVectorT (const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &map, size_t NumVectors, bool zeroOut=true) | |
Basic MultiVector constuctor. More... | |
EpetraMultiVectorT (const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &source) | |
MultiVector copy constructor. More... | |
EpetraMultiVectorT (const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &map, const Teuchos::ArrayView< const Teuchos::ArrayView< const Scalar > > &ArrayOfPtrs, size_t NumVectors) | |
Set multi-vector values from array of pointers using Teuchos memory management classes. (copy). More... | |
virtual | ~EpetraMultiVectorT () |
MultiVector destructor. More... | |
Post-construction modification routines | |
void | replaceGlobalValue (GlobalOrdinal globalRow, size_t vectorIndex, const Scalar &value) |
Replace value, using global (row) index. More... | |
void | sumIntoGlobalValue (GlobalOrdinal globalRow, size_t vectorIndex, const Scalar &value) |
Add value to existing value, using global (row) index. More... | |
void | replaceLocalValue (LocalOrdinal myRow, size_t vectorIndex, const Scalar &value) |
Replace value, using local (row) index. More... | |
void | sumIntoLocalValue (LocalOrdinal myRow, size_t vectorIndex, const Scalar &value) |
Add value to existing value, using local (row) index. More... | |
void | putScalar (const Scalar &value) |
Set all values in the multivector with the given value. More... | |
Data copy and view methods | |
Teuchos::RCP< const Vector < double, int, GlobalOrdinal, Node > > | getVector (size_t j) const |
Return a Vector which is a const view of column j. More... | |
Teuchos::RCP< Vector< double, int, GlobalOrdinal, Node > > | getVectorNonConst (size_t j) |
Return a Vector which is a nonconst view of column j. More... | |
Teuchos::ArrayRCP< const Scalar > | getData (size_t j) const |
Const view of the local values in a particular vector of this multivector. More... | |
Teuchos::ArrayRCP< Scalar > | getDataNonConst (size_t j) |
View of the local values in a particular vector of this multivector. More... | |
Mathematical methods | |
void | dot (const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A, const Teuchos::ArrayView< Scalar > &dots) const |
Compute the dot product of each corresponding pair of vectors (columns) in A and B. More... | |
void | abs (const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A) |
Put element-wise absolute values of input Multi-vector in target: A = abs(this). More... | |
void | reciprocal (const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A) |
Put element-wise reciprocal values of input Multi-vector in target, this(i,j) = 1/A(i,j). More... | |
void | scale (const Scalar &alpha) |
Scale in place: this = alpha*this. More... | |
void | scale (Teuchos::ArrayView< const Scalar > alpha) |
Scale the current values of a multi-vector, this[j] = alpha[j]*this[j]. More... | |
void | update (const Scalar &alpha, const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A, const Scalar &beta) |
Update: this = beta*this + alpha*A. More... | |
void | update (const Scalar &alpha, const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A, const Scalar &beta, const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &B, const Scalar &gamma) |
Update: this = gamma*this + alpha*A + beta*B. More... | |
void | norm1 (const Teuchos::ArrayView< Teuchos::ScalarTraits< Scalar >::magnitudeType > &norms) const |
Compute 1-norm of each vector in multi-vector. More... | |
void | norm2 (const Teuchos::ArrayView< Teuchos::ScalarTraits< Scalar >::magnitudeType > &norms) const |
void | normInf (const Teuchos::ArrayView< Teuchos::ScalarTraits< Scalar >::magnitudeType > &norms) const |
Compute Inf-norm of each vector in multi-vector. More... | |
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... | |
void | multiply (Teuchos::ETransp transA, Teuchos::ETransp transB, const Scalar &alpha, const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A, const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &B, const Scalar &beta) |
Matrix-matrix multiplication: this = beta*this + alpha*op(A)*op(B). More... | |
void | elementWiseMultiply (Scalar scalarAB, const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A, const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &B, Scalar scalarThis) |
Multiply a Vector A elementwise by a MultiVector B. More... | |
Attribute access functions | |
size_t | getNumVectors () const |
Number of columns in the multivector. More... | |
size_t | getLocalLength () const |
Local number of rows on the calling process. More... | |
global_size_t | getGlobalLength () const |
Global number of rows in the multivector. More... | |
bool | isSameSize (const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &vec) const |
Overridden from Teuchos::Describable | |
std::string | description () const |
A simple one-line description of this object. More... | |
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... | |
Xpetra specific | |
EpetraMultiVectorT (const RCP< Epetra_MultiVector > &vec) | |
EpetraMultiVectorT constructor to wrap a Epetra_MultiVector object. More... | |
RCP< Epetra_MultiVector > | getEpetra_MultiVector () const |
Get the underlying Epetra multivector. More... | |
void | setSeed (unsigned int seed) |
Set seed for Random function. More... | |
Additional Inherited Members | |
Public Types inherited from Xpetra::MultiVector< double, int, EpetraGlobalOrdinal, Node > | |
typedef double | scalar_type |
typedef int | local_ordinal_type |
typedef EpetraGlobalOrdinal | global_ordinal_type |
typedef Node | node_type |
Definition at line 89 of file Xpetra_EpetraMultiVector.hpp.
|
private |
Definition at line 92 of file Xpetra_EpetraMultiVector.hpp.
|
private |
Definition at line 93 of file Xpetra_EpetraMultiVector.hpp.
|
private |
Definition at line 94 of file Xpetra_EpetraMultiVector.hpp.
|
inline |
Basic MultiVector constuctor.
Definition at line 102 of file Xpetra_EpetraMultiVector.hpp.
|
inline |
MultiVector copy constructor.
Definition at line 108 of file Xpetra_EpetraMultiVector.hpp.
|
inline |
Set multi-vector values from array of pointers using Teuchos memory management classes. (copy).
Definition at line 114 of file Xpetra_EpetraMultiVector.hpp.
|
inlinevirtual |
MultiVector destructor.
Definition at line 120 of file Xpetra_EpetraMultiVector.hpp.
|
inline |
EpetraMultiVectorT constructor to wrap a Epetra_MultiVector object.
Definition at line 271 of file Xpetra_EpetraMultiVector.hpp.
|
inlinevirtual |
Replace value, using global (row) index.
Implements Xpetra::MultiVector< double, int, EpetraGlobalOrdinal, Node >.
Reimplemented in Xpetra::EpetraVectorT< GO, NO >.
Definition at line 128 of file Xpetra_EpetraMultiVector.hpp.
|
inlinevirtual |
Add value to existing value, using global (row) index.
Implements Xpetra::MultiVector< double, int, EpetraGlobalOrdinal, Node >.
Reimplemented in Xpetra::EpetraVectorT< GO, NO >.
Definition at line 131 of file Xpetra_EpetraMultiVector.hpp.
|
inlinevirtual |
Replace value, using local (row) index.
Implements Xpetra::MultiVector< double, int, EpetraGlobalOrdinal, Node >.
Reimplemented in Xpetra::EpetraVectorT< GO, NO >.
Definition at line 134 of file Xpetra_EpetraMultiVector.hpp.
|
inlinevirtual |
Add value to existing value, using local (row) index.
Implements Xpetra::MultiVector< double, int, EpetraGlobalOrdinal, Node >.
Reimplemented in Xpetra::EpetraVectorT< GO, NO >.
Definition at line 137 of file Xpetra_EpetraMultiVector.hpp.
|
inlinevirtual |
Set all values in the multivector with the given value.
Implements Xpetra::MultiVector< double, int, EpetraGlobalOrdinal, Node >.
Definition at line 140 of file Xpetra_EpetraMultiVector.hpp.
|
inlinevirtual |
Return a Vector which is a const view of column j.
Implements Xpetra::MultiVector< double, int, EpetraGlobalOrdinal, Node >.
Definition at line 148 of file Xpetra_EpetraMultiVector.hpp.
|
inlinevirtual |
Return a Vector which is a nonconst view of column j.
Implements Xpetra::MultiVector< double, int, EpetraGlobalOrdinal, Node >.
Definition at line 153 of file Xpetra_EpetraMultiVector.hpp.
|
inlinevirtual |
Const view of the local values in a particular vector of this multivector.
Implements Xpetra::MultiVector< double, int, EpetraGlobalOrdinal, Node >.
Definition at line 158 of file Xpetra_EpetraMultiVector.hpp.
|
inlinevirtual |
View of the local values in a particular vector of this multivector.
Implements Xpetra::MultiVector< double, int, EpetraGlobalOrdinal, Node >.
Definition at line 163 of file Xpetra_EpetraMultiVector.hpp.
|
inlinevirtual |
Compute the dot product of each corresponding pair of vectors (columns) in A and B.
Implements Xpetra::MultiVector< double, int, EpetraGlobalOrdinal, Node >.
Reimplemented in Xpetra::EpetraVectorT< GO, NO >.
Definition at line 173 of file Xpetra_EpetraMultiVector.hpp.
|
inlinevirtual |
Put element-wise absolute values of input Multi-vector in target: A = abs(this).
Implements Xpetra::MultiVector< double, int, EpetraGlobalOrdinal, Node >.
Definition at line 176 of file Xpetra_EpetraMultiVector.hpp.
|
inlinevirtual |
Put element-wise reciprocal values of input Multi-vector in target, this(i,j) = 1/A(i,j).
Implements Xpetra::MultiVector< double, int, EpetraGlobalOrdinal, Node >.
Definition at line 179 of file Xpetra_EpetraMultiVector.hpp.
|
inlinevirtual |
Scale in place: this = alpha*this.
Implements Xpetra::MultiVector< double, int, EpetraGlobalOrdinal, Node >.
Definition at line 182 of file Xpetra_EpetraMultiVector.hpp.
|
inlinevirtual |
Scale the current values of a multi-vector, this[j] = alpha[j]*this[j].
Implements Xpetra::MultiVector< double, int, EpetraGlobalOrdinal, Node >.
Definition at line 185 of file Xpetra_EpetraMultiVector.hpp.
|
inlinevirtual |
Update: this = beta*this + alpha*A.
Implements Xpetra::MultiVector< double, int, EpetraGlobalOrdinal, Node >.
Definition at line 188 of file Xpetra_EpetraMultiVector.hpp.
|
inlinevirtual |
Update: this = gamma*this + alpha*A + beta*B.
Implements Xpetra::MultiVector< double, int, EpetraGlobalOrdinal, Node >.
Definition at line 191 of file Xpetra_EpetraMultiVector.hpp.
|
inline |
Compute 1-norm of each vector in multi-vector.
Definition at line 194 of file Xpetra_EpetraMultiVector.hpp.
|
inline |
Definition at line 197 of file Xpetra_EpetraMultiVector.hpp.
|
inline |
Compute Inf-norm of each vector in multi-vector.
Definition at line 200 of file Xpetra_EpetraMultiVector.hpp.
|
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< double, int, EpetraGlobalOrdinal, Node >.
Reimplemented in Xpetra::EpetraVectorT< GO, NO >.
Definition at line 203 of file Xpetra_EpetraMultiVector.hpp.
|
inlinevirtual |
Matrix-matrix multiplication: this = beta*this + alpha*op(A)*op(B).
Implements Xpetra::MultiVector< double, int, EpetraGlobalOrdinal, Node >.
Definition at line 206 of file Xpetra_EpetraMultiVector.hpp.
|
inlinevirtual |
Multiply a Vector A elementwise by a MultiVector B.
Implements Xpetra::MultiVector< double, int, EpetraGlobalOrdinal, Node >.
Definition at line 209 of file Xpetra_EpetraMultiVector.hpp.
|
inlinevirtual |
Number of columns in the multivector.
Implements Xpetra::MultiVector< double, int, EpetraGlobalOrdinal, Node >.
Definition at line 217 of file Xpetra_EpetraMultiVector.hpp.
|
inlinevirtual |
Local number of rows on the calling process.
Implements Xpetra::MultiVector< double, int, EpetraGlobalOrdinal, Node >.
Definition at line 220 of file Xpetra_EpetraMultiVector.hpp.
|
inlinevirtual |
Global number of rows in the multivector.
Implements Xpetra::MultiVector< double, int, EpetraGlobalOrdinal, Node >.
Definition at line 223 of file Xpetra_EpetraMultiVector.hpp.
|
inlinevirtual |
Implements Xpetra::MultiVector< double, int, EpetraGlobalOrdinal, Node >.
Definition at line 226 of file Xpetra_EpetraMultiVector.hpp.
|
inlinevirtual |
A simple one-line description of this object.
Implements Xpetra::MultiVector< double, int, EpetraGlobalOrdinal, Node >.
Reimplemented in Xpetra::EpetraVectorT< GO, NO >.
Definition at line 234 of file Xpetra_EpetraMultiVector.hpp.
|
inlinevirtual |
Print the object with the given verbosity level to a FancyOStream.
Implements Xpetra::MultiVector< double, int, EpetraGlobalOrdinal, Node >.
Reimplemented in Xpetra::EpetraVectorT< GO, NO >.
Definition at line 237 of file Xpetra_EpetraMultiVector.hpp.
|
inlinevirtual |
Set multi-vector values to random numbers.
Implements Xpetra::MultiVector< double, int, EpetraGlobalOrdinal, Node >.
Definition at line 242 of file Xpetra_EpetraMultiVector.hpp.
|
inlinevirtual |
Implements DistObject interface.
Access function for the Tpetra::Map this DistObject was constructed with.
Implements Xpetra::DistObject< Packet, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 248 of file Xpetra_EpetraMultiVector.hpp.
|
inline |
Definition at line 251 of file Xpetra_EpetraMultiVector.hpp.
|
inline |
Definition at line 254 of file Xpetra_EpetraMultiVector.hpp.
|
inline |
Import (using an Exporter).
Definition at line 257 of file Xpetra_EpetraMultiVector.hpp.
|
inline |
Export (using an Importer).
Definition at line 260 of file Xpetra_EpetraMultiVector.hpp.
|
inline |
Replace the underlying Map in place.
Definition at line 263 of file Xpetra_EpetraMultiVector.hpp.
|
inline |
Get the underlying Epetra multivector.
Definition at line 277 of file Xpetra_EpetraMultiVector.hpp.
|
inlinevirtual |
Set seed for Random function.
Implements Xpetra::MultiVector< double, int, EpetraGlobalOrdinal, Node >.
Definition at line 280 of file Xpetra_EpetraMultiVector.hpp.
|
inlineprotectedvirtual |
Implementation of the assignment operator (operator=); does a deep copy.
Implements Xpetra::MultiVector< double, int, EpetraGlobalOrdinal, Node >.
Definition at line 333 of file Xpetra_EpetraMultiVector.hpp.