sll_m_interpolators_1d_base.F90

Go to the documentation of this file.

 
module sll_m_interpolators_1d_base
!+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
#include "sll_working_precision.h"
 
   implicit none
 
   public :: &
      sll_c_interpolator_1d
 
   private
!+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
   type, abstract :: sll_c_interpolator_1d
 
   contains
 
      ! Procedure with precomputation of interpolant(s)
      procedure(interpolator_1d_interpolant), deferred :: &
         compute_interpolants
      procedure(interpolator_1d_set_coeffs), deferred :: &
         set_coefficients
      procedure(interpolator_1d_get_coeffs), deferred :: &
         get_coefficients
      procedure(interpolator_one_arg_sub), deferred :: &
         interpolate_from_interpolant_value
      procedure(interpolator_one_arg_sub), deferred :: &
         interpolate_from_interpolant_derivative_eta1
      procedure(interpolator_1d_array_interpolant), deferred :: &
         interpolate_from_interpolant_array
 
      ! Procedures including whole interpolation process
      procedure(interpolator_1d_array), deferred :: &
         interpolate_array
      procedure(interpolator_1d_array_disp), deferred :: &
         interpolate_array_disp
      procedure(interpolator_1d_array_disp_inplace), deferred :: &
         interpolate_array_disp_inplace
 
   end type sll_c_interpolator_1d
 
   abstract interface
      subroutine interpolator_1d_interpolant( &
         interpolator, data_array, &
         eta_coords, &
         size_eta_coords)
         use sll_m_working_precision
         import :: sll_c_interpolator_1d
         class(sll_c_interpolator_1d), intent(inout)        :: interpolator
         sll_real64, intent(in)           :: data_array(:)   
         sll_real64, intent(in), optional :: eta_coords(:)   
         sll_int32, intent(in), optional :: size_eta_coords 
      end subroutine interpolator_1d_interpolant
   end interface
 
   abstract interface
      function interpolator_1d_get_coeffs(interpolator)
         use sll_m_working_precision
         import :: sll_c_interpolator_1d
         class(sll_c_interpolator_1d), intent(in) :: interpolator
         sll_real64, dimension(:), pointer           :: interpolator_1d_get_coeffs 
      end function interpolator_1d_get_coeffs
   end interface
 
   abstract interface
      subroutine interpolator_1d_set_coeffs(interpolator, coeffs)
         use sll_m_working_precision
         import :: sll_c_interpolator_1d
         class(sll_c_interpolator_1d), intent(inout) :: interpolator
         ! We allow the coefficients to be passed as 1d or 2d arrays. This allows
         ! for more flexibility for the children classes.
         sll_real64, dimension(:), intent(in), optional   :: coeffs 
      end subroutine interpolator_1d_set_coeffs
   end interface
 
   abstract interface
      function interpolator_one_arg_sub(interpolator, eta1) result(val)
         use sll_m_working_precision
         import :: sll_c_interpolator_1d
         sll_real64                                     :: val  
         class(sll_c_interpolator_1d), intent(in)    :: interpolator
         sll_real64, intent(in)    :: eta1 
      end function interpolator_one_arg_sub
   end interface
 
   abstract interface
      subroutine interpolator_1d_array_interpolant( &
         interpolator, &
         num_pts, &
         vals_to_interpolate, &
         output_array)
 
         use sll_m_working_precision
         import :: sll_c_interpolator_1d
         class(sll_c_interpolator_1d), intent(inout) :: interpolator
         sll_int32, intent(in) :: num_pts      
         sll_real64, intent(in) :: vals_to_interpolate(num_pts) 
         sll_real64, intent(out):: output_array(num_pts) 
      end subroutine interpolator_1d_array_interpolant
   end interface
 
   abstract interface
      subroutine interpolator_1d_array(this, num_pts, data, coordinates, output_array)
         use sll_m_working_precision
         import :: sll_c_interpolator_1d
         class(sll_c_interpolator_1d), intent(inout)     :: this
         sll_int32, intent(in)     :: num_pts    
         sll_real64, intent(in)     :: data(:)  
         sll_real64, intent(in)     :: coordinates(num_pts) 
         sll_real64, intent(out)    :: output_array(num_pts) 
      end subroutine interpolator_1d_array
   end interface
 
   abstract interface
      subroutine interpolator_1d_array_disp( &
         this, &
         num_pts, &
         data, &
         alpha, &
         output_array)
 
         use sll_m_working_precision
         import :: sll_c_interpolator_1d
         class(sll_c_interpolator_1d), intent(inout)     :: this
         sll_int32, intent(in)     :: num_pts    
         sll_real64, intent(in)     :: data(:)  
         sll_real64, intent(in)     :: alpha 
         sll_real64, intent(out)    :: output_array(num_pts) 
 
      end subroutine interpolator_1d_array_disp
   end interface
 
   abstract interface
      subroutine interpolator_1d_array_disp_inplace( &
         this, &
         num_pts, &
         data, &
         alpha)
 
         use sll_m_working_precision
         import :: sll_c_interpolator_1d
         class(sll_c_interpolator_1d), intent(inout)     :: this
         sll_int32, intent(in)     :: num_pts    
         sll_real64, intent(inout)  :: data(num_pts)  
         sll_real64, intent(in)     :: alpha 
 
      end subroutine interpolator_1d_array_disp_inplace
   end interface
 
end module sll_m_interpolators_1d_base