adjoint_fluid_scheme.f90

! Copyright (c) 2020-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 adjoint_fluid_scheme
  use bc, only: bc_t
  use gather_scatter, only: gs_t
  use mean_sqr_flow, only: mean_sqr_flow_t
  use neko_config, only: neko_bcknd_device
  use checkpoint, only: chkp_t
  use mean_flow, only: mean_flow_t
  use num_types, only: rp, i8
  use comm, only: neko_comm
  use adjoint_source_term, only: adjoint_source_term_t
  use field, only: field_t
  use space, only: space_t, gll
  use dofmap, only: dofmap_t
  use zero_dirichlet, only: zero_dirichlet_t
  use krylov, only: ksp_t, krylov_solver_factory, ksp_max_iter
  use coefs, only: coef_t
  use usr_inflow, only: usr_inflow_t, usr_inflow_eval
  use dirichlet, only: dirichlet_t
  use field_dirichlet, only: field_dirichlet_t
  use field_dirichlet_vector, only: field_dirichlet_vector_t
  use jacobi, only: jacobi_t
  use sx_jacobi, only: sx_jacobi_t
  use device_jacobi, only: device_jacobi_t
  use hsmg, only: hsmg_t
  use phmg, only: phmg_t
  use precon, only: pc_t, precon_factory, precon_destroy
  use fluid_stats, only: fluid_stats_t
  use bc_list, only: bc_list_t
  use mesh, only: mesh_t, neko_msh_max_zlbls, neko_msh_max_zlbl_len
  use math, only: cfill, add2s2, glsum
  use device_math, only: device_cfill, device_add2s2
  use time_scheme_controller, only: time_scheme_controller_t
  use operators, only: cfl
  use logger, only: neko_log, log_size, neko_log_verbose
  use field_registry, only: neko_field_registry
  use json_utils, only: json_get, json_get_or_default, json_extract_object, &
       json_extract_item
  use json_module, only: json_file, json_core, json_value
  use scratch_registry, only: scratch_registry_t
  use user_intf, only: user_t, dummy_user_material_properties, &
       user_material_properties
  use utils, only: neko_error, neko_warning
  use field_series, only: field_series_t
  use time_step_controller, only: time_step_controller_t
  use field_math, only: field_cfill, field_add2s2
  use wall_model_bc, only: wall_model_bc_t
  use shear_stress, only: shear_stress_t
  use field_list, only : field_list_t
  use time_state, only: time_state_t
  use field_math, only: field_addcol3
 
  use mpi_f08, only: mpi_integer, mpi_sum, mpi_allreduce
  use json_utils_ext, only: json_key_fallback
  use device, only : device_event_sync, glb_cmd_event, device_to_host, &
       device_memcpy
  implicit none
  private
  public :: adjoint_fluid_scheme_t, adjoint_fluid_scheme_factory
 
  type, abstract :: adjoint_fluid_scheme_t
     character(len=:), allocatable :: name
 
     type(space_t) :: xh
     type(dofmap_t) :: dm_xh
     type(gs_t) :: gs_xh
     type(coef_t) :: c_xh
 
     type(time_scheme_controller_t), allocatable :: ext_bdf
 
     type(field_t), pointer :: u_adj => null() 
     type(field_t), pointer :: v_adj => null() 
     type(field_t), pointer :: w_adj => null() 
     type(field_t), pointer :: p_adj => null() 
     type(field_series_t) :: ulag, vlag, wlag
 
     type(chkp_t), pointer :: chkp => null()
 
     type(field_t), pointer :: f_adj_x => null()
     type(field_t), pointer :: f_adj_y => null()
     type(field_t), pointer :: f_adj_z => null()
 
     ! List of boundary conditions for pressure
     type(bc_list_t) :: bcs_prs
     ! List of boundary conditions for velocity
     type(bc_list_t) :: bcs_vel
 
     type(json_file), pointer :: params
     type(mesh_t), pointer :: msh => null() 
 
     character(len=NEKO_MSH_MAX_ZLBL_LEN), allocatable :: bc_labels(:)
 
     type(field_t) :: rho
 
     type(field_t) :: mu
 
     type(field_list_t) :: material_properties
 
     logical :: freeze = .false.
 
     procedure(user_material_properties), nopass, pointer :: &
          user_material_properties => null()
 
   contains
     procedure(adjoint_fluid_scheme_init_intrf), pass(this), deferred :: init
     procedure(adjoint_fluid_scheme_free_intrf), pass(this), deferred :: free
     procedure(adjoint_fluid_scheme_step_intrf), pass(this), deferred :: step
     procedure(adjoint_fluid_scheme_restart_intrf), &
          pass(this), deferred :: restart
     procedure(adjoint_fluid_scheme_setup_bcs_intrf), pass(this), deferred :: &
          setup_bcs
 
     procedure(validate_intrf), pass(this), deferred :: validate
     procedure(fluid_scheme_base_compute_cfl_intrf), pass(this), deferred :: compute_cfl
     procedure(update_material_properties), pass(this), deferred :: update_material_properties
  end type adjoint_fluid_scheme_t
 
  abstract interface
     subroutine adjoint_fluid_init_all_intrf(this, msh, lx, params, kspv_init, &
          kspp_init, scheme, user)
       import adjoint_fluid_scheme_t
       import mesh_t
       import json_file
       import user_t
       import rp
       import log_size
       class(adjoint_fluid_scheme_t), target, intent(inout) :: this
       type(mesh_t), target, intent(inout) :: msh
       integer, intent(inout) :: lx
       type(json_file), target, intent(inout) :: params
       type(user_t), target, intent(in) :: user
       logical :: kspv_init
       logical :: kspp_init
       character(len=*), intent(in) :: scheme
       real(kind=rp) :: abs_tol
       integer :: integer_val, ierr
       logical :: logical_val
       character(len=:), allocatable :: solver_type, precon_type
       character(len=LOG_SIZE) :: log_buf
       real(kind=rp) :: gjp_param_a, gjp_param_b
     end subroutine adjoint_fluid_init_all_intrf
  end interface
 
  abstract interface
     subroutine adjoint_fluid_init_common_intrf(this, msh, lx, params, scheme, &
          user, kspv_init)
       import adjoint_fluid_scheme_t
       import mesh_t
       import json_file
       import user_t
       import dirichlet_t
       import log_size
       import rp
       class(adjoint_fluid_scheme_t), target, intent(inout) :: this
       type(mesh_t), target, intent(inout) :: msh
       integer, intent(inout) :: lx
       character(len=*), intent(in) :: scheme
       type(json_file), target, intent(inout) :: params
       type(user_t), target, intent(in) :: user
       logical, intent(in) :: kspv_init
       type(dirichlet_t) :: bdry_mask
       character(len=LOG_SIZE) :: log_buf
       real(kind=rp), allocatable :: real_vec(:)
       real(kind=rp) :: real_val, kappa, b, z0
       logical :: logical_val
       integer :: integer_val, ierr
       type(json_file) :: wm_json
       character(len=:), allocatable :: string_val1, string_val2
     end subroutine adjoint_fluid_init_common_intrf
  end interface
 
  abstract interface
     subroutine adjoint_fluid_free_intrf(this)
       import adjoint_fluid_scheme_t
       class(adjoint_fluid_scheme_t), intent(inout) :: this
     end subroutine adjoint_fluid_free_intrf
  end interface
 
  abstract interface
     subroutine adjoint_fluid_scheme_init_intrf(this, msh, lx, params, user, &
          chkp)
       import adjoint_fluid_scheme_t
       import json_file
       import mesh_t
       import user_t
       import chkp_t
       class(adjoint_fluid_scheme_t), target, intent(inout) :: this
       type(mesh_t), target, intent(inout) :: msh
       integer, intent(in) :: lx
       type(json_file), target, intent(inout) :: params
       type(user_t), target, intent(in) :: user
       type(chkp_t), target, intent(inout) :: chkp
     end subroutine adjoint_fluid_scheme_init_intrf
  end interface
 
  abstract interface
     subroutine adjoint_fluid_scheme_free_intrf(this)
       import adjoint_fluid_scheme_t
       class(adjoint_fluid_scheme_t), intent(inout) :: this
     end subroutine adjoint_fluid_scheme_free_intrf
  end interface
 
  abstract interface
     subroutine adjoint_fluid_scheme_step_intrf(this, time, dt_controller)
       import time_state_t
       import adjoint_fluid_scheme_t
       import time_step_controller_t
       class(adjoint_fluid_scheme_t), target, intent(inout) :: this
       type(time_state_t), intent(in) :: time
       type(time_step_controller_t), intent(in) :: dt_controller
     end subroutine adjoint_fluid_scheme_step_intrf
  end interface
 
  abstract interface
     subroutine adjoint_fluid_scheme_restart_intrf(this, chkp)
       import adjoint_fluid_scheme_t
       import chkp_t
       class(adjoint_fluid_scheme_t), target, intent(inout) :: this
       type(chkp_t), intent(inout) :: chkp
     end subroutine adjoint_fluid_scheme_restart_intrf
  end interface
 
  abstract interface
     subroutine adjoint_fluid_scheme_setup_bcs_intrf(this, user, params)
       import adjoint_fluid_scheme_t, user_t, json_file
       class(adjoint_fluid_scheme_t), intent(inout) :: this
       type(user_t), target, intent(in) :: user
       type(json_file), intent(inout) :: params
     end subroutine adjoint_fluid_scheme_setup_bcs_intrf
  end interface
 
  abstract interface
     subroutine validate_intrf(this)
       import adjoint_fluid_scheme_t
       class(adjoint_fluid_scheme_t), target, intent(inout) :: this
     end subroutine validate_intrf
  end interface
 
  abstract interface
     subroutine update_material_properties(this, t, tstep)
       import adjoint_fluid_scheme_t, rp
       class(adjoint_fluid_scheme_t), intent(inout) :: this
       real(kind=rp),intent(in) :: t
       integer, intent(in) :: tstep
     end subroutine update_material_properties
  end interface
 
  abstract interface
     function fluid_scheme_base_compute_cfl_intrf(this, dt) result(c)
       import adjoint_fluid_scheme_t
       import rp
       class(adjoint_fluid_scheme_t), intent(in) :: this
       real(kind=rp), intent(in) :: dt
       real(kind=rp) :: c
     end function fluid_scheme_base_compute_cfl_intrf
  end interface
 
  interface
 
     module subroutine adjoint_fluid_scheme_factory(object, type_name)
       class(adjoint_fluid_scheme_t), intent(inout), allocatable :: object
       character(len=*) :: type_name
     end subroutine adjoint_fluid_scheme_factory
  end interface
end module adjoint_fluid_scheme