Intrepid2
Intrepid2_HGRAD_HEX_C2_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_HEX_C2_FEM_HPP__
50 #define __INTREPID2_HGRAD_HEX_C2_FEM_HPP__
51 
52 #include "Intrepid2_Basis.hpp"
54 
55 namespace Intrepid2 {
56 
147  namespace Impl {
148 
152  template<bool serendipity>
154  public:
155  typedef struct Hexahedron<serendipity ? 20 : 27> cell_topology_type;
159  template<EOperator opType>
160  struct Serial {
161  template<typename OutputViewType,
162  typename inputViewType>
163  KOKKOS_INLINE_FUNCTION
164  static void
165  getValues( OutputViewType output,
166  const inputViewType input );
167 
168  };
169 
170  template<typename DeviceType,
171  typename outputValueValueType, class ...outputValueProperties,
172  typename inputPointValueType, class ...inputPointProperties>
173  static void
174  getValues( const typename DeviceType::execution_space& space,
175  Kokkos::DynRankView<outputValueValueType,outputValueProperties...> outputValues,
176  const Kokkos::DynRankView<inputPointValueType, inputPointProperties...> inputPoints,
177  const EOperator operatorType);
178 
182  template<typename outputValueViewType,
183  typename inputPointViewType,
184  EOperator opType>
185  struct Functor {
186  outputValueViewType _outputValues;
187  const inputPointViewType _inputPoints;
188 
189  KOKKOS_INLINE_FUNCTION
190  Functor( outputValueViewType outputValues_,
191  inputPointViewType inputPoints_ )
192  : _outputValues(outputValues_), _inputPoints(inputPoints_) {}
193 
194  KOKKOS_INLINE_FUNCTION
195  void operator()(const ordinal_type pt) const {
196  switch (opType) {
197  case OPERATOR_VALUE : {
198  auto output = Kokkos::subview( _outputValues, Kokkos::ALL(), pt );
199  const auto input = Kokkos::subview( _inputPoints, pt, Kokkos::ALL() );
200  Serial<opType>::getValues( output, input );
201  break;
202  }
203  case OPERATOR_GRAD :
204  case OPERATOR_D1 :
205  case OPERATOR_D2 :
206  case OPERATOR_D3 :
207  case OPERATOR_D4 :
208  case OPERATOR_MAX : {
209  auto output = Kokkos::subview( _outputValues, Kokkos::ALL(), pt, Kokkos::ALL() );
210  const auto input = Kokkos::subview( _inputPoints, pt, Kokkos::ALL() );
211  Serial<opType>::getValues( output, input );
212  break;
213  }
214  default: {
215  INTREPID2_TEST_FOR_ABORT( opType != OPERATOR_VALUE &&
216  opType != OPERATOR_GRAD &&
217  opType != OPERATOR_D1 &&
218  opType != OPERATOR_D2 &&
219  opType != OPERATOR_D3 &&
220  opType != OPERATOR_D4 &&
221  opType != OPERATOR_MAX,
222  ">>> ERROR: (Intrepid2::Basis_HGRAD_HEX_DEG2_FEM::Serial::getValues) operator is not supported");
223  }
224  }
225  }
226  };
227  };
228  }
229 
230  template<bool serendipity,
231  typename DeviceType,
232  typename outputValueType,
233  typename pointValueType>
234  class Basis_HGRAD_HEX_DEG2_FEM : public Basis<DeviceType,outputValueType,pointValueType> {
235  public:
237  using typename BasisBase::ExecutionSpace;
238 
239  using typename BasisBase::OrdinalTypeArray1DHost;
240  using typename BasisBase::OrdinalTypeArray2DHost;
241  using typename BasisBase::OrdinalTypeArray3DHost;
242 
243  using typename BasisBase::OutputViewType;
244  using typename BasisBase::PointViewType ;
245  using typename BasisBase::ScalarViewType;
246 
250 
251  using BasisBase::getValues;
252 
253  virtual
254  void
255  getValues( const ExecutionSpace& space,
256  OutputViewType outputValues,
257  const PointViewType inputPoints,
258  const EOperator operatorType = OPERATOR_VALUE ) const override {
259 #ifdef HAVE_INTREPID2_DEBUG
260  // Verify arguments
261  Intrepid2::getValues_HGRAD_Args(outputValues,
262  inputPoints,
263  operatorType,
264  this->getBaseCellTopology(),
265  this->getCardinality());
266 #endif
267  if constexpr (serendipity)
269  getValues<DeviceType>(space,
270  outputValues,
271  inputPoints,
272  operatorType);
273  else
275  getValues<DeviceType>(space,
276  outputValues,
277  inputPoints,
278  operatorType);
279  }
280 
281  virtual
282  void
283  getDofCoords( ScalarViewType dofCoords ) const override {
284 #ifdef HAVE_INTREPID2_DEBUG
285  // Verify rank of output array.
286  INTREPID2_TEST_FOR_EXCEPTION( rank(dofCoords) != 2, std::invalid_argument,
287  ">>> ERROR: (Intrepid2::Basis_HGRAD_HEX_DEG2_FEM::getDofCoords) rank = 2 required for dofCoords array");
288  // Verify 0th dimension of output array.
289  INTREPID2_TEST_FOR_EXCEPTION( static_cast<ordinal_type>(dofCoords.extent(0)) != this->getCardinality(), std::invalid_argument,
290  ">>> ERROR: (Intrepid2::Basis_HGRAD_HEX_DEG2_FEM::getDofCoords) mismatch in number of dof and 0th dimension of dofCoords array");
291  // Verify 1st dimension of output array.
292  INTREPID2_TEST_FOR_EXCEPTION( dofCoords.extent(1) != this->getBaseCellTopology().getDimension(), std::invalid_argument,
293  ">>> ERROR: (Intrepid2::Basis_HGRAD_HEX_DEG2_FEM::getDofCoords) incorrect reference cell (1st) dimension in dofCoords array");
294 #endif
295  Kokkos::deep_copy(dofCoords, this->dofCoords_);
296  }
297 
298  virtual
299  void
300  getDofCoeffs( ScalarViewType dofCoeffs ) const override {
301 #ifdef HAVE_INTREPID2_DEBUG
302  // Verify rank of output array.
303  INTREPID2_TEST_FOR_EXCEPTION( rank(dofCoeffs) != 1, std::invalid_argument,
304  ">>> ERROR: (Intrepid2::Basis_HGRAD_HEX_DEG2_FEM::getdofCoeffs) rank = 1 required for dofCoeffs array");
305  // Verify 0th dimension of output array.
306  INTREPID2_TEST_FOR_EXCEPTION( static_cast<ordinal_type>(dofCoeffs.extent(0)) != this->getCardinality(), std::invalid_argument,
307  ">>> ERROR: (Intrepid2::Basis_HGRAD_HEX_DEG2_FEM::getdofCoeffs) mismatch in number of dof and 0th dimension of dofCoeffs array");
308 #endif
309  Kokkos::deep_copy(dofCoeffs, 1.0);
310  }
311 
312  virtual
313  const char*
314  getName() const override {
315  return serendipity ? "Intrepid2_HGRAD_HEX_I2_FEM" : "Intrepid2_HGRAD_HEX_C2_FEM";
316  }
317 
326  BasisPtr<DeviceType,outputValueType,pointValueType>
327  getSubCellRefBasis(const ordinal_type subCellDim, const ordinal_type subCellOrd) const override{
328  if(subCellDim == 1) {
329  return Teuchos::rcp(new
331  } else if(subCellDim == 2) {
332  return Teuchos::rcp(new
334  }
335  INTREPID2_TEST_FOR_EXCEPTION(true,std::invalid_argument,"Input parameters out of bounds");
336  }
337 
338  BasisPtr<typename Kokkos::HostSpace::device_type,outputValueType,pointValueType>
339  getHostBasis() const override{
341  }
342  };
343 
344  template<typename DeviceType = void, typename outputValueType = double, typename pointValueType = double>
345  using Basis_HGRAD_HEX_C2_FEM = Basis_HGRAD_HEX_DEG2_FEM<false, DeviceType, outputValueType, pointValueType>;
346 
347  template<typename DeviceType = void, typename outputValueType = double, typename pointValueType = double>
348  using Basis_HGRAD_HEX_I2_FEM = Basis_HGRAD_HEX_DEG2_FEM<true, DeviceType, outputValueType, pointValueType>;
349 
350 }// namespace Intrepid2
351 
353 
354 #endif
Kokkos::View< ordinal_type *, typename ExecutionSpace::array_layout, Kokkos::HostSpace > OrdinalTypeArray1DHost
View type for 1d host array.
ordinal_type getCardinality() const
Returns cardinality of the basis.
virtual void getValues(const ExecutionSpace &, OutputViewType, const PointViewType, const EOperator=OPERATOR_VALUE) const
Evaluation of a FEM basis on a reference cell.
Header file for the Intrepid2::Basis_HGRAD_QUAD_C2_FEM class.
virtual void getDofCoords(ScalarViewType dofCoords) const override
Returns spatial locations (coordinates) of degrees of freedom on the reference cell.
Kokkos::DynRankView< scalarType, Kokkos::LayoutStride, DeviceType > ScalarViewType
View type for scalars.
virtual void getDofCoeffs(ScalarViewType dofCoeffs) const override
Coefficients for computing degrees of freedom for Lagrangian basis If P is an element of the space sp...
BasisPtr< DeviceType, outputValueType, pointValueType > getSubCellRefBasis(const ordinal_type subCellDim, const ordinal_type subCellOrd) const override
returns the basis associated to a subCell.
Implementation of the default H(grad)-compatible FEM basis of degree 2 on Hexahedron cell...
An abstract base class that defines interface for concrete basis implementations for Finite Element (...
shards::CellTopology getBaseCellTopology() const
Returns the base cell topology for which the basis is defined. See Shards documentation https://trili...
Kokkos::DynRankView< scalarType, Kokkos::LayoutStride, DeviceType > ScalarViewType
View type for scalars.
virtual void getValues(const ExecutionSpace &space, OutputViewType outputValues, const PointViewType inputPoints, const EOperator operatorType=OPERATOR_VALUE) const override
Evaluation of a FEM basis on a reference cell.
Implementation of the default H(grad)-compatible FEM basis of degree 2 on Line cell.
See Intrepid2::Basis_HGRAD_HEX_DEG2_FEM.
Kokkos::DynRankView< OutputValueType, Kokkos::LayoutStride, DeviceType > OutputViewType
View type for basis value output.
Kokkos::View< ordinal_type **, typename ExecutionSpace::array_layout, Kokkos::HostSpace > OrdinalTypeArray2DHost
View type for 2d host array.
Kokkos::DynRankView< OutputValueType, Kokkos::LayoutStride, DeviceType > OutputViewType
View type for basis value output.
Definition file for FEM basis functions of degree 2 for H(grad) functions on HEX cells.
Implementation of the default H(grad)-compatible FEM basis of degree 2 on Quadrilateral cell...
virtual const char * getName() const override
Returns basis name.
Kokkos::View< ordinal_type ***, typename ExecutionSpace::array_layout, Kokkos::HostSpace > OrdinalTypeArray3DHost
View type for 3d host array.
BasisPtr< typename Kokkos::HostSpace::device_type, outputValueType, pointValueType > getHostBasis() const override
Creates and returns a Basis object whose DeviceType template argument is Kokkos::HostSpace::device_ty...
typename DeviceType::execution_space ExecutionSpace
(Kokkos) Execution space for basis.
Kokkos::DynRankView< PointValueType, Kokkos::LayoutStride, DeviceType > PointViewType
View type for input points.
Kokkos::DynRankView< scalarType, DeviceType > dofCoords_
Coordinates of degrees-of-freedom for basis functions defined in physical space.
Kokkos::DynRankView< PointValueType, Kokkos::LayoutStride, DeviceType > PointViewType
View type for input points.
Header file for the abstract base class Intrepid2::Basis.
typename DeviceType::execution_space ExecutionSpace
(Kokkos) Execution space for basis.