Stokhos Package Browser (Single Doxygen Collection)  Version of the Day
Stokhos_KokkosViewFadMPVectorUnitTest.hpp
Go to the documentation of this file.
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Stokhos Package
5 // Copyright (2009) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
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 Eric T. Phipps (etphipp@sandia.gov).
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 #include "Teuchos_TestingHelpers.hpp"
43 #include "Teuchos_UnitTestHelpers.hpp"
45 
47 #include "Sacado.hpp"
48 #include "Sacado_Fad_MP_Vector.hpp"
49 
50 // For computing DeviceConfig
51 #include "Kokkos_Core.hpp"
52 
53 //
54 // Tests various View< Fad< Sacado::MP::Vector<...> >,...> operations work
55 // as expected
56 //
57 
58 // Helper functions
59 
60 template <typename scalar, typename ordinal>
61 inline
62 scalar generate_vector_coefficient( const ordinal nFEM,
63  const ordinal nStoch,
64  const ordinal iColFEM,
65  const ordinal iStoch )
66 {
67  const scalar X_fem = 100.0 + scalar(iColFEM) / scalar(nFEM);
68  const scalar X_stoch = 1.0 + scalar(iStoch) / scalar(nStoch);
69  return X_fem + X_stoch;
70  //return 1.0;
71 }
72 
73 template <typename ViewType>
74 bool
75 checkVectorView(const ViewType& v,
76  Teuchos::FancyOStream& out) {
77  typedef ViewType view_type;
78  typedef typename view_type::size_type size_type;
79  typedef typename view_type::HostMirror host_view_type;
80  typedef typename host_view_type::array_type host_array_type;
82 
83  // Copy to host
84  host_view_type h_v = Kokkos::create_mirror_view(v);
85  Kokkos::deep_copy(h_v, v);
86  host_array_type h_a = h_v;
87 
88  size_type num_rows, num_cols;
89 
90  // For static, layout left, sacado dimension becomes first dimension
91  // instead of last
92  bool is_right = Kokkos::Impl::is_same< typename ViewType::array_layout,
93  Kokkos::LayoutRight >::value;
94  if (is_right || !view_type::is_contiguous) {
95  num_rows = h_a.extent(0);
96  num_cols = h_a.extent(1);
97  }
98  else {
99  num_rows = h_a.extent(1);
100  num_cols = h_a.extent(0);
101  }
102  bool success = true;
103  if (is_right || !view_type::is_contiguous) {
104  for (size_type i=0; i<num_rows; ++i) {
105  for (size_type j=0; j<num_cols; ++j) {
106  scalar_type val = h_a(i,j);
107  scalar_type val_expected =
108  generate_vector_coefficient<scalar_type>(
109  num_rows, num_cols, i, j);
110  TEUCHOS_TEST_EQUALITY(val, val_expected, out, success);
111  }
112  }
113  }
114  else {
115  for (size_type i=0; i<num_rows; ++i) {
116  for (size_type j=0; j<num_cols; ++j) {
117  scalar_type val = h_a(j,i);
118  scalar_type val_expected =
119  generate_vector_coefficient<scalar_type>(
120  num_rows, num_cols, i, j);
121  TEUCHOS_TEST_EQUALITY(val, val_expected, out, success);
122  }
123  }
124  }
125 
126  return success;
127 }
128 
129 template <typename ViewType>
130 bool
131 checkConstantFadVectorView(const ViewType& view,
132  const typename ViewType::value_type& v,
133  Teuchos::FancyOStream& out) {
134  typedef ViewType view_type;
135  typedef typename view_type::value_type fad_vector_type;
136  typedef typename fad_vector_type::value_type vector_type;
137  typedef typename vector_type::storage_type storage_type;
138  typedef typename view_type::size_type size_type;
139  typedef typename view_type::HostMirror host_view_type;
140 
141  // Copy to host
142  host_view_type h_view = Kokkos::create_mirror_view(view);
143  Kokkos::deep_copy(h_view, view);
144 
145  const size_type num_rows = h_view.extent(0);
146  const size_type num_fad = Kokkos::dimension_scalar(h_view)-1;
147  const size_type num_ensemble = storage_type::static_size;
148  bool success = true;
149  for (size_type i=0; i<num_rows; ++i) {
150  for (size_type k=0; k<num_ensemble; ++k) {
151  TEUCHOS_TEST_EQUALITY(h_view(i).val().coeff(k), v.val().coeff(k), out, success);
152  for (size_type j=0; j<num_fad; ++j) {
153  TEUCHOS_TEST_EQUALITY(h_view(i).dx(j).coeff(k), v.dx(j).coeff(k), out, success);
154  }
155  }
156  }
157 
158  return success;
159 }
160 
161 template <typename ViewType>
162 bool
163 checkConstantFadVectorView2(const ViewType& view,
164  const typename ViewType::value_type& v,
165  Teuchos::FancyOStream& out) {
166  typedef ViewType view_type;
167  typedef typename view_type::value_type fad_vector_type;
168  typedef typename fad_vector_type::value_type vector_type;
169  typedef typename vector_type::storage_type storage_type;
170  typedef typename view_type::size_type size_type;
171  typedef typename view_type::HostMirror host_view_type;
172 
173  // Copy to host
174  host_view_type h_view = Kokkos::create_mirror_view(view);
175  Kokkos::deep_copy(h_view, view);
176 
177  bool success = true;
178  const size_type num_fad = Kokkos::dimension_scalar(h_view)-1;
179  const size_type num_ensemble = storage_type::static_size;
180  for (size_type i0=0; i0<h_view.extent(0); ++i0) {
181  for (size_type i1=0; i1<h_view.extent(1); ++i1) {
182  for (size_type i2=0; i2<h_view.extent(2); ++i2) {
183  for (size_type i3=0; i3<h_view.extent(3); ++i3) {
184  for (size_type i4=0; i4<h_view.extent(4); ++i4) {
185  for (size_type i5=0; i5<h_view.extent(5); ++i5) {
186  for (size_type i6=0; i6<h_view.extent(6); ++i6) {
187  for (size_type k=0; k<num_ensemble; ++k)
188  TEUCHOS_TEST_EQUALITY(h_view.access(i0,i1,i2,i3,i4,i5,i6,0).val().coeff(k),
189  v.val().coeff(k), out, success);
190  for (size_type j=0; j<num_fad; ++j) {
191  for (size_type k=0; k<num_ensemble; ++k)
192  TEUCHOS_TEST_EQUALITY(h_view.access(i0,i1,i2,i3,i4,i5,i6,0).dx(j).coeff(k),
193  v.dx(j).coeff(k), out, success);
194  }
195  }}}}}}}
196 
197  return success;
198 }
199 
200 template <typename DataType, typename LayoutType, typename ExecutionSpace>
201 struct ApplyView {
202  typedef Kokkos::View<DataType,LayoutType,ExecutionSpace> type;
203 };
204 
205 struct NoLayout {};
206 template <typename DataType, typename ExecutionSpace>
207 struct ApplyView<DataType,NoLayout,ExecutionSpace> {
208  typedef Kokkos::View<DataType,ExecutionSpace> type;
209 };
210 
211 //
212 // Tests
213 //
214 
215 const int global_num_rows = 11;
216 const int global_ensemble_size = 8;
217 const int global_fad_size = 5;
218 
219 TEUCHOS_UNIT_TEST_TEMPLATE_2_DECL( Kokkos_View_Fad_MP, Size, Scalar, Layout )
220 {
221  typedef typename Scalar::value_type Vector;
222  typedef typename Vector::execution_space Device;
223  typedef typename ApplyView<Scalar*,Layout,Device>::type ViewType;
224  typedef typename ViewType::size_type size_type;
225 
226  const size_type num_rows = global_num_rows;
227  const size_type num_cols = global_fad_size+1;
228  ViewType v("view", num_rows, num_cols);
229  TEUCHOS_TEST_EQUALITY(v.size(), num_rows, out, success);
230 }
231 
232 TEUCHOS_UNIT_TEST_TEMPLATE_2_DECL( Kokkos_View_Fad_MP, DeepCopy_ConstantScalar, Scalar, Layout )
233 {
234  typedef typename Scalar::value_type Vector;
235  typedef typename Vector::value_type BaseScalar;
236  typedef typename Vector::execution_space Device;
237  typedef typename ApplyView<Scalar*,Layout,Device>::type ViewType;
238  typedef typename ViewType::size_type size_type;
239 
240  const size_type num_rows = global_num_rows;
241  const size_type num_cols = global_fad_size+1;
242  ViewType v("view", num_rows, num_cols);
243  BaseScalar val = 1.2345;
244 
245  Kokkos::deep_copy( v, val );
246 
247  success = checkConstantFadVectorView(v, Scalar(val), out);
248 }
249 
250 TEUCHOS_UNIT_TEST_TEMPLATE_2_DECL( Kokkos_View_Fad_MP, Rank6, Scalar, Layout )
251 {
252  // Try and create a rank-6 view
253  typedef typename Scalar::value_type Vector;
254  typedef typename Vector::value_type BaseScalar;
255  typedef typename Vector::execution_space Device;
256  typedef typename ApplyView<Scalar******,Layout,Device>::type ViewType;
257 
258  ViewType v("view", 1, 2, 3, 4, 4, 3, global_fad_size+1);
259  BaseScalar val = 1.2345;
260 
261  Kokkos::deep_copy( v, val );
262 
263  success = checkConstantFadVectorView2(v, Scalar(val), out);
264 }
265 
266 #define VIEW_FAD_MP_VECTOR_TESTS_SCALAR_LAYOUT( SCALAR, LAYOUT ) \
267  TEUCHOS_UNIT_TEST_TEMPLATE_2_INSTANT( \
268  Kokkos_View_Fad_MP, Size, SCALAR, LAYOUT ) \
269  TEUCHOS_UNIT_TEST_TEMPLATE_2_INSTANT( \
270  Kokkos_View_Fad_MP, DeepCopy_ConstantScalar, SCALAR, LAYOUT ) \
271  TEUCHOS_UNIT_TEST_TEMPLATE_2_INSTANT( \
272  Kokkos_View_Fad_MP, Rank6, SCALAR, LAYOUT )
273 
274 #define VIEW_FAD_MP_VECTOR_TESTS_SCALAR( SCALAR ) \
275  using Kokkos::LayoutLeft; \
276  using Kokkos::LayoutRight; \
277  VIEW_FAD_MP_VECTOR_TESTS_SCALAR_LAYOUT(SCALAR, NoLayout) \
278  VIEW_FAD_MP_VECTOR_TESTS_SCALAR_LAYOUT(SCALAR, LayoutLeft) \
279  VIEW_FAD_MP_VECTOR_TESTS_SCALAR_LAYOUT(SCALAR, LayoutRight)
280 
281 #define VIEW_FAD_MP_VECTOR_TESTS_DEVICE( DEVICE ) \
282  typedef Stokhos::StaticFixedStorage<int,double,global_ensemble_size,DEVICE> SFS; \
283  typedef Sacado::MP::Vector< SFS > MP_SFS; \
284  typedef Sacado::Fad::DFad< MP_SFS > Fad_MP_SFS; \
285  VIEW_FAD_MP_VECTOR_TESTS_SCALAR( Fad_MP_SFS )
Stokhos::StandardStorage< int, double > storage_type
Kokkos::DefaultExecutionSpace execution_space
bool checkConstantFadVectorView2(const ViewType &view, const typename ViewType::value_type &v, Teuchos::FancyOStream &out)
bool checkVectorView(const ViewType &v, Teuchos::FancyOStream &out)
TEUCHOS_UNIT_TEST_TEMPLATE_2_DECL(Kokkos_View_Fad_MP, Size, Scalar, Layout)
KOKKOS_INLINE_FUNCTION constexpr std::enable_if< is_view_uq_pce< View< T, P... > >::value, unsigned >::type dimension_scalar(const View< T, P... > &view)
void deep_copy(const Stokhos::CrsMatrix< ValueType, DstDevice, Layout > &dst, const Stokhos::CrsMatrix< ValueType, SrcDevice, Layout > &src)
expr expr expr dx(i, j)
expr val()
SparseArrayIterator< index_iterator, value_iterator >::value_reference value(const SparseArrayIterator< index_iterator, value_iterator > &it)
bool checkConstantFadVectorView(const ViewType &view, const typename ViewType::value_type &v, Teuchos::FancyOStream &out)
pce_type Scalar
Kokkos::View< DataType, LayoutType, ExecutionSpace > type
scalar generate_vector_coefficient(const ordinal nFEM, const ordinal nStoch, const ordinal iColFEM, const ordinal iStoch)
Stokhos::CrsMatrix< ValueType, Device, Layout >::HostMirror create_mirror_view(const Stokhos::CrsMatrix< ValueType, Device, Layout > &A)