ax_helm_compr_device.F90

Go to the documentation of this file.

! Copyright (c) 2026, The Neko Authors
! All rights reserved.
!
! Redistribution and use in source and binary forms, with or without
! modification, are permitted provided that the following conditions
! are met:
!
!   * Redistributions of source code must retain the above copyright
!     notice, this list of conditions and the following disclaimer.
!
!   * Redistributions in binary form must reproduce the above
!     copyright notice, this list of conditions and the following
!     disclaimer in the documentation and/or other materials provided
!     with the distribution.
!
!   * Neither the name of the authors nor the names of its
!     contributors may be used to endorse or promote products derived
!     from this software without specific prior written permission.
!
! THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
! "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
! LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
! FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
! COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
! INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
! BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
! LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
! CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
! LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
! ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
! POSSIBILITY OF SUCH DAMAGE.
!
module ax_helm_compr_device
  use ax_helm_device, only : ax_helm_device_t
  use num_types, only : rp
  use coefs, only : coef_t
  use space, only : space_t
  use mesh, only : mesh_t
  use device_math, only : device_addcol4
  use device, only : device_get_ptr
  use utils, only : neko_error
  use, intrinsic :: iso_c_binding, only : c_ptr, c_int
  implicit none
  private
 
  type, public, extends(ax_helm_device_t) :: ax_helm_compr_device_t
   contains
     procedure, pass(this) :: compute => ax_helm_compr_device_compute
     procedure, pass(this) :: compute_vector => &
          ax_helm_compr_device_compute_vector
  end type ax_helm_compr_device_t
 
#ifdef HAVE_HIP
  interface
     subroutine hip_ax_helm_compr(w_d, u_d, &
          dx_d, dy_d, dz_d, dxt_d, dyt_d, dzt_d, &
          h1_d, g11_d, g22_d, g33_d, g12_d, g13_d, g23_d, ind_d, nelv, lx) &
          bind(c, name='hip_ax_helm_compr')
       use, intrinsic :: iso_c_binding
       type(c_ptr), value :: w_d, u_d
       type(c_ptr), value :: dx_d, dy_d, dz_d
       type(c_ptr), value :: dxt_d, dyt_d, dzt_d
       type(c_ptr), value :: h1_d, g11_d, g22_d, g33_d, g12_d, g13_d, g23_d
       type(c_ptr), value :: ind_d
       integer(c_int) :: nelv, lx
     end subroutine hip_ax_helm_compr
  end interface
 
  interface
     subroutine hip_ax_helm_compr_vector(au_d, av_d, aw_d, u_d, v_d, w_d, &
          dx_d, dy_d, dz_d, dxt_d, dyt_d, dzt_d, &
          h1_d, g11_d, g22_d, g33_d, g12_d, g13_d, g23_d, ind_d, nelv, lx) &
          bind(c, name='hip_ax_helm_compr_vector')
       use, intrinsic :: iso_c_binding
       type(c_ptr), value :: au_d, av_d, aw_d
       type(c_ptr), value :: u_d, v_d, w_d
       type(c_ptr), value :: dx_d, dy_d, dz_d
       type(c_ptr), value :: dxt_d, dyt_d, dzt_d
       type(c_ptr), value :: h1_d, g11_d, g22_d, g33_d, g12_d, g13_d, g23_d
       type(c_ptr), value :: ind_d
       integer(c_int) :: nelv, lx
     end subroutine hip_ax_helm_compr_vector
  end interface
 
  interface
     subroutine hip_ax_helm_vector_part2(au_d, av_d, aw_d, u_d, v_d, w_d, &
          h2_d, B_d, n) bind(c, name='hip_ax_helm_vector_part2')
       use, intrinsic :: iso_c_binding
       type(c_ptr), value :: au_d, av_d, aw_d
       type(c_ptr), value :: u_d, v_d, w_d
       type(c_ptr), value :: h2_d, B_d
       integer(c_int) :: n
     end subroutine hip_ax_helm_vector_part2
  end interface
