Intrepid2
Intrepid2_HCURL_QUAD_In_FEM.hpp
Go to the documentation of this file.
1// @HEADER
2// ************************************************************************
3//
4// Intrepid2 Package
5// Copyright (2007) Sandia Corporation
6//
7// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8// license for use of this work by or on behalf of the U.S. Government.
9//
10// Redistribution and use in source and binary forms, with or without
11// modification, are permitted provided that the following conditions are
12// met:
13//
14// 1. Redistributions of source code must retain the above copyright
15// notice, this list of conditions and the following disclaimer.
16//
17// 2. Redistributions in binary form must reproduce the above copyright
18// notice, this list of conditions and the following disclaimer in the
19// documentation and/or other materials provided with the distribution.
20//
21// 3. Neither the name of the Corporation nor the names of the
22// contributors may be used to endorse or promote products derived from
23// this software without specific prior written permission.
24//
25// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36//
37// Questions? Contact Kyungjoo Kim (kyukim@sandia.gov), or
38// Mauro Perego (mperego@sandia.gov)
39//
40// ************************************************************************
41// @HEADER
42
49#ifndef __INTREPID2_HCURL_QUAD_IN_FEM_HPP__
50#define __INTREPID2_HCURL_QUAD_IN_FEM_HPP__
51
52#include "Intrepid2_Basis.hpp"
55
56namespace Intrepid2 {
57
58 namespace Impl {
59
64 public:
65 typedef struct Quadrilateral<4> cell_topology_type;
66
70 template<EOperator opType>
71 struct Serial {
72 template<typename outputValueViewType,
73 typename inputPointViewType,
74 typename workViewType,
75 typename vinvViewType>
77 static void
83
85 static ordinal_type
86 getWorkSizePerPoint(ordinal_type order) {
88 }
89 };
90
91 template<typename DeviceType, ordinal_type numPtsPerEval,
92 typename outputValueValueType, class ...outputValueProperties,
93 typename inputPointValueType, class ...inputPointProperties,
94 typename vinvValueType, class ...vinvProperties>
95 static void
96 getValues( Kokkos::DynRankView<outputValueValueType,outputValueProperties...> outputValues,
97 const Kokkos::DynRankView<inputPointValueType, inputPointProperties...> inputPoints,
98 const Kokkos::DynRankView<vinvValueType, vinvProperties...> vinvLine,
99 const Kokkos::DynRankView<vinvValueType, vinvProperties...> vinvBubble,
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 _vinvLine;
115 const vinvViewType _vinvBubble;
116 workViewType _work;
117
120 inputPointViewType inputPoints_,
121 vinvViewType vinvLine_,
122 vinvViewType vinvBubble_,
124 : _outputValues(outputValues_), _inputPoints(inputPoints_),
125 _vinvLine(vinvLine_), _vinvBubble(vinvBubble_), _work(work_) {}
126
128 void operator()(const size_type iter) const {
129 const auto ptBegin = Util<ordinal_type>::min(iter*numPtsEval, _inputPoints.extent(0));
130 const auto ptEnd = Util<ordinal_type>::min(ptBegin+numPtsEval, _inputPoints.extent(0));
131
132 const auto ptRange = Kokkos::pair<ordinal_type,ordinal_type>(ptBegin, ptEnd);
133 const auto input = Kokkos::subview( _inputPoints, ptRange, Kokkos::ALL() );
134
135 typename workViewType::pointer_type ptr = _work.data() + _work.extent(0)*ptBegin*get_dimension_scalar(_work);
136
137 auto vcprop = Kokkos::common_view_alloc_prop(_work);
138 workViewType work(Kokkos::view_wrap(ptr,vcprop), (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, _vinvLine, _vinvBubble );
144 break;
145 }
146 case OPERATOR_CURL : {
147 auto output = Kokkos::subview( _outputValues, Kokkos::ALL(), ptRange );
148 Serial<opType>::getValues( output, input, work, _vinvLine, _vinvBubble );
149 break;
150 }
151 default: {
152 INTREPID2_TEST_FOR_ABORT( true,
153 ">>> ERROR: (Intrepid2::Basis_HCURL_QUAD_In_FEM::Functor) operator is not supported");
154
155 }
156 }
157 }
158 };
159 };
160 }
161
166 template<typename DeviceType = void,
167 typename outputValueType = double,
168 typename pointValueType = double>
170 : public Basis<DeviceType,outputValueType,pointValueType> {
171 public:
175
178 Basis_HCURL_QUAD_In_FEM(const ordinal_type order,
179 const EPointType pointType = POINTTYPE_EQUISPACED);
180
184
185 using Basis<DeviceType,outputValueType,pointValueType>::getValues;
186
187 virtual
188 void
189 getValues( OutputViewType outputValues,
190 const PointViewType inputPoints,
191 const EOperator operatorType = OPERATOR_VALUE ) const override {
192#ifdef HAVE_INTREPID2_DEBUG
194 inputPoints,
195 operatorType,
196 this->getBaseCellTopology(),
197 this->getCardinality() );
198#endif
199 constexpr ordinal_type numPtsPerEval = Parameters::MaxNumPtsPerBasisEval;
200 Impl::Basis_HCURL_QUAD_In_FEM::
201 getValues<DeviceType,numPtsPerEval>( outputValues,
202 inputPoints,
203 this->vinvLine_,
204 this->vinvBubble_,
205 operatorType );
206 }
207
208 virtual
209 void
210 getDofCoords( ScalarViewType dofCoords ) const override {
211#ifdef HAVE_INTREPID2_DEBUG
212 // Verify rank of output array.
213 INTREPID2_TEST_FOR_EXCEPTION( dofCoords.rank() != 2, std::invalid_argument,
214 ">>> ERROR: (Intrepid2::Basis_HCURL_QUAD_In_FEM::getDofCoords) rank = 2 required for dofCoords array");
215 // Verify 0th dimension of output array.
216 INTREPID2_TEST_FOR_EXCEPTION( static_cast<ordinal_type>(dofCoords.extent(0)) != this->getCardinality(), std::invalid_argument,
217 ">>> ERROR: (Intrepid2::Basis_HCURL_QUAD_In_FEM::getDofCoords) mismatch in number of dof and 0th dimension of dofCoords array");
218 // Verify 1st dimension of output array.
219 INTREPID2_TEST_FOR_EXCEPTION( dofCoords.extent(1) != this->getBaseCellTopology().getDimension(), std::invalid_argument,
220 ">>> ERROR: (Intrepid2::Basis_HCURL_QUAD_In_FEM::getDofCoords) incorrect reference cell (1st) dimension in dofCoords array");
221#endif
222 Kokkos::deep_copy(dofCoords, this->dofCoords_);
223 }
224
225 virtual
226 void
227 getDofCoeffs( ScalarViewType dofCoeffs ) const override {
228#ifdef HAVE_INTREPID2_DEBUG
229 // Verify rank of output array.
230 INTREPID2_TEST_FOR_EXCEPTION( dofCoeffs.rank() != 2, std::invalid_argument,
231 ">>> ERROR: (Intrepid2::Basis_HCURL_QUAD_In_FEM::getDofCoeffs) rank = 2 required for dofCoeffs array");
232 // Verify 0th dimension of output array.
233 INTREPID2_TEST_FOR_EXCEPTION( static_cast<ordinal_type>(dofCoeffs.extent(0)) != this->getCardinality(), std::invalid_argument,
234 ">>> ERROR: (Intrepid2::Basis_HCURL_QUAD_In_FEM::getDofCoeffs) mismatch in number of dof and 0th dimension of dofCoeffs array");
235 // Verify 1st dimension of output array.
236 INTREPID2_TEST_FOR_EXCEPTION( dofCoeffs.extent(1) != this->getBaseCellTopology().getDimension(), std::invalid_argument,
237 ">>> ERROR: (Intrepid2::Basis_HCURL_QUAD_In_FEM::getDofCoeffs) incorrect reference cell (1st) dimension in dofCoeffs array");
238#endif
239 Kokkos::deep_copy(dofCoeffs, this->dofCoeffs_);
240 }
241
242 virtual
243 const char*
244 getName() const override {
245 return "Intrepid2_HCURL_QUAD_In_FEM";
246 }
247
248 virtual
249 bool
250 requireOrientation() const override {
251 return true;
252 }
253
264 getSubCellRefBasis(const ordinal_type subCellDim, const ordinal_type subCellOrd) const override{
265 if(subCellDim == 1)
266 return Teuchos::rcp( new
268 ( this->basisDegree_ - 1, POINTTYPE_GAUSS ) );
269
270 INTREPID2_TEST_FOR_EXCEPTION(true,std::invalid_argument,"Input parameters out of bounds");
271 }
272
277
278 private:
279
281 Kokkos::DynRankView<typename ScalarViewType::value_type,DeviceType> vinvLine_, vinvBubble_;
282 EPointType pointType_;
283 };
284
285}// namespace Intrepid2
286
287
289
290#endif
Header file for the abstract base class Intrepid2::Basis.
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 QUAD cells.
Header file for the Intrepid2::Basis_HGRAD_LINE_Cn_FEM class.
Header file for the Intrepid2::Basis_HVOL_LINE_Cn_FEM class.
Implementation of the default H(curl)-compatible FEM basis on Quadrilateral cell.
virtual bool requireOrientation() const override
True if orientation is required.
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 getDofCoords(ScalarViewType dofCoords) const override
Returns spatial locations (coordinates) of degrees of freedom on the reference cell.
Kokkos::DynRankView< typename ScalarViewType::value_type, DeviceType > vinvLine_
inverse of Generalized Vandermonde matrix (isotropic order)
virtual const char * getName() const override
Returns basis name.
virtual void getValues(OutputViewType outputValues, const PointViewType inputPoints, const EOperator operatorType=OPERATOR_VALUE) const override
Evaluation of a FEM basis on a reference cell.
BasisPtr< DeviceType, outputValueType, pointValueType > getSubCellRefBasis(const ordinal_type subCellDim, const ordinal_type subCellOrd) const override
returns the basis associated to a subCell.
Basis_HCURL_QUAD_In_FEM(const ordinal_type order, const EPointType pointType=POINTTYPE_EQUISPACED)
Constructor.
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,...
An abstract base class that defines interface for concrete basis implementations for Finite Element (...
Kokkos::DynRankView< PointValueType, Kokkos::LayoutStride, DeviceType > PointViewType
View type for input points.
Kokkos::DynRankView< OutputValueType, Kokkos::LayoutStride, DeviceType > OutputViewType
View type for basis value output.
Kokkos::View< ordinal_type ***, typename ExecutionSpace::array_layout, Kokkos::HostSpace > OrdinalTypeArray3DHost
View type for 3d host array.
ordinal_type basisDegree_
Degree of the largest complete polynomial space that can be represented by the basis.
ordinal_type getCardinality() const
Returns cardinality of the basis.
Kokkos::DynRankView< scalarType, Kokkos::LayoutStride, DeviceType > ScalarViewType
View type for scalars.
Device DeviceType
(Kokkos) Device type on which Basis is templated. Does not necessarily return true for Kokkos::is_dev...
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
View type for 2d host array.
shards::CellTopology getBaseCellTopology() const
Returns the base cell topology for which the basis is defined. See Shards documentation https://trili...
Kokkos::View< ordinal_type *, typename ExecutionSpace::array_layout, Kokkos::HostSpace > OrdinalTypeArray1DHost
View type for 1d host array.
See Intrepid2::Basis_HCURL_QUAD_In_FEM.
static constexpr ordinal_type MaxNumPtsPerBasisEval
The maximum number of points to eval in serial mode.
small utility functions