Intrepid2
Intrepid2_HGRAD_TET_COMP12_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_TET_COMP12_FEM_HPP__
50 #define __INTREPID2_HGRAD_TET_COMP12_FEM_HPP__
51 
52 #include "Intrepid2_Basis.hpp"
53 
54 namespace Intrepid2 {
55 
100  namespace Impl {
101 
106  public:
107  typedef struct Tetrahedron<4> cell_topology_type;
108 
112  template<typename pointValueType>
113  KOKKOS_INLINE_FUNCTION
114  static ordinal_type
115  getLocalSubTet( const pointValueType x,
116  const pointValueType y,
117  const pointValueType z );
118 
122  template<EOperator opType>
123  struct Serial {
124  template<typename outputValueViewType,
125  typename inputPointViewType>
126  KOKKOS_INLINE_FUNCTION
127  static void
128  getValues( outputValueViewType outputValues,
129  const inputPointViewType inputPoints );
130 
131  };
132 
133  template<typename DeviceType,
134  typename outputValueValueType, class ...outputValueProperties,
135  typename inputPointValueType, class ...inputPointProperties>
136  static void
137  getValues( const typename DeviceType::execution_space& space,
138  Kokkos::DynRankView<outputValueValueType,outputValueProperties...> outputValues,
139  const Kokkos::DynRankView<inputPointValueType, inputPointProperties...> inputPoints,
140  const EOperator operatorType );
141 
145  template<typename outputValueViewType,
146  typename inputPointViewType,
147  EOperator opType>
148  struct Functor {
149  outputValueViewType _outputValues;
150  const inputPointViewType _inputPoints;
151 
152  KOKKOS_INLINE_FUNCTION
153  Functor( outputValueViewType outputValues_,
154  inputPointViewType inputPoints_ )
155  : _outputValues(outputValues_), _inputPoints(inputPoints_) {}
156 
157  KOKKOS_INLINE_FUNCTION
158  void operator()(const ordinal_type pt) const {
159  switch (opType) {
160  case OPERATOR_VALUE : {
161  auto output = Kokkos::subview( _outputValues, Kokkos::ALL(), pt );
162  const auto input = Kokkos::subview( _inputPoints, pt, Kokkos::ALL() );
163  Serial<opType>::getValues( output, input );
164  break;
165  }
166  case OPERATOR_GRAD :
167  case OPERATOR_MAX : {
168  auto output = Kokkos::subview( _outputValues, Kokkos::ALL(), pt, Kokkos::ALL() );
169  const auto input = Kokkos::subview( _inputPoints, pt, Kokkos::ALL() );
170  Serial<opType>::getValues( output, input );
171  break;
172  }
173  default: {
174  INTREPID2_TEST_FOR_ABORT( opType != OPERATOR_VALUE &&
175  opType != OPERATOR_GRAD &&
176  opType != OPERATOR_MAX,
177  ">>> ERROR: (Intrepid2::Basis_HGRAD_TET_COMP12_FEM::Functor::operator() operator is not supported");
178  }
179  }
180  }
181  };
182  };
183  }
184 
185  template<typename DeviceType = void,
186  typename outputValueType = double,
187  typename pointValueType = double>
188  class Basis_HGRAD_TET_COMP12_FEM : public Basis<DeviceType,outputValueType,pointValueType> {
189  public:
191  using typename BasisBase::ExecutionSpace;
192 
193  using typename BasisBase::OrdinalTypeArray1DHost;
194  using typename BasisBase::OrdinalTypeArray2DHost;
195  using typename BasisBase::OrdinalTypeArray3DHost;
196 
197  using typename BasisBase::OutputViewType;
198  using typename BasisBase::PointViewType ;
199  using typename BasisBase::ScalarViewType;
200 
204 
205  using BasisBase::getValues;
206 
219  virtual
220  void
221  getValues( const ExecutionSpace& space,
222  OutputViewType outputValues,
223  const PointViewType inputPoints,
224  const EOperator operatorType = OPERATOR_VALUE ) const override {
225 #ifdef HAVE_INTREPID2_DEBUG
226  Intrepid2::getValues_HGRAD_Args(outputValues,
227  inputPoints,
228  operatorType,
229  this->getBaseCellTopology(),
230  this->getCardinality() );
231 #endif
232  Impl::Basis_HGRAD_TET_COMP12_FEM::
233  getValues<DeviceType>(space,
234  outputValues,
235  inputPoints,
236  operatorType);
237  }
238 
245  virtual
246  void
247  getDofCoords( ScalarViewType dofCoords ) const override {
248 #ifdef HAVE_INTREPID2_DEBUG
249  // Verify rank of output array.
250  INTREPID2_TEST_FOR_EXCEPTION( rank(dofCoords) != 2, std::invalid_argument,
251  ">>> ERROR: (Intrepid2::Basis_HGRAD_TET_COMP12_FEM::getDofCoords) rank = 2 required for dofCoords array");
252  // Verify 0th dimension of output array.
253  INTREPID2_TEST_FOR_EXCEPTION( static_cast<ordinal_type>(dofCoords.extent(0)) != this->getCardinality(), std::invalid_argument,
254  ">>> ERROR: (Intrepid2::Basis_HGRAD_TET_COMP12_FEM::getDofCoords) mismatch in number of dof and 0th dimension of dofCoords array");
255  // Verify 1st dimension of output array.
256  INTREPID2_TEST_FOR_EXCEPTION( dofCoords.extent(1) != this->getBaseCellTopology().getDimension(), std::invalid_argument,
257  ">>> ERROR: (Intrepid2::Basis_HGRAD_TET_COMP12_FEM::getDofCoords) incorrect reference cell (1st) dimension in dofCoords array");
258 #endif
259  Kokkos::deep_copy(dofCoords, this->dofCoords_);
260  }
261 
262  virtual
263  const char*
264  getName() const override {
265  return "Intrepid2_HGRAD_TET_COMP12_FEM";
266  }
267 
268  };
269 }// namespace Intrepid2
270 
272 
273 #endif
See Intrepid2::Basis_HGRAD_TET_COMP12_FEM.
Kokkos::View< ordinal_type *, typename ExecutionSpace::array_layout, Kokkos::HostSpace > OrdinalTypeArray1DHost
View type for 1d host array.
ordinal_type getCardinality() const
Returns cardinality of the basis.
virtual void getValues(const ExecutionSpace &, OutputViewType, const PointViewType, const EOperator=OPERATOR_VALUE) const
Evaluation of a FEM basis on a reference cell.
virtual void getValues(const ExecutionSpace &space, OutputViewType outputValues, const PointViewType inputPoints, const EOperator operatorType=OPERATOR_VALUE) const override
FEM basis evaluation on a reference Tetrahedron cell.
An abstract base class that defines interface for concrete basis implementations for Finite Element (...
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 override
Returns basis name.
Kokkos::DynRankView< scalarType, Kokkos::LayoutStride, DeviceType > ScalarViewType
View type for scalars.
Kokkos::View< ordinal_type **, typename ExecutionSpace::array_layout, Kokkos::HostSpace > OrdinalTypeArray2DHost
View type for 2d host array.
Kokkos::DynRankView< OutputValueType, Kokkos::LayoutStride, DeviceType > OutputViewType
View type for basis value output.
static KOKKOS_INLINE_FUNCTION ordinal_type getLocalSubTet(const pointValueType x, const pointValueType y, const pointValueType z)
See Intrepid2::Basis_HGRAD_TET_COMP12_FEM.
typename DeviceType::execution_space ExecutionSpace
(Kokkos) Execution space for basis.
Kokkos::DynRankView< scalarType, Kokkos::LayoutStride, DeviceType > ScalarViewType
View type for scalars.
Kokkos::View< ordinal_type ***, typename ExecutionSpace::array_layout, Kokkos::HostSpace > OrdinalTypeArray3DHost
View type for 3d host array.
Implementation of the default H(grad)-compatible FEM basis of degree 2 on Tetrahedron cell...
Kokkos::DynRankView< OutputValueType, Kokkos::LayoutStride, DeviceType > OutputViewType
View type for basis value output.
Kokkos::DynRankView< PointValueType, Kokkos::LayoutStride, DeviceType > PointViewType
View type for input points.
virtual void getDofCoords(ScalarViewType dofCoords) const override
Returns spatial locations (coordinates) of degrees of freedom on a reference Tetrahedron.
Definition file for the composite H(grad)-compatible FEM basis of degree 1 on Tetrahedron cell with 1...
Kokkos::DynRankView< scalarType, DeviceType > dofCoords_
Coordinates of degrees-of-freedom for basis functions defined in physical space.
Kokkos::DynRankView< PointValueType, Kokkos::LayoutStride, DeviceType > PointViewType
View type for input points.
Header file for the abstract base class Intrepid2::Basis.
typename DeviceType::execution_space ExecutionSpace
(Kokkos) Execution space for basis.