Thyra_SpmdMultiVectorBase.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.
// 
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Roscoe A. Bartlett (bartlettra@ornl.gov) 
// 
// ***********************************************************************
// @HEADER

#ifndef THYRA_SPMD_MULTI_VECTOR_BASE_DECL_HPP
#define THYRA_SPMD_MULTI_VECTOR_BASE_DECL_HPP


#include "Thyra_MultiVectorBase.hpp"


namespace Thyra {


template<class Scalar> class SpmdVectorSpaceBase;


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


  RCP<const SpmdVectorSpaceBase<Scalar> > spmdSpace() const
    { return spmdSpaceImpl(); }

  RTOpPack::SubMultiVectorView<Scalar> getNonconstLocalSubMultiVector()
    { return getNonconstLocalSubMultiVectorImpl(); }

  RTOpPack::ConstSubMultiVectorView<Scalar> getLocalSubMultiVector() const
    {  return getLocalSubMultiVectorImpl(); }

  void getNonconstLocalData(
    const Ptr<ArrayRCP<Scalar> > &localValues, const Ptr<Ordinal> &leadingDim
    )
    { getNonconstLocalMultiVectorDataImpl(localValues, leadingDim); }

  void getLocalData(
    const Ptr<ArrayRCP<const Scalar> > &localValues, const Ptr<Ordinal> &leadingDim
    ) const
    { getLocalMultiVectorDataImpl(localValues, leadingDim); }


protected:


  virtual RCP<const SpmdVectorSpaceBase<Scalar> > spmdSpaceImpl() const = 0;

  virtual RTOpPack::SubMultiVectorView<Scalar>
  getNonconstLocalSubMultiVectorImpl() = 0;

  virtual RTOpPack::ConstSubMultiVectorView<Scalar>
  getLocalSubMultiVectorImpl() const = 0;

  virtual void getNonconstLocalMultiVectorDataImpl(
    const Ptr<ArrayRCP<Scalar> > &localValues, const Ptr<Ordinal> &leadingDim
    ) = 0;

  virtual void getLocalMultiVectorDataImpl(
    const Ptr<ArrayRCP<const Scalar> > &localValues, const Ptr<Ordinal> &leadingDim
    ) const = 0;

  
}; // end class SpmdMultiVectorBase


} // end namespace Thyra


#endif // THYRA_SPMD_MULTI_VECTOR_BASE_DECL_HPP