mod_atmos_phy_tb_vars Module Reference

module Atmosphere / Physics Turbulence More...

Functions/Subroutines
subroutine, public	atmos_phy_tb_vars_setup
	Setup. More...
subroutine, public	atmos_phy_tb_vars_fillhalo
	HALO Communication. More...
subroutine, public	atmos_phy_tb_vars_restart_read
	Read restart. More...
subroutine, public	atmos_phy_tb_vars_restart_write
	Write restart. More...

Variables
logical, public	atmos_phy_tb_restart_output = .false.
	output restart file? More...
character(len=h_long), public	atmos_phy_tb_restart_in_basename = ''
	basename of the restart file More...
character(len=h_long), public	atmos_phy_tb_restart_out_basename = ''
	basename of the output file More...
character(len=h_mid), public	atmos_phy_tb_restart_out_title = 'ATMOS_PHY_TB restart'
	title of the output file More...
character(len=h_mid), public	atmos_phy_tb_restart_out_dtype = 'DEFAULT'
	REAL4 or REAL8. More...
real(rp), dimension(:,:,:), allocatable, public	atmos_phy_tb_momz_t
real(rp), dimension(:,:,:), allocatable, public	atmos_phy_tb_momx_t
real(rp), dimension(:,:,:), allocatable, public	atmos_phy_tb_momy_t
real(rp), dimension(:,:,:), allocatable, public	atmos_phy_tb_rhot_t
real(rp), dimension(:,:,:,:), allocatable, public	atmos_phy_tb_rhoq_t
real(rp), dimension(:,:,:), allocatable, public	atmos_phy_tb_tke_t
real(rp), dimension(:,:,:), allocatable, public	atmos_phy_tb_tke
real(rp), dimension(:,:,:), allocatable, public	atmos_phy_tb_nu

Detailed Description

module Atmosphere / Physics Turbulence

Description

Container for mod_atmos_phy_tb

Author

Team SCALE

History

• 2014-05-04 (H.Yashiro) [new]

NAMELIST

• PARAM_ATMOS_PHY_TB_VARS

  name	type	default value	comment
  ATMOS_PHY_TB_RESTART_IN_BASENAME	character(len=H_LONG)	''	basename of the restart file
  ATMOS_PHY_TB_RESTART_OUTPUT	logical	.false.	output restart file?
  ATMOS_PHY_TB_RESTART_OUT_BASENAME	character(len=H_LONG)	''	basename of the output file
  ATMOS_PHY_TB_RESTART_OUT_TITLE	character(len=H_MID)	'ATMOS_PHY_TB restart'	title of the output file
  ATMOS_PHY_TB_RESTART_OUT_DTYPE	character(len=H_MID)	'DEFAULT'	REAL4 or REAL8
  ATMOS_PHY_TB_TKE_INIT	real(RP)	1.0E-10_RP

  
  

History Output

No history output

Function/Subroutine Documentation

atmos_phy_tb_vars_setup()

subroutine, public mod_atmos_phy_tb_vars::atmos_phy_tb_vars_setup

(

)

Setup.

Definition at line 85 of file mod_atmos_phy_tb_vars.f90.

References atmos_phy_tb_momx_t, atmos_phy_tb_momy_t, atmos_phy_tb_momz_t, atmos_phy_tb_nu, atmos_phy_tb_restart_in_basename, atmos_phy_tb_restart_out_basename, atmos_phy_tb_restart_out_dtype, atmos_phy_tb_restart_out_title, atmos_phy_tb_restart_output, atmos_phy_tb_rhoq_t, atmos_phy_tb_rhot_t, atmos_phy_tb_tke, atmos_phy_tb_tke_t, scale_const::const_undef, scale_grid_index::ia, scale_stdio::io_fid_conf, scale_stdio::io_fid_log, scale_stdio::io_l, scale_stdio::io_lnml, scale_grid_index::ja, scale_grid_index::ka, scale_process::prc_mpistop(), and scale_tracer::qa.

