scale_atmos_dyn_tstep_large.F90

Go to the documentation of this file.

!-------------------------------------------------------------------------------
!-------------------------------------------------------------------------------
#include "inc_openmp.h"
module scale_atmos_dyn_tstep_large
  !-----------------------------------------------------------------------------
  !
  !++ 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_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,                           & ! (in)
          nd_coef, nd_coef_q, nd_order, nd_sfc_fact, nd_use_rs, &
          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_fct_momentum, flag_fct_t, flag_fct_tracer,       &
          flag_fct_along_stream,                                &
          use_average,                                          &
          dtl, dts, llast                                       )
       use scale_precision
       use scale_grid_index
       use scale_index
       use scale_tracer
       use scale_atmos_boundary, only: &
            bnd_qa
       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

       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_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

       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_grid_index
    use scale_index
    use scale_process, only: &
       prc_mpistop
    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
       write(*,*) 'xxx ATMOS_DYN_Tstep_large_type is invalid: ', tstep_large_type
       call prc_mpistop
    end select

    return
  end subroutine atmos_dyn_tstep_large_setup

end module scale_atmos_dyn_tstep_large