mod_atmos_phy_sf_vars.F90

Go to the documentation of this file.

!-------------------------------------------------------------------------------
!-------------------------------------------------------------------------------
#include "scalelib.h"
module mod_atmos_phy_sf_vars
  !-----------------------------------------------------------------------------
  !
  !++ used modules
  !
  use scale_precision
  use scale_io
  use scale_prof
  use scale_atmos_grid_cartesc_index
  use scale_tracer
  use scale_cpl_sfc_index
  !-----------------------------------------------------------------------------
  implicit none
  private
  !-----------------------------------------------------------------------------
  !
  !++ Public procedure
  !
  public :: atmos_phy_sf_vars_setup
  public :: atmos_phy_sf_vars_fillhalo
  public :: atmos_phy_sf_vars_restart_read
  public :: atmos_phy_sf_vars_restart_write

  public :: atmos_phy_sf_vars_restart_create
  public :: atmos_phy_sf_vars_restart_open
  public :: atmos_phy_sf_vars_restart_def_var
  public :: atmos_phy_sf_vars_restart_enddef
  public :: atmos_phy_sf_vars_restart_close

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

  character(len=H_LONG),  public :: atmos_phy_sf_restart_in_basename           = ''
  logical,                public :: atmos_phy_sf_restart_in_aggregate
  logical,                public :: atmos_phy_sf_restart_in_postfix_timelabel  = .false.                
  character(len=H_LONG),  public :: atmos_phy_sf_restart_out_basename          = ''
  logical,                public :: atmos_phy_sf_restart_out_aggregate
  logical,                public :: atmos_phy_sf_restart_out_postfix_timelabel = .true.                 
  character(len=H_MID),   public :: atmos_phy_sf_restart_out_title             = 'ATMOS_PHY_SF restart'
  character(len=H_SHORT), public :: atmos_phy_sf_restart_out_dtype             = 'DEFAULT'

  real(RP), public, allocatable :: atmos_phy_sf_dens_t    (:,:)     ! tendency DENS     [    kg/m3/s]
  real(RP), public, allocatable :: atmos_phy_sf_momz_t    (:,:)     ! tendency MOMZ     [m/s*kg/m2/s]
  real(RP), public, allocatable :: atmos_phy_sf_rhou_t    (:,:)     ! tendency rho*U    [m/s*kg/m2/s]
  real(RP), public, allocatable :: atmos_phy_sf_rhov_t    (:,:)     ! tendency rho*V    [m/s*kg/m2/s]
  real(RP), public, allocatable :: atmos_phy_sf_rhoh      (:,:)     ! diabatic heating  [J/m3/s]
  real(RP), public, allocatable :: atmos_phy_sf_rhot_t    (:,:)     ! tendency RHOT     [K  *kg/m3/s]
  real(RP), public, allocatable :: atmos_phy_sf_rhoq_t    (:,:,:)   ! tendency rho*QTRC [    kg/kg/s]

  real(RP), public, allocatable :: atmos_phy_sf_sfc_temp  (:,:)     ! surface skin temperature             [K]
  real(RP), public, allocatable :: atmos_phy_sf_sfc_albedo(:,:,:,:) ! surface albedo (direct/diffuse,IR/near-IR/VIS) (0-1)
  real(RP), public, allocatable :: atmos_phy_sf_sfc_z0m   (:,:)     ! surface roughness length, ocean only [m]
  real(RP), public, allocatable :: atmos_phy_sf_sfc_z0h   (:,:)     ! surface roughness length, ocean only [m]
  real(RP), public, allocatable :: atmos_phy_sf_sfc_z0e   (:,:)     ! surface roughness length, ocean only [m]

  ! surface diagnostic variables
  real(RP), public, allocatable :: atmos_phy_sf_sfc_dens  (:,:)     ! surface atmosphere density  [kg/m3]
  real(RP), public, allocatable :: atmos_phy_sf_sfc_pres  (:,:)     ! surface atmosphere pressure [Pa]

  real(RP), public, allocatable :: atmos_phy_sf_sflx_mw   (:,:)     ! z-momentum flux (area center) [m/s*kg/m2/s]
  real(RP), public, allocatable :: atmos_phy_sf_sflx_mu   (:,:)     ! x-momentum flux (area center) [m/s*kg/m2/s]
  real(RP), public, allocatable :: atmos_phy_sf_sflx_mv   (:,:)     ! y-momentum flux (area center) [m/s*kg/m2/s]
  real(RP), public, allocatable :: atmos_phy_sf_sflx_sh   (:,:)     ! sensible heat flux [J/m2/s]
  real(RP), public, allocatable :: atmos_phy_sf_sflx_lh   (:,:)     ! latent heat flux [J/m2/s]
  real(RP), public, allocatable :: atmos_phy_sf_sflx_gh   (:,:)     ! ground heat flux [J/m2/s]
  real(RP), public, allocatable, target :: atmos_phy_sf_sflx_qtrc (:,:,:) ! tracer mass flux [kg/m2/s]
  real(RP), public, pointer     :: atmos_phy_sf_sflx_qv   (:,:)

  real(RP), public, allocatable :: atmos_phy_sf_u10       (:,:)     ! 10m x-wind [m/s]
  real(RP), public, allocatable :: atmos_phy_sf_v10       (:,:)     ! 10m y-wind [m/s]
  real(RP), public, allocatable :: atmos_phy_sf_t2        (:,:)     ! 2m temperature [K]
  real(RP), public, allocatable :: atmos_phy_sf_q2        (:,:)     ! 2m specific humidity [kg/kg]

  real(RP), public, allocatable :: atmos_phy_sf_l_mo      (:,:)     ! monin-obukov length

