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_DirectoryImpl_decl.hpp"

namespace Tpetra {

  template<class LocalOrdinal, 
           class GlobalOrdinal = LocalOrdinal, 
           class Node = Kokkos::DefaultNode::DefaultNodeType>
  class Directory : public Teuchos::Describable {
  public:
    typedef Map<LocalOrdinal, GlobalOrdinal, Node> map_type;



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

    ~Directory ();




    std::string description () const;




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

    LookupStatus 
    getDirectoryEntries (const Teuchos::ArrayView<const GlobalOrdinal>& globalIDs, 
       const Teuchos::ArrayView<int>& nodeIDs, 
       const Teuchos::ArrayView<LocalOrdinal>& localIDs) const;
    
  private:
    typedef Details::Directory<LocalOrdinal, GlobalOrdinal, Node> base_type;

    Teuchos::RCP<const base_type> impl_;

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

    Directory<LocalOrdinal, GlobalOrdinal, Node>& 
    operator= (const Directory<LocalOrdinal, GlobalOrdinal, Node>& source);

  }; // class Directory
} // namespace Tpetra

#endif // TPETRA_DIRECTORY_DECL_HPP