Teko_InverseLibrary.hpp

// @HEADER
// *****************************************************************************
//      Teko: A package for block and physics based preconditioning
//
// Copyright 2010 NTESS and the Teko contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef __Teko_InverseLibrary_hpp__
#define __Teko_InverseLibrary_hpp__

#include "Teko_InverseFactory.hpp"

// Teuchos includes
#include "Teuchos_ParameterList.hpp"

// Stratimikos includes
#include "Stratimikos_DefaultLinearSolverBuilder.hpp"

// Teko includes
#include "Teko_RequestHandler.hpp"
#include "Teko_RequestHandlerContainer.hpp"

namespace Teko {

void addToStratimikosBuilder(const Teuchos::RCP<Stratimikos::DefaultLinearSolverBuilder>& builder);

class InverseLibrary : public RequestHandlerContainer {
 public:
  InverseLibrary();

  InverseLibrary(const Teuchos::RCP<Stratimikos::DefaultLinearSolverBuilder>& strat);

  void addInverse(const std::string& label, const Teuchos::ParameterList& pl);

  void addStratSolver(const std::string& label, const std::string& type,
                      const Teuchos::ParameterList& pl);

  void addStratPrecond(const std::string& label, const std::string& type,
                       const Teuchos::ParameterList& pl);

  void addBlockPrecond(const std::string& label, const std::string& type,
                       const Teuchos::ParameterList& pl);

  Teuchos::RCP<const Teuchos::ParameterList> getParameterList(const std::string& label) const;

  Teuchos::RCP<InverseFactory> getInverseFactory(const std::string& label) const;

  void PrintAvailableInverses(std::ostream& os) const;

  void setRequestHandler(const Teuchos::RCP<RequestHandler>& rh) { callbackHandler_ = rh; }

  Teuchos::RCP<RequestHandler> getRequestHandler() const { return callbackHandler_; }

 protected:
  // stratimikos type Inverse objects: mapping the label to a parameter list
  std::map<std::string, Teuchos::RCP<const Teuchos::ParameterList> > stratSolver_;
  std::map<std::string, Teuchos::RCP<const Teuchos::ParameterList> > stratPrecond_;
  std::map<std::string, Teuchos::RCP<const Teuchos::ParameterList> > blockPrecond_;

  // vectors showing which string types are in Stratimikos
  std::vector<std::string> stratValidSolver_;
  std::vector<std::string> stratValidPrecond_;
  std::vector<std::string> blockValidPrecond_;

  Teuchos::RCP<RequestHandler> callbackHandler_;

  Teuchos::RCP<Stratimikos::DefaultLinearSolverBuilder> defaultBuilder_;

 public:
  static Teuchos::RCP<InverseLibrary> buildFromParameterList(const Teuchos::ParameterList& pl,
                                                             bool useStratDefaults = true);

  static Teuchos::RCP<InverseLibrary> buildFromParameterList(
      const Teuchos::ParameterList& pl,
      const Teuchos::RCP<Stratimikos::DefaultLinearSolverBuilder>& strat);

  static Teuchos::RCP<InverseLibrary> buildFromStratimikos();

  static Teuchos::RCP<InverseLibrary> buildFromStratimikos(
      const Stratimikos::DefaultLinearSolverBuilder& strat);

  static Teuchos::RCP<InverseLibrary> buildFromStratimikos(
      const Teuchos::RCP<Stratimikos::DefaultLinearSolverBuilder>& strat);
};

}  // end namespace Teko

#endif