!  real(RP), public, allocatable :: ATMOS_PHY_SF_SFLX_QEMIS(:,:,:) ! tracer emission   flux [kg/m2/s]
!  real(RP), public, allocatable :: ATMOS_PHY_SF_SFLX_QDEP (:,:,:) ! tracer deposition flux [kg/m2/s]
!  real(RP), public, allocatable :: ATMOS_PHY_SF_SFLX_VDEP (:,:,:) ! tracer deposition velocity [m/s]

  !-----------------------------------------------------------------------------
  !
  !++ Private procedure
  !
  !-----------------------------------------------------------------------------
  !
  !++ Private parameters & variables
  !
  integer,                private, parameter :: vmax              = 10
  integer,                private, parameter :: i_sfc_temp        =  1
  integer,                private, parameter :: i_sfc_alb_ir_dir  =  2
  integer,                private, parameter :: i_sfc_alb_ir_dif  =  3
  integer,                private, parameter :: i_sfc_alb_nir_dir =  4
  integer,                private, parameter :: i_sfc_alb_nir_dif =  5
  integer,                private, parameter :: i_sfc_alb_vis_dir =  6
  integer,                private, parameter :: i_sfc_alb_vis_dif =  7
  integer,                private, parameter :: i_sfc_z0m         =  8
  integer,                private, parameter :: i_sfc_z0h         =  9
  integer,                private, parameter :: i_sfc_z0e         = 10

  character(len=H_SHORT), private            :: var_name(vmax)
  character(len=H_MID),   private            :: var_desc(vmax)
  character(len=H_MID),   private            :: var_stdn(vmax)
  character(len=H_SHORT), private            :: var_unit(vmax)
  integer,                private            :: var_id(vmax)
  integer,                private            :: restart_fid = -1  ! file ID

  data var_name / 'SFC_TEMP',        &
                  'SFC_ALB_IR_dir',  &
                  'SFC_ALB_IR_dif',  &
                  'SFC_ALB_NIR_dir', &
                  'SFC_ALB_NIR_dif', &
                  'SFC_ALB_VIS_dir', &
                  'SFC_ALB_VIS_dif', &
                  'SFC_Z0M',         &
                  'SFC_Z0H',         &
                  'SFC_Z0E'          /

  data var_desc / 'surface skin temperature',            &
                  'surface albedo for IR,  direct ',     &
                  'surface albedo for IR,  diffuse',     &
                  'surface albedo for NIR, direct ',     &
                  'surface albedo for NIR, diffuse',     &
                  'surface albedo for VIS, direct ',     &
                  'surface albedo for VIS, diffuse',     &
                  'surface roughness length (momentum)', &
                  'surface roughness length (heat)',     &
                  'surface roughness length (vapor)'     /

  data var_stdn / 'surface_temp', &
                  '', &
                  '', &
                  '', &
                  '', &
                  '', &
                  '', &
                  'surface_roughness_length_for_momentum_in_air', &
                  'surface_roughness_length_for_heat_in_air', &
                  '' /

  data var_unit / 'K', &
                  '1', &
                  '1', &
                  '1', &
                  '1', &
                  '1', &
                  '1', &
                  'm', &
                  'm', &
                  'm'  /

  real(RP), private :: atmos_phy_sf_default_sfc_temp      = 300.0_rp
  real(RP), private :: atmos_phy_sf_default_sfc_albedo_lw = 0.04_rp
  real(RP), private :: atmos_phy_sf_default_sfc_albedo_sw = 0.10_rp
  real(RP), private :: atmos_phy_sf_default_sfc_z0        = 1e-4_rp

  real(RP), allocatable, target :: zero(:,:)

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

    namelist / param_atmos_phy_sf_vars / &
       atmos_phy_sf_restart_in_basename,           &
       atmos_phy_sf_restart_in_aggregate,          &
       atmos_phy_sf_restart_in_postfix_timelabel,  &
       atmos_phy_sf_restart_output,                &
       atmos_phy_sf_restart_out_basename,          &
       atmos_phy_sf_restart_out_aggregate,         &
       atmos_phy_sf_restart_out_postfix_timelabel, &
       atmos_phy_sf_restart_out_title,             &
       atmos_phy_sf_restart_out_dtype,             &
       atmos_phy_sf_default_sfc_temp,              &
       atmos_phy_sf_default_sfc_albedo_lw,         &
       atmos_phy_sf_default_sfc_albedo_sw,         &
       atmos_phy_sf_default_sfc_z0

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

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

    allocate( atmos_phy_sf_dens_t(ia,ja)    )
    allocate( atmos_phy_sf_momz_t(ia,ja)    )
    allocate( atmos_phy_sf_rhou_t(ia,ja)    )
    allocate( atmos_phy_sf_rhov_t(ia,ja)    )
    allocate( atmos_phy_sf_rhot_t(ia,ja)    )
    allocate( atmos_phy_sf_rhoh(ia,ja)    )
    allocate( atmos_phy_sf_rhoq_t(ia,ja,qa) )
    atmos_phy_sf_dens_t(:,:)     = undef
    atmos_phy_sf_momz_t(:,:)     = undef
    atmos_phy_sf_rhou_t(:,:)     = undef
    atmos_phy_sf_rhov_t(:,:)     = undef
    atmos_phy_sf_rhot_t(:,:)     = undef
    atmos_phy_sf_rhoh(:,:)     = undef
    atmos_phy_sf_rhoq_t(:,:,:)   = undef

    allocate( atmos_phy_sf_sfc_temp(ia,ja)                     )
    allocate( atmos_phy_sf_sfc_albedo(ia,ja,n_rad_dir,n_rad_rgn) )
    allocate( atmos_phy_sf_sfc_z0m(ia,ja)                     )
    allocate( atmos_phy_sf_sfc_z0h(ia,ja)                     )
    allocate( atmos_phy_sf_sfc_z0e(ia,ja)                     )
    atmos_phy_sf_sfc_temp(:,:) = atmos_phy_sf_default_sfc_temp
    atmos_phy_sf_sfc_albedo(:,:,i_r_direct ,i_r_ir ) = atmos_phy_sf_default_sfc_albedo_lw
    atmos_phy_sf_sfc_albedo(:,:,i_r_diffuse,i_r_ir ) = atmos_phy_sf_default_sfc_albedo_lw
    atmos_phy_sf_sfc_albedo(:,:,i_r_direct ,i_r_nir) = atmos_phy_sf_default_sfc_albedo_sw
    atmos_phy_sf_sfc_albedo(:,:,i_r_diffuse,i_r_nir) = atmos_phy_sf_default_sfc_albedo_sw
    atmos_phy_sf_sfc_albedo(:,:,i_r_direct ,i_r_vis) = atmos_phy_sf_default_sfc_albedo_sw
    atmos_phy_sf_sfc_albedo(:,:,i_r_diffuse,i_r_vis) = atmos_phy_sf_default_sfc_albedo_sw
    atmos_phy_sf_sfc_z0m(:,:) = atmos_phy_sf_default_sfc_z0
    atmos_phy_sf_sfc_z0h(:,:) = atmos_phy_sf_default_sfc_z0
    atmos_phy_sf_sfc_z0e(:,:) = atmos_phy_sf_default_sfc_z0

    allocate( atmos_phy_sf_sfc_dens(ia,ja) )
    allocate( atmos_phy_sf_sfc_pres(ia,ja) )
    atmos_phy_sf_sfc_dens(:,:)     = undef
    atmos_phy_sf_sfc_pres(:,:)     = undef

    allocate( atmos_phy_sf_sflx_mw(ia,ja) )
    allocate( atmos_phy_sf_sflx_mu(ia,ja) )
    allocate( atmos_phy_sf_sflx_mv(ia,ja) )
    allocate( atmos_phy_sf_sflx_sh(ia,ja) )
    allocate( atmos_phy_sf_sflx_lh(ia,ja) )
    allocate( atmos_phy_sf_sflx_gh(ia,ja) )
    allocate( atmos_phy_sf_sflx_qtrc(ia,ja,max(qa,1)) )
    atmos_phy_sf_sflx_mw(:,:)     = undef
    atmos_phy_sf_sflx_mu(:,:)     = undef
    atmos_phy_sf_sflx_mv(:,:)     = undef
    atmos_phy_sf_sflx_sh(:,:)     = undef
    atmos_phy_sf_sflx_lh(:,:)     = undef
    atmos_phy_sf_sflx_gh(:,:)     = undef
    atmos_phy_sf_sflx_qtrc(:,:,:)   = undef

    allocate( atmos_phy_sf_u10(ia,ja) )
    allocate( atmos_phy_sf_v10(ia,ja) )
    allocate( atmos_phy_sf_t2(ia,ja) )
    allocate( atmos_phy_sf_q2(ia,ja) )
    allocate( atmos_phy_sf_l_mo(ia,ja) )
    atmos_phy_sf_u10(:,:)     = undef
    atmos_phy_sf_v10(:,:)     = undef
    atmos_phy_sf_t2(:,:)     = undef
    atmos_phy_sf_q2(:,:)     = undef
    atmos_phy_sf_l_mo(:,:)     = undef

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

    log_newline
    log_info("ATMOS_PHY_SF_vars_setup",*) '[ATMOS_PHY_SF] 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_sf_restart_in_basename /= '' ) then
       log_info("ATMOS_PHY_SF_vars_setup",*) 'Restart input?  : YES, file = ', trim(atmos_phy_sf_restart_in_basename)
       log_info("ATMOS_PHY_SF_vars_setup",*) 'Add timelabel?  : ', atmos_phy_sf_restart_in_postfix_timelabel
    else
       log_info("ATMOS_PHY_SF_vars_setup",*) 'Restart input?  : NO'
    endif
    if (       atmos_phy_sf_restart_output             &
         .AND. atmos_phy_sf_restart_out_basename /= '' ) then
       log_info("ATMOS_PHY_SF_vars_setup",*) 'Restart output? : YES, file = ', trim(atmos_phy_sf_restart_out_basename)
       log_info("ATMOS_PHY_SF_vars_setup",*) 'Add timelabel?  : ', atmos_phy_sf_restart_out_postfix_timelabel
    else
       log_info("ATMOS_PHY_SF_vars_setup",*) 'Restart output? : NO'
       atmos_phy_sf_restart_output = .false.
    endif

    if ( i_qv > 0 ) then
       atmos_phy_sf_sflx_qv => atmos_phy_sf_sflx_qtrc(:,:,i_qv)
    else
       allocate( zero(ia,ja) )
       atmos_phy_sf_sflx_qv => zero
    end if

    return
  end subroutine atmos_phy_sf_vars_setup

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

    integer :: n ,idir, irgn
    !---------------------------------------------------------------------------

    call comm_vars8( atmos_phy_sf_sfc_temp(:,:), 1 )
    call comm_vars8( atmos_phy_sf_sfc_z0m(:,:), 2 )
    call comm_vars8( atmos_phy_sf_sfc_z0h(:,:), 3 )
    call comm_vars8( atmos_phy_sf_sfc_z0e(:,:), 4 )

    n = 4
    do irgn = i_r_ir, i_r_vis
    do idir = i_r_direct, i_r_diffuse
       n = n + 1
       call comm_vars8( atmos_phy_sf_sfc_albedo(:,:,idir,irgn), n )
    enddo
    enddo

    call comm_wait ( atmos_phy_sf_sfc_temp(:,:), 1 )
    call comm_wait ( atmos_phy_sf_sfc_z0m(:,:), 2 )
    call comm_wait ( atmos_phy_sf_sfc_z0h(:,:), 3 )
    call comm_wait ( atmos_phy_sf_sfc_z0e(:,:), 4 )

    n = 4
    do irgn = i_r_ir, i_r_vis
    do idir = i_r_direct, i_r_diffuse
       n = n + 1
       call comm_wait ( atmos_phy_sf_sfc_albedo(:,:,idir,irgn), n )
    enddo
    enddo

    return
  end subroutine atmos_phy_sf_vars_fillhalo

  !-----------------------------------------------------------------------------
  subroutine atmos_phy_sf_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_SF_vars_restart_open",*) 'Open restart file (ATMOS_PHY_SF) '

    if ( atmos_phy_sf_restart_in_basename /= '' ) then

       if ( atmos_phy_sf_restart_in_postfix_timelabel ) then
          call time_gettimelabel( timelabel )
          basename = trim(atmos_phy_sf_restart_in_basename)//'_'//trim(timelabel)
       else
          basename = trim(atmos_phy_sf_restart_in_basename)
       endif

       log_info("ATMOS_PHY_SF_vars_restart_open",*) 'basename: ', trim(basename)

       call file_cartesc_open( basename, restart_fid, aggregate=atmos_phy_sf_restart_in_aggregate )

    else
       log_info("ATMOS_PHY_SF_vars_restart_open",*) 'restart file for ATMOS_PHY_SF is not specified.'
    endif

    return
  end subroutine atmos_phy_sf_vars_restart_open

  !-----------------------------------------------------------------------------
  subroutine atmos_phy_sf_vars_restart_read
    use scale_file, only: &
       file_get_aggregate
    use scale_file_cartesc, only: &
       file_cartesc_read, &
       file_cartesc_flush
    implicit none
    !---------------------------------------------------------------------------

    if ( restart_fid /= -1 ) then
       log_newline
       log_info("ATMOS_PHY_SF_vars_restart_read",*) 'Read from restart file (ATMOS_PHY_SF) '

       call file_cartesc_read( restart_fid, var_name(i_sfc_temp),        'XY',  & ! [IN]
                               atmos_phy_sf_sfc_temp(:,:)                     ) ! [OUT]
       call file_cartesc_read( restart_fid, var_name(i_sfc_alb_ir_dir),  'XY',  & ! [IN]
                               atmos_phy_sf_sfc_albedo(:,:,i_r_direct ,i_r_ir ) ) ! [OUT]
       call file_cartesc_read( restart_fid, var_name(i_sfc_alb_ir_dif),  'XY',  & ! [IN]
                               atmos_phy_sf_sfc_albedo(:,:,i_r_diffuse,i_r_ir ) ) ! [OUT]
       call file_cartesc_read( restart_fid, var_name(i_sfc_alb_nir_dir), 'XY',  & ! [IN]
                               atmos_phy_sf_sfc_albedo(:,:,i_r_direct ,i_r_nir) ) ! [OUT]
       call file_cartesc_read( restart_fid, var_name(i_sfc_alb_nir_dif), 'XY',  & ! [IN]
                               atmos_phy_sf_sfc_albedo(:,:,i_r_diffuse,i_r_nir) ) ! [OUT]
       call file_cartesc_read( restart_fid, var_name(i_sfc_alb_vis_dir), 'XY',  & ! [IN]
                               atmos_phy_sf_sfc_albedo(:,:,i_r_direct ,i_r_vis) ) ! [OUT]
       call file_cartesc_read( restart_fid, var_name(i_sfc_alb_vis_dif), 'XY',  & ! [IN]
                               atmos_phy_sf_sfc_albedo(:,:,i_r_diffuse,i_r_vis) ) ! [OUT]
       call file_cartesc_read( restart_fid, var_name(i_sfc_z0m),         'XY',  & ! [IN]
                               atmos_phy_sf_sfc_z0m(:,:)                     ) ! [OUT]
       call file_cartesc_read( restart_fid, var_name(i_sfc_z0h),         'XY',  & ! [IN]
                               atmos_phy_sf_sfc_z0h(:,:)                     ) ! [OUT]
       call file_cartesc_read( restart_fid, var_name(i_sfc_z0e),         'XY',  & ! [IN]
                               atmos_phy_sf_sfc_z0e(:,:)                     ) ! [OUT]

       if ( file_get_aggregate(restart_fid) ) then
          call file_cartesc_flush( restart_fid ) ! X/Y halos have been read from file
       else
          call atmos_phy_sf_vars_fillhalo
       end if

       call atmos_phy_sf_vars_checktotal

    else
       log_info("ATMOS_PHY_SF_vars_restart_read",*) 'invalid restart file ID for ATMOS_PHY_SF.'
    endif

    return
  end subroutine atmos_phy_sf_vars_restart_read

  !-----------------------------------------------------------------------------
  subroutine atmos_phy_sf_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_sf_restart_out_basename /= '' ) then

       log_newline
       log_info("ATMOS_PHY_SF_vars_restart_create",*) 'Create restart file (ATMOS_PHY_AE) '

       if ( atmos_phy_sf_restart_out_postfix_timelabel ) then
          call time_gettimelabel( timelabel )
          basename = trim(atmos_phy_sf_restart_out_basename)//'_'//trim(timelabel)
       else
          basename = trim(atmos_phy_sf_restart_out_basename)
       endif

       log_info("ATMOS_PHY_SF_vars_restart_create",*) 'basename: ', trim(basename)

       call file_cartesc_create( &
            basename, atmos_phy_sf_restart_out_title, atmos_phy_sf_restart_out_dtype, & ! [IN]
            restart_fid,                                                              & ! [OUT]
            aggregate=atmos_phy_sf_restart_out_aggregate                              ) ! [IN]
    endif

    return
  end subroutine atmos_phy_sf_vars_restart_create

  !-----------------------------------------------------------------------------
  subroutine atmos_phy_sf_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_sf_vars_restart_enddef

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

    if ( restart_fid /= -1 ) then
       log_newline
       log_info("ATMOS_PHY_SF_vars_restart_close",*) 'Close restart file (ATMOS_PHY_SF) '

       call file_cartesc_close( restart_fid ) ! [IN]

       restart_fid = -1
    endif

    return
  end subroutine atmos_phy_sf_vars_restart_close

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

    integer :: i
    !---------------------------------------------------------------------------

    if ( restart_fid /= -1 ) then

       do i = i_sfc_temp, i_sfc_z0e
          call file_cartesc_def_var( restart_fid,                           & ! [IN]
                                     var_name(i), var_desc(i), var_unit(i), & ! [IN]
                                     'XY', atmos_phy_sf_restart_out_dtype,  & ! [IN]
                                     var_id(i),                             & ! [OUT]
                                     standard_name=var_stdn(i)              ) ! [IN]
       end do

    endif

    return
  end subroutine atmos_phy_sf_vars_restart_def_var

  !-----------------------------------------------------------------------------
  subroutine atmos_phy_sf_vars_restart_write
    use scale_file_cartesc, only: &
       file_cartesc_write_var
    implicit none
    !---------------------------------------------------------------------------

    if ( restart_fid /= -1 ) then

       call atmos_phy_sf_vars_fillhalo

       call atmos_phy_sf_vars_checktotal

       call file_cartesc_write_var( restart_fid, var_id(i_sfc_temp),                  & ! [IN]
                                    atmos_phy_sf_sfc_temp(:,:),                     & ! [IN]
                                    var_name(i_sfc_temp), 'XY'                        ) ! [IN]
       call file_cartesc_write_var( restart_fid, var_id(i_sfc_alb_ir_dir),            & ! [IN]
                                    atmos_phy_sf_sfc_albedo(:,:,i_r_direct ,i_r_ir ), & ! [IN]
                                    var_name(i_sfc_alb_ir_dir), 'XY'                  ) ! [IN]
       call file_cartesc_write_var( restart_fid, var_id(i_sfc_alb_ir_dif),            & ! [IN]
                                    atmos_phy_sf_sfc_albedo(:,:,i_r_diffuse,i_r_ir ), & ! [IN]
                                    var_name(i_sfc_alb_ir_dif), 'XY'                  ) ! [IN]
       call file_cartesc_write_var( restart_fid, var_id(i_sfc_alb_nir_dir),           & ! [IN]
                                    atmos_phy_sf_sfc_albedo(:,:,i_r_direct ,i_r_nir), & ! [IN]
                                    var_name(i_sfc_alb_nir_dir), 'XY'                 ) ! [IN]
       call file_cartesc_write_var( restart_fid, var_id(i_sfc_alb_nir_dif),           & ! [IN]
                                    atmos_phy_sf_sfc_albedo(:,:,i_r_diffuse,i_r_nir), & ! [IN]
                                    var_name(i_sfc_alb_nir_dif), 'XY'                 ) ! [IN]
       call file_cartesc_write_var( restart_fid, var_id(i_sfc_alb_vis_dir),           & ! [IN]
                                    atmos_phy_sf_sfc_albedo(:,:,i_r_direct ,i_r_vis), & ! [IN]
                                    var_name(i_sfc_alb_vis_dir), 'XY'                 ) ! [IN]
       call file_cartesc_write_var( restart_fid, var_id(i_sfc_alb_vis_dif),           & ! [IN]
                                    atmos_phy_sf_sfc_albedo(:,:,i_r_diffuse,i_r_vis), & ! [IN]
                                    var_name(i_sfc_alb_vis_dif), 'XY'                 ) ! [IN]
       call file_cartesc_write_var( restart_fid, var_id(i_sfc_z0m),                   & ! [IN]
                                    atmos_phy_sf_sfc_z0m(:,:),                     & ! [IN]
                                    var_name(i_sfc_z0m), 'XY'                         ) ! [IN]
       call file_cartesc_write_var( restart_fid, var_id(i_sfc_z0h),                   & ! [IN]
                                    atmos_phy_sf_sfc_z0h(:,:),                     & ! [IN]
                                    var_name(i_sfc_z0h), 'XY'                         ) ! [IN]
       call file_cartesc_write_var( restart_fid, var_id(i_sfc_z0e),                   & ! [IN]
                                    atmos_phy_sf_sfc_z0e(:,:),                     & ! [IN]
                                    var_name(i_sfc_z0e), 'XY'                         ) ! [IN]

    endif

    return
  end subroutine atmos_phy_sf_vars_restart_write

  !-----------------------------------------------------------------------------
  subroutine atmos_phy_sf_vars_checktotal
    use scale_statistics, only: &
       statistics_checktotal, &
       statistics_total
    use scale_atmos_grid_cartesc_real, only: &
       atmos_grid_cartesc_real_area, &
       atmos_grid_cartesc_real_totarea
    implicit none
    !---------------------------------------------------------------------------

    if ( statistics_checktotal ) then
       call statistics_total( ia, is, ie, ja, js, je,                           & ! [IN]
                              atmos_phy_sf_sfc_temp(:,:),                     & ! [IN]
                              var_name(i_sfc_temp),                             & ! [IN]
                              atmos_grid_cartesc_real_area(:,:),                & ! [IN]
                              atmos_grid_cartesc_real_totarea                   ) ! [IN]
       call statistics_total( ia, is, ie, ja, js, je,                           & ! [IN]
                              atmos_phy_sf_sfc_albedo(:,:,i_r_direct ,i_r_ir ), & ! [IN]
                              var_name(i_sfc_alb_ir_dir),                       & ! [IN]
                              atmos_grid_cartesc_real_area(:,:),                & ! [IN]
                              atmos_grid_cartesc_real_totarea                   ) ! [IN]
       call statistics_total( ia, is, ie, ja, js, je,                           & ! [IN]
                              atmos_phy_sf_sfc_albedo(:,:,i_r_diffuse,i_r_ir ), & ! [IN]
                              var_name(i_sfc_alb_ir_dif),                       & ! [IN]
                              atmos_grid_cartesc_real_area(:,:),                & ! [IN]
                              atmos_grid_cartesc_real_totarea                   ) ! [IN]
       call statistics_total( ia, is, ie, ja, js, je,                           & ! [IN]
                              atmos_phy_sf_sfc_albedo(:,:,i_r_direct ,i_r_nir), & ! [IN]
                              var_name(i_sfc_alb_nir_dir),                      & ! [IN]
                              atmos_grid_cartesc_real_area(:,:),                & ! [IN]
                              atmos_grid_cartesc_real_totarea                   ) ! [IN]
       call statistics_total( ia, is, ie, ja, js, je,                           & ! [IN]
                              atmos_phy_sf_sfc_albedo(:,:,i_r_diffuse,i_r_nir), & ! [IN]
                              var_name(i_sfc_alb_nir_dif),                      & ! [IN]
                              atmos_grid_cartesc_real_area(:,:),                & ! [IN]
                              atmos_grid_cartesc_real_totarea                   ) ! [IN]
       call statistics_total( ia, is, ie, ja, js, je,                           & ! [IN]
                              atmos_phy_sf_sfc_albedo(:,:,i_r_direct ,i_r_vis), & ! [IN]
                              var_name(i_sfc_alb_vis_dir),                      & ! [IN]
                              atmos_grid_cartesc_real_area(:,:),                & ! [IN]
                              atmos_grid_cartesc_real_totarea                   ) ! [IN]
       call statistics_total( ia, is, ie, ja, js, je,                           & ! [IN]
                              atmos_phy_sf_sfc_albedo(:,:,i_r_diffuse,i_r_vis), & ! [IN]
                              var_name(i_sfc_alb_vis_dif),                      & ! [IN]
                              atmos_grid_cartesc_real_area(:,:),                & ! [IN]
                              atmos_grid_cartesc_real_totarea                   ) ! [IN]
       call statistics_total( ia, is, ie, ja, js, je,                           & ! [IN]
                              atmos_phy_sf_sfc_z0m(:,:),                     & ! [IN]
                              var_name(i_sfc_z0m),                              & ! [IN]
                              atmos_grid_cartesc_real_area(:,:),                & ! [IN]
                              atmos_grid_cartesc_real_totarea                   ) ! [IN]
       call statistics_total( ia, is, ie, ja, js, je,                           & ! [IN]
                              atmos_phy_sf_sfc_z0h(:,:),                     & ! [IN]
                              var_name(i_sfc_z0h),                              & ! [IN]
                              atmos_grid_cartesc_real_area(:,:),                & ! [IN]
                              atmos_grid_cartesc_real_totarea                   ) ! [IN]
       call statistics_total( ia, is, ie, ja, js, je,                           & ! [IN]
                              atmos_phy_sf_sfc_z0e(:,:),                     & ! [IN]
                              var_name(i_sfc_z0e),                              & ! [IN]
                              atmos_grid_cartesc_real_area(:,:),                & ! [IN]
                              atmos_grid_cartesc_real_totarea                   ) ! [IN]
    endif

    return
  end subroutine atmos_phy_sf_vars_checktotal

end module mod_atmos_phy_sf_vars