Intrepid2
Intrepid2_HGRAD_HEX_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_HEX_CN_FEM_HPP__
50 #define __INTREPID2_HGRAD_HEX_CN_FEM_HPP__
51 
52 #include "Intrepid2_Basis.hpp"
53 #include "Intrepid2_HGRAD_LINE_Cn_FEM.hpp"
54 
55 namespace Intrepid2 {
56 
57  namespace Impl {
61  class Basis_HGRAD_HEX_Cn_FEM {
62  public:
63  typedef struct Hexahedron<8> cell_topology_type;
67  template<EOperator opType>
68  struct Serial {
69  template<typename outputValueViewType,
70  typename inputPointViewType,
71  typename workViewType,
72  typename vinvViewType>
73  KOKKOS_INLINE_FUNCTION
74  static void
75  getValues( outputValueViewType outputValues,
76  const inputPointViewType inputPoints,
77  workViewType work,
78  const vinvViewType vinv,
79  const ordinal_type operatorDn = 0 );
80  };
81 
82  template<typename ExecSpaceType, ordinal_type numPtsPerEval,
83  typename outputValueValueType, class ...outputValueProperties,
84  typename inputPointValueType, class ...inputPointProperties,
85  typename vinvValueType, class ...vinvProperties>
86  static void
87  getValues( Kokkos::DynRankView<outputValueValueType,outputValueProperties...> outputValues,
88  const Kokkos::DynRankView<inputPointValueType, inputPointProperties...> inputPoints,
89  const Kokkos::DynRankView<vinvValueType, vinvProperties...> vinv,
90  const EOperator operatorType );
91 
95  template<typename outputValueViewType,
96  typename inputPointViewType,
97  typename vinvViewType,
98  typename workViewType,
99  EOperator opType,
100  ordinal_type numPtsEval>
101  struct Functor {
102  outputValueViewType _outputValues;
103  const inputPointViewType _inputPoints;
104  const vinvViewType _vinv;
105  workViewType _work;
106  const ordinal_type _opDn;
107 
108  KOKKOS_INLINE_FUNCTION
109  Functor( outputValueViewType outputValues_,
110  inputPointViewType inputPoints_,
111  vinvViewType vinv_,
112  workViewType work_,
113  const ordinal_type opDn_ = 0 )
114  : _outputValues(outputValues_), _inputPoints(inputPoints_),
115  _vinv(vinv_), _work(work_), _opDn(opDn_) {}
116 
117  KOKKOS_INLINE_FUNCTION
118  void operator()(const size_type iter) const {
119  const auto ptBegin = Util<ordinal_type>::min(iter*numPtsEval, _inputPoints.extent(0));
120  const auto ptEnd = Util<ordinal_type>::min(ptBegin+numPtsEval, _inputPoints.extent(0));
121 
122  const auto ptRange = Kokkos::pair<ordinal_type,ordinal_type>(ptBegin, ptEnd);
123  const auto input = Kokkos::subview( _inputPoints, ptRange, Kokkos::ALL() );
124 
125  typename workViewType::pointer_type ptr = _work.data() + _work.extent(0)*ptBegin*get_dimension_scalar(_work);
126 
127  auto vcprop = Kokkos::common_view_alloc_prop(_work);
128  workViewType work(Kokkos::view_wrap(ptr,vcprop), (ptEnd-ptBegin)*_work.extent(0));
129 
130  switch (opType) {
131  case OPERATOR_VALUE : {
132  auto output = Kokkos::subview( _outputValues, Kokkos::ALL(), ptRange );
133  Serial<opType>::getValues( output, input, work, _vinv );
134  break;
135  }
136  case OPERATOR_CURL :
137  case OPERATOR_Dn : {
138  auto output = Kokkos::subview( _outputValues, Kokkos::ALL(), ptRange, Kokkos::ALL() );
139  Serial<opType>::getValues( output, input, work, _vinv, _opDn );
140  break;
141  }
142  default: {
143  INTREPID2_TEST_FOR_ABORT( true,
144  ">>> ERROR: (Intrepid2::Basis_HGRAD_HEX_Cn_FEM::Functor) operator is not supported");
145 
146  }
147  }
148  }
149  };
150  };
151  }
152 
164  template<typename ExecSpaceType = void,
165  typename outputValueType = double,
166  typename pointValueType = double>
167  class Basis_HGRAD_HEX_Cn_FEM
168  : public Basis<ExecSpaceType,outputValueType,pointValueType> {
169  public:
170  using OrdinalTypeArray1DHost = typename Basis<ExecSpaceType,outputValueType,pointValueType>::OrdinalTypeArray1DHost;
171  using OrdinalTypeArray2DHost = typename Basis<ExecSpaceType,outputValueType,pointValueType>::OrdinalTypeArray2DHost;
172  using OrdinalTypeArray3DHost = typename Basis<ExecSpaceType,outputValueType,pointValueType>::OrdinalTypeArray3DHost;
173 
174  using ordinal_type_array_1d_host INTREPID2_DEPRECATED_TYPENAME_REPLACEMENT("use OrdinalTypeArray1DHost instead","OrdinalTypeArray1DHost") = OrdinalTypeArray1DHost INTREPID2_DEPRECATED_TYPENAME_TRAILING_ATTRIBUTE("use OrdinalTypeArray1DHost instead");
175  using ordinal_type_array_2d_host INTREPID2_DEPRECATED_TYPENAME_REPLACEMENT("use OrdinalTypeArray2DHost instead","OrdinalTypeArray2DHost") = OrdinalTypeArray2DHost INTREPID2_DEPRECATED_TYPENAME_TRAILING_ATTRIBUTE("use OrdinalTypeArray2DHost instead");
176  using ordinal_type_array_3d_host INTREPID2_DEPRECATED_TYPENAME_REPLACEMENT("use OrdinalTypeArray3DHost instead","OrdinalTypeArray3DHost") = OrdinalTypeArray3DHost INTREPID2_DEPRECATED_TYPENAME_TRAILING_ATTRIBUTE("use OrdinalTypeArray3DHost instead");
177 
178  using OutputViewType = typename Basis<ExecSpaceType,outputValueType,pointValueType>::OutputViewType;
179  using PointViewType = typename Basis<ExecSpaceType,outputValueType,pointValueType>::PointViewType;
180  using ScalarViewType = typename Basis<ExecSpaceType,outputValueType,pointValueType>::ScalarViewType;
181 
182  using outputViewType INTREPID2_DEPRECATED_TYPENAME_REPLACEMENT("use OutputViewType instead","OutputViewType") = OutputViewType INTREPID2_DEPRECATED_TYPENAME_TRAILING_ATTRIBUTE("use OutputViewType instead");
183  using pointViewType INTREPID2_DEPRECATED_TYPENAME_REPLACEMENT("use PointViewType instead","PointViewType") = PointViewType INTREPID2_DEPRECATED_TYPENAME_TRAILING_ATTRIBUTE("use PointViewType instead");
184  using scalarViewType INTREPID2_DEPRECATED_TYPENAME_REPLACEMENT("use ScalarViewType instead","ScalarViewType") = ScalarViewType INTREPID2_DEPRECATED_TYPENAME_TRAILING_ATTRIBUTE("use ScalarViewType instead");
185 
186  private:
188  Kokkos::DynRankView<typename ScalarViewType::value_type,ExecSpaceType> vinv_;
189 
190  public:
191 
194  Basis_HGRAD_HEX_Cn_FEM(const ordinal_type order,
195  const EPointType pointType = POINTTYPE_EQUISPACED);
196 
197  using Basis<ExecSpaceType,outputValueType,pointValueType>::getValues;
198 
199  virtual
200  void
201  getValues( OutputViewType outputValues,
202  const PointViewType inputPoints,
203  const EOperator operatorType = OPERATOR_VALUE ) const {
204 #ifdef HAVE_INTREPID2_DEBUG
205  Intrepid2::getValues_HGRAD_Args(outputValues,
206  inputPoints,
207  operatorType,
208  this->getBaseCellTopology(),
209  this->getCardinality() );
210 #endif
211  constexpr ordinal_type numPtsPerEval = Parameters::MaxNumPtsPerBasisEval;
212  Impl::Basis_HGRAD_HEX_Cn_FEM::
213  getValues<ExecSpaceType,numPtsPerEval>( outputValues,
214  inputPoints,
215  this->vinv_,
216  operatorType );
217  }
218 
219 
220  virtual
221  void
222  getDofCoords( ScalarViewType dofCoords ) const {
223 #ifdef HAVE_INTREPID2_DEBUG
224  // Verify rank of output array.
225  INTREPID2_TEST_FOR_EXCEPTION( dofCoords.rank() != 2, std::invalid_argument,
226  ">>> ERROR: (Intrepid2::Basis_HGRAD_HEX_Cn_FEM::getDofCoords) rank = 2 required for dofCoords array");
227  // Verify 0th dimension of output array.
228  INTREPID2_TEST_FOR_EXCEPTION( static_cast<ordinal_type>(dofCoords.extent(0)) != this->getCardinality(), std::invalid_argument,
229  ">>> ERROR: (Intrepid2::Basis_HGRAD_HEX_Cn_FEM::getDofCoords) mismatch in number of dof and 0th dimension of dofCoords array");
230  // Verify 1st dimension of output array.
231  INTREPID2_TEST_FOR_EXCEPTION( dofCoords.extent(1) != this->getBaseCellTopology().getDimension(), std::invalid_argument,
232  ">>> ERROR: (Intrepid2::Basis_HGRAD_HEX_Cn_FEM::getDofCoords) incorrect reference cell (1st) dimension in dofCoords array");
233 #endif
234  Kokkos::deep_copy(dofCoords, this->dofCoords_);
235  }
236 
237  virtual
238  void
239  getDofCoeffs( ScalarViewType dofCoeffs ) const {
240 #ifdef HAVE_INTREPID2_DEBUG
241  // Verify rank of output array.
242  INTREPID2_TEST_FOR_EXCEPTION( dofCoeffs.rank() != 1, std::invalid_argument,
243  ">>> ERROR: (Intrepid2::Basis_HGRAD_HEX_Cn_FEM::getdofCoeffs) rank = 1 required for dofCoeffs array");
244  // Verify 0th dimension of output array.
245  INTREPID2_TEST_FOR_EXCEPTION( static_cast<ordinal_type>(dofCoeffs.extent(0)) != this->getCardinality(), std::invalid_argument,
246  ">>> ERROR: (Intrepid2::Basis_HGRAD_HEX_Cn_FEM::getdofCoeffs) mismatch in number of dof and 0th dimension of dofCoeffs array");
247 #endif
248  Kokkos::deep_copy(dofCoeffs, 1.0);
249  }
250 
251  virtual
252  const char*
253  getName() const {
254  return "Intrepid2_HGRAD_HEX_Cn_FEM";
255  }
256 
257  virtual
258  bool
259  requireOrientation() const {
260  return (this->basisDegree_ > 2);
261  }
262 
263  Kokkos::DynRankView<typename ScalarViewType::const_value_type,ExecSpaceType>
264  getVandermondeInverse() {
265  return vinv_;
266  }
267 
268  ordinal_type
269  getWorkSizePerPoint(const EOperator operatorType) {
270  return 4*getPnCardinality<1>(this->basisDegree_);
271  }
272 
273  };
274 
275 }// namespace Intrepid2
276 
277 #include "Intrepid2_HGRAD_HEX_Cn_FEMDef.hpp"
278 
279 #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::Impl::Hexahedron< 8 >
Hexahedron topology, 8 nodes.
Definition: Intrepid2_CellTopologyTags.hpp:399
Intrepid2::Basis< void, double, double >::basisDegree_
ordinal_type basisDegree_
Degree of the largest complete polynomial space that can be represented by the basis.
Definition: Intrepid2_Basis.hpp:178
Intrepid2_HGRAD_LINE_Cn_FEM.hpp
Header file for the Intrepid2::Basis_HGRAD_LINE_Cn_FEM class.
Intrepid2_HGRAD_HEX_Cn_FEMDef.hpp
Definition file for basis function of degree n for H(grad) functions on HEX cells.
Intrepid2::Basis
An abstract base class that defines interface for concrete basis implementations for Finite Element (...
Definition: Intrepid2_Basis.hpp:95
Intrepid2::Impl::Hexahedron
Definition: Intrepid2_CellTopologyTags.hpp:393
Intrepid2::EOperator
EOperator
Enumeration of primitive operators available in Intrepid. Primitive operators act on reconstructed fu...
Definition: Intrepid2_Types.hpp:271
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::Basis_HGRAD_HEX_Cn_FEM
Implementation of the default H(grad)-compatible FEM basis of degree 2 on Hexahedron cell.
Definition: Intrepid2_HGRAD_HEX_Cn_FEM.hpp:168
Intrepid2::Impl::Basis_HGRAD_HEX_Cn_FEM
See Intrepid2::Basis_HGRAD_HEX_Cn_FEM.
Definition: Intrepid2_HGRAD_HEX_Cn_FEM.hpp:61
Intrepid2::EPointType
EPointType
Enumeration of types of point distributions in Intrepid.
Definition: Intrepid2_Types.hpp:419
Intrepid2::Impl::Basis_HGRAD_HEX_Cn_FEM::Functor
See Intrepid2::Basis_HGRAD_HEX_Cn_FEM.
Definition: Intrepid2_HGRAD_HEX_Cn_FEM.hpp:101
Intrepid2::Basis::ScalarViewType
Kokkos::DynRankView< scalarType, Kokkos::LayoutStride, ExecSpaceType > ScalarViewType
View type for scalars.
Definition: Intrepid2_Basis.hpp:340
Intrepid2::Basis_HGRAD_HEX_Cn_FEM::Basis_HGRAD_HEX_Cn_FEM
Basis_HGRAD_HEX_Cn_FEM(const ordinal_type order, const EPointType pointType=POINTTYPE_EQUISPACED)
Constructor.
Definition: Intrepid2_HGRAD_HEX_Cn_FEMDef.hpp:268
Intrepid2::Parameters::MaxNumPtsPerBasisEval
static constexpr ordinal_type MaxNumPtsPerBasisEval
The maximum number of points to eval in serial mode.
Definition: Intrepid2_Types.hpp:121
Intrepid2::getValues_HGRAD_Args
void getValues_HGRAD_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 HGRAD-conforming FEM basis....
Definition: Intrepid2_BasisDef.hpp:484
Intrepid2_Basis.hpp
Header file for the abstract base class Intrepid2::Basis.
Intrepid2::Basis::OutputViewType
Kokkos::DynRankView< OutputValueType, Kokkos::LayoutStride, ExecSpaceType > OutputViewType
View type for basis value output.
Definition: Intrepid2_Basis.hpp:330
Intrepid2::Basis::PointViewType
Kokkos::DynRankView< PointValueType, Kokkos::LayoutStride, ExecSpaceType > PointViewType
View type for input points.
Definition: Intrepid2_Basis.hpp:335
Intrepid2::Impl::Basis_HGRAD_HEX_Cn_FEM::Serial
See Intrepid2::Basis_HGRAD_HEX_Cn_FEM.
Definition: Intrepid2_HGRAD_HEX_Cn_FEM.hpp:68
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_HGRAD_HEX_Cn_FEM::vinv_
Kokkos::DynRankView< typename ScalarViewType::value_type, ExecSpaceType > vinv_
inverse of Generalized Vandermonde matrix (isotropic order)
Definition: Intrepid2_HGRAD_HEX_Cn_FEM.hpp:188
Intrepid2::Util
small utility functions
Definition: Intrepid2_Utils.hpp:254
Generated by doxygen 1.8.20