hip_math.f90

Go to the documentation of this file.

! Copyright (c) 2024-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 hip_math
  use num_types, only : rp, c_rp
  implicit none
  public
 
  interface
     subroutine hip_copy(a_d, b_d, n, strm) &
          bind(c, name = 'hip_copy')
       use, intrinsic :: iso_c_binding, only : c_ptr, c_int
       type(c_ptr), value :: a_d, b_d, strm
       integer(c_int) :: n
     end subroutine hip_copy
 
     subroutine hip_masked_copy(a_d, b_d, mask_d, n, n_mask, strm) &
          bind(c, name = 'hip_masked_copy')
       use, intrinsic :: iso_c_binding, only : c_ptr, c_int
       type(c_ptr), value :: a_d, b_d, mask_d, strm
       integer(c_int) :: n, n_mask
     end subroutine hip_masked_copy
 
     subroutine hip_masked_gather_copy(a_d, b_d, mask_d, n, n_mask, strm) &
          bind(c, name = 'hip_masked_gather_copy')
       use, intrinsic :: iso_c_binding, only : c_ptr, c_int
       type(c_ptr), value :: a_d, b_d, mask_d, strm
       integer(c_int) :: n, n_mask
     end subroutine hip_masked_gather_copy
 
     subroutine hip_masked_gather_copy_aligned(a_d, b_d, mask_d, n, n_mask, &
          strm) bind(c, name = 'hip_masked_gather_copy_aligned')
       use, intrinsic :: iso_c_binding, only : c_ptr, c_int
       type(c_ptr), value :: a_d, b_d, mask_d, strm
       integer(c_int) :: n, n_mask
     end subroutine hip_masked_gather_copy_aligned
 
     subroutine hip_face_masked_gather_copy(a_d, b_d, mask_d, facet_d, n1, &
          n2, lx, ly, lz, n_mask, strm) &
          bind(c, name = 'hip_face_masked_gather_copy')
       use, intrinsic :: iso_c_binding, only : c_ptr, c_int
       type(c_ptr), value :: a_d, b_d, mask_d, facet_d, strm
       integer(c_int) :: n1, n2, lx, ly, lz, n_mask
     end subroutine hip_face_masked_gather_copy
 
     subroutine hip_masked_scatter_copy(a_d, b_d, mask_d, n, n_mask, strm) &
          bind(c, name = 'hip_masked_scatter_copy')
       use, intrinsic :: iso_c_binding, only : c_ptr, c_int
       type(c_ptr), value :: a_d, b_d, mask_d, strm
       integer(c_int) :: n, n_mask
     end subroutine hip_masked_scatter_copy
 
     subroutine hip_masked_scatter_copy_aligned(a_d, b_d, mask_d, n, n_mask, strm) &
          bind(c, name = 'hip_masked_scatter_copy_aligned')
       use, intrinsic :: iso_c_binding, only : c_ptr, c_int
       type(c_ptr), value :: a_d, b_d, mask_d, strm
       integer(c_int) :: n, n_mask
     end subroutine hip_masked_scatter_copy_aligned
 
     subroutine hip_masked_atomic_reduction(a_d, b_d, mask_d, n, m, strm) &
          bind(c, name = 'hip_masked_atomic_reduction')
       use, intrinsic :: iso_c_binding, only : c_ptr, c_int
       type(c_ptr), value :: a_d, b_d, mask_d, strm
       integer(c_int) :: n, m
     end subroutine hip_masked_atomic_reduction
 
     subroutine hip_cfill_mask(a_d, c, n, mask_d, n_mask, strm) &
          bind(c, name = 'hip_cfill_mask')
       use, intrinsic :: iso_c_binding, only : c_ptr, c_int
       import c_rp
       type(c_ptr), value :: a_d
       real(c_rp) :: c
       integer(c_int) :: n
       type(c_ptr), value :: mask_d
       integer(c_int) :: n_mask
       type(c_ptr), value :: strm
     end subroutine hip_cfill_mask
 
     subroutine hip_cmult(a_d, c, n, strm) &
          bind(c, name = 'hip_cmult')
       use, intrinsic :: iso_c_binding, only : c_ptr, c_int
       import c_rp
       type(c_ptr), value :: a_d, strm
       real(c_rp) :: c
       integer(c_int) :: n
     end subroutine hip_cmult
 
     subroutine hip_cmult2(a_d, b_d, c, n, strm) &
          bind(c, name = 'hip_cmult2')
       use, intrinsic :: iso_c_binding, only : c_ptr, c_int
       import c_rp
       type(c_ptr), value :: a_d, b_d, strm
       real(c_rp) :: c
       integer(c_int) :: n
     end subroutine hip_cmult2
 
     subroutine hip_cdiv(a_d, c, n, strm) &
          bind(c, name = 'hip_cdiv')
       use, intrinsic :: iso_c_binding, only : c_ptr, c_int
       import c_rp
       type(c_ptr), value :: a_d, strm
       real(c_rp) :: c
       integer(c_int) :: n
     end subroutine hip_cdiv
 
     subroutine hip_cdiv2(a_d, b_d, c, n, strm) &
          bind(c, name = 'hip_cdiv2')
       use, intrinsic :: iso_c_binding, only : c_ptr, c_int
       import c_rp
       type(c_ptr), value :: a_d, b_d, strm
       real(c_rp) :: c
       integer(c_int) :: n
     end subroutine hip_cdiv2
 
     subroutine hip_radd(a_d, c, n, strm) &
          bind(c, name = 'hip_radd')
       use, intrinsic :: iso_c_binding, only : c_ptr, c_int
       import c_rp
       type(c_ptr), value :: a_d, strm
       real(c_rp) :: c
       integer(c_int) :: n
     end subroutine hip_radd
 
     subroutine hip_cadd2(a_d, b_d, c, n, strm) &
          bind(c, name = 'hip_cadd2')
       use, intrinsic :: iso_c_binding, only : c_ptr, c_int
       import c_rp
       type(c_ptr), value :: a_d
       type(c_ptr), value :: b_d
       type(c_ptr), value :: strm
       real(c_rp) :: c
       integer(c_int) :: n
     end subroutine hip_cadd2
 
     subroutine hip_cwrap(a_d, min_val, max_val, n, strm) &
          bind(c, name = 'hip_cwrap')
       use, intrinsic :: iso_c_binding, only : c_ptr, c_int
       import c_rp
       type(c_ptr), value :: a_d
       type(c_ptr), value :: strm
       real(c_rp) :: min_val
       real(c_rp) :: max_val
       integer(c_int) :: n
     end subroutine hip_cwrap
 
     subroutine hip_cfill(a_d, c, n, strm) &
          bind(c, name = 'hip_cfill')
       use, intrinsic :: iso_c_binding, only : c_ptr, c_int
       import c_rp
       type(c_ptr), value :: a_d, strm
       real(c_rp) :: c
       integer(c_int) :: n
     end subroutine hip_cfill
 
     subroutine hip_rzero(a_d, n, strm) &
          bind(c, name = 'hip_rzero')
       use, intrinsic :: iso_c_binding, only : c_ptr, c_int
       type(c_ptr), value :: a_d, strm
       integer(c_int) :: n
     end subroutine hip_rzero
 
     subroutine hip_add2(a_d, b_d, n, strm) &
          bind(c, name = 'hip_add2')
       use, intrinsic :: iso_c_binding, only : c_ptr, c_int
       import c_rp
       type(c_ptr), value :: a_d, b_d, strm
       integer(c_int) :: n
     end subroutine hip_add2
 
     subroutine hip_add4(a_d, b_d, c_d, d_d, n, strm) &
          bind(c, name = 'hip_add4')
       use, intrinsic :: iso_c_binding, only : c_ptr, c_int
       import c_rp
       type(c_ptr), value :: a_d, b_d, c_d, d_d, strm
       integer(c_int) :: n
     end subroutine hip_add4
 
     subroutine hip_add2s1(a_d, b_d, c1, n, strm) &
          bind(c, name = 'hip_add2s1')
       use, intrinsic :: iso_c_binding, only : c_ptr, c_int
       import c_rp
       type(c_ptr), value :: a_d, b_d, strm
       real(c_rp) :: c1
       integer(c_int) :: n
     end subroutine hip_add2s1
 
     subroutine hip_add2s2(a_d, b_d, c1, n, strm) &
          bind(c, name = 'hip_add2s2')
       use, intrinsic :: iso_c_binding, only : c_ptr, c_int
       import c_rp
       type(c_ptr), value :: a_d, b_d, strm
       real(c_rp) :: c1
       integer(c_int) :: n
     end subroutine hip_add2s2
 
     subroutine hip_addsqr2s2(a_d, b_d, c1, n, strm) &
          bind(c, name = 'hip_addsqr2s2')
       use, intrinsic :: iso_c_binding, only : c_ptr, c_int
       import c_rp
       type(c_ptr), value :: a_d, b_d, strm
       real(c_rp) :: c1
       integer(c_int) :: n
     end subroutine hip_addsqr2s2
 
     subroutine hip_add3s2(a_d, b_d, c_d, c1, c2, n, strm) &
          bind(c, name = 'hip_add3s2')
       use, intrinsic :: iso_c_binding, only : c_ptr, c_int
       import c_rp
       type(c_ptr), value :: a_d, b_d, c_d, strm
       real(c_rp) :: c1, c2
       integer(c_int) :: n
     end subroutine hip_add3s2
 
     subroutine hip_add4s3(a_d, b_d, c_d, d_d, c1, c2, c3, n, strm) &
          bind(c, name = 'hip_add4s3')
       use, intrinsic :: iso_c_binding, only : c_ptr, c_int
       import c_rp
       type(c_ptr), value :: a_d, b_d, c_d, d_d, strm
       real(c_rp) :: c1, c2, c3
       integer(c_int) :: n
     end subroutine hip_add4s3
 
     subroutine hip_add5s4(a_d, b_d, c_d, d_d, e_d, c1, c2, c3, c4, n, strm) &
          bind(c, name = 'hip_add5s4')
       use, intrinsic :: iso_c_binding, only : c_ptr, c_int
       import c_rp
       type(c_ptr), value :: a_d, b_d, c_d, d_d, e_d, strm
       real(c_rp) :: c1, c2, c3, c4
       integer(c_int) :: n
     end subroutine hip_add5s4
 
     subroutine hip_invcol1(a_d, n, strm) &
          bind(c, name = 'hip_invcol1')
       use, intrinsic :: iso_c_binding, only : c_ptr, c_int
       type(c_ptr), value :: a_d, strm
       integer(c_int) :: n
     end subroutine hip_invcol1
 
     subroutine hip_invcol2(a_d, b_d, n, strm) &
          bind(c, name = 'hip_invcol2')
       use, intrinsic :: iso_c_binding, only : c_ptr, c_int
       type(c_ptr), value :: a_d, b_d, strm
       integer(c_int) :: n
     end subroutine hip_invcol2
 
     subroutine hip_invcol3(a_d, b_d, c_d, n, strm) &
          bind(c, name = 'hip_invcol3')
       use, intrinsic :: iso_c_binding, only : c_ptr, c_int
       type(c_ptr), value :: a_d, b_d, c_d, strm
       integer(c_int) :: n
     end subroutine hip_invcol3
 
     subroutine hip_col2(a_d, b_d, n, strm) &
          bind(c, name = 'hip_col2')
       use, intrinsic :: iso_c_binding, only : c_ptr, c_int
       type(c_ptr), value :: a_d, b_d, strm
       integer(c_int) :: n
     end subroutine hip_col2
 
     subroutine hip_col3(a_d, b_d, c_d, n, strm) &
          bind(c, name = 'hip_col3')
       use, intrinsic :: iso_c_binding, only : c_ptr, c_int
       type(c_ptr), value :: a_d, b_d, c_d, strm
       integer(c_int) :: n
     end subroutine hip_col3
 
     subroutine hip_subcol3(a_d, b_d, c_d, n, strm) &
          bind(c, name = 'hip_subcol3')
       use, intrinsic :: iso_c_binding, only : c_ptr, c_int
       type(c_ptr), value :: a_d, b_d, c_d, strm
       integer(c_int) :: n
     end subroutine hip_subcol3
 
     subroutine hip_sub2(a_d, b_d, n, strm) &
          bind(c, name = 'hip_sub2')
       use, intrinsic :: iso_c_binding, only : c_ptr, c_int
       type(c_ptr), value :: a_d, b_d, strm
       integer(c_int) :: n
     end subroutine hip_sub2
 
     subroutine hip_sub3(a_d, b_d, c_d, n, strm) &
          bind(c, name = 'hip_sub3')
       use, intrinsic :: iso_c_binding, only : c_ptr, c_int
       type(c_ptr), value :: a_d, b_d, c_d, strm
       integer(c_int) :: n
     end subroutine hip_sub3
 
     subroutine hip_add3(a_d, b_d, c_d, n, strm) &
          bind(c, name = 'hip_add3')
       use, intrinsic :: iso_c_binding, only : c_ptr, c_int
       type(c_ptr), value :: a_d, b_d, c_d, strm
       integer(c_int) :: n
     end subroutine hip_add3
 
     subroutine hip_addcol3(a_d, b_d, c_d, n, strm) &
          bind(c, name = 'hip_addcol3')
       use, intrinsic :: iso_c_binding, only : c_ptr, c_int
       type(c_ptr), value :: a_d, b_d, c_d, strm
       integer(c_int) :: n
     end subroutine hip_addcol3
 
     subroutine hip_addcol4(a_d, b_d, c_d, d_d, n, strm) &
          bind(c, name = 'hip_addcol4')
       use, intrinsic :: iso_c_binding, only : c_ptr, c_int
       type(c_ptr), value :: a_d, b_d, c_d, d_d, strm
       integer(c_int) :: n
     end subroutine hip_addcol4
 
     subroutine hip_addcol3s2(a_d, b_d, c_d, s, n, strm) &
          bind(c, name = 'hip_addcol3s2')
       use, intrinsic :: iso_c_binding, only : c_ptr, c_int
       import c_rp
       type(c_ptr), value :: a_d, b_d, c_d, strm
       real(c_rp) :: s
       integer(c_int) :: n
     end subroutine hip_addcol3s2
 
     subroutine hip_vdot3(dot_d, u1_d, u2_d, u3_d, v1_d, v2_d, v3_d, n, strm) &
          bind(c, name = 'hip_vdot3')
       use, intrinsic :: iso_c_binding, only : c_ptr, c_int
       type(c_ptr), value :: dot_d, u1_d, u2_d, u3_d, v1_d, v2_d, v3_d, strm
       integer(c_int) :: n
     end subroutine hip_vdot3
 
     subroutine hip_vcross(u1_d, u2_d, u3_d, v1_d, v2_d, v3_d, &
          w1_d, w2_d, w3_d, n, strm) &
          bind(c, name = 'hip_vcross')
       use, intrinsic :: iso_c_binding, only : c_ptr, c_int
 
       type(c_ptr), value :: u1_d, u2_d, u3_d
       type(c_ptr), value :: v1_d, v2_d, v3_d
       type(c_ptr), value :: w1_d, w2_d, w3_d
       type(c_ptr), value :: strm
       integer(c_int) :: n
     end subroutine hip_vcross
 
     real(c_rp) function hip_vlsc3(u_d, v_d, w_d, n, strm) &
          bind(c, name = 'hip_vlsc3')
       use, intrinsic :: iso_c_binding, only : c_ptr, c_int
       import c_rp
       type(c_ptr), value :: u_d, v_d, w_d, strm
       integer(c_int) :: n
     end function hip_vlsc3
 
     subroutine hip_add2s2_many(y_d, x_d_d, a_d, j, n, strm) &
          bind(c, name = 'hip_add2s2_many')
       use, intrinsic :: iso_c_binding, only : c_ptr, c_int
       import c_rp
       type(c_ptr), value :: y_d, x_d_d, a_d, strm
       integer(c_int) :: j, n
     end subroutine hip_add2s2_many
 
     real(c_rp) function hip_glsc3(a_d, b_d, c_d, n, strm) &
          bind(c, name = 'hip_glsc3')
       use, intrinsic :: iso_c_binding, only : c_ptr, c_int
       import c_rp
       type(c_ptr), value :: a_d, b_d, c_d, strm
       integer(c_int) :: n
     end function hip_glsc3
 
     subroutine hip_glsc3_many(h, w_d, v_d_d, mult_d, j, n, strm) &
          bind(c, name = 'hip_glsc3_many')
       use, intrinsic :: iso_c_binding, only : c_ptr, c_int
       import c_rp
       type(c_ptr), value :: w_d, v_d_d, mult_d, strm
       integer(c_int) :: j, n
       real(c_rp) :: h(j)
     end subroutine hip_glsc3_many
 
     real(c_rp) function hip_glsc2(a_d, b_d, n, strm) &
          bind(c, name = 'hip_glsc2')
       use, intrinsic :: iso_c_binding, only : c_ptr, c_int
       import c_rp
       type(c_ptr), value :: a_d, b_d, strm
       integer(c_int) :: n
     end function hip_glsc2
 
     real(c_rp) function hip_glsubnorm2(a_d, b_d, n, strm) &
          bind(c, name = 'hip_glsubnorm2')
       use, intrinsic :: iso_c_binding, only : c_ptr, c_int
       import c_rp
       type(c_ptr), value :: a_d, b_d, strm
       integer(c_int) :: n
     end function hip_glsubnorm2
 
     real(c_rp) function hip_glsum(a_d, n, strm) &
          bind(c, name = 'hip_glsum')
       use, intrinsic :: iso_c_binding, only : c_ptr, c_int
       import c_rp
       type(c_ptr), value :: a_d, strm
       integer(c_int) :: n
     end function hip_glsum
 
     real(c_rp) function hip_glmax(a_d, ninf, n, strm) &
          bind(c, name = 'hip_glmax')
       use, intrinsic :: iso_c_binding, only: c_int, c_ptr
       import c_rp
       type(c_ptr), value :: a_d, strm
       real(c_rp) :: ninf
       integer(c_int) :: n
     end function hip_glmax
 
     real(c_rp) function hip_glmin(a_d, pinf, n, strm) &
          bind(c, name = 'hip_glmin')
       use, intrinsic :: iso_c_binding, only: c_int, c_ptr
       import c_rp
       type(c_ptr), value :: a_d, strm
       real(c_rp) :: pinf
       integer(c_int) :: n
     end function hip_glmin
 
     subroutine hip_absval(a_d, n, strm) &
          bind(c, name = 'hip_absval')
       use, intrinsic :: iso_c_binding, only : c_ptr, c_int
       import c_rp
       type(c_ptr), value :: a_d, strm
       integer(c_int) :: n
     end subroutine hip_absval
  end interface
 
  ! ========================================================================== !
  ! Interfaces for the pointwise operations.
 
  interface
     subroutine hip_pwmax_vec2(a_d, b_d, n, strm) &
          bind(c, name = 'hip_pwmax_vec2')
       use, intrinsic :: iso_c_binding, only : c_int, c_ptr
       type(c_ptr), value :: a_d, b_d, strm
       integer(c_int) :: n
     end subroutine hip_pwmax_vec2
 
     subroutine hip_pwmax_vec3(a_d, b_d, c_d, n, strm) &
          bind(c, name = 'hip_pwmax_vec3')
       use, intrinsic :: iso_c_binding, only : c_int, c_ptr
       type(c_ptr), value :: a_d, b_d, c_d, strm
       integer(c_int) :: n
     end subroutine hip_pwmax_vec3
 
     subroutine hip_pwmax_sca2(a_d, c_d, n, strm) &
          bind(c, name = 'hip_pwmax_sca2')
       use, intrinsic :: iso_c_binding, only : c_int, c_ptr
       import c_rp
       type(c_ptr), value :: a_d, strm
       real(c_rp) :: c_d
       integer(c_int) :: n
     end subroutine hip_pwmax_sca2
 
     subroutine hip_pwmax_sca3(a_d, b_d, c_d, n, strm) &
          bind(c, name = 'hip_pwmax_sca3')
       use, intrinsic :: iso_c_binding, only : c_int, c_ptr
       import c_rp
       type(c_ptr), value :: a_d, b_d, strm
       real(c_rp) :: c_d
       integer(c_int) :: n
     end subroutine hip_pwmax_sca3
 
     subroutine hip_pwmin_vec2(a_d, b_d, n, strm) &
          bind(c, name = 'hip_pwmin_vec2')
       use, intrinsic :: iso_c_binding, only : c_int, c_ptr
       type(c_ptr), value :: a_d, b_d, strm
       integer(c_int) :: n
     end subroutine hip_pwmin_vec2
 
     subroutine hip_pwmin_vec3(a_d, b_d, c_d, n, strm) &
          bind(c, name = 'hip_pwmin_vec3')
       use, intrinsic :: iso_c_binding, only : c_int, c_ptr
       type(c_ptr), value :: a_d, b_d, c_d, strm
       integer(c_int) :: n
     end subroutine hip_pwmin_vec3
 
     subroutine hip_pwmin_sca2(a_d, c_d, n, strm) &
          bind(c, name = 'hip_pwmin_sca2')
       use, intrinsic :: iso_c_binding, only : c_int, c_ptr
       import c_rp
       type(c_ptr), value :: a_d, strm
       real(c_rp) :: c_d
       integer(c_int) :: n
     end subroutine hip_pwmin_sca2
 
     subroutine hip_pwmin_sca3(a_d, b_d, c_d, n, strm) &
          bind(c, name = 'hip_pwmin_sca3')
       use, intrinsic :: iso_c_binding, only : c_int, c_ptr
       import c_rp
       type(c_ptr), value :: a_d, b_d, strm
       real(c_rp) :: c_d
       integer(c_int) :: n
     end subroutine hip_pwmin_sca3
 
  end interface
 
  ! ========================================================================== !
  ! Interfaces for integer operations.
 
  interface
 
     subroutine hip_iadd(a_d, c, n, strm) &
          bind(c, name = 'hip_iadd')
       use, intrinsic :: iso_c_binding, only : c_int, c_ptr
       import c_rp
       type(c_ptr), value :: a_d, strm
       integer(c_int) :: c
       integer(c_int) :: n
     end subroutine hip_iadd
 
  end interface
end module hip_math