Tpetra Matrix/Vector Services Version of the Day
Tpetra_Directory_decl.hpp
00001 // @HEADER
00002 // ***********************************************************************
00003 //
00004 //          Tpetra: Templated Linear Algebra Services Package
00005 //                 Copyright (2008) Sandia Corporation
00006 //
00007 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
00008 // the U.S. Government retains certain rights in this software.
00009 //
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
00038 //
00039 // ************************************************************************
00040 // @HEADER
00041 
00042 #ifndef TPETRA_DIRECTORY_DECL_HPP
00043 #define TPETRA_DIRECTORY_DECL_HPP
00044 
00045 #include <Kokkos_DefaultNode.hpp>
00046 #include <Teuchos_Describable.hpp>
00047 #include "Tpetra_ConfigDefs.hpp"
00048 #include "Tpetra_Map_decl.hpp"
00049 #include "Tpetra_DirectoryImpl_decl.hpp"
00050 #include "Tpetra_TieBreak.hpp"
00051 
00052 namespace Tpetra {
00053 
00127   template<class LocalOrdinal,
00128            class GlobalOrdinal = LocalOrdinal,
00129            class Node = KokkosClassic::DefaultNode::DefaultNodeType>
00130   class Directory : public Teuchos::Describable {
00131   public:
00133     typedef Map<LocalOrdinal, GlobalOrdinal, Node> map_type;
00134 
00136 
00137 
00144     explicit Directory (const map_type& map);
00145 
00153     explicit Directory (const map_type& map,
00154                         const Tpetra::Details::TieBreak<LocalOrdinal,GlobalOrdinal>& tie_break);
00155 
00157     ~Directory ();
00158 
00177     template <class Node2>
00178     RCP<Directory<LocalOrdinal,GlobalOrdinal,Node2> >
00179     clone (const Map<LocalOrdinal,GlobalOrdinal,Node2>& clone_map) const
00180     {
00181       typedef LocalOrdinal LO;
00182       typedef GlobalOrdinal GO;
00183 
00184       RCP<Directory<LO, GO, Node2> > dir (new Directory<LO, GO, Node2> ());
00185       if (clone_map.isDistributed ()) {
00186         if (clone_map.isUniform ()) {
00187           typedef Details::ContiguousUniformDirectory<LO, GO, Node> impl_type;
00188           const impl_type* theImpl = dynamic_cast<const impl_type*> (impl_);
00189           TEUCHOS_TEST_FOR_EXCEPTION(
00190             theImpl == NULL, std::logic_error, "Tpetra::Directory::clone: "
00191             "The input Map claims to be distributed, contiguous, and uniform, "
00192             "but its Directory's implementation type does not match that assumption.  "
00193             "Please report this bug to the Tpetra developers.");
00194           dir->impl_ = theImpl->template clone<Node2> (clone_map);
00195         }
00196         else if (clone_map.isContiguous ()) {
00197           typedef Details::DistributedContiguousDirectory<LO, GO, Node> impl_type;
00198           const impl_type* theImpl = dynamic_cast<const impl_type*> (impl_);
00199           TEUCHOS_TEST_FOR_EXCEPTION(
00200             theImpl == NULL, std::logic_error, "Tpetra::Directory::clone: "
00201             "The input Map claims to be distributed and contiguous, but its "
00202             "Directory's implementation type does not match that assumption.  "
00203             "Please report this bug to the Tpetra developers.");
00204           dir->impl_ = theImpl->template clone<Node2> (clone_map);
00205         }
00206         else { // not contiguous
00207           typedef Details::DistributedNoncontiguousDirectory<LO, GO, Node> impl_type;
00208           const impl_type* theImpl = dynamic_cast<const impl_type*> (impl_);
00209           TEUCHOS_TEST_FOR_EXCEPTION(
00210             theImpl == NULL, std::logic_error, "Tpetra::Directory::clone: "
00211             "The input Map claims to be noncontiguous, but its "
00212             "Directory's implementation type does not match that assumption.  "
00213             "Please report this bug to the Tpetra developers.");
00214           dir->impl_ = theImpl->template clone<Node2> (clone_map);
00215         }
00216       }
00217       else { // locally replicated (not distributed)
00218         typedef Details::ReplicatedDirectory<LO, GO, Node> impl_type;
00219         const impl_type* theImpl = dynamic_cast<const impl_type*> (impl_);
00220         TEUCHOS_TEST_FOR_EXCEPTION(
00221           theImpl == NULL, std::logic_error, "Tpetra::Directory::clone: "
00222           "The input Map claims to be locally replicated, but its "
00223           "Directory's implementation type does not match that assumption.  "
00224           "Please report this bug to the Tpetra developers.");
00225         dir->impl_ = theImpl->template clone<Node2> (clone_map);
00226       }
00227       return dir;
00228     }
00229 
00231 
00232 
00233 
00235     std::string description () const;
00236 
00238 
00239 
00240 
00266     LookupStatus
00267     getDirectoryEntries (const map_type& map,
00268                          const Teuchos::ArrayView<const GlobalOrdinal>& globalIDs,
00269                          const Teuchos::ArrayView<int>& nodeIDs) const;
00270 
00306     LookupStatus
00307     getDirectoryEntries (const map_type& map,
00308                          const Teuchos::ArrayView<const GlobalOrdinal>& globalIDs,
00309                          const Teuchos::ArrayView<int>& nodeIDs,
00310                          const Teuchos::ArrayView<LocalOrdinal>& localIDs) const;
00311 
00318     bool isOneToOne (const Teuchos::Comm<int>& comm) const;
00319 
00321   private:
00328     typedef Details::Directory<LocalOrdinal, GlobalOrdinal, Node> base_type;
00329 
00331     const base_type* impl_;
00332 
00334     Directory (const Directory<LocalOrdinal, GlobalOrdinal, Node>& directory);
00335 
00336     template <class LO, class GO, class N> friend class Directory;
00337 
00339     Directory ();
00340 
00342     Directory<LocalOrdinal, GlobalOrdinal, Node>&
00343     operator= (const Directory<LocalOrdinal, GlobalOrdinal, Node>& source);
00344 
00345   }; // class Directory
00346 } // namespace Tpetra
00347 
00348 #endif // TPETRA_DIRECTORY_DECL_HPP
00349 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines