Thyra Package Browser (Single Doxygen Collection) Version of the Day
Private Types | Private Member Functions | Private Attributes | Related Functions
Thyra::DefaultMultiVectorProductVector< Scalar > Class Template Reference
Development of linear Abstract Numerical Algorithms (ANAs)

Concrete implementation of a product vector which is really composed out of the columns of a multi-vector. More...

#include <Thyra_DefaultMultiVectorProductVector_decl.hpp>

Inheritance diagram for Thyra::DefaultMultiVectorProductVector< Scalar >:
Inheritance graph
[legend]

List of all members.

Private Types

typedef
Teuchos::ConstNonconstObjectContainer
< MultiVectorBase< Scalar > > 		CNMVC

Private Member Functions

RCP< const
DefaultProductVector< Scalar > > 		getDefaultProductVector () const

Private Attributes

int numBlocks_
RCP< const
DefaultMultiVectorProductVectorSpace
< Scalar > > 		productSpace_
CNMVC multiVec_

Related Functions

(Note that these are not member functions.)

template<class Scalar >
RCP
< DefaultMultiVectorProductVector
< Scalar > > 		multiVectorProductVector (const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &productSpace, const RCP< MultiVectorBase< Scalar > > &multiVec)
 Nonmember constructor that just wraps an existing non-const MultiVector as a non-const product vector.
template<class Scalar >
RCP< const
DefaultMultiVectorProductVector
< Scalar > > 		multiVectorProductVector (const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &productSpace, const RCP< const MultiVectorBase< Scalar > > &multiVec)
 Nonmember constructor that just wraps an existing const MultiVector as a const product vector.
template<class Scalar >
RCP
< DefaultMultiVectorProductVector
< Scalar > > 		multiVectorProductVector (const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &productSpace)
 Nonmember constructor that creates a new uninitialized product vector represented underneath as a multi-vector.

Constructors/initializers/accessors

 DefaultMultiVectorProductVector ()
 Construct to uninitialized.
void initialize (const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &productSpace, const RCP< MultiVectorBase< Scalar > > &multiVec)
 Initialize with a non-const multi-vector.
void initialize (const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &productSpace, const RCP< const MultiVectorBase< Scalar > > &multiVec)
 Initialize with a const multi-vector.
RCP< MultiVectorBase< Scalar > > getNonconstMultiVector ()
 
RCP< const MultiVectorBase
< Scalar > > 		getMultiVector () const
 
void uninitialize ()
 

Overridden from Teuchos::Describable

std::string description () const
 
void describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const
 

Overridden from ProductVectorBase

RCP< VectorBase< Scalar > > getNonconstVectorBlock (const int k)
 
RCP< const VectorBase< Scalar > > getVectorBlock (const int k) const
 

Overridden from ProductMultiVectorBase

RCP< const
ProductVectorSpaceBase< Scalar > > 		productSpace () const
 
bool blockIsConst (const int k) const
 
RCP< MultiVectorBase< Scalar > > getNonconstMultiVectorBlock (const int k)
 
RCP< const MultiVectorBase
< Scalar > > 		getMultiVectorBlock (const int k) const
 

Overridden public functions from VectorBase

RCP< const VectorSpaceBase
< Scalar > > 		space () const
 

Overridden protected functions from VectorBase

void applyOpImpl (const RTOpPack::RTOpT< Scalar > &op, const ArrayView< const Ptr< const VectorBase< Scalar > > > &vecs, const ArrayView< const Ptr< VectorBase< Scalar > > > &targ_vecs, const Ptr< RTOpPack::ReductTarget > &reduct_obj, const Ordinal global_offset) const
 
void acquireDetachedVectorViewImpl (const Range1D &rng, RTOpPack::ConstSubVectorView< Scalar > *sub_vec) const
 
void releaseDetachedVectorViewImpl (RTOpPack::ConstSubVectorView< Scalar > *sub_vec) const
 
void acquireNonconstDetachedVectorViewImpl (const Range1D &rng, RTOpPack::SubVectorView< Scalar > *sub_vec)
 
void commitNonconstDetachedVectorViewImpl (RTOpPack::SubVectorView< Scalar > *sub_vec)
 
void setSubVectorImpl (const RTOpPack::SparseSubVectorT< Scalar > &sub_vec)
 

Detailed Description

template<class Scalar>
class Thyra::DefaultMultiVectorProductVector< Scalar >

Concrete implementation of a product vector which is really composed out of the columns of a multi-vector.

Note that clients should almost never be creating objects of this type explicitly and should instead use DefaultMultiVectorProductVectorSpace as a factory.

ToDo: Finish documentation!

Definition at line 57 of file Thyra_DefaultMultiVectorProductVector_decl.hpp.

Member Typedef Documentation

template<class Scalar >
typedef Teuchos::ConstNonconstObjectContainer<MultiVectorBase<Scalar> > Thyra::DefaultMultiVectorProductVector< Scalar >::CNMVC [private]

Definition at line 188 of file Thyra_DefaultMultiVectorProductVector_decl.hpp.

Constructor & Destructor Documentation

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

Construct to uninitialized.

Definition at line 46 of file Thyra_DefaultMultiVectorProductVector_def.hpp.

Member Function Documentation

template<class Scalar >
void Thyra::DefaultMultiVectorProductVector< Scalar >::initialize ( const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &  productSpace,
const RCP< MultiVectorBase< Scalar > > &  multiVec 
)

Initialize with a non-const multi-vector.

Definition at line 53 of file Thyra_DefaultMultiVectorProductVector_def.hpp.

References THYRA_ASSERT_VEC_SPACES.

template<class Scalar >
void Thyra::DefaultMultiVectorProductVector< Scalar >::initialize ( const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &  productSpace,
const RCP< const MultiVectorBase< Scalar > > &  multiVec 
)

Initialize with a const multi-vector.

Definition at line 78 of file Thyra_DefaultMultiVectorProductVector_def.hpp.

References THYRA_ASSERT_VEC_SPACES.

template<class Scalar >
RCP< MultiVectorBase< Scalar > > Thyra::DefaultMultiVectorProductVector< Scalar >::getNonconstMultiVector ( )

Definition at line 104 of file Thyra_DefaultMultiVectorProductVector_def.hpp.

template<class Scalar >
RCP< const MultiVectorBase< Scalar > > Thyra::DefaultMultiVectorProductVector< Scalar >::getMultiVector ( ) const

Definition at line 112 of file Thyra_DefaultMultiVectorProductVector_def.hpp.

template<class Scalar >
void Thyra::DefaultMultiVectorProductVector< Scalar >::uninitialize ( )

Definition at line 119 of file Thyra_DefaultMultiVectorProductVector_def.hpp.

template<class Scalar >
std::string Thyra::DefaultMultiVectorProductVector< Scalar >::description ( ) const [virtual]

Reimplemented from Thyra::VectorDefaultBase< Scalar >.

Definition at line 131 of file Thyra_DefaultMultiVectorProductVector_def.hpp.

template<class Scalar >
void Thyra::DefaultMultiVectorProductVector< Scalar >::describe ( Teuchos::FancyOStream &  out,
const Teuchos::EVerbosityLevel  verbLevel 
) const [virtual]

Reimplemented from Thyra::VectorDefaultBase< Scalar >.

Definition at line 144 of file Thyra_DefaultMultiVectorProductVector_def.hpp.

template<class Scalar >
RCP< VectorBase< Scalar > > Thyra::DefaultMultiVectorProductVector< Scalar >::getNonconstVectorBlock ( const int  k) [virtual]

Implements Thyra::ProductVectorBase< Scalar >.

Definition at line 182 of file Thyra_DefaultMultiVectorProductVector_def.hpp.

template<class Scalar >
RCP< const VectorBase< Scalar > > Thyra::DefaultMultiVectorProductVector< Scalar >::getVectorBlock ( const int  k) const [virtual]

Implements Thyra::ProductVectorBase< Scalar >.

Definition at line 193 of file Thyra_DefaultMultiVectorProductVector_def.hpp.

template<class Scalar >
RCP< const ProductVectorSpaceBase< Scalar > > Thyra::DefaultMultiVectorProductVector< Scalar >::productSpace ( ) const [virtual]

Implements Thyra::ProductMultiVectorBase< Scalar >.

Definition at line 207 of file Thyra_DefaultMultiVectorProductVector_def.hpp.

template<class Scalar >
bool Thyra::DefaultMultiVectorProductVector< Scalar >::blockIsConst ( const int  k) const [virtual]

Implements Thyra::ProductMultiVectorBase< Scalar >.

Definition at line 214 of file Thyra_DefaultMultiVectorProductVector_def.hpp.

template<class Scalar >
RCP< MultiVectorBase< Scalar > > Thyra::DefaultMultiVectorProductVector< Scalar >::getNonconstMultiVectorBlock ( const int  k) [virtual]

Implements Thyra::ProductMultiVectorBase< Scalar >.

Definition at line 225 of file Thyra_DefaultMultiVectorProductVector_def.hpp.

template<class Scalar >
RCP< const MultiVectorBase< Scalar > > Thyra::DefaultMultiVectorProductVector< Scalar >::getMultiVectorBlock ( const int  k) const [virtual]

Implements Thyra::ProductMultiVectorBase< Scalar >.

Definition at line 233 of file Thyra_DefaultMultiVectorProductVector_def.hpp.

template<class Scalar >
RCP< const VectorSpaceBase< Scalar > > Thyra::DefaultMultiVectorProductVector< Scalar >::space ( ) const [virtual]

Implements Thyra::VectorBase< Scalar >.

Definition at line 244 of file Thyra_DefaultMultiVectorProductVector_def.hpp.

