Ifpack2_Details_LinearSolver_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_LINEARSOLVER_DECL_HPP
#define IFPACK2_DETAILS_LINEARSOLVER_DECL_HPP

#include "Ifpack2_ConfigDefs.hpp"
#include "Trilinos_Details_LinearSolver.hpp"
#include "Ifpack2_Preconditioner.hpp"
#include "Teuchos_Describable.hpp"

namespace Ifpack2 {
namespace Details {

template <class SC, class LO, class GO, class NT>
class LinearSolver : public Trilinos::Details::LinearSolver<Tpetra::MultiVector<SC, LO, GO, NT>,
                                                            Tpetra::Operator<SC, LO, GO, NT>,
                                                            typename Tpetra::MultiVector<SC, LO, GO, NT>::mag_type>,
                     virtual public Teuchos::Describable {
 public:
  typedef Ifpack2::Preconditioner<SC, LO, GO, NT> prec_type;
  typedef Tpetra::Operator<SC, LO, GO, NT> OP;
  typedef Tpetra::MultiVector<SC, LO, GO, NT> MV;

  LinearSolver(const Teuchos::RCP<prec_type>& solver, const std::string& solverName);

  virtual ~LinearSolver() {}

  void setMatrix(const Teuchos::RCP<const OP>& A);

  Teuchos::RCP<const OP> getMatrix() const;

  void solve(MV& X, const MV& B);

  void setParameters(const Teuchos::RCP<Teuchos::ParameterList>& params);

  void symbolic();

  void numeric();

  std::string description() const;

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

 private:
  Teuchos::RCP<prec_type> solver_;
  std::string solverName_;
  Teuchos::RCP<const OP> A_;
};

}  // namespace Details
}  // namespace Ifpack2

#endif  // IFPACK2_DETAILS_LINEARSOLVER_DECL_HPP