scale_atmos_dyn_tstep_large.F90

Go to the documentation of this file.

!-------------------------------------------------------------------------------
!-------------------------------------------------------------------------------
#include "scalelib.h"
module scale_atmos_dyn_tstep_large
  !-----------------------------------------------------------------------------
  !
  !++ 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_large_setup

  abstract interface

     subroutine large( &
          DENS, MOMZ, MOMX, MOMY, RHOT, QTRC, PROG,             &
          DENS_av, MOMZ_av, MOMX_av, MOMY_av, RHOT_av, QTRC_av, &
          mflx_hi, tflx_hi,                                     &
          num_diff, num_diff_q,                                 &
          QTRC0,                                                &
          DENS_tp, MOMZ_tp, MOMX_tp, MOMY_tp, RHOT_tp, RHOQ_tp, &
          CORIOLI,                                              &
          CDZ, CDX, CDY, FDZ, FDX, FDY,                         &
          RCDZ, RCDX, RCDY, RFDZ, RFDX, RFDY,                   &
          PHI, GSQRT,                                           &
          J13G, J23G, J33G, MAPF,                               &
          AQ_R, AQ_CV, AQ_CP, AQ_MASS,                          &
          REF_dens, REF_pott, REF_qv, REF_pres,                 &
          BND_W, BND_E, BND_S, BND_N,                           &
          ND_COEF, ND_COEF_Q, ND_ORDER, ND_SFC_FACT, ND_USE_RS, &
          BND_QA, BND_SMOOTHER_FACT,                            &
          DAMP_DENS,       DAMP_VELZ,       DAMP_VELX,          &
          DAMP_VELY,       DAMP_POTT,       DAMP_QTRC,          &
          DAMP_alpha_DENS, DAMP_alpha_VELZ, DAMP_alpha_VELX,    &
          DAMP_alpha_VELY, DAMP_alpha_POTT, DAMP_alpha_QTRC,    &
          wdamp_coef,                                           &
          divdmp_coef,                                          &
          FLAG_TRACER_SPLIT_TEND,                               &
          FLAG_FCT_MOMENTUM, FLAG_FCT_T, FLAG_FCT_TRACER,       &
          FLAG_FCT_ALONG_STREAM,                                &
          USE_AVERAGE,                                          &
          I_QV,                                                 &
          DTL, DTS, Llast                                       )
       use scale_precision
       use scale_atmos_grid_cartesc_index
       use scale_index
       use scale_tracer
       real(RP), intent(inout) :: dens(ka,ia,ja)
       real(RP), intent(inout) :: momz(ka,ia,ja)
       real(RP), intent(inout) :: momx(ka,ia,ja)
       real(RP), intent(inout) :: momy(ka,ia,ja)
       real(RP), intent(inout) :: rhot(ka,ia,ja)
       real(RP), intent(inout) :: qtrc(ka,ia,ja,qa)
       real(RP), intent(inout) :: prog(ka,ia,ja,va)

       real(RP), intent(inout) :: dens_av(ka,ia,ja)
       real(RP), intent(inout) :: momz_av(ka,ia,ja)
       real(RP), intent(inout) :: momx_av(ka,ia,ja)
       real(RP), intent(inout) :: momy_av(ka,ia,ja)
       real(RP), intent(inout) :: rhot_av(ka,ia,ja)
       real(RP), intent(inout) :: qtrc_av(ka,ia,ja,qa)

       real(RP), intent(out)   :: mflx_hi(ka,ia,ja,3)
       real(RP), intent(out)   :: tflx_hi(ka,ia,ja,3)

       real(RP), intent(out)   :: num_diff(ka,ia,ja,5,3)
       real(RP), intent(out)   :: num_diff_q(ka,ia,ja,3)

       real(RP), intent(in)    :: qtrc0(ka,ia,ja,qa)

       real(RP), intent(in)    :: dens_tp(ka,ia,ja)
       real(RP), intent(in)    :: momz_tp(ka,ia,ja)
       real(RP), intent(in)    :: momx_tp(ka,ia,ja)
       real(RP), intent(in)    :: momy_tp(ka,ia,ja)
       real(RP), intent(in)    :: rhot_tp(ka,ia,ja)
       real(RP), intent(in)    :: rhoq_tp(ka,ia,ja,qa)

       real(RP), intent(in)    :: corioli(ia,ja)

       real(RP), intent(in)    :: cdz (ka)
       real(RP), intent(in)    :: cdx (ia)
       real(RP), intent(in)    :: cdy (ja)
       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)    :: aq_r   (qa)
       real(RP), intent(in)    :: aq_cv  (qa)
       real(RP), intent(in)    :: aq_cp  (qa)
       real(RP), intent(in)    :: aq_mass(qa)

       real(RP), intent(in)    :: ref_dens(ka,ia,ja)
       real(RP), intent(in)    :: ref_pott(ka,ia,ja)
       real(RP), intent(in)    :: ref_qv  (ka,ia,ja)
       real(RP), intent(in)    :: ref_pres(ka,ia,ja)

       logical,  intent(in)    :: bnd_w
       logical,  intent(in)    :: bnd_e
       logical,  intent(in)    :: bnd_s
       logical,  intent(in)    :: bnd_n

       real(RP), intent(in)    :: nd_coef
       real(RP), intent(in)    :: nd_coef_q
       integer,  intent(in)    :: nd_order
       real(RP), intent(in)    :: nd_sfc_fact
       logical,  intent(in)    :: nd_use_rs

       integer,  intent(in)    :: bnd_qa
       real(RP), intent(in)    :: bnd_smoother_fact

       real(RP), intent(in)    :: damp_dens(ka,ia,ja)
       real(RP), intent(in)    :: damp_velz(ka,ia,ja)
       real(RP), intent(in)    :: damp_velx(ka,ia,ja)
       real(RP), intent(in)    :: damp_vely(ka,ia,ja)
       real(RP), intent(in)    :: damp_pott(ka,ia,ja)
       real(RP), intent(in)    :: damp_qtrc(ka,ia,ja,bnd_qa)

       real(RP), intent(in)    :: damp_alpha_dens(ka,ia,ja)
       real(RP), intent(in)    :: damp_alpha_velz(ka,ia,ja)
       real(RP), intent(in)    :: damp_alpha_velx(ka,ia,ja)
       real(RP), intent(in)    :: damp_alpha_vely(ka,ia,ja)
       real(RP), intent(in)    :: damp_alpha_pott(ka,ia,ja)
       real(RP), intent(in)    :: damp_alpha_qtrc(ka,ia,ja,bnd_qa)

       real(RP), intent(in)    :: wdamp_coef(ka)
       real(RP), intent(in)    :: divdmp_coef

       logical,  intent(in)    :: flag_tracer_split_tend
       logical,  intent(in)    :: flag_fct_momentum
       logical,  intent(in)    :: flag_fct_t
       logical,  intent(in)    :: flag_fct_tracer
       logical,  intent(in)    :: flag_fct_along_stream

       logical,  intent(in)    :: use_average

       integer,  intent(in)    :: i_qv

       real(DP), intent(in)    :: dtl
       real(DP), intent(in)    :: dts

       logical , intent(in)    :: llast
     end subroutine large

  end interface

  procedure(large), pointer :: atmos_dyn_tstep_large => null()
  public :: atmos_dyn_tstep_large

  !-----------------------------------------------------------------------------
  !
  !++ Public parameters & variables
  !
  !-----------------------------------------------------------------------------
  !
  !++ Private procedure
  !
  !-----------------------------------------------------------------------------
  !
  !++ Private parameters & variables
  !
  !-----------------------------------------------------------------------------
