mod_atmos_component Module Reference

module Atmosphere component More...

Data Types
type	atmoscomponent
	Derived type to manage atmospheric component. More...

Functions/Subroutines
subroutine	atmos_setup (this)
	Setup an object to mange atmospheric component.

Detailed Description

module Atmosphere component

Description

Atmosphere component module

Author

Yuta Kawai, Team SCALE

NAMELIST

• PARAM_ATMOS

  name	type	default value	comment
  ACTIVATE_FLAG	logical	.true.	Flag whether atmospheric component is activated
  TIME_DT	real(DP)	UNDEF8	Timestep value of atmospheric component
  TIME_DT_UNIT	character(len=H_SHORT)	'SEC'	Timestep unit of atmospheric component
  TIME_DT_RESTART	real(DP)	UNDEF8	Timestep value when outputting restart file for atmospheric component
  TIME_DT_RESTART_UNIT	character(len=H_SHORT)	'SEC'	Timestep unit when outputting restart file for atmospheric component
  ATMOS_MESH_TYPE	character(len=H_SHORT)	'REGIONAL' !< Name of mesh type for atmospheric component ('REGIONAL' or 'GLOBAL')
  ATMOS_DYN_DO	logical	.true.	Flag whether dynamics process is considered
  ATMOS_PHY_SF_DO	logical	.false.	Flag whether surface process is considered
  ATMOS_PHY_TB_DO	logical	.false.	Flag whether SGS turbulent process is considered
  ATMOS_PHY_MP_DO	logical	.false.	Flag whether cloud microphysics process is considered
  ATMOS_USE_QV	logical	.false.	Flag whether QV is used although cloud microphysics is not considered

  
  

History Output

No history output

Function/Subroutine Documentation

atmos_setup()

subroutine mod_atmos_component::atmos_setup

(

class(atmoscomponent), intent(inout), target

this

)

Setup an object to mange atmospheric component.

