Intrepid2
Intrepid2_HCURL_TRI_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_HCURL_TRI_IN_FEM_HPP__
17#define __INTREPID2_HCURL_TRI_IN_FEM_HPP__
18
19#include "Intrepid2_Basis.hpp"
22
24#include "Teuchos_LAPACK.hpp"
25
26namespace Intrepid2 {
27
47
48#define CardinalityHCurlTri(order) (order*(order+2))
49
50namespace Impl {
51
56public:
57 typedef struct Triangle<3> cell_topology_type;
58
62 template<EOperator opType>
63 struct Serial {
64 template<typename outputValueViewType,
65 typename inputPointViewType,
66 typename workViewType,
67 typename vinvViewType>
68 KOKKOS_INLINE_FUNCTION
69 static void
70 getValues( outputValueViewType outputValues,
71 const inputPointViewType inputPoints,
72 workViewType work,
73 const vinvViewType vinv );
74
75 KOKKOS_INLINE_FUNCTION
76 static ordinal_type
77 getWorkSizePerPoint(ordinal_type order) {
78 auto cardinality = CardinalityHCurlTri(order);
79 switch (opType) {
80 case OPERATOR_GRAD:
81 case OPERATOR_CURL:
82 case OPERATOR_D1:
83 return 5*cardinality;
84 default:
85 return getDkCardinality<opType,2>()*cardinality;
86 }
87 }
88 };
89
90 template<typename DeviceType, ordinal_type numPtsPerEval,
91 typename outputValueValueType, class ...outputValueProperties,
92 typename inputPointValueType, class ...inputPointProperties,
93 typename vinvValueType, class ...vinvProperties>
94 static void
95 getValues(
96 const typename DeviceType::execution_space& space,
97 Kokkos::DynRankView<outputValueValueType,outputValueProperties...> outputValues,
98 const Kokkos::DynRankView<inputPointValueType, inputPointProperties...> inputPoints,
99 const Kokkos::DynRankView<vinvValueType, vinvProperties...> vinv,
100 const EOperator operatorType);
101
105 template<typename outputValueViewType,
106 typename inputPointViewType,
107 typename vinvViewType,
108 typename workViewType,
109 EOperator opType,
110 ordinal_type numPtsEval>
111 struct Functor {
112 outputValueViewType _outputValues;
113 const inputPointViewType _inputPoints;
114 const vinvViewType _coeffs;
115 workViewType _work;
116
117 KOKKOS_INLINE_FUNCTION
118 Functor( outputValueViewType outputValues_,
119 inputPointViewType inputPoints_,
120 vinvViewType coeffs_,
121 workViewType work_)
122 : _outputValues(outputValues_), _inputPoints(inputPoints_),
123 _coeffs(coeffs_), _work(work_) {}
124
125 KOKKOS_INLINE_FUNCTION
126 void operator()(const size_type iter) const {
127 const auto ptBegin = Util<ordinal_type>::min(iter*numPtsEval, _inputPoints.extent(0));
128 const auto ptEnd = Util<ordinal_type>::min(ptBegin+numPtsEval, _inputPoints.extent(0));
129
130 const auto ptRange = Kokkos::pair<ordinal_type,ordinal_type>(ptBegin, ptEnd);
131 const auto input = Kokkos::subview( _inputPoints, ptRange, Kokkos::ALL() );
132
133
134 typename workViewType::pointer_type ptr = _work.data() + _work.extent(0)*ptBegin*get_dimension_scalar(_work);
135
136 workViewType work = createMatchingUnmanagedView<workViewType>(_work, ptr, (ptEnd-ptBegin)*_work.extent(0));
137
138 switch (opType) {
139 case OPERATOR_VALUE : {
140 auto output = Kokkos::subview( _outputValues, Kokkos::ALL(), ptRange, Kokkos::ALL() );
141 Serial<opType>::getValues( output, input, work, _coeffs );
142 break;
143 }
144 case OPERATOR_CURL: {
145 auto output = Kokkos::subview( _outputValues, Kokkos::ALL(), ptRange);
146 Serial<opType>::getValues( output, input, work, _coeffs );
147 break;
148 }
149 default: {
150 INTREPID2_TEST_FOR_ABORT( true,
151 ">>> ERROR: (Intrepid2::Basis_HCURL_TRI_In_FEM::Functor) operator is not supported");
152
153 }
154 }
155 }
156 };
157};
158}
159
160template<typename DeviceType = void,
161 typename outputValueType = double,
162 typename pointValueType = double>
164 : public Basis<DeviceType,outputValueType,pointValueType> {
165 public:
166 using BasisBase = Basis<DeviceType, outputValueType, pointValueType>;
167 using typename BasisBase::ExecutionSpace;
171
174 Basis_HCURL_TRI_In_FEM(const ordinal_type order,
175 const EPointType pointType = POINTTYPE_EQUISPACED);
176
178
179 using typename BasisBase::OutputViewType;
180 using typename BasisBase::PointViewType;
181 using typename BasisBase::ScalarViewType;
182
183 using typename BasisBase::scalarType;
184
186
187 virtual
188 void
189 getValues(
190 const ExecutionSpace& space,
191 OutputViewType outputValues,
192 const PointViewType inputPoints,
193 const EOperator operatorType = OPERATOR_VALUE) const override {
194#ifdef HAVE_INTREPID2_DEBUG
196 inputPoints,
197 operatorType,
198 this->getBaseCellTopology(),
199 this->getCardinality() );
200#endif
201 constexpr ordinal_type numPtsPerEval = Parameters::MaxNumPtsPerBasisEval;
202 Impl::Basis_HCURL_TRI_In_FEM::
203 getValues<DeviceType,numPtsPerEval>(
204 space,
205 outputValues,
206 inputPoints,
207 this->coeffs_,
208 operatorType);
209 }
210
211 virtual void
212 getScratchSpaceSize( ordinal_type& perTeamSpaceSize,
213 ordinal_type& perThreadSpaceSize,
214 const PointViewType inputPointsconst,
215 const EOperator operatorType = OPERATOR_VALUE) const override;
216
217 KOKKOS_INLINE_FUNCTION
218 virtual void
219 getValues(
220 OutputViewType outputValues,
221 const PointViewType inputPoints,
222 const EOperator operatorType,
223 const typename Kokkos::TeamPolicy<typename DeviceType::execution_space>::member_type& team_member,
224 const typename DeviceType::execution_space::scratch_memory_space & scratchStorage,
225 const ordinal_type subcellDim = -1,
226 const ordinal_type subcellOrdinal = -1) const override;
227
228 virtual
229 void
230 getDofCoords( ScalarViewType dofCoords ) const override {
231#ifdef HAVE_INTREPID2_DEBUG
232 // Verify rank of output array.
233 INTREPID2_TEST_FOR_EXCEPTION( rank(dofCoords) != 2, std::invalid_argument,
234 ">>> ERROR: (Intrepid2::Basis_HCURL_TRI_In_FEM::getDofCoords) rank = 2 required for dofCoords array");
235 // Verify 0th dimension of output array.
236 INTREPID2_TEST_FOR_EXCEPTION( static_cast<ordinal_type>(dofCoords.extent(0)) != this->getCardinality(), std::invalid_argument,
237 ">>> ERROR: (Intrepid2::Basis_HCURL_TRI_In_FEM::getDofCoords) mismatch in number of dof and 0th dimension of dofCoords array");
238 // Verify 1st dimension of output array.
239 INTREPID2_TEST_FOR_EXCEPTION( dofCoords.extent(1) != this->getBaseCellTopology().getDimension(), std::invalid_argument,
240 ">>> ERROR: (Intrepid2::Basis_HCURL_TRI_In_FEM::getDofCoords) incorrect reference cell (1st) dimension in dofCoords array");
241#endif
242 Kokkos::deep_copy(dofCoords, this->dofCoords_);
243 }
244
245 virtual
246 void
247 getDofCoeffs( ScalarViewType dofCoeffs ) const override {
248#ifdef HAVE_INTREPID2_DEBUG
249 // Verify rank of output array.
250 INTREPID2_TEST_FOR_EXCEPTION( rank(dofCoeffs) != 2, std::invalid_argument,
251 ">>> ERROR: (Intrepid2::Basis_HCURL_TRI_In_FEM::getDofCoeffs) rank = 2 required for dofCoeffs array");
252 // Verify 0th dimension of output array.
253 INTREPID2_TEST_FOR_EXCEPTION( static_cast<ordinal_type>(dofCoeffs.extent(0)) != this->getCardinality(), std::invalid_argument,
254 ">>> ERROR: (Intrepid2::Basis_HCURL_TRI_In_FEM::getDofCoeffs) mismatch in number of dof and 0th dimension of dofCoeffs array");
255 // Verify 1st dimension of output array.
256 INTREPID2_TEST_FOR_EXCEPTION( dofCoeffs.extent(1) != this->getBaseCellTopology().getDimension(), std::invalid_argument,
257 ">>> ERROR: (Intrepid2::Basis_HCURL_TRI_In_FEM::getDofCoeffs) incorrect reference cell (1st) dimension in dofCoeffs array");
258#endif
259 Kokkos::deep_copy(dofCoeffs, this->dofCoeffs_);
260 }
261
262 void
263 getExpansionCoeffs( ScalarViewType coeffs ) const {
264 // has to be same rank and dimensions
265 Kokkos::deep_copy(coeffs, this->coeffs_);
266 }
267
268 virtual
269 const char*
270 getName() const override {
271 return "Intrepid2_HCURL_TRI_In_FEM";
272 }
273
274 virtual
275 bool
276 requireOrientation() const override {
277 return true;
278 }
279
290 getSubCellRefBasis(const ordinal_type subCellDim, const ordinal_type subCellOrd) const override{
291 if(subCellDim == 1) {
292 return Teuchos::rcp(new
294 ( this->basisDegree_ - 1, pointType_) );
295 }
296 INTREPID2_TEST_FOR_EXCEPTION(true,std::invalid_argument,"Input parameters out of bounds");
297 }
298
303 private:
304
307 Kokkos::DynRankView<scalarType,DeviceType> coeffs_;
308
310 EPointType pointType_;
311
312};
313
314}// namespace Intrepid2
315
317
318#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,...
Teuchos::RCP< Basis< DeviceType, OutputType, PointType > > BasisPtr
Basis Pointer.
void getValues_HCURL_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 HCURL-conforming FEM basis....
Definition file for FEM basis functions of degree n for H(curl) functions on TRI.
Header file for the Intrepid2::Basis_HGRAD_TRI_Cn_FEM_ORTH class.
Header file for the Intrepid2::Basis_HVOL_LINE_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.
Basis_HCURL_TRI_In_FEM(const ordinal_type order, const EPointType pointType=POINTTYPE_EQUISPACED)
Constructor.
virtual const char * getName() const override
Returns basis name.
BasisPtr< DeviceType, outputValueType, pointValueType > getSubCellRefBasis(const ordinal_type subCellDim, const ordinal_type subCellOrd) const override
returns the basis associated to a subCell.
virtual void getDofCoords(ScalarViewType dofCoords) const override
Returns spatial locations (coordinates) of degrees of freedom on the 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 locally HVOL-compatible FEM basis of variable order on the [-1,...
Kokkos::DynRankView< PointValueType, Kokkos::LayoutStride, DeviceType > PointViewType
View type for input points.
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 > OrdinalTypeArray3DHost
ordinal_type basisDegree_
Degree of the largest complete polynomial space that can be represented by the basis.
Kokkos::DynRankView< scalarType, Kokkos::LayoutStride, DeviceType > ScalarViewType
View type for scalars.
Kokkos::DynRankView< scalarType, DeviceType > dofCoords_
Coordinates of degrees-of-freedom for basis functions defined in physical space.
Kokkos::DynRankView< scalarType, DeviceType > dofCoeffs_
Coefficients for computing degrees of freedom for Lagrangian basis If P is an element of the space sp...
Kokkos::View< ordinal_type **, typename ExecutionSpace::array_layout, Kokkos::HostSpace > OrdinalTypeArray2DHost
ScalarTraits< pointValueType >::scalar_type scalarType
Scalar type for point values.
shards::CellTopology getBaseCellTopology() const
Kokkos::View< ordinal_type *, typename ExecutionSpace::array_layout, Kokkos::HostSpace > OrdinalTypeArray1DHost
See Intrepid2::Basis_HCURL_TRI_In_FEM.
static constexpr ordinal_type MaxNumPtsPerBasisEval
The maximum number of points to eval in serial mode.