contains
  !-----------------------------------------------------------------------------
  subroutine atmos_dyn_tstep_large_setup( &
       Tstep_large_type, &
       DENS, MOMZ, MOMX, MOMY, RHOT, QTRC, PROG, &
       mflx_hi )
    use scale_precision
    use scale_atmos_grid_cartesc_index
    use scale_index
    use scale_prc, only: &
       prc_abort
    use scale_atmos_dyn_tstep_large_fvm_heve, only: &
       atmos_dyn_tstep_large_fvm_heve_setup, &
       atmos_dyn_tstep_large_fvm_heve
    implicit none
    character(len=*), intent(in) :: Tstep_large_type
    real(RP), intent(inout) :: DENS(ka,ia,ja)
    real(RP), intent(inout) :: MOMZ(ka,ia,ja)
    real(RP), intent(inout) :: MOMX(ka,ia,ja)
    real(RP), intent(inout) :: MOMY(ka,ia,ja)
    real(RP), intent(inout) :: RHOT(ka,ia,ja)
    real(RP), intent(inout) :: QTRC(ka,ia,ja,qa)
    real(RP), intent(inout) :: PROG(ka,ia,ja,va)
    real(RP), intent(inout) :: mflx_hi(ka,ia,ja,3)

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

    select case( tstep_large_type )
    case( 'FVM-HEVE' )
       call atmos_dyn_tstep_large_fvm_heve_setup( &
            dens, momz, momx, momy, rhot, qtrc, prog, &
            mflx_hi )
       atmos_dyn_tstep_large => atmos_dyn_tstep_large_fvm_heve
    case default
       log_error("ATMOS_DYN_Tstep_large_setup",*) 'ATMOS_DYN_Tstep_large_type is invalid: ', tstep_large_type
       call prc_abort
    end select

    return
  end subroutine atmos_dyn_tstep_large_setup

end module scale_atmos_dyn_tstep_large