Thyra::DefaultProductMultiVector< Scalar > Class Template Reference
[Development of linear Abstract Numerical Algorithms (ANAs)]

Concrete implementation of a product multi-vector. More...

#include <Thyra_DefaultProductMultiVectorDecl.hpp>

Inheritance diagram for Thyra::DefaultProductMultiVector< Scalar >:

Inheritance graph
[legend]
List of all members.

Constructors/initializers/accessors

 DefaultProductMultiVector (const RCP< const DefaultProductVectorSpace< Scalar > > &productSpace, const int numMembers)
 Constructs to initialized (calls initialize()).
 DefaultProductMultiVector (const RCP< const DefaultProductVectorSpace< Scalar > > &productSpace, const ArrayView< const RCP< MultiVectorBase< Scalar > > > &multiVecs)
 Constructs to initialized (calls initialize()).
 DefaultProductMultiVector (const RCP< const DefaultProductVectorSpace< Scalar > > &productSpace, const ArrayView< const RCP< const MultiVectorBase< Scalar > > > &multiVecs)
 Constructs to initialized (calls initialize()).
void initialize (const RCP< const DefaultProductVectorSpace< Scalar > > &productSpace, const int numMembers)
 
void initialize (const RCP< const DefaultProductVectorSpace< Scalar > > &productSpace, const ArrayView< const RCP< MultiVectorBase< Scalar > > > &multiVecs)
 
void initialize (const RCP< const DefaultProductVectorSpace< Scalar > > &productSpace, const ArrayView< const RCP< const MultiVectorBase< Scalar > > > &multiVecs)
 
void uninitialize ()
 Uninitialize.

Overridden public functions from Teuchos::Describable

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

Overridden public functions 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
 

Overriden public functions from MultiVectorBase

RCP< MultiVectorBase< Scalar > > clone_mv () const
 

Overriden from LinearOpBase

RCP< const VectorSpaceBase<
Scalar > > 
range () const
 
RCP< const VectorSpaceBase<
Scalar > > 
domain () const
 

Overriden protected functions from MultiVectorBase

RCP< const VectorBase< Scalar > > colImpl (Index j) const
 
RCP< VectorBase< Scalar > > nonconstColImpl (Index j)
 
RCP< const MultiVectorBase<
Scalar > > 
contigSubViewImpl (const Range1D &colRng) const
 
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)
 
void mvMultiReductApplyOpImpl (const RTOpPack::RTOpT< Scalar > &primary_op, const ArrayView< const Ptr< const MultiVectorBase< Scalar > > > &multi_vecs, const ArrayView< const Ptr< MultiVectorBase< Scalar > > > &targ_multi_vecs, const ArrayView< const Ptr< RTOpPack::ReductTarget > > &reduct_objs, const Index primary_first_ele_offset, const Index primary_sub_dim, const Index primary_global_offset, const Index secondary_first_ele_offset, const Index secondary_sub_dim) const
 
void acquireDetachedMultiVectorViewImpl (const Range1D &rowRng, const Range1D &colRng, RTOpPack::ConstSubMultiVectorView< Scalar > *sub_mv) const
 
void releaseDetachedMultiVectorViewImpl (RTOpPack::ConstSubMultiVectorView< Scalar > *sub_mv) const
 
void acquireNonconstDetachedMultiVectorViewImpl (const Range1D &rowRng, const Range1D &colRng, RTOpPack::SubMultiVectorView< Scalar > *sub_mv)
 
void commitNonconstDetachedMultiVectorViewImpl (RTOpPack::SubMultiVectorView< Scalar > *sub_mv)
 

Overridden from SingleScalarLinearOpBase

bool opSupported (EOpTransp M_trans) const
 
void apply (const EOpTransp M_trans, const MultiVectorBase< Scalar > &X, MultiVectorBase< Scalar > *Y, const Scalar alpha, const Scalar beta) const
 

Related Functions

(Note that these are not member functions.)

RCP< DefaultProductMultiVector<
Scalar > > 
defaultProductMultiVector (const RCP< const DefaultProductVectorSpace< Scalar > > &productSpace, const int numMembers)
 Nonmember constructor.
RCP< DefaultProductMultiVector<
Scalar > > 
defaultProductMultiVector (const RCP< const DefaultProductVectorSpace< Scalar > > &productSpace, const ArrayView< const RCP< MultiVectorBase< Scalar > > > &multiVecs)
 Nonmember constructor.
RCP< DefaultProductMultiVector<
Scalar > > 
defaultProductMultiVector (const RCP< const DefaultProductVectorSpace< Scalar > > &productSpace, const ArrayView< const RCP< const MultiVectorBase< Scalar > > > &multiVecs)
 Nonmember constructor.

Detailed Description

template<class Scalar>
class Thyra::DefaultProductMultiVector< Scalar >

Concrete implementation of a product multi-vector.

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

ToDo: Finish documentation!

The default constructor is made private to avoid accidental default construction.

Definition at line 59 of file Thyra_DefaultProductMultiVectorDecl.hpp.


Constructor & Destructor Documentation

