MueLu_MLParameterListInterpreter_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_MLPARAMETERLISTINTERPRETER_DECL_HPP
#define MUELU_MLPARAMETERLISTINTERPRETER_DECL_HPP

#include <Teuchos_ParameterList.hpp>

#include <Xpetra_Matrix_fwd.hpp>
#include <Xpetra_MultiVector_fwd.hpp>
#include <Xpetra_Operator_fwd.hpp>

#include "MueLu_ConfigDefs.hpp"
#include "MueLu_HierarchyManager.hpp"
#include "MueLu_MLParameterListInterpreter_fwd.hpp"

#include "MueLu_Hierarchy_fwd.hpp"
#include "MueLu_SmootherFactory_fwd.hpp"

#include "MueLu_TentativePFactory_fwd.hpp"
#include "MueLu_SaPFactory_fwd.hpp"
#include "MueLu_PgPFactory_fwd.hpp"
#include "MueLu_AmalgamationFactory_fwd.hpp"
#include "MueLu_TransPFactory_fwd.hpp"
#include "MueLu_GenericRFactory_fwd.hpp"
#include "MueLu_SmootherPrototype_fwd.hpp"
#include "MueLu_TrilinosSmoother_fwd.hpp"
#include "MueLu_IfpackSmoother_fwd.hpp"
#include "MueLu_DirectSolver_fwd.hpp"
#include "MueLu_RAPFactory_fwd.hpp"
#include "MueLu_CoalesceDropFactory_fwd.hpp"
#include "MueLu_UncoupledAggregationFactory_fwd.hpp"
#include "MueLu_NullspaceFactory_fwd.hpp"
#include "MueLu_FactoryBase_fwd.hpp"

#if defined(HAVE_MUELU_ISORROPIA) && defined(HAVE_MPI)
#include "MueLu_RepartitionHeuristicFactory_fwd.hpp"
#include "MueLu_RepartitionFactory_fwd.hpp"
#include "MueLu_RebalanceTransferFactory_fwd.hpp"
#include "MueLu_IsorropiaInterface_fwd.hpp"
#include "MueLu_RebalanceAcFactory_fwd.hpp"
#include "MueLu_RebalanceMapFactory_fwd.hpp"
#endif

#ifdef HAVE_MUELU_DEPRECATED_CODE
#ifdef MueLu_SHOW_DEPRECATED_WARNINGS
#warning "The header file MueLu_MLParameterListInterpreter.hpp is deprecated"
#endif
#else
#error "The header file MueLu_MLParameterListInterpreter.hpp is deprecated"
#endif

namespace MueLu {

/*
  Utility that from an existing Teuchos::ParameterList creates a new list, in
  which level-specific parameters are replaced with sublists.

  Currently, level-specific parameters that begin with "smoother:"
  or "aggregation:" are placed in sublists. Coarse options are also placed
  in a coarse list.

  Example:
  Input:
  smoother: type (level 0) = symmetric Gauss-Seidel
  smoother: sweeps (level 0) = 1
  Output:
  smoother: list (level 0) ->
  smoother: type = symmetric Gauss-Seidel
  smoother: sweeps = 1
*/
// This function is a copy of ML_CreateSublists to avoid dependency on ML
// Throw exception on error instead of exit()
void CreateSublists(const ParameterList& List, ParameterList& newList);

template <class Scalar        = DefaultScalar,
          class LocalOrdinal  = DefaultLocalOrdinal,
          class GlobalOrdinal = DefaultGlobalOrdinal,
          class Node          = DefaultNode>
class MLParameterListInterpreter : public HierarchyManager<Scalar, LocalOrdinal, GlobalOrdinal, Node> {
#undef MUELU_MLPARAMETERLISTINTERPRETER_SHORT
#include "MueLu_UseShortNames.hpp"

 public:


  MLParameterListInterpreter()
    : nullspace_(NULL)
    , blksize_(1) {}

  MLParameterListInterpreter(Teuchos::ParameterList& paramList, Teuchos::RCP<const Teuchos::Comm<int> > comm = Teuchos::null, std::vector<RCP<FactoryBase> > factoryList = std::vector<RCP<FactoryBase> >(0));

  MLParameterListInterpreter(const std::string& xmlFileName, std::vector<RCP<FactoryBase> > factoryList = std::vector<RCP<FactoryBase> >(0));

  virtual ~MLParameterListInterpreter() = default;



  void SetParameterList(const Teuchos::ParameterList& paramList);



  virtual void SetupHierarchy(Hierarchy& H) const;





  // @param AFact: Factory used by smoother to find 'A'
  static RCP<SmootherFactory> GetSmootherFactory(const Teuchos::ParameterList& paramList, const RCP<FactoryBase>& AFact = Teuchos::null);




  void AddTransferFactory(const RCP<FactoryBase>& factory);

  size_t NumTransferFactories() const;

 private:
  int nullspaceDim_;
  double* nullspace_;  // TODO: replace by Teuchos::ArrayRCP<>

  double* xcoord_;
  double* ycoord_;
  double* zcoord_;

  std::vector<RCP<FactoryBase> > TransferFacts_;


  virtual void SetupOperator(Operator& Op) const;

  int blksize_;


};  // class MLParameterListInterpreter

}  // namespace MueLu

#define MUELU_MLPARAMETERLISTINTERPRETER_SHORT
#endif /* MUELU_MLPARAMETERLISTINTERPRETER_DECL_HPP */