#elif HAVE_CUDA
  interface
     subroutine cuda_ax_helm_compr(w_d, u_d, &
          dx_d, dy_d, dz_d, dxt_d, dyt_d, dzt_d, &
          h1_d, g11_d, g22_d, g33_d, g12_d, g13_d, g23_d, ind_d, nelv, lx) &
          bind(c, name='cuda_ax_helm_compr')
       use, intrinsic :: iso_c_binding
       type(c_ptr), value :: w_d, u_d
       type(c_ptr), value :: dx_d, dy_d, dz_d
       type(c_ptr), value :: dxt_d, dyt_d, dzt_d
       type(c_ptr), value :: h1_d, g11_d, g22_d, g33_d, g12_d, g13_d, g23_d
       type(c_ptr), value :: ind_d
       integer(c_int) :: nelv, lx
     end subroutine cuda_ax_helm_compr
  end interface
 
  interface
     subroutine cuda_ax_helm_compr_vector(au_d, av_d, aw_d, u_d, v_d, w_d, &
          dx_d, dy_d, dz_d, dxt_d, dyt_d, dzt_d, &
          h1_d, g11_d, g22_d, g33_d, g12_d, g13_d, g23_d, ind_d, nelv, lx) &
          bind(c, name='cuda_ax_helm_compr_vector')
       use, intrinsic :: iso_c_binding
       type(c_ptr), value :: au_d, av_d, aw_d
       type(c_ptr), value :: u_d, v_d, w_d
       type(c_ptr), value :: dx_d, dy_d, dz_d
       type(c_ptr), value :: dxt_d, dyt_d, dzt_d
       type(c_ptr), value :: h1_d, g11_d, g22_d, g33_d, g12_d, g13_d, g23_d
       type(c_ptr), value :: ind_d
       integer(c_int) :: nelv, lx
     end subroutine cuda_ax_helm_compr_vector
  end interface
 
  interface
     subroutine cuda_ax_helm_vector_part2(au_d, av_d, aw_d, u_d, v_d, w_d, &
          h2_d, B_d, n) bind(c, name='cuda_ax_helm_vector_part2')
       use, intrinsic :: iso_c_binding
       type(c_ptr), value :: au_d, av_d, aw_d
       type(c_ptr), value :: u_d, v_d, w_d
       type(c_ptr), value :: h2_d, B_d
       integer(c_int) :: n
     end subroutine cuda_ax_helm_vector_part2
  end interface
#elif HAVE_OPENCL
  interface
     subroutine opencl_ax_helm_compr(w_d, u_d, &
          dx_d, dy_d, dz_d, dxt_d, dyt_d, dzt_d, &
          h1_d, g11_d, g22_d, g33_d, g12_d, g13_d, g23_d, ind_d, nelv, lx) &
          bind(c, name='opencl_ax_helm_compr')
       use, intrinsic :: iso_c_binding
       type(c_ptr), value :: w_d, u_d
       type(c_ptr), value :: dx_d, dy_d, dz_d
       type(c_ptr), value :: dxt_d, dyt_d, dzt_d
       type(c_ptr), value :: h1_d, g11_d, g22_d, g33_d, g12_d, g13_d, g23_d
       type(c_ptr), value :: ind_d
       integer(c_int) :: nelv, lx
     end subroutine opencl_ax_helm_compr
  end interface
 
  interface
     subroutine opencl_ax_helm_compr_vector(au_d, av_d, aw_d, u_d, v_d, w_d, &
          dx_d, dy_d, dz_d, dxt_d, dyt_d, dzt_d, &
          h1_d, g11_d, g22_d, g33_d, g12_d, g13_d, g23_d, ind_d, nelv, lx) &
          bind(c, name='opencl_ax_helm_compr_vector')
       use, intrinsic :: iso_c_binding
       type(c_ptr), value :: au_d, av_d, aw_d
       type(c_ptr), value :: u_d, v_d, w_d
       type(c_ptr), value :: dx_d, dy_d, dz_d
       type(c_ptr), value :: dxt_d, dyt_d, dzt_d
       type(c_ptr), value :: h1_d, g11_d, g22_d, g33_d, g12_d, g13_d, g23_d
       type(c_ptr), value :: ind_d
       integer(c_int) :: nelv, lx
     end subroutine opencl_ax_helm_compr_vector
  end interface
 
  interface
     subroutine opencl_ax_helm_vector_part2(au_d, av_d, aw_d, u_d, v_d, w_d, &
          h2_d, B_d, n) bind(c, name='opencl_ax_helm_vector_part2')
       use, intrinsic :: iso_c_binding
       type(c_ptr), value :: au_d, av_d, aw_d
       type(c_ptr), value :: u_d, v_d, w_d
       type(c_ptr), value :: h2_d, B_d
       integer(c_int) :: n
     end subroutine opencl_ax_helm_vector_part2
  end interface
