Intrepid2
Intrepid2_HDIV_TET_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_TET_IN_FEM_HPP__
50 #define __INTREPID2_HDIV_TET_IN_FEM_HPP__
51 
52 #include "Intrepid2_Basis.hpp"
54 
55 #include "Intrepid2_PointTools.hpp"
56 #include "Teuchos_LAPACK.hpp"
57 
58 namespace Intrepid2 {
59 
86 #define CardinalityHDivTet(order) (order*(order+1)*(order+3)/2)
87 
88 namespace Impl {
89 
94 public:
95 
99  template<EOperator opType>
100  struct Serial {
101  template<typename outputValueViewType,
102  typename inputPointViewType,
103  typename workViewType,
104  typename vinvViewType>
105  KOKKOS_INLINE_FUNCTION
106  static void
107  getValues( outputValueViewType outputValues,
108  const inputPointViewType inputPoints,
109  workViewType work,
110  const vinvViewType vinv );
111 
112 
113  KOKKOS_INLINE_FUNCTION
114  static ordinal_type
115  getWorkSizePerPoint(ordinal_type order) {
116  auto cardinality = CardinalityHDivTet(order);
117  switch (opType) {
118  case OPERATOR_DIV:
119  case OPERATOR_D1:
120  return 7*cardinality;
121  default:
122  return getDkCardinality<opType,3>()*cardinality;
123  }
124  }
125  };
126 
127  template<typename ExecSpaceType, ordinal_type numPtsPerEval,
128  typename outputValueValueType, class ...outputValueProperties,
129  typename inputPointValueType, class ...inputPointProperties,
130  typename vinvValueType, class ...vinvProperties>
131  static void
132  getValues( Kokkos::DynRankView<outputValueValueType,outputValueProperties...> outputValues,
133  const Kokkos::DynRankView<inputPointValueType, inputPointProperties...> inputPoints,
134  const Kokkos::DynRankView<vinvValueType, vinvProperties...> vinv,
135  const EOperator operatorType);
136 
140  template<typename outputValueViewType,
141  typename inputPointViewType,
142  typename vinvViewType,
143  typename workViewType,
144  EOperator opType,
145  ordinal_type numPtsEval>
146  struct Functor {
147  outputValueViewType _outputValues;
148  const inputPointViewType _inputPoints;
149  const vinvViewType _coeffs;
150  workViewType _work;
151 
152  KOKKOS_INLINE_FUNCTION
153  Functor( outputValueViewType outputValues_,
154  inputPointViewType inputPoints_,
155  vinvViewType coeffs_,
156  workViewType work_)
157  : _outputValues(outputValues_), _inputPoints(inputPoints_),
158  _coeffs(coeffs_), _work(work_) {}
159 
160  KOKKOS_INLINE_FUNCTION
161  void operator()(const size_type iter) const {
162  const auto ptBegin = Util<ordinal_type>::min(iter*numPtsEval, _inputPoints.extent(0));
163  const auto ptEnd = Util<ordinal_type>::min(ptBegin+numPtsEval, _inputPoints.extent(0));
164 
165  const auto ptRange = Kokkos::pair<ordinal_type,ordinal_type>(ptBegin, ptEnd);
166  const auto input = Kokkos::subview( _inputPoints, ptRange, Kokkos::ALL() );
167 
168  typename workViewType::pointer_type ptr = _work.data() + _work.extent(0)*ptBegin*get_dimension_scalar(_work);
169 
170  auto vcprop = Kokkos::common_view_alloc_prop(_work);
171  workViewType work(Kokkos::view_wrap(ptr,vcprop), (ptEnd-ptBegin)*_work.extent(0));
172 
173  switch (opType) {
174  case OPERATOR_VALUE : {
175  auto output = Kokkos::subview( _outputValues, Kokkos::ALL(), ptRange, Kokkos::ALL() );
176  Serial<opType>::getValues( output, input, work, _coeffs );
177  break;
178  }
179  case OPERATOR_DIV: {
180  auto output = Kokkos::subview( _outputValues, Kokkos::ALL(), ptRange);
181  Serial<opType>::getValues( output, input, work, _coeffs );
182  break;
183  }
184  default: {
185  INTREPID2_TEST_FOR_ABORT( true,
186  ">>> ERROR: (Intrepid2::Basis_HDIV_TET_In_FEM::Functor) operator is not supported");
187 
188  }
189  }
190  }
191  };
192 };
193 }
194 
195 template<typename ExecSpaceType = void,
196  typename outputValueType = double,
197  typename pointValueType = double>
199  : public Basis<ExecSpaceType,outputValueType,pointValueType> {
200  public:
204 
207  Basis_HDIV_TET_In_FEM(const ordinal_type order,
208  const EPointType pointType = POINTTYPE_EQUISPACED);
209 
210 
214 
216 
218 
219  virtual
220  void
221  getValues( /* */ OutputViewType outputValues,
222  const PointViewType inputPoints,
223  const EOperator operatorType = OPERATOR_VALUE) const {
224 #ifdef HAVE_INTREPID2_DEBUG
225  Intrepid2::getValues_HDIV_Args(outputValues,
226  inputPoints,
227  operatorType,
228  this->getBaseCellTopology(),
229  this->getCardinality() );
230 #endif
231 constexpr ordinal_type numPtsPerEval = Parameters::MaxNumPtsPerBasisEval;
232 Impl::Basis_HDIV_TET_In_FEM::
233 getValues<ExecSpaceType,numPtsPerEval>( outputValues,
234  inputPoints,
235  this->coeffs_,
236  operatorType);
237  }
238 
239  virtual
240  void
241  getDofCoords( ScalarViewType dofCoords ) const {
242 #ifdef HAVE_INTREPID2_DEBUG
243  // Verify rank of output array.
244  INTREPID2_TEST_FOR_EXCEPTION( dofCoords.rank() != 2, std::invalid_argument,
245  ">>> ERROR: (Intrepid2::Basis_HDIV_TET_In_FEM::getDofCoords) rank = 2 required for dofCoords array");
246  // Verify 0th dimension of output array.
247  INTREPID2_TEST_FOR_EXCEPTION( static_cast<ordinal_type>(dofCoords.extent(0)) != this->getCardinality(), std::invalid_argument,
248  ">>> ERROR: (Intrepid2::Basis_HDIV_TET_In_FEM::getDofCoords) mismatch in number of dof and 0th dimension of dofCoords array");
249  // Verify 1st dimension of output array.
250  INTREPID2_TEST_FOR_EXCEPTION( dofCoords.extent(1) != this->getBaseCellTopology().getDimension(), std::invalid_argument,
251  ">>> ERROR: (Intrepid2::Basis_HDIV_TET_In_FEM::getDofCoords) incorrect reference cell (1st) dimension in dofCoords array");
252 #endif
253  Kokkos::deep_copy(dofCoords, this->dofCoords_);
254  }
255 
256  virtual
257  void
258  getDofCoeffs( ScalarViewType dofCoeffs ) const {
259 #ifdef HAVE_INTREPID2_DEBUG
260  // Verify rank of output array.
261  INTREPID2_TEST_FOR_EXCEPTION( dofCoeffs.rank() != 2, std::invalid_argument,
262  ">>> ERROR: (Intrepid2::Basis_HDIV_TET_In_FEM::getDofCoeffs) rank = 2 required for dofCoeffs array");
263  // Verify 0th dimension of output array.
264  INTREPID2_TEST_FOR_EXCEPTION( static_cast<ordinal_type>(dofCoeffs.extent(0)) != this->getCardinality(), std::invalid_argument,
265  ">>> ERROR: (Intrepid2::Basis_HDIV_TET_In_FEM::getDofCoeffs) mismatch in number of dof and 0th dimension of dofCoeffs array");
266  // Verify 1st dimension of output array.
267  INTREPID2_TEST_FOR_EXCEPTION( dofCoeffs.extent(1) != this->getBaseCellTopology().getDimension(), std::invalid_argument,
268  ">>> ERROR: (Intrepid2::Basis_HDIV_TET_In_FEM::getDofCoeffs) incorrect reference cell (1st) dimension in dofCoeffs array");
269 #endif
270  Kokkos::deep_copy(dofCoeffs, this->dofCoeffs_);
271  }
272 
273  void
274  getExpansionCoeffs( ScalarViewType coeffs ) const {
275  // has to be same rank and dimensions
276  Kokkos::deep_copy(coeffs, this->coeffs_);
277  }
278 
279  virtual
280  const char*
281  getName() const {
282  return "Intrepid2_HDIV_TET_In_FEM";
283  }
284 
285  virtual
286  bool
288  return true;
289  }
290 
291  private:
292 
295  Kokkos::DynRankView<scalarType,ExecSpaceType> coeffs_;
296 
297 };
298 
299 }// namespace Intrepid2
300 
302 
303 #endif
virtual bool requireOrientation() const
True if orientation is required.
small utility functions
Kokkos::View< ordinal_type *, typename ExecSpaceType::array_layout, Kokkos::HostSpace > OrdinalTypeArray1DHost
View type for 1d host array.
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...
Kokkos::View< ordinal_type **, typename ExecSpaceType::array_layout, Kokkos::HostSpace > OrdinalTypeArray2DHost
View type for 2d host array.
Definition file for FEM basis functions of degree n for H(grad) functions on TET cells.
ordinal_type getCardinality() const
Returns cardinality of the basis.
An abstract base class that defines interface for concrete basis implementations for Finite Element (...
Kokkos::DynRankView< scalarType, ExecSpaceType > coeffs_
expansion coefficients of the nodal basis in terms of the orthgonal one
virtual void getValues(OutputViewType outputValues, const PointViewType inputPoints, const EOperator operatorType=OPERATOR_VALUE) const
Evaluation of a FEM basis on a reference cell.
Kokkos::DynRankView< scalarType, ExecSpaceType > dofCoords_
Coordinates of degrees-of-freedom for basis functions defined in physical space.
shards::CellTopology getBaseCellTopology() const
Returns the base cell topology for which the basis is defined. See Shards documentation https://trili...
virtual void getDofCoords(ScalarViewType dofCoords) const
Returns spatial locations (coordinates) of degrees of freedom on the reference cell.
static constexpr ordinal_type MaxNumPtsPerBasisEval
The maximum number of points to eval in serial mode.
EOperator
Enumeration of primitive operators available in Intrepid. Primitive operators act on reconstructed fu...
Implementation of the default H(div)-compatible Raviart-Thomas basis of arbitrary degree on Tetrahedr...
Kokkos::DynRankView< OutputValueType, Kokkos::LayoutStride, ExecSpaceType > OutputViewType
View type for basis value output.
Kokkos::View< ordinal_type ***, typename ExecSpaceType::array_layout, Kokkos::HostSpace > OrdinalTypeArray3DHost
View type for 3d host array.
Basis_HDIV_TET_In_FEM(const ordinal_type order, const EPointType pointType=POINTTYPE_EQUISPACED)
Constructor.
Kokkos::DynRankView< PointValueType, Kokkos::LayoutStride, ExecSpaceType > PointViewType
View type for input points.
EPointType
Enumeration of types of point distributions in Intrepid.
Kokkos::DynRankView< scalarType, Kokkos::LayoutStride, ExecSpaceType > ScalarViewType
View type for scalars.
Kokkos::DynRankView< scalarType, ExecSpaceType > dofCoeffs_
Coefficients for computing degrees of freedom for Lagrangian basis If P is an element of the space sp...
virtual void getDofCoeffs(ScalarViewType dofCoeffs) const
Coefficients for computing degrees of freedom for Lagrangian basis If P is an element of the space sp...
See Intrepid2::Basis_HDIV_TET_In_FEM.
ScalarTraits< pointValueType >::scalar_type scalarType
Scalar type for point values.
Header file for the Intrepid2::Basis_HGRAD_TET_Cn_FEM_ORTH class.
virtual const char * getName() const
Returns basis name.
Header file for the abstract base class Intrepid2::Basis.
Header file for Intrepid2::PointTools class to provide utilities for barycentric coordinates, equispaced lattices, and warp-blend point distrubtions.