Ifpack2_OverlappingPartitioner_decl.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_OVERLAPPINGPARTITIONER_DECL_HPP
#define IFPACK2_OVERLAPPINGPARTITIONER_DECL_HPP

#include "Ifpack2_ConfigDefs.hpp"
#include "Ifpack2_Partitioner.hpp"
#include "Tpetra_RowGraph.hpp"

namespace Ifpack2 {

template<class GraphType>
class OverlappingPartitioner : public Partitioner<GraphType> {
public:
  typedef typename GraphType::local_ordinal_type local_ordinal_type;
  typedef typename GraphType::global_ordinal_type global_ordinal_type;
  typedef typename GraphType::node_type node_type;
  typedef typename GraphType::nonconst_global_inds_host_view_type nonconst_global_inds_host_view_type;
  typedef typename GraphType::nonconst_local_inds_host_view_type nonconst_local_inds_host_view_type;
 
  typedef Tpetra::RowGraph<local_ordinal_type, global_ordinal_type, node_type> row_graph_type;

  OverlappingPartitioner (const Teuchos::RCP<const row_graph_type>& graph);

  virtual ~OverlappingPartitioner();

  int numLocalParts () const;

  int overlappingLevel() const;

  local_ordinal_type operator () (const local_ordinal_type MyRow) const;

  local_ordinal_type
  operator () (const local_ordinal_type i, const local_ordinal_type j) const;

  size_t numRowsInPart (const local_ordinal_type Part) const;

  void rowsInPart (const local_ordinal_type Part, Teuchos::ArrayRCP<local_ordinal_type>& List) const;

  virtual Teuchos::ArrayView<const local_ordinal_type> 
  nonOverlappingPartition () const;


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


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

  virtual void compute();

  virtual void computePartitions() = 0;

  virtual void computeOverlappingPartitions();
  
  virtual bool isComputed() const;

  virtual std::ostream& print(std::ostream& os) const;



  std::string description() const;

  void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const;

 
protected:

  int NumLocalParts_;

  Teuchos::Array<local_ordinal_type> Partition_;

  Teuchos::Array<Teuchos::ArrayRCP<local_ordinal_type> > Parts_;

  Teuchos::RCP<const row_graph_type> Graph_;

  int OverlappingLevel_;

  bool IsComputed_;

  bool verbose_;

  bool maintainSparsity_;
}; // class Ifpack2::OverlappingPartitioner

}// namespace Ifpack2

#endif // IFPACK2_OVERLAPPINGPARTITIONER_DECL_HPP