Thyra_SpmdVectorBaseDecl.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_SPMD_VECTOR_BASE_DECL_HPP
#define THYRA_SPMD_VECTOR_BASE_DECL_HPP


#include "Thyra_VectorDefaultBaseDecl.hpp"
#include "Thyra_SpmdVectorSpaceDefaultBaseDecl.hpp"


//#define THYRA_SPMD_VECTOR_BASE_DUMP


namespace Thyra {


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

  SpmdVectorBase();


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

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

  virtual void commitLocalData( Scalar* localValues ) = 0;



  virtual void getLocalData( const Scalar** localValues, Index* stride ) const;

  virtual void freeLocalData( const Scalar* localValues ) const;

  void applyOp(
    const Teuchos::Comm<Index>      *comm
    ,const RTOpPack::RTOpT<Scalar>  &op
    ,const int                      num_vecs
    ,const VectorBase<Scalar>*const vecs[]
    ,const int                      num_targ_vecs
    ,VectorBase<Scalar>*const        targ_vecs[]
    ,RTOpPack::ReductTarget         *reduct_obj
    ,const Index                    first_ele_offset
    ,const Index                    sub_dim
    ,const Index                    global_offset
    ) const;


  std::string description() const;


  Teuchos::RCP<const VectorSpaceBase<Scalar> > space() const;
  void applyOp(
    const RTOpPack::RTOpT<Scalar>   &op
    ,const int                      num_vecs
    ,const VectorBase<Scalar>*const vecs[]
    ,const int                      num_targ_vecs
    ,VectorBase<Scalar>*const       targ_vecs[]
    ,RTOpPack::ReductTarget         *reduct_obj
    ,const Index                    first_ele_offset
    ,const Index                    sub_dim
    ,const Index                    global_offset
    ) const;
  void acquireDetachedVectorViewImpl(
    const Range1D& rng, RTOpPack::ConstSubVectorView<Scalar>* sub_vec
    ) const;
  void releaseDetachedVectorViewImpl(
    RTOpPack::ConstSubVectorView<Scalar>* sub_vec
    ) const;
  void acquireNonconstDetachedVectorViewImpl(
    const Range1D& rng, RTOpPack::SubVectorView<Scalar>* sub_vec
    );
  void commitNonconstDetachedVectorViewImpl(
    RTOpPack::SubVectorView<Scalar>* sub_vec
    );


protected:

  virtual void updateSpmdSpace();

private:

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

  // Cached (only on vector space!)
  mutable Index  globalDim_;
  mutable Index  localOffset_;
  mutable Index  localSubDim_;

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

  Range1D validateRange( const Range1D& rng_in ) const;

#ifdef THYRA_SPMD_VECTOR_BASE_DUMP
public:
  static bool show_dump;
#endif // THYRA_SPMD_VECTOR_BASE_DUMP

}; // end class SpmdVectorBase


} // end namespace Thyra


#endif // THYRA_SPMD_VECTOR_BASE_DECL_HPP

---