mod_atmos_dyn Module Reference

module ATMOSPHERE dynamics More...

Data Types
type	atmosdyn
	Derived type to manage a component of atmospheric dynamics. More...

Functions/Subroutines
subroutine	atmosdyn_setup (this, model_mesh, tm_parent_comp)
	Setup a component of atmospheric dynamics.

Detailed Description

module ATMOSPHERE dynamics

Description

Module for atmosphere dynamical process

Author

Yuta Kawai, Team SCALE

NAMELIST

• PARAM_ATMOS_DYN

  name	type	default value	comment
  EQS_TYPE	character(len=H_MID)	"NONHYDRO3D_HEVE"	Type of governing equations
  TINTEG_TYPE	character(len=H_SHORT)	'ERK_SSP_3s3o'	Type of temporal scheme for a dry dynamical core
  TINTEG_TYPE_TRACER	character(len=H_SHORT)	'ERK_SSP_3s3o'	Type of temporal scheme for tracer advection equations
  TIME_DT	real(DP)	UNDEF8	Timestep for a atmospheric dynamical core
  TIME_DT_UNIT	character(len=H_SHORT)	'SEC'	Unit of timestep
  MODALFILTER_FLAG	logical	.false.	Flag to set whether a modal filtering is used
  NUMDIFF_FLAG	logical	.false.	Flag to set whether we calculate explicit numerical diffusion terms, which is available for a regional dynamical core mode
  SPONGELAYER_FLAG	logical	.false.	Flag to set whether a sponge layer is applied
  ONLY_TRACERADV_FLAG	logical	.false.	Flag to set whether we only treat tracer advection equations considering advection test cases
  TRACERADV_DISABLE_LIMITER	logical	.false.	Flag to disable limiters for ensuring non-negative values
  TRACERADV_MODALFILTER_FLAG	logical	.false.	Flag to whether a modal filtering is used for tracer variables
  HIDE_MPI_COMM_FLAG	logical	.false.

  
  
• PARAM_ATMOS_DYN_CORIOLIS

  name	type	default value	comment
  CORIOLIS_TYPE	character(len=H_SHORT)		Type of coriolis force: 'PLANE', 'SPHERE'
  CORIOLIS_F0	real(RP)	0.0_RP
  CORIOLIS_BETA	real(RP)	0.0_RP
  CORIOLIS_Y0	real(RP)

  
  

History Output

No history output

Function/Subroutine Documentation

atmosdyn_setup()

subroutine mod_atmos_dyn::atmosdyn_setup	(	class(atmosdyn), intent(inout)	this,
		class(modelmeshbase), intent(in), target	model_mesh,
		class(time_manager_component), intent(inout)	tm_parent_comp )

Setup a component of atmospheric dynamics.

Parameters

model_mesh	a object to manage computational mesh of atmospheric model
tm_parent_comp	a object to mange a temporal scheme in a parent component

