MueLu_ParameterListInterpreter_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_PARAMETERLISTINTERPRETER_DECL_HPP
#define MUELU_PARAMETERLISTINTERPRETER_DECL_HPP
 
#include <Teuchos_ParameterList.hpp>
 
#include <Xpetra_Matrix_fwd.hpp>
#include <Xpetra_Operator_fwd.hpp>
 
#include "MueLu_ConfigDefs.hpp"
#include "MueLu_HierarchyManager.hpp"
 
#include "MueLu_AggregationExportFactory_fwd.hpp"
#include "MueLu_BrickAggregationFactory_fwd.hpp"
#include "MueLu_ClassicalMapFactory_fwd.hpp"
#include "MueLu_ClassicalPFactory_fwd.hpp"
#include "MueLu_CoalesceDropFactory_fwd.hpp"
#include "MueLu_CoarseMapFactory_fwd.hpp"
#include "MueLu_ConstraintFactory_fwd.hpp"
#include "MueLu_CoordinatesTransferFactory_fwd.hpp"
#include "MueLu_DirectSolver_fwd.hpp"
#include "MueLu_EminPFactory_fwd.hpp"
#include "MueLu_EdgeProlongatorPatternFactory_fwd.hpp"
#include "MueLu_FacadeClassBase.hpp"
#include "MueLu_FacadeClassFactory.hpp"
#include "MueLu_FactoryFactory_fwd.hpp"
#include "MueLu_FilteredAFactory_fwd.hpp"
#include "MueLu_GenericRFactory_fwd.hpp"
#include "MueLu_InitialBlockNumberFactory_fwd.hpp"
#include "MueLu_LineDetectionFactory_fwd.hpp"
#include "MueLu_LocalOrdinalTransferFactory_fwd.hpp"
#include "MueLu_LowPrecisionFactory_fwd.hpp"
#include "MueLu_NotayAggregationFactory_fwd.hpp"
#include "MueLu_NullspaceFactory_fwd.hpp"
#include "MueLu_PatternFactory_fwd.hpp"
#include "MueLu_PgPFactory_fwd.hpp"
#include "MueLu_RAPFactory_fwd.hpp"
#include "MueLu_RAPShiftFactory_fwd.hpp"
#include "MueLu_RebalanceAcFactory_fwd.hpp"
#include "MueLu_RebalanceTransferFactory_fwd.hpp"
#include "MueLu_RepartitionFactory_fwd.hpp"
#include "MueLu_ReitzingerPFactory_fwd.hpp"
#include "MueLu_SaPFactory_fwd.hpp"
#include "MueLu_SemiCoarsenPFactory_fwd.hpp"
#include "MueLu_SmootherFactory_fwd.hpp"
#include "MueLu_TentativePFactory_fwd.hpp"
#include "MueLu_TogglePFactory_fwd.hpp"
#include "MueLu_ToggleCoordinatesTransferFactory_fwd.hpp"
#include "MueLu_TransPFactory_fwd.hpp"
#include "MueLu_UncoupledAggregationFactory_fwd.hpp"
#include "MueLu_ZoltanInterface_fwd.hpp"
#include "MueLu_Zoltan2Interface_fwd.hpp"
#ifdef HAVE_MUELU_MATLAB
#include "MueLu_MatlabSmoother_fwd.hpp"
#include "MueLu_TwoLevelMatlabFactory_fwd.hpp"
#include "MueLu_SingleLevelMatlabFactory_fwd.hpp"
#endif
 
#ifdef HAVE_MUELU_TEKO
#include "MueLu_TekoSmoother_fwd.hpp"
#endif
 
#include "MueLu_CoalesceDropFactory_kokkos_fwd.hpp"
#include "MueLu_SemiCoarsenPFactory_kokkos_fwd.hpp"
#include "MueLu_TentativePFactory_kokkos_fwd.hpp"
 
#if defined(HAVE_MUELU_INTREPID2) && defined(HAVE_MUELU_EXPERIMENTAL)
#include "MueLu_IntrepidPCoarsenFactory_fwd.hpp"
#endif
 
namespace MueLu {
 
template <class Scalar        = DefaultScalar,
          class LocalOrdinal  = DefaultLocalOrdinal,
          class GlobalOrdinal = DefaultGlobalOrdinal,
          class Node          = DefaultNode>
class ParameterListInterpreter : public HierarchyManager<Scalar, LocalOrdinal, GlobalOrdinal, Node> {
#undef MUELU_PARAMETERLISTINTERPRETER_SHORT
#include "MueLu_UseShortNames.hpp"
  typedef std::pair<std::string, const FactoryBase*> keep_pair;
 
