mod_atmos_dyn_driver.f90

Go to the documentation of this file.

!-------------------------------------------------------------------------------
module mod_atmos_dyn_driver
  !-----------------------------------------------------------------------------
  !
  !++ used modules
  !
  use scale_precision
  use scale_stdio
  use scale_prof
  use scale_grid_index
  use scale_index
  use scale_tracer
  !-----------------------------------------------------------------------------
  implicit none
  private
  !-----------------------------------------------------------------------------
  !
  !++ Public procedure
  !
  public :: atmos_dyn_driver_setup
  public :: atmos_dyn_driver

  !-----------------------------------------------------------------------------
  !
  !++ Public parameters & variables
  !
  character(len=H_SHORT), public :: atmos_dyn_tstep_large_type     = 'FVM-HEVE'
  character(len=H_SHORT), public :: atmos_dyn_tstep_tracer_type    = 'FVM-HEVE'

  character(len=H_SHORT), public :: atmos_dyn_tinteg_large_type    = 'EULER'        ! Type of time integration
                                                                   ! 'RK3'
  character(len=H_SHORT), public :: atmos_dyn_tinteg_short_type    = 'RK4'
                                                                   ! 'RK3WS2002'
                                                                   ! 'RK3'
  character(len=H_SHORT), public :: atmos_dyn_tinteg_tracer_type   = 'RK3WS2002'
                                                                   ! 'EULER'

  character(len=H_SHORT), public :: atmos_dyn_fvm_flux_type        = 'CD4'          ! Type of advective flux scheme (FVM)
  character(len=H_SHORT), public :: atmos_dyn_fvm_flux_tracer_type = 'UD3KOREN1993'
                                                                   ! 'CD2'
                                                                   ! 'UD3'
                                                                   ! 'CD4'
                                                                   ! 'UD5'
                                                                   ! 'CD6'

  !-----------------------------------------------------------------------------
  !
  !++ Private procedure
  !
  !-----------------------------------------------------------------------------
  !
  !++ Private parameters & variables
  !
  ! Numerical filter
  integer,  private :: atmos_dyn_numerical_diff_order        = 1
  real(RP), private :: atmos_dyn_numerical_diff_coef         = 1.0e-4_rp ! nondimensional numerical diffusion
  real(RP), private :: atmos_dyn_numerical_diff_coef_tracer  = 0.0_rp    ! nondimensional numerical diffusion for tracer
  real(RP), private :: atmos_dyn_numerical_diff_sfc_fact     = 1.0_rp
  logical , private :: atmos_dyn_numerical_diff_use_refstate = .true.

  real(RP), private :: atmos_dyn_wdamp_tau                   = -1.0_rp   ! maximum tau for Rayleigh damping of w [s]
  real(RP), private :: atmos_dyn_wdamp_height                = -1.0_rp   ! height       to start apply Rayleigh damping [m]
  integer,  private :: atmos_dyn_wdamp_layer                 = -1        ! layer number to start apply Rayleigh damping [num]

  ! Coriolis force
  logical,  private :: atmos_dyn_enable_coriolis             = .false.   ! enable coriolis force?

  ! Divergence damping
  real(RP), private :: atmos_dyn_divdmp_coef                 = 0.0_rp    ! Divergence dumping coef

  ! Flux-Corrected Transport limiter
  logical,  private :: atmos_dyn_flag_fct_momentum           = .false.
  logical,  private :: atmos_dyn_flag_fct_t                  = .false.
  logical,  private :: atmos_dyn_flag_fct_tracer             = .false.
  logical,  private :: atmos_dyn_flag_fct_along_stream       = .true.

  !-----------------------------------------------------------------------------
