Ifpack2 Templated Preconditioning Package Version 1.0
Ifpack2_OverlappingPartitioner_decl.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_OVERLAPPINGPARTITIONER_DECL_HPP
00044 #define IFPACK2_OVERLAPPINGPARTITIONER_DECL_HPP
00045 
00046 #include "Ifpack2_ConfigDefs.hpp"
00047 #include "Ifpack2_Partitioner.hpp"
00048 #include "Tpetra_RowGraph.hpp"
00049 
00050 namespace Ifpack2 {
00051 
00076 template<class GraphType>
00077 class OverlappingPartitioner : public Partitioner<GraphType> {
00078 public:
00079   typedef typename GraphType::local_ordinal_type local_ordinal_type;
00080   typedef typename GraphType::global_ordinal_type global_ordinal_type;
00081   typedef typename GraphType::node_type node_type;
00082   typedef Tpetra::RowGraph<local_ordinal_type, global_ordinal_type, node_type> row_graph_type;
00083 
00085   OverlappingPartitioner (const Teuchos::RCP<const row_graph_type>& graph);
00086 
00088   virtual ~OverlappingPartitioner();
00089 
00095   int numLocalParts () const;
00096 
00098   int overlappingLevel() const;
00099 
00103   local_ordinal_type operator () (const local_ordinal_type MyRow) const;
00104 
00106   local_ordinal_type
00107   operator () (const local_ordinal_type i, const local_ordinal_type j) const;
00108 
00110   size_t numRowsInPart (const local_ordinal_type Part) const;
00111 
00113   void rowsInPart (const local_ordinal_type Part, Teuchos::ArrayRCP<local_ordinal_type>& List) const;
00114 
00116   virtual Teuchos::ArrayView<const local_ordinal_type> 
00117   nonOverlappingPartition () const;
00118 
00120 
00125   virtual void setParameters (Teuchos::ParameterList& List);
00126 
00128 
00132   virtual void setPartitionParameters (Teuchos::ParameterList& List) = 0;
00133 
00135   virtual void compute();
00136 
00138   virtual void computePartitions() = 0;
00139 
00141   virtual void computeOverlappingPartitions();
00142   
00144   virtual bool isComputed() const;
00145 
00147   virtual std::ostream& print(std::ostream& os) const;
00148 
00150 
00151 
00153   std::string description() const;
00154 
00156   void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const;
00157 
00159  
00160 protected:
00161 
00167   int NumLocalParts_;
00168 
00171   Teuchos::Array<local_ordinal_type> Partition_; 
00172 
00175   Teuchos::Array<Teuchos::ArrayRCP<local_ordinal_type> > Parts_;
00176 
00178   Teuchos::RCP<const row_graph_type> Graph_;
00179 
00181   int OverlappingLevel_;
00182 
00184   bool IsComputed_;
00185 
00187   bool verbose_;
00188 }; // class Ifpack2::OverlappingPartitioner
00189 
00190 }// namespace Ifpack2
00191 
00192 #endif // IFPACK2_OVERLAPPINGPARTITIONER_DECL_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends