Intrepid2
Intrepid2_HGRAD_HEX_C1_FEM.hpp
Go to the documentation of this file.
1 // @HEADER
2 // *****************************************************************************
3 // Intrepid2 Package
4 //
5 // Copyright 2007 NTESS and the Intrepid2 contributors.
6 // SPDX-License-Identifier: BSD-3-Clause
7 // *****************************************************************************
8 // @HEADER
9 
16 #ifndef __INTREPID2_HGRAD_HEX_C1_FEM_HPP__
17 #define __INTREPID2_HGRAD_HEX_C1_FEM_HPP__
18 
19 #include "Intrepid2_Basis.hpp"
21 
22 namespace Intrepid2 {
23 
59  namespace Impl {
60 
65  public:
66  typedef struct Hexahedron<8> cell_topology_type;
70  template<EOperator opType>
71  struct Serial {
72  template<typename OutputViewType,
73  typename inputViewType>
74  KOKKOS_INLINE_FUNCTION
75  static void
76  getValues( OutputViewType output,
77  const inputViewType input );
78 
79  };
80 
81  template<typename DeviceType,
82  typename outputValueValueType, class ...outputValueProperties,
83  typename inputPointValueType, class ...inputPointProperties>
84  static void
85  getValues( const typename DeviceType::execution_space& space,
86  Kokkos::DynRankView<outputValueValueType,outputValueProperties...> outputValues,
87  const Kokkos::DynRankView<inputPointValueType, inputPointProperties...> inputPoints,
88  const EOperator operatorType);
89 
93  template<typename outputValueViewType,
94  typename inputPointViewType,
95  EOperator opType>
96  struct Functor {
97  outputValueViewType _outputValues;
98  const inputPointViewType _inputPoints;
99 
100  KOKKOS_INLINE_FUNCTION
101  Functor( outputValueViewType outputValues_,
102  inputPointViewType inputPoints_ )
103  : _outputValues(outputValues_), _inputPoints(inputPoints_) {}
104 
105  KOKKOS_INLINE_FUNCTION
106  void operator()(const ordinal_type pt) const {
107  switch (opType) {
108  case OPERATOR_VALUE : {
109  auto output = Kokkos::subview( _outputValues, Kokkos::ALL(), pt );
110  const auto input = Kokkos::subview( _inputPoints, pt, Kokkos::ALL() );
111  Serial<opType>::getValues( output, input );
112  break;
113  }
114  case OPERATOR_GRAD :
115  case OPERATOR_D2 :
116  case OPERATOR_D3 :
117  case OPERATOR_MAX : {
118  auto output = Kokkos::subview( _outputValues, Kokkos::ALL(), pt, Kokkos::ALL() );
119  const auto input = Kokkos::subview( _inputPoints, pt, Kokkos::ALL() );
120  Serial<opType>::getValues( output, input );
121  break;
122  }
123  default: {
124  INTREPID2_TEST_FOR_ABORT( opType != OPERATOR_VALUE &&
125  opType != OPERATOR_GRAD &&
126  opType != OPERATOR_D2 &&
127  opType != OPERATOR_D3 &&
128  opType != OPERATOR_MAX,
129  ">>> ERROR: (Intrepid2::Basis_HGRAD_HEX_C1_FEM::Serial::getValues) operator is not supported");
130  }
131  }
132  }
133  };
134  };
135  }
136 
137  template<typename DeviceType = void,
138  typename outputValueType = double,
139  typename pointValueType = double>
140  class Basis_HGRAD_HEX_C1_FEM : public Basis<DeviceType,outputValueType,pointValueType> {
141  public:
143  using typename BasisBase::ExecutionSpace;
144 
145  using typename BasisBase::OrdinalTypeArray1DHost;
146  using typename BasisBase::OrdinalTypeArray2DHost;
147  using typename BasisBase::OrdinalTypeArray3DHost;
148 
149  using typename BasisBase::OutputViewType;
150  using typename BasisBase::PointViewType ;
151  using typename BasisBase::ScalarViewType;
152 
156 
157  using BasisBase::getValues;
158 
159  virtual
160  void
161  getValues( const ExecutionSpace& space,
162  OutputViewType outputValues,
163  const PointViewType inputPoints,
164  const EOperator operatorType = OPERATOR_VALUE ) const override {
165 #ifdef HAVE_INTREPID2_DEBUG
166  // Verify arguments
167  Intrepid2::getValues_HGRAD_Args(outputValues,
168  inputPoints,
169  operatorType,
170  this->getBaseCellTopology(),
171  this->getCardinality());
172 #endif
173  Impl::Basis_HGRAD_HEX_C1_FEM::
174  getValues<DeviceType>(space,
175  outputValues,
176  inputPoints,
177  operatorType);
178  }
179 
180  virtual void
181  getScratchSpaceSize( ordinal_type& perTeamSpaceSize,
182  ordinal_type& perThreadSpaceSize,
183  const PointViewType inputPointsconst,
184  const EOperator operatorType = OPERATOR_VALUE) const override;
185 
186  KOKKOS_INLINE_FUNCTION
187  virtual void
188  getValues(
189  OutputViewType outputValues,
190  const PointViewType inputPoints,
191  const EOperator operatorType,
192  const typename Kokkos::TeamPolicy<typename DeviceType::execution_space>::member_type& team_member,
193  const typename DeviceType::execution_space::scratch_memory_space & scratchStorage,
194  const ordinal_type subcellDim = -1,
195  const ordinal_type subcellOrdinal = -1) const override;
196 
197  virtual
198  void
199  getDofCoords( ScalarViewType dofCoords ) const override {
200 #ifdef HAVE_INTREPID2_DEBUG
201  // Verify rank of output array.
202  INTREPID2_TEST_FOR_EXCEPTION( rank(dofCoords) != 2, std::invalid_argument,
203  ">>> ERROR: (Intrepid2::Basis_HGRAD_HEX_C1_FEM::getDofCoords) rank = 2 required for dofCoords array");
204  // Verify 0th dimension of output array.
205  INTREPID2_TEST_FOR_EXCEPTION( static_cast<ordinal_type>(dofCoords.extent(0)) != this->getCardinality(), std::invalid_argument,
206  ">>> ERROR: (Intrepid2::Basis_HGRAD_HEX_C1_FEM::getDofCoords) mismatch in number of dof and 0th dimension of dofCoords array");
207  // Verify 1st dimension of output array.
208  INTREPID2_TEST_FOR_EXCEPTION( dofCoords.extent(1) != this->getBaseCellTopology().getDimension(), std::invalid_argument,
209  ">>> ERROR: (Intrepid2::Basis_HGRAD_HEX_C1_FEM::getDofCoords) incorrect reference cell (1st) dimension in dofCoords array");
210 #endif
211  Kokkos::deep_copy(dofCoords, this->dofCoords_);
212  }
213 
214  virtual
215  void
216  getDofCoeffs( ScalarViewType dofCoeffs ) const override {
217 #ifdef HAVE_INTREPID2_DEBUG
218  // Verify rank of output array.
219  INTREPID2_TEST_FOR_EXCEPTION( rank(dofCoeffs) != 1, std::invalid_argument,
220  ">>> ERROR: (Intrepid2::Basis_HGRAD_HEX_C1_FEM::getdofCoeffs) rank = 1 required for dofCoeffs array");
221  // Verify 0th dimension of output array.
222  INTREPID2_TEST_FOR_EXCEPTION( static_cast<ordinal_type>(dofCoeffs.extent(0)) != this->getCardinality(), std::invalid_argument,
223  ">>> ERROR: (Intrepid2::Basis_HGRAD_HEX_C1_FEM::getdofCoeffs) mismatch in number of dof and 0th dimension of dofCoeffs array");
224 #endif
225  Kokkos::deep_copy(dofCoeffs, 1.0);
226  }
227 
228  virtual
229  const char*
230  getName() const override {
231  return "Intrepid2_HGRAD_HEX_C1_FEM";
232  }
233 
242  BasisPtr<DeviceType,outputValueType,pointValueType>
243  getSubCellRefBasis(const ordinal_type subCellDim, const ordinal_type subCellOrd) const override{
244  if(subCellDim == 1) {
245  return Teuchos::rcp(new
247  } else if(subCellDim == 2) {
248  return Teuchos::rcp(new
250  }
251  INTREPID2_TEST_FOR_EXCEPTION(true,std::invalid_argument,"Input parameters out of bounds");
252  }
253 
254  BasisPtr<typename Kokkos::HostSpace::device_type,outputValueType,pointValueType>
255  getHostBasis() const override{
257  }
258  };
259 }// namespace Intrepid2
260 
262 
263 #endif
virtual const char * getName() const override
Returns basis name.
Implementation of the default H(grad)-compatible FEM basis of degree 1 on Quadrilateral cell...
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.
Header file for the Intrepid2::Basis_HGRAD_QUAD_C1_FEM class.
Definition file for FEM basis functions of degree 1 for H(grad) functions on HEX cells.
Kokkos::DynRankView< PointValueType, Kokkos::LayoutStride, DeviceType > PointViewType
View type for input points.
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.
typename DeviceType::execution_space ExecutionSpace
(Kokkos) Execution space for basis.
virtual void getDofCoords(ScalarViewType dofCoords) const override
Returns spatial locations (coordinates) of degrees of freedom on the reference cell.
virtual KOKKOS_INLINE_FUNCTION void getValues(OutputViewType, const PointViewType, const EOperator, const typename Kokkos::TeamPolicy< ExecutionSpace >::member_type &teamMember, const typename ExecutionSpace::scratch_memory_space &scratchStorage, const ordinal_type subcellDim=-1, const ordinal_type subcellOrdinal=-1) const
Team-level evaluation of basis functions on a reference cell.
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.
virtual void getScratchSpaceSize(ordinal_type &perTeamSpaceSize, ordinal_type &perThreadSpaceSize, const PointViewType inputPointsconst, const EOperator operatorType=OPERATOR_VALUE) const override
Return the size of the scratch space, in bytes, needed for using the team-level implementation of get...
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...
BasisPtr< DeviceType, outputValueType, pointValueType > getSubCellRefBasis(const ordinal_type subCellDim, const ordinal_type subCellOrd) const override
returns the basis associated to a subCell.
Kokkos::View< ordinal_type ***, typename ExecutionSpace::array_layout, Kokkos::HostSpace > OrdinalTypeArray3DHost
View type for 3d host array.
See Intrepid2::Basis_HGRAD_HEX_C1_FEM.
Kokkos::DynRankView< scalarType, Kokkos::LayoutStride, DeviceType > ScalarViewType
View type for scalars.
Implementation of the default H(grad)-compatible FEM basis of degree 1 on Line cell.
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.
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...
Implementation of the default H(grad)-compatible FEM basis of degree 1 on Hexahedron cell...
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.