field_writer.f90

Go to the documentation of this file.

! Copyright (c) 2024-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 field_writer
  use num_types, only : rp, dp, sp
  use json_module, only : json_file
  use simulation_component, only : simulation_component_t
  use time_state, only : time_state_t
  use registry, only : neko_registry
  use case, only : case_t
  use point_zone_registry, only : neko_point_zone_registry
  use fld_file, only : fld_file_t
  use point_zone, only : point_zone_t
  use field_output, only : field_output_t
  use json_utils, only : json_get, json_get_or_default
  use time_based_controller, only : time_based_controller_t
  use utils, only : neko_error, neko_varname_len
  use logger, only : neko_log
  implicit none
  private
 
  type, public, extends(simulation_component_t) :: field_writer_t
     type(field_output_t), private :: output
 
     ! Default values for optional parameters in the constructor.
     character(len=20), private :: default_name = "field_writer"
     character(len=20), private :: default_precision = "single"
     character(len=20), private :: default_filename = ""
     character(len=20), private :: default_format = "nek5000"
     logical, private :: default_subdivide = .false.
 
   contains
     procedure, pass(this) :: init => field_writer_init_from_json
     generic :: init_from_components => &
          init_from_controllers, init_from_controllers_properties
     procedure, pass(this) :: init_from_controllers => &
          field_writer_init_from_controllers
     procedure, pass(this) :: init_from_controllers_properties => &
          field_writer_init_from_controllers_properties
     procedure, private, pass(this) :: init_common => field_writer_init_common
     procedure, pass(this) :: free => field_writer_free
     procedure, pass(this) :: compute_ => field_writer_compute
  end type field_writer_t
 
