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

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

#include <Thyra_DefaultSpmdMultiVectorDecl.hpp>

Inheritance diagram for Thyra::DefaultSpmdMultiVector< Scalar >:

Inheritance graph
[legend]
List of all members.

Constructors/initializers/accessors

 DefaultSpmdMultiVector ()
 Construct to uninitialized.
 DefaultSpmdMultiVector (const RCP< const SpmdVectorSpaceBase< Scalar > > &spmdRangeSpace, const RCP< const ScalarProdVectorSpaceBase< Scalar > > &domainSpace)
 Calls initialize().
 DefaultSpmdMultiVector (const RCP< const SpmdVectorSpaceBase< Scalar > > &spmdRangeSpace, const RCP< const ScalarProdVectorSpaceBase< Scalar > > &domainSpace, const ArrayRCP< Scalar > &localValues, const Index leadingDim)
 Calls initialize().
void initialize (const RCP< const SpmdVectorSpaceBase< Scalar > > &spmdRangeSpace, const RCP< const ScalarProdVectorSpaceBase< Scalar > > &domainSpace)
 Initialize only with vector spaces where storage is allocated internally..
void initialize (const RCP< const SpmdVectorSpaceBase< Scalar > > &spmdRangeSpace, const RCP< const ScalarProdVectorSpaceBase< Scalar > > &domainSpace, const ArrayRCP< Scalar > &localValues, const Index leadingDim)
 Initialize using externally allocated storage.
void uninitialize (RCP< const SpmdVectorSpaceBase< Scalar > > *spmdRangeSpace=NULL, RCP< const ScalarProdVectorSpaceBase< Scalar > > *domainSpace=NULL, ArrayRCP< Scalar > *localValues=NULL, Index *leadingDim=NULL)
 Set to an uninitialized state.

Overridden from EuclideanLinearOpBase

RCP< const ScalarProdVectorSpaceBase<
Scalar > > 
domainScalarProdVecSpc () const
 

Overridden from MultiVectorBase

RCP< VectorBase< Scalar > > nonconstColImpl (Index j)
 
RCP< MultiVectorBase< Scalar > > nonconstContigSubViewImpl (const Range1D &colRng)
 
RCP< const MultiVectorBase<
Scalar > > 
nonContigSubViewImpl (const ArrayView< const int > &cols) const
 
RCP< MultiVectorBase< Scalar > > nonconstNonContigSubViewImpl (const ArrayView< const int > &cols)
 

Overridden from SpmdMultiVectorBase

RCP< const SpmdVectorSpaceBase<
Scalar > > 
spmdSpace () const
 
void getLocalData (Scalar **localValues, Index *leadingDim)
 
void commitLocalData (Scalar *localValues)
 
void getLocalData (const Scalar **localValues, Index *leadingDim) const
 
void freeLocalData (const Scalar *localValues) const
 

Detailed Description

template<class Scalar>
class Thyra::DefaultSpmdMultiVector< Scalar >

Efficient concrete implementation subclass for SPMD multi-vectors.

This subclass provides a very efficient and very general concrete implementation of a Thyra::MultiVectorBase object.

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::createMembers().

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

Examples:

test_scalar_product.cpp.

Definition at line 55 of file Thyra_DefaultSpmdMultiVectorDecl.hpp.


Constructor & Destructor Documentation

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

Construct to uninitialized.

Definition at line 93 of file Thyra_DefaultSpmdMultiVector.hpp.

template<class Scalar>
Thyra::DefaultSpmdMultiVector< Scalar >::DefaultSpmdMultiVector ( const RCP< const SpmdVectorSpaceBase< Scalar > > &  spmdRangeSpace,
const RCP< const ScalarProdVectorSpaceBase< Scalar > > &  domainSpace 
)

Calls initialize().

Definition at line 98 of file Thyra_DefaultSpmdMultiVector.hpp.

template<class Scalar>
Thyra::DefaultSpmdMultiVector< Scalar >::DefaultSpmdMultiVector ( const RCP< const SpmdVectorSpaceBase< Scalar > > &  spmdRangeSpace,
const RCP< const ScalarProdVectorSpaceBase< Scalar > > &  domainSpace,
const ArrayRCP< Scalar > &  localValues,
const Index  leadingDim 
)

Calls initialize().

Definition at line 107 of file Thyra_DefaultSpmdMultiVector.hpp.


Member Function Documentation

template<class Scalar>
void Thyra::DefaultSpmdMultiVector< Scalar >::initialize ( const RCP< const SpmdVectorSpaceBase< Scalar > > &  spmdRangeSpace,
const RCP< const ScalarProdVectorSpaceBase< Scalar > > &  domainSpace 
)

Initialize only with vector spaces where storage is allocated internally..

Parameters:
spmdRangeSpace [in] Smart pointer to SpmdVectorSpaceBase object that defines the data distribution for spmdSpace() and range().
domainSpace [in] Smart pointer to VectorSpaceBase object that defines domain() space.
Preconditions:

