Xpetra_MapFactory_decl.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_MAPFACTORY_DECL_HPP
#define XPETRA_MAPFACTORY_DECL_HPP
 
#include "Xpetra_ConfigDefs.hpp"
 
#include "Xpetra_Map_decl.hpp"
#include "Xpetra_Exceptions.hpp"
 
namespace Xpetra {
 
template <class LocalOrdinal,
          class GlobalOrdinal,
          class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
class MapFactory {
 private:
  MapFactory() {}
 
 public:
 
  static Teuchos::RCP<Map<LocalOrdinal, GlobalOrdinal, Node>>
  Build(UnderlyingLib lib,
        global_size_t numGlobalElements,
        GlobalOrdinal indexBase,
        const Teuchos::RCP<const Teuchos::Comm<int>>& comm,
        LocalGlobal lg = Xpetra::GloballyDistributed);
 
 
  static Teuchos::RCP<Map<LocalOrdinal, GlobalOrdinal, Node>>
  Build(UnderlyingLib lib,
        global_size_t numGlobalElements,
        size_t numLocalElements,
        GlobalOrdinal indexBase,
        const Teuchos::RCP<const Teuchos::Comm<int>>& comm);
 
 
  static Teuchos::RCP<Map<LocalOrdinal, GlobalOrdinal, Node>>
  Build(UnderlyingLib lib,
        global_size_t numGlobalElements,
        const Teuchos::ArrayView<const GlobalOrdinal>& elementList,
        GlobalOrdinal indexBase,
        const Teuchos::RCP<const Teuchos::Comm<int>>& comm);
 
  static Teuchos::RCP<Map<LocalOrdinal, GlobalOrdinal, Node>>
  Build(const Teuchos::RCP<const Xpetra::Map<LocalOrdinal, GlobalOrdinal, Node>>& nodeMap,
        const LocalOrdinal numDofPerNode,
        const GlobalOrdinal gidOffset = Teuchos::ScalarTraits<GlobalOrdinal>::zero());
 
  static Teuchos::RCP<Map<LocalOrdinal, GlobalOrdinal, Node>>
  Build(UnderlyingLib lib,
        global_size_t numGlobalElements,
        const Kokkos::View<const GlobalOrdinal*, typename Node::device_type>& indexList,
        GlobalOrdinal indexBase,
        const Teuchos::RCP<const Teuchos::Comm<int>>& comm);
 
  static Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>>
  createLocalMap(UnderlyingLib lib,
                 size_t numElements,
                 const Teuchos::RCP<const Teuchos::Comm<int>>& comm);
 
 
  static Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>>
  createLocalMapWithNode(UnderlyingLib lib,
                         size_t numElements,
                         const Teuchos::RCP<const Teuchos::Comm<int>>& comm);
 
 
  static Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>>
  createUniformContigMapWithNode(UnderlyingLib lib,
                                 global_size_t numElements,
                                 const Teuchos::RCP<const Teuchos::Comm<int>>& comm);
 
  static Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>>
  createUniformContigMap(UnderlyingLib lib,
                         global_size_t numElements,
                         const Teuchos::RCP<const Teuchos::Comm<int>>& comm);
 
  static Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>>
  createContigMap(UnderlyingLib lib,
                  global_size_t numElements,
                  size_t localNumElements,
                  const Teuchos::RCP<const Teuchos::Comm<int>>& comm);
 
 
  static Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>>
  createContigMapWithNode(UnderlyingLib lib,
                          global_size_t numElements,
                          size_t localNumElements,
                          const Teuchos::RCP<const Teuchos::Comm<int>>& comm);
 
  // for this map.
  static Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>>
  copyMapWithNewComm(const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>>& oldmap,
                     const Teuchos::RCP<const Teuchos::Comm<int>>& newComm);
 
};  // class MapFactory
 
 
}  // namespace Xpetra
 
#define XPETRA_MAPFACTORY_SHORT
 
#endif  // XPETRA_MAPFACTORY_DECL_HPP
 
// TODO: removed unused methods