mod_atmos_dyn_driver Module Reference

module Atmosphere / Dynamics More...

Functions/Subroutines
subroutine, public	atmos_dyn_driver_setup
	Setup. More...
subroutine, public	atmos_dyn_driver (do_flag)
	Dynamical Process (Wrapper) More...

Variables
character(len=h_short), public	atmos_dyn_tstep_large_type = 'FVM-HEVE'
character(len=h_short), public	atmos_dyn_tstep_tracer_type = 'FVM-HEVE'
character(len=h_short), public	atmos_dyn_tinteg_large_type = 'EULER'
character(len=h_short), public	atmos_dyn_tinteg_short_type = 'RK4'
character(len=h_short), public	atmos_dyn_tinteg_tracer_type = 'RK3WS2002'
character(len=h_short), public	atmos_dyn_fvm_flux_type = 'CD4'
character(len=h_short), public	atmos_dyn_fvm_flux_tracer_type = 'UD3KOREN1993'

Detailed Description

module Atmosphere / Dynamics

Description

Dynamical step driver

Author

Team SCALE

Note

The coding to call DYN2 routines is a temporary measure. After improving layering of directories and generalizing API for each modules in dynamical core, we should remove the temporary codes.

History

• 2013-12-04 (S.Nishizawa) [mod] splited from scale_atmos_dyn.f90

NAMELIST

• PARAM_ATMOS_DYN

  name	type	default value	comment
  ATMOS_DYN_TINTEG_SHORT_TYPE	character(len=H_SHORT)	'RK4'
  ATMOS_DYN_TINTEG_TRACER_TYPE	character(len=H_SHORT)	'RK3WS2002'
  ATMOS_DYN_TINTEG_LARGE_TYPE	character(len=H_SHORT)	'EULER'	Type of time integration
  ATMOS_DYN_FVM_FLUX_TYPE	character(len=H_SHORT)	'CD4'	Type of advective flux scheme (FVM)
  ATMOS_DYN_FVM_FLUX_TRACER_TYPE	character(len=H_SHORT)	'UD3KOREN1993'
  ATMOS_DYN_NUMERICAL_DIFF_ORDER	integer	1
  ATMOS_DYN_NUMERICAL_DIFF_COEF	real(RP)	1.0E-4_RP	nondimensional numerical diffusion
  ATMOS_DYN_NUMERICAL_DIFF_COEF_TRACER	real(RP)	0.0_RP	nondimensional numerical diffusion for tracer
  ATMOS_DYN_NUMERICAL_DIFF_SFC_FACT	real(RP)	1.0_RP
  ATMOS_DYN_NUMERICAL_DIFF_USE_REFSTATE	logical	.true.
  ATMOS_DYN_WDAMP_TAU	real(RP)	-1.0_RP	maximum tau for Rayleigh damping of w [s]
  ATMOS_DYN_WDAMP_HEIGHT	real(RP)	-1.0_RP	height to start apply Rayleigh damping [m]
  ATMOS_DYN_WDAMP_LAYER	integer	-1	layer number to start apply Rayleigh damping [num]
  ATMOS_DYN_ENABLE_CORIOLIS	logical	.false.	enable coriolis force?
  ATMOS_DYN_DIVDMP_COEF	real(RP)	0.0_RP	Divergence dumping coef
  ATMOS_DYN_FLAG_FCT_MOMENTUM	logical	.false.
  ATMOS_DYN_FLAG_FCT_T	logical	.false.
  ATMOS_DYN_FLAG_FCT_TRACER	logical	.false.
  ATMOS_DYN_FLAG_FCT_ALONG_STREAM	logical	.true.

  
  

History Output

No history output

Function/Subroutine Documentation

atmos_dyn_driver_setup()

subroutine, public mod_atmos_dyn_driver::atmos_dyn_driver_setup

(

)

Setup.

Definition at line 96 of file mod_atmos_dyn_driver.f90.

