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 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

    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

    return
  end subroutine file_external_input_cartesc_setup

  !-----------------------------------------------------------------------------
  subroutine file_external_input_cartesc_get_dims1d( &
       dim1_max, &
       dim1_S,   &
       dim1_E,   &
       varname,  &
       axistype  )
    use scale_prc, only: &
       prc_abort
    implicit none
    integer,          intent(out) :: dim1_max
    integer,          intent(out) :: dim1_S
    integer,          intent(out) :: dim1_E
    character(len=*), intent(in)  :: varname
    character(len=*), intent(in)  :: axistype     ! axis type (Z/X/Y)

    select case ( axistype )
    case ( 'Z' )
       dim1_max = kmax
       dim1_s   = ks
       dim1_e   = ke
    case ( 'X' )
       dim1_max = imaxb
       dim1_s   = isb
       dim1_e   = ieb
    case ( 'Y' )
       dim1_max = jmaxb
       dim1_s   = jsb
       dim1_e   = jeb
    case ( 'OZ' )
       dim1_max = okmax
       dim1_s   = oks
       dim1_e   = oke
    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_max,  &
       dim1_S,    &
       dim1_E,    &
       dim2_max,  &
       dim2_S,    &
       dim2_E,    &
       transpose, &
       varname,   &
       axistype   )
    use scale_prc, only: &
       prc_abort
    implicit none
    integer,          intent(out) :: dim1_max
    integer,          intent(out) :: dim1_S
    integer,          intent(out) :: dim1_E
    integer,          intent(out) :: dim2_max
    integer,          intent(out) :: dim2_S
    integer,          intent(out) :: dim2_E
    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_max = imaxb
       dim2_max = jmaxb
       dim1_s   = isb
       dim1_e   = ieb
       dim2_s   = jsb
       dim2_e   = jeb
       transpose = .false.
    case ( 'ZX' )
       dim1_max = kmax
       dim2_max = imaxb
       dim1_s   = ks
       dim1_e   = ke
       dim2_s   = isb
       dim2_e   = ieb
       transpose = .false.
    case ( 'XZ' )
       dim1_max = imaxb
       dim2_max = kmax
       dim1_s   = isb
       dim1_e   = ieb
       dim2_s   = ks
       dim2_e   = ke
       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_max,  &
       dim1_S,    &
       dim1_E,    &
       dim2_max,  &
       dim2_S,    &
       dim2_E,    &
       dim3_max,  &
       dim3_S,    &
       dim3_E,    &
       transpose, &
       varname,   &
       axistype   )
    use scale_prc, only: &
       prc_abort
    implicit none
    integer,          intent(out) :: dim1_max
    integer,          intent(out) :: dim1_S
    integer,          intent(out) :: dim1_E
    integer,          intent(out) :: dim2_max
    integer,          intent(out) :: dim2_S
    integer,          intent(out) :: dim2_E
    integer,          intent(out) :: dim3_max
    integer,          intent(out) :: dim3_S
    integer,          intent(out) :: dim3_E
    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_max = kmax
       dim2_max = imaxb
       dim3_max = jmaxb
       dim1_s   = ks
       dim1_e   = ke
       dim2_s   = isb
       dim2_e   = ieb
       dim3_s   = jsb
       dim3_e   = jeb
       transpose = .false.
    case ( 'XYZ' )
       dim1_max = imaxb
       dim2_max = jmaxb
       dim3_max = kmax
       dim1_s   = isb
       dim1_e   = ieb
       dim2_s   = jsb
       dim2_e   = jeb
       dim3_s   = ks
       dim3_e   = ke
       transpose = .true.
    case ( 'OXY' ) ! OCEAN
       dim1_max = okmax
       dim2_max = imaxb
       dim3_max = jmaxb
       dim1_s   = oks
       dim1_e   = oke
       dim2_s   = isb
       dim2_e   = ieb
       dim3_s   = jsb
       dim3_e   = jeb
       transpose = .false.
    case ( 'XYO' ) ! OCEAN
       dim1_max = imaxb
       dim2_max = jmaxb
       dim3_max = okmax
       dim1_s   = isb
       dim1_e   = ieb
       dim2_s   = jsb
       dim2_e   = jeb
       dim3_s   = oks
       dim3_e   = oke
       transpose = .true.
    case ( 'LXY' ) ! LAND
       dim1_max = lkmax
       dim2_max = imaxb
       dim3_max = jmaxb
       dim1_s   = lks
       dim1_e   = lke
       dim2_s   = isb
       dim2_e   = ieb
       dim3_s   = jsb
       dim3_e   = jeb
       transpose = .false.
    case ( 'XYL' ) ! LAND
       dim1_max = imaxb
       dim2_max = jmaxb
       dim3_max = lkmax
       dim1_s   = isb
       dim1_e   = ieb
       dim2_s   = jsb
       dim2_e   = jeb
       dim3_s   = lks
       dim3_e   = lke
       transpose = .true.
    case ( 'UXY' )
       dim1_max = ukmax
       dim2_max = imaxb
       dim3_max = jmaxb
       dim1_s   = uks
       dim1_e   = uke
       dim2_s   = isb
       dim2_e   = ieb
       dim3_s   = jsb
       dim3_e   = jeb
       transpose = .false.
    case ( 'XYU' )
       dim1_max = imaxb
       dim2_max = jmaxb
       dim3_max = ukmax
       dim1_s   = isb
       dim1_e   = ieb
       dim2_s   = jsb
       dim2_e   = jeb
       dim3_s   = uks
       dim3_e   = uke
       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

end module scale_file_external_input_cartesc