Thyra_VectorMultiVectorDecl.hpp

// @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_MULTI_VECTOR_DECL_HPP
#define THYRA_VECTOR_MULTI_VECTOR_DECL_HPP

#include "Thyra_VectorDefaultBaseDecl.hpp"

namespace Thyra {

template<class Scalar>
class VectorMultiVector : virtual public VectorDefaultBase<Scalar> {
public:

  using VectorBase<Scalar>::col;


  VectorMultiVector();

  VectorMultiVector(
    const Teuchos::RefCountPtr<MultiVectorBase<Scalar> > &mv
    );

  void initialize(
    const Teuchos::RefCountPtr<MultiVectorBase<Scalar> > &mv
    );

  void uninitialize(
    Teuchos::RefCountPtr<MultiVectorBase<Scalar> > *mv = NULL
    );

  Teuchos::RefCountPtr<MultiVectorBase<Scalar> > mv();

  Teuchos::RefCountPtr<const MultiVectorBase<Scalar> > mv() const;


  Teuchos::RefCountPtr< const VectorSpaceBase<Scalar> > range() const;
  Teuchos::RefCountPtr< const VectorSpaceBase<Scalar> > domain() const;
  bool opSupported(ETransp M_trans) const;

  void apply(
    const ETransp                     M_trans
    ,const MultiVectorBase<Scalar>    &X
    ,MultiVectorBase<Scalar>          *Y
    ,const Scalar                     alpha
    ,const Scalar                     beta
    ) 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 applyOp(
    const RTOpPack::RTOpT<Scalar>   &primary_op
    ,const int                      num_multi_vecs
    ,const MultiVectorBase<Scalar>* multi_vecs[]
    ,const int                      num_targ_multi_vecs
    ,MultiVectorBase<Scalar>*       targ_multi_vecs[]
    ,RTOpPack::ReductTarget*        reduct_objs[]
    ,const Index                    primary_first_ele
    ,const Index                    primary_sub_dim
    ,const Index                    primary_global_offset
    ,const Index                    secondary_first_ele
    ,const Index                    secondary_sub_dim
    ) const;
  void applyOp(
    const RTOpPack::RTOpT<Scalar>   &primary_op
    ,const RTOpPack::RTOpT<Scalar>  &secondary_op
    ,const int                      num_multi_vecs
    ,const MultiVectorBase<Scalar>* multi_vecs[]
    ,const int                      num_targ_multi_vecs
    ,MultiVectorBase<Scalar>*       targ_multi_vecs[]
    ,RTOpPack::ReductTarget         *reduct_obj
    ,const Index                    primary_first_ele
    ,const Index                    primary_sub_dim
    ,const Index                    primary_global_offset
    ,const Index                    secondary_first_ele
    ,const Index                    secondary_sub_dim
    ) const;
  void getSubMultiVector(
    const Range1D                       &rowRng
    ,const Range1D                      &colRng
    ,RTOpPack::SubMultiVectorT<Scalar>  *sub_mv
    ) const;
  void freeSubMultiVector( RTOpPack::SubMultiVectorT<Scalar>* sub_mv ) const;
  void getSubMultiVector(
    const Range1D                                &rowRng
    ,const Range1D                               &colRng
    ,RTOpPack::MutableSubMultiVectorT<Scalar>    *sub_mv
    );
  void commitSubMultiVector( RTOpPack::MutableSubMultiVectorT<Scalar>* sub_mv );

  Teuchos::RefCountPtr< const VectorSpaceBase<Scalar> > space() const;
  void applyOp(
    const RTOpPack::RTOpT<Scalar>   &op
    ,const int                      num_vecs
    ,const VectorBase<Scalar>*      vecs[]
    ,const int                      num_targ_vecs
    ,VectorBase<Scalar>*            targ_vecs[]
    ,RTOpPack::ReductTarget         *reduct_obj
    ,const Index                    first_ele
    ,const Index                    sub_dim
    ,const Index                    global_offset
    ) const;
  void getSubVector( const Range1D& rng, RTOpPack::SubVectorT<Scalar>* sub_vec ) const;
  void freeSubVector( RTOpPack::SubVectorT<Scalar>* sub_vec ) const;
  void getSubVector( const Range1D& rng, RTOpPack::MutableSubVectorT<Scalar>* sub_vec );
  void commitSubVector( RTOpPack::MutableSubVectorT<Scalar>* sub_vec );

private:
  
  Teuchos::RefCountPtr<MultiVectorBase<Scalar> > mv_;

}; // end class VectorMultiVector

// ///////////////////////////////////////////////////
// Inline members

template <class Scalar>
inline
Teuchos::RefCountPtr<MultiVectorBase<Scalar> >
VectorMultiVector<Scalar>::mv()
{
  return mv_;
}

template <class Scalar>
inline
Teuchos::RefCountPtr<const MultiVectorBase<Scalar> >
VectorMultiVector<Scalar>::mv() const
{
  return mv_;
}

} // end namespace Thyra

#endif // THYRA_VECTOR_MULTI_VECTOR_DECL_HPP

---