Thyra::DefaultSpmdVector< Scalar > Class Template Reference
[Efficient Generic SPMD Concrete Thyra Operator/Vector Subclass Implementations]

Efficient concrete implementation subclass for SPMD vectors. More...

#include <Thyra_DefaultSpmdVectorDecl.hpp>

Inheritance diagram for Thyra::DefaultSpmdVector< Scalar >:

[legend]List of all members.

Constructors/initializers
	DefaultSpmdVector ()
	Construct to uninitialized.
	DefaultSpmdVector (const Teuchos::RefCountPtr< const SpmdVectorSpaceBase< Scalar > > &spmdSpace, const Teuchos::RefCountPtr< Scalar > &localValues, const Index stride)
	Calls initialize().
void	initialize (const Teuchos::RefCountPtr< const SpmdVectorSpaceBase< Scalar > > &spmdSpace, const Teuchos::RefCountPtr< Scalar > &localValues, const Index stride)
	Initialize.
void	uninitialize (Teuchos::RefCountPtr< const SpmdVectorSpaceBase< Scalar > > *spmdSpace=NULL, Teuchos::RefCountPtr< Scalar > *localValues=NULL, Index *stride=NULL)
	Set to an uninitialized state.
Accessors (inlined for minimal overhead)
Teuchos::RefCountPtr< Scalar >	getRCPtr ()
Teuchos::RefCountPtr< const Scalar >	getRCPtr () const
Scalar *	getPtr ()
const Scalar *	getPtr () const
Index	getStride () const
Overridden form Teuchos::Describable
std::string	description () const
Overridden from SpmdVectorBase
Teuchos::RefCountPtr< const SpmdVectorSpaceBase< Scalar > >	spmdSpace () const
void	getLocalData (Scalar **localValues, Index *stride)
void	commitLocalData (Scalar *localValues)
void	getLocalData (const Scalar **localValues, Index *stride) const
void	freeLocalData (const Scalar *localValues) const

---

Detailed Description

template<class Scalar>
class Thyra::DefaultSpmdVector< Scalar >

Efficient concrete implementation subclass for SPMD vectors.

This subclass provides a very efficient and very general concrete implementation of a Thyra::VectorBase object for any SPMD platform.

Objects of this type generally should not be constructed directly by a client but instead by using the concrete vector space subclass Thyra::DefaultSpmdVectorSpace and using the function Thyra::createMember().

The storage type can be anything since a Teuchos::RefCountPtr is used to pass in the local values pointer into the constructor and initialize().

Definition at line 54 of file Thyra_DefaultSpmdVectorDecl.hpp.

---

Constructor & Destructor Documentation

template<class Scalar> Thyra::DefaultSpmdVector< Scalar >::DefaultSpmdVector (   )

Construct to uninitialized. Definition at line 41 of file Thyra_DefaultSpmdVector.hpp.

template<class Scalar> Thyra::DefaultSpmdVector< Scalar >::DefaultSpmdVector (  const Teuchos::RefCountPtr< const SpmdVectorSpaceBase< Scalar > > &  spmdSpace, const Teuchos::RefCountPtr< Scalar > &  localValues, const Index  stride )

Calls initialize(). Definition at line 46 of file Thyra_DefaultSpmdVector.hpp.

---

Member Function Documentation

template<class Scalar> void Thyra::DefaultSpmdVector< Scalar >::initialize (  const Teuchos::RefCountPtr< const SpmdVectorSpaceBase< Scalar > > &  spmdSpace, const Teuchos::RefCountPtr< Scalar > &  localValues, const Index  stride )

Initialize. Parameters: spmdSpace  [in] Smart pointer to SpmdVectorSpaceBase object that defines the data distribution for spmdSpace() and space(). localValues  [in] Smart pointer to beginning of local strided vector data. This array must be at least of dimension mpiRangeSpace->localDim()*stride and (&*localValues)[ i*stride ] gives the local value of the zero-based entry (i) where i=0...spmdSpace()->localSubDim()-1. stride  [in] Stride between local vector elements. Preconditions: spmdSpace.get()!=NULL localValues.get()!=NULL stride != 0 Postconditions: this->getRCptr().get() == localValues.get() this->getPtr() == &*localValues this->getStride() == stride Definition at line 56 of file Thyra_DefaultSpmdVector.hpp.

template<class Scalar> void Thyra::DefaultSpmdVector< Scalar >::uninitialize (  Teuchos::RefCountPtr< const SpmdVectorSpaceBase< Scalar > > *  spmdSpace = NULL, Teuchos::RefCountPtr< Scalar > *  localValues = NULL, Index *  stride = NULL )

Set to an uninitialized state. Postconditions: this->spmdSpace().get() == NULL. Definition at line 74 of file Thyra_DefaultSpmdVector.hpp.

template<class Scalar> Teuchos::RefCountPtr< Scalar > Thyra::DefaultSpmdVector< Scalar >::getRCPtr (   )  [inline]

Definition at line 170 of file Thyra_DefaultSpmdVectorDecl.hpp.

template<class Scalar> Teuchos::RefCountPtr< const Scalar > Thyra::DefaultSpmdVector< Scalar >::getRCPtr (   )  const [inline]

Definition at line 178 of file Thyra_DefaultSpmdVectorDecl.hpp.

template<class Scalar> Scalar * Thyra::DefaultSpmdVector< Scalar >::getPtr (   )  [inline]

Definition at line 185 of file Thyra_DefaultSpmdVectorDecl.hpp.

template<class Scalar> const Scalar * Thyra::DefaultSpmdVector< Scalar >::getPtr (   )  const [inline]

Definition at line 192 of file Thyra_DefaultSpmdVectorDecl.hpp.

template<class Scalar> Index Thyra::DefaultSpmdVector< Scalar >::getStride (   )  const [inline]

Definition at line 199 of file Thyra_DefaultSpmdVectorDecl.hpp.

template<class Scalar> std::string Thyra::DefaultSpmdVector< Scalar >::description (   )  const

Definition at line 94 of file Thyra_DefaultSpmdVector.hpp.

template<class Scalar> Teuchos::RefCountPtr< const SpmdVectorSpaceBase< Scalar > > Thyra::DefaultSpmdVector< Scalar >::spmdSpace (   )  const [virtual]

Implements Thyra::SpmdVectorBase< Scalar >. Definition at line 104 of file Thyra_DefaultSpmdVector.hpp.

template<class Scalar> void Thyra::DefaultSpmdVector< Scalar >::getLocalData (  Scalar **  localValues, Index *  stride )  [virtual]

Implements Thyra::SpmdVectorBase< Scalar >. Definition at line 110 of file Thyra_DefaultSpmdVector.hpp.

template<class Scalar> void Thyra::DefaultSpmdVector< Scalar >::commitLocalData (  Scalar *  localValues  )  [virtual]

Implements Thyra::SpmdVectorBase< Scalar >. Definition at line 123 of file Thyra_DefaultSpmdVector.hpp.

template<class Scalar> void Thyra::DefaultSpmdVector< Scalar >::getLocalData (  const Scalar **  localValues, Index *  stride )  const [virtual]

Reimplemented from Thyra::SpmdVectorBase< Scalar >. Definition at line 132 of file Thyra_DefaultSpmdVector.hpp.

template<class Scalar> void Thyra::DefaultSpmdVector< Scalar >::freeLocalData (  const Scalar *  localValues  )  const [virtual]

Reimplemented from Thyra::SpmdVectorBase< Scalar >. Definition at line 145 of file Thyra_DefaultSpmdVector.hpp.

---

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

• Thyra_DefaultSpmdVectorDecl.hpp
• Thyra_DefaultSpmdVector.hpp

---