Intrepid2
Intrepid2_HVOL_C0_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 
48 #ifndef __INTREPID2_HVOL_C0_FEM_HPP__
49 #define __INTREPID2_HVOL_C0_FEM_HPP__
50 
51 #include "Intrepid2_CellTools.hpp"
52 #include "Intrepid2_Basis.hpp"
53 
54 namespace Intrepid2 {
55 
56  namespace Impl {
57 
62  public:
66  template<EOperator opType>
67  struct Serial {
68  template<typename OutputViewType,
69  typename inputViewType>
70  KOKKOS_INLINE_FUNCTION
71  static void
72  getValues( OutputViewType output,
73  const inputViewType input );
74 
75  };
76 
77  template<typename DeviceType,
78  typename outputValueValueType, class ...outputValueProperties,
79  typename inputPointValueType, class ...inputPointProperties>
80  static void
81  getValues( Kokkos::DynRankView<outputValueValueType,outputValueProperties...> outputValues,
82  const Kokkos::DynRankView<inputPointValueType, inputPointProperties...> inputPoints,
83  const EOperator operatorType);
84 
88  template<typename outputValueViewType,
89  typename inputPointViewType,
90  EOperator opType>
91  struct Functor {
92  outputValueViewType _outputValues;
93  const inputPointViewType _inputPoints;
94 
95  KOKKOS_INLINE_FUNCTION
96  Functor( outputValueViewType outputValues_,
97  inputPointViewType inputPoints_ )
98  : _outputValues(outputValues_), _inputPoints(inputPoints_) {}
99 
100  KOKKOS_INLINE_FUNCTION
101  void operator()(const ordinal_type pt) const {
102  switch (opType) {
103  case OPERATOR_VALUE : {
104  auto output = Kokkos::subview( _outputValues, Kokkos::ALL(), pt );
105  const auto input = Kokkos::subview( _inputPoints, pt, Kokkos::ALL() );
106  Serial<opType>::getValues( output, input );
107  break;
108  }
109  case OPERATOR_MAX : {
110  auto output = Kokkos::subview( _outputValues, Kokkos::ALL(), pt, Kokkos::ALL() );
111  const auto input = Kokkos::subview( _inputPoints, pt, Kokkos::ALL() );
112  Serial<opType>::getValues( output, input );
113  break;
114  }
115  default: {
116  INTREPID2_TEST_FOR_ABORT( opType != OPERATOR_VALUE &&
117  opType != OPERATOR_MAX,
118  ">>> ERROR: (Intrepid2::Basis_HVOL_C0_FEM::Serial::getValues) operator is not supported");
119  }
120  }
121  }
122  };
123  };
124  }
125 
129  template<typename DeviceType = void,
130  typename outputValueType = double,
131  typename pointValueType = double>
132  class Basis_HVOL_C0_FEM : public Basis<DeviceType,outputValueType,pointValueType> {
133  public:
134  using OrdinalTypeArray1DHost = typename Basis<DeviceType,outputValueType,pointValueType>::OrdinalTypeArray1DHost;
135  using OrdinalTypeArray2DHost = typename Basis<DeviceType,outputValueType,pointValueType>::OrdinalTypeArray2DHost;
136  using OrdinalTypeArray3DHost = typename Basis<DeviceType,outputValueType,pointValueType>::OrdinalTypeArray3DHost;
137 
140  Basis_HVOL_C0_FEM() = delete;
141 
144  Basis_HVOL_C0_FEM(const shards::CellTopology cellTopo);
145 
149 
151 
152  virtual
153  void
154  getValues( OutputViewType outputValues,
155  const PointViewType inputPoints,
156  const EOperator operatorType = OPERATOR_VALUE ) const override {
157 #ifdef HAVE_INTREPID2_DEBUG
158  // Verify arguments
159  Intrepid2::getValues_HGRAD_Args(outputValues,
160  inputPoints,
161  operatorType,
162  this->getBaseCellTopology(),
163  this->getCardinality() );
164 #endif
165  Impl::Basis_HVOL_C0_FEM::
166  getValues<DeviceType>( outputValues,
167  inputPoints,
168  operatorType );
169  }
170 
171  virtual
172  void
173  getDofCoords( ScalarViewType dofCoords ) const override {
174 #ifdef HAVE_INTREPID2_DEBUG
175  // Verify rank of output array.
176  INTREPID2_TEST_FOR_EXCEPTION( dofCoords.rank() != 2, std::invalid_argument,
177  ">>> ERROR: (Intrepid2::Basis_HVOL_C0_FEM::getDofCoords) rank = 2 required for dofCoords array");
178  // Verify 0th dimension of output array.
179  INTREPID2_TEST_FOR_EXCEPTION( static_cast<ordinal_type>(dofCoords.extent(0)) != this->getCardinality(), std::invalid_argument,
180  ">>> ERROR: (Intrepid2::Basis_HVOL_C0_FEM::getDofCoords) mismatch in number of dof and 0th dimension of dofCoords array");
181  // Verify 1st dimension of output array.
182  INTREPID2_TEST_FOR_EXCEPTION( dofCoords.extent(1) != this->getBaseCellTopology().getDimension(), std::invalid_argument,
183  ">>> ERROR: (Intrepid2::Basis_HVOL_C0_FEM::getDofCoords) incorrect reference cell (1st) dimension in dofCoords array");
184 #endif
185  Kokkos::deep_copy(dofCoords, this->dofCoords_);
186  }
187 
188  virtual
189  void
190  getDofCoeffs( ScalarViewType dofCoeffs ) const override {
191 #ifdef HAVE_INTREPID2_DEBUG
192  // Verify rank of output array.
193  INTREPID2_TEST_FOR_EXCEPTION( dofCoeffs.rank() != 1, std::invalid_argument,
194  ">>> ERROR: (Intrepid2::Basis_HVOL_C0_FEM::getdofCoeffs) rank = 1 required for dofCoeffs array");
195  // Verify 0th dimension of output array.
196  INTREPID2_TEST_FOR_EXCEPTION( static_cast<ordinal_type>(dofCoeffs.extent(0)) != this->getCardinality(), std::invalid_argument,
197  ">>> ERROR: (Intrepid2::Basis_HVOL_C0_FEM::getdofCoeffs) mismatch in number of dof and 0th dimension of dofCoeffs array");
198 #endif
199  Kokkos::deep_copy(dofCoeffs, 1.0);
200  }
201 
202  virtual
203  const char* getName() const override {
204  return "Intrepid2_HVOL_C0_FEM";
205  }
206 
208  getHostBasis() const override{
210  }
211  };
212 }
213 
215 
216 #endif
See Intrepid2::Basis_HVOL_C0_FEM.
An abstract base class that defines interface for concrete basis implementations for Finite Element (...
virtual const char * getName() const override
Returns basis name.
ordinal_type getCardinality() const
Returns cardinality of the basis.
BasisPtr< typename Kokkos::HostSpace::device_type, OutputType, PointType > HostBasisPtr
Pointer to a Basis whose device type is on the host (Kokkos::HostSpace::device_type), allowing host access to input and output views, and ensuring host execution of basis evaluation.
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...
Basis_HVOL_C0_FEM()=delete
Constructor.
Implementation of the default HVOL-compatible FEM contstant basis on triangle, quadrilateral, hexahedron and tetrahedron cells.
virtual HostBasisPtr< outputValueType, pointValueType > getHostBasis() const override
Creates and returns a Basis object whose DeviceType template argument is Kokkos::HostSpace::device_ty...
shards::CellTopology basisCellTopology_
Base topology of the cells for which the basis is defined. See the Shards package for definition of b...
Definition file FEM basis functions of degree 0 for H(vol) functions on all supported topologies...
shards::CellTopology getBaseCellTopology() const
Returns the base cell topology for which the basis is defined. See Shards documentation https://trili...
Kokkos::DynRankView< scalarType, DeviceType > dofCoords_
Coordinates of degrees-of-freedom for basis functions defined in physical space.
Header file for the Intrepid2::CellTools class.
Header file for the abstract base class Intrepid2::Basis.