wrapper of RRTMG

Note that Japanese and English are described in parallel.

This is a wrapper program of radiation model, RRTMG.

Methods

CH4MolWeight CO2MolWeight CloudIceREff CloudWatREff H2OMolWeight IDCloudIceREffMethod IDCloudIceREffMethodConst IDCloudIceREffMethodLin MeanMolWeight N2OMolWeight RadRRTMGWrapperFlux RadRRTMGWrapperFluxCore RadRRTMGWrapperInit module_name rad_rrtmg_wrapper_inited version xyz_QO3

Included Modules

dc_types dc_message constants gridset gtool_historyauto timeset set_gcmr set_o3 parrrtm rrtmg_lw_rad parrrsw rrtmg_sw_rad set_solarconst rad_short_income dc_iounit namelist_util rrtmg_lw_init rrtmg_sw_init axesset

Public Instance methods

RadRRTMGWrapperFlux( xy_SurfAlbedo, xyz_Press, xyr_Press, xyz_Temp, xyr_Temp, xyz_QH2OVap, xyz_QH2OLiq, xyz_QH2OSol, xyz_CloudCover, xy_SurfTemp, xyr_RadSUwFlux, xyr_RadSDwFlux, xyr_RadLUwFlux, xyr_RadLDwFlux, xyra_DelRadLUwFlux, xyra_DelRadLDwFlux )

Subroutine :

xy_SurfAlbedo(0:imax-1, 1:jmax) : real(DP), intent(in )

xyz_Press(0:imax-1, 1:jmax, 1:kmax) : real(DP), intent(in )

xyr_Press(0:imax-1, 1:jmax, 0:kmax) : real(DP), intent(in )

xyz_Temp(0:imax-1, 1:jmax, 1:kmax) : real(DP), intent(in )

xyr_Temp(0:imax-1, 1:jmax, 0:kmax) : real(DP), intent(in )

xyz_QH2OVap(0:imax-1, 1:jmax, 1:kmax) :

real(DP), intent(in )

:	$ q $ . 混合比. Mass mixing ratio of constituents (1)

xyz_QH2OLiq(0:imax-1, 1:jmax, 1:kmax) : real(DP), intent(in )

xyz_QH2OSol(0:imax-1, 1:jmax, 1:kmax) : real(DP), intent(in )

xyz_CloudCover(0:imax-1, 1:jmax, 1:kmax) : real(DP), intent(in )

xy_SurfTemp(0:imax-1, 1:jmax) : real(DP), intent(in )

xyr_RadSUwFlux(0:imax-1, 1:jmax, 0:kmax) : real(DP), intent(out)

xyr_RadSDwFlux(0:imax-1, 1:jmax, 0:kmax) : real(DP), intent(out)

xyr_RadLUwFlux(0:imax-1, 1:jmax, 0:kmax) : real(DP), intent(out)

xyr_RadLDwFlux(0:imax-1, 1:jmax, 0:kmax) : real(DP), intent(out)

xyra_DelRadLUwFlux(0:imax-1, 1:jmax, 0:kmax, 0:1) : real(DP), intent(out)

xyra_DelRadLDwFlux(0:imax-1, 1:jmax, 0:kmax, 0:1) : real(DP), intent(out)

