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