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 <Teuchos_ArrayView.hpp>
#include <Tpetra_Map_decl.hpp>

namespace Tpetra {
  namespace Details {
    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 (const Teuchos::RCP<const map_type>& map);

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

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

      Teuchos::RCP<const map_type> getMap () const { return map_; }

    private:
      Teuchos::RCP<const map_type> map_;
    };

    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 Teuchos::RCP<const map_type>& map);



      std::string description () const;
    protected:
      LookupStatus 
      getEntriesImpl (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> {
    public:
      typedef Directory<LocalOrdinal, GlobalOrdinal, NodeType> base_type;
      typedef typename base_type::map_type map_type;

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



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

    template<class LocalOrdinal, class GlobalOrdinal, class NodeType>
    class DistributedNoncontiguousDirectory : 
      public Directory<LocalOrdinal, GlobalOrdinal, NodeType> {
    public:
      typedef Directory<LocalOrdinal, GlobalOrdinal, NodeType> base_type;
      typedef typename base_type::map_type map_type;
      
      DistributedNoncontiguousDirectory (const Teuchos::RCP<const map_type>& map);



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

      Teuchos::Array<int> nodeIDs_;

      Teuchos::Array<LocalOrdinal> LIDs_;
    };
  } // namespace Details
} // namespace Tpetra

#endif // __Tpetra_DirectoryImpl_decl_hpp