Ifpack2_Details_OneLevelFactory_decl.hpp

// @HEADER
// *****************************************************************************
//       Ifpack2: Templated Object-Oriented Algebraic Preconditioner Package
//
// Copyright 2009 NTESS and the Ifpack2 contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef IFPACK2_DETAILS_ONELEVELFACTORY_DECL_HPP
#define IFPACK2_DETAILS_ONELEVELFACTORY_DECL_HPP

#include "Ifpack2_ConfigDefs.hpp"
#include "Ifpack2_Preconditioner.hpp"
#include "Tpetra_RowMatrix.hpp"
#include <type_traits>  // std::is_same

namespace Ifpack2 {
namespace Details {

template <class MatrixType>
class OneLevelFactory {
 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 ::Ifpack2::Preconditioner<scalar_type,
                                    local_ordinal_type,
                                    global_ordinal_type,
                                    node_type>
      prec_type;
  typedef ::Tpetra::RowMatrix<scalar_type,
                              local_ordinal_type,
                              global_ordinal_type,
                              node_type>
      row_matrix_type;

  static_assert(std::is_same<MatrixType, row_matrix_type>::value,
                "Ifpack2::Details::OneLevelFactory: MatrixType must be a "
                "Tpetra::RowMatrix specialization.");

  Teuchos::RCP<prec_type>
  create(const std::string& precType,
         const Teuchos::RCP<const row_matrix_type>& matrix) const;

  std::vector<std::string>
  getSupportedNames() const;

  bool
  isSupported(const std::string& precType) const;
};

}  // namespace Details
}  // namespace Ifpack2

#endif  // IFPACK2_DETAILS_ONELEVELFACTORY_DECL_HPP