Thyra_MultiVectorBaseDecl.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_MULTI_VECTOR_BASE_DECL_HPP
#define THYRA_MULTI_VECTOR_BASE_DECL_HPP

#include "Thyra_LinearOpBaseDecl.hpp"
#include "RTOpPack_RTOpT.hpp"

namespace Thyra {

template<class Scalar>
class MultiVectorBase : virtual public LinearOpBase<Scalar>
{
public:

  using LinearOpBase<Scalar>::describe;


  virtual RCP<const VectorBase<Scalar> > col(Index j) const;

  virtual RCP<VectorBase<Scalar> > col(Index j) = 0;



  virtual RCP<const MultiVectorBase<Scalar> >
  subView( const Range1D& colRng ) const = 0;
  
  virtual RCP<MultiVectorBase<Scalar> >
  subView( const Range1D& colRng ) = 0;

  virtual RCP<const MultiVectorBase<Scalar> >
  subView( const int numCols, const int cols[] ) const = 0;

  virtual RCP<MultiVectorBase<Scalar> >
  subView( const int numCols, const int cols[] ) = 0;
  


  void applyOp(
    const RTOpPack::RTOpT<Scalar> &primary_op,
    const int num_multi_vecs,
    const MultiVectorBase<Scalar>*const multi_vecs[],
    const int num_targ_multi_vecs,
    MultiVectorBase<Scalar>*const targ_multi_vecs[],
    RTOpPack::ReductTarget*const reduct_objs[],
    const Index primary_first_ele_offset,
    const Index primary_sub_dim,
    const Index primary_global_offset,
    const Index secondary_first_ele_offset,
    const Index secondary_sub_dim
    ) const
    {
      mvMultiReductApplyOpImpl(
        primary_op, num_multi_vecs, multi_vecs, num_targ_multi_vecs,
        targ_multi_vecs, reduct_objs,
        primary_first_ele_offset, primary_sub_dim,
        primary_global_offset, secondary_first_ele_offset, secondary_sub_dim
        );
    }

  virtual void mvMultiReductApplyOpImpl(
    const RTOpPack::RTOpT<Scalar> &primary_op,
    const int num_multi_vecs,
    const MultiVectorBase<Scalar>*const multi_vecs[],
    const int num_targ_multi_vecs,
    MultiVectorBase<Scalar>*const targ_multi_vecs[],
    RTOpPack::ReductTarget*const reduct_objs[],
    const Index primary_first_ele_offset,
    const Index primary_sub_dim,
    const Index primary_global_offset,
    const Index secondary_first_ele_offset,
    const Index secondary_sub_dim
    ) const = 0;

  void applyOp(
    const RTOpPack::RTOpT<Scalar> &primary_op,
    const RTOpPack::RTOpT<Scalar> &secondary_op,
    const int num_multi_vecs,
    const MultiVectorBase<Scalar>*const multi_vecs[],
    const int num_targ_multi_vecs,
    MultiVectorBase<Scalar>*const targ_multi_vecs[],
    RTOpPack::ReductTarget *reduct_obj,
    const Index primary_first_ele_offset,
    const Index primary_sub_dim,
    const Index primary_global_offset,
    const Index secondary_first_ele_offset,
    const Index secondary_sub_dim
    ) const
    {
      mvSingleReductApplyOpImpl(
        primary_op, secondary_op, num_multi_vecs, multi_vecs,
        num_targ_multi_vecs, targ_multi_vecs, reduct_obj,
        primary_first_ele_offset, primary_sub_dim,
        primary_global_offset, secondary_first_ele_offset,
        secondary_sub_dim
        );
    }

  virtual void mvSingleReductApplyOpImpl(
    const RTOpPack::RTOpT<Scalar> &primary_op,
    const RTOpPack::RTOpT<Scalar> &secondary_op,
    const int num_multi_vecs,
    const MultiVectorBase<Scalar>*const multi_vecs[],
    const int num_targ_multi_vecs,
    MultiVectorBase<Scalar>*const targ_multi_vecs[],
    RTOpPack::ReductTarget *reduct_obj,
    const Index primary_first_ele_offset,
    const Index primary_sub_dim,
    const Index primary_global_offset,
    const Index secondary_first_ele_offset,
    const Index secondary_sub_dim
    ) const = 0;
  


  void acquireDetachedView(
    const Range1D &rowRng,
    const Range1D &colRng,
    RTOpPack::ConstSubMultiVectorView<Scalar> *sub_mv
    ) const
    {
      acquireDetachedMultiVectorViewImpl( rowRng, colRng, sub_mv );
    }

