MueLu_NullspaceFactory_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_NULLSPACEFACTORY_DECL_HPP
#define MUELU_NULLSPACEFACTORY_DECL_HPP

#include "MueLu_ConfigDefs.hpp"

#include "Xpetra_MultiVector_fwd.hpp"

#include "MueLu_NullspaceFactory_fwd.hpp"

#include "MueLu_Level_fwd.hpp"
#include "MueLu_SingleLevelFactoryBase.hpp"

namespace MueLu {

template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>

class NullspaceFactory : public SingleLevelFactoryBase {
 public:
  typedef LocalOrdinal local_ordinal_type;
  typedef GlobalOrdinal global_ordinal_type;
  typedef typename Node::execution_space execution_space;
  typedef Kokkos::RangePolicy<local_ordinal_type, execution_space> range_type;
  typedef Node node_type;

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

 public:


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

  virtual ~NullspaceFactory() {}




  RCP<const ParameterList> GetValidParameterList() const;

  void DeclareInput(Level& currentLevel) const;




  void Build(Level& currentLevel) const;


 private:
  using coordinate_type       = typename Teuchos::ScalarTraits<Scalar>::coordinateType;
  using RealValuedMultiVector = Xpetra::MultiVector<coordinate_type, LO, GO, NO>;
  using CoordsType            = typename RealValuedMultiVector::dual_view_type::t_dev_const_um;
  using MeanCoordsType        = Kokkos::View<typename RealValuedMultiVector::impl_scalar_type*, typename Node::memory_space>;

  void fillNullspaceVector(const RCP<MultiVector>& nullspace, LocalOrdinal numPDEs, LocalOrdinal nullspaceDim, CoordsType coordsView, MeanCoordsType meanView) const;

  mutable bool calculateRotations_ = false;
};

}  // namespace MueLu

#define MUELU_NULLSPACEFACTORY_SHORT
#endif  // MUELU_NULLSPACEFACTORY_DECL_HPP