Ifpack2 Templated Preconditioning Package Version 1.0
Ifpack2_OverlapGraph.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_OVERLAPGRAPH_HPP
00044 #define IFPACK2_OVERLAPGRAPH_HPP
00045 
00046 #include "Ifpack2_ConfigDefs.hpp"
00047 #include "Tpetra_CrsGraph.hpp"
00048 #include "Tpetra_Import.hpp"
00049 #include "Teuchos_RCP.hpp"
00050 #include "Ifpack2_CreateOverlapGraph.hpp"
00051 
00052 namespace Teuchos {
00053   class ParameterList;
00054 }
00055 
00056 namespace Ifpack2 {
00057 
00071 template<class LocalOrdinal, 
00072    class GlobalOrdinal = LocalOrdinal, 
00073    class Node = KokkosClassic::DefaultNode::DefaultNodeType>
00074 class OverlapGraph : public Teuchos::Describable {
00075 public:
00077   typedef Tpetra::CrsGraph<LocalOrdinal,GlobalOrdinal,Node> graph_type;
00078 
00085   OverlapGraph (const Teuchos::RCP<const graph_type>& UserMatrixGraph_in, 
00086     int OverlapLevel_in);
00087 
00089   OverlapGraph (const OverlapGraph<LocalOrdinal,GlobalOrdinal,Node>& Source);
00090 
00092   virtual ~OverlapGraph () {}
00093 
00095   const Tpetra::CrsGraph<LocalOrdinal,GlobalOrdinal,Node>& 
00096   getOverlapGraph () const { return *OverlapGraph_; }
00097     
00099   const Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node>& 
00100   getOverlapRowMap () const {return *OverlapRowMap_; }
00101     
00103   const Tpetra::Import<LocalOrdinal,GlobalOrdinal,Node>& 
00104   getOverlapImporter () const { return *OverlapImporter_; }
00105     
00113   int OverlapLevel () const { return OverlapLevel_; }
00115 
00116 protected:
00117   Teuchos::RCP<const Tpetra::CrsGraph<LocalOrdinal,GlobalOrdinal,Node> > OverlapGraph_;
00118   Teuchos::RCP<const Tpetra::CrsGraph<LocalOrdinal,GlobalOrdinal,Node> > UserMatrixGraph_;
00119   Teuchos::RCP<Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> > OverlapRowMap_;
00120   Teuchos::RCP<Tpetra::Import<LocalOrdinal,GlobalOrdinal,Node> > OverlapImporter_;
00121   int OverlapLevel_;
00122   bool IsOverlapped_;
00123 };
00124 
00125 template<class LocalOrdinal, class GlobalOrdinal, class Node>
00126 OverlapGraph<LocalOrdinal,GlobalOrdinal,Node>::
00127 OverlapGraph (const Teuchos::RCP<const Tpetra::CrsGraph<LocalOrdinal,GlobalOrdinal,Node> >& UserMatrixGraph_in, 
00128         int OverlapLevel_in)
00129   : UserMatrixGraph_ (UserMatrixGraph_in),
00130     OverlapLevel_ (OverlapLevel_in),
00131     IsOverlapped_ (OverlapLevel_in > 0 && UserMatrixGraph_in->getDomainMap ()->isDistributed ())
00132 {
00133   OverlapGraph_ = createOverlapGraph (UserMatrixGraph_, OverlapLevel_);
00134 }
00135 
00136 template<class LocalOrdinal, class GlobalOrdinal, class Node>
00137 OverlapGraph<LocalOrdinal,GlobalOrdinal,Node>::
00138 OverlapGraph (const OverlapGraph<LocalOrdinal,GlobalOrdinal,Node>& Source)
00139   : UserMatrixGraph_ (Source.UserMatrixGraph_),
00140     OverlapRowMap_ (Source.OverlapRowMap_),
00141     OverlapLevel_ (Source.OverlapLevel_),
00142     IsOverlapped_ (Source.IsOverlapped_)
00143 {
00144   using Teuchos::rcp;
00145   typedef Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> map_type;
00146 
00147   if (IsOverlapped_) {
00148     if (! OverlapGraph_.is_null ()) {
00149       OverlapGraph_ = rcp (new graph_type (*OverlapGraph_));
00150     }
00151     if (! OverlapRowMap_.is_null ()) {
00152       OverlapRowMap_ = rcp (new map_type (*OverlapRowMap_));
00153     }
00154   }
00155 }
00156 
00157 }//namespace Ifpack2
00158 
00159 #endif // IFPACK2_OVERLAPGRAPH_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends