Tpetra_BlockMap_decl.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
//
//          Tpetra: Templated Linear Algebra Services Package
//                 Copyright (2008) 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 Michael A. Heroux (maherou@sandia.gov)
//
// ************************************************************************
// @HEADER

#ifndef TPETRA_BLOCKMAP_DECL_HPP
#define TPETRA_BLOCKMAP_DECL_HPP


#include <Tpetra_ConfigDefs.hpp>
#include <map>
#include <Tpetra_Map.hpp>

namespace Tpetra {

template <class LocalOrdinal = Details::DefaultTypes::local_ordinal_type,
          class GlobalOrdinal = Details::DefaultTypes::global_ordinal_type,
          class Node = Details::DefaultTypes::node_type>
class TPETRA_DEPRECATED BlockMap : public Teuchos::Describable {
public:
  typedef LocalOrdinal  local_ordinal_type;
  typedef GlobalOrdinal global_ordinal_type;
  typedef Node          node_type;
  typedef Map<LocalOrdinal, GlobalOrdinal, Node> point_map_type;



  BlockMap (global_size_t numGlobalBlocks,
            LocalOrdinal blockSize,
            GlobalOrdinal indexBase,
            const Teuchos::RCP<const Teuchos::Comm<int> > &comm,
            const Teuchos::RCP<Node> &node = defaultArgNode<node_type> ());

  BlockMap (global_size_t numGlobalBlocks,
            size_t numLocalBlocks,
            LocalOrdinal blockSize,
            GlobalOrdinal indexBase,
            const Teuchos::RCP<const Teuchos::Comm<int> > &comm,
            const Teuchos::RCP<Node> &node = defaultArgNode<node_type> ());

  BlockMap (const global_size_t numGlobalBlocks,
            const Teuchos::ArrayView<const GlobalOrdinal>& myGlobalBlockIDs,
            const Teuchos::ArrayView<const GlobalOrdinal>& myFirstGlobalPointInBlocks,
            const Teuchos::ArrayView<const LocalOrdinal>& myBlockSizes,
            const GlobalOrdinal indexBase,
            const Teuchos::RCP<const Teuchos::Comm<int> > &comm,
            const Teuchos::RCP<Node> &node = defaultArgNode<node_type> ());

  BlockMap (const Teuchos::RCP<const point_map_type>& pointMap,
            const Teuchos::ArrayView<const GlobalOrdinal>& myGlobalBlockIDs,
            const Teuchos::ArrayView<const LocalOrdinal>& myBlockSizes);

  TPETRA_DEPRECATED
  BlockMap (const Teuchos::RCP<const point_map_type>& pointMap,
            const Teuchos::ArrayView<const GlobalOrdinal>& myGlobalBlockIDs,
            const Teuchos::ArrayView<const LocalOrdinal>& myBlockSizes,
            const Teuchos::RCP<Node>& node);

  ~BlockMap () {}



  Teuchos::RCP<const point_map_type> getPointMap () const {
    return pointMap_;
  }

  global_size_t getGlobalNumBlocks() const;

  size_t getNodeNumBlocks() const;

  Teuchos::ArrayView<const GlobalOrdinal> getNodeBlockIDs() const;

  bool isBlockSizeConstant() const;

  Teuchos::ArrayRCP<const LocalOrdinal> getNodeFirstPointInBlocks() const;


  Teuchos::ArrayRCP<const LocalOrdinal> getNodeFirstPointInBlocks_Device() const;


  GlobalOrdinal getGlobalBlockID(LocalOrdinal localBlockID) const;


  LocalOrdinal getLocalBlockID(GlobalOrdinal globalBlockID) const;


  LocalOrdinal getLocalBlockSize(LocalOrdinal localBlockID) const;


  LocalOrdinal getFirstLocalPointInLocalBlock(LocalOrdinal localBlockID) const;


  GlobalOrdinal getFirstGlobalPointInLocalBlock(LocalOrdinal localBlockID) const;

  void
  getRemoteBlockInfo (const Teuchos::ArrayView<const GlobalOrdinal>& GBIDs,
                      const Teuchos::ArrayView<GlobalOrdinal>& firstGlobalPointInBlocks,
                      const Teuchos::ArrayView<LocalOrdinal>& blockSizes) const;

private:
  void
  initWithPointMap (const Teuchos::RCP<const point_map_type>& pointMap,
                    const Teuchos::ArrayView<const GlobalOrdinal>& myGlobalBlockIDs,
                    const Teuchos::ArrayView<const LocalOrdinal>& blockSizes,
                    const Teuchos::RCP<Node>& node);

  void setup_noncontig_mapping();

  Teuchos::RCP<const point_map_type> pointMap_;
  global_size_t globalNumBlocks_;
  Teuchos::Array<GlobalOrdinal> myGlobalBlockIDs_;
  Teuchos::ArrayRCP<LocalOrdinal> pbuf_firstPointInBlock_;
  Teuchos::ArrayRCP<const LocalOrdinal> view_firstPointInBlock_;
  bool blockIDsAreContiguous_;
  LocalOrdinal constantBlockSize_;
  std::map<GlobalOrdinal,LocalOrdinal> map_global_to_local_;
};


template<class LocalOrdinal,class GlobalOrdinal,class Node>
Teuchos::RCP<const Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> >
convertBlockMapToPointMap (const Tpetra::BlockMap<LocalOrdinal,GlobalOrdinal,Node>& blockMap)
{
  using Teuchos::RCP;
  using Teuchos::rcp;
  typedef Map<LocalOrdinal, GlobalOrdinal, Node> point_map_type;
  typedef global_size_t GST;

  const GST numGlobalElems = Teuchos::OrdinalTraits<GST>::invalid ();
  const GlobalOrdinal indexBase = blockMap.getPointMap ()->getIndexBase ();
  RCP<const Teuchos::Comm<int> > comm = blockMap.getPointMap ()->getComm ();
  RCP<Node> node = blockMap.getPointMap ()->getNode ();

  // Create a point-entry map where each point
  // corresponds to a block in the block map.
  return rcp (new point_map_type (numGlobalElems, blockMap.getNodeBlockIDs (),
                                  indexBase, comm, node));
}

} // namespace Tpetra

#endif // ! TPETRA_BLOCKMAP_DECL_HPP