Thyra_VectorDefaultBaseDecl.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
// 
//    Thyra: Interfaces and Support for Abstract Numerical Algorithms
//                 Copyright (2004) Sandia Corporation
// 
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
// 
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//  
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//  
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
// 
// ***********************************************************************
// @HEADER

#ifndef THYRA_VECTOR_DEFAULT_BASE_DECL_HPP
#define THYRA_VECTOR_DEFAULT_BASE_DECL_HPP

#include "Thyra_VectorBaseDecl.hpp"
#include "Thyra_MultiVectorDefaultBaseDecl.hpp"
#include "Thyra_SingleRhsLinearOpBaseDecl.hpp"

namespace Thyra {

template<class Scalar>
class VectorDefaultBase
  : virtual public VectorBase<Scalar>
  , virtual protected MultiVectorDefaultBase<Scalar>
  , virtual protected SingleRhsLinearOpBase<Scalar>
{
public:

  using VectorBase<Scalar>::acquireDetachedView;
  using VectorBase<Scalar>::releaseDetachedView;
  using VectorBase<Scalar>::commitDetachedView;
  using MultiVectorDefaultBase<Scalar>::describe;
  using MultiVectorDefaultBase<Scalar>::applyOp;
  using MultiVectorDefaultBase<Scalar>::col;
  using SingleRhsLinearOpBase<Scalar>::apply;


  void describe(
    Teuchos::FancyOStream                &out
    ,const Teuchos::EVerbosityLevel      verbLevel
    ) const;



  Teuchos::RefCountPtr< const VectorSpaceBase<Scalar> > range() const;
  Teuchos::RefCountPtr< const VectorSpaceBase<Scalar> > domain() const;


  Teuchos::RefCountPtr<VectorBase<Scalar> > col(Index j);
  Teuchos::RefCountPtr<MultiVectorBase<Scalar> > clone_mv() const;
  Teuchos::RefCountPtr<const MultiVectorBase<Scalar> > subView( const Range1D& col_rng ) const;
  Teuchos::RefCountPtr<MultiVectorBase<Scalar> > subView( const Range1D& col_rng );
  Teuchos::RefCountPtr<const MultiVectorBase<Scalar> > subView( const int numCols, const int cols[] ) const;
  Teuchos::RefCountPtr<MultiVectorBase<Scalar> > subView( const int numCols, const int cols[] );
  void acquireDetachedView(
    const Range1D                       &rowRng
    ,const Range1D                      &colRng
    ,RTOpPack::ConstSubMultiVectorView<Scalar>  *sub_mv
    ) const;
  void releaseDetachedView( RTOpPack::ConstSubMultiVectorView<Scalar>* sub_mv ) const;
  void acquireDetachedView(
    const Range1D                                &rowRng
    ,const Range1D                               &colRng
    ,RTOpPack::SubMultiVectorView<Scalar>    *sub_mv
    );
  void commitDetachedView( RTOpPack::SubMultiVectorView<Scalar>* sub_mv );


  Teuchos::RefCountPtr<VectorBase<Scalar> > clone_v() const;
  virtual void acquireDetachedView( const Range1D& rng, RTOpPack::ConstSubVectorView<Scalar>* sub_vec ) const;
  virtual void releaseDetachedView( RTOpPack::ConstSubVectorView<Scalar>* sub_vec ) const;
  virtual void acquireDetachedView( const Range1D& rng, RTOpPack::SubVectorView<Scalar>* sub_vec );
  virtual void commitDetachedView( RTOpPack::SubVectorView<Scalar>* sub_vec );
  virtual void setSubVector( const RTOpPack::SparseSubVectorT<Scalar>& sub_vec );


protected:


  bool opSupported(ETransp M_trans) const;

  void apply(
    const ETransp                M_trans
    ,const VectorBase<Scalar>    &x
    ,VectorBase<Scalar>          *y
    ,const Scalar                alpha
    ,const Scalar                beta
    ) const;


private:

  // /////////////////////////////////////
  // Private data members

  Teuchos::RefCountPtr<VectorSpaceBase<Scalar> >  domain_; // Only initialized if *this is used as a MultiVectorBase

  // /////////////////////////////////////
  // Private member functions

  void validateColRng( const Range1D &rowRng ) const;
  void validateColIndexes(  const int numCols, const int cols[] ) const;

};

} // end namespace Thyra

#endif  // THYRA_VECTOR_DEFAULT_BASE_DECL_HPP

---