precon.f90

Go to the documentation of this file.

! Copyright (c) 2020-2021, 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 precon
  use utils, only : neko_typename_len
  use num_types, only : rp
  use coefs, only : coef_t
  use bc_list, only : bc_list_t
  use json_module, only : json_file
  implicit none
  private
 
  type, public, abstract :: pc_t
   contains
     procedure(pc_init), pass(this), deferred :: init
     procedure(pc_solve), pass(this), deferred :: solve
     procedure(pc_update), pass(this), deferred :: update
     procedure(pc_free), pass(this), deferred :: free
  end type pc_t
 
  abstract interface
     subroutine pc_init(this, coef, bclst, json)
       import :: pc_t, coef_t, bc_list_t, json_file
       implicit none
       class(pc_t), intent(inout), target :: this
       type(coef_t), intent(in), target :: coef
       type(bc_list_t), intent(inout), target :: bclst
       type(json_file), intent(inout) :: json
     end subroutine pc_init
  end interface
 
  abstract interface
     subroutine pc_solve(this, z, r, n)
       import rp
       import :: pc_t
       implicit none
       integer, intent(in) :: n
       class(pc_t), intent(inout) :: this
       real(kind=rp), dimension(n), intent(inout) :: z
       real(kind=rp), dimension(n), intent(inout) :: r
     end subroutine pc_solve
     subroutine pc_update(this)
       import rp
       import :: pc_t
       implicit none
       class(pc_t), intent(inout) :: this
     end subroutine pc_update
     subroutine pc_free(this)
       import :: pc_t
       implicit none
       class(pc_t), intent(inout) :: this
     end subroutine pc_free
  end interface
 
  interface
 
     module subroutine precon_allocator(pc, type_name)
       class(pc_t), allocatable, intent(inout) :: pc
       character(len=*), intent(in) :: type_name
     end subroutine precon_allocator
 
     module subroutine precon_factory(pc, type_name, coef, bclst, json)
       class(pc_t), allocatable, intent(inout), target :: pc
       character(len=*), intent(in) :: type_name
       type(coef_t), intent(in), target :: coef
       type(bc_list_t), intent(inout), target :: bclst
       type(json_file), intent(inout) :: json
     end subroutine precon_factory
  end interface
 
  !
  ! Machinery for injecting user-defined types
  !
 
  abstract interface
     subroutine precon_allocate(obj)
       import pc_t
       class(pc_t), allocatable, intent(inout) :: obj
     end subroutine precon_allocate
  end interface
 
  interface
 
     module subroutine register_precon(type_name, allocator)
       character(len=*), intent(in) :: type_name
       procedure(precon_allocate), pointer, intent(in) :: allocator
     end subroutine register_precon
  end interface
 
  type precon_allocator_entry
     character(len=NEKO_TYPENAME_LEN) :: type_name
     procedure(precon_allocate), pointer, nopass :: allocator
  end type precon_allocator_entry
 
  type(precon_allocator_entry), allocatable :: precon_registry(:)
 
  integer :: precon_registry_size = 0
 
  public :: precon_allocator, precon_factory, register_precon, precon_allocate
 
end module precon