scalar_stats_simcomp.f90

Go to the documentation of this file.

! Copyright (c) 2025-2026, 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_stats_simcomp
  use num_types, only : rp, dp, sp
  use json_module, only : json_file
  use simulation_component, only : simulation_component_t
  use registry, only : neko_registry
  use time_state, only : time_state_t
  use field, only : field_t
  use scalar_stats, only : scalar_stats_t
  use scalar_stats_output, only : scalar_stats_output_t
  use case, only : case_t
  use coefs, only : coef_t
  use utils, only : neko_fname_len, filename_suffix, filename_tslash_pos, &
       neko_varname_len
  use logger, only : log_size, neko_log
  use json_utils, only : json_get, json_get_or_default, &
       json_get_or_lookup_or_default
  use comm, only : neko_comm
  use mpi_f08, only : mpi_wtime, mpi_barrier
  implicit none
  private
 
  type, public, extends(simulation_component_t) :: scalar_stats_simcomp_t
     type(scalar_stats_t) :: stats
     type(scalar_stats_output_t) :: stats_output
     real(kind=rp) :: start_time
     real(kind=rp) :: time
     logical :: default_fname = .true.
 
   contains
     procedure, pass(this) :: init => scalar_stats_simcomp_init_from_json
     procedure, pass(this) :: init_from_components => &
          scalar_stats_simcomp_init_from_components
     procedure, pass(this) :: free => scalar_stats_simcomp_free
     procedure, pass(this) :: compute_ => scalar_stats_simcomp_compute
     procedure, pass(this) :: output_ => scalar_stats_simcomp_compute
     procedure, pass(this) :: restart_ => scalar_stats_simcomp_restart
  end type scalar_stats_simcomp_t
 
