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>
52  RCP<const Export<int, GlobalOrdinal> > toXpetra(const Epetra_Export *exp) {
53  if (exp != NULL) {
54  RCP<const Epetra_Export> eexp = rcp(new Epetra_Export(*exp)); //NOTE: non consitent: return pointer, take ref
55  return rcp(new Xpetra::EpetraExportT<GlobalOrdinal>(eexp));
56  }
57 
58  return Teuchos::null;
59  }
60 
61  template<class EpetraGlobalOrdinal>
63  : export_(rcp(new Epetra_Export(toEpetra(source), toEpetra(target)))) { } // Warning: Epetra(Target, Source) vs. Tpetra(Source, Target)
64 
65  //
66  template<class EpetraGlobalOrdinal>
67  ArrayView< const int > EpetraExportT<EpetraGlobalOrdinal>::getExportPIDs() const { XPETRA_MONITOR("EpetraExportT::getExportImageIDs"); return ArrayView<const int> (export_->ExportPIDs(),export_->NumExportIDs()); }
68 
69  template<class EpetraGlobalOrdinal>
71  XPETRA_MONITOR("EpetraExportT::getPermuteFromLIDs");
72  TEUCHOS_TEST_FOR_EXCEPTION(1, Xpetra::Exceptions::NotImplemented, "TODO EpetraExportT<EpetraGlobalOrdinal>::getExportImageIDs not implemented"); }
73 
74  template<class EpetraGlobalOrdinal>
76  XPETRA_MONITOR("EpetraExportT::getPermuteToLIDs");
77  TEUCHOS_TEST_FOR_EXCEPTION(1, Xpetra::Exceptions::NotImplemented, "TODO EpetraExportT<EpetraGlobalOrdinal>::getPermuteToLIDs not implemented"); }
78 
79  template<class EpetraGlobalOrdinal>
81  XPETRA_MONITOR("EpetraExportT::getNumRemoteIDs");
82  TEUCHOS_TEST_FOR_EXCEPTION(1, Xpetra::Exceptions::NotImplemented, "TODO EpetraExportT<EpetraGlobalOrdinal>::getNumRemoteIDs not implemented"); }
83 
84  template<class EpetraGlobalOrdinal>
86  XPETRA_MONITOR("EpetraExportT::getRemoteLIDs");
87  TEUCHOS_TEST_FOR_EXCEPTION(1, Xpetra::Exceptions::NotImplemented, "TODO EpetraExportT<EpetraGlobalOrdinal>::getRemoteLIDs not implemented"); }
88 
89  template<class EpetraGlobalOrdinal>
91  XPETRA_MONITOR("EpetraExportT::getNumExportIDs");
92  TEUCHOS_TEST_FOR_EXCEPTION(1, Xpetra::Exceptions::NotImplemented, "TODO EpetraExportT<EpetraGlobalOrdinal>::getNumExportIDs not implemented"); }
93 
94  template<class EpetraGlobalOrdinal>
96  XPETRA_MONITOR("EpetraExportT::getExportLIDs");
97  TEUCHOS_TEST_FOR_EXCEPTION(1, Xpetra::Exceptions::NotImplemented, "TODO EpetraExportT<EpetraGlobalOrdinal>::getExportLIDs not implemented"); }
98 
99  template<class EpetraGlobalOrdinal>
100  void EpetraExportT<EpetraGlobalOrdinal>::print(std::ostream &os) const { XPETRA_MONITOR("EpetraExportT::"); export_->Print(os); }
101 
102 #ifndef XPETRA_EPETRA_NO_32BIT_GLOBAL_INDICES
103 template class EpetraExportT<int>;
104 template RCP<const Export<int, int> > toXpetra<int>(const Epetra_Export *);
105 #endif
106 
107 #ifndef XPETRA_EPETRA_NO_64BIT_GLOBAL_INDICES
108 template class EpetraExportT<long long>;
109 template RCP<const Export<int, long long> > toXpetra<long long>(const Epetra_Export *);
110 #endif
111 
112 } // Xpetra namespace
113 
template RCP< const CrsGraph< int, long long > > toXpetra< long long >(const Epetra_CrsGraph &g)
size_t getNumExportIDs() const
Number of entries that must be sent by the calling process to other processes.
const Epetra_CrsGraph & toEpetra(const RCP< const CrsGraph< int, GlobalOrdinal > > &graph)
size_t getNumRemoteIDs() const
Number of entries not on the calling process.
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
Xpetra namespace
RCP< const CrsGraph< int, GlobalOrdinal > > toXpetra(const Epetra_CrsGraph &g)
ArrayView< const int > getExportPIDs() const
List of processes to which entries will be sent.
ArrayView< const LocalOrdinal > getExportLIDs() const
List of entries in the source Map that will be sent to other processes.
TEUCHOS_DEPRECATED RCP< T > rcp(T *p, Dealloc_T dealloc, bool owns_mem)
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.
ArrayView< const LocalOrdinal > getPermuteToLIDs() const
List of local IDs in the target Map that are permuted.
template RCP< const CrsGraph< int, int > > toXpetra< int >(const Epetra_CrsGraph &g)
Exception throws when you call an unimplemented method of Xpetra.
RCP< const Epetra_Export > export_
ArrayView< const LocalOrdinal > getRemoteLIDs() const
List of entries in the target Map to receive from other processes.
#define XPETRA_MONITOR(funcName)
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.