simulation_component_fctry.f90

Go to the documentation of this file.

! Copyright (c) 2024, 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 vorticity, only : vorticity_t
  use force_torque, only : force_torque_t
  use fluid_stats_simcomp, only : fluid_stats_simcomp_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 weak_grad, only : weak_grad_t
  use derivative, only : derivative_t
  use spectral_error, only: spectral_error_t
 
  ! List of all possible types created by the factory routine
  character(len=20) :: SIMCOMPS_KNOWN_TYPES(8) = [character(len=20) :: &
     "vorticity", &
     "lambda2", &
     "probes", &
     "les_model", &
     "field_writer", &
     "fluid_stats", &
     "force_torque", &
     "spectral_error"]
 
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
 
    call json_get(json, "type", type_name)
 
    if (trim(type_name) .eq. "vorticity") then
       allocate(vorticity_t::object)
    else if (trim(type_name) .eq. "lambda2") then
       allocate(lambda2_t::object)
    else if (trim(type_name) .eq. "probes") then
       allocate(probes_t::object)
    else if (trim(type_name) .eq. "les_model") then
       allocate(les_simcomp_t::object)
    else if (trim(type_name) .eq. "field_writer") then
       allocate(field_writer_t::object)
    else if (trim(type_name) .eq. "weak_grad") then
       allocate(weak_grad_t::object)
    else if (trim(type_name) .eq. "derivative") then
       allocate(derivative_t::object)
    else if (trim(type_name) .eq. "force_torque") then
       allocate(force_torque_t::object)
    else if (trim(type_name) .eq. "fluid_stats") then
       allocate(fluid_stats_simcomp_t::object)
    else if (trim(type_name) .eq. "spectral_error") then
       allocate(spectral_error_t::object)
    else
       type_string =  concat_string_array(simcomps_known_types, &
            new_line('A') // "-  ",  .true.)
       call neko_error("Unknown simulation component type: " &
                       // trim(type_name) // ".  Known types are: " &
                       // type_string)
       stop
    end if
 
    ! Initialize
    call object%init(json, case)
 
  end subroutine simulation_component_factory
 
 
end submodule simulation_component_fctry