Ifpack2_OverlappingPartitioner_decl.hpp

/*@HEADER
// ***********************************************************************
//
//       Ifpack2: Tempated Object-Oriented Algebraic Preconditioner Package
//                 Copyright (2009) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
//@HEADER
*/

#ifndef IFPACK2_OVERLAPPINGPARTITIONER_DECL_HPP
#define IFPACK2_OVERLAPPINGPARTITIONER_DECL_HPP

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

/* \brief Ifpack2_OverlappingPartitioner: A class to create overlapping
    partitions of a local graph.

Class Ifpack2_OverlappingPartitioner enables the extension of 
non-overlapping partitions to an arbitrary value of overlap.
Note that overlap refers to the overlap among \e local parts,
and not the overlap among the processes.

Supported parameters are:
- \c "partitioner: local parts": the required number of parts;
- \c "partitioner: overlap": the required amount of overlap is set in 
  parameter. Default = 0 (integer).
- \c "partitioner: verbose": if \c true, information are reported on
  cout. Nothing is reported otherwise.

This class is a semi-virtual class, that contains the basic utilities
for derived classes Ifpack2_LinearPartitioner, Ifpack2_GreedyPartitioner,
Ifpack2_METISPartitioner, and Ifpack2_EquationPartitioner. Graphs in
input to one of these classes are supposed to contain no singletons.
Usually, this means that the graph is derived from an Tpetra_RowMatrix,
that has been filtered using Ifpack2_SingletonFilter.

\date Last update: Aug-12.
*/  

namespace Ifpack2 {

template<class GraphType>
class OverlappingPartitioner : public Partitioner<GraphType> {

public:
  typedef typename GraphType::local_ordinal_type LocalOrdinal;
  typedef typename GraphType::global_ordinal_type GlobalOrdinal;
  typedef typename GraphType::node_type Node;

  OverlappingPartitioner(const Teuchos::RCP<const Tpetra::RowGraph<LocalOrdinal,GlobalOrdinal,Node> >& Graph);

  virtual ~OverlappingPartitioner();

  size_t numLocalParts() const;

  size_t overlappingLevel() const;


  LocalOrdinal operator() (LocalOrdinal MyRow) const;

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

  size_t numRowsInPart(const LocalOrdinal Part) const;

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

  virtual Teuchos::ArrayView<const LocalOrdinal>  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<LocalOrdinal> Partition_; 
  // partition i
  Teuchos::Array<Teuchos::ArrayRCP<LocalOrdinal> > Parts_;
  Teuchos::RCP<const Tpetra::RowGraph<LocalOrdinal,GlobalOrdinal,Node> > Graph_;
  size_t OverlappingLevel_;
  bool IsComputed_;
  bool verbose_;

}; // class Ifpack2::OverlappingPartitioner

}// namespace Ifpack2

#endif // IFPACK2_OVERLAPPINGPARTITIONER_DECL_HPP