Xpetra_TpetraVector_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_TPETRAVECTOR_DECL_HPP
47 #define XPETRA_TPETRAVECTOR_DECL_HPP
48 
49 #include "Xpetra_TpetraConfigDefs.hpp"
50 
51 #include "Xpetra_Vector.hpp"
52 #include "Xpetra_MultiVector.hpp"
53 #include "Xpetra_TpetraMultiVector.hpp"
54 
55 #include "Xpetra_TpetraMap.hpp" //TMP
56 #include "Xpetra_Utils.hpp"
57 
58 #include "Tpetra_Vector.hpp"
59 
60 namespace Xpetra {
61 
62 // TODO: move that elsewhere
63 template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
64 RCP<Tpetra::Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>> toTpetra(Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>&);
65 
66 template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
67 RCP<Tpetra::Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>> toTpetra(const Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>&);
68 
69 template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
70 RCP<const Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>> toXpetra(RCP<const Tpetra::Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>> vec);
71 
72 template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
73 RCP<Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>> toXpetra(RCP<Tpetra::Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>> vec);
74 
75 //
76 //
77 
78 template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
79 class TpetraVector
80  : public virtual Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>
81  , public TpetraMultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>
82 {
83 
84  public:
85  using TpetraMultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>::dot; // overloading, not hiding
86  using TpetraMultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>::norm1; // overloading, not hiding
87  using TpetraMultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>::norm2; // overloading, not hiding
88  using TpetraMultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>::normInf; // overloading, not hiding
89  using TpetraMultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>::meanValue; // overloading, not hiding
90  using TpetraMultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>::replaceGlobalValue; // overloading, not hiding
91  using TpetraMultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>::sumIntoGlobalValue; // overloading, not hiding
92  using TpetraMultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>::replaceLocalValue; // overloading, not hiding
93  using TpetraMultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>::sumIntoLocalValue; // overloading, not hiding
94 
96 
97 
99  TpetraVector(const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>>& map, bool zeroOut = true);
100 
102  TpetraVector(const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>>& map, const Teuchos::ArrayView<const Scalar>& A);
103 
105  virtual ~TpetraVector();
106 
108 
110 
111 
113  void replaceGlobalValue(GlobalOrdinal globalRow, const Scalar& value);
114 
116  void sumIntoGlobalValue(GlobalOrdinal globalRow, const Scalar& value);
117 
119  void replaceLocalValue(LocalOrdinal myRow, const Scalar& value);
120 
122  void sumIntoLocalValue(LocalOrdinal myRow, const Scalar& value);
123 
125 
127 
128 
130  typename Teuchos::ScalarTraits<Scalar>::magnitudeType norm1() const;
131 
133  typename Teuchos::ScalarTraits<Scalar>::magnitudeType norm2() const;
134 
136  typename Teuchos::ScalarTraits<Scalar>::magnitudeType normInf() const;
137 
139  Scalar meanValue() const;
140 
142 
144 
145 
147  std::string description() const;
148 
150  void describe(Teuchos::FancyOStream& out, const Teuchos::EVerbosityLevel verbLevel = Teuchos::Describable::verbLevel_default) const;
151 
153 
155  Scalar dot(const Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& a) const;
156 
157 #ifdef TPETRA_ENABLE_DEPRECATED_CODE
158  TPETRA_DEPRECATED typename Teuchos::ScalarTraits<Scalar>::magnitudeType
160  normWeighted(const Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& weights) const;
161 #endif
162 
163 
165 
166 
168  TpetraVector(const Teuchos::RCP<Tpetra::Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>>& vec);
169 
171  RCP<Tpetra::Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>> getTpetra_Vector() const;
172 
173 #ifdef HAVE_XPETRA_KOKKOS_REFACTOR
174 
175  typedef typename Xpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>::dual_view_type dual_view_type;
176 
177  typename dual_view_type::t_host_um getHostLocalView() const;
178 
179  typename dual_view_type::t_dev_um getDeviceLocalView() const;
180 
191  template<class TargetDeviceType>
192  typename Kokkos::Impl::if_c<
193  Kokkos::Impl::is_same<typename dual_view_type::t_dev_um::execution_space::memory_space, typename TargetDeviceType::memory_space>::value,
194  typename dual_view_type::t_dev_um,
195  typename dual_view_type::t_host_um>::type
196  getLocalView() const;
197 #endif
198 
200 
201 }; // TpetraVector class
202 
203 
204 // TODO: move that elsewhere
205 template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
206 RCP<Tpetra::Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>>
207 toTpetra(Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& x)
208 {
209  typedef TpetraVector<Scalar, LocalOrdinal, GlobalOrdinal, Node> TpetraVectorClass;
210  XPETRA_DYNAMIC_CAST(TpetraVectorClass, x, tX, "toTpetra");
211  return tX.getTpetra_Vector();
212 }
213 
214 template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
215 RCP<Tpetra::Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>>
216 toTpetra(const Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& x)
217 {
218  typedef TpetraVector<Scalar, LocalOrdinal, GlobalOrdinal, Node> TpetraVectorClass;
219  XPETRA_DYNAMIC_CAST(const TpetraVectorClass, x, tX, "toTpetra");
220  return tX.getTpetra_Vector();
221 }
222 
223 template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
224 RCP<Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>>
225 toXpetra(RCP<Tpetra::Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>> vec)
226 {
227  if(!vec.is_null())
228  return rcp(new TpetraVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>(vec));
229 
230  return Teuchos::null;
231 }
232 
233 template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
234 RCP<const Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>>
235 toXpetra(RCP<const Tpetra::Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>> vec)
236 {
237  // We cast away the const to wrap the Tpetra vector into an Xpetra object. But it's OK because the Xpetra vector is returned as const.
238  return toXpetra(Teuchos::rcp_const_cast<Tpetra::Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>>(vec));
239 }
240 
241 } // namespace Xpetra
242 
243 #define XPETRA_TPETRAVECTOR_SHORT
244 #endif // XPETRA_TPETRAVECTOR_DECL_HPP
Xpetra_MultiVector.hpp
Xpetra::TpetraVector::replaceGlobalValue
void replaceGlobalValue(GlobalOrdinal globalRow, const Scalar &value)
Replace current value at the specified location with specified value.
Definition: Xpetra_TpetraVector_def.hpp:82
Xpetra
Xpetra namespace
Definition: Xpetra_BlockedCrsMatrix.hpp:88
Xpetra::toTpetra
RCP< const Tpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node > > toTpetra(const RCP< const CrsGraph< LocalOrdinal, GlobalOrdinal, Node > > &graph)
Definition: Xpetra_TpetraCrsGraph_decl.hpp:378
Xpetra::MultiVector
Definition: Xpetra_MultiVector.hpp:78
XPETRA_DYNAMIC_CAST
#define XPETRA_DYNAMIC_CAST(type, obj, newObj, exceptionMsg)
Definition: Xpetra_Exceptions.hpp:58
Xpetra::toXpetra
RCP< const CrsGraph< int, GlobalOrdinal, Node > > toXpetra(const Epetra_CrsGraph &g)
Definition: Xpetra_EpetraCrsGraph.cpp:168
rcp
TEUCHOS_DEPRECATED RCP< T > rcp(T *p, Dealloc_T dealloc, bool owns_mem)
Teuchos::EVerbosityLevel
EVerbosityLevel
Xpetra_Utils.hpp
Teuchos::ArrayView
Xpetra::Map
Definition: Xpetra_Map_decl.hpp:91
Teuchos::RCP
Xpetra::TpetraVector::dot
Scalar dot(const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &a) const
Computes dot product of this Vector against input Vector x.
Definition: Xpetra_TpetraVector_def.hpp:182
Xpetra::TpetraVector::description
std::string description() const
Return a simple one-line description of this object.
Definition: Xpetra_TpetraVector_def.hpp:162
Xpetra::Vector
Definition: Xpetra_Vector.hpp:62
Xpetra::TpetraMultiVector
Definition: Xpetra_TpetraMultiVector_decl.hpp:89
Teuchos::basic_FancyOStream
Xpetra::TpetraVector::sumIntoGlobalValue
void sumIntoGlobalValue(GlobalOrdinal globalRow, const Scalar &value)
Adds specified value to existing value at the specified location.
Definition: Xpetra_TpetraVector_def.hpp:92
Xpetra::TpetraVector::describe
void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const
Print the object with some verbosity level to an FancyOStream object.
Definition: Xpetra_TpetraVector_def.hpp:172
Xpetra::TpetraVector::TpetraVector
TpetraVector(const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node >> &map, bool zeroOut=true)
Sets all vector entries to zero.
Definition: Xpetra_TpetraVector_def.hpp:56
Xpetra::TpetraVector::normInf
Teuchos::ScalarTraits< Scalar >::magnitudeType normInf() const
Compute Inf-norm of this Vector.
Definition: Xpetra_TpetraVector_def.hpp:142
Xpetra_Vector.hpp
Xpetra_TpetraConfigDefs.hpp
Xpetra::TpetraVector::replaceLocalValue
void replaceLocalValue(LocalOrdinal myRow, const Scalar &value)
Replace current value at the specified location with specified values.
Definition: Xpetra_TpetraVector_def.hpp:102
Xpetra::TpetraVector
Definition: Xpetra_TpetraVector_decl.hpp:82
Xpetra::TpetraVector::norm2
Teuchos::ScalarTraits< Scalar >::magnitudeType norm2() const
Compute 2-norm of this Vector.
Definition: Xpetra_TpetraVector_def.hpp:132
Xpetra::TpetraVector::sumIntoLocalValue
void sumIntoLocalValue(LocalOrdinal myRow, const Scalar &value)
Adds specified value to existing value at the specified location.
Definition: Xpetra_TpetraVector_def.hpp:112
Xpetra::TpetraVector::~TpetraVector
virtual ~TpetraVector()
Destructor.
Definition: Xpetra_TpetraVector_def.hpp:74
Teuchos::ScalarTraits::magnitudeType
T magnitudeType
Xpetra::TpetraVector::meanValue
Scalar meanValue() const
Compute mean (average) value of this Vector.
Definition: Xpetra_TpetraVector_def.hpp:152
Xpetra::TpetraVector::getTpetra_Vector
RCP< Tpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > getTpetra_Vector() const
Get the underlying Tpetra multivector.
Definition: Xpetra_TpetraVector_def.hpp:212
Teuchos::Describable::verbLevel_default
static const EVerbosityLevel verbLevel_default
Xpetra::TpetraVector::norm1
Teuchos::ScalarTraits< Scalar >::magnitudeType norm1() const
Return 1-norm of this Vector.
Definition: Xpetra_TpetraVector_def.hpp:122
Generated by doxygen 1.8.20