ax.f90

Go to the documentation of this file.

! Copyright (c) 2020-2026, 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 ax_product
  use utils, only : neko_typename_len
  use num_types, only : rp
  use coefs, only : coef_t
  use space, only : space_t
  use mesh, only : mesh_t
  implicit none
  private
 
  type, public, abstract :: ax_t
   contains
     procedure(ax_compute), pass(this), deferred :: compute
     procedure(ax_compute_vector), pass(this), deferred :: compute_vector
     procedure, pass(this) :: free => ax_free
  end type ax_t
 
  interface
 
     module subroutine ax_helm_allocator(object, type_name)
       class(ax_t), allocatable, intent(inout) :: object
       character(len=*), intent(in) :: type_name
     end subroutine ax_helm_allocator
  end interface
 
  !
  ! Machinery for injecting user-defined types
  !
 
  abstract interface
     subroutine ax_helm_allocate(obj)
       import ax_t
       class(ax_t), allocatable, intent(inout) :: obj
     end subroutine ax_helm_allocate
  end interface
 
  interface
 
     module subroutine register_ax_helm(type_name, allocator)
       character(len=*), intent(in) :: type_name
       procedure(ax_helm_allocate), pointer, intent(in) :: allocator
     end subroutine register_ax_helm
  end interface
 
  type ax_helm_allocator_entry
     character(len=NEKO_TYPENAME_LEN) :: type_name
     procedure(ax_helm_allocate), pointer, nopass :: allocator
  end type ax_helm_allocator_entry
 
  type(ax_helm_allocator_entry), allocatable :: ax_helm_registry(:)
 
  integer :: ax_helm_registry_size = 0
 
  public :: ax_helm_allocator, register_ax_helm, ax_helm_allocate
 
  abstract interface
     subroutine ax_compute(this, w, u, coef, msh, Xh)
       import space_t
       import mesh_t
       import coef_t
       import ax_t
       import rp
       implicit none
       class(ax_t), intent(in) :: this
       type(space_t), intent(in) :: Xh
       type(mesh_t), intent(in) :: msh
       type(coef_t), intent(in) :: coef
       real(kind=rp), intent(inout) :: w(xh%lx, xh%ly, xh%lz, msh%nelv)
       real(kind=rp), intent(in) :: u(xh%lx, xh%ly, xh%lz, msh%nelv)
     end subroutine ax_compute
  end interface
 
  abstract interface
     subroutine ax_compute_vector(this, au, av, aw, u, v, w, coef, msh, Xh)
       import space_t
       import mesh_t
       import coef_t
       import ax_t
       import rp
       implicit none
       class(ax_t), intent(in) :: this
       type(space_t), intent(in) :: Xh
       type(mesh_t), intent(in) :: msh
       type(coef_t), intent(in) :: coef
       real(kind=rp), intent(inout) :: au(xh%lx, xh%ly, xh%lz, msh%nelv)
       real(kind=rp), intent(inout) :: av(xh%lx, xh%ly, xh%lz, msh%nelv)
       real(kind=rp), intent(inout) :: aw(xh%lx, xh%ly, xh%lz, msh%nelv)
       real(kind=rp), intent(in) :: u(xh%lx, xh%ly, xh%lz, msh%nelv)
       real(kind=rp), intent(in) :: v(xh%lx, xh%ly, xh%lz, msh%nelv)
       real(kind=rp), intent(in) :: w(xh%lx, xh%ly, xh%lz, msh%nelv)
     end subroutine ax_compute_vector
  end interface
 
contains
 
  subroutine ax_free(this)
    class(ax_t), intent(inout) :: this
  end subroutine ax_free
 
end module ax_product