Tpetra::VectorSpace< OrdinalType, ScalarType > Class Template Reference

Tpetra::VectorSpace. More...

#include <Tpetra_VectorSpace.hpp>

Inheritance diagram for Tpetra::VectorSpace< OrdinalType, ScalarType >:

[legend]Collaboration diagram for Tpetra::VectorSpace< OrdinalType, ScalarType >:

[legend]List of all members.

Public Member Functions
	VectorSpace (ElementSpace< OrdinalType > const &elementSpace, Platform< OrdinalType, ScalarType > const &platform)
	Tpetra::VectorSpace constructor taking an ElementSpace object.
	VectorSpace (BlockElementSpace< OrdinalType > const &blockElementSpace, Platform< OrdinalType, ScalarType > const &platform)
	Tpetra::VectorSpace constructor taking a BlockElementSpace object.
	VectorSpace (VectorSpace< OrdinalType, ScalarType > const &vectorSpace)
	Tpetra::VectorSpace shallow copy constructor.
	~VectorSpace ()
	Tpetra::VectorSpace destructor.
OrdinalType	getNumGlobalEntries () const
	Returns the number of entries in this VectorSpace.
OrdinalType	getNumMyEntries () const
	Returns the number of entries belonging to the calling image.
OrdinalType	getIndexBase () const
	Returns the index base for this VectorSpace.
OrdinalType	getMinLocalIndex () const
	Min/Max Indices.
OrdinalType	getMaxLocalIndex () const
OrdinalType	getMinGlobalIndex () const
OrdinalType	getMaxGlobalIndex () const
OrdinalType	getLocalIndex (OrdinalType globalIndex) const
	Return the local index for a given global index.
OrdinalType	getGlobalIndex (OrdinalType localIndex) const
	Return the global index for a given local index.
bool	isMyLocalIndex (OrdinalType localIndex) const
	Returns true if the local index value passed in is found on the calling image, returns false if it doesn't.
bool	isMyGlobalIndex (OrdinalType globalIndex) const
	Returns true if the global index value passed in is found the calling image, returns false if it doesn't.
Vector< OrdinalType, ScalarType > *	createVector () const
	Creates a Tpetra::Vector, with all entries set to 0.
bool	isCompatible (VectorSpace< OrdinalType, ScalarType > const &vectorSpace) const
	Returns true if the VectorSpace passed in is compatible with this VectorSpace.
bool	isSameAs (VectorSpace< OrdinalType, ScalarType > const &vectorSpace) const
	Returns true if the VectorSpace passed in is identical to this VectorSpace. Also implemented through the == and != operators.
bool	operator== (VectorSpace< OrdinalType, ScalarType > const &vectorSpace) const
bool	operator!= (VectorSpace< OrdinalType, ScalarType > const &vectorSpace) const
void	print (ostream &os) const
	Prints the VectorSpace object to the output stream.
Platform< OrdinalType, ScalarType > const &	platform () const
	Access functions for the Tpetra::Platform and Tpetra::Comm communicators.
Comm< OrdinalType, ScalarType > const &	comm () const
ElementSpace< OrdinalType > const &	elementSpace () const
	Access function for the ElementSpace used by this VectorSpace.
VectorSpace< OrdinalType, ScalarType > &	operator= (VectorSpace< OrdinalType, ScalarType > const &Source)
	Assignment operator.

---

Detailed Description

template<typename OrdinalType, typename ScalarType>
class Tpetra::VectorSpace< OrdinalType, ScalarType >

Tpetra::VectorSpace.

VectorSpace serves two purposes. In addition to creating Tpetra::Vectors, it acts as an "insulating" class between Vectors and ElementSpace/BlockElementSpace. Through this mechanism, Vectors can be created and manipulated using one nonambiguous set of vector indices, regardless of if it uses an ElementSpace or a BlockElementSpace for distribution.

---

Member Function Documentation

template<typename OrdinalType, typename ScalarType>

OrdinalType Tpetra::VectorSpace< OrdinalType, ScalarType >::getGlobalIndex

(

OrdinalType

localIndex

)

const [inline]

Return the global index for a given local index.

If this VectorSpace was created using a BlockElementSpace, LIDs and GIDs from the compatible ElementSpace will be used.

template<typename OrdinalType, typename ScalarType>

OrdinalType Tpetra::VectorSpace< OrdinalType, ScalarType >::getLocalIndex

(

OrdinalType

globalIndex

)

const [inline]

Return the local index for a given global index.

If this VectorSpace was created using a BlockElementSpace, LIDs and GIDs from the compatible ElementSpace will be used.

template<typename OrdinalType, typename ScalarType>

void Tpetra::VectorSpace< OrdinalType, ScalarType >::print

(

ostream &

os

)

const [inline, virtual]

Prints the VectorSpace object to the output stream.

An << operator is inherited from Tpetra::Object, which uses the print method.

Reimplemented from Tpetra::Object.

---

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

• Tpetra_VectorSpace.hpp

---