Thyra_SpmdMultiVectorBase.hpp

// @HEADER
// *****************************************************************************
//    Thyra: Interfaces and Support for Abstract Numerical Algorithms
//
// Copyright 2004 NTESS and the Thyra contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @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