References atmos_dyn_fvm_flux_tracer_type, atmos_dyn_fvm_flux_type, scale_atmos_dyn::atmos_dyn_setup(), atmos_dyn_tinteg_large_type, atmos_dyn_tinteg_short_type, atmos_dyn_tinteg_tracer_type, atmos_dyn_tstep_large_type, atmos_dyn_tstep_tracer_type, mod_atmos_admin::atmos_dyn_type, mod_atmos_admin::atmos_sw_dyn, mod_atmos_vars::dens, scale_grid::grid_cdx, scale_grid::grid_cdy, scale_grid::grid_cdz, scale_grid::grid_fdx, scale_grid::grid_fdy, scale_grid::grid_fdz, scale_grid::grid_fz, scale_stdio::io_fid_conf, scale_stdio::io_fid_log, scale_stdio::io_fid_nml, scale_stdio::io_l, scale_stdio::io_nml, scale_grid_index::kmax, scale_grid_index::ks, mod_atmos_vars::momx, mod_atmos_vars::momy, mod_atmos_vars::momz, scale_process::prc_mpistop(), mod_atmos_dyn_vars::prog, mod_atmos_vars::qtrc, scale_grid_real::real_lat, mod_atmos_vars::rhot, and scale_time::time_dtsec_atmos_dyn.

Referenced by mod_atmos_driver::atmos_driver_setup().

    use scale_process, only: &
       prc_mpistop
    use scale_grid, only: &
       grid_fz,  &
       grid_cdz, &
       grid_cdx, &
       grid_cdy, &
       grid_fdz, &
       grid_fdx, &
       grid_fdy
    use scale_grid_real, only: &
       real_lat
    use scale_time, only: &
       time_dtsec_atmos_dyn
    use mod_atmos_admin, only: &
       atmos_sw_dyn,   &
       atmos_dyn_type
    use mod_atmos_vars, only: &
       dens, &
       momz, &
       momx, &
       momy, &
       rhot, &
       qtrc
    use mod_atmos_dyn_vars, only: &
       prog
    use scale_atmos_dyn, only: &
       atmos_dyn_setup
    implicit none

    namelist / param_atmos_dyn / &
       atmos_dyn_tinteg_short_type,           &
       atmos_dyn_tinteg_tracer_type,          &
       atmos_dyn_tinteg_large_type,           &
       atmos_dyn_fvm_flux_type,               &
       atmos_dyn_fvm_flux_tracer_type,        &
       atmos_dyn_numerical_diff_order,        &
       atmos_dyn_numerical_diff_coef,         &
       atmos_dyn_numerical_diff_coef_tracer,  &
       atmos_dyn_numerical_diff_sfc_fact,     &
       atmos_dyn_numerical_diff_use_refstate, &
       atmos_dyn_wdamp_tau,                   &
       atmos_dyn_wdamp_height,                &
       atmos_dyn_wdamp_layer,                 &
       atmos_dyn_enable_coriolis,             &
       atmos_dyn_divdmp_coef,                 &
       atmos_dyn_flag_fct_momentum,           &
       atmos_dyn_flag_fct_t,                  &
       atmos_dyn_flag_fct_tracer,             &
       atmos_dyn_flag_fct_along_stream

    real(RP) :: DT
    integer  :: ierr
    !---------------------------------------------------------------------------

    if( io_l ) write(io_fid_log,*)
    if( io_l ) write(io_fid_log,*) '++++++ Module[DRIVER] / Categ[ATMOS DYN] / Origin[SCALE-RM]'

    if ( atmos_sw_dyn ) then

       !--- read namelist
       rewind(io_fid_conf)
       read(io_fid_conf,nml=param_atmos_dyn,iostat=ierr)
       if( ierr < 0 ) then !--- missing
          if( io_l ) write(io_fid_log,*) '*** Not found namelist. Default used.'
       elseif( ierr > 0 ) then !--- fatal error
          write(*,*) 'xxx Not appropriate names in namelist PARAM_ATMOS_DYN. Check!'
          call prc_mpistop
       endif
       if( io_nml ) write(io_fid_nml,nml=param_atmos_dyn)

       dt = real(TIME_DTSEC_ATMOS_DYN,kind=rp)

       if ( atmos_dyn_wdamp_layer > kmax ) then
          write(*,*) 'xxx ATMOS_DYN_wdamp_layer should be less than total number of vertical layer(KA). Check!'
          call prc_mpistop
       elseif( atmos_dyn_wdamp_layer > 0 ) then
          atmos_dyn_wdamp_height = grid_fz(atmos_dyn_wdamp_layer+ks-1)
       endif

       if ( atmos_dyn_wdamp_tau < 0.0_rp ) then
          atmos_dyn_wdamp_tau = dt * 10.0_rp
       elseif ( atmos_dyn_wdamp_tau < dt ) then
          write(*,*) 'xxx ATMOS_DYN_wdamp_tau should be larger than TIME_DT_ATMOS_DYN. Check!'
          call prc_mpistop
       end if

       if ( atmos_sw_dyn ) then
          if( io_l ) write(io_fid_log,*)
          if( io_l ) write(io_fid_log,*) '*** Scheme for Large time step  : ', trim(atmos_dyn_tinteg_large_type)
          if( io_l ) write(io_fid_log,*) '*** Scheme for Short time step  : ', trim(atmos_dyn_tinteg_short_type)
          if( io_l ) write(io_fid_log,*) '*** Scheme for Tracer advection : ', trim(atmos_dyn_tinteg_tracer_type)
       endif

       call atmos_dyn_setup( atmos_dyn_tinteg_short_type,        & ! [IN]
                             atmos_dyn_tinteg_tracer_type,       & ! [IN]
                             atmos_dyn_tinteg_large_type,        & ! [IN]
                             atmos_dyn_tstep_tracer_type,        & ! [IN]
                             atmos_dyn_tstep_large_type,         & ! [IN]
                             atmos_dyn_fvm_flux_type,            & ! [IN]
                             atmos_dyn_fvm_flux_tracer_type,     & ! [IN]
                             dens, momz, momx, momy, rhot, qtrc, & ! [IN]
                             prog,                               & ! [IN]
                             grid_cdz, grid_cdx, grid_cdy,       & ! [IN]
                             grid_fdz, grid_fdx, grid_fdy,       & ! [IN]
                             atmos_dyn_wdamp_tau,                & ! [IN]
                             atmos_dyn_wdamp_height,             & ! [IN]
                             grid_fz,                            & ! [IN]
                             atmos_dyn_enable_coriolis,          & ! [IN]
                             real_lat,                           & ! [IN]
                             none = atmos_dyn_type=='NONE'       ) ! [IN]
    endif

    return

Here is the call graph for this function:

Here is the caller graph for this function:

atmos_dyn_driver()

subroutine, public mod_atmos_dyn_driver::atmos_dyn_driver

(

logical, intent(in)

do_flag

)

Dynamical Process (Wrapper)

Definition at line 215 of file mod_atmos_dyn_driver.f90.

References scale_atmos_boundary::atmos_boundary_alpha_dens, scale_atmos_boundary::atmos_boundary_alpha_pott, scale_atmos_boundary::atmos_boundary_alpha_qtrc, scale_atmos_boundary::atmos_boundary_alpha_velx, scale_atmos_boundary::atmos_boundary_alpha_vely, scale_atmos_boundary::atmos_boundary_alpha_velz, scale_atmos_boundary::atmos_boundary_dens, scale_atmos_boundary::atmos_boundary_pott, scale_atmos_boundary::atmos_boundary_qtrc, scale_atmos_boundary::atmos_boundary_velx, scale_atmos_boundary::atmos_boundary_vely, scale_atmos_boundary::atmos_boundary_velz, scale_atmos_dyn::atmos_dyn(), scale_atmos_refstate::atmos_refstate_dens, scale_atmos_refstate::atmos_refstate_pott, scale_atmos_refstate::atmos_refstate_pres, scale_atmos_refstate::atmos_refstate_qv, mod_atmos_admin::atmos_use_average, mod_atmos_vars::atmos_vars_total(), mod_atmos_vars::dens, mod_atmos_vars::dens_av, mod_atmos_vars::dens_tp, scale_grid::grid_cdx, scale_grid::grid_cdy, scale_grid::grid_cdz, scale_grid::grid_fdx, scale_grid::grid_fdy, scale_grid::grid_fdz, scale_grid::grid_rcdx, scale_grid::grid_rcdy, scale_grid::grid_rcdz, scale_grid::grid_rfdx, scale_grid::grid_rfdy, scale_grid::grid_rfdz, scale_gridtrans::gtrans_gsqrt, scale_gridtrans::gtrans_j13g, scale_gridtrans::gtrans_j23g, scale_gridtrans::gtrans_j33g, scale_gridtrans::gtrans_mapf, mod_atmos_vars::momx, mod_atmos_vars::momx_av, mod_atmos_vars::momx_tp, mod_atmos_vars::momy, mod_atmos_vars::momy_av, mod_atmos_vars::momy_tp, mod_atmos_vars::momz, mod_atmos_vars::momz_av, mod_atmos_vars::momz_tp, mod_atmos_dyn_vars::prog, mod_atmos_vars::qtrc, mod_atmos_vars::qtrc_av, scale_grid_real::real_phi, mod_atmos_vars::rhoq_tp, mod_atmos_vars::rhot, mod_atmos_vars::rhot_av, mod_atmos_vars::rhot_tp, scale_time::time_dtsec, scale_time::time_dtsec_atmos_dyn, scale_tracer::tracer_cp, scale_tracer::tracer_cv, scale_tracer::tracer_mass, and scale_tracer::tracer_r.