[Source]

  subroutine RadRRTMGWrapperFlux( xy_SurfAlbedo, xyz_Press, xyr_Press, xyz_Temp, xyr_Temp, xyz_QH2OVap, xyz_QH2OLiq, xyz_QH2OSol, xyz_CloudCover, xy_SurfTemp, xyr_RadSUwFlux, xyr_RadSDwFlux, xyr_RadLUwFlux, xyr_RadLDwFlux, xyra_DelRadLUwFlux, xyra_DelRadLDwFlux )


    ! USE statements
    !

    real(DP), intent(in ) :: xy_SurfAlbedo   (0:imax-1, 1:jmax)
    real(DP), intent(in ) :: xyz_Press       (0:imax-1, 1:jmax, 1:kmax)
    real(DP), intent(in ) :: xyr_Press       (0:imax-1, 1:jmax, 0:kmax)
    real(DP), intent(in ) :: xyz_Temp        (0:imax-1, 1:jmax, 1:kmax)
    real(DP), intent(in ) :: xyr_Temp        (0:imax-1, 1:jmax, 0:kmax)
    real(DP), intent(in ) :: xyz_QH2OVap     (0:imax-1, 1:jmax, 1:kmax)
                              ! $ q $ .   混合比. Mass mixing ratio of constituents (1)
    real(DP), intent(in ) :: xyz_QH2OLiq     (0:imax-1, 1:jmax, 1:kmax)
    real(DP), intent(in ) :: xyz_QH2OSol     (0:imax-1, 1:jmax, 1:kmax)
    real(DP), intent(in ) :: xyz_CloudCover  (0:imax-1, 1:jmax, 1:kmax)
    real(DP), intent(in ) :: xy_SurfTemp     (0:imax-1, 1:jmax)
    real(DP), intent(out) :: xyr_RadSUwFlux   (0:imax-1, 1:jmax, 0:kmax)
    real(DP), intent(out) :: xyr_RadSDwFlux   (0:imax-1, 1:jmax, 0:kmax)
    real(DP), intent(out) :: xyr_RadLUwFlux    (0:imax-1, 1:jmax, 0:kmax)
    real(DP), intent(out) :: xyr_RadLDwFlux    (0:imax-1, 1:jmax, 0:kmax)
    real(DP), intent(out) :: xyra_DelRadLUwFlux(0:imax-1, 1:jmax, 0:kmax, 0:1)
    real(DP), intent(out) :: xyra_DelRadLDwFlux(0:imax-1, 1:jmax, 0:kmax, 0:1)

!!$    real(DP):: xyr_RadLUwFlux    (0:imax-1, 1:jmax, 0:kmax)
!!$    real(DP):: xyr_RadLDwFlux    (0:imax-1, 1:jmax, 0:kmax)
!!$    real(DP):: xyra_DelRadLUwFlux(0:imax-1, 1:jmax, 0:kmax, 0:1)
!!$    real(DP):: xyra_DelRadLDwFlux(0:imax-1, 1:jmax, 0:kmax, 0:1)


    ! Work variables
    !
    real(DP) :: xyz_DelAtmMass   (0:imax-1, 1:jmax, 1:kmax)

    integer  :: k


    ! 初期化確認
    ! Initialization check
    !
    if ( .not. rad_rrtmg_wrapper_inited ) then
      call MessageNotify( 'E', module_name, 'This module has not been initialized.' )
    end if

#ifndef RRTMG
    call MessageNotify( 'E', module_name, 'RRTMG modules are not included in compilation.' )
#endif

    do k = 1, kmax
      xyz_DelAtmMass(:,:,k) = ( xyr_Press(:,:,k-1) - xyr_Press(:,:,k ) ) / Grav
    end do

    call RadRRTMGWrapperFluxCore( xy_SurfAlbedo, xyz_DelAtmMass, xyz_Press, xyr_Press, xyz_Temp, xyr_Temp, xyz_QH2OVap, xyz_QH2OLiq, xyz_QH2OSol, xyz_CloudCover, xy_SurfTemp, xyr_RadSUwFlux, xyr_RadSDwFlux, xyr_RadLUwFlux, xyr_RadLDwFlux, xyra_DelRadLUwFlux, xyra_DelRadLDwFlux )


  end subroutine RadRRTMGWrapperFlux

RadRRTMGWrapperInit( FlagSnow )

*Subroutine* :
`FlagSnow` :	`logical, intent(in)`

This procedure input/output NAMELIST#rad_rrtmg_wrapper_nml .

[Source]

  subroutine RadRRTMGWrapperInit( FlagSnow )

    ! ファイル入出力補助
    ! File I/O support
    !
    use dc_iounit, only: FileOpen

    ! ヒストリデータ出力
    ! History data output
    !
    use gtool_historyauto, only: HistoryAutoAddVariable

    ! NAMELIST ファイル入力に関するユーティリティ
    ! Utilities for NAMELIST file input
    !
    use namelist_util, only: namelist_filename, NmlutilMsg, NmlutilAryValid

    ! 全球一定体積混合比の設定
    ! Set globally constant volume mixing ratio
    !
    use set_gcmr, only : SetGCMRInit

    ! O3 分布の設定
    ! Set O3 distribution
    !
    use set_o3, only : SetO3Init

    !
    ! Physical constants settings
    !
    use constants, only: CpDry
                            ! $ C_p $ [J kg-1 K-1].
                            ! 乾燥大気の定圧比熱.
                            ! Specific heat of air at constant pressure