Definition at line 111 of file mod_atmos_dyn.F90.

    use mod_atmos_mesh, only: atmosmesh
    use scale_time_manager, only: time_manager_component
 
    implicit none
 
    class(AtmosDyn), intent(inout) :: this
    class(ModelMeshBase), target, intent(in) :: model_mesh
    class(TIME_manager_component), intent(inout) :: tm_parent_comp
 
    character(len=H_MID) :: EQS_TYPE             = "NONHYDRO3D_HEVE"
    character(len=H_SHORT) :: TINTEG_TYPE        = 'ERK_SSP_3s3o'
    character(len=H_SHORT) :: TINTEG_TYPE_TRACER = 'ERK_SSP_3s3o'
    real(DP) :: TIME_DT                          = undef8            
    character(len=H_SHORT) :: TIME_DT_UNIT       = 'SEC'
    
    logical :: MODALFILTER_FLAG           = .false. 
    logical :: NUMDIFF_FLAG               = .false. 
    logical :: SPONGELAYER_FLAG           = .false. 
    logical :: ONLY_TRACERADV_FLAG        = .false. 
    logical :: TRACERADV_DISABLE_LIMITER  = .false. 
    logical :: TRACERADV_MODALFILTER_FLAG = .false. 
    logical :: HIDE_MPI_COMM_FLAG         = .false.
    
    namelist / param_atmos_dyn /       &
      eqs_type,                        &
      tinteg_type,                     &
      tinteg_type_tracer,              &      
      time_dt,                         &
      time_dt_unit,                    &
      modalfilter_flag,                &
      numdiff_flag,                    &
      spongelayer_flag,                &
      only_traceradv_flag,             &
      traceradv_disable_limiter,       &
      traceradv_modalfilter_flag,      &
      hide_mpi_comm_flag
    
    class(AtmosMesh), pointer     :: atm_mesh
    class(MeshBase), pointer      :: ptr_mesh
    class(LocalMeshBase), pointer :: ptr_lcmesh
    class(ElementBase3D), pointer :: elem3D
    integer :: n
    real(DP) :: dtsec
 
    class(MeshBase3D), pointer :: mesh3D
 
    integer :: ierr
    !--------------------------------------------------
 
    if (.not. this%IsActivated()) return
    log_info('AtmosDyn_setup',*)
 
    !--- read namelist
    rewind(io_fid_conf)
    read(io_fid_conf,nml=param_atmos_dyn,iostat=ierr)
    if( ierr < 0 ) then !--- missing
      log_info("ATMOS_DYN_setup",*) 'Not found namelist. Default used.'
    elseif( ierr > 0 ) then !--- fatal error
      log_error("ATMOS_DYN_setup",*) 'Not appropriate names in namelist PARAM_ATMOS_DYN. Check!'
      call prc_abort
    endif
    log_nml(param_atmos_dyn)
    
    !- get mesh --------------------------------------------------
 
    call model_mesh%GetModelMesh( ptr_mesh )
    select type(model_mesh)
    class is (atmosmesh)
      atm_mesh => model_mesh
    end select
    mesh3d => atm_mesh%ptr_mesh
 
    !- Setup the temporal integrator
 
    call tm_parent_comp%Regist_process( 'ATMOS_DYN', time_dt, time_dt_unit, & ! (in)
      this%tm_process_id )                                                    ! (out)
 
    dtsec = tm_parent_comp%process_list(this%tm_process_id)%dtsec
 
    !- initialize the variables 
    call this%dyn_vars%Init( model_mesh )
 
    call setup_coriolis_parameter( this%dyn_vars, atm_mesh )
 
    !- Initialize a module for 3D dynamical core 
    call this%dyncore_driver%Init( eqs_type, &
      tinteg_type, dtsec,                    &
      spongelayer_flag, modalfilter_flag,    &
      hide_mpi_comm_flag, &
      atm_mesh )
 
    !- Initialize a module for tracer equations
    call this%trcadv_driver%Init( "TRCADV3D_HEVE", &
      tinteg_type_tracer, dtsec,                                        &
      traceradv_modalfilter_flag, traceradv_disable_limiter,            &
      atm_mesh, this%dyncore_driver%boundary_cond, only_traceradv_flag  )
 
    !- Setup the numerical diffusion
    this%CALC_NUMDIFF_FLAG = numdiff_flag
    if (this%CALC_NUMDIFF_FLAG) call this%numdiff%Init( atm_mesh, dtsec )
 
    return

References mod_atmos_dyn_vars::atmos_dyn_auxvars2d_coriolis_id, scale_coriolis_param::get_coriolis_parameter(), scale_atm_dyn_dgm_driver_trcadv3d::massflx_x_id, scale_atm_dyn_dgm_driver_trcadv3d::massflx_y_id, scale_atm_dyn_dgm_driver_trcadv3d::massflx_z_id, scale_atm_dyn_dgm_nonhydro3d_common::prgvar_ddens_id, scale_atm_dyn_dgm_nonhydro3d_common::prgvar_num, scale_atm_dyn_dgm_driver_trcadv3d::trcvars3d_dens0_id, and scale_atm_dyn_dgm_driver_trcadv3d::trcvars3d_dens_id.