Intrepid2
Intrepid2_HVOL_TRI_Cn_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 
48 #ifndef __INTREPID2_HVOL_TRI_CN_FEM_HPP__
49 #define __INTREPID2_HVOL_TRI_CN_FEM_HPP__
50 
51 #include "Intrepid2_Basis.hpp"
52 
53 #include "Intrepid2_PointTools.hpp"
54 #include "Teuchos_LAPACK.hpp"
55 
56 namespace Intrepid2 {
57 
72  namespace Impl {
73 
78  public:
79  typedef struct Triangle<3> cell_topology_type;
83  template<EOperator opType>
84  struct Serial {
85  template<typename outputValueViewType,
86  typename inputPointViewType,
87  typename workViewType,
88  typename vinvViewType>
89  KOKKOS_INLINE_FUNCTION
90  static void
91  getValues( outputValueViewType outputValues,
92  const inputPointViewType inputPoints,
93  workViewType work,
94  const vinvViewType vinv );
95 
96 
97  KOKKOS_INLINE_FUNCTION
98  static ordinal_type
99  getWorkSizePerPoint(ordinal_type order) {
100  auto cardinality = getPnCardinality<2>(order);
101  switch (opType) {
102  case OPERATOR_GRAD:
103  case OPERATOR_CURL:
104  case OPERATOR_D1:
105  return 5*cardinality;
106  break;
107  default:
108  return getDkCardinality<opType,2>()*cardinality;
109  }
110  }
111  };
112 
113  template<typename ExecSpaceType, ordinal_type numPtsPerEval,
114  typename outputValueValueType, class ...outputValueProperties,
115  typename inputPointValueType, class ...inputPointProperties,
116  typename vinvValueType, class ...vinvProperties>
117  static void
118  getValues( Kokkos::DynRankView<outputValueValueType,outputValueProperties...> outputValues,
119  const Kokkos::DynRankView<inputPointValueType, inputPointProperties...> inputPoints,
120  const Kokkos::DynRankView<vinvValueType, vinvProperties...> vinv,
121  const EOperator operatorType);
122 
126  template<typename outputValueViewType,
127  typename inputPointViewType,
128  typename vinvViewType,
129  typename workViewType,
130  EOperator opType,
131  ordinal_type numPtsEval>
132  struct Functor {
133  outputValueViewType _outputValues;
134  const inputPointViewType _inputPoints;
135  const vinvViewType _vinv;
136  workViewType _work;
137 
138  KOKKOS_INLINE_FUNCTION
139  Functor( outputValueViewType outputValues_,
140  inputPointViewType inputPoints_,
141  vinvViewType vinv_,
142  workViewType work_)
143  : _outputValues(outputValues_), _inputPoints(inputPoints_),
144  _vinv(vinv_), _work(work_) {}
145 
146  KOKKOS_INLINE_FUNCTION
147  void operator()(const size_type iter) const {
148  const auto ptBegin = Util<ordinal_type>::min(iter*numPtsEval, _inputPoints.extent(0));
149  const auto ptEnd = Util<ordinal_type>::min(ptBegin+numPtsEval, _inputPoints.extent(0));
150 
151  const auto ptRange = Kokkos::pair<ordinal_type,ordinal_type>(ptBegin, ptEnd);
152  const auto input = Kokkos::subview( _inputPoints, ptRange, Kokkos::ALL() );
153 
154  typename workViewType::pointer_type ptr = _work.data() + _work.extent(0)*ptBegin*get_dimension_scalar(_work);
155 
156  auto vcprop = Kokkos::common_view_alloc_prop(_work);
157  workViewType work(Kokkos::view_wrap(ptr,vcprop), (ptEnd-ptBegin)*_work.extent(0));
158 
159  switch (opType) {
160  case OPERATOR_VALUE : {
161  auto output = Kokkos::subview( _outputValues, Kokkos::ALL(), ptRange );
162  Serial<opType>::getValues( output, input, work, _vinv );
163  break;
164  }
165  case OPERATOR_D1:
166  case OPERATOR_D2: {
167  auto output = Kokkos::subview( _outputValues, Kokkos::ALL(), ptRange, Kokkos::ALL() );
168  Serial<opType>::getValues( output, input, work, _vinv );
169  break;
170  }
171  default: {
172  INTREPID2_TEST_FOR_ABORT( true,
173  ">>> ERROR: (Intrepid2::Basis_HVOL_TRI_Cn_FEM::Functor) operator is not supported");
174 
175  }
176  }
177  }
178  };
179  };
180  }
181 
182  template<typename ExecSpaceType = void,
183  typename outputValueType = double,
184  typename pointValueType = double>
186  : public Basis<ExecSpaceType,outputValueType,pointValueType> {
187  public:
191 
194  Basis_HVOL_TRI_Cn_FEM(const ordinal_type order,
195  const EPointType pointType = POINTTYPE_EQUISPACED);
196 
197 
202 
204 
205  virtual
206  void
207  getValues( outputViewType outputValues,
208  const pointViewType inputPoints,
209  const EOperator operatorType = OPERATOR_VALUE) const {
210 #ifdef HAVE_INTREPID2_DEBUG
211  Intrepid2::getValues_HVOL_Args(outputValues,
212  inputPoints,
213  operatorType,
214  this->getBaseCellTopology(),
215  this->getCardinality() );
216 #endif
217  constexpr ordinal_type numPtsPerEval = Parameters::MaxNumPtsPerBasisEval;
218  Impl::Basis_HVOL_TRI_Cn_FEM::
219  getValues<ExecSpaceType,numPtsPerEval>( outputValues,
220  inputPoints,
221  this->vinv_,
222  operatorType);
223  }
224 
225  virtual
226  void
227  getDofCoords( scalarViewType dofCoords ) const {
228 #ifdef HAVE_INTREPID2_DEBUG
229  // Verify rank of output array.
230  INTREPID2_TEST_FOR_EXCEPTION( dofCoords.rank() != 2, std::invalid_argument,
231  ">>> ERROR: (Intrepid2::Basis_HVOL_TRI_Cn_FEM::getDofCoords) rank = 2 required for dofCoords array");
232  // Verify 0th dimension of output array.
233  INTREPID2_TEST_FOR_EXCEPTION( static_cast<ordinal_type>(dofCoords.extent(0)) != this->getCardinality(), std::invalid_argument,
234  ">>> ERROR: (Intrepid2::Basis_HVOL_TRI_Cn_FEM::getDofCoords) mismatch in number of dof and 0th dimension of dofCoords array");
235  // Verify 1st dimension of output array.
236  INTREPID2_TEST_FOR_EXCEPTION( dofCoords.extent(1) != this->getBaseCellTopology().getDimension(), std::invalid_argument,
237  ">>> ERROR: (Intrepid2::Basis_HVOL_TRI_Cn_FEM::getDofCoords) incorrect reference cell (1st) dimension in dofCoords array");
238 #endif
239  Kokkos::deep_copy(dofCoords, this->dofCoords_);
240  }
241 
242  virtual
243  void
244  getDofCoeffs( scalarViewType dofCoeffs ) const {
245 #ifdef HAVE_INTREPID2_DEBUG
246  // Verify rank of output array.
247  INTREPID2_TEST_FOR_EXCEPTION( dofCoeffs.rank() != 1, std::invalid_argument,
248  ">>> ERROR: (Intrepid2::Basis_HVOL_TRI_Cn_FEM::getdofCoeffs) rank = 1 required for dofCoeffs array");
249  // Verify 0th dimension of output array.
250  INTREPID2_TEST_FOR_EXCEPTION( static_cast<ordinal_type>(dofCoeffs.extent(0)) != this->getCardinality(), std::invalid_argument,
251  ">>> ERROR: (Intrepid2::Basis_HVOL_TRI_Cn_FEM::getdofCoeffs) mismatch in number of dof and 0th dimension of dofCoeffs array");
252 #endif
253  Kokkos::deep_copy(dofCoeffs, 1.0);
254  }
255 
256  void
257  getVandermondeInverse( scalarViewType vinv ) const {
258  // has to be same rank and dimensions
259  Kokkos::deep_copy(vinv, this->vinv_);
260  }
261 
262  virtual
263  const char*
264  getName() const {
265  return "Intrepid2_HVOL_TRI_Cn_FEM";
266  }
267 
268  virtual
269  bool
271  return false;
272  }
273 
274  private:
275 
278  Kokkos::DynRankView<scalarType,ExecSpaceType> vinv_;
279 
280  };
281 
282 }// namespace Intrepid2
283 
285 
286 #endif
Intrepid2::Basis::getCardinality
ordinal_type getCardinality() const
Returns cardinality of the basis.
Definition: Intrepid2_Basis.hpp:411
Intrepid2::Basis_HVOL_TRI_Cn_FEM::getValues
virtual void getValues(outputViewType outputValues, const pointViewType inputPoints, const EOperator operatorType=OPERATOR_VALUE) const
Evaluation of a FEM basis on a reference cell.
Definition: Intrepid2_HVOL_TRI_Cn_FEM.hpp:207
Intrepid2::Basis::dofCoords_
Kokkos::DynRankView< scalarType, ExecSpaceType > dofCoords_
Coordinates of degrees-of-freedom for basis functions defined in physical space.
Definition: Intrepid2_Basis.hpp:267
Intrepid2::Basis::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:432
Intrepid2::Basis::ordinal_type_array_3d_host
Kokkos::View< ordinal_type ***, typename ExecSpaceType::array_layout, Kokkos::HostSpace > ordinal_type_array_3d_host
View type for 3d host array.
Definition: Intrepid2_Basis.hpp:121
Intrepid2::Basis::ordinal_type_array_2d_host
Kokkos::View< ordinal_type **,typename ExecSpaceType::array_layout, Kokkos::HostSpace > ordinal_type_array_2d_host
View type for 2d host array.
Definition: Intrepid2_Basis.hpp:117
Intrepid2::Impl::Basis_HVOL_TRI_Cn_FEM
See Intrepid2::Basis_HVOL_TRI_Cn_FEM.
Definition: Intrepid2_HVOL_TRI_Cn_FEM.hpp:77
Intrepid2::Basis_HVOL_TRI_Cn_FEM::Basis_HVOL_TRI_Cn_FEM
Basis_HVOL_TRI_Cn_FEM(const ordinal_type order, const EPointType pointType=POINTTYPE_EQUISPACED)
Constructor.
Definition: Intrepid2_HVOL_TRI_Cn_FEMDef.hpp:225
Intrepid2::Basis_HVOL_TRI_Cn_FEM::requireOrientation
virtual bool requireOrientation() const
True if orientation is required.
Definition: Intrepid2_HVOL_TRI_Cn_FEM.hpp:270
Intrepid2_HVOL_TRI_Cn_FEMDef.hpp
Definition file for FEM basis functions of degree n for H(vol) functions on TRI.
Intrepid2::Impl::Basis_HVOL_TRI_Cn_FEM::Serial
See Intrepid2::Basis_HVOL_TRI_Cn_FEM.
Definition: Intrepid2_HVOL_TRI_Cn_FEM.hpp:84
Intrepid2::Basis_HVOL_TRI_Cn_FEM
Implementation of the default HVOL-compatible Lagrange basis of arbitrary degree on Triangle cell.
Definition: Intrepid2_HVOL_TRI_Cn_FEM.hpp:185
Intrepid2::Basis
An abstract base class that defines interface for concrete basis implementations for Finite Element (...
Definition: Intrepid2_Basis.hpp:93
Intrepid2::Basis_HVOL_TRI_Cn_FEM::getName
virtual const char * getName() const
Returns basis name.
Definition: Intrepid2_HVOL_TRI_Cn_FEM.hpp:264
Intrepid2::EOperator
EOperator
Enumeration of primitive operators available in Intrepid. Primitive operators act on reconstructed fu...
Definition: Intrepid2_Types.hpp:271
Intrepid2::Basis::ordinal_type_array_1d_host
Kokkos::View< ordinal_type *,typename ExecSpaceType::array_layout, Kokkos::HostSpace > ordinal_type_array_1d_host
View type for 1d host array.
Definition: Intrepid2_Basis.hpp:113
Intrepid2::Basis::outputViewType
Kokkos::DynRankView< outputValueType, Kokkos::LayoutStride, ExecSpaceType > outputViewType
View type for basis value output.
Definition: Intrepid2_Basis.hpp:295
Intrepid2::Basis::pointViewType
Kokkos::DynRankView< pointValueType, Kokkos::LayoutStride, ExecSpaceType > pointViewType
View type for input points.
Definition: Intrepid2_Basis.hpp:299
Intrepid2::EPointType
EPointType
Enumeration of types of point distributions in Intrepid.
Definition: Intrepid2_Types.hpp:419
Intrepid2::Impl::Basis_HVOL_TRI_Cn_FEM::Functor
See Intrepid2::Basis_HVOL_TRI_Cn_FEM.
Definition: Intrepid2_HVOL_TRI_Cn_FEM.hpp:132
Intrepid2::Impl::Triangle< 3 >
Triangle topology, 3 nodes.
Definition: Intrepid2_CellTopologyTags.hpp:142
Intrepid2::Basis::scalarType
ScalarTraits< pointValueType >::scalar_type scalarType
Scalar type for point values.
Definition: Intrepid2_Basis.hpp:145
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_HVOL_TRI_Cn_FEM::getDofCoords
virtual void getDofCoords(scalarViewType dofCoords) const
Returns spatial locations (coordinates) of degrees of freedom on the reference cell.
Definition: Intrepid2_HVOL_TRI_Cn_FEM.hpp:227
Intrepid2::Basis_HVOL_TRI_Cn_FEM::vinv_
Kokkos::DynRankView< scalarType, ExecSpaceType > vinv_
inverse of Generalized Vandermonde matrix, whose columns store the expansion coefficients of the noda...
Definition: Intrepid2_HVOL_TRI_Cn_FEM.hpp:278
Intrepid2_Basis.hpp
Header file for the abstract base class Intrepid2::Basis.
Intrepid2::getValues_HVOL_Args
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....
Definition: Intrepid2_BasisDef.hpp:749
Intrepid2::Basis_HVOL_TRI_Cn_FEM::getDofCoeffs
virtual void getDofCoeffs(scalarViewType dofCoeffs) const
Coefficients for computing degrees of freedom for Lagrangian basis If P is an element of the space sp...
Definition: Intrepid2_HVOL_TRI_Cn_FEM.hpp:244
Intrepid2_PointTools.hpp
Header file for Intrepid2::PointTools class to provide utilities for barycentric coordinates,...
Intrepid2::Impl::Triangle
Definition: Intrepid2_CellTopologyTags.hpp:136
Intrepid2::Basis::scalarViewType
Kokkos::DynRankView< scalarType, Kokkos::LayoutStride, ExecSpaceType > scalarViewType
View type for scalars.
Definition: Intrepid2_Basis.hpp:303
Intrepid2::Util
small utility functions
Definition: Intrepid2_Utils.hpp:232