MueLu_StructuredAggregationFactory_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_STRUCTUREDAGGREGATIONFACTORY_DECL_HPP
#define MUELU_STRUCTUREDAGGREGATIONFACTORY_DECL_HPP
 
// #include <Xpetra_Map_fwd.hpp>
// #include <Xpetra_CrsGraph_fwd.hpp>
// #include <Xpetra_CrsGraphFactory.hpp>
 
#include "MueLu_ConfigDefs.hpp"
#include "MueLu_SingleLevelFactoryBase.hpp"
#include "MueLu_StructuredAggregationFactory_fwd.hpp"
#include "MueLu_Level_fwd.hpp"
#include "MueLu_Exceptions.hpp"
#include "MueLu_AggregationStructuredAlgorithm_fwd.hpp"
 
namespace MueLu {

 
template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
class StructuredAggregationFactory : public SingleLevelFactoryBase {
#undef MUELU_STRUCTUREDAGGREGATIONFACTORY_SHORT
#include "MueLu_UseShortNames.hpp"
 
 public:


  StructuredAggregationFactory();

  virtual ~StructuredAggregationFactory() {}
 
  RCP<const ParameterList> GetValidParameterList() const;



  // set information about 1-node aggregates (map name and generating factory)
  void SetOnePtMapName(const std::string name, Teuchos::RCP<const FactoryBase> mapFact) {
    SetParameter("OnePt aggregate map name", ParameterEntry(std::string(name)));  // revalidate
    SetFactory("OnePt aggregate map factory", mapFact);
  }



 
  void DeclareInput(Level& currentLevel) const;




  void Build(Level& currentLevel) const;

 
 private:
  mutable bool bDefinitionPhase_;
 
};  // class StructuredAggregationFactory
 
}  // namespace MueLu
 
#define MUELU_STRUCTUREDAGGREGATIONFACTORY_SHORT
#endif /* MUELU_STRUCTUREDAGGREGATIONFACTORY_DECL_HPP */