scalar_sgs_stats.f90

Go to the documentation of this file.

! Copyright (c) 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_sgs_stats
  use mean_field, only : mean_field_t
  use num_types, only : rp
  use field_math, only : field_cmult, field_cmult2
  use operators, only : grad
  use coefs, only : coef_t
  use field, only : field_t
  use field_list, only : field_list_t
  use stats_quant, only : stats_quant_t
  use registry, only : neko_registry
  use scratch_registry, only : neko_scratch_registry
  implicit none
  private
 
  type, public, extends(stats_quant_t) :: scalar_sgs_stats_t
     type(field_t), pointer :: alphat => null() 
     type(field_t), pointer :: nut => null() 
     logical :: nut_dependency = .false.
     real(kind=rp) :: pr_turb 
     type(field_t), pointer :: s => null() 
 
     type(mean_field_t) :: alphat_mean
 
     type(mean_field_t) :: alphatdsdx
     type(mean_field_t) :: alphatdsdy
     type(mean_field_t) :: alphatdsdz
 
     type(field_t), pointer :: dsdx_work
     type(field_t), pointer :: dsdy_work
     type(field_t), pointer :: dsdz_work
 
     type(coef_t), pointer :: coef => null()
     integer :: n_stats = 4
     type(field_list_t) :: stat_fields
   contains
     generic :: init => init_alphat, init_nut
     procedure, pass(this) :: init_alphat => scalar_sgs_stats_init_alphat
     procedure, pass(this) :: init_nut => scalar_sgs_stats_init_nut
     procedure, pass(this) :: free => scalar_sgs_stats_free
     procedure, pass(this) :: update => scalar_sgs_stats_update
     procedure, pass(this) :: reset => scalar_sgs_stats_reset
  end type scalar_sgs_stats_t
 
contains
 
  subroutine scalar_sgs_stats_init_alphat(this, coef, s_name, alphat_field)
    class(scalar_sgs_stats_t), intent(inout), target:: this
    type(coef_t), target, optional :: coef
    character(len=*), intent(in) :: s_name
    character(len=*), intent(in) :: alphat_field
 
    call this%free()
    this%coef => coef
 
    this%s => neko_registry%get_field(s_name)
    this%alphat => neko_registry%get_field(alphat_field)
    this%nut_dependency = .false.
 
    ! Initialize mean fields. The fluxes are means of products, updated with
    ! update_col3, so the field passed to init only provides the dofmap.
    call this%alphat_mean%init(this%alphat)
 
    call this%alphatdsdx%init(this%s, trim(s_name) // 'alphatdsdx')
    call this%alphatdsdy%init(this%s, trim(s_name) // 'alphatdsdy')
    call this%alphatdsdz%init(this%s, trim(s_name) // 'alphatdsdz')
 
    allocate(this%stat_fields%items(this%n_stats))
 
    call this%stat_fields%assign_to_field(1, this%alphat_mean%mf)
    call this%stat_fields%assign_to_field(2, this%alphatdsdx%mf)
    call this%stat_fields%assign_to_field(3, this%alphatdsdy%mf)
    call this%stat_fields%assign_to_field(4, this%alphatdsdz%mf)
 
  end subroutine scalar_sgs_stats_init_alphat
 
  subroutine scalar_sgs_stats_init_nut(this, coef, s_name, nut_field, pr_turb)
    class(scalar_sgs_stats_t), intent(inout), target:: this
    type(coef_t), target, optional :: coef
    character(len=*), intent(in) :: s_name
    character(len=*), intent(in) :: nut_field
    real(kind=rp), intent(in) :: pr_turb
 
    call this%free()
    this%coef => coef
 
    this%s => neko_registry%get_field(s_name)
    this%nut => neko_registry%get_field(nut_field)
    this%pr_turb = pr_turb
    this%nut_dependency = .true.
 
    allocate(this%alphat)
    call this%alphat%init(this%nut%dof, trim(s_name) // 'alphat_temp')
 
    ! Initialize mean fields. The fluxes are means of products, updated with
    ! update_col3, so the field passed to init only provides the dofmap.
    call this%alphat_mean%init(this%alphat)
 
    call this%alphatdsdx%init(this%s, trim(s_name) // 'alphatdsdx')
    call this%alphatdsdy%init(this%s, trim(s_name) // 'alphatdsdy')
    call this%alphatdsdz%init(this%s, trim(s_name) // 'alphatdsdz')
 
    allocate(this%stat_fields%items(this%n_stats))
 
    call this%stat_fields%assign_to_field(1, this%alphat_mean%mf)
    call this%stat_fields%assign_to_field(2, this%alphatdsdx%mf)
    call this%stat_fields%assign_to_field(3, this%alphatdsdy%mf)
    call this%stat_fields%assign_to_field(4, this%alphatdsdz%mf)
 
  end subroutine scalar_sgs_stats_init_nut
 
  subroutine scalar_sgs_stats_update(this, k)
    class(scalar_sgs_stats_t), intent(inout) :: this
    real(kind=rp), intent(in) :: k
    integer :: temp_indices(3)
 
    call neko_scratch_registry%request_field(this%dsdx_work, &
         temp_indices(1), .false.)
    call neko_scratch_registry%request_field(this%dsdy_work, &
         temp_indices(2), .false.)
    call neko_scratch_registry%request_field(this%dsdz_work, &
         temp_indices(3), .false.)
 
    if (this%nut_dependency) then
       call field_cmult2(this%alphat, this%nut, 1.0_rp / this%pr_turb)
    end if
    call this%alphat_mean%update(k)
 
    call grad(this%dsdx_work%x, &
         this%dsdy_work%x, &
         this%dsdz_work%x, &
         this%s%x, this%coef)
 
    call this%alphatdsdx%update_col3(k, this%alphat, this%dsdx_work)
    call this%alphatdsdy%update_col3(k, this%alphat, this%dsdy_work)
    call this%alphatdsdz%update_col3(k, this%alphat, this%dsdz_work)
 
    call neko_scratch_registry%relinquish_field(temp_indices)
  end subroutine scalar_sgs_stats_update
 
 
  subroutine scalar_sgs_stats_free(this)
    class(scalar_sgs_stats_t), intent(inout) :: this
 
    call this%alphat_mean%free()
 
    call this%alphatdsdx%free()
    call this%alphatdsdy%free()
    call this%alphatdsdz%free()
 
    if (this%nut_dependency .and. associated(this%alphat)) then
       call this%alphat%free()
       deallocate(this%alphat)
    end if
 
    nullify(this%coef)
    nullify(this%s)
    nullify(this%alphat)
 
    call this%stat_fields%free()
 
  end subroutine scalar_sgs_stats_free
 
  subroutine scalar_sgs_stats_reset(this)
    class(scalar_sgs_stats_t), intent(inout), target:: this
 
    call this%alphat_mean%reset()
 
    call this%alphatdsdx%reset()
    call this%alphatdsdy%reset()
    call this%alphatdsdz%reset()
 
  end subroutine scalar_sgs_stats_reset
 
end module scalar_sgs_stats