scale_atmos_phy_mp_sdm.F90

Go to the documentation of this file.

!-------------------------------------------------------------------------------
!-------------------------------------------------------------------------------
module scale_atmos_phy_mp_sdm
  !-----------------------------------------------------------------------------
  !
  !++ used modules
  !
  use scale_precision
  use scale_stdio
  use scale_prof
  use scale_grid_index
  use scale_atmos_hydrometeor, only: &
     n_hyd
  !-----------------------------------------------------------------------------
  implicit none
  private
  !-----------------------------------------------------------------------------
  !
  !++ Public procedure
  !
  public :: atmos_phy_mp_sdm_config
  public :: atmos_phy_mp_sdm_setup
  public :: atmos_phy_mp_sdm

  public :: atmos_phy_mp_sdm_cloudfraction
  public :: atmos_phy_mp_sdm_effectiveradius
  public :: atmos_phy_mp_sdm_mixingratio

  !-----------------------------------------------------------------------------
  !
  !++ Public parameters & variables
  !
  integer, parameter :: QA_MP  = 3

  character(len=H_SHORT), public, target :: atmos_phy_mp_sdm_name(qa_mp)
  character(len=H_MID),   public, target :: atmos_phy_mp_sdm_desc(qa_mp)
  character(len=H_SHORT), public, target :: atmos_phy_mp_sdm_unit(qa_mp)

  real(RP), public, target :: atmos_phy_mp_sdm_dens(n_hyd) ! hydrometeor density [kg/m3]=[g/L]

  data atmos_phy_mp_sdm_name / 'QV', 'QC', 'QR' /

  data atmos_phy_mp_sdm_desc / &
       'Ratio of Water Vapor mass to total mass (Specific humidity)',   &
       'cloud water mixing ratio', &
       'rain water mixing ratio'  /

  data atmos_phy_mp_sdm_unit / 'kg/kg', 'kg/kg', 'kg/kg' /

  !-----------------------------------------------------------------------------
  !
  !++ Private procedure
  !
  !-----------------------------------------------------------------------------
  !
  !++ Private parameters & variables
  !
  integer, private, parameter :: i_mp_qc =  1
  integer, private, parameter :: i_mp_qr =  2
  !-----------------------------------------------------------------------------
contains
  !-----------------------------------------------------------------------------
  !-----------------------------------------------------------------------------
  subroutine atmos_phy_mp_sdm_config( &
       MP_TYPE, &
       QA, QS   )
    use scale_process, only: &
       prc_mpistop
    implicit none

    character(len=*), intent(in)  :: mp_type
    integer,          intent(out) :: qa
    integer,          intent(out) :: qs
    !---------------------------------------------------------------------------

    write(*,*) '*** SDM not supported.'
    write(*,*) '*** Please contact SCALE developers'
    call prc_mpistop

    qa = 0
    qs = 0

    return
  end subroutine atmos_phy_mp_sdm_config

  !-----------------------------------------------------------------------------
  !-----------------------------------------------------------------------------
  subroutine atmos_phy_mp_sdm_setup
    use scale_process, only: &
       prc_mpistop
    use scale_const, only: &
       undef => const_undef
    implicit none
    !---------------------------------------------------------------------------

    write(*,*) '*** SDM not supported.'
    write(*,*) '*** Please contact SCALE developers'
    call prc_mpistop

    atmos_phy_mp_sdm_dens(:) = undef

    return
  end subroutine atmos_phy_mp_sdm_setup

  !-----------------------------------------------------------------------------
  !-----------------------------------------------------------------------------
  subroutine atmos_phy_mp_sdm( &
       DENS,      &
       MOMZ,      &
       MOMX,      &
       MOMY,      &
       RHOT,      &
       QTRC,      &
       CCN,       &
       EVAPORATE, &
       SFLX_rain, &
       SFLX_snow  )
    use scale_grid_index
    use scale_const, only: &
       undef => const_undef
    use scale_tracer, only: &
       qa
    use scale_process, only: &
       prc_mpistop
    implicit none

    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(in)    :: ccn (ka,ia,ja)
    real(RP), intent(out)   :: evaporate(ka,ia,ja)   !---- evaporated cloud number concentration [/m3]
    real(RP), intent(out)   :: sflx_rain(ia,ja)
    real(RP), intent(out)   :: sflx_snow(ia,ja)
    !---------------------------------------------------------------------------

    write(*,*) '*** SDM not supported.'
    write(*,*) '*** Please contact SCALE developers'
    call prc_mpistop

    evaporate = undef
    sflx_rain = undef
    sflx_snow = undef

    return
  end subroutine atmos_phy_mp_sdm

  !-----------------------------------------------------------------------------
  subroutine atmos_phy_mp_sdm_cloudfraction( &
       cldfrac,       &
       QTRC,          &
       mask_criterion )
    use scale_grid_index
    use scale_tracer, only: &
       qa
    implicit none

    real(RP), intent(out) :: cldfrac(ka,ia,ja)
    real(RP), intent(in)  :: qtrc   (ka,ia,ja,qa)
    real(RP), intent(in)  :: mask_criterion ! not used
    !---------------------------------------------------------------------------

    cldfrac(:,:,:) = 0.0_rp ! dummy

    return
  end subroutine atmos_phy_mp_sdm_cloudfraction

  !-----------------------------------------------------------------------------
  subroutine atmos_phy_mp_sdm_effectiveradius( &
       Re,    &
       QTRC0, &
       DENS0, &
       TEMP0  )
    use scale_grid_index
    use scale_tracer, only: &
       qa
    use scale_atmos_hydrometeor, only: &
       n_hyd
    implicit none

    real(RP), intent(out) :: re   (ka,ia,ja,n_hyd) ! effective radius
    real(RP), intent(in)  :: qtrc0(ka,ia,ja,qa)    ! tracer mass concentration [kg/kg]
    real(RP), intent(in)  :: dens0(ka,ia,ja)       ! Density [kg/m3]
    real(RP), intent(in)  :: temp0(ka,ia,ja)       ! Temperatuer [K]
    !---------------------------------------------------------------------------

    re(:,:,:,:) = 8.e-6_rp ! dummy

    return
  end subroutine atmos_phy_mp_sdm_effectiveradius
  !-----------------------------------------------------------------------------
  subroutine atmos_phy_mp_sdm_mixingratio( &
       Qe,   &
       QTRC0 )
    use scale_const, only: &
       eps => const_eps
    use scale_grid_index
    use scale_tracer, only: &
       qa
    use scale_atmos_hydrometeor, only: &
       n_hyd
    implicit none

    real(RP), intent(out) :: qe   (ka,ia,ja,n_hyd) ! mixing ratio of each cateory [kg/kg]
    real(RP), intent(in)  :: qtrc0(ka,ia,ja,qa)    ! tracer mass concentration [kg/kg]

    integer  :: ihydro
    !---------------------------------------------------------------------------

    qe(:,:,:,:) = 8.e-6_rp ! dummy

    return
  end subroutine atmos_phy_mp_sdm_mixingratio

end module scale_atmos_phy_mp_sdm