Ifpack2_Partitioner.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_PARTITIONER_HPP
#define IFPACK2_PARTITIONER_HPP

#include "Ifpack2_ConfigDefs.hpp"
#include "Teuchos_ParameterList.hpp"
#include "Teuchos_ArrayRCP.hpp"
#include <iostream>

namespace Ifpack2 {


template <class GraphType>
class Partitioner : public Teuchos::Describable {
 public:
  typedef typename GraphType::local_ordinal_type LocalOrdinal;
  typedef typename GraphType::global_ordinal_type GlobalOrdinal;
  typedef typename GraphType::node_type Node;

  virtual ~Partitioner(){};

  virtual int numLocalParts() const = 0;

  virtual int overlappingLevel() const = 0;

  virtual LocalOrdinal operator()(LocalOrdinal MyRow) const = 0;

  virtual LocalOrdinal operator()(LocalOrdinal i, LocalOrdinal j) const = 0;

  virtual size_t numRowsInPart(const LocalOrdinal Part) const = 0;

  virtual void
  rowsInPart(const LocalOrdinal Part,
             Teuchos::ArrayRCP<LocalOrdinal>& List) const = 0;

  virtual Teuchos::ArrayView<const LocalOrdinal>
  nonOverlappingPartition() const = 0;

  virtual void setParameters(Teuchos::ParameterList& List) = 0;

  virtual void compute() = 0;

  virtual bool isComputed() const = 0;

  virtual std::ostream& print(std::ostream& os) const = 0;
};

// Overloaded output stream operator for Partitioner
template <class GraphType>
inline std::ostream&
operator<<(std::ostream& os,
           const Ifpack2::Partitioner<GraphType>& obj) {
  return obj.print(os);
}

}  // namespace Ifpack2

#endif  // IFPACK2_PARTITIONER_HPP