#elif HAVE_METAL
  interface
     subroutine metal_ax_helm_compr(w_d, u_d, &
          dx_d, dy_d, dz_d, dxt_d, dyt_d, dzt_d, &
          h1_d, g11_d, g22_d, g33_d, g12_d, g13_d, g23_d, ind_d, nelv, lx) &
          bind(c, name='metal_ax_helm_compr')
       use, intrinsic :: iso_c_binding
       type(c_ptr), value :: w_d, u_d
       type(c_ptr), value :: dx_d, dy_d, dz_d
       type(c_ptr), value :: dxt_d, dyt_d, dzt_d
       type(c_ptr), value :: h1_d, g11_d, g22_d, g33_d, g12_d, g13_d, g23_d
       type(c_ptr), value :: ind_d
       integer(c_int) :: nelv, lx
     end subroutine metal_ax_helm_compr
  end interface
 
  interface
     subroutine metal_ax_helm_compr_vector(au_d, av_d, aw_d, u_d, v_d, w_d, &
          dx_d, dy_d, dz_d, dxt_d, dyt_d, dzt_d, &
          h1_d, g11_d, g22_d, g33_d, g12_d, g13_d, g23_d, ind_d, nelv, lx) &
          bind(c, name='metal_ax_helm_compr_vector')
       use, intrinsic :: iso_c_binding
       type(c_ptr), value :: au_d, av_d, aw_d
       type(c_ptr), value :: u_d, v_d, w_d
       type(c_ptr), value :: dx_d, dy_d, dz_d
       type(c_ptr), value :: dxt_d, dyt_d, dzt_d
       type(c_ptr), value :: h1_d, g11_d, g22_d, g33_d, g12_d, g13_d, g23_d
       type(c_ptr), value :: ind_d
       integer(c_int) :: nelv, lx
     end subroutine metal_ax_helm_compr_vector
  end interface
 
  interface
     subroutine metal_ax_helm_vector_part2(au_d, av_d, aw_d, u_d, v_d, w_d, &
          h2_d, B_d, n) bind(c, name='metal_ax_helm_vector_part2')
       use, intrinsic :: iso_c_binding
       type(c_ptr), value :: au_d, av_d, aw_d
       type(c_ptr), value :: u_d, v_d, w_d
       type(c_ptr), value :: h2_d, B_d
       integer(c_int) :: n
     end subroutine metal_ax_helm_vector_part2
  end interface
#endif
 
