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       using Teuchos::rcp_dynamic_cast;
00184 
00185       RCP<Directory<LO, GO, Node2> > dir (new Directory<LO, GO, Node2> ());
00186       if (clone_map.isDistributed ()) {
00187         if (clone_map.isUniform ()) {
00188           typedef Details::ContiguousUniformDirectory<LO, GO, Node> impl_type;
00189           dir->impl_ = rcp_dynamic_cast<const impl_type> (impl_)->template clone<Node2> (clone_map);
00190         }
00191         else if (clone_map.isContiguous ()) {
00192           typedef Details::DistributedContiguousDirectory<LO, GO, Node> impl_type;
00193           dir->impl_ = rcp_dynamic_cast<const impl_type> (impl_)->template clone<Node2> (clone_map);
00194         }
00195         else { // not contiguous
00196           typedef Details::DistributedNoncontiguousDirectory<LO, GO, Node> impl_type;
00197           dir->impl_ = rcp_dynamic_cast<const impl_type> (impl_)->template clone<Node2> (clone_map);
00198         }
00199       }
00200       else { // locally replicated (not distributed)
00201         typedef Details::ReplicatedDirectory<LO, GO, Node> impl_type;
00202         dir->impl_ = rcp_dynamic_cast<const impl_type> (impl_)->template clone<Node2> (clone_map);
00203       }
00204       return dir;
00205     }
00206 
00208 
00209 
00210 
00212     std::string description () const;
00213 
00215 
00216 
00217 
00243     LookupStatus
00244     getDirectoryEntries (const map_type& map,
00245                          const Teuchos::ArrayView<const GlobalOrdinal>& globalIDs,
00246                          const Teuchos::ArrayView<int>& nodeIDs) const;
00247 
00283     LookupStatus
00284     getDirectoryEntries (const map_type& map,
00285                          const Teuchos::ArrayView<const GlobalOrdinal>& globalIDs,
00286                          const Teuchos::ArrayView<int>& nodeIDs,
00287                          const Teuchos::ArrayView<LocalOrdinal>& localIDs) const;
00288 
00295     bool isOneToOne (const Teuchos::Comm<int>& comm) const;
00296 
00298   private:
00305     typedef Details::Directory<LocalOrdinal, GlobalOrdinal, Node> base_type;
00306 
00308     const base_type* impl_;
00309 
00311     Directory (const Directory<LocalOrdinal, GlobalOrdinal, Node>& directory);
00312 
00313     template <class LO, class GO, class N> friend class Directory;
00314 
00316     Directory ();
00317 
00319     Directory<LocalOrdinal, GlobalOrdinal, Node>&
00320     operator= (const Directory<LocalOrdinal, GlobalOrdinal, Node>& source);
00321 
00322   }; // class Directory
00323 } // namespace Tpetra
00324 
00325 #endif // TPETRA_DIRECTORY_DECL_HPP
00326 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines