rhs_maker.f90

Go to the documentation of this file.

! Copyright (c) 2018-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 rhs_maker
  use num_types, only : rp
  use field_series, only : field_series_t
  use field, only : field_t
  implicit none
  private
 
  type, public, abstract :: rhs_maker_sumab_t
   contains
     procedure(rhs_maker_sumab), nopass, deferred :: compute_fluid
  end type rhs_maker_sumab_t
 
  type, public, abstract :: rhs_maker_ext_t
   contains
     procedure(rhs_maker_ext), nopass, deferred :: compute_fluid
     procedure(scalar_rhs_maker_ext), nopass, deferred :: compute_scalar
  end type rhs_maker_ext_t
 
  type, public, abstract :: rhs_maker_bdf_t
   contains
     procedure(rhs_maker_bdf), nopass, deferred :: compute_fluid
     procedure(scalar_rhs_maker_bdf), nopass, deferred :: compute_scalar
  end type rhs_maker_bdf_t
 
  type, public, abstract :: rhs_maker_oifs_t
   contains
     procedure(rhs_maker_oifs), nopass, deferred :: compute_fluid
     procedure(scalar_rhs_maker_oifs), nopass, deferred :: compute_scalar
  end type rhs_maker_oifs_t
 
  abstract interface
     subroutine rhs_maker_sumab(u, v, w, uu, vv, ww, &
          uulag, vvlag, wwlag, ab, nab)
       import field_t
       import field_series_t
       import rp
       type(field_t), intent(inout) :: u, v, w
       type(field_t), intent(inout) :: uu, vv, ww
       type(field_series_t), intent(inout) :: uulag, vvlag, wwlag
       real(kind=rp), dimension(3), intent(in) :: ab
       integer, intent(in) :: nab
     end subroutine rhs_maker_sumab
  end interface
 
  abstract interface
     subroutine rhs_maker_ext(fx_lag, fy_lag, fz_lag, &
          fx_laglag, fy_laglag, fz_laglag, fx, fy, fz, &
          rho, ext_coeffs, n)
       import field_t
       import rp
       type(field_t), intent(inout) :: fx_lag, fy_lag, fz_lag
       type(field_t), intent(inout) :: fx_laglag, fy_laglag, fz_laglag
       real(kind=rp), intent(inout) :: rho, ext_coeffs(4)
       integer, intent(in) :: n
       real(kind=rp), intent(inout) :: fx(n), fy(n), fz(n)
     end subroutine rhs_maker_ext
  end interface
 
  abstract interface
     subroutine scalar_rhs_maker_ext(fs_lag, fs_laglag, fs, rho, &
          ext_coeffs, n)
       import field_t
       import rp
       type(field_t), intent(inout) :: fs_lag
       type(field_t), intent(inout) :: fs_laglag
       real(kind=rp), intent(inout) :: rho, ext_coeffs(4)
       integer, intent(in) :: n
       real(kind=rp), intent(inout) :: fs(n)
     end subroutine scalar_rhs_maker_ext
  end interface
 
  abstract interface
     subroutine rhs_maker_bdf(ulag, vlag, wlag, bfx, bfy, bfz, &
          u, v, w, B, rho, dt, bd, nbd, n)
       import field_series_t
       import field_t
       import rp
       integer, intent(in) :: n, nbd
       type(field_t), intent(in) :: u, v, w
       type(field_series_t), intent(in) :: ulag, vlag, wlag
       real(kind=rp), intent(inout) :: bfx(n), bfy(n), bfz(n)
       real(kind=rp), intent(in) :: b(n)
       real(kind=rp), intent(in) :: dt, rho, bd(4)
     end subroutine rhs_maker_bdf
  end interface
 
  abstract interface
     subroutine scalar_rhs_maker_bdf(s_lag, fs, s, B, rho, dt, &
          bd, nbd, n)
       import field_series_t
       import field_t
       import rp
       integer, intent(in) :: n, nbd
       type(field_t), intent(in) :: s
       type(field_series_t), intent(in) :: s_lag
       real(kind=rp), intent(inout) :: fs(n)
       real(kind=rp), intent(in) :: b(n)
       real(kind=rp), intent(in) :: dt, rho, bd(4)
     end subroutine scalar_rhs_maker_bdf
  end interface
 
  abstract interface
     subroutine rhs_maker_oifs(phi_x, phi_y, phi_z, bf_x, bf_y, bf_z, &
                               rho, dt, n)
       import rp
       real(kind=rp), intent(in) :: rho, dt
       integer, intent(in) :: n
       real(kind=rp), intent(inout) :: bf_x(n), bf_y(n), bf_z(n)
       real(kind=rp), intent(inout) :: phi_x(n), phi_y(n), phi_z(n)
     end subroutine rhs_maker_oifs
  end interface
 
  abstract interface
     subroutine scalar_rhs_maker_oifs(phi_s, bf_s, rho, dt, n)
       import rp
       real(kind=rp), intent(in) :: rho, dt
       integer, intent(in) :: n
       real(kind=rp), intent(inout) :: bf_s(n)
       real(kind=rp), intent(inout) :: phi_s(n)
     end subroutine scalar_rhs_maker_oifs
  end interface
 
  interface
 
     module subroutine rhs_maker_sumab_fctry(object)
       class(rhs_maker_sumab_t), allocatable, intent(inout) :: object
     end subroutine rhs_maker_sumab_fctry
 
     module subroutine rhs_maker_ext_fctry(object)
       class(rhs_maker_ext_t), allocatable, intent(inout) :: object
     end subroutine rhs_maker_ext_fctry
 
     module subroutine rhs_maker_bdf_fctry(object)
       class(rhs_maker_bdf_t), allocatable, intent(inout) :: object
     end subroutine rhs_maker_bdf_fctry
 
     module subroutine rhs_maker_oifs_fctry(object)
       class(rhs_maker_oifs_t), allocatable, intent(inout) :: object
     end subroutine rhs_maker_oifs_fctry
 
  end interface
 
  public :: rhs_maker_sumab_fctry, rhs_maker_ext_fctry, rhs_maker_bdf_fctry, &
            rhs_maker_oifs_fctry
 
end module rhs_maker