Xpetra_TpetraBlockMap.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)
//                    Ray Tuminaro      (rstumin@sandia.gov)
//
// ***********************************************************************
//
// @HEADER
#ifndef XPETRA_TPETRABLOCKMAP_HPP
#define XPETRA_TPETRABLOCKMAP_HPP

#include "Xpetra_ConfigDefs.hpp"

#ifndef HAVE_XPETRA_TPETRA
#error This file should be included only if HAVE_XPETRA_TPETRA is defined.
#endif

#include "Xpetra_Map.hpp"
#include "Xpetra_BlockMap.hpp"

#include "Tpetra_BlockMap.hpp"
#include "Tpetra_Map.hpp"

#include "Xpetra_Exceptions.hpp"

namespace Xpetra {

template<class LocalOrdinal = BlockMap<>::local_ordinal_type,
         class GlobalOrdinal = typename BlockMap<LocalOrdinal>::global_ordinal_type,
         class Node = typename BlockMap<LocalOrdinal, GlobalOrdinal>::node_type>
class TpetraBlockMap
  : public BlockMap<LocalOrdinal,GlobalOrdinal,Node>
{
 public:

  // The following typedef are used by the XPETRA_DYNAMIC_CAST() macro.
  typedef TpetraMap<LocalOrdinal, GlobalOrdinal, Node> TpetraMapClass;



  TpetraBlockMap(global_size_t numGlobalBlocks,
                 LocalOrdinal blockSize,
                 GlobalOrdinal indexBase,
                 const Teuchos::RCP<const Teuchos::Comm<int> > &comm,
                 const Teuchos::RCP<Node>& node = KokkosClassic::Details::getNode<Node> ()) :
    map_ (rcp (new Tpetra::BlockMap<LocalOrdinal, GlobalOrdinal, Node> (numGlobalBlocks, blockSize,
                                                                        indexBase, comm, node)))
  {}

  TpetraBlockMap(global_size_t numGlobalBlocks,
                 size_t numLocalBlocks,
                 LocalOrdinal blockSize,
                 GlobalOrdinal indexBase,
                 const Teuchos::RCP<const Teuchos::Comm<int> > &comm,
                 const Teuchos::RCP<Node> &node = KokkosClassic::Details::getNode<Node> ())
  : map_ (rcp (new Tpetra::BlockMap<LocalOrdinal, GlobalOrdinal, Node> (numGlobalBlocks,
                                                                        numLocalBlocks,
                                                                        blockSize, indexBase,
                                                                        comm, node)))
  {}

  TpetraBlockMap(global_size_t numGlobalBlocks,
                 const Teuchos::ArrayView<const GlobalOrdinal>& myGlobalBlockIDs,
                 const Teuchos::ArrayView<const GlobalOrdinal>& myFirstGlobalPointInBlocks,
                 const Teuchos::ArrayView<const LocalOrdinal>& myBlockSizes,
                 GlobalOrdinal indexBase,
                 const Teuchos::RCP<const Teuchos::Comm<int> > &comm,
                 const Teuchos::RCP<Node> &node = KokkosClassic::Details::getNode<Node> ())
  : map_ (rcp (new Tpetra::BlockMap<LocalOrdinal, GlobalOrdinal, Node> (numGlobalBlocks,
                                                                        myGlobalBlockIDs,
                                                                        myFirstGlobalPointInBlocks,
                                                                        myBlockSizes,
                                                                        indexBase, comm, node)))
  {}

  TpetraBlockMap(const Teuchos::RCP<const Map<LocalOrdinal,GlobalOrdinal,Node> >& pointMap,
                 const Teuchos::ArrayView<const GlobalOrdinal>& myGlobalBlockIDs,
                 const Teuchos::ArrayView<const LocalOrdinal>& myBlockSizes,
                 const Teuchos::RCP<Node> &node = KokkosClassic::Details::getNode<Node> ())
  {
    XPETRA_RCP_DYNAMIC_CAST(const TpetraMapClass, pointMap, tPointMap, "Xpetra::TpetraBlockMap constructors only accept Xpetra::TpetraMap as input arguments.");
    map_ = rcp (new Tpetra::BlockMap<LocalOrdinal, GlobalOrdinal, Node> (tPointMap->getTpetra_Map (),
                                                                         myGlobalBlockIDs, myBlockSizes,
                                                                         node));
  }

  TpetraBlockMap (const Teuchos::RCP<const Tpetra::BlockMap<LocalOrdinal, GlobalOrdinal, Node> > &map) :
    map_ (map)
  {}

  virtual ~TpetraBlockMap ()
  {}




  global_size_t getGlobalNumBlocks() const {  return map_->getGlobalNumBlocks(); }

  size_t getNodeNumBlocks() const {  return map_->getNodeNumBlocks(); }

  Teuchos::ArrayView<const GlobalOrdinal> getNodeBlockIDs() const {  return map_->getNodeBlockIDs(); }

  bool isBlockSizeConstant() const {  return map_->isBlockSizeConstant(); }

  Teuchos::ArrayRCP<const LocalOrdinal> getNodeFirstPointInBlocks() const {  return map_->getNodeFirstPointInBlocks(); }


  Teuchos::ArrayRCP<const LocalOrdinal> getNodeFirstPointInBlocks_Device() const {  return map_->getNodeFirstPointInBlocks_Device(); }


  GlobalOrdinal getGlobalBlockID(LocalOrdinal localBlockID) const {  return map_->getGlobalBlockID(localBlockID); }


  LocalOrdinal getLocalBlockID(GlobalOrdinal globalBlockID) const {  return map_->getLocalBlockID(globalBlockID); }


  LocalOrdinal getLocalBlockSize(LocalOrdinal localBlockID) const {  return map_->getLocalBlockSize(localBlockID); }


  LocalOrdinal getFirstLocalPointInLocalBlock(LocalOrdinal localBlockID) const {  return map_->getFirstLocalPointInLocalBlock(localBlockID); }


  GlobalOrdinal getFirstGlobalPointInLocalBlock(LocalOrdinal localBlockID) const {  return map_->getFirstGlobalPointInLocalBlock(localBlockID); }


  RCP< const Tpetra::BlockMap<LocalOrdinal, GlobalOrdinal, Node> > getTpetra_BlockMap() const {  return map_; }

private:
  RCP< const Tpetra::BlockMap<LocalOrdinal, GlobalOrdinal, Node> > map_;


};//class TpetraBlockMap

}//namespace Xpetra

#define XPETRA_TPETRABLOCKMAP_SHORT
#endif