!!$    ! 地球大気向け短波放射モデル Ver. 2.6
!!$    ! short wave radiation model for the Earth's atmosphere Ver. 2.6
!!$    !
!!$    use rad_Earth_SW_V2_6, only: RadEarthSWV26Init
!!$
!!$    ! 地球大気向け長波放射モデル Ver. 2.4
!!$    ! long wave radiation model for the Earth's atmosphere Ver. 2.4
!!$    !
!!$    use rad_Earth_LW_V2_4, only : RadEarthLWV24Init

#ifdef RRTMG
    ! RRTMG LW initialization
    ! RRTMG LW initialization
    !
    use rrtmg_lw_init, only: rrtmg_lw_ini

    ! RRTMG SW initialization
    ! RRTMG SW initialization
    !
    use rrtmg_sw_init, only: rrtmg_sw_ini
#endif

    ! 太陽放射フラックスの設定
    ! Set solar constant
    !
    use set_solarconst, only : SetSolarConstInit

    ! 短波入射 (太陽入射)
    ! Short wave (insolation) incoming
    !
    use rad_short_income, only : RadShortIncomeInit

    ! 座標データ設定
    ! Axes data settings
    !
    use axesset, only : AxnameX, AxnameY, AxnameZ, AxnameR, AxnameT

    ! 宣言文 ; Declaration statements
    !

    logical, intent(in) :: FlagSnow

    character(STRING)   :: CloudIceREffMethod

    integer:: unit_nml        ! NAMELIST ファイルオープン用装置番号.
                              ! Unit number for NAMELIST file open
    integer:: iostat_nml      ! NAMELIST 読み込み時の IOSTAT.
                              ! IOSTAT of NAMELIST read

    ! NAMELIST 変数群
    ! NAMELIST group name
    !
    namelist /rad_rrtmg_wrapper_nml/ CloudIceREffMethod, CloudWatREff, CloudIceREff

!!$      & SWVer, LWVer
          !
          ! デフォルト値については初期化手続 "rad_rrtmg_wrapper#RadEarthV2Init"
          ! のソースコードを参照のこと.
          !
          ! Refer to source codes in the initialization procedure
          ! "rad_rrtmg_wrapper#RadEarthV2Init" for the default values.
          !

    if ( rad_rrtmg_wrapper_inited ) return


    ! Molecular weights of atmosphere, CO2, H2O, N2O, CH4
    !
    MeanMolWeight = 28.0d-3
    CO2MolWeight  = 44.0d-3
    H2OMolWeight  = 18.0d-3
    N2OMolWeight  = 44.0d-3
    CH4MolWeight  = 16.0d-3


    ! デフォルト値の設定
    ! Default values settings
    !
    CloudIceREffMethod = 'Const'
!!$    CloudIceREffMethod = 'Lin'

    CloudWatREff    = 10.0d-6
    CloudIceREff    = 50.0d-6


!!$    SWVer = 1
!!$    LWVer = 3


    ! NAMELIST の読み込み
    ! NAMELIST is input
    !
    if ( trim(namelist_filename) /= '' ) then
      call FileOpen( unit_nml, namelist_filename, mode = 'r' ) ! (in)

      rewind( unit_nml )
      read( unit_nml, nml = rad_rrtmg_wrapper_nml, iostat = iostat_nml )             ! (out)
      close( unit_nml )

      call NmlutilMsg( iostat_nml, module_name ) ! (in)
    end if


    ! Identification of calculation method of cloud particle effective radius
    !
    call MessageNotify( 'M', module_name, 'CloudIceREffMethod=<%c>.', c1 = trim(CloudIceREffMethod) )
    !
    select case ( CloudIceREffMethod )
    case ( 'Const' )
      IDCloudIceREffMethod = IDCloudIceREffMethodConst
    case ( 'Lin' )
      IDCloudIceREffMethod = IDCloudIceREffMethodLin
    case default
      call MessageNotify( 'E', module_name, 'CloudIceREffMethod=<%c> is not supported.', c1 = trim(CloudIceREffMethod) )
    end select


    ! Allocate a local variable for O3 distribution
    !
    allocate( xyz_QO3(0:imax-1, 1:jmax, 1:kmax) )


    ! Initialization of modules used in this module
    !

    ! 全球一定体積混合比の設定
    ! Set globally constant volume mixing ratio
    !
    call SetGCMRInit

    ! O3 分布の設定
    ! Set O3 distribution
    !
    call SetO3Init