Definition at line 118 of file Thyra_DefaultSpmdMultiVector.hpp.

template<class Scalar>
void Thyra::DefaultSpmdMultiVector< Scalar >::initialize ( const RCP< const SpmdVectorSpaceBase< Scalar > > &  spmdRangeSpace,
const RCP< const ScalarProdVectorSpaceBase< Scalar > > &  domainSpace,
const ArrayRCP< Scalar > &  localValues,
const Index  leadingDim 
)

Initialize using externally allocated storage.

Parameters:
spmdRangeSpace [in] Smart pointer to SpmdVectorSpaceBase object that defines the data distribution for spmdSpace() and range().
domainSpace [in] Smart pointer to VectorSpaceBase object that defines domain() space.
localValues [in] Smart pointer to beginning of Fortran-style column-major array that defines the local localValues in the multi-vector. This array must be at least of dimension spmdRangeSpace->localSubDim()*domainSpace->dim() and (&*localValues)[ i + j*leadingDim ] gives the local value of the zero-based entry (i,j) where i=0...spmdSpace()->localSubDim()-1 and j=0...domainSpace->dim()-1.
leadingDim [in] The leading dimension of the multi-vector.
Preconditions:

Definition at line 133 of file Thyra_DefaultSpmdMultiVector.hpp.

template<class Scalar>
void Thyra::DefaultSpmdMultiVector< Scalar >::uninitialize ( RCP< const SpmdVectorSpaceBase< Scalar > > *  spmdRangeSpace = NULL,
RCP< const ScalarProdVectorSpaceBase< Scalar > > *  domainSpace = NULL,
ArrayRCP< Scalar > *  localValues = NULL,
Index leadingDim = NULL 
)

Set to an uninitialized state.

Postconditions:

Definition at line 154 of file Thyra_DefaultSpmdMultiVector.hpp.

template<class Scalar>
RCP< const ScalarProdVectorSpaceBase< Scalar > > Thyra::DefaultSpmdMultiVector< Scalar >::domainScalarProdVecSpc (  )  const [virtual]

Implements Thyra::EuclideanLinearOpBase< Scalar >.

Definition at line 178 of file Thyra_DefaultSpmdMultiVector.hpp.

template<class Scalar>
RCP< VectorBase< Scalar > > Thyra::DefaultSpmdMultiVector< Scalar >::nonconstColImpl ( Index  j  )  [virtual]

Implements Thyra::MultiVectorBase< Scalar >.

Definition at line 190 of file Thyra_DefaultSpmdMultiVector.hpp.

template<class Scalar>
RCP< MultiVectorBase< Scalar > > Thyra::DefaultSpmdMultiVector< Scalar >::nonconstContigSubViewImpl ( const Range1D colRng  )  [virtual]

Reimplemented from Thyra::MultiVectorDefaultBase< Scalar >.

Definition at line 210 of file Thyra_DefaultSpmdMultiVector.hpp.

template<class Scalar>
RCP< const MultiVectorBase< Scalar > > Thyra::DefaultSpmdMultiVector< Scalar >::nonContigSubViewImpl ( const ArrayView< const int > &  cols  )  const [virtual]

Reimplemented from Thyra::MultiVectorDefaultBase< Scalar >.

Definition at line 233 of file Thyra_DefaultSpmdMultiVector.hpp.

template<class Scalar>
RCP< MultiVectorBase< Scalar > > Thyra::DefaultSpmdMultiVector< Scalar >::nonconstNonContigSubViewImpl ( const ArrayView< const int > &  cols  )  [virtual]

Reimplemented from Thyra::MultiVectorDefaultBase< Scalar >.

Definition at line 254 of file Thyra_DefaultSpmdMultiVector.hpp.

template<class Scalar>
RCP< const SpmdVectorSpaceBase< Scalar > > Thyra::DefaultSpmdMultiVector< Scalar >::spmdSpace (  )  const [virtual]

Implements Thyra::SpmdMultiVectorBase< Scalar >.

Definition at line 285 of file Thyra_DefaultSpmdMultiVector.hpp.

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

Implements Thyra::SpmdMultiVectorBase< Scalar >.

Definition at line 294 of file Thyra_DefaultSpmdMultiVector.hpp.

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

Implements Thyra::SpmdMultiVectorBase< Scalar >.

Definition at line 310 of file Thyra_DefaultSpmdMultiVector.hpp.

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

Implements Thyra::SpmdMultiVectorBase< Scalar >.

Definition at line 322 of file Thyra_DefaultSpmdMultiVector.hpp.

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

Implements Thyra::SpmdMultiVectorBase< Scalar >.

Definition at line 338 of file Thyra_DefaultSpmdMultiVector.hpp.


The documentation for this class was generated from the following files:
Generated on Wed May 12 21:42:35 2010 for Thyra Operator/Vector Support by  doxygen 1.4.7