contains
 
  subroutine field_writer_init_from_json(this, json, case)
    class(field_writer_t), intent(inout), target :: this
    type(json_file), intent(inout) :: json
    class(case_t), intent(inout), target :: case
    character(len=:), allocatable :: filename
    character(len=:), allocatable :: name
    character(len=:), allocatable :: precision
    character(len=:), allocatable :: format
    character(len=:), allocatable :: point_zone_name
    character(len=NEKO_VARNAME_LEN), allocatable :: fields(:)
    integer :: precision_value
    logical :: subdivide
    class(point_zone_t), pointer :: point_zone
 
    call this%init_base(json, case)
    call json_get(json, "fields", fields)
    call json_get_or_default(json, "name", name, this%default_name)
    call json_get_or_default(json, "output_filename", filename, &
         this%default_filename)
    call json_get_or_default(json, "output_precision", precision, &
         this%default_precision)
    call json_get_or_default(json, "output_format", format, this%default_format)
 
    if (precision .eq. "single") then
       precision_value = sp
    else if (precision .eq. "double") then
       precision_value = dp
    else
       call neko_error("Invalid precision specified for field_writer: " &
            // trim(precision))
    end if
 
    call json_get_or_default(json, "output_subdivide", subdivide, &
         this%default_subdivide)
 
    if (json%valid_path('point_zone')) then
       call json_get(json, 'point_zone', point_zone_name)
       point_zone => neko_point_zone_registry%get_point_zone(point_zone_name)
       call this%init_common(name, fields, filename, precision_value, format, &
            subdivide, point_zone)
    else
       call this%init_common(name, fields, filename, precision_value, format, &
            subdivide)
    end if
 
  end subroutine field_writer_init_from_json
 
  subroutine field_writer_init_from_controllers(this, name, case, order, &
       preprocess_controller, compute_controller, output_controller, &
       fields, filename, precision, format, subdivide, point_zone)
    class(field_writer_t), intent(inout) :: this
    character(len=*), intent(in) :: name
    class(case_t), intent(inout), target :: case
    integer :: order
    type(time_based_controller_t), intent(in) :: preprocess_controller
    type(time_based_controller_t), intent(in) :: compute_controller
    type(time_based_controller_t), intent(in) :: output_controller
    character(len=*), intent(in) :: fields(:)
    character(len=*), intent(in), optional :: filename
    integer, intent(in), optional :: precision
    character(len=20), intent(in), optional :: format
    logical, intent(in), optional :: subdivide
    class(point_zone_t), intent(inout), optional :: point_zone
 
    call this%init_base_from_components(case, order, preprocess_controller, &
         compute_controller, output_controller)
    call this%init_common(name, fields, filename, precision, format, &
         subdivide, point_zone)
 
  end subroutine field_writer_init_from_controllers
 
  subroutine field_writer_init_from_controllers_properties(this, name, &
       case, order, preprocess_control, preprocess_value, compute_control, &
       compute_value, output_control, output_value, fields, filename, &
       precision, format, subdivide, point_zone)
    class(field_writer_t), intent(inout) :: this
    character(len=*), intent(in) :: name
    class(case_t), intent(inout), target :: case
    integer :: order
    character(len=*), intent(in) :: preprocess_control
    real(kind=rp), intent(in) :: preprocess_value
    character(len=*), intent(in) :: compute_control
    real(kind=rp), intent(in) :: compute_value
    character(len=*), intent(in) :: output_control
    real(kind=rp), intent(in) :: output_value
    character(len=*), intent(in) :: fields(:)
    character(len=*), intent(in), optional :: filename
    integer, intent(in), optional :: precision
    character(len=*), intent(in), optional :: format
    logical, intent(in), optional :: subdivide
    class(point_zone_t), intent(inout), optional :: point_zone
 
    call this%init_base_from_components(case, order, preprocess_control, &
         preprocess_value, compute_control, compute_value, output_control, &
         output_value)
    call this%init_common(name, fields, filename, precision, format, &
         subdivide, point_zone)
 
  end subroutine field_writer_init_from_controllers_properties
 
  subroutine field_writer_init_common(this, name, fields, filename, precision, &
       format, subdivide, point_zone)
    class(field_writer_t), intent(inout) :: this
    character(len=*), intent(in) :: name
    character(len=*), intent(in) :: fields(:)
    character(len=*), intent(in), optional :: filename
    integer, intent(in), optional :: precision
    character(len=*), intent(in), optional :: format
    logical, intent(in), optional :: subdivide
    class(point_zone_t), intent(inout), optional :: point_zone
 
    logical :: filename_provided
    integer :: i
 
    this%name = name
    ! Register fields if they don't exist.
    do i = 1, size(fields)
       call neko_registry%add_field(this%case%fluid%dm_Xh, trim(fields(i)), &
            ignore_existing = .true.)
    end do
 
    ! Throw an error if no output filename is provided to avoid dumping masked
    ! fields in the default fluid output.
    if (present(point_zone) .and. &
         (.not. present(filename) .or. len_trim(filename) .eq. 0 ) ) then
       call neko_error("Please provide a filename for the " // &
            "field_writer when using a point_zone with the key " // &
            "'output_filename'.")
    end if
 
    filename_provided = .false.
    if (present(filename)) then
       if (len_trim(filename) .ne. 0) then
          filename_provided = .true.
          call this%output%init(trim(filename), size(fields), &
               precision = precision, format = format, &
               path = this%case%output_directory)
 
          if (present(subdivide)) then
             call this%output%file_%set_subdivide(subdivide)
          end if
 
          do i = 1, size(fields)
             call this%output%fields%assign(i, &
                  neko_registry%get_field(trim(fields(i))))
          end do
 
          call this%case%output_controller%add(this%output, &
               this%output_controller%control_value, &
               this%output_controller%control_mode)
 
       end if
    end if
 
    if (.not. filename_provided) then
       do i = 1, size(fields)
          call this%case%f_out%fluid%append( &
               neko_registry%get_field(trim(fields(i))))
       end do
    end if
 
    !
    ! Set the mask for subsampling is a point zone is provided. Only supported
    ! for fld/nek5000 files
    !
    if (present(point_zone)) then
       select type (ft => this%output%file_%file_type)
       class is (fld_file_t)
          call ft%set_mask(point_zone%mask)
       class default
          call neko_error("point_zone can only be used with nek5000/fld files")
       end select
    end if
 
  end subroutine field_writer_init_common
 
  subroutine field_writer_free(this)
    class(field_writer_t), intent(inout) :: this
    call this%free_base()
    call this%output%free()
  end subroutine field_writer_free
 
  subroutine field_writer_compute(this, time)
    class(field_writer_t), intent(inout) :: this
    type(time_state_t), intent(in) :: time
 
  end subroutine field_writer_compute
 
end module field_writer