mod_atmos_phy_tb_vars.F90

Go to the documentation of this file.

!-------------------------------------------------------------------------------
!-------------------------------------------------------------------------------
#include "scalelib.h"
module mod_atmos_phy_tb_vars
  !-----------------------------------------------------------------------------
  !
  !++ used modules
  !
  use scale_precision
  use scale_io
  use scale_prof
  use scale_atmos_grid_cartesc_index
  use scale_tracer
  !-----------------------------------------------------------------------------
  implicit none
  private
  !-----------------------------------------------------------------------------
  !
  !++ Public procedure
  !
  public :: atmos_phy_tb_vars_setup
  public :: atmos_phy_tb_vars_fillhalo
  public :: atmos_phy_tb_vars_restart_read
  public :: atmos_phy_tb_vars_restart_write

  public :: atmos_phy_tb_vars_restart_create
  public :: atmos_phy_tb_vars_restart_open
  public :: atmos_phy_tb_vars_restart_def_var
  public :: atmos_phy_tb_vars_restart_enddef
  public :: atmos_phy_tb_vars_restart_close

  !-----------------------------------------------------------------------------
  !
  !++ Public parameters & variables
  !
  logical,               public :: atmos_phy_tb_restart_output                 = .false.                

  character(len=H_LONG),  public :: atmos_phy_tb_restart_in_basename           = ''
  logical,                public :: atmos_phy_tb_restart_in_aggregate
  logical,                public :: atmos_phy_tb_restart_in_postfix_timelabel  = .false.                
  character(len=H_LONG),  public :: atmos_phy_tb_restart_out_basename          = ''
  logical,                public :: atmos_phy_tb_restart_out_aggregate
  logical,                public :: atmos_phy_tb_restart_out_postfix_timelabel = .true.                 
  character(len=H_MID),   public :: atmos_phy_tb_restart_out_title             = 'ATMOS_PHY_TB restart'
  character(len=H_SHORT), public :: atmos_phy_tb_restart_out_dtype             = 'DEFAULT'

  real(RP), public, allocatable :: atmos_phy_tb_momz_t(:,:,:)   ! tendency MOMZ [kg/m2/s2]
  real(RP), public, allocatable :: atmos_phy_tb_momx_t(:,:,:)   ! tendency MOMX [kg/m2/s2]
  real(RP), public, allocatable :: atmos_phy_tb_momy_t(:,:,:)   ! tendency MOMY [kg/m2/s2]
  real(RP), public, allocatable :: atmos_phy_tb_rhot_t(:,:,:)   ! tendency RHOT [K*kg/m3/s]
  real(RP), public, allocatable :: atmos_phy_tb_rhoq_t(:,:,:,:) ! tendency rho*QTRC [kg/kg/s]

  integer, public :: i_tke = -1

  !-----------------------------------------------------------------------------
  !
  !++ Private procedure
  !
  !-----------------------------------------------------------------------------
  !
  !++ Private parameters & variables
  !
!  integer,                private, parameter :: VMAX = 0       !< number of the variables
!  character(len=H_SHORT), private            :: VAR_NAME(VMAX) !< name  of the variables
!  character(len=H_MID),   private            :: VAR_DESC(VMAX) !< desc. of the variables
!  character(len=H_SHORT), private            :: VAR_UNIT(VMAX) !< unit  of the variables
!  integer,                private            :: VAR_ID(VMAX)   !< ID    of the variables
!  integer,                private            :: restart_fid = -1  ! file ID

  !-----------------------------------------------------------------------------
contains
  !-----------------------------------------------------------------------------
  subroutine atmos_phy_tb_vars_setup
    use scale_prc, only: &
       prc_abort
    use scale_const, only: &
       undef => const_undef
    implicit none

    namelist / param_atmos_phy_tb_vars / &
       atmos_phy_tb_restart_in_basename,           &
       atmos_phy_tb_restart_in_aggregate,          &
       atmos_phy_tb_restart_in_postfix_timelabel,  &
       atmos_phy_tb_restart_output,                &
       atmos_phy_tb_restart_out_basename,          &
       atmos_phy_tb_restart_out_aggregate,         &
       atmos_phy_tb_restart_out_postfix_timelabel, &
       atmos_phy_tb_restart_out_title,             &
       atmos_phy_tb_restart_out_dtype

    integer :: ierr
    integer :: iv
    !---------------------------------------------------------------------------

    log_newline
    log_info("ATMOS_PHY_TB_vars_setup",*) 'Setup'

    allocate( atmos_phy_tb_momz_t(ka,ia,ja)    )
    allocate( atmos_phy_tb_momx_t(ka,ia,ja)    )
    allocate( atmos_phy_tb_momy_t(ka,ia,ja)    )
    allocate( atmos_phy_tb_rhot_t(ka,ia,ja)    )
    allocate( atmos_phy_tb_rhoq_t(ka,ia,ja,qa) )
    atmos_phy_tb_momz_t(:,:,:)   = undef
    atmos_phy_tb_momx_t(:,:,:)   = undef
    atmos_phy_tb_momy_t(:,:,:)   = undef
    atmos_phy_tb_rhot_t(:,:,:)   = undef
    atmos_phy_tb_rhoq_t(:,:,:,:) = undef

    !--- read namelist
    rewind(io_fid_conf)
    read(io_fid_conf,nml=param_atmos_phy_tb_vars,iostat=ierr)
    if( ierr < 0 ) then !--- missing
       log_info("ATMOS_PHY_TB_vars_setup",*) 'Not found namelist. Default used.'
    elseif( ierr > 0 ) then !--- fatal error
       log_error("ATMOS_PHY_TB_vars_setup",*) 'Not appropriate names in namelist PARAM_ATMOS_PHY_TB_VARS. Check!'
       call prc_abort
    endif
    log_nml(param_atmos_phy_tb_vars)

!    LOG_NEWLINE
!    LOG_INFO("ATMOS_PHY_TB_vars_setup",*) '[ATMOS_PHY_TB] prognostic/diagnostic variables'
!    LOG_INFO_CONT('(1x,A,A24,A,A48,A,A12,A)') &
!               '      |', 'VARNAME                 ','|', &
!               'DESCRIPTION                                     ', '[', 'UNIT        ', ']'
!    do iv = 1, VMAX
!       LOG_INFO_CONT('(1x,A,I3,A,A24,A,A48,A,A12,A)') &
!                  'NO.',iv,'|',VAR_NAME(iv),'|',VAR_DESC(iv),'[',VAR_UNIT(iv),']'
!    enddo

!    LOG_NEWLINE
!    if ( ATMOS_PHY_TB_RESTART_IN_BASENAME /= '' ) then
!       LOG_INFO("ATMOS_PHY_TB_vars_setup",*) 'Restart input?  : YES, file = ', trim(ATMOS_PHY_TB_RESTART_IN_BASENAME)
!       LOG_INFO("ATMOS_PHY_TB_vars_setup",*) 'Add timelabel?  : ', ATMOS_PHY_TB_RESTART_IN_POSTFIX_TIMELABEL
!    else
!       LOG_INFO("ATMOS_PHY_TB_vars_setup",*) 'Restart input?  : NO'
!    endif
!    if (       ATMOS_PHY_TB_RESTART_OUTPUT             &
!         .AND. ATMOS_PHY_TB_RESTART_OUT_BASENAME /= '' ) then
!       LOG_INFO("ATMOS_PHY_TB_vars_setup",*) 'Restart output? : YES, file = ', trim(ATMOS_PHY_TB_RESTART_OUT_BASENAME)
!       LOG_INFO("ATMOS_PHY_TB_vars_setup",*) 'Add timelabel?  : ', ATMOS_PHY_TB_RESTART_OUT_POSTFIX_TIMELABEL
!    else
!       LOG_INFO("ATMOS_PHY_TB_vars_setup",*) 'Restart output? : NO'
!       ATMOS_PHY_TB_RESTART_OUTPUT = .false.
!    endif

    return
  end subroutine atmos_phy_tb_vars_setup

  !-----------------------------------------------------------------------------
  subroutine atmos_phy_tb_vars_fillhalo
    use scale_comm_cartesc, only: &
       comm_vars8, &
       comm_wait
    implicit none
    !---------------------------------------------------------------------------

!    do j  = 1, JA
!    do i  = 1, IA
!       ATMOS_PHY_TB_??(   1:KS-1,i,j) = ATMOS_PHY_TB_??(KS,i,j)
!       ATMOS_PHY_TB_??(KE+1:KA,  i,j) = ATMOS_PHY_TB_??(KE,i,j)
!    enddo
!    enddo

