Intrepid2
Intrepid2_HDIV_TET_In_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
15
16#ifndef __INTREPID2_HDIV_TET_IN_FEM_HPP__
17#define __INTREPID2_HDIV_TET_IN_FEM_HPP__
18
19#include "Intrepid2_Basis.hpp"
22
24#include "Teuchos_LAPACK.hpp"
25
26namespace Intrepid2 {
27
53
54#define CardinalityHDivTet(order) (order*(order+1)*(order+3)/2)
55
56namespace Impl {
57
62public:
63
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
80
81 KOKKOS_INLINE_FUNCTION
82 static ordinal_type
83 getWorkSizePerPoint(ordinal_type order) {
84 auto cardinality = CardinalityHDivTet(order);
85 switch (opType) {
86 case OPERATOR_DIV:
87 case OPERATOR_D1:
88 return 7*cardinality;
89 default:
90 return getDkCardinality<opType,3>()*cardinality;
91 }
92 }
93 };
94
95 template<typename DeviceType, ordinal_type numPtsPerEval,
96 typename outputValueValueType, class ...outputValueProperties,
97 typename inputPointValueType, class ...inputPointProperties,
98 typename vinvValueType, class ...vinvProperties>
99 static void
100 getValues( Kokkos::DynRankView<outputValueValueType,outputValueProperties...> outputValues,
101 const Kokkos::DynRankView<inputPointValueType, inputPointProperties...> inputPoints,
102 const Kokkos::DynRankView<vinvValueType, vinvProperties...> vinv,
103 const EOperator operatorType);
104
108 template<typename outputValueViewType,
109 typename inputPointViewType,
110 typename vinvViewType,
111 typename workViewType,
112 EOperator opType,
113 ordinal_type numPtsEval>
114 struct Functor {
115 outputValueViewType _outputValues;
116 const inputPointViewType _inputPoints;
117 const vinvViewType _coeffs;
118 workViewType _work;
119
120 KOKKOS_INLINE_FUNCTION
121 Functor( outputValueViewType outputValues_,
122 inputPointViewType inputPoints_,
123 vinvViewType coeffs_,
124 workViewType work_)
125 : _outputValues(outputValues_), _inputPoints(inputPoints_),
126 _coeffs(coeffs_), _work(work_) {}
127
128 KOKKOS_INLINE_FUNCTION
129 void operator()(const size_type iter) const {
130 const auto ptBegin = Util<ordinal_type>::min(iter*numPtsEval, _inputPoints.extent(0));
131 const auto ptEnd = Util<ordinal_type>::min(ptBegin+numPtsEval, _inputPoints.extent(0));
132
133 const auto ptRange = Kokkos::pair<ordinal_type,ordinal_type>(ptBegin, ptEnd);
134 const auto input = Kokkos::subview( _inputPoints, ptRange, Kokkos::ALL() );
135
136 typename workViewType::pointer_type ptr = _work.data() + _work.extent(0)*ptBegin*get_dimension_scalar(_work);
137
138 workViewType work = createMatchingUnmanagedView<workViewType>(_work, ptr, (ptEnd-ptBegin)*_work.extent(0));
139
140 switch (opType) {
141 case OPERATOR_VALUE : {
142 auto output = Kokkos::subview( _outputValues, Kokkos::ALL(), ptRange, Kokkos::ALL() );
143 Serial<opType>::getValues( output, input, work, _coeffs );
144 break;
145 }
146 case OPERATOR_DIV: {
147 auto output = Kokkos::subview( _outputValues, Kokkos::ALL(), ptRange);
148 Serial<opType>::getValues( output, input, work, _coeffs );
149 break;
150 }
151 default: {
152 INTREPID2_TEST_FOR_ABORT( true,
153 ">>> ERROR: (Intrepid2::Basis_HDIV_TET_In_FEM::Functor) operator is not supported");
154
155 }
156 }
157 }
158 };
159};
160}
161
162template<typename DeviceType = void,
163 typename outputValueType = double,
164 typename pointValueType = double>
166 : public Basis<DeviceType,outputValueType,pointValueType> {
167 public:
168 using BasisBase = Basis<DeviceType, outputValueType, pointValueType>;
169 using OrdinalTypeArray1DHost = typename BasisBase::OrdinalTypeArray1DHost;
170 using OrdinalTypeArray2DHost = typename BasisBase::OrdinalTypeArray2DHost;
171 using OrdinalTypeArray3DHost = typename BasisBase::OrdinalTypeArray3DHost;
172
175 Basis_HDIV_TET_In_FEM(const ordinal_type order,
176 const EPointType pointType = POINTTYPE_EQUISPACED);
177
178 using OutputViewType = typename BasisBase::OutputViewType;
179 using PointViewType = typename BasisBase::PointViewType;
180 using ScalarViewType = typename BasisBase::ScalarViewType;
181 using scalarType = typename BasisBase::scalarType;
183
184 virtual
185 void
186 getValues( /* */ OutputViewType outputValues,
187 const PointViewType inputPoints,
188 const EOperator operatorType = OPERATOR_VALUE) const override {
189#ifdef HAVE_INTREPID2_DEBUG
191 inputPoints,
192 operatorType,
193 this->getBaseCellTopology(),
194 this->getCardinality() );
195#endif
196 constexpr ordinal_type numPtsPerEval = Parameters::MaxNumPtsPerBasisEval;
197 Impl::Basis_HDIV_TET_In_FEM::
198 getValues<DeviceType,numPtsPerEval>( outputValues,
199 inputPoints,
200 this->coeffs_,
201 operatorType);
202 }
203
204 virtual void
205 getScratchSpaceSize( ordinal_type& perTeamSpaceSize,
206 ordinal_type& perThreadSpaceSize,
207 const PointViewType inputPointsconst,
208 const EOperator operatorType = OPERATOR_VALUE) const override;
209
210 KOKKOS_INLINE_FUNCTION
211 virtual void
212 getValues(
213 OutputViewType outputValues,
214 const PointViewType inputPoints,
215 const EOperator operatorType,
216 const typename Kokkos::TeamPolicy<typename DeviceType::execution_space>::member_type& team_member,
217 const typename DeviceType::execution_space::scratch_memory_space & scratchStorage,
218 const ordinal_type subcellDim = -1,
219 const ordinal_type subcellOrdinal = -1) const override;
220
221 virtual
222 void
223 getDofCoords( ScalarViewType dofCoords ) const override {
224#ifdef HAVE_INTREPID2_DEBUG
225 // Verify rank of output array.
226 INTREPID2_TEST_FOR_EXCEPTION( dofCoords.rank() != 2, std::invalid_argument,
227 ">>> ERROR: (Intrepid2::Basis_HDIV_TET_In_FEM::getDofCoords) rank = 2 required for dofCoords array");
228 // Verify 0th dimension of output array.
229 INTREPID2_TEST_FOR_EXCEPTION( static_cast<ordinal_type>(dofCoords.extent(0)) != this->getCardinality(), std::invalid_argument,
230 ">>> ERROR: (Intrepid2::Basis_HDIV_TET_In_FEM::getDofCoords) mismatch in number of dof and 0th dimension of dofCoords array");
231 // Verify 1st dimension of output array.
232 INTREPID2_TEST_FOR_EXCEPTION( dofCoords.extent(1) != this->getBaseCellTopology().getDimension(), std::invalid_argument,
233 ">>> ERROR: (Intrepid2::Basis_HDIV_TET_In_FEM::getDofCoords) incorrect reference cell (1st) dimension in dofCoords array");
234#endif
235 Kokkos::deep_copy(dofCoords, this->dofCoords_);
236 }
237
238 virtual
239 void
240 getDofCoeffs( ScalarViewType dofCoeffs ) const override {
241 #ifdef HAVE_INTREPID2_DEBUG
242 // Verify rank of output array.
243 INTREPID2_TEST_FOR_EXCEPTION( dofCoeffs.rank() != 2, std::invalid_argument,
244 ">>> ERROR: (Intrepid2::Basis_HDIV_TET_In_FEM::getDofCoeffs) rank = 2 required for dofCoeffs array");
245 // Verify 0th dimension of output array.
246 INTREPID2_TEST_FOR_EXCEPTION( static_cast<ordinal_type>(dofCoeffs.extent(0)) != this->getCardinality(), std::invalid_argument,
247 ">>> ERROR: (Intrepid2::Basis_HDIV_TET_In_FEM::getDofCoeffs) mismatch in number of dof and 0th dimension of dofCoeffs array");
248 // Verify 1st dimension of output array.
249 INTREPID2_TEST_FOR_EXCEPTION( dofCoeffs.extent(1) != this->getBaseCellTopology().getDimension(), std::invalid_argument,
250 ">>> ERROR: (Intrepid2::Basis_HDIV_TET_In_FEM::getDofCoeffs) incorrect reference cell (1st) dimension in dofCoeffs array");
251#endif
252 Kokkos::deep_copy(dofCoeffs, this->dofCoeffs_);
253 }
254
255 void
256 getExpansionCoeffs( ScalarViewType coeffs ) const {
257 // has to be same rank and dimensions
258 Kokkos::deep_copy(coeffs, this->coeffs_);
259 }
260
261 virtual
262 const char*
263 getName() const override {
264 return "Intrepid2_HDIV_TET_In_FEM";
265 }
266
267 virtual
268 bool
269 requireOrientation() const override {
270 return true;
271 }
272
283 getSubCellRefBasis(const ordinal_type subCellDim, const ordinal_type subCellOrd) const override{
284
285 if(subCellDim == 2) {
286 return Teuchos::rcp(new
288 (this->basisDegree_-1, pointType_));
289 }
290 INTREPID2_TEST_FOR_EXCEPTION(true,std::invalid_argument,"Input parameters out of bounds");
291 }
292
297 private:
298
300 Kokkos::DynRankView<scalarType,DeviceType> coeffs_;
301
303 EPointType pointType_;
304 };
305
306}// namespace Intrepid2
307
309
310#endif
Header file for the abstract base class Intrepid2::Basis.
KOKKOS_INLINE_FUNCTION ordinal_type getDkCardinality(const EOperator operatorType, const ordinal_type spaceDim)
Returns multiplicities of dx, dy, and dz based on the enumeration of the partial derivative,...
void getValues_HDIV_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 HDIV-conforming FEM basis....
Teuchos::RCP< Basis< DeviceType, OutputType, PointType > > BasisPtr
Basis Pointer.
Definition file for FEM basis functions of degree n for H(grad) functions on TET cells.
Header file for the Intrepid2::Basis_HGRAD_TET_Cn_FEM_ORTH class.
Header file for the Intrepid2::Basis_HVOL_TRI_Cn_FEM class.
Header file for Intrepid2::PointTools class to provide utilities for barycentric coordinates,...
KOKKOS_INLINE_FUNCTION std::enable_if< std::is_pointer_v< CtorProp > &&!std::is_convertible_v< CtorProp, constchar * >, OutViewType >::type createMatchingUnmanagedView(const InViewType &view, const CtorProp &data, const Dims... dims)
Creates an unmanaged view that matches the value_type of the provided view The type of the output vie...
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...
virtual bool requireOrientation() const override
True if orientation is required.
virtual void getDofCoords(ScalarViewType dofCoords) const override
Returns spatial locations (coordinates) of degrees of freedom on the reference cell.
virtual const char * getName() const override
Returns basis name.
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...
Basis_HDIV_TET_In_FEM(const ordinal_type order, const EPointType pointType=POINTTYPE_EQUISPACED)
Constructor.
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 HVOL-compatible Lagrange basis of arbitrary degree on Triangle cell.
Kokkos::DynRankView< PointValueType, Kokkos::LayoutStride, DeviceType > PointViewType
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
Kokkos::DynRankView< OutputValueType, Kokkos::LayoutStride, DeviceType > OutputViewType
Kokkos::View< ordinal_type ***, typename ExecutionSpace::array_layout, Kokkos::HostSpace > OrdinalTypeArray3DHost
Kokkos::DynRankView< scalarType, Kokkos::LayoutStride, DeviceType > ScalarViewType
Kokkos::DynRankView< scalarType, DeviceType > dofCoords_
Kokkos::DynRankView< scalarType, DeviceType > dofCoeffs_
Kokkos::View< ordinal_type **, typename ExecutionSpace::array_layout, Kokkos::HostSpace > OrdinalTypeArray2DHost
shards::CellTopology getBaseCellTopology() const
Kokkos::View< ordinal_type *, typename ExecutionSpace::array_layout, Kokkos::HostSpace > OrdinalTypeArray1DHost
See Intrepid2::Basis_HDIV_TET_In_FEM.
static constexpr ordinal_type MaxNumPtsPerBasisEval
The maximum number of points to eval in serial mode.