Intrepid2
Intrepid2_HVOL_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 
48 #ifndef __INTREPID2_HVOL_TET_CN_FEM_HPP__
49 #define __INTREPID2_HVOL_TET_CN_FEM_HPP__
50 
51 #include "Intrepid2_Basis.hpp"
52 
53 #include "Intrepid2_PointTools.hpp"
54 #include "Teuchos_LAPACK.hpp"
55 
56 
57 namespace Intrepid2 {
58 
74  namespace Impl {
75 
79  class Basis_HVOL_TET_Cn_FEM {
80  public:
81  typedef struct Tetrahedron<4> cell_topology_type;
85  template<EOperator opType>
86  struct Serial {
87  template<typename outputValueViewType,
88  typename inputPointViewType,
89  typename workViewType,
90  typename vinvViewType>
91  KOKKOS_INLINE_FUNCTION
92  static void
93  getValues( outputValueViewType outputValues,
94  const inputPointViewType inputPoints,
95  workViewType work,
96  const vinvViewType vinv );
97 
98 
99  KOKKOS_INLINE_FUNCTION
100  static ordinal_type
101  getWorkSizePerPoint(ordinal_type order) {
102  auto cardinality = getPnCardinality<3>(order);
103  switch (opType) {
104  case OPERATOR_GRAD:
105  case OPERATOR_CURL:
106  case OPERATOR_D1:
107  return 7*cardinality;
108  default:
109  return getDkCardinality<opType,3>()*cardinality;
110  }
111  }
112  };
113 
114  template<typename ExecSpaceType, ordinal_type numPtsPerEval,
115  typename outputValueValueType, class ...outputValueProperties,
116  typename inputPointValueType, class ...inputPointProperties,
117  typename vinvValueType, class ...vinvProperties>
118  static void
119  getValues( Kokkos::DynRankView<outputValueValueType,outputValueProperties...> outputValues,
120  const Kokkos::DynRankView<inputPointValueType, inputPointProperties...> inputPoints,
121  const Kokkos::DynRankView<vinvValueType, vinvProperties...> vinv,
122  const EOperator operatorType);
123 
127  template<typename outputValueViewType,
128  typename inputPointViewType,
129  typename vinvViewType,
130  typename workViewType,
131  EOperator opType,
132  ordinal_type numPtsEval>
133  struct Functor {
134  outputValueViewType _outputValues;
135  const inputPointViewType _inputPoints;
136  const vinvViewType _vinv;
137  workViewType _work;
138 
139  KOKKOS_INLINE_FUNCTION
140  Functor( outputValueViewType outputValues_,
141  inputPointViewType inputPoints_,
142  vinvViewType vinv_,
143  workViewType work_)
144  : _outputValues(outputValues_), _inputPoints(inputPoints_),
145  _vinv(vinv_), _work(work_) {}
146 
147  KOKKOS_INLINE_FUNCTION
148  void operator()(const size_type iter) const {
149  const auto ptBegin = Util<ordinal_type>::min(iter*numPtsEval, _inputPoints.extent(0));
150  const auto ptEnd = Util<ordinal_type>::min(ptBegin+numPtsEval, _inputPoints.extent(0));
151 
152  const auto ptRange = Kokkos::pair<ordinal_type,ordinal_type>(ptBegin, ptEnd);
153  const auto input = Kokkos::subview( _inputPoints, ptRange, Kokkos::ALL() );
154 
155  typename workViewType::pointer_type ptr = _work.data() + _work.extent(0)*ptBegin*get_dimension_scalar(_work);
156 
157  auto vcprop = Kokkos::common_view_alloc_prop(_work);
158  workViewType work(Kokkos::view_wrap(ptr,vcprop), (ptEnd-ptBegin)*_work.extent(0));
159 
160  switch (opType) {
161  case OPERATOR_VALUE : {
162  auto output = Kokkos::subview( _outputValues, Kokkos::ALL(), ptRange );
163  Serial<opType>::getValues( output, input, work, _vinv );
164  break;
165  }
166  case OPERATOR_GRAD :
167  case OPERATOR_D1 :
168  case OPERATOR_D2 :
169  //case OPERATOR_D3 :
170  {
171  auto output = Kokkos::subview( _outputValues, Kokkos::ALL(), ptRange, Kokkos::ALL() );
172  Serial<opType>::getValues( output, input, work, _vinv );
173  break;
174  }
175  default: {
176  INTREPID2_TEST_FOR_ABORT( true,
177  ">>> ERROR: (Intrepid2::Basis_HVOL_TET_Cn_FEM::Functor) operator is not supported");
178 
179  }
180  }
181  }
182  };
183  };
184  }
185 
186  template<typename ExecSpaceType = void,
187  typename outputValueType = double,
188  typename pointValueType = double>
189  class Basis_HVOL_TET_Cn_FEM
190  : public Basis<ExecSpaceType,outputValueType,pointValueType> {
191  public:
192  using OrdinalTypeArray1DHost = typename Basis<ExecSpaceType,outputValueType,pointValueType>::OrdinalTypeArray1DHost;
193  using OrdinalTypeArray2DHost = typename Basis<ExecSpaceType,outputValueType,pointValueType>::OrdinalTypeArray2DHost;
194  using OrdinalTypeArray3DHost = typename Basis<ExecSpaceType,outputValueType,pointValueType>::OrdinalTypeArray3DHost;
195 
196  using ordinal_type_array_1d_host INTREPID2_DEPRECATED_TYPENAME_REPLACEMENT("use OrdinalTypeArray1DHost instead","OrdinalTypeArray1DHost") = OrdinalTypeArray1DHost INTREPID2_DEPRECATED_TYPENAME_TRAILING_ATTRIBUTE("use OrdinalTypeArray1DHost instead");
197  using ordinal_type_array_2d_host INTREPID2_DEPRECATED_TYPENAME_REPLACEMENT("use OrdinalTypeArray2DHost instead","OrdinalTypeArray2DHost") = OrdinalTypeArray2DHost INTREPID2_DEPRECATED_TYPENAME_TRAILING_ATTRIBUTE("use OrdinalTypeArray2DHost instead");
198  using ordinal_type_array_3d_host INTREPID2_DEPRECATED_TYPENAME_REPLACEMENT("use OrdinalTypeArray3DHost instead","OrdinalTypeArray3DHost") = OrdinalTypeArray3DHost INTREPID2_DEPRECATED_TYPENAME_TRAILING_ATTRIBUTE("use OrdinalTypeArray3DHost instead");
199 
202  Basis_HVOL_TET_Cn_FEM(const ordinal_type order,
203  const EPointType pointType = POINTTYPE_EQUISPACED);
204 
205 
206  using OutputViewType = typename Basis<ExecSpaceType,outputValueType,pointValueType>::OutputViewType;
207  using PointViewType = typename Basis<ExecSpaceType,outputValueType,pointValueType>::PointViewType;
208  using ScalarViewType = typename Basis<ExecSpaceType,outputValueType,pointValueType>::ScalarViewType;
209 
210  using outputViewType INTREPID2_DEPRECATED_TYPENAME_REPLACEMENT("use OutputViewType instead","OutputViewType") = OutputViewType INTREPID2_DEPRECATED_TYPENAME_TRAILING_ATTRIBUTE("use OutputViewType instead");
211  using pointViewType INTREPID2_DEPRECATED_TYPENAME_REPLACEMENT("use PointViewType instead","PointViewType") = PointViewType INTREPID2_DEPRECATED_TYPENAME_TRAILING_ATTRIBUTE("use PointViewType instead");
212  using scalarViewType INTREPID2_DEPRECATED_TYPENAME_REPLACEMENT("use ScalarViewType instead","ScalarViewType") = ScalarViewType INTREPID2_DEPRECATED_TYPENAME_TRAILING_ATTRIBUTE("use ScalarViewType instead");
213 
214  typedef typename Basis<ExecSpaceType,outputValueType,pointValueType>::scalarType scalarType;
215 
216  using Basis<ExecSpaceType,outputValueType,pointValueType>::getValues;
217 
218  virtual
219  void
220  getValues( OutputViewType outputValues,
221  const PointViewType inputPoints,
222  const EOperator operatorType = OPERATOR_VALUE) const {
223 #ifdef HAVE_INTREPID2_DEBUG
224  Intrepid2::getValues_HVOL_Args(outputValues,
225  inputPoints,
226  operatorType,
227  this->getBaseCellTopology(),
228  this->getCardinality() );
229 #endif
230  constexpr ordinal_type numPtsPerEval = Parameters::MaxNumPtsPerBasisEval;
231  Impl::Basis_HVOL_TET_Cn_FEM::
232  getValues<ExecSpaceType,numPtsPerEval>( outputValues,
233  inputPoints,
234  this->vinv_,
235  operatorType);
236  }
237 
238  virtual
239  void
240  getDofCoords( ScalarViewType dofCoords ) const {
241 #ifdef HAVE_INTREPID2_DEBUG
242  // Verify rank of output array.
243  INTREPID2_TEST_FOR_EXCEPTION( dofCoords.rank() != 2, std::invalid_argument,
244  ">>> ERROR: (Intrepid2::Basis_HVOL_TET_Cn_FEM::getDofCoords) rank = 2 required for dofCoords array");
245  // Verify 0th dimension of output array.
246  INTREPID2_TEST_FOR_EXCEPTION( static_cast<ordinal_type>(dofCoords.extent(0)) != this->getCardinality(), std::invalid_argument,
247  ">>> ERROR: (Intrepid2::Basis_HVOL_TET_Cn_FEM::getDofCoords) mismatch in number of dof and 0th dimension of dofCoords array");
248  // Verify 1st dimension of output array.
249  INTREPID2_TEST_FOR_EXCEPTION( dofCoords.extent(1) != this->getBaseCellTopology().getDimension(), std::invalid_argument,
250  ">>> ERROR: (Intrepid2::Basis_HVOL_TET_Cn_FEM::getDofCoords) incorrect reference cell (1st) dimension in dofCoords array");
251 #endif
252  Kokkos::deep_copy(dofCoords, this->dofCoords_);
253  }
254 
255  virtual
256  void
257  getDofCoeffs( ScalarViewType dofCoeffs ) const {
258 #ifdef HAVE_INTREPID2_DEBUG
259  // Verify rank of output array.
260  INTREPID2_TEST_FOR_EXCEPTION( dofCoeffs.rank() != 1, std::invalid_argument,
261  ">>> ERROR: (Intrepid2::Basis_HVOL_TET_Cn_FEM::getdofCoeffs) rank = 1 required for dofCoeffs array");
262  // Verify 0th dimension of output array.
263  INTREPID2_TEST_FOR_EXCEPTION( static_cast<ordinal_type>(dofCoeffs.extent(0)) != this->getCardinality(), std::invalid_argument,
264  ">>> ERROR: (Intrepid2::Basis_HVOL_TET_Cn_FEM::getdofCoeffs) mismatch in number of dof and 0th dimension of dofCoeffs array");
265 #endif
266  Kokkos::deep_copy(dofCoeffs, 1.0);
267  }
268 
269  void
270  getVandermondeInverse( ScalarViewType vinv ) const {
271  // has to be same rank and dimensions
272  Kokkos::deep_copy(vinv, this->vinv_);
273  }
274 
275  virtual
276  const char*
277  getName() const {
278  return "Intrepid2_HVOL_TET_Cn_FEM";
279  }
280 
281  virtual
282  bool
283  requireOrientation() const {
284  return false;
285  }
286 
287  private:
288 
291  Kokkos::DynRankView<scalarType,ExecSpaceType> vinv_;
292 
293  };
294 
295 }// namespace Intrepid2
296 
297 #include "Intrepid2_HVOL_TET_Cn_FEMDef.hpp"
298 
299 #endif
Intrepid2::Basis< void, double, double >::getCardinality
ordinal_type getCardinality() const
Returns cardinality of the basis.
Definition: Intrepid2_Basis.hpp:554
Intrepid2::Basis< void, double, double >::dofCoords_
Kokkos::DynRankView< scalarType, void > dofCoords_
Coordinates of degrees-of-freedom for basis functions defined in physical space.
Definition: Intrepid2_Basis.hpp:294
Intrepid2::Basis< void, double, double >::getBaseCellTopology
shards::CellTopology getBaseCellTopology() const
Returns the base cell topology for which the basis is defined. See Shards documentation https://trili...
Definition: Intrepid2_Basis.hpp:583
Intrepid2::Basis_HVOL_TET_Cn_FEM::vinv_
Kokkos::DynRankView< scalarType, ExecSpaceType > vinv_
inverse of Generalized Vandermonde matrix, whose columns store the expansion coefficients of the noda...
Definition: Intrepid2_HVOL_TET_Cn_FEM.hpp:291
Intrepid2_HVOL_TET_Cn_FEMDef.hpp
Definition file for FEM basis functions of degree n for H(vol) functions on TET.
Intrepid2::Basis
An abstract base class that defines interface for concrete basis implementations for Finite Element (...
Definition: Intrepid2_Basis.hpp:95
Intrepid2::Impl::Basis_HVOL_TET_Cn_FEM
See Intrepid2::Basis_HVOL_TET_Cn_FEM.
Definition: Intrepid2_HVOL_TET_Cn_FEM.hpp:79
Intrepid2::EOperator
EOperator
Enumeration of primitive operators available in Intrepid. Primitive operators act on reconstructed fu...
Definition: Intrepid2_Types.hpp:271
Intrepid2::Impl::Tetrahedron
Definition: Intrepid2_CellTopologyTags.hpp:290
Intrepid2::Basis::OrdinalTypeArray3DHost
Kokkos::View< ordinal_type ***, typename ExecSpaceType::array_layout, Kokkos::HostSpace > OrdinalTypeArray3DHost
View type for 3d host array.
Definition: Intrepid2_Basis.hpp:139
Intrepid2::EPointType
EPointType
Enumeration of types of point distributions in Intrepid.
Definition: Intrepid2_Types.hpp:419
Intrepid2::Basis_HVOL_TET_Cn_FEM
Implementation of the default HVOL-compatible Lagrange basis of arbitrary degree on Tetrahedron cell.
Definition: Intrepid2_HVOL_TET_Cn_FEM.hpp:190
Intrepid2::Basis::ScalarViewType
Kokkos::DynRankView< scalarType, Kokkos::LayoutStride, ExecSpaceType > ScalarViewType
View type for scalars.
Definition: Intrepid2_Basis.hpp:340
Intrepid2::Basis::scalarType
ScalarTraits< pointValueType >::scalar_type scalarType
Scalar type for point values.
Definition: Intrepid2_Basis.hpp:169
Intrepid2::Parameters::MaxNumPtsPerBasisEval
static constexpr ordinal_type MaxNumPtsPerBasisEval
The maximum number of points to eval in serial mode.
Definition: Intrepid2_Types.hpp:121
Intrepid2::Impl::Basis_HVOL_TET_Cn_FEM::Functor
See Intrepid2::Basis_HVOL_TET_Cn_FEM.
Definition: Intrepid2_HVOL_TET_Cn_FEM.hpp:133
Intrepid2_Basis.hpp
Header file for the abstract base class Intrepid2::Basis.
Intrepid2::getValues_HVOL_Args
void getValues_HVOL_Args(const outputValueViewType outputValues, const inputPointViewType inputPoints, const EOperator operatorType, const shards::CellTopology cellTopo, const ordinal_type basisCard)
Runtime check of the arguments for the getValues method in an HVOL-conforming FEM basis....
Definition: Intrepid2_BasisDef.hpp:749
Intrepid2::Basis::OutputViewType
Kokkos::DynRankView< OutputValueType, Kokkos::LayoutStride, ExecSpaceType > OutputViewType
View type for basis value output.
Definition: Intrepid2_Basis.hpp:330
Intrepid2::Impl::Tetrahedron< 4 >
Tetrahedron topology, 4 nodes.
Definition: Intrepid2_CellTopologyTags.hpp:296
Intrepid2::Impl::Basis_HVOL_TET_Cn_FEM::Serial
See Intrepid2::Basis_HVOL_TET_Cn_FEM.
Definition: Intrepid2_HVOL_TET_Cn_FEM.hpp:86
Intrepid2_PointTools.hpp
Header file for Intrepid2::PointTools class to provide utilities for barycentric coordinates,...
Intrepid2::Basis::PointViewType
Kokkos::DynRankView< PointValueType, Kokkos::LayoutStride, ExecSpaceType > PointViewType
View type for input points.
Definition: Intrepid2_Basis.hpp:335
Intrepid2::Basis::OrdinalTypeArray2DHost
Kokkos::View< ordinal_type **, typename ExecSpaceType::array_layout, Kokkos::HostSpace > OrdinalTypeArray2DHost
View type for 2d host array.
Definition: Intrepid2_Basis.hpp:134
Intrepid2::Basis::OrdinalTypeArray1DHost
Kokkos::View< ordinal_type *, typename ExecSpaceType::array_layout, Kokkos::HostSpace > OrdinalTypeArray1DHost
View type for 1d host array.
Definition: Intrepid2_Basis.hpp:129
Intrepid2::Basis_HVOL_TET_Cn_FEM::Basis_HVOL_TET_Cn_FEM
Basis_HVOL_TET_Cn_FEM(const ordinal_type order, const EPointType pointType=POINTTYPE_EQUISPACED)
Constructor.
Definition: Intrepid2_HVOL_TET_Cn_FEMDef.hpp:231
Intrepid2::Util
small utility functions
Definition: Intrepid2_Utils.hpp:254
Generated by doxygen 1.8.20