template<class Scalar>
Thyra::DefaultProductMultiVector< Scalar >::DefaultProductMultiVector ( const RCP< const DefaultProductVectorSpace< Scalar > > &  productSpace,
const int  numMembers 
)

Constructs to initialized (calls initialize()).

Definition at line 45 of file Thyra_DefaultProductMultiVector.hpp.

template<class Scalar>
Thyra::DefaultProductMultiVector< Scalar >::DefaultProductMultiVector ( const RCP< const DefaultProductVectorSpace< Scalar > > &  productSpace,
const ArrayView< const RCP< MultiVectorBase< Scalar > > > &  multiVecs 
)

Constructs to initialized (calls initialize()).

Definition at line 56 of file Thyra_DefaultProductMultiVector.hpp.

template<class Scalar>
Thyra::DefaultProductMultiVector< Scalar >::DefaultProductMultiVector ( const RCP< const DefaultProductVectorSpace< Scalar > > &  productSpace,
const ArrayView< const RCP< const MultiVectorBase< Scalar > > > &  multiVecs 
)

Constructs to initialized (calls initialize()).

Definition at line 67 of file Thyra_DefaultProductMultiVector.hpp.


Member Function Documentation

template<class Scalar>
void Thyra::DefaultProductMultiVector< Scalar >::initialize ( const RCP< const DefaultProductVectorSpace< Scalar > > &  productSpace,
const int  numMembers 
)

Definition at line 78 of file Thyra_DefaultProductMultiVector.hpp.

template<class Scalar>
void Thyra::DefaultProductMultiVector< Scalar >::initialize ( const RCP< const DefaultProductVectorSpace< Scalar > > &  productSpace,
const ArrayView< const RCP< MultiVectorBase< Scalar > > > &  multiVecs 
)

Definition at line 96 of file Thyra_DefaultProductMultiVector.hpp.

template<class Scalar>
void Thyra::DefaultProductMultiVector< Scalar >::initialize ( const RCP< const DefaultProductVectorSpace< Scalar > > &  productSpace,
const ArrayView< const RCP< const MultiVectorBase< Scalar > > > &  multiVecs 
)

Definition at line 106 of file Thyra_DefaultProductMultiVector.hpp.

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

Uninitialize.

ToDo: Finish documentation.

Definition at line 116 of file Thyra_DefaultProductMultiVector.hpp.

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

Reimplemented from Thyra::LinearOpDefaultBase< Scalar >.

Definition at line 128 of file Thyra_DefaultProductMultiVector.hpp.

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

Reimplemented from Thyra::LinearOpDefaultBase< Scalar >.

Definition at line 143 of file Thyra_DefaultProductMultiVector.hpp.

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

Implements Thyra::ProductMultiVectorBase< Scalar >.

Definition at line 191 of file Thyra_DefaultProductMultiVector.hpp.

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

Implements Thyra::ProductMultiVectorBase< Scalar >.

Definition at line 198 of file Thyra_DefaultProductMultiVector.hpp.

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

Implements Thyra::ProductMultiVectorBase< Scalar >.

Definition at line 206 of file Thyra_DefaultProductMultiVector.hpp.

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

Implements Thyra::ProductMultiVectorBase< Scalar >.

Definition at line 214 of file Thyra_DefaultProductMultiVector.hpp.

template<class Scalar>
RCP< MultiVectorBase< Scalar > > Thyra::DefaultProductMultiVector< Scalar >::clone_mv (  )  const [virtual]

Reimplemented from Thyra::MultiVectorDefaultBase< Scalar >.

Definition at line 225 of file Thyra_DefaultProductMultiVector.hpp.

template<class Scalar>
RCP< const VectorSpaceBase< Scalar > > Thyra::DefaultProductMultiVector< Scalar >::range (  )  const [virtual]

Implements Thyra::LinearOpBase< RangeScalar, DomainScalar >.

Definition at line 240 of file Thyra_DefaultProductMultiVector.hpp.

template<class Scalar>
RCP< const VectorSpaceBase< Scalar > > Thyra::DefaultProductMultiVector< Scalar >::domain (  )  const [virtual]

Implements Thyra::LinearOpBase< RangeScalar, DomainScalar >.

Definition at line 248 of file Thyra_DefaultProductMultiVector.hpp.

template<class Scalar>
RCP< const VectorBase< Scalar > > Thyra::DefaultProductMultiVector< Scalar >::colImpl ( Index  j  )  const [protected, virtual]

Reimplemented from Thyra::MultiVectorBase< Scalar >.

Definition at line 264 of file Thyra_DefaultProductMultiVector.hpp.

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

Implements Thyra::MultiVectorBase< Scalar >.

Definition at line 276 of file Thyra_DefaultProductMultiVector.hpp.

template<class Scalar>
RCP< const MultiVectorBase< Scalar > > Thyra::DefaultProductMultiVector< Scalar >::contigSubViewImpl ( const Range1D colRng  )  const [protected, virtual]

Reimplemented from Thyra::MultiVectorDefaultBase< Scalar >.

Definition at line 288 of file Thyra_DefaultProductMultiVector.hpp.

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

