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_open
	Open restart file for read. More...
subroutine, public	atmos_phy_tb_vars_restart_read
	Read restart. More...
subroutine, public	atmos_phy_tb_vars_restart_create
	Create restart file. More...
subroutine, public	atmos_phy_tb_vars_restart_enddef
	Exit netCDF define mode. More...
subroutine, public	atmos_phy_tb_vars_restart_close
	Close restart file. More...
subroutine, public	atmos_phy_tb_vars_restart_def_var
	Write 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 input file. More...
logical, public	atmos_phy_tb_restart_in_postfix_timelabel = .false.
	Add timelabel to the basename of input file? More...
character(len=h_long), public	atmos_phy_tb_restart_out_basename = ''
	Basename of the output file. More...
logical, public	atmos_phy_tb_restart_out_postfix_timelabel = .true.
	Add timelabel to the basename of 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_short), 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

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 input file
  ATMOS_PHY_TB_RESTART_IN_POSTFIX_TIMELABEL	logical	.false.	Add timelabel to the basename of input 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_POSTFIX_TIMELABEL	logical	.true.	Add timelabel to the basename of 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_SHORT)	'DEFAULT'	REAL4 or REAL8

  
  

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 81 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_restart_in_basename, atmos_phy_tb_restart_in_postfix_timelabel, atmos_phy_tb_restart_out_basename, atmos_phy_tb_restart_out_dtype, atmos_phy_tb_restart_out_postfix_timelabel, atmos_phy_tb_restart_out_title, atmos_phy_tb_restart_output, atmos_phy_tb_rhoq_t, atmos_phy_tb_rhot_t, scale_const::const_undef, scale_grid_index::ia, 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::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

    namelist / param_atmos_phy_tb_vars / &
       atmos_phy_tb_restart_in_basename,           &
       atmos_phy_tb_restart_in_postfix_timelabel,  &
       atmos_phy_tb_restart_output,                &
       atmos_phy_tb_restart_out_basename,          &
       atmos_phy_tb_restart_out_postfix_timelabel, &
       atmos_phy_tb_restart_out_title,             &
       atmos_phy_tb_restart_out_dtype

    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) )
    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

    !--- 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_nml ) write(io_fid_nml,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,A24,A,A48,A,A12,A)') &
