Thyra_SpmdMultiVectorBaseDecl.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_SPMD_MULTI_VECTOR_BASE_DECL_HPP
#define THYRA_SPMD_MULTI_VECTOR_BASE_DECL_HPP

#include "Thyra_MultiVectorDefaultBaseDecl.hpp"
#include "Thyra_SingleScalarEuclideanLinearOpBaseDecl.hpp"
#include "Teuchos_BLAS.hpp"

namespace Thyra {

template<class Scalar> class SpmdVectorSpaceBase;

template<class Scalar>
class SpmdMultiVectorBase
  : virtual public MultiVectorDefaultBase<Scalar>
  , virtual public SingleScalarEuclideanLinearOpBase<Scalar>
{
public:

  using SingleScalarEuclideanLinearOpBase<Scalar>::euclideanApply;
  using SingleScalarEuclideanLinearOpBase<Scalar>::apply;
  using MultiVectorDefaultBase<Scalar>::applyOp;


  SpmdMultiVectorBase();



  virtual Teuchos::RefCountPtr<const SpmdVectorSpaceBase<Scalar> > spmdSpace() const = 0;

  virtual void getLocalData( Scalar **localValues, Index *leadingDim ) = 0;

  virtual void commitLocalData( Scalar *localValues ) = 0;

  virtual void getLocalData( const Scalar **localValues, Index *leadingDim ) const = 0;

  virtual void freeLocalData( const Scalar *localValues ) const = 0;



  Teuchos::RefCountPtr< const ScalarProdVectorSpaceBase<Scalar> > rangeScalarProdVecSpc() const;



  void apply(
    const ETransp                     M_trans
    ,const MultiVectorBase<Scalar>    &X
    ,MultiVectorBase<Scalar>          *Y
    ,const Scalar                     alpha
    ,const Scalar                     beta
    ) const;


  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
    ,const Index                          primary_sub_dim
    ,const Index                          primary_global_offset
    ,const Index                          secondary_first_ele
    ,const Index                          secondary_sub_dim
    ) const;
  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 );

protected:


  bool opSupported(ETransp M_trans) const;

  void euclideanApply(
    const ETransp                     M_trans
    ,const MultiVectorBase<Scalar>    &X
    ,MultiVectorBase<Scalar>          *Y
    ,const Scalar                     alpha
    ,const Scalar                     beta
    ) const;



  virtual void updateSpmdSpace();

  Range1D validateRowRange( const Range1D& rowRng ) const;

  Range1D validateColRange( const Range1D& rowCol ) const;

  
private:
  
  // ///////////////////////////////////////
  // Private data members
  
  mutable bool in_applyOp_;

  mutable Teuchos::BLAS<int,Scalar> blas_;

  // cached
  Index  globalDim_;
  Index  localOffset_;
  Index  localSubDim_;
  Index  numCols_;
  
}; // end class SpmdMultiVectorBase

} // end namespace Thyra

#endif // THYRA_SPMD_MULTI_VECTOR_BASE_DECL_HPP

---