Xpetra_StridedMapFactory_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_STRIDEDMAPFACTORY_DECL_HPP
#define XPETRA_STRIDEDMAPFACTORY_DECL_HPP

#include <Tpetra_KokkosCompat_DefaultNode.hpp>

#include "Xpetra_ConfigDefs.hpp"

#include "Xpetra_StridedMap_decl.hpp"

namespace Xpetra {

template <class LocalOrdinal,
          class GlobalOrdinal,
          class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
class StridedMapFactory {
#undef XPETRA_STRIDEDMAPFACTORY_SHORT
#include "Xpetra_UseShortNamesOrdinal.hpp"

 private:
  StridedMapFactory() = delete;

 public:
  static RCP<Xpetra::StridedMap<LocalOrdinal, GlobalOrdinal, Node>>
  Build(UnderlyingLib lib,
        global_size_t numGlobalElements,
        GlobalOrdinal indexBase,
        std::vector<size_t>& stridingInfo,
        const Teuchos::RCP<const Teuchos::Comm<int>>& comm,
        LocalOrdinal stridedBlockId = -1,
        GlobalOrdinal offset        = 0,
        LocalGlobal lg              = Xpetra::GloballyDistributed);

  static RCP<StridedMap>
  Build(UnderlyingLib lib,
        global_size_t numGlobalElements,
        size_t numLocalElements,
        GlobalOrdinal indexBase,
        std::vector<size_t>& stridingInfo,
        const Teuchos::RCP<const Teuchos::Comm<int>>& comm,
        LocalOrdinal stridedBlockId = -1,
        GlobalOrdinal offset        = 0);

  static RCP<StridedMap>
  Build(const RCP<const Map>& map, std::vector<size_t>& stridingInfo, LocalOrdinal stridedBlockId = -1, GlobalOrdinal offset = 0);

  static RCP<StridedMap>
  Build(const RCP<const StridedMap>& map, LocalOrdinal stridedBlockId);

  static RCP<StridedMap>
  Build(const StridedMap& map);

  static RCP<StridedMap>
  Build(UnderlyingLib lib,
        global_size_t numGlobalElements,
        const Teuchos::ArrayView<const GlobalOrdinal>& elementList,
        GlobalOrdinal indexBase,
        std::vector<size_t>& stridingInfo,
        const Teuchos::RCP<const Teuchos::Comm<int>>& comm,
        LocalOrdinal stridedBlockId = -1,  // FIXME (mfh 03 Sep 2014) This breaks if LocalOrdinal is unsigned
        GlobalOrdinal /* offset */  = 0);

};  // class StridedMapFactory

}  // namespace Xpetra

#define XPETRA_STRIDEDMAPFACTORY_SHORT
#endif  // XPETRA_STRIDEDMAPFACTORY_DECL_HPP

// TODO: removed unused methods