contains
 
  subroutine ax_helm_compr_device_compute(this, w, u, coef, msh, Xh)
    class(ax_helm_compr_device_t), intent(in) :: this
    type(mesh_t), intent(in) :: msh
    type(space_t), intent(in) :: Xh
    type(coef_t), intent(in) :: coef
    real(kind=rp), intent(inout) :: w(xh%lx, xh%ly, xh%lz, msh%nelv)
    real(kind=rp), intent(in) :: u(xh%lx, xh%ly, xh%lz, msh%nelv)
    type(c_ptr) :: u_d, w_d
 
    if (.not. allocated(coef%compression_inds)) then
       call this%ax_helm_device_t%compute(w, u, coef, msh, xh)
       return
    end if
 
    if (size(coef%compression_inds) .ne. msh%nelv) then
       call neko_error('Compressed geometric factors do not match the mesh')
    end if
 
    u_d = device_get_ptr(u)
    w_d = device_get_ptr(w)
 
#ifdef HAVE_HIP
    call hip_ax_helm_compr(w_d, u_d, xh%dx_d, xh%dy_d, xh%dz_d, &
         xh%dxt_d, xh%dyt_d, xh%dzt_d, coef%h1_d, &
         coef%G11_compr_d, coef%G22_compr_d, coef%G33_compr_d, &
         coef%G12_compr_d, coef%G13_compr_d, coef%G23_compr_d, &
         coef%compression_inds_d, msh%nelv, xh%lx)
#elif HAVE_CUDA
    call cuda_ax_helm_compr(w_d, u_d, xh%dx_d, xh%dy_d, xh%dz_d, &
         xh%dxt_d, xh%dyt_d, xh%dzt_d, coef%h1_d, &
         coef%G11_compr_d, coef%G22_compr_d, coef%G33_compr_d, &
         coef%G12_compr_d, coef%G13_compr_d, coef%G23_compr_d, &
         coef%compression_inds_d, msh%nelv, xh%lx)
#elif HAVE_OPENCL
    call opencl_ax_helm_compr(w_d, u_d, xh%dx_d, xh%dy_d, xh%dz_d, &
         xh%dxt_d, xh%dyt_d, xh%dzt_d, coef%h1_d, &
         coef%G11_compr_d, coef%G22_compr_d, coef%G33_compr_d, &
         coef%G12_compr_d, coef%G13_compr_d, coef%G23_compr_d, &
         coef%compression_inds_d, msh%nelv, xh%lx)
#elif HAVE_METAL
    call metal_ax_helm_compr(w_d, u_d, xh%dx_d, xh%dy_d, xh%dz_d, &
         xh%dxt_d, xh%dyt_d, xh%dzt_d, coef%h1_d, &
         coef%G11_compr_d, coef%G22_compr_d, coef%G33_compr_d, &
         coef%G12_compr_d, coef%G13_compr_d, coef%G23_compr_d, &
         coef%compression_inds_d, msh%nelv, xh%lx)
#endif
 
    if (coef%ifh2) then
       call device_addcol4(w_d, coef%h2_d, coef%B_d, u_d, coef%dof%size())
    end if
 
  end subroutine ax_helm_compr_device_compute
 
  subroutine ax_helm_compr_device_compute_vector(this, au, av, aw, &
       u, v, w, coef, msh, Xh)
    class(ax_helm_compr_device_t), intent(in) :: this
    type(space_t), intent(in) :: Xh
    type(mesh_t), intent(in) :: msh
    type(coef_t), intent(in) :: coef
    real(kind=rp), intent(inout) :: au(xh%lx, xh%ly, xh%lz, msh%nelv)
    real(kind=rp), intent(inout) :: av(xh%lx, xh%ly, xh%lz, msh%nelv)
    real(kind=rp), intent(inout) :: aw(xh%lx, xh%ly, xh%lz, msh%nelv)
    real(kind=rp), intent(in) :: u(xh%lx, xh%ly, xh%lz, msh%nelv)
    real(kind=rp), intent(in) :: v(xh%lx, xh%ly, xh%lz, msh%nelv)
    real(kind=rp), intent(in) :: w(xh%lx, xh%ly, xh%lz, msh%nelv)
    type(c_ptr) :: u_d, v_d, w_d
    type(c_ptr) :: au_d, av_d, aw_d
 
    if (.not. allocated(coef%compression_inds)) then
       call this%ax_helm_device_t%compute_vector(au, av, aw, u, v, w, &
            coef, msh, xh)
       return
    end if
 
    if (size(coef%compression_inds) .ne. msh%nelv) then
       call neko_error('Compressed geometric factors do not match the mesh')
    end if
 
    u_d = device_get_ptr(u)
    v_d = device_get_ptr(v)
    w_d = device_get_ptr(w)
 
    au_d = device_get_ptr(au)
    av_d = device_get_ptr(av)
    aw_d = device_get_ptr(aw)
 
