MueLu_LWGraph_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_LWGRAPH_DECL_HPP
#define MUELU_LWGRAPH_DECL_HPP
 
#include <Xpetra_ConfigDefs.hpp>   // global_size_t
#include <Xpetra_CrsGraph_fwd.hpp>     // inline functions requires class declaration
#include <Xpetra_Map_fwd.hpp>
 
#include "MueLu_ConfigDefs.hpp"
 
#include "MueLu_LWGraph_fwd.hpp"
#include "MueLu_GraphBase.hpp"
#include "MueLu_Exceptions.hpp"
 
namespace MueLu {

  template<class LocalOrdinal = DefaultLocalOrdinal,
           class GlobalOrdinal = DefaultGlobalOrdinal,
           class Node = DefaultNode>
  class LWGraph : public MueLu::GraphBase<LocalOrdinal,GlobalOrdinal,Node> {
#undef MUELU_LWGRAPH_SHORT
#include "MueLu_UseShortNamesOrdinal.hpp"
 
  public:



    //
    // @param[in] rowPtrs: Array containing row offsets (CSR format)
    // @param[in] colPtrs: Array containing local column indices (CSR format)
    // @param[in] domainMap: non-overlapping (domain) map for graph. Usually provided by AmalgamationFactory stored in UnAmalgamationInfo container
    // @param[in] importMap: overlapping map for graph. Usually provided by AmalgamationFactory stored in UnAmalgamationInfo container
    // @param[in] objectLabel: label string
    LWGraph(const ArrayRCP<const LO>& rowPtrs, const ArrayRCP<const LO>& colPtrs,
            const RCP<const Map>& domainMap, const RCP<const Map>& importMap, const std::string& objectLabel = "")
            : rows_(rowPtrs), columns_(colPtrs), domainMap_(domainMap), importMap_(importMap), domainMapRef_(*domainMap), objectLabel_(objectLabel)
    {
      minLocalIndex_ = domainMapRef_.getMinLocalIndex();
      maxLocalIndex_ = domainMapRef_.getMaxLocalIndex();
 
      maxNumRowEntries_ = 0;
 
      LO nRows = as<LO>(rowPtrs.size()-1);
      for (LO i = 0; i < nRows; i++)
        maxNumRowEntries_ = std::max(maxNumRowEntries_, as<size_t>(rowPtrs[i+1] - rowPtrs[i]));
    }
 
    virtual ~LWGraph() {}
 
    size_t GetNodeNumVertices() const { return rows_.size()-1; }
    size_t GetNodeNumEdges()    const { return rows_[rows_.size()-1]; }
 
    // TODO: do we really need this function
    // It is being called from CoupledAggregation, but do we need it there?
    Xpetra::global_size_t GetGlobalNumEdges() const {
      Xpetra::global_size_t in = GetNodeNumEdges(), out;
      Teuchos::reduceAll(*domainMap_->getComm(), Teuchos::REDUCE_SUM, in, Teuchos::outArg(out));
      return out;
    }
 
    const RCP<const Teuchos::Comm<int> > GetComm()      const    { return domainMap_->getComm(); }
    const RCP<const Map>                 GetDomainMap() const    { return domainMap_; }
    const RCP<const Map>                 GetImportMap() const    { return importMap_; }
 
    void SetBoundaryNodeMap(RCP<const Map> const &/* map */)           { throw Exceptions::NotImplemented("LWGraph: Boundary node map not implemented."); }

    Teuchos::ArrayView<const LO> getNeighborVertices(LO i) const { return columns_.view(rows_[i], rows_[i+1]-rows_[i]); }

    bool isLocalNeighborVertex(LO i) const                       { return i >= minLocalIndex_ && i <= maxLocalIndex_; }

    void SetBoundaryNodeMap(const ArrayRCP<const bool>& bndry)   { dirichletBoundaries_ = bndry; }

    size_t getLocalMaxNumRowEntries () const                      { return maxNumRowEntries_; }

    const ArrayRCP<const bool> GetBoundaryNodeMap() const        { return dirichletBoundaries_; }
 

    std::string description() const                              { return "MueLu.description()"; } //FIXME use object's label

    const ArrayRCP<const LO> getRowPtrs() const {
      return rows_;
    }

    const ArrayRCP<const LO> getEntries() const {
      return columns_;
    }
    
    //using MueLu::Describable::describe; // overloading, not hiding
    //void describe(Teuchos::FancyOStream &out, const VerbLevel verbLevel = Default) const;;
    void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel = Default) const;
 
 
    RCP<CrsGraph> GetCrsGraph() const;
 
  private:

    const ArrayRCP<const LO> rows_;
    const ArrayRCP<const LO> columns_;
    const RCP<const Map> domainMap_, importMap_;
    const Map& domainMapRef_;
    const std::string objectLabel_;
    ArrayRCP<const bool> dirichletBoundaries_;
 
    // local index boundaries (cached from domain map)
    LO     minLocalIndex_, maxLocalIndex_;
    size_t maxNumRowEntries_;
  };
 
} // namespace MueLu
 
#define MUELU_LWGRAPH_SHORT
#endif // MUELU_LWGRAPH_DECL_HPP