Intrepid2
Intrepid2_HGRAD_TET_Cn_FEM.hpp
Go to the documentation of this file.
1 // @HEADER
2 // ************************************************************************
3 //
4 // Intrepid2 Package
5 // Copyright (2007) 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 Kyungjoo Kim (kyukim@sandia.gov), or
38 // Mauro Perego (mperego@sandia.gov)
39 //
40 // ************************************************************************
41 // @HEADER
42 
49 #ifndef __INTREPID2_HGRAD_TET_CN_FEM_HPP__
50 #define __INTREPID2_HGRAD_TET_CN_FEM_HPP__
51 
52 #include "Intrepid2_Basis.hpp"
54 
55 #include "Intrepid2_PointTools.hpp"
56 #include "Teuchos_LAPACK.hpp"
57 
58 
59 namespace Intrepid2 {
60 
86  namespace Impl {
87 
92  public:
93  typedef struct Tetrahedron<4> cell_topology_type;
97  template<EOperator opType>
98  struct Serial {
99  template<typename outputValueViewType,
100  typename inputPointViewType,
101  typename workViewType,
102  typename vinvViewType>
103  KOKKOS_INLINE_FUNCTION
104  static void
105  getValues( outputValueViewType outputValues,
106  const inputPointViewType inputPoints,
107  workViewType work,
108  const vinvViewType vinv );
109  };
110 
111  template<typename ExecSpaceType, ordinal_type numPtsPerEval,
112  typename outputValueValueType, class ...outputValueProperties,
113  typename inputPointValueType, class ...inputPointProperties,
114  typename vinvValueType, class ...vinvProperties>
115  static void
116  getValues( Kokkos::DynRankView<outputValueValueType,outputValueProperties...> outputValues,
117  const Kokkos::DynRankView<inputPointValueType, inputPointProperties...> inputPoints,
118  const Kokkos::DynRankView<vinvValueType, vinvProperties...> vinv,
119  const EOperator operatorType);
120 
124  template<typename outputValueViewType,
125  typename inputPointViewType,
126  typename vinvViewType,
127  typename workViewType,
128  EOperator opType,
129  ordinal_type numPtsEval>
130  struct Functor {
131  outputValueViewType _outputValues;
132  const inputPointViewType _inputPoints;
133  const vinvViewType _vinv;
134  workViewType _work;
135 
136  KOKKOS_INLINE_FUNCTION
137  Functor( outputValueViewType outputValues_,
138  inputPointViewType inputPoints_,
139  vinvViewType vinv_,
140  workViewType work_)
141  : _outputValues(outputValues_), _inputPoints(inputPoints_),
142  _vinv(vinv_), _work(work_) {}
143 
144  KOKKOS_INLINE_FUNCTION
145  void operator()(const size_type iter) const {
146  const auto ptBegin = Util<ordinal_type>::min(iter*numPtsEval, _inputPoints.extent(0));
147  const auto ptEnd = Util<ordinal_type>::min(ptBegin+numPtsEval, _inputPoints.extent(0));
148 
149  const auto ptRange = Kokkos::pair<ordinal_type,ordinal_type>(ptBegin, ptEnd);
150  const auto input = Kokkos::subview( _inputPoints, ptRange, Kokkos::ALL() );
151 
152  typename workViewType::pointer_type ptr = _work.data() + _work.extent(0)*ptBegin*get_dimension_scalar(_work);
153 
154  auto vcprop = Kokkos::common_view_alloc_prop(_work);
155  workViewType work(Kokkos::view_wrap(ptr,vcprop), (ptEnd-ptBegin)*_work.extent(0));
156 
157  switch (opType) {
158  case OPERATOR_VALUE : {
159  auto output = Kokkos::subview( _outputValues, Kokkos::ALL(), ptRange );
160  Serial<opType>::getValues( output, input, work, _vinv );
161  break;
162  }
163  case OPERATOR_GRAD :
164  case OPERATOR_D1 :
165  case OPERATOR_D2 :
166  //case OPERATOR_D3 :
167  {
168  auto output = Kokkos::subview( _outputValues, Kokkos::ALL(), ptRange, Kokkos::ALL() );
169  Serial<opType>::getValues( output, input, work, _vinv );
170  break;
171  }
172  default: {
173  INTREPID2_TEST_FOR_ABORT( true,
174  ">>> ERROR: (Intrepid2::Basis_HGRAD_TET_Cn_FEM::Functor) operator is not supported");
175 
176  }
177  }
178  }
179  };
180  };
181  }
182 
183  template<typename ExecSpaceType = void,
184  typename outputValueType = double,
185  typename pointValueType = double>
187  : public Basis<ExecSpaceType,outputValueType,pointValueType> {
188  public:
192 
197 
198  private:
199 
202  Kokkos::DynRankView<scalarType,ExecSpaceType> vinv_;
203 
204  public:
205 
208  Basis_HGRAD_TET_Cn_FEM(const ordinal_type order,
209  const EPointType pointType = POINTTYPE_EQUISPACED);
210 
211 
212 
214 
215  virtual
216  void
217  getValues( outputViewType outputValues,
218  const pointViewType inputPoints,
219  const EOperator operatorType = OPERATOR_VALUE) const {
220 #ifdef HAVE_INTREPID2_DEBUG
221  Intrepid2::getValues_HGRAD_Args(outputValues,
222  inputPoints,
223  operatorType,
224  this->getBaseCellTopology(),
225  this->getCardinality() );
226 #endif
227  constexpr ordinal_type numPtsPerEval = Parameters::MaxNumPtsPerBasisEval;
228  Impl::Basis_HGRAD_TET_Cn_FEM::
229  getValues<ExecSpaceType,numPtsPerEval>( outputValues,
230  inputPoints,
231  this->vinv_,
232  operatorType);
233  }
234 
235  virtual
236  void
237  getDofCoords( scalarViewType dofCoords ) const {
238 #ifdef HAVE_INTREPID2_DEBUG
239  // Verify rank of output array.
240  INTREPID2_TEST_FOR_EXCEPTION( dofCoords.rank() != 2, std::invalid_argument,
241  ">>> ERROR: (Intrepid2::Basis_HGRAD_TET_Cn_FEM::getDofCoords) rank = 2 required for dofCoords array");
242  // Verify 0th dimension of output array.
243  INTREPID2_TEST_FOR_EXCEPTION( static_cast<ordinal_type>(dofCoords.extent(0)) != this->getCardinality(), std::invalid_argument,
244  ">>> ERROR: (Intrepid2::Basis_HGRAD_TET_Cn_FEM::getDofCoords) mismatch in number of dof and 0th dimension of dofCoords array");
245  // Verify 1st dimension of output array.
246  INTREPID2_TEST_FOR_EXCEPTION( dofCoords.extent(1) != this->getBaseCellTopology().getDimension(), std::invalid_argument,
247  ">>> ERROR: (Intrepid2::Basis_HGRAD_TET_Cn_FEM::getDofCoords) incorrect reference cell (1st) dimension in dofCoords array");
248 #endif
249  Kokkos::deep_copy(dofCoords, this->dofCoords_);
250  }
251 
252  virtual
253  void
254  getDofCoeffs( scalarViewType dofCoeffs ) const {
255 #ifdef HAVE_INTREPID2_DEBUG
256  // Verify rank of output array.
257  INTREPID2_TEST_FOR_EXCEPTION( dofCoeffs.rank() != 1, std::invalid_argument,
258  ">>> ERROR: (Intrepid2::Basis_HGRAD_TET_Cn_FEM::getdofCoeffs) rank = 1 required for dofCoeffs array");
259  // Verify 0th dimension of output array.
260  INTREPID2_TEST_FOR_EXCEPTION( static_cast<ordinal_type>(dofCoeffs.extent(0)) != this->getCardinality(), std::invalid_argument,
261  ">>> ERROR: (Intrepid2::Basis_HGRAD_TET_Cn_FEM::getdofCoeffs) mismatch in number of dof and 0th dimension of dofCoeffs array");
262 #endif
263  Kokkos::deep_copy(dofCoeffs, 1.0);
264  }
265 
266 
267  void
268  getVandermondeInverse( scalarViewType vinv ) const {
269  // has to be same rank and dimensions
270  Kokkos::deep_copy(vinv, this->vinv_);
271  }
272 
273  virtual
274  const char*
275  getName() const {
276  return "Intrepid2_HGRAD_TET_Cn_FEM";
277  }
278 
279  virtual
280  bool
282  return (this->basisDegree_ > 2);
283  }
284 
285  Kokkos::DynRankView<typename scalarViewType::const_value_type,ExecSpaceType>
286  getVandermondeInverse() const {
287  return vinv_;
288  }
289 
290  ordinal_type
291  getWorkSizePerPoint(const EOperator operatorType) const {
292  auto cardinality = getPnCardinality<3>(this->basisDegree_);
293  switch (operatorType) {
294  case OPERATOR_GRAD:
295  case OPERATOR_CURL:
296  case OPERATOR_D1:
297  return 7*cardinality;
298  default:
299  return getDkCardinality(operatorType, 3)*cardinality;
300  }
301  }
302  };
303 
304 }// namespace Intrepid2
305 
307 
308 #endif
virtual const char * getName() const
Returns basis name.
small utility functions
virtual void getDofCoeffs(scalarViewType dofCoeffs) const
Coefficients for computing degrees of freedom for Lagrangian basis If P is an element of the space sp...
virtual void getValues(outputViewType outputValues, const pointViewType inputPoints, const EOperator operatorType=OPERATOR_VALUE) const
Evaluation of a FEM basis on a reference cell.
Kokkos::DynRankView< scalarType, Kokkos::LayoutStride, ExecSpaceType > scalarViewType
View type for scalars.
An abstract base class that defines interface for concrete basis implementations for Finite Element (...
Kokkos::DynRankView< outputValueType, Kokkos::LayoutStride, ExecSpaceType > outputViewType
View type for basis value output.
shards::CellTopology getBaseCellTopology() const
Returns the base cell topology for which the basis is defined. See Shards documentation https://trili...
Kokkos::DynRankView< scalarType, ExecSpaceType > dofCoords_
Coordinates of degrees-of-freedom for basis functions defined in physical space.
ordinal_type getCardinality() const
Returns cardinality of the basis.
Kokkos::View< ordinal_type ***, typename ExecSpaceType::array_layout, Kokkos::HostSpace > ordinal_type_array_3d_host
View type for 3d host array.
Basis_HGRAD_TET_Cn_FEM(const ordinal_type order, const EPointType pointType=POINTTYPE_EQUISPACED)
Constructor.
ordinal_type basisDegree_
Degree of the largest complete polynomial space that can be represented by the basis.
virtual bool requireOrientation() const
True if orientation is required.
static constexpr ordinal_type MaxNumPtsPerBasisEval
The maximum number of points to eval in serial mode.
Kokkos::View< ordinal_type *,typename ExecSpaceType::array_layout, Kokkos::HostSpace > ordinal_type_array_1d_host
View type for 1d host array.
Implementation of the default H(grad)-compatible Lagrange basis of arbitrary degree on Tetrahedron ce...
Kokkos::DynRankView< pointValueType, Kokkos::LayoutStride, ExecSpaceType > pointViewType
View type for input points.
See Intrepid2::Basis_HGRAD_TET_Cn_FEM.
Definition file for FEM basis functions of degree n for H(grad) functions on TET cells.
virtual void getDofCoords(scalarViewType dofCoords) const
Returns spatial locations (coordinates) of degrees of freedom on the reference cell.
Kokkos::DynRankView< scalarType, ExecSpaceType > vinv_
inverse of Generalized Vandermonde matrix, whose columns store the expansion coefficients of the noda...
ScalarTraits< pointValueType >::scalar_type scalarType
Scalar type for point values.
Header file for the Intrepid2::Basis_HGRAD_TET_Cn_FEM_ORTH class.
Header file for the abstract base class Intrepid2::Basis.
Kokkos::View< ordinal_type **,typename ExecSpaceType::array_layout, Kokkos::HostSpace > ordinal_type_array_2d_host
View type for 2d host array.
Header file for Intrepid2::PointTools class to provide utilities for barycentric coordinates, equispaced lattices, and warp-blend point distrubtions.