Xpetra Version of the Day
Loading...
Searching...
No Matches
Xpetra_TpetraExport_decl.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_TPETRAEXPORT_DECL_HPP
47#define XPETRA_TPETRAEXPORT_DECL_HPP
48
49/* this file is automatically generated - do not edit (see script/tpetra.py) */
50
52
53#include "Xpetra_Export.hpp"
54#include "Xpetra_Exceptions.hpp"
55
57#include "Tpetra_Export.hpp"
58
59// Note: 'export' is a reserved keyword in C++. Do not use 'export' as a variable name.
60
61namespace Xpetra {
62
63
64// TODO: move that elsewhere
65template<class LocalOrdinal, class GlobalOrdinal, class Node>
66const Tpetra::Export<LocalOrdinal, GlobalOrdinal, Node>& toTpetra(const Export<LocalOrdinal, GlobalOrdinal, Node>&);
67
68
69template<class LocalOrdinal, class GlobalOrdinal, class Node>
70RCP<const Export<LocalOrdinal, GlobalOrdinal, Node>>
71toXpetra(const RCP<const Tpetra::Export<LocalOrdinal, GlobalOrdinal, Node>>& exp);
72
73
74
75template<class LocalOrdinal,
76 class GlobalOrdinal,
77 class Node>
79 : public Export<LocalOrdinal, GlobalOrdinal, Node>
80{
81
82 public:
85
86
88
89
92
93
96 const Teuchos::RCP<const map_type>& target,
98
99
102
103
106
107
109
111
112
113
115 size_t getNumSameIDs() const;
116
117
119 size_t getNumPermuteIDs() const;
120
121
124
125
128
129
131 size_t getNumRemoteIDs() const;
132
133
136
137
139 size_t getNumExportIDs() const;
140
141
144
145
148
149
152
153
156
159
160
162
164
165
166
168 void print(std::ostream& os) const;
169
170
172
174
175
176
178 TpetraExport(const RCP<const Tpetra::Export<LocalOrdinal, GlobalOrdinal, Node>>& exp);
179
180
182
184
185
186 private:
187
189
190}; // TpetraExport class
191
192
193
194// --------------
195// Free functions
196// --------------
197
198
199
200// TODO: move that elsewhere
201template<class LocalOrdinal, class GlobalOrdinal, class Node>
202const Tpetra::Export<LocalOrdinal, GlobalOrdinal, Node>&
204{
205 // TODO: throw exception
207 dynamic_cast<const TpetraExport<LocalOrdinal, GlobalOrdinal, Node>&>(exp);
208 return *tpetraExport.getTpetra_Export();
209}
210
211 template <class LocalOrdinal, class GlobalOrdinal, class Node>
213 typedef TpetraExport<LocalOrdinal, GlobalOrdinal, Node> TpetraExportClass;
214 if (exportObj != Teuchos::null) {
215 XPETRA_RCP_DYNAMIC_CAST(const TpetraExportClass, rcpFromRef(*exportObj), tpetraExport, "toTpetra");
216 return tpetraExport->getTpetra_Export();
217 }
218 return Teuchos::null;
219 }
220
221
222template<class LocalOrdinal, class GlobalOrdinal, class Node>
223RCP<const Export<LocalOrdinal, GlobalOrdinal, Node>>
224toXpetra(const RCP<const Tpetra::Export<LocalOrdinal, GlobalOrdinal, Node>>& exp)
225{
226 if(!exp.is_null())
228
229 return Teuchos::null;
230}
231
232
233
234} // namespace Xpetra
235
236#endif // XPETRA_TPETRAEXPORT_DECL_HPP
237
238
#define XPETRA_RCP_DYNAMIC_CAST(type, obj, newObj, exceptionMsg)
ArrayView< const LocalOrdinal > getPermuteFromLIDs() const
List of local IDs in the source Map that are permuted.
size_t getNumPermuteIDs() const
Number of IDs to permute but not to communicate.
void setDistributorParameters(const Teuchos::RCP< Teuchos::ParameterList > params) const
Set distributor parameters.
ArrayView< const LocalOrdinal > getExportLIDs() const
List of entries in the source Map that will be sent to other processes.
Map< LocalOrdinal, GlobalOrdinal, Node > map_type
The specialization of Map used by this class.
Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > getSourceMap() const
The source Map used to construct this Export.
size_t getNumSameIDs() const
Number of initial identical IDs.
ArrayView< const LocalOrdinal > getRemoteLIDs() const
List of entries in the target Map to receive from other processes.
size_t getNumExportIDs() const
Number of entries that must be sent by the calling process to other processes.
ArrayView< const LocalOrdinal > getPermuteToLIDs() const
List of local IDs in the target Map that are permuted.
Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > getTargetMap() const
The target Map used to construct this Export.
ArrayView< const int > getExportPIDs() const
List of processes to which entries will be sent.
RCP< const Tpetra::Export< LocalOrdinal, GlobalOrdinal, Node > > getTpetra_Export() const
void print(std::ostream &os) const
Print the Export's data to the given output stream.
size_t getNumRemoteIDs() const
Number of entries not on the calling process.
RCP< const Tpetra::Export< LocalOrdinal, GlobalOrdinal, Node > > export_
TEUCHOS_DEPRECATED RCP< T > rcp(T *p, Dealloc_T dealloc, bool owns_mem)
Xpetra namespace
RCP< const CrsGraph< int, GlobalOrdinal, Node > > toXpetra(const Epetra_CrsGraph &g)
RCP< const Tpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node > > toTpetra(const RCP< const CrsGraph< LocalOrdinal, GlobalOrdinal, Node > > &graph)