!!$    ! 地球大気向け短波放射モデル Ver. 2.6
!!$    ! short wave radiation model for the Earth's atmosphere Ver. 2.6
!!$    !
!!$    call RadEarthSWV26Init( &
!!$      & FlagSnow &
!!$      & )
!!$
!!$    ! 地球大気向け長波放射モデル Ver. 2.4
!!$    ! long wave radiation model for the Earth's atmosphere Ver. 2.4
!!$    !
!!$    call RadEarthLWV24Init( &
!!$      & FlagSnow            &
!!$      & )


#ifdef RRTMG
    ! RRTMG LW initialization
    ! RRTMG LW initialization
    !
    call rrtmg_lw_ini( CpDry )

    ! RRTMG SW initialization
    ! RRTMG SW initialization
    !
    call rrtmg_sw_ini( CpDry )
#endif

    ! 太陽放射フラックスの設定
    ! Set solar constant
    !
    call SetSolarConstInit

    ! 短波入射 (太陽入射)
    ! Short wave (insolation) incoming
    !
    call RadShortIncomeInit


    ! ヒストリデータ出力のためのへの変数登録
    ! Register of variables for history data output
    !
    call HistoryAutoAddVariable( 'CloudCoverforRad', (/ AxnameX, AxnameY, AxnameZ, AxnameT /), 'cloud cover', '1' )
    call HistoryAutoAddVariable( 'CloudCoverRand', (/ AxnameX, AxnameY, AxnameT /), 'cloud cover', '1' )

    call HistoryAutoAddVariable( 'RadCSLUWFLXB', (/ AxnameX, AxnameY, AxnameR, AxnameT /), 'clear sky upward longwave flux', 'W m-2' )
    call HistoryAutoAddVariable( 'RadCSLDWFLXB', (/ AxnameX, AxnameY, AxnameR, AxnameT /), 'clear sky downward longwave flux', 'W m-2' )
    call HistoryAutoAddVariable( 'RadCSSUWFLXB', (/ AxnameX, AxnameY, AxnameR, AxnameT /), 'clear sky upward shortwave flux', 'W m-2' )
    call HistoryAutoAddVariable( 'RadCSSDWFLXB', (/ AxnameX, AxnameY, AxnameR, AxnameT /), 'clear sky downward shortwave flux', 'W m-2' )

    ! 印字 ; Print
    !
    call MessageNotify( 'M', module_name, '----- Initialization Messages -----' )
    call MessageNotify( 'M', module_name, '  CloudWatREff      = %f', d = (/ CloudWatREff /) )
    call MessageNotify( 'M', module_name, '  CloudIceREff      = %f', d = (/ CloudIceREff /) )
!!$    call MessageNotify( 'M', module_name, 'SWVer = %d', i = (/ SWVer /) )
!!$    call MessageNotify( 'M', module_name, 'LWVer = %d', i = (/ LWVer /) )
    call MessageNotify( 'M', module_name, '-- version = %c', c1 = trim(version) )


    rad_rrtmg_wrapper_inited = .true.

  end subroutine RadRRTMGWrapperInit

Private Instance methods

CH4MolWeight

*Variable* :
`CH4MolWeight` :	`real(DP), save`

CO2MolWeight

*Variable* :
`CO2MolWeight` :	`real(DP), save`

CloudIceREff

*Variable* :
`CloudIceREff` :	`real(DP), save`

CloudWatREff

*Variable* :
`CloudWatREff` :	`real(DP), save`

H2OMolWeight

*Variable* :
`H2OMolWeight` :	`real(DP), save`

IDCloudIceREffMethod

*Variable* :
`IDCloudIceREffMethod` :	`integer, save`

IDCloudIceREffMethodConst

*Constant* :
`IDCloudIceREffMethodConst` `= 0` :	`integer, parameter`

IDCloudIceREffMethodLin

*Constant* :
`IDCloudIceREffMethodLin` `= 1` :	`integer, parameter`

MeanMolWeight

*Variable* :
`MeanMolWeight` :	`real(DP), save`

N2OMolWeight

*Variable* :
`N2OMolWeight` :	`real(DP), save`

RadRRTMGWrapperFluxCore( xy_SurfAlbedo, xyz_DelAtmMass, xyz_Press, xyr_Press, xyz_Temp, xyr_Temp, xyz_QH2OVap, xyz_QH2OLiq, xyz_QH2OSol, xyz_CloudCover, xy_SurfTemp, xyr_RadSUwFlux, xyr_RadSDwFlux, xyr_RadLUwFlux, xyr_RadLDwFlux, xyra_DelRadLUwFlux, xyra_DelRadLDwFlux )