Xpetra Version of the Day
Loading...
Searching...
No Matches
Xpetra_MultiVector_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_MULTIVECTOR_DECL_HPP
47#define XPETRA_MULTIVECTOR_DECL_HPP
48
49
50#include <Teuchos_LabeledObject.hpp>
53#include <Teuchos_Range1D.hpp>
54
55#include "Xpetra_ConfigDefs.hpp"
56#include "Xpetra_DistObject.hpp"
57#include "Xpetra_Map_decl.hpp"
58
59#include "Xpetra_Access.hpp"
60
61 #include <Kokkos_Core.hpp>
62 #include <Kokkos_DualView.hpp>
63 #include <Kokkos_ArithTraits.hpp>
64
65namespace Xpetra {
66
67
68#ifndef DOXYGEN_SHOULD_SKIP_THIS
69// forward declaration of Vector, needed to prevent circular inclusions
70template<class S, class LO, class GO, class N> class Vector;
71#endif
72
73
74template<class Scalar,
75 class LocalOrdinal,
76 class GlobalOrdinal,
79 : public DistObject<Scalar, LocalOrdinal, GlobalOrdinal, Node>
80{
81
82 public:
83
84 typedef Scalar scalar_type;
85 typedef LocalOrdinal local_ordinal_type;
86 typedef GlobalOrdinal global_ordinal_type;
87 typedef Node node_type;
88
90
91
93 virtual ~MultiVector();
94
95
108
109
111
113
114
116 virtual void replaceGlobalValue(GlobalOrdinal globalRow, size_t vectorIndex, const Scalar& value) = 0;
117
118
120 virtual void sumIntoGlobalValue(GlobalOrdinal globalRow, size_t vectorIndex, const Scalar& value) = 0;
121
122
124 virtual void replaceLocalValue(LocalOrdinal myRow, size_t vectorIndex, const Scalar& value) = 0;
125
126
128 virtual void sumIntoLocalValue(LocalOrdinal myRow, size_t vectorIndex, const Scalar& value) = 0;
129
130
132 virtual void putScalar(const Scalar& value) = 0;
133
134
136
138
139
140
143
144
147
148
150 virtual Teuchos::ArrayRCP<const Scalar> getData(size_t j) const = 0;
151
152
155
156
158
160
161
162
165
166
169
170
173
174
176 virtual void scale(const Scalar& alpha) = 0;
177
178
181
182
184 virtual void update(const Scalar& alpha, const MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& A, const Scalar& beta) = 0;
185
186
188 virtual void update(const Scalar& alpha, const MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& A,
190 const Scalar& gamma) = 0;
191
192
194 virtual void norm1(const Teuchos::ArrayView<typename Teuchos::ScalarTraits<Scalar>::magnitudeType>& norms) const = 0;
195
196
198 virtual void norm2(const Teuchos::ArrayView<typename Teuchos::ScalarTraits<Scalar>::magnitudeType>& norms) const = 0;
199
200
202 virtual void normInf(const Teuchos::ArrayView<typename Teuchos::ScalarTraits<Scalar>::magnitudeType>& norms) const = 0;
203
204
207 virtual void meanValue(const Teuchos::ArrayView<Scalar>& means) const = 0;
208
209
211 virtual void multiply(Teuchos::ETransp transA,
212 Teuchos::ETransp transB,
213 const Scalar& alpha,
216 const Scalar& beta) = 0;
217
218
246 virtual void elementWiseMultiply(Scalar scalarAB,
249 Scalar scalarThis) = 0;
250
251
253
255
256
257
259 virtual size_t getNumVectors() const = 0;
260
261
263 virtual size_t getLocalLength() const = 0;
264
265
267 virtual global_size_t getGlobalLength() const = 0;
268
269
270 // \brief Checks to see if the local length, number of vectors and size of Scalar type match
272
273
275
277
278
279
281 virtual std::string description() const = 0;
282
283
286
287
288 virtual void replaceMap(const RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>>& map) = 0;
289
290
292
294
295
296
298 virtual void setSeed(unsigned int seed) = 0;
299
300
302 virtual void randomize(bool bUseXpetraImplementation = false) = 0;
303
305 virtual void randomize(const Scalar& minVal, const Scalar& maxVal, bool bUseXpetraImplementation = false) = 0;
306
308 virtual void Xpetra_randomize();
309
311 virtual void Xpetra_randomize(const Scalar& minVal, const Scalar& maxVal);
312
313
314 using impl_scalar_type = typename Kokkos::Details::ArithTraits<Scalar>::val_type;
315 using dual_view_type = Kokkos::DualView<impl_scalar_type**, Kokkos::LayoutStride, typename node_type::device_type, Kokkos::MemoryUnmanaged>;
316 using dual_view_type_const = Kokkos::DualView<const impl_scalar_type**, Kokkos::LayoutStride, typename node_type::device_type, Kokkos::MemoryUnmanaged>;
317 using host_execution_space = typename dual_view_type::host_mirror_space;
318 using dev_execution_space = typename dual_view_type::t_dev::execution_space;
319
320 virtual typename dual_view_type::t_host_const_um getHostLocalView (Access::ReadOnlyStruct) const
321 {
322 throw std::runtime_error("Dummy function getHostLocalView, should be overwritten at"+std::string(__FILE__)+":"+std::to_string(__LINE__));
323#ifndef __NVCC__
324 typename dual_view_type::t_host_um test;
325#endif
327 }
328
329
330 virtual typename dual_view_type::t_dev_const_um getDeviceLocalView(Access::ReadOnlyStruct) const
331 {
332 throw std::runtime_error("Dummy function getHostLocalView, should be overwritten at"+std::string(__FILE__)+":"+std::to_string(__LINE__));
333#ifndef __NVCC__
334 typename dual_view_type::t_dev_um test;
335#endif
337 }
338
339 virtual typename dual_view_type::t_host_um getHostLocalView (Access::OverwriteAllStruct) const
340 {
341 throw std::runtime_error("Dummy function getHostLocalView, should be overwritten at"+std::string(__FILE__)+":"+std::to_string(__LINE__));
342#ifndef __NVCC__
343 typename dual_view_type::t_host_um test;
344#endif
346 }
347
348
349 virtual typename dual_view_type::t_dev_um getDeviceLocalView(Access::OverwriteAllStruct) const
350 {
351 throw std::runtime_error("Dummy function getHostLocalView, should be overwritten at"+std::string(__FILE__)+":"+std::to_string(__LINE__));
352#ifndef __NVCC__
353 typename dual_view_type::t_dev_um test;
354#endif
356 }
357
358 virtual typename dual_view_type::t_host_um getHostLocalView (Access::ReadWriteStruct) const
359 {
360 throw std::runtime_error("Dummy function getHostLocalView, should be overwritten at"+std::string(__FILE__)+":"+std::to_string(__LINE__));
361#ifndef __NVCC__
362 typename dual_view_type::t_host_um test;
363#endif
365 }
366
367
368 virtual typename dual_view_type::t_dev_um getDeviceLocalView(Access::ReadWriteStruct) const
369 {
370 throw std::runtime_error("Dummy function getHostLocalView, should be overwritten at"+std::string(__FILE__)+":"+std::to_string(__LINE__));
371#ifndef __NVCC__
372 typename dual_view_type::t_dev_um test;
373#endif
375 }
376
377
379
380
381 protected:
382
383
390
391
392}; // MultiVector class
393
394} // namespace Xpetra
395
396#define XPETRA_MULTIVECTOR_SHORT
397
398#endif // XPETRA_MULTIVECTOR_DECL_HPP
static const EVerbosityLevel verbLevel_default
virtual void replaceGlobalValue(GlobalOrdinal globalRow, size_t vectorIndex, const Scalar &value)=0
Replace value, using global (row) index.
virtual void randomize(const Scalar &minVal, const Scalar &maxVal, bool bUseXpetraImplementation=false)=0
Set multi-vector values to random numbers.
virtual size_t getNumVectors() const =0
Number of columns in the multivector.
Kokkos::DualView< const impl_scalar_type **, Kokkos::LayoutStride, typename node_type::device_type, Kokkos::MemoryUnmanaged > dual_view_type_const
virtual void putScalar(const Scalar &value)=0
Set all values in the multivector with the given value.
virtual dual_view_type::t_dev_um getDeviceLocalView(Access::ReadWriteStruct) const
typename Kokkos::Details::ArithTraits< Scalar >::val_type impl_scalar_type
virtual void replaceMap(const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &map)=0
virtual Teuchos::ArrayRCP< const Scalar > getData(size_t j) const =0
Const view of the local values in a particular vector of this multivector.
virtual void norm1(const Teuchos::ArrayView< typename Teuchos::ScalarTraits< Scalar >::magnitudeType > &norms) const =0
Compute 1-norm of each vector in multi-vector.
typename dual_view_type::t_dev::execution_space dev_execution_space
virtual void abs(const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A)=0
Put element-wise absolute values of input Multi-vector in target: A = abs(this).
virtual dual_view_type::t_host_um getHostLocalView(Access::OverwriteAllStruct) const
virtual void reciprocal(const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A)=0
Put element-wise reciprocal values of input Multi-vector in target, this(i,j) = 1/A(i,...
virtual dual_view_type::t_host_um getHostLocalView(Access::ReadWriteStruct) const
typename dual_view_type::host_mirror_space host_execution_space
MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > & operator=(const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &rhs)
Assignment operator: Does a deep copy.
virtual void multiply(Teuchos::ETransp transA, Teuchos::ETransp transB, const Scalar &alpha, const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A, const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &B, const Scalar &beta)=0
Matrix-matrix multiplication: this = beta*this + alpha*op(A)*op(B).
virtual void sumIntoLocalValue(LocalOrdinal myRow, size_t vectorIndex, const Scalar &value)=0
Add value to existing value, using local (row) index.
virtual Teuchos::RCP< Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > getVectorNonConst(size_t j)=0
Return a Vector which is a nonconst view of column j.
virtual size_t getLocalLength() const =0
Local number of rows on the calling process.
virtual void update(const Scalar &alpha, const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A, const Scalar &beta, const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &B, const Scalar &gamma)=0
Update multi-vector with scaled values of A and B, this = gamma*this + alpha*A + beta*B.
virtual Teuchos::RCP< const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > getVector(size_t j) const =0
Return a Vector which is a const view of column j.
virtual void scale(Teuchos::ArrayView< const Scalar > alpha)=0
Scale the current values of a multi-vector, this[j] = alpha[j]*this[j].
virtual void sumIntoGlobalValue(GlobalOrdinal globalRow, size_t vectorIndex, const Scalar &value)=0
Add value to existing value, using global (row) index.
virtual dual_view_type::t_dev_const_um getDeviceLocalView(Access::ReadOnlyStruct) const
virtual void randomize(bool bUseXpetraImplementation=false)=0
Set multi-vector values to random numbers.
virtual void normInf(const Teuchos::ArrayView< typename Teuchos::ScalarTraits< Scalar >::magnitudeType > &norms) const =0
Compute Inf-norm of each vector in multi-vector.
virtual void norm2(const Teuchos::ArrayView< typename Teuchos::ScalarTraits< Scalar >::magnitudeType > &norms) const =0
virtual void Xpetra_randomize()
Set multi-vector values to random numbers. XPetra implementation.
Kokkos::DualView< impl_scalar_type **, Kokkos::LayoutStride, typename node_type::device_type, Kokkos::MemoryUnmanaged > dual_view_type
virtual void scale(const Scalar &alpha)=0
Scale the current values of a multi-vector, this = alpha*this.
virtual std::string description() const =0
A simple one-line description of this object.
virtual void assign(const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &rhs)=0
Implementation of the assignment operator (operator=); does a deep copy.
virtual void dot(const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A, const Teuchos::ArrayView< Scalar > &dots) const =0
Compute dot product of each corresponding pair of vectors, dots[i] = this[i].dot(A[i]).
virtual void update(const Scalar &alpha, const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A, const Scalar &beta)=0
Update multi-vector values with scaled values of A, this = beta*this + alpha*A.
virtual void meanValue(const Teuchos::ArrayView< Scalar > &means) const =0
virtual dual_view_type::t_dev_um getDeviceLocalView(Access::OverwriteAllStruct) const
virtual void elementWiseMultiply(Scalar scalarAB, const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A, const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &B, Scalar scalarThis)=0
Multiply a Vector A elementwise by a MultiVector B.
virtual ~MultiVector()
Destructor.
virtual void setSeed(unsigned int seed)=0
Set seed for Random function.
virtual void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const =0
Print the object with the given verbosity level to a FancyOStream.
virtual Teuchos::ArrayRCP< Scalar > getDataNonConst(size_t j)=0
View of the local values in a particular vector of this multivector.
virtual dual_view_type::t_host_const_um getHostLocalView(Access::ReadOnlyStruct) const
virtual global_size_t getGlobalLength() const =0
Global number of rows in the multivector.
virtual void replaceLocalValue(LocalOrdinal myRow, size_t vectorIndex, const Scalar &value)=0
Replace value, using local (row) index.
virtual bool isSameSize(const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &vec) const =0
#define TEUCHOS_UNREACHABLE_RETURN(dummyReturnVal)
Xpetra namespace
size_t global_size_t
Global size_t object.