Intrepid2
Intrepid2_HCURL_QUAD_I1_FEM.hpp
Go to the documentation of this file.
1 // @HEADER
2 // *****************************************************************************
3 // Intrepid2 Package
4 //
5 // Copyright 2007 NTESS and the Intrepid2 contributors.
6 // SPDX-License-Identifier: BSD-3-Clause
7 // *****************************************************************************
8 // @HEADER
9 
16 #ifndef __INTREPID2_HCURL_QUAD_I1_FEM_HPP__
17 #define __INTREPID2_HCURL_QUAD_I1_FEM_HPP__
18 
19 #include "Intrepid2_Basis.hpp"
21 
22 namespace Intrepid2 {
23 
67  namespace Impl {
68 
73  public:
74  typedef struct Quadrilateral<4> cell_topology_type;
75 
79  template<EOperator opType>
80  struct Serial {
81  template<typename OutputViewType,
82  typename inputViewType>
83  KOKKOS_INLINE_FUNCTION
84  static void
85  getValues( OutputViewType output,
86  const inputViewType input );
87 
88  };
89 
90  template<typename DeviceType,
91  typename outputValueValueType, class ...outputValueProperties,
92  typename inputPointValueType, class ...inputPointProperties>
93  static void
94  getValues( Kokkos::DynRankView<outputValueValueType,outputValueProperties...> outputValues,
95  const Kokkos::DynRankView<inputPointValueType, inputPointProperties...> inputPoints,
96  const EOperator operatorType);
97 
101  template<typename outputValueViewType,
102  typename inputPointViewType,
103  EOperator opType>
104  struct Functor {
105  outputValueViewType _outputValues;
106  const inputPointViewType _inputPoints;
107 
108  KOKKOS_INLINE_FUNCTION
109  Functor( outputValueViewType outputValues_,
110  inputPointViewType inputPoints_)
111  : _outputValues(outputValues_), _inputPoints(inputPoints_) {}
112 
113  KOKKOS_INLINE_FUNCTION
114  void operator()(const ordinal_type pt) const {
115  switch (opType) {
116  case OPERATOR_VALUE : {
117  auto output = Kokkos::subview( _outputValues, Kokkos::ALL(), pt, Kokkos::ALL() );
118  const auto input = Kokkos::subview( _inputPoints, pt, Kokkos::ALL() );
119  Serial<opType>::getValues( output, input );
120  break;
121  }
122 
123  case OPERATOR_CURL: {
124  auto output = Kokkos::subview( _outputValues, Kokkos::ALL(), pt );
125  const auto input = Kokkos::subview( _inputPoints, pt, Kokkos::ALL() );
126  Serial<opType>::getValues( output, input );
127  break;
128  }
129  default: {
130  INTREPID2_TEST_FOR_ABORT( opType != OPERATOR_VALUE &&
131  opType != OPERATOR_CURL,
132  ">>> ERROR: (Intrepid2::Basis_HCURL_QUAD_CI_FEM::Serial::getVAlues) operator is not supported");
133  break;
134  }
135  } //end switch
136  }
137 
138  };
139  };
140  }
141 
142  template<typename DeviceType = void,
143  typename outputValueType = double,
144  typename pointValueType = double>
145  class Basis_HCURL_QUAD_I1_FEM : public Basis<DeviceType,outputValueType, pointValueType> {
146  public:
148  using OrdinalTypeArray1DHost = typename BasisBase::OrdinalTypeArray1DHost;
149  using OrdinalTypeArray2DHost = typename BasisBase::OrdinalTypeArray2DHost;
150  using OrdinalTypeArray3DHost = typename BasisBase::OrdinalTypeArray3DHost;
151 
152 
156 
157  using OutputViewType = typename BasisBase::OutputViewType;
158  using PointViewType = typename BasisBase::PointViewType;
159  using ScalarViewType = typename BasisBase::ScalarViewType;
160 
161  using BasisBase::getValues;
162 
163  virtual
164  void
165  getValues( OutputViewType outputValues,
166  const PointViewType inputPoints,
167  const EOperator operatorType = OPERATOR_VALUE ) const override {
168 #ifdef HAVE_INTREPID2_DEBUG
169  // Verify arguments
170  Intrepid2::getValues_HCURL_Args(outputValues,
171  inputPoints,
172  operatorType,
173  this->getBaseCellTopology(),
174  this->getCardinality() );
175 #endif
176  Impl::Basis_HCURL_QUAD_I1_FEM::
177  getValues<DeviceType>( outputValues,
178  inputPoints,
179  operatorType );
180  }
181 
182  virtual void
183  getScratchSpaceSize( ordinal_type& perTeamSpaceSize,
184  ordinal_type& perThreadSpaceSize,
185  const PointViewType inputPointsconst,
186  const EOperator operatorType = OPERATOR_VALUE) const override;
187 
188  KOKKOS_INLINE_FUNCTION
189  virtual void
190  getValues(
191  OutputViewType outputValues,
192  const PointViewType inputPoints,
193  const EOperator operatorType,
194  const typename Kokkos::TeamPolicy<typename DeviceType::execution_space>::member_type& team_member,
195  const typename DeviceType::execution_space::scratch_memory_space & scratchStorage,
196  const ordinal_type subcellDim = -1,
197  const ordinal_type subcellOrdinal = -1) const override;
198 
199  virtual
200  void
201  getDofCoords( ScalarViewType dofCoords ) const override {
202 #ifdef HAVE_INTREPID2_DEBUG
203  // Verify rank of output array.
204  INTREPID2_TEST_FOR_EXCEPTION( dofCoords.rank() != 2, std::invalid_argument,
205  ">>> ERROR: (Intrepid2::Basis_HCURL_QUAD_I1_FEM::getDofCoords) rank = 2 required for dofCoords array");
206  // Verify 0th dimension of output array.
207  INTREPID2_TEST_FOR_EXCEPTION( static_cast<ordinal_type>(dofCoords.extent(0)) != this->basisCardinality_, std::invalid_argument,
208  ">>> ERROR: (Intrepid2::Basis_HCURL_QUAD_I1_FEM::getDofCoords) mismatch in number of dof and 0th dimension of dofCoords array");
209  // Verify 1st dimension of output array.
210  INTREPID2_TEST_FOR_EXCEPTION( dofCoords.extent(1) != this->getBaseCellTopology().getDimension(), std::invalid_argument,
211  ">>> ERROR: (Intrepid2::Basis_HCURL_QUAD_I1_FEM::getDofCoords) incorrect reference cell (1st) dimension in dofCoords array");
212 #endif
213  Kokkos::deep_copy(dofCoords, this->dofCoords_);
214  }
215 
216  virtual
217  void
218  getDofCoeffs( ScalarViewType dofCoeffs ) const override {
219 #ifdef HAVE_INTREPID2_DEBUG
220  // Verify rank of output array.
221  INTREPID2_TEST_FOR_EXCEPTION( dofCoeffs.rank() != 2, std::invalid_argument,
222  ">>> ERROR: (Intrepid2::Basis_HCURL_QUAD_I1_FEM::getDofCoeffs) rank = 2 required for dofCoeffs array");
223  // Verify 0th dimension of output array.
224  INTREPID2_TEST_FOR_EXCEPTION( static_cast<ordinal_type>(dofCoeffs.extent(0)) != this->getCardinality(), std::invalid_argument,
225  ">>> ERROR: (Intrepid2::Basis_HCURL_QUAD_I1_FEM::getDofCoeffs) mismatch in number of dof and 0th dimension of dofCoeffs array");
226  // Verify 1st dimension of output array.
227  INTREPID2_TEST_FOR_EXCEPTION( dofCoeffs.extent(1) != this->getBaseCellTopology().getDimension(), std::invalid_argument,
228  ">>> ERROR: (Intrepid2::Basis_HCURL_QUAD_I1_FEM::getDofCoeffs) incorrect reference cell (1st) dimension in dofCoeffs array");
229 #endif
230  Kokkos::deep_copy(dofCoeffs, this->dofCoeffs_);
231  }
232 
233  virtual
234  const char*
235  getName() const override {
236  return "Intrepid2_HCURL_QUAD_I1_FEM";
237  }
238 
239  virtual
240  bool
241  requireOrientation() const override {
242  return true;
243  }
244 
254  BasisPtr<DeviceType,outputValueType,pointValueType>
255  getSubCellRefBasis(const ordinal_type subCellDim, const ordinal_type subCellOrd) const override{
256  if(subCellDim == 1)
257  return Teuchos::rcp( new
258  Basis_HVOL_C0_FEM<DeviceType,outputValueType,pointValueType>(shards::getCellTopologyData<shards::Line<2> >()));
259 
260  INTREPID2_TEST_FOR_EXCEPTION(true,std::invalid_argument,"Input parameters out of bounds");
261  }
262 
263  BasisPtr<typename Kokkos::HostSpace::device_type,outputValueType,pointValueType>
264  getHostBasis() const override{
266  }
267 
268  };
269 }// namespace Intrepid2
270 
272 
273 #endif
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.
BasisPtr< DeviceType, outputValueType, pointValueType > getSubCellRefBasis(const ordinal_type subCellDim, const ordinal_type subCellOrd) const override
returns the basis associated to a subCell.
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...
Implementation of the default H(curl)-compatible FEM basis of degree 1 on Quadrilateral cell...
Kokkos::DynRankView< scalarType, Kokkos::LayoutStride, DeviceType > ScalarViewType
View type for scalars.
virtual bool requireOrientation() const override
True if orientation is required.
virtual const char * getName() const override
Returns basis name.
virtual KOKKOS_INLINE_FUNCTION void getValues(OutputViewType, const PointViewType, const EOperator, const typename Kokkos::TeamPolicy< ExecutionSpace >::member_type &teamMember, const typename ExecutionSpace::scratch_memory_space &scratchStorage, const ordinal_type subcellDim=-1, const ordinal_type subcellOrdinal=-1) const
Team-level evaluation of basis functions on a reference cell.
Kokkos::View< ordinal_type **, typename ExecutionSpace::array_layout, Kokkos::HostSpace > OrdinalTypeArray2DHost
View type for 2d host array.
Header file for the Intrepid2::Basis_HVOL_C0_FEM class.
Definition file for FEM basis functions of degree 1 for H(curl) functions on Qadrilateral cells...
Kokkos::DynRankView< OutputValueType, Kokkos::LayoutStride, DeviceType > OutputViewType
View type for basis value output.
BasisPtr< typename Kokkos::HostSpace::device_type, outputValueType, pointValueType > getHostBasis() const override
Creates and returns a Basis object whose DeviceType template argument is Kokkos::HostSpace::device_ty...
Implementation of the default HVOL-compatible FEM contstant basis on triangle, quadrilateral, hexahedron and tetrahedron cells.
ordinal_type basisCardinality_
Cardinality of the basis, i.e., the number of basis functions/degrees-of-freedom. ...
Kokkos::View< ordinal_type ***, typename ExecutionSpace::array_layout, Kokkos::HostSpace > OrdinalTypeArray3DHost
View type for 3d host array.
Kokkos::DynRankView< scalarType, DeviceType > dofCoeffs_
Coefficients for computing degrees of freedom for Lagrangian basis If P is an element of the space sp...
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.
See Intrepid2::Basis_HCURL_QUAD_I1_FEM.
Header file for the abstract base class Intrepid2::Basis.