Tpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

A class for constructing and using dense, distributors vectors. More...

#include <Tpetra_VectorDecl.hpp>

Inheritance diagram for Tpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node >:

Inheritance graph
[legend]
List of all members.

Public Member Functions

Constructor/Destructor Methods
 Vector (const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &map, bool zeroOut=true)
 Sets all vector entries to zero.
 Vector (const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &source)
 Vector copy constructor.
 Vector (const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &map, const Teuchos::ArrayView< const Scalar > &A)
 Set multi-vector values from an array using Teuchos memory management classes. (copy).
virtual ~Vector ()
 Destructor.
Post-construction modification routines
void replaceGlobalValue (GlobalOrdinal globalRow, const Scalar &value)
 Replace current value at the specified location with specified value.
void sumIntoGlobalValue (GlobalOrdinal globalRow, const Scalar &value)
 Adds specified value to existing value at the specified location.
void replaceLocalValue (LocalOrdinal myRow, const Scalar &value)
 Replace current value at the specified location with specified values.
void sumIntoLocalValue (LocalOrdinal myRow, const Scalar &value)
 Adds specified value to existing value at the specified location.
Extraction methods
void get1dCopy (Teuchos::ArrayView< Scalar > A) const
 Return multi-vector values in user-provided two-dimensional array (using Teuchos memory management classes).
Mathematical methods
Scalar dot (const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &a) const
 Computes dot product of this Vector against input Vector x.
Teuchos::ScalarTraits< Scalar
>::magnitudeType 
norm1 () const
 Return 1-norm of this Vector.
Teuchos::ScalarTraits< Scalar
>::magnitudeType 
norm2 () const
 Compute 2-norm of this Vector.
Teuchos::ScalarTraits< Scalar
>::magnitudeType 
normInf () const
 Compute Inf-norm of this Vector.
Teuchos::ScalarTraits< Scalar
>::magnitudeType 
normWeighted (const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &weights) const
 Compute Weighted 2-norm (RMS Norm) of this Vector.
Scalar meanValue () const
 Compute mean (average) value of this Vector.
Overridden from Teuchos::Describable
std::string description () const
 Return a simple one-line description of this object.
void describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const
 Print the object with some verbosity level to an FancyOStream object.

Protected Member Functions

 Vector (const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &map, Teuchos::ArrayRCP< Scalar > data)
 Advanced constructor accepting parallel buffer view.

Detailed Description

template<class Scalar, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
class Tpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node >

A class for constructing and using dense, distributors vectors.

This class is templated on Scalar, LocalOrdinal and GlobalOrdinal. The LocalOrdinal type, if omitted, defaults to int. The GlobalOrdinal type, if omitted, defaults to the LocalOrdinal type.


Constructor & Destructor Documentation

template<class Scalar, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
Tpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Vector ( const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &  map,
bool  zeroOut = true 
) [explicit]

Sets all vector entries to zero.

template<class Scalar, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
Tpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Vector ( const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &  source  ) 

Vector copy constructor.

template<class Scalar, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
Tpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Vector ( const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &  map,
const Teuchos::ArrayView< const Scalar > &  A 
)

Set multi-vector values from an array using Teuchos memory management classes. (copy).

template<class Scalar, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
virtual Tpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::~Vector (  )  [virtual]

Destructor.

template<class Scalar, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
Tpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Vector ( const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &  map,
Teuchos::ArrayRCP< Scalar >  data 
) [protected]

Advanced constructor accepting parallel buffer view.


Member Function Documentation

template<class Scalar, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
void Tpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::replaceGlobalValue ( GlobalOrdinal  globalRow,
const Scalar &  value 
)

Replace current value at the specified location with specified value.

template<class Scalar, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
void Tpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::sumIntoGlobalValue ( GlobalOrdinal  globalRow,
const Scalar &  value 
)

Adds specified value to existing value at the specified location.

template<class Scalar, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
void Tpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::replaceLocalValue ( LocalOrdinal  myRow,
const Scalar &  value 
)

Replace current value at the specified location with specified values.

template<class Scalar, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
void Tpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::sumIntoLocalValue ( LocalOrdinal  myRow,
const Scalar &  value 
)

Adds specified value to existing value at the specified location.

template<class Scalar, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
void Tpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::get1dCopy ( Teuchos::ArrayView< Scalar >  A  )  const

Return multi-vector values in user-provided two-dimensional array (using Teuchos memory management classes).

template<class Scalar, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
Scalar Tpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::dot ( const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &  a  )  const

Computes dot product of this Vector against input Vector x.

template<class Scalar, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
Teuchos::ScalarTraits<Scalar>::magnitudeType Tpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::norm1 (  )  const

Return 1-norm of this Vector.

template<class Scalar, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
Teuchos::ScalarTraits<Scalar>::magnitudeType Tpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::norm2 (  )  const

Compute 2-norm of this Vector.

template<class Scalar, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
Teuchos::ScalarTraits<Scalar>::magnitudeType Tpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::normInf (  )  const

Compute Inf-norm of this Vector.

template<class Scalar, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
Teuchos::ScalarTraits<Scalar>::magnitudeType Tpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::normWeighted ( const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &  weights  )  const

Compute Weighted 2-norm (RMS Norm) of this Vector.

template<class Scalar, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
Scalar Tpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::meanValue (  )  const

Compute mean (average) value of this Vector.

template<class Scalar, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
std::string Tpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::description (  )  const [virtual]

Return a simple one-line description of this object.

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

template<class Scalar, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
void Tpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::describe ( Teuchos::FancyOStream out,
const Teuchos::EVerbosityLevel  verbLevel = Teuchos::Describable::verbLevel_default 
) const [virtual]

Print the object with some verbosity level to an FancyOStream object.

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


The documentation for this class was generated from the following file:
Generated on Wed May 12 21:40:14 2010 for Tpetra Matrix/Vector Services by  doxygen 1.4.7