Xpetra_CrsGraphFactory.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//             Xpetra: A linear algebra interface package
//
// Copyright 2012 NTESS and the Xpetra contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER
 
#ifndef XPETRA_CRSGRAPHFACTORY_HPP
#define XPETRA_CRSGRAPHFACTORY_HPP
 
#include "Xpetra_ConfigDefs.hpp"
 
#include "Xpetra_CrsGraph.hpp"
 
#include "Xpetra_TpetraCrsGraph.hpp"
 
#include "Xpetra_Exceptions.hpp"
 
namespace Xpetra {
 
template <class LocalOrdinal,
          class GlobalOrdinal,
          class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
class CrsGraphFactory {
 private:
  CrsGraphFactory() {}
 
 public:
  static Teuchos::RCP<CrsGraph<LocalOrdinal, GlobalOrdinal, Node>>
  Build(const RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>>& rowMap) {
    if (rowMap->lib() == UseTpetra)
      return rcp(new TpetraCrsGraph<LocalOrdinal, GlobalOrdinal, Node>(rowMap, 0));
 
    XPETRA_FACTORY_END;
  }
 
  static Teuchos::RCP<CrsGraph<LocalOrdinal, GlobalOrdinal, Node>>
  Build(const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>>& map, size_t maxNumEntriesPerRow) {
    XPETRA_MONITOR("CrsGraphFactory::Build");
 
    if (map->lib() == UseTpetra)
      return rcp(new TpetraCrsGraph<LocalOrdinal, GlobalOrdinal, Node>(map, maxNumEntriesPerRow));
 
    XPETRA_FACTORY_END;
    TEUCHOS_UNREACHABLE_RETURN(null);
  }
 
  static Teuchos::RCP<CrsGraph<LocalOrdinal, GlobalOrdinal, Node>>
  Build(const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>>& rowMap,
        const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>>& colMap,
        size_t maxNumEntriesPerRow,
        const Teuchos::RCP<Teuchos::ParameterList>& plist = Teuchos::null) {
    XPETRA_MONITOR("CrsGraphFactory::Build");
 
    if (rowMap->lib() == UseTpetra)
      return rcp(new TpetraCrsGraph<LocalOrdinal, GlobalOrdinal, Node>(rowMap, colMap, maxNumEntriesPerRow, plist));
 
    XPETRA_FACTORY_END;
    TEUCHOS_UNREACHABLE_RETURN(null);
  }
 
  static Teuchos::RCP<CrsGraph<LocalOrdinal, GlobalOrdinal, Node>>
  Build(const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>>& rowMap,
        const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>>& colMap,
        const ArrayRCP<const size_t>& NumEntriesPerRowToAlloc,
        const Teuchos::RCP<Teuchos::ParameterList>& plist = Teuchos::null) {
    XPETRA_MONITOR("CrsGraphFactory::Build");
 
    if (rowMap->lib() == UseTpetra)
      return rcp(new TpetraCrsGraph<LocalOrdinal, GlobalOrdinal, Node>(rowMap, colMap, NumEntriesPerRowToAlloc, plist));
 
    XPETRA_FACTORY_END;
    TEUCHOS_UNREACHABLE_RETURN(null);
  }
 
  static Teuchos::RCP<CrsGraph<LocalOrdinal, GlobalOrdinal, Node>>
  Build(const RCP<const CrsGraph<LocalOrdinal, GlobalOrdinal, Node>>& sourceGraph,
        const Import<LocalOrdinal, GlobalOrdinal, Node>& importer,
        const RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>>& domainMap = Teuchos::null,
        const RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>>& rangeMap  = Teuchos::null,
        const RCP<Teuchos::ParameterList>& params                          = Teuchos::null) {
    if (sourceGraph->getRowMap()->lib() == UseTpetra)
      return rcp(new TpetraCrsGraph<LocalOrdinal, GlobalOrdinal, Node>(sourceGraph, importer, domainMap, rangeMap, params));
 
    XPETRA_FACTORY_END;
    TEUCHOS_UNREACHABLE_RETURN(null);
  }
 
  static Teuchos::RCP<CrsGraph<LocalOrdinal, GlobalOrdinal, Node>>
  Build(const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>>& rowMap,
        const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>>& colMap,
        const typename Xpetra::CrsGraph<LocalOrdinal, GlobalOrdinal, Node>::local_graph_type::row_map_type& rowPointers,
        const typename Xpetra::CrsGraph<LocalOrdinal, GlobalOrdinal, Node>::local_graph_type::entries_type::non_const_type& columnIndices,
        const Teuchos::RCP<Teuchos::ParameterList>& plist = Teuchos::null) {
    XPETRA_MONITOR("CrsMatrixFactory::Build");
 
    if (rowMap->lib() == UseTpetra)
      return rcp(new TpetraCrsGraph<LocalOrdinal, GlobalOrdinal, Node>(rowMap,
                                                                       colMap,
                                                                       rowPointers,
                                                                       columnIndices,
                                                                       plist));
 
    XPETRA_FACTORY_END;
  }
 
  static Teuchos::RCP<CrsGraph<LocalOrdinal, GlobalOrdinal, Node>>
  Build(const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>>& rowMap,
        const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>>& colMap,
        const typename Xpetra::CrsGraph<LocalOrdinal, GlobalOrdinal, Node>::local_graph_type& lclGraph,
        const Teuchos::RCP<Teuchos::ParameterList>& params) {
    XPETRA_MONITOR("CrsMatrixFactory::Build");
 
    if (rowMap->lib() == UseTpetra)
      return rcp(new TpetraCrsGraph<LocalOrdinal, GlobalOrdinal, Node>(rowMap,
                                                                       colMap,
                                                                       lclGraph,
                                                                       params));
 
    XPETRA_FACTORY_END;
  }
 
  static Teuchos::RCP<CrsGraph<LocalOrdinal, GlobalOrdinal, Node>>
  Build(const typename Xpetra::CrsGraph<LocalOrdinal, GlobalOrdinal, Node>::local_graph_type& lclGraph,
        const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>>& rowMap,
        const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>>& colMap,
        const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>>& domainMap = Teuchos::null,
        const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>>& rangeMap  = Teuchos::null,
        const Teuchos::RCP<Teuchos::ParameterList>& params                          = Teuchos::null) {
    XPETRA_MONITOR("CrsMatrixFactory::Build");
 
    if (rowMap->lib() == UseTpetra)
      return rcp(new TpetraCrsGraph<LocalOrdinal, GlobalOrdinal, Node>(lclGraph,
                                                                       rowMap,
                                                                       colMap,
                                                                       domainMap,
                                                                       rangeMap,
                                                                       params));
 
    XPETRA_FACTORY_END;
  }
 
  static Teuchos::RCP<CrsGraph<LocalOrdinal, GlobalOrdinal, Node>>
  Build(const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>>& rowMap,
        const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>>& colMap,
        const Teuchos::ArrayRCP<size_t>& rowPointers,
        const Teuchos::ArrayRCP<LocalOrdinal>& columnIndices,
        const Teuchos::RCP<Teuchos::ParameterList>& plist = Teuchos::null) {
    XPETRA_MONITOR("CrsMatrixFactory::Build");
 
    if (rowMap->lib() == UseTpetra)
      return rcp(new TpetraCrsGraph<LocalOrdinal, GlobalOrdinal, Node>(rowMap,
                                                                       colMap,
                                                                       rowPointers,
                                                                       columnIndices,
                                                                       plist));
 
    XPETRA_FACTORY_END;
  }
};
 
}  // namespace Xpetra
 
#define XPETRA_CRSGRAPHFACTORY_SHORT
#endif