Ifpack2_Partitioner.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_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 size_t numLocalParts() const = 0;

  virtual size_t 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;

}; // class Ifpack2::Partitioner

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

} //namespace Ipack2

#endif // IFPACK2_PARTITIONER_HPP