Thyra::MultiVectorCols< Scalar > Class Template Reference

Default subclass for MultiVectorBase implemented using columns of separate abstract vectors. More...

#include <Thyra_MultiVectorColsDecl.hpp>

Inheritance diagram for Thyra::MultiVectorCols< Scalar >:

[legend]List of all members.

Constructors/Initializers
	MultiVectorCols ()
	Construct to initialized.
	MultiVectorCols (const Teuchos::RefCountPtr< VectorBase< Scalar > > &col_vec)
	Calls initialize().
	MultiVectorCols (const Teuchos::RefCountPtr< const VectorSpaceBase< Scalar > > &range, const Teuchos::RefCountPtr< const VectorSpaceBase< Scalar > > &domain, const Teuchos::RefCountPtr< VectorBase< Scalar > > col_vecs[]=NULL)
	Calls initialize().
void	initialize (const Teuchos::RefCountPtr< VectorBase< Scalar > > &col_vec)
	Initialize given a single vector object.
void	initialize (const Teuchos::RefCountPtr< const VectorSpaceBase< Scalar > > &range, const Teuchos::RefCountPtr< const VectorSpaceBase< Scalar > > &domain, const Teuchos::RefCountPtr< VectorBase< Scalar > > col_vecs[]=NULL)
	Initialize given the spaces for the columns and rows and possibly the column vectors.
void	set_uninitialized ()
	Set uninitialized.
Overridden from OpBase
Teuchos::RefCountPtr< const VectorSpaceBase< Scalar > >	range () const
Teuchos::RefCountPtr< const VectorSpaceBase< Scalar > >	domain () const
Overridden from MultiVectorBase
Teuchos::RefCountPtr< VectorBase< Scalar > >	col (Index j)
Teuchos::RefCountPtr< MultiVectorBase< Scalar > >	subView (const Range1D &col_rng)
Overridden from SingleRhsLinearOpBase
bool	opSupported (ETransp M_trans) const
	For complex Scalar types returns true for NOTRANS and CONJTRANS and for real types returns true for all values of M_trans.
void	apply (const ETransp M_trans, const VectorBase< Scalar > &x, VectorBase< Scalar > *y, const Scalar alpha, const Scalar beta) const
	This function is implemented in terms of the multi-vector applyOp() function.

---

Detailed Description

template<class Scalar>
class Thyra::MultiVectorCols< Scalar >

Default subclass for MultiVectorBase implemented using columns of separate abstract vectors.

This is a very bad implementation of a multi-vector but this will work in situations where you need a multi-vector but some underlying linear algebra library does not directly support them.

This subclass can be used to represent a MultiVectorBase wrapper around a single VectorBase object so that a single vector can be passed to a method that expects a MultiVectorBase object.

Definition at line 52 of file Thyra_MultiVectorColsDecl.hpp.

---

Constructor & Destructor Documentation

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

Construct to initialized. Postconditions: this->range().get() == NULL this->domain().get() == NULL Definition at line 42 of file Thyra_MultiVectorCols.hpp.

template<class Scalar> Thyra::MultiVectorCols< Scalar >::MultiVectorCols (  const Teuchos::RefCountPtr< VectorBase< Scalar > > &  col_vec  )

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

template<class Scalar> Thyra::MultiVectorCols< Scalar >::MultiVectorCols (  const Teuchos::RefCountPtr< const VectorSpaceBase< Scalar > > &  range, const Teuchos::RefCountPtr< const VectorSpaceBase< Scalar > > &  domain, const Teuchos::RefCountPtr< VectorBase< Scalar > >  col_vecs[] = NULL )

Calls initialize(). Definition at line 54 of file Thyra_MultiVectorCols.hpp.

---

Member Function Documentation

template<class Scalar> void Thyra::MultiVectorCols< Scalar >::initialize (  const Teuchos::RefCountPtr< VectorBase< Scalar > > &  col_vec  )

Initialize given a single vector object. Parameters: col_vec  [in] A single column vector. It is not allowed for col_vecs==NULL. Preconditions: col_vec.get() != NULL (throw std::invalid_argument) col_vec->dim() > 0 (throw std::invalid_argument) Postconditions: this->range().get() == col_vec.space().get() this->domain()->dim() == 1 this->col(1).get() == col_vec.get() Definition at line 64 of file Thyra_MultiVectorCols.hpp.

template<class Scalar> void Thyra::MultiVectorCols< Scalar >::initialize (  const Teuchos::RefCountPtr< const VectorSpaceBase< Scalar > > &  range, const Teuchos::RefCountPtr< const VectorSpaceBase< Scalar > > &  domain, const Teuchos::RefCountPtr< VectorBase< Scalar > >  col_vecs[] = NULL )

Initialize given the spaces for the columns and rows and possibly the column vectors. Parameters: range  [in] The space that the columns must lie in. The underlying vector space must not be changed while this is in use. domain  [in] The space that the rows must lie in. The underlying vector space must not be changed while this is in use. What this argument really specifies is what vector type will be compatible with the vectors that the client may try to use to interact with the rows of this multivector. col_vecs  [in] Array (size domain->dim()) of column vectors to use for the columns of this. It is allowed for col_vecs==NULL in which case range->createMember() will be used to create the columns of this. Preconditions: range.get() != NULL (throw std::invalid_argument) domain.get() != NULL (throw std::invalid_argument) range->dim() > 0 (throw std::invalid_argument) domain->dim() > 0 (throw std::invalid_argument) [col_vecs != NULL] col_vecs[j-1].get() != NULL && col_vecs[j-1]->space()->is_compatible(*range) == true, for j=1..domain->dim() Postconditions: this->range().get() == range.get() this->domain().get() == domain.get() [col_vecs != NULL] this->col(j).get() == col_vecs[j-1].get(), for j=1..domain->dim() Definition at line 81 of file Thyra_MultiVectorCols.hpp.

template<class Scalar> void Thyra::MultiVectorCols< Scalar >::set_uninitialized (   )

Set uninitialized. Definition at line 110 of file Thyra_MultiVectorCols.hpp.

template<class Scalar> Teuchos::RefCountPtr< const VectorSpaceBase< Scalar > > Thyra::MultiVectorCols< Scalar >::range (   )  const

Definition at line 121 of file Thyra_MultiVectorCols.hpp.

template<class Scalar> Teuchos::RefCountPtr< const VectorSpaceBase< Scalar > > Thyra::MultiVectorCols< Scalar >::domain (   )  const

Definition at line 128 of file Thyra_MultiVectorCols.hpp.

template<class Scalar> Teuchos::RefCountPtr< VectorBase< Scalar > > Thyra::MultiVectorCols< Scalar >::col (  Index  j  )

Definition at line 193 of file Thyra_MultiVectorCols.hpp.

template<class Scalar> Teuchos::RefCountPtr< MultiVectorBase< Scalar > > Thyra::MultiVectorCols< Scalar >::subView (  const Range1D &  col_rng  )

Reimplemented from Thyra::MultiVectorDefaultBase< Scalar >. Definition at line 204 of file Thyra_MultiVectorCols.hpp.

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

For complex Scalar types returns true for NOTRANS and CONJTRANS and for real types returns true for all values of M_trans. Implements Thyra::SingleScalarLinearOpBase< Scalar >. Definition at line 136 of file Thyra_MultiVectorCols.hpp.

template<class Scalar> void Thyra::MultiVectorCols< Scalar >::apply (  const ETransp  M_trans, const VectorBase< Scalar > &  x, VectorBase< Scalar > *  y, const Scalar  alpha, const Scalar  beta )  const [protected, virtual]

This function is implemented in terms of the multi-vector applyOp() function. The implementation takes care of two types of operations. One (M_trans==TRANS) is the block dot product of two vectors to form scalar (stored as the vector y which as one component). The other (M_trans==NOTRANS) is essentially an axpy operation where x is a vector with one element. Both of these operations are performed using reduction/transformation operators. This implementation is near optimal but the default implementation of the multi-vector version of apply() as implemented in the base class LinearOpBase will not be a near optimal implementation in its current form do to multiple, sequential reductions but it could be made to be with a little work. Implements Thyra::SingleRhsLinearOpBase< Scalar >. Definition at line 143 of file Thyra_MultiVectorCols.hpp.

---

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

• Thyra_MultiVectorColsDecl.hpp
• Thyra_MultiVectorCols.hpp

---