BelosCustomSolverFactory.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//                 Belos: Block Linear Solvers Package
//
// Copyright 2004-2016 NTESS and the Belos contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef BELOSSOLVERFACTORYBASE_HPP
#define BELOSSOLVERFACTORYBASE_HPP

#include <string>
#include <vector>
#include "Teuchos_RCP.hpp"

#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Teuchos {
// Forward declaration
class ParameterList;
} // namespace Teuchos
#endif // DOXYGEN_SHOULD_SKIP_THIS

namespace Belos {

#ifndef DOXYGEN_SHOULD_SKIP_THIS
// Forward declaration
template<class Scalar, class MV, class OP>
class SolverManager;
#endif // DOXYGEN_SHOULD_SKIP_THIS

template<class Scalar, class MV, class OP>
class CustomSolverFactory {
public:
  virtual Teuchos::RCP<SolverManager<Scalar, MV, OP> >
  getSolver (const std::string& solverName,
             const Teuchos::RCP<Teuchos::ParameterList>& solverParams) = 0;

  virtual int numSupportedSolvers () const = 0;

  virtual std::vector<std::string> supportedSolverNames () const = 0;

  virtual bool isSupported (const std::string& solverName) const = 0;

  virtual ~CustomSolverFactory () {}
};

} // namespace Belos

#endif // BELOSSOLVERFACTORYBASE_HPP