Intrepid2
Intrepid2_HGRAD_HEX_C1_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_HGRAD_HEX_C1_FEM_HPP__
50 #define __INTREPID2_HGRAD_HEX_C1_FEM_HPP__
51 
52 #include "Intrepid2_Basis.hpp"
53 
54 namespace Intrepid2 {
55 
91  namespace Impl {
92 
97  public:
98  typedef struct Hexahedron<8> cell_topology_type;
102  template<EOperator opType>
103  struct Serial {
104  template<typename OutputViewType,
105  typename inputViewType>
106  KOKKOS_INLINE_FUNCTION
107  static void
108  getValues( OutputViewType output,
109  const inputViewType input );
110 
111  };
112 
113  template<typename ExecSpaceType,
114  typename outputValueValueType, class ...outputValueProperties,
115  typename inputPointValueType, class ...inputPointProperties>
116  static void
117  getValues( Kokkos::DynRankView<outputValueValueType,outputValueProperties...> outputValues,
118  const Kokkos::DynRankView<inputPointValueType, inputPointProperties...> inputPoints,
119  const EOperator operatorType);
120 
124  template<typename outputValueViewType,
125  typename inputPointViewType,
126  EOperator opType>
127  struct Functor {
128  outputValueViewType _outputValues;
129  const inputPointViewType _inputPoints;
130 
131  KOKKOS_INLINE_FUNCTION
132  Functor( outputValueViewType outputValues_,
133  inputPointViewType inputPoints_ )
134  : _outputValues(outputValues_), _inputPoints(inputPoints_) {}
135 
136  KOKKOS_INLINE_FUNCTION
137  void operator()(const ordinal_type pt) const {
138  switch (opType) {
139  case OPERATOR_VALUE : {
140  auto output = Kokkos::subview( _outputValues, Kokkos::ALL(), pt );
141  const auto input = Kokkos::subview( _inputPoints, pt, Kokkos::ALL() );
142  Serial<opType>::getValues( output, input );
143  break;
144  }
145  case OPERATOR_GRAD :
146  case OPERATOR_D2 :
147  case OPERATOR_D3 :
148  case OPERATOR_MAX : {
149  auto output = Kokkos::subview( _outputValues, Kokkos::ALL(), pt, Kokkos::ALL() );
150  const auto input = Kokkos::subview( _inputPoints, pt, Kokkos::ALL() );
151  Serial<opType>::getValues( output, input );
152  break;
153  }
154  default: {
155  INTREPID2_TEST_FOR_ABORT( opType != OPERATOR_VALUE &&
156  opType != OPERATOR_GRAD &&
157  opType != OPERATOR_D2 &&
158  opType != OPERATOR_D3 &&
159  opType != OPERATOR_MAX,
160  ">>> ERROR: (Intrepid2::Basis_HGRAD_HEX_C1_FEM::Serial::getValues) operator is not supported");
161  }
162  }
163  }
164  };
165  };
166  }
167 
168  template<typename ExecSpaceType = void,
169  typename outputValueType = double,
170  typename pointValueType = double>
171  class Basis_HGRAD_HEX_C1_FEM : public Basis<ExecSpaceType,outputValueType,pointValueType> {
172  public:
176 
180 
184 
186 
187  virtual
188  void
189  getValues( OutputViewType outputValues,
190  const PointViewType inputPoints,
191  const EOperator operatorType = OPERATOR_VALUE ) const {
192 #ifdef HAVE_INTREPID2_DEBUG
193  // Verify arguments
194  Intrepid2::getValues_HGRAD_Args(outputValues,
195  inputPoints,
196  operatorType,
197  this->getBaseCellTopology(),
198  this->getCardinality() );
199 #endif
200  Impl::Basis_HGRAD_HEX_C1_FEM::
201  getValues<ExecSpaceType>( outputValues,
202  inputPoints,
203  operatorType );
204  }
205 
206  virtual
207  void
208  getDofCoords( ScalarViewType dofCoords ) const {
209 #ifdef HAVE_INTREPID2_DEBUG
210  // Verify rank of output array.
211  INTREPID2_TEST_FOR_EXCEPTION( dofCoords.rank() != 2, std::invalid_argument,
212  ">>> ERROR: (Intrepid2::Basis_HGRAD_HEX_C1_FEM::getDofCoords) rank = 2 required for dofCoords array");
213  // Verify 0th dimension of output array.
214  INTREPID2_TEST_FOR_EXCEPTION( static_cast<ordinal_type>(dofCoords.extent(0)) != this->getCardinality(), std::invalid_argument,
215  ">>> ERROR: (Intrepid2::Basis_HGRAD_HEX_C1_FEM::getDofCoords) mismatch in number of dof and 0th dimension of dofCoords array");
216  // Verify 1st dimension of output array.
217  INTREPID2_TEST_FOR_EXCEPTION( dofCoords.extent(1) != this->getBaseCellTopology().getDimension(), std::invalid_argument,
218  ">>> ERROR: (Intrepid2::Basis_HGRAD_HEX_C1_FEM::getDofCoords) incorrect reference cell (1st) dimension in dofCoords array");
219 #endif
220  Kokkos::deep_copy(dofCoords, this->dofCoords_);
221  }
222 
223  virtual
224  void
225  getDofCoeffs( ScalarViewType dofCoeffs ) const {
226 #ifdef HAVE_INTREPID2_DEBUG
227  // Verify rank of output array.
228  INTREPID2_TEST_FOR_EXCEPTION( dofCoeffs.rank() != 1, std::invalid_argument,
229  ">>> ERROR: (Intrepid2::Basis_HGRAD_HEX_C1_FEM::getdofCoeffs) rank = 1 required for dofCoeffs array");
230  // Verify 0th dimension of output array.
231  INTREPID2_TEST_FOR_EXCEPTION( static_cast<ordinal_type>(dofCoeffs.extent(0)) != this->getCardinality(), std::invalid_argument,
232  ">>> ERROR: (Intrepid2::Basis_HGRAD_HEX_C1_FEM::getdofCoeffs) mismatch in number of dof and 0th dimension of dofCoeffs array");
233 #endif
234  Kokkos::deep_copy(dofCoeffs, 1.0);
235  }
236 
237  virtual
238  const char*
239  getName() const {
240  return "Intrepid2_HGRAD_HEX_C1_FEM";
241  }
242 
243  };
244 }// namespace Intrepid2
245 
247 
248 #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.
Definition file for FEM basis functions of degree 1 for H(grad) functions on HEX 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 > 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...
virtual void getValues(OutputViewType outputValues, const PointViewType inputPoints, const EOperator operatorType=OPERATOR_VALUE) const
Evaluation of a FEM basis on a reference cell.
shards::CellTopology getBaseCellTopology() const
Returns the base cell topology for which the basis is defined. See Shards documentation https://trili...
virtual const char * getName() const
Returns basis name.
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...
void getValues_HGRAD_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 HGRAD-conforming FEM basis...
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.
Kokkos::DynRankView< PointValueType, Kokkos::LayoutStride, ExecSpaceType > PointViewType
View type for input points.
See Intrepid2::Basis_HGRAD_HEX_C1_FEM.
Kokkos::DynRankView< scalarType, Kokkos::LayoutStride, ExecSpaceType > ScalarViewType
View type for scalars.
Implementation of the default H(grad)-compatible FEM basis of degree 1 on Hexahedron cell...
Header file for the abstract base class Intrepid2::Basis.