scale_atmos_phy_mp.F90

Go to the documentation of this file.

!-------------------------------------------------------------------------------
! Warning: This file was generated from atmos-physics/microphysics/scale_atmos_phy_mp.F90.erb.
!          Do not edit this file.
!-------------------------------------------------------------------------------
module scale_atmos_phy_mp
  !-----------------------------------------------------------------------------
  !
  !++ used modules
  !
  use scale_precision
  use scale_stdio
  use scale_prof
  use scale_grid_index
  use scale_tracer
  !-----------------------------------------------------------------------------
  implicit none
  private
  !-----------------------------------------------------------------------------
  !
  !++ Public procedure
  !
  public :: atmos_phy_mp_config

  abstract interface
     subroutine mp( &
          DENS,      &
          MOMZ,      &
          MOMX,      &
          MOMY,      &
          RHOT,      &
          QTRC,      &
          CCN,       &
          EVAPORATE, &
          SFLX_rain, &
          SFLX_snow  )
       use scale_precision
       use scale_grid_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(in)    :: CCN(KA,IA,JA)
       real(RP), intent(out)   :: EVAPORATE(KA,IA,JA)
       real(RP), intent(out)   :: SFLX_rain(IA,JA)
       real(RP), intent(out)   :: SFLX_snow(IA,JA)
     end subroutine mp
     subroutine su
     end subroutine su
     subroutine cf( &
          cldfrac,       &
          QTRC,          &
          mask_criterion )
       use scale_precision
       use scale_grid_index
       use scale_tracer
       real(RP), intent(out) :: cldfrac(KA,IA,JA)
       real(RP), intent(in)  :: QTRC   (KA,IA,JA,QA)
       real(RP), intent(in)  :: mask_criterion
     end subroutine cf
     subroutine er( &
          Re,    &
          QTRC0, &
          DENS0, &
          TEMP0  )
       use scale_precision
       use scale_grid_index
       use scale_tracer
       use scale_atmos_hydrometeor, only: n_hyd
       real(RP), intent(out) :: Re   (KA,IA,JA,N_HYD) ! effective radius          [cm]
       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)       ! temperature               [K]
     end subroutine er
     subroutine mr( &
          Qe,   &
          QTRC0 )
       use scale_precision
       use scale_grid_index
       use scale_tracer
       use scale_atmos_hydrometeor, only: n_hyd
       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]
     end subroutine mr
  end interface
  procedure(mp), pointer :: atmos_phy_mp => null()
  procedure(su), pointer :: atmos_phy_mp_setup => null()
  procedure(cf), pointer :: atmos_phy_mp_cloudfraction => null()
  procedure(er), pointer :: atmos_phy_mp_effectiveradius => null()
  procedure(mr), pointer :: atmos_phy_mp_mixingratio => null()
  public :: atmos_phy_mp
  public :: atmos_phy_mp_setup
  public :: atmos_phy_mp_cloudfraction
  public :: atmos_phy_mp_effectiveradius
  public :: atmos_phy_mp_mixingratio
  !-----------------------------------------------------------------------------
  !
  !++ Public parameters & variables
  !
  integer, public    :: qa_mp =  0 ! number of cloud microphysical tracers
  integer, public    :: qs_mp = -1 ! start index in QTRC
  integer, public    :: qe_mp = -1 ! end   index in QTRC

  character(len=H_SHORT), pointer, public :: atmos_phy_mp_name(:)
  character(len=H_MID),   pointer, public :: atmos_phy_mp_desc(:)
  character(len=H_SHORT), pointer, public :: atmos_phy_mp_unit(:)
  real(RP), pointer, public :: atmos_phy_mp_dens(:)
  !-----------------------------------------------------------------------------
  !
  !++ Private procedure
  !
  !-----------------------------------------------------------------------------
  !
  !++ Private parameters & variables
  !
  !-----------------------------------------------------------------------------