Referenced by mod_atmos_driver::atmos_driver().

    use scale_grid, only: &
       grid_cdz,  &
       grid_cdx,  &
       grid_cdy,  &
       grid_fdz,  &
       grid_fdx,  &
       grid_fdy,  &
       grid_rcdz, &
       grid_rcdx, &
       grid_rcdy, &
       grid_rfdz, &
       grid_rfdx, &
       grid_rfdy
    use scale_grid_real, only: &
       real_phi
    use scale_gridtrans, only: &
       gtrans_gsqrt, &
       gtrans_j13g,  &
       gtrans_j23g,  &
       gtrans_j33g,  &
       gtrans_mapf
    use scale_time, only: &
       time_dtsec,           &
       time_dtsec_atmos_dyn
    use mod_atmos_admin, only: &
       atmos_use_average
    use mod_atmos_vars, only: &
       atmos_vars_total,  &
       dens,    &
       momz,    &
       momx,    &
       momy,    &
       rhot,    &
       qtrc,    &
       dens_av, &
       momz_av, &
       momx_av, &
       momy_av, &
       rhot_av, &
       qtrc_av, &
       dens_tp, &
       momz_tp, &
       momx_tp, &
       momy_tp, &
       rhot_tp, &
       rhoq_tp
    use mod_atmos_dyn_vars, only: &
       prog
    use scale_atmos_refstate, only: &
       atmos_refstate_dens, &
       atmos_refstate_pott, &
       atmos_refstate_qv,   &
       atmos_refstate_pres
    use scale_atmos_boundary, only: &
       atmos_boundary_dens,       &
       atmos_boundary_velz,       &
       atmos_boundary_velx,       &
       atmos_boundary_vely,       &
       atmos_boundary_pott,       &
       atmos_boundary_qtrc,       &
       atmos_boundary_alpha_dens, &
       atmos_boundary_alpha_velz, &
       atmos_boundary_alpha_velx, &
       atmos_boundary_alpha_vely, &
       atmos_boundary_alpha_pott, &
       atmos_boundary_alpha_qtrc
    use scale_atmos_dyn, only: &
       atmos_dyn
    implicit none

    logical, intent(in) :: do_flag
    !---------------------------------------------------------------------------

    if ( do_flag ) then
       call atmos_dyn( dens, momz, momx, momy, rhot, qtrc,                   & ! [INOUT]
                       prog,                                                 & ! [IN]
                       dens_av, momz_av, momx_av, momy_av, rhot_av, qtrc_av, & ! [INOUT]
                       dens_tp, momz_tp, momx_tp, momy_tp, rhot_tp, rhoq_tp, & ! [IN]
                       grid_cdz,  grid_cdx,  grid_cdy,                       & ! [IN]
                       grid_fdz,  grid_fdx,  grid_fdy,                       & ! [IN]
                       grid_rcdz, grid_rcdx, grid_rcdy,                      & ! [IN]
                       grid_rfdz, grid_rfdx, grid_rfdy,                      & ! [IN]
                       real_phi,                                             & ! [IN]
                       gtrans_gsqrt,                                         & ! [IN]
                       gtrans_j13g, gtrans_j23g, gtrans_j33g, gtrans_mapf,   & ! [IN]
                       tracer_r, tracer_cv, tracer_cp, tracer_mass,          & ! [IN]
                       atmos_refstate_dens,                                  & ! [IN]
                       atmos_refstate_pott,                                  & ! [IN]
                       atmos_refstate_qv,                                    & ! [IN]
                       atmos_refstate_pres,                                  & ! [IN]
                       atmos_dyn_numerical_diff_coef,                        & ! [IN]
                       atmos_dyn_numerical_diff_coef_tracer,                 & ! [IN]
                       atmos_dyn_numerical_diff_order,                       & ! [IN]
                       atmos_dyn_numerical_diff_sfc_fact,                    & ! [IN]
                       atmos_dyn_numerical_diff_use_refstate,                & ! [IN]
                       atmos_boundary_dens,                                  & ! [IN]
                       atmos_boundary_velz,                                  & ! [IN]
                       atmos_boundary_velx,                                  & ! [IN]
                       atmos_boundary_vely,                                  & ! [IN]
                       atmos_boundary_pott,                                  & ! [IN]
                       atmos_boundary_qtrc,                                  & ! [IN]
                       atmos_boundary_alpha_dens,                            & ! [IN]
                       atmos_boundary_alpha_velz,                            & ! [IN]
                       atmos_boundary_alpha_velx,                            & ! [IN]
                       atmos_boundary_alpha_vely,                            & ! [IN]
                       atmos_boundary_alpha_pott,                            & ! [IN]
                       atmos_boundary_alpha_qtrc,                            & ! [IN]
                       atmos_dyn_divdmp_coef,                                & ! [IN]
                       atmos_dyn_flag_fct_momentum,                          & ! [IN]
                       atmos_dyn_flag_fct_t,                                 & ! [IN]
                       atmos_dyn_flag_fct_tracer,                            & ! [IN]
                       atmos_dyn_flag_fct_along_stream,                      & ! [IN]
                       atmos_use_average,                                    & ! [IN]
                       time_dtsec,                                           & ! [IN]
                       time_dtsec_atmos_dyn                                  ) ! [IN]

       call atmos_vars_total
    endif

    return

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

