adjoint_scalar_convection_source_term.f90

! Copyright (c) 2023, 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.
!
! this is a such a dumb name
module adjoint_scalar_convection_source_term
  use num_types, only: rp
  use field_list, only: field_list_t
  use field, only: field_t
  use scratch_registry, only: neko_scratch_registry
  use json_module, only: json_file
  use time_state, only: time_state_t
  use source_term, only: source_term_t
  use interpolation, only: interpolator_t
  use space, only: space_t, gl
  use coefs, only: coef_t
  use field_math, only: field_subcol3, field_sub2, field_col3
  use operators, only: grad, dudxyz
  use utils, only: neko_error
  use scratch_registry, only: scratch_registry_t, neko_scratch_registry
  use neko_config, only: neko_bcknd_device
  use math, only: col2, invcol2
  use device_math, only: device_col2, device_invcol2
  implicit none
  private
 
  ! I don't know how to name this term, but when you have a passive
  ! scalar you get an extra term in the adjoint velocity equation, which comes
  ! from the convective term in the passive scalar equation.
  ! Maybe this should be called just `adjoint_scalar_convection`?
  ! but it does come in a source term...
 
  ! In any case,
  ! it's a source term acting on the adjoint velocity equations, of the form:
  ! \f$\nabla s s_adj\f$
  type, public, extends(source_term_t) :: &
       adjoint_scalar_convection_source_term_t
     type(field_t), pointer :: s_adj => null()
     type(field_t), pointer :: s => null()
     ! --- for over-integration
     type(space_t), pointer :: xh_gll
     type(space_t), pointer :: xh_gl
     type(coef_t), pointer :: c_xh_gl
     type(interpolator_t), pointer :: gll_to_gl
     logical :: dealias
     type(scratch_registry_t), pointer :: scratch_gl
 
   contains
     procedure, pass(this) :: init => &
          adjoint_scalar_convection_source_term_init_from_json
     procedure, pass(this) :: init_from_components => &
          adjoint_scalar_convection_source_term_init_from_components
     procedure, pass(this) :: free => adjoint_scalar_convection_source_term_free
     procedure, pass(this) :: compute_ => &
          adjoint_scalar_convection_source_term_compute
  end type adjoint_scalar_convection_source_term_t
 
