Tpetra parallel linear algebra Version of the Day
Tpetra_Details_getEntryOnHost.hpp
Go to the documentation of this file.
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_GETENTRYONHOST_HPP
43#define TPETRA_DETAILS_GETENTRYONHOST_HPP
44
50
51#include "TpetraCore_config.h"
52#include "Kokkos_Core.hpp"
53
54namespace Tpetra {
55namespace Details {
56
57template<class ViewType,
58 class IndexType>
59typename ViewType::non_const_value_type
60getEntryOnHost (const ViewType& x,
61 const IndexType ind)
62{
63 static_assert (ViewType::Rank == 1, "x must be a rank-1 Kokkos::View.");
64 // Get a 0-D subview of the entry of the array, and copy to host scalar.
65 typename ViewType::non_const_value_type val;
66 Kokkos::deep_copy(val, Kokkos::subview(x, ind));
67 return val;
68}
69
70template<class ViewType,
71 class IndexType>
72typename ViewType::HostMirror::const_type
73getEntriesOnHost (const ViewType& x,
74 const IndexType ind,
75 const int count)
76{
77 static_assert (ViewType::Rank == 1, "x must be a rank-1 Kokkos::View.");
78 // Get a 1-D subview of the entry of the array, and copy to host.
79 auto subview = Kokkos::subview(x, Kokkos::make_pair(ind, ind + count));
80 return Kokkos::create_mirror_view_and_copy(typename ViewType::HostMirror::memory_space(), subview);
81}
82
83} // namespace Details
84} // namespace Tpetra
85
86#endif // TPETRA_DETAILS_GETENTRYONHOST_HPP
Implementation details of Tpetra.
Namespace Tpetra contains the class and methods constituting the Tpetra library.
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.