Intrepid2
Intrepid2_HGRAD_LINE_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_LINE_C1_FEM_HPP__
50 #define __INTREPID2_HGRAD_LINE_C1_FEM_HPP__
51 
52 #include "Intrepid2_Basis.hpp"
53 
54 namespace Intrepid2 {
55 
78  namespace Impl {
79 
84  public:
85  typedef struct Line<2> cell_topology_type;
89  template<EOperator opType>
90  struct Serial {
91  template<typename OutputViewType,
92  typename inputViewType>
93  KOKKOS_INLINE_FUNCTION
94  static void
95  getValues( OutputViewType output,
96  const inputViewType input );
97 
98  };
99 
100  template<typename ExecSpaceType,
101  typename outputValueValueType, class ...outputValueProperties,
102  typename inputPointValueType, class ...inputPointProperties>
103  static void
104  getValues( Kokkos::DynRankView<outputValueValueType,outputValueProperties...> outputValues,
105  const Kokkos::DynRankView<inputPointValueType, inputPointProperties...> inputPoints,
106  const EOperator operatorType);
107 
111  template<typename outputValueViewType,
112  typename inputPointViewType,
113  EOperator opType>
114  struct Functor {
115  outputValueViewType _outputValues;
116  const inputPointViewType _inputPoints;
117 
118  KOKKOS_INLINE_FUNCTION
119  Functor( outputValueViewType outputValues_,
120  inputPointViewType inputPoints_ )
121  : _outputValues(outputValues_), _inputPoints(inputPoints_) {}
122 
123  KOKKOS_INLINE_FUNCTION
124  void operator()(const ordinal_type pt) const {
125  switch (opType) {
126  case OPERATOR_VALUE : {
127  auto output = Kokkos::subview( _outputValues, Kokkos::ALL(), pt );
128  const auto input = Kokkos::subview( _inputPoints, pt, Kokkos::ALL() );
129  Serial<opType>::getValues( output, input );
130  break;
131  }
132  case OPERATOR_GRAD :
133  case OPERATOR_MAX : {
134  auto output = Kokkos::subview( _outputValues, Kokkos::ALL(), pt, Kokkos::ALL() );
135  const auto input = Kokkos::subview( _inputPoints, pt, Kokkos::ALL() );
136  Serial<opType>::getValues( output, input );
137  break;
138  }
139  default: {
140  INTREPID2_TEST_FOR_ABORT( opType != OPERATOR_VALUE &&
141  opType != OPERATOR_GRAD &&
142  opType != OPERATOR_MAX,
143  ">>> ERROR: (Intrepid2::Basis_HGRAD_LINE_C1_FEM::Serial::getValues) operator is not supported");
144 
145  }
146  }
147  }
148  };
149  };
150  }
151 
152  template<typename ExecSpaceType = void,
153  typename outputValueType = double,
154  typename pointValueType = double>
156  : public Basis<ExecSpaceType,outputValueType,pointValueType> {
157  public:
161 
162  using ordinal_type_array_1d_host INTREPID2_DEPRECATED_TYPENAME_REPLACEMENT("use OrdinalTypeArray1DHost instead","OrdinalTypeArray1DHost") = OrdinalTypeArray1DHost INTREPID2_DEPRECATED_TYPENAME_TRAILING_ATTRIBUTE("use OrdinalTypeArray1DHost instead");
163  using ordinal_type_array_2d_host INTREPID2_DEPRECATED_TYPENAME_REPLACEMENT("use OrdinalTypeArray2DHost instead","OrdinalTypeArray2DHost") = OrdinalTypeArray2DHost INTREPID2_DEPRECATED_TYPENAME_TRAILING_ATTRIBUTE("use OrdinalTypeArray2DHost instead");
164  using ordinal_type_array_3d_host INTREPID2_DEPRECATED_TYPENAME_REPLACEMENT("use OrdinalTypeArray3DHost instead","OrdinalTypeArray3DHost") = OrdinalTypeArray3DHost INTREPID2_DEPRECATED_TYPENAME_TRAILING_ATTRIBUTE("use OrdinalTypeArray3DHost instead");
165 
169 
173 
174  using outputViewType INTREPID2_DEPRECATED_TYPENAME_REPLACEMENT("use OutputViewType instead","OutputViewType") = OutputViewType INTREPID2_DEPRECATED_TYPENAME_TRAILING_ATTRIBUTE("use OutputViewType instead");
175  using pointViewType INTREPID2_DEPRECATED_TYPENAME_REPLACEMENT("use PointViewType instead","PointViewType") = PointViewType INTREPID2_DEPRECATED_TYPENAME_TRAILING_ATTRIBUTE("use PointViewType instead");
176  using scalarViewType INTREPID2_DEPRECATED_TYPENAME_REPLACEMENT("use ScalarViewType instead","ScalarViewType") = ScalarViewType INTREPID2_DEPRECATED_TYPENAME_TRAILING_ATTRIBUTE("use ScalarViewType instead");
177 
179 
180  virtual
181  void
182  getValues( OutputViewType outputValues,
183  const PointViewType inputPoints,
184  const EOperator operatorType = OPERATOR_VALUE ) const {
185 #ifdef HAVE_INTREPID2_DEBUG
186  // Verify arguments
187  Intrepid2::getValues_HGRAD_Args(outputValues,
188  inputPoints,
189  operatorType,
190  this->getBaseCellTopology(),
191  this->getCardinality() );
192 #endif
193  Impl::Basis_HGRAD_LINE_C1_FEM::
194  getValues<ExecSpaceType>( outputValues,
195  inputPoints,
196  operatorType );
197  }
198 
199  virtual
200  void
201  getDofCoords( ScalarViewType dofCoords ) const {
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_HGRAD_LINE_C1_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_HGRAD_LINE_C1_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->basisCellTopology_.getDimension(), std::invalid_argument,
211  ">>> ERROR: (Intrepid2::Basis_HGRAD_LINE_C1_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 {
219 #ifdef HAVE_INTREPID2_DEBUG
220  // Verify rank of output array.
221  INTREPID2_TEST_FOR_EXCEPTION( dofCoeffs.rank() != 1, std::invalid_argument,
222  ">>> ERROR: (Intrepid2::Basis_HGRAD_LINE_C1_FEM::getdofCoeffs) rank = 1 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_HGRAD_LINE_C1_FEM::getdofCoeffs) mismatch in number of dof and 0th dimension of dofCoeffs array");
226 #endif
227  Kokkos::deep_copy(dofCoeffs, 1.0);
228  }
229 
230  virtual
231  const char*
232  getName() const {
233  return "Intrepid2_HGRAD_LINE_C1_FEM";
234  }
235 
236  };
237 
238 }// namespace Intrepid2
239 
241 
242 #endif
See Intrepid2::Basis_HGRAD_LINE_C1_FEM.
Definition file for FEM basis functions of degree 1 for H(grad) functions on a Line.
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.
ordinal_type basisCardinality_
Cardinality of the basis, i.e., the number of basis functions/degrees-of-freedom. ...
virtual void getDofCoords(ScalarViewType dofCoords) const
Returns spatial locations (coordinates) of degrees of freedom on the reference 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...
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.
Kokkos::DynRankView< OutputValueType, Kokkos::LayoutStride, ExecSpaceType > OutputViewType
View type for basis value output.
virtual void getDofCoeffs(ScalarViewType dofCoeffs) const
Coefficients for computing degrees of freedom for Lagrangian basis If P is an element of the space sp...
Kokkos::View< ordinal_type ***, typename ExecSpaceType::array_layout, Kokkos::HostSpace > OrdinalTypeArray3DHost
View type for 3d host array.
virtual const char * getName() const
Returns basis name.
Kokkos::DynRankView< PointValueType, Kokkos::LayoutStride, ExecSpaceType > PointViewType
View type for input points.
virtual void getValues(OutputViewType outputValues, const PointViewType inputPoints, const EOperator operatorType=OPERATOR_VALUE) const
Evaluation of a FEM basis on a reference cell.
Implementation of the default H(grad)-compatible FEM basis of degree 1 on Line cell.
Kokkos::DynRankView< scalarType, Kokkos::LayoutStride, ExecSpaceType > ScalarViewType
View type for scalars.
Header file for the abstract base class Intrepid2::Basis.
shards::CellTopology basisCellTopology_
Base topology of the cells for which the basis is defined. See the Shards package for definition of b...