scalar_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 scalar_ic
  use gather_scatter, only : gs_t, gs_op_add
  use neko_config, only : neko_bcknd_device
  use num_types, only : rp
  use device_math, only : device_col2
  use device, only : device_memcpy, host_to_device, device_to_host
  use field, only : field_t
  use utils, only : neko_error, filename_chsuffix, filename_suffix, &
       neko_warning, neko_fname_len, extract_fld_file_index
  use coefs, only : coef_t
  use math, only : col2, cfill, cfill_mask
  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 field_registry, only: neko_field_registry
  use logger, only: neko_log, log_size
  use fld_file_data, only: fld_file_data_t
  use fld_file, only: fld_file_t
  use checkpoint, only: chkp_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
  implicit none
  private
 
  interface set_scalar_ic
     module procedure set_scalar_ic_int, set_scalar_ic_usr
  end interface set_scalar_ic
 
  public :: set_scalar_ic
 
contains
 
  subroutine set_scalar_ic_int(s, coef, gs, type, params, i)
    type(field_t), intent(inout) :: s
    type(coef_t), intent(in) :: coef
    type(gs_t), intent(inout) :: gs
    character(len=*) :: type
    type(json_file), intent(inout) :: params
    integer, intent(in) :: i
 
    ! Variables for retrieving JSON parameters
    real(kind=rp) :: ic_value
    character(len=:), allocatable :: read_str
    character(len=NEKO_FNAME_LEN) :: fname, mesh_fname
    real(kind=rp) :: zone_value, tol
    logical :: interpolate
 
    if (trim(type) .eq. 'uniform') then
 
       call json_get(params, 'value', ic_value)
       call set_scalar_ic_uniform(s, ic_value)
 
    else if (trim(type) .eq. 'point_zone') then
 
       call json_get(params, 'base_value', ic_value)
       call json_get(params, 'zone_name', read_str)
       call json_get(params, 'zone_value', zone_value)
 
       call set_scalar_ic_point_zone(s, ic_value, read_str, zone_value)
 
    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_scalar_ic_fld(s, fname, interpolate, tol, mesh_fname, i)
 
    else
       call neko_error('Invalid initial condition')
    end if
 
    call set_scalar_ic_common(s, coef, gs)
 
  end subroutine set_scalar_ic_int
 
  subroutine set_scalar_ic_usr(scheme_name, s, coef, gs, user_proc)
    character(len=*), intent(in) :: scheme_name
    type(field_t), target, intent(inout) :: s
    type(coef_t), intent(in) :: coef
    type(gs_t), intent(inout) :: gs
    procedure(user_initial_conditions_intf) :: user_proc
    type(field_list_t) :: fields
 
    call neko_log%message("Type: user")
 
    call fields%init(1)
    call fields%assign_to_field(1, s)
 
    call user_proc(scheme_name, fields)
    call set_scalar_ic_common(s, coef, gs)
 
  end subroutine set_scalar_ic_usr
 
  subroutine set_scalar_ic_common(s, coef, gs)
    type(field_t), intent(inout) :: s
    type(coef_t), intent(in) :: coef
    type(gs_t), intent(inout) :: gs
    integer :: n
 
    n = s%dof%size()
    if (neko_bcknd_device .eq. 1) then
       call device_memcpy(s%x, s%x_d, n, host_to_device, sync = .false.)
    end if
 
    ! Ensure continuity across elements for initial conditions
    call gs%op(s%x, n, gs_op_add)
 
    if (neko_bcknd_device .eq. 1) then
       call device_col2(s%x_d, coef%mult_d, n)
    else
       call col2(s%x, coef%mult, n)
    end if
 
  end subroutine set_scalar_ic_common
 
  subroutine set_scalar_ic_uniform(s, ic_value)
    type(field_t), intent(inout) :: s
    real(kind=rp), intent(in) :: ic_value
    integer :: n
    character(len=LOG_SIZE) :: log_buf
 
    call neko_log%message("Type : uniform")
    write (log_buf, '(A,ES12.6)') "Value: ", ic_value
    call neko_log%message(log_buf)
 
    s = ic_value
    n = s%dof%size()
    if (neko_bcknd_device .eq. 1) then
       call cfill(s%x, ic_value, n)
    end if
 
  end subroutine set_scalar_ic_uniform
 
  subroutine set_scalar_ic_point_zone(s, base_value, zone_name, zone_value)
    type(field_t), intent(inout) :: s
    real(kind=rp), intent(in) :: base_value
    character(len=*), intent(in) :: zone_name
    real(kind=rp), intent(in) :: zone_value
 
    ! Internal variables
    character(len=LOG_SIZE) :: log_buf
    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,ES12.6)') "Zone value: ", zone_value
    call neko_log%message(log_buf)
 
    size = s%dof%size()
    zone => neko_point_zone_registry%get_point_zone(trim(zone_name))
 
    call set_scalar_ic_uniform(s, base_value)
    call cfill_mask(s%x, zone_value, size, zone%mask%get(), zone%size)
 
  end subroutine set_scalar_ic_point_zone
 
  subroutine set_scalar_ic_fld(s, file_name, &
       interpolate, tolerance, mesh_file_name, i)
    type(field_t), intent(inout) :: s
    character(len=*), intent(in) :: file_name
    logical, intent(in) :: interpolate
    real(kind=rp), intent(in) :: tolerance
    character(len=*), intent(inout) :: mesh_file_name
    integer, intent(in) :: i
 
    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)
 
    ! Extract sample index from the file name
    sample_idx = extract_fld_file_index(file_name, -1)
 
    if (sample_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
 
    ! 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. s%msh%glb_nelv .or. &
         fld_data%gdim .ne. s%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
 
       ! Copy all fld data to device since the reader loads everything on the host
       call fld_data%x%copy_from(host_to_device, .false.)
       call fld_data%y%copy_from(host_to_device, .false.)
       call fld_data%z%copy_from(host_to_device, .false.)
       call fld_data%t%copy_from(host_to_device, .true.)
 
       ! Generates an interpolator object and performs the point search
       call fld_data%generate_interpolator(global_interp, s%dof, s%msh, &
            tolerance)
 
       ! Evaluate scalar
 
       ! i == 0 means it's the temperature field
       if (i .ne. 0) then
          call global_interp%evaluate(s%x, fld_data%s(i)%x, .false.)
       else
          call global_interp%evaluate(s%x, fld_data%t%x, .false.)
       end if
 
       call global_interp%free
 
       ! Copy back to the host for set_scalar_ic_common
       call fld_data%t%copy_from(device_to_host, .true.)
 
    else ! No interpolation, just potentially 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(s%Xh, prev_xh)
 
       ! Do the space-to-space interpolation
       ! i == 0 means it's the temperature field
       if (i .ne. 0) then
          call space_interp%map_host(s%x, fld_data%s(i)%x, fld_data%nelv, s%Xh)
       else
          call space_interp%map_host(s%x, fld_data%t%x, fld_data%nelv, s%Xh)
       end if
 
       call space_interp%free
 
    end if
 
    call fld_data%free
    call prev_xh%free
 
  end subroutine set_scalar_ic_fld
 
end module scalar_ic