Reimplemented from Thyra::MultiVectorDefaultBase< Scalar >.

Definition at line 300 of file Thyra_DefaultProductMultiVector.hpp.

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

Reimplemented from Thyra::MultiVectorDefaultBase< Scalar >.

Definition at line 312 of file Thyra_DefaultProductMultiVector.hpp.

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

Reimplemented from Thyra::MultiVectorDefaultBase< Scalar >.

Definition at line 326 of file Thyra_DefaultProductMultiVector.hpp.

template<class Scalar>
void Thyra::DefaultProductMultiVector< Scalar >::mvMultiReductApplyOpImpl ( const RTOpPack::RTOpT< Scalar > &  primary_op,
const ArrayView< const Ptr< const MultiVectorBase< Scalar > > > &  multi_vecs,
const ArrayView< const Ptr< MultiVectorBase< Scalar > > > &  targ_multi_vecs,
const ArrayView< const Ptr< RTOpPack::ReductTarget > > &  reduct_objs,
const Index  primary_first_ele_offset,
const Index  primary_sub_dim,
const Index  primary_global_offset,
const Index  secondary_first_ele_offset,
const Index  secondary_sub_dim 
) const [protected, virtual]

Reimplemented from Thyra::MultiVectorDefaultBase< Scalar >.

Definition at line 339 of file Thyra_DefaultProductMultiVector.hpp.

template<class Scalar>
void Thyra::DefaultProductMultiVector< Scalar >::acquireDetachedMultiVectorViewImpl ( const Range1D rowRng,
const Range1D colRng,
RTOpPack::ConstSubMultiVectorView< Scalar > *  sub_mv 
) const [protected, virtual]

Reimplemented from Thyra::MultiVectorDefaultBase< Scalar >.

Definition at line 554 of file Thyra_DefaultProductMultiVector.hpp.

template<class Scalar>
void Thyra::DefaultProductMultiVector< Scalar >::releaseDetachedMultiVectorViewImpl ( RTOpPack::ConstSubMultiVectorView< Scalar > *  sub_mv  )  const [protected, virtual]

Reimplemented from Thyra::MultiVectorDefaultBase< Scalar >.

Definition at line 567 of file Thyra_DefaultProductMultiVector.hpp.

template<class Scalar>
void Thyra::DefaultProductMultiVector< Scalar >::acquireNonconstDetachedMultiVectorViewImpl ( const Range1D rowRng,
const Range1D colRng,
RTOpPack::SubMultiVectorView< Scalar > *  sub_mv 
) [protected, virtual]

Reimplemented from Thyra::MultiVectorDefaultBase< Scalar >.

Definition at line 578 of file Thyra_DefaultProductMultiVector.hpp.

template<class Scalar>
void Thyra::DefaultProductMultiVector< Scalar >::commitNonconstDetachedMultiVectorViewImpl ( RTOpPack::SubMultiVectorView< Scalar > *  sub_mv  )  [protected, virtual]

Reimplemented from Thyra::MultiVectorDefaultBase< Scalar >.

Definition at line 591 of file Thyra_DefaultProductMultiVector.hpp.

template<class Scalar>
bool Thyra::DefaultProductMultiVector< Scalar >::opSupported ( EOpTransp  M_trans  )  const [protected, virtual]

Implements Thyra::SingleScalarLinearOpBase< Scalar >.

Definition at line 604 of file Thyra_DefaultProductMultiVector.hpp.

template<class Scalar>
void Thyra::DefaultProductMultiVector< Scalar >::apply ( const EOpTransp  M_trans,
const MultiVectorBase< Scalar > &  X,
MultiVectorBase< Scalar > *  Y,
const Scalar  alpha,
const Scalar  beta 
) const [protected, virtual]

Implements Thyra::SingleScalarLinearOpBase< Scalar >.

Definition at line 611 of file Thyra_DefaultProductMultiVector.hpp.


Friends And Related Function Documentation

template<class Scalar>
RCP< DefaultProductMultiVector< Scalar > > defaultProductMultiVector ( const RCP< const DefaultProductVectorSpace< Scalar > > &  productSpace,
const int  numMembers 
) [related]

Nonmember constructor.

Definition at line 281 of file Thyra_DefaultProductMultiVectorDecl.hpp.

template<class Scalar>
RCP< DefaultProductMultiVector< Scalar > > defaultProductMultiVector ( const RCP< const DefaultProductVectorSpace< Scalar > > &  productSpace,
const ArrayView< const RCP< MultiVectorBase< Scalar > > > &  multiVecs 
) [related]

Nonmember constructor.

Definition at line 298 of file Thyra_DefaultProductMultiVectorDecl.hpp.

template<class Scalar>
RCP< DefaultProductMultiVector< Scalar > > defaultProductMultiVector ( const RCP< const DefaultProductVectorSpace< Scalar > > &  productSpace,
const ArrayView< const RCP< const MultiVectorBase< Scalar > > > &  multiVecs 
) [related]

Nonmember constructor.

Definition at line 315 of file Thyra_DefaultProductMultiVectorDecl.hpp.


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