spalding_device.F90

Go to the documentation of this file.

! Copyright (c) 2025, 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 spalding_device
  use num_types, only : rp, c_rp
  use, intrinsic :: iso_c_binding, only : c_ptr
  use utils, only : neko_error
  implicit none
  private
 
#ifdef HAVE_HIP
  interface
     subroutine hip_spalding_compute(u_d, v_d, w_d, &
          n_x_d, n_y_d, n_z_d, nu_d, rho_w_d, h_d, &
          tau_x_d, tau_y_d, tau_z_d, n_nodes, &
          kappa, B, tstep) &
          bind(c, name = 'hip_spalding_compute')
       use, intrinsic :: iso_c_binding, only : c_ptr, c_int
       use num_types, only : c_rp
       implicit none
       type(c_ptr), value :: u_d, v_d, w_d, rho_w_d
       type(c_ptr), value :: n_x_d, n_y_d, n_z_d, h_d, nu_d
       real(c_rp) :: kappa, B
       type(c_ptr), value :: tau_x_d, tau_y_d, tau_z_d
       integer(c_int) :: n_nodes, tstep
     end subroutine hip_spalding_compute
  end interface
#elif HAVE_CUDA
  interface
     subroutine cuda_spalding_compute(u_d, v_d, w_d, &
          n_x_d, n_y_d, n_z_d, nu_d, rho_w_d, h_d, &
          tau_x_d, tau_y_d, tau_z_d, n_nodes, &
          kappa, B, tstep) &
          bind(c, name = 'cuda_spalding_compute')
       use, intrinsic :: iso_c_binding, only : c_ptr, c_int
       use num_types, only : c_rp
       implicit none
       type(c_ptr), value :: u_d, v_d, w_d, rho_w_d
       type(c_ptr), value :: n_x_d, n_y_d, n_z_d, h_d, nu_d
       real(c_rp) :: kappa, B
       type(c_ptr), value :: tau_x_d, tau_y_d, tau_z_d
       integer(c_int) :: n_nodes, tstep
     end subroutine cuda_spalding_compute
  end interface
#elif HAVE_OPENCL
  interface
     subroutine opencl_spalding_compute(u_d, v_d, w_d, &
          n_x_d, n_y_d, n_z_d, nu_d, rho_w_d, h_d, &
          tau_x_d, tau_y_d, tau_z_d, n_nodes, &
          kappa, B, tstep) &
          bind(c, name = 'opencl_spalding_compute')
       use, intrinsic :: iso_c_binding, only : c_ptr, c_int
       use num_types, only : c_rp
       implicit none
       type(c_ptr), value :: u_d, v_d, w_d, rho_w_d
       type(c_ptr), value :: n_x_d, n_y_d, n_z_d, h_d, nu_d
       real(c_rp) :: kappa, B
       type(c_ptr), value :: tau_x_d, tau_y_d, tau_z_d
       integer(c_int) :: n_nodes, tstep
     end subroutine opencl_spalding_compute
  end interface
#elif HAVE_METAL
  interface
     subroutine metal_spalding_compute(u_d, v_d, w_d, &
          n_x_d, n_y_d, n_z_d, nu_d, rho_w_d, h_d, &
          tau_x_d, tau_y_d, tau_z_d, n_nodes, &
          kappa, B, tstep) &
          bind(c, name = 'metal_spalding_compute')
       use, intrinsic :: iso_c_binding, only : c_ptr, c_int
       use num_types, only : c_rp
       implicit none
       type(c_ptr), value :: u_d, v_d, w_d, rho_w_d
       type(c_ptr), value :: n_x_d, n_y_d, n_z_d, h_d, nu_d
       real(c_rp) :: kappa, B
       type(c_ptr), value :: tau_x_d, tau_y_d, tau_z_d
       integer(c_int) :: n_nodes, tstep
     end subroutine metal_spalding_compute
  end interface
#endif
  public :: spalding_compute_device
 
contains
  subroutine spalding_compute_device(u_d, v_d, w_d, &
       n_x_d, n_y_d, n_z_d, nu_d, rho_w_d, h_d, tau_x_d, tau_y_d, tau_z_d, &
       n_nodes, kappa, B, tstep)
    integer, intent(in) :: n_nodes, tstep
    type(c_ptr), intent(in) :: u_d, v_d, w_d, rho_w_d
    type(c_ptr), intent(in) :: n_x_d, n_y_d, n_z_d, h_d, nu_d
    type(c_ptr), intent(inout) :: tau_x_d, tau_y_d, tau_z_d
    real(kind=rp), intent(in) :: kappa, b
 
#if HAVE_HIP
    call hip_spalding_compute(u_d, v_d, w_d, &
         n_x_d, n_y_d, n_z_d, nu_d, rho_w_d, h_d, &
         tau_x_d, tau_y_d, tau_z_d, n_nodes, kappa, b, tstep)
#elif HAVE_CUDA
    call cuda_spalding_compute(u_d, v_d, w_d, &
         n_x_d, n_y_d, n_z_d, nu_d, rho_w_d, h_d, &
         tau_x_d, tau_y_d, tau_z_d, n_nodes, kappa, b, tstep)
#elif HAVE_OPENCL
    call opencl_spalding_compute(u_d, v_d, w_d, &
         n_x_d, n_y_d, n_z_d, nu_d, rho_w_d, h_d, &
         tau_x_d, tau_y_d, tau_z_d, n_nodes, kappa, b, tstep)
#elif HAVE_METAL
    call metal_spalding_compute(u_d, v_d, w_d, &
         n_x_d, n_y_d, n_z_d, nu_d, rho_w_d, h_d, &
         tau_x_d, tau_y_d, tau_z_d, n_nodes, kappa, b, tstep)
#else
    call neko_error('No device backend configured')
#endif
 
  end subroutine spalding_compute_device
end module spalding_device