!    call COMM_vars8( ATMOS_PHY_TB_??(:,:,:), 1 )
!    call COMM_wait ( ATMOS_PHY_TB_??(:,:,:), 1 )

    return
  end subroutine atmos_phy_tb_vars_fillhalo

  !-----------------------------------------------------------------------------
  subroutine atmos_phy_tb_vars_restart_open
    use scale_time, only: &
       time_gettimelabel
    use scale_file_cartesc, only: &
       file_cartesc_open
    implicit none

    character(len=19)     :: timelabel
    character(len=H_LONG) :: basename
    !---------------------------------------------------------------------------

!    LOG_NEWLINE
!    LOG_INFO("ATMOS_PHY_TB_vars_restart_open",*) 'Open restart file (ATMOS_PHY_TB) '

!    if ( ATMOS_PHY_TB_RESTART_IN_BASENAME /= '' ) then

!       if ( ATMOS_PHY_TB_RESTART_IN_POSTFIX_TIMELABEL ) then
!          call TIME_gettimelabel( timelabel )
!          basename = trim(ATMOS_PHY_TB_RESTART_IN_BASENAME)//'_'//trim(timelabel)
!       else
!          basename = trim(ATMOS_PHY_TB_RESTART_IN_BASENAME)
!       endif

!       LOG_INFO("ATMOS_PHY_TB_vars_restart_open",*) 'basename: ', trim(basename)

!       call FILE_CARTESC_open( basename, restart_fid, aggregate=ATMOS_PHY_TB_RESTART_IN_AGGREGATE )
!    else
!       LOG_INFO("ATMOS_PHY_TB_vars_restart_open",*) 'restart file for ATMOS_PHY_TB is not specified.'
!    endif

    return
  end subroutine atmos_phy_tb_vars_restart_open

  !-----------------------------------------------------------------------------
  subroutine atmos_phy_tb_vars_restart_read
!!$    use scale_statistics, only: &
!!$       STATISTICS_checktotal, &
!!$       STAT_total
!!$    use scale_atmos_grid_cartesC_real, only: &
!!$       ATMOS_GRID_CARTESC_REAL_VOL, &
!!$       ATMOS_GRID_CARTESC_REAL_TOTVOL
!!$    use scale_file, only: &
!!$       FILE_get_aggregate
!!$    use scale_file_cartesC, only: &
!!$       FILE_CARTESC_read, &
!!$       FILE_CARTESC_flush
!!$    implicit none

    integer  :: i, j
    !---------------------------------------------------------------------------

!    if ( restart_fid /= -1 ) then
!       LOG_NEWLINE
!       LOG_INFO("ATMOS_PHY_TB_vars_restart_read",*) 'Read from restart file (ATMOS_PHY_TB) '
!
!       call FILE_CARTESC_read( restart_fid, VAR_NAME(1), 'ZXY', & ! [IN]
!                               ATMOS_PHY_TB_??(:,:,:)           ) ! [OUT]
!
!       if ( FILE_get_AGGREGATE(restart_fid) ) then
!          call FILE_CARTESC_flush( restart_fid ) ! X/Y halos have been read from file
!
!          ! fill k halos
!          do j  = 1, JA
!          do i  = 1, IA
!             ATMOS_PHY_TB_??(   1:KS-1,i,j) = ATMOS_PHY_TB_??(KS,i,j)
!             ATMOS_PHY_TB_??(KE+1:KA,  i,j) = ATMOS_PHY_TB_??(KE,i,j)
!          enddo
!          enddo
!       else
!          call ATMOS_PHY_TB_vars_fillhalo
!       end if
!
!       if ( STATISTICS_checktotal ) then
!          call STAT_total( KA, KS, KE, IA, IS, IE, JA, JS, JE, &
!                           ATMOS_PHY_TB_??(:,:,:), VAR_NAME(1), &
!                           ATMOS_GRID_CARTESC_REAL_VOL(:,:,:),  & ! (in)
!                           ATMOS_GRID_CARTESC_REAL_TOTVOL       ) ! (in)
!       endif
!    else
!       LOG_INFO("ATMOS_PHY_TB_vars_restart_read",*) 'invalid restart file ID for ATMOS_PHY_TB.'
!    endif

    return
  end subroutine atmos_phy_tb_vars_restart_read

  !-----------------------------------------------------------------------------
  subroutine atmos_phy_tb_vars_restart_create
    use scale_time, only: &
       time_gettimelabel
    use scale_file_cartesc, only: &
       file_cartesc_create
    implicit none

    character(len=19)     :: timelabel
    character(len=H_LONG) :: basename
    !---------------------------------------------------------------------------

