Thyra_DefaultClusteredSpmdProductVectorSpace_decl.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_DEFAULT_CLUSTERED_SPMD_PRODUCT_VECTOR_SPACE_DECL_HPP
#define THYRA_DEFAULT_CLUSTERED_SPMD_PRODUCT_VECTOR_SPACE_DECL_HPP

#include "Thyra_VectorSpaceBase_decl.hpp"
#include "Thyra_ProductVectorSpaceBase.hpp"
#include "Thyra_VectorSpaceDefaultBase.hpp"
#include "Teuchos_Comm.hpp"


namespace Thyra {


template<class Scalar>
class DefaultClusteredSpmdProductVectorSpace
  : public ProductVectorSpaceBase<Scalar>
  , protected VectorSpaceDefaultBase<Scalar>
{
public:


  DefaultClusteredSpmdProductVectorSpace();

  DefaultClusteredSpmdProductVectorSpace(
    const RCP<const Teuchos::Comm<Ordinal> >          &intraClusterComm
    ,const int                                        clusterRootRank
    ,const RCP<const Teuchos::Comm<Ordinal> >         &interClusterComm
    ,const int                                        numBlocks
    ,const RCP<const VectorSpaceBase<Scalar> >        vecSpaces[]
    );

  void initialize(
    const RCP<const Teuchos::Comm<Ordinal> >          &intraClusterComm
    ,const int                                        clusterRootRank
    ,const RCP<const Teuchos::Comm<Ordinal> >         &interClusterComm
    ,const int                                        numBlocks
    ,const RCP<const VectorSpaceBase<Scalar> >        vecSpaces[]
    );

  RCP<const Teuchos::Comm<Ordinal> > intraClusterComm() const;

  int clusterRootRank() const;

  RCP<const Teuchos::Comm<Ordinal> > interClusterComm() const;

  int clusterSubDim() const;

  int clusterOffset() const;
  
  
  std::string description() const;

  Ordinal dim() const;
  bool isCompatible(const VectorSpaceBase<Scalar>& vecSpc) const;
  RCP< const VectorSpaceFactoryBase<Scalar> > smallVecSpcFcty() const;
  Scalar scalarProd( const VectorBase<Scalar>& x, const VectorBase<Scalar>& y ) const;
  void scalarProdsImpl(
    const MultiVectorBase<Scalar>& X, const MultiVectorBase<Scalar>& Y,
    const ArrayView<Scalar> &scalarProds ) const;
  bool isEuclidean() const;
  bool hasInCoreView(
    const Range1D& rng, const EViewType viewType, const EStrideType strideType
    ) const;
  RCP< const VectorSpaceBase<Scalar> > clone() const;


  int numBlocks() const;
  RCP<const VectorSpaceBase<Scalar> > getBlock(const int k) const; 


protected:


  RCP<VectorBase<Scalar> > createMember() const;
  RCP<MultiVectorBase<Scalar> > createMembers(int numMembers) const;


private:

  // //////////////////////////////////////
  // Private types

  typedef std::vector<RCP<const VectorSpaceBase<Scalar> > >  vecSpaces_t;

  // //////////////////////////////////////
  // Private data members

  RCP<const Teuchos::Comm<Ordinal> >  intraClusterComm_;
  int clusterRootRank_;
  RCP<const Teuchos::Comm<Ordinal> >  interClusterComm_;
  vecSpaces_t vecSpaces_; // size == numBlocks
  bool isEuclidean_;
  Ordinal globalDim_;     // The global dimension of all of the block vectors in
                        // all of the clusters.
  Ordinal clusterSubDim_; // The some of the dimensions of the block vector
                        // spaces in this cluster
  Ordinal clusterOffset_; // The offset of the first element in the first
                        // constituent vector in this cluster in the
                        // w.r.t. the global vector.
  
};


// ///////////////////////////
// Inline defintions


template<class Scalar>
RCP<const Teuchos::Comm<Ordinal> >
DefaultClusteredSpmdProductVectorSpace<Scalar>::intraClusterComm() const
{
  return intraClusterComm_;
}


template<class Scalar>
int DefaultClusteredSpmdProductVectorSpace<Scalar>::clusterRootRank() const
{
  return clusterRootRank_;
}


template<class Scalar>
RCP<const Teuchos::Comm<Ordinal> >
DefaultClusteredSpmdProductVectorSpace<Scalar>::interClusterComm() const
{
  return interClusterComm_;
}


template<class Scalar>
int DefaultClusteredSpmdProductVectorSpace<Scalar>::clusterSubDim() const
{
  return clusterSubDim_;
}


template<class Scalar>
int DefaultClusteredSpmdProductVectorSpace<Scalar>::clusterOffset() const
{
  return clusterOffset_;
}


} // end namespace Thyra


#endif // THYRA_DEFAULT_CLUSTERED_SPMD_PRODUCT_VECTOR_SPACE_DECL_HPP