Ifpack2_LocalFilter_decl.hpp

/*@HEADER
// ***********************************************************************
//
//       Ifpack2: Templated 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_LOCALFILTER_DECL_HPP
#define IFPACK2_LOCALFILTER_DECL_HPP

#include "Ifpack2_ConfigDefs.hpp"
#include "Ifpack2_Details_RowMatrix.hpp"
#include <type_traits>
#include <vector>


namespace Ifpack2 {

template<class MatrixType>
class LocalFilter :
    virtual public Ifpack2::Details::RowMatrix<MatrixType>,
    virtual public Teuchos::Describable
{
private:
  // Tpetra needs C++11 now because Kokkos needs C++11 now.
  // Thus, Ifpack2 needs C++11.
  static_assert (std::is_same<
                   MatrixType,
                   Tpetra::RowMatrix<
                     typename MatrixType::scalar_type,
                     typename MatrixType::local_ordinal_type,
                     typename MatrixType::global_ordinal_type,
                     typename MatrixType::node_type> >::value,
                 "Ifpack2::LocalFilter: MatrixType must be a Tpetra::RowMatrix specialization.");

public:


  typedef typename MatrixType::scalar_type scalar_type;

  typedef typename MatrixType::local_ordinal_type local_ordinal_type;

  typedef typename MatrixType::global_ordinal_type global_ordinal_type;

  typedef typename MatrixType::node_type node_type;

  typedef typename Teuchos::ScalarTraits<scalar_type>::magnitudeType magnitude_type;

  typedef Tpetra::RowMatrix<scalar_type,
                            local_ordinal_type,
                            global_ordinal_type,
                            node_type> row_matrix_type;

  typedef Tpetra::Map<local_ordinal_type,
                      global_ordinal_type,
                      node_type> map_type;

  typedef typename row_matrix_type::mag_type mag_type;



  virtual std::string description () const;

  virtual void
  describe (Teuchos::FancyOStream &out,
            const Teuchos::EVerbosityLevel verbLevel =
            Teuchos::Describable::verbLevel_default) const;



  explicit LocalFilter (const Teuchos::RCP<const row_matrix_type>& A);

  virtual ~LocalFilter();



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


  virtual Teuchos::RCP<const map_type> getRowMap() const;

  virtual Teuchos::RCP<const map_type> getColMap() const;

  virtual Teuchos::RCP<const map_type> getDomainMap() const;

  virtual Teuchos::RCP<const map_type> getRangeMap() const;

  virtual Teuchos::RCP<const Tpetra::RowGraph<local_ordinal_type,global_ordinal_type,node_type> >
  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 global_ordinal_type getIndexBase() const;

  virtual global_size_t getGlobalNumEntries() const;

  virtual size_t getNodeNumEntries() const;

  virtual size_t getNumEntriesInGlobalRow (global_ordinal_type globalRow) const;

  virtual size_t getNumEntriesInLocalRow (local_ordinal_type localRow) const;

  virtual size_t getGlobalMaxNumRowEntries() const;

  virtual size_t getNodeMaxNumRowEntries() const;

  virtual bool hasColMap() const;

  virtual bool isLocallyIndexed() const;

  virtual bool isGloballyIndexed() const;

  virtual bool isFillComplete() const;

  virtual bool supportsRowViews() const;



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

  virtual void
  getLocalRowCopy (local_ordinal_type LocalRow,
                   const Teuchos::ArrayView<local_ordinal_type> &Indices,
                   const Teuchos::ArrayView<scalar_type> &Values,
                   size_t &NumEntries) const ;


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


  virtual void
  getLocalRowView (local_ordinal_type LocalRow,
                   Teuchos::ArrayView<const local_ordinal_type> &indices,
                   Teuchos::ArrayView<const scalar_type> &values) const;

  virtual void
  getLocalDiagCopy (Tpetra::Vector<scalar_type, local_ordinal_type, global_ordinal_type, node_type> &diag) const;



  virtual void leftScale(const Tpetra::Vector<scalar_type, local_ordinal_type, global_ordinal_type, node_type>& x);

  virtual void rightScale(const Tpetra::Vector<scalar_type, local_ordinal_type, global_ordinal_type, node_type>& x);

  virtual mag_type getFrobeniusNorm() const;

  virtual void
  apply (const Tpetra::MultiVector<scalar_type, local_ordinal_type, global_ordinal_type, node_type> &X,
         Tpetra::MultiVector<scalar_type, local_ordinal_type, global_ordinal_type, node_type> &Y,
         Teuchos::ETransp mode = Teuchos::NO_TRANS,
         scalar_type alpha = Teuchos::ScalarTraits<scalar_type>::one(),
         scalar_type beta = Teuchos::ScalarTraits<scalar_type>::zero()) const;

  virtual bool hasTransposeApply() const;

  virtual Teuchos::RCP<const row_matrix_type> getUnderlyingMatrix() const;

private:
  typedef Tpetra::RowGraph<local_ordinal_type,
                           global_ordinal_type,
                           node_type> row_graph_type;
  void
  applyNonAliased (const Tpetra::MultiVector<scalar_type,local_ordinal_type,global_ordinal_type,node_type> &X,
                   Tpetra::MultiVector<scalar_type,local_ordinal_type,global_ordinal_type,node_type> &Y,
                   Teuchos::ETransp mode,
                   scalar_type alpha,
                   scalar_type beta) const;

  static bool
  mapPairIsFitted (const map_type& map1, const map_type& map2);

  // If both pairs of Maps of the original matrix A are fitted on this
  // process, then this process can use a fast "view" implementation.
  static bool
  mapPairsAreFitted (const row_matrix_type& A);

  Teuchos::RCP<const row_matrix_type> A_;

  Teuchos::RCP<const map_type> localRowMap_;

  Teuchos::RCP<const map_type> localDomainMap_;

  Teuchos::RCP<const map_type> localRangeMap_;

  size_t NumNonzeros_;
  size_t MaxNumEntries_;
  size_t MaxNumEntriesA_;
  std::vector<size_t> NumEntries_;

  mutable Teuchos::Array<local_ordinal_type> localIndices_;

  mutable Teuchos::Array<scalar_type> Values_;
};// class LocalFilter

}// namespace Ifpack2

#endif /* IFPACK2_LOCALFILTER_DECL_HPP */