flow_ic.f90

Go to the documentation of this file.

! Copyright (c) 2021-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 flow_ic
  use num_types, only : rp
  use logger, only : neko_log, log_size
  use gather_scatter, only : gs_t, gs_op_add
  use neko_config, only : neko_bcknd_device
  use flow_profile, only : blasius_profile, blasius_linear, blasius_cubic, &
       blasius_quadratic, blasius_quartic, blasius_sin, blasius_tanh
  use device, only : device_memcpy, host_to_device, device_to_host, device_sync
  use field, only : field_t
  use utils, only : neko_error, filename_chsuffix, &
       neko_warning, neko_fname_len, extract_fld_file_index
  use coefs, only : coef_t
  use math, only : col2, cfill, cfill_mask, abscmp
  use device_math, only : device_col2
  use user_intf, only : user_initial_conditions_intf
  use json_module, only : json_file
  use json_utils, only : json_get, json_get_or_default
  use point_zone, only : point_zone_t
  use point_zone_registry, only : neko_point_zone_registry
  use fld_file_data, only : fld_file_data_t
  use fld_file, only : fld_file_t
  use file, only : file_t
  use global_interpolation, only : global_interpolation_t
  use interpolation, only : interpolator_t
  use space, only : space_t, gll
  use field_list, only : field_list_t
  use operators, only : rotate_cyc
  implicit none
  private
 
  interface set_flow_ic
     module procedure set_flow_ic_int, set_flow_ic_usr, &
          set_compressible_flow_ic_usr
  end interface set_flow_ic
 
  public :: set_flow_ic, set_flow_ic_fld
 
