// @HEADER
// *****************************************************************************
//        MueLu: A package for multigrid based preconditioning
//
// Copyright 2012 NTESS and the MueLu contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef MUELU_AMALGAMATIONFACTORY_DECL_HPP
#define MUELU_AMALGAMATIONFACTORY_DECL_HPP

#include <Xpetra_Matrix_fwd.hpp>
#include <Xpetra_Map_fwd.hpp>

#include "MueLu_ConfigDefs.hpp"
#include "MueLu_SingleLevelFactoryBase.hpp"
#include "MueLu_AmalgamationInfo_fwd.hpp"

#include "MueLu_Level_fwd.hpp"
#include "MueLu_Exceptions.hpp"

namespace MueLu {

/*!
  @class AmalgamationFactory
  @brief AmalgamationFactory for subblocks of strided map based amalgamation data

  Class generates unamalgamation information using matrix A with strided maps.
  It stores the output information within an AmalgamationInfo object as "UnAmalgamationInfo".
  This object contains

  \li \c nodegid2dofgids_ a map of all node ids of which the current proc has corresponding DOF gids (used by \c TentativePFactory).
  \li \c gNodeIds vector of all node ids on the current proc (may be less than nodegid2dofgids_.size()). These nodes are stored on the current proc.

*/

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

 public:
  //! @name Constructors/Destructors.
  //@{

  //! Constructor
  AmalgamationFactory();

  //! Destructor
  virtual ~AmalgamationFactory();

  RCP<const ParameterList> GetValidParameterList() const override;

  //@}

  //! Input
  //@{

  void DeclareInput(Level& currentLevel) const override;

  //@}

  void Build(Level& currentLevel) const override;

  /*! @brief Translate global (row/column) id to global amalgamation block id
   *
   * @note Assume that the node map has the same \c indexBase as the dof map
   *
   * @param gid (GlobalOrdinal): input global id (row gid or column gid)
   * @param blockSize (LocalOrdinal): block size (needed for constant block size)
   * @param offset (GlobalOrdinal): global offset for dofs (stored in strided map, default = 0)
   * @param indexBase (GlobalOrdinal): indexBase for DOF map (and node map, default = 0)
   */
  static const GlobalOrdinal DOFGid2NodeId(GlobalOrdinal gid, LocalOrdinal blockSize, const GlobalOrdinal offset /*= 0*/,
                                           const GlobalOrdinal indexBase /* = 0*/);

  /*! @brief Method to calculate the global (row) id offset from scratch.
   *
   * @param stridedMap (const StridedMap&): strided map of operator A (matrix)
   */
  static const GlobalOrdinal DOFGidOffset(RCP<const StridedMap> stridedMap);

  /*! @brief Method to create merged  map for systems of PDEs.
   *
   * @param sourceMap (const Map&): source map with dofs which shall be amalgamated to a node map
   * @param A (const Matrix&): operator A (matrix) with striding information (if available)
   * @param amalgamatedMap (const Map&): amalgamated node based map
   * @param translation (Array<LO>&): array storing local node ids given local dof ids (needed in CoalesceDropFactory)
   */
  static void AmalgamateMap(const Map& sourceMap, const Matrix& A, RCP<const Map>& amalgamatedMap, Array<LO>& translation);

  /*! @brief Method to create merged  map for systems of PDEs.
   *
   * @param sourceMap (const StridedMap): source map with dofs which shall be amalgamated to a node map
   * @param amalgamatedMap (const Map&): amalgamated node based map
   *
   */
  static void AmalgamateMap(RCP<const StridedMap> sourceMap, RCP<const Map>& amalgamatedMap);

};  // class AmalgamationFactory

}  // namespace MueLu

#define MUELU_AMALGAMATIONFACTORY_SHORT
#endif  // MUELU_AMALGAMATIONFACTORY_DECL_HPP
