Tpetra_Directory_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_DIRECTORY_DECL_HPP
#define TPETRA_DIRECTORY_DECL_HPP

#include <Kokkos_DefaultNode.hpp>
#include <Teuchos_Describable.hpp>
#include "Tpetra_ConfigDefs.hpp"
#include "Tpetra_Map_decl.hpp"
#include "Tpetra_DirectoryImpl_decl.hpp"
#include "Tpetra_TieBreak.hpp"

namespace Tpetra {

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



    explicit TEUCHOS_DEPRECATED Directory (const map_type& map);

    explicit TEUCHOS_DEPRECATED
    Directory (const map_type& map,
               const Tpetra::Details::TieBreak<LocalOrdinal,GlobalOrdinal>& tie_break);

    explicit TEUCHOS_DEPRECATED
    Directory (const Teuchos::RCP<const map_type>& map);

    Directory ();

    ~Directory ();

    void initialize (const map_type& map);

    void
    initialize (const map_type& map,
                const Tpetra::Details::TieBreak<LocalOrdinal, GlobalOrdinal>& tieBreak);

    bool initialized () const;

    template <class Node2>
    RCP<Directory<LocalOrdinal,GlobalOrdinal,Node2> >
    clone (const Map<LocalOrdinal,GlobalOrdinal,Node2>& clone_map) const
    {
      typedef LocalOrdinal LO;
      typedef GlobalOrdinal GO;

      RCP<Directory<LO, GO, Node2> > dir (new Directory<LO, GO, Node2> ());
      if (clone_map.isDistributed ()) {
        if (clone_map.isUniform ()) {
          typedef Details::ContiguousUniformDirectory<LO, GO, Node> impl_type;
          const impl_type* theImpl = dynamic_cast<const impl_type*> (impl_);
          TEUCHOS_TEST_FOR_EXCEPTION(
            theImpl == NULL, std::logic_error, "Tpetra::Directory::clone: "
            "The input Map claims to be distributed, contiguous, and uniform, "
            "but its Directory's implementation type does not match that assumption.  "
            "Please report this bug to the Tpetra developers.");
          dir->impl_ = theImpl->template clone<Node2> (clone_map);
        }
        else if (clone_map.isContiguous ()) {
          typedef Details::DistributedContiguousDirectory<LO, GO, Node> impl_type;
          const impl_type* theImpl = dynamic_cast<const impl_type*> (impl_);
          TEUCHOS_TEST_FOR_EXCEPTION(
            theImpl == NULL, std::logic_error, "Tpetra::Directory::clone: "
            "The input Map claims to be distributed and contiguous, but its "
            "Directory's implementation type does not match that assumption.  "
            "Please report this bug to the Tpetra developers.");
          dir->impl_ = theImpl->template clone<Node2> (clone_map);
        }
        else { // not contiguous
          typedef Details::DistributedNoncontiguousDirectory<LO, GO, Node> impl_type;
          const impl_type* theImpl = dynamic_cast<const impl_type*> (impl_);
          TEUCHOS_TEST_FOR_EXCEPTION(
            theImpl == NULL, std::logic_error, "Tpetra::Directory::clone: "
            "The input Map claims to be noncontiguous, but its "
            "Directory's implementation type does not match that assumption.  "
            "Please report this bug to the Tpetra developers.");
          dir->impl_ = theImpl->template clone<Node2> (clone_map);
        }
      }
      else { // locally replicated (not distributed)
        typedef Details::ReplicatedDirectory<LO, GO, Node> impl_type;
        const impl_type* theImpl = dynamic_cast<const impl_type*> (impl_);
        TEUCHOS_TEST_FOR_EXCEPTION(
          theImpl == NULL, std::logic_error, "Tpetra::Directory::clone: "
          "The input Map claims to be locally replicated, but its "
          "Directory's implementation type does not match that assumption.  "
          "Please report this bug to the Tpetra developers.");
        dir->impl_ = theImpl->template clone<Node2> (clone_map);
      }
      return dir;
    }




    std::string description () const;




    LookupStatus
    getDirectoryEntries (const map_type& map,
                         const Teuchos::ArrayView<const GlobalOrdinal>& globalIDs,
                         const Teuchos::ArrayView<int>& nodeIDs) const;

    LookupStatus TEUCHOS_DEPRECATED
    getDirectoryEntries (const Teuchos::ArrayView<const GlobalOrdinal>& globalIDs,
                         const Teuchos::ArrayView<int>& nodeIDs) const;

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

    LookupStatus TEUCHOS_DEPRECATED
    getDirectoryEntries (const Teuchos::ArrayView<const GlobalOrdinal>& globalIDs,
                         const Teuchos::ArrayView<int>& nodeIDs,
                         const Teuchos::ArrayView<LocalOrdinal>& localIDs) const;

    bool isOneToOne (const map_type& map) const;

  private:
    typedef Details::Directory<LocalOrdinal, GlobalOrdinal, Node> base_type;

    const base_type* impl_;

    Directory (const Directory<LocalOrdinal, GlobalOrdinal, Node>& directory);

    template <class LO, class GO, class N> friend class Directory;

    Directory<LocalOrdinal, GlobalOrdinal, Node>&
    operator= (const Directory<LocalOrdinal, GlobalOrdinal, Node>& source);
  }; // class Directory
} // namespace Tpetra

#endif // TPETRA_DIRECTORY_DECL_HPP