scale_atmos_dyn_tstep_short.F90

Go to the documentation of this file.

!-------------------------------------------------------------------------------
!-------------------------------------------------------------------------------
#include "scalelib.h"
module scale_atmos_dyn_tstep_short
  !-----------------------------------------------------------------------------
  !
  !++ used modules
  !
  use scale_precision
  use scale_io
  use scale_prof
  use scale_atmos_grid_cartesc_index
  use scale_index
  use scale_tracer
  !-----------------------------------------------------------------------------
  implicit none
  private
  !-----------------------------------------------------------------------------
  !
  !++ Public procedure
  !
  public :: atmos_dyn_tstep_short_regist
 
  abstract interface
 
     subroutine short_setup
     end subroutine short_setup
 
     subroutine short( DENS_new, MOMZ_new, MOMX_new, MOMY_new, RHOT_new, & ! (out)
                       prog_new,                                         & ! (out)
                       mflx_hi,  tflx_hi,                                & ! (out)
                       dens0,    momz0,    momx0,    momy0,    rhot0,    & ! (in)
                       dens,     momz,     momx,     momy,     rhot,     & ! (in)
                       dens_t,   momz_t,   momx_t,   momy_t,   rhot_t,   & ! (in)
                       prog0, prog,                                      & ! (in)
                       dpres0, rt2p, corioli,                            & ! (in)
                       num_diff, wdamp_coef, divdmp_coef, ddiv,          & ! (in)
                       flag_fct_momentum, flag_fct_t,                    & ! (in)
                       flag_fct_along_stream,                            & ! (in)
                       cdz, fdz, fdx, fdy,                               & ! (in)
                       rcdz, rcdx, rcdy, rfdz, rfdx, rfdy,               & ! (in)
                       phi, gsqrt, j13g, j23g, j33g, mapf,               & ! (in)
                       ref_dens, ref_rhot,                               & ! (in)
                       bnd_w, bnd_e, bnd_s, bnd_n, twod,                 & ! (in)
                       dtrk, last                                        ) ! (in)
       use scale_precision
       use scale_atmos_grid_cartesc_index
       use scale_index
       real(RP), intent(out) :: DENS_new(KA,IA,JA)   ! prognostic variables
       real(RP), intent(out) :: MOMZ_new(KA,IA,JA)   !
       real(RP), intent(out) :: MOMX_new(KA,IA,JA)   !
       real(RP), intent(out) :: MOMY_new(KA,IA,JA)   !
       real(RP), intent(out) :: RHOT_new(KA,IA,JA)   !
       real(RP), intent(out) :: PROG_new(KA,IA,JA,VA)  !
 
       real(RP), intent(inout) :: mflx_hi(KA,IA,JA,3) ! mass flux
       real(RP), intent(out)   :: tflx_hi(KA,IA,JA,3) ! internal energy flux
 
       real(RP), intent(in),target :: DENS0(KA,IA,JA) ! prognostic variables at previous dynamical time step
       real(RP), intent(in),target :: MOMZ0(KA,IA,JA) !
       real(RP), intent(in),target :: MOMX0(KA,IA,JA) !
       real(RP), intent(in),target :: MOMY0(KA,IA,JA) !
       real(RP), intent(in),target :: RHOT0(KA,IA,JA) !
 
       real(RP), intent(in)  :: DENS(KA,IA,JA)      ! prognostic variables at previous RK step
       real(RP), intent(in)  :: MOMZ(KA,IA,JA)      !
       real(RP), intent(in)  :: MOMX(KA,IA,JA)      !
       real(RP), intent(in)  :: MOMY(KA,IA,JA)      !
       real(RP), intent(in)  :: RHOT(KA,IA,JA)      !
 
       real(RP), intent(in)  :: DENS_t(KA,IA,JA)    ! tendency
       real(RP), intent(in)  :: MOMZ_t(KA,IA,JA)    !
       real(RP), intent(in)  :: MOMX_t(KA,IA,JA)    !
       real(RP), intent(in)  :: MOMY_t(KA,IA,JA)    !
       real(RP), intent(in)  :: RHOT_t(KA,IA,JA)    !
 
       real(RP), intent(in)  :: PROG0(KA,IA,JA,VA)
       real(RP), intent(in)  :: PROG (KA,IA,JA,VA)
 
       real(RP), intent(in)  :: DPRES0  (KA,IA,JA)
       real(RP), intent(in)  :: RT2P    (KA,IA,JA)
       real(RP), intent(in)  :: CORIOLI (   IA,JA)
       real(RP), intent(in)  :: num_diff(KA,IA,JA,5,3)
       real(RP), intent(in)  :: wdamp_coef(KA)
       real(RP), intent(in)  :: divdmp_coef
       real(RP), intent(in)  :: DDIV(KA,IA,JA)
 
       logical,  intent(in)  :: FLAG_FCT_MOMENTUM
       logical,  intent(in)  :: FLAG_FCT_T
       logical,  intent(in)  :: FLAG_FCT_ALONG_STREAM
 
       real(RP), intent(in)  :: CDZ (KA)
       real(RP), intent(in)  :: FDZ (KA-1)
       real(RP), intent(in)  :: FDX (IA-1)
       real(RP), intent(in)  :: FDY (JA-1)
       real(RP), intent(in)  :: RCDZ(KA)
       real(RP), intent(in)  :: RCDX(IA)
       real(RP), intent(in)  :: RCDY(JA)
       real(RP), intent(in)  :: RFDZ(KA-1)
       real(RP), intent(in)  :: RFDX(IA-1)
       real(RP), intent(in)  :: RFDY(JA-1)
 
       real(RP), intent(in)  :: PHI     (KA,IA,JA)
       real(RP), intent(in)  :: GSQRT   (KA,IA,JA,7)
       real(RP), intent(in)  :: J13G    (KA,IA,JA,7)
       real(RP), intent(in)  :: J23G    (KA,IA,JA,7)
       real(RP), intent(in)  :: J33G
       real(RP), intent(in)  :: MAPF    (IA,JA,2,4)
       real(RP), intent(in)  :: REF_dens(KA,IA,JA)
       real(RP), intent(in)  :: REF_rhot(KA,IA,JA)
 
       logical,  intent(in)  :: BND_W
       logical,  intent(in)  :: BND_E
       logical,  intent(in)  :: BND_S
       logical,  intent(in)  :: BND_N
       logical,  intent(in)  :: TwoD
 
       real(RP), intent(in)  :: dtrk
       logical,  intent(in)  :: last
     end subroutine short
 
  end interface
 
  procedure(short_setup), pointer :: atmos_dyn_tstep_short_setup => null()
  public :: atmos_dyn_tstep_short_setup
  procedure(short), pointer :: atmos_dyn_tstep_short => null()
  public :: atmos_dyn_tstep_short
 
  !-----------------------------------------------------------------------------
  !
  !++ Public parameters & variables
  !
  !-----------------------------------------------------------------------------
  !
  !++ Private procedure
  !
  !-----------------------------------------------------------------------------
  !
  !++ Private parameters & variables
  !
  !-----------------------------------------------------------------------------
