Ifpack2_Details_Factory_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_FACTORY_DECL_HPP
#define IFPACK2_DETAILS_FACTORY_DECL_HPP
 
#include "Ifpack2_ConfigDefs.hpp"
#include "Ifpack2_Preconditioner.hpp"
 
namespace Ifpack2 {
namespace Details {
 
template <class SC, class LO, class GO, class NT>
class Factory {
 public:
  typedef Tpetra::RowMatrix<SC, LO, GO, NT> row_matrix_type;
  typedef ::Ifpack2::Preconditioner<SC, LO, GO, NT> prec_type;
  typedef typename Teuchos::ScalarTraits<SC>::magnitudeType magnitude_type;
  typedef Tpetra::MultiVector<magnitude_type, LO, GO, NT> coord_type;

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

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

  Teuchos::RCP<prec_type>
  create(const std::string& precType,
         const Teuchos::RCP<const row_matrix_type>& matrix,
         const int overlap);
 
  std::vector<std::string>
  getSupportedNames() const;
 
  bool
  isSupported(const std::string& precType);
};
 
}  // namespace Details
}  // namespace Ifpack2
 
#endif  // IFPACK2_DETAILS_FACTORY_DECL_HPP