Ifpack2 Templated Preconditioning Package Version 1.0
Ifpack2_SparsityFilter_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 // 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 
00030 #ifndef IFPACK2_SPARSITYFILTER_DECL_HPP
00031 #define IFPACK2_SPARSITYFILTER_DECL_HPP
00032 
00033 #include "Ifpack2_ConfigDefs.hpp"
00034 #include "Tpetra_ConfigDefs.hpp"
00035 #include "Tpetra_RowMatrix.hpp"
00036 #include "Teuchos_RefCountPtr.hpp"
00037 #include "Teuchos_ScalarTraits.hpp"
00038 
00039 
00040 namespace Ifpack2 {
00042 
00068 template<class MatrixType>
00069 class  SparsityFilter : virtual public Tpetra::RowMatrix<typename MatrixType::scalar_type,typename MatrixType::local_ordinal_type,typename MatrixType::global_ordinal_type,typename MatrixType::node_type> {
00070   
00071 public:
00072   typedef typename MatrixType::scalar_type Scalar;
00073   typedef typename MatrixType::local_ordinal_type LocalOrdinal;
00074   typedef typename MatrixType::global_ordinal_type GlobalOrdinal;
00075   typedef typename MatrixType::node_type Node;
00076   typedef typename Teuchos::ScalarTraits<Scalar>::magnitudeType magnitudeType;
00077   
00078 
00079 public:
00081 
00082 
00084   explicit SparsityFilter(const Teuchos::RCP<const Tpetra::RowMatrix<Scalar,LocalOrdinal,GlobalOrdinal,Node> >& Matrix,
00085         size_t AllowedNumEntries,
00086         LocalOrdinal AllowedBandwidth = -Teuchos::ScalarTraits<LocalOrdinal>::one());
00088   virtual ~SparsityFilter();
00089 
00091 
00093 
00094 
00096   virtual const Teuchos::RCP<const Teuchos::Comm<int> > & getComm() const;
00097 
00099   virtual Teuchos::RCP<Node> getNode() const;
00100 
00102   virtual const Teuchos::RCP<const Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> > & getRowMap() const;
00103 
00105   virtual const Teuchos::RCP<const Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> > & getColMap() const;
00106 
00108   virtual const Teuchos::RCP<const Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> > & getDomainMap() const;
00109 
00111   virtual const Teuchos::RCP<const Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> > & getRangeMap() const;
00112 
00114   virtual Teuchos::RCP<const Tpetra::RowGraph<LocalOrdinal,GlobalOrdinal,Node> > getGraph() const;
00115 
00117   virtual global_size_t getGlobalNumRows() const;
00118 
00120   virtual global_size_t getGlobalNumCols() const;
00121 
00123   virtual size_t getNodeNumRows() const;
00124 
00126   virtual size_t getNodeNumCols() const;
00127 
00129   virtual GlobalOrdinal getIndexBase() const;
00130 
00132   virtual global_size_t getGlobalNumEntries() const;
00133 
00135   virtual size_t getNodeNumEntries() const;
00136   
00138 
00139   virtual size_t getNumEntriesInGlobalRow(GlobalOrdinal globalRow) const;
00140   
00142 
00143   virtual size_t getNumEntriesInLocalRow(LocalOrdinal localRow) const;
00144   
00146   virtual global_size_t getGlobalNumDiags() const;
00147   
00149   virtual size_t getNodeNumDiags() const;
00150   
00152   virtual size_t getGlobalMaxNumRowEntries() const;
00153   
00155   virtual size_t getNodeMaxNumRowEntries() const;
00156   
00158   virtual bool hasColMap() const;
00159   
00161   virtual bool isLowerTriangular() const;
00162   
00164   virtual bool isUpperTriangular() const;
00165   
00167   virtual bool isLocallyIndexed() const;
00168   
00170   virtual bool isGloballyIndexed() const;
00171   
00173   virtual bool isFillComplete() const;
00174   
00175 
00177   
00179 
00180   
00182 
00192   virtual void getGlobalRowCopy(GlobalOrdinal GlobalRow,
00193         const Teuchos::ArrayView<GlobalOrdinal> &Indices,
00194         const Teuchos::ArrayView<Scalar> &Values,
00195         size_t &NumEntries) const;
00196   
00198 
00208   virtual void getLocalRowCopy(LocalOrdinal DropRow, 
00209              const Teuchos::ArrayView<LocalOrdinal> &Indices, 
00210              const Teuchos::ArrayView<Scalar> &Values,
00211              size_t &NumEntries) const ;
00212   
00214 
00223   virtual void getGlobalRowView(GlobalOrdinal GlobalRow, 
00224         Teuchos::ArrayView<const GlobalOrdinal> &indices, 
00225         Teuchos::ArrayView<const Scalar> &values) const;
00226   
00228 
00237   virtual void getLocalRowView(LocalOrdinal DropRow, 
00238              Teuchos::ArrayView<const LocalOrdinal> &indices, 
00239              Teuchos::ArrayView<const Scalar> &values) const;
00240   
00242 
00244   virtual void getLocalDiagCopy(Tpetra::Vector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &diag) const;
00245   
00247   
00249 
00250   
00260   virtual void leftScale(const Tpetra::Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& x);
00261   
00271   virtual void rightScale(const Tpetra::Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& x);
00272   
00274 
00277   virtual typename Teuchos::ScalarTraits<Scalar>::magnitudeType getFrobeniusNorm() const;
00278 
00280 
00285   virtual void apply(const Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &X, 
00286          Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &Y, 
00287          Teuchos::ETransp mode = Teuchos::NO_TRANS, 
00288          Scalar alpha = Teuchos::ScalarTraits<Scalar>::one(),
00289          Scalar beta = Teuchos::ScalarTraits<Scalar>::zero()) const;
00290   
00292   virtual bool hasTransposeApply() const;
00293   
00295   
00297 
00298   
00300 
00309   TPETRA_DEPRECATED virtual void getGlobalRowView(GlobalOrdinal GlobalRow, 
00310               Teuchos::ArrayRCP<const GlobalOrdinal> &indices,
00311               Teuchos::ArrayRCP<const Scalar>        &values) const;
00312   
00314 
00323   TPETRA_DEPRECATED virtual void getLocalRowView(LocalOrdinal DropRow,
00324              Teuchos::ArrayRCP<const LocalOrdinal> &indices,
00325              Teuchos::ArrayRCP<const Scalar>       &values) const;  
00327 
00328   
00329 private:
00330 
00332   Teuchos::RCP<const Tpetra::RowMatrix<Scalar,LocalOrdinal,GlobalOrdinal,Node> > A_;
00333 
00335   size_t AllowedNumEntries_;  
00337   LocalOrdinal AllowedBandwidth_;
00339   size_t NumRows_;
00341   size_t NumNonzeros_;
00343   size_t MaxNumEntries_;
00345   size_t MaxNumEntriesA_;
00347   std::vector<size_t> NumEntries_;
00349   mutable Teuchos::Array<LocalOrdinal> Indices_;
00351   mutable Teuchos::Array<Scalar> Values_;
00352 
00353 };// class SparsityFilter
00354 
00355 }// namespace Ifpack2
00356 
00357 #endif /* IFPACK2_SPARSITYFILTER_DECL_HPP */
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends