Intrepid2
Intrepid2_HGRAD_PYR_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_PYR_C1_FEM_HPP__
50 #define __INTREPID2_HGRAD_PYR_C1_FEM_HPP__
51 
52 #include "Intrepid2_Basis.hpp"
53 
54 namespace Intrepid2 {
55 
84  namespace Impl {
85 
90  public:
91  typedef struct Pyramid<5> cell_topology_type;
95  template<EOperator opType>
96  struct Serial {
97  template<typename outputViewType,
98  typename inputViewType>
99  KOKKOS_INLINE_FUNCTION
100  static void
101  getValues( outputViewType output,
102  const inputViewType input );
103 
104  };
105 
106  template<typename ExecSpaceType,
107  typename outputValueValueType, class ...outputValueProperties,
108  typename inputPointValueType, class ...inputPointProperties>
109  static void
110  getValues( Kokkos::DynRankView<outputValueValueType,outputValueProperties...> outputValues,
111  const Kokkos::DynRankView<inputPointValueType, inputPointProperties...> inputPoints,
112  const EOperator operatorType);
113 
117  template<typename outputValueViewType,
118  typename inputPointViewType,
119  EOperator opType>
120  struct Functor {
121  outputValueViewType _outputValues;
122  const inputPointViewType _inputPoints;
123 
124  KOKKOS_INLINE_FUNCTION
125  Functor( outputValueViewType outputValues_,
126  inputPointViewType inputPoints_ )
127  : _outputValues(outputValues_), _inputPoints(inputPoints_) {}
128 
129  KOKKOS_INLINE_FUNCTION
130  void operator()(const ordinal_type pt) const {
131  switch (opType) {
132  case OPERATOR_VALUE : {
133  auto output = Kokkos::subview( _outputValues, Kokkos::ALL(), pt );
134  const auto input = Kokkos::subview( _inputPoints, pt, Kokkos::ALL() );
135  Serial<opType>::getValues( output, input );
136  break;
137  }
138  case OPERATOR_GRAD :
139  case OPERATOR_CURL :
140  case OPERATOR_D2 :
141  case OPERATOR_MAX : {
142  auto output = Kokkos::subview( _outputValues, Kokkos::ALL(), pt, Kokkos::ALL() );
143  const auto input = Kokkos::subview( _inputPoints, pt, Kokkos::ALL() );
144  Serial<opType>::getValues( output, input );
145  break;
146  }
147  default: {
148  INTREPID2_TEST_FOR_ABORT( opType != OPERATOR_VALUE &&
149  opType != OPERATOR_GRAD &&
150  opType != OPERATOR_CURL &&
151  opType != OPERATOR_D2 &&
152  opType != OPERATOR_MAX,
153  ">>> ERROR: (Intrepid2::Basis_HGRAD_PYR_C1_FEM::Serial::getValues) operator is not supported");
154  }
155  }
156  }
157  };
158 
159  };
160  }
161  template<typename ExecSpaceType = void,
162  typename outputValueType = double,
163  typename pointValueType = double>
164  class Basis_HGRAD_PYR_C1_FEM : public Basis<ExecSpaceType,outputValueType,pointValueType> {
165  public:
169 
170 
174 
178 
180 
181  virtual
182  void
183  getValues( outputViewType outputValues,
184  const pointViewType inputPoints,
185  const EOperator operatorType = OPERATOR_VALUE ) const {
186 #ifdef HAVE_INTREPID2_DEBUG
187  // Verify arguments
188  Intrepid2::getValues_HGRAD_Args(outputValues,
189  inputPoints,
190  operatorType,
191  this->getBaseCellTopology(),
192  this->getCardinality() );
193 #endif
194  Impl::Basis_HGRAD_PYR_C1_FEM::
195  getValues<ExecSpaceType>( outputValues,
196  inputPoints,
197  operatorType );
198  }
199 
200  virtual
201  void
202  getDofCoords( scalarViewType dofCoords ) const {
203 #ifdef HAVE_INTREPID2_DEBUG
204  // Verify rank of output array.
205  INTREPID2_TEST_FOR_EXCEPTION( dofCoords.rank() != 2, std::invalid_argument,
206  ">>> ERROR: (Intrepid2::Basis_HGRAD_PYR_C1_FEM::getDofCoords) rank = 2 required for dofCoords array");
207  // Verify 0th dimension of output array.
208  INTREPID2_TEST_FOR_EXCEPTION( static_cast<ordinal_type>(dofCoords.extent(0)) != this->getCardinality(), std::invalid_argument,
209  ">>> ERROR: (Intrepid2::Basis_HGRAD_PYR_C1_FEM::getDofCoords) mismatch in number of dof and 0th dimension of dofCoords array");
210  // Verify 1st dimension of output array.
211  INTREPID2_TEST_FOR_EXCEPTION( dofCoords.extent(1) != this->getBaseCellTopology().getDimension(), std::invalid_argument,
212  ">>> ERROR: (Intrepid2::Basis_HGRAD_PYR_C1_FEM::getDofCoords) incorrect reference cell (1st) dimension in dofCoords array");
213 #endif
214  Kokkos::deep_copy(dofCoords, this->dofCoords_);
215  }
216 
217  virtual
218  void
219  getDofCoeffs( scalarViewType dofCoeffs ) const {
220 #ifdef HAVE_INTREPID2_DEBUG
221  // Verify rank of output array.
222  INTREPID2_TEST_FOR_EXCEPTION( dofCoeffs.rank() != 1, std::invalid_argument,
223  ">>> ERROR: (Intrepid2::Basis_HGRAD_PYR_C1_FEM::getdofCoeffs) rank = 1 required for dofCoeffs array");
224  // Verify 0th dimension of output array.
225  INTREPID2_TEST_FOR_EXCEPTION( static_cast<ordinal_type>(dofCoeffs.extent(0)) != this->getCardinality(), std::invalid_argument,
226  ">>> ERROR: (Intrepid2::Basis_HGRAD_PYR_C1_FEM::getdofCoeffs) mismatch in number of dof and 0th dimension of dofCoeffs array");
227 #endif
228  Kokkos::deep_copy(dofCoeffs, 1.0);
229  }
230 
231  virtual
232  const char*
233  getName() const {
234  return "Intrepid2_HGRAD_PYR_C1_FEM";
235  }
236 
237  };
238 }// namespace Intrepid2
239 
241 
242 #endif
Kokkos::DynRankView< scalarType, Kokkos::LayoutStride, ExecSpaceType > scalarViewType
View type for scalars.
Implementation of the default H(grad)-compatible FEM basis of degree 1 on Pyramid cell...
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< outputValueType, Kokkos::LayoutStride, ExecSpaceType > outputViewType
View type for basis value output.
Kokkos::DynRankView< scalarType, ExecSpaceType > dofCoords_
Coordinates of degrees-of-freedom for basis functions defined in physical space.
shards::CellTopology getBaseCellTopology() const
Returns the base cell topology for which the basis is defined. See Shards documentation https://trili...
Kokkos::View< ordinal_type ***, typename ExecSpaceType::array_layout, Kokkos::HostSpace > ordinal_type_array_3d_host
View type for 3d host array.
virtual void getDofCoords(scalarViewType dofCoords) const
Returns spatial locations (coordinates) of degrees of freedom on the reference cell.
virtual void getDofCoeffs(scalarViewType dofCoeffs) const
Coefficients for computing degrees of freedom for Lagrangian basis If P is an element of the space sp...
See Intrepid2::Basis_HGRAD_PYR_C1_FEM.
EOperator
Enumeration of primitive operators available in Intrepid. Primitive operators act on reconstructed fu...
Kokkos::View< ordinal_type *,typename ExecSpaceType::array_layout, Kokkos::HostSpace > ordinal_type_array_1d_host
View type for 1d host array.
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< pointValueType, Kokkos::LayoutStride, ExecSpaceType > pointViewType
View type for input points.
Definition file for FEM basis functions of degree 1 for H(grad) functions on PYR cells.
virtual const char * getName() const
Returns basis name.
virtual void getValues(outputViewType outputValues, const pointViewType inputPoints, const EOperator operatorType=OPERATOR_VALUE) const
Evaluation of a FEM basis on a reference cell.
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.