Ifpack2_SparsityFilter_decl.hpp

/*@HEADER
// ***********************************************************************
//
//       Ifpack2: Tempated Object-Oriented Algebraic Preconditioner Package
//                 Copyright (2009) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
//@HEADER
*/

#ifndef IFPACK2_SPARSITYFILTER_DECL_HPP
#define IFPACK2_SPARSITYFILTER_DECL_HPP

#include "Ifpack2_ConfigDefs.hpp"
#include "Tpetra_ConfigDefs.hpp"
#include "Tpetra_RowMatrix.hpp"
#include "Teuchos_RefCountPtr.hpp"
#include "Teuchos_ScalarTraits.hpp"


namespace Ifpack2 {

template<class MatrixType>
class SparsityFilter : 
    virtual public Tpetra::RowMatrix<typename MatrixType::scalar_type,
             typename MatrixType::local_ordinal_type,
             typename MatrixType::global_ordinal_type,
             typename MatrixType::node_type> {
public:
  typedef typename MatrixType::scalar_type Scalar;
  typedef typename MatrixType::local_ordinal_type LocalOrdinal;
  typedef typename MatrixType::global_ordinal_type GlobalOrdinal;
  typedef typename MatrixType::node_type Node;
  typedef typename Teuchos::ScalarTraits<Scalar>::magnitudeType magnitudeType;
  


  explicit SparsityFilter(const Teuchos::RCP<const Tpetra::RowMatrix<Scalar,LocalOrdinal,GlobalOrdinal,Node> >& Matrix,
        size_t AllowedNumEntries,
        LocalOrdinal AllowedBandwidth = -Teuchos::ScalarTraits<LocalOrdinal>::one());
  virtual ~SparsityFilter();




  virtual Teuchos::RCP<const Teuchos::Comm<int> > getComm() const;

  virtual Teuchos::RCP<Node> getNode() const;

  virtual Teuchos::RCP<const Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> > getRowMap() const;

  virtual Teuchos::RCP<const Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> > getColMap() const;

  virtual Teuchos::RCP<const Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> > getDomainMap() const;

  virtual Teuchos::RCP<const Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> > getRangeMap() const;

  virtual Teuchos::RCP<const Tpetra::RowGraph<LocalOrdinal,GlobalOrdinal,Node> > getGraph() const;

  virtual global_size_t getGlobalNumRows() const;

  virtual global_size_t getGlobalNumCols() const;

  virtual size_t getNodeNumRows() const;

  virtual size_t getNodeNumCols() const;

  virtual GlobalOrdinal getIndexBase() const;

  virtual global_size_t getGlobalNumEntries() const;

  virtual size_t getNodeNumEntries() const;
  

  virtual size_t getNumEntriesInGlobalRow(GlobalOrdinal globalRow) const;
  

  virtual size_t getNumEntriesInLocalRow(LocalOrdinal localRow) const;
  
  virtual global_size_t getGlobalNumDiags() const;
  
  virtual size_t getNodeNumDiags() const;
  
  virtual size_t getGlobalMaxNumRowEntries() const;
  
  virtual size_t getNodeMaxNumRowEntries() const;
  
  virtual bool hasColMap() const;
  
  virtual bool isLowerTriangular() const;
  
  virtual bool isUpperTriangular() const;
  
  virtual bool isLocallyIndexed() const;
  
  virtual bool isGloballyIndexed() const;
  
  virtual bool isFillComplete() const;
  
  virtual bool supportsRowViews() const;  

  

  

  virtual void getGlobalRowCopy(GlobalOrdinal GlobalRow,
        const Teuchos::ArrayView<GlobalOrdinal> &Indices,
        const Teuchos::ArrayView<Scalar> &Values,
        size_t &NumEntries) const;
  

  virtual void getLocalRowCopy(LocalOrdinal DropRow, 
             const Teuchos::ArrayView<LocalOrdinal> &Indices, 
             const Teuchos::ArrayView<Scalar> &Values,
             size_t &NumEntries) const ;
  

  virtual void getGlobalRowView(GlobalOrdinal GlobalRow, 
        Teuchos::ArrayView<const GlobalOrdinal> &indices, 
        Teuchos::ArrayView<const Scalar> &values) const;
  

  virtual void getLocalRowView(LocalOrdinal DropRow, 
             Teuchos::ArrayView<const LocalOrdinal> &indices, 
             Teuchos::ArrayView<const Scalar> &values) const;
  

  virtual void getLocalDiagCopy(Tpetra::Vector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &diag) const;
  
  

  
  virtual void leftScale(const Tpetra::Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& x);
  
  virtual void rightScale(const Tpetra::Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& x);
  

  virtual typename Teuchos::ScalarTraits<Scalar>::magnitudeType getFrobeniusNorm() const;


  virtual void apply(const Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &X, 
         Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &Y, 
         Teuchos::ETransp mode = Teuchos::NO_TRANS, 
         Scalar alpha = Teuchos::ScalarTraits<Scalar>::one(),
         Scalar beta = Teuchos::ScalarTraits<Scalar>::zero()) const;
  
  virtual bool hasTransposeApply() const;
  
  

  

  TPETRA_DEPRECATED virtual void getGlobalRowView(GlobalOrdinal GlobalRow, 
              Teuchos::ArrayRCP<const GlobalOrdinal> &indices,
              Teuchos::ArrayRCP<const Scalar>        &values) const;
  

  TPETRA_DEPRECATED virtual void getLocalRowView(LocalOrdinal DropRow,
             Teuchos::ArrayRCP<const LocalOrdinal> &indices,
             Teuchos::ArrayRCP<const Scalar>       &values) const;  

  
private:

  Teuchos::RCP<const Tpetra::RowMatrix<Scalar,LocalOrdinal,GlobalOrdinal,Node> > A_;

  size_t AllowedNumEntries_;  
  LocalOrdinal AllowedBandwidth_;
  size_t NumRows_;
  size_t NumNonzeros_;
  size_t MaxNumEntries_;
  size_t MaxNumEntriesA_;
  std::vector<size_t> NumEntries_;
  mutable Teuchos::Array<LocalOrdinal> Indices_;
  mutable Teuchos::Array<Scalar> Values_;

};// class SparsityFilter

}// namespace Ifpack2

#endif /* IFPACK2_SPARSITYFILTER_DECL_HPP */