device_neumann.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 device_neumann
  use utils, only : neko_error
  use, intrinsic :: iso_c_binding, only : c_int, c_ptr
  implicit none
  private
 
#ifdef HAVE_HIP
  interface
     subroutine hip_neumann_apply_scalar(msk, facet, x, flux, area, &
          lx, m, strm) &
          bind(c, name = 'hip_neumann_apply_scalar')
       use, intrinsic :: iso_c_binding
       implicit none
       integer(c_int) :: m, lx
       type(c_ptr), value :: msk, facet, x, flux, area, strm
     end subroutine hip_neumann_apply_scalar
 
     subroutine hip_neumann_apply_vector(msk, facet, x, y, z, flux_x, flux_y,&
          flux_z, area, lx, m, strm) &
          bind(c, name = 'hip_neumann_apply_vector')
       use, intrinsic :: iso_c_binding
       implicit none
       integer(c_int) :: m, lx
       type(c_ptr), value :: msk, facet, x, y, z, flux_x, flux_y, flux_z, &
            area, strm
     end subroutine hip_neumann_apply_vector
  end interface
#elif HAVE_CUDA
  interface
     subroutine cuda_neumann_apply_scalar(msk, facet, x, flux, area, &
          lx, m, strm) &
          bind(c, name = 'cuda_neumann_apply_scalar')
       use, intrinsic :: iso_c_binding
       implicit none
       integer(c_int) :: m, lx
       type(c_ptr), value :: msk, facet, x, flux, area, strm
     end subroutine cuda_neumann_apply_scalar
 
     subroutine cuda_neumann_apply_vector(msk, facet, x, y, z, flux_x, flux_y, &
          flux_z, area, lx, m, strm) &
          bind(c, name = 'cuda_neumann_apply_vector')
       use, intrinsic :: iso_c_binding
       implicit none
       integer(c_int) :: m, lx
       type(c_ptr), value :: msk, facet, x, y, z, flux_x, flux_y, flux_z, &
            area, strm
     end subroutine cuda_neumann_apply_vector
  end interface
#elif HAVE_OPENCL
  interface
     subroutine opencl_neumann_apply_scalar(msk, facet, x, flux, area, &
          lx, m, strm) &
          bind(c, name = 'opencl_neumann_apply_scalar')
       use, intrinsic :: iso_c_binding
       implicit none
       integer(c_int) :: m, lx
       type(c_ptr), value :: msk, facet, x, flux, area, strm
     end subroutine opencl_neumann_apply_scalar
 
     subroutine opencl_neumann_apply_vector(msk, facet, x, y, z, flux_x, &
          flux_y, flux_z, area, lx, m, strm) &
          bind(c, name = 'opencl_neumann_apply_vector')
       use, intrinsic :: iso_c_binding
       implicit none
       integer(c_int) :: m, lx
       type(c_ptr), value :: msk, facet, x, y, z, flux_x, flux_y, flux_z, &
            area, strm
     end subroutine opencl_neumann_apply_vector
  end interface
#elif HAVE_METAL
  interface
     subroutine metal_neumann_apply_scalar(msk, facet, x, flux, area, &
          lx, m, strm) &
          bind(c, name = 'metal_neumann_apply_scalar')
       use, intrinsic :: iso_c_binding
       implicit none
       integer(c_int) :: m, lx
       type(c_ptr), value :: msk, facet, x, flux, area, strm
     end subroutine metal_neumann_apply_scalar
 
     subroutine metal_neumann_apply_vector(msk, facet, x, y, z, flux_x, &
          flux_y, flux_z, area, lx, m, strm) &
          bind(c, name = 'metal_neumann_apply_vector')
       use, intrinsic :: iso_c_binding
       implicit none
       integer(c_int) :: m, lx
       type(c_ptr), value :: msk, facet, x, y, z, flux_x, flux_y, flux_z, &
            area, strm
     end subroutine metal_neumann_apply_vector
  end interface
#endif
 
  public :: device_neumann_apply_scalar, device_neumann_apply_vector
 
contains
 
  subroutine device_neumann_apply_scalar(msk, facet, x, flux, area, lx, m, strm)
    integer, intent(in) :: m, lx
    type(c_ptr) :: msk, facet, x, flux, area, strm
 
    if (m .lt. 1) return
#ifdef HAVE_HIP
    call hip_neumann_apply_scalar(msk, facet, x, flux, area, lx, m, strm)
#elif HAVE_CUDA
    call cuda_neumann_apply_scalar(msk, facet, x, flux, area, lx, m, strm)
#elif HAVE_OPENCL
    call opencl_neumann_apply_scalar(msk, facet, x, flux, area, lx, m, strm)
#elif HAVE_METAL
    call metal_neumann_apply_scalar(msk, facet, x, flux, area, lx, m, strm)
#else
    call neko_error('No device backend configured')
#endif
 
  end subroutine device_neumann_apply_scalar
 
  subroutine device_neumann_apply_vector(msk, facet, x, y, z, flux_x, flux_y, &
       flux_z, area, lx, m, strm)
    integer, intent(in) :: m, lx
    type(c_ptr) :: msk, facet, x, y, z, flux_x, flux_y, flux_z, area, strm
 
    if (m .lt. 1) return
#ifdef HAVE_HIP
    call hip_neumann_apply_vector(msk, facet, x, y, z, flux_x, flux_y, flux_z, &
         area, lx, m, strm)
#elif HAVE_CUDA
    call cuda_neumann_apply_vector(msk, facet, x, y, z, flux_x, flux_y, &
         flux_z, area, lx, m, strm)
#elif HAVE_OPENCL
    call opencl_neumann_apply_vector(msk, facet, x, y, z, flux_x, flux_y, &
         flux_z, area, lx, m, strm)
#elif HAVE_METAL
    call metal_neumann_apply_vector(msk, facet, x, y, z, flux_x, flux_y, &
         flux_z, area, lx, m, strm)
#else
    call neko_error('No device backend configured')
#endif
 
  end subroutine device_neumann_apply_vector
 
end module device_neumann