Xpetra_BlockedMap_decl.hpp

Go to the documentation of this file.

// @HEADER
//
// ***********************************************************************
//
//             Xpetra: A linear algebra interface package
//                  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)
//                    Tobias Wiesner    (tawiesn@sandia.gov)
//                    Ray Tuminaro      (rstumin@sandia.gov)
//
// ***********************************************************************
//
// @HEADER
#ifndef PACKAGES_XPETRA_SUP_BLOCKEDMAP_XPETRA_BLOCKEDMAP_DECL_HPP_
#define PACKAGES_XPETRA_SUP_BLOCKEDMAP_XPETRA_BLOCKEDMAP_DECL_HPP_

#include "Xpetra_ConfigDefs.hpp"

#include "Xpetra_Import.hpp"
#include "Xpetra_Map_decl.hpp"

namespace Xpetra {

template <class LocalOrdinal,
          class GlobalOrdinal,
          class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
class BlockedMap : public Map<LocalOrdinal, GlobalOrdinal, Node> {
 public:
  typedef LocalOrdinal local_ordinal_type;
  typedef GlobalOrdinal global_ordinal_type;
  typedef Node node_type;
  typedef typename Map<LocalOrdinal, GlobalOrdinal, Node>::global_indices_array_device_type global_indices_array_device_type;

 private:
#undef XPETRA_BLOCKEDMAP_SHORT
#include "Xpetra_UseShortNamesOrdinal.hpp"

 public:



  BlockedMap();

  BlockedMap(const RCP<const Map>& fullmap, const std::vector<RCP<const Map>>& maps, bool bThyraMode = false);

  BlockedMap(const std::vector<RCP<const Map>>& maps, const std::vector<RCP<const Map>>& thyramaps);

  BlockedMap(const BlockedMap& input);

  virtual ~BlockedMap();



  virtual global_size_t getGlobalNumElements() const;

  virtual size_t getLocalNumElements() const;

  virtual GlobalOrdinal getIndexBase() const;

  virtual LocalOrdinal getMinLocalIndex() const;

  virtual LocalOrdinal getMaxLocalIndex() const;

  virtual GlobalOrdinal getMinGlobalIndex() const;

  virtual GlobalOrdinal getMaxGlobalIndex() const;

  virtual GlobalOrdinal getMinAllGlobalIndex() const;

  virtual GlobalOrdinal getMaxAllGlobalIndex() const;

  virtual LocalOrdinal getLocalElement(GlobalOrdinal globalIndex) const;

  virtual GlobalOrdinal getGlobalElement(LocalOrdinal localIndex) const;

  virtual LookupStatus getRemoteIndexList(const Teuchos::ArrayView<const GlobalOrdinal>& /* GIDList    */,
                                          const Teuchos::ArrayView<int>& /* nodeIDList */,
                                          const Teuchos::ArrayView<LocalOrdinal>& /* LIDList    */) const;

  virtual LookupStatus getRemoteIndexList(const Teuchos::ArrayView<const GlobalOrdinal>& /* GIDList    */,
                                          const Teuchos::ArrayView<int>& /* nodeIDList */) const;

  virtual Teuchos::ArrayView<const GlobalOrdinal> getLocalElementList() const;

  virtual global_indices_array_device_type getMyGlobalIndicesDevice() const;




  virtual bool isNodeLocalElement(LocalOrdinal localIndex) const;

  virtual bool isNodeGlobalElement(GlobalOrdinal globalIndex) const;

  virtual bool isContiguous() const;

  virtual bool isDistributed() const;

  virtual bool isCompatible(const Xpetra::Map<LocalOrdinal, GlobalOrdinal, Node>& map) const;

  virtual bool isSameAs(const Xpetra::Map<LocalOrdinal, GlobalOrdinal, Node>& map) const;




  virtual Teuchos::RCP<const Teuchos::Comm<int>> getComm() const;


