MueLu_KokkosTuningInterface.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_KOKKOSTUNINGINTERFACE_HPP
#define MUELU_KOKKOSTUNINGINTERFACE_HPP

#include <string>
#include <vector>
#include "Teuchos_Comm.hpp"
#include "Teuchos_RCP.hpp"
#include "Teuchos_ArrayRCP.hpp"
#include "Teuchos_ParameterList.hpp"
#include "MueLu_BaseClass.hpp"

namespace MueLu {

class KokkosTuningInterface : public BaseClass {
 public:
  KokkosTuningInterface(const Teuchos::RCP<const Teuchos::Comm<int> >& comm);

  virtual ~KokkosTuningInterface() {}

  Teuchos::RCP<const Teuchos::ParameterList> GetValidParameterList() const;

  // Sets the input parameters for the KokkosTuneInterface
  // NOTE: These are *not* the parameters which KokkosTuning is going to overwrite, rather the
  // parameters to tell KokkosTuning what to do.
  void SetParameterList(Teuchos::ParameterList& inParams) {
    params_ = inParams;
    Setup();
  }

  // Calls Kokkos Tuning to set MueLu Parameters, manually specifying the Kokkos context ID
  void SetMueLuParameters(size_t kokkos_context_id, Teuchos::ParameterList& mueluParams, bool overwrite = true) const;

  // Calls Kokkos Tuning to set MueLu Parameters, using the Kokkos context ID on the list
  void SetMueLuParameters(Teuchos::ParameterList& mueluParams, bool overwrite = true) const;

 private:
  // Mapping unpacker
  void UnpackMueLuMapping();

  // String splitter
  std::vector<std::string> SplitString(const std::string& base_string, const std::string& delimiter) const;

  // Sets up Kokkos Tuning - This gets called from SetParameterList
  void Setup();

  // Cached data
  Teuchos::RCP<const Teuchos::Comm<int> > comm_;
  mutable Teuchos::ParameterList params_;  // The mutable is a hack to deal with issues in Teuchos

  // Tuning information
  mutable std::vector<Kokkos::Tools::Experimental::VariableValue> in_variables;
  mutable std::vector<Kokkos::Tools::Experimental::VariableValue> out_variables;
  std::vector<std::string> out_names;
  std::vector<std::string> out_typenames;
};

}  // namespace MueLu

#endif  // MUELU_KOKKOSTUNEINTERFACE_HPP