MueLu_UncoupledAggregationFactory_kokkos_decl.hpp

Go to the documentation of this file.

// @HEADER
//
// ***********************************************************************
//
//        MueLu: A package for multigrid based preconditioning
//                  Copyright 2012 Sandia Corporation
//
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact
//                    Jonathan Hu       (jhu@sandia.gov)
//                    Andrey Prokopenko (aprokop@sandia.gov)
//                    Ray Tuminaro      (rstumin@sandia.gov)
//
// ***********************************************************************
//
// @HEADER
#ifndef MUELU_UNCOUPLEDAGGREGATIONFACTORY_KOKKOS_DECL_HPP
#define MUELU_UNCOUPLEDAGGREGATIONFACTORY_KOKKOS_DECL_HPP

#include "MueLu_ConfigDefs.hpp"

#include <KokkosCompat_ClassicNodeAPI_Wrapper.hpp>

#include <Xpetra_Map_fwd.hpp>
#include <Xpetra_Vector_fwd.hpp>
#include <Xpetra_VectorFactory_fwd.hpp>

#include "MueLu_UncoupledAggregationFactory_kokkos_fwd.hpp"

#include "MueLu_Aggregates_kokkos_fwd.hpp"
#include "MueLu_AggregationAlgorithmBase_kokkos.hpp"
#include "MueLu_AggregationPhase1Algorithm_kokkos_fwd.hpp"
#include "MueLu_AggregationPhase2aAlgorithm_kokkos_fwd.hpp"
#include "MueLu_AggregationPhase2bAlgorithm_kokkos_fwd.hpp"
#include "MueLu_AggregationPhase3Algorithm_kokkos_fwd.hpp"
#include "MueLu_AmalgamationInfo_fwd.hpp"
#include "MueLu_Exceptions.hpp"
#include "MueLu_IsolatedNodeAggregationAlgorithm_kokkos_fwd.hpp"
#include "MueLu_Level_fwd.hpp"
#include "MueLu_LWGraph_kokkos.hpp"
#include "MueLu_OnePtAggregationAlgorithm_kokkos_fwd.hpp"
#include "MueLu_PreserveDirichletAggregationAlgorithm_kokkos_fwd.hpp"
#include "MueLu_SingleLevelFactoryBase.hpp"

namespace MueLu {

  template<class LocalOrdinal = DefaultLocalOrdinal,
           class GlobalOrdinal = DefaultGlobalOrdinal,
           class Node = DefaultNode>
  class UncoupledAggregationFactory_kokkos : public SingleLevelFactoryBase {
#undef MUELU_UNCOUPLEDAGGREGATIONFACTORY_KOKKOS_SHORT
#include "MueLu_UseShortNamesOrdinal.hpp"

  public:


    UncoupledAggregationFactory_kokkos();

    virtual ~UncoupledAggregationFactory_kokkos() { }

    RCP<const ParameterList> GetValidParameterList() const;




    // Options shared by all aggregation algorithms

    // deprecated
    void SetOrdering(const std::string& ordering) {
      SetParameter("aggregation: ordering", ParameterEntry(ordering));
    }
    // deprecated
    void SetMaxNeighAlreadySelected(int maxNeighAlreadySelected) {
      SetParameter("aggregation: max selected neighbors", ParameterEntry(Teuchos::as<LocalOrdinal>(maxNeighAlreadySelected))); // revalidate
    }
    // deprecated
    void SetMinNodesPerAggregate(int minNodesPerAggregate) {
      SetParameter("aggregation: min agg size", ParameterEntry(Teuchos::as<LocalOrdinal>(minNodesPerAggregate))); // revalidate
    }
    // 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);
    }

    // deprecated
    const std::string& GetOrdering() const {
      const ParameterList& pL = GetParameterList();
      return pL.get<std::string>("aggregation: ordering");
    }
    // deprecated
    int GetMaxNeighAlreadySelected() const {
      const ParameterList& pL = GetParameterList();
      return Teuchos::as<int>(pL.get<LocalOrdinal>("aggregation: max selected neighbors"));
    }
    // deprecated
    int GetMinNodesPerAggregate() const {
      const ParameterList& pL = GetParameterList();
      return Teuchos::as<int>(pL.get<LocalOrdinal>("aggregation: min agg size"));
    }




    void DeclareInput(Level &currentLevel) const;




    void Build(Level &currentLevel) const;




    //void Append(const RCP<MueLu::AggregationAlgorithmBase<LocalOrdinal, GlobalOrdinal, Node> > & alg);

    //void ClearAggregationAlgorithms() { algos_.clear(); }

  private:

    // will be filled in Build routine
    mutable std::vector<RCP<MueLu::AggregationAlgorithmBase_kokkos<LocalOrdinal, GlobalOrdinal, Node> > > algos_;

    mutable bool bDefinitionPhase_;

  }; // class UncoupledAggregationFactory_kokkos

}

#define MUELU_UNCOUPLEDAGGREGATIONFACTORY_KOKKOS_SHORT
#endif // MUELU_UNCOUPLEDAGGREGATIONFACTORY_KOKKOS_DECL_HPP