MueLu_BraessSarazinSmoother_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_BRAESSSARAZINSMOOTHER_DECL_HPP_
#define MUELU_BRAESSSARAZINSMOOTHER_DECL_HPP_
#include "MueLu_ConfigDefs.hpp"

#include <Teuchos_ParameterList.hpp>

// Xpetra
#include <Xpetra_MapExtractor_fwd.hpp>
#include <Xpetra_MultiVectorFactory_fwd.hpp>
#include <Xpetra_Matrix_fwd.hpp>

// MueLu
#include "MueLu_BraessSarazinSmoother_fwd.hpp"
#include "MueLu_SmootherPrototype.hpp"
#include "MueLu_FactoryBase_fwd.hpp"
#include "MueLu_FactoryManagerBase_fwd.hpp"
#include "MueLu_SmootherBase_fwd.hpp"
#include "MueLu_Utilities_fwd.hpp"

#include "MueLu_FactoryManager_fwd.hpp"

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 BraessSarazinSmoother : public SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal, Node> {
#undef MUELU_BRAESSSARAZINSMOOTHER_SHORT
#include "MueLu_UseShortNames.hpp"

 public:


  RCP<const ParameterList> GetValidParameterList() const;

  void DeclareInput(Level &currentLevel) const;

  void AddFactoryManager(RCP<const FactoryManagerBase> FactManager, int pos = 0);




  void Setup(Level &currentLevel);

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

  RCP<SmootherPrototype> Copy() const;



  std::string description() const;

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

  size_t getNodeSmootherComplexity() const;


 private:
  std::string type_ = "Braess Sarazin";

  RCP<const FactoryBase> AFact_;               
  RCP<const FactoryManagerBase> FactManager_;  

  RCP<Matrix> A_ = Teuchos::null;  // < ! internal blocked operator "A" generated by AFact_

  RCP<const MapExtractor> rangeMapExtractor_;   
  RCP<const MapExtractor> domainMapExtractor_;  

  RCP<Matrix> A00_;  
  RCP<Matrix> A01_;  
  RCP<Matrix> A10_;  
  RCP<Matrix> A11_;  
  RCP<Matrix> S_;    
  RCP<Vector> D_;    

  Teuchos::RCP<SmootherBase> smoo_;  

};  // class Amesos2Smoother

}  // namespace MueLu

#define MUELU_BRAESSSARAZINSMOOTHER_SHORT
#endif /* MUELU_BRAESSSARAZINSMOOTHER_DECL_HPP_ */