contains
 
  subroutine set_flow_ic_int(u, v, w, p, coef, gs, type, params)
    type(field_t), intent(inout) :: u
    type(field_t), intent(inout) :: v
    type(field_t), intent(inout) :: w
    type(field_t), intent(inout) :: p
    type(coef_t), intent(in) :: coef
    type(gs_t), intent(inout) :: gs
    character(len=*) :: type
    type(json_file), intent(inout) :: params
    real(kind=rp) :: delta, tol
    real(kind=rp), allocatable :: uinf(:)
    real(kind=rp), allocatable :: zone_value(:)
    character(len=:), allocatable :: read_str
    character(len=NEKO_FNAME_LEN) :: fname, mesh_fname
    logical :: interpolate
 
 
    !
    ! Uniform (Uinf, Vinf, Winf)
    !
    if (trim(type) .eq. 'uniform') then
 
       call json_get(params, 'value', uinf)
       call set_flow_ic_uniform(u, v, w, uinf)
 
       !
       ! Blasius boundary layer
       !
    else if (trim(type) .eq. 'blasius') then
 
       call json_get(params, 'delta', delta)
       call json_get(params, 'approximation', read_str)
       call json_get(params, 'freestream_velocity', uinf)
 
       call set_flow_ic_blasius(u, v, w, delta, uinf, read_str)
 
       !
       ! Point zone initial condition
       !
    else if (trim(type) .eq. 'point_zone') then
 
       call json_get(params, 'base_value', uinf)
       call json_get(params, 'zone_name', read_str)
       call json_get(params, 'zone_value', zone_value)
 
       call set_flow_ic_point_zone(u, v, w, uinf, read_str, zone_value)
 
       !
       ! Field initial condition (from fld file)
       !
    else if (trim(type) .eq. 'field') then
 
       call json_get(params, 'file_name', read_str)
       fname = trim(read_str)
       call json_get_or_default(params, 'interpolate', interpolate, &
            .false.)
       call json_get_or_default(params, 'tolerance', tol, 0.000001_rp)
       call json_get_or_default(params, 'mesh_file_name', read_str, "none")
       mesh_fname = trim(read_str)
 
       call set_flow_ic_fld(u, v, w, p, fname, interpolate, tol, mesh_fname)
 
    else
       call neko_error('Invalid initial condition')
    end if
 
    call set_flow_ic_common(u, v, w, p, coef, gs)
 
  end subroutine set_flow_ic_int
 
  subroutine set_flow_ic_usr(u, v, w, p, coef, gs, user_proc, scheme_name)
    type(field_t), target, intent(inout) :: u
    type(field_t), target, intent(inout) :: v
    type(field_t), target, intent(inout) :: w
    type(field_t), target, intent(inout) :: p
    type(coef_t), intent(in) :: coef
    type(gs_t), intent(inout) :: gs
    procedure(user_initial_conditions_intf) :: user_proc
    character(len=*), intent(in) :: scheme_name
 
    type(field_list_t) :: fields
 
 
    call neko_log%message("Type: user")
 
    call fields%init(4)
    call fields%assign_to_field(1, u)
    call fields%assign_to_field(2, v)
    call fields%assign_to_field(3, w)
    call fields%assign_to_field(4, p)
 
    call user_proc(scheme_name, fields)
 
    call set_flow_ic_common(u, v, w, p, coef, gs)
 
  end subroutine set_flow_ic_usr
 
  subroutine set_compressible_flow_ic_usr(rho, u, v, w, p, coef, gs, &
       user_proc, scheme_name)
    type(field_t), target, intent(inout) :: rho
    type(field_t), target, intent(inout) :: u
    type(field_t), target, intent(inout) :: v
    type(field_t), target, intent(inout) :: w
    type(field_t), target, intent(inout) :: p
    type(coef_t), intent(in) :: coef
    type(gs_t), intent(inout) :: gs
    procedure(user_initial_conditions_intf) :: user_proc
    character(len=*), intent(in) :: scheme_name
    integer :: n
    type(field_list_t) :: fields
 
 
    call neko_log%message("Type: user (compressible flows)")
 
    call fields%init(5)
    call fields%assign_to_field(1, rho)
    call fields%assign_to_field(2, u)
    call fields%assign_to_field(3, v)
    call fields%assign_to_field(4, w)
    call fields%assign_to_field(5, p)
    call user_proc(scheme_name, fields)
 
    call set_flow_ic_common(u, v, w, p, coef, gs)
 
    n = u%dof%size()
 
    if (neko_bcknd_device .eq. 1) then
       call device_memcpy(p%x, p%x_d, n, host_to_device, sync = .false.)
       call device_memcpy(rho%x, rho%x_d, n, host_to_device, sync = .false.)
    end if
 
    ! Ensure continuity across elements for initial conditions
    ! These variables are not treated in the common constructor
    call gs%op(p%x, p%dof%size(), gs_op_add)
    call gs%op(rho%x, rho%dof%size(), gs_op_add)
 
    if (neko_bcknd_device .eq. 1) then
       call device_col2(rho%x_d, coef%mult_d, rho%dof%size())
       call device_col2(p%x_d, coef%mult_d, p%dof%size())
    else
       call col2(rho%x, coef%mult, rho%dof%size())
       call col2(p%x, coef%mult, p%dof%size())
    end if
 
  end subroutine set_compressible_flow_ic_usr
 
  subroutine set_flow_ic_common(u, v, w, p, coef, gs)
    type(field_t), intent(inout) :: u
    type(field_t), intent(inout) :: v
    type(field_t), intent(inout) :: w
    type(field_t), intent(inout) :: p
    type(coef_t), intent(in) :: coef
    type(gs_t), intent(inout) :: gs
    integer :: n
 
    n = u%dof%size()
 
    if (neko_bcknd_device .eq. 1) then
       call device_memcpy(u%x, u%x_d, n, &
            host_to_device, sync = .false.)
       call device_memcpy(v%x, v%x_d, n, &
            host_to_device, sync = .false.)
       call device_memcpy(w%x, w%x_d, n, &
            host_to_device, sync = .false.)
    end if
 
    ! Ensure continuity across elements for initial conditions
    call rotate_cyc(u%x, v%x, w%x, 1, coef)
    call gs%op(u%x, u%dof%size(), gs_op_add)
    call gs%op(v%x, v%dof%size(), gs_op_add)
    call gs%op(w%x, w%dof%size(), gs_op_add)
    call rotate_cyc(u%x, v%x, w%x, 0, coef)
 
    if (neko_bcknd_device .eq. 1) then
       call device_col2(u%x_d, coef%mult_d, u%dof%size())
       call device_col2(v%x_d, coef%mult_d, v%dof%size())
       call device_col2(w%x_d, coef%mult_d, w%dof%size())
    else
       call col2(u%x, coef%mult, u%dof%size())
       call col2(v%x, coef%mult, v%dof%size())
       call col2(w%x, coef%mult, w%dof%size())
    end if
 
  end subroutine set_flow_ic_common
 
  subroutine set_flow_ic_uniform(u, v, w, uinf)
    type(field_t), intent(inout) :: u
    type(field_t), intent(inout) :: v
    type(field_t), intent(inout) :: w
    real(kind=rp), intent(in) :: uinf(3)
    integer :: n, i
    character(len=LOG_SIZE) :: log_buf
 
    call neko_log%message("Type : uniform")
    write (log_buf, '(A, 3(ES12.6, A))') "Value: [", (uinf(i), ", ", i=1, 2), &
         uinf(3), "]"
    call neko_log%message(log_buf)
 
    u = uinf(1)
    v = uinf(2)
    w = uinf(3)
    n = u%dof%size()
    if (neko_bcknd_device .eq. 1) then
       call cfill(u%x, uinf(1), n)
       call cfill(v%x, uinf(2), n)
       call cfill(w%x, uinf(3), n)
    end if
 
  end subroutine set_flow_ic_uniform
 
  subroutine set_flow_ic_blasius(u, v, w, delta, uinf, type)
    type(field_t), intent(inout) :: u
    type(field_t), intent(inout) :: v
    type(field_t), intent(inout) :: w
    real(kind=rp), intent(in) :: delta
    real(kind=rp), intent(in) :: uinf(3)
    character(len=*), intent(in) :: type
    procedure(blasius_profile), pointer :: bla => null()
    integer :: i
    character(len=LOG_SIZE) :: log_buf
 
    call neko_log%message("Type         : blasius")
    write (log_buf, '(A,ES12.6)') "delta        : ", delta
    call neko_log%message(log_buf)
    call neko_log%message("Approximation : " // trim(type))
    write (log_buf, '(A,"[",2(ES12.6,","),ES12.6,"]")') "Value         : ", &
         uinf(1), uinf(2), uinf(3)
    call neko_log%message(log_buf)
 
    select case (trim(type))
    case ('linear')
       bla => blasius_linear
    case ('quadratic')
       bla => blasius_quadratic
    case ('cubic')
       bla => blasius_cubic
    case ('quartic')
       bla => blasius_quartic
    case ('sin')
       bla => blasius_sin
    case ('tanh')
       bla => blasius_tanh
    case default
       call neko_error('Invalid Blasius approximation')
    end select
 
    if ((uinf(1) .gt. 0.0_rp) .and. abscmp(uinf(2), 0.0_rp) &
         .and. abscmp(uinf(3), 0.0_rp)) then
       do i = 1, u%dof%size()
          u%x(i,1,1,1) = bla(u%dof%z(i,1,1,1), delta, uinf(1))
          v%x(i,1,1,1) = 0.0_rp
          w%x(i,1,1,1) = 0.0_rp
       end do
    else if (abscmp(uinf(1), 0.0_rp) .and. (uinf(2) .gt. 0.0_rp) &
         .and. abscmp(uinf(3), 0.0_rp)) then
       do i = 1, u%dof%size()
          u%x(i,1,1,1) = 0.0_rp
          v%x(i,1,1,1) = bla(u%dof%x(i,1,1,1), delta, uinf(2))
          w%x(i,1,1,1) = 0.0_rp
       end do
    else if (abscmp(uinf(1), 0.0_rp) .and. abscmp(uinf(2), 0.0_rp) &
         .and. (uinf(3) .gt. 0.0_rp)) then
       do i = 1, u%dof%size()
          u%x(i,1,1,1) = 0.0_rp
          v%x(i,1,1,1) = 0.0_rp
          w%x(i,1,1,1) = bla(u%dof%y(i,1,1,1), delta, uinf(3))
       end do
    end if
 
  end subroutine set_flow_ic_blasius
 
  subroutine set_flow_ic_point_zone(u, v, w, base_value, zone_name, zone_value)
    type(field_t), intent(inout) :: u
    type(field_t), intent(inout) :: v
    type(field_t), intent(inout) :: w
    real(kind=rp), intent(in), dimension(3) :: base_value
    character(len=*), intent(in) :: zone_name
    real(kind=rp), intent(in) :: zone_value(:)
    character(len=LOG_SIZE) :: log_buf
 
    ! Internal variables
    class(point_zone_t), pointer :: zone
    integer :: size
 
    call neko_log%message("Type       : point_zone")
    write (log_buf, '(A,ES12.6)') "Base value : ", base_value
    call neko_log%message(log_buf)
    call neko_log%message("Zone name : " // trim(zone_name))
    write (log_buf, '(A,"[",2(ES12.6,","),ES12.6," ]")') "Value      : ", &
         zone_value(1), zone_value(2), zone_value(3)
    call neko_log%message(log_buf)
 
    call set_flow_ic_uniform(u, v, w, base_value)
    size = u%dof%size()
 
    zone => neko_point_zone_registry%get_point_zone(trim(zone_name))
 
    call cfill_mask(u%x, zone_value(1), size, zone%mask%get(), zone%size)
    call cfill_mask(v%x, zone_value(2), size, zone%mask%get(), zone%size)
    call cfill_mask(w%x, zone_value(3), size, zone%mask%get(), zone%size)
 
  end subroutine set_flow_ic_point_zone
 
  subroutine set_flow_ic_fld(u, v, w, p, file_name, &
       interpolate, tolerance, mesh_file_name)
    type(field_t), intent(inout) :: u
    type(field_t), intent(inout) :: v
    type(field_t), intent(inout) :: w
    type(field_t), intent(inout) :: p
    character(len=*), intent(in) :: file_name
    logical, intent(in) :: interpolate
    real(kind=rp), intent(in) :: tolerance
    character(len=*), intent(inout) :: mesh_file_name
 
    character(len=LOG_SIZE) :: log_buf
    integer :: sample_idx, sample_mesh_idx
    integer :: last_index
    type(fld_file_data_t) :: fld_data
    type(file_t) :: f
    logical :: mesh_mismatch
 
    ! ---- For the mesh to mesh interpolation
    type(global_interpolation_t) :: global_interp
    ! -----
 
    ! ---- For space to space interpolation
    type(space_t) :: prev_xh
    type(interpolator_t) :: space_interp
    ! ----
 
    call neko_log%message("Type          : field")
    call neko_log%message("File name     : " // trim(file_name))
    write (log_buf, '(A,L1)') "Interpolation : ", interpolate
    call neko_log%message(log_buf)
    if (interpolate) then
    end if
 
    ! Extract sample index from the file name
    sample_idx = extract_fld_file_index(file_name, -1)
 
    if (sample_idx .eq. -1) &
         call neko_error("Invalid file name for the initial condition. The&
    & file format must be e.g. 'mean0.f00001'")
 
    ! Change from "field0.f000*" to "field0.fld" for the fld reader
    call filename_chsuffix(file_name, file_name, 'fld')
 
    call fld_data%init
    call f%init(trim(file_name))
 
    if (interpolate) then
 
       ! If no mesh file is specified, use the default file name
       if (mesh_file_name .eq. "none") then
          mesh_file_name = trim(file_name)
          sample_mesh_idx = sample_idx
       else
 
          ! Extract sample index from the mesh file name
          sample_mesh_idx = extract_fld_file_index(mesh_file_name, -1)
 
          if (sample_mesh_idx .eq. -1) then
             call neko_error("Invalid file name for the initial condition. &
             &The file format must be e.g. 'mean0.f00001'")
          end if
 
          write (log_buf, '(A,ES12.6)') "Tolerance     : ", tolerance
          call neko_log%message(log_buf)
          write (log_buf, '(A,A)') "Mesh file     : ", &
               trim(mesh_file_name)
          call neko_log%message(log_buf)
 
       end if ! if mesh_file_name .eq. none
 
       ! Read the mesh coordinates if they are not in our fld file
       if (sample_mesh_idx .ne. sample_idx) then
          call f%set_counter(sample_mesh_idx)
          call f%read(fld_data)
       end if
 
    end if
 
    ! Read the field file containing (u,v,w,p)
    call f%set_counter(sample_idx)
    call f%read(fld_data)
 
    !
    ! Check that the data in the fld file matches the current case.
    ! Note that this is a safeguard and there are corner cases where
    ! two different meshes have the same dimension and same # of elements
    ! but this should be enough to cover obvious cases.
    !
    mesh_mismatch = (fld_data%glb_nelv .ne. u%msh%glb_nelv .or. &
         fld_data%gdim .ne. u%msh%gdim)
 
    if (mesh_mismatch .and. .not. interpolate) then
       call neko_error("The fld file must match the current mesh! &
       &Use 'interpolate': 'true' to enable interpolation.")
    else if (.not. mesh_mismatch .and. interpolate) then
       call neko_log%warning("You have activated interpolation but you might &
       &still be using the same mesh.")
    end if
 
    ! Mesh interpolation if specified
    if (interpolate) then
 
       ! Issue a warning if the mesh is in single precision
       select type (ft => f%file_type)
       type is (fld_file_t)
          if (.not. ft%dp_precision) then
             call neko_warning("The coordinates read from the field file are &
             &in single precision.")
             call neko_log%message("It is recommended to use a mesh in double &
             &precision for better interpolation results.")
             call neko_log%message("If the interpolation does not work, you&
             &can try to increase the tolerance.")
          end if
       class default
       end select
 
       ! Sync coordinates to device for the interpolation
       if (neko_bcknd_device .eq. 1) then
          call device_memcpy(fld_data%x%x, fld_data%x%x_d, fld_data%x%size(),&
               host_to_device, sync=.false.)
          call device_memcpy(fld_data%y%x, fld_data%y%x_d, fld_data%y%size(),&
               host_to_device, sync=.false.)
          call device_memcpy(fld_data%z%x, fld_data%z%x_d, fld_data%z%size(),&
               host_to_device, sync=.true.)
       end if
 
       ! Generates an interpolator object and performs the point search
       call fld_data%generate_interpolator(global_interp, u%dof, u%msh, &
            tolerance)
       call fld_data%u%copy_from(host_to_device, .true.)
       call fld_data%v%copy_from(host_to_device, .true.)
       call fld_data%w%copy_from(host_to_device, .true.)
       call fld_data%p%copy_from(host_to_device, .true.)
       ! Evaluate velocities and pressure
 
       call global_interp%evaluate(u%x(:,1,1,1), fld_data%u%x, .false.)
       call global_interp%evaluate(v%x(:,1,1,1), fld_data%v%x, .false.)
       call global_interp%evaluate(w%x(:,1,1,1), fld_data%w%x, .false.)
       call global_interp%evaluate(p%x(:,1,1,1), fld_data%p%x, .false.)
       call u%copy_from(device_to_host, .true.)
       call v%copy_from(device_to_host, .true.)
       call w%copy_from(device_to_host, .true.)
       call p%copy_from(device_to_host, .true.)
 
       call global_interp%free
 
    else ! No interpolation, but potentially just from different spaces
 
       ! Build a space_t object from the data in the fld file
       call prev_xh%init(gll, fld_data%lx, fld_data%ly, fld_data%lz)
       call space_interp%init(u%Xh, prev_xh)
 
       ! Do the space-to-space interpolation
       call space_interp%map_host(u%x, fld_data%u%x, fld_data%nelv, u%Xh)
       call space_interp%map_host(v%x, fld_data%v%x, fld_data%nelv, u%Xh)
       call space_interp%map_host(w%x, fld_data%w%x, fld_data%nelv, u%Xh)
       call space_interp%map_host(p%x, fld_data%p%x, fld_data%nelv, u%Xh)
 
       call space_interp%free
 
    end if
 
    ! NOTE: we do not copy (u,v,w) to the GPU since `set_flow_ic_common` does
    ! the copy for us
    if (neko_bcknd_device .eq. 1) call device_memcpy(p%x, p%x_d, p%dof%size(), &
         host_to_device, sync = .false.)
 
    call fld_data%free
    call prev_xh%free()
 
  end subroutine set_flow_ic_fld
 
end module flow_ic