Xpetra  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Xpetra_Vector.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_VECTOR_HPP
47 #define XPETRA_VECTOR_HPP
48 
49 /* this file is automatically generated - do not edit (see script/interfaces.py) */
50 
51 #include "Xpetra_ConfigDefs.hpp"
52 #include "Xpetra_MultiVector.hpp"
53 
54 namespace Xpetra {
55 
56  template <class Scalar,
57  class LocalOrdinal,
58  class GlobalOrdinal,
60  class Vector
61  : public virtual MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >
62  {
63 
64  public:
65 
66  using scalar_type = Scalar;
67  using local_ordinal_type = LocalOrdinal;
68  using global_ordinal_type = GlobalOrdinal;
69  using node_type = Node;
70 
71 
81 
82 #ifdef HAVE_XPETRA_KOKKOS_REFACTOR
83 
85 
88 
99  template<class TargetDeviceType>
100  typename Kokkos::Impl::if_c<
101  std::is_same<
102  typename dual_view_type::t_dev_um::execution_space::memory_space,
103  typename TargetDeviceType::memory_space>::value,
104  typename dual_view_type::t_dev_um,
105  typename dual_view_type::t_host_um>::type
106  getLocalView () const {
107  return this->MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::template getLocalView<TargetDeviceType>();
108  }
109 #endif
110 
112 
113 
115  virtual ~Vector() { }
116 
118 
120 
121 
123  virtual void replaceGlobalValue(GlobalOrdinal globalRow, const Scalar &value)= 0;
124 
126  virtual void sumIntoGlobalValue(GlobalOrdinal globalRow, const Scalar &value)= 0;
127 
129  virtual void replaceLocalValue(LocalOrdinal myRow, const Scalar &value)= 0;
130 
132  virtual void sumIntoLocalValue(LocalOrdinal myRow, const Scalar &value)= 0;
133 
135 
137 
138 
140  virtual Scalar dot(const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &a) const = 0;
141 
143  virtual typename Teuchos::ScalarTraits< Scalar >::magnitudeType norm1() const = 0;
144 
146  virtual typename Teuchos::ScalarTraits< Scalar >::magnitudeType norm2() const = 0;
147 
149  virtual typename Teuchos::ScalarTraits< Scalar >::magnitudeType normInf() const = 0;
150 
152  virtual Scalar meanValue() const = 0;
153 
155 
157 
158 
160  virtual std::string description() const = 0;
161 
163  virtual void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const = 0;
164 
166 
167  }; // Vector class
168 } // Xpetra namespace
169 
170 #define XPETRA_VECTOR_SHORT
171 #endif // XPETRA_VECTOR_HPP
virtual Teuchos::ScalarTraits< Scalar >::magnitudeType norm1() const =0
Return 1-norm of this Vector.
virtual Teuchos::ScalarTraits< Scalar >::magnitudeType norm2() const =0
Compute 2-norm of this Vector.
virtual void replaceGlobalValue(GlobalOrdinal globalRow, const Scalar &value)=0
Replace current value at the specified location with specified value.
virtual Teuchos::ScalarTraits< Scalar >::magnitudeType normInf() const =0
Compute Inf-norm of this Vector.
virtual void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const =0
Print the object with some verbosity level to an FancyOStream object.
virtual Scalar dot(const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &a) const =0
Computes dot product of this Vector against input Vector x.
virtual Scalar meanValue() const =0
Compute mean (average) value of this Vector.
virtual void sumIntoLocalValue(LocalOrdinal myRow, const Scalar &value)=0
Adds specified value to existing value at the specified location.
virtual std::string description() const =0
Return a simple one-line description of this object.
virtual void sumIntoGlobalValue(GlobalOrdinal globalRow, const Scalar &value)=0
Adds specified value to existing value at the specified location.
virtual void replaceLocalValue(LocalOrdinal myRow, const Scalar &value)=0
Replace current value at the specified location with specified values.
virtual ~Vector()
Destructor.