mapping.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.
!
!
module mapping
  use num_types, only: rp
  use json_module, only: json_file
  use coefs, only: coef_t
  use field, only: field_t
  use field_math, only: field_copy
  implicit none
  private
 
  type, abstract, public :: mapping_t
     type(coef_t), pointer :: coef => null()
     type(field_t) :: x_in
 
   contains
     procedure, pass(this) :: init_base => mapping_init_base
     procedure, pass(this) :: free_base => mapping_free_base
     procedure, pass(this) :: apply_forward => mapping_apply_forward_wrapper
     procedure, pass(this) :: apply_backward => mapping_apply_backward_wrapper
     procedure(mapping_init), pass(this), deferred :: init
     procedure(mapping_free), pass(this), deferred :: free
     procedure(mapping_forward_mapping), pass(this), deferred :: forward_mapping
     procedure(mapping_backward_mapping), pass(this), deferred :: &
          backward_mapping
  end type mapping_t
 
  type, public :: mapping_wrapper_t
     class(mapping_t), allocatable :: mapping
   contains
     procedure, pass(this) :: free => mapping_wrapper_free
  end type mapping_wrapper_t
 
  abstract interface
 
     subroutine mapping_init(this, json, coef)
       import mapping_t, json_file, coef_t
       class(mapping_t), intent(inout) :: this
       type(json_file), intent(inout) :: json
       type(coef_t), intent(inout) :: coef
     end subroutine mapping_init
  end interface
 
  abstract interface
 
     subroutine mapping_free(this)
       import mapping_t
       class(mapping_t), intent(inout) :: this
     end subroutine mapping_free
  end interface
 
  abstract interface
 
     subroutine mapping_forward_mapping(this, X_out, X_in)
       import mapping_t, field_t
       class(mapping_t), intent(inout) :: this
       type(field_t), intent(in) :: X_in
       type(field_t), intent(inout) :: X_out
     end subroutine mapping_forward_mapping
  end interface
 
  abstract interface
 
     subroutine mapping_backward_mapping(this, sens_out, sens_in, X_in)
       import mapping_t, field_t
       class(mapping_t), intent(inout) :: this
       type(field_t), intent(in) :: sens_in
       type(field_t), intent(in) :: X_in
       type(field_t), intent(inout) :: sens_out
     end subroutine mapping_backward_mapping
  end interface
 
  interface mapping_factory
     module subroutine mapping_factory(object, json, coef)
       class(mapping_t), allocatable, intent(inout) :: object
       type(json_file), intent(inout) :: json
       type(coef_t), intent(inout) :: coef
     end subroutine mapping_factory
  end interface mapping_factory
 
  public :: mapping_factory
contains
 
  subroutine mapping_init_base(this, json, coef)
    class(mapping_t), intent(inout) :: this
    type(json_file), intent(inout) :: json
    type(coef_t), intent(inout), target :: coef
 
    this%coef => coef
    call this%X_in%init(coef%dof)
 
  end subroutine mapping_init_base
 
  subroutine mapping_free_base(this)
    class(mapping_t), intent(inout) :: this
 
    call this%X_in%free()
    nullify(this%coef)
 
  end subroutine mapping_free_base
 
  subroutine mapping_wrapper_free(this)
    class(mapping_wrapper_t), intent(inout) :: this
 
    if (allocated(this%mapping)) then
       call this%mapping%free()
       deallocate(this%mapping)
    end if
  end subroutine mapping_wrapper_free
 
  subroutine mapping_apply_forward_wrapper(this, X_out, X_in)
    class(mapping_t), intent(inout) :: this
    type(field_t), intent(inout) :: X_out
    type(field_t), intent(in) :: X_in
 
    call field_copy(this%X_in, x_in)
    call this%forward_mapping(x_out, this%X_in)
 
  end subroutine mapping_apply_forward_wrapper
 
  subroutine mapping_apply_backward_wrapper(this, sens_out, sens_in)
    class(mapping_t), intent(inout) :: this
    type(field_t), intent(inout) :: sens_out
    type(field_t), intent(in) :: sens_in
    ! @todo
    ! hmmmm, it would be silly to call mapping backward without mapping forward
    ! but at least this%X_in is certainly initialized.
    ! but it won't contain the correct information unless a map forward has
    ! occured.
    call this%backward_mapping(sens_out, sens_in, this%X_in)
 
  end subroutine mapping_apply_backward_wrapper
 
end module mapping