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 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
00038 //
00039 // ***********************************************************************
00040 //@HEADER
00041 */
00042 
00043 #ifndef IFPACK2_PARTITIONER_HPP
00044 #define IFPACK2_PARTITIONER_HPP
00045 
00046 #include "Ifpack2_ConfigDefs.hpp"
00047 #include "Teuchos_ParameterList.hpp"
00048 #include "Teuchos_ArrayRCP.hpp"
00049 #include <iostream>
00050 
00051 namespace Ifpack2 {
00052 
00054 
00178 template <class GraphType>
00179 class Partitioner : public Teuchos::Describable {
00180 public:
00181   typedef typename GraphType::local_ordinal_type LocalOrdinal;
00182   typedef typename GraphType::global_ordinal_type GlobalOrdinal;
00183   typedef typename GraphType::node_type Node;
00184 
00186   virtual ~Partitioner() {};
00187 
00192   virtual int numLocalParts () const = 0;
00193 
00195   virtual int overlappingLevel() const = 0;
00196 
00201   virtual LocalOrdinal operator() (LocalOrdinal MyRow) const = 0;
00202 
00204   virtual LocalOrdinal operator() (LocalOrdinal i, LocalOrdinal j) const = 0;
00205 
00207   virtual size_t numRowsInPart (const LocalOrdinal Part) const = 0;
00208     
00210   virtual void 
00211   rowsInPart (const LocalOrdinal Part, 
00212         Teuchos::ArrayRCP<LocalOrdinal>& List) const = 0;
00213   
00215   virtual Teuchos::ArrayView<const LocalOrdinal>
00216   nonOverlappingPartition () const = 0;
00217 
00219   virtual void setParameters (Teuchos::ParameterList& List) = 0;
00220 
00222   virtual void compute () = 0;
00223 
00225   virtual bool isComputed () const = 0;
00226 
00228   virtual std::ostream& print (std::ostream& os) const = 0;
00229 
00230 };
00231 
00232 // Overloaded output stream operator for Partitioner
00233 template <class GraphType>
00234 inline std::ostream& 
00235 operator<< (std::ostream& os, 
00236       const Ifpack2::Partitioner<GraphType>& obj)
00237 {
00238   return obj.print (os);
00239 }
00240 
00241 } // namespace Ifpack2
00242 
00243 #endif // IFPACK2_PARTITIONER_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends