Xpetra Version of the Day
Loading...
Searching...
No Matches
Xpetra_TpetraMap_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_TPETRAMAP_DECL_HPP
47#define XPETRA_TPETRAMAP_DECL_HPP
48
49/* this file is automatically generated - do not edit (see script/tpetra.py) */
50
52
53#include <Tpetra_Map.hpp>
54
55#include "Xpetra_Map_decl.hpp"
56#include "Xpetra_Utils.hpp"
57
58#include "Xpetra_Exceptions.hpp"
59
60namespace Xpetra {
61
62 template <class LocalOrdinal, class GlobalOrdinal, class Node>
63 const RCP<Map<LocalOrdinal,GlobalOrdinal,Node> > toXpetraNonConst(const RCP<const Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> >& map);
64
65 template <class LocalOrdinal,
66 class GlobalOrdinal,
69 : public virtual Map<LocalOrdinal,GlobalOrdinal,Node> {
70
71 public:
72
74
75
76
78
79
80 TpetraMap (global_size_t numGlobalElements,
81 GlobalOrdinal indexBase,
82 const Teuchos::RCP< const Teuchos::Comm< int > > &comm,
84
85
87
88
89 TpetraMap (global_size_t numGlobalElements,
90 size_t numLocalElements,
91 GlobalOrdinal indexBase,
92 const Teuchos::RCP< const Teuchos::Comm< int > > &comm);
93
94
96
97
98 TpetraMap (global_size_t numGlobalElements,
100 GlobalOrdinal indexBase,
101 const Teuchos::RCP< const Teuchos::Comm< int > > &comm);
102
103
104#ifdef HAVE_XPETRA_TPETRA
106 TpetraMap (global_size_t numGlobalElements,
107 const Kokkos::View<const GlobalOrdinal*, typename Node::device_type>& indexList,
108 GlobalOrdinal indexBase,
109 const Teuchos::RCP< const Teuchos::Comm< int > > &comm);
110#endif
111
113 ~TpetraMap();
114
115
117
118
121
123 size_t getLocalNumElements() const;
124
126 GlobalOrdinal getIndexBase() const;
127
129 LocalOrdinal getMinLocalIndex() const;
130
132 LocalOrdinal getMaxLocalIndex() const;
133
135 GlobalOrdinal getMinGlobalIndex() const;
136
138 GlobalOrdinal getMaxGlobalIndex() const;
139
141 GlobalOrdinal getMinAllGlobalIndex() const;
142
144 GlobalOrdinal getMaxAllGlobalIndex() const;
145
147 LocalOrdinal getLocalElement(GlobalOrdinal globalIndex) const;
148
150 GlobalOrdinal getGlobalElement(LocalOrdinal localIndex) const;
151
154
157
160
162
164
165
167 bool isNodeLocalElement(LocalOrdinal localIndex) const;
168
170 bool isNodeGlobalElement(GlobalOrdinal globalIndex) const;
171
173 bool isContiguous() const;
174
176 bool isDistributed() const;
177
180
183
185
187
188
191
192
194
196
197
199 std::string description() const;
200
203
206
208
210
211
213 TpetraMap(const Teuchos::RCP<const Tpetra::Map<LocalOrdinal, GlobalOrdinal, Node > > &map);
214
216 UnderlyingLib lib() const;
217
220
221#ifdef HAVE_XPETRA_TPETRA
225#endif
226
228
229 protected:
230
232
233 }; // TpetraMap class
234
235
236 template <class LocalOrdinal, class GlobalOrdinal, class Node>
237 const Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> & toTpetra(const Map<LocalOrdinal,GlobalOrdinal,Node> &map) {
238 // TODO: throw exception
240 return *tpetraMap.getTpetra_Map();
241 }
242
243 template <class LocalOrdinal, class GlobalOrdinal, class Node>
246 if (map != Teuchos::null) {
247 XPETRA_RCP_DYNAMIC_CAST(const TpetraMapClass, map->getMap(), tpetraMap, "toTpetra");
248 return tpetraMap->getTpetra_Map();
249 }
250 return Teuchos::null;
251 }
252
253 // In some cases (for instance, in MueLu adapter to Tpetra operator), we need to return a reference. This is only possible if
254 // we assume that the map argument is nonzero
255 template <class LocalOrdinal, class GlobalOrdinal, class Node>
257 TEUCHOS_TEST_FOR_EXCEPTION(map.is_null(), std::invalid_argument, "map must be nonzero");
259 XPETRA_RCP_DYNAMIC_CAST(const TpetraMapClass, map->getMap(), tpetraMap, "toTpetra");
260 return tpetraMap->getTpetra_Map();
261 }
262
263 template <class LocalOrdinal, class GlobalOrdinal, class Node>
264 const RCP<const Map<LocalOrdinal,GlobalOrdinal,Node> > toXpetra(const RCP<const Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> >& map) {
265 if (!map.is_null())
267
268 return Teuchos::null;
269 }
270
271 template <class LocalOrdinal, class GlobalOrdinal, class Node>
272 const RCP<Map<LocalOrdinal,GlobalOrdinal,Node> > toXpetraNonConst(const RCP<const Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> >& map) {
273 if (!map.is_null())
275
276 return Teuchos::null;
277 }
278
279
280 namespace useTpetra {
281
283 template <class LocalOrdinal, class GlobalOrdinal, class Node>
285 createLocalMapWithNode(size_t numElements, const Teuchos::RCP< const Teuchos::Comm< int > > &comm)
286 {
287 XPETRA_MONITOR("useTpetra::createLocalMapWithNode");
288
289 return rcp(new TpetraMap<LocalOrdinal,GlobalOrdinal,Node>(Tpetra::createLocalMapWithNode<LocalOrdinal,GlobalOrdinal,Node>(numElements, comm)));
290 }
291
293 template <class LocalOrdinal, class GlobalOrdinal>
295 createContigMap(global_size_t numElements, size_t localNumElements, const Teuchos::RCP< const Teuchos::Comm< int > > &comm) {
296 XPETRA_MONITOR("useTpetra::createContigMap");
297
298 return rcp(new TpetraMap<LocalOrdinal,GlobalOrdinal, typename Tpetra::Map<>::node_type>(Tpetra::createContigMap<LocalOrdinal,GlobalOrdinal, typename Tpetra::Map<>::node_type>(numElements, localNumElements, comm)));
299 }
300
302 template <class LocalOrdinal, class GlobalOrdinal, class Node>
304 createContigMapWithNode(global_size_t numElements, size_t localNumElements,
305 const Teuchos::RCP< const Teuchos::Comm< int > > &comm)
306 {
307 XPETRA_MONITOR("useTpetra::createContigMap");
308 return rcp(new TpetraMap<LocalOrdinal,GlobalOrdinal,Node>(Tpetra::createContigMapWithNode<LocalOrdinal,GlobalOrdinal,Node>(numElements, localNumElements, comm)));
309 }
310 } // useTpetra namespace
311
312#define XPETRA_TPETRAMAP_SHORT
313} // Xpetra namespace
314#endif // XPETRA_TPETRAMAP_DECL_HPP
315
#define XPETRA_MONITOR(funcName)
#define XPETRA_RCP_DYNAMIC_CAST(type, obj, newObj, exceptionMsg)
static const EVerbosityLevel verbLevel_default
Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::local_map_type local_map_type
virtual RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > getMap() const
bool isDistributed() const
Whether this Map is globally distributed or locally replicated.
UnderlyingLib lib() const
Get the library used by this object (Tpetra or Epetra?)
LocalOrdinal getLocalElement(GlobalOrdinal globalIndex) const
The local index corresponding to the given global index.
LookupStatus getRemoteIndexList(const Teuchos::ArrayView< const GlobalOrdinal > &GIDList, const Teuchos::ArrayView< int > &nodeIDList, const Teuchos::ArrayView< LocalOrdinal > &LIDList) const
Return the process IDs and corresponding local IDs for the given global IDs.
void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const
Print this object with the given verbosity level to the given FancyOStream.
GlobalOrdinal getMaxAllGlobalIndex() const
The maximum global index over all processes in the communicator.
std::string description() const
Return a simple one-line description of this object.
global_size_t getGlobalNumElements() const
The number of elements in this Map.
Teuchos::ArrayView< const GlobalOrdinal > getLocalElementList() const
Return a view of the global indices owned by this node.
size_t getLocalNumElements() const
The number of elements belonging to the calling node.
bool isContiguous() const
True if this Map is distributed contiguously, else false.
typename Map< LocalOrdinal, GlobalOrdinal, Node >::local_map_type local_map_type
TpetraMap(global_size_t numGlobalElements, GlobalOrdinal indexBase, const Teuchos::RCP< const Teuchos::Comm< int > > &comm, LocalGlobal lg=GloballyDistributed)
Constructor with Tpetra-defined contiguous uniform distribution.
bool isSameAs(const Map< LocalOrdinal, GlobalOrdinal, Node > &map) const
True if and only if map is identical to this Map.
RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > getTpetra_Map() const
Get the underlying Tpetra map.
RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > removeEmptyProcesses() const
Return a new Map with processes with zero elements removed.
RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > map_
GlobalOrdinal getIndexBase() const
The index base for this Map.
GlobalOrdinal getMinGlobalIndex() const
The minimum global index owned by the calling process.
GlobalOrdinal getMinAllGlobalIndex() const
The minimum global index over all processes in the communicator.
local_map_type getLocalMap() const
Get the local Map for Kokkos kernels.
bool isNodeLocalElement(LocalOrdinal localIndex) const
True if the local index is valid for this Map on this node, else false.
LocalOrdinal getMaxLocalIndex() const
The maximum local index on the calling process.
RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > replaceCommWithSubset(const Teuchos::RCP< const Teuchos::Comm< int > > &newComm) const
Replace this Map's communicator with a subset communicator.
bool isCompatible(const Map< LocalOrdinal, GlobalOrdinal, Node > &map) const
True if and only if map is compatible with this Map.
Teuchos::RCP< const Teuchos::Comm< int > > getComm() const
Get this Map's Comm object.
GlobalOrdinal getGlobalElement(LocalOrdinal localIndex) const
The global index corresponding to the given local index.
GlobalOrdinal getMaxGlobalIndex() const
The maximum global index owned by the calling process.
LocalOrdinal getMinLocalIndex() const
The minimum local index.
bool isNodeGlobalElement(GlobalOrdinal globalIndex) const
True if the global index is found in this Map on this node, else false.
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
Teuchos::RCP< const TpetraMap< LocalOrdinal, GlobalOrdinal, Node > > createLocalMapWithNode(size_t numElements, const Teuchos::RCP< const Teuchos::Comm< int > > &comm)
Non-member function to create a locally replicated Map with a specified node.
Teuchos::RCP< const TpetraMap< LocalOrdinal, GlobalOrdinal, Node > > createContigMapWithNode(global_size_t numElements, size_t localNumElements, const Teuchos::RCP< const Teuchos::Comm< int > > &comm)
Non-member function to create a (potentially) non-uniform, contiguous Map with a user-specified node.
Teuchos::RCP< const TpetraMap< LocalOrdinal, GlobalOrdinal, typename Tpetra::Map<>::node_type > > createContigMap(global_size_t numElements, size_t localNumElements, const Teuchos::RCP< const Teuchos::Comm< int > > &comm)
Non-member function to create a (potentially) non-uniform, contiguous Map with the default node.
Xpetra namespace
const RCP< Map< LocalOrdinal, GlobalOrdinal, Node > > toXpetraNonConst(const RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > &map)
size_t global_size_t
Global size_t object.
RCP< const CrsGraph< int, GlobalOrdinal, Node > > toXpetra(const Epetra_CrsGraph &g)
const RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > toTpetraNonZero(const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &map)
RCP< const Tpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node > > toTpetra(const RCP< const CrsGraph< LocalOrdinal, GlobalOrdinal, Node > > &graph)