MueLu_ScaledNullspaceFactory_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_SCALEDNULLSPACEFACTORY_DECL_HPP
#define MUELU_SCALEDNULLSPACEFACTORY_DECL_HPP

#include <Xpetra_Matrix_fwd.hpp>
#include <Xpetra_VectorFactory_fwd.hpp>
#include <Xpetra_MultiVectorFactory_fwd.hpp>

#include "MueLu_ConfigDefs.hpp"
#include "MueLu_SingleLevelFactoryBase.hpp"
#include "MueLu_ScaledNullspaceFactory_fwd.hpp"

#include "MueLu_Level_fwd.hpp"

namespace MueLu {

template <class Scalar        = DefaultScalar,
          class LocalOrdinal  = DefaultLocalOrdinal,
          class GlobalOrdinal = DefaultGlobalOrdinal,
          class Node          = DefaultNode>
class ScaledNullspaceFactory : public SingleLevelFactoryBase {
#undef MUELU_SCALEDNULLSPACEFACTORY_SHORT
#include "MueLu_UseShortNames.hpp"

 public:


  ScaledNullspaceFactory(const std::string &nspName = "Nullspace") {
    SetParameter("Fine level nullspace", ParameterEntry(nspName));
  }

  virtual ~ScaledNullspaceFactory() {}




  RCP<const ParameterList> GetValidParameterList() const;

  void DeclareInput(Level &currentLevel) const;




  void Build(Level &currentLevel) const;


 private:
};  // class NullspaceFactory

}  // namespace MueLu

#define MUELU_SCALEDNULLSPACEFACTORY_SHORT
#endif  // MUELU_SCALEDNULLSPACEFACTORY_DECL_HPP