scale_file_external_input_cartesC.F90

Go to the documentation of this file.

!-------------------------------------------------------------------------------
!-------------------------------------------------------------------------------
#include "scalelib.h"
module scale_file_external_input_cartesc
  !-----------------------------------------------------------------------------
  !
  !++ Used modules
  !
  use scale_precision
  use scale_io
  use scale_prof
  use scale_atmos_grid_cartesc_index
  use scale_ocean_grid_cartesc_index
  use scale_land_grid_cartesc_index
  use scale_urban_grid_cartesc_index
  !-----------------------------------------------------------------------------
  implicit none
  private
  !-----------------------------------------------------------------------------
  !
  !++ Public procedures
  !
  public :: file_external_input_cartesc_setup
  public :: file_external_input_cartesc_finalize
 
  !-----------------------------------------------------------------------------
  !
  !++ Public parameters & variables
  !
  private :: file_external_input_cartesc_get_dims1d
  private :: file_external_input_cartesc_get_dims2d
  private :: file_external_input_cartesc_get_dims3d
 
  !-----------------------------------------------------------------------------
  !
  !++ Private procedures
  !
  !-----------------------------------------------------------------------------
  !
  !++ Private parameters & variables
  !
  !-----------------------------------------------------------------------------
contains
  !-----------------------------------------------------------------------------
  subroutine file_external_input_cartesc_setup
    use scale_file_external_input, only: &
       file_external_input_setup, &
       file_external_input_get_dims1d, &
       file_external_input_get_dims2d, &
       file_external_input_get_dims3d, &
       file_external_input_read_1d,    &
       file_external_input_read_2d,    &
       file_external_input_read_3d
 
    call file_external_input_setup
 
    file_external_input_get_dims1d => file_external_input_cartesc_get_dims1d
    file_external_input_get_dims2d => file_external_input_cartesc_get_dims2d
    file_external_input_get_dims3d => file_external_input_cartesc_get_dims3d
 
    file_external_input_read_1d => file_external_input_cartesc_read_1d
    file_external_input_read_2d => file_external_input_cartesc_read_2d
    file_external_input_read_3d => file_external_input_cartesc_read_3d
 
    return
  end subroutine file_external_input_cartesc_setup
 
  !-----------------------------------------------------------------------------
  subroutine file_external_input_cartesc_finalize
    use scale_file_external_input, only: &
       file_external_input_finalize
 
    call file_external_input_finalize
 
    return
  end subroutine file_external_input_cartesc_finalize
 
  !-----------------------------------------------------------------------------
  subroutine file_external_input_cartesc_get_dims1d( &
       dim1_size, &
       dim1_max,  &
       dim1_S,    &
       varname,   &
       axistype   )
    use scale_prc, only: &
       prc_abort
    implicit none
    integer,          intent(out) :: dim1_size
    integer,          intent(out) :: dim1_max
    integer,          intent(out) :: dim1_s
    character(len=*), intent(in)  :: varname
    character(len=*), intent(in)  :: axistype     ! axis type (Z/X/Y)
 
    select case ( axistype )
    case ( 'Z' )
       dim1_size = ka
       dim1_max  = kmax
       dim1_s    = ks
    case ( 'X' )
       dim1_size = ia
       dim1_max  = imaxb
       dim1_s    = isb
    case ( 'Y' )
       dim1_size = ja
       dim1_max  = jmaxb
       dim1_s    = jsb
    case ( 'OZ' )
       dim1_size = oka
       dim1_max  = okmax
       dim1_s    = oks
    case default
       log_error("FILE_EXTERNAL_INPUT_CARTESC_get_dims1D",*) 'unsupported axis type. Check! axistype:', trim(axistype), ', item:',trim(varname)
       call prc_abort
    end select
 
    return
  end subroutine file_external_input_cartesc_get_dims1d
 
  subroutine file_external_input_cartesc_get_dims2d( &
       dim1_size, &
       dim1_max,  &
       dim1_S,    &
       dim2_size, &
       dim2_max,  &
       dim2_S,    &
       transpose, &
       varname,   &
       axistype   )
    use scale_prc, only: &
       prc_abort
    implicit none
    integer,          intent(out) :: dim1_size
    integer,          intent(out) :: dim1_max
    integer,          intent(out) :: dim1_s
    integer,          intent(out) :: dim2_size
    integer,          intent(out) :: dim2_max
    integer,          intent(out) :: dim2_s
    logical,          intent(out) :: transpose
    character(len=*), intent(in)  :: varname
    character(len=*), intent(in)  :: axistype     ! axis type (XY/XZ/ZX)
 
    select case ( axistype )
    case ( 'XY' )
       dim1_size = ia
       dim1_max  = imaxb
       dim1_s    = isb
       dim2_size = ja
       dim2_max  = jmaxb
       dim2_s    = jsb
       transpose = .false.
    case ( 'ZX' )
       dim1_size = ka
       dim1_max  = kmax
       dim1_s    = ks
       dim2_size = ia
       dim2_max  = imaxb
       dim2_s    = isb
       transpose = .false.
    case ( 'XZ' )
       dim1_size = ia
       dim1_max  = imaxb
       dim1_s    = isb
       dim2_size = ka
       dim2_max  = kmax
       dim2_s    = ks
       transpose = .true.
    case default
       log_error("FILE_EXTERNAL_INPUT_CARTESC_get_dims2D",*) 'unsupported axis type. Check! axistype:', trim(axistype), ', item:',trim(varname)
       call prc_abort
    end select
 
    return
  end subroutine file_external_input_cartesc_get_dims2d
 
  subroutine file_external_input_cartesc_get_dims3d( &
       dim1_size, &
       dim1_max,  &
       dim1_S,    &
       dim2_size, &
       dim2_max,  &
       dim2_S,    &
       dim3_size, &
       dim3_max,  &
       dim3_S,    &
       transpose, &
       varname,   &
       axistype   )
    use scale_prc, only: &
       prc_abort
    implicit none
    integer,          intent(out) :: dim1_size
    integer,          intent(out) :: dim1_max
    integer,          intent(out) :: dim1_s
    integer,          intent(out) :: dim2_size
    integer,          intent(out) :: dim2_max
    integer,          intent(out) :: dim2_s
    integer,          intent(out) :: dim3_size
    integer,          intent(out) :: dim3_max
    integer,          intent(out) :: dim3_s
    logical,          intent(out) :: transpose
    character(len=*), intent(in)  :: varname
    character(len=*), intent(in)  :: axistype     ! axis type (ZXY/XYZ/LXY/XYL/UXY/XYU)
 
    select case ( axistype )
    case ( 'ZXY' )
       dim1_size = ka
       dim1_max  = kmax
       dim1_s    = ks
       dim2_size = ia
       dim2_max  = imaxb
       dim2_s    = isb
       dim3_size = ja
       dim3_max  = jmaxb
       dim3_s    = jsb
       transpose = .false.
    case ( 'XYZ' )
       dim1_size = ia
       dim1_max  = imaxb
       dim1_s    = isb
       dim2_size = ja
       dim2_max  = jmaxb
       dim2_s    = jsb
       dim3_size = ka
       dim3_max  = kmax
       dim3_s    = ks
       transpose = .true.
    case ( 'OXY' ) ! OCEAN
       dim1_size = oka
       dim1_max  = okmax
       dim1_s    = oks
       dim2_size = ia
       dim2_max  = imaxb
       dim2_s    = isb
       dim3_size = ja
       dim3_max  = jmaxb
       dim3_s    = jsb
       transpose = .false.
    case ( 'XYO' ) ! OCEAN
       dim1_size = ia
       dim1_max  = imaxb
       dim1_s    = isb
       dim2_size = ja
       dim2_max  = jmaxb
       dim2_s    = jsb
       dim3_size = oka
       dim3_max  = okmax
       dim3_s    = oks
       transpose = .true.
    case ( 'LXY' ) ! LAND
       dim1_size = lka
       dim1_max  = lkmax
       dim1_s    = lks
       dim2_size = ia
       dim2_max  = imaxb
       dim2_s    = isb
       dim3_size = ja
       dim3_max  = jmaxb
       dim3_s    = jsb
       transpose = .false.
    case ( 'XYL' ) ! LAND
       dim1_size = ia
       dim1_max = imaxb
       dim1_s   = isb
       dim2_size = ja
       dim2_max  = jmaxb
       dim2_s    = jsb
       dim3_size = lka
       dim3_max  = lkmax
       dim3_s    = lks
       transpose = .true.
    case ( 'UXY' )
       dim1_size = uka
       dim1_max  = ukmax
       dim1_s    = uks
       dim2_size = ia
       dim2_max  = imaxb
       dim2_s    = isb
       dim3_size = ja
       dim3_max  = jmaxb
       dim3_s    = jsb
       transpose = .false.
    case ( 'XYU' )
       dim1_size = ia
       dim1_max  = imaxb
       dim1_s    = isb
       dim2_size = ja
       dim2_max  = jmaxb
       dim2_s    = jsb
       dim3_size = uka
       dim3_max  = ukmax
       dim3_s    = uks
       transpose = .true.
    case default
       log_error("FILE_EXTERNAL_INPUT_CARTESC_get_dims3D",*) 'unsupported axis type. Check! axistype:', trim(axistype), ', item:',trim(varname)
       call prc_abort
    end select
 
    return
  end subroutine file_external_input_cartesc_get_dims3d
 
 
  subroutine file_external_input_cartesc_read_1d( &
       fid, varname, &
       dim_type,     &
       var,          &
       step          )
    use scale_file_cartesc, only: &
       file_cartesc_read, &
       file_cartesc_flush
    implicit none
    integer,          intent(in)  :: fid
    character(len=*), intent(in)  :: varname
    character(len=*), intent(in)  :: dim_type
    real(RP),         intent(out) :: var(:)
    integer,          intent(in), optional :: step
 
    call file_cartesc_read( fid, varname, dim_type, & ! [IN]
                            var(:),                 & ! [OUT]
                            step = step             ) ! [IN]
 
    call file_cartesc_flush( fid )
 
    return
  end subroutine file_external_input_cartesc_read_1d
 
  subroutine file_external_input_cartesc_read_2d( &
       fid, varname, &
       dim_type,     &
       var,          &
       step          )
    use scale_file_cartesc, only: &
       file_cartesc_read, &
       file_cartesc_flush
    implicit none
    integer,          intent(in)  :: fid
    character(len=*), intent(in)  :: varname
    character(len=*), intent(in)  :: dim_type
    real(RP),         intent(out) :: var(:,:)
    integer,          intent(in), optional :: step
 
    call file_cartesc_read( fid, varname, dim_type, & ! [IN]
                            var(:,:),               & ! [OUT]
                            step = step             ) ! [IN]
 
    call file_cartesc_flush( fid )
 
    return
  end subroutine file_external_input_cartesc_read_2d
 
  subroutine file_external_input_cartesc_read_3d( &
       fid, varname, &
       dim_type,     &
       var,          &
       step          )
    use scale_file_cartesc, only: &
       file_cartesc_read, &
       file_cartesc_flush
    implicit none
    integer,          intent(in)  :: fid
    character(len=*), intent(in)  :: varname
    character(len=*), intent(in)  :: dim_type
    real(RP),         intent(out) :: var(:,:,:)
    integer,          intent(in), optional :: step
 
    call file_cartesc_read( fid, varname, dim_type, & ! [IN]
                            var(:,:,:),             & ! [OUT]
                            step = step             ) ! [IN]
 
    call file_cartesc_flush( fid )
 
    return
  end subroutine file_external_input_cartesc_read_3d
 
end module scale_file_external_input_cartesc