adv_no_dealias.f90

Go to the documentation of this file.

! Copyright (c) 2021-2024, 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 adv_no_dealias
  use advection, only : advection_t
  use num_types, only : rp
  use math, only : subcol3, rzero, addcol3
  use field_math, only : field_col3
  use space, only : space_t
  use field, only : field_t
  use coefs, only : coef_t
  use device_math, only : device_subcol3, device_rzero, device_addcol3
  use neko_config, only : neko_bcknd_device
  use operators, only : conv1, div
  use device, only : device_free, device_map, device_get_ptr
  use scratch_registry, only : neko_scratch_registry
  use, intrinsic :: iso_c_binding, only : c_ptr, c_null_ptr, c_associated
  implicit none
  private
 
  type, public, extends(advection_t) :: adv_no_dealias_t
     real(kind=rp), allocatable :: temp(:)
     type(c_ptr) :: temp_d = c_null_ptr
   contains
     procedure, pass(this) :: init => init_no_dealias
     procedure, pass(this) :: free => free_no_dealias
     procedure, pass(this) :: compute => compute_advection_no_dealias
     procedure, pass(this) :: compute_scalar => &
          compute_scalar_advection_no_dealias
     procedure, pass(this) :: compute_ale => compute_ale_advection_no_dealias
     procedure, pass(this) :: recompute_metrics => recompute_metrics_no_dealias
  end type adv_no_dealias_t
 
contains
 
  subroutine init_no_dealias(this, coef)
    class(adv_no_dealias_t), intent(inout) :: this
    type(coef_t), intent(in) :: coef
 
    allocate(this%temp(coef%dof%size()))
 
    if (neko_bcknd_device .eq. 1) then
       call device_map(this%temp, this%temp_d, coef%dof%size())
    end if
 
  end subroutine init_no_dealias
 
  subroutine free_no_dealias(this)
    class(adv_no_dealias_t), intent(inout) :: this
 
    if (allocated(this%temp)) then
       deallocate(this%temp)
    end if
    if (c_associated(this%temp_d)) then
       call device_free(this%temp_d)
    end if
  end subroutine free_no_dealias
 
  subroutine compute_advection_no_dealias(this, vx, vy, vz, fx, fy, fz, Xh, &
       coef, n, dt)
    class(adv_no_dealias_t), intent(inout) :: this
    type(space_t), intent(in) :: Xh
    type(coef_t), intent(in) :: coef
    type(field_t), intent(inout) :: vx, vy, vz
    type(field_t), intent(inout) :: fx, fy, fz
    integer, intent(in) :: n
    real(kind=rp), intent(in), optional :: dt
 
    if (neko_bcknd_device .eq. 1) then
 
       call conv1(this%temp, vx%x, vx%x, vy%x, vz%x, xh, coef)
       call device_subcol3 (fx%x_d, coef%B_d, this%temp_d, n)
       call conv1(this%temp, vy%x, vx%x, vy%x, vz%x, xh, coef)
       call device_subcol3 (fy%x_d, coef%B_d, this%temp_d, n)
       if (coef%Xh%lz .eq. 1) then
          call device_rzero (this%temp_d, n)
       else
          call conv1(this%temp, vz%x, vx%x, vy%x, vz%x, xh, coef)
          call device_subcol3(fz%x_d, coef%B_d, this%temp_d, n)
       end if
    else
       call conv1(this%temp, vx%x, vx%x, vy%x, vz%x, xh, coef)
       call subcol3 (fx%x, coef%B, this%temp, n)
       call conv1(this%temp, vy%x, vx%x, vy%x, vz%x, xh, coef)
       call subcol3 (fy%x, coef%B, this%temp, n)
       if (coef%Xh%lz .eq. 1) then
          call rzero (this%temp, n)
       else
          call conv1(this%temp, vz%x, vx%x, vy%x, vz%x, xh, coef)
          call subcol3(fz%x, coef%B, this%temp, n)
       end if
    end if
 
  end subroutine compute_advection_no_dealias
 
  subroutine compute_scalar_advection_no_dealias(this, vx, vy, vz, s, fs, Xh, &
       coef, n, dt)
    class(adv_no_dealias_t), intent(inout) :: this
    type(field_t), intent(inout) :: vx, vy, vz
    type(field_t), intent(inout) :: s
    type(field_t), intent(inout) :: fs
    type(space_t), intent(in) :: Xh
    type(coef_t), intent(in) :: coef
    integer, intent(in) :: n
    real(kind=rp), intent(in), optional :: dt
 
    if (neko_bcknd_device .eq. 1) then
 
       call conv1(this%temp, s%x, vx%x, vy%x, vz%x, xh, coef)
       call device_subcol3 (fs%x_d, coef%B_d, this%temp_d, n)
       if (coef%Xh%lz .eq. 1) then
          call device_rzero (this%temp_d, n)
       end if
    else
       ! temp will hold vx*ds/dx + vy*ds/dy + vz*ds/sz
       call conv1(this%temp, s%x, vx%x, vy%x, vz%x, xh, coef)
 
       ! fs = fs - B*temp
       call subcol3 (fs%x, coef%B, this%temp, n)
       if (coef%Xh%lz .eq. 1) then
          call rzero (this%temp, n)
       end if
    end if
 
  end subroutine compute_scalar_advection_no_dealias
 
  subroutine recompute_metrics_no_dealias(this, coef, moving_boundary)
    class(adv_no_dealias_t), intent(inout) :: this
    type(coef_t), intent(in) :: coef
    logical, intent(in) :: moving_boundary
    ! no-op
  end subroutine recompute_metrics_no_dealias
 
  subroutine compute_ale_advection_no_dealias(this, vx, vy, vz, &
       wm_x, wm_y, wm_z, fx, fy, fz, Xh, coef, n, dt)
    class(adv_no_dealias_t), intent(inout) :: this
    type(field_t), intent(inout) :: vx, vy, vz
    type(field_t), intent(inout) :: wm_x, wm_y, wm_z
    type(field_t), intent(inout) :: fx, fy, fz
    type(space_t), intent(in) :: Xh
    type(coef_t), intent(in) :: coef
    type(field_t), pointer :: work_x, work_y, work_z
    integer :: id_x, id_y, id_z
    integer, intent(in) :: n
    real(kind=rp), intent(in), optional :: dt
 
    call neko_scratch_registry%request_field(work_x, id_x, .false.)
    call neko_scratch_registry%request_field(work_y, id_y, .false.)
    call neko_scratch_registry%request_field(work_z, id_z, .false.)
 
    ! u.wm_*
    call field_col3(work_x, vx, wm_x)
    call field_col3(work_y, vx, wm_y)
    call field_col3(work_z, vx, wm_z)
    call div(this%temp, work_x%x, work_y%x, work_z%x, coef)
 
    if (neko_bcknd_device .eq. 1) then
       call device_addcol3(fx%x_d, coef%B_d, this%temp_d, n)
    else
       call addcol3(fx%x, coef%B, this%temp, n)
    end if
 
    ! v.wm_*
    call field_col3(work_x, vy, wm_x)
    call field_col3(work_y, vy, wm_y)
    call field_col3(work_z, vy, wm_z)
    call div(this%temp, work_x%x, work_y%x, work_z%x, coef)
 
    if (neko_bcknd_device .eq. 1) then
       call device_addcol3(fy%x_d, coef%B_d, this%temp_d, n)
    else
       call addcol3(fy%x, coef%B, this%temp, n)
    end if
 
    ! w.wm_*
    call field_col3(work_x, vz, wm_x)
    call field_col3(work_y, vz, wm_y)
    call field_col3(work_z, vz, wm_z)
    call div(this%temp, work_x%x, work_y%x, work_z%x, coef)
 
    if (neko_bcknd_device .eq. 1) then
       call device_addcol3(fz%x_d, coef%B_d, this%temp_d, n)
    else
       call addcol3(fz%x, coef%B, this%temp, n)
    end if
 
    call neko_scratch_registry%relinquish_field(id_x)
    call neko_scratch_registry%relinquish_field(id_y)
    call neko_scratch_registry%relinquish_field(id_z)
 
  end subroutine compute_ale_advection_no_dealias
end module adv_no_dealias