ecearth3/sources/tm5mp/base/parray_iwp.F90.in

!
! PArray
!
!
! Template for PArray routines with integer arguments.
!
! To generate kind specific versions, use:
!
!    sed -e 's/<wp>/1/g' parray_iwp.f90 > parray_i1.f90
!    sed -e 's/<wp>/2/g' parray_iwp.f90 > parray_i2.f90
!    sed -e 's/<wp>/4/g' parray_iwp.f90 > parray_i4.f90
!    sed -e 's/<wp>/8/g' parray_iwp.f90 > parray_i8.f90
!

module PArray_i<wp>

  implicit none
  
  ! --- in/out -------------------------
  
  private
  
  public    :: pa_Init, pa_Done, pa_SetShape, pa_SetCopy
  
  
  ! --- interfaces ---------------------------
  
  interface pa_Init
    module procedure pa_Init_i<wp>_1d
    module procedure pa_Init_i<wp>_2d
    module procedure pa_Init_i<wp>_3d
    module procedure pa_Init_i<wp>_4d
    module procedure pa_Init_i<wp>_5d
    module procedure pa_Init_i<wp>_6d
    module procedure pa_Init_i<wp>_7d
  end interface
  
  interface pa_Done
    module procedure pa_Done_i<wp>_1d
    module procedure pa_Done_i<wp>_2d
    module procedure pa_Done_i<wp>_3d
    module procedure pa_Done_i<wp>_4d
    module procedure pa_Done_i<wp>_5d
    module procedure pa_Done_i<wp>_6d
    module procedure pa_Done_i<wp>_7d
  end interface
  
  interface pa_SetShape
    module procedure pa_SetShape_i<wp>_1d_shp
    module procedure pa_SetShape_i<wp>_1d_n
    module procedure pa_SetShape_i<wp>_2d_shp
    module procedure pa_SetShape_i<wp>_2d_n
    module procedure pa_SetShape_i<wp>_3d_shp
    module procedure pa_SetShape_i<wp>_3d_n
    module procedure pa_SetShape_i<wp>_4d_shp
    module procedure pa_SetShape_i<wp>_4d_n
    module procedure pa_SetShape_i<wp>_5d_shp
    module procedure pa_SetShape_i<wp>_5d_n
    module procedure pa_SetShape_i<wp>_6d_shp
    module procedure pa_SetShape_i<wp>_6d_n
    module procedure pa_SetShape_i<wp>_7d_shp
    module procedure pa_SetShape_i<wp>_7d_n
  end interface
  
  interface pa_SetCopy
    module procedure pa_SetCopy_i<wp>_1d
    module procedure pa_SetCopy_i<wp>_2d
    module procedure pa_SetCopy_i<wp>_3d
    module procedure pa_SetCopy_i<wp>_4d
    module procedure pa_SetCopy_i<wp>_5d
    module procedure pa_SetCopy_i<wp>_6d
    module procedure pa_SetCopy_i<wp>_7d
  end interface
  
  
contains


  ! =========================================================
  ! ===
  ! === integer(<wp>)
  ! ===
  ! =========================================================
  
  
  ! *******************************************
  ! ***
  ! *** integer(<wp>) 1D
  ! ***
  ! *******************************************
  
  
  subroutine pa_Init_i<wp>_1d( x )
  
    ! --- in/out ---------------------------
    
    integer(<wp>), pointer     ::  x(:)
    
    ! --- begin ---------------------------
    
    nullify( x )
    
  end subroutine pa_Init_i<wp>_1d


  ! ***

  
  subroutine pa_Done_i<wp>_1d( x )
  
    ! --- in/out ---------------------------
    
    integer(<wp>), pointer     ::  x(:)
    
    ! --- begin ---------------------------
    
    if ( associated(x) ) deallocate( x )
    
  end subroutine pa_Done_i<wp>_1d


  ! ***
  
  
  subroutine pa_SetShape_i<wp>_1d_shp( x, n )
  
    ! --- in/out ---------------------------
    
    integer(<wp>), pointer  ::  x(:)
    integer, intent(in)   ::  n(1)
    
    ! --- begin ---------------------------
    
    if ( associated(x) ) then
      if ( any( shape(x) /= n ) ) deallocate( x )
    end if
    if ( .not. associated(x) ) allocate( x(n(1)) )
    
  end subroutine pa_SetShape_i<wp>_1d_shp


  ! ***


  subroutine pa_SetShape_i<wp>_1d_n( x, n1 )
  
    ! --- in/out ---------------------------
    
    integer(<wp>), pointer  ::  x(:)
    integer, intent(in)   ::  n1
    
    ! --- begin ---------------------------
    
    if ( associated(x) ) then
      if ( size(x) /= n1 ) deallocate( x )
    end if
    if ( .not. associated(x) ) allocate( x(n1) )
    
  end subroutine pa_SetShape_i<wp>_1d_n


  ! ***
  
  
  subroutine pa_SetCopy_i<wp>_1d( x, y )
  
    ! --- in/out ---------------------------
    
    integer(<wp>), pointer     ::  x(:)
    integer(<wp>), intent(in)  ::  y(:)
    
    ! --- begin ---------------------------
    
    call pa_SetShape( x, shape(y) )
    x = y
    
  end subroutine pa_SetCopy_i<wp>_1d


  ! *******************************************
  ! ***
  ! *** integer(<wp>) 2D
  ! ***
  ! *******************************************
  
  
  subroutine pa_Init_i<wp>_2d( x )
  
    ! --- in/out ---------------------------
    
    integer(<wp>), pointer     ::  x(:,:)
    
    ! --- begin ---------------------------
    
    nullify( x )
    
  end subroutine pa_Init_i<wp>_2d


  ! ***
  
  
  subroutine pa_Done_i<wp>_2d( x )
  
    ! --- in/out ---------------------------
    
    integer(<wp>), pointer     ::  x(:,:)
    
    ! --- begin ---------------------------
    
    if ( associated(x) ) deallocate( x )
    
  end subroutine pa_Done_i<wp>_2d


  ! ***
  
  
  subroutine pa_SetShape_i<wp>_2d_shp( x, n )
  
    ! --- in/out ---------------------------
    
    integer(<wp>), pointer  ::  x(:,:)
    integer, intent(in)   ::  n(2)
    
    ! --- begin ---------------------------
    
    if ( associated(x) ) then
      if ( any( shape(x) /= n ) ) deallocate( x )
    end if
    if ( .not. associated(x) ) allocate( x(n(1),n(2)) )
    
  end subroutine pa_SetShape_i<wp>_2d_shp


  ! ***
  
  
  subroutine pa_SetShape_i<wp>_2d_n( x, n1, n2 )
  
    ! --- in/out ---------------------------
    
    integer(<wp>), pointer  ::  x(:,:)
    integer, intent(in)   ::  n1, n2
    
    ! --- begin ---------------------------
    
    call pa_SetShape( x, (/n1,n2/) )
    
  end subroutine pa_SetShape_i<wp>_2d_n


  ! ***
  
  
  subroutine pa_SetCopy_i<wp>_2d( x, y )
  
    ! --- in/out ---------------------------
    
    integer(<wp>), pointer     ::  x(:,:)
    integer(<wp>), intent(in)  ::  y(:,:)
    
    ! --- begin ---------------------------
    
    call pa_SetShape( x, shape(y) )
    x = y
    
  end subroutine pa_SetCopy_i<wp>_2d


  ! *******************************************
  ! ***
  ! *** integer(<wp>) 3D
  ! ***
  ! *******************************************
  
  
  subroutine pa_Init_i<wp>_3d( x )
  
    ! --- in/out ---------------------------
    
    integer(<wp>), pointer     ::  x(:,:,:)
    
    ! --- begin ---------------------------
    
    nullify( x )
    
  end subroutine pa_Init_i<wp>_3d


  ! ***
  
  
  subroutine pa_Done_i<wp>_3d( x )
  
    ! --- in/out ---------------------------
    
    integer(<wp>), pointer     ::  x(:,:,:)
    
    ! --- begin ---------------------------
    
    if ( associated(x) ) deallocate( x )
    
  end subroutine pa_Done_i<wp>_3d


  ! ***
  
  
  subroutine pa_SetShape_i<wp>_3d_shp( x, n )
  
    ! --- in/out ---------------------------
    
    integer(<wp>), pointer  ::  x(:,:,:)
    integer, intent(in)   ::  n(3)
    
    ! --- begin ---------------------------
    
    if ( associated(x) ) then
      if ( any( shape(x) /= n ) ) deallocate( x )
    end if
    if ( .not. associated(x) ) allocate( x(n(1),n(2),n(3)) )
    
  end subroutine pa_SetShape_i<wp>_3d_shp


  ! ***
  
  
  subroutine pa_SetShape_i<wp>_3d_n( x, n1, n2, n3 )
  
    ! --- in/out ---------------------------
    
    integer(<wp>), pointer  ::  x(:,:,:)
    integer, intent(in)   ::  n1, n2, n3
    
    ! --- begin ---------------------------
    
    call pa_SetShape( x, (/n1,n2,n3/) )
    
  end subroutine pa_SetShape_i<wp>_3d_n


  ! ***
  
  
  subroutine pa_SetCopy_i<wp>_3d( x, y )
  
    ! --- in/out ---------------------------
    
    integer(<wp>), pointer     ::  x(:,:,:)
    integer(<wp>), intent(in)  ::  y(:,:,:)
    
    ! --- begin ---------------------------
    
    call pa_SetShape( x, shape(y) )
    x = y
    
  end subroutine pa_SetCopy_i<wp>_3d


  ! *******************************************
  ! ***
  ! *** integer(<wp>) 4D
  ! ***
  ! *******************************************
  
  
  subroutine pa_Init_i<wp>_4d( x )
  
    ! --- in/out ---------------------------
    
    integer(<wp>), pointer     ::  x(:,:,:,:)
    
    ! --- begin ---------------------------
    
    nullify( x )
    
  end subroutine pa_Init_i<wp>_4d


  ! ***
  
  
  subroutine pa_Done_i<wp>_4d( x )
  
    ! --- in/out ---------------------------
    
    integer(<wp>), pointer     ::  x(:,:,:,:)
    
    ! --- begin ---------------------------
    
    if ( associated(x) ) deallocate( x )
    
  end subroutine pa_Done_i<wp>_4d


  ! ***
  
  
  subroutine pa_SetShape_i<wp>_4d_shp( x, n )
  
    ! --- in/out ---------------------------
    
    integer(<wp>), pointer  ::  x(:,:,:,:)
    integer, intent(in)   ::  n(4)
    
    ! --- begin ---------------------------
    
    if ( associated(x) ) then
      if ( any( shape(x) /= n ) ) deallocate( x )
    end if
    if ( .not. associated(x) ) allocate( x(n(1),n(2),n(3),n(4)) )
    
  end subroutine pa_SetShape_i<wp>_4d_shp


  ! ***
  
  
  subroutine pa_SetShape_i<wp>_4d_n( x, n1, n2, n3, n4 )
  
    ! --- in/out ---------------------------
    
    integer(<wp>), pointer  ::  x(:,:,:,:)
    integer, intent(in)   ::  n1, n2, n3, n4
    
    ! --- begin ---------------------------
    
    call pa_SetShape( x, (/n1,n2,n3,n4/) )
    
  end subroutine pa_SetShape_i<wp>_4d_n


  ! ***
  
  
  subroutine pa_SetCopy_i<wp>_4d( x, y )
  
    ! --- in/out ---------------------------
    
    integer(<wp>), pointer     ::  x(:,:,:,:)
    integer(<wp>), intent(in)  ::  y(:,:,:,:)
    
    ! --- begin ---------------------------
    
    call pa_SetShape( x, shape(y) )
    x = y
    
  end subroutine pa_SetCopy_i<wp>_4d


  ! *******************************************
  ! ***
  ! *** integer(<wp>) 5D
  ! ***
  ! *******************************************
  
  
  subroutine pa_Init_i<wp>_5d( x )
  
    ! --- in/out ---------------------------
    
    integer(<wp>), pointer     ::  x(:,:,:,:,:)
    
    ! --- begin ---------------------------
    
    nullify( x )
    
  end subroutine pa_Init_i<wp>_5d


  ! ***
  
  
  subroutine pa_Done_i<wp>_5d( x )
  
    ! --- in/out ---------------------------
    
    integer(<wp>), pointer     ::  x(:,:,:,:,:)
    
    ! --- begin ---------------------------
    
    if ( associated(x) ) deallocate( x )
    
  end subroutine pa_Done_i<wp>_5d


  ! ***
  
  
  subroutine pa_SetShape_i<wp>_5d_shp( x, n )
  
    ! --- in/out ---------------------------
    
    integer(<wp>), pointer  ::  x(:,:,:,:,:)
    integer, intent(in)   ::  n(5)
    
    ! --- begin ---------------------------
    
    if ( associated(x) ) then
      if ( any( shape(x) /= n ) ) deallocate( x )
    end if
    if ( .not. associated(x) ) allocate( x(n(1),n(2),n(3),n(4),n(5)) )
    
  end subroutine pa_SetShape_i<wp>_5d_shp


  ! ***
  
  
  subroutine pa_SetShape_i<wp>_5d_n( x, n1, n2, n3, n4, n5 )
  
    ! --- in/out ---------------------------
    
    integer(<wp>), pointer  ::  x(:,:,:,:,:)
    integer, intent(in)   ::  n1, n2, n3, n4, n5
    
    ! --- begin ---------------------------
    
    call pa_SetShape( x, (/n1,n2,n3,n4,n5/) )
    
  end subroutine pa_SetShape_i<wp>_5d_n


  ! ***
  
  
  subroutine pa_SetCopy_i<wp>_5d( x, y )
  
    ! --- in/out ---------------------------
    
    integer(<wp>), pointer     ::  x(:,:,:,:,:)
    integer(<wp>), intent(in)  ::  y(:,:,:,:,:)
    
    ! --- begin ---------------------------
    
    call pa_SetShape( x, shape(y) )
    x = y
    
  end subroutine pa_SetCopy_i<wp>_5d


  ! *******************************************
  ! ***
  ! *** integer(<wp>) 6D
  ! ***
  ! *******************************************
  
  
  subroutine pa_Init_i<wp>_6d( x )
  
    ! --- in/out ---------------------------
    
    integer(<wp>), pointer     ::  x(:,:,:,:,:,:)
    
    ! --- begin ---------------------------
    
    nullify( x )
    
  end subroutine pa_Init_i<wp>_6d


  ! ***
  
  
  subroutine pa_Done_i<wp>_6d( x )
  
    ! --- in/out ---------------------------
    
    integer(<wp>), pointer     ::  x(:,:,:,:,:,:)
    
    ! --- begin ---------------------------
    
    if ( associated(x) ) deallocate( x )
    
  end subroutine pa_Done_i<wp>_6d


  ! ***
  
  
  subroutine pa_SetShape_i<wp>_6d_shp( x, n )
  
    ! --- in/out ---------------------------
    
    integer(<wp>), pointer  ::  x(:,:,:,:,:,:)
    integer, intent(in)   ::  n(6)
    
    ! --- begin ---------------------------
    
    if ( associated(x) ) then
      if ( any( shape(x) /= n ) ) deallocate( x )
    end if
    if ( .not. associated(x) ) allocate( x(n(1),n(2),n(3),n(4),n(5),n(6)) )
    
  end subroutine pa_SetShape_i<wp>_6d_shp


  ! ***
  
  
  subroutine pa_SetShape_i<wp>_6d_n( x, n1, n2, n3, n4, n5, n6 )
  
    ! --- in/out ---------------------------
    
    integer(<wp>), pointer  ::  x(:,:,:,:,:,:)
    integer, intent(in)   ::  n1, n2, n3, n4, n5, n6
    
    ! --- begin ---------------------------
    
    call pa_SetShape( x, (/n1,n2,n3,n4,n5,n6/) )
    
  end subroutine pa_SetShape_i<wp>_6d_n


  ! ***
  
  
  subroutine pa_SetCopy_i<wp>_6d( x, y )
  
    ! --- in/out ---------------------------
    
    integer(<wp>), pointer     ::  x(:,:,:,:,:,:)
    integer(<wp>), intent(in)  ::  y(:,:,:,:,:,:)
    
    ! --- begin ---------------------------
    
    call pa_SetShape( x, shape(y) )
    x = y
    
  end subroutine pa_SetCopy_i<wp>_6d


  ! *******************************************
  ! ***
  ! *** integer(<wp>) 7D
  ! ***
  ! *******************************************
  
  
  subroutine pa_Init_i<wp>_7d( x )
  
    ! --- in/out ---------------------------
    
    integer(<wp>), pointer     ::  x(:,:,:,:,:,:,:)
    
    ! --- begin ---------------------------
    
    nullify( x )
    
  end subroutine pa_Init_i<wp>_7d


  ! ***
  
  
  subroutine pa_Done_i<wp>_7d( x )
  
    ! --- in/out ---------------------------
    
    integer(<wp>), pointer     ::  x(:,:,:,:,:,:,:)
    
    ! --- begin ---------------------------
    
    if ( associated(x) ) deallocate( x )
    
  end subroutine pa_Done_i<wp>_7d


  ! ***
  
  
  subroutine pa_SetShape_i<wp>_7d_shp( x, n )
  
    ! --- in/out ---------------------------
    
    integer(<wp>), pointer  ::  x(:,:,:,:,:,:,:)
    integer, intent(in)   ::  n(7)
    
    ! --- begin ---------------------------
    
    if ( associated(x) ) then
      if ( any( shape(x) /= n ) ) deallocate( x )
    end if
    if ( .not. associated(x) ) allocate( x(n(1),n(2),n(3),n(4),n(5),n(6),n(7)) )
    
  end subroutine pa_SetShape_i<wp>_7d_shp


  ! ***
  
  
  subroutine pa_SetShape_i<wp>_7d_n( x, n1, n2, n3, n4, n5, n6, n7 )
  
    ! --- in/out ---------------------------
    
    integer(<wp>), pointer  ::  x(:,:,:,:,:,:,:)
    integer, intent(in)   ::  n1, n2, n3, n4, n5, n6, n7
    
    ! --- begin ---------------------------
    
    call pa_SetShape( x, (/n1,n2,n3,n4,n5,n6,n7/) )
    
  end subroutine pa_SetShape_i<wp>_7d_n


  ! ***
  
  
  subroutine pa_SetCopy_i<wp>_7d( x, y )
  
    ! --- in/out ---------------------------
    
    integer(<wp>), pointer     ::  x(:,:,:,:,:,:,:)
    integer(<wp>), intent(in)  ::  y(:,:,:,:,:,:,:)
    
    ! --- begin ---------------------------
    
    call pa_SetShape( x, shape(y) )
    x = y
    
  end subroutine pa_SetCopy_i<wp>_7d




end module PArray_i<wp>