IFPACK Development
Ifpack_Partitioner.h
00001 /*
00002 //@HEADER
00003 // ***********************************************************************
00004 //
00005 //       Ifpack: Object-Oriented Algebraic Preconditioner Package
00006 //                 Copyright (2002) Sandia Corporation
00007 //
00008 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00009 // license for use of this work by or on behalf of the U.S. Government.
00010 //
00011 // Redistribution and use in source and binary forms, with or without
00012 // modification, are permitted provided that the following conditions are
00013 // met:
00014 //
00015 // 1. Redistributions of source code must retain the above copyright
00016 // notice, this list of conditions and the following disclaimer.
00017 //
00018 // 2. Redistributions in binary form must reproduce the above copyright
00019 // notice, this list of conditions and the following disclaimer in the
00020 // documentation and/or other materials provided with the distribution.
00021 //
00022 // 3. Neither the name of the Corporation nor the names of the
00023 // contributors may be used to endorse or promote products derived from
00024 // this software without specific prior written permission.
00025 //
00026 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00027 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00028 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00029 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00030 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00031 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00032 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00033 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00034 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00035 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00036 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00037 //
00038 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
00039 //
00040 // ***********************************************************************
00041 //@HEADER
00042 */
00043 
00044 #ifndef IFPACK_PARTITIONER_H
00045 #define IFPACK_PARTITIONER_H
00046 
00047 #include "Ifpack_ConfigDefs.h"
00048 #include "Teuchos_ParameterList.hpp"
00049 class Epetra_Comm;
00050 class Ifpack_Graph;
00051 class Epetra_Map;
00052 class Epetra_BlockMap;
00053 class Epetra_Import;
00054 
00056 
00162 class Ifpack_Partitioner {
00163 
00164 public:
00165 
00167   virtual ~Ifpack_Partitioner() {};
00168 
00170   virtual int NumLocalParts() const = 0;
00171 
00173   virtual int OverlappingLevel() const = 0;
00174 
00176 
00183   virtual int operator() (int MyRow) const = 0;
00184 
00186   virtual int operator() (int i, int j) const = 0;
00187 
00189   virtual int NumRowsInPart(const int Part) const = 0;
00190     
00192   virtual int RowsInPart(const int Part, int* List) const = 0;
00193   
00195   virtual const int* NonOverlappingPartition() const = 0;
00196 
00198   virtual int SetParameters(Teuchos::ParameterList& List) = 0;
00199 
00201   virtual int Compute() = 0;
00202 
00204   virtual bool IsComputed() = 0;
00205 
00207   virtual ostream& Print(std::ostream& os) const = 0;
00208 
00209 }; // class Ifpack_Partitioner
00210 
00211 inline ostream& operator<<(ostream& os, const Ifpack_Partitioner& obj)
00212 {
00213   return(obj.Print(os));
00214 }
00215 
00216 #endif // IFPACK_PARTITIONER_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends