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 
00124   template<class LocalOrdinal = int,
00125            class GlobalOrdinal = LocalOrdinal,
00126            class Node = KokkosClassic::DefaultNode::DefaultNodeType>
00127   class Directory : public Teuchos::Describable {
00128   public:
00130     typedef Map<LocalOrdinal, GlobalOrdinal, Node> map_type;
00131 
00133 
00134 
00141     explicit TEUCHOS_DEPRECATED Directory (const map_type& map);
00142 
00150     explicit TEUCHOS_DEPRECATED
00151     Directory (const map_type& map,
00152                const Tpetra::Details::TieBreak<LocalOrdinal,GlobalOrdinal>& tie_break);
00153 
00158     explicit TEUCHOS_DEPRECATED
00159     Directory (const Teuchos::RCP<const map_type>& map);
00160 
00165     Directory ();
00166 
00168     ~Directory ();
00169 
00171     void initialize (const map_type& map);
00172 
00174     void
00175     initialize (const map_type& map,
00176                 const Tpetra::Details::TieBreak<LocalOrdinal, GlobalOrdinal>& tieBreak);
00177 
00179     bool initialized () const;
00180 
00199     template <class Node2>
00200     RCP<Directory<LocalOrdinal,GlobalOrdinal,Node2> >
00201     clone (const Map<LocalOrdinal,GlobalOrdinal,Node2>& clone_map) const
00202     {
00203       typedef LocalOrdinal LO;
00204       typedef GlobalOrdinal GO;
00205 
00206       RCP<Directory<LO, GO, Node2> > dir (new Directory<LO, GO, Node2> ());
00207       if (clone_map.isDistributed ()) {
00208         if (clone_map.isUniform ()) {
00209           typedef Details::ContiguousUniformDirectory<LO, GO, Node> impl_type;
00210           const impl_type* theImpl = dynamic_cast<const impl_type*> (impl_);
00211           TEUCHOS_TEST_FOR_EXCEPTION(
00212             theImpl == NULL, std::logic_error, "Tpetra::Directory::clone: "
00213             "The input Map claims to be distributed, contiguous, and uniform, "
00214             "but its Directory's implementation type does not match that assumption.  "
00215             "Please report this bug to the Tpetra developers.");
00216           dir->impl_ = theImpl->template clone<Node2> (clone_map);
00217         }
00218         else if (clone_map.isContiguous ()) {
00219           typedef Details::DistributedContiguousDirectory<LO, GO, Node> impl_type;
00220           const impl_type* theImpl = dynamic_cast<const impl_type*> (impl_);
00221           TEUCHOS_TEST_FOR_EXCEPTION(
00222             theImpl == NULL, std::logic_error, "Tpetra::Directory::clone: "
00223             "The input Map claims to be distributed and contiguous, but its "
00224             "Directory's implementation type does not match that assumption.  "
00225             "Please report this bug to the Tpetra developers.");
00226           dir->impl_ = theImpl->template clone<Node2> (clone_map);
00227         }
00228         else { // not contiguous
00229           typedef Details::DistributedNoncontiguousDirectory<LO, GO, Node> impl_type;
00230           const impl_type* theImpl = dynamic_cast<const impl_type*> (impl_);
00231           TEUCHOS_TEST_FOR_EXCEPTION(
00232             theImpl == NULL, std::logic_error, "Tpetra::Directory::clone: "
00233             "The input Map claims to be noncontiguous, but its "
00234             "Directory's implementation type does not match that assumption.  "
00235             "Please report this bug to the Tpetra developers.");
00236           dir->impl_ = theImpl->template clone<Node2> (clone_map);
00237         }
00238       }
00239       else { // locally replicated (not distributed)
00240         typedef Details::ReplicatedDirectory<LO, GO, Node> impl_type;
00241         const impl_type* theImpl = dynamic_cast<const impl_type*> (impl_);
00242         TEUCHOS_TEST_FOR_EXCEPTION(
00243           theImpl == NULL, std::logic_error, "Tpetra::Directory::clone: "
00244           "The input Map claims to be locally replicated, but its "
00245           "Directory's implementation type does not match that assumption.  "
00246           "Please report this bug to the Tpetra developers.");
00247         dir->impl_ = theImpl->template clone<Node2> (clone_map);
00248       }
00249       return dir;
00250     }
00251 
00253 
00254 
00255 
00257     std::string description () const;
00258 
00260 
00261 
00262 
00288     LookupStatus
00289     getDirectoryEntries (const map_type& map,
00290                          const Teuchos::ArrayView<const GlobalOrdinal>& globalIDs,
00291                          const Teuchos::ArrayView<int>& nodeIDs) const;
00292 
00298     LookupStatus TEUCHOS_DEPRECATED
00299     getDirectoryEntries (const Teuchos::ArrayView<const GlobalOrdinal>& globalIDs,
00300                          const Teuchos::ArrayView<int>& nodeIDs) const;
00301 
00337     LookupStatus
00338     getDirectoryEntries (const map_type& map,
00339                          const Teuchos::ArrayView<const GlobalOrdinal>& globalIDs,
00340                          const Teuchos::ArrayView<int>& nodeIDs,
00341                          const Teuchos::ArrayView<LocalOrdinal>& localIDs) const;
00342 
00348     LookupStatus TEUCHOS_DEPRECATED
00349     getDirectoryEntries (const Teuchos::ArrayView<const GlobalOrdinal>& globalIDs,
00350                          const Teuchos::ArrayView<int>& nodeIDs,
00351                          const Teuchos::ArrayView<LocalOrdinal>& localIDs) const;
00352 
00359     bool isOneToOne (const map_type& map) const;
00360 
00362   private:
00369     typedef Details::Directory<LocalOrdinal, GlobalOrdinal, Node> base_type;
00370 
00375     const base_type* impl_;
00376 
00378     Directory (const Directory<LocalOrdinal, GlobalOrdinal, Node>& directory);
00379 
00380     template <class LO, class GO, class N> friend class Directory;
00381 
00383     Directory<LocalOrdinal, GlobalOrdinal, Node>&
00384     operator= (const Directory<LocalOrdinal, GlobalOrdinal, Node>& source);
00385   }; // class Directory
00386 } // namespace Tpetra
00387 
00388 #endif // TPETRA_DIRECTORY_DECL_HPP
00389 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines