dynamic_smagorinsky.f90

Go to the documentation of this file.

! Copyright (c) 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 dynamic_smagorinsky
  use num_types, only : rp
  use field, only : field_t
  use fluid_scheme_base, only : fluid_scheme_base_t
  use les_model, only : les_model_t
  use json_utils, only : json_get, json_get_or_default
  use json_module, only : json_file
  use utils, only : neko_error
  use neko_config, only : neko_bcknd_device
  use elementwise_filter, only : elementwise_filter_t
  use dynamic_smagorinsky_cpu, only : dynamic_smagorinsky_compute_cpu
  use logger, only : log_size, neko_log
  use field_registry, only : neko_field_registry
  use dynamic_smagorinsky_device, only : dynamic_smagorinsky_compute_device
  implicit none
  private
 
  type, public, extends(les_model_t) :: dynamic_smagorinsky_t
     type(field_t) :: c_dyn
     type(elementwise_filter_t) :: test_filter
     type(field_t) :: mij(6)
     type(field_t) :: lij(6)
     type(field_t) :: num
     type(field_t) :: den
   contains
     procedure, pass(this) :: init => dynamic_smagorinsky_init
     procedure, pass(this) :: free => dynamic_smagorinsky_free
     procedure, pass(this) :: compute => dynamic_smagorinsky_compute
 
  end type dynamic_smagorinsky_t
 
contains
  subroutine dynamic_smagorinsky_init(this, fluid, json)
    class(dynamic_smagorinsky_t), intent(inout) :: this
    class(fluid_scheme_base_t), intent(inout), target :: fluid
    type(json_file), intent(inout) :: json
    type(json_file) :: json_subdict
    character(len=:), allocatable :: nut_name
    integer :: i
    character(len=:), allocatable :: delta_type
    logical :: if_ext
    character(len=:), allocatable :: filter_type
    character(len=LOG_SIZE) :: log_buf
 
    associate(dofmap => fluid%dm_Xh, &
         coef => fluid%c_Xh)
 
      call json_get_or_default(json, "nut_field", nut_name, "nut")
      call json_get_or_default(json, "delta_type", delta_type, "pointwise")
      call json_get_or_default(json, "extrapolation", if_ext, .false.)
 
      call this%free()
      call this%init_base(fluid, nut_name, delta_type, if_ext)
      call json_get(json, "test_filter", json_subdict)
      call this%test_filter%init(json_subdict, coef)
      if (json%valid_path('filter.transfer_function')) then
         call neko_error("Dynamic Smagorinsky model does not support " // &
              "transfer function specified in the json file. " // &
              "Please hard-code it in " // &
              "subroutine set_ds_filt() in " // &
              "src/les/dynamic_smagorisnky.f90")
      end if
      if (json%valid_path('filter.type')) then
         call json_get(json, "filter.type", filter_type)
         if (trim(filter_type) .ne. "elementwise") then
            call neko_error("Currently only elementwise filter is supported &
            &for dynamic smagorinsky model.")
         end if
      end if
 
      call set_ds_filt(this%test_filter)
 
      call neko_log%section('LES model')
      write(log_buf, '(A)') 'Model : Dynamic Smagorinsky'
      call neko_log%message(log_buf)
      write(log_buf, '(A, A)') 'Delta evaluation : ', delta_type
      call neko_log%message(log_buf)
      write(log_buf, '(A, A)') 'Test filter type : ', &
           this%test_filter%filter_type
      call neko_log%message(log_buf)
      write(log_buf, '(A, L1)') 'extrapolation : ', if_ext
      call neko_log%message(log_buf)
      call neko_log%end_section()
 
      call this%c_dyn%init(dofmap, "ds_c_dyn")
      call this%num%init(dofmap, "ds_num")
      call this%den%init(dofmap, "ds_den")
 
      do i = 1, 6
         call this%mij(i)%init(dofmap)
         call this%lij(i)%init(dofmap)
      end do
 
    end associate
 
  end subroutine dynamic_smagorinsky_init
 
  subroutine dynamic_smagorinsky_free(this)
    class(dynamic_smagorinsky_t), intent(inout) :: this
    integer :: i
 
    call this%c_dyn%free()
    do i = 1, 6
       call this%mij(i)%free()
       call this%lij(i)%free()
    end do
    call this%num%free()
    call this%den%free()
    call this%test_filter%free()
    call this%free_base()
 
  end subroutine dynamic_smagorinsky_free
 
  subroutine dynamic_smagorinsky_compute(this, t, tstep)
    class(dynamic_smagorinsky_t), intent(inout) :: this
    real(kind=rp), intent(in) :: t
    integer, intent(in) :: tstep
 
    type(field_t), pointer :: u, v, w, u_e, v_e, w_e
 
    if (this%if_ext .eqv. .true.) then
       ! Extrapolate the velocity fields
       associate(ulag => this%ulag, vlag => this%vlag, &
            wlag => this%wlag, ext_bdf => this%ext_bdf)
 
         u => neko_field_registry%get_field_by_name("u")
         v => neko_field_registry%get_field_by_name("v")
         w => neko_field_registry%get_field_by_name("w")
         u_e => neko_field_registry%get_field_by_name("u_e")
         v_e => neko_field_registry%get_field_by_name("v_e")
         w_e => neko_field_registry%get_field_by_name("w_e")
 
         call this%sumab%compute_fluid(u_e, v_e, w_e, u, v, w, &
              ulag, vlag, wlag, ext_bdf%advection_coeffs, ext_bdf%nadv)
 
       end associate
    end if
 
    ! Compute the eddy viscosity field
    if (neko_bcknd_device .eq. 1) then
       call dynamic_smagorinsky_compute_device(this%if_ext, t, tstep, &
            this%coef, this%nut, &
            this%delta, this%c_dyn, this%test_filter, &
            this%mij, this%lij, this%num, this%den)
    else
       call dynamic_smagorinsky_compute_cpu(this%if_ext, t, tstep, &
            this%coef, this%nut, &
            this%delta, this%c_dyn, this%test_filter, &
            this%mij, this%lij, this%num, this%den)
    end if
 
  end subroutine dynamic_smagorinsky_compute
 
  subroutine set_ds_filt(filter_1d)
    type(elementwise_filter_t), intent(inout) :: filter_1d
    integer :: i
 
    if (filter_1d%nx .le. 2) then
       call neko_error("Dynamic Smagorinsky model error: test filter is not &
       &defined for the current polynomial order")
    end if
    if (mod(filter_1d%nx,2) .eq. 0) then ! number of grid spacing is odd
       ! cutoff at polynomial order int((filter_1d%nx)/2)
       filter_1d%transfer(int((filter_1d%nx)/2)) = 0.95_rp
       filter_1d%transfer(int((filter_1d%nx)/2) + 1) = 0.50_rp
       filter_1d%transfer(int((filter_1d%nx)/2) + 2) = 0.05_rp
       if ((int((filter_1d%nx)/2) + 2) .lt. filter_1d%nx) then
          do i = int((filter_1d%nx)/2) + 3, filter_1d%nx
             filter_1d%transfer(i) = 0.0_rp
          end do
       end if
       ! make delta_ratio = (nx-1)/(nt-1) as close to 2
       filter_1d%nt = int(filter_1d%nx/2) + 1
    else ! number of grid spacing is even
       ! cutoff at polynomial order int((filter_1d%nx-1)/2)
       filter_1d%transfer(int((filter_1d%nx-1)/2)) = 0.95_rp
       filter_1d%transfer(int((filter_1d%nx-1)/2) + 1) = 0.50_rp
       filter_1d%transfer(int((filter_1d%nx-1)/2) + 2) = 0.05_rp
       if ((int((filter_1d%nx-1)/2) + 2) .lt. filter_1d%nx) then
          do i = int((filter_1d%nx-1)/2) + 3, filter_1d%nx
             filter_1d%transfer(i) = 0.0_rp
          end do
       end if
       ! make delta_ratio = (nx-1)/(nt-1) = 2
       filter_1d%nt = int((filter_1d%nx-1)/2) + 1
    end if
 
    call filter_1d%build_1d()
 
  end subroutine set_ds_filt
 
end module dynamic_smagorinsky