Tpetra_DirectoryImpl_decl.hpp

// @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_DirectoryImpl_decl_hpp
#define __Tpetra_DirectoryImpl_decl_hpp

#include <Tpetra_ConfigDefs.hpp>
#include "Tpetra_TieBreak.hpp"

//
// mfh 13-15 May 2013: HAVE_TPETRA_DIRECTORY_SPARSE_MAP_FIX governs
// the fix for Bug 5822.  The fix is enabled by default.  To disable
// the fix, uncomment out the three lines below that undefine
// HAVE_TPETRA_DIRECTORY_SPARSE_MAP_FIX, and comment out the three
// lines below them that define that macro.
//
// mfh 23 Mar 2014: I want Bug 5822 to stay fixed, so I am removing
// all references to HAVE_TPETRA_DIRECTORY_SPARSE_MAP_FIX.  I hope no
// downstream code is using that macro, but just in case, I will leave
// it defined.

#ifndef HAVE_TPETRA_DIRECTORY_SPARSE_MAP_FIX
#  define HAVE_TPETRA_DIRECTORY_SPARSE_MAP_FIX 1
#endif // HAVE_TPETRA_DIRECTORY_SPARSE_MAP_FIX

#include <Tpetra_Details_FixedHashTable_decl.hpp>


namespace Tpetra {
  // Forward declaration.
  template <class LocalOrdinal, class GlobalOrdinal, class Node> class Map;

  namespace Details {
    // Forward declaration.
    template <class LocalOrdinal, class GlobalOrdinal> class TieBreak;

    template<class LocalOrdinal, class GlobalOrdinal, class NodeType>
    class Directory : public Teuchos::Describable {
    public:
      typedef LocalOrdinal local_ordinal_type;
      typedef GlobalOrdinal global_ordinal_type;
      typedef NodeType node_type;
      typedef ::Tpetra::Map<LocalOrdinal, GlobalOrdinal, NodeType> map_type;

      Directory ();

      LookupStatus
      getEntries (const map_type& map,
                  const Teuchos::ArrayView<const GlobalOrdinal> &globalIDs,
                  const Teuchos::ArrayView<int> &nodeIDs,
                  const Teuchos::ArrayView<LocalOrdinal> &localIDs,
                  const bool computeLIDs) const;

      virtual bool isOneToOne (const Teuchos::Comm<int>& comm) const = 0;

    protected:
      virtual LookupStatus
      getEntriesImpl (const map_type& map,
                      const Teuchos::ArrayView<const GlobalOrdinal> &globalIDs,
                      const Teuchos::ArrayView<int> &nodeIDs,
                      const Teuchos::ArrayView<LocalOrdinal> &localIDs,
                      const bool computeLIDs) const = 0;
    };

    template<class LocalOrdinal, class GlobalOrdinal, class NodeType>
    class ReplicatedDirectory :
      public Directory<LocalOrdinal, GlobalOrdinal, NodeType> {
    public:
      typedef Directory<LocalOrdinal, GlobalOrdinal, NodeType> base_type;
      typedef typename base_type::map_type map_type;

      ReplicatedDirectory (const map_type& map);

      ReplicatedDirectory ();

      virtual bool isOneToOne (const Teuchos::Comm<int>& comm) const;

      template <class Node2>
      Directory<LocalOrdinal,GlobalOrdinal,Node2>*
      clone (const ::Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node2>& cloneMap) const
      {
        typedef ReplicatedDirectory<LocalOrdinal,GlobalOrdinal,Node2> Dir2;
        return new Dir2 (cloneMap);
      }



      std::string description () const;
    protected:
      LookupStatus
      getEntriesImpl (const map_type& map,
                      const Teuchos::ArrayView<const GlobalOrdinal> &globalIDs,
                      const Teuchos::ArrayView<int> &nodeIDs,
                      const Teuchos::ArrayView<LocalOrdinal> &localIDs,
                      const bool computeLIDs) const;

    private:
      const int numProcs_;
    };


    template<class LocalOrdinal, class GlobalOrdinal, class NodeType>
    class ContiguousUniformDirectory :
      public Directory<LocalOrdinal, GlobalOrdinal, NodeType> {
    private:
      // This friend declaration lets us implement clone().
      template <class LO, class GO, class N> friend class ContiguousUniformDirectory;

      ContiguousUniformDirectory () {}

    public:
      typedef Directory<LocalOrdinal, GlobalOrdinal, NodeType> base_type;
      typedef typename base_type::map_type map_type;

      ContiguousUniformDirectory (const map_type& map);

      virtual bool isOneToOne (const Teuchos::Comm<int>&) const {
        return true;
      }

      template <class Node2>
      Directory<LocalOrdinal,GlobalOrdinal,Node2>*
      clone (const ::Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node2>& cloneMap) const
      {
        typedef ContiguousUniformDirectory<LocalOrdinal,GlobalOrdinal,Node2> Dir2;
        return new Dir2 (cloneMap);
      }



      std::string description () const;

    protected:
      LookupStatus
      getEntriesImpl (const map_type& map,
                      const Teuchos::ArrayView<const GlobalOrdinal> &globalIDs,
                      const Teuchos::ArrayView<int> &nodeIDs,
                      const Teuchos::ArrayView<LocalOrdinal> &localIDs,
                      const bool computeLIDs) const;
    };