 public:
 
 
 protected:
  ParameterListInterpreter() {
    factFact_   = Teuchos::null;
    facadeFact_ = Teuchos::rcp(new FacadeClassFactory());
  }
 
 public:
  ParameterListInterpreter(Teuchos::ParameterList& paramList, Teuchos::RCP<const Teuchos::Comm<int> > comm = Teuchos::null, Teuchos::RCP<FactoryFactory> factFact = Teuchos::null, Teuchos::RCP<FacadeClassFactory> facadeFact = Teuchos::null);
 
  ParameterListInterpreter(const std::string& xmlFileName, const Teuchos::Comm<int>& comm, Teuchos::RCP<FactoryFactory> factFact = Teuchos::null, Teuchos::RCP<FacadeClassFactory> facadeFact = Teuchos::null);
 
  virtual ~ParameterListInterpreter();
 
 
  void SetParameterList(const Teuchos::ParameterList& paramList);
 
  void SetupHierarchy(Hierarchy& H) const;
 
 private:
  virtual void SetupOperator(Operator& A) const;
 
  int blockSize_;               
  CycleType Cycle_;             
  int WCycleStartLevel_;        
  double scalingFactor_;        
  GlobalOrdinal dofOffset_;     
  std::string hierarchyLabel_;  
 
 
  // These three variables are only needed to print out proper [default]
  bool changedPRrebalance_;
  bool changedPRViaCopyrebalance_;
  bool changedImplicitTranspose_;
 
  void SetEasyParameterList(const Teuchos::ParameterList& paramList);
  void Validate(const Teuchos::ParameterList& paramList) const;
 
  void UpdateFactoryManager(Teuchos::ParameterList& paramList, const Teuchos::ParameterList& defaultList, FactoryManager& manager,
                            int levelID, std::vector<keep_pair>& keeps) const;
 
  // "Generic components" for UpdateFactoryManager
  void UpdateFactoryManager_Smoothers(Teuchos::ParameterList& paramList, const Teuchos::ParameterList& defaultList, FactoryManager& manager,
                                      int levelID, std::vector<keep_pair>& keeps) const;
  void UpdateFactoryManager_CoarseSolvers(Teuchos::ParameterList& paramList, const Teuchos::ParameterList& defaultList, FactoryManager& manager,
                                          int levelID, std::vector<keep_pair>& keeps) const;
  void UpdateFactoryManager_Aggregation_TentativeP(Teuchos::ParameterList& paramList, const Teuchos::ParameterList& defaultList, FactoryManager& manager,
                                                   int levelID, std::vector<keep_pair>& keeps) const;
  void UpdateFactoryManager_Restriction(Teuchos::ParameterList& paramList, const Teuchos::ParameterList& defaultList, FactoryManager& manager,
                                        int levelID, std::vector<keep_pair>& keeps) const;
  void UpdateFactoryManager_RAP(Teuchos::ParameterList& paramList, const Teuchos::ParameterList& defaultList, FactoryManager& manager,
                                int levelID, std::vector<keep_pair>& keeps) const;
  void UpdateFactoryManager_Coordinates(Teuchos::ParameterList& paramList, const Teuchos::ParameterList& defaultList, FactoryManager& manager,
                                        int levelID, std::vector<keep_pair>& keeps) const;
  void UpdateFactoryManager_Material(Teuchos::ParameterList& paramList, const Teuchos::ParameterList& defaultList, FactoryManager& manager,
                                     int levelID, std::vector<keep_pair>& keeps) const;
  void UpdateFactoryManager_Repartition(Teuchos::ParameterList& paramList, const Teuchos::ParameterList& defaultList, FactoryManager& manager,
                                        int levelID, std::vector<keep_pair>& keeps, RCP<Factory>& nullSpaceFactory) const;
  void UpdateFactoryManager_LowPrecision(ParameterList& paramList, const ParameterList& defaultList, FactoryManager& manager,
                                         int levelID, std::vector<keep_pair>& keeps) const;
  void UpdateFactoryManager_Nullspace(Teuchos::ParameterList& paramList, const Teuchos::ParameterList& defaultList, FactoryManager& manager,
                                      int levelID, std::vector<keep_pair>& keeps, RCP<Factory>& nullSpaceFactory) const;
  void UpdateFactoryManager_BlockNumber(Teuchos::ParameterList& paramList, const Teuchos::ParameterList& defaultList,
                                        FactoryManager& manager, int levelID, std::vector<keep_pair>& keeps) const;
  void UpdateFactoryManager_LocalOrdinalTransfer(const std::string& VarName, const std::string& multigridAlgo, Teuchos::ParameterList& paramList, const Teuchos::ParameterList& defaultList,
                                                 FactoryManager& manager, int levelID, std::vector<keep_pair>& keeps) const;
 