  BlockedMap<LocalOrdinal, GlobalOrdinal, Node>& operator=(const BlockedMap& rhs);



  /*virtual size_t getLocalLength() const {
    throw Xpetra::Exceptions::RuntimeError("BlockedMap::getLocalLength: routine not implemented.");
    return 0;
  }*/

  /*virtual global_size_t getGlobalLength() const {
    throw Xpetra::Exceptions::RuntimeError("BlockedMap::getGlobalLength: routine not implemented.");
    return 0;
  }*/

  virtual bool getThyraMode() const;




  virtual RCP<const Xpetra::Map<LocalOrdinal, GlobalOrdinal, Node>> removeEmptyProcesses() const;

  virtual RCP<const Xpetra::Map<LocalOrdinal, GlobalOrdinal, Node>>
  replaceCommWithSubset(const Teuchos::RCP<const Teuchos::Comm<int>>& /* newComm */) const;




  virtual UnderlyingLib lib() const;

  // TODO: find a better solution for this hack
  // The problem is that EpetraMap, TpetraMap and StridedMap all inherit Map. To have proper toEpetra() we
  // need to understand the type of underlying matrix. But in src/Map we have no knowledge of StridedMaps, so
  // we cannot check for it by casting. This function allows us to avoid the restriction, as StridedMap redefines
  // it to return the base map.
  virtual RCP<const Xpetra::Map<LocalOrdinal, GlobalOrdinal, Node>>
  getMap() const;


  size_t getNumMaps() const;

  const RCP<const Xpetra::Map<LocalOrdinal, GlobalOrdinal, Node>>
  getMap(size_t i, bool bThyraMode = false) const;

  const RCP<Xpetra::Import<LocalOrdinal, GlobalOrdinal, Node>>
  getImporter(size_t i) const;

  const RCP<const Xpetra::Map<LocalOrdinal, GlobalOrdinal, Node>>
  getFullMap() const;

  size_t getMapIndexForGID(GlobalOrdinal gid) const;

#ifdef HAVE_XPETRA_TPETRA
  using local_map_type = typename Xpetra::Map<LocalOrdinal, GlobalOrdinal, Node>::local_map_type;

  local_map_type getLocalMap() const { return fullmap_->getLocalMap(); }

#else  // HAVE_XPETRA_TPETRA
#ifdef __GNUC__
#warning "Xpetra Kokkos interface for CrsMatrix is enabled (HAVE_XPETRA_KOKKOS_REFACTOR) but Tpetra is disabled. The Kokkos interface needs Tpetra to be enabled, too."
#endif  // __GNUC__
#endif  // #else !HAVE_XPETRA_TPETRA




  virtual std::string description() const;

  virtual void describe(Teuchos::FancyOStream& out, const Teuchos::EVerbosityLevel verbLevel = Teuchos::Describable::verbLevel_default) const;


 protected:
  virtual void assign(const BlockedMap& input);

  static Teuchos::RCP<const Xpetra::Map<LocalOrdinal, GlobalOrdinal, Node>>
  concatenateMaps(const std::vector<Teuchos::RCP<const Xpetra::Map<LocalOrdinal, GlobalOrdinal, Node>>>& subMaps);

 private:
  bool CheckConsistency() const;

 private:
  RCP<const Map> fullmap_;
  std::vector<RCP<const Map>> maps_;
  std::vector<RCP<Import>> importers_;
  bool bThyraMode_;                        //< boolean flag: use Thyra numbering for local sub-block maps. default = false (for Xpetra mode)
  std::vector<RCP<const Map>> thyraMaps_;  //< store Thyra-style numbering maps here in Thyra mode. In Xpetra mode this vector is empty.
};                                         // BlockedMap class

}  // namespace Xpetra

#define XPETRA_BLOCKEDMAP_SHORT

#endif /* PACKAGES_XPETRA_SUP_BLOCKEDMAP_XPETRA_BLOCKEDMAP_DECL_HPP_ */