psmile_transform_index.F90

Go to the documentation of this file.

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

      function psmile_transform_index_1d_to_3d ( &
                      index_1d, array_shape)
!
! !USES:
!
      use psmile_common, only : ndim_3d
      use psmile, dummy_interface => psmile_transform_index_1d_to_3d

      implicit none
!
! !INPUT PARAMETERS:
!
      integer, intent(in) :: index_1d
!     The 1d index which is to be transformed into a 3d one
      integer, intent(in) :: array_shape (2, ndim_3d)
!     The array shape which is used for transforming the 1d index
!
! !RETURN VALUE:
!
      integer :: psmile_transform_index_1d_to_3d (ndim_3d)

!     Contains the 3d index
!
! !DEFINED PARAMETERS:
!
      integer :: array_size(3)
!
!
! !DESCRIPTION:
!
! Subroutine "psmile_transform_index_1d_to_3d" transforms a given 1d
! index into a 3d index based on the shape information provided.
!
! !REVISION HISTORY:
!
!   Date      Programmer   Description
! ----------  ----------   -----------
! 20.09.10    M. Hanke     created
!
!----------------------------------------------------------------------
!
!  $Id: psmile_transform_index.F90 2580 2010-09-21 12:58:05Z hanke $
!  $Author: hanke $
!
   Character(len=len_cvs_string), save :: mycvs = 
       '$Id: psmile_transform_index.F90 2580 2010-09-21 12:58:05Z hanke $'
!
!----------------------------------------------------------------------
!
!  Initialization
!
      array_size(:) = array_shape(2,:) - array_shape(1,:) + 1

      psmile_transform_index_1d_to_3d(3) = (index_1d-1) / product(array_size(1:2))
      psmile_transform_index_1d_to_3d(2) = (index_1d - 1 - &
                                            psmile_transform_index_1d_to_3d(3) * &
                                            product(array_size(1:2))) / array_size(1)
      psmile_transform_index_1d_to_3d(1) = index_1d - 1 - &
                                           psmile_transform_index_1d_to_3d(2) * &
                                           array_size(1) - &
                                           psmile_transform_index_1d_to_3d(3) * &
                                           product(array_size(1:2))

      psmile_transform_index_1d_to_3d(:) = psmile_transform_index_1d_to_3d(:) + &
                                           array_shape(1,:)

      end function psmile_transform_index_1d_to_3d

!----------------------------------------------------------------------

      function psmile_transform_index_3d_to_1d ( &
                      index_3d, array_shape)
!
! !USES:
!
      use psmile_common, only : ndim_3d
      use psmile, dummy_interface => psmile_transform_index_3d_to_1d

      implicit none
!
! !INPUT PARAMETERS:
!
      integer, intent(in) :: index_3d (ndim_3d)
!     The 1d index which is to be transformed into a 3d one
      integer, intent(in) :: array_shape (2, ndim_3d)
!     The array shape which is used for transforming the 1d index
!
! !RETURN VALUE:
!
      integer :: psmile_transform_index_3d_to_1d

!     Contains the 3d index
!
! !DEFINED PARAMETERS:
!
      integer :: array_size(3), i
!
!
! !DESCRIPTION:
!
! Subroutine "psmile_transform_index_3d_to_1d" transforms a given 3d
! index into a 1d index based on the shape information provided.
!
! !REVISION HISTORY:
!
!   Date      Programmer   Description
! ----------  ----------   -----------
! 20.09.10    M. Hanke     created
!
!----------------------------------------------------------------------
!
!  $Id: psmile_transform_index.F90 2580 2010-09-21 12:58:05Z hanke $
!  $Author: hanke $
!
   Character(len=len_cvs_string), save :: mycvs = 
       '$Id: psmile_transform_index.F90 2580 2010-09-21 12:58:05Z hanke $'
!
!----------------------------------------------------------------------
!
!  Initialization
!
      array_size(:) = array_shape(2,:) - array_shape(1,:) + 1

      psmile_transform_index_3d_to_1d = 1 + &
         (index_3d(1) - array_shape(1,1)) + &
         (index_3d(2) - array_shape(1,2)) * array_size(1) + &
         (index_3d(3) - array_shape(1,3)) * product(array_size(1:2))

      end function psmile_transform_index_3d_to_1d