contains
  !-----------------------------------------------------------------------------
  subroutine atmos_dyn_driver_setup
    use scale_process, only: &
       prc_mpistop
    use scale_grid, only: &
       grid_fz,  &
       grid_cdz, &
       grid_cdx, &
       grid_cdy, &
       grid_fdz, &
       grid_fdx, &
       grid_fdy
    use scale_grid_real, only: &
       real_lat
    use scale_time, only: &
       time_dtsec_atmos_dyn
    use mod_atmos_admin, only: &
       atmos_sw_dyn,   &
       atmos_dyn_type
    use mod_atmos_vars, only: &
       dens, &
       momz, &
       momx, &
       momy, &
       rhot, &
       qtrc
    use mod_atmos_dyn_vars, only: &
       prog
    use scale_atmos_dyn, only: &
       atmos_dyn_setup
    implicit none

    namelist / param_atmos_dyn / &
       atmos_dyn_tinteg_short_type,           &
       atmos_dyn_tinteg_tracer_type,          &
       atmos_dyn_tinteg_large_type,           &
       atmos_dyn_fvm_flux_type,               &
       atmos_dyn_fvm_flux_tracer_type,        &
       atmos_dyn_numerical_diff_order,        &
       atmos_dyn_numerical_diff_coef,         &
       atmos_dyn_numerical_diff_coef_tracer,  &
       atmos_dyn_numerical_diff_sfc_fact,     &
       atmos_dyn_numerical_diff_use_refstate, &
       atmos_dyn_wdamp_tau,                   &
       atmos_dyn_wdamp_height,                &
       atmos_dyn_wdamp_layer,                 &
       atmos_dyn_enable_coriolis,             &
       atmos_dyn_divdmp_coef,                 &
       atmos_dyn_flag_fct_momentum,           &
       atmos_dyn_flag_fct_t,                  &
       atmos_dyn_flag_fct_tracer,             &
       atmos_dyn_flag_fct_along_stream

    real(RP) :: dt
    integer  :: ierr
    !---------------------------------------------------------------------------

    if( io_l ) write(io_fid_log,*)
    if( io_l ) write(io_fid_log,*) '++++++ Module[DRIVER] / Categ[ATMOS DYN] / Origin[SCALE-RM]'

    if ( atmos_sw_dyn ) then

       !--- read namelist
       rewind(io_fid_conf)
       read(io_fid_conf,nml=param_atmos_dyn,iostat=ierr)
       if( ierr < 0 ) then !--- missing
          if( io_l ) write(io_fid_log,*) '*** Not found namelist. Default used.'
       elseif( ierr > 0 ) then !--- fatal error
          write(*,*) 'xxx Not appropriate names in namelist PARAM_ATMOS_DYN. Check!'
          call prc_mpistop
       endif
       if( io_nml ) write(io_fid_nml,nml=param_atmos_dyn)

       dt = real(time_dtsec_atmos_dyn,kind=rp)

       if ( atmos_dyn_wdamp_layer > kmax ) then
          write(*,*) 'xxx ATMOS_DYN_wdamp_layer should be less than total number of vertical layer(KA). Check!'
          call prc_mpistop
       elseif( atmos_dyn_wdamp_layer > 0 ) then
          atmos_dyn_wdamp_height = grid_fz(atmos_dyn_wdamp_layer+ks-1)
       endif

       if ( atmos_dyn_wdamp_tau < 0.0_rp ) then
          atmos_dyn_wdamp_tau = dt * 10.0_rp
       elseif ( atmos_dyn_wdamp_tau < dt ) then
          write(*,*) 'xxx ATMOS_DYN_wdamp_tau should be larger than TIME_DT_ATMOS_DYN. Check!'
          call prc_mpistop
       end if

       if ( atmos_sw_dyn ) then
          if( io_l ) write(io_fid_log,*)
          if( io_l ) write(io_fid_log,*) '*** Scheme for Large time step  : ', trim(atmos_dyn_tinteg_large_type)
          if( io_l ) write(io_fid_log,*) '*** Scheme for Short time step  : ', trim(atmos_dyn_tinteg_short_type)
          if( io_l ) write(io_fid_log,*) '*** Scheme for Tracer advection : ', trim(atmos_dyn_tinteg_tracer_type)
       endif

       call atmos_dyn_setup( atmos_dyn_tinteg_short_type,        & ! [IN]
                             atmos_dyn_tinteg_tracer_type,       & ! [IN]
                             atmos_dyn_tinteg_large_type,        & ! [IN]
                             atmos_dyn_tstep_tracer_type,        & ! [IN]
                             atmos_dyn_tstep_large_type,         & ! [IN]
                             atmos_dyn_fvm_flux_type,            & ! [IN]
                             atmos_dyn_fvm_flux_tracer_type,     & ! [IN]
                             dens, momz, momx, momy, rhot, qtrc, & ! [IN]
                             prog,                               & ! [IN]
                             grid_cdz, grid_cdx, grid_cdy,       & ! [IN]
                             grid_fdz, grid_fdx, grid_fdy,       & ! [IN]
                             atmos_dyn_wdamp_tau,                & ! [IN]
                             atmos_dyn_wdamp_height,             & ! [IN]
                             grid_fz,                            & ! [IN]
                             atmos_dyn_enable_coriolis,          & ! [IN]
                             real_lat,                           & ! [IN]
                             none = atmos_dyn_type=='NONE'       ) ! [IN]
    endif

    return
  end subroutine atmos_dyn_driver_setup

  !-----------------------------------------------------------------------------
  subroutine atmos_dyn_driver( do_flag )
    use scale_grid, only: &
       grid_cdz,  &
       grid_cdx,  &
       grid_cdy,  &
       grid_fdz,  &
       grid_fdx,  &
       grid_fdy,  &
       grid_rcdz, &
       grid_rcdx, &
       grid_rcdy, &
       grid_rfdz, &
       grid_rfdx, &
       grid_rfdy
    use scale_grid_real, only: &
       real_phi
    use scale_gridtrans, only: &
       gtrans_gsqrt, &
       gtrans_j13g,  &
       gtrans_j23g,  &
       gtrans_j33g,  &
       gtrans_mapf
    use scale_time, only: &
       time_dtsec,           &
       time_dtsec_atmos_dyn
    use mod_atmos_admin, only: &
       atmos_use_average
    use mod_atmos_vars, only: &
       atmos_vars_total,  &
       dens,    &
       momz,    &
       momx,    &
       momy,    &
       rhot,    &
       qtrc,    &
       dens_av, &
       momz_av, &
       momx_av, &
       momy_av, &
       rhot_av, &
       qtrc_av, &
       dens_tp, &
       momz_tp, &
       momx_tp, &
       momy_tp, &
       rhot_tp, &
       rhoq_tp
    use mod_atmos_dyn_vars, only: &
       prog
    use scale_atmos_refstate, only: &
       atmos_refstate_dens, &
       atmos_refstate_pott, &
       atmos_refstate_qv,   &
       atmos_refstate_pres
    use scale_atmos_boundary, only: &
       atmos_boundary_dens,       &
       atmos_boundary_velz,       &
       atmos_boundary_velx,       &
       atmos_boundary_vely,       &
       atmos_boundary_pott,       &
       atmos_boundary_qtrc,       &
       atmos_boundary_alpha_dens, &
       atmos_boundary_alpha_velz, &
       atmos_boundary_alpha_velx, &
       atmos_boundary_alpha_vely, &
       atmos_boundary_alpha_pott, &
       atmos_boundary_alpha_qtrc
    use scale_atmos_dyn, only: &
       atmos_dyn
    implicit none

    logical, intent(in) :: do_flag
    !---------------------------------------------------------------------------

    if ( do_flag ) then
       call atmos_dyn( dens, momz, momx, momy, rhot, qtrc,                   & ! [INOUT]
                       prog,                                                 & ! [IN]
                       dens_av, momz_av, momx_av, momy_av, rhot_av, qtrc_av, & ! [INOUT]
                       dens_tp, momz_tp, momx_tp, momy_tp, rhot_tp, rhoq_tp, & ! [IN]
                       grid_cdz,  grid_cdx,  grid_cdy,                       & ! [IN]
                       grid_fdz,  grid_fdx,  grid_fdy,                       & ! [IN]
                       grid_rcdz, grid_rcdx, grid_rcdy,                      & ! [IN]
                       grid_rfdz, grid_rfdx, grid_rfdy,                      & ! [IN]
                       real_phi,                                             & ! [IN]
                       gtrans_gsqrt,                                         & ! [IN]
                       gtrans_j13g, gtrans_j23g, gtrans_j33g, gtrans_mapf,   & ! [IN]
                       tracer_r, tracer_cv, tracer_cp, tracer_mass,          & ! [IN]
                       atmos_refstate_dens,                                  & ! [IN]
                       atmos_refstate_pott,                                  & ! [IN]
                       atmos_refstate_qv,                                    & ! [IN]
                       atmos_refstate_pres,                                  & ! [IN]
                       atmos_dyn_numerical_diff_coef,                        & ! [IN]
                       atmos_dyn_numerical_diff_coef_tracer,                 & ! [IN]
                       atmos_dyn_numerical_diff_order,                       & ! [IN]
                       atmos_dyn_numerical_diff_sfc_fact,                    & ! [IN]
                       atmos_dyn_numerical_diff_use_refstate,                & ! [IN]
                       atmos_boundary_dens,                                  & ! [IN]
                       atmos_boundary_velz,                                  & ! [IN]
                       atmos_boundary_velx,                                  & ! [IN]
                       atmos_boundary_vely,                                  & ! [IN]
                       atmos_boundary_pott,                                  & ! [IN]
                       atmos_boundary_qtrc,                                  & ! [IN]
                       atmos_boundary_alpha_dens,                            & ! [IN]
                       atmos_boundary_alpha_velz,                            & ! [IN]
                       atmos_boundary_alpha_velx,                            & ! [IN]
                       atmos_boundary_alpha_vely,                            & ! [IN]
                       atmos_boundary_alpha_pott,                            & ! [IN]
                       atmos_boundary_alpha_qtrc,                            & ! [IN]
                       atmos_dyn_divdmp_coef,                                & ! [IN]
                       atmos_dyn_flag_fct_momentum,                          & ! [IN]
                       atmos_dyn_flag_fct_t,                                 & ! [IN]
                       atmos_dyn_flag_fct_tracer,                            & ! [IN]
                       atmos_dyn_flag_fct_along_stream,                      & ! [IN]
                       atmos_use_average,                                    & ! [IN]
                       time_dtsec,                                           & ! [IN]
                       time_dtsec_atmos_dyn                                  ) ! [IN]

       call atmos_vars_total
    endif

    return
  end subroutine atmos_dyn_driver

end module mod_atmos_dyn_driver