device_deardorff_nut.F90

Go to the documentation of this file.

! Copyright (c) 2025-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 device_deardorff_nut
  use, intrinsic :: iso_c_binding, only: c_ptr, c_int
  use num_types, only: rp, c_rp
  use utils, only: neko_error
  use comm, only: neko_comm, pe_size, mpi_real_precision
  use mpi_f08, only: mpi_sum, mpi_in_place, mpi_allreduce
 
  implicit none
  private
 
#ifdef HAVE_HIP
  interface
     subroutine hip_deardorff_nut_compute(TKE_d, &
          dTdx_d, dTdy_d, dTdz_d, &
          a11_d, a12_d, a13_d, &
          a21_d, a22_d, a23_d, &
          a31_d, a32_d, a33_d, &
          delta_d, nut_d, temperature_alphat, TKE_alphat, TKE_source, &
          c_k, T0, g1, g2, g3, &
          eps, n) bind(C,name="hip_deardorff_nut_compute")
       use, intrinsic :: iso_c_binding, only: c_ptr, c_int
       import c_rp
       type(c_ptr), value :: TKE_d, &
            dTdx_d, dTdy_d, dTdz_d, &
            a11_d, a12_d, a13_d, &
            a21_d, a22_d, a23_d, &
            a31_d, a32_d, a33_d, &
            delta_d, nut_d, temperature_alphat, &
            TKE_alphat, TKE_source
       integer(c_int) :: n
       real(c_rp) :: c_k, T0, g1, g2, g3, eps
     end subroutine hip_deardorff_nut_compute
  end interface
#elif HAVE_CUDA
  interface
     subroutine cuda_deardorff_nut_compute(TKE_d, &
          dTdx_d, dTdy_d, dTdz_d, &
          a11_d, a12_d, a13_d, &
          a21_d, a22_d, a23_d, &
          a31_d, a32_d, a33_d, &
          delta_d, nut_d, temperature_alphat, TKE_alphat, TKE_source, &
          c_k, T0, g1, g2, g3, &
          eps, n) &
          bind(c, name = 'cuda_deardorff_nut_compute')
       use, intrinsic :: iso_c_binding, only: c_ptr, c_int
       import c_rp
       type(c_ptr), value :: TKE_d, &
            dTdx_d, dTdy_d, dTdz_d, &
            a11_d, a12_d, a13_d, &
            a21_d, a22_d, a23_d, &
            a31_d, a32_d, a33_d, &
            delta_d, nut_d, temperature_alphat, &
            TKE_alphat, TKE_source
       integer(c_int) :: n
       real(c_rp) :: c_k, T0, g1, g2, g3, eps
     end subroutine cuda_deardorff_nut_compute
  end interface
#elif HAVE_OPENCL
#endif
 
  public :: device_deardorff_nut_compute
 
contains
 
  subroutine device_deardorff_nut_compute(TKE_d, &
       dTdx_d, dTdy_d, dTdz_d, a11_d, a12_d, a13_d, &
       a21_d, a22_d, a23_d, &
       a31_d, a32_d, a33_d, &
       delta_d, &
       nut_d, temperature_alphat, TKE_alphat, TKE_source, &
       c_k, T0, g, eps, n)
    type(c_ptr) :: tke_d, dtdx_d, dtdy_d, dtdz_d, &
         a11_d, a12_d, a13_d, &
         a21_d, a22_d, a23_d, &
         a31_d, a32_d, a33_d, &
         delta_d, nut_d, temperature_alphat, tke_alphat, tke_source
    integer :: n
    real(kind=rp) :: c_k, t0, g(3), eps
#if HAVE_HIP
    call hip_deardorff_nut_compute(tke_d, &
         dtdx_d, dtdy_d, dtdz_d, &
         a11_d, a12_d, a13_d, &
         a21_d, a22_d, a23_d, &
         a31_d, a32_d, a33_d, &
         delta_d, nut_d, temperature_alphat, tke_alphat, tke_source, &
         c_k, t0, g(1), g(2), g(3), eps, n)
#elif HAVE_CUDA
    call cuda_deardorff_nut_compute(tke_d, &
         dtdx_d, dtdy_d, dtdz_d, &
         a11_d, a12_d, a13_d, &
         a21_d, a22_d, a23_d, &
         a31_d, a32_d, a33_d, &
         delta_d, nut_d, temperature_alphat, tke_alphat, tke_source, &
         c_k, t0, g(1), g(2), g(3), eps, n)
#elif HAVE_OPENCL
    call neko_error('opencl backend is not supported for device_deardorff_nut')
#else
    call neko_error('no device backend configured')
#endif
  end subroutine device_deardorff_nut_compute
 
 
end module device_deardorff_nut