Referenced by mod_atmos_vars::atmos_vars_setup().

    use scale_process, only: &
       prc_mpistop
    use scale_const, only: &
       undef => const_undef
    implicit none
    real(RP) :: atmos_phy_tb_tke_init = 1.0e-10_rp

    namelist / param_atmos_phy_tb_vars / &
       atmos_phy_tb_restart_in_basename,  &
       atmos_phy_tb_restart_output,       &
       atmos_phy_tb_restart_out_basename, &
       atmos_phy_tb_restart_out_title,    &
       atmos_phy_tb_restart_out_dtype,    &
       atmos_phy_tb_tke_init

    integer :: ierr
    integer :: iv
    !---------------------------------------------------------------------------

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

    allocate( atmos_phy_tb_momz_t(ka,ia,ja)    )
    allocate( atmos_phy_tb_momx_t(ka,ia,ja)    )
    allocate( atmos_phy_tb_momy_t(ka,ia,ja)    )
    allocate( atmos_phy_tb_rhot_t(ka,ia,ja)    )
    allocate( atmos_phy_tb_rhoq_t(ka,ia,ja,qa) )
    allocate( atmos_phy_tb_tke_t(ka,ia,ja)     )

    allocate( atmos_phy_tb_tke(ka,ia,ja) )
    allocate( atmos_phy_tb_nu(ka,ia,ja) )

    !--- read namelist
    rewind(io_fid_conf)
    read(io_fid_conf,nml=param_atmos_phy_tb_vars,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_PHY_TB_VARS. Check!'
       call prc_mpistop
    endif
    if( io_lnml ) write(io_fid_log,nml=param_atmos_phy_tb_vars)

    if( io_l ) write(io_fid_log,*)
    if( io_l ) write(io_fid_log,*) '*** [ATMOS_PHY_TB] prognostic/diagnostic variables'
    if( io_l ) write(io_fid_log,'(1x,A,A15,A,A32,3(A))') &
               '***       |','VARNAME        ','|', 'DESCRIPTION                     ','[', 'UNIT            ',']'
    do iv = 1, vmax
       if( io_l ) write(io_fid_log,'(1x,A,i3,A,A15,A,A32,3(A))') &
                  '*** NO.',iv,'|',var_name(iv),'|',var_desc(iv),'[',var_unit(iv),']'
    enddo

    if( io_l ) write(io_fid_log,*)
    if ( atmos_phy_tb_restart_in_basename /= '' ) then
       if( io_l ) write(io_fid_log,*) '*** Restart input?  : ', trim(atmos_phy_tb_restart_in_basename)
    else
       if( io_l ) write(io_fid_log,*) '*** Restart input?  : NO'
    endif
    if (       atmos_phy_tb_restart_output             &
         .AND. atmos_phy_tb_restart_out_basename /= '' ) then
       if( io_l ) write(io_fid_log,*) '*** Restart output? : ', trim(atmos_phy_tb_restart_out_basename)
    else
       if( io_l ) write(io_fid_log,*) '*** Restart output? : NO'
       atmos_phy_tb_restart_output = .false.
    endif

    atmos_phy_tb_momz_t(:,:,:)   = undef
    atmos_phy_tb_momx_t(:,:,:)   = undef
    atmos_phy_tb_momy_t(:,:,:)   = undef
    atmos_phy_tb_rhot_t(:,:,:)   = undef
    atmos_phy_tb_rhoq_t(:,:,:,:) = undef
    atmos_phy_tb_tke_t(:,:,:)   = undef

    atmos_phy_tb_tke(:,:,:) = atmos_phy_tb_tke_init
    atmos_phy_tb_nu(:,:,:) = undef

    return

Here is the call graph for this function:

Here is the caller graph for this function:

atmos_phy_tb_vars_fillhalo()

subroutine, public mod_atmos_phy_tb_vars::atmos_phy_tb_vars_fillhalo

(

)

HALO Communication.

Definition at line 167 of file mod_atmos_phy_tb_vars.f90.

References atmos_phy_tb_nu, atmos_phy_tb_tke, scale_grid_index::ie, scale_grid_index::is, scale_grid_index::je, scale_grid_index::js, scale_grid_index::ka, scale_grid_index::ke, and scale_grid_index::ks.

    use scale_comm, only: &
       comm_vars8, &
       comm_wait
    implicit none

    integer :: i, j
    !---------------------------------------------------------------------------

    do j  = js, je
    do i  = is, ie
       atmos_phy_tb_tke(   1:ks-1,i,j) = atmos_phy_tb_tke(ks,i,j)
       atmos_phy_tb_nu(   1:ks-1,i,j) = atmos_phy_tb_nu(ks,i,j)
       atmos_phy_tb_tke(ke+1:ka,  i,j) = atmos_phy_tb_tke(ke,i,j)
       atmos_phy_tb_nu(ke+1:ka,  i,j) = atmos_phy_tb_nu(ke,i,j)
    enddo
    enddo

    call comm_vars8( atmos_phy_tb_tke(:,:,:), 1 )
    call comm_vars8( atmos_phy_tb_nu(:,:,:), 2 )
    call comm_wait ( atmos_phy_tb_tke(:,:,:), 1 )
    call comm_wait ( atmos_phy_tb_nu(:,:,:), 2 )

    return

atmos_phy_tb_vars_restart_read()

subroutine, public mod_atmos_phy_tb_vars::atmos_phy_tb_vars_restart_read

(

)

Read restart.

Definition at line 195 of file mod_atmos_phy_tb_vars.f90.

References atmos_phy_tb_restart_in_basename, atmos_phy_tb_tke, scale_stdio::io_fid_log, and scale_stdio::io_l.

Referenced by mod_atmos_vars::atmos_vars_restart_read().

    use scale_fileio, only: &
       fileio_read
    use scale_rm_statistics, only: &
       stat_total
    implicit none

    real(RP) :: total
    !---------------------------------------------------------------------------

    if( io_l ) write(io_fid_log,*)
    if( io_l ) write(io_fid_log,*) '*** Input restart file (ATMOS_PHY_TB) ***'

    if ( atmos_phy_tb_restart_in_basename /= '' ) then
       if( io_l ) write(io_fid_log,*) '*** basename: ', trim(atmos_phy_tb_restart_in_basename)

       call fileio_read( atmos_phy_tb_tke(:,:,:),                                     & ! [OUT]
                         atmos_phy_tb_restart_in_basename, var_name(1), 'ZXY', step=1 ) ! [IN]
!       call FILEIO_read( ATMOS_PHY_TB_NU (:,:,:),                                     & ! [OUT]
!                         ATMOS_PHY_TB_RESTART_IN_BASENAME, VAR_NAME(2), 'ZXY', step=1 ) ! [IN]
!
!       call ATMOS_PHY_TB_vars_fillhalo
!
       call stat_total( total, atmos_phy_tb_tke(:,:,:), var_name(1) )
!       call STAT_total( total, ATMOS_PHY_TB_NU (:,:,:), VAR_NAME(2) )
    else
       if( io_l ) write(io_fid_log,*) '*** restart file for ATMOS_PHY_TB is not specified.'
    endif

    return

Here is the caller graph for this function:

atmos_phy_tb_vars_restart_write()

subroutine, public mod_atmos_phy_tb_vars::atmos_phy_tb_vars_restart_write

(

)

Write restart.

Definition at line 229 of file mod_atmos_phy_tb_vars.f90.

References atmos_phy_tb_restart_out_basename, atmos_phy_tb_restart_out_dtype, atmos_phy_tb_restart_out_title, atmos_phy_tb_tke, scale_stdio::io_fid_log, scale_stdio::io_l, and scale_time::time_gettimelabel().

Referenced by mod_atmos_vars::atmos_vars_restart_write().

    use scale_time, only: &
       time_gettimelabel
    use scale_fileio, only: &
       fileio_write
    implicit none

    character(len=20)     :: timelabel
    character(len=H_LONG) :: basename
    !---------------------------------------------------------------------------

    if ( atmos_phy_tb_restart_out_basename /= '' ) then

       call time_gettimelabel( timelabel )
       write(basename,'(A,A,A)') trim(atmos_phy_tb_restart_out_basename), '_', trim(timelabel)

       if( io_l ) write(io_fid_log,*)
       if( io_l ) write(io_fid_log,*) '*** Output restart file (ATMOS_PHY_TB) ***'
       if( io_l ) write(io_fid_log,*) '*** basename: ', trim(basename)

       call fileio_write( atmos_phy_tb_tke(:,:,:), basename,            atmos_phy_tb_restart_out_title, & ! [IN]
                          var_name(1), var_desc(1), var_unit(1), 'ZXY', atmos_phy_tb_restart_out_dtype  ) ! [IN]
!       call FILEIO_write( ATMOS_PHY_TB_NU (:,:,:), basename,            ATMOS_PHY_TB_RESTART_OUT_TITLE, & ! [IN]
!                          VAR_NAME(2), VAR_DESC(2), VAR_UNIT(2), 'ZXY', ATMOS_PHY_TB_RESTART_OUT_DTYPE  ) ! [IN]

    endif

    return

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

atmos_phy_tb_restart_output

logical, public mod_atmos_phy_tb_vars::atmos_phy_tb_restart_output = .false.

output restart file?

Definition at line 40 of file mod_atmos_phy_tb_vars.f90.

Referenced by mod_admin_restart::admin_restart_setup(), and atmos_phy_tb_vars_setup().

  logical,               public :: atmos_phy_tb_restart_output       = .false.                

atmos_phy_tb_restart_in_basename

character(len=h_long), public mod_atmos_phy_tb_vars::atmos_phy_tb_restart_in_basename = ''

basename of the restart file

Definition at line 42 of file mod_atmos_phy_tb_vars.f90.

Referenced by mod_admin_restart::admin_restart_setup(), atmos_phy_tb_vars_restart_read(), and atmos_phy_tb_vars_setup().

  character(len=H_LONG), public :: atmos_phy_tb_restart_in_basename  = ''

atmos_phy_tb_restart_out_basename

character(len=h_long), public mod_atmos_phy_tb_vars::atmos_phy_tb_restart_out_basename = ''

basename of the output file

Definition at line 43 of file mod_atmos_phy_tb_vars.f90.

Referenced by mod_admin_restart::admin_restart_setup(), atmos_phy_tb_vars_restart_write(), and atmos_phy_tb_vars_setup().

  character(len=H_LONG), public :: atmos_phy_tb_restart_out_basename = ''

atmos_phy_tb_restart_out_title

character(len=h_mid), public mod_atmos_phy_tb_vars::atmos_phy_tb_restart_out_title = 'ATMOS_PHY_TB restart'

title of the output file

Definition at line 44 of file mod_atmos_phy_tb_vars.f90.

Referenced by mod_admin_restart::admin_restart_setup(), atmos_phy_tb_vars_restart_write(), and atmos_phy_tb_vars_setup().

  character(len=H_MID),  public :: atmos_phy_tb_restart_out_title    = 'ATMOS_PHY_TB restart'

atmos_phy_tb_restart_out_dtype

character(len=h_mid), public mod_atmos_phy_tb_vars::atmos_phy_tb_restart_out_dtype = 'DEFAULT'

REAL4 or REAL8.

Definition at line 45 of file mod_atmos_phy_tb_vars.f90.

Referenced by mod_admin_restart::admin_restart_setup(), atmos_phy_tb_vars_restart_write(), and atmos_phy_tb_vars_setup().

  character(len=H_MID),  public :: atmos_phy_tb_restart_out_dtype    = 'DEFAULT'

atmos_phy_tb_momz_t

real(rp), dimension(:,:,:), allocatable, public mod_atmos_phy_tb_vars::atmos_phy_tb_momz_t

Definition at line 47 of file mod_atmos_phy_tb_vars.f90.

Referenced by mod_atmos_phy_tb_driver::atmos_phy_tb_driver(), mod_atmos_phy_tb_driver::atmos_phy_tb_driver_setup(), and atmos_phy_tb_vars_setup().

  real(RP), public, allocatable :: atmos_phy_tb_momz_t(:,:,:)   ! tendency MOMZ [kg/m2/s2]

atmos_phy_tb_momx_t

real(rp), dimension(:,:,:), allocatable, public mod_atmos_phy_tb_vars::atmos_phy_tb_momx_t

Definition at line 48 of file mod_atmos_phy_tb_vars.f90.

Referenced by mod_atmos_phy_tb_driver::atmos_phy_tb_driver(), and atmos_phy_tb_vars_setup().

  real(RP), public, allocatable :: atmos_phy_tb_momx_t(:,:,:)   ! tendency MOMX [kg/m2/s2]

atmos_phy_tb_momy_t

real(rp), dimension(:,:,:), allocatable, public mod_atmos_phy_tb_vars::atmos_phy_tb_momy_t

Definition at line 49 of file mod_atmos_phy_tb_vars.f90.

Referenced by mod_atmos_phy_tb_driver::atmos_phy_tb_driver(), and atmos_phy_tb_vars_setup().

  real(RP), public, allocatable :: atmos_phy_tb_momy_t(:,:,:)   ! tendency MOMY [kg/m2/s2]

atmos_phy_tb_rhot_t

real(rp), dimension(:,:,:), allocatable, public mod_atmos_phy_tb_vars::atmos_phy_tb_rhot_t

Definition at line 50 of file mod_atmos_phy_tb_vars.f90.

Referenced by mod_atmos_phy_tb_driver::atmos_phy_tb_driver(), and atmos_phy_tb_vars_setup().

  real(RP), public, allocatable :: atmos_phy_tb_rhot_t(:,:,:)   ! tendency RHOT [K*kg/m3/s]

atmos_phy_tb_rhoq_t

real(rp), dimension(:,:,:,:), allocatable, public mod_atmos_phy_tb_vars::atmos_phy_tb_rhoq_t

Definition at line 51 of file mod_atmos_phy_tb_vars.f90.

Referenced by mod_atmos_phy_tb_driver::atmos_phy_tb_driver(), and atmos_phy_tb_vars_setup().

  real(RP), public, allocatable :: atmos_phy_tb_rhoq_t(:,:,:,:) ! tendency rho*QTRC [kg/kg/s]

atmos_phy_tb_tke_t

real(rp), dimension(:,:,:), allocatable, public mod_atmos_phy_tb_vars::atmos_phy_tb_tke_t

Definition at line 52 of file mod_atmos_phy_tb_vars.f90.

Referenced by mod_atmos_phy_tb_driver::atmos_phy_tb_driver(), mod_atmos_phy_tb_driver::atmos_phy_tb_driver_setup(), and atmos_phy_tb_vars_setup().

  real(RP), public, allocatable :: atmos_phy_tb_tke_t(:,:,:)    ! tendency TKE @m2/s3]

atmos_phy_tb_tke

real(rp), dimension(:,:,:), allocatable, public mod_atmos_phy_tb_vars::atmos_phy_tb_tke

Definition at line 54 of file mod_atmos_phy_tb_vars.f90.

Referenced by mod_atmos_phy_tb_driver::atmos_phy_tb_driver(), atmos_phy_tb_vars_fillhalo(), atmos_phy_tb_vars_restart_read(), atmos_phy_tb_vars_restart_write(), and atmos_phy_tb_vars_setup().

  real(RP), public, allocatable :: atmos_phy_tb_tke(:,:,:) ! turburent kinetic energy [m2/s2]

atmos_phy_tb_nu

real(rp), dimension (:,:,:), allocatable, public mod_atmos_phy_tb_vars::atmos_phy_tb_nu

Definition at line 55 of file mod_atmos_phy_tb_vars.f90.

Referenced by mod_atmos_phy_tb_driver::atmos_phy_tb_driver(), atmos_phy_tb_vars_fillhalo(), and atmos_phy_tb_vars_setup().

  real(RP), public, allocatable :: atmos_phy_tb_nu (:,:,:) ! eddy viscosity           [m2/s]