contains
  !-----------------------------------------------------------------------------
  subroutine atmos_dyn_tstep_short_regist( &
       ATMOS_DYN_TYPE, &
       VA_out, &
       VAR_NAME, VAR_DESC, VAR_UNIT )
    use scale_precision
    use scale_atmos_grid_cartesc_index
    use scale_index
    use scale_prc, only: &
       prc_abort
    use scale_atmos_dyn_tstep_short_fvm_heve, only: &
       atmos_dyn_tstep_short_fvm_heve_regist, &
       atmos_dyn_tstep_short_fvm_heve_setup, &
       atmos_dyn_tstep_short_fvm_heve
    use scale_atmos_dyn_tstep_short_fvm_hevi, only: &
       atmos_dyn_tstep_short_fvm_hevi_regist, &
       atmos_dyn_tstep_short_fvm_hevi_setup, &
       atmos_dyn_tstep_short_fvm_hevi
    use scale_atmos_dyn_tstep_short_fvm_hivi, only: &
       atmos_dyn_tstep_short_fvm_hivi_regist, &
       atmos_dyn_tstep_short_fvm_hivi_setup, &
       atmos_dyn_tstep_short_fvm_hivi
    implicit none
 
    character(len=*),       intent(in)  :: atmos_dyn_type
    integer,                intent(out) :: va_out
    character(len=H_SHORT), intent(out) :: var_name(:)
    character(len=H_MID),   intent(out) :: var_desc(:)
    character(len=H_SHORT), intent(out) :: var_unit(:)
    !---------------------------------------------------------------------------
 
    select case( atmos_dyn_type )
    case( 'FVM-HEVE', 'HEVE' )
 
       call atmos_dyn_tstep_short_fvm_heve_regist( atmos_dyn_type,              & ! [IN]
                                                   va_out,                      & ! [OUT]
                                                   var_name, var_desc, var_unit ) ! [OUT]
 
       atmos_dyn_tstep_short_setup => atmos_dyn_tstep_short_fvm_heve_setup
       atmos_dyn_tstep_short       => atmos_dyn_tstep_short_fvm_heve
 
    case( 'FVM-HEVI', 'HEVI' )
 
       call atmos_dyn_tstep_short_fvm_hevi_regist( atmos_dyn_type,              & ! [IN]
                                                   va_out,                      & ! [OUT]
                                                   var_name, var_desc, var_unit ) ! [OUT]
 
       atmos_dyn_tstep_short_setup => atmos_dyn_tstep_short_fvm_hevi_setup
       atmos_dyn_tstep_short       => atmos_dyn_tstep_short_fvm_hevi
 
    case( 'FVM-HIVI', 'HIVI' )
 
       log_error("ATMOS_DYN_Tstep_short_regist",*) 'HIVI is tentatively disabled'
       call prc_abort
 
       call atmos_dyn_tstep_short_fvm_hivi_regist( atmos_dyn_type,              & ! [IN]
                                                   va_out,                      & ! [OUT]
                                                   var_name, var_desc, var_unit ) ! [OUT]
 
       atmos_dyn_tstep_short_setup => atmos_dyn_tstep_short_fvm_hivi_setup
       atmos_dyn_tstep_short       => atmos_dyn_tstep_short_fvm_hivi
 
    case( 'OFF', 'NONE' )
 
       va_out      = 0
       var_name(:) = ""
       var_desc(:) = ""
       var_unit(:) = ""
 
    case default
       log_error("ATMOS_DYN_Tstep_short_regist",*) 'ATMOS_DYN_TYPE is invalid: ', atmos_dyn_type
       call prc_abort
    end select
 
    return
  end subroutine atmos_dyn_tstep_short_regist
 
end module scale_atmos_dyn_tstep_short