contains
  subroutine adjoint_scalar_convection_source_term_init_from_json(this, &
       json, fields, coef, variable_name)
    class(adjoint_scalar_convection_source_term_t), intent(inout) :: this
    type(json_file), intent(inout) :: json
    type(field_list_t), intent(in), target :: fields
    type(coef_t), intent(in), target :: coef
    character(len=*), intent(in) :: variable_name
 
    ! this is a bit weird... because I don't think this should come from the
    ! JSON.
    ! Maybe we should think of all these source terms as only "appendable"
    !
    ! Because we'll never have the whole case here, so we'll never be able
    ! init from components anyway...
 
 
  end subroutine adjoint_scalar_convection_source_term_init_from_json
 
  subroutine adjoint_scalar_convection_source_term_init_from_components(this,&
       f_x, f_y, f_z, s, s_adj, coef, c_Xh_GL, GLL_to_GL, dealias, scratch_GL)
    class(adjoint_scalar_convection_source_term_t), intent(inout) :: this
    type(field_t), pointer, intent(in) :: f_x, f_y, f_z
    type(field_t), intent(in), target :: s, s_adj
    type(coef_t), intent(in), target :: coef
    type(coef_t), intent(in), target :: c_Xh_GL
    type(interpolator_t), intent(in), target :: GLL_to_GL
    logical, intent(in) :: dealias
    type(scratch_registry_t), intent(in), target :: scratch_GL
 
    type(field_list_t) :: fields
    real(kind=rp) :: start_time
    real(kind=rp) :: end_time
 
    ! I wish you didn't need a start time and end time...
    ! but I'm just going to set a super big number...
    start_time = 0.0_rp
    end_time = 100000000.0_rp
 
    call this%free()
 
    ! this is copying the fluid source term init
    ! We package the fields for the source term to operate on in a field list.
    call fields%init(3)
    call fields%assign(1, f_x)
    call fields%assign(2, f_y)
    call fields%assign(3, f_z)
 
    call this%init_base(fields, coef, start_time, end_time)
 
    ! point everything in the correct places
    this%s_adj => s_adj
    this%s => s
 
    ! for over integration
    this%dealias = dealias
    this%c_Xh_GL => c_xh_gl
    this%Xh_GL => this%c_Xh_GL%Xh
    this%Xh_GLL => this%coef%Xh
    this%GLL_to_GL => gll_to_gl
    this%scratch_GL => scratch_gl
 
  end subroutine adjoint_scalar_convection_source_term_init_from_components
 
  subroutine adjoint_scalar_convection_source_term_free(this)
    class(adjoint_scalar_convection_source_term_t), intent(inout) :: this
 
    call this%free_base()
    nullify(this%s_adj)
    nullify(this%s)
    nullify(this%c_Xh_GL)
    nullify(this%Xh_GL)
    nullify(this%Xh_GLL)
    nullify(this%GLL_to_GL)
    nullify(this%scratch_GL)
 
  end subroutine adjoint_scalar_convection_source_term_free
 
  subroutine adjoint_scalar_convection_source_term_compute(this, time)
    class(adjoint_scalar_convection_source_term_t), intent(inout) :: this
    type(time_state_t), intent(in) :: time
    type(field_t), pointer :: fu, fv, fw
    integer :: temp_indices(4)
    type(field_t), pointer :: dsdx, dsdy, dsdz, work
    type(field_t), pointer :: accumulate, fld_GL, s_GL, s_adj_GL
    integer :: temp_indices_GL(4)
    integer :: n_GL, nel
 
 
    call neko_scratch_registry%request_field(dsdx, temp_indices(1))
    call neko_scratch_registry%request_field(dsdy, temp_indices(2))
    call neko_scratch_registry%request_field(dsdz, temp_indices(3))
    call neko_scratch_registry%request_field(work, temp_indices(4))
 
    fu => this%fields%get(1)
    fv => this%fields%get(2)
    fw => this%fields%get(3)
 
    ! we need the term \f$\nabla s s_adj\f$
    if (this%dealias) then
       nel = this%coef%msh%nelv
       n_gl = nel * this%Xh_GL%lxyz
       call this%scratch_GL%request_field(accumulate, temp_indices_gl(1))
       call this%scratch_GL%request_field(fld_gl, temp_indices_gl(2))
       call this%scratch_GL%request_field(s_gl, temp_indices_gl(3))
       call this%scratch_GL%request_field(s_adj_gl, temp_indices_gl(4))
 
       call this%GLL_to_GL%map(s_gl%x, this%s%x, nel, this%Xh_GL)
       call this%GLL_to_GL%map(s_adj_gl%x, this%s_adj%x, nel, this%Xh_GL)
 
       ! u
       call dudxyz(fld_gl%x, s_gl%x, this%c_Xh_GL%drdx, &
            this%c_Xh_GL%dsdx, this%c_Xh_GL%dtdx, this%c_Xh_GL)
       call field_col3(accumulate, s_adj_gl, fld_gl)
       ! Evaluate term on GL and preempt the GLL premultiplication
       if (neko_bcknd_device .eq. 1) then
          call device_col2(accumulate%x_d, this%c_Xh_GL%B_d, n_gl)
          call this%GLL_to_GL%map(work%x, accumulate%x, nel, this%Xh_GLL)
          call device_invcol2(work%x_d, this%coef%B_d, work%size())
       else
          call col2(accumulate%x, this%c_Xh_GL%B, n_gl)
          call this%GLL_to_GL%map(work%x, accumulate%x, nel, this%Xh_GLL)
          call invcol2(work%x, this%coef%B, work%size())
       end if
       call field_sub2(fu, work)
 
       ! v
       call dudxyz(fld_gl%x, s_gl%x, this%c_Xh_GL%drdy, &
            this%c_Xh_GL%dsdy, this%c_Xh_GL%dtdy, this%c_Xh_GL)
       call field_col3(accumulate, s_adj_gl, fld_gl)
       ! Evaluate term on GL and preempt the GLL premultiplication
       if (neko_bcknd_device .eq. 1) then
          call device_col2(accumulate%x_d, this%c_Xh_GL%B_d, n_gl)
          call this%GLL_to_GL%map(work%x, accumulate%x, nel, this%Xh_GLL)
          call device_invcol2(work%x_d, this%coef%B_d, work%size())
       else
          call col2(accumulate%x, this%c_Xh_GL%B, n_gl)
          call this%GLL_to_GL%map(work%x, accumulate%x, nel, this%Xh_GLL)
          call invcol2(work%x, this%coef%B, work%size())
       end if
       call field_sub2(fv, work)
 
       ! w
       call dudxyz(fld_gl%x, s_gl%x, this%c_Xh_GL%drdz, &
            this%c_Xh_GL%dsdz, this%c_Xh_GL%dtdz, this%c_Xh_GL)
       call field_col3(accumulate, s_adj_gl, fld_gl)
       ! Evaluate term on GL and preempt the GLL premultiplication
       if (neko_bcknd_device .eq. 1) then
          call device_col2(accumulate%x_d, this%c_Xh_GL%B_d, n_gl)
          call this%GLL_to_GL%map(work%x, accumulate%x, nel, this%Xh_GLL)
          call device_invcol2(work%x_d, this%coef%B_d, work%size())
       else
          call col2(accumulate%x, this%c_Xh_GL%B, n_gl)
          call this%GLL_to_GL%map(work%x, accumulate%x, nel, this%Xh_GLL)
          call invcol2(work%x, this%coef%B, work%size())
       end if
       call field_sub2(fw, work)
 
       call this%scratch_GL%relinquish_field(temp_indices_gl)
 
    else
       call grad(dsdx%x, dsdy%x, dsdz%x, this%s%x, this%coef)
       call field_subcol3(fu, this%s_adj, dsdx)
       call field_subcol3(fv, this%s_adj, dsdy)
       call field_subcol3(fw, this%s_adj, dsdz)
    end if
 
    ! free the scratch
    call neko_scratch_registry%relinquish_field(temp_indices)
  end subroutine adjoint_scalar_convection_source_term_compute
 
end module adjoint_scalar_convection_source_term