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"
53 
54 namespace Intrepid2 {
55 
138  namespace Impl {
139 
144  public:
145  typedef struct Hexahedron<27> cell_topology_type;
149  template<EOperator opType>
150  struct Serial {
151  template<typename OutputViewType,
152  typename inputViewType>
153  KOKKOS_INLINE_FUNCTION
154  static void
155  getValues( OutputViewType output,
156  const inputViewType input );
157 
158  };
159 
160  template<typename ExecSpaceType,
161  typename outputValueValueType, class ...outputValueProperties,
162  typename inputPointValueType, class ...inputPointProperties>
163  static void
164  getValues( Kokkos::DynRankView<outputValueValueType,outputValueProperties...> outputValues,
165  const Kokkos::DynRankView<inputPointValueType, inputPointProperties...> inputPoints,
166  const EOperator operatorType);
167 
171  template<typename outputValueViewType,
172  typename inputPointViewType,
173  EOperator opType>
174  struct Functor {
175  outputValueViewType _outputValues;
176  const inputPointViewType _inputPoints;
177 
178  KOKKOS_INLINE_FUNCTION
179  Functor( outputValueViewType outputValues_,
180  inputPointViewType inputPoints_ )
181  : _outputValues(outputValues_), _inputPoints(inputPoints_) {}
182 
183  KOKKOS_INLINE_FUNCTION
184  void operator()(const ordinal_type pt) const {
185  switch (opType) {
186  case OPERATOR_VALUE : {
187  auto output = Kokkos::subview( _outputValues, Kokkos::ALL(), pt );
188  const auto input = Kokkos::subview( _inputPoints, pt, Kokkos::ALL() );
189  Serial<opType>::getValues( output, input );
190  break;
191  }
192  case OPERATOR_GRAD :
193  case OPERATOR_D1 :
194  case OPERATOR_D2 :
195  case OPERATOR_D3 :
196  case OPERATOR_D4 :
197  case OPERATOR_MAX : {
198  auto output = Kokkos::subview( _outputValues, Kokkos::ALL(), pt, Kokkos::ALL() );
199  const auto input = Kokkos::subview( _inputPoints, pt, Kokkos::ALL() );
200  Serial<opType>::getValues( output, input );
201  break;
202  }
203  default: {
204  INTREPID2_TEST_FOR_ABORT( opType != OPERATOR_VALUE &&
205  opType != OPERATOR_GRAD &&
206  opType != OPERATOR_D1 &&
207  opType != OPERATOR_D2 &&
208  opType != OPERATOR_D3 &&
209  opType != OPERATOR_D4 &&
210  opType != OPERATOR_MAX,
211  ">>> ERROR: (Intrepid2::Basis_HGRAD_HEX_C2_FEM::Serial::getValues) operator is not supported");
212  }
213  }
214  }
215  };
216  };
217  }
218 
219  template<typename ExecSpaceType = void,
220  typename outputValueType = double,
221  typename pointValueType = double>
222  class Basis_HGRAD_HEX_C2_FEM : public Basis<ExecSpaceType,outputValueType,pointValueType> {
223  public:
227 
228  using ordinal_type_array_1d_host INTREPID2_DEPRECATED_TYPENAME_REPLACEMENT("use OrdinalTypeArray1DHost instead","OrdinalTypeArray1DHost") = OrdinalTypeArray1DHost INTREPID2_DEPRECATED_TYPENAME_TRAILING_ATTRIBUTE("use OrdinalTypeArray1DHost instead");
229  using ordinal_type_array_2d_host INTREPID2_DEPRECATED_TYPENAME_REPLACEMENT("use OrdinalTypeArray2DHost instead","OrdinalTypeArray2DHost") = OrdinalTypeArray2DHost INTREPID2_DEPRECATED_TYPENAME_TRAILING_ATTRIBUTE("use OrdinalTypeArray2DHost instead");
230  using ordinal_type_array_3d_host INTREPID2_DEPRECATED_TYPENAME_REPLACEMENT("use OrdinalTypeArray3DHost instead","OrdinalTypeArray3DHost") = OrdinalTypeArray3DHost INTREPID2_DEPRECATED_TYPENAME_TRAILING_ATTRIBUTE("use OrdinalTypeArray3DHost instead");
231 
235 
239 
240  using outputViewType INTREPID2_DEPRECATED_TYPENAME_REPLACEMENT("use OutputViewType instead","OutputViewType") = OutputViewType INTREPID2_DEPRECATED_TYPENAME_TRAILING_ATTRIBUTE("use OutputViewType instead");
241  using pointViewType INTREPID2_DEPRECATED_TYPENAME_REPLACEMENT("use PointViewType instead","PointViewType") = PointViewType INTREPID2_DEPRECATED_TYPENAME_TRAILING_ATTRIBUTE("use PointViewType instead");
242  using scalarViewType INTREPID2_DEPRECATED_TYPENAME_REPLACEMENT("use ScalarViewType instead","ScalarViewType") = ScalarViewType INTREPID2_DEPRECATED_TYPENAME_TRAILING_ATTRIBUTE("use ScalarViewType instead");
243 
245 
246  virtual
247  void
248  getValues( OutputViewType outputValues,
249  const PointViewType inputPoints,
250  const EOperator operatorType = OPERATOR_VALUE ) const {
251 #ifdef HAVE_INTREPID2_DEBUG
252  // Verify arguments
253  Intrepid2::getValues_HGRAD_Args(outputValues,
254  inputPoints,
255  operatorType,
256  this->getBaseCellTopology(),
257  this->getCardinality() );
258 #endif
259  Impl::Basis_HGRAD_HEX_C2_FEM::
260  getValues<ExecSpaceType>( outputValues,
261  inputPoints,
262  operatorType );
263  }
264 
265  virtual
266  void
267  getDofCoords( ScalarViewType dofCoords ) const {
268 #ifdef HAVE_INTREPID2_DEBUG
269  // Verify rank of output array.
270  INTREPID2_TEST_FOR_EXCEPTION( dofCoords.rank() != 2, std::invalid_argument,
271  ">>> ERROR: (Intrepid2::Basis_HGRAD_HEX_C2_FEM::getDofCoords) rank = 2 required for dofCoords array");
272  // Verify 0th dimension of output array.
273  INTREPID2_TEST_FOR_EXCEPTION( static_cast<ordinal_type>(dofCoords.extent(0)) != this->getCardinality(), std::invalid_argument,
274  ">>> ERROR: (Intrepid2::Basis_HGRAD_HEX_C2_FEM::getDofCoords) mismatch in number of dof and 0th dimension of dofCoords array");
275  // Verify 1st dimension of output array.
276  INTREPID2_TEST_FOR_EXCEPTION( dofCoords.extent(1) != this->getBaseCellTopology().getDimension(), std::invalid_argument,
277  ">>> ERROR: (Intrepid2::Basis_HGRAD_HEX_C2_FEM::getDofCoords) incorrect reference cell (1st) dimension in dofCoords array");
278 #endif
279  Kokkos::deep_copy(dofCoords, this->dofCoords_);
280  }
281 
282  virtual
283  void
284  getDofCoeffs( ScalarViewType dofCoeffs ) const {
285 #ifdef HAVE_INTREPID2_DEBUG
286  // Verify rank of output array.
287  INTREPID2_TEST_FOR_EXCEPTION( dofCoeffs.rank() != 1, std::invalid_argument,
288  ">>> ERROR: (Intrepid2::Basis_HGRAD_HEX_C2_FEM::getdofCoeffs) rank = 1 required for dofCoeffs array");
289  // Verify 0th dimension of output array.
290  INTREPID2_TEST_FOR_EXCEPTION( static_cast<ordinal_type>(dofCoeffs.extent(0)) != this->getCardinality(), std::invalid_argument,
291  ">>> ERROR: (Intrepid2::Basis_HGRAD_HEX_C2_FEM::getdofCoeffs) mismatch in number of dof and 0th dimension of dofCoeffs array");
292 #endif
293  Kokkos::deep_copy(dofCoeffs, 1.0);
294  }
295 
296  virtual
297  const char*
298  getName() const {
299  return "Intrepid2_HGRAD_HEX_C2_FEM";
300  }
301 
302  };
303 }// namespace Intrepid2
304 
306 
307 #endif
Kokkos::View< ordinal_type *, typename ExecSpaceType::array_layout, Kokkos::HostSpace > OrdinalTypeArray1DHost
View type for 1d host array.
Kokkos::View< ordinal_type **, typename ExecSpaceType::array_layout, Kokkos::HostSpace > OrdinalTypeArray2DHost
View type for 2d host array.
virtual const char * getName() const
Returns basis name.
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, ExecSpaceType > dofCoords_
Coordinates of degrees-of-freedom for basis functions defined in physical space.
See Intrepid2::Basis_HGRAD_HEX_C2_FEM.
ordinal_type getCardinality() const
Returns cardinality of the basis.
Definition file for FEM basis functions of degree 2 for H(grad) functions on HEX cells.
Kokkos::DynRankView< OutputValueType, Kokkos::LayoutStride, ExecSpaceType > OutputViewType
View type for basis value output.
Kokkos::View< ordinal_type ***, typename ExecSpaceType::array_layout, Kokkos::HostSpace > OrdinalTypeArray3DHost
View type for 3d host array.
virtual void getDofCoeffs(ScalarViewType dofCoeffs) const
Coefficients for computing degrees of freedom for Lagrangian basis If P is an element of the space sp...
Kokkos::DynRankView< PointValueType, Kokkos::LayoutStride, ExecSpaceType > PointViewType
View type for input points.
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.
virtual void getDofCoords(ScalarViewType dofCoords) const
Returns spatial locations (coordinates) of degrees of freedom on the reference cell.
Header file for the abstract base class Intrepid2::Basis.