  void UpdateFactoryManager_MatrixTransfer(const std::string& VarName, Teuchos::ParameterList& paramList, const Teuchos::ParameterList& defaultList,
                                           FactoryManager& manager, int levelID, std::vector<keep_pair>& keeps) const;
 
  // Algorithm-specific components for UpdateFactoryManager
  void UpdateFactoryManager_SemiCoarsen(Teuchos::ParameterList& paramList, const Teuchos::ParameterList& defaultList, FactoryManager& manager,
                                        int levelID, std::vector<keep_pair>& keeps) const;
  void UpdateFactoryManager_PCoarsen(Teuchos::ParameterList& paramList, const Teuchos::ParameterList& defaultList, FactoryManager& manager,
                                     int levelID, std::vector<keep_pair>& keeps) const;
  void UpdateFactoryManager_SA(std::string& multigridAlgo, Teuchos::ParameterList& paramList, const Teuchos::ParameterList& defaultList, FactoryManager& manager,
                               int levelID, std::vector<keep_pair>& keeps) const;
  void UpdateFactoryManager_Reitzinger(Teuchos::ParameterList& paramList, const Teuchos::ParameterList& defaultList, FactoryManager& manager,
                                       int levelID, std::vector<keep_pair>& keeps) const;
  void UpdateFactoryManager_Emin(Teuchos::ParameterList& paramList, const Teuchos::ParameterList& defaultList, FactoryManager& manager,
                                 int levelID, std::vector<keep_pair>& keeps) const;
  void UpdateFactoryManager_EminReitzinger(Teuchos::ParameterList& paramList, const Teuchos::ParameterList& defaultList, FactoryManager& manager,
                                           int levelID, std::vector<keep_pair>& keeps) const;
  void UpdateFactoryManager_PG(Teuchos::ParameterList& paramList, const Teuchos::ParameterList& defaultList, FactoryManager& manager,
                               int levelID, std::vector<keep_pair>& keeps) const;
  void UpdateFactoryManager_Replicate(Teuchos::ParameterList& paramList, const Teuchos::ParameterList& defaultList, FactoryManager& manager,
                                      int levelID, std::vector<keep_pair>& keeps) const;
  void UpdateFactoryManager_Combine(Teuchos::ParameterList& paramList, const Teuchos::ParameterList& defaultList, FactoryManager& manager,
                                    int levelID, std::vector<keep_pair>& keeps) const;
  void UpdateFactoryManager_Matlab(Teuchos::ParameterList& paramList, const Teuchos::ParameterList& defaultList, FactoryManager& manager,
                                   int levelID, std::vector<keep_pair>& keeps) const;
 
  bool useCoordinates_;
  bool useBlockNumber_;
  bool useMaterial_;
  bool useKokkos_;
 
  // TODO:
  // - parameter list validator
  // - SetParameterList
  // - Set/Get directly Level manager
  // - build per level
  // - comments/docs
  // - use FactoryManager instead of FactoryMap
  void SetFactoryParameterList(const Teuchos::ParameterList& paramList);
 
  typedef std::map<std::string, RCP<const FactoryBase> > FactoryMap;  // TODO: remove this line
  typedef std::map<std::string, RCP<FactoryManagerBase> > FactoryManagerMap;
 
  void BuildFactoryMap(const Teuchos::ParameterList& paramList, const FactoryMap& factoryMapIn, FactoryMap& factoryMapOut, FactoryManagerMap& factoryManagers) const;
 
  Teuchos::RCP<FactoryFactory> factFact_;
 
  Teuchos::RCP<MueLu::FacadeClassFactory<Scalar, LocalOrdinal, GlobalOrdinal, Node> > facadeFact_;
 
};
 
}  // namespace MueLu
 
#define MUELU_PARAMETERLISTINTERPRETER_SHORT
#endif /* MUELU_PARAMETERLISTINTERPRETER_DECL_HPP */