Intrepid2
Intrepid2_HDIV_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_HDIV_HEX_I1_FEM_HPP__
50 #define __INTREPID2_HDIV_HEX_I1_FEM_HPP__
51 
52 #include "Intrepid2_Basis.hpp"
53 
54 namespace Intrepid2 {
55 
105  namespace Impl {
106 
111  public:
112  typedef struct Hexahedron<8> cell_topology_type;
116  template<EOperator opType>
117  struct Serial {
118  template<typename outputViewType,
119  typename inputViewType>
120  KOKKOS_INLINE_FUNCTION
121  static void
122  getValues( outputViewType output,
123  const inputViewType input );
124  };
125 
126  template<typename ExecSpaceType,
127  typename outputValueValueType, class ...outputValueProperties,
128  typename inputPointValueType, class ...inputPointProperties>
129  static void
130  getValues( Kokkos::DynRankView<outputValueValueType,outputValueProperties...> outputValues,
131  const Kokkos::DynRankView<inputPointValueType, inputPointProperties...> inputPoints,
132  const EOperator operatorType);
133 
137  template<typename outputValueViewType,
138  typename inputPointViewType,
139  EOperator opType>
140  struct Functor {
141  outputValueViewType _outputValues;
142  const inputPointViewType _inputPoints;
143 
144  KOKKOS_INLINE_FUNCTION
145  Functor( outputValueViewType outputValues_,
146  inputPointViewType inputPoints_ )
147  : _outputValues(outputValues_), _inputPoints(inputPoints_) {}
148 
149  KOKKOS_INLINE_FUNCTION
150  void operator()(const ordinal_type pt) const {
151  switch (opType) {
152  case OPERATOR_VALUE : {
153  auto output = Kokkos::subview( _outputValues, Kokkos::ALL(), pt, Kokkos::ALL() );
154  const auto input = Kokkos::subview( _inputPoints, pt, Kokkos::ALL() );
155  Serial<opType>::getValues( output, input );
156  break;
157  }
158  case OPERATOR_DIV :{
159  auto output = Kokkos::subview( _outputValues, Kokkos::ALL(), pt );
160  const auto input = Kokkos::subview( _inputPoints, pt, Kokkos::ALL() );
161  Serial<opType>::getValues( output, input );
162  break;
163  }
164  default: {
165  INTREPID2_TEST_FOR_ABORT( opType != OPERATOR_VALUE &&
166  opType != OPERATOR_DIV,
167  ">>> ERROR: (Intrepid2::Basis_HDIV_HEX_I1_FEM::Serial::getValues) operator is not supported");
168  }
169  }
170  }
171  };
172  };
173 
174  }
175 
176  template<typename ExecSpaceType = void,
177  typename outputValueType = double,
178  typename pointValueType = double>
179  class Basis_HDIV_HEX_I1_FEM : public Basis<ExecSpaceType,outputValueType,pointValueType> {
180  public:
184 
185  template<EOperator opType>
186  struct Serial {
187  template<typename outputValueValueType, class ...outputValueProperties,
188  typename inputPointValueType, class ...inputPointProperties>
189  KOKKOS_INLINE_FUNCTION
190  static void
191  getValues( Kokkos::DynRankView<outputValueValueType,outputValueProperties...> outputValues,
192  const Kokkos::DynRankView<inputPointValueType, inputPointProperties...> inputPoints );
193 
194  };
195 
196 
200 
204 
206 
207  virtual
208  void
209  getValues( outputViewType outputValues,
210  const pointViewType inputPoints,
211  const EOperator operatorType = OPERATOR_VALUE ) const {
212 #ifdef HAVE_INTREPID2_DEBUG
213  Intrepid2::getValues_HDIV_Args(outputValues,
214  inputPoints,
215  operatorType,
216  this->getBaseCellTopology(),
217  this->getCardinality() );
218 #endif
219  Impl::Basis_HDIV_HEX_I1_FEM::
220  getValues<ExecSpaceType>( outputValues,
221  inputPoints,
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_HDIV_HEX_I1_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->basisCardinality_, std::invalid_argument,
234  ">>> ERROR: (Intrepid2::Basis_HDIV_HEX_I1_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->basisCellTopology_.getDimension(), std::invalid_argument,
237  ">>> ERROR: (Intrepid2::Basis_HDIV_HEX_I1_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() != 2, std::invalid_argument,
248  ">>> ERROR: (Intrepid2::Basis_HDIV_HEX_I1_FEM::getDofCoeffs) rank = 2 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_HDIV_HEX_I1_FEM::getDofCoeffs) mismatch in number of dof and 0th dimension of dofCoeffs array");
252  // Verify 1st dimension of output array.
253  INTREPID2_TEST_FOR_EXCEPTION( dofCoeffs.extent(1) != this->getBaseCellTopology().getDimension(), std::invalid_argument,
254  ">>> ERROR: (Intrepid2::Basis_HDIV_HEX_I1_FEM::getDofCoeffs) incorrect reference cell (1st) dimension in dofCoeffs array");
255 #endif
256  Kokkos::deep_copy(dofCoeffs, this->dofCoeffs_);
257  }
258 
259  virtual
260  const char*
261  getName() const {
262  return "Intrepid2_HDIV_HEX_I1_FEM";
263  }
264 
265  virtual
266  bool
268  return true;
269  }
270 
271  };
272 
273 }// namespace Intrepid2
274 
276 
277 #endif
Definition file for FEM basis functions of degree 1 for H(div) functions on HEX cells.
Kokkos::DynRankView< scalarType, Kokkos::LayoutStride, ExecSpaceType > scalarViewType
View type for scalars.
ordinal_type basisCardinality_
Cardinality of the basis, i.e., the number of basis functions/degrees-of-freedom. ...
An abstract base class that defines interface for concrete basis implementations for Finite Element (...
Kokkos::DynRankView< outputValueType, Kokkos::LayoutStride, ExecSpaceType > outputViewType
View type for basis value output.
shards::CellTopology getBaseCellTopology() const
Returns the base cell topology for which the basis is defined. See Shards documentation https://trili...
Kokkos::DynRankView< scalarType, ExecSpaceType > dofCoords_
Coordinates of degrees-of-freedom for basis functions defined in physical space.
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.
Kokkos::View< ordinal_type ***, typename ExecSpaceType::array_layout, Kokkos::HostSpace > ordinal_type_array_3d_host
View type for 3d host array.
Implementation of the default H(div)-compatible FEM basis of degree 1 on Hexahedron cell...
See Intrepid2::Basis_HDIV_HEX_I1_FEM.
Kokkos::View< ordinal_type *,typename ExecSpaceType::array_layout, Kokkos::HostSpace > ordinal_type_array_1d_host
View type for 1d host array.
Kokkos::DynRankView< pointValueType, Kokkos::LayoutStride, ExecSpaceType > pointViewType
View type for input points.
virtual bool requireOrientation() const
True if orientation is required.
virtual void getDofCoords(scalarViewType dofCoords) const
Returns spatial locations (coordinates) of degrees of freedom on the reference cell.
virtual const char * getName() const
Returns basis name.
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...
Header file for the abstract base class Intrepid2::Basis.
Kokkos::View< ordinal_type **,typename ExecSpaceType::array_layout, Kokkos::HostSpace > ordinal_type_array_2d_host
View type for 2d host array.
shards::CellTopology basisCellTopology_
Base topology of the cells for which the basis is defined. See the Shards package for definition of b...