Intrepid2
Intrepid2_HDIV_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_HDIV_QUAD_IN_FEM_HPP__
50 #define __INTREPID2_HDIV_QUAD_IN_FEM_HPP__
51 
52 #include "Intrepid2_Basis.hpp"
53 #include "Intrepid2_HGRAD_LINE_Cn_FEM.hpp"
54 
55 namespace Intrepid2 {
56 
57  namespace Impl {
58 
62  class Basis_HDIV_QUAD_In_FEM {
63  public:
64  typedef struct Quadrilateral<4> cell_topology_type;
68  template<EOperator opType>
69  struct Serial {
70  template<typename outputValueViewType,
71  typename inputPointViewType,
72  typename workViewType,
73  typename vinvViewType>
74  KOKKOS_INLINE_FUNCTION
75  static void
76  getValues( outputValueViewType outputValues,
77  const inputPointViewType inputPoints,
78  workViewType work,
79  const vinvViewType vinvLine,
80  const vinvViewType vinvBubble );
81 
82  KOKKOS_INLINE_FUNCTION
83  static ordinal_type
84  getWorkSizePerPoint(ordinal_type order) {
85  return 2*getPnCardinality<1>(order)+getPnCardinality<1>(order-1);
86  }
87  };
88 
89  template<typename ExecSpaceType, ordinal_type numPtsPerEval,
90  typename outputValueValueType, class ...outputValueProperties,
91  typename inputPointValueType, class ...inputPointProperties,
92  typename vinvValueType, class ...vinvProperties>
93  static void
94  getValues( Kokkos::DynRankView<outputValueValueType,outputValueProperties...> outputValues,
95  const Kokkos::DynRankView<inputPointValueType, inputPointProperties...> inputPoints,
96  const Kokkos::DynRankView<vinvValueType, vinvProperties...> vinvLine,
97  const Kokkos::DynRankView<vinvValueType, vinvProperties...> vinvBubble,
98  const EOperator operatorType );
99 
103  template<typename outputValueViewType,
104  typename inputPointViewType,
105  typename vinvViewType,
106  typename workViewType,
107  EOperator opType,
108  ordinal_type numPtsEval>
109  struct Functor {
110  outputValueViewType _outputValues;
111  const inputPointViewType _inputPoints;
112  const vinvViewType _vinvLine;
113  const vinvViewType _vinvBubble;
114  workViewType _work;
115 
116  KOKKOS_INLINE_FUNCTION
117  Functor( outputValueViewType outputValues_,
118  inputPointViewType inputPoints_,
119  vinvViewType vinvLine_,
120  vinvViewType vinvBubble_,
121  workViewType work_)
122  : _outputValues(outputValues_), _inputPoints(inputPoints_),
123  _vinvLine(vinvLine_), _vinvBubble(vinvBubble_), _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  typename workViewType::pointer_type ptr = _work.data() + _work.extent(0)*ptBegin*get_dimension_scalar(_work);
134 
135  auto vcprop = Kokkos::common_view_alloc_prop(_work);
136  workViewType work(Kokkos::view_wrap(ptr,vcprop), (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, _vinvLine, _vinvBubble );
142  break;
143  }
144  case OPERATOR_DIV : {
145  auto output = Kokkos::subview( _outputValues, Kokkos::ALL(), ptRange );
146  Serial<opType>::getValues( output, input, work, _vinvLine, _vinvBubble );
147  break;
148  }
149  default: {
150  INTREPID2_TEST_FOR_ABORT( true,
151  ">>> ERROR: (Intrepid2::Basis_HDIV_QUAD_In_FEM::Functor) operator is not supported");
152 
153  }
154  }
155  }
156  };
157  };
158  }
159 
164  template<typename ExecSpaceType = void,
165  typename outputValueType = double,
166  typename pointValueType = double>
167  class Basis_HDIV_QUAD_In_FEM
168  : public Basis<ExecSpaceType,outputValueType,pointValueType> {
169  public:
170  using OrdinalTypeArray1DHost = typename Basis<ExecSpaceType,outputValueType,pointValueType>::OrdinalTypeArray1DHost;
171  using OrdinalTypeArray2DHost = typename Basis<ExecSpaceType,outputValueType,pointValueType>::OrdinalTypeArray2DHost;
172  using OrdinalTypeArray3DHost = typename Basis<ExecSpaceType,outputValueType,pointValueType>::OrdinalTypeArray3DHost;
173 
174  using ordinal_type_array_1d_host INTREPID2_DEPRECATED_TYPENAME_REPLACEMENT("use OrdinalTypeArray1DHost instead","OrdinalTypeArray1DHost") = OrdinalTypeArray1DHost INTREPID2_DEPRECATED_TYPENAME_TRAILING_ATTRIBUTE("use OrdinalTypeArray1DHost instead");
175  using ordinal_type_array_2d_host INTREPID2_DEPRECATED_TYPENAME_REPLACEMENT("use OrdinalTypeArray2DHost instead","OrdinalTypeArray2DHost") = OrdinalTypeArray2DHost INTREPID2_DEPRECATED_TYPENAME_TRAILING_ATTRIBUTE("use OrdinalTypeArray2DHost instead");
176  using ordinal_type_array_3d_host INTREPID2_DEPRECATED_TYPENAME_REPLACEMENT("use OrdinalTypeArray3DHost instead","OrdinalTypeArray3DHost") = OrdinalTypeArray3DHost INTREPID2_DEPRECATED_TYPENAME_TRAILING_ATTRIBUTE("use OrdinalTypeArray3DHost instead");
177 
180  Basis_HDIV_QUAD_In_FEM(const ordinal_type order,
181  const EPointType pointType = POINTTYPE_EQUISPACED);
182 
183  using OutputViewType = typename Basis<ExecSpaceType,outputValueType,pointValueType>::OutputViewType;
184  using PointViewType = typename Basis<ExecSpaceType,outputValueType,pointValueType>::PointViewType;
185  using ScalarViewType = typename Basis<ExecSpaceType,outputValueType,pointValueType>::ScalarViewType;
186 
187  using outputViewType INTREPID2_DEPRECATED_TYPENAME_REPLACEMENT("use OutputViewType instead","OutputViewType") = OutputViewType INTREPID2_DEPRECATED_TYPENAME_TRAILING_ATTRIBUTE("use OutputViewType instead");
188  using pointViewType INTREPID2_DEPRECATED_TYPENAME_REPLACEMENT("use PointViewType instead","PointViewType") = PointViewType INTREPID2_DEPRECATED_TYPENAME_TRAILING_ATTRIBUTE("use PointViewType instead");
189  using scalarViewType INTREPID2_DEPRECATED_TYPENAME_REPLACEMENT("use ScalarViewType instead","ScalarViewType") = ScalarViewType INTREPID2_DEPRECATED_TYPENAME_TRAILING_ATTRIBUTE("use ScalarViewType instead");
190 
191  using Basis<ExecSpaceType,outputValueType,pointValueType>::getValues;
192 
193  virtual
194  void
195  getValues( OutputViewType outputValues,
196  const PointViewType inputPoints,
197  const EOperator operatorType = OPERATOR_VALUE ) const {
198 #ifdef HAVE_INTREPID2_DEBUG
199  Intrepid2::getValues_HDIV_Args(outputValues,
200  inputPoints,
201  operatorType,
202  this->getBaseCellTopology(),
203  this->getCardinality() );
204 #endif
205  constexpr ordinal_type numPtsPerEval = Parameters::MaxNumPtsPerBasisEval;
206  Impl::Basis_HDIV_QUAD_In_FEM::
207  getValues<ExecSpaceType,numPtsPerEval>( outputValues,
208  inputPoints,
209  this->vinvLine_,
210  this->vinvBubble_,
211  operatorType );
212  }
213  virtual
214  void
215  getDofCoords( ScalarViewType dofCoords ) const {
216 #ifdef HAVE_INTREPID2_DEBUG
217  // Verify rank of output array.
218  INTREPID2_TEST_FOR_EXCEPTION( dofCoords.rank() != 2, std::invalid_argument,
219  ">>> ERROR: (Intrepid2::Basis_HDIV_QUAD_In_FEM::getDofCoords) rank = 2 required for dofCoords array");
220  // Verify 0th dimension of output array.
221  INTREPID2_TEST_FOR_EXCEPTION( static_cast<ordinal_type>(dofCoords.extent(0)) != this->getCardinality(), std::invalid_argument,
222  ">>> ERROR: (Intrepid2::Basis_HDIV_QUAD_In_FEM::getDofCoords) mismatch in number of dof and 0th dimension of dofCoords array");
223  // Verify 1st dimension of output array.
224  INTREPID2_TEST_FOR_EXCEPTION( dofCoords.extent(1) != this->getBaseCellTopology().getDimension(), std::invalid_argument,
225  ">>> ERROR: (Intrepid2::Basis_HDIV_QUAD_In_FEM::getDofCoords) incorrect reference cell (1st) dimension in dofCoords array");
226 #endif
227  Kokkos::deep_copy(dofCoords, this->dofCoords_);
228  }
229 
230  virtual
231  void
232  getDofCoeffs( ScalarViewType dofCoeffs ) const {
233 #ifdef HAVE_INTREPID2_DEBUG
234  // Verify rank of output array.
235  INTREPID2_TEST_FOR_EXCEPTION( dofCoeffs.rank() != 2, std::invalid_argument,
236  ">>> ERROR: (Intrepid2::Basis_HDIV_QUAD_In_FEM::getDofCoeffs) rank = 2 required for dofCoeffs array");
237  // Verify 0th dimension of output array.
238  INTREPID2_TEST_FOR_EXCEPTION( static_cast<ordinal_type>(dofCoeffs.extent(0)) != this->getCardinality(), std::invalid_argument,
239  ">>> ERROR: (Intrepid2::Basis_HDIV_QUAD_In_FEM::getDofCoeffs) mismatch in number of dof and 0th dimension of dofCoeffs array");
240  // Verify 1st dimension of output array.
241  INTREPID2_TEST_FOR_EXCEPTION( dofCoeffs.extent(1) != this->getBaseCellTopology().getDimension(), std::invalid_argument,
242  ">>> ERROR: (Intrepid2::Basis_HDIV_QUAD_In_FEM::getDofCoeffs) incorrect reference cell (1st) dimension in dofCoeffs array");
243 #endif
244  Kokkos::deep_copy(dofCoeffs, this->dofCoeffs_);
245  }
246 
247  virtual
248  const char*
249  getName() const {
250  return "Intrepid2_HDIV_QUAD_In_FEM";
251  }
252 
253  virtual
254  bool
255  requireOrientation() const {
256  return true;
257  }
258 
259  private:
260 
262  Kokkos::DynRankView<typename ScalarViewType::value_type,ExecSpaceType> vinvLine_, vinvBubble_;
263  };
264 
265 }// namespace Intrepid2
266 
267 #include "Intrepid2_HDIV_QUAD_In_FEMDef.hpp"
268 
269 #endif
Intrepid2::Basis< void, double, double >::getCardinality
ordinal_type getCardinality() const
Returns cardinality of the basis.
Definition: Intrepid2_Basis.hpp:554
Intrepid2::Basis< void, double, double >::dofCoords_
Kokkos::DynRankView< scalarType, void > dofCoords_
Coordinates of degrees-of-freedom for basis functions defined in physical space.
Definition: Intrepid2_Basis.hpp:294
Intrepid2::Basis_HDIV_QUAD_In_FEM::Basis_HDIV_QUAD_In_FEM
Basis_HDIV_QUAD_In_FEM(const ordinal_type order, const EPointType pointType=POINTTYPE_EQUISPACED)
Constructor.
Definition: Intrepid2_HDIV_QUAD_In_FEMDef.hpp:247
Intrepid2::Basis< void, double, double >::getBaseCellTopology
shards::CellTopology getBaseCellTopology() const
Returns the base cell topology for which the basis is defined. See Shards documentation https://trili...
Definition: Intrepid2_Basis.hpp:583
Intrepid2::Impl::Quadrilateral
Definition: Intrepid2_CellTopologyTags.hpp:212
Intrepid2::Impl::Basis_HDIV_QUAD_In_FEM::Functor
See Intrepid2::Basis_HDIV_QUAD_In_FEM.
Definition: Intrepid2_HDIV_QUAD_In_FEM.hpp:109
Intrepid2_HGRAD_LINE_Cn_FEM.hpp
Header file for the Intrepid2::Basis_HGRAD_LINE_Cn_FEM class.
Intrepid2_HDIV_QUAD_In_FEMDef.hpp
Definition file for FEM basis functions of degree n for H(div) functions on QUAD cells.
Intrepid2::getValues_HDIV_Args
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....
Definition: Intrepid2_BasisDef.hpp:688
Intrepid2::Basis_HDIV_QUAD_In_FEM
Implementation of the default H(div)-compatible FEM basis on Quadrilateral cell
Definition: Intrepid2_HDIV_QUAD_In_FEM.hpp:168
Intrepid2::Basis
An abstract base class that defines interface for concrete basis implementations for Finite Element (...
Definition: Intrepid2_Basis.hpp:95
Intrepid2::EOperator
EOperator
Enumeration of primitive operators available in Intrepid. Primitive operators act on reconstructed fu...
Definition: Intrepid2_Types.hpp:271
Intrepid2::Impl::Basis_HDIV_QUAD_In_FEM::Serial
See Intrepid2::Basis_HDIV_QUAD_In_FEM.
Definition: Intrepid2_HDIV_QUAD_In_FEM.hpp:69
Intrepid2::Basis::OrdinalTypeArray3DHost
Kokkos::View< ordinal_type ***, typename ExecSpaceType::array_layout, Kokkos::HostSpace > OrdinalTypeArray3DHost
View type for 3d host array.
Definition: Intrepid2_Basis.hpp:139
Intrepid2::EPointType
EPointType
Enumeration of types of point distributions in Intrepid.
Definition: Intrepid2_Types.hpp:419
Intrepid2::Impl::Basis_HDIV_QUAD_In_FEM
See Intrepid2::Basis_HDIV_QUAD_In_FEM.
Definition: Intrepid2_HDIV_QUAD_In_FEM.hpp:62
Intrepid2::Basis::ScalarViewType
Kokkos::DynRankView< scalarType, Kokkos::LayoutStride, ExecSpaceType > ScalarViewType
View type for scalars.
Definition: Intrepid2_Basis.hpp:340
Intrepid2::Parameters::MaxNumPtsPerBasisEval
static constexpr ordinal_type MaxNumPtsPerBasisEval
The maximum number of points to eval in serial mode.
Definition: Intrepid2_Types.hpp:121
Intrepid2::Basis< void, double, double >::dofCoeffs_
Kokkos::DynRankView< scalarType, void > dofCoeffs_
Coefficients for computing degrees of freedom for Lagrangian basis If P is an element of the space sp...
Definition: Intrepid2_Basis.hpp:304
Intrepid2::Impl::Quadrilateral< 4 >
Quadrilateral topology, 4 nodes.
Definition: Intrepid2_CellTopologyTags.hpp:218
Intrepid2_Basis.hpp
Header file for the abstract base class Intrepid2::Basis.
Intrepid2::Basis::OutputViewType
Kokkos::DynRankView< OutputValueType, Kokkos::LayoutStride, ExecSpaceType > OutputViewType
View type for basis value output.
Definition: Intrepid2_Basis.hpp:330
Intrepid2::Basis_HDIV_QUAD_In_FEM::vinvLine_
Kokkos::DynRankView< typename ScalarViewType::value_type, ExecSpaceType > vinvLine_
inverse of Generalized Vandermonde matrix (isotropic order)
Definition: Intrepid2_HDIV_QUAD_In_FEM.hpp:262
Intrepid2::Basis::PointViewType
Kokkos::DynRankView< PointValueType, Kokkos::LayoutStride, ExecSpaceType > PointViewType
View type for input points.
Definition: Intrepid2_Basis.hpp:335
Intrepid2::Basis::OrdinalTypeArray2DHost
Kokkos::View< ordinal_type **, typename ExecSpaceType::array_layout, Kokkos::HostSpace > OrdinalTypeArray2DHost
View type for 2d host array.
Definition: Intrepid2_Basis.hpp:134
Intrepid2::Basis::OrdinalTypeArray1DHost
Kokkos::View< ordinal_type *, typename ExecSpaceType::array_layout, Kokkos::HostSpace > OrdinalTypeArray1DHost
View type for 1d host array.
Definition: Intrepid2_Basis.hpp:129
Intrepid2::Util
small utility functions
Definition: Intrepid2_Utils.hpp:254
Generated by doxygen 1.8.20