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

Convenient node subclass for concrete VectorBase subclasses that relies on a default MultiVectorBase implementation. More...

#include <Thyra_VectorDefaultBaseDecl.hpp>

Inheritance diagram for Thyra::VectorDefaultBase< Scalar >:

[legend]List of all members.


Public functions overridden from Teuchos::Describable
virtual std::string	description () const
	Default description that gives the label, type, and dimenstion .
virtual void	describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const
	Generates a default outputting for all vectors.
Overridden from LinearOpBase (should never need to be overridden in subclasses)
virtual RCP< const VectorSpaceBase< Scalar > >	range () const
	Returns `this->space()`.
virtual RCP< const VectorSpaceBase< Scalar > >	domain () const
	Returns a `DefaultSerialVectorSpace` object with dimension 1.
Overridden from MultiVectorBase (should never need to be overridden in subclasses)
RCP< MultiVectorBase< Scalar > >	clone_mv () const
	Returns `this->clone_v()`.
Overridden from VectorBase
RCP< VectorBase< Scalar > >	clone_v () const
	Simply creates a new vector and copies the contents from `*this`.
Overridden protected functions from MultiVectorBase
virtual RCP< VectorBase< Scalar > >	nonconstColImpl (Index j)
	Returns `Teuchos::rcp(this,false)`.
virtual RCP< const MultiVectorBase< Scalar > >	contigSubViewImpl (const Range1D &col_rng) const
	Returns `Teuchos::rcp(this,false)`.
virtual RCP< MultiVectorBase< Scalar > >	nonconstContigSubViewImpl (const Range1D &col_rng)
	Returns `Teuchos::rcp(this,false)`.
virtual RCP< const MultiVectorBase< Scalar > >	nonContigSubViewImpl (const ArrayView< const int > &cols) const
	Returns `Teuchos::rcp(this,false)`.
virtual RCP< MultiVectorBase< Scalar > >	nonconstNonContigSubViewImpl (const ArrayView< const int > &cols)
	Returns `Teuchos::rcp(this,false)`.
virtual void	acquireDetachedMultiVectorViewImpl (const Range1D &rowRng, const Range1D &colRng, RTOpPack::ConstSubMultiVectorView< Scalar > *sub_mv) const
	Implemented in terms of `this->acquireDetachedView()`.
virtual void	releaseDetachedMultiVectorViewImpl (RTOpPack::ConstSubMultiVectorView< Scalar > *sub_mv) const
	Implemented in terms of `this->releaseDetachedView()`.
virtual void	acquireNonconstDetachedMultiVectorViewImpl (const Range1D &rowRng, const Range1D &colRng, RTOpPack::SubMultiVectorView< Scalar > *sub_mv)
	Implemented in terms of `this->acquireDetachedView()`.
virtual void	commitNonconstDetachedMultiVectorViewImpl (RTOpPack::SubMultiVectorView< Scalar > *sub_mv)
	Implemented in terms of `this->commitDetachedView()`.
Overridden protected functions from VectorBase
virtual void	acquireDetachedVectorViewImpl (const Range1D &rng, RTOpPack::ConstSubVectorView< Scalar > *sub_vec) const

virtual void	releaseDetachedVectorViewImpl (RTOpPack::ConstSubVectorView< Scalar > *sub_vec) const

virtual void	acquireNonconstDetachedVectorViewImpl (const Range1D &rng, RTOpPack::SubVectorView< Scalar > *sub_vec)

virtual void	commitNonconstDetachedVectorViewImpl (RTOpPack::SubVectorView< Scalar > *sub_vec)

virtual void	setSubVectorImpl (const RTOpPack::SparseSubVectorT< Scalar > &sub_vec)

Overridden protected functions from SingleRhsLinearOpBase.
These functions should never need to be overridden in subclasses
bool	opSupported (EOpTransp 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 EOpTransp M_trans, const VectorBase< Scalar > &x, VectorBase< Scalar > *y, const Scalar alpha, const Scalar beta) const
	. Applies vector or its adjoint (transpose) as a linear operator.

Detailed Description

template<class Scalar>
class Thyra::VectorDefaultBase< Scalar >

Convenient node subclass for concrete VectorBase subclasses that relies on a default MultiVectorBase implementation.

This node subclass provides as many default implementations as possible for virtual functions based on the default multi-vector implementation DefaultColumnwiseMultiVector.

Notes for subclass developers

In order to create a concrete subclass of this interface, only two operations must be overridden: space() and applyOp(). Overriding the space() operation requires defining a concrete VectorSpaceBase class (which has only three pure virtual operations if using VectorSpaceDefaultBase).

Note that all of the inherited LinearOpBase and MultiVectorBase functions are overridden in this subclass and are given perfectly good implementations. Therefore, a concrete subclass of VectorDefaultBase should not have to re-override any of these functions.

Definition at line 63 of file Thyra_VectorDefaultBaseDecl.hpp.

Member Function Documentation

template<class Scalar>

std::string Thyra::VectorDefaultBase< Scalar >::description ( ) const [virtual]

Default description that gives the label, type, and dimenstion .

Reimplemented from Thyra::LinearOpDefaultBase< Scalar >.

Reimplemented in Thyra::DefaultMultiVectorProductVector< Scalar >, Thyra::DefaultProductVector< Scalar >, and Thyra::SpmdVectorBase< Scalar >.

Definition at line 65 of file Thyra_VectorDefaultBase.hpp.

template<class Scalar>

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

Generates a default outputting for all vectors.

Calls on the this->describe(void) function for the name of the class (and possibly its instance name) and then if verbLevel>=VERB_HIGH, then the vector elements themselves are printed as well. The format of the output is is shown below:

   type = 'this->description()', size = n
     0:x1
     1:x2
     .
     .
     .
     n-1:xn

The index:value lines are offset an additional Teuchos::OSTab amount. A newline is printed after the last n-1:xn entry.

Reimplemented from Thyra::LinearOpDefaultBase< Scalar >.

Reimplemented in Thyra::DefaultMultiVectorProductVector< Scalar >, and Thyra::DefaultProductVector< Scalar >.

Definition at line 83 of file Thyra_VectorDefaultBase.hpp.

template<class Scalar>

RCP< const VectorSpaceBase< Scalar > > Thyra::VectorDefaultBase< Scalar >::range ( ) const [virtual]

Returns this->space().

Implements Thyra::LinearOpBase< RangeScalar, DomainScalar >.

Definition at line 109 of file Thyra_VectorDefaultBase.hpp.

template<class Scalar>

RCP< const VectorSpaceBase< Scalar > > Thyra::VectorDefaultBase< Scalar >::domain ( ) const [virtual]

Returns a DefaultSerialVectorSpace object with dimension 1.

Implements Thyra::LinearOpBase< RangeScalar, DomainScalar >.

Definition at line 123 of file Thyra_VectorDefaultBase.hpp.

template<class Scalar>

RCP< MultiVectorBase< Scalar > > Thyra::VectorDefaultBase< Scalar >::clone_mv ( ) const [virtual]

Returns this->clone_v().

Reimplemented from Thyra::MultiVectorDefaultBase< Scalar >.

Definition at line 143 of file Thyra_VectorDefaultBase.hpp.

template<class Scalar>

RCP< VectorBase< Scalar > > Thyra::VectorDefaultBase< Scalar >::clone_v ( ) const [virtual]

Simply creates a new vector and copies the contents from *this.

Implements Thyra::VectorBase< Scalar >.

Definition at line 160 of file Thyra_VectorDefaultBase.hpp.

template<class Scalar>

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