  virtual void acquireDetachedMultiVectorViewImpl(
    const Range1D &rowRng,
    const Range1D &colRng,
    RTOpPack::ConstSubMultiVectorView<Scalar> *sub_mv
    ) const = 0;

  void releaseDetachedView(
    RTOpPack::ConstSubMultiVectorView<Scalar>* sub_mv
    ) const
    {
      releaseDetachedMultiVectorViewImpl(sub_mv);
    }

  virtual void releaseDetachedMultiVectorViewImpl(
    RTOpPack::ConstSubMultiVectorView<Scalar>* sub_mv
    ) const = 0;

  void acquireDetachedView(
    const Range1D &rowRng,
    const Range1D &colRng,
    RTOpPack::SubMultiVectorView<Scalar> *sub_mv
    )
    {
      acquireNonconstDetachedMultiVectorViewImpl(rowRng,colRng,sub_mv);
    }

  virtual void acquireNonconstDetachedMultiVectorViewImpl(
    const Range1D &rowRng,
    const Range1D &colRng,
    RTOpPack::SubMultiVectorView<Scalar> *sub_mv
    ) = 0;

  void commitDetachedView(
    RTOpPack::SubMultiVectorView<Scalar>* sub_mv
    )
    {
      commitNonconstDetachedMultiVectorViewImpl(sub_mv);
    }

  virtual void commitNonconstDetachedMultiVectorViewImpl(
    RTOpPack::SubMultiVectorView<Scalar>* sub_mv
    ) = 0;



  virtual RCP<MultiVectorBase<Scalar> > clone_mv() const = 0;



  RCP<const LinearOpBase<Scalar> > clone() const;


private:
  
#ifdef DOXYGEN_COMPILE
  VectorBase<Scalar>  *columns; // Doxygen only
#endif  

}; // end class MultiVectorBase<Scalar>

template<class Scalar>
inline
void applyOp(
  const RTOpPack::RTOpT<Scalar> &primary_op,
  const int num_multi_vecs,
  const MultiVectorBase<Scalar>*const multi_vecs[],
  const int num_targ_multi_vecs,
  MultiVectorBase<Scalar>*const targ_multi_vecs[],
  RTOpPack::ReductTarget*const reduct_objs[],
  const Index primary_first_ele_offset = 0,
  const Index primary_sub_dim = -1,
  const Index primary_global_offset = 0,
  const Index secondary_first_ele_offset = 0,
  const Index secondary_sub_dim = -1
  )
{
  if(num_multi_vecs)
    multi_vecs[0]->applyOp(
      primary_op
      ,num_multi_vecs,multi_vecs,num_targ_multi_vecs,targ_multi_vecs
      ,reduct_objs,primary_first_ele_offset,primary_sub_dim,primary_global_offset
      ,secondary_first_ele_offset,secondary_sub_dim
      );
  else if(num_targ_multi_vecs)
    targ_multi_vecs[0]->applyOp(
      primary_op
      ,num_multi_vecs,multi_vecs,num_targ_multi_vecs,targ_multi_vecs
      ,reduct_objs,primary_first_ele_offset,primary_sub_dim,primary_global_offset
      ,secondary_first_ele_offset,secondary_sub_dim
      );
}

template<class Scalar>
inline
void applyOp(
  const RTOpPack::RTOpT<Scalar> &primary_op,
  const RTOpPack::RTOpT<Scalar> &secondary_op,
  const int num_multi_vecs,
  const MultiVectorBase<Scalar>*const multi_vecs[],
  const int num_targ_multi_vecs,
  MultiVectorBase<Scalar>*const targ_multi_vecs[],
  RTOpPack::ReductTarget *reduct_obj,
  const Index primary_first_ele_offset = 0,
  const Index primary_sub_dim = -1,
  const Index primary_global_offset = 0,
  const Index secondary_first_ele_offset = 0,
  const Index secondary_sub_dim = -1
  )
{
  if(num_multi_vecs)
    multi_vecs[0]->applyOp(
      primary_op,secondary_op
      ,num_multi_vecs,multi_vecs,num_targ_multi_vecs,targ_multi_vecs
      ,reduct_obj,primary_first_ele_offset,primary_sub_dim,primary_global_offset
      ,secondary_first_ele_offset,secondary_sub_dim
      );
  else if(num_targ_multi_vecs)
    targ_multi_vecs[0]->applyOp(
      primary_op,secondary_op
      ,num_multi_vecs,multi_vecs,num_targ_multi_vecs,targ_multi_vecs
      ,reduct_obj,primary_first_ele_offset,primary_sub_dim,primary_global_offset
      ,secondary_first_ele_offset,secondary_sub_dim
      );
}

} // namespace Thyra

#endif // THYRA_MULTI_VECTOR_BASE_DECL_HPP

---