Xpetra_Map.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_MAP_HPP
47 #define XPETRA_MAP_HPP
48 
49 /* this file is automatically generated - do not edit (see script/interfaces.py) */
50 
51 #include "Xpetra_ConfigDefs.hpp"
52 #include <Kokkos_DefaultNode.hpp>
53 #include <Teuchos_Describable.hpp>
54 
55 #ifdef HAVE_XPETRA_EPETRA
56 #include "Epetra_config.h"
57 #endif
58 
59 namespace Xpetra {
60 
61  // TODO move this typedef to another place
62  // Node which is used for Epetra. This can be either the
63  // Serial node or OpenMP node (but not both)
64 #ifdef HAVE_XPETRA_EPETRA
65 # ifdef EPETRA_HAVE_OMP
66  typedef Kokkos::Compat::KokkosOpenMPWrapperNode EpetraNode;
67 # else
69 # endif
70 #endif
71 
76  };
77 
78  template <class LocalOrdinal = int,
79  class GlobalOrdinal = LocalOrdinal,
81  class Map
82  : public Teuchos::Describable
83  {
84  public:
85  typedef LocalOrdinal local_ordinal_type;
86  typedef GlobalOrdinal global_ordinal_type;
87  typedef Node node_type;
88 
90 
91 
93  virtual ~Map() { }
94 
96 
98 
99 
101  virtual global_size_t getGlobalNumElements() const = 0;
102 
104  virtual size_t getNodeNumElements() const = 0;
105 
107  virtual GlobalOrdinal getIndexBase() const = 0;
108 
110  virtual LocalOrdinal getMinLocalIndex() const = 0;
111 
113  virtual LocalOrdinal getMaxLocalIndex() const = 0;
114 
116  virtual GlobalOrdinal getMinGlobalIndex() const = 0;
117 
119  virtual GlobalOrdinal getMaxGlobalIndex() const = 0;
120 
122  virtual GlobalOrdinal getMinAllGlobalIndex() const = 0;
123 
125  virtual GlobalOrdinal getMaxAllGlobalIndex() const = 0;
126 
128  virtual LocalOrdinal getLocalElement(GlobalOrdinal globalIndex) const = 0;
129 
131  virtual GlobalOrdinal getGlobalElement(LocalOrdinal localIndex) const = 0;
132 
135 
137  virtual LookupStatus getRemoteIndexList(const Teuchos::ArrayView< const GlobalOrdinal > &GIDList, const Teuchos::ArrayView< int > &nodeIDList) const = 0;
138 
141 
143 
145 
146 
148  virtual bool isNodeLocalElement(LocalOrdinal localIndex) const = 0;
149 
151  virtual bool isNodeGlobalElement(GlobalOrdinal globalIndex) const = 0;
152 
154  virtual bool isContiguous() const = 0;
155 
157  virtual bool isDistributed() const = 0;
158 
160  virtual bool isCompatible(const Map< LocalOrdinal, GlobalOrdinal, Node > &map) const = 0;
161 
163  virtual bool isSameAs(const Map< LocalOrdinal, GlobalOrdinal, Node > &map) const = 0;
164 
166 
168 
169 
172 
174  virtual Teuchos::RCP< Node > getNode() const = 0;
175 
177 
179 
180 
182  virtual std::string description() const = 0;
183 
186 
188 
190 
191 
194 
197 
199 
201 
202 
204  virtual UnderlyingLib lib() const = 0;
205 
206  // TODO: find a better solution for this hack
207  // The problem is that EpetraMap, TpetraMap and StridedMap all inherit Map. To have proper toEpetra() we
208  // need to understand the type of underlying matrix. But in src/Map we have no knowledge of StridedMaps, so
209  // we cannot check for it by casting. This function allows us to avoid the restriction, as StridedMap redefines
210  // it to return the base map.
211  virtual RCP<const Xpetra::Map<LocalOrdinal, GlobalOrdinal, Node> > getMap() const { return rcpFromRef(*this); }
212 
214 
215  }; // Map class
216 
217 } // Xpetra namespace
218 
219 #define XPETRA_MAP_SHORT
220 #endif // XPETRA_MAP_HPP
virtual LookupStatus getRemoteIndexList(const Teuchos::ArrayView< const GlobalOrdinal > &GIDList, const Teuchos::ArrayView< int > &nodeIDList, const Teuchos::ArrayView< LocalOrdinal > &LIDList) const =0
Return the process ranks and corresponding local indices for the given global indices.
virtual Teuchos::ArrayView< const GlobalOrdinal > getNodeElementList() const =0
Return a view of the global indices owned by this process.
LocalOrdinal local_ordinal_type
Definition: Xpetra_Map.hpp:85
virtual Teuchos::RCP< const Teuchos::Comm< int > > getComm() const =0
Get this Map&#39;s Comm object.
virtual RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > replaceCommWithSubset(const Teuchos::RCP< const Teuchos::Comm< int > > &newComm) const =0
Replace this Map&#39;s communicator with a subset communicator.
virtual bool isDistributed() const =0
Whether this Map is globally distributed or locally replicated.
virtual LocalOrdinal getMinLocalIndex() const =0
The minimum local index.
GlobalOrdinal global_ordinal_type
Definition: Xpetra_Map.hpp:86
virtual bool isCompatible(const Map< LocalOrdinal, GlobalOrdinal, Node > &map) const =0
True if and only if map is compatible with this Map.
Node node_type
Definition: Xpetra_Map.hpp:87
virtual GlobalOrdinal getMinAllGlobalIndex() const =0
The minimum global index over all processes in the communicator.
Xpetra namespace
virtual size_t getNodeNumElements() const =0
The number of elements belonging to the calling process.
virtual LocalOrdinal getLocalElement(GlobalOrdinal globalIndex) const =0
The local index corresponding to the given global index.
virtual GlobalOrdinal getMinGlobalIndex() const =0
The minimum global index owned by the calling process.
Kokkos::Compat::KokkosSerialWrapperNode EpetraNode
Definition: Xpetra_Map.hpp:68
virtual GlobalOrdinal getIndexBase() const =0
The index base for this Map.
virtual ~Map()
Destructor.
Definition: Xpetra_Map.hpp:93
virtual RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > removeEmptyProcesses() const =0
Return a new Map with processes with zero elements removed.
virtual bool isNodeGlobalElement(GlobalOrdinal globalIndex) const =0
Whether the given global index is valid for this Map on this process.
virtual RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > getMap() const
Definition: Xpetra_Map.hpp:211
virtual GlobalOrdinal getMaxGlobalIndex() const =0
The maximum global index owned by the calling process.
virtual GlobalOrdinal getMaxAllGlobalIndex() const =0
The maximum global index over all processes in the communicator.
virtual GlobalOrdinal getGlobalElement(LocalOrdinal localIndex) const =0
The global index corresponding to the given local index.
virtual LocalOrdinal getMaxLocalIndex() const =0
The maximum local index on the calling process.
size_t global_size_t
Global size_t object.
static const EVerbosityLevel verbLevel_default
virtual bool isSameAs(const Map< LocalOrdinal, GlobalOrdinal, Node > &map) const =0
True if and only if map is identical to this Map.
virtual bool isNodeLocalElement(LocalOrdinal localIndex) const =0
Whether the given local index is valid for this Map on this process.
virtual global_size_t getGlobalNumElements() const =0
The number of elements in this Map.
virtual void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const =0
Print this object with the given verbosity level to the given Teuchos::FancyOStream.
virtual Teuchos::RCP< Node > getNode() const =0
Get this Map&#39;s Node object.
virtual bool isContiguous() const =0
True if this Map is distributed contiguously, else false.
virtual UnderlyingLib lib() const =0
Get the library used by this object (Tpetra or Epetra?)
virtual std::string description() const =0
Return a simple one-line description of this object.