MueLu_CoarseMapFactory_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_COARSEMAPFACTORY_DECL_HPP_
#define MUELU_COARSEMAPFACTORY_DECL_HPP_

#include "Xpetra_StridedMapFactory_fwd.hpp"

#include "MueLu_ConfigDefs.hpp"
#include "MueLu_SingleLevelFactoryBase.hpp"
#include "MueLu_CoarseMapFactory_fwd.hpp"

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

namespace MueLu {

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

 public:
  CoarseMapFactory();

  ~CoarseMapFactory();



  RCP<const ParameterList> GetValidParameterList() const override;

  void DeclareInput(Level& currentLevel) const override;




  void Build(Level& currentLevel) const override;


  virtual size_t getFixedBlockSize() const {
    // sum up size of all strided blocks (= number of dofs per node)
    size_t blkSize = 0;
    std::vector<size_t>::const_iterator it;
    for (it = stridingInfo_.begin(); it != stridingInfo_.end(); ++it) {
      blkSize += *it;
    }
    return blkSize;
  }


  virtual std::vector<size_t> getStridingData() const { return stridingInfo_; }

  virtual void setStridingData(std::vector<size_t> stridingInfo);

  virtual LocalOrdinal getStridedBlockId() const {
    const ParameterList& pL = GetParameterList();
    return pL.get<LocalOrdinal>("Strided block id");
  }

  virtual void setStridedBlockId(LocalOrdinal stridedBlockId) {
    SetParameter("Strided block id", ParameterEntry(stridedBlockId));
  }


 protected:
  virtual void BuildCoarseMap(Level& currentLevel, const GlobalOrdinal domainGIDOffset) const;

  virtual GlobalOrdinal GetDomainGIDOffset(Level& currentLevel) const;

 private:
  virtual void CheckForConsistentStridingInformation(
      LocalOrdinal stridedBlockId, const size_t nullspaceDimension) const;

  mutable std::vector<size_t> stridingInfo_;

};  // class CoarseMapFactory

}  // namespace MueLu

#define MUELU_COARSEMAPFACTORY_SHORT
#endif /* MUELU_COARSEMAPFACTORY_DECL_HPP_ */