simulation_component_fctry.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.
!
!
submodule(simulation_component) simulation_component_fctry
  use boundary_operation, only : boundary_operation_t
  use boundary_flux, only : boundary_flux_t
  use force_torque, only : force_torque_t
  use fluid_stats_simcomp, only : fluid_stats_simcomp_t
  use fluid_sgs_stats_simcomp, only : fluid_sgs_stats_simcomp_t
  use lpt_simcomp, only : lpt_simcomp_t
  use scalar_stats_simcomp, only : scalar_stats_simcomp_t
  use scalar_sgs_stats_simcomp, only : scalar_sgs_stats_simcomp_t
  use spatial_average, only : spatial_average_t
  use user_stats, only : user_stats_t
  use lambda2, only : lambda2_t
  use probes, only : probes_t
  use les_simcomp, only : les_simcomp_t
  use utils, only : concat_string_array, neko_error
  use field_writer, only : field_writer_t
  use curl_simcomp, only : curl_t
  use weak_gradient_simcomp, only : weak_gradient_t
  use gradient_simcomp, only : gradient_t
  use divergence_simcomp, only : divergence_t
  use derivative_simcomp, only : derivative_t
  use spectral_error, only : spectral_error_t
  use data_streamer_simcomp, only : data_streamer_simcomp_t
  use field_subsampler, only : field_subsampler_t
  use utils, only : neko_type_error, neko_type_registration_error
  implicit none
 
  ! List of all possible types created by the factory routine
  character(len=20) :: SIMCOMPS_KNOWN_TYPES(22) = [character(len=20) :: &
       "boundary_operation", &
       "boundary_flux", &
       "lagrangian_particles", &
       "lambda2", &
       "probes", &
       "les_model", &
       "field_writer", &
       "fluid_stats", &
       "fluid_sgs_stats", &
       "scalar_stats", &
       "scalar_sgs_stats", &
       "gradient", &
       "divergence", &
       "curl", &
       "derivative", &
       "weak_gradient", &
       "force_torque", &
       "spatial_average", &
       "user_stats", &
       "spectral_error", &
       "data_streamer", &
       "field_subsampler"]
 
contains
 
  module subroutine simulation_component_factory(object, json, case)
    class(simulation_component_t), allocatable, intent(inout) :: object
    type(json_file), intent(inout) :: json
    class(case_t), intent(inout), target :: case
    character(len=:), allocatable :: type_name
    character(len=:), allocatable :: type_string
    logical :: is_user
 
    ! Check if this is a user-defined component
    call json_get_or_default(json, "is_user", is_user, .false.)
    if (is_user) return
 
    ! Get the type name
    call json_get(json, "type", type_name)
 
    ! Allocate
    call simulation_component_allocator(object, type_name)
 
    ! Initialize
    call object%init(json, case)
 
  end subroutine simulation_component_factory
 
  module subroutine simulation_component_allocator(object, type_name)
    class(simulation_component_t), allocatable, intent(inout) :: object
    character(len=*), intent(in):: type_name
    integer :: i
 
    if (allocated(object)) then
       call object%free()
       deallocate(object)
    end if
 
    select case (trim(type_name))
    case ("boundary_operation")
       allocate(boundary_operation_t::object)
    case ("boundary_flux")
       allocate(boundary_flux_t::object)
    case ("lagrangian_particles")
       allocate(lpt_simcomp_t::object)
    case ("lambda2")
       allocate(lambda2_t::object)
    case ("probes")
       allocate(probes_t::object)
    case ("les_model")
       allocate(les_simcomp_t::object)
    case ("field_writer")
       allocate(field_writer_t::object)
    case ("weak_gradient")
       allocate(weak_gradient_t::object)
    case ("gradient")
       allocate(gradient_t::object)
    case ("derivative")
       allocate(derivative_t::object)
    case ("curl")
       allocate(curl_t::object)
    case ("divergence")
       allocate(divergence_t::object)
    case ("force_torque")
       allocate(force_torque_t::object)
    case ("spatial_average")
       allocate(spatial_average_t::object)
    case ("fluid_stats")
       allocate(fluid_stats_simcomp_t::object)
    case ("fluid_sgs_stats")
       allocate(fluid_sgs_stats_simcomp_t::object)
    case ("scalar_stats")
       allocate(scalar_stats_simcomp_t::object)
    case ("scalar_sgs_stats")
       allocate(scalar_sgs_stats_simcomp_t::object)
    case ("user_stats")
       allocate(user_stats_t::object)
    case ("spectral_error")
       allocate(spectral_error_t::object)
    case ("data_streamer")
       allocate(data_streamer_simcomp_t::object)
    case ("field_subsampler")
       allocate(field_subsampler_t::object)
    case default
       do i = 1, simcomp_registry_size
          if (trim(type_name) == &
               trim(simcomp_registry(i)%type_name)) then
             call simcomp_registry(i)%allocator(object)
             return
          end if
       end do
       call neko_type_error("simulation component", trim(type_name), &
            simcomps_known_types)
    end select
 
  end subroutine simulation_component_allocator
 
  module subroutine register_simulation_component(type_name, allocator)
    character(len=*), intent(in) :: type_name
    procedure(simulation_component_allocate), pointer, intent(in) :: allocator
    type(allocator_entry), allocatable :: temp(:)
    integer :: i
 
    do i = 1, size(simcomps_known_types)
       if (trim(type_name) .eq. trim(simcomps_known_types(i))) then
          call neko_type_registration_error("simulation component", type_name, &
               .true.)
       end if
    end do
 
    do i = 1, simcomp_registry_size
       if (trim(type_name) .eq. &
            trim(simcomp_registry(i)%type_name)) then
          call neko_type_registration_error("simulation component", type_name, &
               .false.)
       end if
    end do
 
    ! Expand registry
    if (simcomp_registry_size == 0) then
       allocate(simcomp_registry(1))
    else
       allocate(temp(simcomp_registry_size + 1))
       temp(1:simcomp_registry_size) = simcomp_registry
       call move_alloc(temp, simcomp_registry)
    end if
 
    simcomp_registry_size = simcomp_registry_size + 1
    simcomp_registry(simcomp_registry_size)%type_name = type_name
    simcomp_registry(simcomp_registry_size)%allocator => allocator
  end subroutine register_simulation_component
 
end submodule simulation_component_fctry