mean_field_output.f90

Go to the documentation of this file.

! Copyright (c) 2020-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 mean_field_output
  use num_types, only : rp
  use field_list, only : field_list_t
  use neko_config, only : neko_bcknd_device
  use fld_file_data, only : fld_file_data_t
  use map_2d, only : map_2d_t
  use map_1d, only : map_1d_t
  use coefs, only : coef_t
  use device, only : device_to_host, device_memcpy
  use mean_field, only : mean_field_t
  use output, only : output_t
  use matrix, only : matrix_t
  implicit none
  private
 
  type, public, extends(output_t) :: mean_field_output_t
     type(mean_field_t), pointer :: mean_fields(:)
     type(field_list_t) :: fields
     real(kind=rp) :: start_time = 0.0_rp
     integer :: n_fields = 0
     type(map_1d_t) :: map_1d
     type(map_2d_t) :: map_2d
     integer :: output_dim = 0
   contains
     procedure, pass(this) :: init => mean_field_output_init
     procedure, pass(this) :: free => mean_field_output_free
     procedure, pass(this) :: sample => mean_field_output_sample
  end type mean_field_output_t
 
contains
 
  subroutine mean_field_output_init(this, mean_fields, n_fields, start_time, &
       coef, avg_dir, name, path)
    class(mean_field_output_t), intent(inout):: this
    integer, intent(in) :: n_fields
    type(mean_field_t), intent(inout), target :: mean_fields(n_fields)
    type(coef_t), intent(inout) :: coef
    character(len=*), intent(in) :: avg_dir
    character(len=*), intent(in), optional :: name
    character(len=*), intent(in), optional :: path
    real(kind=rp), intent(in) :: start_time
    character(len=1024) :: fname
    integer :: i
 
    this%start_time = start_time
 
    if (trim(avg_dir) .eq. 'none' .or. &
         trim(avg_dir) .eq. 'x' .or.&
         trim(avg_dir) .eq. 'y' .or.&
         trim(avg_dir) .eq. 'z'&
         ) then
       if (present(name) .and. present(path)) then
          fname = trim(path) // trim(name) // '.fld'
       else if (present(name)) then
          fname = trim(name) // '.fld'
       else if (present(path)) then
          fname = trim(path) // 'user_stats.fld'
       else
          fname = 'user_stats.fld'
       end if
 
       this%output_dim = 3
 
       if (trim(avg_dir) .eq. 'x' .or.&
            trim(avg_dir) .eq. 'y' .or.&
            trim(avg_dir) .eq. 'z' ) then
          call this%map_2d%init_char(coef, avg_dir, 1e-7_rp)
          this%output_dim = 2
       end if
    else
       if (present(name) .and. present(path)) then
          fname = trim(path) // trim(name) // '.csv'
       else if (present(name)) then
          fname = trim(name) // '.csv'
       else if (present(path)) then
          fname = trim(path) // 'user_stats.csv'
       else
          fname = 'user_stats.csv'
       end if
       call this%map_1d%init_char(coef, avg_dir, 1e-7_rp)
       this%output_dim = 1
    end if
 
    call this%init_base(fname)
 
    call this%fields%init(n_fields)
    this%n_fields = n_fields
    this%mean_fields => mean_fields
    do i = 1, n_fields
       this%fields%items(i)%ptr => this%mean_fields(i)%mf
    end do
 
  end subroutine mean_field_output_init
 
  subroutine mean_field_output_free(this)
    class(mean_field_output_t), intent(inout) :: this
 
    call this%free_base()
 
    nullify(this%mean_fields)
    call this%map_1d%free()
    call this%map_2d%free()
    call this%fields%free()
 
  end subroutine mean_field_output_free
 
  subroutine mean_field_output_sample(this, t)
    class(mean_field_output_t), intent(inout) :: this
    real(kind=rp), intent(in) :: t
    integer :: i
    type(fld_file_data_t) :: output_2d
    type(matrix_t) :: avg_output_1d
    real(kind=rp) :: u, v, w, p
 
    associate(out_fields => this%fields%items)
      if (t .ge. this%start_time) then
         if ( neko_bcknd_device .eq. 1) then
            do i = 1, size(out_fields)
               call device_memcpy(out_fields(i)%ptr%x, out_fields(i)%ptr%x_d,&
                    out_fields(i)%ptr%dof%size(), device_to_host, &
                    sync = (i .eq. size(out_fields))) ! Sync on last field
            end do
         end if
         if (this%output_dim .eq. 1) then
            call this%map_1d%average_planes(avg_output_1d, &
                 this%fields)
            call this%file_%write(avg_output_1d, t)
         else if (this%output_dim .eq. 2) then
            call this%map_2d%average(output_2d, this%fields)
            call this%file_%write(output_2d, t)
         else
            call this%file_%write(this%fields, t)
         end if
         do i = 1, this%n_fields
            call this%mean_fields(i)%reset()
         end do
      end if
    end associate
 
  end subroutine mean_field_output_sample
 
end module mean_field_output