MueLu_AmesosSmoother.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_AMESOSSMOOTHER_HPP
#define MUELU_AMESOSSMOOTHER_HPP
 
#include "MueLu_ConfigDefs.hpp"
#if defined(HAVE_MUELU_EPETRA) && defined(HAVE_MUELU_AMESOS)
 
#include <Teuchos_ParameterList.hpp>
#include <Xpetra_Matrix_fwd.hpp>
 
class Epetra_LinearProblem;
class Amesos_BaseSolver;
 
#include "MueLu_SmootherPrototype.hpp"
#include "MueLu_Exceptions.hpp"
 
#include "MueLu_Level_fwd.hpp"
#include "MueLu_FactoryBase_fwd.hpp"
#include "MueLu_Utilities_fwd.hpp"
 
namespace MueLu {
 
template <class Node = typename SmootherPrototype<double, int, int>::node_type>
class AmesosSmoother : public SmootherPrototype<double, int, int, Node> {
  typedef double Scalar;
  typedef int LocalOrdinal;
  typedef int GlobalOrdinal;
 
#undef MUELU_AMESOSSMOOTHER_SHORT
#include "MueLu_UseShortNames.hpp"
 
 public:
 
 
  AmesosSmoother(const std::string& type = "", const Teuchos::ParameterList& paramList = Teuchos::ParameterList());
 
  virtual ~AmesosSmoother(){};
 
 
 
 
  void DeclareInput(Level& currentLevel) const;
 
 
 
 
  void Setup(Level& currentLevel);
 
  void Apply(MultiVector& X, const MultiVector& B, bool /* InitialGuessIsZero */ = false) const;
 
 
  RCP<SmootherPrototype> Copy() const;
 
 
 
  std::string description() const;
 
  // using MueLu::Describable::describe; // overloading, not hiding
  void print(Teuchos::FancyOStream& out, const VerbLevel verbLevel = Default) const;
 
  size_t getNodeSmootherComplexity() const;
 
 
 private:
  // Important note:
  // linearProblem_ must be destroyed before A_, because destructor of linearProblem_ is using A_.
  // In C++, destructor of member objects are called in the reverse order they appear within the declaration for the class.
  // ==18029== Invalid read of size 8
  // ==18029==    at 0xC0780A: Epetra_LinearProblem::GetMatrix() const (Epetra_LinearProblem.h:173)
  // ==18029==    by 0xC5EC27: Amesos_Superlu::PrintTiming() const (Amesos_Superlu.cpp:664)
  // ==18029==    by 0xC628C6: Amesos_Superlu::~Amesos_Superlu() (Amesos_Superlu.cpp:108)
 
  std::string type_;
 
  RCP<Matrix> A_;
 
  RCP<Epetra_LinearProblem> linearProblem_;
 
  RCP<Amesos_BaseSolver> prec_;
 
};  // class AmesosSmoother
 
// when <Scalar, LocalOrdinal, GlobalOrdinal> == <double, int, int>. Otherwise, an exception is thrown.
template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
RCP<MueLu::SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal, Node> >
GetAmesosSmoother(const std::string& /* type */ = "", const Teuchos::ParameterList& /* paramList */ = Teuchos::ParameterList()) {
  TEUCHOS_TEST_FOR_EXCEPTION(true, Exceptions::RuntimeError,
                             "AmesosSmoother cannot be used with Scalar != double, LocalOrdinal != int, GlobalOrdinal != int");
  TEUCHOS_UNREACHABLE_RETURN(Teuchos::null);
}
 
// specialization for Epetra
#if defined(HAVE_MUELU_SERIAL)
template <>
inline RCP<MueLu::SmootherPrototype<double, int, int, Xpetra::EpetraNode> >
GetAmesosSmoother<double, int, int, Xpetra::EpetraNode>(const std::string& type, const Teuchos::ParameterList& paramList) {
  return rcp(new MueLu::AmesosSmoother<Xpetra::EpetraNode>(type, paramList));
}
#endif  // HAVE_MUELU_SERIAL
 
}  // namespace MueLu
 
#define MUELU_AMESOSSMOOTHER_SHORT
 
#endif  // HAVE_MUELU_AMESOS
#endif  // MUELU_AMESOSSMOOTHER_HPP