Xpetra_EpetraExport.cpp
Go to the documentation of this file.
1 // @HEADER
2 //
3 // ***********************************************************************
4 //
5 // Xpetra: A linear algebra interface package
6 // Copyright 2012 Sandia Corporation
7 //
8 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
9 // the U.S. Government retains certain rights in this software.
10 //
11 // Redistribution and use in source and binary forms, with or without
12 // modification, are permitted provided that the following conditions are
13 // met:
14 //
15 // 1. Redistributions of source code must retain the above copyright
16 // notice, this list of conditions and the following disclaimer.
17 //
18 // 2. Redistributions in binary form must reproduce the above copyright
19 // notice, this list of conditions and the following disclaimer in the
20 // documentation and/or other materials provided with the distribution.
21 //
22 // 3. Neither the name of the Corporation nor the names of the
23 // contributors may be used to endorse or promote products derived from
24 // this software without specific prior written permission.
25 //
26 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 //
38 // Questions? Contact
39 // Jonathan Hu (jhu@sandia.gov)
40 // Andrey Prokopenko (aprokop@sandia.gov)
41 // Ray Tuminaro (rstumin@sandia.gov)
42 //
43 // ***********************************************************************
44 //
45 // @HEADER
46 #include "Xpetra_EpetraExport.hpp"
47 #include "Xpetra_Exceptions.hpp"
48 
49 namespace Xpetra {
50 
51  template<class GlobalOrdinal, class Node>
53  if (exp != NULL) {
54  RCP<const Epetra_Export> eexp = rcp(new Epetra_Export(*exp)); //NOTE: non consitent: return pointer, take ref
56  }
57 
58  return Teuchos::null;
59  }
60 
61 #if 0
62  template<class EpetraGlobalOrdinal, class Node>
64  : export_(rcp(new Epetra_Export(toEpetra<EpetraGlobalOrdinal,Node>(source), toEpetra<EpetraGlobalOrdinal,Node>(target)))) { } // Warning: Epetra(Target, Source) vs. Tpetra(Source, Target)
65 #endif
66 #if 0
67  //
68  template<class EpetraGlobalOrdinal, class Node>
69  ArrayView< const int > EpetraExportT<EpetraGlobalOrdinal, Node>::getExportPIDs() const { XPETRA_MONITOR("EpetraExportT::getExportImageIDs"); return ArrayView<const int> (export_->ExportPIDs(),export_->NumExportIDs()); }
70 #endif
71 #if 0
72  template<class EpetraGlobalOrdinal, class Node>
74  XPETRA_MONITOR("EpetraExportT::getPermuteFromLIDs");
75  TEUCHOS_TEST_FOR_EXCEPTION(1, Xpetra::Exceptions::NotImplemented, "TODO EpetraExportT<EpetraGlobalOrdinal>::getExportImageIDs not implemented"); }
76 #endif
77 #if 0
78  template<class EpetraGlobalOrdinal, class Node>
80  XPETRA_MONITOR("EpetraExportT::getPermuteToLIDs");
81  TEUCHOS_TEST_FOR_EXCEPTION(1, Xpetra::Exceptions::NotImplemented, "TODO EpetraExportT<EpetraGlobalOrdinal>::getPermuteToLIDs not implemented"); }
82 #endif
83 #if 0
84  template<class EpetraGlobalOrdinal, class Node>
86  XPETRA_MONITOR("EpetraExportT::getNumRemoteIDs");
87  TEUCHOS_TEST_FOR_EXCEPTION(1, Xpetra::Exceptions::NotImplemented, "TODO EpetraExportT<EpetraGlobalOrdinal>::getNumRemoteIDs not implemented"); }
88 #endif
89 #if 0
90  template<class EpetraGlobalOrdinal, class Node>
92  XPETRA_MONITOR("EpetraExportT::getRemoteLIDs");
93  TEUCHOS_TEST_FOR_EXCEPTION(1, Xpetra::Exceptions::NotImplemented, "TODO EpetraExportT<EpetraGlobalOrdinal>::getRemoteLIDs not implemented"); }
94 #endif
95 #if 0
96  template<class EpetraGlobalOrdinal, class Node>
98  XPETRA_MONITOR("EpetraExportT::getNumExportIDs");
99  TEUCHOS_TEST_FOR_EXCEPTION(1, Xpetra::Exceptions::NotImplemented, "TODO EpetraExportT<EpetraGlobalOrdinal>::getNumExportIDs not implemented"); }
100 #endif
101 #if 0
102  template<class EpetraGlobalOrdinal, class Node>
104  XPETRA_MONITOR("EpetraExportT::getExportLIDs");
105  TEUCHOS_TEST_FOR_EXCEPTION(1, Xpetra::Exceptions::NotImplemented, "TODO EpetraExportT<EpetraGlobalOrdinal>::getExportLIDs not implemented"); }
106 #endif
107 #if 0
108  template<class EpetraGlobalOrdinal, class Node>
109  void EpetraExportT<EpetraGlobalOrdinal, Node>::print(std::ostream &os) const { XPETRA_MONITOR("EpetraExportT::"); export_->Print(os); }
110 #endif
111 
112 
113 #ifndef XPETRA_EPETRA_NO_32BIT_GLOBAL_INDICES
114 
115 #ifdef HAVE_XPETRA_TPETRA
116 #ifdef HAVE_XPETRA_SERIAL
118 template RCP<const Export<int,int,Kokkos::Compat::KokkosSerialWrapperNode > > toXpetra<int,Kokkos::Compat::KokkosSerialWrapperNode >(const Epetra_Export *);
119 #endif
120 #ifdef HAVE_XPETRA_PTHREAD
122 template RCP<const Export<int,int,Kokkos::Compat::KokkosThreadsWrapperNode> > toXpetra<int,Kokkos::Compat::KokkosThreadsWrapperNode >(const Epetra_Export *);
123 #endif
124 #ifdef HAVE_XPETRA_OPENMP
126 template RCP<const Export<int, int, Kokkos::Compat::KokkosOpenMPWrapperNode> > toXpetra<int,Kokkos::Compat::KokkosOpenMPWrapperNode>(const Epetra_Export *);
127 #endif
128 #ifdef HAVE_XPETRA_CUDA
129 typedef Kokkos::Compat::KokkosCudaWrapperNode default_node_type;
131 template RCP<const Export<int, int, default_node_type> > toXpetra<int,default_node_type>(const Epetra_Export *);
132 #endif
133 #else
134 // Tpetra is disabled and Kokkos not available: use dummy node type
135 typedef EpetraNode default_node_type;
137 template RCP<const Export<int, int, default_node_type> > toXpetra<int,default_node_type>(const Epetra_Export *);
138 #endif // HAVE_XPETRA_TPETRA
139 #endif
140 
141 #ifndef XPETRA_EPETRA_NO_64BIT_GLOBAL_INDICES
142 
143 #ifdef HAVE_XPETRA_TPETRA
144 #ifdef HAVE_XPETRA_SERIAL
146 template RCP<const Export<int,long long,Kokkos::Compat::KokkosSerialWrapperNode > > toXpetra<long long,Kokkos::Compat::KokkosSerialWrapperNode >(const Epetra_Export *);
147 #endif
148 #ifdef HAVE_XPETRA_PTHREAD
150 template RCP<const Export<int,long long,Kokkos::Compat::KokkosThreadsWrapperNode> > toXpetra<long long,Kokkos::Compat::KokkosThreadsWrapperNode >(const Epetra_Export *);
151 #endif
152 #ifdef HAVE_XPETRA_OPENMP
154 template RCP<const Export<int, long long, Kokkos::Compat::KokkosOpenMPWrapperNode> > toXpetra<long long,Kokkos::Compat::KokkosOpenMPWrapperNode>(const Epetra_Export *);
155 #endif
156 #ifdef HAVE_XPETRA_CUDA
157 typedef Kokkos::Compat::KokkosCudaWrapperNode default_node_type;
159 template RCP<const Export<int, long long, default_node_type> > toXpetra<long long,default_node_type>(const Epetra_Export *);
160 #endif
161 #else
162 // Tpetra is disabled and Kokkos not available: use dummy node type
163 typedef EpetraNode default_node_type;
165 template RCP<const Export<int, long long, default_node_type> > toXpetra<long long,default_node_type>(const Epetra_Export *);
166 #endif // HAVE_XPETRA_TPETRA
167 #endif
168 
169 } // Xpetra namespace
170 
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
Xpetra namespace
ArrayView< const LocalOrdinal > getPermuteToLIDs() const
List of local IDs in the target Map that are permuted.
void print(std::ostream &os) const
Print the Export&#39;s data to the given output stream.
ArrayView< const LocalOrdinal > getPermuteFromLIDs() const
List of local IDs in the source Map that are permuted.
TEUCHOS_DEPRECATED RCP< T > rcp(T *p, Dealloc_T dealloc, bool owns_mem)
ArrayView< const LocalOrdinal > getRemoteLIDs() const
List of entries in the target Map to receive from other processes.
EpetraExportT(const Teuchos::RCP< const map_type > &source, const Teuchos::RCP< const map_type > &target)
Construct a Export object from the source and target Map.
size_t getNumRemoteIDs() const
Number of entries not on the calling process.
ArrayView< const LocalOrdinal > getExportLIDs() const
List of entries in the source Map that will be sent to other processes.
Exception throws when you call an unimplemented method of Xpetra.
ArrayView< const int > getExportPIDs() const
List of processes to which entries will be sent.
RCP< const CrsGraph< int, GlobalOrdinal, Node > > toXpetra(const Epetra_CrsGraph &g)
size_t getNumExportIDs() const
Number of entries that must be sent by the calling process to other processes.
#define XPETRA_MONITOR(funcName)