Intrepid2
Intrepid2_HVOL_QUAD_Cn_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
14
15#ifndef __INTREPID2_HVOL_QUAD_CN_FEM_HPP__
16#define __INTREPID2_HVOL_QUAD_CN_FEM_HPP__
17
18#include "Intrepid2_Basis.hpp"
20
21namespace Intrepid2 {
22
23 namespace Impl {
24
29 public:
30 typedef struct Quadrilateral<4> cell_topology_type;
34 template<EOperator opType>
35 struct Serial {
36 template<typename outputValueViewType,
37 typename inputPointViewType,
38 typename workViewType,
39 typename vinvViewType>
40 KOKKOS_INLINE_FUNCTION
41 static void
42 getValues( outputValueViewType outputValues,
43 const inputPointViewType inputPoints,
44 workViewType work,
45 const vinvViewType vinv,
46 const ordinal_type operatorDn = 0 );
47
48 KOKKOS_INLINE_FUNCTION
49 static ordinal_type
50 getWorkSizePerPoint(ordinal_type order) {return 3*getPnCardinality<1>(order); }
51 };
52
53 template<typename DeviceType, ordinal_type numPtsPerEval,
54 typename outputValueValueType, class ...outputValueProperties,
55 typename inputPointValueType, class ...inputPointProperties,
56 typename vinvValueType, class ...vinvProperties>
57 static void
58 getValues( Kokkos::DynRankView<outputValueValueType,outputValueProperties...> outputValues,
59 const Kokkos::DynRankView<inputPointValueType, inputPointProperties...> inputPoints,
60 const Kokkos::DynRankView<vinvValueType, vinvProperties...> vinv,
61 const EOperator operatorType);
62
66 template<typename outputValueViewType,
67 typename inputPointViewType,
68 typename vinvViewType,
69 typename workViewType,
70 EOperator opType,
71 ordinal_type numPtsEval>
72 struct Functor {
73 outputValueViewType _outputValues;
74 const inputPointViewType _inputPoints;
75 const vinvViewType _vinv;
76 workViewType _work;
77 const ordinal_type _opDn;
78
79 KOKKOS_INLINE_FUNCTION
80 Functor( outputValueViewType outputValues_,
81 inputPointViewType inputPoints_,
82 vinvViewType vinv_,
83 workViewType work_,
84 const ordinal_type opDn_ = 0 )
85 : _outputValues(outputValues_), _inputPoints(inputPoints_),
86 _vinv(vinv_), _work(work_), _opDn(opDn_) {}
87
88 KOKKOS_INLINE_FUNCTION
89 void operator()(const size_type iter) const {
90 const auto ptBegin = Util<ordinal_type>::min(iter*numPtsEval, _inputPoints.extent(0));
91 const auto ptEnd = Util<ordinal_type>::min(ptBegin+numPtsEval, _inputPoints.extent(0));
92
93 const auto ptRange = Kokkos::pair<ordinal_type,ordinal_type>(ptBegin, ptEnd);
94 const auto input = Kokkos::subview( _inputPoints, ptRange, Kokkos::ALL() );
95
96 typename workViewType::pointer_type ptr = _work.data() + _work.extent(0)*ptBegin*get_dimension_scalar(_work);
97
98 workViewType work = createMatchingUnmanagedView<workViewType>(_work, ptr, (ptEnd-ptBegin)*_work.extent(0));
99
100 switch (opType) {
101 case OPERATOR_VALUE : {
102 auto output = Kokkos::subview( _outputValues, Kokkos::ALL(), ptRange );
103 Serial<opType>::getValues( output, input, work, _vinv );
104 break;
105 }
106 case OPERATOR_Dn : {
107 auto output = Kokkos::subview( _outputValues, Kokkos::ALL(), ptRange, Kokkos::ALL() );
108 Serial<opType>::getValues( output, input, work, _vinv, _opDn );
109 break;
110 }
111 default: {
112 INTREPID2_TEST_FOR_ABORT( true,
113 ">>> ERROR: (Intrepid2::Basis_HVOL_QUAD_Cn_FEM::Functor) operator is not supported");
114
115 }
116 }
117 }
118 };
119 };
120 }
121
128 template<typename DeviceType = void,
129 typename outputValueType = double,
130 typename pointValueType = double>
132 : public Basis<DeviceType,outputValueType,pointValueType> {
133 public:
134 using BasisBase = Basis<DeviceType,outputValueType,pointValueType>;
135
139
140 using typename BasisBase::OutputViewType;
141 using typename BasisBase::PointViewType ;
142 using typename BasisBase::ScalarViewType;
143
146 Basis_HVOL_QUAD_Cn_FEM(const ordinal_type order,
147 const EPointType pointType = POINTTYPE_EQUISPACED);
148
150
151 virtual
152 void
153 getValues( OutputViewType outputValues,
154 const PointViewType inputPoints,
155 const EOperator operatorType = OPERATOR_VALUE ) const override {
156#ifdef HAVE_INTREPID2_DEBUG
158 inputPoints,
159 operatorType,
160 this->getBaseCellTopology(),
161 this->getCardinality() );
162#endif
163 constexpr ordinal_type numPtsPerEval = Parameters::MaxNumPtsPerBasisEval;
164 Impl::Basis_HVOL_QUAD_Cn_FEM::
165 getValues<DeviceType,numPtsPerEval>( outputValues,
166 inputPoints,
167 this->vinv_,
168 operatorType );
169 }
170
171 virtual void
172 getScratchSpaceSize( ordinal_type& perTeamSpaceSize,
173 ordinal_type& perThreadSpaceSize,
174 const PointViewType inputPoints,
175 const EOperator operatorType = OPERATOR_VALUE) const override;
176
177 KOKKOS_INLINE_FUNCTION
178 virtual void
179 getValues(
180 OutputViewType outputValues,
181 const PointViewType inputPoints,
182 const EOperator operatorType,
183 const typename Kokkos::TeamPolicy<typename DeviceType::execution_space>::member_type& team_member,
184 const typename DeviceType::execution_space::scratch_memory_space & scratchStorage,
185 const ordinal_type subcellDim = -1,
186 const ordinal_type subcellOrdinal = -1) const override;
187
188
189 virtual
190 void
191 getDofCoords( ScalarViewType dofCoords ) const override {
192#ifdef HAVE_INTREPID2_DEBUG
193 // Verify rank of output array.
194 INTREPID2_TEST_FOR_EXCEPTION( dofCoords.rank() != 2, std::invalid_argument,
195 ">>> ERROR: (Intrepid2::Basis_HVOL_QUAD_Cn_FEM::getDofCoords) rank = 2 required for dofCoords array");
196 // Verify 0th dimension of output array.
197 INTREPID2_TEST_FOR_EXCEPTION( static_cast<ordinal_type>(dofCoords.extent(0)) != this->getCardinality(), std::invalid_argument,
198 ">>> ERROR: (Intrepid2::Basis_HVOL_QUAD_Cn_FEM::getDofCoords) mismatch in number of dof and 0th dimension of dofCoords array");
199 // Verify 1st dimension of output array.
200 INTREPID2_TEST_FOR_EXCEPTION( dofCoords.extent(1) != this->getBaseCellTopology().getDimension(), std::invalid_argument,
201 ">>> ERROR: (Intrepid2::Basis_HVOL_QUAD_Cn_FEM::getDofCoords) incorrect reference cell (1st) dimension in dofCoords array");
202#endif
203 Kokkos::deep_copy(dofCoords, this->dofCoords_);
204 }
205
206 virtual
207 void
208 getDofCoeffs( ScalarViewType dofCoeffs ) const override {
209#ifdef HAVE_INTREPID2_DEBUG
210 // Verify rank of output array.
211 INTREPID2_TEST_FOR_EXCEPTION( dofCoeffs.rank() != 1, std::invalid_argument,
212 ">>> ERROR: (Intrepid2::Basis_HVOL_QUAD_Cn_FEM::getdofCoeffs) rank = 1 required for dofCoeffs array");
213 // Verify 0th dimension of output array.
214 INTREPID2_TEST_FOR_EXCEPTION( static_cast<ordinal_type>(dofCoeffs.extent(0)) != this->getCardinality(), std::invalid_argument,
215 ">>> ERROR: (Intrepid2::Basis_HVOL_QUAD_Cn_FEM::getdofCoeffs) mismatch in number of dof and 0th dimension of dofCoeffs array");
216#endif
217 Kokkos::deep_copy(dofCoeffs, 1.0);
218 }
219
220 virtual
221 const char*
222 getName() const override {
223 return "Intrepid2_HVOL_QUAD_Cn_FEM";
224 }
225
226 virtual
227 bool
228 requireOrientation() const override {
229 return false;
230 }
231
236
237 private:
238
240 Kokkos::DynRankView<typename ScalarViewType::value_type,DeviceType> vinv_;
241 EPointType pointType_;
242 };
243
244}// namespace Intrepid2
245
247
248#endif
Header file for the abstract base class Intrepid2::Basis.
BasisPtr< typename Kokkos::HostSpace::device_type, OutputType, PointType > HostBasisPtr
Pointer to a Basis whose device type is on the host (Kokkos::HostSpace::device_type),...
KOKKOS_INLINE_FUNCTION ordinal_type getPnCardinality(ordinal_type n)
Returns cardinality of Polynomials of order n (P^n).
void getValues_HVOL_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 HVOL-conforming FEM basis....
Header file for the Intrepid2::Basis_HVOL_LINE_Cn_FEM class.
Definition file for FEM basis functions of degree n for H(vol) functions on QUAD.
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...
Kokkos::DynRankView< typename ScalarViewType::value_type, ExecutionSpace > vinv_
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.
virtual HostBasisPtr< 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_HVOL_QUAD_Cn_FEM(const ordinal_type order, const EPointType pointType=POINTTYPE_EQUISPACED)
Constructor.
virtual void getDofCoords(ScalarViewType dofCoords) const override
Returns spatial locations (coordinates) of degrees of freedom on the reference 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
Team-level evaluation of basis functions on a reference cell.
Kokkos::DynRankView< OutputValueType, Kokkos::LayoutStride, DeviceType > OutputViewType
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
Kokkos::DynRankView< scalarType, DeviceType > dofCoords_
Coordinates of degrees-of-freedom for basis functions defined in physical space.
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_HVOL_QUAD_Cn_FEM.
static constexpr ordinal_type MaxNumPtsPerBasisEval
The maximum number of points to eval in serial mode.