contains
 
  subroutine scalar_stats_simcomp_init_from_json(this, json, case)
    class(scalar_stats_simcomp_t), target, intent(inout) :: this
    type(json_file), intent(inout) :: json
    class(case_t), intent(inout), target :: case
    character(len=:), allocatable :: filename
    character(len=NEKO_VARNAME_LEN), allocatable :: fields(:)
    character(len=:), allocatable :: hom_dir
    character(len=:), allocatable :: stat_set
    character(len=:), allocatable :: sname
    character(len=:), allocatable :: name
    real(kind=rp) :: start_time
    type(field_t), pointer :: s, u, v, w, p
    type(coef_t), pointer :: coef
    logical :: sname_provided
 
    sname_provided = json%valid_path('field')
 
    call json_get_or_default(json, 'field', &
         sname, 's')
    if (sname_provided) then
       call json_get_or_default(json, "name", &
            name, "scalar_stats_" // trim(sname))
    else
       call json_get_or_default(json, "name", &
            name, "scalar_stats")
    end if
    call this%init_base(json, case)
    call json_get_or_default(json, 'avg_direction', &
         hom_dir, 'none')
    call json_get_or_lookup_or_default(json, 'start_time', &
         start_time, 0.0_rp)
    call json_get_or_default(json, 'set_of_stats', &
         stat_set, 'full')
 
    s => neko_registry%get_field_by_name(sname)
    u => neko_registry%get_field("u")
    v => neko_registry%get_field("v")
    w => neko_registry%get_field("w")
    p => neko_registry%get_field("p")
    coef => case%fluid%c_Xh
    this%name = name
 
    if (json%valid_path("output_filename")) then
       call json_get(json, "output_filename", filename)
       call scalar_stats_simcomp_init_from_components(this, name, s, u, v, w, &
            p, coef, start_time, hom_dir, stat_set, filename)
    else if (sname_provided) then
       call scalar_stats_simcomp_init_from_components(this, name, s, u, v, w, &
            p, coef, start_time, hom_dir, stat_set, "scalar_stats_" // &
            trim(sname) // "0")
    else
       call scalar_stats_simcomp_init_from_components(this, name, s, u, v, w, &
            p, coef, start_time, hom_dir, stat_set)
    end if
 
  end subroutine scalar_stats_simcomp_init_from_json
 
  subroutine scalar_stats_simcomp_init_from_components(this, name, s, u, v, w, &
       p, coef, start_time, hom_dir, stat_set, fname)
    class(scalar_stats_simcomp_t), target, intent(inout) :: this
    character(len=*), intent(in) :: name
    character(len=*), intent(in) :: hom_dir
    character(len=*), intent(in) :: stat_set
    real(kind=rp), intent(in) :: start_time
    type(field_t), intent(in), target :: s, u, v, w, p
    type(coef_t), intent(in), target :: coef
    character(len=*), intent(in), optional :: fname
    character(len=NEKO_FNAME_LEN) :: stats_fname
    character(len=LOG_SIZE) :: log_buf
    character(len=5) :: prefix
 
    this%name = name
    call neko_log%section('Scalar stats')
    write(log_buf, '(A,A)') 'Scalar field: ', trim(s%name)
    call neko_log%message(log_buf)
    write(log_buf, '(A,E15.7)') 'Start time: ', start_time
    call neko_log%message(log_buf)
    write(log_buf, '(A,A)') 'Set of statistics: ', trim(stat_set)
    call neko_log%message(log_buf)
    write(log_buf, '(A,A)') 'Averaging in direction: ', trim(hom_dir)
    call neko_log%message(log_buf)
 
 
    call this%stats%init(coef, s, u, v, w, p, stat_set, name)
 
    this%start_time = start_time
    this%time = start_time
    if (present(fname)) then
       this%default_fname = .false.
       stats_fname = fname
    else
       stats_fname = "scalar_stats0"
       this%default_fname = .true.
    end if
 
    call this%stats_output%init(this%stats, this%start_time, &
         hom_dir = hom_dir, name = stats_fname, &
         path = this%case%output_directory)
 
    call this%case%output_controller%add(this%stats_output, &
         this%output_controller%control_value, &
         this%output_controller%control_mode)
 
    call neko_log%end_section()
 
  end subroutine scalar_stats_simcomp_init_from_components
 
  subroutine scalar_stats_simcomp_free(this)
    class(scalar_stats_simcomp_t), intent(inout) :: this
    call this%free_base()
    call this%stats%free()
  end subroutine scalar_stats_simcomp_free
 
  subroutine scalar_stats_simcomp_restart(this, time)
    class(scalar_stats_simcomp_t), intent(inout) :: this
    type(time_state_t), intent(in) :: time
    character(len=NEKO_FNAME_LEN) :: fname
    character(len=5) :: prefix, suffix
    integer :: last_slash_pos
    real(kind=rp) :: t
    t = time%t
    if (t .gt. this%time) this%time = t
    if (this%default_fname) then
       fname = this%stats_output%file_%get_base_fname()
       write (prefix, '(I5)') this%stats_output%file_%get_counter()
       call filename_suffix(fname, suffix)
       last_slash_pos = &
            filename_tslash_pos(fname)
       if (last_slash_pos .ne. 0) then
          fname = &
               trim(fname(1:last_slash_pos))// &
               "scalar_stats"//trim(adjustl(prefix))//"."//suffix
       else
          fname = "scalar_stats"// &
               trim(adjustl(prefix))//"."//suffix
       end if
       call this%stats_output%init_base(fname)
    end if
  end subroutine scalar_stats_simcomp_restart
 
  subroutine scalar_stats_simcomp_compute(this, time)
    class(scalar_stats_simcomp_t), intent(inout) :: this
    type(time_state_t), intent(in) :: time
    real(kind=rp) :: delta_t, t
    real(kind=rp) :: sample_start_time, sample_time
    character(len=LOG_SIZE) :: log_buf
    integer :: ierr
 
    if (time%start_time .gt. this%start_time) then
       write(log_buf, '(A)') 'Simulation start time is later than the ' &
            // 'scalar stats start time.'
       call neko_log%warning(log_buf)
       write(log_buf, '(A,E15.7)') 'Simulation start time:', time%start_time
       call neko_log%warning(log_buf)
       write(log_buf, '(A,E15.7)') 'Scalar stats start time:', this%start_time
       call neko_log%warning(log_buf)
       write(log_buf, '(A)') 'Assigning the statistics start time to ' &
            // 'the simulation start time.'
       call neko_log%warning(log_buf)
       this%start_time = time%start_time
       this%time = time%start_time
    end if
 
    t = time%t
 
    if (t .ge. this%start_time) then
       delta_t = t - this%time !This is only a real number
 
       call mpi_barrier(neko_comm, ierr)
 
       sample_start_time = mpi_wtime()
 
       call this%stats%update(delta_t)
       call mpi_barrier(neko_comm, ierr)
       this%time = t
 
       sample_time = mpi_wtime() - sample_start_time
 
       call neko_log%section('Scalar stats')
       write(log_buf, '(A,E15.7)') 'Sampling at time:', t
       call neko_log%message(log_buf)
       write(log_buf, '(A33,E15.7)') 'Simulationtime since last sample:', &
            delta_t
       call neko_log%message(log_buf)
       write(log_buf, '(A,E15.7)') 'Sampling time (s):', sample_time
       call neko_log%message(log_buf)
       call neko_log%end_section()
    end if
 
  end subroutine scalar_stats_simcomp_compute
 
end module scalar_stats_simcomp