InterpolationSchemeInterface.f90

Go to the documentation of this file.

module interpolationschemeinterfacemodule
  use kindmodule, only: dp, i4b
 
  implicit none
  private
 
  public :: interpolationschemeinterface
  public :: coefficientstype
 
  type :: coefficientstype
    real(dp) :: c_n = 0.0_dp
    real(dp) :: c_m = 0.0_dp
    real(dp) :: rhs = 0.0_dp
  end type coefficientstype
 
  type, abstract :: interpolationschemeinterface
  contains
    procedure(compute_if), deferred :: compute
    procedure(set_field_if), deferred :: set_field
  end type interpolationschemeinterface
 
  abstract interface
 
    !> @brief Compute interpolation coefficients for a face value
    !!
    !! This method computes the coefficients needed to interpolate a scalar field
    !! value at the face between two connected cells. The method returns coefficients
    !! that define how the face value depends on the cell-centered values.
    !<
    function compute_if(this, n, m, iposnm) result(phi_face)
      ! -- import
      import dp, i4b
      import interpolationschemeinterface
      import coefficientstype
      ! -- return
      type(coefficientstype) :: phi_face
      ! -- dummy
      class(interpolationschemeinterface), target :: this
      integer(I4B), intent(in) :: n
      integer(I4B), intent(in) :: m
      integer(I4B), intent(in) :: iposnm
    end function
 
    !> @brief Set the scalar field for which interpolation will be computed
    !!
    !! This method establishes a pointer to the scalar field data that will be
    !! used for subsequent interpolation computations. Implementations may also
    !! update any dependent cached data to ensure consistent results.
    !<
    subroutine set_field_if(this, phi)
      ! -- import
      import dp
      import interpolationschemeinterface
      ! -- dummy
      class(interpolationschemeinterface), target :: this
      real(DP), intent(in), dimension(:), pointer :: phi
    end subroutine
 
  end interface
 
end module interpolationschemeinterfacemodule