MueLu_DirectSolver_decl.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//        MueLu: A package for multigrid based preconditioning
//
// Copyright 2012 NTESS and the MueLu contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef MUELU_DIRECTSOLVER_DECL_HPP
#define MUELU_DIRECTSOLVER_DECL_HPP

#include <Teuchos_ParameterList.hpp>

#include "MueLu_ConfigDefs.hpp"
#include "MueLu_DirectSolver_fwd.hpp"

#include "MueLu_SmootherPrototype.hpp"

#include "MueLu_FactoryBase_fwd.hpp"
#include "MueLu_Amesos2Smoother_fwd.hpp"
#include "MueLu_AmesosSmoother_fwd.hpp"
#include "MueLu_BelosSmoother_fwd.hpp"
#include "MueLu_StratimikosSmoother_fwd.hpp"
#include "MueLu_RefMaxwellSmoother_fwd.hpp"

// Note: DirectSolver is a SmootherPrototype that cannot be turned into a smoother using Setup().
//       When this prototype is cloned using Copy(), the clone is an Amesos or an Amesos2 smoother.
//       The clone can be used as a smoother after calling Setup().

namespace MueLu {

template <class Scalar        = SmootherPrototype<>::scalar_type,
          class LocalOrdinal  = typename SmootherPrototype<Scalar>::local_ordinal_type,
          class GlobalOrdinal = typename SmootherPrototype<Scalar, LocalOrdinal>::global_ordinal_type,
          class Node          = typename SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
class DirectSolver : public SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal, Node> {
#undef MUELU_DIRECTSOLVER_SHORT
#include "MueLu_UseShortNames.hpp"

 public:


  DirectSolver(const std::string& type = "", const Teuchos::ParameterList& paramList = Teuchos::ParameterList());

  virtual ~DirectSolver() {}




  void DeclareInput(Level& currentLevel) const;




  void Setup(Level& currentLevel);

  void Apply(MultiVector& X, const MultiVector& B, bool InitialGuessIsZero = false) const;


  void SetFactory(const std::string& varName, const RCP<const FactoryBase>& factory);

  RCP<SmootherPrototype> Copy() const;



  std::string description() const;

  void print(Teuchos::FancyOStream& out, const VerbLevel verbLevel = Default) const;

  size_t getNodeSmootherComplexity() const {
    if (!s_.is_null())
      return s_->getNodeSmootherComplexity();
    else
      return 0.0;
  }


 private:
  //
  // Parameters
  //

  std::string type_;

  //
  // Underlying Smoother
  //

  RCP<SmootherPrototype> sEpetra_, sTpetra_, sBelos_, sStratimikos_, sRefMaxwell_;
  mutable RCP<SmootherPrototype> s_;

  // Records for the case if something goes wrong
  bool triedEpetra_, triedTpetra_, triedBelos_, triedStratimikos_, triedRefMaxwell_;
  std::string errorEpetra_, errorTpetra_, errorBelos_, errorStratimikos_, errorRefMaxwell_;

};  // class DirectSolver

}  // namespace MueLu

#define MUELU_DIRECTSOLVER_SHORT
#endif  // MUELU_DIRECTSOLVER_DECL_HPP