Ifpack2_DenseContainer_decl.hpp

Go to the documentation of this file.

/*@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_DENSECONTAINER_DECL_HPP
#define IFPACK2_DENSECONTAINER_DECL_HPP


#include "Ifpack2_Container.hpp"
#include "Ifpack2_Details_MultiVectorLocalGatherScatter.hpp"
#include "Ifpack2_Details_LapackSupportsScalar.hpp"
#include "Tpetra_MultiVector.hpp"
#include "Tpetra_Map.hpp"
#include "Tpetra_RowMatrix.hpp"
#include "Teuchos_SerialDenseMatrix.hpp"

namespace Ifpack2 {

template<class MatrixType,
         class LocalScalarType,
         const bool supportsLocalScalarType =
         ::Ifpack2::Details::LapackSupportsScalar<LocalScalarType>::value >
class DenseContainer {};

template<typename MatrixType, typename LocalScalarType>
class DenseContainer<MatrixType, LocalScalarType, true> :
    public Container<MatrixType> {
public:


  typedef MatrixType matrix_type;
  typedef LocalScalarType local_scalar_type;

  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;

  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::DenseContainer: Please use MatrixType = Tpetra::RowMatrix.");

  typedef typename Container<MatrixType>::row_matrix_type row_matrix_type;



  DenseContainer (const Teuchos::RCP<const row_matrix_type>& matrix,
                  const Teuchos::ArrayView<const local_ordinal_type>& localRows);

  virtual ~DenseContainer ();



  virtual size_t getNumRows () const {
    return numRows_;
  }

  virtual bool isInitialized () const {
    return IsInitialized_;
  }

  virtual bool isComputed () const {
    return IsComputed_;
  }

  virtual void setParameters(const Teuchos::ParameterList& List);



  virtual void initialize ();

  virtual void compute ();

  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 void
  weightedApply (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,
                 const Tpetra::Vector<scalar_type,local_ordinal_type,global_ordinal_type,node_type>& D,
                 Teuchos::ETransp mode=Teuchos::NO_TRANS,
                 scalar_type alpha=Teuchos::ScalarTraits<scalar_type>::one(),
                 scalar_type beta=Teuchos::ScalarTraits<scalar_type>::zero()) const;



  virtual std::ostream& print (std::ostream& os) const;



  virtual std::string description () const;

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

private:
  DenseContainer (const DenseContainer<MatrixType, LocalScalarType>& rhs);

  void extract (const Teuchos::RCP<const row_matrix_type>& globalMatrix);

  void factor ();

  typedef Tpetra::MultiVector<local_scalar_type, local_ordinal_type,
                              global_ordinal_type, node_type> local_mv_type;

  void
  applyImpl (const local_mv_type& X,
             local_mv_type& Y,
             Teuchos::ETransp mode,
             const local_scalar_type alpha,
             const local_scalar_type beta) const;

  size_t numRows_;

  Teuchos::SerialDenseMatrix<int, local_scalar_type> diagBlock_;

  Teuchos::Array<int> ipiv_;

  Teuchos::RCP<const Tpetra::Map<local_ordinal_type, global_ordinal_type, node_type> > localMap_;

  mutable Teuchos::RCP<local_mv_type> Y_;

  mutable Teuchos::RCP<local_mv_type> X_;

  bool IsInitialized_;

  bool IsComputed_;
};

template<class MatrixType, class LocalScalarType>
class DenseContainer<MatrixType, LocalScalarType, false> :
    public Container<MatrixType> {
public:


  typedef MatrixType matrix_type;
  typedef LocalScalarType local_scalar_type;

  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;

  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::DenseContainer: Please use MatrixType = Tpetra::RowMatrix.");

  typedef typename Container<MatrixType>::row_matrix_type row_matrix_type;



  DenseContainer (const Teuchos::RCP<const row_matrix_type>& matrix,
                  const Teuchos::ArrayView<const local_ordinal_type>& localRows);

  virtual ~DenseContainer ();



  virtual size_t getNumRows () const {
    return numRows_;
  }

  virtual bool isInitialized () const {
    return IsInitialized_;
  }

  virtual bool isComputed () const {
    return IsComputed_;
  }

  virtual void setParameters(const Teuchos::ParameterList& List);



  virtual void initialize ();

  virtual void compute ();

  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 void
  weightedApply (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,
                 const Tpetra::Vector<scalar_type,local_ordinal_type,global_ordinal_type,node_type>& D,
                 Teuchos::ETransp mode=Teuchos::NO_TRANS,
                 scalar_type alpha=Teuchos::ScalarTraits<scalar_type>::one(),
                 scalar_type beta=Teuchos::ScalarTraits<scalar_type>::zero()) const;



  virtual std::ostream& print (std::ostream& os) const;



  virtual std::string description () const;

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

private:
  DenseContainer (const DenseContainer<MatrixType, LocalScalarType>& rhs);

  void extract (const Teuchos::RCP<const row_matrix_type>& globalMatrix);

  void factor ();

  typedef Tpetra::MultiVector<local_scalar_type, local_ordinal_type,
                              global_ordinal_type, node_type> local_mv_type;

  void
  applyImpl (const local_mv_type& X,
             local_mv_type& Y,
             Teuchos::ETransp mode,
             const local_scalar_type alpha,
             const local_scalar_type beta) const;

  size_t numRows_;

  Teuchos::SerialDenseMatrix<int, local_scalar_type> diagBlock_;

  Teuchos::Array<int> ipiv_;

  Teuchos::RCP<const Tpetra::Map<local_ordinal_type, global_ordinal_type, node_type> > localMap_;

  mutable Teuchos::RCP<local_mv_type> Y_;

  mutable Teuchos::RCP<local_mv_type> X_;

  bool IsInitialized_;

  bool IsComputed_;
};

} // namespace Ifpack2

#endif // IFPACK2_DENSECONTAINER_DECL_HPP