!    if ( ATMOS_PHY_TB_RESTART_OUT_BASENAME /= '' ) then
!
!       LOG_NEWLINE
!       LOG_INFO("ATMOS_PHY_TB_vars_restart_create",*) 'Create restart file (ATMOS_PHY_AE) '
!
!       if ( ATMOS_PHY_TB_RESTART_OUT_POSTFIX_TIMELABEL ) then
!          call TIME_gettimelabel( timelabel )
!          basename = trim(ATMOS_PHY_TB_RESTART_OUT_BASENAME)//'_'//trim(timelabel)
!       else
!          basename = trim(ATMOS_PHY_TB_RESTART_OUT_BASENAME)
!       endif
!
!       LOG_INFO("ATMOS_PHY_TB_vars_restart_create",*) 'basename: ', trim(basename)
!
!    call FILE_CARTESC_create( &
!         basename, ATMOS_PHY_TB_RESTART_OUT_TITLE, ATMOS_PHY_TB_RESTART_OUT_DTYPE, & ! [IN]
!         restart_fid,                                                              & ! [OUT]
!         aggregate=ATMOS_PHY_TB_RESTART_OUT_AGGREGATE                              ) ! [IN]
!    endif

    return
  end subroutine atmos_phy_tb_vars_restart_create

  !-----------------------------------------------------------------------------
  subroutine atmos_phy_tb_vars_restart_enddef
    use scale_file_cartesc, only: &
       file_cartesc_enddef
    implicit none

!    if ( restart_fid /= -1 ) then
!       call FILE_CARTESC_enddef( restart_fid ) ! [IN]
!    endif

    return
  end subroutine atmos_phy_tb_vars_restart_enddef

  !-----------------------------------------------------------------------------
  subroutine atmos_phy_tb_vars_restart_close
    use scale_file_cartesc, only: &
       file_cartesc_close
    implicit none
    !---------------------------------------------------------------------------

!    if ( restart_fid /= -1 ) then
!       LOG_NEWLINE
!       LOG_INFO("ATMOS_PHY_TB_vars_restart_close",*) 'Close restart file (ATMOS_PHY_TB) '
!
!       call FILE_CARTESC_close( restart_fid ) ! [IN]
!
!       restart_fid = -1
!    endif

    return
  end subroutine atmos_phy_tb_vars_restart_close

  !-----------------------------------------------------------------------------
  subroutine atmos_phy_tb_vars_restart_def_var
    use scale_file_cartesc, only: &
       file_cartesc_def_var
    implicit none
    !---------------------------------------------------------------------------

!    if ( restart_fid /= -1 ) then

!       call FILE_CARTESC_def_var( restart_fid,     & ! [IN]
!            VAR_NAME(1), VAR_DESC(1), VAR_UNIT(1), & ! [IN]
!            'ZXY', ATMOS_PHY_TB_RESTART_OUT_DTYPE, & ! [IN]
!            VAR_ID(1)                              ) ! [OUT]

!    endif

    return
  end subroutine atmos_phy_tb_vars_restart_def_var

  !-----------------------------------------------------------------------------
  subroutine atmos_phy_tb_vars_restart_write
!!$    use scale_statistics, only: &
!!$       STATISTICS_checktotal, &
!!$       STAT_total
!!$    use scale_atmos_grid_cartesC_real, only: &
!!$       ATMOS_GRID_CARTESC_REAL_VOL, &
!!$       ATMOS_GRID_CARTESC_REAL_TOTVOL
!!$    use scale_file_cartesC, only: &
!!$       FILE_CARTESC_write_var
    implicit none

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

!    if ( restart_fid /= -1 ) then
!
!       call ATMOS_PHY_TB_vars_fillhalo
!
!       if ( STATISTICS_checktotal ) then
!          call STAT_total( KA, KS, KE, IA, IS, IE, JA, JS, JE, &
!                           ATMOS_PHY_TB_??(:,:,:), VAR_NAME(1), &
!                           ATMOS_GRID_CARTESC_REAL_VOL(:,:,:),  & ! (in)
!                           ATMOS_GRID_CARTESC_REAL_TOTVOL       ) ! (in)
!       endif
!
!       call FILE_CARTESC_write_var( restart_fid, VAR_ID(1), ATMOS_PHY_TB_??(:,:,:), &
!                              VAR_NAME(1), 'ZXY' ) ! [IN]
!
!    endif

    return
  end subroutine atmos_phy_tb_vars_restart_write

end module mod_atmos_phy_tb_vars