psmile_grid_reduced_gauss.F90

Go to the documentation of this file.

!------------------------------------------------------------------------
! Copyright 2011, DKRZ, Hamburg, Germany.
! All rights reserved. Use is subject to OASIS4 license terms.
!------------------------------------------------------------------------

module psmile_grid_reduced_gauss

   use psmile_common, only : ndim_3d, dble_vector

   type block_info
      integer :: global_1d_start_idx, global_1d_end_idx
      integer :: local_1d_start_idx, local_1d_end_idx
      integer :: global_3d_start_idx(ndim_3d), 
                 global_3d_end_idx(ndim_3d)
   end type block_info

   type reduced_gauss_grid_data

      ! global grid information
      integer, pointer :: nbr_points_per_lat(:)

      ! auxiliary grid
      type (dble_vector) :: aux_corners (ndim_3d) ! This should replaced with type(corner_block)
                                                  ! or something similar. However, due to the
                                                  ! current design of module psmile this would
                                                  ! create cyclic dependencies.

      ! mapping of 3d aux grid coordinates to 1d local reduced gauss grid coordinates
      integer, pointer :: aux_3d_to_local_1d_map(:,:,:)

      ! local grid information
      integer, pointer :: local_1d_stencil_lookup(:,:) ! for every local cell index this array
                                                       ! contains the indices of the 15
                                                       ! neighbours for the bicubic stencil. It
                                                       ! is set in psmile_gauss_get_neighbours.
                                                       ! The neighbours are arrangend as follos
                                                       ! (6 is the base point of the stencil):
                                                       !   13  14  15  16
                                                       !    9  10  11  12
                                                       !    5   6   7   8
                                                       !    1   2   3   4
                                                       ! memory layout:
                                                       ! local_1d_stencil_lookup (16, nloc)

      type (block_info), pointer :: local_block_info(:) ! contains some additional data on the
                                                        ! blocks of the local parition. This is
                                                        ! used of optimisation purpose
      ! transformation information
      integer, pointer :: global_lat_offsets(:)

      ! contains global 1d indices of the remote points that are stored locally
      integer, pointer              :: remote_index(:)

   end type reduced_gauss_grid_data

   interface psmile_gauss_local_1d_to_3d

      function psmile_gauss_1_local_1d_to_3d (grid_id, idx)

         use psmile_common, only : ndim_3d

         integer, intent (in) :: grid_id, idx

         integer              :: psmile_gauss_1_local_1d_to_3d (ndim_3d)
      end function psmile_gauss_1_local_1d_to_3d

      function psmile_gauss_n_local_1d_to_3d (grid_id, idx, num_points)

         use psmile_common, only : ndim_3d

         integer, intent (in) :: num_points
         integer, intent (in) :: grid_id, idx(num_points)

         integer              :: psmile_gauss_n_local_1d_to_3d (ndim_3d, num_points)
      end function psmile_gauss_n_local_1d_to_3d

   end interface psmile_gauss_local_1d_to_3d

   interface

      subroutine psmile_init_gauss_data (grid_id, nbr_points_per_lat)

         integer, intent(in) :: grid_id
         integer, intent(in) :: nbr_points_per_lat(:)
      end subroutine psmile_init_gauss_data

      subroutine psmile_gauss_gen_aux_grid (grid_id)

         integer, intent(in) :: grid_id
      end subroutine

      subroutine psmile_gauss_gen_aux_grid_map (grid_id)

         integer, intent (in) :: grid_id
      end subroutine psmile_gauss_gen_aux_grid_map

      subroutine psmile_free_aux_grid_data (grid_id)

         integer, intent (in) :: grid_id
      end subroutine psmile_free_aux_grid_data


      integer function get_gauss_neighbour_cell (idx, nbr_points_lat, nbr_points_lat_neigh)

         integer, intent (in) :: idx,            
                                 nbr_points_lat, 
                                 nbr_points_lat_neigh
      end function get_gauss_neighbour_cell

      integer function get_gauss_opposite_neighbour_cell (idx, nbr_points_lat, nbr_points_lat_neigh)

         integer, intent (in) :: idx,            
                                 nbr_points_lat, 
                                 nbr_points_lat_neigh
      end function get_gauss_opposite_neighbour_cell

      integer function psmile_gauss_blockidx_to_glat (grid_id, block_idx)

         integer, intent (in) :: grid_id, block_idx
      end function psmile_gauss_blockidx_to_glat

      function psmile_gauss_get_bicu_stencil (grid_id, base)

         use psmile_common, only : ndim_3d

         integer, intent (in) :: grid_id, base(ndim_3d)

         integer :: psmile_gauss_get_bicu_stencil(ndim_3d, 16)
      end function psmile_gauss_get_bicu_stencil

      function psmile_gauss_shift_bicu_stencil (grid_id, base, shift)

         use psmile_common, only : ndim_3d

         integer, intent (in) :: grid_id, base (ndim_3d), shift(ndim_3d)

         integer :: psmile_gauss_shift_bicu_stencil (ndim_3d, 16)
      end function psmile_gauss_shift_bicu_stencil

      function psmile_gauss_get_neigh_stencil (grid_id, base)

         use psmile_common, only : ndim_3d

         integer, intent (in) :: grid_id, base (ndim_3d)

         integer :: psmile_gauss_get_neigh_stencil (ndim_3d, 9)
      end function psmile_gauss_get_neigh_stencil

      function psmile_gauss_get_bili_stencil (grid_id, base)

         use psmile_common, only : ndim_3d

         integer, intent (in) :: grid_id, base(ndim_3d)

         integer :: psmile_gauss_get_bili_stencil(ndim_3d, 4)
      end function psmile_gauss_get_bili_stencil

      function psmile_gauss_shift_bili_stencil (grid_id, base, shift)

         use psmile_common, only : ndim_3d

         integer, intent (in) :: grid_id, base (ndim_3d), shift(ndim_3d)

         integer :: psmile_gauss_shift_bili_stencil (ndim_3d, 4)
      end function psmile_gauss_shift_bili_stencil

      function psmile_gauss_3d_to_global_1d (grid_id, points_3d, num_points)

         use psmile_common, only : ndim_3d

         integer, intent(in) :: grid_id, num_points
         integer, intent(in) :: points_3d(ndim_3d, num_points)

         integer :: psmile_gauss_3d_to_global_1d(num_points)
      end function psmile_gauss_3d_to_global_1d

      function psmile_gauss_1d_global_to_local (grid_id, points_1d, num_points, &
                                                fill_value, inc_remote_neigh)

         integer, intent(in)           :: grid_id, num_points, fill_value
         integer, intent(in)           :: points_1d(num_points)
         logical, intent(in), optional :: inc_remote_neigh 

         integer :: psmile_gauss_1d_global_to_local(num_points)
      end function psmile_gauss_1d_global_to_local

      function psmile_gauss_3d_to_local_1d (grid_id, points_3d, num_points, &
                                                fill_value, inc_remote_neigh)
         use psmile_common, only : ndim_3d

         integer, intent(in)           :: grid_id, num_points, fill_value
         integer, intent(in)           :: points_3d(ndim_3d, num_points)
         logical, intent(in), optional :: inc_remote_neigh 

         integer :: psmile_gauss_3d_to_local_1d(num_points)
      end function psmile_gauss_3d_to_local_1d

   end interface

end module psmile_grid_reduced_gauss