Tpetra parallel linear algebra  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Tpetra_Details_DualViewUtil.hpp
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Tpetra: Templated Linear Algebra Services Package
5 // Copyright (2008) Sandia Corporation
6 //
7 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
8 // the U.S. Government retains certain rights in this software.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38 //
39 // ************************************************************************
40 // @HEADER
41 
42 #ifndef TPETRA_DETAILS_DUALVIEWUTIL_HPP
43 #define TPETRA_DETAILS_DUALVIEWUTIL_HPP
44 
45 #include "TpetraCore_config.h"
46 #include "Kokkos_DualView.hpp"
47 #include "Teuchos_ArrayView.hpp"
48 #include <ostream>
49 #include <string>
50 
52 namespace Tpetra {
53 
56 namespace Details {
57 
61 auto view_alloc_no_init (const std::string& label) ->
62  decltype (Kokkos::view_alloc (label, Kokkos::WithoutInitializing));
63 
68 template<class ElementType, class DeviceType>
69 void
71  (Kokkos::DualView<ElementType*, DeviceType>& dv,
72  const typename Kokkos::DualView<ElementType*, DeviceType>::t_host& hostView)
73 {
74  using dual_view_type = Kokkos::DualView<ElementType*, DeviceType>;
75 
76  if (dv.extent (0) == hostView.extent (0)) {
77  // We don't need to reallocate the device View.
78  dv.clear_sync_state ();
79  dv.modify_host ();
80  dv.h_view = hostView;
81  dv.sync_device ();
82  }
83  else {
84  auto devView = Kokkos::create_mirror_view (DeviceType (), hostView);
85  Kokkos::deep_copy (devView, hostView);
86  dv = dual_view_type (devView, hostView);
87  }
88 }
89 
90 template<class ElementType, class DeviceType>
91 void
92 makeDualViewFromArrayView (Kokkos::DualView<ElementType*, DeviceType>& dv,
93  const Teuchos::ArrayView<const ElementType>& av,
94  const std::string& label)
95 {
96  using dual_view_type = Kokkos::DualView<ElementType*, DeviceType>;
97  using host_view_type = typename dual_view_type::t_host;
98  using const_host_view_type = typename host_view_type::const_type;
99 
100  const auto size = av.size ();
101  const ElementType* ptr = (size == 0) ? nullptr : av.getRawPtr ();
102  const_host_view_type inView (ptr, size);
103  host_view_type hostView (view_alloc_no_init (label), size);
104  Kokkos::deep_copy (hostView, inView);
105 
106  makeDualViewFromOwningHostView (dv, hostView);
107 }
108 
109 template<class ElementType, class DeviceType>
110 void
111 makeDualViewFromVector (Kokkos::DualView<ElementType*, DeviceType>& dv,
112  const std::vector<ElementType>& vec,
113  const std::string& label)
114 {
115  using dual_view_type = Kokkos::DualView<ElementType*, DeviceType>;
116  using host_view_type = typename dual_view_type::t_host;
117  using const_host_view_type = typename host_view_type::const_type;
118 
119  const auto size = vec.size ();
120  const ElementType* ptr = (size == 0) ? nullptr : vec.data ();
121  const_host_view_type inView (ptr, size);
122  host_view_type hostView (view_alloc_no_init (label), size);
123  Kokkos::deep_copy (hostView, inView);
124 
125  makeDualViewFromOwningHostView (dv, hostView);
126 }
127 
128 template<class ElementType, class DeviceType>
129 void
130 printDualView (std::ostream& out,
131  const Kokkos::DualView<ElementType*, DeviceType>& dv,
132  const std::string& name)
133 {
134  out << name << ": ";
135  const size_t size = size_t (dv.extent (0));
136  const auto hostView = dv.view_host ();
137 
138  out << "[";
139  for (size_t k = 0; k < size; ++k) {
140  out << hostView[k];
141  if (k + size_t (1) < size) {
142  out << ",";
143  }
144  }
145  out << "]";
146 }
147 
148 } // namespace Details
149 
150 } // namespace Tpetra
151 
152 #endif // TPETRA_DETAILS_DUALVIEWUTIL_HPP
void deep_copy(MultiVector< DS, DL, DG, DN > &dst, const MultiVector< SS, SL, SG, SN > &src)
Copy the contents of the MultiVector src into dst.
auto view_alloc_no_init(const std::string &label) ->
Use in place of the string label as the first argument of Kokkos::View&#39;s constructor, in case you want to allocate without initializing.
void makeDualViewFromOwningHostView(Kokkos::DualView< ElementType *, DeviceType > &dv, const typename Kokkos::DualView< ElementType *, DeviceType >::t_host &hostView)
Initialize dv such that its host View is hostView.