MueLu_ML2MueLuParameterTranslator.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_ML2MUELUPARAMETERTRANSLATOR_HPP
#define MUELU_ML2MUELUPARAMETERTRANSLATOR_HPP

#include <functional>
#include <vector>
#include <cctype>

#include <Teuchos_ParameterList.hpp>
#include <Teuchos_XMLParameterListCoreHelpers.hpp>
#include <Teuchos_RCP.hpp>

#include <MueLu_Exceptions.hpp>
#include <MueLu_MasterList.hpp>
#include <MueLu_ParameterListUtils.hpp>

namespace MueLu {

class ML2MueLuParameterTranslator {
 public:


  ML2MueLuParameterTranslator() {}

  virtual ~ML2MueLuParameterTranslator() {}




  static std::string translate(Teuchos::ParameterList& paramList, const std::string& defaultVals = "") {
    return SetParameterList(paramList, defaultVals);
  }

  static std::string translate(const std::string& xmlFileName, const std::string& defaultVals = "") {
    Teuchos::RCP<Teuchos::ParameterList> paramList = Teuchos::getParametersFromXmlFile(xmlFileName);
    return SetParameterList(*paramList, defaultVals);
  }


  static int SetDefaults(std::string ProblemType, Teuchos::ParameterList& List,
                         int* options = 0, double* params = 0, const bool OverWrite = true);

  static int SetDefaultsDD(Teuchos::ParameterList& List,
                           Teuchos::RCP<std::vector<int> >& options,
                           Teuchos::RCP<std::vector<double> >& params,
                           bool Overwrite = true);

  static int SetDefaultsDD_LU(Teuchos::ParameterList& List,
                              Teuchos::RCP<std::vector<int> >& options,
                              Teuchos::RCP<std::vector<double> >& params,
                              bool Overwrite = true);

  static int SetDefaultsDD_3Levels(Teuchos::ParameterList& List,
                                   Teuchos::RCP<std::vector<int> >& options,
                                   Teuchos::RCP<std::vector<double> >& params,
                                   bool Overwrite = true);

  static int SetDefaultsDD_3Levels_LU(Teuchos::ParameterList& List,
                                      Teuchos::RCP<std::vector<int> >& options,
                                      Teuchos::RCP<std::vector<double> >& params,
                                      bool Overwrite = true);

  static int SetDefaultsMaxwell(Teuchos::ParameterList& List,
                                Teuchos::RCP<std::vector<int> >& options,
                                Teuchos::RCP<std::vector<double> >& params,
                                bool Overwrite = true);

  static int SetDefaultsSA(Teuchos::ParameterList& List,
                           Teuchos::RCP<std::vector<int> >& options,
                           Teuchos::RCP<std::vector<double> >& params,
                           bool Overwrite = true);

  static int SetDefaultsNSSA(Teuchos::ParameterList& List,
                             Teuchos::RCP<std::vector<int> >& options,
                             Teuchos::RCP<std::vector<double> >& params,
                             bool Overwrite = true);

  static int SetDefaultsClassicalAMG(Teuchos::ParameterList& List,
                                     Teuchos::RCP<std::vector<int> >& options,
                                     Teuchos::RCP<std::vector<double> >& params,
                                     bool Overwrite = true);

  static int SetDefaultsRefMaxwell(Teuchos::ParameterList& inList, bool OverWrite = true);

 private:


  static std::string SetParameterList(const Teuchos::ParameterList& paramList_in, const std::string& defaultVals);

  static std::string GetSmootherFactory(const Teuchos::ParameterList& paramList, Teuchos::ParameterList& adaptingParamList, const std::string& pname, const std::string& value);


  //
  // helper routines
  //

  // trim from start
  static inline std::string& ltrim(std::string& s) {
    s.erase(s.begin(), std::find_if(s.begin(), s.end(), [](int c) { return !std::isspace(c); }));
    return s;
  }

  // trim from end
  static inline std::string& rtrim(std::string& s) {
    s.erase(std::find_if(s.rbegin(), s.rend(), [](int c) { return !std::isspace(c); }).base(), s.end());
    return s;
  }

  // trim from both ends
  static inline std::string& trim(std::string& s) {
    return ltrim(rtrim(s));
  }


  // std::string xmlString_;   ///! string containing MueLu XML parameters corresponding to ML parameters

};  // class MLParameterListInterpreter

}  // end namespace MueLu

#endif /* MUELU_ML2MUELUPARAMETERTRANSLATOR_HPP  */