Definition at line 91 of file mod_atmos_component.F90.

    use scale_const, only: &
      undef8 => const_undef8
    
    use scale_atmos_hydrometeor, only: &
      atmos_hydrometeor_dry,   &
      atmos_hydrometeor_regist    
    use scale_atmos_thermodyn, only: &
      atmos_thermodyn_setup
    use scale_atmos_saturation, only: &
      atmos_saturation_setup
 
    use scale_file_history_meshfield, only: &
      file_history_meshfield_setup  
    use scale_time_manager, only: &
      time_manager_regist_component
 
    implicit none
    
    class(AtmosComponent), intent(inout), target :: this
 
    logical :: ACTIVATE_FLAG = .true. !< Flag whether atmospheric component is activated
 
    real(DP) :: TIME_DT                             = undef8  !< Timestep value of atmospheric component
    character(len=H_SHORT) :: TIME_DT_UNIT          = 'SEC'   !< Timestep unit of atmospheric component
    real(DP) :: TIME_DT_RESTART                     = undef8  !< Timestep value when outputting restart file for atmospheric component
    character(len=H_SHORT) :: TIME_DT_RESTART_UNIT  = 'SEC'   !< Timestep unit when outputting restart file for atmospheric component
 
    logical :: ATMOS_DYN_DO    = .true.  !< Flag whether dynamics process is considered
    logical :: ATMOS_PHY_SF_DO = .false. !< Flag whether surface process is considered
    logical :: ATMOS_PHY_TB_DO = .false. !< Flag whether SGS turbulent process is considered
    logical :: ATMOS_PHY_MP_DO = .false. !< Flag whether cloud microphysics process is considered
    character(len=H_SHORT) :: ATMOS_MESH_TYPE = 'REGIONAL'  !< Name of mesh type for atmospheric component ('REGIONAL' or 'GLOBAL')
 
    logical :: ATMOS_USE_QV    = .false. !< Flag whether QV is used although cloud microphysics is not considered
 
 
    namelist / param_atmos / &
      activate_flag,         &
      time_dt,               &
      time_dt_unit,          &
      time_dt_restart,       &
      time_dt_restart_unit,  &
      atmos_mesh_type,       &
      atmos_dyn_do,          &
      atmos_phy_sf_do,       &
      atmos_phy_tb_do,       &
      atmos_phy_mp_do,       &    
      atmos_use_qv
    
    integer :: ierr
    !--------------------------------------------------
    call prof_rapstart( 'ATM_setup', 1)
    log_info('AtmosComponent_setup',*) 'Atmosphere model components '
    
    !--- read namelist
    rewind(io_fid_conf)
    read(io_fid_conf,nml=param_atmos,iostat=ierr)
    if( ierr < 0 ) then !--- missing
      log_info("ATMOS_setup",*) 'Not found namelist. Default used.'
    elseif( ierr > 0 ) then !--- fatal error
      log_error("ATM_setup",*) 'Not appropriate names in namelist PARAM_ATMOS. Check!'
      call prc_abort
    endif
    log_nml(param_atmos)
 
    !************************************************
    call this%ModelComponent_Init('ATMOS', activate_flag )
    if ( .not. activate_flag ) return
 
    !- Setup time manager
 
    call this%time_manager%Init( this%GetComponentName(), &
      time_dt, time_dt_unit,                              &
      time_dt_restart, time_dt_restart_unit               ) 
    
    call time_manager_regist_component( this%time_manager )
    
    !- Setup mesh & file I/O for atmospheric component
 
    this%mesh_type = atmos_mesh_type
    select case( this%mesh_type )
    case('REGIONAL')
      call this%mesh_rm%Init()
      call file_history_meshfield_setup( mesh3d_=this%mesh_rm%mesh )
      this%mesh => this%mesh_rm
    case('GLOBAL')
      call this%mesh_gm%Init()
      call file_history_meshfield_setup( meshcubedsphere3d_=this%mesh_gm%mesh )
      this%mesh => this%mesh_gm
    case default
      log_error("ATM_setup",*) 'Unsupported type of mesh is specified. Check!', this%mesh_type
      call prc_abort    
    end select
    
    !- setup common tools for atmospheric model
 
    call atmos_thermodyn_setup
    call atmos_saturation_setup
 
    !- Setup each processes in atmospheric model ------------------------------------
 
    !- Setup the module for atmosphere / physics / surface
    call this%phy_sfc_proc%ModelComponentProc_Init( 'AtmosPhysSfc', atmos_phy_sf_do )
    call this%phy_sfc_proc%setup( this%mesh, this%time_manager )
    
    !- Setup the module for atmosphere / physics / cloud microphysics
    call this%phy_mp_proc%ModelComponentProc_Init( 'AtmosPhysMp', atmos_phy_mp_do )
    call this%phy_mp_proc%setup( this%mesh, this%time_manager )
 
    !-- Regist qv if needed
    if ( atmos_hydrometeor_dry .and. atmos_use_qv ) then
      log_info("ATMOS_setup",*) "Regist QV"
      call atmos_hydrometeor_regist( 0, 0,                                 & ! (in)
        (/'QV'/),                                                          & ! (in)
        (/'Ratio of Water Vapor mass to total mass (Specific humidity)'/), & ! (in)
        (/'kg/kg'/),                                                       & ! (in)
        this%phy_mp_proc%vars%QS                                           ) ! (out)
      
      this%phy_mp_proc%vars%QA = 1
      this%phy_mp_proc%vars%QE = this%phy_mp_proc%vars%QS    
    end if
 
    !- Setup the module for atmosphere / dynamics 
    call this%dyn_proc%ModelComponentProc_Init( 'AtmosDyn', atmos_dyn_do )
    call this%dyn_proc%setup( this%mesh, this%time_manager )
 
    !- Setup the module for atmosphere / physics / turbulence
    call this%phy_tb_proc%ModelComponentProc_Init( 'AtmosPhysTb', atmos_phy_tb_do )
    call this%phy_tb_proc%setup( this%mesh, this%time_manager )
    call this%phy_tb_proc%SetDynBC( this%dyn_proc%dyncore_driver%boundary_cond )
 
    log_newline
    log_info('AtmosComponent_setup',*) 'Finish setup of each atmospheric components.'
 
    call prof_rapend( 'ATM_setup', 1)
 
    return

References mod_atmos_phy_mp_vars::atmosphympvars_getlocalmeshfields_sfcflx(), mod_atmos_vars::atmosvars_getlocalmeshphytends(), mod_atmos_vars::atmosvars_getlocalmeshsfcvar(), scale_file_history_meshfield::file_history_meshfield_setup(), scale_atm_dyn_dgm_nonhydro3d_common::phytend_dens_id, scale_atm_dyn_dgm_nonhydro3d_common::phytend_momx_id, scale_atm_dyn_dgm_nonhydro3d_common::phytend_momy_id, scale_atm_dyn_dgm_nonhydro3d_common::phytend_momz_id, scale_atm_dyn_dgm_nonhydro3d_common::phytend_num, scale_atm_dyn_dgm_nonhydro3d_common::phytend_rhoh_id, scale_atm_dyn_dgm_nonhydro3d_common::phytend_rhot_id, and scale_time_manager::time_manager_regist_component().