Implement getHostBasis() in newer Basis subclasses (#8811)

Intrepid2: added getHostBasis() implementations for several Basis subclasses, along with support for DeviceType template arguments in the same. Specifically, the following classes now support getHostBasis and DeviceType template arguments: - DerivedBasis_HCURL_HEX - DerivedBasis_HCURL_QUAD - DerivedBasis_HDIV_HEX - DerivedBasis_HDIV_QUAD - DerivedBasis_HGRAD_HEX - DerivedBasis_HGRAD_QUAD - DerivedBasis_HVOL_HEX - DerivedBasis_HVOL_QUAD - HGRAD_LINE_Cn_FEM - HVOL_LINE_Cn_FEM - IntegratedLegendreBasis_HGRAD_LINE - LegendreBasis_HVOL_LINE Other changes: - added typedef Intrepid2::DefaultTestDeviceType to TestUtils; this is UVM-free on CUDA, and Kokkos::DefaultExecutionSpace::device_type otherwise. - Made use of DefaultTestDeviceType as well as getHostBasis in the BasisValues test group (in MonolithicExecutable) - revised template arguments of Basis_DirectSumBasis, Basis_TensorBasis, andBasis_TensorBasis3; these now depend only on the base Basis class - added typedef for BasisBase in several Basis subclasses - added typedef for HostBasis in several Basis subclasses (specifically, those defined on the line which are used in DerivedBasis instantiations) The modified tests within MonolithicExecutable exercise getHostBasis() on all modified bases. These also test the modified bases with the UVM-free DeviceType when run under CUDA.
trilinos · Mar 1, 2021 · 4002c6b · 4002c6b
1 parent 817210a
commit 4002c6b
Show file tree

Hide file tree

Showing 23 changed files with 596 additions and 273 deletions.
diff --git a/packages/intrepid2/src/Discretization/Basis/Intrepid2_Basis.hpp b/packages/intrepid2/src/Discretization/Basis/Intrepid2_Basis.hpp
@@ -75,6 +75,11 @@ class Basis;
 template <typename DeviceType = void, typename OutputType = double, typename PointType = double>
 using BasisPtr = Teuchos::RCP<Basis<DeviceType,OutputType,PointType> >;
 
+/** \brief 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.
+ */
+template <typename OutputType = double, typename PointType = double>
+using HostBasisPtr = BasisPtr<typename Kokkos::HostSpace::device_type, OutputType, PointType>;
+
   /** \class  Intrepid2::Basis
       \brief  An abstract base class that defines interface for concrete basis implementations for
               Finite Element (FEM) and Finite Volume/Finite Difference (FVD) discrete spaces.
@@ -898,11 +903,11 @@ using BasisPtr = Teuchos::RCP<Basis<DeviceType,OutputType,PointType> >;
                                     ">>> ERROR (Basis::getSubCellRefBasis): this method is not supported or should be overridden accordingly by derived classes.");
     }
 
-    /** \brief creates and returns a basis object allocated on host.
-     
-        \return pointer to a basis allocated on host.
-     */
-    virtual BasisPtr<typename Kokkos::HostSpace::device_type, OutputValueType, PointValueType>
+    /** \brief Creates and returns a Basis object whose DeviceType template argument is Kokkos::HostSpace::device_type, but is otherwise identical to this.
+    
+       \return Pointer to the new Basis object.
+    */
+    virtual HostBasisPtr<OutputValueType, PointValueType>
     getHostBasis() const {
       INTREPID2_TEST_FOR_EXCEPTION( true, std::logic_error,
                                     ">>> ERROR (Basis::getHostBasis): this method is not supported or should be overridden accordingly by derived classes.");

diff --git a/packages/intrepid2/src/Discretization/Basis/Intrepid2_DerivedBasisFamily.hpp b/packages/intrepid2/src/Discretization/Basis/Intrepid2_DerivedBasisFamily.hpp
@@ -86,7 +86,7 @@ namespace Intrepid2
     using OutputValueType = typename LineBasisHGRAD::OutputValueType;
     using PointValueType  = typename LineBasisHGRAD::PointValueType;
 
-    using Basis    = ::Intrepid2::Basis<ExecutionSpace,OutputValueType,PointValueType>;
+    using Basis    = typename LineBasisHGRAD::BasisBase;
     using BasisPtr = Teuchos::RCP<Basis>;
 
     // line bases

diff --git a/packages/intrepid2/src/Discretization/Basis/Intrepid2_DerivedBasis_HCURL_HEX.hpp b/packages/intrepid2/src/Discretization/Basis/Intrepid2_DerivedBasis_HCURL_HEX.hpp
@@ -67,9 +67,7 @@ namespace Intrepid2
 {
   template<class HGRAD_LINE, class HVOL_LINE>
   class Basis_Derived_HCURL_Family1_HEX
-  : public Basis_TensorBasis3<HVOL_LINE,
-                              HGRAD_LINE,
-                              HGRAD_LINE>
+  : public Basis_TensorBasis3<typename HGRAD_LINE::BasisBase>
   {
   public:
     using OutputViewType = typename HGRAD_LINE::OutputViewType;
@@ -79,7 +77,7 @@ namespace Intrepid2
     using LineGradBasis = HGRAD_LINE;
     using LineVolBasis  = HVOL_LINE;
 
-    using TensorBasis3 = Basis_TensorBasis3<LineVolBasis, LineGradBasis, LineGradBasis>;
+    using TensorBasis3 = Basis_TensorBasis3<typename HGRAD_LINE::BasisBase>;
   public:
     /** \brief  Constructor.
         \param [in] polyOrder_x - the polynomial order in the x dimension.
@@ -224,9 +222,7 @@ namespace Intrepid2
 
   template<class HGRAD_LINE, class HVOL_LINE>
   class Basis_Derived_HCURL_Family2_HEX
-  : public Basis_TensorBasis3<HGRAD_LINE,
-                              HVOL_LINE,
-                              HGRAD_LINE>
+  : public Basis_TensorBasis3<typename HGRAD_LINE::BasisBase>
   {
   public:
     using OutputViewType = typename HGRAD_LINE::OutputViewType;
@@ -236,7 +232,7 @@ namespace Intrepid2
     using LineGradBasis = HGRAD_LINE;
     using LineVolBasis  = HVOL_LINE;
 
-    using TensorBasis3 = Basis_TensorBasis3<LineGradBasis, LineVolBasis, LineGradBasis>;
+    using TensorBasis3 = Basis_TensorBasis3<typename HGRAD_LINE::BasisBase>;
   public:
     /** \brief  Constructor.
         \param [in] polyOrder_x - the polynomial order in the x dimension.
@@ -388,9 +384,7 @@ namespace Intrepid2
 
   template<class HGRAD_LINE, class HVOL_LINE>
   class Basis_Derived_HCURL_Family3_HEX
-  : public Basis_TensorBasis3<HGRAD_LINE,
-                              HGRAD_LINE,
-                              HVOL_LINE>
+  : public Basis_TensorBasis3<typename HGRAD_LINE::BasisBase>
   {
     using OutputViewType = typename HGRAD_LINE::OutputViewType;
     using PointViewType  = typename HGRAD_LINE::PointViewType ;
@@ -399,7 +393,7 @@ namespace Intrepid2
     using LineGradBasis = HGRAD_LINE;
     using LineVolBasis  = HVOL_LINE;
 
-    using TensorBasis3 = Basis_TensorBasis3<LineGradBasis, LineGradBasis, LineVolBasis>;
+    using TensorBasis3 = Basis_TensorBasis3<typename HGRAD_LINE::BasisBase>;
   public:
     /** \brief  Constructor.
         \param [in] polyOrder_x - the polynomial order in the x dimension.
@@ -540,11 +534,11 @@ namespace Intrepid2
 
   template<class HGRAD_LINE, class HVOL_LINE>
   class Basis_Derived_HCURL_Family1_Family2_HEX
-  : public Basis_DirectSumBasis <typename HGRAD_LINE::ExecutionSpace, typename HGRAD_LINE::OutputValueType, typename HGRAD_LINE::PointValueType>
+  : public Basis_DirectSumBasis <typename HGRAD_LINE::BasisBase>
   {
     using Family1 = Basis_Derived_HCURL_Family1_HEX<HGRAD_LINE, HVOL_LINE>;
     using Family2 = Basis_Derived_HCURL_Family2_HEX<HGRAD_LINE, HVOL_LINE>;
-    using DirectSumBasis = Basis_DirectSumBasis  <typename HGRAD_LINE::ExecutionSpace, typename HGRAD_LINE::OutputValueType, typename HGRAD_LINE::PointValueType>;
+    using DirectSumBasis = Basis_DirectSumBasis  <typename HGRAD_LINE::BasisBase>;
   public:
     /** \brief  Constructor.
         \param [in] polyOrder_x - the polynomial order in the x dimension.
@@ -560,11 +554,11 @@ namespace Intrepid2
 
   template<class HGRAD_LINE, class HVOL_LINE>
   class Basis_Derived_HCURL_HEX
-  : public Basis_DirectSumBasis <typename HGRAD_LINE::ExecutionSpace, typename HGRAD_LINE::OutputValueType, typename HGRAD_LINE::PointValueType>
+  : public Basis_DirectSumBasis <typename HGRAD_LINE::BasisBase>
   {
     using Family12 = Basis_Derived_HCURL_Family1_Family2_HEX<HGRAD_LINE, HVOL_LINE>;
     using Family3  = Basis_Derived_HCURL_Family3_HEX        <HGRAD_LINE, HVOL_LINE>;
-    using DirectSumBasis = Basis_DirectSumBasis <typename HGRAD_LINE::ExecutionSpace, typename HGRAD_LINE::OutputValueType, typename HGRAD_LINE::PointValueType>;
+    using DirectSumBasis = Basis_DirectSumBasis <typename HGRAD_LINE::BasisBase>;
 
     std::string name_;
     ordinal_type order_x_;
@@ -577,6 +571,8 @@ namespace Intrepid2
     using ExecutionSpace  = typename HGRAD_LINE::ExecutionSpace;
     using OutputValueType = typename HGRAD_LINE::OutputValueType;
     using PointValueType  = typename HGRAD_LINE::PointValueType;
+
+    using BasisBase = typename HGRAD_LINE::BasisBase;
 
     /** \brief  Constructor.
         \param [in] polyOrder_x - the polynomial order in the x dimension.
@@ -631,7 +627,7 @@ namespace Intrepid2
         \param [in] subCellOrd - position of the subCell among of the subCells having the same dimension
         \return pointer to the subCell basis of dimension subCellDim and position subCellOrd
      */
-    BasisPtr<ExecutionSpace, OutputValueType, PointValueType>
+    Teuchos::RCP<BasisBase>
       getSubCellRefBasis(const ordinal_type subCellDim, const ordinal_type subCellOrd) const override{
 
       using LineBasis = HVOL_LINE;
@@ -674,7 +670,18 @@ namespace Intrepid2
 
       INTREPID2_TEST_FOR_EXCEPTION(true,std::invalid_argument,"Input parameters out of bounds");
     }
-
+    /** \brief Creates and returns a Basis object whose DeviceType template argument is Kokkos::HostSpace::device_type, but is otherwise identical to this.
+     
+        \return Pointer to the new Basis object.
+     */
+    virtual HostBasisPtr<OutputValueType, PointValueType>
+    getHostBasis() const override {
+      using HostBasis  = Basis_Derived_HCURL_HEX<typename HGRAD_LINE::HostBasis, typename HVOL_LINE::HostBasis>;
+
+      auto hostBasis = Teuchos::rcp(new HostBasis(order_x_, order_y_, order_z_, pointType_));
+
+      return hostBasis;
+    }
   };
 } // end namespace Intrepid2
 

diff --git a/packages/intrepid2/src/Discretization/Basis/Intrepid2_DerivedBasis_HCURL_QUAD.hpp b/packages/intrepid2/src/Discretization/Basis/Intrepid2_DerivedBasis_HCURL_QUAD.hpp
@@ -66,7 +66,7 @@ namespace Intrepid2
 {
   template<class HGRAD_LINE, class HVOL_LINE>
   class Basis_Derived_HCURL_Family1_QUAD
-  : public Basis_TensorBasis<typename HGRAD_LINE::ExecutionSpace, typename HGRAD_LINE::OutputValueType, typename HGRAD_LINE::PointValueType>
+  : public Basis_TensorBasis<typename HGRAD_LINE::BasisBase>
   {
   public:
     using ExecutionSpace  = typename HGRAD_LINE::ExecutionSpace;
@@ -77,10 +77,12 @@ namespace Intrepid2
     using PointViewType  = typename HGRAD_LINE::PointViewType ;
     using ScalarViewType = typename HGRAD_LINE::ScalarViewType;
 
+    using BasisBase = typename HGRAD_LINE::BasisBase;
+
     using LineGradBasis = HGRAD_LINE;
     using LineHVolBasis = HVOL_LINE;
 
-    using TensorBasis = Basis_TensorBasis<ExecutionSpace, OutputValueType, PointValueType>;
+    using TensorBasis = Basis_TensorBasis<BasisBase>;
   public:
     /** \brief  Constructor.
         \param [in] polyOrder_x - the polynomial order in the x dimension.
@@ -191,7 +193,7 @@ namespace Intrepid2
 
   template<class HGRAD_LINE, class HVOL_LINE>
   class Basis_Derived_HCURL_Family2_QUAD
-  : public Basis_TensorBasis<typename HGRAD_LINE::ExecutionSpace, typename HGRAD_LINE::OutputValueType, typename HGRAD_LINE::PointValueType>
+  : public Basis_TensorBasis<typename HGRAD_LINE::BasisBase>
   {
 
   public:
@@ -206,7 +208,9 @@ namespace Intrepid2
     using LineGradBasis = HGRAD_LINE;
     using LineHVolBasis = HVOL_LINE;
 
-    using TensorBasis = Basis_TensorBasis<ExecutionSpace, OutputValueType, PointValueType>;
+    using BasisBase = typename HGRAD_LINE::BasisBase;
+
+    using TensorBasis = Basis_TensorBasis<BasisBase>;
 
     /** \brief  Constructor.
         \param [in] polyOrder_x - the polynomial order in the x dimension.
@@ -317,11 +321,13 @@ namespace Intrepid2
 
   template<class HGRAD_LINE, class HVOL_LINE>
   class Basis_Derived_HCURL_QUAD
-  : public Basis_DirectSumBasis <typename HGRAD_LINE::ExecutionSpace, typename HGRAD_LINE::OutputValueType, typename HGRAD_LINE::PointValueType>
+  : public Basis_DirectSumBasis <typename HGRAD_LINE::BasisBase>
   {
     using Family1 = Basis_Derived_HCURL_Family1_QUAD<HGRAD_LINE, HVOL_LINE>;
     using Family2 = Basis_Derived_HCURL_Family2_QUAD<HGRAD_LINE, HVOL_LINE>;
-    using DirectSumBasis = Basis_DirectSumBasis <typename HGRAD_LINE::ExecutionSpace, typename HGRAD_LINE::OutputValueType, typename HGRAD_LINE::PointValueType>;
+    using DirectSumBasis = Basis_DirectSumBasis <typename HGRAD_LINE::BasisBase>;
+
+    using BasisBase = typename HGRAD_LINE::BasisBase;
 
   protected:
     std::string name_;
@@ -388,7 +394,7 @@ namespace Intrepid2
         \param [in] subCellOrd - position of the subCell among of the subCells having the same dimension
         \return pointer to the subCell basis of dimension subCellDim and position subCellOrd
      */
-    BasisPtr<ExecutionSpace, OutputValueType, PointValueType>
+    Teuchos::RCP<BasisBase>
       getSubCellRefBasis(const ordinal_type subCellDim, const ordinal_type subCellOrd) const override{
       if(subCellDim == 1) {
         switch(subCellOrd) {
@@ -404,6 +410,18 @@ namespace Intrepid2
       INTREPID2_TEST_FOR_EXCEPTION(true,std::invalid_argument,"Input parameters out of bounds");
     }
 
+    /** \brief Creates and returns a Basis object whose DeviceType template argument is Kokkos::HostSpace::device_type, but is otherwise identical to this.
+     
+        \return Pointer to the new Basis object.
+     */
+    virtual HostBasisPtr<OutputValueType, PointValueType>
+    getHostBasis() const override {
+      using HostBasis  = Basis_Derived_HCURL_QUAD<typename HGRAD_LINE::HostBasis, typename HVOL_LINE::HostBasis>;
+
+      auto hostBasis = Teuchos::rcp(new HostBasis(order_x_, order_y_, pointType_));
+
+      return hostBasis;
+    }
   };
 } // end namespace Intrepid2
 

diff --git a/packages/intrepid2/src/Discretization/Basis/Intrepid2_DerivedBasis_HDIV_HEX.hpp b/packages/intrepid2/src/Discretization/Basis/Intrepid2_DerivedBasis_HDIV_HEX.hpp
@@ -71,7 +71,7 @@ namespace Intrepid2
   template<class HGRAD_LINE, class HVOL_LINE>
   class Basis_Derived_HDIV_Family1_HEX
   :
-  public Basis_TensorBasis3<HGRAD_LINE, HVOL_LINE, HVOL_LINE>
+  public Basis_TensorBasis3<typename HGRAD_LINE::BasisBase>
   {
   public:
     using OutputViewType = typename HGRAD_LINE::OutputViewType;
@@ -81,7 +81,7 @@ namespace Intrepid2
     using LineGradBasis = HGRAD_LINE;
     using LineHVolBasis = HVOL_LINE;
 
-    using TensorBasis3 = Basis_TensorBasis3<LineGradBasis, LineHVolBasis, LineHVolBasis>;
+    using TensorBasis3 = Basis_TensorBasis3<typename HGRAD_LINE::BasisBase>;
   public:
     /** \brief  Constructor.
         \param [in] polyOrder_x - the polynomial order in the x dimension.
@@ -205,7 +205,7 @@ namespace Intrepid2
   template<class HGRAD_LINE, class HVOL_LINE>
   class Basis_Derived_HDIV_Family2_HEX
   :
-  public Basis_TensorBasis3<HVOL_LINE, HGRAD_LINE, HVOL_LINE>
+  public Basis_TensorBasis3<typename HGRAD_LINE::BasisBase>
   {
   public:
     using OutputViewType = typename HGRAD_LINE::OutputViewType;
@@ -215,7 +215,7 @@ namespace Intrepid2
     using LineGradBasis = HGRAD_LINE;
     using LineHVolBasis = HVOL_LINE;
 
-    using TensorBasis3 = Basis_TensorBasis3<LineHVolBasis, LineGradBasis, LineHVolBasis>;
+    using TensorBasis3 = Basis_TensorBasis3<typename HGRAD_LINE::BasisBase>;
   public:
     /** \brief  Constructor.
         \param [in] polyOrder_x - the polynomial order in the x dimension.
@@ -344,7 +344,7 @@ namespace Intrepid2
 
   template<class HGRAD_LINE, class HVOL_LINE>
   class Basis_Derived_HDIV_Family3_HEX
-  : public Basis_TensorBasis3<HVOL_LINE, HVOL_LINE, HGRAD_LINE>
+  : public Basis_TensorBasis3<typename HGRAD_LINE::BasisBase>
   {
   public:
     using OutputViewType = typename HGRAD_LINE::OutputViewType;
@@ -354,7 +354,7 @@ namespace Intrepid2
     using LineGradBasis = HGRAD_LINE;
     using LineHVolBasis = HVOL_LINE;
 
-    using TensorBasis3 = Basis_TensorBasis3<LineHVolBasis, LineHVolBasis, LineGradBasis>;
+    using TensorBasis3 = Basis_TensorBasis3<typename HGRAD_LINE::BasisBase>;
   public:
     /** \brief  Constructor.
         \param [in] polyOrder_x - the polynomial order in the x dimension.
@@ -483,11 +483,11 @@ namespace Intrepid2
   // which is to say that we go 3,1,2.
   template<class HGRAD_LINE, class HVOL_LINE>
   class Basis_Derived_HDIV_Family3_Family1_HEX
-  : public Basis_DirectSumBasis <typename HGRAD_LINE::ExecutionSpace, typename HGRAD_LINE::OutputValueType, typename HGRAD_LINE::PointValueType>
+  : public Basis_DirectSumBasis <typename HGRAD_LINE::BasisBase>
   {
     using Family3 = Basis_Derived_HDIV_Family3_HEX<HGRAD_LINE, HVOL_LINE>;
     using Family1 = Basis_Derived_HDIV_Family1_HEX<HGRAD_LINE, HVOL_LINE>;
-    using DirectSumBasis = Basis_DirectSumBasis<typename HGRAD_LINE::ExecutionSpace, typename HGRAD_LINE::OutputValueType, typename HGRAD_LINE::PointValueType>;
+    using DirectSumBasis = Basis_DirectSumBasis<typename HGRAD_LINE::BasisBase>;
   public:
     /** \brief  Constructor.
         \param [in] polyOrder_x - the polynomial order in the x dimension.
@@ -505,11 +505,11 @@ namespace Intrepid2
 
   template<class HGRAD_LINE, class HVOL_LINE>
   class Basis_Derived_HDIV_HEX
-  : public Basis_DirectSumBasis <typename HGRAD_LINE::ExecutionSpace, typename HGRAD_LINE::OutputValueType, typename HGRAD_LINE::PointValueType>
+  : public Basis_DirectSumBasis <typename HGRAD_LINE::BasisBase>
   {
     using Family31 = Basis_Derived_HDIV_Family3_Family1_HEX<HGRAD_LINE, HVOL_LINE>;
     using Family2  = Basis_Derived_HDIV_Family2_HEX        <HGRAD_LINE, HVOL_LINE>;
-    using DirectSumBasis = Basis_DirectSumBasis<typename HGRAD_LINE::ExecutionSpace, typename HGRAD_LINE::OutputValueType, typename HGRAD_LINE::PointValueType>;
+    using DirectSumBasis = Basis_DirectSumBasis<typename HGRAD_LINE::BasisBase>;
 
     std::string name_;
     ordinal_type order_x_;
@@ -521,6 +521,8 @@ namespace Intrepid2
     using ExecutionSpace  = typename HGRAD_LINE::ExecutionSpace;
     using OutputValueType = typename HGRAD_LINE::OutputValueType;
     using PointValueType  = typename HGRAD_LINE::PointValueType;
+
+    using BasisBase = typename HGRAD_LINE::BasisBase;
 
     /** \brief  Constructor.
         \param [in] polyOrder_x - the polynomial order in the x dimension.
@@ -575,8 +577,8 @@ namespace Intrepid2
         \param [in] subCellOrd - position of the subCell among of the subCells having the same dimension
         \return pointer to the subCell basis of dimension subCellDim and position subCellOrd
      */
-    BasisPtr<ExecutionSpace, OutputValueType, PointValueType>
-      getSubCellRefBasis(const ordinal_type subCellDim, const ordinal_type subCellOrd) const override{
+    Teuchos::RCP<BasisBase>
+      getSubCellRefBasis(const ordinal_type subCellDim, const ordinal_type subCellOrd) const override {
 
       using QuadBasis = Basis_Derived_HVOL_QUAD<HVOL_LINE>;
 
@@ -599,7 +601,19 @@ namespace Intrepid2
 
       INTREPID2_TEST_FOR_EXCEPTION(true,std::invalid_argument,"Input parameters out of bounds");
     }
-
+
+    /** \brief Creates and returns a Basis object whose DeviceType template argument is Kokkos::HostSpace::device_type, but is otherwise identical to this.
+     
+        \return Pointer to the new Basis object.
+     */
+    virtual HostBasisPtr<OutputValueType, PointValueType>
+    getHostBasis() const override {
+      using HostBasis  = Basis_Derived_HDIV_HEX<typename HGRAD_LINE::HostBasis, typename HVOL_LINE::HostBasis>;
+
+      auto hostBasis = Teuchos::rcp(new HostBasis(order_x_, order_y_, order_z_, pointType_));
+
+      return hostBasis;
+    }
   };
 } // end namespace Intrepid2