#ifdef HAVE_HIP
    call hip_ax_helm_compr_vector(au_d, av_d, aw_d, u_d, v_d, w_d, &
         xh%dx_d, xh%dy_d, xh%dz_d, xh%dxt_d, xh%dyt_d, xh%dzt_d, coef%h1_d, &
         coef%G11_compr_d, coef%G22_compr_d, coef%G33_compr_d, &
         coef%G12_compr_d, coef%G13_compr_d, coef%G23_compr_d, &
         coef%compression_inds_d, msh%nelv, xh%lx)
#elif HAVE_CUDA
    call cuda_ax_helm_compr_vector(au_d, av_d, aw_d, u_d, v_d, w_d, &
         xh%dx_d, xh%dy_d, xh%dz_d, xh%dxt_d, xh%dyt_d, xh%dzt_d, coef%h1_d, &
         coef%G11_compr_d, coef%G22_compr_d, coef%G33_compr_d, &
         coef%G12_compr_d, coef%G13_compr_d, coef%G23_compr_d, &
         coef%compression_inds_d, msh%nelv, xh%lx)
#elif HAVE_OPENCL
    call opencl_ax_helm_compr_vector(au_d, av_d, aw_d, u_d, v_d, w_d, &
         xh%dx_d, xh%dy_d, xh%dz_d, xh%dxt_d, xh%dyt_d, xh%dzt_d, coef%h1_d, &
         coef%G11_compr_d, coef%G22_compr_d, coef%G33_compr_d, &
         coef%G12_compr_d, coef%G13_compr_d, coef%G23_compr_d, &
         coef%compression_inds_d, msh%nelv, xh%lx)
#elif HAVE_METAL
    call metal_ax_helm_compr_vector(au_d, av_d, aw_d, u_d, v_d, w_d, &
         xh%dx_d, xh%dy_d, xh%dz_d, xh%dxt_d, xh%dyt_d, xh%dzt_d, coef%h1_d, &
         coef%G11_compr_d, coef%G22_compr_d, coef%G33_compr_d, &
         coef%G12_compr_d, coef%G13_compr_d, coef%G23_compr_d, &
         coef%compression_inds_d, msh%nelv, xh%lx)
#endif
 
    if (coef%ifh2) then
#ifdef HAVE_HIP
       call hip_ax_helm_vector_part2(au_d, av_d, aw_d, u_d, v_d, w_d, &
            coef%h2_d, coef%B_d, coef%dof%size())
#elif HAVE_CUDA
       call cuda_ax_helm_vector_part2(au_d, av_d, aw_d, u_d, v_d, w_d, &
            coef%h2_d, coef%B_d, coef%dof%size())
#elif HAVE_OPENCL
       call opencl_ax_helm_vector_part2(au_d, av_d, aw_d, u_d, v_d, w_d, &
            coef%h2_d, coef%B_d, coef%dof%size())
#elif HAVE_METAL
       call metal_ax_helm_vector_part2(au_d, av_d, aw_d, u_d, v_d, w_d, &
            coef%h2_d, coef%B_d, coef%dof%size())
#endif
    end if
 
  end subroutine ax_helm_compr_device_compute_vector
 
end module ax_helm_compr_device