contains
  !-----------------------------------------------------------------------------
  !-----------------------------------------------------------------------------
  subroutine atmos_phy_mp_config( MP_TYPE )
    use scale_process, only: &
       prc_mpistop
    use scale_atmos_phy_mp_dry, only: &
       atmos_phy_mp_dry_config, &
       atmos_phy_mp_dry_setup, &
       atmos_phy_mp_dry, &
       atmos_phy_mp_dry_cloudfraction, &
       atmos_phy_mp_dry_effectiveradius, &
       atmos_phy_mp_dry_mixingratio, &
       atmos_phy_mp_dry_name, &
       atmos_phy_mp_dry_desc, &
       atmos_phy_mp_dry_unit, &
       atmos_phy_mp_dry_dens
    use scale_atmos_phy_mp_kessler, only: &
       atmos_phy_mp_kessler_config, &
       atmos_phy_mp_kessler_setup, &
       atmos_phy_mp_kessler, &
       atmos_phy_mp_kessler_cloudfraction, &
       atmos_phy_mp_kessler_effectiveradius, &
       atmos_phy_mp_kessler_mixingratio, &
       atmos_phy_mp_kessler_name, &
       atmos_phy_mp_kessler_desc, &
       atmos_phy_mp_kessler_unit, &
       atmos_phy_mp_kessler_dens
    use scale_atmos_phy_mp_tomita08, only: &
       atmos_phy_mp_tomita08_config, &
       atmos_phy_mp_tomita08_setup, &
       atmos_phy_mp_tomita08, &
       atmos_phy_mp_tomita08_cloudfraction, &
       atmos_phy_mp_tomita08_effectiveradius, &
       atmos_phy_mp_tomita08_mixingratio, &
       atmos_phy_mp_tomita08_name, &
       atmos_phy_mp_tomita08_desc, &
       atmos_phy_mp_tomita08_unit, &
       atmos_phy_mp_tomita08_dens
    use scale_atmos_phy_mp_sn14, only: &
       atmos_phy_mp_sn14_config, &
       atmos_phy_mp_sn14_setup, &
       atmos_phy_mp_sn14, &
       atmos_phy_mp_sn14_cloudfraction, &
       atmos_phy_mp_sn14_effectiveradius, &
       atmos_phy_mp_sn14_mixingratio, &
       atmos_phy_mp_sn14_name, &
       atmos_phy_mp_sn14_desc, &
       atmos_phy_mp_sn14_unit, &
       atmos_phy_mp_sn14_dens
    use scale_atmos_phy_mp_suzuki10, only: &
       atmos_phy_mp_suzuki10_config, &
       atmos_phy_mp_suzuki10_setup, &
       atmos_phy_mp_suzuki10, &
       atmos_phy_mp_suzuki10_cloudfraction, &
       atmos_phy_mp_suzuki10_effectiveradius, &
       atmos_phy_mp_suzuki10_mixingratio, &
       atmos_phy_mp_suzuki10_name, &
       atmos_phy_mp_suzuki10_desc, &
       atmos_phy_mp_suzuki10_unit, &
       atmos_phy_mp_suzuki10_dens
    use scale_atmos_phy_mp_sdm, only: &
       atmos_phy_mp_sdm_config, &
       atmos_phy_mp_sdm_setup, &
       atmos_phy_mp_sdm, &
       atmos_phy_mp_sdm_cloudfraction, &
       atmos_phy_mp_sdm_effectiveradius, &
       atmos_phy_mp_sdm_mixingratio, &
       atmos_phy_mp_sdm_name, &
       atmos_phy_mp_sdm_desc, &
       atmos_phy_mp_sdm_unit, &
       atmos_phy_mp_sdm_dens
    implicit none

    character(len=*), intent(in) :: mp_type
    !---------------------------------------------------------------------------

    if( io_l ) write(io_fid_log,*) '*** => ', trim(mp_type), ' is selected.'

    select case( mp_type )
    case( 'DRY' )
       call atmos_phy_mp_dry_config( &
            mp_type,     & ! (in)
            qa_mp, qs_mp ) ! (out)
       atmos_phy_mp                 => atmos_phy_mp_dry
       atmos_phy_mp_setup           => atmos_phy_mp_dry_setup
       atmos_phy_mp_cloudfraction   => atmos_phy_mp_dry_cloudfraction
       atmos_phy_mp_effectiveradius => atmos_phy_mp_dry_effectiveradius
       atmos_phy_mp_mixingratio     => atmos_phy_mp_dry_mixingratio
       atmos_phy_mp_name            => atmos_phy_mp_dry_name
       atmos_phy_mp_desc            => atmos_phy_mp_dry_desc
       atmos_phy_mp_unit            => atmos_phy_mp_dry_unit
       atmos_phy_mp_dens            => atmos_phy_mp_dry_dens
    case( 'KESSLER' )
       call atmos_phy_mp_kessler_config( &
            mp_type,     & ! (in)
            qa_mp, qs_mp ) ! (out)
       atmos_phy_mp                 => atmos_phy_mp_kessler
       atmos_phy_mp_setup           => atmos_phy_mp_kessler_setup
       atmos_phy_mp_cloudfraction   => atmos_phy_mp_kessler_cloudfraction
       atmos_phy_mp_effectiveradius => atmos_phy_mp_kessler_effectiveradius
       atmos_phy_mp_mixingratio     => atmos_phy_mp_kessler_mixingratio
       atmos_phy_mp_name            => atmos_phy_mp_kessler_name
       atmos_phy_mp_desc            => atmos_phy_mp_kessler_desc
       atmos_phy_mp_unit            => atmos_phy_mp_kessler_unit
       atmos_phy_mp_dens            => atmos_phy_mp_kessler_dens
    case( 'TOMITA08' )
       call atmos_phy_mp_tomita08_config( &
            mp_type,     & ! (in)
            qa_mp, qs_mp ) ! (out)
       atmos_phy_mp                 => atmos_phy_mp_tomita08
       atmos_phy_mp_setup           => atmos_phy_mp_tomita08_setup
       atmos_phy_mp_cloudfraction   => atmos_phy_mp_tomita08_cloudfraction
       atmos_phy_mp_effectiveradius => atmos_phy_mp_tomita08_effectiveradius
       atmos_phy_mp_mixingratio     => atmos_phy_mp_tomita08_mixingratio
       atmos_phy_mp_name            => atmos_phy_mp_tomita08_name
       atmos_phy_mp_desc            => atmos_phy_mp_tomita08_desc
       atmos_phy_mp_unit            => atmos_phy_mp_tomita08_unit
       atmos_phy_mp_dens            => atmos_phy_mp_tomita08_dens
    case( 'SN14' )
       call atmos_phy_mp_sn14_config( &
            mp_type,     & ! (in)
            qa_mp, qs_mp ) ! (out)
       atmos_phy_mp                 => atmos_phy_mp_sn14
       atmos_phy_mp_setup           => atmos_phy_mp_sn14_setup
       atmos_phy_mp_cloudfraction   => atmos_phy_mp_sn14_cloudfraction
       atmos_phy_mp_effectiveradius => atmos_phy_mp_sn14_effectiveradius
       atmos_phy_mp_mixingratio     => atmos_phy_mp_sn14_mixingratio
       atmos_phy_mp_name            => atmos_phy_mp_sn14_name
       atmos_phy_mp_desc            => atmos_phy_mp_sn14_desc
       atmos_phy_mp_unit            => atmos_phy_mp_sn14_unit
       atmos_phy_mp_dens            => atmos_phy_mp_sn14_dens
    case( 'SUZUKI10' )
       call atmos_phy_mp_suzuki10_config( &
            mp_type,     & ! (in)
            qa_mp, qs_mp ) ! (out)
       atmos_phy_mp                 => atmos_phy_mp_suzuki10
       atmos_phy_mp_setup           => atmos_phy_mp_suzuki10_setup
       atmos_phy_mp_cloudfraction   => atmos_phy_mp_suzuki10_cloudfraction
       atmos_phy_mp_effectiveradius => atmos_phy_mp_suzuki10_effectiveradius
       atmos_phy_mp_mixingratio     => atmos_phy_mp_suzuki10_mixingratio
       atmos_phy_mp_name            => atmos_phy_mp_suzuki10_name
       atmos_phy_mp_desc            => atmos_phy_mp_suzuki10_desc
       atmos_phy_mp_unit            => atmos_phy_mp_suzuki10_unit
       atmos_phy_mp_dens            => atmos_phy_mp_suzuki10_dens
    case( 'SDM' )
       call atmos_phy_mp_sdm_config( &
            mp_type,     & ! (in)
            qa_mp, qs_mp ) ! (out)
       atmos_phy_mp                 => atmos_phy_mp_sdm
       atmos_phy_mp_setup           => atmos_phy_mp_sdm_setup
       atmos_phy_mp_cloudfraction   => atmos_phy_mp_sdm_cloudfraction
       atmos_phy_mp_effectiveradius => atmos_phy_mp_sdm_effectiveradius
       atmos_phy_mp_mixingratio     => atmos_phy_mp_sdm_mixingratio
       atmos_phy_mp_name            => atmos_phy_mp_sdm_name
       atmos_phy_mp_desc            => atmos_phy_mp_sdm_desc
       atmos_phy_mp_unit            => atmos_phy_mp_sdm_unit
       atmos_phy_mp_dens            => atmos_phy_mp_sdm_dens
    end select

    qe_mp = qs_mp + qa_mp - 1

    return
  end subroutine atmos_phy_mp_config

end module scale_atmos_phy_mp