MueLu_Graph_def.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_GRAPH_DEF_HPP
#define MUELU_GRAPH_DEF_HPP

#include "Xpetra_Map.hpp"
#include "Xpetra_CrsGraph.hpp"

#include "MueLu_Graph_decl.hpp"
#include "MueLu_Exceptions.hpp"

namespace MueLu {

template <class LocalOrdinal, class GlobalOrdinal, class Node>
Graph<LocalOrdinal, GlobalOrdinal, Node>::Graph(const RCP<const CrsGraph> &graph, const std::string & /* objectLabel */)
  : graph_(graph) {
  minLocalIndex_ = graph_->getDomainMap()->getMinLocalIndex();
  maxLocalIndex_ = graph_->getDomainMap()->getMaxLocalIndex();
}

#ifdef MUELU_UNUSED
template <class LocalOrdinal, class GlobalOrdinal, class Node>
size_t Graph<LocalOrdinal, GlobalOrdinal, Node>::GetNodeNumGhost() const {
  /*
    Ray's comments about nGhost:
    Graph->NGhost == graph_->RowMatrixColMap()->NumMyElements() - graph_->MatrixDomainMap()->NumMyElements()
    is basically right. But we've had some issues about how epetra handles empty columns.
    Probably worth discussing this with Jonathan and Chris to see if this is ALWAYS right.
  */
  size_t nGhost = graph_->getColMap()->getLocalNumElements() - graph_->getDomainMap()->getLocalNumElements();
  if (nGhost < 0) nGhost = 0;  // FIXME: size_t is unsigned.

  return nGhost;
}
#endif

// using MueLu::Describable::describe; // overloading, not hiding
// void describe(Teuchos::FancyOStream &out, const VerbLevel verbLevel = Default) const {
template <class LocalOrdinal, class GlobalOrdinal, class Node>
void Graph<LocalOrdinal, GlobalOrdinal, Node>::print(Teuchos::FancyOStream &out, const VerbLevel verbLevel) const {
  MUELU_DESCRIBE;

  if (verbLevel & Parameters0) {
    // out0 << "Prec. type: " << type_ << std::endl;
  }

  if (verbLevel & Parameters1) {
    // out0 << "Linear Algebra: " << toString(lib_) << std::endl;
    // out0 << "PrecType: " << type_ << std::endl;
    // out0 << "Parameter list: " << std::endl; { Teuchos::OSTab tab2(out); out << paramList_; }
    // out0 << "Overlap: " << overlap_ << std::endl;
  }

  if (verbLevel & Debug) {
    graph_->describe(out0, Teuchos::VERB_EXTREME);
  }
}

}  // namespace MueLu

#endif  // MUELU_GRAPH_DEF_HPP