Xpetra  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Xpetra_EpetraImport.hpp
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 #ifndef XPETRA_EPETRAIMPORT_HPP
47 #define XPETRA_EPETRAIMPORT_HPP
48 
49 /* this file is automatically generated - do not edit (see script/epetra.py) */
50 
52 
53 #include "Xpetra_Import.hpp"
54 
55 #include "Xpetra_EpetraMap.hpp" //TMP
56 
57 #include "Epetra_Import.h"
58 
59 namespace Xpetra {
60 
61 template <class GlobalOrdinal, class Node>
62 RCP<const Import<int, GlobalOrdinal, Node> > toXpetra(const Epetra_Import *import);
63 //
64 
65 template <class EpetraGlobalOrdinal, class Node>
67  : public Import<int, EpetraGlobalOrdinal, Node> {
68  typedef int LocalOrdinal;
69  typedef EpetraGlobalOrdinal GlobalOrdinal;
72 
73  public:
75 
76 
78  EpetraImportT(const Teuchos::RCP<const map_type> &source, const Teuchos::RCP<const map_type> &target)
79  : import_(rcp(new Epetra_Import(toEpetra<GlobalOrdinal, Node>(target), toEpetra<GlobalOrdinal, Node>(source)))) {} // Warning: Epetra(Target, Source) vs. Tpetra(Source, Target)
80 
82  // Definition not in cpp, so comment out
83  // EpetraImportT(const Teuchos::RCP< const map_type > &source, const Teuchos::RCP< const map_type > &target, const Teuchos::RCP< Teuchos::ParameterList > &plist);
84 
86  // Definition commented out in cpp
87  // EpetraImportT(const Import< LocalOrdinal, GlobalOrdinal, Node > &import);
88 
91 
93  Teuchos::RCP<const Import<LocalOrdinal, GlobalOrdinal, Node> >
94  createRemoteOnlyImport(const Teuchos::RCP<const map_type> &remoteTarget) const { TEUCHOS_TEST_FOR_EXCEPTION(1, Xpetra::Exceptions::NotImplemented, "TODO EpetraImportT<EpetraGlobalOrdinal>::createRemoteOnlyImport not implemented"); }
95 
97 
99 
100 
102  size_t getNumSameIDs() const {
103  XPETRA_MONITOR("EpetraImportT::getNumSameIDs");
104  return import_->NumSameIDs();
105  }
106 
108  size_t getNumPermuteIDs() const {
109  XPETRA_MONITOR("EpetraImportT::getNumPermuteIDs");
110  return import_->NumPermuteIDs();
111  }
112 
114  ArrayView<const LocalOrdinal> getPermuteFromLIDs() const {
115  XPETRA_MONITOR("EpetraImportT::getPermuteFromLIDs");
116  TEUCHOS_TEST_FOR_EXCEPTION(1, Xpetra::Exceptions::NotImplemented, "TODO EpetraImportT<EpetraGlobalOrdinal>::getExportImageIDs not implemented");
117  }
118 
120  ArrayView<const LocalOrdinal> getPermuteToLIDs() const {
121  XPETRA_MONITOR("EpetraImportT::getPermuteToLIDs");
122  TEUCHOS_TEST_FOR_EXCEPTION(1, Xpetra::Exceptions::NotImplemented, "TODO EpetraImportT<EpetraGlobalOrdinal>::getPermuteToLIDs not implemented");
123  }
124 
126  size_t getNumRemoteIDs() const {
127  XPETRA_MONITOR("EpetraImportT::getNumRemoteIDs");
128  return import_->NumRemoteIDs();
129  }
130 
132  ArrayView<const LocalOrdinal> getRemoteLIDs() const {
133  XPETRA_MONITOR("EpetraImportT::getRemoteLIDs");
134  TEUCHOS_TEST_FOR_EXCEPTION(1, Xpetra::Exceptions::NotImplemented, "TODO EpetraImportT<EpetraGlobalOrdinal>::getRemoteLIDs not implemented");
135  }
136 
138  ArrayView<const LocalOrdinal> getRemotePIDs() const {
139  XPETRA_MONITOR("EpetraImportT::getRemotePIDs");
140  TEUCHOS_TEST_FOR_EXCEPTION(1, Xpetra::Exceptions::NotImplemented, "TODO EpetraImportT<EpetraGlobalOrdinal>::getRemotePIDs not implemented");
141  }
142 
144  size_t getNumExportIDs() const {
145  XPETRA_MONITOR("EpetraImportT::getNumExportIDs");
146  return import_->NumExportIDs();
147  }
148 
150  ArrayView<const LocalOrdinal> getExportLIDs() const {
151  XPETRA_MONITOR("EpetraImportT::getExportLIDs");
152  TEUCHOS_TEST_FOR_EXCEPTION(1, Xpetra::Exceptions::NotImplemented, "TODO EpetraImportT<EpetraGlobalOrdinal>::getExportLIDs not implemented");
153  }
154 
156  ArrayView<const int> getExportPIDs() const {
157  XPETRA_MONITOR("EpetraImportT::getExportImageIDs");
158  return ArrayView<const int>(import_->ExportPIDs(), import_->NumExportIDs());
159  }
160 
162  Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > getSourceMap() const {
163  XPETRA_MONITOR("EpetraImportT::getSourceMap");
164  return toXpetra<GlobalOrdinal, Node>(import_->SourceMap());
165  }
166 
168  Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > getTargetMap() const {
169  XPETRA_MONITOR("EpetraImportT::getTargetMap");
170  return toXpetra<GlobalOrdinal, Node>(import_->TargetMap());
171  }
172 
173  void setDistributorParameters(const Teuchos::RCP<Teuchos::ParameterList> params) const { XPETRA_MONITOR("EpetraImportT::setDistributorParameters"); }
174 
176 
178 
179 
181  void print(std::ostream &os) const {
182  XPETRA_MONITOR("EpetraImportT::print");
183  import_->Print(os);
184  }
185 
187 
189 
190 
192  EpetraImportT(const RCP<const Epetra_Import> &import)
193  : import_(import) {}
194 
196  RCP<const Epetra_Import> getEpetra_Import() const { return import_; }
197 
199 
200  private:
201  RCP<const Epetra_Import> import_;
202 
203 }; // EpetraImportT class
204 
205 } // namespace Xpetra
206 
207 #endif // XPETRA_EPETRAIMPORT_HPP
ArrayView< const int > getExportPIDs() const
List of processes to which entries will be sent.
EpetraImportT(const RCP< const Epetra_Import > &import)
EpetraImportT constructor to wrap a Epetra_Import object.
void print(std::ostream &os) const
Print the Import&#39;s data to the given output stream.
ArrayView< const LocalOrdinal > getPermuteFromLIDs() const
List of local IDs in the source Map that are permuted.
ArrayView< const LocalOrdinal > getRemoteLIDs() const
List of entries in the target Map to receive from other processes.
EpetraGlobalOrdinal GlobalOrdinal
RCP< const Epetra_Import > getEpetra_Import() const
Get the underlying Epetra import.
void setDistributorParameters(const Teuchos::RCP< Teuchos::ParameterList > params) const
Set parameters on the underlying object.
Map< LocalOrdinal, GlobalOrdinal, Node > map_type
The specialization of Map used by this class.
size_t getNumExportIDs() const
Number of entries that must be sent by the calling process to other processes.
size_t getNumSameIDs() const
Number of initial identical IDs.
ArrayView< const LocalOrdinal > getExportLIDs() const
List of entries in the source Map that will be sent to other processes.
ArrayView< const LocalOrdinal > getPermuteToLIDs() const
List of local IDs in the target Map that are permuted.
EpetraImportT(const Teuchos::RCP< const map_type > &source, const Teuchos::RCP< const map_type > &target)
Construct an Import from the source and target Maps.
RCP< const Epetra_Import > import_
Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > getSourceMap() const
The Source Map used to construct this Import object.
Exception throws when you call an unimplemented method of Xpetra.
RCP< const CrsGraph< int, GlobalOrdinal, Node > > toXpetra(const Epetra_CrsGraph &g)
#define XPETRA_MONITOR(funcName)
Teuchos::RCP< const Import< LocalOrdinal, GlobalOrdinal, Node > > createRemoteOnlyImport(const Teuchos::RCP< const map_type > &remoteTarget) const
Special &quot;constructor&quot;.
size_t getNumPermuteIDs() const
Number of IDs to permute but not to communicate.
ArrayView< const LocalOrdinal > getRemotePIDs() const
List of entries in the target Map to receive from other processes.
size_t getNumRemoteIDs() const
Number of entries not on the calling process.
const Epetra_CrsGraph & toEpetra(const RCP< const CrsGraph< int, GlobalOrdinal, Node > > &graph)
Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > getTargetMap() const
The Target Map used to construct this Import object.