    template<class LocalOrdinal, class GlobalOrdinal, class NodeType>
    class DistributedContiguousDirectory :
      public Directory<LocalOrdinal, GlobalOrdinal, NodeType> {
    private:
      template <class LO, class GO, class N> friend class DistributedContiguousDirectory;

      DistributedContiguousDirectory () {}

    public:
      typedef Directory<LocalOrdinal, GlobalOrdinal, NodeType> base_type;
      typedef typename base_type::map_type map_type;

      DistributedContiguousDirectory (const map_type& map);

      virtual bool isOneToOne (const Teuchos::Comm<int>&) const {
        return true;
      }

      template <class Node2>
      Directory<LocalOrdinal,GlobalOrdinal,Node2>*
      clone (const ::Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node2>& cloneMap) const
      {
        typedef DistributedContiguousDirectory<LocalOrdinal,GlobalOrdinal,Node2> Dir2;
        Dir2* dir = new Dir2 (cloneMap);
        try {
          dir->allMinGIDs_ = allMinGIDs_;
        } catch (std::exception& e) {
          delete dir; // clean up just in case assignment throws (it shouldn't)
          throw;
        }
        return dir;
      }



      std::string description () const;

    protected:
      LookupStatus
      getEntriesImpl (const map_type& map,
                      const Teuchos::ArrayView<const GlobalOrdinal> &globalIDs,
                      const Teuchos::ArrayView<int> &nodeIDs,
                      const Teuchos::ArrayView<LocalOrdinal> &localIDs,
                      const bool computeLIDs) const;

    private:
      Teuchos::ArrayRCP<GlobalOrdinal> allMinGIDs_;
    };

    template<class LocalOrdinal, class GlobalOrdinal, class NodeType>
    class DistributedNoncontiguousDirectory :
      public Directory<LocalOrdinal, GlobalOrdinal, NodeType> {
    private:
      template <class LO, class GO, class N> friend class DistributedNoncontiguousDirectory;
      DistributedNoncontiguousDirectory () {}

    public:
      typedef Tpetra::Details::TieBreak<LocalOrdinal, GlobalOrdinal> tie_break_type;
      typedef Directory<LocalOrdinal, GlobalOrdinal, NodeType> base_type;
      typedef typename base_type::map_type map_type;

      DistributedNoncontiguousDirectory (const map_type& map);

      DistributedNoncontiguousDirectory (const map_type& map,
                                         const tie_break_type& tie_break);

      virtual bool isOneToOne (const Teuchos::Comm<int>& comm) const;

      template <class Node2>
      Directory<LocalOrdinal,GlobalOrdinal,Node2>*
      clone (const ::Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node2>& cloneMap) const
      {
        typedef DistributedNoncontiguousDirectory<LocalOrdinal,GlobalOrdinal,Node2> Dir2;
        typedef ::Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node2> output_map_type;
        Dir2* dir = new Dir2 (cloneMap);

        // This method returns a raw pointer.  Thus, take care to
        // check whether intermediate operations succeed, so that we
        // don't leak memory if they don't.
        RCP<const output_map_type> outDirMap;
        try {
          outDirMap = directoryMap_->template clone<Node2> (cloneMap.getNode ());
        }
        catch (...) {
          outDirMap = Teuchos::null; // deallocate
          throw;
        }

        dir->directoryMap_ = outDirMap;
        dir->PIDs_ = PIDs_;
        dir->LIDs_ = LIDs_;
        dir->lidToPidTable_ = lidToPidTable_;
        dir->lidToLidTable_ = lidToLidTable_;
        dir->useHashTables_ = useHashTables_;
        return dir;
      }



      std::string description () const;
    protected:
      LookupStatus
      getEntriesImpl (const map_type& map,
                      const Teuchos::ArrayView<const GlobalOrdinal> &globalIDs,
                      const Teuchos::ArrayView<int> &nodeIDs,
                      const Teuchos::ArrayView<LocalOrdinal> &localIDs,
                      const bool computeLIDs) const;
    private:
      void
      initialize (const map_type& map,
                  Teuchos::Ptr<const tie_break_type> tie_break);

      bool isLocallyOneToOne () const {
        return locallyOneToOne_;
      }

      Teuchos::RCP<const map_type> directoryMap_;



      Teuchos::ArrayRCP<int> PIDs_;

      Teuchos::ArrayRCP<LocalOrdinal> LIDs_;



      Teuchos::RCP<Details::FixedHashTable<LocalOrdinal, int,
                                           Kokkos::Device<typename NodeType::execution_space,
                                                          typename NodeType::memory_space> > > lidToPidTable_;

      Teuchos::RCP<Details::FixedHashTable<LocalOrdinal, LocalOrdinal,
                                           Kokkos::Device<typename NodeType::execution_space,
                                                          typename NodeType::memory_space> > > lidToLidTable_;

      mutable enum EOneToOneResult {
        ONE_TO_ONE_NOT_CALLED_YET,
        ONE_TO_ONE_FALSE,
        ONE_TO_ONE_TRUE
      } oneToOneResult_;

      bool locallyOneToOne_;

      bool useHashTables_;
    };
  } // namespace Details
} // namespace Tpetra

#endif // __Tpetra_DirectoryImpl_decl_hpp