atmos_dyn_tstep_large_type

character(len=h_short), public mod_atmos_dyn_driver::atmos_dyn_tstep_large_type = 'FVM-HEVE'

Definition at line 41 of file mod_atmos_dyn_driver.f90.

Referenced by atmos_dyn_driver_setup().

  character(len=H_SHORT), public :: ATMOS_DYN_TSTEP_LARGE_TYPE     = 'FVM-HEVE'

atmos_dyn_tstep_tracer_type

character(len=h_short), public mod_atmos_dyn_driver::atmos_dyn_tstep_tracer_type = 'FVM-HEVE'

Definition at line 42 of file mod_atmos_dyn_driver.f90.

Referenced by atmos_dyn_driver_setup().

  character(len=H_SHORT), public :: ATMOS_DYN_TSTEP_TRACER_TYPE    = 'FVM-HEVE'

atmos_dyn_tinteg_large_type

character(len=h_short), public mod_atmos_dyn_driver::atmos_dyn_tinteg_large_type = 'EULER'

Definition at line 44 of file mod_atmos_dyn_driver.f90.

Referenced by atmos_dyn_driver_setup().

  character(len=H_SHORT), public :: ATMOS_DYN_TINTEG_LARGE_TYPE    = 'EULER'        ! Type of time integration

atmos_dyn_tinteg_short_type

character(len=h_short), public mod_atmos_dyn_driver::atmos_dyn_tinteg_short_type = 'RK4'

Definition at line 46 of file mod_atmos_dyn_driver.f90.

Referenced by atmos_dyn_driver_setup().

  character(len=H_SHORT), public :: ATMOS_DYN_TINTEG_SHORT_TYPE    = 'RK4'

atmos_dyn_tinteg_tracer_type

character(len=h_short), public mod_atmos_dyn_driver::atmos_dyn_tinteg_tracer_type = 'RK3WS2002'

Definition at line 49 of file mod_atmos_dyn_driver.f90.

Referenced by atmos_dyn_driver_setup().

  character(len=H_SHORT), public :: ATMOS_DYN_TINTEG_TRACER_TYPE   = 'RK3WS2002'

atmos_dyn_fvm_flux_type

character(len=h_short), public mod_atmos_dyn_driver::atmos_dyn_fvm_flux_type = 'CD4'

Definition at line 52 of file mod_atmos_dyn_driver.f90.

Referenced by atmos_dyn_driver_setup().

  character(len=H_SHORT), public :: ATMOS_DYN_FVM_FLUX_TYPE        = 'CD4'          ! Type of advective flux scheme (FVM)

atmos_dyn_fvm_flux_tracer_type

character(len=h_short), public mod_atmos_dyn_driver::atmos_dyn_fvm_flux_tracer_type = 'UD3KOREN1993'

Definition at line 53 of file mod_atmos_dyn_driver.f90.

Referenced by atmos_dyn_driver_setup().

  character(len=H_SHORT), public :: ATMOS_DYN_FVM_FLUX_TRACER_TYPE = 'UD3KOREN1993'