Tpetra parallel linear algebra Version of the Day
Loading...
Searching...
No Matches
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
52namespace Tpetra {
53
56namespace Details {
57
61auto view_alloc_no_init (const std::string& label) ->
62 decltype (Kokkos::view_alloc (label, Kokkos::WithoutInitializing));
63
68template<class ElementType, class DeviceType>
69void
71 (Kokkos::DualView<ElementType*, DeviceType>& dv,
72 const typename Kokkos::DualView<ElementType*, DeviceType>::t_host& hostView)
73{
74 using execution_space = typename DeviceType::execution_space;
75 using dual_view_type = Kokkos::DualView<ElementType*, DeviceType>;
76
77 if (dv.extent (0) == hostView.extent (0)) {
78 // We don't need to reallocate the device View.
79 dv.clear_sync_state ();
80 dv.modify_host ();
81 dv.h_view = hostView;
82 dv.sync_device ();
83 }
84 else {
85 auto devView = Kokkos::create_mirror_view (DeviceType (), hostView);
86 // DEEP_COPY REVIEW - DEVICE-TO-HOSTMIRROR
87 Kokkos::deep_copy (execution_space(), devView, hostView);
88 dv = dual_view_type (devView, hostView);
89 }
90}
91
92template<class ElementType, class DeviceType>
93void
94makeDualViewFromArrayView (Kokkos::DualView<ElementType*, DeviceType>& dv,
95 const Teuchos::ArrayView<const ElementType>& av,
96 const std::string& label)
97{
98 using execution_space = typename DeviceType::execution_space;
99 using dual_view_type = Kokkos::DualView<ElementType*, DeviceType>;
100 using host_view_type = typename dual_view_type::t_host;
101 using const_host_view_type = typename host_view_type::const_type;
102
103 const auto size = av.size ();
104 const ElementType* ptr = (size == 0) ? nullptr : av.getRawPtr ();
106 host_view_type hostView (view_alloc_no_init (label), size);
107 // DEEP_COPY REVIEW - DEVICE-TO-HOSTMIRROR
108 Kokkos::deep_copy (execution_space(), hostView, inView);
109
111}
112
113template<class ElementType, class DeviceType>
114void
115makeDualViewFromVector (Kokkos::DualView<ElementType*, DeviceType>& dv,
116 const std::vector<ElementType>& vec,
117 const std::string& label)
118{
119 using dual_view_type = Kokkos::DualView<ElementType*, DeviceType>;
120 using execution_space = typename DeviceType::execution_space;
121 using host_view_type = typename dual_view_type::t_host;
122 using const_host_view_type = typename host_view_type::const_type;
123
124 const auto size = vec.size ();
125 const ElementType* ptr = (size == 0) ? nullptr : vec.data ();
126 const_host_view_type inView (ptr, size);
127 host_view_type hostView (view_alloc_no_init (label), size);
128 // DEEP_COPY REVIEW - DEVICE-TO-HOSTMIRROR
129 Kokkos::deep_copy (execution_space(), hostView, inView);
130
131 makeDualViewFromOwningHostView (dv, hostView);
132}
133
134template<class ElementType, class DeviceType>
135void
136printDualView (std::ostream& out,
137 const Kokkos::DualView<ElementType*, DeviceType>& dv,
138 const std::string& name)
139{
140 out << name << ": ";
141 const size_t size = size_t (dv.extent (0));
142 const auto hostView = dv.view_host ();
143
144 out << "[";
145 for (size_t k = 0; k < size; ++k) {
146 out << hostView[k];
147 if (k + size_t (1) < size) {
148 out << ",";
149 }
150 }
151 out << "]";
152}
153
154} // namespace Details
155
156} // namespace Tpetra
157
158#endif // TPETRA_DETAILS_DUALVIEWUTIL_HPP
Struct that holds views of the contents of a CrsMatrix.
Implementation details of Tpetra.
auto view_alloc_no_init(const std::string &label) -> decltype(Kokkos::view_alloc(label, Kokkos::WithoutInitializing))
Use in place of the string label as the first argument of Kokkos::View's constructor,...
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.
Namespace Tpetra contains the class and methods constituting the Tpetra library.