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 TEUCHOS_DEPRECATED Directory (const map_type& map);
00145 
00153     explicit TEUCHOS_DEPRECATED
00154     Directory (const map_type& map,
00155                const Tpetra::Details::TieBreak<LocalOrdinal,GlobalOrdinal>& tie_break);
00156 
00161     explicit TEUCHOS_DEPRECATED
00162     Directory (const Teuchos::RCP<const map_type>& map);
00163 
00168     Directory ();
00169 
00171     ~Directory ();
00172 
00174     void initialize (const map_type& map);
00175 
00177     void
00178     initialize (const map_type& map,
00179                 const Tpetra::Details::TieBreak<LocalOrdinal, GlobalOrdinal>& tieBreak);
00180 
00182     bool initialized () const;
00183 
00202     template <class Node2>
00203     RCP<Directory<LocalOrdinal,GlobalOrdinal,Node2> >
00204     clone (const Map<LocalOrdinal,GlobalOrdinal,Node2>& clone_map) const
00205     {
00206       typedef LocalOrdinal LO;
00207       typedef GlobalOrdinal GO;
00208 
00209       RCP<Directory<LO, GO, Node2> > dir (new Directory<LO, GO, Node2> ());
00210       if (clone_map.isDistributed ()) {
00211         if (clone_map.isUniform ()) {
00212           typedef Details::ContiguousUniformDirectory<LO, GO, Node> impl_type;
00213           const impl_type* theImpl = dynamic_cast<const impl_type*> (impl_);
00214           TEUCHOS_TEST_FOR_EXCEPTION(
00215             theImpl == NULL, std::logic_error, "Tpetra::Directory::clone: "
00216             "The input Map claims to be distributed, contiguous, and uniform, "
00217             "but its Directory's implementation type does not match that assumption.  "
00218             "Please report this bug to the Tpetra developers.");
00219           dir->impl_ = theImpl->template clone<Node2> (clone_map);
00220         }
00221         else if (clone_map.isContiguous ()) {
00222           typedef Details::DistributedContiguousDirectory<LO, GO, Node> impl_type;
00223           const impl_type* theImpl = dynamic_cast<const impl_type*> (impl_);
00224           TEUCHOS_TEST_FOR_EXCEPTION(
00225             theImpl == NULL, std::logic_error, "Tpetra::Directory::clone: "
00226             "The input Map claims to be distributed and contiguous, but its "
00227             "Directory's implementation type does not match that assumption.  "
00228             "Please report this bug to the Tpetra developers.");
00229           dir->impl_ = theImpl->template clone<Node2> (clone_map);
00230         }
00231         else { // not contiguous
00232           typedef Details::DistributedNoncontiguousDirectory<LO, GO, Node> impl_type;
00233           const impl_type* theImpl = dynamic_cast<const impl_type*> (impl_);
00234           TEUCHOS_TEST_FOR_EXCEPTION(
00235             theImpl == NULL, std::logic_error, "Tpetra::Directory::clone: "
00236             "The input Map claims to be noncontiguous, but its "
00237             "Directory's implementation type does not match that assumption.  "
00238             "Please report this bug to the Tpetra developers.");
00239           dir->impl_ = theImpl->template clone<Node2> (clone_map);
00240         }
00241       }
00242       else { // locally replicated (not distributed)
00243         typedef Details::ReplicatedDirectory<LO, GO, Node> impl_type;
00244         const impl_type* theImpl = dynamic_cast<const impl_type*> (impl_);
00245         TEUCHOS_TEST_FOR_EXCEPTION(
00246           theImpl == NULL, std::logic_error, "Tpetra::Directory::clone: "
00247           "The input Map claims to be locally replicated, but its "
00248           "Directory's implementation type does not match that assumption.  "
00249           "Please report this bug to the Tpetra developers.");
00250         dir->impl_ = theImpl->template clone<Node2> (clone_map);
00251       }
00252       return dir;
00253     }
00254 
00256 
00257 
00258 
00260     std::string description () const;
00261 
00263 
00264 
00265 
00291     LookupStatus
00292     getDirectoryEntries (const map_type& map,
00293                          const Teuchos::ArrayView<const GlobalOrdinal>& globalIDs,
00294                          const Teuchos::ArrayView<int>& nodeIDs) const;
00295 
00301     LookupStatus TEUCHOS_DEPRECATED
00302     getDirectoryEntries (const Teuchos::ArrayView<const GlobalOrdinal>& globalIDs,
00303                          const Teuchos::ArrayView<int>& nodeIDs) const;
00304 
00340     LookupStatus
00341     getDirectoryEntries (const map_type& map,
00342                          const Teuchos::ArrayView<const GlobalOrdinal>& globalIDs,
00343                          const Teuchos::ArrayView<int>& nodeIDs,
00344                          const Teuchos::ArrayView<LocalOrdinal>& localIDs) const;
00345 
00351     LookupStatus TEUCHOS_DEPRECATED
00352     getDirectoryEntries (const Teuchos::ArrayView<const GlobalOrdinal>& globalIDs,
00353                          const Teuchos::ArrayView<int>& nodeIDs,
00354                          const Teuchos::ArrayView<LocalOrdinal>& localIDs) const;
00355 
00362     bool isOneToOne (const map_type& map) const;
00363 
00365   private:
00372     typedef Details::Directory<LocalOrdinal, GlobalOrdinal, Node> base_type;
00373 
00378     const base_type* impl_;
00379 
00381     Directory (const Directory<LocalOrdinal, GlobalOrdinal, Node>& directory);
00382 
00383     template <class LO, class GO, class N> friend class Directory;
00384 
00386     Directory<LocalOrdinal, GlobalOrdinal, Node>&
00387     operator= (const Directory<LocalOrdinal, GlobalOrdinal, Node>& source);
00388   }; // class Directory
00389 } // namespace Tpetra
00390 
00391 #endif // TPETRA_DIRECTORY_DECL_HPP
00392 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines