Ifpack2_OverlapGraph.hpp

// @HEADER
// *****************************************************************************
//       Ifpack2: Templated Object-Oriented Algebraic Preconditioner Package
//
// Copyright 2009 NTESS and the Ifpack2 contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef IFPACK2_OVERLAPGRAPH_HPP
#define IFPACK2_OVERLAPGRAPH_HPP

#include "Ifpack2_ConfigDefs.hpp"
#include "Tpetra_CrsGraph.hpp"
#include "Tpetra_Import.hpp"
#include "Teuchos_RCP.hpp"
#include "Ifpack2_CreateOverlapGraph.hpp"

namespace Teuchos {
  class ParameterList;
}

namespace Ifpack2 {


template<class LocalOrdinal = typename Tpetra::CrsGraph<>::local_ordinal_type,
         class GlobalOrdinal = typename Tpetra::CrsGraph<LocalOrdinal>::global_ordinal_type,
         class Node = typename Tpetra::CrsGraph<LocalOrdinal, GlobalOrdinal>::node_type>
class OverlapGraph : public Teuchos::Describable {
public:
  typedef Tpetra::CrsGraph<LocalOrdinal, GlobalOrdinal, Node> graph_type;

  OverlapGraph (const Teuchos::RCP<const graph_type>& UserMatrixGraph_in,
                int OverlapLevel_in);

  OverlapGraph (const OverlapGraph<LocalOrdinal,GlobalOrdinal,Node>& Source);

  virtual ~OverlapGraph () {}

  const Tpetra::CrsGraph<LocalOrdinal,GlobalOrdinal,Node>&
  getOverlapGraph () const { return *OverlapGraph_; }

  const Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node>&
  getOverlapRowMap () const {return *OverlapRowMap_; }

  const Tpetra::Import<LocalOrdinal,GlobalOrdinal,Node>&
  getOverlapImporter () const { return *OverlapImporter_; }

  int OverlapLevel () const { return OverlapLevel_; }

protected:
  Teuchos::RCP<const Tpetra::CrsGraph<LocalOrdinal,GlobalOrdinal,Node> > OverlapGraph_;
  Teuchos::RCP<const Tpetra::CrsGraph<LocalOrdinal,GlobalOrdinal,Node> > UserMatrixGraph_;
  Teuchos::RCP<Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> > OverlapRowMap_;
  Teuchos::RCP<Tpetra::Import<LocalOrdinal,GlobalOrdinal,Node> > OverlapImporter_;
  int OverlapLevel_;
  bool IsOverlapped_;
};

template<class LocalOrdinal, class GlobalOrdinal, class Node>
OverlapGraph<LocalOrdinal,GlobalOrdinal,Node>::
OverlapGraph (const Teuchos::RCP<const Tpetra::CrsGraph<LocalOrdinal,GlobalOrdinal,Node> >& UserMatrixGraph_in,
              int OverlapLevel_in)
  : UserMatrixGraph_ (UserMatrixGraph_in),
    OverlapLevel_ (OverlapLevel_in),
    IsOverlapped_ (OverlapLevel_in > 0 && UserMatrixGraph_in->getDomainMap ()->isDistributed ())
{
  OverlapGraph_ = createOverlapGraph (UserMatrixGraph_, OverlapLevel_);
}

template<class LocalOrdinal, class GlobalOrdinal, class Node>
OverlapGraph<LocalOrdinal,GlobalOrdinal,Node>::
OverlapGraph (const OverlapGraph<LocalOrdinal,GlobalOrdinal,Node>& Source)
  : UserMatrixGraph_ (Source.UserMatrixGraph_),
    OverlapRowMap_ (Source.OverlapRowMap_),
    OverlapLevel_ (Source.OverlapLevel_),
    IsOverlapped_ (Source.IsOverlapped_)
{
  using Teuchos::rcp;
  typedef Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> map_type;

  if (IsOverlapped_) {
    if (! OverlapGraph_.is_null ()) {
      OverlapGraph_ = rcp (new graph_type (*OverlapGraph_));
    }
    if (! OverlapRowMap_.is_null ()) {
      OverlapRowMap_ = rcp (new map_type (*OverlapRowMap_));
    }
  }
}

}//namespace Ifpack2

#endif // IFPACK2_OVERLAPGRAPH_HPP