Intrepid2
Intrepid2_HDIV_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_HDIV_TRI_IN_FEM_HPP__
17#define __INTREPID2_HDIV_TRI_IN_FEM_HPP__
18
19#include "Intrepid2_Basis.hpp"
22
24#include "Teuchos_LAPACK.hpp"
25
26namespace Intrepid2 {
27
55
56#define CardinalityHDivTri(order) (order*(order+2))
57
58namespace Impl {
59
64public:
65 typedef struct Triangle<3> cell_topology_type;
66
70 template<EOperator opType>
71 struct Serial {
72 template<typename outputValueViewType,
73 typename inputPointViewType,
74 typename workViewType,
75 typename vinvViewType>
76 KOKKOS_INLINE_FUNCTION
77 static void
78 getValues( outputValueViewType outputValues,
79 const inputPointViewType inputPoints,
80 workViewType work,
81 const vinvViewType vinv );
82
83 KOKKOS_INLINE_FUNCTION
84 static ordinal_type
85 getWorkSizePerPoint(ordinal_type order) {
86 auto cardinality = CardinalityHDivTri(order);
87 switch (opType) {
88 case OPERATOR_GRAD:
89 case OPERATOR_DIV:
90 case OPERATOR_D1:
91 return 5*cardinality;
92 default:
93 return getDkCardinality<opType,2>()*cardinality;
94 }
95 }
96 };
97
98 template<typename DeviceType, ordinal_type numPtsPerEval,
99 typename outputValueValueType, class ...outputValueProperties,
100 typename inputPointValueType, class ...inputPointProperties,
101 typename vinvValueType, class ...vinvProperties>
102 static void
103 getValues( Kokkos::DynRankView<outputValueValueType,outputValueProperties...> outputValues,
104 const Kokkos::DynRankView<inputPointValueType, inputPointProperties...> inputPoints,
105 const Kokkos::DynRankView<vinvValueType, vinvProperties...> vinv,
106 const EOperator operatorType);
107
111 template<typename outputValueViewType,
112 typename inputPointViewType,
113 typename vinvViewType,
114 typename workViewType,
115 EOperator opType,
116 ordinal_type numPtsEval>
117 struct Functor {
118 outputValueViewType _outputValues;
119 const inputPointViewType _inputPoints;
120 const vinvViewType _coeffs;
121 workViewType _work;
122
123 KOKKOS_INLINE_FUNCTION
124 Functor( outputValueViewType outputValues_,
125 inputPointViewType inputPoints_,
126 vinvViewType coeffs_,
127 workViewType work_)
128 : _outputValues(outputValues_), _inputPoints(inputPoints_),
129 _coeffs(coeffs_), _work(work_) {}
130
131 KOKKOS_INLINE_FUNCTION
132 void operator()(const size_type iter) const {
133 const auto ptBegin = Util<ordinal_type>::min(iter*numPtsEval, _inputPoints.extent(0));
134 const auto ptEnd = Util<ordinal_type>::min(ptBegin+numPtsEval, _inputPoints.extent(0));
135
136 const auto ptRange = Kokkos::pair<ordinal_type,ordinal_type>(ptBegin, ptEnd);
137 const auto input = Kokkos::subview( _inputPoints, ptRange, Kokkos::ALL() );
138
139 typename workViewType::pointer_type ptr = _work.data() + _work.extent(0)*ptBegin*get_dimension_scalar(_work);
140
141 workViewType work = createMatchingUnmanagedView<workViewType>(_work, ptr, (ptEnd-ptBegin)*_work.extent(0));
142
143
144 switch (opType) {
145 case OPERATOR_VALUE : {
146 auto output = Kokkos::subview( _outputValues, Kokkos::ALL(), ptRange, Kokkos::ALL() );
147 Serial<opType>::getValues( output, input, work, _coeffs );
148 break;
149 }
150 case OPERATOR_DIV: {
151 auto output = Kokkos::subview( _outputValues, Kokkos::ALL(), ptRange);
152 Serial<opType>::getValues( output, input, work, _coeffs );
153 break;
154 }
155 default: {
156 INTREPID2_TEST_FOR_ABORT( true,
157 ">>> ERROR: (Intrepid2::Basis_HDIV_TRI_In_FEM::Functor) operator is not supported");
158
159 }
160 }
161 }
162 };
163};
164}
165
166template<typename DeviceType = void,
167 typename outputValueType = double,
168 typename pointValueType = double>
170 : public Basis<DeviceType,outputValueType,pointValueType> {
171 public:
172 using BasisBase = Basis<DeviceType, outputValueType, pointValueType>;
173 using OrdinalTypeArray1DHost = typename BasisBase::OrdinalTypeArray1DHost;
174 using OrdinalTypeArray2DHost = typename BasisBase::OrdinalTypeArray2DHost;
175 using OrdinalTypeArray3DHost = typename BasisBase::OrdinalTypeArray3DHost;
176
179 Basis_HDIV_TRI_In_FEM(const ordinal_type order,
180 const EPointType pointType = POINTTYPE_EQUISPACED);
181
183
184 using OutputViewType = typename BasisBase::OutputViewType;
185 using PointViewType = typename BasisBase::PointViewType;
186 using ScalarViewType = typename BasisBase::ScalarViewType;
187 using scalarType = typename BasisBase::scalarType;
189
190 virtual
191 void
192 getValues( OutputViewType outputValues,
193 const PointViewType inputPoints,
194 const EOperator operatorType = OPERATOR_VALUE) const override {
195#ifdef HAVE_INTREPID2_DEBUG
197 inputPoints,
198 operatorType,
199 this->getBaseCellTopology(),
200 this->getCardinality() );
201#endif
202 constexpr ordinal_type numPtsPerEval = Parameters::MaxNumPtsPerBasisEval;
203 Impl::Basis_HDIV_TRI_In_FEM::
204 getValues<DeviceType,numPtsPerEval>( outputValues,
205 inputPoints,
206 this->coeffs_,
207 operatorType);
208 }
209
210 virtual void
211 getScratchSpaceSize( ordinal_type& perTeamSpaceSize,
212 ordinal_type& perThreadSpaceSize,
213 const PointViewType inputPointsconst,
214 const EOperator operatorType = OPERATOR_VALUE) const override;
215
216 KOKKOS_INLINE_FUNCTION
217 virtual void
218 getValues(
219 OutputViewType outputValues,
220 const PointViewType inputPoints,
221 const EOperator operatorType,
222 const typename Kokkos::TeamPolicy<typename DeviceType::execution_space>::member_type& team_member,
223 const typename DeviceType::execution_space::scratch_memory_space & scratchStorage,
224 const ordinal_type subcellDim = -1,
225 const ordinal_type subcellOrdinal = -1) const override;
226
227 virtual
228 void
229 getDofCoords( ScalarViewType dofCoords ) const override {
230#ifdef HAVE_INTREPID2_DEBUG
231 // Verify rank of output array.
232 INTREPID2_TEST_FOR_EXCEPTION( dofCoords.rank() != 2, std::invalid_argument,
233 ">>> ERROR: (Intrepid2::Basis_HDIV_TRI_In_FEM::getDofCoords) rank = 2 required for dofCoords array");
234 // Verify 0th dimension of output array.
235 INTREPID2_TEST_FOR_EXCEPTION( static_cast<ordinal_type>(dofCoords.extent(0)) != this->getCardinality(), std::invalid_argument,
236 ">>> ERROR: (Intrepid2::Basis_HDIV_TRI_In_FEM::getDofCoords) mismatch in number of dof and 0th dimension of dofCoords array");
237 // Verify 1st dimension of output array.
238 INTREPID2_TEST_FOR_EXCEPTION( dofCoords.extent(1) != this->getBaseCellTopology().getDimension(), std::invalid_argument,
239 ">>> ERROR: (Intrepid2::Basis_HDIV_TRI_In_FEM::getDofCoords) incorrect reference cell (1st) dimension in dofCoords array");
240#endif
241 Kokkos::deep_copy(dofCoords, this->dofCoords_);
242 }
243
244 virtual
245 void
246 getDofCoeffs( ScalarViewType dofCoeffs ) const override {
247#ifdef HAVE_INTREPID2_DEBUG
248 // Verify rank of output array.
249 INTREPID2_TEST_FOR_EXCEPTION( dofCoeffs.rank() != 2, std::invalid_argument,
250 ">>> ERROR: (Intrepid2::Basis_HDIV_TRI_In_FEM::getDofCoeffs) rank = 2 required for dofCoeffs array");
251 // Verify 0th dimension of output array.
252 INTREPID2_TEST_FOR_EXCEPTION( static_cast<ordinal_type>(dofCoeffs.extent(0)) != this->getCardinality(), std::invalid_argument,
253 ">>> ERROR: (Intrepid2::Basis_HDIV_TRI_In_FEM::getDofCoeffs) mismatch in number of dof and 0th dimension of dofCoeffs array");
254 // Verify 1st dimension of output array.
255 INTREPID2_TEST_FOR_EXCEPTION( dofCoeffs.extent(1) != this->getBaseCellTopology().getDimension(), std::invalid_argument,
256 ">>> ERROR: (Intrepid2::Basis_HDIV_TRI_In_FEM::getDofCoeffs) incorrect reference cell (1st) dimension in dofCoeffs array");
257#endif
258 Kokkos::deep_copy(dofCoeffs, this->dofCoeffs_);
259 }
260
261 void
262 getExpansionCoeffs( ScalarViewType coeffs ) const {
263 // has to be same rank and dimensions
264 Kokkos::deep_copy(coeffs, this->coeffs_);
265 }
266
267 virtual
268 const char*
269 getName() const override {
270 return "Intrepid2_HDIV_TRI_In_FEM";
271 }
272
273 virtual
274 bool
275 requireOrientation() const override {
276 return true;
277 }
278
289 getSubCellRefBasis(const ordinal_type subCellDim, const ordinal_type subCellOrd) const override{
290 if(subCellDim == 1) {
291 return Teuchos::rcp(new
293 (this->basisDegree_-1, pointType_));
294 }
295 INTREPID2_TEST_FOR_EXCEPTION(true,std::invalid_argument,"Input parameters out of bounds");
296 }
297
302 private:
303
306 Kokkos::DynRankView<scalarType,DeviceType> coeffs_;
307
309 EPointType pointType_;
310
311};
312
313}// namespace Intrepid2
314
316
317#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(div) functions on TRI cells.
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...
Basis_HDIV_TRI_In_FEM(const ordinal_type order, const EPointType pointType=POINTTYPE_EQUISPACED)
Constructor.
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 void getDofCoeffs(ScalarViewType dofCoeffs) const override
Coefficients for computing degrees of freedom for Lagrangian basis If P is an element of the space sp...
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 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.
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_HDIV_TRI_In_FEM.
static constexpr ordinal_type MaxNumPtsPerBasisEval
The maximum number of points to eval in serial mode.