Tpetra Matrix/Vector Services Version of the Day
Tpetra_ImportExportData_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_IMPORTEXPORTDATA_DECL_HPP
00043 #define TPETRA_IMPORTEXPORTDATA_DECL_HPP
00044 
00045 #include "Tpetra_Distributor.hpp"
00046 
00047 namespace Tpetra {
00048 
00049 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00050   // forward declaration of Import,Export, needed to prevent circular inclusions
00051   template<class LocalOrdinal, class GlobalOrdinal, class Node> class Import;
00052   template<class LocalOrdinal, class GlobalOrdinal, class Node> class Export;
00053 
00054   // Forward declaration of Map
00055   template<class LocalOrdinal, class GlobalOrdinal, class Node> class Map;
00056 #endif
00057 
00073   template<class LocalOrdinal, class GlobalOrdinal, class Node>
00074   class ImportExportData {
00075   public:
00076     typedef LocalOrdinal local_ordinal_type;
00077     typedef GlobalOrdinal global_ordinal_type;
00078     typedef Node node_type;
00079     typedef Map<LocalOrdinal,GlobalOrdinal,Node> map_type;
00080 
00085     ImportExportData (const Teuchos::RCP<const map_type>& source,
00086                       const Teuchos::RCP<const map_type>& target);
00087 
00093     ImportExportData (const Teuchos::RCP<const map_type>& source,
00094                       const Teuchos::RCP<const map_type>& target,
00095                       const Teuchos::RCP<Teuchos::FancyOStream>& out);
00096 
00102     ImportExportData (const Teuchos::RCP<const map_type>& source,
00103                       const Teuchos::RCP<const map_type>& target,
00104                       const Teuchos::RCP<Teuchos::ParameterList>& plist);
00105 
00112     ImportExportData (const Teuchos::RCP<const map_type>& source,
00113                       const Teuchos::RCP<const map_type>& target,
00114                       const Teuchos::RCP<Teuchos::FancyOStream>& out,
00115                       const Teuchos::RCP<Teuchos::ParameterList>& plist);
00117     ~ImportExportData();
00118 
00120     Teuchos::RCP<Teuchos::FancyOStream> out_;
00121 
00127     Teuchos::RCP<ImportExportData<LocalOrdinal, GlobalOrdinal, Node> > reverseClone();
00128 
00140     Teuchos::Array<LocalOrdinal> permuteToLIDs_;
00141 
00153     Teuchos::Array<LocalOrdinal> permuteFromLIDs_;
00154 
00161     Teuchos::Array<LocalOrdinal> remoteLIDs_;
00162 
00169     Teuchos::Array<LocalOrdinal> exportLIDs_;
00170 
00172     Teuchos::Array<int> exportPIDs_;
00173 
00186     size_t numSameIDs_;
00187 
00189     const Teuchos::RCP<const Map<LocalOrdinal,GlobalOrdinal,Node> > source_;
00190 
00192     const Teuchos::RCP<const Map<LocalOrdinal,GlobalOrdinal,Node> > target_;
00193 
00195     Teuchos::RCP<const Teuchos::Comm<int> > comm_;
00196 
00203     Distributor distributor_;
00204 
00205   private:
00207     ImportExportData (const ImportExportData<LocalOrdinal,GlobalOrdinal,Node> &rhs);
00209     ImportExportData<LocalOrdinal,GlobalOrdinal,Node>&
00210     operator= (const ImportExportData<LocalOrdinal,GlobalOrdinal,Node> & rhs);
00211   }; // class ImportExportData
00212 
00213 } // namespace Tpetra
00214 
00215 #endif // TPETRA_IMPORTEXPORTDATA_DECL_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines