Thyra Package Browser (Single Doxygen Collection) Version of the Day
Private Member Functions | Private Attributes
Thyra::VectorDefaultBase< Scalar > Class Template Reference

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

#include <Thyra_VectorDefaultBase_decl.hpp>

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

List of all members.

Private Member Functions

void validateColRng (const Range1D &rowRng) const
void validateColIndexes (const ArrayView< const int > &cols) const

Private Attributes

RCP< const VectorSpaceBase
< Scalar > > 
domain_

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

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

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 (Ordinal 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 LinearOpBase

bool opSupportedImpl (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 applyImpl (const EOpTransp M_trans, const MultiVectorBase< Scalar > &X, const Ptr< MultiVectorBase< 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.

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 60 of file Thyra_VectorDefaultBase_decl.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::SpmdVectorBase< Scalar >, Thyra::DefaultMultiVectorProductVector< Scalar >, and Thyra::DefaultProductVector< Scalar >.

Definition at line 65 of file Thyra_VectorDefaultBase_def.hpp.

References Teuchos::Describable::description(), and is_null().

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 82 of file Thyra_VectorDefaultBase_def.hpp.

References Thyra::ConstDetachedVectorView< Scalar >::subDim(), and Teuchos::VERB_HIGH.

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

Returns this->space().

Implements Thyra::LinearOpBase< Scalar >.

Definition at line 108 of file Thyra_VectorDefaultBase_def.hpp.

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

Returns a DefaultSerialVectorSpace object with dimension 1.

Implements Thyra::LinearOpBase< Scalar >.

Definition at line 122 of file Thyra_VectorDefaultBase_def.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 142 of file Thyra_VectorDefaultBase_def.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 159 of file Thyra_VectorDefaultBase_def.hpp.

References Thyra::assign(), Thyra::copy(), and Teuchos::RCP< T >::ptr().

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

Returns Teuchos::rcp(this,false).

Implements Thyra::MultiVectorBase< Scalar >.

Definition at line 181 of file Thyra_VectorDefaultBase_def.hpp.

References Teuchos::rcp().

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

Returns Teuchos::rcp(this,false).

Reimplemented from Thyra::MultiVectorDefaultBase< Scalar >.

Definition at line 197 of file Thyra_VectorDefaultBase_def.hpp.

References Teuchos::rcp().

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

Returns Teuchos::rcp(this,false).

Reimplemented from Thyra::MultiVectorDefaultBase< Scalar >.

Definition at line 212 of file Thyra_VectorDefaultBase_def.hpp.

References Teuchos::rcp().

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

Returns Teuchos::rcp(this,false).

Reimplemented from Thyra::MultiVectorDefaultBase< Scalar >.

Definition at line 227 of file Thyra_VectorDefaultBase_def.hpp.

References Teuchos::rcp().

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

Returns Teuchos::rcp(this,false).

Reimplemented from Thyra::MultiVectorDefaultBase< Scalar >.

Definition at line 243 of file Thyra_VectorDefaultBase_def.hpp.

References Teuchos::rcp().

template<class Scalar >
void Thyra::VectorDefaultBase< Scalar >::acquireDetachedMultiVectorViewImpl ( const Range1D rowRng,
const Range1D colRng,
RTOpPack::ConstSubMultiVectorView< Scalar > *  sub_mv 
) const [protected, virtual]
template<class Scalar >
void Thyra::VectorDefaultBase< Scalar >::releaseDetachedMultiVectorViewImpl ( RTOpPack::ConstSubMultiVectorView< Scalar > *  sub_mv) const [protected, virtual]
template<class Scalar >
void Thyra::VectorDefaultBase< Scalar >::acquireNonconstDetachedMultiVectorViewImpl ( const Range1D rowRng,
const Range1D colRng,
RTOpPack::SubMultiVectorView< Scalar > *  sub_mv 
) [protected, virtual]
template<class Scalar >
void Thyra::VectorDefaultBase< Scalar >::commitNonconstDetachedMultiVectorViewImpl ( RTOpPack::SubMultiVectorView< Scalar > *  sub_mv) [protected, virtual]
template<class Scalar >
void Thyra::VectorDefaultBase< Scalar >::acquireDetachedVectorViewImpl ( const Range1D rng,
RTOpPack::ConstSubVectorView< Scalar > *  sub_vec 
) const [protected, virtual]

This implementation is based on a vector reduction operator class (see RTOpPack::ROpGetSubVector) and calls applyOp(). Note that the footprint of the reduction object (both internal and external state) will be O(rng.size()). For serial applications this is fairly reasonable and will not be a major performance penalty. For parallel applications, however, this is a terrible implementation and must be overridden if rng.size() is large at all. Although, this function should not even be used in case where the vector is very large. If a subclass does override this function, it must also override releaseDetachedView() which has a implementation which is a companion to this function's implementation.

Implements Thyra::VectorBase< Scalar >.

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

Definition at line 344 of file Thyra_VectorDefaultBase_def.hpp.

References Teuchos::dyn_cast(), Teuchos::Range1D::full_range(), Teuchos::Range1D::lbound(), TEST_FOR_EXCEPTION, and Teuchos::Range1D::ubound().

Referenced by Thyra::SpmdVectorBase< Scalar >::acquireDetachedVectorViewImpl(), Thyra::DefaultProductVector< Scalar >::acquireDetachedVectorViewImpl(), and Thyra::VectorDefaultBase< Scalar >::acquireNonconstDetachedVectorViewImpl().

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

This implementation is based on a vector reduction operator class (see RTOpPack::ROpGetSubVector) and calls applyOp(). Note that the footprint of the reduction object (both internal and external state) will be O(rng.size()). For serial applications this is fairly reasonable and will not be a major performance penalty. For parallel applications, this will be a terrible thing to do and must be overridden if rng.size() is large at all. If a subclass does override this function, it must also override commitDetachedView() which has a implementation which is a companion to this function's implementation.

Implements Thyra::VectorBase< Scalar >.

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

Definition at line 381 of file Thyra_VectorDefaultBase_def.hpp.

References Thyra::VectorDefaultBase< Scalar >::acquireDetachedVectorViewImpl(), RTOpPack::ConstSubVectorView< Scalar >::globalOffset(), RTOpPack::SubVectorView< Scalar >::initialize(), RTOpPack::ConstSubVectorView< Scalar >::stride(), RTOpPack::ConstSubVectorView< Scalar >::subDim(), and RTOpPack::ConstSubVectorView< Scalar >::values().

Referenced by Thyra::SpmdVectorBase< Scalar >::acquireNonconstDetachedVectorViewImpl(), and Thyra::DefaultProductVector< Scalar >::acquireNonconstDetachedVectorViewImpl().

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

This implementation uses a transformation operator class (see RTOpPack::TOpSetSubVector) and calls applyOp(). Be forewarned however, that the operator objects state data (both internal and external) will be order O(sub_vec.subNz()). For serial applications, this is entirely adequate. For parallel applications this may be bad!

Implements Thyra::VectorBase< Scalar >.

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

Definition at line 419 of file Thyra_VectorDefaultBase_def.hpp.

Referenced by Thyra::VectorDefaultBase< Scalar >::commitNonconstDetachedVectorViewImpl().

template<class Scalar >
bool Thyra::VectorDefaultBase< Scalar >::opSupportedImpl ( EOpTransp  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::LinearOpBase< Scalar >.

Definition at line 431 of file Thyra_VectorDefaultBase_def.hpp.

References Thyra::CONJTRANS, and Thyra::NOTRANS.

template<class Scalar >
void Thyra::VectorDefaultBase< Scalar >::applyImpl ( const EOpTransp  M_trans,
const MultiVectorBase< Scalar > &  X,
const Ptr< MultiVectorBase< Scalar > > &  Y,
const Scalar  alpha,
const Scalar  beta 
) const [protected, virtual]
template<class Scalar >
void Thyra::VectorDefaultBase< Scalar >::validateColRng ( const Range1D rowRng) const [inline, private]
template<class Scalar >
void Thyra::VectorDefaultBase< Scalar >::validateColIndexes ( const ArrayView< const int > &  cols) const [inline, private]

Definition at line 538 of file Thyra_VectorDefaultBase_def.hpp.

References Teuchos::ArrayView< T >::size().


Member Data Documentation

template<class Scalar >
RCP<const VectorSpaceBase<Scalar> > Thyra::VectorDefaultBase< Scalar >::domain_ [mutable, private]

Definition at line 268 of file Thyra_VectorDefaultBase_decl.hpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines