MueLu_Aggregates_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_AGGREGATES_DECL_HPP
#define MUELU_AGGREGATES_DECL_HPP
 
#include "MueLu_ConfigDefs.hpp"
 
#include <Kokkos_StaticCrsGraph.hpp>
#include <Tpetra_KokkosCompat_ClassicNodeAPI_Wrapper.hpp>
 
#include "MueLu_Aggregates_fwd.hpp"
 
#include <Xpetra_Map_fwd.hpp>
#include <Xpetra_Vector_fwd.hpp>
#include <Xpetra_VectorFactory_fwd.hpp>
#include <Xpetra_MultiVector_fwd.hpp>
 
#include "MueLu_BaseClass.hpp"
 
#include "MueLu_LWGraph_kokkos.hpp"
#include "MueLu_Graph.hpp"
#include "MueLu_GraphBase.hpp"
#include "MueLu_IndexManager.hpp"
#include "MueLu_IndexManager_kokkos.hpp"
 
#define MUELU_UNAGGREGATED  -1   /* indicates that a node is unassigned to  */
                                 /* any aggregate.                          */
 
#define MUELU_UNASSIGNED    -1   /* indicates a vertex is not yet claimed   */
                                 /* by a processor during aggregation.      */
                                 /* Note, it is possible at                 */
                                 /* this stage that some processors may have*/
                                 /* claimed their copy of a vertex for one  */
                                 /* of their aggregates.  However, some     */
                                 /* arbitration still needs to occur.       */
                                 /* The corresponding procWinner[]'s remain */
                                 /* as MUELU_UNASSIGNED until               */
                                 /* ArbitrateAndCommunicate() is            */
                                 /* invoked to arbitrate.                   */
 
/*****************************************************************************
 
****************************************************************************/
 
namespace MueLu {

  template <class LocalOrdinal, class GlobalOrdinal, class Node>
  class Aggregates;
 
  template <class LocalOrdinal, class GlobalOrdinal, class DeviceType>
  class Aggregates<LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode<DeviceType> > : public BaseClass {
  public:
    using local_ordinal_type  = LocalOrdinal;
    using global_ordinal_type = GlobalOrdinal;
    using execution_space     = typename DeviceType::execution_space;
    using node_type           = Tpetra::KokkosCompat::KokkosDeviceWrapperNode<DeviceType>;
    using device_type         = DeviceType;
    using range_type          = Kokkos::RangePolicy<local_ordinal_type, execution_space>;
    using LO_view             = Kokkos::View<local_ordinal_type*, device_type>;
 
    using aggregates_sizes_type = Kokkos::View<LocalOrdinal*, device_type>;
 
  private:
    // For compatibility
    typedef node_type                                           Node;
#undef MUELU_AGGREGATES_SHORT
#include "MueLu_UseShortNamesOrdinal.hpp"
 
  public:
 
    // Defining types that require the short names included above
    using local_graph_type = typename LWGraph_kokkos::local_graph_type;
    using colors_view_type = Kokkos::View<typename local_graph_type::entries_type::data_type,
                                          typename local_graph_type::device_type::memory_space>;

    Aggregates(const GraphBase & graph);

    Aggregates(LWGraph_kokkos graph);

    Aggregates(const RCP<const Map>& map);

    virtual ~Aggregates() { }



    RCP<IndexManager_kokkos>& GetIndexManagerKokkos() { return geoDataKokkos_; }

    void SetIndexManagerKokkos(RCP<IndexManager_kokkos> & geoDataKokkos) { geoDataKokkos_ = geoDataKokkos; }

    RCP<IndexManager>& GetIndexManager() { return geoData_; }

    void SetIndexManager(RCP<IndexManager> & geoData) { geoData_ = geoData; }

    colors_view_type& GetGraphColors() { return graphColors_; }

    void SetGraphColors(colors_view_type graphColors) { graphColors_ = graphColors; }

    LO GetGraphNumColors() { return graphNumColors_; }

    void SetGraphNumColors(const LO graphNumColors) { graphNumColors_ = graphNumColors; }


    void SetNumAggregates(LO nAggregates) { numAggregates_ = nAggregates; }

    void SetNumGlobalAggregates(GO nGlobalAggregates) { numGlobalAggregates_ = nGlobalAggregates; }

    KOKKOS_INLINE_FUNCTION LO GetNumAggregates() const {
      return numAggregates_;
    }

    KOKKOS_INLINE_FUNCTION void AggregatesCrossProcessors(const bool& flag) {
      aggregatesIncludeGhosts_ = flag;
    }

    KOKKOS_INLINE_FUNCTION bool AggregatesCrossProcessors() const {
      return aggregatesIncludeGhosts_;
    }

    RCP<LOMultiVector>& GetVertex2AggIdNonConst()     { return vertex2AggId_;       }

    RCP<LOVector>& GetProcWinnerNonConst()       { return procWinner_;         }
    const RCP<LOMultiVector>& GetVertex2AggId() const { return vertex2AggId_;       }

    const RCP<LOVector>& GetProcWinner() const   { return procWinner_;         }

    inline bool IsRoot(LO i) const                      { return isRoot_[i];          }

    inline void SetIsRoot(LO i, bool value = true)      { isRoot_[i] = value;         }
 
    const RCP<const Map> GetMap() const; 

    typename aggregates_sizes_type::const_type ComputeAggregateSizes(bool forceRecompute = false) const;

    Teuchos::ArrayRCP<LocalOrdinal> ComputeAggregateSizesArrayRCP(bool forceRecompute = false) const;
 
    local_graph_type GetGraph() const;

    void ComputeNodesInAggregate(LO_view & aggPtr, LO_view & aggNodes, LO_view & unaggregated) const;

    //  If # of global aggregates is unknown, this method does coummunication and internally record the value
    GO GetNumGlobalAggregatesComputeIfNeeded();



    std::string description() const;

    //using MueLu::Describable::describe; // overloading, not hiding
    void print(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel = verbLevel_default) const;
 
  private:
    LO   numAggregates_;              
    GO   numGlobalAggregates_;        

    RCP<LOMultiVector> vertex2AggId_;

    RCP<LOVector> procWinner_;

    RCP<IndexManager_kokkos> geoDataKokkos_;

    RCP<IndexManager> geoData_;

    colors_view_type graphColors_;

    LO graphNumColors_;

    Teuchos::ArrayRCP<bool> isRoot_;

    bool aggregatesIncludeGhosts_;

    mutable
    aggregates_sizes_type aggregateSizes_;

    mutable
    typename aggregates_sizes_type::HostMirror aggregateSizesHost_;

    mutable
    local_graph_type graph_;
  };
 
} //namespace MueLu
 
#define MUELU_AGGREGATES_SHORT
#endif // MUELU_AGGREGATES_DECL_HPP