template<class Scalar >
void Thyra::DefaultMultiVectorProductVector< Scalar >::applyOpImpl ( const RTOpPack::RTOpT< Scalar > &  op,
const ArrayView< const Ptr< const VectorBase< Scalar > > > &  vecs,
const ArrayView< const Ptr< VectorBase< Scalar > > > &  targ_vecs,
const Ptr< RTOpPack::ReductTarget > &  reduct_obj,
const Ordinal  global_offset 
) const [protected, virtual]

Implements Thyra::VectorBase< Scalar >.

Definition at line 257 of file Thyra_DefaultMultiVectorProductVector_def.hpp.

template<class Scalar >
void Thyra::DefaultMultiVectorProductVector< Scalar >::acquireDetachedVectorViewImpl ( const Range1D &  rng,
RTOpPack::ConstSubVectorView< Scalar > *  sub_vec 
) const [protected, virtual]

Reimplemented from Thyra::VectorDefaultBase< Scalar >.

Definition at line 271 of file Thyra_DefaultMultiVectorProductVector_def.hpp.

template<class Scalar >
void Thyra::DefaultMultiVectorProductVector< Scalar >::releaseDetachedVectorViewImpl ( RTOpPack::ConstSubVectorView< Scalar > *  sub_vec) const [protected, virtual]

Reimplemented from Thyra::VectorDefaultBase< Scalar >.

Definition at line 280 of file Thyra_DefaultMultiVectorProductVector_def.hpp.

template<class Scalar >
void Thyra::DefaultMultiVectorProductVector< Scalar >::acquireNonconstDetachedVectorViewImpl ( const Range1D &  rng,
RTOpPack::SubVectorView< Scalar > *  sub_vec 
) [protected, virtual]

Reimplemented from Thyra::VectorDefaultBase< Scalar >.

Definition at line 289 of file Thyra_DefaultMultiVectorProductVector_def.hpp.

template<class Scalar >
void Thyra::DefaultMultiVectorProductVector< Scalar >::commitNonconstDetachedVectorViewImpl ( RTOpPack::SubVectorView< Scalar > *  sub_vec) [protected, virtual]

Reimplemented from Thyra::VectorDefaultBase< Scalar >.

Definition at line 298 of file Thyra_DefaultMultiVectorProductVector_def.hpp.

template<class Scalar >
void Thyra::DefaultMultiVectorProductVector< Scalar >::setSubVectorImpl ( const RTOpPack::SparseSubVectorT< Scalar > &  sub_vec) [protected, virtual]

Reimplemented from Thyra::VectorDefaultBase< Scalar >.

Definition at line 307 of file Thyra_DefaultMultiVectorProductVector_def.hpp.

template<class Scalar >
RCP< const DefaultProductVector< Scalar > > Thyra::DefaultMultiVectorProductVector< Scalar >::getDefaultProductVector ( ) const [private]

Definition at line 320 of file Thyra_DefaultMultiVectorProductVector_def.hpp.

Friends And Related Function Documentation

template<class Scalar >
RCP< DefaultMultiVectorProductVector< Scalar > > multiVectorProductVector ( const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &  productSpace,
const RCP< MultiVectorBase< Scalar > > &  multiVec 
) [related]

Nonmember constructor that just wraps an existing non-const MultiVector as a non-const product vector.

Definition at line 214 of file Thyra_DefaultMultiVectorProductVector_decl.hpp.

template<class Scalar >
RCP< const DefaultMultiVectorProductVector< Scalar > > multiVectorProductVector ( const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &  productSpace,
const RCP< const MultiVectorBase< Scalar > > &  multiVec 
) [related]

Nonmember constructor that just wraps an existing const MultiVector as a const product vector.

Definition at line 234 of file Thyra_DefaultMultiVectorProductVector_decl.hpp.

template<class Scalar >
RCP< DefaultMultiVectorProductVector< Scalar > > multiVectorProductVector ( const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &  productSpace) [related]

Nonmember constructor that creates a new uninitialized product vector represented underneath as a multi-vector.

Definition at line 258 of file Thyra_DefaultMultiVectorProductVector_decl.hpp.

Member Data Documentation

template<class Scalar >
int Thyra::DefaultMultiVectorProductVector< Scalar >::numBlocks_ [private]

Definition at line 193 of file Thyra_DefaultMultiVectorProductVector_decl.hpp.

template<class Scalar >
RCP<const DefaultMultiVectorProductVectorSpace<Scalar> > Thyra::DefaultMultiVectorProductVector< Scalar >::productSpace_ [private]

Definition at line 194 of file Thyra_DefaultMultiVectorProductVector_decl.hpp.

template<class Scalar >
CNMVC Thyra::DefaultMultiVectorProductVector< Scalar >::multiVec_ [private]

Definition at line 195 of file Thyra_DefaultMultiVectorProductVector_decl.hpp.

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Fri Apr 6 2012 for Thyra Package Browser (Single Doxygen Collection) by  doxygen 1.7.4