MueLu_SaPFactory_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_SAPFACTORY_DECL_HPP
#define MUELU_SAPFACTORY_DECL_HPP

#include <string>

#include "MueLu_ConfigDefs.hpp"

#include <Tpetra_KokkosCompat_ClassicNodeAPI_Wrapper.hpp>

#include "MueLu_SaPFactory_fwd.hpp"

#include "MueLu_Level_fwd.hpp"
#include "MueLu_ParameterListAcceptor.hpp"
#include "MueLu_PerfUtils_fwd.hpp"
#include "MueLu_PFactory.hpp"
#include "MueLu_TentativePFactory_fwd.hpp"

namespace MueLu {

template <class Scalar        = DefaultScalar,
          class LocalOrdinal  = DefaultLocalOrdinal,
          class GlobalOrdinal = DefaultGlobalOrdinal,
          class Node          = DefaultNode>
class SaPFactory : public PFactory {
 public:
  typedef LocalOrdinal local_ordinal_type;
  typedef GlobalOrdinal global_ordinal_type;
  typedef typename Node::execution_space execution_space;
  typedef Node node_type;

 private:
#undef MUELU_SAPFACTORY_SHORT
#include "MueLu_UseShortNames.hpp"

 public:


  SaPFactory();

  virtual ~SaPFactory();

  RCP<const ParameterList> GetValidParameterList() const;




  void DeclareInput(Level& fineLevel, Level& coarseLevel) const;




  void Build(Level& fineLevel, Level& coarseLevel) const;

  void BuildP(Level& fineLevel, Level& coarseLevel) const;

  void SatisfyPConstraintsNonKokkos(RCP<Matrix> A, RCP<Matrix>& P) const;

  void optimalSatisfyPConstraintsForScalarPDEsNonKokkos(RCP<Matrix>& P) const;

  void SatisfyPConstraints(RCP<Matrix> A, RCP<Matrix>& P) const;

  void optimalSatisfyPConstraintsForScalarPDEs(RCP<Matrix>& P) const;

  bool constrainRow(Scalar* orig, LocalOrdinal nEntries, Scalar leftBound, Scalar rghtBound, Scalar rsumTarget, Scalar* fixedUnsorted, Scalar* scalarData) const;

};

}  // namespace MueLu

#define MUELU_SAPFACTORY_SHORT
#endif  // MUELU_SAPFACTORY_DECL_HPP