Ifpack2 Templated Preconditioning Package Version 1.0
Ifpack2_Partitioner.hpp
00001 //@HEADER
00002 // ***********************************************************************
00003 // 
00004 //       Ifpack2: Tempated Object-Oriented Algebraic Preconditioner Package
00005 //                 Copyright (2009) Sandia Corporation
00006 // 
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 // 
00010 // This library is free software; you can redistribute it and/or modify
00011 // it under the terms of the GNU Lesser General Public License as
00012 // published by the Free Software Foundation; either version 2.1 of the
00013 // License, or (at your option) any later version.
00014 //  
00015 // This library is distributed in the hope that it will be useful, but
00016 // WITHOUT ANY WARRANTY; without even the implied warranty of
00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00018 // Lesser General Public License for more details.
00019 //  
00020 // You should have received a copy of the GNU Lesser General Public
00021 // License along with this library; if not, write to the Free Software
00022 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00023 // USA
00024 // Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
00025 // 
00026 // ***********************************************************************
00027 //@HEADER
00028 
00029 #ifndef IFPACK2_PARTITIONER_HPP
00030 #define IFPACK2_PARTITIONER_HPP
00031 
00032 #include "Ifpack2_ConfigDefs.hpp"
00033 #include "Teuchos_ParameterList.hpp"
00034 #include "Teuchos_ArrayRCP.hpp"
00035 #include <iostream>
00036 
00037 namespace Ifpack2 {
00038 
00040 
00134 template <class GraphType>
00135 class Partitioner : public Teuchos::Describable {
00136 public:
00137   typedef typename GraphType::local_ordinal_type LocalOrdinal;
00138   typedef typename GraphType::global_ordinal_type GlobalOrdinal;
00139   typedef typename GraphType::node_type Node;
00140 
00142   virtual ~Partitioner() {};
00143 
00145   virtual size_t numLocalParts() const = 0;
00146 
00148   virtual size_t overlappingLevel() const = 0;
00149 
00151 
00158   virtual LocalOrdinal operator() (LocalOrdinal MyRow) const = 0;
00159 
00161   virtual LocalOrdinal operator() (LocalOrdinal i, LocalOrdinal j) const = 0;
00162 
00164   virtual size_t numRowsInPart(const LocalOrdinal Part) const = 0;
00165     
00167   virtual void rowsInPart(const LocalOrdinal Part, Teuchos::ArrayRCP<LocalOrdinal> &List) const = 0;
00168   
00170   virtual Teuchos::ArrayView<const LocalOrdinal>  nonOverlappingPartition() const = 0;
00171 
00173   virtual void setParameters(Teuchos::ParameterList& List) = 0;
00174 
00176   virtual void compute() = 0;
00177 
00179   virtual bool isComputed() const = 0;
00180 
00182   virtual std::ostream& print(std::ostream& os) const = 0;
00183 
00184 }; // class Ifpack2::Partitioner
00185 
00186 template <class GraphType>
00187 inline std::ostream& operator<<(std::ostream& os, const Ifpack2::Partitioner<GraphType>& obj)
00188 {
00189   return(obj.print(os));
00190 }
00191 
00192 } //namespace Ipack2
00193 
00194 #endif // IFPACK2_PARTITIONER_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends