Intrepid2
Intrepid2_HCURL_HEX_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_HEX_I1_FEM_HPP__
50 #define __INTREPID2_HCURL_HEX_I1_FEM_HPP__
51 
52 #include "Intrepid2_Basis.hpp"
53 
54 namespace Intrepid2 {
55 
116  namespace Impl {
117 
122  public:
123  typedef struct Hexahedron<8> cell_topology_type;
124 
128  template<EOperator opType>
129  struct Serial {
130  template<typename OutputViewType,
131  typename inputViewType>
132  KOKKOS_INLINE_FUNCTION
133  static void
134  getValues( OutputViewType output,
135  const inputViewType input );
136  };
137 
138  template<typename ExecSpaceType,
139  typename outputValueValueType, class ...outputValueProperties,
140  typename inputPointValueType, class ...inputPointProperties>
141  static void
142  getValues( Kokkos::DynRankView<outputValueValueType,outputValueProperties...> outputValues,
143  const Kokkos::DynRankView<inputPointValueType, inputPointProperties...> inputPoints,
144  const EOperator operatorType);
145 
149  template<typename outputValueViewType,
150  typename inputPointViewType,
151  EOperator opType>
152  struct Functor {
153  outputValueViewType _outputValues;
154  const inputPointViewType _inputPoints;
155 
156  KOKKOS_INLINE_FUNCTION
157  Functor( outputValueViewType outputValues_,
158  inputPointViewType inputPoints_ )
159  : _outputValues(outputValues_), _inputPoints(inputPoints_) {}
160 
161  KOKKOS_INLINE_FUNCTION
162  void operator()(const ordinal_type pt) const {
163  switch (opType) {
164  case OPERATOR_VALUE:
165  case OPERATOR_CURL: {
166  auto output = Kokkos::subview( _outputValues, Kokkos::ALL(), pt, Kokkos::ALL() );
167  const auto input = Kokkos::subview( _inputPoints, pt, Kokkos::ALL() );
168  Serial<opType>::getValues( output, input );
169  break;
170  }
171  default: {
172  INTREPID2_TEST_FOR_ABORT( opType != OPERATOR_VALUE &&
173  opType != OPERATOR_CURL,
174  ">>> ERROR: (Intrepid2::Basis_HCURL_QUAD_CI_FEM::Serial::getVAlues) operator is not supported");
175  break;
176  }
177  } //end switch
178  }
179  };
180  };
181  }
182 
183  template<typename ExecSpaceType = void,
184  typename outputValueType = double,
185  typename pointValueType = double>
186  class Basis_HCURL_HEX_I1_FEM : public Basis<ExecSpaceType,outputValueType,pointValueType> {
187  public:
191 
195 
199 
201 
202  virtual
203  void
204  getValues( OutputViewType outputValues,
205  const PointViewType inputPoints,
206  const EOperator operatorType = OPERATOR_VALUE ) const {
207 #ifdef HAVE_INTREPID2_DEBUG
208  Intrepid2::getValues_HCURL_Args(outputValues,
209  inputPoints,
210  operatorType,
211  this->getBaseCellTopology(),
212  this->getCardinality() );
213 #endif
214  Impl::Basis_HCURL_HEX_I1_FEM::
215  getValues<ExecSpaceType>( outputValues,
216  inputPoints,
217  operatorType );
218  }
219 
220  virtual
221  void
222  getDofCoords( ScalarViewType dofCoords ) const {
223 #ifdef HAVE_INTREPID2_DEBUG
224  // Verify rank of output array.
225  INTREPID2_TEST_FOR_EXCEPTION( dofCoords.rank() != 2, std::invalid_argument,
226  ">>> ERROR: (Intrepid2::Basis_HCURL_HEX_I1_FEM::getDofCoords) rank = 2 required for dofCoords array");
227  // Verify 0th dimension of output array.
228  INTREPID2_TEST_FOR_EXCEPTION( static_cast<ordinal_type>(dofCoords.extent(0)) != this->basisCardinality_, std::invalid_argument,
229  ">>> ERROR: (Intrepid2::Basis_HCURL_HEX_I1_FEM::getDofCoords) mismatch in number of dof and 0th dimension of dofCoords array");
230  // Verify 1st dimension of output array.
231  INTREPID2_TEST_FOR_EXCEPTION( dofCoords.extent(1) != this->basisCellTopology_.getDimension(), std::invalid_argument,
232  ">>> ERROR: (Intrepid2::Basis_HCURL_HEX_I1_FEM::getDofCoords) incorrect reference cell (1st) dimension in dofCoords array");
233 #endif
234  Kokkos::deep_copy(dofCoords, this->dofCoords_);
235  }
236 
237 
238  virtual
239  void
240  getDofCoeffs( ScalarViewType dofCoeffs ) const {
241 #ifdef HAVE_INTREPID2_DEBUG
242  // Verify rank of output array.
243  INTREPID2_TEST_FOR_EXCEPTION( dofCoeffs.rank() != 2, std::invalid_argument,
244  ">>> ERROR: (Intrepid2::Basis_HCURL_HEX_I1_FEM::getDofCoeffs) rank = 2 required for dofCoeffs array");
245  // Verify 0th dimension of output array.
246  INTREPID2_TEST_FOR_EXCEPTION( static_cast<ordinal_type>(dofCoeffs.extent(0)) != this->getCardinality(), std::invalid_argument,
247  ">>> ERROR: (Intrepid2::Basis_HCURL_HEX_I1_FEM::getDofCoeffs) mismatch in number of dof and 0th dimension of dofCoeffs array");
248  // Verify 1st dimension of output array.
249  INTREPID2_TEST_FOR_EXCEPTION( dofCoeffs.extent(1) != this->getBaseCellTopology().getDimension(), std::invalid_argument,
250  ">>> ERROR: (Intrepid2::Basis_HCURL_HEX_I1_FEM::getDofCoeffs) incorrect reference cell (1st) dimension in dofCoeffs array");
251 #endif
252  Kokkos::deep_copy(dofCoeffs, this->dofCoeffs_);
253  }
254 
255  virtual
256  const char*
257  getName() const {
258  return "Intrepid2_HCURL_HEX_I1_FEM";
259  }
260 
261  virtual
262  bool
264  return true;
265  }
266 
267  };
268 }// namespace Intrepid2
269 
271 
272 #endif
Kokkos::View< ordinal_type *, typename ExecSpaceType::array_layout, Kokkos::HostSpace > OrdinalTypeArray1DHost
View type for 1d host array.
Kokkos::View< ordinal_type **, typename ExecSpaceType::array_layout, Kokkos::HostSpace > OrdinalTypeArray2DHost
View type for 2d host array.
ordinal_type basisCardinality_
Cardinality of the basis, i.e., the number of basis functions/degrees-of-freedom. ...
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...
ordinal_type getCardinality() const
Returns cardinality of the basis.
virtual void getValues(OutputViewType outputValues, const PointViewType inputPoints, const EOperator operatorType=OPERATOR_VALUE) const
Evaluation of a FEM basis on a reference cell.
An abstract base class that defines interface for concrete basis implementations for Finite Element (...
virtual bool requireOrientation() const
True if orientation is required.
Kokkos::DynRankView< scalarType, ExecSpaceType > dofCoords_
Coordinates of degrees-of-freedom for basis functions defined in physical space.
virtual void getDofCoeffs(ScalarViewType dofCoeffs) const
Coefficients for computing degrees of freedom for Lagrangian basis If P is an element of the space sp...
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.
EOperator
Enumeration of primitive operators available in Intrepid. Primitive operators act on reconstructed fu...
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.
Definition file for FEM basis functions of degree 1 for H(curl) functions on HEX cells.
Kokkos::DynRankView< PointValueType, Kokkos::LayoutStride, ExecSpaceType > PointViewType
View type for input points.
Implementation of the default H(curl)-compatible FEM basis of degree 1 on Hexahedron cell...
See Intrepid2::Basis_HCURL_HEX_I1_FEM.
virtual const char * getName() const
Returns basis name.
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...
Header file for the abstract base class Intrepid2::Basis.
shards::CellTopology basisCellTopology_
Base topology of the cells for which the basis is defined. See the Shards package for definition of b...