mod_atmos_phy_tb_driver.F90

Go to the documentation of this file.

!-------------------------------------------------------------------------------
!-------------------------------------------------------------------------------
#include "scalelib.h"
module mod_atmos_phy_tb_driver
  !-----------------------------------------------------------------------------
  !
  !++ 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_driver_tracer_setup
  public :: atmos_phy_tb_driver_setup
  public :: atmos_phy_tb_driver_calc_tendency

  !-----------------------------------------------------------------------------
  !
  !++ Public parameters & variables
  !
  !-----------------------------------------------------------------------------
  !
  !++ Private procedure
  !
  !-----------------------------------------------------------------------------
  !
  !++ Private parameters & variables
  !
  !-----------------------------------------------------------------------------
contains
  !-----------------------------------------------------------------------------
  subroutine atmos_phy_tb_driver_tracer_setup
    use scale_prc, only: &
       prc_abort
    use scale_atmos_phy_tb_d1980, only: &
       atmos_phy_tb_d1980_config
    use scale_atmos_phy_tb_dns, only: &
       atmos_phy_tb_dns_config
    use mod_atmos_admin, only: &
       atmos_phy_tb_type, &
       atmos_sw_phy_tb
    use mod_atmos_phy_tb_vars, only: &
       i_tke
    implicit none
    !---------------------------------------------------------------------------

    if ( .not. atmos_sw_phy_tb ) return

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

    select case( atmos_phy_tb_type )
    case( 'SMAGORINSKY' )
       i_tke = -1
    case( 'D1980' )
       call atmos_phy_tb_d1980_config( atmos_phy_tb_type, & ! [IN]
                                       i_tke              ) ! [OUT]
    case( 'DNS' )
       call atmos_phy_tb_dns_config( atmos_phy_tb_type, & ! [IN]
                                     i_tke              ) ! [OUT]
    case('OFF')
       ! do nothing
    case default
       log_error("ATMOS_PHY_TB_driver_tracer_setup",*) 'ATMOS_PHY_TB_TYPE is invalid: ', atmos_phy_tb_type
       call prc_abort
    end select

    return
  end subroutine atmos_phy_tb_driver_tracer_setup

  !-----------------------------------------------------------------------------
  subroutine atmos_phy_tb_driver_setup
    use scale_atmos_grid_cartesc, only: &
       cdz => atmos_grid_cartesc_cdz, &
       cdx => atmos_grid_cartesc_cdx, &
       cdy => atmos_grid_cartesc_cdy
    use scale_atmos_grid_cartesc_real, only: &
       real_cz  => atmos_grid_cartesc_real_cz, &
       real_fz  => atmos_grid_cartesc_real_fz
    use scale_atmos_grid_cartesc_metric, only: &
       mapf  => atmos_grid_cartesc_metric_mapf
    use scale_atmos_phy_tb_smg, only: &
       atmos_phy_tb_smg_setup
    use scale_atmos_phy_tb_d1980, only: &
       atmos_phy_tb_d1980_setup
    use scale_atmos_phy_tb_dns, only: &
       atmos_phy_tb_dns_setup
    use mod_atmos_admin, only: &
       atmos_phy_tb_type, &
       atmos_sw_phy_tb
    use mod_atmos_phy_tb_vars, only: &
       momz_t_tb => atmos_phy_tb_momz_t
    implicit none

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

    if ( .not. atmos_sw_phy_tb ) return

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

    ! initialize
    !$omp parallel do
    do j = js, je
    do i = is, ie
       momz_t_tb(ks-1,i,j) = 0.0_rp
       momz_t_tb(ke  ,i,j) = 0.0_rp
    enddo
    enddo

    ! setup library component
    select case( atmos_phy_tb_type )
    case( 'SMAGORINSKY' )
       call atmos_phy_tb_smg_setup( real_fz, real_cz, cdx, cdy, mapf(:,:,:,i_xy) ) ! [IN]
    case( 'D1980' )
       call atmos_phy_tb_d1980_setup( cdz, cdx, cdy, real_cz ) ! [IN]
    case( 'DNS' )
       call atmos_phy_tb_dns_setup( cdz, cdx, cdy, real_cz ) ! [IN]
    end select

    return
  end subroutine atmos_phy_tb_driver_setup

  !-----------------------------------------------------------------------------
  subroutine atmos_phy_tb_driver_calc_tendency( update_flag )
    use scale_statistics, only: &
       statistics_checktotal, &
       statistics_total
    use scale_atmos_grid_cartesc, only: &
       fdz  => atmos_grid_cartesc_fdz, &
       rcdz => atmos_grid_cartesc_rcdz, &
       rfdz => atmos_grid_cartesc_rfdz, &
       cdx  => atmos_grid_cartesc_cdx, &
       fdx  => atmos_grid_cartesc_fdx, &
       cdy  => atmos_grid_cartesc_cdy, &
       fdy  => atmos_grid_cartesc_fdy
    use scale_atmos_grid_cartesc_real, only: &
       fz  => atmos_grid_cartesc_real_fz, &
       atmos_grid_cartesc_real_vol,       &
       atmos_grid_cartesc_real_totvol,    &
       atmos_grid_cartesc_real_volwxy,    &
       atmos_grid_cartesc_real_totvolwxy, &
       atmos_grid_cartesc_real_volzuy,    &
       atmos_grid_cartesc_real_totvolzuy, &
       atmos_grid_cartesc_real_volzxv,    &
       atmos_grid_cartesc_real_totvolzxv
    use scale_atmos_grid_cartesc_metric, only: &
       gsqrt => atmos_grid_cartesc_metric_gsqrt, &
       j13g  => atmos_grid_cartesc_metric_j13g,  &
       j23g  => atmos_grid_cartesc_metric_j23g,  &
       j33g  => atmos_grid_cartesc_metric_j33g,  &
       mapf  => atmos_grid_cartesc_metric_mapf
    use scale_file_history, only: &
       file_history_in
    use scale_time, only: &
       dt_tb => time_dtsec_atmos_phy_tb
    use scale_atmos_phy_tb_smg, only: &
       atmos_phy_tb_smg
    use scale_atmos_phy_tb_d1980, only: &
       atmos_phy_tb_d1980
    use scale_atmos_phy_tb_dns, only: &
       atmos_phy_tb_dns
    use scale_atmos_phy_tb_common, only: &
       calc_tend_momz => atmos_phy_tb_calc_tend_momz, &
       calc_tend_momx => atmos_phy_tb_calc_tend_momx, &
       calc_tend_momy => atmos_phy_tb_calc_tend_momy, &
       calc_tend_phi  => atmos_phy_tb_calc_tend_phi
    use mod_atmos_admin, only: &
       atmos_phy_tb_type
    use mod_atmos_vars, only: &
       atmos_vars_get_diagnostic, &
       dens => dens_av,   &
       momz => momz_av,   &
       momx => momx_av,   &
       momy => momy_av,   &
       rhot => rhot_av,   &
       pott,              &
       qtrc => qtrc_av,   &
       momz_t => momz_tp, &
       momx_t => momx_tp, &
       momy_t => momy_tp, &
       rhot_t => rhot_tp, &
       rhoq_t => rhoq_tp
    use mod_atmos_phy_tb_vars, only: &
       i_tke, &
       momz_t_tb => atmos_phy_tb_momz_t, &
       momx_t_tb => atmos_phy_tb_momx_t, &
       momy_t_tb => atmos_phy_tb_momy_t, &
       rhot_t_tb => atmos_phy_tb_rhot_t, &
       rhoq_t_tb => atmos_phy_tb_rhoq_t
    use mod_atmos_phy_sf_vars, only: &
       sflx_mw => atmos_phy_sf_sflx_mw, &
       sflx_mu => atmos_phy_sf_sflx_mu, &
       sflx_mv => atmos_phy_sf_sflx_mv, &
       sflx_sh => atmos_phy_sf_sflx_sh, &
       sflx_q  => atmos_phy_sf_sflx_qtrc
    implicit none

    logical, intent(in) :: update_flag

    ! eddy viscosity/diffusion flux
    real(RP) :: QFLX_MOMZ(ka,ia,ja,3)
    real(RP) :: QFLX_MOMX(ka,ia,ja,3)
    real(RP) :: QFLX_MOMY(ka,ia,ja,3)
    real(RP) :: QFLX_RHOT(ka,ia,ja,3)
    real(RP) :: QFLX_RHOQ(ka,ia,ja,3,qa)

    real(RP) :: Nu(ka,ia,ja) ! eddy viscosity
    real(RP) :: Ri(ka,ia,ja) ! Richardson number
    real(RP) :: Pr(ka,ia,ja) ! Prandtl number

    real(RP) :: N2(ka,ia,ja)

    real(RP) :: tend(ka,ia,ja)

    integer  :: JJS, JJE
    integer  :: IIS, IIE

    integer  :: k, i, j, iq
    !---------------------------------------------------------------------------

    if ( update_flag ) then

       call atmos_vars_get_diagnostic( "N2", n2 )

       select case( atmos_phy_tb_type )
       case( 'SMAGORINSKY' )
          call atmos_phy_tb_smg( qflx_momz, qflx_momx, qflx_momy,         & ! [OUT]
                                 qflx_rhot, qflx_rhoq,                    & ! [OUT]
                                 momz_t_tb, momx_t_tb, momy_t_tb,         & ! [OUT]
                                 rhot_t_tb, rhoq_t_tb,                    & ! [OUT]
                                 nu, ri, pr,                              & ! [OUT]
                                 momz, momx, momy, pott, dens, qtrc, n2,  & ! [IN]
                                 fz, fdz, rcdz, rfdz, cdx, fdx, cdy, fdy, & ! [IN]
                                 gsqrt, j13g, j23g, j33g, mapf,           & ! [IN]
                                 dt_tb                                    ) ! [IN]
       case( 'D1980' )
          momz_t_tb(:,:,:)   = 0.0_rp
          momx_t_tb(:,:,:)   = 0.0_rp
          momy_t_tb(:,:,:)   = 0.0_rp
          rhot_t_tb(:,:,:)   = 0.0_rp
          call atmos_phy_tb_d1980( qflx_momz, qflx_momx, qflx_momy,        & ! [OUT]
                                   qflx_rhot, qflx_rhoq,                   & ! [OUT]
                                   rhoq_t_tb,                              & ! [OUT]
                                   nu, ri, pr,                             & ! [OUT]
                                   momz, momx, momy, rhot, dens, qtrc, n2, & ! [IN]
                                   sflx_mw, sflx_mu, sflx_mv,              & ! [IN]
                                   sflx_sh, sflx_q,                        & ! [IN]
                                   gsqrt, j13g, j23g, j33g, mapf,          & ! [IN]
                                   dt_tb                                   ) ! [IN]
       case( 'DNS' )
          momz_t_tb(:,:,:)   = 0.0_rp
          momx_t_tb(:,:,:)   = 0.0_rp
          momy_t_tb(:,:,:)   = 0.0_rp
          rhot_t_tb(:,:,:)   = 0.0_rp
          call atmos_phy_tb_dns( qflx_momz, qflx_momx, qflx_momy,        & ! [OUT]
                                 qflx_rhot, qflx_rhoq,                   & ! [OUT]
                                 rhoq_t_tb,                              & ! [OUT]
                                 nu, ri, pr,                             & ! [OUT]
                                 momz, momx, momy, rhot, dens, qtrc, n2, & ! [IN]
                                 sflx_mw, sflx_mu, sflx_mv,              & ! [IN]
                                 sflx_sh, sflx_q,                        & ! [IN]
                                 gsqrt, j13g, j23g, j33g, mapf,          & ! [IN]
                                 dt_tb                                   ) ! [IN]
       end select


       do jjs = js, je, jblock
       jje = jjs+jblock-1
       do iis = is, ie, iblock
       iie = iis+iblock-1

          call calc_tend_momz( tend(:,:,:), & ! (out)
                               qflx_momz,   & ! (in)
                               gsqrt, j13g, j23g, j33g, mapf, & ! (in)
                               iis, iie, jjs, jje ) ! (in)
          !$omp parallel do
          do j = jjs, jje
          do i = iis, iie
          do k = ks, ke-1
             momz_t_tb(k,i,j) = momz_t_tb(k,i,j) + tend(k,i,j)
          end do
          end do
          end do

          call calc_tend_momx( tend(:,:,:), & ! (out)
                               qflx_momx,   & ! (in)
                               gsqrt, j13g, j23g, j33g, mapf, & ! (in)
                               iis, iie, jjs, jje ) ! (in)
          !$omp parallel do
          do j = jjs, jje
          do i = iis, iie
          do k = ks, ke
             momx_t_tb(k,i,j) = momx_t_tb(k,i,j) + tend(k,i,j)
          end do
          end do
          end do

          call calc_tend_momy( tend(:,:,:), & ! (out)
                               qflx_momy,   & ! (in)
                               gsqrt, j13g, j23g, j33g, mapf, & ! (in)
                               iis, iie, jjs, jje ) ! (in)
          !$omp parallel do
          do j = jjs, jje
          do i = iis, iie
          do k = ks, ke
             momy_t_tb(k,i,j) = momy_t_tb(k,i,j) + tend(k,i,j)
          end do
          end do
          end do

          call calc_tend_phi ( tend(:,:,:), & ! (out)
                               qflx_rhot,   & ! (in)
                               gsqrt, j13g, j23g, j33g, mapf, & ! (in)
                               iis, iie, jjs, jje ) ! (in)
          !$omp parallel do
          do j = jjs, jje
          do i = iis, iie
          do k = ks, ke
             rhot_t_tb(k,i,j) = rhot_t_tb(k,i,j) + tend(k,i,j)
          end do
          end do
          end do

          do iq = 1, qa
             if ( iq == i_tke .or. .not. tracer_advc(iq) ) cycle

             call calc_tend_phi( tend(:,:,:),                   & ! (out)
                                 qflx_rhoq(:,:,:,:,iq),         & ! (in)
                                 gsqrt, j13g, j23g, j33g, mapf, & ! (in)
                                 iis, iie, jjs, jje ) ! (in)

             !$omp parallel do
             do j = jjs, jje
             do i = iis, iie
             do k = ks, ke
                rhoq_t_tb(k,i,j,iq) = rhoq_t_tb(k,i,j,iq) + tend(k,i,j)
             end do
             end do
             end do

          end do

       end do
       end do


       call file_history_in( nu(:,:,:), 'NU',  'eddy viscosity',           'm2/s' , fill_halo=.true. )
       call file_history_in( ri(:,:,:), 'Ri',  'Richardson number',        'NIL'  , fill_halo=.true. )
       call file_history_in( pr(:,:,:), 'Pr',  'Prantle number',           'NIL'  , fill_halo=.true. )

       call file_history_in( momz_t_tb(:,:,:), 'MOMZ_t_TB', 'MOMZ tendency (TB)', 'kg/m2/s2',  fill_halo=.true. )
       call file_history_in( momx_t_tb(:,:,:), 'MOMX_t_TB', 'MOMX tendency (TB)', 'kg/m2/s2',  fill_halo=.true. )
       call file_history_in( momy_t_tb(:,:,:), 'MOMY_t_TB', 'MOMY tendency (TB)', 'kg/m2/s2',  fill_halo=.true. )
       call file_history_in( rhot_t_tb(:,:,:), 'RHOT_t_TB', 'RHOT tendency (TB)', 'K.kg/m3/s', fill_halo=.true. )

       do iq = 1, qa
          call file_history_in( rhoq_t_tb(:,:,:,iq), trim(tracer_name(iq))//'_t_TB',                      &
                        'tendency rho*'//trim(tracer_name(iq))//' in TB', 'kg/m3/s', fill_halo=.true. )
       enddo

       call file_history_in( qflx_momz(:,:,:,zdir), 'SGS_ZFLX_MOMZ', 'SGS Z FLUX of MOMZ', 'kg/m/s2', &
                     fill_halo=.true.)
       call file_history_in( qflx_momz(:,:,:,xdir), 'SGS_XFLX_MOMZ', 'SGS X FLUX of MOMZ', 'kg/m/s2', &
                     dim_type='ZHXHY', fill_halo=.true.)
       call file_history_in( qflx_momz(:,:,:,ydir), 'SGS_YFLX_MOMZ', 'SGS Y FLUX of MOMZ', 'kg/m/s2', &
                     dim_type='ZHXYH', fill_halo=.true.)

       call file_history_in( qflx_momx(:,:,:,zdir), 'SGS_ZFLX_MOMX', 'SGS Z FLUX of MOMX', 'kg/m/s2', &
                     dim_type='ZHXHY', fill_halo=.true.)
       call file_history_in( qflx_momx(:,:,:,xdir), 'SGS_XFLX_MOMX', 'SGS X FLUX of MOMX', 'kg/m/s2', &
                     fill_halo=.true.)
       call file_history_in( qflx_momx(:,:,:,ydir), 'SGS_YFLX_MOMX', 'SGS Y FLUX of MOMX', 'kg/m/s2', &
                     dim_type='ZXHYH', fill_halo=.true.)

       call file_history_in( qflx_momy(:,:,:,zdir), 'SGS_ZFLX_MOMY', 'SGS Z FLUX of MOMY', 'kg/m/s2', &
                     dim_type='ZHXYH', fill_halo=.true.)
       call file_history_in( qflx_momy(:,:,:,xdir), 'SGS_XFLX_MOMY', 'SGS X FLUX of MOMY', 'kg/m/s2', &
                     dim_type='ZXHYH', fill_halo=.true.)
       call file_history_in( qflx_momy(:,:,:,ydir), 'SGS_YFLX_MOMY', 'SGS Y FLUX of MOMY', 'kg/m/s2', &
                     fill_halo=.true.)

       call file_history_in( qflx_rhot(:,:,:,zdir), 'SGS_ZFLX_RHOT', 'SGS Z FLUX of RHOT', 'K*kg/m2/s', &
                     dim_type='ZHXY', fill_halo=.true.)
       call file_history_in( qflx_rhot(:,:,:,xdir), 'SGS_XFLX_RHOT', 'SGS X FLUX of RHOT', 'K*kg/m2/s', &
                     dim_type='ZXHY', fill_halo=.true.)
       call file_history_in( qflx_rhot(:,:,:,ydir), 'SGS_YFLX_RHOT', 'SGS Y FLUX of RHOT', 'K*kg/m2/s', &
                     dim_type='ZXYH', fill_halo=.true.)


       do iq = 1, qa
          if ( iq == i_tke .or. .not. tracer_advc(iq) ) cycle

          call file_history_in( qflx_rhoq(:,:,:,zdir,iq), &
               'SGS_ZFLX_'//trim(tracer_name(iq)), 'SGS Z FLUX of '//trim(tracer_name(iq)), 'kg/m2/s', &
               dim_type='ZHXY', fill_halo=.true.)
          call file_history_in( qflx_rhoq(:,:,:,xdir,iq), &
               'SGS_XFLX_'//trim(tracer_name(iq)), 'SGS X FLUX of '//trim(tracer_name(iq)), 'kg/m2/s', &
               dim_type='ZXHY', fill_halo=.true.)
          call file_history_in( qflx_rhoq(:,:,:,ydir,iq), &
               'SGS_YFLX_'//trim(tracer_name(iq)), 'SGS Y FLUX of '//trim(tracer_name(iq)), 'kg/m2/s', &
               dim_type='ZXYH', fill_halo=.true.)
       end do

       if ( statistics_checktotal ) then
          call statistics_total( ka, ks, ke, ia, is, ie, ja, js, je, &
                                 momz_t_tb(:,:,:), 'MOMZ_t_TB',         &
                                 atmos_grid_cartesc_real_volwxy(:,:,:), &
                                 atmos_grid_cartesc_real_totvolwxy      )
          call statistics_total( ka, ks, ke, ia, is, ie, ja, js, je, &
                                 momx_t_tb(:,:,:), 'MOMX_t_TB',         &
                                 atmos_grid_cartesc_real_volzuy(:,:,:), &
                                 atmos_grid_cartesc_real_totvolzuy      )
          call statistics_total( ka, ks, ke, ia, is, ie, ja, js, je, &
                                 momy_t_tb(:,:,:), 'MOMY_t_TB',         &
                                 atmos_grid_cartesc_real_volzxv(:,:,:), &
                                 atmos_grid_cartesc_real_totvolzxv      )
          call statistics_total( ka, ks, ke, ia, is, ie, ja, js, je, &
                                 rhot_t_tb(:,:,:), 'RHOT_t_TB',       &
                                 atmos_grid_cartesc_real_vol(:,:,:),  &
                                 atmos_grid_cartesc_real_totvol       )
          call statistics_total( ka, ks, ke, ia, is, ie, ja, js, je, &
                                 nu(:,:,:),        'Nu',              &
                                 atmos_grid_cartesc_real_vol(:,:,:),  &
                                 atmos_grid_cartesc_real_totvol       )
          call statistics_total( ka, ks, ke, ia, is, ie, ja, js, je, &
                                 ri(:,:,:),        'Ri',              &
                                 atmos_grid_cartesc_real_vol(:,:,:),  &
                                 atmos_grid_cartesc_real_totvol       )
          call statistics_total( ka, ks, ke, ia, is, ie, ja, js, je, &
                                 pr(:,:,:),        'Pr',              &
                                 atmos_grid_cartesc_real_vol(:,:,:),  &
                                 atmos_grid_cartesc_real_totvol       )

          do iq = 1, qa
             call statistics_total( ka, ks, ke, ia, is, ie, ja, js, je, &
                                    rhoq_t_tb(:,:,:,iq), trim(tracer_name(iq))//'_t_TB', &
                                    atmos_grid_cartesc_real_vol(:,:,:),                  &
                                    atmos_grid_cartesc_real_totvol                       )
          enddo
       endif

    endif

    !$omp parallel do default(none) private(i,j,k) OMP_SCHEDULE_ collapse(2) &
    !$omp shared(JS,JE,IS,IE,KS,KE,MOMZ_t,MOMZ_t_TB,MOMX_t,MOMX_t_TB,MOMY_t,MOMY_t_TB,RHOT_t,RHOT_t_TB)
    do j = js, je
    do i = is, ie
    do k = ks, ke
       momz_t(k,i,j) = momz_t(k,i,j) + momz_t_tb(k,i,j)
       momx_t(k,i,j) = momx_t(k,i,j) + momx_t_tb(k,i,j)
       momy_t(k,i,j) = momy_t(k,i,j) + momy_t_tb(k,i,j)
       rhot_t(k,i,j) = rhot_t(k,i,j) + rhot_t_tb(k,i,j)
    enddo
    enddo
    enddo

    do iq = 1,  qa

       if ( .not. ( iq == i_tke .or. tracer_advc(iq) ) ) cycle

       !$omp parallel do private(i,j,k) OMP_SCHEDULE_ collapse(2)
       do j  = js, je
       do i  = is, ie
       do k  = ks, ke
          rhoq_t(k,i,j,iq) = rhoq_t(k,i,j,iq) + rhoq_t_tb(k,i,j,iq)
       enddo
       enddo
      enddo

    enddo

    return
  end subroutine atmos_phy_tb_driver_calc_tendency

end module mod_atmos_phy_tb_driver