base_functional.f90

! 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.
 
module base_functional
  use design, only: design_t
  use json_module, only: json_file
  use json_utils, only: json_get
  use num_types, only: rp
  use point_zone, only: point_zone_t
  use simulation_m, only: simulation_t
  use vector, only: vector_t
  use utils, only: neko_error
  implicit none
  private
 
  type, abstract, public :: base_functional_t
 
     real(kind=rp) :: value
     type(vector_t) :: sensitivity
     character(len=25) :: name
     logical :: has_mask
     class(point_zone_t), pointer :: mask => null()
 
   contains
 
     ! ----------------------------------------------------------------------- !
     ! Derived class interfaces
 
     generic :: init => init_json, init_json_sim
 
     procedure, pass(this) :: init_json => functional_init_json
     procedure, pass(this) :: init_json_sim => functional_init_json_sim
     procedure(functional_free), pass(this), deferred :: free
 
     procedure(functional_update_value), pass(this), deferred :: update_value
     procedure(functional_update_sensitivity), pass(this), deferred :: &
          update_sensitivity
 
     procedure, pass(this) :: get_value => functional_get_value
     procedure, pass(this) :: get_sensitivity => functional_get_sensitivity
 
  end type base_functional_t
 
  ! -------------------------------------------------------------------------- !
  ! Interface specifications for the derived types, these are the constructors
  ! for the different types of objective functions.
 
  abstract interface
 
     subroutine functional_free(this)
       import base_functional_t
       class(base_functional_t), intent(inout) :: this
     end subroutine functional_free
 
     subroutine functional_update_value(this, design)
       import base_functional_t, design_t
       class(base_functional_t), intent(inout) :: this
       class(design_t), intent(in) :: design
     end subroutine functional_update_value
 
     subroutine functional_update_sensitivity(this, design)
       import base_functional_t, design_t
       class(base_functional_t), intent(inout) :: this
       class(design_t), intent(in) :: design
     end subroutine functional_update_sensitivity
 
  end interface
 
contains
 
  subroutine functional_init_json(this, json, design)
    class(base_functional_t), intent(inout) :: this
    type(json_file), intent(inout) :: json
    class(design_t), intent(in) :: design
    character(len=:), allocatable :: type
 
    call json_get(json, 'type', type)
    call neko_error("Functional type: '" // type // &
         "' does not support initialization without simulation")
  end subroutine functional_init_json
 
  subroutine functional_init_json_sim(this, json, design, simulation)
    class(base_functional_t), intent(inout) :: this
    type(json_file), intent(inout) :: json
    class(design_t), intent(in) :: design
    type(simulation_t), target, intent(inout) :: simulation
    character(len=:), allocatable :: type
 
    call json_get(json, 'type', type)
    call neko_error("Functional type: '" // type // &
         "' does not support initialization with simulation")
  end subroutine functional_init_json_sim
 
 
  function functional_get_value(this) result(v)
    class(base_functional_t), intent(in) :: this
    real(kind=rp) :: v
 
    v = this%value
  end function functional_get_value
 
  subroutine functional_get_sensitivity(this, sensitivity)
    class(base_functional_t), intent(in) :: this
    type(vector_t), intent(inout) :: sensitivity
 
    sensitivity = this%sensitivity
  end subroutine functional_get_sensitivity
end module base_functional