Intrepid2
Intrepid2_HCURL_TRI_I1_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_TRI_I1_FEM_HPP
50 #define INTREPID2_HCURL_TRI_I1_FEM_HPP
51 
52 #include "Intrepid2_Basis.hpp"
53 
54 namespace Intrepid2 {
55 
96  namespace Impl {
97 
101  class Basis_HCURL_TRI_I1_FEM {
102  public:
103  typedef struct Triangle<3> cell_topology_type;
107  template<EOperator opType>
108  struct Serial {
109  template<typename OutputViewType,
110  typename inputViewType>
111  KOKKOS_INLINE_FUNCTION
112  static void
113  getValues( OutputViewType output,
114  const inputViewType input );
115 
116  };
117 
118  template<typename ExecSpaceType,
119  typename outputValueValueType, class ...outputValueProperties,
120  typename inputPointValueType, class ...inputPointProperties>
121  static void
122  getValues( Kokkos::DynRankView<outputValueValueType,outputValueProperties...> outputValues,
123  const Kokkos::DynRankView<inputPointValueType, inputPointProperties...> inputPoints,
124  const EOperator operatorType);
125 
129  template<typename outputValueViewType,
130  typename inputPointViewType,
131  EOperator opType>
132  struct Functor {
133  outputValueViewType _outputValues;
134  const inputPointViewType _inputPoints;
135 
136  KOKKOS_INLINE_FUNCTION
137  Functor( outputValueViewType outputValues_,
138  inputPointViewType inputPoints_ )
139  : _outputValues(outputValues_), _inputPoints(inputPoints_) {}
140 
141  KOKKOS_INLINE_FUNCTION
142  void operator()(const ordinal_type pt) const {
143  switch (opType) {
144  case OPERATOR_VALUE : {
145  auto output = Kokkos::subview( _outputValues, Kokkos::ALL(), pt, Kokkos::ALL() );
146  const auto input = Kokkos::subview( _inputPoints, pt, Kokkos::ALL() );
147  Serial<opType>::getValues( output, input );
148  break;
149  }
150  case OPERATOR_CURL : {
151  auto output = Kokkos::subview( _outputValues, Kokkos::ALL(), pt );
152  const auto input = Kokkos::subview( _inputPoints, pt, Kokkos::ALL() );
153  Serial<opType>::getValues( output, input );
154  break;
155  }
156  case OPERATOR_DIV: {
157  INTREPID2_TEST_FOR_ABORT( (opType == OPERATOR_DIV),
158  ">>> ERROR (Basis_HCURL_TRI_I1_FEM): DIV is invalid operator for HCURL Basis Functions");
159  break;
160  }
161  case OPERATOR_GRAD: {
162  INTREPID2_TEST_FOR_ABORT( (opType == OPERATOR_GRAD),
163  ">>> ERROR (Basis_HCURL_TRI_I1_FEM): GRAD is invalid operator for HCURL Basis Functions");
164  break;
165  }
166  default: {
167  INTREPID2_TEST_FOR_ABORT( opType != OPERATOR_VALUE &&
168  opType != OPERATOR_CURL,
169  ">>> ERROR: (Intrepid2::Basis_HCURL_QUAD_I1_FEM::Serial::getValues) operator is not supported");
170  }
171  }
172  }
173  };
174 
175  };
176  }
177 
178  template< typename ExecSpaceType = void,
179  typename outputValueType = double,
180  typename pointValueType = double >
181  class Basis_HCURL_TRI_I1_FEM : public Basis<ExecSpaceType, outputValueType, pointValueType> {
182  public:
183  using OrdinalTypeArray1DHost = typename Basis<ExecSpaceType,outputValueType,pointValueType>::OrdinalTypeArray1DHost;
184  using OrdinalTypeArray2DHost = typename Basis<ExecSpaceType,outputValueType,pointValueType>::OrdinalTypeArray2DHost;
185  using OrdinalTypeArray3DHost = typename Basis<ExecSpaceType,outputValueType,pointValueType>::OrdinalTypeArray3DHost;
186 
187  using ordinal_type_array_1d_host INTREPID2_DEPRECATED_TYPENAME_REPLACEMENT("use OrdinalTypeArray1DHost instead","OrdinalTypeArray1DHost") = OrdinalTypeArray1DHost INTREPID2_DEPRECATED_TYPENAME_TRAILING_ATTRIBUTE("use OrdinalTypeArray1DHost instead");
188  using ordinal_type_array_2d_host INTREPID2_DEPRECATED_TYPENAME_REPLACEMENT("use OrdinalTypeArray2DHost instead","OrdinalTypeArray2DHost") = OrdinalTypeArray2DHost INTREPID2_DEPRECATED_TYPENAME_TRAILING_ATTRIBUTE("use OrdinalTypeArray2DHost instead");
189  using ordinal_type_array_3d_host INTREPID2_DEPRECATED_TYPENAME_REPLACEMENT("use OrdinalTypeArray3DHost instead","OrdinalTypeArray3DHost") = OrdinalTypeArray3DHost INTREPID2_DEPRECATED_TYPENAME_TRAILING_ATTRIBUTE("use OrdinalTypeArray3DHost instead");
190 
193  Basis_HCURL_TRI_I1_FEM();
194 
195  using OutputViewType = typename Basis<ExecSpaceType,outputValueType,pointValueType>::OutputViewType;
196  using PointViewType = typename Basis<ExecSpaceType,outputValueType,pointValueType>::PointViewType;
197  using ScalarViewType = typename Basis<ExecSpaceType,outputValueType,pointValueType>::ScalarViewType;
198 
199  using outputViewType INTREPID2_DEPRECATED_TYPENAME_REPLACEMENT("use OutputViewType instead","OutputViewType") = OutputViewType INTREPID2_DEPRECATED_TYPENAME_TRAILING_ATTRIBUTE("use OutputViewType instead");
200  using pointViewType INTREPID2_DEPRECATED_TYPENAME_REPLACEMENT("use PointViewType instead","PointViewType") = PointViewType INTREPID2_DEPRECATED_TYPENAME_TRAILING_ATTRIBUTE("use PointViewType instead");
201  using scalarViewType INTREPID2_DEPRECATED_TYPENAME_REPLACEMENT("use ScalarViewType instead","ScalarViewType") = ScalarViewType INTREPID2_DEPRECATED_TYPENAME_TRAILING_ATTRIBUTE("use ScalarViewType instead");
202 
203  using Basis<ExecSpaceType,outputValueType,pointValueType>::getValues;
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  // Verify arguments
212  Intrepid2::getValues_HCURL_Args(outputValues,
213  inputPoints,
214  operatorType,
215  this->getBaseCellTopology(),
216  this->getCardinality() );
217 #endif
218  Impl::Basis_HCURL_TRI_I1_FEM::
219  getValues<ExecSpaceType>( outputValues,
220  inputPoints,
221  operatorType );
222  }
223 
224  virtual
225  void
226  getDofCoords( ScalarViewType dofCoords ) const {
227 #ifdef HAVE_INTREPID2_DEBUG
228  // Verify rank of output array.
229  INTREPID2_TEST_FOR_EXCEPTION( dofCoords.rank() != 2, std::invalid_argument,
230  ">>> ERROR: (Intrepid2::Basis_HCURL_TRI_I1_FEM::getDofCoords) rank = 2 required for dofCoords array");
231  // Verify 0th dimension of output array.
232  INTREPID2_TEST_FOR_EXCEPTION( static_cast<ordinal_type>(dofCoords.extent(0)) != this->basisCardinality_, std::invalid_argument,
233  ">>> ERROR: (Intrepid2::Basis_HCURL_TRI_I1_FEM::getDofCoords) mismatch in number of dof and 0th dimension of dofCoords array");
234  // Verify 1st dimension of output array.
235  INTREPID2_TEST_FOR_EXCEPTION( dofCoords.extent(1) != this->basisCellTopology_.getDimension(), std::invalid_argument,
236  ">>> ERROR: (Intrepid2::Basis_HCURL_TRI_I1_FEM::getDofCoords) incorrect reference cell (1st) dimension in dofCoords array");
237 #endif
238  Kokkos::deep_copy(dofCoords, this->dofCoords_);
239  }
240 
241  virtual
242  void
243  getDofCoeffs( ScalarViewType dofCoeffs ) const {
244 #ifdef HAVE_INTREPID2_DEBUG
245  // Verify rank of output array.
246  INTREPID2_TEST_FOR_EXCEPTION( dofCoeffs.rank() != 2, std::invalid_argument,
247  ">>> ERROR: (Intrepid2::Basis_HCURL_TRI_I1_FEM::getDofCoeffs) rank = 2 required for dofCoeffs array");
248  // Verify 0th dimension of output array.
249  INTREPID2_TEST_FOR_EXCEPTION( static_cast<ordinal_type>(dofCoeffs.extent(0)) != this->getCardinality(), std::invalid_argument,
250  ">>> ERROR: (Intrepid2::Basis_HCURL_TRI_I1_FEM::getDofCoeffs) mismatch in number of dof and 0th dimension of dofCoeffs array");
251  // Verify 1st dimension of output array.
252  INTREPID2_TEST_FOR_EXCEPTION( dofCoeffs.extent(1) != this->getBaseCellTopology().getDimension(), std::invalid_argument,
253  ">>> ERROR: (Intrepid2::Basis_HCURL_TRI_I1_FEM::getDofCoeffs) incorrect reference cell (1st) dimension in dofCoeffs array");
254 #endif
255  Kokkos::deep_copy(dofCoeffs, this->dofCoeffs_);
256  }
257 
258 
259  virtual
260  const char*
261  getName() const {
262  return "Intrepid2_HCURL_TRI_I1_FEM";
263  }
264 
265  virtual
266  bool
267  requireOrientation() const {
268  return true;
269  }
270 
271  };
272 
273 }// namespace Intrepid2
274 
275 #include "Intrepid2_HCURL_TRI_I1_FEMDef.hpp"
276 
277 #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< 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_HCURL_TRI_I1_FEMDef.hpp
Definition file for default FEM basis functions of degree 1 for H(curl) functions on Triangle cells.
Intrepid2::Basis_HCURL_TRI_I1_FEM
Implementation of the default H(curl)-compatible FEM basis of degree 1 on Triangle cell.
Definition: Intrepid2_HCURL_TRI_I1_FEM.hpp:181
Intrepid2::Impl::Basis_HCURL_TRI_I1_FEM::Functor
See Intrepid2::Basis_HCURL_TRI_I1_FEM.
Definition: Intrepid2_HCURL_TRI_I1_FEM.hpp:132
Intrepid2::getValues_HCURL_Args
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: Intrepid2_BasisDef.hpp:603
Intrepid2::Basis
An abstract base class that defines interface for concrete basis implementations for Finite Element (...
Definition: Intrepid2_Basis.hpp:95
Intrepid2::Impl::Basis_HCURL_TRI_I1_FEM
See Intrepid2::Basis_HCURL_TRI_I1_FEM.
Definition: Intrepid2_HCURL_TRI_I1_FEM.hpp:101
Intrepid2::EOperator
EOperator
Enumeration of primitive operators available in Intrepid. Primitive operators act on reconstructed fu...
Definition: Intrepid2_Types.hpp:271
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::Impl::Triangle< 3 >
Triangle topology, 3 nodes.
Definition: Intrepid2_CellTopologyTags.hpp:142
Intrepid2::Basis::ScalarViewType
Kokkos::DynRankView< scalarType, Kokkos::LayoutStride, ExecSpaceType > ScalarViewType
View type for scalars.
Definition: Intrepid2_Basis.hpp:340
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_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::PointViewType
Kokkos::DynRankView< PointValueType, Kokkos::LayoutStride, ExecSpaceType > PointViewType
View type for input points.
Definition: Intrepid2_Basis.hpp:335
Intrepid2::Basis_HCURL_TRI_I1_FEM::Basis_HCURL_TRI_I1_FEM
Basis_HCURL_TRI_I1_FEM()
Constructor.
Definition: Intrepid2_HCURL_TRI_I1_FEMDef.hpp:182
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::Impl::Basis_HCURL_TRI_I1_FEM::Serial
See Intrepid2::Basis_HCURL_TRI_I1_FEM.
Definition: Intrepid2_HCURL_TRI_I1_FEM.hpp:108
Intrepid2::Impl::Triangle
Definition: Intrepid2_CellTopologyTags.hpp:136
Generated by doxygen 1.8.20