objective_factory.f90

! Copyright (c) 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.
 
submodule(objective) objective_factory_mod
  use json_utils, only: json_get
  use utils, only: neko_type_error
 
  ! Import the objective function types
  use minimum_dissipation_objective, only: minimum_dissipation_objective_t
  use lube_term_objective, only: lube_term_objective_t
  use scalar_mixing_objective, only: scalar_mixing_objective_t
 
  implicit none
 
  character(len=25), parameter :: KNOWN_TYPES(3) = [ character(len=25) :: &
       "minimum_dissipation", &
       "scalar_mixing", &
       "lube_term"]
 
contains
 
  ! -------------------------------------------------------------------------- !
  ! Factory function
 
  module subroutine objective_factory(object, json, design, simulation)
    class(objective_t), allocatable, intent(inout) :: object
    type(json_file), intent(inout) :: json
    class(design_t), intent(in) :: design
    type(simulation_t), target, optional, intent(inout) :: simulation
    character(len=:), allocatable :: type
 
    if (allocated(object)) then
       call object%free()
       deallocate(object)
    end if
 
    call json_get(json, "type", type)
    select case (trim(type))
    case ("minimum_dissipation")
       allocate(minimum_dissipation_objective_t::object)
    case ("scalar_mixing")
       allocate(scalar_mixing_objective_t::object)
    case ("lube_term")
       allocate(lube_term_objective_t::object)
 
    case default
       call neko_type_error("Objective", type, KNOWN_TYPES)
    end select
 
    call object%init(json, design, simulation)
  end subroutine objective_factory
 
end submodule objective_factory_mod