!               '***       |', 'VARNAME                 ','|', &
!               'DESCRIPTION                                     ', '[', 'UNIT        ', ']'
!    do iv = 1, VMAX
!       if( IO_L ) write(IO_FID_LOG,'(1x,A,I3,A,A24,A,A48,A,A12,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?  : YES, file = ', trim(ATMOS_PHY_TB_RESTART_IN_BASENAME)
!       if( IO_L ) write(IO_FID_LOG,*) '*** Add timelabel?  : ', ATMOS_PHY_TB_RESTART_IN_POSTFIX_TIMELABEL
!    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? : YES, file = ', trim(ATMOS_PHY_TB_RESTART_OUT_BASENAME)
!       if( IO_L ) write(IO_FID_LOG,*) '*** Add timelabel?  : ', ATMOS_PHY_TB_RESTART_OUT_POSTFIX_TIMELABEL
!    else
!       if( IO_L ) write(IO_FID_LOG,*) '*** Restart output? : NO'
!       ATMOS_PHY_TB_RESTART_OUTPUT = .false.
!    endif

    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 157 of file mod_atmos_phy_tb_vars.f90.

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

!    do j  = 1, JA
!    do i  = 1, IA
!       ATMOS_PHY_TB_??(   1:KS-1,i,j) = ATMOS_PHY_TB_??(KS,i,j)
!       ATMOS_PHY_TB_??(KE+1:KA,  i,j) = ATMOS_PHY_TB_??(KE,i,j)
!    enddo
!    enddo

!    call COMM_vars8( ATMOS_PHY_TB_??(:,:,:), 1 )
!    call COMM_wait ( ATMOS_PHY_TB_??(:,:,:), 1 )

    return

atmos_phy_tb_vars_restart_open()

subroutine, public mod_atmos_phy_tb_vars::atmos_phy_tb_vars_restart_open

(

)

Open restart file for read.

Definition at line 179 of file mod_atmos_phy_tb_vars.f90.

References scale_fileio::fileio_open(), and scale_time::time_gettimelabel().

Referenced by mod_atmos_vars::atmos_vars_restart_open().

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

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

!    if( IO_L ) write(IO_FID_LOG,*)
!    if( IO_L ) write(IO_FID_LOG,*) '*** Open restart file (ATMOS_PHY_TB) ***'

!    if ( ATMOS_PHY_TB_RESTART_IN_BASENAME /= '' ) then

!       if ( ATMOS_PHY_TB_RESTART_IN_POSTFIX_TIMELABEL ) then
!          call TIME_gettimelabel( timelabel )
!          basename = trim(ATMOS_PHY_TB_RESTART_IN_BASENAME)//'_'//trim(timelabel)
!       else
!          basename = trim(ATMOS_PHY_TB_RESTART_IN_BASENAME)
!       endif

!       if( IO_L ) write(IO_FID_LOG,*) '*** basename: ', trim(basename)

!       call FILEIO_open( restart_fid, basename )
!    else
!       if( IO_L ) write(IO_FID_LOG,*) '*** restart file for ATMOS_PHY_TB is not specified.'
!    endif

    return

Here is the call graph for this function:

Here is the caller graph for this function:

atmos_phy_tb_vars_restart_read()

subroutine, public mod_atmos_phy_tb_vars::atmos_phy_tb_vars_restart_read

(

)

Read restart.

Definition at line 214 of file mod_atmos_phy_tb_vars.f90.

References scale_fileio::fileio_flush(), and scale_rm_statistics::statistics_checktotal.

Referenced by mod_atmos_vars::atmos_vars_restart_read().

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

    real(RP) :: total
    integer  :: i, j
    !---------------------------------------------------------------------------

!    if ( restart_fid /= -1 ) then
!       if( IO_L ) write(IO_FID_LOG,*)
!       if( IO_L ) write(IO_FID_LOG,*) '*** Read from restart file (ATMOS_PHY_TB) ***'
!
!       call FILEIO_read( ATMOS_PHY_TB_??(:,:,:),                & ! [OUT]
!                         restart_fid, VAR_NAME(1), 'ZXY', step=1 ) ! [IN]
!
!       if ( IO_AGGREGATE ) then
!          call FILEIO_flush( restart_fid ) ! X/Y halos have been read from file
!
!          ! fill k halos
!          do j  = 1, JA
!          do i  = 1, IA
!             ATMOS_PHY_TB_??(   1:KS-1,i,j) = ATMOS_PHY_TB_??(KS,i,j)
!             ATMOS_PHY_TB_??(KE+1:KA,  i,j) = ATMOS_PHY_TB_??(KE,i,j)
!          enddo
!          enddo
!       else
!          call ATMOS_PHY_TB_vars_fillhalo
!       end if
!
!       if ( STATISTICS_checktotal ) then
!          call STAT_total( total, ATMOS_PHY_TB_??(:,:,:), VAR_NAME(1) )
!       endif
!    else
!       if( IO_L ) write(IO_FID_LOG,*) '*** invalid restart file ID for ATMOS_PHY_TB.'
!    endif

    return

Here is the call graph for this function:

Here is the caller graph for this function:

atmos_phy_tb_vars_restart_create()

subroutine, public mod_atmos_phy_tb_vars::atmos_phy_tb_vars_restart_create

(

)

Create restart file.

Definition at line 260 of file mod_atmos_phy_tb_vars.f90.

References scale_fileio::fileio_create(), and scale_time::time_gettimelabel().

Referenced by mod_atmos_vars::atmos_vars_restart_create().

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

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

!    if ( ATMOS_PHY_TB_RESTART_OUT_BASENAME /= '' ) then
!
!       if( IO_L ) write(IO_FID_LOG,*)
!       if( IO_L ) write(IO_FID_LOG,*) '*** Create restart file (ATMOS_PHY_AE) ***'
!
!       if ( ATMOS_PHY_TB_RESTART_OUT_POSTFIX_TIMELABEL ) then
!          call TIME_gettimelabel( timelabel )
!          basename = trim(ATMOS_PHY_TB_RESTART_OUT_BASENAME)//'_'//trim(timelabel)
!       else
!          basename = trim(ATMOS_PHY_TB_RESTART_OUT_BASENAME)
!       endif
!
!       if( IO_L ) write(IO_FID_LOG,*) '*** basename: ', trim(basename)
!
!       call FILEIO_create( restart_fid,                                                             & ! [OUT]
!                           basename, ATMOS_PHY_TB_RESTART_OUT_TITLE, 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:

atmos_phy_tb_vars_restart_enddef()

subroutine, public mod_atmos_phy_tb_vars::atmos_phy_tb_vars_restart_enddef

(

)

Exit netCDF define mode.

Definition at line 294 of file mod_atmos_phy_tb_vars.f90.

References scale_fileio::fileio_enddef().

Referenced by mod_atmos_vars::atmos_vars_restart_enddef().

    use scale_fileio, only: &
       fileio_enddef
    implicit none

!    if ( restart_fid /= -1 ) then
!       call FILEIO_enddef( restart_fid ) ! [IN]
!    endif

    return

Here is the call graph for this function:

Here is the caller graph for this function:

atmos_phy_tb_vars_restart_close()

subroutine, public mod_atmos_phy_tb_vars::atmos_phy_tb_vars_restart_close

(

)

Close restart file.

Definition at line 308 of file mod_atmos_phy_tb_vars.f90.

References scale_fileio::fileio_close().

Referenced by mod_atmos_vars::atmos_vars_restart_close().

    use scale_fileio, only: &
       fileio_close
    implicit none
    !---------------------------------------------------------------------------

!    if ( restart_fid /= -1 ) then
!       if( IO_L ) write(IO_FID_LOG,*)
!       if( IO_L ) write(IO_FID_LOG,*) '*** Close restart file (ATMOS_PHY_TB) ***'
!
!       call FILEIO_close( restart_fid ) ! [IN]
!
!       restart_fid = -1
!    endif

    return

Here is the call graph for this function:

Here is the caller graph for this function:

atmos_phy_tb_vars_restart_def_var()

subroutine, public mod_atmos_phy_tb_vars::atmos_phy_tb_vars_restart_def_var

(

)

Write restart.

Definition at line 328 of file mod_atmos_phy_tb_vars.f90.

References scale_fileio::fileio_def_var().

Referenced by mod_atmos_vars::atmos_vars_restart_def_var().

    use scale_fileio, only: &
       fileio_def_var
    implicit none
    !---------------------------------------------------------------------------

!    if ( restart_fid /= -1 ) then

!       call FILEIO_def_var( restart_fid, VAR_ID(1), VAR_NAME(1), VAR_DESC(1), &
!                            VAR_UNIT(1), '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:

atmos_phy_tb_vars_restart_write()

subroutine, public mod_atmos_phy_tb_vars::atmos_phy_tb_vars_restart_write

(

)

Write restart.

Definition at line 346 of file mod_atmos_phy_tb_vars.f90.

References scale_rm_statistics::statistics_checktotal.

Referenced by mod_atmos_vars::atmos_vars_restart_write().

    use scale_rm_statistics, only: &
       statistics_checktotal, &
       stat_total
    use scale_fileio, only: &
       fileio_write_var
    implicit none

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

!    if ( restart_fid /= -1 ) then
!
!       call ATMOS_PHY_TB_vars_fillhalo
!
!       if ( STATISTICS_checktotal ) then
!          call STAT_total( total, ATMOS_PHY_TB_??(:,:,:), VAR_NAME(1) )
!       endif
!
!       call FILEIO_write_var( restart_fid, VAR_ID(1), ATMOS_PHY_TB_??(:,:,:), &
!                              VAR_NAME(1), 'ZXY' ) ! [IN]
!
!    endif

    return

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 46 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 input file.

Definition at line 48 of file mod_atmos_phy_tb_vars.f90.

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

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

atmos_phy_tb_restart_in_postfix_timelabel

logical, public mod_atmos_phy_tb_vars::atmos_phy_tb_restart_in_postfix_timelabel = .false.

Add timelabel to the basename of input file?

Definition at line 49 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_IN_POSTFIX_TIMELABEL  = .false.                

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 50 of file mod_atmos_phy_tb_vars.f90.

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

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

atmos_phy_tb_restart_out_postfix_timelabel

logical, public mod_atmos_phy_tb_vars::atmos_phy_tb_restart_out_postfix_timelabel = .true.

Add timelabel to the basename of output file?

Definition at line 51 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_OUT_POSTFIX_TIMELABEL = .true.                 

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 52 of file mod_atmos_phy_tb_vars.f90.

Referenced by mod_admin_restart::admin_restart_setup(), 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_short), public mod_atmos_phy_tb_vars::atmos_phy_tb_restart_out_dtype = 'DEFAULT'

REAL4 or REAL8.

Definition at line 53 of file mod_atmos_phy_tb_vars.f90.

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

  character(len=H_SHORT), 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 55 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 56 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 57 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 58 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 59 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]