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 
00050 namespace Tpetra {
00051 
00102   template<class LocalOrdinal, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
00103   class Directory : public Teuchos::Describable {
00104   public:
00106 
00107 
00114     explicit Directory(const Teuchos::RCP<const Map<LocalOrdinal,GlobalOrdinal,Node> > &map);
00115 
00117     ~Directory();
00118 
00120 
00122 
00123 
00145     LookupStatus getDirectoryEntries(const Teuchos::ArrayView<const GlobalOrdinal> &globalIDs, 
00146                                      const Teuchos::ArrayView<int> &nodeIDs) const;
00147 
00178     LookupStatus getDirectoryEntries(const Teuchos::ArrayView<const GlobalOrdinal> &globalIDs, 
00179                                      const Teuchos::ArrayView<int> &nodeIDs, 
00180                                      const Teuchos::ArrayView<LocalOrdinal> &localIDs) const;
00182     
00183   private:
00185     Teuchos::RCP<const Map<LocalOrdinal,GlobalOrdinal,Node> > map_;
00186 
00205     Teuchos::RCP<const Map<LocalOrdinal,GlobalOrdinal,Node> > directoryMap_;
00206 
00208     Teuchos::RCP<const Teuchos::Comm<int> > comm_;
00209 
00230     std::vector<GlobalOrdinal> allMinGIDs_; 
00231 
00235     std::vector<int> nodeIDs_;
00239     std::vector<LocalOrdinal> LIDs_;
00240 
00242     Directory (const Directory<LocalOrdinal,GlobalOrdinal,Node> &directory);
00243 
00245     Directory<LocalOrdinal,GlobalOrdinal,Node> & operator = (const Directory<LocalOrdinal,GlobalOrdinal,Node> &source);
00246 
00263     LookupStatus getEntries(const Teuchos::ArrayView<const GlobalOrdinal> &globalIDs, 
00264                             const Teuchos::ArrayView<int> &nodeIDs, 
00265                             const Teuchos::ArrayView<LocalOrdinal> &localIDs, 
00266                             bool computeLIDs) const;
00267 
00273     void generateDirectory();
00274 
00275   }; // class Directory
00276 
00277 } // namespace Tpetra
00278 
00279 #endif // TPETRA_DIRECTORY_DECL_HPP
00280 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines